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