src/w32term.h

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