X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/f67e15be8d94718b2e2ea7da68eb0b2dc94ce016..77a765fd789f80afbe170bf640794a4b25968ea6:/src/keyboard.h diff --git a/src/keyboard.h b/src/keyboard.h index 1d40045bfa..10bf16d5c5 100644 --- a/src/keyboard.h +++ b/src/keyboard.h @@ -1,13 +1,12 @@ /* Declarations useful when processing input. - Copyright (C) 1985, 1986, 1987, 1993, 2001, 2002, 2003, 2004, - 2005, 2006, 2007, 2008 Free Software Foundation, Inc. + Copyright (C) 1985-1987, 1993, 2001-2011 Free Software Foundation, Inc. This file is part of GNU Emacs. -GNU Emacs is free software; you can redistribute it and/or modify +GNU Emacs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 3, or (at your option) -any later version. +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. GNU Emacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -15,13 +14,19 @@ 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 -along with GNU Emacs; see the file COPYING. If not, write to -the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, -Boston, MA 02110-1301, USA. */ +along with GNU Emacs. If not, see . */ #include "systime.h" /* for EMACS_TIME */ +#include "coding.h" /* for ENCODE_UTF_8 and ENCODE_SYSTEM */ -/* Length of echobuf field in each KBOARD. */ +/* 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 ## _ + +/* Most code should use this macro to access Lisp fields in struct + kboard. */ +#define KVAR(kboard, field) ((kboard)->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 @@ -74,32 +79,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 Voverriding_terminal_local_map; + Lisp_Object KBOARD_INTERNAL_FIELD (Voverriding_terminal_local_map); /* Last command executed by the editor command loop, not counting commands that set the prefix argument. */ - Lisp_Object Vlast_command; + Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_command); /* Normally same as last-command, but never modified by other commands. */ - Lisp_Object Vreal_last_command; + Lisp_Object KBOARD_INTERNAL_FIELD (Vreal_last_command); /* User-supplied table to translate input characters through. */ - Lisp_Object Vkeyboard_translate_table; + Lisp_Object KBOARD_INTERNAL_FIELD (Vkeyboard_translate_table); /* Last command that may be repeated by `repeat'. */ - Lisp_Object Vlast_repeatable_command; + Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_repeatable_command); /* The prefix argument for the next command, in raw form. */ - Lisp_Object Vprefix_arg; + Lisp_Object KBOARD_INTERNAL_FIELD (Vprefix_arg); /* Saved prefix argument for the last command, in raw form. */ - Lisp_Object Vlast_prefix_arg; + Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_prefix_arg); /* Unread events specific to this kboard. */ - Lisp_Object kbd_queue; + Lisp_Object KBOARD_INTERNAL_FIELD (kbd_queue); /* Non-nil while a kbd macro is being defined. */ - Lisp_Object defining_kbd_macro; + Lisp_Object KBOARD_INTERNAL_FIELD (defining_kbd_macro); /* The start of storage for the current keyboard macro. */ Lisp_Object *kbd_macro_buffer; @@ -121,28 +126,28 @@ struct kboard int kbd_macro_bufsize; /* Last anonymous kbd macro defined. */ - Lisp_Object Vlast_kbd_macro; + Lisp_Object KBOARD_INTERNAL_FIELD (Vlast_kbd_macro); /* Alist of system-specific X windows key symbols. */ - Lisp_Object Vsystem_key_alist; + Lisp_Object KBOARD_INTERNAL_FIELD (Vsystem_key_alist); /* Cache for modify_event_symbol. */ - Lisp_Object system_key_syms; + Lisp_Object KBOARD_INTERNAL_FIELD (system_key_syms); /* The kind of display: x, w32, ... */ - Lisp_Object Vwindow_system; + Lisp_Object KBOARD_INTERNAL_FIELD (Vwindow_system); /* Keymap mapping keys to alternative preferred forms. See the DEFVAR for more documentation. */ - Lisp_Object Vlocal_function_key_map; + Lisp_Object KBOARD_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 Vinput_decode_map; + Lisp_Object KBOARD_INTERNAL_FIELD (Vinput_decode_map); /* Minibufferless frames on this display use this frame's minibuffer. */ - Lisp_Object Vdefault_minibuffer_frame; + Lisp_Object KBOARD_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. */ @@ -150,7 +155,7 @@ struct kboard /* The text we're echoing in the modeline - partial key sequences, usually. This is nil when not echoing. */ - Lisp_Object echo_string; + Lisp_Object KBOARD_INTERNAL_FIELD (echo_string); /* This flag indicates that events were put into kbd_queue while Emacs was running for some other KBOARD. @@ -172,7 +177,6 @@ struct kboard char echo_after_prompt; }; -#ifdef MULTI_KBOARD /* Temporarily used before a frame has been opened. */ extern KBOARD *initial_kboard; @@ -189,22 +193,10 @@ extern KBOARD *all_kboards; /* Nonzero in the single-kboard state, 0 in the any-kboard state. */ extern int single_kboard; -#else -extern KBOARD the_only_kboard; -#define current_kboard (&the_only_kboard) -#define all_kboards (&the_only_kboard) -#define single_kboard 1 -#endif -extern Lisp_Object Vlucid_menu_bar_dirty_flag; -extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook; - /* Total number of times read_char has returned. */ extern int num_input_events; -/* Total number of times read_char has returned, outside of macros. */ -extern EMACS_INT num_nonmacro_input_events; - /* Nonzero means polling for input is temporarily suppressed. */ extern int poll_suppress_count; @@ -222,6 +214,8 @@ extern int this_command_key_count; generated by the next character. */ extern Lisp_Object internal_last_event_frame; +extern Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook; + /* 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 @@ -251,6 +245,129 @@ extern Lisp_Object item_properties; /* Last property. */ /* Not nil if item is enabled. */ #define ITEM_PROPERTY_ENABLE 8 + +/* 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 (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. */ +#ifndef HAVE_NTGUI +#if defined (USE_GTK) || defined (HAVE_NS) +# 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 */ +#else /* HAVE_NTGUI */ +#define ENCODE_MENU_STRING(str) (str) +#endif + +#if defined (HAVE_NS) || defined (HAVE_NTGUI) || defined (USE_GTK) + +/* 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; + const char* name; + /* value (meaning depend on widget type) */ + const char* value; + /* keyboard equivalent. no implications for XtTranslations */ + Lisp_Object lkey; + const 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 */ + unsigned char enabled; + /* true if selected */ + unsigned char selected; + /* The type of a button. */ + enum button_type button_type; +#if defined (HAVE_NTGUI) + /* true if menu title */ + unsigned char title; +#endif + /* Contents of the sub-widgets, also selected slot for checkbox */ + struct _widget_value* contents; + /* data passed to callback */ + void *call_data; + /* next one in the list */ + struct _widget_value* next; +#ifdef USE_GTK + struct _widget_value *free_list; +#endif +} widget_value; + +#endif /* HAVE_NS || HAVE_NTGUI */ + /* Macros for dealing with lispy events. */ @@ -301,6 +418,8 @@ extern Lisp_Object Qevent_kind, Qevent_symbol_elements; extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement; extern Lisp_Object Qscroll_bar_movement; +extern Lisp_Object Qhelp_echo; + /* Getting the kind of an event head. */ #define EVENT_HEAD_KIND(event_head) \ (Fget ((event_head), Qevent_kind)) @@ -308,66 +427,94 @@ extern Lisp_Object Qscroll_bar_movement; /* Symbols to use for non-text mouse positions. */ extern Lisp_Object Qmode_line, Qvertical_line, Qheader_line; +/* True while doing kbd input. */ +extern int waiting_for_input; + +/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt + happens. */ +extern EMACS_TIME *input_available_clear_time; + +extern int ignore_mouse_drag_p; + +/* The primary selection. */ +extern Lisp_Object QPRIMARY; + /* Forward declaration for prototypes. */ struct input_event; -extern Lisp_Object parse_modifiers P_ ((Lisp_Object)); -extern Lisp_Object reorder_modifiers P_ ((Lisp_Object)); -extern Lisp_Object read_char P_ ((int, int, Lisp_Object *, Lisp_Object, - int *, EMACS_TIME *)); - - -/* Parent keymap of terminal-local function-key-map instances. */ -extern Lisp_Object Vfunction_key_map; - -/* Keymap of key translations that can override keymaps. */ -extern Lisp_Object Vkey_translation_map; - -extern int parse_menu_item P_ ((Lisp_Object, int, int)); - -extern void echo_now P_ ((void)); -extern void init_kboard P_ ((KBOARD *)); -extern void delete_kboard P_ ((KBOARD *)); -extern void not_single_kboard_state P_ ((KBOARD *)); -extern void push_kboard P_ ((struct kboard *)); -extern void push_frame_kboard P_ ((struct frame *)); -extern void pop_kboard P_ ((void)); -extern void temporarily_switch_to_single_kboard P_ ((struct frame *)); -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)); -extern void quit_throw_to_read_char P_ ((void)) NO_RETURN; -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 *)); -extern void kbd_buffer_store_event_hold P_ ((struct input_event *, - struct input_event *)); -extern void kbd_buffer_unget_event P_ ((struct input_event *)); -#ifdef POLL_FOR_INPUT -extern void poll_for_input_1 P_ ((void)); -#endif -extern void show_help_echo P_ ((Lisp_Object, Lisp_Object, Lisp_Object, - Lisp_Object, int)); -extern void gen_help_event P_ ((Lisp_Object, Lisp_Object, Lisp_Object, - Lisp_Object, int)); -extern void kbd_buffer_store_help_event P_ ((Lisp_Object, Lisp_Object)); -extern Lisp_Object menu_item_eval_property P_ ((Lisp_Object)); -extern int kbd_buffer_events_waiting P_ ((int)); -extern void add_user_signals P_ ((int, const char *)); - -extern int tty_read_avail_input P_ ((struct terminal *, int, - struct input_event *)); - -/* arch-tag: 769cbade-1ba9-4950-b886-db265b061aa3 - (do not change this comment) */ +extern Lisp_Object parse_modifiers (Lisp_Object); +extern Lisp_Object reorder_modifiers (Lisp_Object); +extern Lisp_Object read_char (int, int, Lisp_Object *, Lisp_Object, + int *, EMACS_TIME *); +extern int parse_solitary_modifier (Lisp_Object symbol); + + +/* This is like Vthis_command, except that commands never set it. */ +extern Lisp_Object real_this_command; + +/* Non-nil disable property on a command means + do not execute it; call disabled-command-function's value instead. */ +extern Lisp_Object QCbutton, QCtoggle, QCradio, QClabel; + +extern Lisp_Object Qinput_method_function; + +/* An event header symbol HEAD may have a property named + Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS); + BASE is the base, unmodified version of HEAD, and MODIFIERS is the + mask of modifiers applied to it. If present, this is used to help + 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 unsigned long last_event_timestamp; + +extern int quit_char; + +extern int timers_run; + +extern int menu_separator_name_p (const char *); +extern int parse_menu_item (Lisp_Object, int); + +extern void echo_now (void); +extern void init_kboard (KBOARD *); +extern void delete_kboard (KBOARD *); +extern void not_single_kboard_state (KBOARD *); +extern void push_kboard (struct kboard *); +extern void push_frame_kboard (struct frame *); +extern void pop_kboard (void); +extern void temporarily_switch_to_single_kboard (struct frame *); +extern void record_asynch_buffer_change (void); +extern SIGTYPE 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 void clear_input_pending (void); +extern int requeued_events_pending_p (void); +extern void bind_polling_period (int); +extern void stuff_buffered_input (Lisp_Object); +extern void clear_waiting_for_input (void); +extern void swallow_events (int); +extern int help_char_p (Lisp_Object); +extern void quit_throw_to_read_char (void) NO_RETURN; +extern int 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 *); +extern void kbd_buffer_unget_event (struct input_event *); +extern void poll_for_input_1 (void); +extern void show_help_echo (Lisp_Object, Lisp_Object, Lisp_Object, + Lisp_Object, int); +extern void gen_help_event (Lisp_Object, Lisp_Object, Lisp_Object, + Lisp_Object, EMACS_INT); +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 void add_user_signal (int, const char *); + +extern int tty_read_avail_input (struct terminal *, int, + struct input_event *); +extern EMACS_TIME timer_check (int); +