keyboard.h 18.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Declarations useful when processing input.
2
   Copyright (C) 1985, 1986, 1987, 1993, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
#include "systime.h"		/* for EMACS_TIME */
21
#include "coding.h"             /* for ENCODE_UTF_8 and ENCODE_SYSTEM */
22

23 24
/* Length of echobuf field in each KBOARD.  */

25 26 27
/* Each KBOARD represents one logical input stream from which Emacs
   gets input.  If we are using ordinary terminals, it has one KBOARD
   object for each terminal device.
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
   Usually each X display screen has its own KBOARD,
   but when two of them are on the same X server,
   we assume they share a keyboard and give them one KBOARD in common.

   Some Lisp variables are per-kboard; they are stored in the KBOARD structure
   and accessed indirectly via a Lisp_Misc_Kboard_Objfwd object.

   So that definition of keyboard macros, and reading of prefix arguments,
   can happen in parallel on various KBOARDs at once,
   the state information for those activities is stored in the KBOARD.

   Emacs has two states for reading input:

   ** Any kboard.  Emacs can accept input from any KBOARD,
   and as soon as any of them provides a complete command, Emacs can run it.

   ** Single kboard.  Then Emacs is running a command for one KBOARD
   and can only read input from that KBOARD.

   All input, from all KBOARDs, goes together in a single event queue
   at interrupt level.  read_char sees the events sequentially,
   but deals with them in accord with the current input state.

   In the any-kboard state, read_key_sequence processes input from any KBOARD
   immediately.  When a new event comes in from a particular KBOARD,
   read_key_sequence switches to that KBOARD.  As a result,
   as soon as a complete key arrives from some KBOARD or other,
   Emacs starts executing that key's binding.  It switches to the
   single-kboard state for the execution of that command,
   so that that command can get input only from its own KBOARD.

   While in the single-kboard state, read_char can consider input only
   from the current KBOARD.  If events come from other KBOARDs, they
   are put aside for later in the KBOARDs' kbd_queue lists.
   The flag kbd_queue_has_data in a KBOARD is 1 if this has happened.
Pavel Janík's avatar
Pavel Janík committed
63
   When Emacs goes back to the any-kboard state, it looks at all the KBOARDs
64 65 66 67 68 69 70
   to find those; and it tries processing their input right away.  */

