X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/257210319f10abebbfd7c12784cf3a8e112c3562..a5128e3ded506a54619177d9a7c95d58463baace:/src/keyboard.h diff --git a/src/keyboard.h b/src/keyboard.h index 752064a612..8bb54dd86e 100644 --- a/src/keyboard.h +++ b/src/keyboard.h @@ -1,5 +1,6 @@ /* Declarations useful when processing input. - Copyright (C) 1985-1987, 1993, 2001-2012 Free Software Foundation, Inc. + Copyright (C) 1985-1987, 1993, 2001-2014 Free Software Foundation, + Inc. This file is part of GNU Emacs. @@ -16,17 +17,15 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Emacs. If not, see . */ -#include "systime.h" /* for EMACS_TIME, Time */ +#include "systime.h" /* for struct timespec, Time */ #include "coding.h" /* for ENCODE_UTF_8 and ENCODE_SYSTEM */ +#include "termhooks.h" -/* Lisp fields in struct keyboard are hidden from most code and accessed - via the KVAR macro, below. Only select pieces of code, like the GC, - are allowed to use KBOARD_INTERNAL_FIELD. */ -#define KBOARD_INTERNAL_FIELD(field) field ## _ +INLINE_HEADER_BEGIN -/* Most code should use this macro to access Lisp fields in struct - kboard. */ -#define KVAR(kboard, field) ((kboard)->KBOARD_INTERNAL_FIELD (field)) +/* Most code should use this macro to access Lisp fields in struct kboard. */ + +#define KVAR(kboard, field) ((kboard)->INTERNAL_FIELD (field)) /* Each KBOARD represents one logical input stream from which Emacs gets input. If we are using ordinary terminals, it has one KBOARD @@ -79,32 +78,32 @@ struct kboard can effectively wait for input in the any-kboard state, and hence avoid blocking out the other KBOARDs. See universal-argument in lisp/simple.el for an example. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Voverriding_terminal_local_map); + Lisp_Object INTERNAL_FIELD (Voverriding_terminal_local_map); /* Last command executed by the editor command loop, not counting commands that set the prefix argument. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_command); + Lisp_Object INTERNAL_FIELD (Vlast_command); /* Normally same as last-command, but never modified by other commands. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vreal_last_command); + Lisp_Object INTERNAL_FIELD (Vreal_last_command); /* User-supplied table to translate input characters through. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vkeyboard_translate_table); + Lisp_Object INTERNAL_FIELD (Vkeyboard_translate_table); /* Last command that may be repeated by `repeat'. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_repeatable_command); + Lisp_Object INTERNAL_FIELD (Vlast_repeatable_command); /* The prefix argument for the next command, in raw form. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vprefix_arg); + Lisp_Object INTERNAL_FIELD (Vprefix_arg); /* Saved prefix argument for the last command, in raw form. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_prefix_arg); + Lisp_Object INTERNAL_FIELD (Vlast_prefix_arg); /* Unread events specific to this kboard. */ - Lisp_Object KBOARD_INTERNAL_FIELD (kbd_queue); + Lisp_Object INTERNAL_FIELD (kbd_queue); /* Non-nil while a kbd macro is being defined. */ - Lisp_Object KBOARD_INTERNAL_FIELD (defining_kbd_macro); + Lisp_Object INTERNAL_FIELD (defining_kbd_macro); /* The start of storage for the current keyboard macro. */ Lisp_Object *kbd_macro_buffer; @@ -126,28 +125,28 @@ struct kboard ptrdiff_t kbd_macro_bufsize; /* Last anonymous kbd macro defined. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_kbd_macro); + Lisp_Object INTERNAL_FIELD (Vlast_kbd_macro); /* Alist of system-specific X windows key symbols. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vsystem_key_alist); + Lisp_Object INTERNAL_FIELD (Vsystem_key_alist); /* Cache for modify_event_symbol. */ - Lisp_Object KBOARD_INTERNAL_FIELD (system_key_syms); + Lisp_Object INTERNAL_FIELD (system_key_syms); /* The kind of display: x, w32, ... */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vwindow_system); + Lisp_Object INTERNAL_FIELD (Vwindow_system); /* Keymap mapping keys to alternative preferred forms. See the DEFVAR for more documentation. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vlocal_function_key_map); + Lisp_Object INTERNAL_FIELD (Vlocal_function_key_map); /* Keymap mapping ASCII function key sequences onto their preferred forms. Initialized by the terminal-specific lisp files. See the DEFVAR for more documentation. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vinput_decode_map); + Lisp_Object INTERNAL_FIELD (Vinput_decode_map); /* Minibufferless frames on this display use this frame's minibuffer. */ - Lisp_Object KBOARD_INTERNAL_FIELD (Vdefault_minibuffer_frame); + Lisp_Object INTERNAL_FIELD (Vdefault_minibuffer_frame); /* Number of displays using this KBOARD. Normally 1, but can be larger when you have multiple screens on a single X display. */ @@ -155,7 +154,7 @@ struct kboard /* The text we're echoing in the modeline - partial key sequences, usually. This is nil when not echoing. */ - Lisp_Object KBOARD_INTERNAL_FIELD (echo_string); + Lisp_Object INTERNAL_FIELD (echo_string); /* This flag indicates that events were put into kbd_queue while Emacs was running for some other KBOARD. @@ -169,14 +168,55 @@ struct kboard reading from this KBOARD again until more input arrives. */ char kbd_queue_has_data; - /* Nonzero means echo each character as typed. */ - char immediate_echo; + /* True means echo each character as typed. */ + bool_bf immediate_echo : 1; /* If we have echoed a prompt string specified by the user, this is its length in characters. Otherwise this is -1. */ - char echo_after_prompt; + ptrdiff_t echo_after_prompt; }; +INLINE void +kset_default_minibuffer_frame (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vdefault_minibuffer_frame) = val; +} +INLINE void +kset_defining_kbd_macro (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (defining_kbd_macro) = val; +} +INLINE void +kset_input_decode_map (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vinput_decode_map) = val; +} +INLINE void +kset_last_command (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vlast_command) = val; +} +INLINE void +kset_last_kbd_macro (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vlast_kbd_macro) = val; +} +INLINE void +kset_prefix_arg (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vprefix_arg) = val; +} +INLINE void +kset_system_key_alist (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vsystem_key_alist) = val; +} +INLINE void +kset_window_system (struct kboard *kb, Lisp_Object val) +{ + kb->INTERNAL_FIELD (Vwindow_system) = val; +} + /* Temporarily used before a frame has been opened. */ extern KBOARD *initial_kboard; @@ -187,9 +227,6 @@ extern KBOARD *initial_kboard; right now considering input. We can consider input from another kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */ extern KBOARD *current_kboard; - -/* A list of all kboard objects, linked through next_kboard. */ -extern KBOARD *all_kboards; /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */ extern uintmax_t num_input_events; @@ -299,7 +336,7 @@ enum menu_item_idx MENU_ITEMS_ITEM_LENGTH }; -extern Lisp_Object unuse_menu_items (Lisp_Object dummy); +extern void unuse_menu_items (void); /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be @@ -379,18 +416,18 @@ typedef struct _widget_value (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event)) /* Extract the starting and ending positions from a composite event. */ -#define EVENT_START(event) (XCAR (XCDR (event))) -#define EVENT_END(event) (XCAR (XCDR (XCDR (event)))) +#define EVENT_START(event) (CAR_SAFE (CDR_SAFE (event))) +#define EVENT_END(event) (CAR_SAFE (CDR_SAFE (CDR_SAFE (event)))) /* Extract the click count from a multi-click event. */ #define EVENT_CLICK_COUNT(event) (Fnth (make_number (2), (event))) /* Extract the fields of a position. */ -#define POSN_WINDOW(posn) (XCAR (posn)) -#define POSN_POSN(posn) (XCAR (XCDR (posn))) +#define POSN_WINDOW(posn) (CAR_SAFE (posn)) +#define POSN_POSN(posn) (CAR_SAFE (CDR_SAFE (posn))) #define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x))) -#define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn)))) -#define POSN_TIMESTAMP(posn) (XCAR (XCDR (XCDR (XCDR (posn))))) +#define POSN_WINDOW_POSN(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (posn)))) +#define POSN_TIMESTAMP(posn) (CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (posn))))) #define POSN_SCROLLBAR_PART(posn) (Fnth (make_number (4), (posn))) /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events. @@ -420,28 +457,26 @@ extern Lisp_Object Qhelp_echo; /* Symbols to use for non-text mouse positions. */ extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line; +extern Lisp_Object Qright_divider, Qbottom_divider; /* True while doing kbd input. */ -extern int waiting_for_input; +extern bool waiting_for_input; -/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt +/* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt happens. */ -extern EMACS_TIME *input_available_clear_time; +extern struct timespec *input_available_clear_time; #if defined HAVE_WINDOW_SYSTEM && !defined USE_GTK && !defined HAVE_NS -extern int ignore_mouse_drag_p; +extern bool ignore_mouse_drag_p; #endif /* The primary selection. */ extern Lisp_Object QPRIMARY; -/* Forward declaration for prototypes. */ -struct input_event; - extern Lisp_Object parse_modifiers (Lisp_Object); extern Lisp_Object reorder_modifiers (Lisp_Object); -extern Lisp_Object read_char (int, ptrdiff_t, Lisp_Object *, Lisp_Object, - int *, EMACS_TIME *); +extern Lisp_Object read_char (int, Lisp_Object, Lisp_Object, + bool *, struct timespec *); extern int parse_solitary_modifier (Lisp_Object symbol); @@ -459,18 +494,14 @@ extern Lisp_Object QCtoggle, QCradio; speed up parse_modifiers. */ extern Lisp_Object Qevent_symbol_element_mask; -/* The timestamp of the last input event we received from the X server. - X Windows wants this for selection ownership. */ -extern Time last_event_timestamp; - extern int quit_char; -extern int timers_run; +extern unsigned int timers_run; -extern int menu_separator_name_p (const char *); -extern int parse_menu_item (Lisp_Object, int); +extern bool menu_separator_name_p (const char *); +extern bool parse_menu_item (Lisp_Object, int); -extern void init_kboard (KBOARD *); +extern KBOARD *allocate_kboard (Lisp_Object); extern void delete_kboard (KBOARD *); extern void not_single_kboard_state (KBOARD *); extern void push_kboard (struct kboard *); @@ -482,16 +513,18 @@ extern void input_poll_signal (int); extern void start_polling (void); extern void stop_polling (void); extern void set_poll_suppress_count (int); -extern void gobble_input (int); -extern int input_polling_used (void); +extern int gobble_input (void); +extern bool input_polling_used (void); extern void clear_input_pending (void); -extern int requeued_events_pending_p (void); +extern bool requeued_events_pending_p (void); extern void bind_polling_period (int); +#if HAVE_NTGUI extern int make_ctrl_char (int) ATTRIBUTE_CONST; +#endif extern void stuff_buffered_input (Lisp_Object); extern void clear_waiting_for_input (void); -extern void swallow_events (int); -extern int lucid_event_type_list_p (Lisp_Object); +extern void swallow_events (bool); +extern bool lucid_event_type_list_p (Lisp_Object); extern void kbd_buffer_store_event (struct input_event *); extern void kbd_buffer_store_event_hold (struct input_event *, struct input_event *); @@ -503,14 +536,15 @@ extern void gen_help_event (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, ptrdiff_t); extern void kbd_buffer_store_help_event (Lisp_Object, Lisp_Object); extern Lisp_Object menu_item_eval_property (Lisp_Object); -extern int kbd_buffer_events_waiting (int); +extern bool kbd_buffer_events_waiting (void); extern void add_user_signal (int, const char *); -extern int tty_read_avail_input (struct terminal *, int, - struct input_event *); -extern EMACS_TIME timer_check (void); +extern int tty_read_avail_input (struct terminal *, struct input_event *); +extern struct timespec timer_check (void); extern void mark_kboards (void); -#ifdef WINDOWSNT +#ifdef HAVE_NTGUI extern const char *const lispy_function_keys[]; #endif + +INLINE_HEADER_END