src/w32term.h

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