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