aboutsummaryrefslogtreecommitdiffstats
path: root/src/lread.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/lread.c')
-rw-r--r--src/lread.c20
1 files changed, 14 insertions, 6 deletions
diff --git a/src/lread.c b/src/lread.c
index e43929a8c6a..73e38d89954 100644
--- a/src/lread.c
+++ b/src/lread.c
@@ -741,10 +741,14 @@ read_filtered_event (bool no_switch_frame, bool ascii_required,
741} 741}
742 742
743DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0, 743DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
744 doc: /* Read a character from the command input (keyboard or macro). 744 doc: /* Read a character event from the command input (keyboard or macro).
745It is returned as a number. 745It is returned as a number.
746If the character has modifiers, they are resolved and reflected to the 746If the event has modifiers, they are resolved and reflected in the
747character code if possible (e.g. C-SPC -> 0). 747returned character code if possible (e.g. C-SPC yields 0 and C-a yields 97).
748If some of the modifiers cannot be reflected in the character code, the
749returned value will include those modifiers, and will not be a valid
750character code: it will fail the `characterp' test. Use `event-basic-type'
751to recover the character code with the modifiers removed.
748 752
749If the user generates an event which is not a character (i.e. a mouse 753If the user generates an event which is not a character (i.e. a mouse
750click or function key event), `read-char' signals an error. As an 754click or function key event), `read-char' signals an error. As an
@@ -791,10 +795,14 @@ floating-point value. */)
791} 795}
792 796
793DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0, 797DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
794 doc: /* Read a character from the command input (keyboard or macro). 798 doc: /* Read a character event from the command input (keyboard or macro).
795It is returned as a number. Non-character events are ignored. 799It is returned as a number. Non-character events are ignored.
796If the character has modifiers, they are resolved and reflected to the 800If the event has modifiers, they are resolved and reflected in the
797character code if possible (e.g. C-SPC -> 0). 801returned character code if possible (e.g. C-SPC yields 0 and C-a yields 97).
802If some of the modifiers cannot be reflected in the character code, the
803returned value will include those modifiers, and will not be a valid
804character code: it will fail the `characterp' test. Use `event-basic-type'
805to recover the character code with the modifiers removed.
798 806
799If the optional argument PROMPT is non-nil, display that as a prompt. 807If the optional argument PROMPT is non-nil, display that as a prompt.
800If the optional argument INHERIT-INPUT-METHOD is non-nil and some 808If the optional argument INHERIT-INPUT-METHOD is non-nil and some