typedef struct kboard KBOARD;
struct kboard
  {
    KBOARD *next_kboard;

71 72 73 74 75 76 77
    /* If non-nil, a keymap that overrides all others but applies only to
       this KBOARD.  Lisp code that uses this instead of calling read-char
       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 Voverriding_terminal_local_map;

78 79 80 81
    /* Last command executed by the editor command loop, not counting
       commands that set the prefix argument.  */
    Lisp_Object Vlast_command;

82
    /* Normally same as last-command, but never modified by other commands.  */
83 84
    Lisp_Object Vreal_last_command;

85 86 87
    /* User-supplied table to translate input characters through.  */
    Lisp_Object Vkeyboard_translate_table;
    
88 89 90
    /* Last command that may be repeated by `repeat'.  */
    Lisp_Object Vlast_repeatable_command;

91 92
    /* The prefix argument for the next command, in raw form.  */
    Lisp_Object Vprefix_arg;
93 94 95

    /* Saved prefix argument for the last command, in raw form.  */
    Lisp_Object Vlast_prefix_arg;
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

    /* Unread events specific to this kboard.  */
    Lisp_Object kbd_queue;

    /* Non-nil while a kbd macro is being defined.  */
    Lisp_Object defining_kbd_macro;

    /* The start of storage for the current keyboard macro.  */
    Lisp_Object *kbd_macro_buffer;

    /* Where to store the next keystroke of the macro.  */
    Lisp_Object *kbd_macro_ptr;

    /* The finalized section of the macro starts at kbd_macro_buffer and
       ends before this.  This is not the same as kbd_macro_ptr, because
       we advance this to kbd_macro_ptr when a key's command is complete.
       This way, the keystrokes for "end-kbd-macro" are not included in the
113 114 115 116
       macro.  This also allows us to throw away the events added to the
       macro by the last command: all the events between kbd_macro_end and
       kbd_macro_ptr belong to the last command; see
       cancel-kbd-macro-events.  */
117 118 119 120 121 122 123 124
    Lisp_Object *kbd_macro_end;

    /* Allocated size of kbd_macro_buffer.  */
    int kbd_macro_bufsize;

    /* Last anonymous kbd macro defined.  */
    Lisp_Object Vlast_kbd_macro;

125 126 127
    /* Alist of system-specific X windows key symbols.  */
    Lisp_Object Vsystem_key_alist;

128 129 130
    /* Cache for modify_event_symbol.  */
    Lisp_Object system_key_syms;

131 132 133
    /* The kind of display: x, w32, ...  */
    Lisp_Object Vwindow_system;

134 135
    /* Keymap mapping keys to alternative preferred forms.
       See the DEFVAR for more documentation.  */
136
    Lisp_Object Vlocal_function_key_map;
137
    
138 139 140 141 142
    /* 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 Vinput_decode_map;
    
143 144 145
    /* Minibufferless frames on this display use this frame's minibuffer.  */
    Lisp_Object Vdefault_minibuffer_frame;

146 147 148 149 150
    /* Number of displays using this KBOARD.  Normally 1, but can be
       larger when you have multiple screens on a single X display.  */
    int reference_count;

    /* The text we're echoing in the modeline - partial key sequences,
Gerd Moellmann's avatar
Gerd Moellmann committed
151 152
       usually.  This is nil when not echoing.  */
    Lisp_Object echo_string;
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

    /* This flag indicates that events were put into kbd_queue
       while Emacs was running for some other KBOARD.
       The flag means that, when Emacs goes into the any-kboard state again,
       it should check this KBOARD to see if there is a complete command
       waiting.

       Note that the kbd_queue field can be non-nil even when
       kbd_queue_has_data is 0.  When we push back an incomplete
       command, then this flag is 0, meaning we don't want to try
       reading from this KBOARD again until more input arrives.  */
    char kbd_queue_has_data;

    /* Nonzero means echo each character as typed.  */
    char immediate_echo;

    /* If we have echoed a prompt string specified by the user,
Gerd Moellmann's avatar
Gerd Moellmann committed
170
       this is its length in characters.  Otherwise this is -1.  */
171 172 173
    char echo_after_prompt;
  };

174
/* Temporarily used before a frame has been opened. */
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
extern KBOARD *initial_kboard;

/* In the single-kboard state, this is the kboard
   from which input is accepted.

   In the any-kboard state, this is the kboard from which we are
   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;

/* Nonzero in the single-kboard state, 0 in the any-kboard state.  */
extern int single_kboard;

Jim Blandy's avatar
Jim Blandy committed
191
/* Total number of times read_char has returned.  */
192
extern int num_input_events;
Jim Blandy's avatar
Jim Blandy committed
193

194
/* Total number of times read_char has returned, outside of macros.  */
195
extern EMACS_INT num_nonmacro_input_events;
196

197
/* Nonzero means polling for input is temporarily suppressed.  */
Jim Blandy's avatar
Jim Blandy committed
198 199
extern int poll_suppress_count;

200 201 202 203 204 205
/* Vector holding the key sequence that invoked the current command.
   It is reused for each command, and it may be longer than the current
   sequence; this_command_key_count indicates how many elements
   actually mean something.  */
extern Lisp_Object this_command_keys;
extern int this_command_key_count;
206

207 208 209 210 211
/* The frame in which the last input event occurred, or Qmacro if the
   last event came from a macro.  We use this to determine when to
   generate switch-frame events.  This may be cleared by functions
   like Fselect_frame, to make sure that a switch-frame event is
   generated by the next character.  */
212
extern Lisp_Object internal_last_event_frame;
Jim Blandy's avatar
Jim Blandy committed
213

214 215 216 217 218
/* Menu items.  */

extern Lisp_Object Vlucid_menu_bar_dirty_flag;
extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

219 220 221 222 223
/* This holds a Lisp vector that holds the properties of a single
   menu item while decoding it in parse_menu_item.
   Using a Lisp vector to hold this information while we decode it
   takes care of protecting all the data from GC.  */
