xemacs-beta: lisp/keymap.el comparison

comparison lisp/keymap.el @ 5745:f9e4d44504a4

Document #'events-to-keys some more, use it less. lisp/ChangeLog addition: 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * minibuf.el (get-user-response): * cmdloop.el (y-or-n-p-minibuf): No need to call #'events-to-keys in these two functions, #'lookup-key accepts events directly. * keymap.el: * keymap.el (events-to-keys): Document this function some more. Stop passing strings through unexamined, treat them as vectors of characters. Event keys are never integers, remove some code that only ran if (integerp (event-key ce)). Event keys are never numbers, don't check for that. Don't create (menu-selection call-interactively function-name) keystrokes for menu choices, #'character-to-event doesn't understand that syntax, so nothing uses it. Don't ever accept mouse events, #'character-to-event doesn't accept our synthesising of them. src/ChangeLog addition: 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * keymap.c: * keymap.c (key_desc_list_to_event): Drop the allow_menu_events argument. Don't accept lists starting with Qmenu_selection as describing keys, nothing generates them in a way this function understands. The intention is reasonable but the implementation was never documented and never finished. * keymap.c (syms_of_keymap): Drop Qmenu_selection. * events.c (Fcharacter_to_event): * keymap.h: Drop the allow_menu_events argument to key_desc_list_to_event.

author	Aidan Kehoe <kehoea@parhasard.net>
date	Wed, 10 Jul 2013 14:14:30 +0100
parents	071b810ceb18
children	0e9f791cc655

comparison

equal deleted inserted replaced

-:f6af091ac654
+:f9e4d44504a4
 (set mapvar map)))
 name))
 ;;; Converting vectors of events to a read-equivalent form.
-;;; This is used both by call-interactively (for the command history)
-;;; and by macros.el (for saving keyboard macros to a file).
-;; #### why does (events-to-keys [backspace]) return "\C-h"?
-;; BTW, this function is a mess, and macros.el does *not* use it, in
-;; spite of the above comment.  `format-kbd-macro' is used to save
-;; keyboard macros to a file.
 (defun events-to-keys (events &optional no-mice)
-"Given a vector of event objects, returns a vector of key descriptors,
+"Given a vector of event objects, return a vector of key descriptors.
-or a string (if they all fit in the ASCII range).
-Optional arg NO-MICE means that button events are not allowed."
+If all events can be represented unambiguously as characters, return a
+string.  Both the string and the vector will be equivalent to the events, if
+the elements are passed to `character-to-event'.
+If an event represents a key press of a printable ASCII character between ?@
+and ?_, with the control modifier and only the control modifier, it is
+returned as a character between ?\x00 and ?\x1f, inclusive. ?\\C-i, ?\\C-j,
+?\\C-m are returned as the symbols `tab', `linefeed' and `return',
+respectively.
+There is a similar equivalence between ASCII characters with the meta
+modifier and Latin 1 characters, but this function does not use that
+equivalence.
+Obsolete optional argument NO-MICE means that mouse events are not allowed.
+These are actually never allowed, since `character-to-event' never accepts
+them.
+EVENTS can be a string, and will be treated as a vector of the events
+corresponding to those characters."
+;; This is only used in packages. There were some contexts where it was
+;; used in core, but those dated from before #'lookup-key accepted events
+;; in KEYS; it conses less and is more accurate to use the events directly,
+;; rather than calling this function. It'd be nice to move this to
+;; xemacs-base and add an autoload, there's no need for it to be dumped.
 (if (and events (symbolp events)) (setq events (vector events)))
-(cond ((stringp events)
+(check-type events array)
-events)
+(cond ((let* ((length (length events))
-((not (vectorp events))
-(signal 'wrong-type-argument (list 'vectorp events)))
-((let* ((length (length events))
 (string (make-string length 0))
 c ce
 (i 0))
 (while (< i length)
 (setq ce (aref events i))
 (or (eventp ce) (setq ce (character-to-event ce)))
-;; Normalize `c' to `?c' and `(control k)' to `?\C-k'
+;; Normalize `c' to `?c' and `(control k)' to `?\C-k' We don't
-;; By passing t for the `allow-meta' arg we could get kbd macros
+;; "normalize" Latin 1 to the corresponding meta characters, or
-;; with meta in them to translate to the string form instead of
+;; vice-versa.
-;; the list/symbol form; but I expect that would cause confusion,
-;; so let's use the list/symbol form whenever there's
-;; any ambiguity.
 (setq c (event-to-character ce))
 (if (and c
 (key-press-event-p ce))
-(cond ((symbolp (event-key ce))
+(if (symbolp (event-key ce))
 (if (get (event-key ce) 'character-of-keysym)
-;; Don't use a string for `backspace' and `tab' to
+;; Don't use a string `tab' to avoid that unpleasant
-;;  avoid that unpleasant little ambiguity.
+;; little ambiguity.
-(setq c nil)))
+(setq c nil))))
-((and (= (event-modifier-bits ce) 1) ;control
-(integerp (event-key ce)))
-(let* ((te (character-to-event c)))
-(if (and (symbolp (event-key te))
-(get (event-key te) 'character-of-keysym))
-;; Don't "normalize" (control i) to tab
-;;  to avoid the ambiguity in the other direction
-(setq c nil))
-(deallocate-event te)))))
 (if c
 (aset string i c)
 (setq i length string nil))
 (setq i (1+ i)))
 string))
 (t
 (let* ((length (length events))
-(new (copy-sequence events))
+(new (vconcat events nil))
 event mods key
 (i 0))
 (while (< i length)
 (setq event (aref events i))
+(or (eventp event) (setq event (character-to-event event)))
 (cond ((key-press-event-p event)
 (setq mods (event-modifiers event)
 key (event-key event))
-(if (numberp key)
-(setq key (intern (make-string 1 key))))
-(aset new i (if mods
-(nconc mods (cons key nil))
-key)))
-((misc-user-event-p event)
-(aset new i (list 'menu-selection
-(event-function event)
-(event-object event))))
-((or (button-press-event-p event)
-(button-release-event-p event))
-(if no-mice
-(error
-"Mouse events can't be saved in keyboard macros."))
-(setq mods (event-modifiers event)
-key (intern (format "button%d%s"
-(event-button event)
-(if (button-release-event-p event)
-"up" ""))))
 (aset new i (if mods
 (nconc mods (cons key nil))
 key)))
 ((or (and event (symbolp event))
 (and (consp event) (symbolp (car event))))
 (aset new i event))
 (t
-(signal 'wrong-type-argument (list 'eventp event))))
+(signal 'wrong-type-argument
+(list 'key-press-event-p event))))
 (setq i (1+ i)))
 new))))
 (defun next-key-event ()
 "Return the next available keyboard event."
 (let (event)
 (while (not (key-press-event-p (setq event (next-command-event))))

Mercurial > hg > xemacs-beta

comparison lisp/keymap.el @ 5745:f9e4d44504a4