src/w32term.h

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