Replace bcopy, bzero, bcmp by memcpy, memmove, memset, memcmp
[bpt/emacs.git] / src / termhooks.h
index 4d8fb8a..7762dd1 100644 (file)
@@ -1,13 +1,13 @@
 /* Parameters and display hooks for terminal devices.
-   Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
-                 2005, 2006, 2007 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 1994, 2001, 2002, 2003, 2004,
+                 2005, 2006, 2007, 2008, 2009, 2010  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,20 +15,13 @@ 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 <http://www.gnu.org/licenses/>.  */
 
 \f
 /* Miscellanea.   */
 
 struct glyph;
 struct frame;
-
-/* Only use prototypes when lisp.h has been included.  */
-#ifndef P_
-#define P_(X) ()
-#endif
 \f
 
 enum scroll_bar_part {
@@ -46,7 +39,7 @@ enum scroll_bar_part {
 /* If the value of the frame parameter changed, whis hook is called.
    For example, if going from fullscreen to not fullscreen this hook
    may do something OS dependent, like extended window manager hints on X11.  */
-extern void (*fullscreen_hook) P_ ((struct frame *f));
+extern void (*fullscreen_hook) (struct frame *f);
 
 \f
 /* Input queue declarations and hooks.  */
@@ -112,7 +105,7 @@ enum event_kind
   HORIZ_WHEEL_EVENT,            /* A wheel event generated by a second
                                    horizontal wheel that is present on some
                                    mice. See WHEEL_EVENT.  */
-#if defined (WINDOWSNT) || defined (MAC_OS)
+#if defined (WINDOWSNT)
   LANGUAGE_CHANGE_EVENT,       /* A LANGUAGE_CHANGE_EVENT is
                                   generated on WINDOWSNT or Mac OS
                                   when the keyboard layout or input
@@ -132,10 +125,6 @@ enum event_kind
                                   whose scroll bar was clicked in.
                                   .timestamp gives a timestamp (in
                                   milliseconds) for the click.  */
-#ifdef WINDOWSNT
-  W32_SCROLL_BAR_CLICK_EVENT,  /* as for SCROLL_BAR_CLICK, but only generated
-                                  by MS-Windows scroll bar controls. */
-#endif
   SELECTION_REQUEST_EVENT,     /* Another X client wants a selection from us.
                                   See `struct selection_input_event'.  */
   SELECTION_CLEAR_EVENT,       /* Another X client cleared our selection.  */
@@ -187,19 +176,39 @@ enum event_kind
      save yourself before shutdown. */
   SAVE_SESSION_EVENT
 
-#ifdef MAC_OS
-  /* Generated when an Apple event, a HICommand event, or a Services
-     menu event is received and the corresponding handler is
-     registered.  Members `x' and `y' are for the event class and ID
-     symbols, respectively.  Member `arg' is a Lisp object converted
-     from the received Apple event.  Parameters for non-Apple events
-     are converted to those in Apple events.  */
-  , MAC_APPLE_EVENT
-#endif
-
 #ifdef HAVE_GPM
   , GPM_CLICK_EVENT
 #endif
+
+#ifdef HAVE_DBUS
+  , DBUS_EVENT
+#endif
+
+  , CONFIG_CHANGED_EVENT
+
+#ifdef WINDOWSNT
+  /* Generated when an APPCOMMAND event is received, in response to
+     Multimedia or Internet buttons on some keyboards.
+     Such keys are available as normal function keys on X through the
+     Xkeyboard extension.
+     On Windows, some of them get mapped to normal function key events,
+     but others need to be handled by APPCOMMAND. Handling them all as
+     APPCOMMAND events means they can be disabled
+     (w32-pass-multimedia-buttons-to-system), important on Windows since
+     the system never sees these keys if Emacs claims to handle them.
+     On X, the window manager seems to grab the keys it wants
+     first, so this is not a problem there.  */
+  , MULTIMEDIA_KEY_EVENT
+#endif
+
+#ifdef HAVE_NS
+  /* Generated when native multi-keystroke input method is used to modify
+     tentative or indicative text display. */
+  , NS_TEXT_EVENT
+  /* Non-key system events (e.g. application menu events) */
+  , NS_NONKEY_EVENT
+#endif
+
 };
 
 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
@@ -246,7 +255,7 @@ struct input_event
   Lisp_Object arg;
 };
 
