src/w32term.h

   1 /* Definitions and headers for communication on the Microsoft W32 API.
   2    Copyright (C) 1995, 2001 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 2, or (at your option)
   9 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; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Added by Kevin Gallo */
  22
  23 #include "w32gui.h"
  24
  25 /* The class of this X application.  */
  26 #define EMACS_CLASS "Emacs"
  27 \f
  28 #define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
  29 #define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
  30
  31 #define FONT_WIDTH(f)       \
  32   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmAveCharWidth)
  33 #define FONT_HEIGHT(f)      \
  34    ((f)->bdf ? (f)->bdf->height : (f)->tm.tmHeight)
  35 #define FONT_BASE(f)        \
  36   ((f)->bdf ? (f)->bdf->ury : (f)->tm.tmAscent)
  37 #define FONT_DESCENT(f)     \
  38   ((f)->bdf ? -((f)->bdf->lly) : (f)->tm.tmDescent)
  39 #define FONT_MAX_WIDTH(f)   \
  40   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmMaxCharWidth)
  41
  42 #define CP_DEFAULT 1004
  43 /* Special pseudo-codepages. */
  44 #define CP_8BIT      -1
  45 #define CP_UNICODE   -2
  46 #define CP_UNKNOWN   -3
  47
  48 #define CHECK_W32_FRAME(f, frame)               \
  49   if (NILP (frame))                             \
  50     f = SELECTED_FRAME ();                      \
  51   else                                          \
  52     {                                           \
  53       CHECK_LIVE_FRAME (frame, 0);              \
  54       f = XFRAME (frame);                       \
  55     }                                           \
  56   if (! FRAME_W32_P (f))
  57
  58 /* Indicates whether we are in the readsocket call and the message we
  59    are processing in the current loop */
  60
  61 extern MSG CurMsg;
  62 extern BOOL bUseDflt;
  63
  64 extern struct frame *x_window_to_frame ();
  65
  66 /* Structure recording bitmaps and reference count.
  67    If REFCOUNT is 0 then this record is free to be reused.  */
  68
  69 struct w32_bitmap_record
  70 {
  71   Pixmap pixmap;
  72   char *file;
  73   HINSTANCE hinst; /* Used to load the file */
  74   int refcount;
  75   /* Record some info about this pixmap.  */
  76   int height, width, depth;
  77 };
  78
  79 /* Palette book-keeping stuff for mapping requested colors into the
  80    system palette.  Keep a ref-counted list of requested colors and
  81    regenerate the app palette whenever the requested list changes. */
  82
  83 extern Lisp_Object Vw32_enable_palette;
  84
  85 struct w32_palette_entry {
  86   struct w32_palette_entry * next;
  87   PALETTEENTRY entry;
  88 #if 0
  89   unsigned refcount;
  90 #endif
  91 };
  92
  93 extern void w32_regenerate_palette(struct frame *f);
  94
  95 \f
  96 /* For each display (currently only one on w32), we have a structure that
  97    records information about it.  */
  98
  99 struct w32_display_info
 100 {
 101   /* Chain of all w32_display_info structures.  */
 102   struct w32_display_info *next;
 103
 104   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 105      The same cons cell also appears in x_display_name_list.  */
 106   Lisp_Object name_list_element;
 107
 108   /* Number of frames that are on this display.  */
 109   int reference_count;
 110
 111   /* Dots per inch of the screen.  */
 112   double resx, resy;
 113
 114   /* Number of planes on this screen.  */
 115   int n_planes;
 116
 117   /* Number of bits per pixel on this screen.  */
 118   int n_cbits;
 119
 120   /* Dimensions of this screen.  */
 121   int height, width;
 122   int height_in,width_in;
 123
 124   /* Mask of things that cause the mouse to be grabbed.  */
 125   int grabbed;
 126
 127   /* Emacs bitmap-id of the default icon bitmap for this frame.
 128      Or -1 if none has been allocated yet.  */
 129   int icon_bitmap_id;
 130
 131   /* The root window of this screen.  */
 132   Window root_window;
 133
 134   /* The cursor to use for vertical scroll bars.  */
 135   Cursor vertical_scroll_bar_cursor;
 136
 137   /* color palette information.  */
 138   int has_palette;
 139   struct w32_palette_entry * color_list;
 140   unsigned num_colors;
 141   HPALETTE palette;
 142
 143   /* deferred action flags checked when starting frame update.  */
 144   int regen_palette;
 145
 146   /* Keystroke that has been faked by Emacs and will be ignored when
 147      received; value is reset after key is received.  */
 148   int faked_key;
 149
 150   /* A table of all the fonts we have already loaded.  */
 151   struct font_info *font_table;
 152
 153   /* The current capacity of font_table.  */
 154   int font_table_size;
 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 iff 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   /* Cache of images.  */
 233   struct image_cache *image_cache;
 234 };
 235
 236 /* This is a chain of structures for all the displays currently in use.  */
 237 extern struct w32_display_info *x_display_list;
 238 extern struct w32_display_info one_w32_display_info;
 239
 240 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 241    one for each element of w32_display_list and in the same order.
 242    NAME is the name of the frame.
 243    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 244 extern Lisp_Object w32_display_name_list;
 245
 246 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
 247 extern Lisp_Object Vx_pixel_size_width_font_regexp;
 248
 249 /* A flag to control how to display unibyte 8-bit character.  */
 250 extern int unibyte_display_via_language_environment;
 251
 252 struct w32_display_info *x_display_info_for_name ();
 253
 254 extern struct w32_display_info *w32_term_init ();
 255 \f
 256 extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
 257 extern struct font_info *w32_get_font_info (), *w32_query_font ();
 258 extern void w32_cache_char_metrics (XFontStruct *font);
 259 extern void w32_find_ccl_program();
 260 \f
 261 #define PIX_TYPE COLORREF
 262
 263 /* Each W32 frame object points to its own struct w32_display object
 264    in the output_data.w32 field.  The w32_display structure contains all
 265    the information that is specific to W32 windows.  */
 266
 267 /* Put some things in x_output for compatibility.
 268    NTEMACS_TODO: Move all common things here to eliminate unneccesary
 269    diffs between X and w32 code.  */
 270 struct x_output
 271 {
 272   PIX_TYPE background_pixel;
 273   PIX_TYPE foreground_pixel;
 274 };
 275
 276
 277 struct w32_output
 278 {
 279   /* Placeholder for things accessed through output_data.x.  */
 280   struct x_output x_compatible;
 281
 282   /* Menubar "widget" handle.  */
 283   HMENU menubar_widget;
 284
 285   /* Original palette (used to deselect real palette after drawing) */
 286   HPALETTE old_palette;
 287
 288   /* Position of the W32 window (x and y offsets in root window).  */
 289   int left_pos;
 290   int top_pos;
 291
 292   /* Border width of the W32 window as known by the window system.  */
 293   int border_width;
 294
 295   /* Size of the W32 window in pixels.  */
 296   int pixel_height, pixel_width;
 297
 298   /* Height of a line, in pixels.  */
 299   int line_height;
 300
 301   /* Here are the Graphics Contexts for the default font.  */
 302   XGCValues *cursor_gc;                         /* cursor drawing */
 303
 304   /* Width of the internal border.  This is a line of background color
 305      just inside the window's border.  When the frame is selected,
 306      a highlighting is displayed inside the internal border.  */
 307   int internal_border_width;
 308
 309   /* The window used for this frame.
 310      May be zero while the frame object is being created
 311      and the window has not yet been created.  */
 312   Window window_desc;
 313
 314   /* The window that is the parent of this window.
 315      Usually this is a window that was made by the window manager,
 316      but it can be the root window, and it can be explicitly specified
 317      (see the explicit_parent field, below).  */
 318   Window parent_desc;
 319
 320   /* Default ASCII font of this frame. */
 321   XFontStruct *font;
 322
 323   /* The baseline offset of the default ASCII font.  */
 324   int baseline_offset;
 325
 326   /* If a fontset is specified for this frame instead of font, this
 327      value contains an ID of the fontset, else -1.  */
 328   int fontset;
 329
 330   /* Pixel values used for various purposes.
 331      border_pixel may be -1 meaning use a gray tile.  */
 332   COLORREF cursor_pixel;
 333   COLORREF border_pixel;
 334   COLORREF mouse_pixel;
 335   COLORREF cursor_foreground_pixel;
 336
 337   /* Foreground color for scroll bars.  A value of -1 means use the
 338      default (black for non-toolkit scroll bars).  */
 339   COLORREF scroll_bar_foreground_pixel;
 340
 341   /* Background color for scroll bars.  A value of -1 means use the
 342      default (background color of the frame for non-toolkit scroll
 343      bars).  */
 344   COLORREF scroll_bar_background_pixel;
 345
 346   /* Descriptor for the cursor in use for this window.  */
 347   Cursor text_cursor;
 348   Cursor nontext_cursor;
 349   Cursor modeline_cursor;
 350   Cursor cross_cursor;
 351   Cursor hourglass_cursor;
 352   Cursor horizontal_drag_cursor;
 353
 354   /* Window whose cursor is hourglass_cursor.  This window is
 355      temporarily mapped to display an hourglass cursor.  */
 356   Window hourglass_window;
 357
 358   /* Non-zero means hourglass cursor is currently displayed.  */
 359   unsigned hourglass_p : 1;
 360
 361   /* Flag to set when the window needs to be completely repainted.  */
 362   int needs_exposure;
 363
 364   DWORD dwStyle;
 365
 366   /* The size of the extra width currently allotted for vertical
 367      scroll bars, in pixels.  */
 368   int vertical_scroll_bar_extra;
 369
 370   /* The extra width currently allotted for the areas in which
 371      truncation marks, continuation marks, and overlay arrows are
 372      displayed.  */
 373   int left_fringe_width, right_fringe_width;
 374   int fringe_cols, fringes_extra;
 375
 376   /* This is the gravity value for the specified window position.  */
 377   int win_gravity;
 378
 379   /* The geometry flags for this window.  */
 380   int size_hint_flags;
 381
 382   /* This is the Emacs structure for the display this frame is on.  */
 383   /* struct w32_display_info *display_info; */
 384
 385   /* Nonzero means our parent is another application's window
 386      and was explicitly specified.  */
 387   char explicit_parent;
 388
 389   /* Nonzero means tried already to make this frame visible.  */
 390   char asked_for_visible;
 391
 392   /* Nonzero means menubar is currently active.  */
 393   char menubar_active;
 394
 395   /* Nonzero means a menu command is being processed.  */
 396   char menu_command_in_progress;
 397
 398   /* Nonzero means menubar is about to become active, but should be
 399      brought up to date first.  */
 400   volatile char pending_menu_activation;
 401
 402   /* Relief GCs, colors etc.  */
 403   struct relief
 404   {
 405     XGCValues *gc;
 406     unsigned long pixel;
 407     int allocated_p;
 408   }
 409   black_relief, white_relief;
 410
 411   /* The background for which the above relief GCs were set up.
 412      They are changed only when a different background is involved.  */
 413   unsigned long relief_background;
 414
 415   /* See enum below */
 416   int want_fullscreen;
 417
 418   /* This many pixels are the difference between the outer window (i.e. the
 419      left of the window manager decoration) and FRAME_W32_WINDOW. */
 420   int x_pixels_diff;
 421
 422   /* This many pixels are the difference between the outer window (i.e. the
 423      top of the window manager titlebar) and FRAME_W32_WINDOW. */
 424   int y_pixels_diff;
 425 };
 426
 427 extern struct w32_output w32term_display;
 428
 429 enum
 430 {
 431   /* Values used as a bit mask, BOTH == WIDTH | HEIGHT.  */
 432   FULLSCREEN_NONE       = 0,
 433   FULLSCREEN_WIDTH      = 1,
 434   FULLSCREEN_HEIGHT     = 2,
 435   FULLSCREEN_BOTH       = 3,
 436   FULLSCREEN_WAIT       = 4,
 437   FULLSCREEN_MOVE_WAIT  = 8,
 438 };
 439
 440 /* Return the window associated with the frame F.  */
 441 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 442
 443 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 444 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 445 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 446 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 447 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.w32->internal_border_width)
 448 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.w32->line_height)
 449 /* Width of the default font of frame F.  Must be defined by each
 450    terminal specific header.  */
 451 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 452 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 453
 454 /* This gives the w32_display_info structure for the display F is on.  */
 455 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 456 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 457
 458 /* This is the 'font_info *' which frame F has.  */
 459 #define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
 460
 461 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 462 #define PIXEL_WIDTH(f) ((f)->output_data.w32->pixel_width)
 463 #define PIXEL_HEIGHT(f) ((f)->output_data.w32->pixel_height)
 464
 465 /* Value is the smallest width of any character in any font on frame F.  */
 466
 467 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 468      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 469
 470 /* Value is the smallest height of any font on frame F.  */
 471
 472 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 473      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 474
 475 /* Return a pointer to the image cache of frame F.  */
 476
 477 #define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
 478
 479 \f
 480 /* Total width of fringes reserved for drawing truncation bitmaps,
 481    continuation bitmaps and alike.  The width is in canonical char
 482    units of the frame.  This must currently be the case because window
 483    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 484    able to split windows horizontally nicely.  */
 485
 486 #define FRAME_X_FRINGE_COLS(F)  ((F)->output_data.w32->fringe_cols)
 487
 488 /* Total width of fringes in pixels.  */
 489
 490 #define FRAME_X_FRINGE_WIDTH(F) ((F)->output_data.w32->fringes_extra)
 491
 492 /* Pixel-width of the left and right fringe.  */
 493
 494 #define FRAME_X_LEFT_FRINGE_WIDTH(F) ((F)->output_data.w32->left_fringe_width)
 495 #define FRAME_X_RIGHT_FRINGE_WIDTH(F) ((F)->output_data.w32->right_fringe_width)
 496
 497
 498 \f
 499 /* W32-specific scroll bar stuff.  */
 500
 501 /* We represent scroll bars as lisp vectors.  This allows us to place
 502    references to them in windows without worrying about whether we'll
 503    end up with windows referring to dead scroll bars; the garbage
 504    collector will free it when its time comes.
 505
 506    We use struct scroll_bar as a template for accessing fields of the
 507    vector.  */
 508
 509 struct scroll_bar {
 510
 511   /* These fields are shared by all vectors.  */
 512   EMACS_INT size_from_Lisp_Vector_struct;
 513   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 514
 515   /* The window we're a scroll bar for.  */
 516   Lisp_Object window;
 517
 518   /* The next and previous in the chain of scroll bars in this frame.  */
 519   Lisp_Object next, prev;
 520
 521   /* The window representing this scroll bar.  Since this is a full
 522      32-bit quantity, we store it split into two 32-bit values.  */
 523   Lisp_Object w32_window_low, w32_window_high;
 524
 525   /* Same as above for the widget.  */
 526   Lisp_Object w32_widget_low, w32_widget_high;
 527
 528   /* The position and size of the scroll bar in pixels, relative to the
 529      frame.  */
 530   Lisp_Object top, left, width, height;
 531
 532   /* The starting and ending positions of the handle, relative to the
 533      handle area (i.e. zero is the top position, not
 534      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 535      hasn't been drawn yet.
 536
 537      These are not actually the locations where the beginning and end
 538      are drawn; in order to keep handles from becoming invisible when
 539      editing large files, we establish a minimum height by always
 540      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 541      where they would be normally; the bottom and top are in a
 542      different co-ordinate system.  */
 543   Lisp_Object start, end;
 544
 545   /* If the scroll bar handle is currently being dragged by the user,
 546      this is the number of pixels from the top of the handle to the
 547      place where the user grabbed it.  If the handle isn't currently
 548      being dragged, this is Qnil.  */
 549   Lisp_Object dragging;
 550 };
 551
 552 /* The number of elements a vector holding a struct scroll_bar needs.  */
 553 #define SCROLL_BAR_VEC_SIZE                                     \
 554   ((sizeof (struct scroll_bar)                                  \
 555     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 556    / sizeof (Lisp_Object))
 557
 558 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 559 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 560
 561
 562 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 563 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 564
 565 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 566 #define SCROLL_BAR_UNPACK(low, high, int32) \
 567   (XSETINT ((low),   (int32)        & 0xffff), \
 568    XSETINT ((high), ((int32) >> 16) & 0xffff))
 569
 570
 571 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 572 #define SCROLL_BAR_W32_WINDOW(ptr) \
 573   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 574
 575 /* Store a window id in a struct scroll_bar.  */
 576 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 577   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 578
 579 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 580 #define SCROLL_BAR_X_WIDGET(ptr) \
 581   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 582
 583 /* Store a widget id in a struct scroll_bar.  */
 584 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 585   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 586
 587 /* Return the inside width of a vertical scroll bar, given the outside
 588    width.  */
 589 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 590   ((width) \
 591    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 592    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 593    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 594
 595 /* Return the length of the rectangle within which the top of the
 596    handle must stay.  This isn't equivalent to the inside height,
 597    because the scroll bar handle has a minimum height.
 598
 599    This is the real range of motion for the scroll bar, so when we're
 600    scaling buffer positions to scroll bar positions, we use this, not
 601    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 602 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 603   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 604
 605 /* Return the inside height of vertical scroll bar, given the outside
 606    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 607 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 608   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 609
 610
 611 /* Border widths for scroll bars.
 612
 613    Scroll bar windows don't have any borders; their border width is
 614    set to zero, and we redraw borders ourselves.  This makes the code
 615    a bit cleaner, since we don't have to convert between outside width
 616    (used when relating to the rest of the screen) and inside width
 617    (used when sizing and drawing the scroll bar window itself).
 618
 619    The handle moves up and down/back and forth in a rectangle inset
 620    from the edges of the scroll bar.  These are widths by which we
 621    inset the handle boundaries from the scroll bar edges.  */
 622 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 623 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 624 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 625 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 626
 627 /* Minimum lengths for scroll bar handles, in pixels.  */
 628 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 629
 630 /* Trimming off a few pixels from each side prevents
 631    text from glomming up against the scroll bar */
 632 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 633
 634 \f
 635 /* Manipulating pixel sizes and character sizes.
 636    Knowledge of which factors affect the overall size of the window should
 637    be hidden in these macros, if that's possible.
 638
 639    Return the upper/left pixel position of the character cell on frame F
 640    at ROW/COL.  */
 641 #define CHAR_TO_PIXEL_ROW(f, row) \
 642   ((f)->output_data.w32->internal_border_width \
 643    + (row) * (f)->output_data.w32->line_height)
 644 #define CHAR_TO_PIXEL_COL(f, col) \
 645   ((f)->output_data.w32->internal_border_width \
 646    + (col) * FONT_WIDTH ((f)->output_data.w32->font))
 647
 648 /* Return the pixel width/height of frame F if it has
 649    WIDTH columns/HEIGHT rows.  */
 650 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 651   (CHAR_TO_PIXEL_COL (f, width) \
 652    + (f)->output_data.w32->vertical_scroll_bar_extra \
 653    + (f)->output_data.w32->fringes_extra \
 654    + (f)->output_data.w32->internal_border_width)
 655 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 656   (CHAR_TO_PIXEL_ROW (f, height) \
 657    + (f)->output_data.w32->internal_border_width)
 658
 659
 660 /* Return the row/column (zero-based) of the character cell containing
 661    the pixel on FRAME at ROW/COL.  */
 662 #define PIXEL_TO_CHAR_ROW(f, row) \
 663   (((row) - (f)->output_data.w32->internal_border_width) \
 664    / (f)->output_data.w32->line_height)
 665 #define PIXEL_TO_CHAR_COL(f, col) \
 666   (((col) - (f)->output_data.w32->internal_border_width) \
 667    / FONT_WIDTH ((f)->output_data.w32->font))
 668
 669 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 670    frame F?  */
 671 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 672   (PIXEL_TO_CHAR_COL (f, ((width) \
 673                           - (f)->output_data.w32->internal_border_width \
 674                           - (f)->output_data.w32->fringes_extra \
 675                           - (f)->output_data.w32->vertical_scroll_bar_extra)))
 676 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 677   (PIXEL_TO_CHAR_ROW (f, ((height) \
 678                           - (f)->output_data.w32->internal_border_width)))
 679
 680 \f
 681 extern void w32_fill_rect ();
 682 extern void w32_clear_window ();
 683
 684 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 685 { \
 686     RECT rect; \
 687     rect.left = x; \
 688     rect.top = y; \
 689     rect.right = x + nx; \
 690     rect.bottom = y + ny; \
 691     w32_fill_rect (f,hdc,pix,&rect); \
 692 }
 693
 694 #define w32_clear_rect(f,hdc,lprect) \
 695 w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
 696
 697 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 698 w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
 699
 700 extern struct font_info *w32_load_font ();
 701 extern void w32_unload_font ();
 702
 703 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
 704                                      int *, int *));
 705
 706 /* Define for earlier versions of Visual C */
 707 #ifndef WM_MOUSEWHEEL
 708 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 709 #endif /* WM_MOUSEWHEEL */
 710 #ifndef MSH_MOUSEWHEEL
 711 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 712 #endif /* MSH_MOUSEWHEEL */
 713 #ifndef WM_XBUTTONDOWN
 714 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 715 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 716 #endif /* WM_XBUTTONDOWN */
 717
 718 #define WM_EMACS_START                 (WM_USER + 1)
 719 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 720 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 721 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 722 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 723 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 724 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 725 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 726 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 727 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 728 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 729 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 730 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 731 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 732 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 733 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 734 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 735 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 736 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 737 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 738 #define WM_EMACS_END                   (WM_EMACS_START + 19)
 739
 740 #define WND_FONTWIDTH_INDEX    (0)
 741 #define WND_LINEHEIGHT_INDEX   (4)
 742 #define WND_BORDER_INDEX       (8)
 743 #define WND_SCROLLBAR_INDEX    (12)
 744 #define WND_BACKGROUND_INDEX   (16)
 745 #define WND_LAST_INDEX         (20)
 746
 747 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 748
 749 extern DWORD dwWindowsThreadId;
 750 extern HANDLE hWindowsThread;
 751 extern DWORD dwMainThreadId;
 752 extern HANDLE hMainThread;
 753
 754 typedef struct W32Msg {
 755     MSG msg;
 756     DWORD dwModifiers;
 757     RECT rect;
 758 } W32Msg;
 759
 760 /* Structure for recording message when input thread must return a
 761    result that depends on lisp thread to compute.  Lisp thread can
 762    complete deferred messages out of order.  */
 763 typedef struct deferred_msg
 764 {
 765   struct deferred_msg * next;
 766   W32Msg                w32msg;
 767   LRESULT               result;
 768   int                   completed;
 769 } deferred_msg;
 770
 771 extern CRITICAL_SECTION critsect;
 772
 773 extern void init_crit ();
 774 extern void delete_crit ();
 775
 776 extern void signal_quit ();
 777
 778 #define enter_crit() EnterCriticalSection (&critsect)
 779 #define leave_crit() LeaveCriticalSection (&critsect)
 780
 781 extern void select_palette (struct frame * f, HDC hdc);
 782 extern void deselect_palette (struct frame * f, HDC hdc);
 783 extern HDC get_frame_dc (struct frame * f);
 784 extern int release_frame_dc (struct frame * f, HDC hDC);
 785
 786 extern void drain_message_queue ();
 787
 788 extern BOOL get_next_msg ();
 789 extern BOOL post_msg ();
 790 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 791 extern void wait_for_sync ();
 792
 793 extern BOOL parse_button ();
 794
 795 /* Keypad command key support.  W32 doesn't have virtual keys defined
 796    for the function keys on the keypad (they are mapped to the standard
 797    fuction keys), so we define our own.  */
 798 #define VK_NUMPAD_BEGIN         0x92
 799 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 800 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 801 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 802 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 803 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 804 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 805 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 806 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 807 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 808 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 809 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 810 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 811
 812 #ifndef VK_LWIN
 813 /* Older compiler environments don't have these defined.  */
 814 #define VK_LWIN                 0x5B
 815 #define VK_RWIN                 0x5C
 816 #define VK_APPS                 0x5D
 817 #endif
 818
 819 /* Support for treating Windows and Apps keys as modifiers.  These
 820    constants must not overlap with any of the dwControlKeyState flags in
 821    KEY_EVENT_RECORD.  */
 822 #define LEFT_WIN_PRESSED       0x8000
 823 #define RIGHT_WIN_PRESSED      0x4000
 824 #define APPS_PRESSED           0x2000
 825
 826 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 827    (even though they are supported on 98 and ME.  */
 828 #ifndef WM_MOUSELEAVE
 829 #define WM_MOUSELEAVE 0x02A3
 830 #define TME_LEAVE 0x00000002;
 831
 832 typedef struct tagTRACKMOUSEEVENT
 833 {
 834   DWORD cbSize;
 835   DWORD dwFlags;
 836   HWND hwndTrack;
 837   DWORD dwHoverTime;
 838 } TRACKMOUSEEVENT;
 839 #endif
 840
 841 struct image;
 842 struct face;
 843
 844 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 845 struct frame * check_x_frame (Lisp_Object);
 846 EXFUN (Fx_display_color_p, 1);
 847 EXFUN (Fx_display_grayscale_p, 1);
 848 int image_ascent P_ ((struct image *, struct face *));