bpo-20181: Convert the readline module to the Argument Clinic (#14326)

This commit is contained in:
Zackery Spytz 2020-07-12 10:01:03 -06:00 committed by GitHub
parent 6a1e9c2673
commit b7047e59a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 1032 additions and 257 deletions

686
Modules/clinic/readline.c.h generated Normal file
View File

@ -0,0 +1,686 @@
/*[clinic input]
preserve
[clinic start generated code]*/
PyDoc_STRVAR(readline_parse_and_bind__doc__,
"parse_and_bind($module, string, /)\n"
"--\n"
"\n"
"Execute the init line provided in the string argument.");
#define READLINE_PARSE_AND_BIND_METHODDEF \
{"parse_and_bind", (PyCFunction)readline_parse_and_bind, METH_O, readline_parse_and_bind__doc__},
PyDoc_STRVAR(readline_read_init_file__doc__,
"read_init_file($module, filename=None, /)\n"
"--\n"
"\n"
"Execute a readline initialization file.\n"
"\n"
"The default filename is the last filename used.");
#define READLINE_READ_INIT_FILE_METHODDEF \
{"read_init_file", (PyCFunction)(void(*)(void))readline_read_init_file, METH_FASTCALL, readline_read_init_file__doc__},
static PyObject *
readline_read_init_file_impl(PyObject *module, PyObject *filename_obj);
static PyObject *
readline_read_init_file(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *filename_obj = Py_None;
if (!_PyArg_CheckPositional("read_init_file", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
filename_obj = args[0];
skip_optional:
return_value = readline_read_init_file_impl(module, filename_obj);
exit:
return return_value;
}
PyDoc_STRVAR(readline_read_history_file__doc__,
"read_history_file($module, filename=None, /)\n"
"--\n"
"\n"
"Load a readline history file.\n"
"\n"
"The default filename is ~/.history.");
#define READLINE_READ_HISTORY_FILE_METHODDEF \
{"read_history_file", (PyCFunction)(void(*)(void))readline_read_history_file, METH_FASTCALL, readline_read_history_file__doc__},
static PyObject *
readline_read_history_file_impl(PyObject *module, PyObject *filename_obj);
static PyObject *
readline_read_history_file(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *filename_obj = Py_None;
if (!_PyArg_CheckPositional("read_history_file", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
filename_obj = args[0];
skip_optional:
return_value = readline_read_history_file_impl(module, filename_obj);
exit:
return return_value;
}
PyDoc_STRVAR(readline_write_history_file__doc__,
"write_history_file($module, filename=None, /)\n"
"--\n"
"\n"
"Save a readline history file.\n"
"\n"
"The default filename is ~/.history.");
#define READLINE_WRITE_HISTORY_FILE_METHODDEF \
{"write_history_file", (PyCFunction)(void(*)(void))readline_write_history_file, METH_FASTCALL, readline_write_history_file__doc__},
static PyObject *
readline_write_history_file_impl(PyObject *module, PyObject *filename_obj);
static PyObject *
readline_write_history_file(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *filename_obj = Py_None;
if (!_PyArg_CheckPositional("write_history_file", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
filename_obj = args[0];
skip_optional:
return_value = readline_write_history_file_impl(module, filename_obj);
exit:
return return_value;
}
#if defined(HAVE_RL_APPEND_HISTORY)
PyDoc_STRVAR(readline_append_history_file__doc__,
"append_history_file($module, nelements, filename=None, /)\n"
"--\n"
"\n"
"Append the last nelements items of the history list to file.\n"
"\n"
"The default filename is ~/.history.");
#define READLINE_APPEND_HISTORY_FILE_METHODDEF \
{"append_history_file", (PyCFunction)(void(*)(void))readline_append_history_file, METH_FASTCALL, readline_append_history_file__doc__},
static PyObject *
readline_append_history_file_impl(PyObject *module, int nelements,
PyObject *filename_obj);
static PyObject *
readline_append_history_file(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
int nelements;
PyObject *filename_obj = Py_None;
if (!_PyArg_CheckPositional("append_history_file", nargs, 1, 2)) {
goto exit;
}
nelements = _PyLong_AsInt(args[0]);
if (nelements == -1 && PyErr_Occurred()) {
goto exit;
}
if (nargs < 2) {
goto skip_optional;
}
filename_obj = args[1];
skip_optional:
return_value = readline_append_history_file_impl(module, nelements, filename_obj);
exit:
return return_value;
}
#endif /* defined(HAVE_RL_APPEND_HISTORY) */
PyDoc_STRVAR(readline_set_history_length__doc__,
"set_history_length($module, length, /)\n"
"--\n"
"\n"
"Set the maximal number of lines which will be written to the history file.\n"
"\n"
"A negative length is used to inhibit history truncation.");
#define READLINE_SET_HISTORY_LENGTH_METHODDEF \
{"set_history_length", (PyCFunction)readline_set_history_length, METH_O, readline_set_history_length__doc__},
static PyObject *
readline_set_history_length_impl(PyObject *module, int length);
static PyObject *
readline_set_history_length(PyObject *module, PyObject *arg)
{
PyObject *return_value = NULL;
int length;
length = _PyLong_AsInt(arg);
if (length == -1 && PyErr_Occurred()) {
goto exit;
}
return_value = readline_set_history_length_impl(module, length);
exit:
return return_value;
}
PyDoc_STRVAR(readline_get_history_length__doc__,
"get_history_length($module, /)\n"
"--\n"
"\n"
"Return the maximum number of lines that will be written to the history file.");
#define READLINE_GET_HISTORY_LENGTH_METHODDEF \
{"get_history_length", (PyCFunction)readline_get_history_length, METH_NOARGS, readline_get_history_length__doc__},
static PyObject *
readline_get_history_length_impl(PyObject *module);
static PyObject *
readline_get_history_length(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_history_length_impl(module);
}
PyDoc_STRVAR(readline_set_completion_display_matches_hook__doc__,
"set_completion_display_matches_hook($module, function=None, /)\n"
"--\n"
"\n"
"Set or remove the completion display function.\n"
"\n"
"The function is called as\n"
" function(substitution, [matches], longest_match_length)\n"
"once each time matches need to be displayed.");
#define READLINE_SET_COMPLETION_DISPLAY_MATCHES_HOOK_METHODDEF \
{"set_completion_display_matches_hook", (PyCFunction)(void(*)(void))readline_set_completion_display_matches_hook, METH_FASTCALL, readline_set_completion_display_matches_hook__doc__},
static PyObject *
readline_set_completion_display_matches_hook_impl(PyObject *module,
PyObject *function);
static PyObject *
readline_set_completion_display_matches_hook(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *function = Py_None;
if (!_PyArg_CheckPositional("set_completion_display_matches_hook", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
function = args[0];
skip_optional:
return_value = readline_set_completion_display_matches_hook_impl(module, function);
exit:
return return_value;
}
PyDoc_STRVAR(readline_set_startup_hook__doc__,
"set_startup_hook($module, function=None, /)\n"
"--\n"
"\n"
"Set or remove the function invoked by the rl_startup_hook callback.\n"
"\n"
"The function is called with no arguments just\n"
"before readline prints the first prompt.");
#define READLINE_SET_STARTUP_HOOK_METHODDEF \
{"set_startup_hook", (PyCFunction)(void(*)(void))readline_set_startup_hook, METH_FASTCALL, readline_set_startup_hook__doc__},
static PyObject *
readline_set_startup_hook_impl(PyObject *module, PyObject *function);
static PyObject *
readline_set_startup_hook(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *function = Py_None;
if (!_PyArg_CheckPositional("set_startup_hook", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
function = args[0];
skip_optional:
return_value = readline_set_startup_hook_impl(module, function);
exit:
return return_value;
}
#if defined(HAVE_RL_PRE_INPUT_HOOK)
PyDoc_STRVAR(readline_set_pre_input_hook__doc__,
"set_pre_input_hook($module, function=None, /)\n"
"--\n"
"\n"
"Set or remove the function invoked by the rl_pre_input_hook callback.\n"
"\n"
"The function is called with no arguments after the first prompt\n"
"has been printed and just before readline starts reading input\n"
"characters.");
#define READLINE_SET_PRE_INPUT_HOOK_METHODDEF \
{"set_pre_input_hook", (PyCFunction)(void(*)(void))readline_set_pre_input_hook, METH_FASTCALL, readline_set_pre_input_hook__doc__},
static PyObject *
readline_set_pre_input_hook_impl(PyObject *module, PyObject *function);
static PyObject *
readline_set_pre_input_hook(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *function = Py_None;
if (!_PyArg_CheckPositional("set_pre_input_hook", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
function = args[0];
skip_optional:
return_value = readline_set_pre_input_hook_impl(module, function);
exit:
return return_value;
}
#endif /* defined(HAVE_RL_PRE_INPUT_HOOK) */
PyDoc_STRVAR(readline_get_completion_type__doc__,
"get_completion_type($module, /)\n"
"--\n"
"\n"
"Get the type of completion being attempted.");
#define READLINE_GET_COMPLETION_TYPE_METHODDEF \
{"get_completion_type", (PyCFunction)readline_get_completion_type, METH_NOARGS, readline_get_completion_type__doc__},
static PyObject *
readline_get_completion_type_impl(PyObject *module);
static PyObject *
readline_get_completion_type(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_completion_type_impl(module);
}
PyDoc_STRVAR(readline_get_begidx__doc__,
"get_begidx($module, /)\n"
"--\n"
"\n"
"Get the beginning index of the completion scope.");
#define READLINE_GET_BEGIDX_METHODDEF \
{"get_begidx", (PyCFunction)readline_get_begidx, METH_NOARGS, readline_get_begidx__doc__},
static PyObject *
readline_get_begidx_impl(PyObject *module);
static PyObject *
readline_get_begidx(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_begidx_impl(module);
}
PyDoc_STRVAR(readline_get_endidx__doc__,
"get_endidx($module, /)\n"
"--\n"
"\n"
"Get the ending index of the completion scope.");
#define READLINE_GET_ENDIDX_METHODDEF \
{"get_endidx", (PyCFunction)readline_get_endidx, METH_NOARGS, readline_get_endidx__doc__},
static PyObject *
readline_get_endidx_impl(PyObject *module);
static PyObject *
readline_get_endidx(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_endidx_impl(module);
}
PyDoc_STRVAR(readline_set_completer_delims__doc__,
"set_completer_delims($module, string, /)\n"
"--\n"
"\n"
"Set the word delimiters for completion.");
#define READLINE_SET_COMPLETER_DELIMS_METHODDEF \
{"set_completer_delims", (PyCFunction)readline_set_completer_delims, METH_O, readline_set_completer_delims__doc__},
PyDoc_STRVAR(readline_remove_history_item__doc__,
"remove_history_item($module, pos, /)\n"
"--\n"
"\n"
"Remove history item given by its position.");
#define READLINE_REMOVE_HISTORY_ITEM_METHODDEF \
{"remove_history_item", (PyCFunction)readline_remove_history_item, METH_O, readline_remove_history_item__doc__},
static PyObject *
readline_remove_history_item_impl(PyObject *module, int entry_number);
static PyObject *
readline_remove_history_item(PyObject *module, PyObject *arg)
{
PyObject *return_value = NULL;
int entry_number;
entry_number = _PyLong_AsInt(arg);
if (entry_number == -1 && PyErr_Occurred()) {
goto exit;
}
return_value = readline_remove_history_item_impl(module, entry_number);
exit:
return return_value;
}
PyDoc_STRVAR(readline_replace_history_item__doc__,
"replace_history_item($module, pos, line, /)\n"
"--\n"
"\n"
"Replaces history item given by its position with contents of line.");
#define READLINE_REPLACE_HISTORY_ITEM_METHODDEF \
{"replace_history_item", (PyCFunction)(void(*)(void))readline_replace_history_item, METH_FASTCALL, readline_replace_history_item__doc__},
static PyObject *
readline_replace_history_item_impl(PyObject *module, int entry_number,
PyObject *line);
static PyObject *
readline_replace_history_item(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
int entry_number;
PyObject *line;
if (!_PyArg_CheckPositional("replace_history_item", nargs, 2, 2)) {
goto exit;
}
entry_number = _PyLong_AsInt(args[0]);
if (entry_number == -1 && PyErr_Occurred()) {
goto exit;
}
if (!PyUnicode_Check(args[1])) {
_PyArg_BadArgument("replace_history_item", "argument 2", "str", args[1]);
goto exit;
}
if (PyUnicode_READY(args[1]) == -1) {
goto exit;
}
line = args[1];
return_value = readline_replace_history_item_impl(module, entry_number, line);
exit:
return return_value;
}
PyDoc_STRVAR(readline_add_history__doc__,
"add_history($module, string, /)\n"
"--\n"
"\n"
"Add an item to the history buffer.");
#define READLINE_ADD_HISTORY_METHODDEF \
{"add_history", (PyCFunction)readline_add_history, METH_O, readline_add_history__doc__},
PyDoc_STRVAR(readline_set_auto_history__doc__,
"set_auto_history($module, enabled, /)\n"
"--\n"
"\n"
"Enables or disables automatic history.");
#define READLINE_SET_AUTO_HISTORY_METHODDEF \
{"set_auto_history", (PyCFunction)readline_set_auto_history, METH_O, readline_set_auto_history__doc__},
static PyObject *
readline_set_auto_history_impl(PyObject *module,
int _should_auto_add_history);
static PyObject *
readline_set_auto_history(PyObject *module, PyObject *arg)
{
PyObject *return_value = NULL;
int _should_auto_add_history;
_should_auto_add_history = PyObject_IsTrue(arg);
if (_should_auto_add_history < 0) {
goto exit;
}
return_value = readline_set_auto_history_impl(module, _should_auto_add_history);
exit:
return return_value;
}
PyDoc_STRVAR(readline_get_completer_delims__doc__,
"get_completer_delims($module, /)\n"
"--\n"
"\n"
"Get the word delimiters for completion.");
#define READLINE_GET_COMPLETER_DELIMS_METHODDEF \
{"get_completer_delims", (PyCFunction)readline_get_completer_delims, METH_NOARGS, readline_get_completer_delims__doc__},
static PyObject *
readline_get_completer_delims_impl(PyObject *module);
static PyObject *
readline_get_completer_delims(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_completer_delims_impl(module);
}
PyDoc_STRVAR(readline_set_completer__doc__,
"set_completer($module, function=None, /)\n"
"--\n"
"\n"
"Set or remove the completer function.\n"
"\n"
"The function is called as function(text, state),\n"
"for state in 0, 1, 2, ..., until it returns a non-string.\n"
"It should return the next possible completion starting with \'text\'.");
#define READLINE_SET_COMPLETER_METHODDEF \
{"set_completer", (PyCFunction)(void(*)(void))readline_set_completer, METH_FASTCALL, readline_set_completer__doc__},
static PyObject *
readline_set_completer_impl(PyObject *module, PyObject *function);
static PyObject *
readline_set_completer(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *return_value = NULL;
PyObject *function = Py_None;
if (!_PyArg_CheckPositional("set_completer", nargs, 0, 1)) {
goto exit;
}
if (nargs < 1) {
goto skip_optional;
}
function = args[0];
skip_optional:
return_value = readline_set_completer_impl(module, function);
exit:
return return_value;
}
PyDoc_STRVAR(readline_get_completer__doc__,
"get_completer($module, /)\n"
"--\n"
"\n"
"Get the current completer function.");
#define READLINE_GET_COMPLETER_METHODDEF \
{"get_completer", (PyCFunction)readline_get_completer, METH_NOARGS, readline_get_completer__doc__},
static PyObject *
readline_get_completer_impl(PyObject *module);
static PyObject *
readline_get_completer(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_completer_impl(module);
}
PyDoc_STRVAR(readline_get_history_item__doc__,
"get_history_item($module, index, /)\n"
"--\n"
"\n"
"Return the current contents of history item at index.");
#define READLINE_GET_HISTORY_ITEM_METHODDEF \
{"get_history_item", (PyCFunction)readline_get_history_item, METH_O, readline_get_history_item__doc__},
static PyObject *
readline_get_history_item_impl(PyObject *module, int idx);
static PyObject *
readline_get_history_item(PyObject *module, PyObject *arg)
{
PyObject *return_value = NULL;
int idx;
idx = _PyLong_AsInt(arg);
if (idx == -1 && PyErr_Occurred()) {
goto exit;
}
return_value = readline_get_history_item_impl(module, idx);
exit:
return return_value;
}
PyDoc_STRVAR(readline_get_current_history_length__doc__,
"get_current_history_length($module, /)\n"
"--\n"
"\n"
"Return the current (not the maximum) length of history.");
#define READLINE_GET_CURRENT_HISTORY_LENGTH_METHODDEF \
{"get_current_history_length", (PyCFunction)readline_get_current_history_length, METH_NOARGS, readline_get_current_history_length__doc__},
static PyObject *
readline_get_current_history_length_impl(PyObject *module);
static PyObject *
readline_get_current_history_length(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_current_history_length_impl(module);
}
PyDoc_STRVAR(readline_get_line_buffer__doc__,
"get_line_buffer($module, /)\n"
"--\n"
"\n"
"Return the current contents of the line buffer.");
#define READLINE_GET_LINE_BUFFER_METHODDEF \
{"get_line_buffer", (PyCFunction)readline_get_line_buffer, METH_NOARGS, readline_get_line_buffer__doc__},
static PyObject *
readline_get_line_buffer_impl(PyObject *module);
static PyObject *
readline_get_line_buffer(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_get_line_buffer_impl(module);
}
#if defined(HAVE_RL_COMPLETION_APPEND_CHARACTER)
PyDoc_STRVAR(readline_clear_history__doc__,
"clear_history($module, /)\n"
"--\n"
"\n"
"Clear the current readline history.");
#define READLINE_CLEAR_HISTORY_METHODDEF \
{"clear_history", (PyCFunction)readline_clear_history, METH_NOARGS, readline_clear_history__doc__},
static PyObject *
readline_clear_history_impl(PyObject *module);
static PyObject *
readline_clear_history(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_clear_history_impl(module);
}
#endif /* defined(HAVE_RL_COMPLETION_APPEND_CHARACTER) */
PyDoc_STRVAR(readline_insert_text__doc__,
"insert_text($module, string, /)\n"
"--\n"
"\n"
"Insert text into the line buffer at the cursor position.");
#define READLINE_INSERT_TEXT_METHODDEF \
{"insert_text", (PyCFunction)readline_insert_text, METH_O, readline_insert_text__doc__},
PyDoc_STRVAR(readline_redisplay__doc__,
"redisplay($module, /)\n"
"--\n"
"\n"
"Change what\'s displayed on the screen to reflect contents of the line buffer.");
#define READLINE_REDISPLAY_METHODDEF \
{"redisplay", (PyCFunction)readline_redisplay, METH_NOARGS, readline_redisplay__doc__},
static PyObject *
readline_redisplay_impl(PyObject *module);
static PyObject *
readline_redisplay(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return readline_redisplay_impl(module);
}
#ifndef READLINE_APPEND_HISTORY_FILE_METHODDEF
#define READLINE_APPEND_HISTORY_FILE_METHODDEF
#endif /* !defined(READLINE_APPEND_HISTORY_FILE_METHODDEF) */
#ifndef READLINE_SET_PRE_INPUT_HOOK_METHODDEF
#define READLINE_SET_PRE_INPUT_HOOK_METHODDEF
#endif /* !defined(READLINE_SET_PRE_INPUT_HOOK_METHODDEF) */
#ifndef READLINE_CLEAR_HISTORY_METHODDEF
#define READLINE_CLEAR_HISTORY_METHODDEF
#endif /* !defined(READLINE_CLEAR_HISTORY_METHODDEF) */
/*[clinic end generated code: output=cb44f391ccbfb565 input=a9049054013a1b77]*/

View File

@ -94,6 +94,11 @@ get_readline_state(PyObject *module)
return (readlinestate *)state; return (readlinestate *)state;
} }
/*[clinic input]
module readline
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=ad49da781b9c8721]*/
static int static int
readline_clear(PyObject *m) readline_clear(PyObject *m)
{ {
@ -148,8 +153,18 @@ decode(const char *s)
/* Exported function to send one line to readline's init file parser */ /* Exported function to send one line to readline's init file parser */
/*[clinic input]
readline.parse_and_bind
string: object
/
Execute the init line provided in the string argument.
[clinic start generated code]*/
static PyObject * static PyObject *
parse_and_bind(PyObject *self, PyObject *string) readline_parse_and_bind(PyObject *module, PyObject *string)
/*[clinic end generated code: output=1a1ede8afb9546c1 input=8a28a00bb4d61eec]*/
{ {
char *copy; char *copy;
PyObject *encoded = encode(string); PyObject *encoded = encode(string);
@ -170,23 +185,28 @@ parse_and_bind(PyObject *self, PyObject *string)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_parse_and_bind,
"parse_and_bind(string) -> None\n\
Execute the init line provided in the string argument.");
/* Exported function to parse a readline init file */ /* Exported function to parse a readline init file */
/*[clinic input]
readline.read_init_file
filename as filename_obj: object = None
/
Execute a readline initialization file.
The default filename is the last filename used.
[clinic start generated code]*/
static PyObject * static PyObject *
read_init_file(PyObject *self, PyObject *args) readline_read_init_file_impl(PyObject *module, PyObject *filename_obj)
/*[clinic end generated code: output=8e059b676142831e input=4c80c473e448139d]*/
{ {
PyObject *filename_obj = Py_None, *filename_bytes; PyObject *filename_bytes;
if (!PyArg_ParseTuple(args, "|O:read_init_file", &filename_obj))
return NULL;
if (filename_obj != Py_None) { if (filename_obj != Py_None) {
if (!PyUnicode_FSConverter(filename_obj, &filename_bytes)) if (!PyUnicode_FSConverter(filename_obj, &filename_bytes))
return NULL; return NULL;
errno = rl_read_init_file(PyBytes_AsString(filename_bytes)); errno = rl_read_init_file(PyBytes_AS_STRING(filename_bytes));
Py_DECREF(filename_bytes); Py_DECREF(filename_bytes);
} else } else
errno = rl_read_init_file(NULL); errno = rl_read_init_file(NULL);
@ -195,24 +215,28 @@ read_init_file(PyObject *self, PyObject *args)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_read_init_file,
"read_init_file([filename]) -> None\n\
Execute a readline initialization file.\n\
The default filename is the last filename used.");
/* Exported function to load a readline history file */ /* Exported function to load a readline history file */
/*[clinic input]
readline.read_history_file
filename as filename_obj: object = None
/
Load a readline history file.
The default filename is ~/.history.
[clinic start generated code]*/
static PyObject * static PyObject *
read_history_file(PyObject *self, PyObject *args) readline_read_history_file_impl(PyObject *module, PyObject *filename_obj)
/*[clinic end generated code: output=66a951836fb54fbb input=3d29d755b7e6932e]*/
{ {
PyObject *filename_obj = Py_None, *filename_bytes; PyObject *filename_bytes;
if (!PyArg_ParseTuple(args, "|O:read_history_file", &filename_obj))
return NULL;
if (filename_obj != Py_None) { if (filename_obj != Py_None) {
if (!PyUnicode_FSConverter(filename_obj, &filename_bytes)) if (!PyUnicode_FSConverter(filename_obj, &filename_bytes))
return NULL; return NULL;
errno = read_history(PyBytes_AsString(filename_bytes)); errno = read_history(PyBytes_AS_STRING(filename_bytes));
Py_DECREF(filename_bytes); Py_DECREF(filename_bytes);
} else } else
errno = read_history(NULL); errno = read_history(NULL);
@ -222,26 +246,31 @@ read_history_file(PyObject *self, PyObject *args)
} }
static int _history_length = -1; /* do not truncate history by default */ static int _history_length = -1; /* do not truncate history by default */
PyDoc_STRVAR(doc_read_history_file,
"read_history_file([filename]) -> None\n\
Load a readline history file.\n\
The default filename is ~/.history.");
/* Exported function to save a readline history file */ /* Exported function to save a readline history file */
/*[clinic input]
readline.write_history_file
filename as filename_obj: object = None
/
Save a readline history file.
The default filename is ~/.history.
[clinic start generated code]*/
static PyObject * static PyObject *
write_history_file(PyObject *self, PyObject *args) readline_write_history_file_impl(PyObject *module, PyObject *filename_obj)
/*[clinic end generated code: output=fbcad13d8ef59ae6 input=28a8e062fe363703]*/
{ {
PyObject *filename_obj = Py_None, *filename_bytes; PyObject *filename_bytes;
const char *filename; const char *filename;
int err; int err;
if (!PyArg_ParseTuple(args, "|O:write_history_file", &filename_obj))
return NULL;
if (filename_obj != Py_None) { if (filename_obj != Py_None) {
if (!PyUnicode_FSConverter(filename_obj, &filename_bytes)) if (!PyUnicode_FSConverter(filename_obj, &filename_bytes))
return NULL; return NULL;
filename = PyBytes_AsString(filename_bytes); filename = PyBytes_AS_STRING(filename_bytes);
} else { } else {
filename_bytes = NULL; filename_bytes = NULL;
filename = NULL; filename = NULL;
@ -256,28 +285,33 @@ write_history_file(PyObject *self, PyObject *args)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_write_history_file,
"write_history_file([filename]) -> None\n\
Save a readline history file.\n\
The default filename is ~/.history.");
#ifdef HAVE_RL_APPEND_HISTORY #ifdef HAVE_RL_APPEND_HISTORY
/* Exported function to save part of a readline history file */ /* Exported function to save part of a readline history file */
/*[clinic input]
readline.append_history_file
nelements: int
filename as filename_obj: object = None
/
Append the last nelements items of the history list to file.
The default filename is ~/.history.
[clinic start generated code]*/
static PyObject * static PyObject *
append_history_file(PyObject *self, PyObject *args) readline_append_history_file_impl(PyObject *module, int nelements,
PyObject *filename_obj)
/*[clinic end generated code: output=5df06fc9da56e4e4 input=784b774db3a4b7c5]*/
{ {
int nelements; PyObject *filename_bytes;
PyObject *filename_obj = Py_None, *filename_bytes;
const char *filename; const char *filename;
int err; int err;
if (!PyArg_ParseTuple(args, "i|O:append_history_file", &nelements, &filename_obj))
return NULL;
if (filename_obj != Py_None) { if (filename_obj != Py_None) {
if (!PyUnicode_FSConverter(filename_obj, &filename_bytes)) if (!PyUnicode_FSConverter(filename_obj, &filename_bytes))
return NULL; return NULL;
filename = PyBytes_AsString(filename_bytes); filename = PyBytes_AS_STRING(filename_bytes);
} else { } else {
filename_bytes = NULL; filename_bytes = NULL;
filename = NULL; filename = NULL;
@ -291,57 +325,50 @@ append_history_file(PyObject *self, PyObject *args)
return PyErr_SetFromErrno(PyExc_OSError); return PyErr_SetFromErrno(PyExc_OSError);
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_append_history_file,
"append_history_file(nelements[, filename]) -> None\n\
Append the last nelements items of the history list to file.\n\
The default filename is ~/.history.");
#endif #endif
/* Set history length */ /* Set history length */
static PyObject* /*[clinic input]
set_history_length(PyObject *self, PyObject *args) readline.set_history_length
length: int
/
Set the maximal number of lines which will be written to the history file.
A negative length is used to inhibit history truncation.
[clinic start generated code]*/
static PyObject *
readline_set_history_length_impl(PyObject *module, int length)
/*[clinic end generated code: output=e161a53e45987dc7 input=b8901bf16488b760]*/
{ {
int length = _history_length;
if (!PyArg_ParseTuple(args, "i:set_history_length", &length))
return NULL;
_history_length = length; _history_length = length;
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(set_history_length_doc,
"set_history_length(length) -> None\n\
set the maximal number of lines which will be written to\n\
the history file. A negative length is used to inhibit\n\
history truncation.");
/* Get history length */ /* Get history length */
static PyObject* /*[clinic input]
get_history_length(PyObject *self, PyObject *noarg) readline.get_history_length
Return the maximum number of lines that will be written to the history file.
[clinic start generated code]*/
static PyObject *
readline_get_history_length_impl(PyObject *module)
/*[clinic end generated code: output=83a2eeae35b6d2b9 input=5dce2eeba4327817]*/
{ {
return PyLong_FromLong(_history_length); return PyLong_FromLong(_history_length);
} }
PyDoc_STRVAR(get_history_length_doc,
"get_history_length() -> int\n\
return the maximum number of lines that will be written to\n\
the history file.");
/* Generic hook function setter */ /* Generic hook function setter */
static PyObject * static PyObject *
set_hook(const char *funcname, PyObject **hook_var, PyObject *args) set_hook(const char *funcname, PyObject **hook_var, PyObject *function)
{ {
PyObject *function = Py_None;
char buf[80];
PyOS_snprintf(buf, sizeof(buf), "|O:set_%.50s", funcname);
if (!PyArg_ParseTuple(args, buf, &function))
return NULL;
if (function == Py_None) { if (function == Py_None) {
Py_CLEAR(*hook_var); Py_CLEAR(*hook_var);
} }
@ -358,12 +385,27 @@ set_hook(const char *funcname, PyObject **hook_var, PyObject *args)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
/*[clinic input]
readline.set_completion_display_matches_hook
function: object = None
/
Set or remove the completion display function.
The function is called as
function(substitution, [matches], longest_match_length)
once each time matches need to be displayed.
[clinic start generated code]*/
static PyObject * static PyObject *
set_completion_display_matches_hook(PyObject *self, PyObject *args) readline_set_completion_display_matches_hook_impl(PyObject *module,
PyObject *function)
/*[clinic end generated code: output=516e5cb8db75a328 input=4f0bfd5ab0179a26]*/
{ {
PyObject *result = set_hook("completion_display_matches_hook", PyObject *result = set_hook("completion_display_matches_hook",
&readlinestate_global->completion_display_matches_hook, args); &readlinestate_global->completion_display_matches_hook,
function);
#ifdef HAVE_RL_COMPLETION_DISPLAY_MATCHES_HOOK #ifdef HAVE_RL_COMPLETION_DISPLAY_MATCHES_HOOK
/* We cannot set this hook globally, since it replaces the /* We cannot set this hook globally, since it replaces the
default completion display. */ default completion display. */
@ -379,90 +421,114 @@ set_completion_display_matches_hook(PyObject *self, PyObject *args)
} }
PyDoc_STRVAR(doc_set_completion_display_matches_hook, /*[clinic input]
"set_completion_display_matches_hook([function]) -> None\n\ readline.set_startup_hook
Set or remove the completion display function.\n\
The function is called as\n\ function: object = None
function(substitution, [matches], longest_match_length)\n\ /
once each time matches need to be displayed.");
Set or remove the function invoked by the rl_startup_hook callback.
The function is called with no arguments just
before readline prints the first prompt.
[clinic start generated code]*/
static PyObject * static PyObject *
set_startup_hook(PyObject *self, PyObject *args) readline_set_startup_hook_impl(PyObject *module, PyObject *function)
/*[clinic end generated code: output=02cd0e0c4fa082ad input=7783b4334b26d16d]*/
{ {
return set_hook("startup_hook", &readlinestate_global->startup_hook, args); return set_hook("startup_hook", &readlinestate_global->startup_hook,
function);
} }
PyDoc_STRVAR(doc_set_startup_hook,
"set_startup_hook([function]) -> None\n\
Set or remove the function invoked by the rl_startup_hook callback.\n\
The function is called with no arguments just\n\
before readline prints the first prompt.");
#ifdef HAVE_RL_PRE_INPUT_HOOK #ifdef HAVE_RL_PRE_INPUT_HOOK
/* Set pre-input hook */ /* Set pre-input hook */
/*[clinic input]
readline.set_pre_input_hook
function: object = None
/
Set or remove the function invoked by the rl_pre_input_hook callback.
The function is called with no arguments after the first prompt
has been printed and just before readline starts reading input
characters.
[clinic start generated code]*/
static PyObject * static PyObject *
set_pre_input_hook(PyObject *self, PyObject *args) readline_set_pre_input_hook_impl(PyObject *module, PyObject *function)
/*[clinic end generated code: output=fe1a96505096f464 input=4f3eaeaf7ce1fdbe]*/
{ {
return set_hook("pre_input_hook", &readlinestate_global->pre_input_hook, args); return set_hook("pre_input_hook", &readlinestate_global->pre_input_hook,
function);
} }
PyDoc_STRVAR(doc_set_pre_input_hook,
"set_pre_input_hook([function]) -> None\n\
Set or remove the function invoked by the rl_pre_input_hook callback.\n\
The function is called with no arguments after the first prompt\n\
has been printed and just before readline starts reading input\n\
characters.");
#endif #endif
/* Get the completion type for the scope of the tab-completion */ /* Get the completion type for the scope of the tab-completion */
/*[clinic input]
readline.get_completion_type
Get the type of completion being attempted.
[clinic start generated code]*/
static PyObject * static PyObject *
get_completion_type(PyObject *self, PyObject *noarg) readline_get_completion_type_impl(PyObject *module)
/*[clinic end generated code: output=5c54d58a04997c07 input=04b92bc7a82dac91]*/
{ {
return PyLong_FromLong(rl_completion_type); return PyLong_FromLong(rl_completion_type);
} }
PyDoc_STRVAR(doc_get_completion_type,
"get_completion_type() -> int\n\
Get the type of completion being attempted.");
/* Get the beginning index for the scope of the tab-completion */ /* Get the beginning index for the scope of the tab-completion */
/*[clinic input]
readline.get_begidx
Get the beginning index of the completion scope.
[clinic start generated code]*/
static PyObject * static PyObject *
get_begidx(PyObject *self, PyObject *noarg) readline_get_begidx_impl(PyObject *module)
/*[clinic end generated code: output=362616ee8ed1b2b1 input=e083b81c8eb4bac3]*/
{ {
Py_INCREF(readlinestate_global->begidx); Py_INCREF(readlinestate_global->begidx);
return readlinestate_global->begidx; return readlinestate_global->begidx;
} }
PyDoc_STRVAR(doc_get_begidx,
"get_begidx() -> int\n\
get the beginning index of the completion scope");
/* Get the ending index for the scope of the tab-completion */ /* Get the ending index for the scope of the tab-completion */
/*[clinic input]
readline.get_endidx
Get the ending index of the completion scope.
[clinic start generated code]*/
static PyObject * static PyObject *
get_endidx(PyObject *self, PyObject *noarg) readline_get_endidx_impl(PyObject *module)
/*[clinic end generated code: output=7f763350b12d7517 input=d4c7e34a625fd770]*/
{ {
Py_INCREF(readlinestate_global->endidx); Py_INCREF(readlinestate_global->endidx);
return readlinestate_global->endidx; return readlinestate_global->endidx;
} }
PyDoc_STRVAR(doc_get_endidx,
"get_endidx() -> int\n\
get the ending index of the completion scope");
/* Set the tab-completion word-delimiters that readline uses */ /* Set the tab-completion word-delimiters that readline uses */
/*[clinic input]
readline.set_completer_delims
string: object
/
Set the word delimiters for completion.
[clinic start generated code]*/
static PyObject * static PyObject *
set_completer_delims(PyObject *self, PyObject *string) readline_set_completer_delims(PyObject *module, PyObject *string)
/*[clinic end generated code: output=4305b266106c4f1f input=ae945337ebd01e20]*/
{ {
char *break_chars; char *break_chars;
PyObject *encoded = encode(string); PyObject *encoded = encode(string);
@ -484,10 +550,6 @@ set_completer_delims(PyObject *self, PyObject *string)
return PyErr_NoMemory(); return PyErr_NoMemory();
} }
PyDoc_STRVAR(doc_set_completer_delims,
"set_completer_delims(string) -> None\n\
set the word delimiters for completion");
/* _py_free_history_entry: Utility function to free a history entry. */ /* _py_free_history_entry: Utility function to free a history entry. */
#if defined(RL_READLINE_VERSION) && RL_READLINE_VERSION >= 0x0500 #if defined(RL_READLINE_VERSION) && RL_READLINE_VERSION >= 0x0500
@ -520,14 +582,21 @@ _py_free_history_entry(HIST_ENTRY *entry)
#endif #endif
/*[clinic input]
readline.remove_history_item
pos as entry_number: int
/
Remove history item given by its position.
[clinic start generated code]*/
static PyObject * static PyObject *
py_remove_history(PyObject *self, PyObject *args) readline_remove_history_item_impl(PyObject *module, int entry_number)
/*[clinic end generated code: output=ab114f029208c7e8 input=c8520ac3da50224e]*/
{ {
int entry_number;
HIST_ENTRY *entry; HIST_ENTRY *entry;
if (!PyArg_ParseTuple(args, "i:remove_history_item", &entry_number))
return NULL;
if (entry_number < 0) { if (entry_number < 0) {
PyErr_SetString(PyExc_ValueError, PyErr_SetString(PyExc_ValueError,
"History index cannot be negative"); "History index cannot be negative");
@ -545,22 +614,24 @@ py_remove_history(PyObject *self, PyObject *args)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_remove_history, /*[clinic input]
"remove_history_item(pos) -> None\n\ readline.replace_history_item
remove history item given by its position");
pos as entry_number: int
line: unicode
/
Replaces history item given by its position with contents of line.
[clinic start generated code]*/
static PyObject * static PyObject *
py_replace_history(PyObject *self, PyObject *args) readline_replace_history_item_impl(PyObject *module, int entry_number,
PyObject *line)
/*[clinic end generated code: output=f8cec2770ca125eb input=b7ccef0780ae041b]*/
{ {
int entry_number;
PyObject *line;
PyObject *encoded; PyObject *encoded;
HIST_ENTRY *old_entry; HIST_ENTRY *old_entry;
if (!PyArg_ParseTuple(args, "iU:replace_history_item", &entry_number,
&line)) {
return NULL;
}
if (entry_number < 0) { if (entry_number < 0) {
PyErr_SetString(PyExc_ValueError, PyErr_SetString(PyExc_ValueError,
"History index cannot be negative"); "History index cannot be negative");
@ -583,14 +654,20 @@ py_replace_history(PyObject *self, PyObject *args)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_replace_history,
"replace_history_item(pos, line) -> None\n\
replaces history item given by its position with contents of line");
/* Add a line to the history buffer */ /* Add a line to the history buffer */
/*[clinic input]
readline.add_history
string: object
/
Add an item to the history buffer.
[clinic start generated code]*/
static PyObject * static PyObject *
py_add_history(PyObject *self, PyObject *string) readline_add_history(PyObject *module, PyObject *string)
/*[clinic end generated code: output=b107b7e8106e803d input=e57c1cf6bc68d7e3]*/
{ {
PyObject *encoded = encode(string); PyObject *encoded = encode(string);
if (encoded == NULL) { if (encoded == NULL) {
@ -601,60 +678,75 @@ py_add_history(PyObject *self, PyObject *string)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_add_history,
"add_history(string) -> None\n\
add an item to the history buffer");
static int should_auto_add_history = 1; static int should_auto_add_history = 1;
/* Enable or disable automatic history */ /* Enable or disable automatic history */
/*[clinic input]
readline.set_auto_history
enabled as _should_auto_add_history: bool
/
Enables or disables automatic history.
[clinic start generated code]*/
static PyObject * static PyObject *
py_set_auto_history(PyObject *self, PyObject *args) readline_set_auto_history_impl(PyObject *module,
int _should_auto_add_history)
/*[clinic end generated code: output=619c6968246fd82b input=3d413073a1a03355]*/
{ {
if (!PyArg_ParseTuple(args, "p:set_auto_history", should_auto_add_history = _should_auto_add_history;
&should_auto_add_history)) {
return NULL;
}
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_set_auto_history,
"set_auto_history(enabled) -> None\n\
Enables or disables automatic history.");
/* Get the tab-completion word-delimiters that readline uses */ /* Get the tab-completion word-delimiters that readline uses */
/*[clinic input]
readline.get_completer_delims
Get the word delimiters for completion.
[clinic start generated code]*/
static PyObject * static PyObject *
get_completer_delims(PyObject *self, PyObject *noarg) readline_get_completer_delims_impl(PyObject *module)
/*[clinic end generated code: output=6b060280fa68ef43 input=e36eb14fb8a1f08a]*/
{ {
return decode(rl_completer_word_break_characters); return decode(rl_completer_word_break_characters);
} }
PyDoc_STRVAR(doc_get_completer_delims,
"get_completer_delims() -> string\n\
get the word delimiters for completion");
/* Set the completer function */ /* Set the completer function */
/*[clinic input]
readline.set_completer
function: object = None
/
Set or remove the completer function.
The function is called as function(text, state),
for state in 0, 1, 2, ..., until it returns a non-string.
It should return the next possible completion starting with 'text'.
[clinic start generated code]*/
static PyObject * static PyObject *
set_completer(PyObject *self, PyObject *args) readline_set_completer_impl(PyObject *module, PyObject *function)
/*[clinic end generated code: output=171a2a60f81d3204 input=51e81e13118eb877]*/
{ {
return set_hook("completer", &readlinestate_global->completer, args); return set_hook("completer", &readlinestate_global->completer, function);
} }
PyDoc_STRVAR(doc_set_completer, /*[clinic input]
"set_completer([function]) -> None\n\ readline.get_completer
Set or remove the completer function.\n\
The function is called as function(text, state),\n\
for state in 0, 1, 2, ..., until it returns a non-string.\n\
It should return the next possible completion starting with 'text'.");
Get the current completer function.
[clinic start generated code]*/
static PyObject * static PyObject *
get_completer(PyObject *self, PyObject *noargs) readline_get_completer_impl(PyObject *module)
/*[clinic end generated code: output=6e6bbd8226d14475 input=6457522e56d70d13]*/
{ {
if (readlinestate_global->completer == NULL) { if (readlinestate_global->completer == NULL) {
Py_RETURN_NONE; Py_RETURN_NONE;
@ -663,11 +755,6 @@ get_completer(PyObject *self, PyObject *noargs)
return readlinestate_global->completer; return readlinestate_global->completer;
} }
PyDoc_STRVAR(doc_get_completer,
"get_completer() -> function\n\
\n\
Returns current completer function.");
/* Private function to get current length of history. XXX It may be /* Private function to get current length of history. XXX It may be
* possible to replace this with a direct use of history_length instead, * possible to replace this with a direct use of history_length instead,
* but it's not clear whether BSD's libedit keeps history_length up to date. * but it's not clear whether BSD's libedit keeps history_length up to date.
@ -689,14 +776,21 @@ _py_get_history_length(void)
/* Exported function to get any element of history */ /* Exported function to get any element of history */
/*[clinic input]
readline.get_history_item
index as idx: int
/
Return the current contents of history item at index.
[clinic start generated code]*/
static PyObject * static PyObject *
get_history_item(PyObject *self, PyObject *args) readline_get_history_item_impl(PyObject *module, int idx)
/*[clinic end generated code: output=83d3e53ea5f34b3d input=63fff0c3c4323269]*/
{ {
int idx = 0;
HIST_ENTRY *hist_ent; HIST_ENTRY *hist_ent;
if (!PyArg_ParseTuple(args, "i:get_history_item", &idx))
return NULL;
if (using_libedit_emulation) { if (using_libedit_emulation) {
/* Older versions of libedit's readline emulation /* Older versions of libedit's readline emulation
* use 0-based indexes, while readline and newer * use 0-based indexes, while readline and newer
@ -723,58 +817,70 @@ get_history_item(PyObject *self, PyObject *args)
} }
} }
PyDoc_STRVAR(doc_get_history_item,
"get_history_item() -> string\n\
return the current contents of history item at index.");
/* Exported function to get current length of history */ /* Exported function to get current length of history */
/*[clinic input]
readline.get_current_history_length
Return the current (not the maximum) length of history.
[clinic start generated code]*/
static PyObject * static PyObject *
get_current_history_length(PyObject *self, PyObject *noarg) readline_get_current_history_length_impl(PyObject *module)
/*[clinic end generated code: output=436b294f12ba1e3f input=9cb3f431a68d071f]*/
{ {
return PyLong_FromLong((long)_py_get_history_length()); return PyLong_FromLong((long)_py_get_history_length());
} }
PyDoc_STRVAR(doc_get_current_history_length,
"get_current_history_length() -> integer\n\
return the current (not the maximum) length of history.");
/* Exported function to read the current line buffer */ /* Exported function to read the current line buffer */
/*[clinic input]
readline.get_line_buffer
Return the current contents of the line buffer.
[clinic start generated code]*/
static PyObject * static PyObject *
get_line_buffer(PyObject *self, PyObject *noarg) readline_get_line_buffer_impl(PyObject *module)
/*[clinic end generated code: output=d22f9025ecad80e4 input=5f5fbc0d12c69412]*/
{ {
return decode(rl_line_buffer); return decode(rl_line_buffer);
} }
PyDoc_STRVAR(doc_get_line_buffer,
"get_line_buffer() -> string\n\
return the current contents of the line buffer.");
#ifdef HAVE_RL_COMPLETION_APPEND_CHARACTER #ifdef HAVE_RL_COMPLETION_APPEND_CHARACTER
/* Exported function to clear the current history */ /* Exported function to clear the current history */
/*[clinic input]
readline.clear_history
Clear the current readline history.
[clinic start generated code]*/
static PyObject * static PyObject *
py_clear_history(PyObject *self, PyObject *noarg) readline_clear_history_impl(PyObject *module)
/*[clinic end generated code: output=1f2dbb0dfa5d5ebb input=208962c4393f5d16]*/
{ {
clear_history(); clear_history();
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_clear_history,
"clear_history() -> None\n\
Clear the current readline history.");
#endif #endif
/* Exported function to insert text into the line buffer */ /* Exported function to insert text into the line buffer */
/*[clinic input]
readline.insert_text
string: object
/
Insert text into the line buffer at the cursor position.
[clinic start generated code]*/
static PyObject * static PyObject *
insert_text(PyObject *self, PyObject *string) readline_insert_text(PyObject *module, PyObject *string)
/*[clinic end generated code: output=23d792821d320c19 input=bc96c3c848d5ccb5]*/
{ {
PyObject *encoded = encode(string); PyObject *encoded = encode(string);
if (encoded == NULL) { if (encoded == NULL) {
@ -785,77 +891,60 @@ insert_text(PyObject *self, PyObject *string)
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_insert_text,
"insert_text(string) -> None\n\
Insert text into the line buffer at the cursor position.");
/* Redisplay the line buffer */ /* Redisplay the line buffer */
/*[clinic input]
readline.redisplay
Change what's displayed on the screen to reflect contents of the line buffer.
[clinic start generated code]*/
static PyObject * static PyObject *
redisplay(PyObject *self, PyObject *noarg) readline_redisplay_impl(PyObject *module)
/*[clinic end generated code: output=a8b9725827c3c34b input=b485151058d75edc]*/
{ {
rl_redisplay(); rl_redisplay();
Py_RETURN_NONE; Py_RETURN_NONE;
} }
PyDoc_STRVAR(doc_redisplay, #include "clinic/readline.c.h"
"redisplay() -> None\n\
Change what's displayed on the screen to reflect the current\n\
contents of the line buffer.");
/* Table of functions exported by the module */ /* Table of functions exported by the module */
static struct PyMethodDef readline_methods[] = static struct PyMethodDef readline_methods[] =
{ {
{"parse_and_bind", parse_and_bind, METH_O, doc_parse_and_bind}, READLINE_PARSE_AND_BIND_METHODDEF
{"get_line_buffer", get_line_buffer, METH_NOARGS, doc_get_line_buffer}, READLINE_GET_LINE_BUFFER_METHODDEF
{"insert_text", insert_text, METH_O, doc_insert_text}, READLINE_INSERT_TEXT_METHODDEF
{"redisplay", redisplay, METH_NOARGS, doc_redisplay}, READLINE_REDISPLAY_METHODDEF
{"read_init_file", read_init_file, METH_VARARGS, doc_read_init_file}, READLINE_READ_INIT_FILE_METHODDEF
{"read_history_file", read_history_file, READLINE_READ_HISTORY_FILE_METHODDEF
METH_VARARGS, doc_read_history_file}, READLINE_WRITE_HISTORY_FILE_METHODDEF
{"write_history_file", write_history_file,
METH_VARARGS, doc_write_history_file},
#ifdef HAVE_RL_APPEND_HISTORY #ifdef HAVE_RL_APPEND_HISTORY
{"append_history_file", append_history_file, READLINE_APPEND_HISTORY_FILE_METHODDEF
METH_VARARGS, doc_append_history_file},
#endif #endif
{"get_history_item", get_history_item, READLINE_GET_HISTORY_ITEM_METHODDEF
METH_VARARGS, doc_get_history_item}, READLINE_GET_CURRENT_HISTORY_LENGTH_METHODDEF
{"get_current_history_length", (PyCFunction)get_current_history_length, READLINE_SET_HISTORY_LENGTH_METHODDEF
METH_NOARGS, doc_get_current_history_length}, READLINE_GET_HISTORY_LENGTH_METHODDEF
{"set_history_length", set_history_length, READLINE_SET_COMPLETER_METHODDEF
METH_VARARGS, set_history_length_doc}, READLINE_GET_COMPLETER_METHODDEF
{"get_history_length", get_history_length, READLINE_GET_COMPLETION_TYPE_METHODDEF
METH_NOARGS, get_history_length_doc}, READLINE_GET_BEGIDX_METHODDEF
{"set_completer", set_completer, METH_VARARGS, doc_set_completer}, READLINE_GET_ENDIDX_METHODDEF
{"get_completer", get_completer, METH_NOARGS, doc_get_completer}, READLINE_SET_COMPLETER_DELIMS_METHODDEF
{"get_completion_type", get_completion_type, READLINE_SET_AUTO_HISTORY_METHODDEF
METH_NOARGS, doc_get_completion_type}, READLINE_ADD_HISTORY_METHODDEF
{"get_begidx", get_begidx, METH_NOARGS, doc_get_begidx}, READLINE_REMOVE_HISTORY_ITEM_METHODDEF
{"get_endidx", get_endidx, METH_NOARGS, doc_get_endidx}, READLINE_REPLACE_HISTORY_ITEM_METHODDEF
READLINE_GET_COMPLETER_DELIMS_METHODDEF
{"set_completer_delims", set_completer_delims, READLINE_SET_COMPLETION_DISPLAY_MATCHES_HOOK_METHODDEF
METH_O, doc_set_completer_delims}, READLINE_SET_STARTUP_HOOK_METHODDEF
{"set_auto_history", py_set_auto_history, METH_VARARGS, doc_set_auto_history},
{"add_history", py_add_history, METH_O, doc_add_history},
{"remove_history_item", py_remove_history, METH_VARARGS, doc_remove_history},
{"replace_history_item", py_replace_history, METH_VARARGS, doc_replace_history},
{"get_completer_delims", get_completer_delims,
METH_NOARGS, doc_get_completer_delims},
{"set_completion_display_matches_hook", set_completion_display_matches_hook,
METH_VARARGS, doc_set_completion_display_matches_hook},
{"set_startup_hook", set_startup_hook,
METH_VARARGS, doc_set_startup_hook},
#ifdef HAVE_RL_PRE_INPUT_HOOK #ifdef HAVE_RL_PRE_INPUT_HOOK
{"set_pre_input_hook", set_pre_input_hook, READLINE_SET_PRE_INPUT_HOOK_METHODDEF
METH_VARARGS, doc_set_pre_input_hook},
#endif #endif
#ifdef HAVE_RL_COMPLETION_APPEND_CHARACTER #ifdef HAVE_RL_COMPLETION_APPEND_CHARACTER
{"clear_history", py_clear_history, METH_NOARGS, doc_clear_history}, READLINE_CLEAR_HISTORY_METHODDEF
#endif #endif
{0, 0} {0, 0}
}; };