extern Lisp_Object item_properties;
224

225 226 227 228 229 230
/* This describes the elements of item_properties.
   The first element is not a property, it is a pointer to the item properties
   that is saved for GC protection. */
#define ITEM_PROPERTY_ITEM 0
/* The item string.  */
#define ITEM_PROPERTY_NAME 1
Pavel Janík's avatar
Pavel Janík committed
231
/* Start of initialize to nil */
232 233 234 235 236 237 238 239 240 241 242 243
/* The binding: nil, a command or a keymap.  */
#define ITEM_PROPERTY_DEF 2
/* The keymap if the binding is a keymap, otherwise nil.  */
#define ITEM_PROPERTY_MAP 3
/* Nil, :radio or :toggle.  */
#define ITEM_PROPERTY_TYPE 4
/* Nil or a string describing an equivalent key binding.  */
#define ITEM_PROPERTY_KEYEQ 5
/* Not nil if a selected toggle box or radio button, otherwise nil.  */
#define ITEM_PROPERTY_SELECTED 6
/* Place for a help string. Not yet used.  */
#define ITEM_PROPERTY_HELP 7
Pavel Janík's avatar
Pavel Janík committed
244
/* Start of initialize to t */
245 246 247
/* Last property. */
/* Not nil if item is enabled.  */
#define ITEM_PROPERTY_ENABLE 8
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308

/* This holds a Lisp vector that holds the results of decoding
   the keymaps or alist-of-alists that specify a menu.

   It describes the panes and items within the panes.

   Each pane is described by 3 elements in the vector:
   t, the pane name, the pane's prefix key.
   Then follow the pane's items, with 5 elements per item:
   the item string, the enable flag, the item's value,
   the definition, and the equivalent keyboard key's description string.

   In some cases, multiple levels of menus may be described.
   A single vector slot containing nil indicates the start of a submenu.
   A single vector slot containing lambda indicates the end of a submenu.
   The submenu follows a menu item which is the way to reach the submenu.

   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

   Using a Lisp vector to hold this information while we decode it
   takes care of protecting all the data from GC.  */
extern Lisp_Object menu_items;

/* If non-nil, means that the global vars defined here are already in use.
   Used to detect cases where we try to re-enter this non-reentrant code.  */
extern Lisp_Object menu_items_inuse;

/* Number of slots currently allocated in menu_items.  */
extern int menu_items_allocated;

/* This is the index in menu_items of the first empty slot.  */
extern int menu_items_used;

/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
extern int menu_items_n_panes;

#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3

enum menu_item_idx
{
  MENU_ITEMS_ITEM_NAME = 0,
  MENU_ITEMS_ITEM_ENABLE,
  MENU_ITEMS_ITEM_VALUE,
  MENU_ITEMS_ITEM_EQUIV_KEY,
  MENU_ITEMS_ITEM_DEFINITION,
  MENU_ITEMS_ITEM_TYPE,
  MENU_ITEMS_ITEM_SELECTED,
  MENU_ITEMS_ITEM_HELP,
  MENU_ITEMS_ITEM_LENGTH
};

extern Lisp_Object unuse_menu_items P_ ((Lisp_Object dummy));

/* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
   isn't defined.  The use of HAVE_MULTILINGUAL_MENU could probably be
   confined to an extended version of this with sections of code below
   using it unconditionally.  */
309
#ifndef HAVE_NTGUI
310
#if defined (USE_GTK) || defined (HAVE_NS)
311 312 313 314 315 316
# define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
#elif defined HAVE_X_I18N
#define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
#else
#define ENCODE_MENU_STRING(str) string_make_unibyte (str)
#endif /* USE_GTK  */
317
#else /* HAVE_NTGUI */
318 319
#define ENCODE_MENU_STRING(str) (str)
#endif
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369

#if defined (HAVE_NS) || defined (HAVE_NTGUI)

typedef void * XtPointer;
typedef unsigned char Boolean;

/* Definitions copied from lwlib.h */

enum button_type
{
  BUTTON_TYPE_NONE,
  BUTTON_TYPE_TOGGLE,
  BUTTON_TYPE_RADIO
};

