src/w32term.h

   1 /* Definitions and headers for communication on the Microsoft Windows API.
   2    Copyright (C) 1995, 2001-2012 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 void check_w32 (void);
 207 extern int w32_defined_color (FRAME_PTR f, const char *color,
 208                               XColor *color_def, int alloc);
 209 extern void x_set_window_size (struct frame *f, int change_grav,
 210                               int cols, int rows);
 211 extern int x_display_pixel_height (struct w32_display_info *);
 212 extern int x_display_pixel_width (struct w32_display_info *);
 213 extern void x_sync (struct frame *);
 214 extern Lisp_Object x_get_focus_frame (struct frame *);
 215 extern void x_set_mouse_position (struct frame *f, int h, int v);
 216 extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
 217 extern void x_make_frame_visible (struct frame *f);
 218 extern void x_make_frame_invisible (struct frame *f);
 219 extern void x_iconify_frame (struct frame *f);
 220 extern int x_char_width (struct frame *f);
 221 extern int x_char_height (struct frame *f);
 222 extern int x_pixel_width (struct frame *f);
 223 extern int x_pixel_height (struct frame *f);
 224 extern void x_set_frame_alpha (struct frame *f);
 225 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
 226 extern void x_set_tool_bar_lines (struct frame *f,
 227                                   Lisp_Object value,
 228                                   Lisp_Object oldval);
 229 extern void x_activate_menubar (struct frame *);
 230 extern int x_bitmap_icon (struct frame *, Lisp_Object);
 231 extern void initialize_frame_menubar (struct frame *);
 232 extern void x_free_frame_resources (struct frame *);
 233 extern void x_real_positions (struct frame *, int *, int *);
 234
 235 /* w32inevt.c */
 236 extern int w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId);
 237 extern int w32_kbd_mods_to_emacs (DWORD mods, WORD key);
 238
 239
 240 extern Lisp_Object x_get_focus_frame (struct frame *);
 241
 242 \f
 243 #define PIX_TYPE COLORREF
 244
 245 /* Each W32 frame object points to its own struct w32_display object
 246    in the output_data.w32 field.  The w32_display structure contains all
 247    the information that is specific to W32 windows.  */
 248
 249 /* Put some things in x_output for compatibility.
 250    NTEMACS_TODO: Move all common things here to eliminate unnecessary
 251    diffs between X and w32 code.  */
 252 struct x_output
 253 {
 254 #if 0 /* These are also defined in struct frame.  Use that instead.  */
 255   PIX_TYPE background_pixel;
 256   PIX_TYPE foreground_pixel;
 257 #endif
 258
 259   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 260      frame, or IMPLICIT if we received an EnterNotify.
 261      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 262   int focus_state;
 263
 264 };
 265
 266 enum
 267 {
 268   /* Values for focus_state, used as bit mask.
 269      EXPLICIT means we received a FocusIn for the frame and know it has
 270      the focus.  IMPLICIT means we received an EnterNotify and the frame
 271      may have the focus if no window manager is running.
 272      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 273   FOCUS_NONE     = 0,
 274   FOCUS_IMPLICIT = 1,
 275   FOCUS_EXPLICIT = 2
 276 };
 277
 278 struct w32_output
 279 {
 280   /* Placeholder for things accessed through output_data.x.  */
 281   struct x_output x_compatible;
 282
 283   /* Menubar "widget" handle.  */
 284   HMENU menubar_widget;
 285
 286   /* Original palette (used to deselect real palette after drawing) */
 287   HPALETTE old_palette;
 288
 289   /* Here are the Graphics Contexts for the default font.  */
 290   XGCValues *cursor_gc;                         /* cursor drawing */
 291
 292   /* The window used for this frame.
 293      May be zero while the frame object is being created
 294      and the window has not yet been created.  */
 295   Window window_desc;
 296
 297   /* The window that is the parent of this window.
 298      Usually this is a window that was made by the window manager,
 299      but it can be the root window, and it can be explicitly specified
 300      (see the explicit_parent field, below).  */
 301   Window parent_desc;
 302
 303   /* Default ASCII font of this frame. */
 304   struct font *font;
 305
 306   /* The baseline offset of the default ASCII font.  */
 307   int baseline_offset;
 308
 309   /* If a fontset is specified for this frame instead of font, this
 310      value contains an ID of the fontset, else -1.  */
 311   int fontset;
 312
 313   /* Pixel values used for various purposes.
 314      border_pixel may be -1 meaning use a gray tile.  */
 315   COLORREF cursor_pixel;
 316   COLORREF border_pixel;
 317   COLORREF mouse_pixel;
 318   COLORREF cursor_foreground_pixel;
 319
 320   /* Foreground color for scroll bars.  A value of -1 means use the
 321      default (black for non-toolkit scroll bars).  */
 322   COLORREF scroll_bar_foreground_pixel;
 323
 324   /* Background color for scroll bars.  A value of -1 means use the
 325      default (background color of the frame for non-toolkit scroll
 326      bars).  */
 327   COLORREF scroll_bar_background_pixel;
 328
 329   /* Descriptor for the cursor in use for this window.  */
 330   Cursor text_cursor;
 331   Cursor nontext_cursor;
 332   Cursor modeline_cursor;
 333   Cursor hand_cursor;
 334   Cursor hourglass_cursor;
 335   Cursor horizontal_drag_cursor;
 336
 337   /* Non-zero means hourglass cursor is currently displayed.  */
 338   unsigned hourglass_p : 1;
 339
 340   /* Non-hourglass cursor that is currently active.  */
 341   Cursor current_cursor;
 342
 343   DWORD dwStyle;
 344
 345   /* This is the Emacs structure for the display this frame is on.  */
 346   /* struct w32_display_info *display_info; */
 347
 348   /* Nonzero means our parent is another application's window
 349      and was explicitly specified.  */
 350   char explicit_parent;
 351
 352   /* Nonzero means tried already to make this frame visible.  */
 353   char asked_for_visible;
 354
 355   /* Nonzero means menubar is currently active.  */
 356   char menubar_active;
 357
 358   /* Nonzero means menubar is about to become active, but should be
 359      brought up to date first.  */
 360   volatile char pending_menu_activation;
 361
 362   /* Relief GCs, colors etc.  */
 363   struct relief
 364   {
 365     XGCValues *gc;
 366     unsigned long pixel;
 367     int allocated_p;
 368   }
 369   black_relief, white_relief;
 370
 371   /* The background for which the above relief GCs were set up.
 372      They are changed only when a different background is involved.  */
 373   unsigned long relief_background;
 374 };
 375
 376 extern struct w32_output w32term_display;
 377
 378 /* Return the X output data for frame F.  */
 379 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 380
 381 /* Return the window associated with the frame F.  */
 382 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 383 #define FRAME_X_WINDOW(f) FRAME_W32_WINDOW (f)
 384
 385 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 386 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 387 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 388
 389 /* This gives the w32_display_info structure for the display F is on.  */
 390 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 391 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 392
 393 /* This is the `Display *' which frame F is on.  */
 394 #define FRAME_X_DISPLAY(f) (0)
 395
 396 /* Value is the smallest width of any character in any font on frame F.  */
 397
 398 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 399      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 400
 401 /* Value is the smallest height of any font on frame F.  */
 402
 403 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 404      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 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   /* These fields are shared by all vectors.  */
 419   EMACS_INT size_from_Lisp_Vector_struct;
 420   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 421
 422   /* The window we're a scroll bar for.  */
 423   Lisp_Object window;
 424
 425   /* The next and previous in the chain of scroll bars in this frame.  */
 426   Lisp_Object next, prev;
 427
 428   /* The window representing this scroll bar.  Since this is a full
 429      32-bit quantity, we store it split into two 32-bit values.  */
 430   Lisp_Object w32_window_low, w32_window_high;
 431
 432   /* Same as above for the widget.  */
 433   Lisp_Object w32_widget_low, w32_widget_high;
 434
 435   /* The position and size of the scroll bar in pixels, relative to the
 436      frame.  */
 437   Lisp_Object top, left, width, height;
 438
 439   /* The starting and ending positions of the handle, relative to the
 440      handle area (i.e. zero is the top position, not
 441      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 442      hasn't been drawn yet.
 443
 444      These are not actually the locations where the beginning and end
 445      are drawn; in order to keep handles from becoming invisible when
 446      editing large files, we establish a minimum height by always
 447      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 448      where they would be normally; the bottom and top are in a
 449      different co-ordinate system.  */
 450   Lisp_Object start, end;
 451
 452   /* If the scroll bar handle is currently being dragged by the user,
 453      this is the number of pixels from the top of the handle to the
 454      place where the user grabbed it.  If the handle isn't currently
 455      being dragged, this is Qnil.  */
 456   Lisp_Object dragging;
 457
 458   /* t if the background of the fringe that is adjacent to a scroll
 459      bar is extended to the gap between the fringe and the bar.  */
 460   Lisp_Object fringe_extended_p;
 461 };
 462
 463 /* The number of elements a vector holding a struct scroll_bar needs.  */
 464 #define SCROLL_BAR_VEC_SIZE                                     \
 465   ((sizeof (struct scroll_bar)                                  \
 466     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 467    / word_size)
 468
 469 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 470 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 471
 472 #ifdef _WIN64
 473 /* Building a 64-bit C integer from two 32-bit lisp integers.  */
 474 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 32 | XINT (low))
 475
 476 /* Setting two lisp integers to the low and high words of a 64-bit C int.  */
 477 #define SCROLL_BAR_UNPACK(low, high, int64) \
 478   (XSETINT ((low),   ((DWORDLONG)(int64))        & 0xffffffff), \
 479    XSETINT ((high), ((DWORDLONG)(int64) >> 32) & 0xffffffff))
 480 #else  /* not _WIN64 */
 481 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 482 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 483
 484 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 485 #define SCROLL_BAR_UNPACK(low, high, int32) \
 486   (XSETINT ((low),   (int32)        & 0xffff), \
 487    XSETINT ((high), ((int32) >> 16) & 0xffff))
 488 #endif  /* not _WIN64 */
 489
 490 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 491 #define SCROLL_BAR_W32_WINDOW(ptr) \
 492   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 493
 494 /* Store a window id in a struct scroll_bar.  */
 495 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 496   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (intptr_t) id))
 497
 498 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 499 #define SCROLL_BAR_X_WIDGET(ptr) \
 500   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 501
 502 /* Store a widget id in a struct scroll_bar.  */
 503 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 504   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 505
 506 /* Return the inside width of a vertical scroll bar, given the outside
 507    width.  */
 508 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 509   ((width) \
 510    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 511    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 512    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 513
 514 /* Return the length of the rectangle within which the top of the
 515    handle must stay.  This isn't equivalent to the inside height,
 516    because the scroll bar handle has a minimum height.
 517
 518    This is the real range of motion for the scroll bar, so when we're
 519    scaling buffer positions to scroll bar positions, we use this, not
 520    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 521 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 522   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 523
 524 /* Return the inside height of vertical scroll bar, given the outside
 525    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 526 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 527   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 528
 529
 530 /* Border widths for scroll bars.
 531
 532    Scroll bar windows don't have any borders; their border width is
 533    set to zero, and we redraw borders ourselves.  This makes the code
 534    a bit cleaner, since we don't have to convert between outside width
 535    (used when relating to the rest of the screen) and inside width
 536    (used when sizing and drawing the scroll bar window itself).
 537
 538    The handle moves up and down/back and forth in a rectangle inset
 539    from the edges of the scroll bar.  These are widths by which we
 540    inset the handle boundaries from the scroll bar edges.  */
 541 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 542 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 543 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 544 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 545
 546 /* Minimum lengths for scroll bar handles, in pixels.  */
 547 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 548
 549 /* Trimming off a few pixels from each side prevents
 550    text from glomming up against the scroll bar */
 551 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 552
 553 \f
 554 struct frame;  /* from frame.h */
 555
 556 extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
 557 extern void w32_clear_window (struct frame *);
 558
 559 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 560 do { \
 561     RECT rect; \
 562     rect.left = x; \
 563     rect.top = y; \
 564     rect.right = x + nx; \
 565     rect.bottom = y + ny; \
 566     w32_fill_rect (f,hdc,pix,&rect); \
 567 } while (0)
 568
 569 #define w32_clear_rect(f,hdc,lprect) \
 570   w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
 571
 572 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 573   w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
 574
 575 /* Define for earlier versions of Visual C */
 576 #ifndef WM_MOUSEWHEEL
 577 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 578 #endif /* WM_MOUSEWHEEL */
 579 #ifndef MSH_MOUSEWHEEL
 580 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 581 #endif /* MSH_MOUSEWHEEL */
 582 #ifndef WM_XBUTTONDOWN
 583 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 584 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 585 #endif /* WM_XBUTTONDOWN */
 586 #ifndef WM_MOUSEHWHEEL
 587 #define WM_MOUSEHWHEEL                 (WM_MOUSEWHEEL + 4)
 588 #endif /* WM_MOUSEHWHEEL  */
 589 #ifndef WM_APPCOMMAND
 590 #define WM_APPCOMMAND 0x319
 591 #define GET_APPCOMMAND_LPARAM(lParam)  (HIWORD(lParam) & 0x7fff)
 592 #endif
 593 #ifndef WM_UNICHAR
 594 #define WM_UNICHAR 0x109
 595 #endif
 596 #ifndef UNICODE_NOCHAR
 597 #define UNICODE_NOCHAR 0xFFFF
 598 #endif
 599
 600 #define WM_EMACS_START                 (WM_USER + 1)
 601 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 602 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 603 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 604 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 605 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 606 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 607 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 608 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 609 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 610 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 611 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 612 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 613 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 614 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 615 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 616 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 617 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 618 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 619 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 620 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
 621 #define WM_EMACS_PAINT                 (WM_EMACS_START + 20)
 622 #define WM_EMACS_BRINGTOTOP            (WM_EMACS_START + 21)
 623 #define WM_EMACS_INPUT_READY           (WM_EMACS_START + 22)
 624 #define WM_EMACS_END                   (WM_EMACS_START + 23)
 625
 626 #define WND_FONTWIDTH_INDEX    (0)
 627 #define WND_LINEHEIGHT_INDEX   (4)
 628 #define WND_BORDER_INDEX       (8)
 629 #define WND_SCROLLBAR_INDEX    (12)
 630 #define WND_BACKGROUND_INDEX   (16)
 631 #define WND_LAST_INDEX         (20)
 632
 633 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 634
 635 extern DWORD dwWindowsThreadId;
 636 extern HANDLE hWindowsThread;
 637 extern DWORD dwMainThreadId;
 638 extern HANDLE hMainThread;
 639
 640 typedef struct W32Msg {
 641     MSG msg;
 642     DWORD dwModifiers;
 643     RECT rect;
 644 } W32Msg;
 645
 646 extern BOOL prepend_msg (W32Msg *lpmsg);
 647
 648 /* Structure for recording message when input thread must return a
 649    result that depends on lisp thread to compute.  Lisp thread can
 650    complete deferred messages out of order.  */
 651 typedef struct deferred_msg
 652 {
 653   struct deferred_msg * next;
 654   W32Msg                w32msg;
 655   LRESULT               result;
 656   int                   completed;
 657 } deferred_msg;
 658
 659 extern CRITICAL_SECTION critsect;
 660
 661 extern void init_crit (void);
 662 extern void delete_crit (void);
 663
 664 extern void signal_quit (void);
 665
 666 #define enter_crit() EnterCriticalSection (&critsect)
 667 #define leave_crit() LeaveCriticalSection (&critsect)
 668
 669 extern void select_palette (struct frame * f, HDC hdc);
 670 extern void deselect_palette (struct frame * f, HDC hdc);
 671 extern HDC get_frame_dc (struct frame * f);
 672 extern int release_frame_dc (struct frame * f, HDC hDC);
 673
 674 extern void drain_message_queue (void);
 675
 676 extern BOOL get_next_msg (W32Msg *, BOOL);
 677 extern BOOL post_msg (W32Msg *);
 678 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 679
 680 extern BOOL parse_button (int, int, int *, int *);
 681
 682 extern void w32_sys_ring_bell (struct frame *f);
 683 extern void x_delete_display (struct w32_display_info *dpyinfo);
 684 extern void w32_initialize_display_info (Lisp_Object);
 685 extern void initialize_w32_display (struct terminal *);
 686
 687
 688 /* Keypad command key support.  W32 doesn't have virtual keys defined
 689    for the function keys on the keypad (they are mapped to the standard
 690    function keys), so we define our own.  */
 691 #define VK_NUMPAD_BEGIN         0x92
 692 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 693 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 694 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 695 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 696 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 697 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 698 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 699 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 700 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 701 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 702 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 703 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 704
 705 #ifndef VK_LWIN
 706 /* Older compiler environments don't have these defined.  */
 707 #define VK_LWIN                 0x5B
 708 #define VK_RWIN                 0x5C
 709 #define VK_APPS                 0x5D
 710 #endif
 711
 712 /* Support for treating Windows and Apps keys as modifiers.  These
 713    constants must not overlap with any of the dwControlKeyState flags in
 714    KEY_EVENT_RECORD.  */
 715 #define LEFT_WIN_PRESSED       0x8000
 716 #define RIGHT_WIN_PRESSED      0x4000
 717 #define APPS_PRESSED           0x2000
 718
 719 /* The current ANSI input codepage for GUI sessions.  */
 720 extern int w32_keyboard_codepage;
 721
 722 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 723    (even though they are supported on 98 and ME.  */
 724 #ifndef WM_MOUSELEAVE
 725 #define WM_MOUSELEAVE 0x02A3
 726 #define TME_LEAVE 0x00000002;
 727
 728 typedef struct tagTRACKMOUSEEVENT
 729 {
 730   DWORD cbSize;
 731   DWORD dwFlags;
 732   HWND hwndTrack;
 733   DWORD dwHoverTime;
 734 } TRACKMOUSEEVENT;
 735 #endif
 736
 737 struct image;
 738 struct face;
 739
 740 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 741 struct frame * check_x_frame (Lisp_Object);
 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 extern void syms_of_w32term (void);
 776 extern void syms_of_w32menu (void);
 777 extern void syms_of_w32fns (void);
 778
 779 extern void globals_of_w32menu (void);
 780 extern void globals_of_w32fns (void);
 781
 782 #ifdef CYGWIN
 783 extern int w32_message_fd;
 784 #endif /* CYGWIN */