src/w32term.h

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