src/w32term.h

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