src/w32term.h

   1 /* Definitions and headers for communication on the Microsoft W32 API.
   2    Copyright (C) 1995, 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Added by Kevin Gallo */
  22
  23 #include "w32gui.h"
  24
  25 \f
  26 #define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
  27 #define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
  28
  29 #define FONT_WIDTH(f)       \
  30   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmAveCharWidth)
  31 #define FONT_HEIGHT(f)      \
  32    ((f)->bdf ? (f)->bdf->height : (f)->tm.tmHeight)
  33 #define FONT_BASE(f)        \
  34   ((f)->bdf ? (f)->bdf->ury : (f)->tm.tmAscent)
  35 #define FONT_DESCENT(f)     \
  36   ((f)->bdf ? -((f)->bdf->lly) : (f)->tm.tmDescent)
  37 #define FONT_MAX_WIDTH(f)   \
  38   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmMaxCharWidth)
  39
  40 #define CP_DEFAULT 1004
  41 /* Special pseudo-codepages. */
  42 #define CP_8BIT      -1
  43 #define CP_UNICODE   -2
  44 #define CP_UNKNOWN   -3
  45
  46 #define CHECK_W32_FRAME(f, frame)               \
  47   if (NILP (frame))                             \
  48     f = SELECTED_FRAME ();                      \
  49   else                                          \
  50     {                                           \
  51       CHECK_LIVE_FRAME (frame, 0);              \
  52       f = XFRAME (frame);                       \
  53     }                                           \
  54   if (! FRAME_W32_P (f))
  55
  56 /* Indicates whether we are in the readsocket call and the message we
  57    are processing in the current loop */
  58
  59 extern MSG CurMsg;
  60 extern BOOL bUseDflt;
  61
  62 extern struct frame *x_window_to_frame ();
  63
  64 /* Structure recording bitmaps and reference count.
  65    If REFCOUNT is 0 then this record is free to be reused.  */
  66
  67 struct w32_bitmap_record
  68 {
  69   Pixmap pixmap;
  70   char *file;
  71   HINSTANCE hinst; /* Used to load the file */
  72   int refcount;
  73   /* Record some info about this pixmap.  */
  74   int height, width, depth;
  75 };
  76
  77 /* Palette book-keeping stuff for mapping requested colors into the
  78    system palette.  Keep a ref-counted list of requested colors and
  79    regenerate the app palette whenever the requested list changes. */
  80
  81 extern Lisp_Object Vw32_enable_palette;
  82
  83 struct w32_palette_entry {
  84   struct w32_palette_entry * next;
  85   PALETTEENTRY entry;
  86 #if 0
  87   unsigned refcount;
  88 #endif
  89 };
  90
  91 extern void w32_regenerate_palette(struct frame *f);
  92
  93 \f
  94 /* For each display (currently only one on w32), we have a structure that
  95    records information about it.  */
  96
  97 struct w32_display_info
  98 {
  99   /* Chain of all w32_display_info structures.  */
 100   struct w32_display_info *next;
 101
 102   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 103      The same cons cell also appears in x_display_name_list.  */
 104   Lisp_Object name_list_element;
 105
 106   /* Number of frames that are on this display.  */
 107   int reference_count;
 108
 109   /* Dots per inch of the screen.  */
 110   double resx, resy;
 111
 112   /* Number of planes on this screen.  */
 113   int n_planes;
 114
 115   /* Number of bits per pixel on this screen.  */
 116   int n_cbits;
 117
 118   /* Dimensions of this screen.  */
 119   int height, width;
 120   int height_in,width_in;
 121
 122   /* Mask of things that cause the mouse to be grabbed.  */
 123   int grabbed;
 124
 125   /* Emacs bitmap-id of the default icon bitmap for this frame.
 126      Or -1 if none has been allocated yet.  */
 127   int icon_bitmap_id;
 128
 129   /* The root window of this screen.  */
 130   Window root_window;
 131
 132   /* The cursor to use for vertical scroll bars.  */
 133   Cursor vertical_scroll_bar_cursor;
 134
 135   /* Resource data base */
 136   XrmDatabase xrdb;
 137
 138   /* color palette information.  */
 139   int has_palette;
 140   struct w32_palette_entry * color_list;
 141   unsigned num_colors;
 142   HPALETTE palette;
 143
 144   /* deferred action flags checked when starting frame update.  */
 145   int regen_palette;
 146
 147   /* Keystroke that has been faked by Emacs and will be ignored when
 148      received; value is reset after key is received.  */
 149   int faked_key;
 150
 151   /* A table of all the fonts we have already loaded.  */
 152   struct font_info *font_table;
 153
 154   /* The current capacity of font_table.  */
 155   int font_table_size;
 156
 157   /* Minimum width over all characters in all fonts in font_table.  */
 158   int smallest_char_width;
 159
 160   /* Minimum font height over all fonts in font_table.  */
 161   int smallest_font_height;
 162
 163   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 164   XGCValues *scratch_cursor_gc;
 165
 166   /* These variables describe the range of text currently shown in its
 167      mouse-face, together with the window they apply to. As long as
 168      the mouse stays within this range, we need not redraw anything on
 169      its account.  Rows and columns are glyph matrix positions in
 170      MOUSE_FACE_WINDOW.  */
 171   int mouse_face_beg_row, mouse_face_beg_col;
 172   int mouse_face_beg_x, mouse_face_beg_y;
 173   int mouse_face_end_row, mouse_face_end_col;
 174   int mouse_face_end_x, mouse_face_end_y;
 175   int mouse_face_past_end;
 176   Lisp_Object mouse_face_window;
 177   int mouse_face_face_id;
 178   Lisp_Object mouse_face_overlay;
 179
 180   /* 1 if a mouse motion event came and we didn't handle it right away because
 181      gc was in progress.  */
 182   int mouse_face_deferred_gc;
 183
 184   /* FRAME and X, Y position of mouse when last checked for
 185      highlighting.  X and Y can be negative or out of range for the frame.  */
 186   struct frame *mouse_face_mouse_frame;
 187   int mouse_face_mouse_x, mouse_face_mouse_y;
 188
 189   /* Nonzero means defer mouse-motion highlighting.  */
 190   int mouse_face_defer;
 191
 192   /* Nonzero means that the mouse highlight should not be shown.  */
 193   int mouse_face_hidden;
 194
 195   int mouse_face_image_state;
 196
 197   char *w32_id_name;
 198
 199   /* The number of fonts actually stored in w32_font_table.
 200      font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
 201      n_fonts <= font_table_size. and font_table[i].name != 0. */
 202   int n_fonts;
 203
 204   /* Pointer to bitmap records.  */
 205   struct w32_bitmap_record *bitmaps;
 206
 207   /* Allocated size of bitmaps field.  */
 208   int bitmaps_size;
 209
 210   /* Last used bitmap index.  */
 211   int bitmaps_last;
 212
 213   /* The frame (if any) which has the window that has keyboard focus.
 214      Zero if none.  This is examined by Ffocus_frame in w32fns.c.  Note
 215      that a mere EnterNotify event can set this; if you need to know the
 216      last frame specified in a FocusIn or FocusOut event, use
 217      w32_focus_event_frame.  */
 218   struct frame *w32_focus_frame;
 219
 220   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 221      separate from w32_focus_frame, because whether or not LeaveNotify
 222      events cause us to lose focus depends on whether or not we have
 223      received a FocusIn event for it.  */
 224   struct frame *w32_focus_event_frame;
 225
 226   /* The frame which currently has the visual highlight, and should get
 227      keyboard input (other sorts of input have the frame encoded in the
 228      event).  It points to the focus frame's selected window's
 229      frame.  It differs from w32_focus_frame when we're using a global
 230      minibuffer.  */
 231   struct frame *x_highlight_frame;
 232
 233   /* Cache of images.  */
 234   struct image_cache *image_cache;
 235 };
 236
 237 /* This is a chain of structures for all the displays currently in use.  */
 238 extern struct w32_display_info *x_display_list;
 239 extern struct w32_display_info one_w32_display_info;
 240
 241 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 242    one for each element of w32_display_list and in the same order.
 243    NAME is the name of the frame.
 244    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 245 extern Lisp_Object w32_display_name_list;
 246
 247 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
 248 extern Lisp_Object Vx_pixel_size_width_font_regexp;
 249
 250 /* A flag to control how to display unibyte 8-bit character.  */
 251 extern int unibyte_display_via_language_environment;
 252
 253 struct w32_display_info *x_display_info_for_name ();
 254
 255 extern struct w32_display_info *w32_term_init ();
 256 \f
 257 extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
 258 extern struct font_info *w32_get_font_info (), *w32_query_font ();
 259 extern void w32_cache_char_metrics (XFontStruct *font);
 260 extern void w32_find_ccl_program();
 261 \f
 262 #define PIX_TYPE COLORREF
 263
 264 /* Each W32 frame object points to its own struct w32_display object
 265    in the output_data.w32 field.  The w32_display structure contains all
 266    the information that is specific to W32 windows.  */
 267
 268 /* Put some things in x_output for compatibility.
 269    NTEMACS_TODO: Move all common things here to eliminate unneccesary
 270    diffs between X and w32 code.  */
 271 struct x_output
 272 {
 273   PIX_TYPE background_pixel;
 274   PIX_TYPE foreground_pixel;
 275 };
 276
 277
 278 struct w32_output
 279 {
 280   /* Placeholder for things accessed through output_data.x.  */
 281   struct x_output x_compatible;
 282
 283   /* Menubar "widget" handle.  */
 284   HMENU menubar_widget;
 285
 286   /* Original palette (used to deselect real palette after drawing) */
 287   HPALETTE old_palette;
 288
 289   /* Position of the W32 window (x and y offsets in root window).  */
 290   int left_pos;
 291   int top_pos;
 292
 293   /* Border width of the W32 window as known by the window system.  */
 294   int border_width;
 295
 296   /* Size of the W32 window in pixels.  */
 297   int pixel_height, pixel_width;
 298
 299   /* Height of a line, in pixels.  */
 300   int line_height;
 301
 302   /* Here are the Graphics Contexts for the default font.  */
 303   XGCValues *cursor_gc;                         /* cursor drawing */
 304
 305   /* Width of the internal border.  This is a line of background color
 306      just inside the window's border.  When the frame is selected,
 307      a highlighting is displayed inside the internal border.  */
 308   int internal_border_width;
 309
 310   /* The window used for this frame.
 311      May be zero while the frame object is being created
 312      and the window has not yet been created.  */
 313   Window window_desc;
 314
 315   /* The window that is the parent of this window.
 316      Usually this is a window that was made by the window manager,
 317      but it can be the root window, and it can be explicitly specified
 318      (see the explicit_parent field, below).  */
 319   Window parent_desc;
 320
 321   /* Default ASCII font of this frame. */
 322   XFontStruct *font;
 323
 324   /* The baseline offset of the default ASCII font.  */
 325   int baseline_offset;
 326
 327   /* If a fontset is specified for this frame instead of font, this
 328      value contains an ID of the fontset, else -1.  */
 329   int fontset;
 330
 331   /* Pixel values used for various purposes.
 332      border_pixel may be -1 meaning use a gray tile.  */
 333   COLORREF cursor_pixel;
 334   COLORREF border_pixel;
 335   COLORREF mouse_pixel;
 336   COLORREF cursor_foreground_pixel;
 337
 338   /* Foreground color for scroll bars.  A value of -1 means use the
 339      default (black for non-toolkit scroll bars).  */
 340   COLORREF scroll_bar_foreground_pixel;
 341
 342   /* Background color for scroll bars.  A value of -1 means use the
 343      default (background color of the frame for non-toolkit scroll
 344      bars).  */
 345   COLORREF scroll_bar_background_pixel;
 346
 347   /* Descriptor for the cursor in use for this window.  */
 348   Cursor text_cursor;
 349   Cursor nontext_cursor;
 350   Cursor modeline_cursor;
 351   Cursor hand_cursor;
 352   Cursor hourglass_cursor;
 353   Cursor horizontal_drag_cursor;
 354
 355   /* Window whose cursor is hourglass_cursor.  This window is
 356      temporarily mapped to display an hourglass cursor.  */
 357   Window hourglass_window;
 358
 359   /* Non-zero means hourglass cursor is currently displayed.  */
 360   unsigned hourglass_p : 1;
 361
 362   /* Flag to set when the window needs to be completely repainted.  */
 363   int needs_exposure;
 364
 365   DWORD dwStyle;
 366
 367   /* The size of the extra width currently allotted for vertical
 368      scroll bars, in pixels.  */
 369   int vertical_scroll_bar_extra;
 370
 371   /* The extra width currently allotted for the areas in which
 372      truncation marks, continuation marks, and overlay arrows are
 373      displayed.  */
 374   int left_fringe_width, right_fringe_width;
 375   int fringe_cols, fringes_extra;
 376
 377   /* This is the gravity value for the specified window position.  */
 378   int win_gravity;
 379
 380   /* The geometry flags for this window.  */
 381   int size_hint_flags;
 382
 383   /* This is the Emacs structure for the display this frame is on.  */
 384   /* struct w32_display_info *display_info; */
 385
 386   /* Nonzero means our parent is another application's window
 387      and was explicitly specified.  */
 388   char explicit_parent;
 389
 390   /* Nonzero means tried already to make this frame visible.  */
 391   char asked_for_visible;
 392
 393   /* Nonzero means menubar is currently active.  */
 394   char menubar_active;
 395
 396   /* Nonzero means a menu command is being processed.  */
 397   char menu_command_in_progress;
 398
 399   /* Nonzero means menubar is about to become active, but should be
 400      brought up to date first.  */
 401   volatile char pending_menu_activation;
 402
 403   /* Relief GCs, colors etc.  */
 404   struct relief
 405   {
 406     XGCValues *gc;
 407     unsigned long pixel;
 408     int allocated_p;
 409   }
 410   black_relief, white_relief;
 411
 412   /* The background for which the above relief GCs were set up.
 413      They are changed only when a different background is involved.  */
 414   unsigned long relief_background;
 415
 416   /* See enum below */
 417   int want_fullscreen;
 418
 419   /* This many pixels are the difference between the outer window (i.e. the
 420      left of the window manager decoration) and FRAME_W32_WINDOW. */
 421   int x_pixels_diff;
 422
 423   /* This many pixels are the difference between the outer window (i.e. the
 424      top of the window manager titlebar) and FRAME_W32_WINDOW. */
 425   int y_pixels_diff;
 426 };
 427
 428 extern struct w32_output w32term_display;
 429
 430 /* Return the X output data for frame F.  */
 431 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 432
 433 /* Return the window associated with the frame F.  */
 434 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 435 #define FRAME_X_WINDOW(f) ((f)->output_data.w32->window_desc)
 436
 437 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 438 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 439 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 440 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 441 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.w32->internal_border_width)
 442 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.w32->line_height)
 443 /* Width of the default font of frame F.  Must be defined by each
 444    terminal specific header.  */
 445 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 446 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 447
 448 /* This gives the w32_display_info structure for the display F is on.  */
 449 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 450 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 451
 452 /* This is the `Display *' which frame F is on.  */
 453 #define FRAME_X_DISPLAY(f) (0)
 454
 455 /* This is the 'font_info *' which frame F has.  */
 456 #define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
 457
 458 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 459 #define PIXEL_WIDTH(f) ((f)->output_data.w32->pixel_width)
 460 #define PIXEL_HEIGHT(f) ((f)->output_data.w32->pixel_height)
 461
 462 /* Value is the smallest width of any character in any font on frame F.  */
 463
 464 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 465      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 466
 467 /* Value is the smallest height of any font on frame F.  */
 468
 469 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 470      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 471
 472 /* Return a pointer to the image cache of frame F.  */
 473
 474 #define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
 475
 476 \f
 477 /* Total width of fringes reserved for drawing truncation bitmaps,
 478    continuation bitmaps and alike.  The width is in canonical char
 479    units of the frame.  This must currently be the case because window
 480    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 481    able to split windows horizontally nicely.  */
 482
 483 #define FRAME_X_FRINGE_COLS(F)  ((F)->output_data.w32->fringe_cols)
 484
 485 /* Total width of fringes in pixels.  */
 486
 487 #define FRAME_X_FRINGE_WIDTH(F) ((F)->output_data.w32->fringes_extra)
 488
 489 /* Pixel-width of the left and right fringe.  */
 490
 491 #define FRAME_X_LEFT_FRINGE_WIDTH(F) ((F)->output_data.w32->left_fringe_width)
 492 #define FRAME_X_RIGHT_FRINGE_WIDTH(F) ((F)->output_data.w32->right_fringe_width)
 493
 494
 495 \f
 496 /* W32-specific scroll bar stuff.  */
 497
 498 /* We represent scroll bars as lisp vectors.  This allows us to place
 499    references to them in windows without worrying about whether we'll
 500    end up with windows referring to dead scroll bars; the garbage
 501    collector will free it when its time comes.
 502
 503    We use struct scroll_bar as a template for accessing fields of the
 504    vector.  */
 505
 506 struct scroll_bar {
 507
 508   /* These fields are shared by all vectors.  */
 509   EMACS_INT size_from_Lisp_Vector_struct;
 510   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 511
 512   /* The window we're a scroll bar for.  */
 513   Lisp_Object window;
 514
 515   /* The next and previous in the chain of scroll bars in this frame.  */
 516   Lisp_Object next, prev;
 517
 518   /* The window representing this scroll bar.  Since this is a full
 519      32-bit quantity, we store it split into two 32-bit values.  */
 520   Lisp_Object w32_window_low, w32_window_high;
 521
 522   /* Same as above for the widget.  */
 523   Lisp_Object w32_widget_low, w32_widget_high;
 524
 525   /* The position and size of the scroll bar in pixels, relative to the
 526      frame.  */
 527   Lisp_Object top, left, width, height;
 528
 529   /* The starting and ending positions of the handle, relative to the
 530      handle area (i.e. zero is the top position, not
 531      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 532      hasn't been drawn yet.
 533
 534      These are not actually the locations where the beginning and end
 535      are drawn; in order to keep handles from becoming invisible when
 536      editing large files, we establish a minimum height by always
 537      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 538      where they would be normally; the bottom and top are in a
 539      different co-ordinate system.  */
 540   Lisp_Object start, end;
 541
 542   /* If the scroll bar handle is currently being dragged by the user,
 543      this is the number of pixels from the top of the handle to the
 544      place where the user grabbed it.  If the handle isn't currently
 545      being dragged, this is Qnil.  */
 546   Lisp_Object dragging;
 547 };
 548
 549 /* The number of elements a vector holding a struct scroll_bar needs.  */
 550 #define SCROLL_BAR_VEC_SIZE                                     \
 551   ((sizeof (struct scroll_bar)                                  \
 552     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 553    / sizeof (Lisp_Object))
 554
 555 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 556 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 557
 558
 559 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 560 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 561
 562 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 563 #define SCROLL_BAR_UNPACK(low, high, int32) \
 564   (XSETINT ((low),   (int32)        & 0xffff), \
 565    XSETINT ((high), ((int32) >> 16) & 0xffff))
 566
 567
 568 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 569 #define SCROLL_BAR_W32_WINDOW(ptr) \
 570   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 571
 572 /* Store a window id in a struct scroll_bar.  */
 573 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 574   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 575
 576 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 577 #define SCROLL_BAR_X_WIDGET(ptr) \
 578   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 579
 580 /* Store a widget id in a struct scroll_bar.  */
 581 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 582   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 583
 584 /* Return the inside width of a vertical scroll bar, given the outside
 585    width.  */
 586 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 587   ((width) \
 588    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 589    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 590    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 591
 592 /* Return the length of the rectangle within which the top of the
 593    handle must stay.  This isn't equivalent to the inside height,
 594    because the scroll bar handle has a minimum height.
 595
 596    This is the real range of motion for the scroll bar, so when we're
 597    scaling buffer positions to scroll bar positions, we use this, not
 598    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 599 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 600   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 601
 602 /* Return the inside height of vertical scroll bar, given the outside
 603    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 604 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 605   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 606
 607
 608 /* Border widths for scroll bars.
 609
 610    Scroll bar windows don't have any borders; their border width is
 611    set to zero, and we redraw borders ourselves.  This makes the code
 612    a bit cleaner, since we don't have to convert between outside width
 613    (used when relating to the rest of the screen) and inside width
 614    (used when sizing and drawing the scroll bar window itself).
 615
 616    The handle moves up and down/back and forth in a rectangle inset
 617    from the edges of the scroll bar.  These are widths by which we
 618    inset the handle boundaries from the scroll bar edges.  */
 619 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 620 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 621 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 622 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 623
 624 /* Minimum lengths for scroll bar handles, in pixels.  */
 625 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 626
 627 /* Trimming off a few pixels from each side prevents
 628    text from glomming up against the scroll bar */
 629 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 630
 631 \f
 632 /* Manipulating pixel sizes and character sizes.
 633    Knowledge of which factors affect the overall size of the window should
 634    be hidden in these macros, if that's possible.
 635
 636    Return the upper/left pixel position of the character cell on frame F
 637    at ROW/COL.  */
 638 #define CHAR_TO_PIXEL_ROW(f, row) \
 639   ((f)->output_data.w32->internal_border_width \
 640    + (row) * (f)->output_data.w32->line_height)
 641 #define CHAR_TO_PIXEL_COL(f, col) \
 642   ((f)->output_data.w32->internal_border_width \
 643    + (col) * FONT_WIDTH ((f)->output_data.w32->font))
 644
 645 /* Return the pixel width/height of frame F if it has
 646    WIDTH columns/HEIGHT rows.  */
 647 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 648   (CHAR_TO_PIXEL_COL (f, width) \
 649    + (f)->output_data.w32->vertical_scroll_bar_extra \
 650    + (f)->output_data.w32->fringes_extra \
 651    + (f)->output_data.w32->internal_border_width)
 652 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 653   (CHAR_TO_PIXEL_ROW (f, height) \
 654    + (f)->output_data.w32->internal_border_width)
 655
 656
 657 /* Return the row/column (zero-based) of the character cell containing
 658    the pixel on FRAME at ROW/COL.  */
 659 #define PIXEL_TO_CHAR_ROW(f, row) \
 660   (((row) - (f)->output_data.w32->internal_border_width) \
 661    / (f)->output_data.w32->line_height)
 662 #define PIXEL_TO_CHAR_COL(f, col) \
 663   (((col) - (f)->output_data.w32->internal_border_width) \
 664    / FONT_WIDTH ((f)->output_data.w32->font))
 665
 666 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 667    frame F?  */
 668 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 669   (PIXEL_TO_CHAR_COL (f, ((width) \
 670                           - (f)->output_data.w32->internal_border_width \
 671                           - (f)->output_data.w32->fringes_extra \
 672                           - (f)->output_data.w32->vertical_scroll_bar_extra)))
 673 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 674   (PIXEL_TO_CHAR_ROW (f, ((height) \
 675                           - (f)->output_data.w32->internal_border_width)))
 676
 677 \f
 678 extern void w32_fill_rect ();
 679 extern void w32_clear_window ();
 680
 681 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 682 { \
 683     RECT rect; \
 684     rect.left = x; \
 685     rect.top = y; \
 686     rect.right = x + nx; \
 687     rect.bottom = y + ny; \
 688     w32_fill_rect (f,hdc,pix,&rect); \
 689 }
 690
 691 #define w32_clear_rect(f,hdc,lprect) \
 692 w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
 693
 694 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 695 w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
 696
 697 extern struct font_info *w32_load_font ();
 698 extern void w32_unload_font ();
 699
 700 /* Define for earlier versions of Visual C */
 701 #ifndef WM_MOUSEWHEEL
 702 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 703 #endif /* WM_MOUSEWHEEL */
 704 #ifndef MSH_MOUSEWHEEL
 705 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 706 #endif /* MSH_MOUSEWHEEL */
 707 #ifndef WM_XBUTTONDOWN
 708 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 709 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 710 #endif /* WM_XBUTTONDOWN */
 711
 712 #define WM_EMACS_START                 (WM_USER + 1)
 713 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 714 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 715 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 716 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 717 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 718 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 719 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 720 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 721 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 722 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 723 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 724 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 725 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 726 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 727 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 728 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 729 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 730 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 731 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 732 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
 733 #define WM_EMACS_END                   (WM_EMACS_START + 20)
 734
 735 #define WND_FONTWIDTH_INDEX    (0)
 736 #define WND_LINEHEIGHT_INDEX   (4)
 737 #define WND_BORDER_INDEX       (8)
 738 #define WND_SCROLLBAR_INDEX    (12)
 739 #define WND_BACKGROUND_INDEX   (16)
 740 #define WND_LAST_INDEX         (20)
 741
 742 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 743
 744 extern DWORD dwWindowsThreadId;
 745 extern HANDLE hWindowsThread;
 746 extern DWORD dwMainThreadId;
 747 extern HANDLE hMainThread;
 748
 749 typedef struct W32Msg {
 750     MSG msg;
 751     DWORD dwModifiers;
 752     RECT rect;
 753 } W32Msg;
 754
 755 /* Structure for recording message when input thread must return a
 756    result that depends on lisp thread to compute.  Lisp thread can
 757    complete deferred messages out of order.  */
 758 typedef struct deferred_msg
 759 {
 760   struct deferred_msg * next;
 761   W32Msg                w32msg;
 762   LRESULT               result;
 763   int                   completed;
 764 } deferred_msg;
 765
 766 extern CRITICAL_SECTION critsect;
 767
 768 extern void init_crit ();
 769 extern void delete_crit ();
 770
 771 extern void signal_quit ();
 772
 773 #define enter_crit() EnterCriticalSection (&critsect)
 774 #define leave_crit() LeaveCriticalSection (&critsect)
 775
 776 extern void select_palette (struct frame * f, HDC hdc);
 777 extern void deselect_palette (struct frame * f, HDC hdc);
 778 extern HDC get_frame_dc (struct frame * f);
 779 extern int release_frame_dc (struct frame * f, HDC hDC);
 780
 781 extern void drain_message_queue ();
 782
 783 extern BOOL get_next_msg ();
 784 extern BOOL post_msg ();
 785 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 786 extern void wait_for_sync ();
 787
 788 extern BOOL parse_button ();
 789
 790 /* Keypad command key support.  W32 doesn't have virtual keys defined
 791    for the function keys on the keypad (they are mapped to the standard
 792    fuction keys), so we define our own.  */
 793 #define VK_NUMPAD_BEGIN         0x92
 794 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 795 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 796 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 797 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 798 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 799 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 800 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 801 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 802 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 803 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 804 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 805 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 806
 807 #ifndef VK_LWIN
 808 /* Older compiler environments don't have these defined.  */
 809 #define VK_LWIN                 0x5B
 810 #define VK_RWIN                 0x5C
 811 #define VK_APPS                 0x5D
 812 #endif
 813
 814 /* Support for treating Windows and Apps keys as modifiers.  These
 815    constants must not overlap with any of the dwControlKeyState flags in
 816    KEY_EVENT_RECORD.  */
 817 #define LEFT_WIN_PRESSED       0x8000
 818 #define RIGHT_WIN_PRESSED      0x4000
 819 #define APPS_PRESSED           0x2000
 820
 821 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 822    (even though they are supported on 98 and ME.  */
 823 #ifndef WM_MOUSELEAVE
 824 #define WM_MOUSELEAVE 0x02A3
 825 #define TME_LEAVE 0x00000002;
 826
 827 typedef struct tagTRACKMOUSEEVENT
 828 {
 829   DWORD cbSize;
 830   DWORD dwFlags;
 831   HWND hwndTrack;
 832   DWORD dwHoverTime;
 833 } TRACKMOUSEEVENT;
 834 #endif
 835
 836 struct image;
 837 struct face;
 838
 839 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 840 struct frame * check_x_frame (Lisp_Object);
 841 EXFUN (Fx_display_color_p, 1);
 842 EXFUN (Fx_display_grayscale_p, 1);
 843 int image_ascent P_ ((struct image *, struct face *));
 844
 845 #define FONT_TYPE_FOR_UNIBYTE(font, ch)                 \
 846   ((font)->bdf ? BDF_1D_FONT : ANSI_FONT)
 847
 848 #define FONT_TYPE_FOR_MULTIBYTE(font, ch)               \
 849   (!(font)->bdf                                         \
 850    ? UNICODE_FONT                                       \
 851    : ((CHARSET_DIMENSION (CHAR_CHARSET ((ch))) == 1)    \
 852       ? BDF_1D_FONT : BDF_2D_FONT))