src/w32term.h

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