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 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_pixel_width (struct frame *f);
 221 extern int x_pixel_height (struct frame *f);
 222 extern void x_set_frame_alpha (struct frame *f);
 223 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
 224 extern void x_set_tool_bar_lines (struct frame *f,
 225                                   Lisp_Object value,
 226                                   Lisp_Object oldval);
 227 extern void x_activate_menubar (struct frame *);
 228 extern int x_bitmap_icon (struct frame *, Lisp_Object);
 229 extern void initialize_frame_menubar (struct frame *);
 230 extern void x_free_frame_resources (struct frame *);
 231 extern void x_real_positions (struct frame *, int *, int *);
 232
 233 /* w32inevt.c */
 234 extern int w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId);
 235 extern int w32_kbd_mods_to_emacs (DWORD mods, WORD key);
 236
 237
 238 extern Lisp_Object x_get_focus_frame (struct frame *);
 239
 240 \f
 241 #define PIX_TYPE COLORREF
 242
 243 /* Each W32 frame object points to its own struct w32_display object
 244    in the output_data.w32 field.  The w32_display structure contains all
 245    the information that is specific to W32 windows.  */
 246
 247 /* Put some things in x_output for compatibility.
 248    NTEMACS_TODO: Move all common things here to eliminate unnecessary
 249    diffs between X and w32 code.  */
 250 struct x_output
 251 {
 252   /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
 253      frame, or IMPLICIT if we received an EnterNotify.
 254      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 255   int focus_state;
 256 };
 257
 258 enum
 259 {
 260   /* Values for focus_state, used as bit mask.
 261      EXPLICIT means we received a FocusIn for the frame and know it has
 262      the focus.  IMPLICIT means we received an EnterNotify and the frame
 263      may have the focus if no window manager is running.
 264      FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
 265   FOCUS_NONE     = 0,
 266   FOCUS_IMPLICIT = 1,
 267   FOCUS_EXPLICIT = 2
 268 };
 269
 270 struct w32_output
 271 {
 272   /* Placeholder for things accessed through output_data.x.  */
 273   struct x_output x_compatible;
 274
 275   /* Menubar "widget" handle.  */
 276   HMENU menubar_widget;
 277
 278   /* Original palette (used to deselect real palette after drawing) */
 279   HPALETTE old_palette;
 280
 281   /* Here are the Graphics Contexts for the default font.  */
 282   XGCValues *cursor_gc;                         /* cursor drawing */
 283
 284   /* The window used for this frame.
 285      May be zero while the frame object is being created
 286      and the window has not yet been created.  */
 287   Window window_desc;
 288
 289   /* The window that is the parent of this window.
 290      Usually this is a window that was made by the window manager,
 291      but it can be the root window, and it can be explicitly specified
 292      (see the explicit_parent field, below).  */
 293   Window parent_desc;
 294
 295   /* Default ASCII font of this frame. */
 296   struct font *font;
 297
 298   /* The baseline offset of the default ASCII font.  */
 299   int baseline_offset;
 300
 301   /* If a fontset is specified for this frame instead of font, this
 302      value contains an ID of the fontset, else -1.  */
 303   int fontset;
 304
 305   /* Pixel values used for various purposes.
 306      border_pixel may be -1 meaning use a gray tile.  */
 307   COLORREF cursor_pixel;
 308   COLORREF border_pixel;
 309   COLORREF mouse_pixel;
 310   COLORREF cursor_foreground_pixel;
 311
 312   /* Foreground color for scroll bars.  A value of -1 means use the
 313      default (black for non-toolkit scroll bars).  */
 314   COLORREF scroll_bar_foreground_pixel;
 315
 316   /* Background color for scroll bars.  A value of -1 means use the
 317      default (background color of the frame for non-toolkit scroll
 318      bars).  */
 319   COLORREF scroll_bar_background_pixel;
 320
 321   /* Descriptor for the cursor in use for this window.  */
 322   Cursor text_cursor;
 323   Cursor nontext_cursor;
 324   Cursor modeline_cursor;
 325   Cursor hand_cursor;
 326   Cursor hourglass_cursor;
 327   Cursor horizontal_drag_cursor;
 328
 329   /* Non-zero means hourglass cursor is currently displayed.  */
 330   unsigned hourglass_p : 1;
 331
 332   /* Non-hourglass cursor that is currently active.  */
 333   Cursor current_cursor;
 334
 335   DWORD dwStyle;
 336
 337   /* This is the Emacs structure for the display this frame is on.  */
 338   /* struct w32_display_info *display_info; */
 339
 340   /* Nonzero means our parent is another application's window
 341      and was explicitly specified.  */
 342   unsigned explicit_parent : 1;
 343
 344   /* Nonzero means tried already to make this frame visible.  */
 345   unsigned asked_for_visible : 1;
 346
 347   /* Nonzero means menubar is currently active.  */
 348   unsigned menubar_active : 1;
 349
 350   /* Relief GCs, colors etc.  */
 351   struct relief
 352   {
 353     XGCValues *gc;
 354     unsigned long pixel;
 355     int allocated_p;
 356   }
 357   black_relief, white_relief;
 358
 359   /* The background for which the above relief GCs were set up.
 360      They are changed only when a different background is involved.  */
 361   unsigned long relief_background;
 362
 363   /* Frame geometry and full-screen mode before it was resized by
 364      specifying the 'fullscreen' frame parameter.  Used to restore the
 365      geometry when 'fullscreen' is reset to nil.  */
 366   int normal_width, normal_height, normal_top, normal_left;
 367   int prev_fsmode;
 368 };
 369
 370 extern struct w32_output w32term_display;
 371
 372 /* Return the X output data for frame F.  */
 373 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 374
 375 /* Return the window associated with the frame F.  */
 376 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 377 #define FRAME_X_WINDOW(f) FRAME_W32_WINDOW (f)
 378
 379 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 380 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 381 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 382
 383 /* This gives the w32_display_info structure for the display F is on.  */
 384 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 385 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 386
 387 /* This is the `Display *' which frame F is on.  */
 388 #define FRAME_X_DISPLAY(f) (0)
 389
 390 /* Value is the smallest width of any character in any font on frame F.  */
 391
 392 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 393      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 394
 395 /* Value is the smallest height of any font on frame F.  */
 396
 397 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 398      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 399
 400 #define FRAME_NORMAL_WIDTH(F)  ((F)->output_data.w32->normal_width)
 401 #define FRAME_NORMAL_HEIGHT(F) ((F)->output_data.w32->normal_height)
 402 #define FRAME_NORMAL_TOP(F)    ((F)->output_data.w32->normal_top)
 403 #define FRAME_NORMAL_LEFT(F)   ((F)->output_data.w32->normal_left)
 404 #define FRAME_PREV_FSMODE(F)   ((F)->output_data.w32->prev_fsmode)
 405
 406 \f
 407 /* W32-specific scroll bar stuff.  */
 408
 409 /* We represent scroll bars as lisp vectors.  This allows us to place
 410    references to them in windows without worrying about whether we'll
 411    end up with windows referring to dead scroll bars; the garbage
 412    collector will free it when its time comes.
 413
 414    We use struct scroll_bar as a template for accessing fields of the
 415    vector.  */
 416
 417 struct scroll_bar {
 418
 419   /* This field is shared by all vectors.  */
 420   struct vectorlike_header header;
 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 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 464 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 465
 466 #ifdef _WIN64
 467 /* Building a 64-bit C integer from two 32-bit lisp integers.  */
 468 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 32 | XINT (low))
 469
 470 /* Setting two lisp integers to the low and high words of a 64-bit C int.  */
 471 #define SCROLL_BAR_UNPACK(low, high, int64) \
 472   (XSETINT ((low),   ((DWORDLONG)(int64))        & 0xffffffff), \
 473    XSETINT ((high), ((DWORDLONG)(int64) >> 32) & 0xffffffff))
 474 #else  /* not _WIN64 */
 475 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 476 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 477
 478 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 479 #define SCROLL_BAR_UNPACK(low, high, int32) \
 480   (XSETINT ((low),   (int32)        & 0xffff), \
 481    XSETINT ((high), ((int32) >> 16) & 0xffff))
 482 #endif  /* not _WIN64 */
 483
 484 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 485 #define SCROLL_BAR_W32_WINDOW(ptr) \
 486   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 487
 488 /* Store a window id in a struct scroll_bar.  */
 489 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 490   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (intptr_t) id))
 491
 492 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 493 #define SCROLL_BAR_X_WIDGET(ptr) \
 494   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 495
 496 /* Store a widget id in a struct scroll_bar.  */
 497 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 498   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 499
 500 /* Return the inside width of a vertical scroll bar, given the outside
 501    width.  */
 502 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 503   ((width) \
 504    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 505    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 506    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 507
 508 /* Return the length of the rectangle within which the top of the
 509    handle must stay.  This isn't equivalent to the inside height,
 510    because the scroll bar handle has a minimum height.
 511
 512    This is the real range of motion for the scroll bar, so when we're
 513    scaling buffer positions to scroll bar positions, we use this, not
 514    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 515 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 516   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 517
 518 /* Return the inside height of vertical scroll bar, given the outside
 519    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 520 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 521   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 522
 523
 524 /* Border widths for scroll bars.
 525
 526    Scroll bar windows don't have any borders; their border width is
 527    set to zero, and we redraw borders ourselves.  This makes the code
 528    a bit cleaner, since we don't have to convert between outside width
 529    (used when relating to the rest of the screen) and inside width
 530    (used when sizing and drawing the scroll bar window itself).
 531
 532    The handle moves up and down/back and forth in a rectangle inset
 533    from the edges of the scroll bar.  These are widths by which we
 534    inset the handle boundaries from the scroll bar edges.  */
 535 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 536 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 537 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 538 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 539
 540 /* Minimum lengths for scroll bar handles, in pixels.  */
 541 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 542
 543 /* Trimming off a few pixels from each side prevents
 544    text from glomming up against the scroll bar */
 545 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 546
 547 \f
 548 struct frame;  /* from frame.h */
 549
 550 extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
 551 extern void w32_clear_window (struct frame *);
 552
 553 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 554 do { \
 555     RECT rect; \
 556     rect.left = x; \
 557     rect.top = y; \
 558     rect.right = x + nx; \
 559     rect.bottom = y + ny; \
 560     w32_fill_rect (f,hdc,pix,&rect); \
 561 } while (0)
 562
 563 #define w32_clear_rect(f,hdc,lprect) \
 564   w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
 565
 566 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 567   w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
 568
 569 /* Define for earlier versions of Visual C */
 570 #ifndef WM_MOUSEWHEEL
 571 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 572 #endif /* WM_MOUSEWHEEL */
 573 #ifndef MSH_MOUSEWHEEL
 574 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 575 #endif /* MSH_MOUSEWHEEL */
 576 #ifndef WM_XBUTTONDOWN
 577 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 578 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 579 #endif /* WM_XBUTTONDOWN */
 580 #ifndef WM_MOUSEHWHEEL
 581 #define WM_MOUSEHWHEEL                 (WM_MOUSEWHEEL + 4)
 582 #endif /* WM_MOUSEHWHEEL  */
 583 #ifndef WM_APPCOMMAND
 584 #define WM_APPCOMMAND 0x319
 585 #define GET_APPCOMMAND_LPARAM(lParam)  (HIWORD(lParam) & 0x7fff)
 586 #endif
 587 #ifndef WM_UNICHAR
 588 #define WM_UNICHAR 0x109
 589 #endif
 590 #ifndef UNICODE_NOCHAR
 591 #define UNICODE_NOCHAR 0xFFFF
 592 #endif
 593
 594 #define WM_EMACS_START                 (WM_USER + 1)
 595 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 596 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 597 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 598 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 599 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 600 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 601 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 602 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 603 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 604 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 605 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 606 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 607 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 608 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 609 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 610 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 611 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 612 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 613 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 614 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
 615 #define WM_EMACS_PAINT                 (WM_EMACS_START + 20)
 616 #define WM_EMACS_BRINGTOTOP            (WM_EMACS_START + 21)
 617 #define WM_EMACS_INPUT_READY           (WM_EMACS_START + 22)
 618 #define WM_EMACS_FILENOTIFY            (WM_EMACS_START + 23)
 619 #define WM_EMACS_END                   (WM_EMACS_START + 24)
 620
 621 #define WND_FONTWIDTH_INDEX    (0)
 622 #define WND_LINEHEIGHT_INDEX   (4)
 623 #define WND_BORDER_INDEX       (8)
 624 #define WND_SCROLLBAR_INDEX    (12)
 625 #define WND_BACKGROUND_INDEX   (16)
 626 #define WND_LAST_INDEX         (20)
 627
 628 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 629
 630 extern DWORD dwWindowsThreadId;
 631 extern HANDLE hWindowsThread;
 632 extern DWORD dwMainThreadId;
 633 extern HANDLE hMainThread;
 634
 635 typedef struct W32Msg {
 636     MSG msg;
 637     DWORD dwModifiers;
 638     RECT rect;
 639 } W32Msg;
 640
 641 extern BOOL prepend_msg (W32Msg *lpmsg);
 642
 643 /* Structure for recording message when input thread must return a
 644    result that depends on lisp thread to compute.  Lisp thread can
 645    complete deferred messages out of order.  */
 646 typedef struct deferred_msg
 647 {
 648   struct deferred_msg * next;
 649   W32Msg                w32msg;
 650   LRESULT               result;
 651   int                   completed;
 652 } deferred_msg;
 653
 654 extern CRITICAL_SECTION critsect;
 655
 656 extern void init_crit (void);
 657 extern void delete_crit (void);
 658
 659 extern void signal_quit (void);
 660
 661 #define enter_crit() EnterCriticalSection (&critsect)
 662 #define leave_crit() LeaveCriticalSection (&critsect)
 663
 664 extern void select_palette (struct frame * f, HDC hdc);
 665 extern void deselect_palette (struct frame * f, HDC hdc);
 666 extern HDC get_frame_dc (struct frame * f);
 667 extern int release_frame_dc (struct frame * f, HDC hDC);
 668
 669 extern int drain_message_queue (void);
 670
 671 extern BOOL get_next_msg (W32Msg *, BOOL);
 672 extern BOOL post_msg (W32Msg *);
 673 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 674
 675 extern BOOL parse_button (int, int, int *, int *);
 676
 677 extern void w32_sys_ring_bell (struct frame *f);
 678 extern void x_delete_display (struct w32_display_info *dpyinfo);
 679
 680 extern volatile int notification_buffer_in_use;
 681 extern BYTE file_notifications[16384];
 682 extern DWORD notifications_size;
 683 extern void *notifications_desc;
 684 extern Lisp_Object w32_get_watch_object (void *);
 685 extern Lisp_Object lispy_file_action (DWORD);
 686
 687 extern void w32_initialize_display_info (Lisp_Object);
 688 extern void initialize_w32_display (struct terminal *);
 689
 690 /* Keypad command key support.  W32 doesn't have virtual keys defined
 691    for the function keys on the keypad (they are mapped to the standard
 692    function keys), so we define our own.  */
 693 #define VK_NUMPAD_BEGIN         0x92
 694 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 695 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 696 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 697 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 698 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 699 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 700 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 701 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 702 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 703 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 704 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 705 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 706
 707 #ifndef VK_LWIN
 708 /* Older compiler environments don't have these defined.  */
 709 #define VK_LWIN                 0x5B
 710 #define VK_RWIN                 0x5C
 711 #define VK_APPS                 0x5D
 712 #endif
 713
 714 /* Support for treating Windows and Apps keys as modifiers.  These
 715    constants must not overlap with any of the dwControlKeyState flags in
 716    KEY_EVENT_RECORD.  */
 717 #define LEFT_WIN_PRESSED       0x8000
 718 #define RIGHT_WIN_PRESSED      0x4000
 719 #define APPS_PRESSED           0x2000
 720
 721 /* The current ANSI input codepage for GUI sessions.  */
 722 extern int w32_keyboard_codepage;
 723
 724 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 725    (even though they are supported on 98 and ME.  */
 726 #ifndef WM_MOUSELEAVE
 727 #define WM_MOUSELEAVE 0x02A3
 728 #define TME_LEAVE 0x00000002;
 729
 730 typedef struct tagTRACKMOUSEEVENT
 731 {
 732   DWORD cbSize;
 733   DWORD dwFlags;
 734   HWND hwndTrack;
 735   DWORD dwHoverTime;
 736 } TRACKMOUSEEVENT;
 737 #endif
 738
 739 struct image;
 740 struct face;
 741
 742 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 743 struct frame * check_x_frame (Lisp_Object);
 744
 745 typedef DWORD (WINAPI * ClipboardSequence_Proc) (void);
 746 typedef BOOL (WINAPI * AppendMenuW_Proc) (
 747     IN HMENU,
 748     IN UINT,
 749     IN UINT_PTR,
 750     IN LPCWSTR);
 751
 752 extern HWND w32_system_caret_hwnd;
 753 extern int w32_system_caret_height;
 754 extern int w32_system_caret_x;
 755 extern int w32_system_caret_y;
 756
 757 #ifdef _MSC_VER
 758 #ifndef EnumSystemLocales
 759 /* MSVC headers define these only for _WIN32_WINNT >= 0x0500.  */
 760 typedef BOOL (CALLBACK *LOCALE_ENUMPROCA)(LPSTR);
 761 typedef BOOL (CALLBACK *LOCALE_ENUMPROCW)(LPWSTR);
 762 BOOL WINAPI EnumSystemLocalesA(LOCALE_ENUMPROCA,DWORD);
 763 BOOL WINAPI EnumSystemLocalesW(LOCALE_ENUMPROCW,DWORD);
 764 #ifdef UNICODE
 765 #define EnumSystemLocales EnumSystemLocalesW
 766 #else
 767 #define EnumSystemLocales EnumSystemLocalesA
 768 #endif
 769 #endif
 770 #endif
 771
 772 #if EMACSDEBUG
 773 extern const char*
 774 w32_name_of_message (UINT msg);
 775 #endif /* EMACSDEBUG */
 776
 777 #ifdef NTGUI_UNICODE
 778 extern Lisp_Object ntgui_encode_system (Lisp_Object str);
 779 #define GUISTR(x) (L ## x)
 780 #define GUI_ENCODE_FILE GUI_ENCODE_SYSTEM
 781 #define GUI_ENCODE_SYSTEM(x) ntgui_encode_system (x)
 782 #define GUI_FN(fn) fn ## W
 783 typedef wchar_t guichar_t;
 784 #else /* !NTGUI_UNICODE */
 785 #define GUISTR(x) x
 786 #define GUI_ENCODE_FILE ENCODE_FILE
 787 #define GUI_ENCODE_SYSTEM ENCODE_SYSTEM
 788 #define GUI_FN(fn) fn
 789 typedef char guichar_t;
 790 #endif /* NTGUI_UNICODE */
 791
 792 #define GUI_SDATA(x) ((guichar_t*) SDATA (x))
 793
 794 extern void syms_of_w32term (void);
 795 extern void syms_of_w32menu (void);
 796 extern void syms_of_w32fns (void);
 797
 798 extern void globals_of_w32menu (void);
 799 extern void globals_of_w32fns (void);
 800 extern void globals_of_w32notify (void);
 801
 802 #ifdef CYGWIN
 803 extern int w32_message_fd;
 804 #endif /* CYGWIN */