/* This structure is based on the one in ../lwlib/lwlib.h, with unused portions
   removed.  No term uses these. */
typedef struct _widget_value
{
  /* name of widget */
  Lisp_Object   lname;
  char*		name;
  /* value (meaning depend on widget type) */
  char*		value;
  /* keyboard equivalent. no implications for XtTranslations */
  Lisp_Object   lkey;
  char*		key;
  /* Help string or nil if none.
     GC finds this string through the frame's menu_bar_vector
     or through menu_items.  */
  Lisp_Object	help;
  /* true if enabled */
  Boolean	enabled;
  /* true if selected */
  Boolean	selected;
  /* The type of a button.  */
  enum button_type button_type;
#if defined (HAVE_NTGUI)
  /* true if menu title */
  Boolean       title;
#endif
  /* Contents of the sub-widgets, also selected slot for checkbox */
  struct _widget_value*	contents;
  /* data passed to callback */
  XtPointer	call_data;
  /* next one in the list */
  struct _widget_value*	next;
} widget_value;
#endif

370 371 372 373 374
#if defined (HAVE_NS) || defined (HAVE_NTGUI) || defined (USE_X_TOOLKIT) || defined (USE_GTK)
extern widget_value *xmalloc_widget_value P_ ((void));
extern widget_value *digest_single_submenu P_ ((int, int, int));
#endif

375

Jim Blandy's avatar
Jim Blandy committed
376 377
/* Macros for dealing with lispy events.  */

Glenn Morris's avatar
Glenn Morris committed
378
/* True if EVENT has data fields describing it (i.e. a mouse click).  */
379
#define EVENT_HAS_PARAMETERS(event) (CONSP (event))
Jim Blandy's avatar
Jim Blandy committed
380

Jim Blandy's avatar
Jim Blandy committed
381 382
/* Extract the head from an event.
   This works on composite and simple events.  */
