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 enum text_cursor_kinds {
  67   NO_CURSOR = -1,
  68   FILLED_BOX_CURSOR,
  69   HOLLOW_BOX_CURSOR,
  70   BAR_CURSOR
  71 };
  72
  73 /* Structure recording bitmaps and reference count.
  74    If REFCOUNT is 0 then this record is free to be reused.  */
  75
  76 struct w32_bitmap_record
  77 {
  78   Pixmap pixmap;
  79   char *file;
  80   HINSTANCE hinst; /* Used to load the file */
  81   int refcount;
  82   /* Record some info about this pixmap.  */
  83   int height, width, depth;
  84 };
  85
  86 /* Palette book-keeping stuff for mapping requested colors into the
  87    system palette.  Keep a ref-counted list of requested colors and
  88    regenerate the app palette whenever the requested list changes. */
  89
  90 extern Lisp_Object Vw32_enable_palette;
  91
  92 struct w32_palette_entry {
  93   struct w32_palette_entry * next;
  94   PALETTEENTRY entry;
  95 #if 0
  96   unsigned refcount;
  97 #endif
  98 };
  99
 100 extern void w32_regenerate_palette(struct frame *f);
 101
 102 \f
 103 /* For each display (currently only one on w32), we have a structure that
 104    records information about it.  */
 105
 106 struct w32_display_info
 107 {
 108   /* Chain of all w32_display_info structures.  */
 109   struct w32_display_info *next;
 110
 111   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 112      The same cons cell also appears in x_display_name_list.  */
 113   Lisp_Object name_list_element;
 114
 115   /* Number of frames that are on this display.  */
 116   int reference_count;
 117
 118   /* Dots per inch of the screen.  */
 119   double resx, resy;
 120
 121   /* Number of planes on this screen.  */
 122   int n_planes;
 123
 124   /* Number of bits per pixel on this screen.  */
 125   int n_cbits;
 126
 127   /* Dimensions of this screen.  */
 128   int height, width;
 129   int height_in,width_in;
 130
 131   /* Mask of things that cause the mouse to be grabbed.  */
 132   int grabbed;
 133
 134   /* Emacs bitmap-id of the default icon bitmap for this frame.
 135      Or -1 if none has been allocated yet.  */
 136   int icon_bitmap_id;
 137
 138   /* The root window of this screen.  */
 139   Window root_window;
 140
 141   /* The cursor to use for vertical scroll bars.  */
 142   Cursor vertical_scroll_bar_cursor;
 143
 144   /* color palette information.  */
 145   int has_palette;
 146   struct w32_palette_entry * color_list;
 147   unsigned num_colors;
 148   HPALETTE palette;
 149
 150   /* deferred action flags checked when starting frame update.  */
 151   int regen_palette;
 152
 153   /* Keystroke that has been faked by Emacs and will be ignored when
 154      received; value is reset after key is received.  */
 155   int faked_key;
 156
 157   /* A table of all the fonts we have already loaded.  */
 158   struct font_info *font_table;
 159
 160   /* The current capacity of font_table.  */
 161   int font_table_size;
 162
 163   /* Minimum width over all characters in all fonts in font_table.  */
 164   int smallest_char_width;
 165
 166   /* Minimum font height over all fonts in font_table.  */
 167   int smallest_font_height;
 168
 169   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 170   XGCValues *scratch_cursor_gc;
 171
 172   /* These variables describe the range of text currently shown in its
 173      mouse-face, together with the window they apply to. As long as
 174      the mouse stays within this range, we need not redraw anything on
 175      its account.  Rows and columns are glyph matrix positions in
 176      MOUSE_FACE_WINDOW.  */
 177   int mouse_face_beg_row, mouse_face_beg_col;
 178   int mouse_face_beg_x, mouse_face_beg_y;
 179   int mouse_face_end_row, mouse_face_end_col;
 180   int mouse_face_end_x, mouse_face_end_y;
 181   int mouse_face_past_end;
 182   Lisp_Object mouse_face_window;
 183   int mouse_face_face_id;
 184
 185   /* 1 if a mouse motion event came and we didn't handle it right away because
 186      gc was in progress.  */
 187   int mouse_face_deferred_gc;
 188
 189   /* FRAME and X, Y position of mouse when last checked for
 190      highlighting.  X and Y can be negative or out of range for the frame.  */
 191   struct frame *mouse_face_mouse_frame;
 192   int mouse_face_mouse_x, mouse_face_mouse_y;
 193
 194   /* Nonzero means defer mouse-motion highlighting.  */
 195   int mouse_face_defer;
 196
 197   int mouse_face_image_state;
 198
 199   char *w32_id_name;
 200
 201   /* The number of fonts actually stored in w32_font_table.
 202      font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
 203      n_fonts <= font_table_size. and font_table[i].name != 0. */
 204   int n_fonts;
 205
 206   /* Pointer to bitmap records.  */
 207   struct w32_bitmap_record *bitmaps;
 208
 209   /* Allocated size of bitmaps field.  */
 210   int bitmaps_size;
 211
 212   /* Last used bitmap index.  */
 213   int bitmaps_last;
 214
 215   /* The frame (if any) which has the window that has keyboard focus.
 216      Zero if none.  This is examined by Ffocus_frame in w32fns.c.  Note
 217      that a mere EnterNotify event can set this; if you need to know the
 218      last frame specified in a FocusIn or FocusOut event, use
 219      w32_focus_event_frame.  */
 220   struct frame *w32_focus_frame;
 221
 222   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 223      separate from w32_focus_frame, because whether or not LeaveNotify
 224      events cause us to lose focus depends on whether or not we have
 225      received a FocusIn event for it.  */
 226   struct frame *w32_focus_event_frame;
 227
 228   /* The frame which currently has the visual highlight, and should get
 229      keyboard input (other sorts of input have the frame encoded in the
 230      event).  It points to the focus frame's selected window's
 231      frame.  It differs from w32_focus_frame when we're using a global
 232      minibuffer.  */
 233   struct frame *w32_highlight_frame;
 234
 235   /* Cache of images.  */
 236   struct image_cache *image_cache;
 237 };
 238
 239 /* This is a chain of structures for all the displays currently in use.  */
 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 /* A flag to control how to display unibyte 8-bit character.  */
 252 extern int unibyte_display_via_language_environment;
 253
 254 struct w32_display_info *x_display_info_for_name ();
 255
 256 extern struct w32_display_info *w32_term_init ();
 257 \f
 258 extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
 259 extern struct font_info *w32_get_font_info (), *w32_query_font ();
 260 extern void w32_cache_char_metrics (XFontStruct *font);
 261 extern void w32_find_ccl_program();
 262 \f
 263 #define PIX_TYPE COLORREF
 264
 265 /* Each W32 frame object points to its own struct w32_display object
 266    in the output_data.w32 field.  The w32_display structure contains all
 267    the information that is specific to W32 windows.  */
 268
 269 /* Put some things in x_output for compatibility.
 270    NTEMACS_TODO: Move all common things here to eliminate unneccesary
 271    diffs between X and w32 code.  */
 272 struct x_output
 273 {
 274   PIX_TYPE background_pixel;
 275   PIX_TYPE foreground_pixel;
 276 };
 277
 278
 279 struct w32_output
 280 {
 281   /* Placeholder for things accessed through output_data.x.  */
 282   struct x_output x_compatibile;
 283
 284   /* Menubar "widget" handle.  */
 285   HMENU menubar_widget;
 286
 287   /* Original palette (used to deselect real palette after drawing) */
 288   HPALETTE old_palette;
 289
 290   /* Position of the W32 window (x and y offsets in root window).  */
 291   int left_pos;
 292   int top_pos;
 293
 294   /* Border width of the W32 window as known by the window system.  */
 295   int border_width;
 296
 297   /* Size of the W32 window in pixels.  */
 298   int pixel_height, pixel_width;
 299
 300   /* Height of a line, in pixels.  */
 301   int line_height;
 302
 303   /* Here are the Graphics Contexts for the default font.  */
 304   XGCValues *cursor_gc;                         /* cursor drawing */
 305
 306   /* Width of the internal border.  This is a line of background color
 307      just inside the window's border.  When the frame is selected,
 308      a highlighting is displayed inside the internal border.  */
 309   int internal_border_width;
 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 cross_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   /* What kind of text cursor is drawn in this window right now?
 367      (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
 368   enum text_cursor_kinds current_cursor;
 369
 370   /* What kind of text cursor should we draw in the future?
 371      This should always be filled_box_cursor or bar_cursor.  */
 372   enum text_cursor_kinds desired_cursor;
 373
 374   /* Width of bar cursor (if we are using that).  */
 375   int cursor_width;
 376
 377   DWORD dwStyle;
 378
 379   /* The size of the extra width currently allotted for vertical
 380      scroll bars, in pixels.  */
 381   int vertical_scroll_bar_extra;
 382
 383   /* The extra width currently allotted for the areas in which
 384      truncation marks, continuation marks, and overlay arrows are
 385      displayed.  */
 386   int flags_areas_extra;
 387
 388   /* This is the gravity value for the specified window position.  */
 389   int win_gravity;
 390
 391   /* The geometry flags for this window.  */
 392   int size_hint_flags;
 393
 394   /* This is the Emacs structure for the display this frame is on.  */
 395   /* struct w32_display_info *display_info; */
 396
 397   /* Nonzero means our parent is another application's window
 398      and was explicitly specified.  */
 399   char explicit_parent;
 400
 401   /* Nonzero means tried already to make this frame visible.  */
 402   char asked_for_visible;
 403
 404   /* Nonzero means menubar is currently active.  */
 405   char menubar_active;
 406
 407   /* Nonzero means menubar is about to become active, but should be
 408      brought up to date first.  */
 409   volatile char pending_menu_activation;
 410
 411   /* Relief GCs, colors etc.  */
 412   struct relief
 413   {
 414     XGCValues *gc;
 415     unsigned long pixel;
 416     int allocated_p;
 417   }
 418   black_relief, white_relief;
 419
 420   /* The background for which the above relief GCs were set up.
 421      They are changed only when a different background is involved.  */
 422   unsigned long relief_background;
 423 };
 424
 425 extern struct w32_output w32term_display;
 426
 427 /* Return the window associated with the frame F.  */
 428 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 429
 430 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 431 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 432 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 433 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 434 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.w32->internal_border_width)
 435 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.w32->line_height)
 436 /* Width of the default font of frame F.  Must be defined by each
 437    terminal specific header.  */
 438 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 439 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 440
 441 /* This gives the w32_display_info structure for the display F is on.  */
 442 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 443 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 444
 445 /* This is the 'font_info *' which frame F has.  */
 446 #define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
 447
 448 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 449 #define PIXEL_WIDTH(f) ((f)->output_data.w32->pixel_width)
 450 #define PIXEL_HEIGHT(f) ((f)->output_data.w32->pixel_height)
 451
 452 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.w32->desired_cursor)
 453
 454 /* Value is the smallest width of any character in any font on frame F.  */
 455
 456 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 457      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 458
 459 /* Value is the smallest height of any font on frame F.  */
 460
 461 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 462      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 463
 464 /* Return a pointer to the image cache of frame F.  */
 465
 466 #define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
 467
 468 \f
 469 /* Pixel width of the bitmaps drawn to indicate truncation,
 470    continuation etc.  */
 471
 472 #define FRAME_FLAGS_BITMAP_WIDTH(f)     8
 473 #define FRAME_FLAGS_BITMAP_HEIGHT(f)    8
 474
 475 /* Total width of areas reserved for drawing truncation bitmaps,
 476    continuation bitmaps and alike.  The width is in canonical char
 477    units of the frame.  This must currently be the case because window
 478    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 479    able to split windows horizontally nicely.  */
 480
 481 #define FRAME_X_FLAGS_AREA_COLS(F)                              \
 482      ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1)     \
 483       / CANON_X_UNIT ((F)))
 484
 485 /* Total width of flags areas in pixels.  */
 486
 487 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
 488      (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
 489
 490 /* Pixel-width of the left flags area.  */
 491
 492 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
 493      (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 494
 495 /* Pixel-width of the right flags area.  Note that we are doing
 496    integer arithmetic here, so don't loose a pixel if the total
 497    width is an odd number.  */
 498
 499 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F)       \
 500      (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 501
 502
 503 \f
 504 /* W32-specific scroll bar stuff.  */
 505
 506 /* We represent scroll bars as lisp vectors.  This allows us to place
 507    references to them in windows without worrying about whether we'll
 508    end up with windows referring to dead scroll bars; the garbage
 509    collector will free it when its time comes.
 510
 511    We use struct scroll_bar as a template for accessing fields of the
 512    vector.  */
 513
 514 struct scroll_bar {
 515
 516   /* These fields are shared by all vectors.  */
 517   EMACS_INT size_from_Lisp_Vector_struct;
 518   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 519
 520   /* The window we're a scroll bar for.  */
 521   Lisp_Object window;
 522
 523   /* The next and previous in the chain of scroll bars in this frame.  */
 524   Lisp_Object next, prev;
 525
 526   /* The window representing this scroll bar.  Since this is a full
 527      32-bit quantity, we store it split into two 32-bit values.  */
 528   Lisp_Object w32_window_low, w32_window_high;
 529
 530   /* Same as above for the widget.  */
 531   Lisp_Object w32_widget_low, w32_widget_high;
 532
 533   /* The position and size of the scroll bar in pixels, relative to the
 534      frame.  */
 535   Lisp_Object top, left, width, height;
 536
 537   /* The starting and ending positions of the handle, relative to the
 538      handle area (i.e. zero is the top position, not
 539      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 540      hasn't been drawn yet.
 541
 542      These are not actually the locations where the beginning and end
 543      are drawn; in order to keep handles from becoming invisible when
 544      editing large files, we establish a minimum height by always
 545      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 546      where they would be normally; the bottom and top are in a
 547      different co-ordinate system.  */
 548   Lisp_Object start, end;
 549
 550   /* If the scroll bar handle is currently being dragged by the user,
 551      this is the number of pixels from the top of the handle to the
 552      place where the user grabbed it.  If the handle isn't currently
 553      being dragged, this is Qnil.  */
 554   Lisp_Object dragging;
 555 };
 556
 557 /* The number of elements a vector holding a struct scroll_bar needs.  */
 558 #define SCROLL_BAR_VEC_SIZE                                     \
 559   ((sizeof (struct scroll_bar)                                  \
 560     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 561    / sizeof (Lisp_Object))
 562
 563 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 564 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 565
 566
 567 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 568 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 569
 570 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 571 #define SCROLL_BAR_UNPACK(low, high, int32) \
 572   (XSETINT ((low),   (int32)        & 0xffff), \
 573    XSETINT ((high), ((int32) >> 16) & 0xffff))
 574
 575
 576 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 577 #define SCROLL_BAR_W32_WINDOW(ptr) \
 578   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 579
 580 /* Store a window id in a struct scroll_bar.  */
 581 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 582   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 583
 584 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 585 #define SCROLL_BAR_X_WIDGET(ptr) \
 586   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 587
 588 /* Store a widget id in a struct scroll_bar.  */
 589 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 590   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 591
 592 /* Return the inside width of a vertical scroll bar, given the outside
 593    width.  */
 594 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 595   ((width) \
 596    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 597    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 598    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 599
 600 /* Return the length of the rectangle within which the top of the
 601    handle must stay.  This isn't equivalent to the inside height,
 602    because the scroll bar handle has a minimum height.
 603
 604    This is the real range of motion for the scroll bar, so when we're
 605    scaling buffer positions to scroll bar positions, we use this, not
 606    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 607 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 608   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 609
 610 /* Return the inside height of vertical scroll bar, given the outside
 611    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 612 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 613   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 614
 615
 616 /* Border widths for scroll bars.
 617
 618    Scroll bar windows don't have any borders; their border width is
 619    set to zero, and we redraw borders ourselves.  This makes the code
 620    a bit cleaner, since we don't have to convert between outside width
 621    (used when relating to the rest of the screen) and inside width
 622    (used when sizing and drawing the scroll bar window itself).
 623
 624    The handle moves up and down/back and forth in a rectangle inset
 625    from the edges of the scroll bar.  These are widths by which we
 626    inset the handle boundaries from the scroll bar edges.  */
 627 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 628 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 629 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 630 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 631
 632 /* Minimum lengths for scroll bar handles, in pixels.  */
 633 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 634
 635 /* Trimming off a few pixels from each side prevents
 636    text from glomming up against the scroll bar */
 637 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 638
 639 \f
 640 /* Manipulating pixel sizes and character sizes.
 641    Knowledge of which factors affect the overall size of the window should
 642    be hidden in these macros, if that's possible.
 643
 644    Return the upper/left pixel position of the character cell on frame F
 645    at ROW/COL.  */
 646 #define CHAR_TO_PIXEL_ROW(f, row) \
 647   ((f)->output_data.w32->internal_border_width \
 648    + (row) * (f)->output_data.w32->line_height)
 649 #define CHAR_TO_PIXEL_COL(f, col) \
 650   ((f)->output_data.w32->internal_border_width \
 651    + (col) * FONT_WIDTH ((f)->output_data.w32->font))
 652
 653 /* Return the pixel width/height of frame F if it has
 654    WIDTH columns/HEIGHT rows.  */
 655 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 656   (CHAR_TO_PIXEL_COL (f, width) \
 657    + (f)->output_data.w32->vertical_scroll_bar_extra \
 658    + (f)->output_data.w32->flags_areas_extra \
 659    + (f)->output_data.w32->internal_border_width)
 660 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 661   (CHAR_TO_PIXEL_ROW (f, height) \
 662    + (f)->output_data.w32->internal_border_width)
 663
 664
 665 /* Return the row/column (zero-based) of the character cell containing
 666    the pixel on FRAME at ROW/COL.  */
 667 #define PIXEL_TO_CHAR_ROW(f, row) \
 668   (((row) - (f)->output_data.w32->internal_border_width) \
 669    / (f)->output_data.w32->line_height)
 670 #define PIXEL_TO_CHAR_COL(f, col) \
 671   (((col) - (f)->output_data.w32->internal_border_width) \
 672    / FONT_WIDTH ((f)->output_data.w32->font))
 673
 674 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 675    frame F?  */
 676 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 677   (PIXEL_TO_CHAR_COL (f, ((width) \
 678                           - (f)->output_data.w32->internal_border_width \
 679                           - (f)->output_data.w32->flags_areas_extra \
 680                           - (f)->output_data.w32->vertical_scroll_bar_extra)))
 681 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 682   (PIXEL_TO_CHAR_ROW (f, ((height) \
 683                           - (f)->output_data.w32->internal_border_width)))
 684
 685 \f
 686 extern void w32_fill_rect ();
 687 extern void w32_clear_window ();
 688
 689 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 690 { \
 691     RECT rect; \
 692     rect.left = x; \
 693     rect.top = y; \
 694     rect.right = x + nx; \
 695     rect.bottom = y + ny; \
 696     w32_fill_rect (f,hdc,pix,&rect); \
 697 }
 698
 699 #define w32_clear_rect(f,hdc,lprect) \
 700 w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
 701
 702 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 703 w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
 704
 705 extern struct font_info *w32_load_font ();
 706 extern void w32_unload_font ();
 707
 708 /* Define for earlier versions of Visual C */
 709 #ifndef WM_MOUSEWHEEL
 710 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 711 #endif /* WM_MOUSEWHEEL */
 712 #ifndef MSH_MOUSEWHEEL
 713 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 714 #endif /* MSH_MOUSEWHEEL */
 715
 716 #define WM_EMACS_START                 (WM_USER + 1)
 717 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 718 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 719 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 720 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 721 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 722 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 723 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 724 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 725 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 726 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 727 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 728 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 729 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 730 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 731 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 732 #define WM_EMACS_END                   (WM_EMACS_START + 15)
 733
 734 #define WND_FONTWIDTH_INDEX    (0)
 735 #define WND_LINEHEIGHT_INDEX   (4)
 736 #define WND_BORDER_INDEX       (8)
 737 #define WND_SCROLLBAR_INDEX    (12)
 738 #define WND_BACKGROUND_INDEX   (16)
 739 #define WND_LAST_INDEX         (20)
 740
 741 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 742
 743 extern DWORD dwWindowsThreadId;
 744 extern HANDLE hWindowsThread;
 745 extern DWORD dwMainThreadId;
 746 extern HANDLE hMainThread;
 747
 748 typedef struct W32Msg {
 749     MSG msg;
 750     DWORD dwModifiers;
 751     RECT rect;
 752 } W32Msg;
 753
 754 /* Structure for recording message when input thread must return a
 755    result that depends on lisp thread to compute.  Lisp thread can
 756    complete deferred messages out of order.  */
 757 typedef struct deferred_msg
 758 {
 759   struct deferred_msg * next;
 760   W32Msg                w32msg;
 761   LRESULT               result;
 762   int                   completed;
 763 } deferred_msg;
 764
 765 extern CRITICAL_SECTION critsect;
 766
 767 extern void init_crit ();
 768 extern void delete_crit ();
 769
 770 extern void signal_quit ();
 771
 772 #define enter_crit() EnterCriticalSection (&critsect)
 773 #define leave_crit() LeaveCriticalSection (&critsect)
 774
 775 extern void select_palette (struct frame * f, HDC hdc);
 776 extern void deselect_palette (struct frame * f, HDC hdc);
 777 extern HDC get_frame_dc (struct frame * f);
 778 extern int release_frame_dc (struct frame * f, HDC hDC);
 779
 780 extern void drain_message_queue ();
 781
 782 extern BOOL get_next_msg ();
 783 extern BOOL post_msg ();
 784 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 785 extern void wait_for_sync ();
 786
 787 extern BOOL parse_button ();
 788
 789 /* Keypad command key support.  W32 doesn't have virtual keys defined
 790    for the function keys on the keypad (they are mapped to the standard
 791    fuction keys), so we define our own.  */
 792 #define VK_NUMPAD_BEGIN         0x92
 793 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 794 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 795 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 796 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 797 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 798 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 799 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 800 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 801 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 802 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 803 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 804 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 805
 806 #ifndef VK_LWIN
 807 /* Older compiler environments don't have these defined.  */
 808 #define VK_LWIN                 0x5B
 809 #define VK_RWIN                 0x5C
 810 #define VK_APPS                 0x5D
 811 #endif
 812
 813 /* Support for treating Windows and Apps keys as modifiers.  These
 814    constants must not overlap with any of the dwControlKeyState flags in
 815    KEY_EVENT_RECORD.  */
 816 #define LEFT_WIN_PRESSED       0x8000
 817 #define RIGHT_WIN_PRESSED      0x4000
 818 #define APPS_PRESSED           0x2000
 819
 820 struct image;
 821 struct face;
 822
 823 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 824 struct frame * check_x_frame (Lisp_Object);
 825 EXFUN (Fx_display_color_p, 1);
 826 EXFUN (Fx_display_grayscale_p, 1);
 827 int image_ascent P_ ((struct image *, struct face *));