src/gnutls.c: Doc fixes. Make some functions static.
[emacs.git] / src / keyboard.h
blob9fd3b48eba943acca531cfd2b2f25c6db146b2ed
1 /* Declarations useful when processing input.
2 Copyright (C) 1985, 1986, 1987, 1993, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 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/>. */
20 #include "systime.h" /* for EMACS_TIME */
21 #include "coding.h" /* for ENCODE_UTF_8 and ENCODE_SYSTEM */
23 /* Length of echobuf field in each KBOARD. */
25 /* Each KBOARD represents one logical input stream from which Emacs
26 gets input. If we are using ordinary terminals, it has one KBOARD
27 object for each terminal device.
28 Usually each X display screen has its own KBOARD,
29 but when two of them are on the same X server,
30 we assume they share a keyboard and give them one KBOARD in common.
32 Some Lisp variables are per-kboard; they are stored in the KBOARD structure
33 and accessed indirectly via a Lisp_Misc_Kboard_Objfwd object.
35 So that definition of keyboard macros, and reading of prefix arguments,
36 can happen in parallel on various KBOARDs at once,
37 the state information for those activities is stored in the KBOARD.
39 Emacs has two states for reading input:
41 ** Any kboard. Emacs can accept input from any KBOARD,
42 and as soon as any of them provides a complete command, Emacs can run it.
44 ** Single kboard. Then Emacs is running a command for one KBOARD
45 and can only read input from that KBOARD.
47 All input, from all KBOARDs, goes together in a single event queue
48 at interrupt level. read_char sees the events sequentially,
49 but deals with them in accord with the current input state.
51 In the any-kboard state, read_key_sequence processes input from any KBOARD
52 immediately. When a new event comes in from a particular KBOARD,
53 read_key_sequence switches to that KBOARD. As a result,
54 as soon as a complete key arrives from some KBOARD or other,
55 Emacs starts executing that key's binding. It switches to the
56 single-kboard state for the execution of that command,
57 so that that command can get input only from its own KBOARD.
59 While in the single-kboard state, read_char can consider input only
60 from the current KBOARD. If events come from other KBOARDs, they
61 are put aside for later in the KBOARDs' kbd_queue lists.
62 The flag kbd_queue_has_data in a KBOARD is 1 if this has happened.
63 When Emacs goes back to the any-kboard state, it looks at all the KBOARDs
64 to find those; and it tries processing their input right away. */
66 typedef struct kboard KBOARD;
67 struct kboard
69 KBOARD *next_kboard;
71 /* If non-nil, a keymap that overrides all others but applies only to
72 this KBOARD. Lisp code that uses this instead of calling read-char
73 can effectively wait for input in the any-kboard state, and hence
74 avoid blocking out the other KBOARDs. See universal-argument in
75 lisp/simple.el for an example. */
76 Lisp_Object Voverriding_terminal_local_map;
78 /* Last command executed by the editor command loop, not counting
79 commands that set the prefix argument. */
80 Lisp_Object Vlast_command;
82 /* Normally same as last-command, but never modified by other commands. */
83 Lisp_Object Vreal_last_command;
85 /* User-supplied table to translate input characters through. */
86 Lisp_Object Vkeyboard_translate_table;
88 /* Last command that may be repeated by `repeat'. */
89 Lisp_Object Vlast_repeatable_command;
91 /* The prefix argument for the next command, in raw form. */
92 Lisp_Object Vprefix_arg;
94 /* Saved prefix argument for the last command, in raw form. */
95 Lisp_Object Vlast_prefix_arg;
97 /* Unread events specific to this kboard. */
98 Lisp_Object kbd_queue;
100 /* Non-nil while a kbd macro is being defined. */
101 Lisp_Object defining_kbd_macro;
103 /* The start of storage for the current keyboard macro. */
104 Lisp_Object *kbd_macro_buffer;
106 /* Where to store the next keystroke of the macro. */
107 Lisp_Object *kbd_macro_ptr;
109 /* The finalized section of the macro starts at kbd_macro_buffer and
110 ends before this. This is not the same as kbd_macro_ptr, because
111 we advance this to kbd_macro_ptr when a key's command is complete.
112 This way, the keystrokes for "end-kbd-macro" are not included in the
113 macro. This also allows us to throw away the events added to the
114 macro by the last command: all the events between kbd_macro_end and
115 kbd_macro_ptr belong to the last command; see
116 cancel-kbd-macro-events. */
117 Lisp_Object *kbd_macro_end;
119 /* Allocated size of kbd_macro_buffer. */
120 int kbd_macro_bufsize;
122 /* Last anonymous kbd macro defined. */
123 Lisp_Object Vlast_kbd_macro;
125 /* Alist of system-specific X windows key symbols. */
126 Lisp_Object Vsystem_key_alist;
128 /* Cache for modify_event_symbol. */
129 Lisp_Object system_key_syms;
131 /* The kind of display: x, w32, ... */
132 Lisp_Object Vwindow_system;
134 /* Keymap mapping keys to alternative preferred forms.
135 See the DEFVAR for more documentation. */
136 Lisp_Object Vlocal_function_key_map;
138 /* Keymap mapping ASCII function key sequences onto their preferred
139 forms. Initialized by the terminal-specific lisp files. See the
140 DEFVAR for more documentation. */
141 Lisp_Object Vinput_decode_map;
143 /* Minibufferless frames on this display use this frame's minibuffer. */
144 Lisp_Object Vdefault_minibuffer_frame;
146 /* Number of displays using this KBOARD. Normally 1, but can be
147 larger when you have multiple screens on a single X display. */
148 int reference_count;
150 /* The text we're echoing in the modeline - partial key sequences,
151 usually. This is nil when not echoing. */
152 Lisp_Object echo_string;
154 /* This flag indicates that events were put into kbd_queue
155 while Emacs was running for some other KBOARD.
156 The flag means that, when Emacs goes into the any-kboard state again,
157 it should check this KBOARD to see if there is a complete command
158 waiting.
160 Note that the kbd_queue field can be non-nil even when
161 kbd_queue_has_data is 0. When we push back an incomplete
162 command, then this flag is 0, meaning we don't want to try
163 reading from this KBOARD again until more input arrives. */
164 char kbd_queue_has_data;
166 /* Nonzero means echo each character as typed. */
167 char immediate_echo;
169 /* If we have echoed a prompt string specified by the user,
170 this is its length in characters. Otherwise this is -1. */
171 char echo_after_prompt;
174 /* Temporarily used before a frame has been opened. */
175 extern KBOARD *initial_kboard;
177 /* In the single-kboard state, this is the kboard
178 from which input is accepted.
180 In the any-kboard state, this is the kboard from which we are
181 right now considering input. We can consider input from another
182 kboard, but doing so requires throwing to wrong_kboard_jmpbuf. */
183 extern KBOARD *current_kboard;
185 /* A list of all kboard objects, linked through next_kboard. */
186 extern KBOARD *all_kboards;
188 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
189 extern int single_kboard;
191 /* Total number of times read_char has returned. */
192 extern int num_input_events;
194 /* Total number of times read_char has returned, outside of macros. */
195 extern EMACS_INT num_nonmacro_input_events;
197 /* Nonzero means polling for input is temporarily suppressed. */
198 extern int poll_suppress_count;
200 /* Vector holding the key sequence that invoked the current command.
201 It is reused for each command, and it may be longer than the current
202 sequence; this_command_key_count indicates how many elements
203 actually mean something. */
204 extern Lisp_Object this_command_keys;
205 extern int this_command_key_count;
207 /* The frame in which the last input event occurred, or Qmacro if the
208 last event came from a macro. We use this to determine when to
209 generate switch-frame events. This may be cleared by functions
210 like Fselect_frame, to make sure that a switch-frame event is
211 generated by the next character. */
212 extern Lisp_Object internal_last_event_frame;
214 /* Menu items. */
216 extern Lisp_Object Vlucid_menu_bar_dirty_flag;
217 extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
219 /* This holds a Lisp vector that holds the properties of a single
220 menu item while decoding it in parse_menu_item.
221 Using a Lisp vector to hold this information while we decode it
222 takes care of protecting all the data from GC. */
223 extern Lisp_Object item_properties;
225 /* This describes the elements of item_properties.
226 The first element is not a property, it is a pointer to the item properties
227 that is saved for GC protection. */
228 #define ITEM_PROPERTY_ITEM 0
229 /* The item string. */
230 #define ITEM_PROPERTY_NAME 1
231 /* Start of initialize to nil */
232 /* The binding: nil, a command or a keymap. */
233 #define ITEM_PROPERTY_DEF 2
234 /* The keymap if the binding is a keymap, otherwise nil. */
235 #define ITEM_PROPERTY_MAP 3
236 /* Nil, :radio or :toggle. */
237 #define ITEM_PROPERTY_TYPE 4
238 /* Nil or a string describing an equivalent key binding. */
239 #define ITEM_PROPERTY_KEYEQ 5
240 /* Not nil if a selected toggle box or radio button, otherwise nil. */
241 #define ITEM_PROPERTY_SELECTED 6
242 /* Place for a help string. Not yet used. */
243 #define ITEM_PROPERTY_HELP 7
244 /* Start of initialize to t */
245 /* Last property. */
246 /* Not nil if item is enabled. */
247 #define ITEM_PROPERTY_ENABLE 8
249 /* This holds a Lisp vector that holds the results of decoding
250 the keymaps or alist-of-alists that specify a menu.
252 It describes the panes and items within the panes.
254 Each pane is described by 3 elements in the vector:
255 t, the pane name, the pane's prefix key.
256 Then follow the pane's items, with 5 elements per item:
257 the item string, the enable flag, the item's value,
258 the definition, and the equivalent keyboard key's description string.
260 In some cases, multiple levels of menus may be described.
261 A single vector slot containing nil indicates the start of a submenu.
262 A single vector slot containing lambda indicates the end of a submenu.
263 The submenu follows a menu item which is the way to reach the submenu.
265 A single vector slot containing quote indicates that the
266 following items should appear on the right of a dialog box.
268 Using a Lisp vector to hold this information while we decode it
269 takes care of protecting all the data from GC. */
270 extern Lisp_Object menu_items;
272 /* If non-nil, means that the global vars defined here are already in use.
273 Used to detect cases where we try to re-enter this non-reentrant code. */
274 extern Lisp_Object menu_items_inuse;
276 /* Number of slots currently allocated in menu_items. */
277 extern int menu_items_allocated;
279 /* This is the index in menu_items of the first empty slot. */
280 extern int menu_items_used;
282 /* The number of panes currently recorded in menu_items,
283 excluding those within submenus. */
284 extern int menu_items_n_panes;
286 #define MENU_ITEMS_PANE_NAME 1
287 #define MENU_ITEMS_PANE_PREFIX 2
288 #define MENU_ITEMS_PANE_LENGTH 3
290 enum menu_item_idx
292 MENU_ITEMS_ITEM_NAME = 0,
293 MENU_ITEMS_ITEM_ENABLE,
294 MENU_ITEMS_ITEM_VALUE,
295 MENU_ITEMS_ITEM_EQUIV_KEY,
296 MENU_ITEMS_ITEM_DEFINITION,
297 MENU_ITEMS_ITEM_TYPE,
298 MENU_ITEMS_ITEM_SELECTED,
299 MENU_ITEMS_ITEM_HELP,
300 MENU_ITEMS_ITEM_LENGTH
303 extern Lisp_Object unuse_menu_items (Lisp_Object dummy);
305 /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
306 isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be
307 confined to an extended version of this with sections of code below
308 using it unconditionally. */
309 #ifndef HAVE_NTGUI
310 #if defined (USE_GTK) || defined (HAVE_NS)
311 # define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
312 #elif defined HAVE_X_I18N
313 #define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
314 #else
315 #define ENCODE_MENU_STRING(str) string_make_unibyte (str)
316 #endif /* USE_GTK */
317 #else /* HAVE_NTGUI */
318 #define ENCODE_MENU_STRING(str) (str)
319 #endif
321 #if defined (HAVE_NS) || defined (HAVE_NTGUI) || defined (USE_GTK)
323 /* Definitions copied from lwlib.h */
325 enum button_type
327 BUTTON_TYPE_NONE,
328 BUTTON_TYPE_TOGGLE,
329 BUTTON_TYPE_RADIO
332 /* This structure is based on the one in ../lwlib/lwlib.h, with unused portions
333 removed. No term uses these. */
334 typedef struct _widget_value
336 /* name of widget */
337 Lisp_Object lname;
338 const char* name;
339 /* value (meaning depend on widget type) */
340 const char* value;
341 /* keyboard equivalent. no implications for XtTranslations */
342 Lisp_Object lkey;
343 const char* key;
344 /* Help string or nil if none.
345 GC finds this string through the frame's menu_bar_vector
346 or through menu_items. */
347 Lisp_Object help;
348 /* true if enabled */
349 unsigned char enabled;
350 /* true if selected */
351 unsigned char selected;
352 /* The type of a button. */
353 enum button_type button_type;
354 #if defined (HAVE_NTGUI)
355 /* true if menu title */
356 unsigned char title;
357 #endif
358 /* Contents of the sub-widgets, also selected slot for checkbox */
359 struct _widget_value* contents;
360 /* data passed to callback */
361 void *call_data;
362 /* next one in the list */
363 struct _widget_value* next;
364 #ifdef USE_GTK
365 struct _widget_value *free_list;
366 #endif
367 } widget_value;
369 #endif /* HAVE_NS || HAVE_NTGUI */
372 /* Macros for dealing with lispy events. */
374 /* True if EVENT has data fields describing it (i.e. a mouse click). */
375 #define EVENT_HAS_PARAMETERS(event) (CONSP (event))
377 /* Extract the head from an event.
378 This works on composite and simple events. */
379 #define EVENT_HEAD(event) \
380 (EVENT_HAS_PARAMETERS (event) ? XCAR (event) : (event))
382 /* Extract the starting and ending positions from a composite event. */
383 #define EVENT_START(event) (XCAR (XCDR (event)))
384 #define EVENT_END(event) (XCAR (XCDR (XCDR (event))))
386 /* Extract the click count from a multi-click event. */
387 #define EVENT_CLICK_COUNT(event) (Fnth (make_number (2), (event)))
389 /* Extract the fields of a position. */
390 #define POSN_WINDOW(posn) (XCAR (posn))
391 #define POSN_POSN(posn) (XCAR (XCDR (posn)))
392 #define POSN_SET_POSN(posn,x) (XSETCAR (XCDR (posn), (x)))
393 #define POSN_WINDOW_POSN(posn) (XCAR (XCDR (XCDR (posn))))
394 #define POSN_TIMESTAMP(posn) (XCAR (XCDR (XCDR (XCDR (posn)))))
395 #define POSN_SCROLLBAR_PART(posn) (Fnth (make_number (4), (posn)))
397 /* A cons (STRING . STRING-CHARPOS), or nil in mouse-click events.
398 It's a cons if the click is over a string in the mode line. */
400 #define POSN_STRING(posn) (Fnth (make_number (4), (posn)))
402 /* If POSN_STRING is nil, event refers to buffer location. */
404 #define POSN_INBUFFER_P(posn) (NILP (POSN_STRING (posn)))
405 #define POSN_BUFFER_POSN(posn) (Fnth (make_number (5), (posn)))
407 extern Lisp_Object do_mouse_tracking;
409 /* Some of the event heads. */
410 extern Lisp_Object Qswitch_frame;
412 /* Properties on event heads. */
413 extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
415 /* Getting an unmodified version of an event head. */
416 #define EVENT_HEAD_UNMODIFIED(event_head) \
417 (Fcar (Fget ((event_head), Qevent_symbol_elements)))
419 /* The values of Qevent_kind properties. */
420 extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
421 extern Lisp_Object Qscroll_bar_movement;
423 extern Lisp_Object Qhelp_echo;
425 /* Getting the kind of an event head. */
426 #define EVENT_HEAD_KIND(event_head) \
427 (Fget ((event_head), Qevent_kind))
429 /* Symbols to use for non-text mouse positions. */
430 extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line;
432 /* True while doing kbd input. */
433 extern int waiting_for_input;
435 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
436 happens. */
437 extern EMACS_TIME *input_available_clear_time;
439 extern int ignore_mouse_drag_p;
441 extern Lisp_Object Vdouble_click_time;
443 /* The primary selection. */
444 extern Lisp_Object QPRIMARY;
446 /* Forward declaration for prototypes. */
447 struct input_event;
449 extern Lisp_Object parse_modifiers (Lisp_Object);
450 extern Lisp_Object reorder_modifiers (Lisp_Object);
451 extern Lisp_Object read_char (int, int, Lisp_Object *, Lisp_Object,
452 int *, EMACS_TIME *);
453 extern int parse_solitary_modifier (Lisp_Object symbol);
456 /* Parent keymap of terminal-local function-key-map instances. */
457 extern Lisp_Object Vfunction_key_map;
459 /* Keymap of key translations that can override keymaps. */
460 extern Lisp_Object Vkey_translation_map;
462 /* This is like Vthis_command, except that commands never set it. */
463 extern Lisp_Object real_this_command;
465 /* If the lookup of the command returns a binding, the original
466 command is stored in this-original-command. It is nil otherwise. */
467 extern Lisp_Object Vthis_original_command;
469 /* Non-nil disable property on a command means
470 do not execute it; call disabled-command-function's value instead. */
471 extern Lisp_Object QCbutton, QCtoggle, QCradio, QClabel;
473 /* A mask of extra modifier bits to put into every keyboard char. */
474 extern EMACS_INT extra_keyboard_modifiers;
476 /* If non-nil, this implements the current input method. */
477 extern Lisp_Object Vinput_method_function;
478 extern Lisp_Object Qinput_method_function;
480 /* An event header symbol HEAD may have a property named
481 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
482 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
483 mask of modifiers applied to it. If present, this is used to help
484 speed up parse_modifiers. */
485 extern Lisp_Object Qevent_symbol_element_mask;
487 /* The timestamp of the last input event we received from the X server.
488 X Windows wants this for selection ownership. */
489 extern unsigned long last_event_timestamp;
491 extern int quit_char;
493 extern int parse_menu_item (Lisp_Object, int);
495 extern void echo_now (void);
496 extern void init_kboard (KBOARD *);
497 extern void delete_kboard (KBOARD *);
498 extern void not_single_kboard_state (KBOARD *);
499 extern void push_kboard (struct kboard *);
500 extern void push_frame_kboard (struct frame *);
501 extern void pop_kboard (void);
502 extern void temporarily_switch_to_single_kboard (struct frame *);
503 extern void record_asynch_buffer_change (void);
504 extern SIGTYPE input_poll_signal (int);
505 extern void start_polling (void);
506 extern void stop_polling (void);
507 extern void set_poll_suppress_count (int);
508 extern void gobble_input (int);
509 extern int input_polling_used (void);
510 extern void clear_input_pending (void);
511 extern int requeued_events_pending_p (void);
512 extern void bind_polling_period (int);
513 extern void stuff_buffered_input (Lisp_Object);
514 extern void clear_waiting_for_input (void);
515 extern void swallow_events (int);
516 extern int help_char_p (Lisp_Object);
517 extern void quit_throw_to_read_char (void) NO_RETURN;
518 extern int lucid_event_type_list_p (Lisp_Object);
519 extern void kbd_buffer_store_event (struct input_event *);
520 extern void kbd_buffer_store_event_hold (struct input_event *,
521 struct input_event *);
522 extern void kbd_buffer_unget_event (struct input_event *);
523 extern void poll_for_input_1 (void);
524 extern void show_help_echo (Lisp_Object, Lisp_Object, Lisp_Object,
525 Lisp_Object, int);
526 extern void gen_help_event (Lisp_Object, Lisp_Object, Lisp_Object,
527 Lisp_Object, EMACS_INT);
528 extern void kbd_buffer_store_help_event (Lisp_Object, Lisp_Object);
529 extern Lisp_Object menu_item_eval_property (Lisp_Object);
530 extern int kbd_buffer_events_waiting (int);
531 extern void add_user_signal (int, const char *);
533 extern int tty_read_avail_input (struct terminal *, int,
534 struct input_event *);
535 extern EMACS_TIME timer_check (int);
537 /* arch-tag: 769cbade-1ba9-4950-b886-db265b061aa3
538 (do not change this comment) */