383
#define EVENT_HEAD(event) \
Ken Raeburn's avatar
Ken Raeburn committed
384
  (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
385

Jim Blandy's avatar
Jim Blandy committed
386
/* Extract the starting and ending positions from a composite event.  */
Ken Raeburn's avatar
Ken Raeburn committed
387 388
#define EVENT_START(event) (XCAR (XCDR (event)))
#define EVENT_END(event) (XCAR (XCDR (XCDR (event))))
389

390
/* Extract the click count from a multi-click event.  */
391
#define EVENT_CLICK_COUNT(event) (Fnth (make_number (2), (event)))
392

Jim Blandy's avatar
Jim Blandy committed
393
/* Extract the fields of a position.  */
Ken Raeburn's avatar
Ken Raeburn committed
394
#define POSN_WINDOW(posn) (XCAR (posn))
395 396
#define POSN_POSN(posn) (XCAR (XCDR (posn)))
#define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
Ken Raeburn's avatar
Ken Raeburn committed
397
#define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn))))
398
#define POSN_TIMESTAMP(posn) (XCAR (XCDR (XCDR (XCDR (posn)))))
399
#define POSN_SCROLLBAR_PART(posn)	(Fnth (make_number (4), (posn)))
Jim Blandy's avatar
Jim Blandy committed
400

Gerd Moellmann's avatar
Gerd Moellmann committed
401 402 403
/* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
   It's a cons if the click is over a string in the mode line.  */

404 405 406 407 408 409
#define POSN_STRING(posn) (Fnth (make_number (4), (posn)))

/* If POSN_STRING is nil, event refers to buffer location.  */

#define POSN_INBUFFER_P(posn) (NILP (POSN_STRING (posn)))
#define POSN_BUFFER_POSN(posn) (Fnth (make_number (5), (posn)))
Gerd Moellmann's avatar
Gerd Moellmann committed
410

Jim Blandy's avatar
Jim Blandy committed
411
/* Some of the event heads.  */
412
extern Lisp_Object Qswitch_frame;
Jim Blandy's avatar
Jim Blandy committed
413 414

/* Properties on event heads.  */
415
extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
416 417 418

/* Getting an unmodified version of an event head.  */
#define EVENT_HEAD_UNMODIFIED(event_head) \
419
  (Fcar (Fget ((event_head), Qevent_symbol_elements)))
Jim Blandy's avatar
Jim Blandy committed
420 421 422

/* The values of Qevent_kind properties.  */
extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
423
extern Lisp_Object Qscroll_bar_movement;
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429

/* Getting the kind of an event head.  */
#define EVENT_HEAD_KIND(event_head) \
  (Fget ((event_head), Qevent_kind))

/* Symbols to use for non-text mouse positions.  */
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
430
extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line;
Jim Blandy's avatar
Jim Blandy committed
431

432 433 434
/* Forward declaration for prototypes.  */
struct input_event;

435
extern Lisp_Object parse_modifiers P_ ((Lisp_Object));
436
extern Lisp_Object reorder_modifiers P_ ((Lisp_Object));
437 438
extern Lisp_Object read_char P_ ((int, int, Lisp_Object *, Lisp_Object,
				  int *, EMACS_TIME *));
439
extern int parse_solitary_modifier (Lisp_Object symbol);
Karoly Lorentey's avatar
Karoly Lorentey committed
440

Jim Blandy's avatar
Jim Blandy committed
441

442 443 444
/* Parent keymap of terminal-local function-key-map instances.  */
extern Lisp_Object Vfunction_key_map;

445
/* Keymap of key translations that can override keymaps.  */
446
extern Lisp_Object Vkey_translation_map;
447

Andreas Schwab's avatar
Andreas Schwab committed
448
extern int parse_menu_item P_ ((Lisp_Object, int, int));
449

450 451 452
extern void echo_now P_ ((void));
extern void init_kboard P_ ((KBOARD *));
extern void delete_kboard P_ ((KBOARD *));
453
extern void not_single_kboard_state P_ ((KBOARD *));
454
extern void push_kboard P_ ((struct kboard *));
455
extern void push_frame_kboard P_ ((struct frame *));
456
extern void pop_kboard P_ ((void));
457
extern void temporarily_switch_to_single_kboard P_ ((struct frame *));
458 459 460 461 462 463 464 465 466 467 468 469 470 471
extern void record_asynch_buffer_change P_ ((void));
extern SIGTYPE input_poll_signal P_ ((int));
extern void start_polling P_ ((void));
extern void stop_polling P_ ((void));
extern void set_poll_suppress_count P_ ((int));
extern void gobble_input P_ ((int));
extern int input_polling_used P_ ((void));
extern void clear_input_pending P_ ((void));
extern int requeued_events_pending_p P_ ((void));
extern void bind_polling_period P_ ((int));
extern void stuff_buffered_input P_ ((Lisp_Object));
extern void clear_waiting_for_input P_ ((void));
extern void swallow_events P_ ((int));
extern int help_char_p P_ ((Lisp_Object));
472
extern void quit_throw_to_read_char P_ ((void)) NO_RETURN;
473 474 475
extern void cmd_error_internal P_ ((Lisp_Object, char *));
extern int lucid_event_type_list_p P_ ((Lisp_Object));
extern void kbd_buffer_store_event P_ ((struct input_event *));
476 477
extern void kbd_buffer_store_event_hold P_ ((struct input_event *,
					     struct input_event *));
478
extern void kbd_buffer_unget_event P_ ((struct input_event *));
Dave Love's avatar
Dave Love committed
479 480 481
#ifdef POLL_FOR_INPUT
extern void poll_for_input_1 P_ ((void));
#endif
482 483
extern void show_help_echo P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				Lisp_Object, int));
484 485
extern void gen_help_event P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
			       Lisp_Object, int));
486
extern void kbd_buffer_store_help_event P_ ((Lisp_Object, Lisp_Object));
487
extern Lisp_Object menu_item_eval_property P_ ((Lisp_Object));
488
extern int  kbd_buffer_events_waiting P_ ((int));
489
extern void add_user_signals P_ ((int, const char *));
Miles Bader's avatar
Miles Bader committed
490

491
extern int tty_read_avail_input P_ ((struct terminal *, int,
492
                                     struct input_event *));
493

Miles Bader's avatar
Miles Bader committed
494 495
/* arch-tag: 769cbade-1ba9-4950-b886-db265b061aa3
   (do not change this comment) */