src/w32term.h

   1 /* Definitions and headers for communication on the Microsoft W32 API.
   2    Copyright (C) 1995, 2001-2012 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 3 of the License, or
   9 (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /* Added by Kevin Gallo */
  20
  21 #include "w32gui.h"
  22
  23 \f
  24 #define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
  25 #define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
  26
  27 #define FONT_WIDTH(f)     ((f)->max_width)
  28 #define FONT_HEIGHT(f)    ((f)->height)
  29 #define FONT_BASE(f)      ((f)->ascent)
  30 #define FONT_DESCENT(f)   ((f)->descent)
  31
  32 #define CP_DEFAULT 1004
  33
  34 #define CHECK_W32_FRAME(f, frame)               \
  35   if (NILP (frame))                             \
  36     f = SELECTED_FRAME ();                      \
  37   else                                          \
  38     {                                           \
  39       CHECK_LIVE_FRAME (frame, 0);              \
  40       f = XFRAME (frame);                       \
  41     }                                           \
  42   if (! FRAME_W32_P (f))
  43
  44 /* Indicates whether we are in the readsocket call and the message we
  45    are processing in the current loop */
  46
  47 extern MSG CurMsg;
  48 extern BOOL bUseDflt;
  49
  50 /* Structure recording bitmaps and reference count.
  51    If REFCOUNT is 0 then this record is free to be reused.  */
  52
  53 struct w32_bitmap_record
  54 {
  55   Pixmap pixmap;
  56   char *file;
  57   HINSTANCE hinst; /* Used to load the file */
  58   int refcount;
  59   /* Record some info about this pixmap.  */
  60   int height, width, depth;
  61 };
  62
  63 struct w32_palette_entry {
  64   struct w32_palette_entry * next;
  65   PALETTEENTRY entry;
  66 #if 0
  67   unsigned refcount;
  68 #endif
  69 };
  70
  71 extern void w32_regenerate_palette (struct frame *f);
  72
  73 \f
  74 /* For each display (currently only one on w32), we have a structure that
  75    records information about it.  */
  76
  77 struct w32_display_info
  78 {
  79   /* Chain of all w32_display_info structures.  */
  80   struct w32_display_info *next;
  81
  82   /* The generic display parameters corresponding to this w32 display.  */
  83   struct terminal *terminal;
  84
  85   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
  86      The same cons cell also appears in x_display_name_list.  */
  87   Lisp_Object name_list_element;
  88
  89   /* Number of frames that are on this display.  */
  90   int reference_count;
  91
  92   /* Dots per inch of the screen.  */
  93   double resx, resy;
  94
  95   /* Number of planes on this screen.  */
  96   int n_planes;
  97
  98   /* Number of bits per pixel on this screen.  */
  99   int n_cbits;
 100
 101   /* Mask of things that cause the mouse to be grabbed.  */
 102   int grabbed;
 103
 104   /* Emacs bitmap-id of the default icon bitmap for this frame.
 105      Or -1 if none has been allocated yet.  */
 106   ptrdiff_t icon_bitmap_id;
 107
 108   /* The root window of this screen.  */
 109   Window root_window;
 110
 111   /* The cursor to use for vertical scroll bars.  */
 112   Cursor vertical_scroll_bar_cursor;
 113
 114   /* Resource data base */
 115   XrmDatabase xrdb;
 116
 117   /* color palette information.  */
 118   int has_palette;
 119   struct w32_palette_entry * color_list;
 120   unsigned num_colors;
 121   HPALETTE palette;
 122
 123   /* deferred action flags checked when starting frame update.  */
 124   int regen_palette;
 125
 126   /* Keystroke that has been faked by Emacs and will be ignored when
 127      received; value is reset after key is received.  */
 128   int faked_key;
 129
 130   /* Minimum width over all characters in all fonts in font_table.  */
 131   int smallest_char_width;
 132
 133   /* Minimum font height over all fonts in font_table.  */
 134   int smallest_font_height;
 135
 136   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 137   XGCValues *scratch_cursor_gc;
 138
 139   /* Information about the range of text currently shown in
 140      mouse-face.  */
 141   Mouse_HLInfo mouse_highlight;
 142
 143   char *w32_id_name;
 144
 145   /* The number of fonts actually stored in w32_font_table.
 146      font_table[n] is used and valid if 0 <= n < n_fonts. 0 <=
 147      n_fonts <= font_table_size. and font_table[i].name != 0. */
 148   int n_fonts;
 149
 150   /* Pointer to bitmap records.  */
 151   struct w32_bitmap_record *bitmaps;
 152
 153   /* Allocated size of bitmaps field.  */
 154   ptrdiff_t bitmaps_size;
 155
 156   /* Last used bitmap index.  */
 157   ptrdiff_t bitmaps_last;
 158
 159   /* The frame (if any) which has the window that has keyboard focus.
 160      Zero if none.  This is examined by Ffocus_frame in w32fns.c.  Note
 161      that a mere EnterNotify event can set this; if you need to know the
 162      last frame specified in a FocusIn or FocusOut event, use
 163      w32_focus_event_frame.  */
 164   struct frame *w32_focus_frame;
 165
 166   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 167      separate from w32_focus_frame, because whether or not LeaveNotify
 168      events cause us to lose focus depends on whether or not we have
 169      received a FocusIn event for it.  */
 170   struct frame *w32_focus_event_frame;
 171
 172   /* The frame which currently has the visual highlight, and should get
 173      keyboard input (other sorts of input have the frame encoded in the
 174      event).  It points to the focus frame's selected window's
 175      frame.  It differs from w32_focus_frame when we're using a global
 176      minibuffer.  */
 177   struct frame *x_highlight_frame;
 178 };
 179
 180 /* This is a chain of structures for all the displays currently in use.  */
 181 extern struct w32_display_info *x_display_list;
 182 extern struct w32_display_info one_w32_display_info;
 183
 184 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 185    one for each element of w32_display_list and in the same order.
 186    NAME is the name of the frame.
 187    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 188 extern Lisp_Object w32_display_name_list;
 189
 190 extern struct frame *x_window_to_frame (struct w32_display_info *, HWND);
 191
 192 struct w32_display_info *x_display_info_for_name (Lisp_Object);
 193
 194 Lisp_Object display_x_get_resource (struct w32_display_info *,
 195                                     Lisp_Object, Lisp_Object,
 196                                     Lisp_Object, Lisp_Object);
 197
 198 extern struct w32_display_info *w32_term_init (Lisp_Object,
 199                                                char *, char *);
 200
 201 extern int x_display_pixel_height (struct w32_display_info *);
 202 extern int x_display_pixel_width (struct w32_display_info *);
 203
 204 \f
 205 #define PIX_TYPE COLORREF
 206
 207 /* Each W32 frame object points to its own struct w32_display object
 208    in the output_data.w32 field.  The w32_display structure contains all
 209    the information that is specific to W32 windows.  */
 210
 211 /* Put some things in x_output for compatibility.
 212    NTEMACS_TODO: Move all common things here to eliminate unnecessary
 213    diffs between X and w32 code.  */
 214 struct x_output
 215 {
 216 #if 0 /* These are also defined in struct frame.  Use that instead.  */
 217   PIX_TYPE background_pixel;
 218   PIX_TYPE foreground_pixel;
 219 #endif
 220
 221   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 222      frame, or IMPLICIT if we received an EnterNotify.
 223      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 224   int focus_state;
 225
 226 };
 227
 228 enum
 229 {
 230   /* Values for focus_state, used as bit mask.
 231      EXPLICIT means we received a FocusIn for the frame and know it has
 232      the focus.  IMPLICIT means we received an EnterNotify and the frame
 233      may have the focus if no window manager is running.
 234      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 235   FOCUS_NONE     = 0,
 236   FOCUS_IMPLICIT = 1,
 237   FOCUS_EXPLICIT = 2
 238 };
 239
 240 struct w32_output
 241 {
 242   /* Placeholder for things accessed through output_data.x.  */
 243   struct x_output x_compatible;
 244
 245   /* Menubar "widget" handle.  */
 246   HMENU menubar_widget;
 247
 248   /* Original palette (used to deselect real palette after drawing) */
 249   HPALETTE old_palette;
 250
 251   /* Here are the Graphics Contexts for the default font.  */
 252   XGCValues *cursor_gc;                         /* cursor drawing */
 253
 254   /* The window used for this frame.
 255      May be zero while the frame object is being created
 256      and the window has not yet been created.  */
 257   Window window_desc;
 258
 259   /* The window that is the parent of this window.
 260      Usually this is a window that was made by the window manager,
 261      but it can be the root window, and it can be explicitly specified
 262      (see the explicit_parent field, below).  */
 263   Window parent_desc;
 264
 265   /* Default ASCII font of this frame. */
 266   struct font *font;
 267
 268   /* The baseline offset of the default ASCII font.  */
 269   int baseline_offset;
 270
 271   /* If a fontset is specified for this frame instead of font, this
 272      value contains an ID of the fontset, else -1.  */
 273   int fontset;
 274
 275   /* Pixel values used for various purposes.
 276      border_pixel may be -1 meaning use a gray tile.  */
 277   COLORREF cursor_pixel;
 278   COLORREF border_pixel;
 279   COLORREF mouse_pixel;
 280   COLORREF cursor_foreground_pixel;
 281
 282   /* Foreground color for scroll bars.  A value of -1 means use the
 283      default (black for non-toolkit scroll bars).  */
 284   COLORREF scroll_bar_foreground_pixel;
 285
 286   /* Background color for scroll bars.  A value of -1 means use the
 287      default (background color of the frame for non-toolkit scroll
 288      bars).  */
 289   COLORREF scroll_bar_background_pixel;
 290
 291   /* Descriptor for the cursor in use for this window.  */
 292   Cursor text_cursor;
 293   Cursor nontext_cursor;
 294   Cursor modeline_cursor;
 295   Cursor hand_cursor;
 296   Cursor hourglass_cursor;
 297   Cursor horizontal_drag_cursor;
 298
 299   /* Non-zero means hourglass cursor is currently displayed.  */
 300   unsigned hourglass_p : 1;
 301
 302   /* Non-hourglass cursor that is currently active.  */
 303   Cursor current_cursor;
 304
 305   /* Flag to set when the window needs to be completely repainted.  */
 306   int needs_exposure;
 307
 308   DWORD dwStyle;
 309
 310   /* This is the Emacs structure for the display this frame is on.  */
 311   /* struct w32_display_info *display_info; */
 312
 313   /* Nonzero means our parent is another application's window
 314      and was explicitly specified.  */
 315   char explicit_parent;
 316
 317   /* Nonzero means tried already to make this frame visible.  */
 318   char asked_for_visible;
 319
 320   /* Nonzero means menubar is currently active.  */
 321   char menubar_active;
 322
 323   /* Nonzero means menubar is about to become active, but should be
 324      brought up to date first.  */
 325   volatile char pending_menu_activation;
 326
 327   /* Relief GCs, colors etc.  */
 328   struct relief
 329   {
 330     XGCValues *gc;
 331     unsigned long pixel;
 332     int allocated_p;
 333   }
 334   black_relief, white_relief;
 335
 336   /* The background for which the above relief GCs were set up.
 337      They are changed only when a different background is involved.  */
 338   unsigned long relief_background;
 339 };
 340
 341 extern struct w32_output w32term_display;
 342
 343 /* Return the X output data for frame F.  */
 344 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 345
 346 /* Return the window associated with the frame F.  */
 347 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 348 #define FRAME_X_WINDOW(f) ((f)->output_data.w32->window_desc)
 349
 350 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 351 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 352 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 353
 354 /* This gives the w32_display_info structure for the display F is on.  */
 355 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 356 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 357
 358 /* This is the `Display *' which frame F is on.  */
 359 #define FRAME_X_DISPLAY(f) (0)
 360
 361 /* Value is the smallest width of any character in any font on frame F.  */
 362
 363 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 364      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 365
 366 /* Value is the smallest height of any font on frame F.  */
 367
 368 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 369      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 370 \f
 371 /* W32-specific scroll bar stuff.  */
 372
 373 /* We represent scroll bars as lisp vectors.  This allows us to place
 374    references to them in windows without worrying about whether we'll
 375    end up with windows referring to dead scroll bars; the garbage
 376    collector will free it when its time comes.
 377
 378    We use struct scroll_bar as a template for accessing fields of the
 379    vector.  */
 380
 381 struct scroll_bar {
 382
 383   /* These fields are shared by all vectors.  */
 384   EMACS_INT size_from_Lisp_Vector_struct;
 385   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 386
 387   /* The window we're a scroll bar for.  */
 388   Lisp_Object window;
 389
 390   /* The next and previous in the chain of scroll bars in this frame.  */
 391   Lisp_Object next, prev;
 392
 393   /* The window representing this scroll bar.  Since this is a full
 394      32-bit quantity, we store it split into two 32-bit values.  */
 395   Lisp_Object w32_window_low, w32_window_high;
 396
 397   /* Same as above for the widget.  */
 398   Lisp_Object w32_widget_low, w32_widget_high;
 399
 400   /* The position and size of the scroll bar in pixels, relative to the
 401      frame.  */
 402   Lisp_Object top, left, width, height;
 403
 404   /* The starting and ending positions of the handle, relative to the
 405      handle area (i.e. zero is the top position, not
 406      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 407      hasn't been drawn yet.
 408
 409      These are not actually the locations where the beginning and end
 410      are drawn; in order to keep handles from becoming invisible when
 411      editing large files, we establish a minimum height by always
 412      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 413      where they would be normally; the bottom and top are in a
 414      different co-ordinate system.  */
 415   Lisp_Object start, end;
 416
 417   /* If the scroll bar handle is currently being dragged by the user,
 418      this is the number of pixels from the top of the handle to the
 419      place where the user grabbed it.  If the handle isn't currently
 420      being dragged, this is Qnil.  */
 421   Lisp_Object dragging;
 422
 423   /* t if the background of the fringe that is adjacent to a scroll
 424      bar is extended to the gap between the fringe and the bar.  */
 425   Lisp_Object fringe_extended_p;
 426 };
 427
 428 /* The number of elements a vector holding a struct scroll_bar needs.  */
 429 #define SCROLL_BAR_VEC_SIZE                                     \
 430   ((sizeof (struct scroll_bar)                                  \
 431     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 432    / sizeof (Lisp_Object))
 433
 434 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 435 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 436
 437
 438 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 439 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 440
 441 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 442 #define SCROLL_BAR_UNPACK(low, high, int32) \
 443   (XSETINT ((low),   (int32)        & 0xffff), \
 444    XSETINT ((high), ((int32) >> 16) & 0xffff))
 445
 446
 447 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 448 #define SCROLL_BAR_W32_WINDOW(ptr) \
 449   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 450
 451 /* Store a window id in a struct scroll_bar.  */
 452 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 453   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 454
 455 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 456 #define SCROLL_BAR_X_WIDGET(ptr) \
 457   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 458
 459 /* Store a widget id in a struct scroll_bar.  */
 460 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 461   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 462
 463 /* Return the inside width of a vertical scroll bar, given the outside
 464    width.  */
 465 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 466   ((width) \
 467    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 468    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 469    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 470
 471 /* Return the length of the rectangle within which the top of the
 472    handle must stay.  This isn't equivalent to the inside height,
 473    because the scroll bar handle has a minimum height.
 474
 475    This is the real range of motion for the scroll bar, so when we're
 476    scaling buffer positions to scroll bar positions, we use this, not
 477    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 478 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 479   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 480
 481 /* Return the inside height of vertical scroll bar, given the outside
 482    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 483 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 484   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 485
 486
 487 /* Border widths for scroll bars.
 488
 489    Scroll bar windows don't have any borders; their border width is
 490    set to zero, and we redraw borders ourselves.  This makes the code
 491    a bit cleaner, since we don't have to convert between outside width
 492    (used when relating to the rest of the screen) and inside width
 493    (used when sizing and drawing the scroll bar window itself).
 494
 495    The handle moves up and down/back and forth in a rectangle inset
 496    from the edges of the scroll bar.  These are widths by which we
 497    inset the handle boundaries from the scroll bar edges.  */
 498 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 499 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 500 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 501 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 502
 503 /* Minimum lengths for scroll bar handles, in pixels.  */
 504 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 505
 506 /* Trimming off a few pixels from each side prevents
 507    text from glomming up against the scroll bar */
 508 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 509
 510 \f
 511 struct frame;  /* from frame.h */
 512
 513 extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
 514 extern void w32_clear_window (struct frame *);
 515
 516 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 517 do { \
 518     RECT rect; \
 519     rect.left = x; \
 520     rect.top = y; \
 521     rect.right = x + nx; \
 522     rect.bottom = y + ny; \
 523     w32_fill_rect (f,hdc,pix,&rect); \
 524 } while (0)
 525
 526 #define w32_clear_rect(f,hdc,lprect) \
 527   w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
 528
 529 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 530   w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
 531
 532 /* Define for earlier versions of Visual C */
 533 #ifndef WM_MOUSEWHEEL
 534 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 535 #endif /* WM_MOUSEWHEEL */
 536 #ifndef MSH_MOUSEWHEEL
 537 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 538 #endif /* MSH_MOUSEWHEEL */
 539 #ifndef WM_XBUTTONDOWN
 540 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 541 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 542 #endif /* WM_XBUTTONDOWN */
 543 #ifndef WM_MOUSEHWHEEL
 544 #define WM_MOUSEHWHEEL                 (WM_MOUSEWHEEL + 4)
 545 #endif /* WM_MOUSEHWHEEL  */
 546 #ifndef WM_APPCOMMAND
 547 #define WM_APPCOMMAND 0x319
 548 #define GET_APPCOMMAND_LPARAM(lParam)  (HIWORD(lParam) & 0x7fff)
 549 #endif
 550 #ifndef WM_UNICHAR
 551 #define WM_UNICHAR 0x109
 552 #endif
 553 #ifndef UNICODE_NOCHAR
 554 #define UNICODE_NOCHAR 0xFFFF
 555 #endif
 556
 557 #define WM_EMACS_START                 (WM_USER + 1)
 558 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 559 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 560 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 561 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 562 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 563 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 564 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 565 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 566 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 567 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 568 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 569 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 570 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 571 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 572 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 573 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 574 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 575 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 576 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 577 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
 578 #define WM_EMACS_PAINT                 (WM_EMACS_START + 20)
 579 #define WM_EMACS_BRINGTOTOP            (WM_EMACS_START + 21)
 580 #define WM_EMACS_END                   (WM_EMACS_START + 22)
 581
 582 #define WND_FONTWIDTH_INDEX    (0)
 583 #define WND_LINEHEIGHT_INDEX   (4)
 584 #define WND_BORDER_INDEX       (8)
 585 #define WND_SCROLLBAR_INDEX    (12)
 586 #define WND_BACKGROUND_INDEX   (16)
 587 #define WND_LAST_INDEX         (20)
 588
 589 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 590
 591 extern DWORD dwWindowsThreadId;
 592 extern HANDLE hWindowsThread;
 593 extern DWORD dwMainThreadId;
 594 extern HANDLE hMainThread;
 595
 596 typedef struct W32Msg {
 597     MSG msg;
 598     DWORD dwModifiers;
 599     RECT rect;
 600 } W32Msg;
 601
 602 /* Structure for recording message when input thread must return a
 603    result that depends on lisp thread to compute.  Lisp thread can
 604    complete deferred messages out of order.  */
 605 typedef struct deferred_msg
 606 {
 607   struct deferred_msg * next;
 608   W32Msg                w32msg;
 609   LRESULT               result;
 610   int                   completed;
 611 } deferred_msg;
 612
 613 extern CRITICAL_SECTION critsect;
 614
 615 extern void init_crit (void);
 616 extern void delete_crit (void);
 617
 618 extern void signal_quit (void);
 619
 620 #define enter_crit() EnterCriticalSection (&critsect)
 621 #define leave_crit() LeaveCriticalSection (&critsect)
 622
 623 extern void select_palette (struct frame * f, HDC hdc);
 624 extern void deselect_palette (struct frame * f, HDC hdc);
 625 extern HDC get_frame_dc (struct frame * f);
 626 extern int release_frame_dc (struct frame * f, HDC hDC);
 627
 628 extern void drain_message_queue (void);
 629
 630 extern BOOL get_next_msg (W32Msg *, BOOL);
 631 extern BOOL post_msg (W32Msg *);
 632 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 633
 634 extern BOOL parse_button (int, int, int *, int *);
 635
 636 extern void w32_sys_ring_bell (struct frame *f);
 637 extern void x_delete_display (struct w32_display_info *dpyinfo);
 638
 639 /* Keypad command key support.  W32 doesn't have virtual keys defined
 640    for the function keys on the keypad (they are mapped to the standard
 641    function keys), so we define our own.  */
 642 #define VK_NUMPAD_BEGIN         0x92
 643 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 644 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 645 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 646 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 647 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 648 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 649 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 650 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 651 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 652 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 653 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 654 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 655
 656 #ifndef VK_LWIN
 657 /* Older compiler environments don't have these defined.  */
 658 #define VK_LWIN                 0x5B
 659 #define VK_RWIN                 0x5C
 660 #define VK_APPS                 0x5D
 661 #endif
 662
 663 /* Support for treating Windows and Apps keys as modifiers.  These
 664    constants must not overlap with any of the dwControlKeyState flags in
 665    KEY_EVENT_RECORD.  */
 666 #define LEFT_WIN_PRESSED       0x8000
 667 #define RIGHT_WIN_PRESSED      0x4000
 668 #define APPS_PRESSED           0x2000
 669
 670 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 671    (even though they are supported on 98 and ME.  */
 672 #ifndef WM_MOUSELEAVE
 673 #define WM_MOUSELEAVE 0x02A3
 674 #define TME_LEAVE 0x00000002;
 675
 676 typedef struct tagTRACKMOUSEEVENT
 677 {
 678   DWORD cbSize;
 679   DWORD dwFlags;
 680   HWND hwndTrack;
 681   DWORD dwHoverTime;
 682 } TRACKMOUSEEVENT;
 683 #endif
 684
 685 struct image;
 686 struct face;
 687
 688 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 689 struct frame * check_x_frame (Lisp_Object);
 690
 691 typedef DWORD (WINAPI * ClipboardSequence_Proc) (void);
 692 typedef BOOL (WINAPI * AppendMenuW_Proc) (
 693     IN HMENU,
 694     IN UINT,
 695     IN UINT_PTR,
 696     IN LPCWSTR);
 697
 698 extern HWND w32_system_caret_hwnd;
 699 extern int w32_system_caret_height;
 700 extern int w32_system_caret_x;
 701 extern int w32_system_caret_y;