-#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
+#define EVENT_INIT(event) memset (&(event), 0, sizeof (struct input_event))
 
 /* Bits in the modifiers member of the input_event structure.
    Note that reorder_modifiers assumes that the bits are in canonical
@@ -309,7 +318,8 @@ extern struct tty_display_info *gpm_tty;
 #endif /* CONSP */
 
 \f
-struct mac_display_info;
+struct ns_display_info;
+struct x_display_info;
 struct w32_display_info;
 
 /* Terminal-local parameters. */
@@ -325,7 +335,7 @@ struct terminal
 
   /* All fields before `next_terminal' should be Lisp_Object and are traced
      by the GC.  All fields afterwards are ignored by the GC.  */
-  
+
   /* Chain of all terminal devices. */
   struct terminal *next_terminal;
 
@@ -343,10 +353,13 @@ struct terminal
      times. */
   char *name;
 
-#ifdef MULTI_KBOARD
   /* The terminal's keyboard object. */
   struct kboard *kboard;
-#endif
+
+#ifdef HAVE_WINDOW_SYSTEM
+  /* Cache of images.  */
+  struct image_cache *image_cache;
+#endif /* HAVE_WINDOW_SYSTEM */
 
   /* Device-type dependent data shared amongst all frames on this terminal. */
   union display_info
@@ -354,7 +367,7 @@ struct terminal
     struct tty_display_info *tty;     /* termchar.h */
     struct x_display_info *x;         /* xterm.h */
     struct w32_display_info *w32;     /* w32term.h */
-    struct mac_display_info *mac;     /* macterm.h */
+    struct ns_display_info *ns;       /* nsterm.h */
   } display_info;
 
 \f
@@ -371,12 +384,12 @@ struct terminal
 
   /* Terminal characteristics. */
   /* XXX Are these really used on non-termcap displays? */
-  
+
   int must_write_spaces;       /* Nonzero means spaces in the text must
                                   actually be output; can't just skip over
                                   some columns to leave them blank.  */
   int fast_clear_end_of_line;   /* Nonzero means terminal has a `ce' string */
-  
+
   int line_ins_del_ok;          /* Terminal can insert and delete lines */
   int char_ins_del_ok;          /* Terminal can insert and delete chars */
   int scroll_region_ok;         /* Terminal supports setting the scroll
@@ -399,30 +412,31 @@ struct terminal
   struct redisplay_interface *rif;
 
   /* Frame-based redisplay interface. */
-  
+
   /* Text display hooks.  */
 
