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