(fix_submap_inheritance, get_keyelt, store_in_keymap,
[bpt/emacs.git] / src / xterm.h
index 23a5bb1..19332e7 100644 (file)
@@ -15,7 +15,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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
 #include <X11/Xlib.h>
 #include <X11/cursorfont.h>
@@ -70,13 +71,15 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #endif
 #endif
 
-#ifdef XlibSpecificationRelease
-#if XlibSpecificationRelease >= 5
-#define HAVE_X11R5
+#ifdef HAVE_X11R5
 /* In case someone has X11R5 on AIX 3.1,
    make sure HAVE_X11R4 is defined as well as HAVE_X11R5.  */
 #define HAVE_X11R4
 #endif
+
+#ifdef HAVE_X11R5
+#define HAVE_X_I18N
+#include <X11/Xlocale.h>
 #endif
 \f
 #define BLACK_PIX_DEFAULT(f) BlackPixel (FRAME_X_DISPLAY (f), \
@@ -88,25 +91,9 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
 #define FONT_BASE(f)    ((f)->ascent)
 
-#define CHECK_X_FRAME(f, frame)                        \
-  if (NILP (frame))                            \
-    f = selected_frame;                                \
-  else                                         \
-    {                                          \
-      CHECK_LIVE_FRAME (frame, 0);             \
-      f = XFRAME (frame);                      \
-    }                                          \
-  if (! FRAME_X_P (f))
-
-  
-
 /* The mask of events that text windows always want to receive.  This
-   does not include mouse movement events.  It is used when the window
-   is created (in x_window) and and in selection processing.
-
-   We do include ButtonReleases in this set because Emacs isn't always
-   fast enough to catch them when it wants them, and they're rare
-   enough that they don't use much processor time.  */
+   includes mouse movement events, since handling the mouse-font text property
+   means that we must track mouse motion all the time.  */
 
 #define STANDARD_EVENT_SET      \
   (KeyPressMask                        \
@@ -114,7 +101,6 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
    | ButtonPressMask           \
    | ButtonReleaseMask         \
    | PointerMotionMask         \
-   | PointerMotionHintMask     \
    | StructureNotifyMask       \
    | FocusChangeMask           \
    | LeaveWindowMask           \
@@ -138,16 +124,6 @@ enum text_cursor_kinds {
   filled_box_cursor, hollow_box_cursor, bar_cursor
 };
 
-/* This data type is used for the font_table field
-   of struct x_display_info.  */
-
-struct font_info
-{
-  XFontStruct *font;
-  char *name;
-  char *full_name;
-};
-
 /* Structure recording X pixmap and reference count.
    If REFCOUNT is 0 then this record is free to be reused.  */
 
@@ -283,8 +259,16 @@ struct x_display_info
 
   /* More atoms, which are selection types.  */
   Atom Xatom_CLIPBOARD, Xatom_TIMESTAMP, Xatom_TEXT, Xatom_DELETE,
+  Xatom_COMPOUND_TEXT,
   Xatom_MULTIPLE, Xatom_INCR, Xatom_EMACS_TMP, Xatom_TARGETS, Xatom_NULL,
   Xatom_ATOM_PAIR;
+
+  /* More atoms for font properties.  The last three are private
+     properties, see the comments in src/fontset.h.  */
+  Atom Xatom_PIXEL_SIZE,
+  Xatom_MULE_BASELINE_OFFSET, Xatom_MULE_RELATIVE_COMPOSE,
+  Xatom_MULE_DEFAULT_ASCENT;
+
 #ifdef MULTI_KBOARD
   struct kboard *kboard;
 #endif
@@ -309,6 +293,10 @@ struct x_display_info
      frame.  It differs from x_focus_frame when we're using a global
      minibuffer.  */
   struct frame *x_highlight_frame;
+
+  /* The null pixel used for filling a character background with
+     background color of a gc.  */
+  Pixmap null_pixel;
 };
 
 /* This is a chain of structures for all the X displays currently in use.  */
@@ -320,16 +308,22 @@ extern struct x_display_info *x_display_list;
    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 extern Lisp_Object x_display_name_list;
 
+/* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
+extern Lisp_Object Vx_pixel_size_width_font_regexp;
+
 extern struct x_display_info *x_display_info_for_display ();
 extern struct x_display_info *x_display_info_for_name ();
 
 extern struct x_display_info *x_term_init ();
+
+extern Lisp_Object x_list_fonts ();
+extern struct font_info *x_get_font_info(), *x_load_font (), *x_query_font ();
 \f
-/* Each X frame object points to its own struct x_display object
-   in the display.x field.  The x_display structure contains all
+/* Each X frame object points to its own struct x_output object
+   in the output_data.x field.  The x_output structure contains
    the information that is specific to X windows.  */
 
-struct x_display
+struct x_output
 {
   /* Position of the X window (x and y offsets in root window).  */
   int left_pos;
@@ -341,6 +335,12 @@ struct x_display
   /* Size of the X window in pixels.  */
   int pixel_height, pixel_width;
 
+  /* Height of menu bar widget, in pixels.
+     Zero if not using the X toolkit.
+     When using the toolkit, this value is not meaningful
+     if the menubar is turned off.  */
+  int menubar_height;
+
   /* Height of a line, in pixels.  */
   int line_height;
 
@@ -388,8 +388,16 @@ struct x_display
      icon. */
   int icon_bitmap;
 
+  /* Default ASCII font of this frame.  */
   XFontStruct *font;
 
+  /* The baseline position of the default ASCII font.  */
+  int font_baseline;
+
+  /* If a fontset is specified for this frame instead of font, this
+     value contains an ID of the fontset, else -1.  */
+  int fontset;
+
   /* Pixel values used for various purposes.
      border_pixel may be -1 meaning use a gray tile.  */
   unsigned long background_pixel;
@@ -405,11 +413,6 @@ struct x_display
   Cursor modeline_cursor;
   Cursor cross_cursor;
 
-  /* The name that was associated with the icon, the last time
-     it was refreshed.  Usually the same as the name of the
-     buffer in the currently selected window in the frame */
-  char *icon_label;
-
   /* Flag to set when the X window needs to be completely repainted.  */
   int needs_exposure;
 
@@ -465,32 +468,57 @@ struct x_display
   /* This is the Emacs structure for the X display this frame is on.  */
   struct x_display_info *display_info;
 
+  /* This is a button event that wants to activate the menubar.
+     We save it here until the command loop gets to think about it.  */
+  XEvent *saved_menu_event;
+
+  /* This is the widget id used for this frame's menubar in lwlib.  */
+#ifdef USE_X_TOOLKIT
+  int id;
+#endif
+
   /* Nonzero means our parent is another application's window
      and was explicitly specified.  */
   char explicit_parent;
+
+  /* Nonzero means tried already to make this frame visible.  */
+  char asked_for_visible;
+
+  /* Nonzero if this frame was ever previously visible.  */
+  char has_been_visible;
+
+#ifdef HAVE_X_I18N
+  /* Input method. */
+  XIM xim;
+  /* Input context (currently, this means Compose key handler setup).  */
+  XIC xic;
+#endif
 };
 
 /* Get at the computed faces of an X window frame.  */
-#define FRAME_PARAM_FACES(f) ((f)->display.x->param_faces)
-#define FRAME_N_PARAM_FACES(f) ((f)->display.x->n_param_faces)
+#define FRAME_PARAM_FACES(f) ((f)->output_data.x->param_faces)
+#define FRAME_N_PARAM_FACES(f) ((f)->output_data.x->n_param_faces)
 #define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
 #define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
 
-#define FRAME_COMPUTED_FACES(f) ((f)->display.x->computed_faces)
-#define FRAME_N_COMPUTED_FACES(f) ((f)->display.x->n_computed_faces)
-#define FRAME_SIZE_COMPUTED_FACES(f) ((f)->display.x->size_computed_faces)
-#define FRAME_DEFAULT_FACE(f) ((f)->display.x->computed_faces[0])
-#define FRAME_MODE_LINE_FACE(f) ((f)->display.x->computed_faces[1])
+#define FRAME_COMPUTED_FACES(f) ((f)->output_data.x->computed_faces)
+#define FRAME_N_COMPUTED_FACES(f) ((f)->output_data.x->n_computed_faces)
+#define FRAME_SIZE_COMPUTED_FACES(f) ((f)->output_data.x->size_computed_faces)
+#define FRAME_DEFAULT_FACE(f) ((f)->output_data.x->computed_faces[0])
+#define FRAME_MODE_LINE_FACE(f) ((f)->output_data.x->computed_faces[1])
 
 /* Return the window associated with the frame F.  */
-#define FRAME_X_WINDOW(f) ((f)->display.x->window_desc)
+#define FRAME_X_WINDOW(f) ((f)->output_data.x->window_desc)
 
-#define FRAME_FOREGROUND_PIXEL(f) ((f)->display.x->foreground_pixel)
-#define FRAME_BACKGROUND_PIXEL(f) ((f)->display.x->background_pixel)
-#define FRAME_FONT(f) ((f)->display.x->font)
+#define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
+#define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
+#define FRAME_FONT(f) ((f)->output_data.x->font)
+#define FRAME_FONTSET(f) ((f)->output_data.x->fontset)
+#define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.x->internal_border_width)
+#define FRAME_LINE_HEIGHT(f) ((f)->output_data.x->line_height)
 
 /* This gives the x_display_info structure for the display F is on.  */
-#define FRAME_X_DISPLAY_INFO(f) ((f)->display.x->display_info)
+#define FRAME_X_DISPLAY_INFO(f) ((f)->output_data.x->display_info)
 
 /* This is the `Display *' which frame F is on.  */
 #define FRAME_X_DISPLAY(f) (FRAME_X_DISPLAY_INFO (f)->display)
@@ -498,12 +526,17 @@ struct x_display
 /* This is the `Screen *' which frame F is on.  */
 #define FRAME_X_SCREEN(f) (FRAME_X_DISPLAY_INFO (f)->screen)
 
+/* This is the 'font_info *' which frame F has.  */
+#define FRAME_X_FONT_TABLE(f) (FRAME_X_DISPLAY_INFO (f)->font_table)
+
 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
-#define PIXEL_WIDTH(f) ((f)->display.x->pixel_width)
-#define PIXEL_HEIGHT(f) ((f)->display.x->pixel_height)
+#define PIXEL_WIDTH(f) ((f)->output_data.x->pixel_width)
+#define PIXEL_HEIGHT(f) ((f)->output_data.x->pixel_height)
 
-#define FRAME_DESIRED_CURSOR(f) ((f)->display.x->desired_cursor)
+#define FRAME_DESIRED_CURSOR(f) ((f)->output_data.x->desired_cursor)
 
+#define FRAME_XIM(f) ((f)->output_data.x->xim)
+#define FRAME_XIC(f) ((f)->output_data.x->xic)
 \f
 /* X-specific scroll bar stuff.  */
 
@@ -586,12 +619,15 @@ struct scroll_bar {
 /* Return the outside pixel height for a vertical scroll bar HEIGHT
    rows high on frame F.  */
 #define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
-  ((height) * (f)->display.x->line_height)
+  ((height) * (f)->output_data.x->line_height)
 
 /* Return the inside width of a vertical scroll bar, given the outside
    width.  */
-#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
-  ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
+#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
+  ((width) \
+   - VERTICAL_SCROLL_BAR_LEFT_BORDER \
+   - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
+   - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 
 /* Return the length of the rectangle within which the top of the
    handle must stay.  This isn't equivalent to the inside height,
@@ -600,12 +636,12 @@ struct scroll_bar {
    This is the real range of motion for the scroll bar, so when we're
    scaling buffer positions to scroll bar positions, we use this, not
    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
-#define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
-  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
+#define VERTICAL_SCROLL_BAR_TOP_RANGE(f, height) \
+  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 
 /* Return the inside height of vertical scroll bar, given the outside
    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
-#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
+#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f, height) \
   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 
 
@@ -628,6 +664,10 @@ struct scroll_bar {
 /* Minimum lengths for scroll bar handles, in pixels.  */
 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (5)
 
+/* Trimming off a few pixels from each side prevents
+   text from glomming up against the scroll bar */
+#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (2)
+
 \f
 /* Manipulating pixel sizes and character sizes.
    Knowledge of which factors affect the overall size of the window should
@@ -636,52 +676,56 @@ struct scroll_bar {
    Return the upper/left pixel position of the character cell on frame F
    at ROW/COL.  */
 #define CHAR_TO_PIXEL_ROW(f, row) \
-  ((f)->display.x->internal_border_width \
-   + (row) * (f)->display.x->line_height)
+  ((f)->output_data.x->internal_border_width \
+   + (row) * (f)->output_data.x->line_height)
 #define CHAR_TO_PIXEL_COL(f, col) \
-  ((f)->display.x->internal_border_width \
-   + (col) * FONT_WIDTH ((f)->display.x->font))
+  ((f)->output_data.x->internal_border_width \
+   + (col) * FONT_WIDTH ((f)->output_data.x->font))
 
 /* Return the pixel width/height of frame F if it has
    WIDTH columns/HEIGHT rows.  */
 #define CHAR_TO_PIXEL_WIDTH(f, width) \
   (CHAR_TO_PIXEL_COL (f, width) \
-   + (f)->display.x->vertical_scroll_bar_extra \
-   + (f)->display.x->internal_border_width)
+   + (f)->output_data.x->vertical_scroll_bar_extra \
+   + (f)->output_data.x->internal_border_width)
 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
   (CHAR_TO_PIXEL_ROW (f, height) \
-   + (f)->display.x->internal_border_width)
+   + (f)->output_data.x->internal_border_width)
 
 
 /* Return the row/column (zero-based) of the character cell containing 
    the pixel on FRAME at ROW/COL.  */
 #define PIXEL_TO_CHAR_ROW(f, row) \
-  (((row) - (f)->display.x->internal_border_width) \
-   / (f)->display.x->line_height)
+  (((row) - (f)->output_data.x->internal_border_width) \
+   / (f)->output_data.x->line_height)
 #define PIXEL_TO_CHAR_COL(f, col) \
-  (((col) - (f)->display.x->internal_border_width) \
-   / FONT_WIDTH ((f)->display.x->font))
+  (((col) - (f)->output_data.x->internal_border_width) \
+   / FONT_WIDTH ((f)->output_data.x->font))
 
 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
    frame F?  */
 #define PIXEL_TO_CHAR_WIDTH(f, width) \
   (PIXEL_TO_CHAR_COL (f, ((width) \
-                         - (f)->display.x->internal_border_width \
-                         - (f)->display.x->vertical_scroll_bar_extra)))
+                         - (f)->output_data.x->internal_border_width \
+                         - (f)->output_data.x->vertical_scroll_bar_extra)))
 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
   (PIXEL_TO_CHAR_ROW (f, ((height) \
-                         - (f)->display.x->internal_border_width)))
+                         - (f)->output_data.x->internal_border_width)))
 \f
 /* If a struct input_event has a kind which is selection_request_event
    or selection_clear_event, then its contents are really described
    by this structure.  */
 
 /* For an event of kind selection_request_event,
-   this structure really describes the contents.  */
+   this structure really describes the contents.
+   **Don't make this struct longer!**
+   If it overlaps the frame_or_window field of struct input_event,
+   that will cause GC to crash.  */
 struct selection_input_event
 {
   int kind;
   Display *display;
+  /* We spell it with an "o" here because X does.  */
   Window requestor;
   Atom selection, target, property;
   Time time;
@@ -689,6 +733,7 @@ struct selection_input_event
 
 #define SELECTION_EVENT_DISPLAY(eventp)        \
   (((struct selection_input_event *) (eventp))->display)
+/* We spell it with an "o" here because X does.  */
 #define SELECTION_EVENT_REQUESTOR(eventp)      \
   (((struct selection_input_event *) (eventp))->requestor)
 #define SELECTION_EVENT_SELECTION(eventp)      \