-  void (*cursor_to_hook) P_ ((struct frame *f, int vpos, int hpos));
-  void (*raw_cursor_to_hook) P_ ((struct frame *, int, int));
-  
-  void (*clear_to_end_hook) P_ ((struct frame *));
-  void (*clear_frame_hook) P_ ((struct frame *));
-  void (*clear_end_of_line_hook) P_ ((struct frame *, int));
-  
-  void (*ins_del_lines_hook) P_ ((struct frame *f, int, int));
-  
-  void (*insert_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
-  void (*write_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
-  void (*delete_glyphs_hook) P_ ((struct frame *, int));
-  
-  void (*ring_bell_hook) P_ ((struct frame *f));
-  
-  void (*reset_terminal_modes_hook) P_ ((struct terminal *));
-  void (*set_terminal_modes_hook) P_ ((struct terminal *));
-
-  void (*update_begin_hook) P_ ((struct frame *));
-  void (*update_end_hook) P_ ((struct frame *));
-  void (*set_terminal_window_hook) P_ ((struct frame *, int));
+  void (*cursor_to_hook) (struct frame *f, int vpos, int hpos);
+  void (*raw_cursor_to_hook) (struct frame *, int, int);
+
+  void (*clear_to_end_hook) (struct frame *);
+  void (*clear_frame_hook) (struct frame *);
+  void (*clear_end_of_line_hook) (struct frame *, int);
+
+  void (*ins_del_lines_hook) (struct frame *f, int, int);
+
+  void (*insert_glyphs_hook) (struct frame *f, struct glyph *s, int n);
+  void (*write_glyphs_hook) (struct frame *f, struct glyph *s, int n);
+  void (*delete_glyphs_hook) (struct frame *, int);
+
+  void (*ring_bell_hook) (struct frame *f);
+  void (*toggle_invisible_pointer_hook) (struct frame *f, int invisible);
+
+  void (*reset_terminal_modes_hook) (struct terminal *);
+  void (*set_terminal_modes_hook) (struct terminal *);
+
+  void (*update_begin_hook) (struct frame *);
+  void (*update_end_hook) (struct frame *);
+  void (*set_terminal_window_hook) (struct frame *, int);
 
   /* Multi-frame and mouse support hooks.  */
 
@@ -431,7 +445,7 @@ struct terminal
      Set *f to the frame the mouse is in, or zero if the mouse is in no
      Emacs frame.  If it is set to zero, all the other arguments are
      garbage.
-  
+
      If the motion started in a scroll bar, set *bar_window to the
      scroll bar's window, *part to the part the mouse is currently over,
      *x to the position of the mouse along the scroll bar, and *y to the
@@ -441,15 +455,15 @@ struct terminal
      row of the character cell the mouse is over.
 
      Set *time to the time the mouse was at the returned position.
-     
+
      This should clear mouse_moved until the next motion
      event arrives.  */
-  void (*mouse_position_hook) P_ ((struct frame **f, int,
-                                   Lisp_Object *bar_window,
-                                   enum scroll_bar_part *part,
-                                   Lisp_Object *x,
-                                   Lisp_Object *y,
-                                   unsigned long *time));
+  void (*mouse_position_hook) (struct frame **f, int,
+                               Lisp_Object *bar_window,
+                               enum scroll_bar_part *part,
+                               Lisp_Object *x,
+                               Lisp_Object *y,
+                               unsigned long *time);
 
   /* The window system handling code should set this if the mouse has
      moved since the last call to the mouse_position_hook.  Calling that
@@ -459,7 +473,7 @@ struct terminal
   /* When a frame's focus redirection is changed, this hook tells the
      window system code to re-decide where to put the highlight.  Under
      X, this means that Emacs lies about where the focus is.  */
-  void (*frame_rehighlight_hook) P_ ((struct frame *));
+  void (*frame_rehighlight_hook) (struct frame *);
 
   /* If we're displaying frames using a window system that can stack
      frames on top of each other, this hook allows you to bring a frame
@@ -467,17 +481,17 @@ struct terminal
      hook is zero, that means the terminal we're displaying on doesn't
      support overlapping frames, so there's no need to raise or lower
      anything.
-     
+
      If RAISE is non-zero, F is brought to the front, before all other
      windows.  If RAISE is zero, F is sent to the back, behind all other
      windows.  */
-  void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
+  void (*frame_raise_lower_hook) (struct frame *f, int raise);
 
   /* If the value of the frame parameter changed, whis hook is called.
      For example, if going from fullscreen to not fullscreen this hook
      may do something OS dependent, like extended window manager hints on X11.  */
-  void (*fullscreen_hook) P_ ((struct frame *f));
-    
+  void (*fullscreen_hook) (struct frame *f);
+
   \f
   /* Scroll bar hooks.  */
 
@@ -486,29 +500,29 @@ struct terminal
      lisp objects.  This allows us to place references to them in
      Lisp_Windows without worrying about those references becoming
      dangling references when the scroll bar is destroyed.
-     
+
      The window-system-independent portion of Emacs just refers to
      scroll bars via their windows, and never looks inside the scroll bar
      representation; it always uses hook functions to do all the
      scroll bar manipulation it needs.
-     
+
      The `vertical_scroll_bar' field of a Lisp_Window refers to that
      window's scroll bar, or is nil if the window doesn't have a
      scroll bar.
-     
+
      The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
      are free for use by the scroll bar implementation in any way it sees
      fit.  They are marked by the garbage collector.  */
-  
-  
+
+
   /* Set the vertical scroll bar for WINDOW to have its upper left corner
      at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
      indicate that we are displaying PORTION characters out of a total
      of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
      have a scroll bar, create one for it.  */
-  void (*set_vertical_scroll_bar_hook) P_ ((struct window *window,
-                                            int portion, int whole,
-                                            int position));
+  void (*set_vertical_scroll_bar_hook) (struct window *window,
+                                        int portion, int whole,
+                                        int position);
 
 
   /* The following three hooks are used when we're doing a thorough
@@ -518,24 +532,24 @@ struct terminal
      Instead, we just assert at the beginning of redisplay that *all*
      scroll bars are to be removed, and then save scroll bars from the
      fiery pit when we actually redisplay their window.  */
-  
+
   /* 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.
-     
+
      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;
      if the HAS_SCROLL_BARS flag has just been turned off, only calling
      this and the judge_scroll_bars_hook will get rid of them.
-     
+
      If non-zero, this hook should be safe to apply to any frame,
      whether or not it can support scroll bars, and whether or not it is
      currently displaying them.  */
-  void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
+  void (*condemn_scroll_bars_hook) (struct frame *frame);
 
   /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
      Note that it's okay to redeem a scroll bar that is not condemned.  */
-  void (*redeem_scroll_bar_hook) P_ ((struct window *window));
+  void (*redeem_scroll_bar_hook) (struct window *window);
 
   /* Remove all scroll bars on FRAME that haven't been saved since the
      last call to `*condemn_scroll_bars_hook'.
@@ -544,11 +558,11 @@ struct terminal
      tree is redisplayed, even if it is not displaying scroll bars at the
      moment; if the HAS_SCROLL_BARS flag has just been turned off, only
      calling this and condemn_scroll_bars_hook will get rid of them.
-     
+
      If non-zero, this hook should be safe to apply to any frame,
      whether or not it can support scroll bars, and whether or not it is
      currently displaying them.  */
-  void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
+  void (*judge_scroll_bars_hook) (struct frame *FRAME);
 
 \f
   /* Called to read input events.
@@ -570,29 +584,29 @@ struct terminal
      Therefore, in most cases EXPECTED should be simply ignored.
 
      XXX This documentation needs to be updated.  */
-  int (*read_socket_hook) P_ ((struct terminal *terminal,
-                               int expected,
-                               struct input_event *hold_quit));
+  int (*read_socket_hook) (struct terminal *terminal,
+                           int expected,
+                           struct input_event *hold_quit);
 
   /* Called when a frame's display becomes entirely up to date.  */
-  void (*frame_up_to_date_hook) P_ ((struct frame *));
+  void (*frame_up_to_date_hook) (struct frame *);
 
 \f
   /* Called to delete the device-specific portions of a frame that is
      on this terminal device. */
-  void (*delete_frame_hook) P_ ((struct frame *));
+  void (*delete_frame_hook) (struct frame *);
 
   /* Called after the last frame on this terminal is deleted, or when
      the display device was closed (hangup).
-     
+
      If this is NULL, then the generic delete_terminal is called
      instead.  Otherwise the hook must call delete_terminal itself.
 
      The hook must check for and close any live frames that are still
-     on the terminal.  Fdelete_frame ensures that there are no live
+     on the terminal.  delete_frame ensures that there are no live
      frames on the terminal when it calls this hook, so infinite
      recursion is prevented.  */
-  void (*delete_terminal_hook) P_ ((struct terminal *));
+  void (*delete_terminal_hook) (struct terminal *);
 };
 
 
@@ -626,23 +640,24 @@ extern struct terminal *terminal_list;
 #ifdef HAVE_NTGUI
 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 #endif
-#ifdef MAC_OS
-#define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
-#endif
 #ifndef FRAME_WINDOW_P
 #define FRAME_WINDOW_P(f) (0)
 #endif
 
 /* Return true if the terminal device is not suspended. */
-#define TERMINAL_ACTIVE_P(d) ((d)->type != output_termcap || (d)->display_info.tty->input)
+#define TERMINAL_ACTIVE_P(d) (((d)->type != output_termcap && (d)->type !=output_msdos_raw) || (d)->display_info.tty->input)
 
-extern Lisp_Object get_terminal_param P_ ((struct terminal *, Lisp_Object));
-extern struct terminal *get_terminal P_ ((Lisp_Object terminal, int));
-extern struct terminal *create_terminal P_ ((void));
-extern void delete_terminal P_ ((struct terminal *));
+extern Lisp_Object get_terminal_param (struct terminal *, Lisp_Object);
+extern struct terminal *get_terminal (Lisp_Object terminal, int);
+extern struct terminal *create_terminal (void);
+extern void delete_terminal (struct terminal *);
 
 /* The initial terminal device, created by initial_term_init. */
 extern struct terminal *initial_terminal;
 
+#ifdef HAVE_GPM
+extern void close_gpm (int gpm_fd);
+#endif
+
 /* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
    (do not change this comment) */