Now part of GNU Emacs. Update FSF's address.
[bpt/emacs.git] / src / termhooks.h
index a479b5b..641d21b 100644 (file)
@@ -1,6 +1,7 @@
 /* Hooks by which low level terminal operations
    can be made to call other routines.
-   Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
+                 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -16,8 +17,8 @@ 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., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 \f
 /* Miscellanea.   */
@@ -162,7 +163,7 @@ extern void (*set_vertical_scroll_bar_hook)
 
 /* Arrange for all scroll bars on FRAME to be removed at the next call
    to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
-   `*redeem_scroll_bar_hook' is applied to its window before the judgement. 
+   `*redeem_scroll_bar_hook' is applied to its window before the judgement.
 
    This should be applied to each frame each time its window tree is
    redisplayed, even if it is not displaying scroll bars at the moment;
@@ -179,7 +180,7 @@ extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
 extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
 
 /* Remove all scroll bars on FRAME that haven't been saved since the
-   last call to `*condemn_scroll_bars_hook'.  
+   last call to `*condemn_scroll_bars_hook'.
 
    This should be applied to each frame after each time its window
    tree is redisplayed, even if it is not displaying scroll bars at the
@@ -215,9 +216,7 @@ enum event_kind
   MULTIBYTE_CHAR_KEYSTROKE_EVENT,      /* The multibyte char code is in .code,
                                   perhaps with modifiers applied.
                                   The others are the same as
-                                  ASCII_KEYSTROKE_EVENT.  This type of event
-                                  is generated only when we are using
-                                  XIM on X window.  */
+                                  ASCII_KEYSTROKE_EVENT.  */
   NON_ASCII_KEYSTROKE_EVENT,   /* .code is a number identifying the
                                   function key.  A code N represents
                                   a key whose name is
@@ -242,28 +241,23 @@ enum event_kind
                                   the mouse click occurred in.
                                   .timestamp gives a timestamp (in
                                   milliseconds) for the click.  */
-#if defined(WINDOWSNT) || defined(MAC_OSX)
-  MOUSE_WHEEL_EVENT,           /* A mouse-wheel event is generated 
-                                  on WINDOWSNT or MAC_OSX by a 
-                                  wheel on a mouse (e.g., MS Intellimouse).
-                                  The event contains a delta that corresponds
-                                  to the amount and direction that the wheel
-                                  is rotated.  This delta is typically
-                                  used to implement a scroll or zoom.
-                                  .code gives the delta.
-                                  .modifiers holds the state of the
-                                  modifier keys.
+  WHEEL_EVENT,                 /* A wheel event is generated by a
+                                  wheel on a mouse (e.g., MS
+                                  Intellimouse).
+                                  .modifiers holds the rotate
+                                  direction (up or down), and the
+                                  state of the modifier keys.
                                   .x and .y give the mouse position,
                                   in characters, within the window.
                                   .frame_or_window gives the frame
                                   the wheel event occurred in.
                                   .timestamp gives a timestamp (in
-                                  milliseconds) for the wheel event.  */
-#endif
-#ifdef WINDOWSNT
-  LANGUAGE_CHANGE_EVENT,       /* A LANGUAGE_CHANGE_EVENT is generated
-                                  on WINDOWSNT when the keyboard layout
-                                  or input language is changed by the
+                                  milliseconds) for the event.  */
+#if defined (WINDOWSNT) || defined (MAC_OS)
+  LANGUAGE_CHANGE_EVENT,       /* A LANGUAGE_CHANGE_EVENT is
+                                  generated on WINDOWSNT or Mac OS
+                                  when the keyboard layout or input
+                                  language is changed by the
                                   user.  */
 #endif
   SCROLL_BAR_CLICK_EVENT,      /* .code gives the number of the mouse button
@@ -300,7 +294,7 @@ enum event_kind
                                   files selected outside of Emacs are dropped
                                   onto an Emacs window.
                                   Currently used only on Windows NT.
-                                  .modifiers holds the state of the 
+                                  .modifiers holds the state of the
                                   modifier keys.
                                   .x and .y give the mouse position,
                                   in characters, within the window.
@@ -348,7 +342,7 @@ struct input_event
 {
   /* What kind of event was this?  */
   enum event_kind kind;
-  
+
   /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
      this is the character.
      For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
@@ -379,8 +373,10 @@ struct input_event
   Lisp_Object arg;
 };
 
+#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
+
 /* Called to read input events.  */
-extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int));
+extern int (*read_socket_hook) P_ ((int, int, struct input_event *));
 
 /* Called when a frame's display becomes entirely up to date.  */
 extern void (*frame_up_to_date_hook) P_ ((struct frame *));
@@ -388,7 +384,7 @@ extern void (*frame_up_to_date_hook) P_ ((struct frame *));
 
 /* Bits in the modifiers member of the input_event structure.
    Note that reorder_modifiers assumes that the bits are in canonical
-   order.  
+   order.
 
    The modifiers applied to mouse clicks are rather ornate.  The
    window-system-specific code should store mouse clicks with
@@ -436,3 +432,6 @@ enum {
 };
 
 #endif
+
+/* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
+   (do not change this comment) */