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 extern void w32_dialog_in_progress (Lisp_Object in_progress);
 250
 251 /* w32inevt.c */
 252 extern int w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId);
 253 extern int w32_kbd_mods_to_emacs (DWORD mods, WORD key);
 254
 255 /* w32console.c */
 256 extern void w32con_hide_cursor (void);
 257 extern void w32con_show_cursor (void);
 258
 259 \f
 260 #define PIX_TYPE COLORREF
 261
 262 /* Each W32 frame object points to its own struct w32_display object
 263    in the output_data.w32 field.  The w32_display structure contains all
 264    the information that is specific to W32 windows.  */
 265
 266 /* Put some things in x_output for compatibility.
 267    NTEMACS_TODO: Move all common things here to eliminate unnecessary
 268    diffs between X and w32 code.  */
 269 struct x_output
 270 {
 271   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 272      frame, or IMPLICIT if we received an EnterNotify.
 273      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 274   int focus_state;
 275 };
 276
 277 enum
 278 {
 279   /* Values for focus_state, used as bit mask.
 280      EXPLICIT means we received a FocusIn for the frame and know it has
 281      the focus.  IMPLICIT means we received an EnterNotify and the frame
 282      may have the focus if no window manager is running.
 283      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 284   FOCUS_NONE     = 0,
 285   FOCUS_IMPLICIT = 1,
 286   FOCUS_EXPLICIT = 2
 287 };
 288
 289 struct w32_output
 290 {
 291   /* Placeholder for things accessed through output_data.x.  */
 292   struct x_output x_compatible;
 293
 294   /* Menubar "widget" handle.  */
 295   HMENU menubar_widget;
 296
 297   /* Original palette (used to deselect real palette after drawing) */
 298   HPALETTE old_palette;
 299
 300   /* Here are the Graphics Contexts for the default font.  */
 301   XGCValues *cursor_gc;                         /* cursor drawing */
 302
 303   /* The window used for this frame.
 304      May be zero while the frame object is being created
 305      and the window has not yet been created.  */
 306   Window window_desc;
 307
 308   /* The window that is the parent of this window.
 309      Usually this is a window that was made by the window manager,
 310      but it can be the root window, and it can be explicitly specified
 311      (see the explicit_parent field, below).  */
 312   Window parent_desc;
 313
 314   /* Default ASCII font of this frame. */
 315   struct font *font;
 316
 317   /* The baseline offset of the default ASCII font.  */
 318   int baseline_offset;
 319
 320   /* If a fontset is specified for this frame instead of font, this
 321      value contains an ID of the fontset, else -1.  */
 322   int fontset;
 323
 324   /* Pixel values used for various purposes.
 325      border_pixel may be -1 meaning use a gray tile.  */
 326   COLORREF cursor_pixel;
 327   COLORREF border_pixel;
 328   COLORREF mouse_pixel;
 329   COLORREF cursor_foreground_pixel;
 330
 331   /* Foreground color for scroll bars.  A value of -1 means use the
 332      default (black for non-toolkit scroll bars).  */
 333   COLORREF scroll_bar_foreground_pixel;
 334
 335   /* Background color for scroll bars.  A value of -1 means use the
 336      default (background color of the frame for non-toolkit scroll
 337      bars).  */
 338   COLORREF scroll_bar_background_pixel;
 339
 340   /* Descriptor for the cursor in use for this window.  */
 341   Cursor text_cursor;
 342   Cursor nontext_cursor;
 343   Cursor modeline_cursor;
 344   Cursor hand_cursor;
 345   Cursor hourglass_cursor;
 346   Cursor horizontal_drag_cursor;
 347   Cursor vertical_drag_cursor;
 348   Cursor left_edge_cursor;
 349   Cursor top_left_corner_cursor;
 350   Cursor top_edge_cursor;
 351   Cursor top_right_corner_cursor;
 352   Cursor right_edge_cursor;
 353   Cursor bottom_right_corner_cursor;
 354   Cursor bottom_edge_cursor;
 355   Cursor bottom_left_corner_cursor;
 356
 357   /* Non-zero means hourglass cursor is currently displayed.  */
 358   unsigned hourglass_p : 1;
 359
 360   /* Non-hourglass cursor that is currently active.  */
 361   Cursor current_cursor;
 362
 363   DWORD dwStyle;
 364
 365   /* This is the Emacs structure for the display this frame is on.  */
 366   /* struct w32_display_info *display_info; */
 367
 368   /* Nonzero means our parent is another application's window
 369      and was explicitly specified.  */
 370   unsigned explicit_parent : 1;
 371
 372   /* Nonzero means tried already to make this frame visible.  */
 373   unsigned asked_for_visible : 1;
 374
 375   /* Nonzero means menubar is currently active.  */
 376   unsigned menubar_active : 1;
 377
 378   /* Relief GCs, colors etc.  */
 379   struct relief
 380   {
 381     XGCValues *gc;
 382     unsigned long pixel;
 383   }
 384   black_relief, white_relief;
 385
 386   /* The background for which the above relief GCs were set up.
 387      They are changed only when a different background is involved.  */
 388   unsigned long relief_background;
 389
 390   /* Frame geometry and full-screen mode before it was resized by
 391      specifying the 'fullscreen' frame parameter.  Used to restore the
 392      geometry when 'fullscreen' is reset to nil.  */
 393   WINDOWPLACEMENT normal_placement;
 394   int prev_fsmode;
 395 };
 396
 397 extern struct w32_output w32term_display;
 398
 399 /* Return the X output data for frame F.  */
 400 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 401
 402 /* Return the window associated with the frame F.  */
 403 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 404 #define FRAME_X_WINDOW(f) FRAME_W32_WINDOW (f)
 405
 406 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 407 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 408 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 409
 410 /* This gives the w32_display_info structure for the display F is on.  */
 411 #define FRAME_DISPLAY_INFO(f) ((void) (f), (&one_w32_display_info))
 412
 413 /* This is the `Display *' which frame F is on.  */
 414 #define FRAME_X_DISPLAY(f) (0)
 415
 416 #define FRAME_NORMAL_PLACEMENT(F) ((F)->output_data.w32->normal_placement)
 417 #define FRAME_PREV_FSMODE(F)      ((F)->output_data.w32->prev_fsmode)
 418
 419 \f
 420 /* W32-specific scroll bar stuff.  */
 421
 422 /* We represent scroll bars as lisp vectors.  This allows us to place
 423    references to them in windows without worrying about whether we'll
 424    end up with windows referring to dead scroll bars; the garbage
 425    collector will free it when its time comes.
 426
 427    We use struct scroll_bar as a template for accessing fields of the
 428    vector.  */
 429
 430 struct scroll_bar {
 431
 432   /* This field is shared by all vectors.  */
 433   struct vectorlike_header header;
 434
 435   /* The window we're a scroll bar for.  */
 436   Lisp_Object window;
 437
 438   /* The next and previous in the chain of scroll bars in this frame.  */
 439   Lisp_Object next, prev;
 440
 441   /* The window representing this scroll bar.  Since this is a full
 442      32-bit quantity, we store it split into two 32-bit values.  */
 443   Lisp_Object w32_window_low, w32_window_high;
 444
 445   /* Same as above for the widget.  */
 446   Lisp_Object w32_widget_low, w32_widget_high;
 447
 448   /* The position and size of the scroll bar in pixels, relative to the
 449      frame.  */
 450   int top, left, width, height;
 451
 452   /* The starting and ending positions of the handle, relative to the
 453      handle area (i.e. zero is the top position, not
 454      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 455      hasn't been drawn yet.
 456
 457      These are not actually the locations where the beginning and end
 458      are drawn; in order to keep handles from becoming invisible when
 459      editing large files, we establish a minimum height by always
 460      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 461      where they would be normally; the bottom and top are in a
 462      different co-ordinate system.  */
 463   int start, end;
 464
 465   /* If the scroll bar handle is currently being dragged by the user,
 466      this is the number of pixels from the top of the handle to the
 467      place where the user grabbed it.  If the handle isn't currently
 468      being dragged, this is Qnil.  */
 469   int dragging;
 470
 471   /* true if the scroll bar is horizontal.  */
 472   bool horizontal;
 473 };
 474
 475 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 476 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 477
 478 #ifdef _WIN64
 479 /* Building a 64-bit C integer from two 32-bit lisp integers.  */
 480 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 32 | XINT (low))
 481
 482 /* Setting two lisp integers to the low and high words of a 64-bit C int.  */
 483 #define SCROLL_BAR_UNPACK(low, high, int64) \
 484   (XSETINT ((low),   ((DWORDLONG)(int64))        & 0xffffffff), \
 485    XSETINT ((high), ((DWORDLONG)(int64) >> 32) & 0xffffffff))
 486 #else  /* not _WIN64 */
 487 /* Building a 32-bit C unsigned integer from two 16-bit lisp integers.  */
 488 #define SCROLL_BAR_PACK(low, high) ((UINT_PTR)(XINT (high) << 16 | XINT (low)))
 489
 490 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 491 #define SCROLL_BAR_UNPACK(low, high, int32) \
 492   (XSETINT ((low),   (int32)        & 0xffff), \
 493    XSETINT ((high), ((int32) >> 16) & 0xffff))
 494 #endif  /* not _WIN64 */
 495
 496 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 497 #define SCROLL_BAR_W32_WINDOW(ptr) \
 498   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 499
 500 /* Store a window id in a struct scroll_bar.  */
 501 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 502   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (intptr_t) id))
 503
 504 /* Return the inside width of a vertical scroll bar, given the outside
 505    width.  */
 506 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width)       \
 507   ((width)                                              \
 508    - VERTICAL_SCROLL_BAR_LEFT_BORDER                    \
 509    - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
 510
 511 /* Return the length of the rectangle within which the top of the
 512    handle must stay.  This isn't equivalent to the inside height,
 513    because the scroll bar handle has a minimum height.
 514
 515    This is the real range of motion for the scroll bar, so when we're
 516    scaling buffer positions to scroll bar positions, we use this, not
 517    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 518 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height)                         \
 519   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 520
 521 /* Return the inside height of vertical scroll bar, given the outside
 522    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 523 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height)                     \
 524   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 525
 526 /* Return the inside height of a horizontal scroll bar, given the
 527    outside height.  */
 528 #define HORIZONTAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 529   ((height)                                           \
 530    - HORIZONTAL_SCROLL_BAR_TOP_BORDER                 \
 531    - HORIZONTAL_SCROLL_BAR_BOTTOM_BORDER)
 532
 533 /* Return the length of the rectangle within which the left of the
 534    handle must stay.  This isn't equivalent to the inside width,
 535    because the scroll bar handle has a minimum width.
 536
 537    This is the real range of motion for the scroll bar, so when we're
 538    scaling buffer positions to scroll bar positions, we use this, not
 539    HORIZONTAL_SCROLL_BAR_INSIDE_WIDTH.  */
 540 #define HORIZONTAL_SCROLL_BAR_LEFT_RANGE(f,width)                       \
 541   (HORIZONTAL_SCROLL_BAR_INSIDE_WIDTH (f, width) - HORIZONTAL_SCROLL_BAR_MIN_HANDLE)
 542
 543 /* Return the inside width of horizontal scroll bar, given the outside
 544    width.  See HORIZONTAL_SCROLL_BAR_LEFT_RANGE too.  */
 545 #define HORIZONTAL_SCROLL_BAR_INSIDE_WIDTH(f,width)                     \
 546   ((width) - HORIZONTAL_SCROLL_BAR_LEFT_BORDER - HORIZONTAL_SCROLL_BAR_RIGHT_BORDER)
 547
 548
 549 /* Border widths for scroll bars.
 550
 551    Scroll bar windows don't have any borders; their border width is
 552    set to zero, and we redraw borders ourselves.  This makes the code
 553    a bit cleaner, since we don't have to convert between outside width
 554    (used when relating to the rest of the screen) and inside width
 555    (used when sizing and drawing the scroll bar window itself).
 556
 557    The handle moves up and down/back and forth in a rectangle inset
 558    from the edges of the scroll bar.  These are widths by which we
 559    inset the handle boundaries from the scroll bar edges.  */
 560 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 561 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 562 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 563 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 564
 565 #define HORIZONTAL_SCROLL_BAR_LEFT_BORDER (horizontal_scroll_bar_left_border)
 566 #define HORIZONTAL_SCROLL_BAR_RIGHT_BORDER (horizontal_scroll_bar_right_border)
 567 #define HORIZONTAL_SCROLL_BAR_TOP_BORDER (0)
 568 #define HORIZONTAL_SCROLL_BAR_BOTTOM_BORDER (0)
 569
 570 /* Minimum lengths for scroll bar handles, in pixels.  */
 571 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 572 #define HORIZONTAL_SCROLL_BAR_MIN_HANDLE (horizontal_scroll_bar_min_handle)
 573
 574 struct frame;  /* from frame.h */
 575
 576 extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
 577 extern void w32_clear_window (struct frame *);
 578
 579 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 580 do { \
 581     RECT rect; \
 582     rect.left = x; \
 583     rect.top = y; \
 584     rect.right = x + nx; \
 585     rect.bottom = y + ny; \
 586     w32_fill_rect (f,hdc,pix,&rect); \
 587 } while (0)
 588
 589 #define w32_fill_area_abs(f,hdc,pix,x0,y0,x1,y1) \
 590 do { \
 591     RECT rect; \
 592     rect.left = x0; \
 593     rect.top = y0; \
 594     rect.right = x1; \
 595     rect.bottom = y1; \
 596     w32_fill_rect (f,hdc,pix,&rect); \
 597 } while (0)
 598
 599 #define w32_clear_rect(f,hdc,lprect) \
 600   w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
 601
 602 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 603   w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
 604
 605 /* Define for earlier versions of Visual C */
 606 #ifndef WM_MOUSEWHEEL
 607 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 608 #endif /* WM_MOUSEWHEEL */
 609 #ifndef MSH_MOUSEWHEEL
 610 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 611 #endif /* MSH_MOUSEWHEEL */
 612 #ifndef WM_XBUTTONDOWN
 613 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 614 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 615 #endif /* WM_XBUTTONDOWN */
 616 #ifndef WM_MOUSEHWHEEL
 617 #define WM_MOUSEHWHEEL                 (WM_MOUSEWHEEL + 4)
 618 #endif /* WM_MOUSEHWHEEL  */
 619 #ifndef WM_APPCOMMAND
 620 #define WM_APPCOMMAND 0x319
 621 #define GET_APPCOMMAND_LPARAM(lParam)  (HIWORD(lParam) & 0x7fff)
 622 #endif
 623 #ifndef WM_UNICHAR
 624 #define WM_UNICHAR 0x109
 625 #endif
 626 #ifndef UNICODE_NOCHAR
 627 #define UNICODE_NOCHAR 0xFFFF
 628 #endif
 629
 630 #define WM_EMACS_START                 (WM_USER + 1)
 631 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 632 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 633 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 634 #define WM_EMACS_CREATEVSCROLLBAR      (WM_EMACS_START + 3)
 635 #define WM_EMACS_CREATEHSCROLLBAR      (WM_EMACS_START + 4)
 636 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 5)
 637 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 6)
 638 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 7)
 639 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 8)
 640 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 9)
 641 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 10)
 642 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 11)
 643 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 12)
 644 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 13)
 645 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 14)
 646 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 15)
 647 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 16)
 648 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 17)
 649 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 18)
 650 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 19)
 651 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 20)
 652 #define WM_EMACS_SHOWCURSOR            (WM_EMACS_START + 21)
 653 #define WM_EMACS_PAINT                 (WM_EMACS_START + 22)
 654 #define WM_EMACS_BRINGTOTOP            (WM_EMACS_START + 23)
 655 #define WM_EMACS_INPUT_READY           (WM_EMACS_START + 24)
 656 #define WM_EMACS_FILENOTIFY            (WM_EMACS_START + 25)
 657 #define WM_EMACS_END                   (WM_EMACS_START + 26)
 658
 659 #define WND_FONTWIDTH_INDEX    (0)
 660 #define WND_LINEHEIGHT_INDEX   (4)
 661 #define WND_BORDER_INDEX       (8)
 662 #define WND_VSCROLLBAR_INDEX   (12)
 663 #define WND_HSCROLLBAR_INDEX   (16)
 664 #define WND_BACKGROUND_INDEX   (20)
 665 #define WND_LAST_INDEX         (24)
 666
 667 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 668
 669 extern DWORD dwWindowsThreadId;
 670 extern HANDLE hWindowsThread;
 671 extern DWORD dwMainThreadId;
 672 extern HANDLE hMainThread;
 673
 674 typedef struct W32Msg {
 675     MSG msg;
 676     DWORD dwModifiers;
 677     RECT rect;
 678 } W32Msg;
 679
 680 extern BOOL prepend_msg (W32Msg *lpmsg);
 681
 682 /* Structure for recording message when input thread must return a
 683    result that depends on lisp thread to compute.  Lisp thread can
 684    complete deferred messages out of order.  */
 685 typedef struct deferred_msg
 686 {
 687   struct deferred_msg * next;
 688   W32Msg                w32msg;
 689   LRESULT               result;
 690   int                   completed;
 691 } deferred_msg;
 692
 693 extern CRITICAL_SECTION critsect;
 694
 695 extern void init_crit (void);
 696 extern void delete_crit (void);
 697
 698 extern void signal_quit (void);
 699
 700 #define enter_crit() EnterCriticalSection (&critsect)
 701 #define leave_crit() LeaveCriticalSection (&critsect)
 702
 703 extern void select_palette (struct frame * f, HDC hdc);
 704 extern void deselect_palette (struct frame * f, HDC hdc);
 705 extern HDC get_frame_dc (struct frame * f);
 706 extern int release_frame_dc (struct frame * f, HDC hDC);
 707
 708 extern int drain_message_queue (void);
 709
 710 extern BOOL get_next_msg (W32Msg *, BOOL);
 711 extern BOOL post_msg (W32Msg *);
 712 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 713
 714 extern BOOL parse_button (int, int, int *, int *);
 715
 716 extern void w32_sys_ring_bell (struct frame *f);
 717 extern void x_delete_display (struct w32_display_info *dpyinfo);
 718 extern void x_clear_under_internal_border (struct frame *f);
 719 extern void x_query_color (struct frame *, XColor *);
 720
 721 #define FILE_NOTIFICATIONS_SIZE 16384
 722 /* Notifications come in sets.  We use a doubly linked list with a
 723    sentinel to communicate those sets from the watching threads to the
 724    main thread.  */
 725 struct notifications_set {
 726   LPBYTE notifications;
 727   DWORD size;
 728   void *desc;
 729   struct notifications_set *next;
 730   struct notifications_set *prev;
 731 };
 732 extern struct notifications_set *notifications_set_head;
 733 extern Lisp_Object w32_get_watch_object (void *);
 734 extern Lisp_Object lispy_file_action (DWORD);
 735 extern int handle_file_notifications (struct input_event *);
 736
 737 extern void w32_initialize_display_info (Lisp_Object);
 738 extern void initialize_w32_display (struct terminal *, int *, int *);
 739
 740 #ifdef WINDOWSNT
 741 /* Keyboard hooks.  */
 742 extern void setup_w32_kbdhook (void);
 743 extern void remove_w32_kbdhook (void);
 744 extern int check_w32_winkey_state (int);
 745 #define w32_kbdhook_active (os_subtype != OS_9X)
 746 #else
 747 #define w32_kbdhook_active 0
 748 #endif
 749
 750 /* Keypad command key support.  W32 doesn't have virtual keys defined
 751    for the function keys on the keypad (they are mapped to the standard
 752    function keys), so we define our own.  */
 753 #define VK_NUMPAD_BEGIN         0x92
 754 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 755 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 756 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 757 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 758 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 759 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 760 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 761 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 762 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 763 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 764 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 765 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 766
 767 #ifndef VK_LWIN
 768 /* Older compiler environments don't have these defined.  */
 769 #define VK_LWIN                 0x5B
 770 #define VK_RWIN                 0x5C
 771 #define VK_APPS                 0x5D
 772 #endif
 773
 774 /* Support for treating Windows and Apps keys as modifiers.  These
 775    constants must not overlap with any of the dwControlKeyState flags in
 776    KEY_EVENT_RECORD.  */
 777 #define LEFT_WIN_PRESSED       0x8000
 778 #define RIGHT_WIN_PRESSED      0x4000
 779 #define APPS_PRESSED           0x2000
 780
 781 /* The current ANSI input codepage for GUI sessions.  */
 782 extern int w32_keyboard_codepage;
 783
 784 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 785    (even though they are supported on 98 and ME.  */
 786 #ifndef WM_MOUSELEAVE
 787 #define WM_MOUSELEAVE 0x02A3
 788 #define TME_LEAVE 0x00000002;
 789
 790 typedef struct tagTRACKMOUSEEVENT
 791 {
 792   DWORD cbSize;
 793   DWORD dwFlags;
 794   HWND hwndTrack;
 795   DWORD dwHoverTime;
 796 } TRACKMOUSEEVENT;
 797 #endif
 798
 799 struct image;
 800 struct face;
 801
 802 XGCValues *XCreateGC (void *, HWND, unsigned long, XGCValues *);
 803
 804 typedef DWORD (WINAPI * ClipboardSequence_Proc) (void);
 805 typedef BOOL (WINAPI * AppendMenuW_Proc) (
 806     IN HMENU,
 807     IN UINT,
 808     IN UINT_PTR,
 809     IN LPCWSTR);
 810
 811 extern HWND w32_system_caret_hwnd;
 812 extern int w32_system_caret_height;
 813 extern int w32_system_caret_x;
 814 extern int w32_system_caret_y;
 815 extern struct window *w32_system_caret_window;
 816 extern int w32_system_caret_hdr_height;
 817 extern int w32_system_caret_mode_height;
 818
 819 #ifdef _MSC_VER
 820 #ifndef EnumSystemLocales
 821 /* MSVC headers define these only for _WIN32_WINNT >= 0x0500.  */
 822 typedef BOOL (CALLBACK *LOCALE_ENUMPROCA)(LPSTR);
 823 typedef BOOL (CALLBACK *LOCALE_ENUMPROCW)(LPWSTR);
 824 BOOL WINAPI EnumSystemLocalesA(LOCALE_ENUMPROCA,DWORD);
 825 BOOL WINAPI EnumSystemLocalesW(LOCALE_ENUMPROCW,DWORD);
 826 #ifdef UNICODE
 827 #define EnumSystemLocales EnumSystemLocalesW
 828 #else
 829 #define EnumSystemLocales EnumSystemLocalesA
 830 #endif
 831 #endif
 832 #endif
 833
 834 #if EMACSDEBUG
 835 extern const char*
 836 w32_name_of_message (UINT msg);
 837 #endif /* EMACSDEBUG */
 838
 839 #ifdef NTGUI_UNICODE
 840 extern Lisp_Object ntgui_encode_system (Lisp_Object str);
 841 #define GUISTR(x) (L ## x)
 842 #define GUI_ENCODE_FILE GUI_ENCODE_SYSTEM
 843 #define GUI_ENCODE_SYSTEM(x) ntgui_encode_system (x)
 844 #define GUI_FN(fn) fn ## W
 845 typedef wchar_t guichar_t;
 846 #else /* !NTGUI_UNICODE */
 847 #define GUISTR(x) x
 848 #define GUI_ENCODE_FILE ENCODE_FILE
 849 #define GUI_ENCODE_SYSTEM ENCODE_SYSTEM
 850 #define GUI_FN(fn) fn
 851 typedef char guichar_t;
 852 #endif /* NTGUI_UNICODE */
 853
 854 #define GUI_SDATA(x) ((guichar_t*) SDATA (x))
 855
 856 extern Lisp_Object w32_popup_dialog (struct frame *, Lisp_Object, Lisp_Object);
 857 extern void w32_arrow_cursor (void);
 858
 859 extern void syms_of_w32term (void);
 860 extern void syms_of_w32menu (void);
 861 extern void syms_of_w32fns (void);
 862
 863 extern void globals_of_w32menu (void);
 864 extern void globals_of_w32fns (void);
 865 extern void globals_of_w32notify (void);
 866
 867 extern void w32_init_main_thread (void);
 868
 869 #ifdef CYGWIN
 870 extern int w32_message_fd;
 871 #endif /* CYGWIN */