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 d5ba48a170d..2e5cba510c5 100644
--- a/src/lread.c
+++ b/src/lread.c
@@ -735,10 +735,14 @@ read_filtered_event (bool no_switch_frame, bool ascii_required,
735} 735}
736 736
737DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0, 737DEFUN ("read-char", Fread_char, Sread_char, 0, 3, 0,
738 doc: /* Read a character from the command input (keyboard or macro). 738 doc: /* Read a character event from the command input (keyboard or macro).
739It is returned as a number. 739It is returned as a number.
740If the character has modifiers, they are resolved and reflected to the 740If the event has modifiers, they are resolved and reflected in the
741character code if possible (e.g. C-SPC -> 0). 741returned character code if possible (e.g. C-SPC yields 0 and C-a yields 97).
742If some of the modifiers cannot be reflected in the character code, the
743returned value will include those modifiers, and will not be a valid
744character code: it will fail the `characterp' test. Use `event-basic-type'
745to recover the character code with the modifiers removed.
742 746
743If the user generates an event which is not a character (i.e. a mouse 747If the user generates an event which is not a character (i.e. a mouse
744click or function key event), `read-char' signals an error. As an 748click or function key event), `read-char' signals an error. As an
@@ -785,10 +789,14 @@ floating-point value. */)
785} 789}
786 790
787DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0, 791DEFUN ("read-char-exclusive", Fread_char_exclusive, Sread_char_exclusive, 0, 3, 0,
788 doc: /* Read a character from the command input (keyboard or macro). 792 doc: /* Read a character event from the command input (keyboard or macro).
789It is returned as a number. Non-character events are ignored. 793It is returned as a number. Non-character events are ignored.
790If the character has modifiers, they are resolved and reflected to the 794If the event has modifiers, they are resolved and reflected in the
791character code if possible (e.g. C-SPC -> 0). 795returned character code if possible (e.g. C-SPC yields 0 and C-a yields 97).
796If some of the modifiers cannot be reflected in the character code, the
797returned value will include those modifiers, and will not be a valid
798character code: it will fail the `characterp' test. Use `event-basic-type'
799to recover the character code with the modifiers removed.
792 800
793If the optional argument PROMPT is non-nil, display that as a prompt. 801If the optional argument PROMPT is non-nil, display that as a prompt.
794If the optional argument INHERIT-INPUT-METHOD is non-nil and some 802If the optional argument INHERIT-INPUT-METHOD is non-nil and some