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 *x_display_list;
 241 extern struct w32_display_info one_w32_display_info;
 242
 243 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 244    one for each element of w32_display_list and in the same order.
 245    NAME is the name of the frame.
 246    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 247 extern Lisp_Object w32_display_name_list;
 248
 249 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.  */
 250 extern Lisp_Object Vx_pixel_size_width_font_regexp;
 251
 252 /* A flag to control how to display unibyte 8-bit character.  */
 253 extern int unibyte_display_via_language_environment;
 254
 255 struct w32_display_info *x_display_info_for_name ();
 256
 257 extern struct w32_display_info *w32_term_init ();
 258 \f
 259 extern Lisp_Object w32_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
 260 extern struct font_info *w32_get_font_info (), *w32_query_font ();
 261 extern void w32_cache_char_metrics (XFontStruct *font);
 262 extern void w32_find_ccl_program();
 263 \f
 264 #define PIX_TYPE COLORREF
 265
 266 /* Each W32 frame object points to its own struct w32_display object
 267    in the output_data.w32 field.  The w32_display structure contains all
 268    the information that is specific to W32 windows.  */
 269
 270 /* Put some things in x_output for compatibility.
 271    NTEMACS_TODO: Move all common things here to eliminate unneccesary
 272    diffs between X and w32 code.  */
 273 struct x_output
 274 {
 275   PIX_TYPE background_pixel;
 276   PIX_TYPE foreground_pixel;
 277 };
 278
 279
 280 struct w32_output
 281 {
 282   /* Placeholder for things accessed through output_data.x.  */
 283   struct x_output x_compatibile;
 284
 285   /* Menubar "widget" handle.  */
 286   HMENU menubar_widget;
 287
 288   /* Original palette (used to deselect real palette after drawing) */
 289   HPALETTE old_palette;
 290
 291   /* Position of the W32 window (x and y offsets in root window).  */
 292   int left_pos;
 293   int top_pos;
 294
 295   /* Border width of the W32 window as known by the window system.  */
 296   int border_width;
 297
 298   /* Size of the W32 window in pixels.  */
 299   int pixel_height, pixel_width;
 300
 301   /* Height of a line, in pixels.  */
 302   int line_height;
 303
 304   /* Here are the Graphics Contexts for the default font.  */
 305   XGCValues *cursor_gc;                         /* cursor drawing */
 306
 307   /* Width of the internal border.  This is a line of background color
 308      just inside the window's border.  When the frame is selected,
 309      a highlighting is displayed inside the internal border.  */
 310   int internal_border_width;
 311
 312   /* The window used for this frame.
 313      May be zero while the frame object is being created
 314      and the window has not yet been created.  */
 315   Window window_desc;
 316
 317   /* The window that is the parent of this window.
 318      Usually this is a window that was made by the window manager,
 319      but it can be the root window, and it can be explicitly specified
 320      (see the explicit_parent field, below).  */
 321   Window parent_desc;
 322
 323   /* Default ASCII font of this frame. */
 324   XFontStruct *font;
 325
 326   /* The baseline offset of the default ASCII font.  */
 327   int baseline_offset;
 328
 329   /* If a fontset is specified for this frame instead of font, this
 330      value contains an ID of the fontset, else -1.  */
 331   int fontset;
 332
 333   /* Pixel values used for various purposes.
 334      border_pixel may be -1 meaning use a gray tile.  */
 335   COLORREF cursor_pixel;
 336   COLORREF border_pixel;
 337   COLORREF mouse_pixel;
 338   COLORREF cursor_foreground_pixel;
 339
 340   /* Foreground color for scroll bars.  A value of -1 means use the
 341      default (black for non-toolkit scroll bars).  */
 342   COLORREF scroll_bar_foreground_pixel;
 343
 344   /* Background color for scroll bars.  A value of -1 means use the
 345      default (background color of the frame for non-toolkit scroll
 346      bars).  */
 347   COLORREF scroll_bar_background_pixel;
 348
 349   /* Descriptor for the cursor in use for this window.  */
 350   Cursor text_cursor;
 351   Cursor nontext_cursor;
 352   Cursor modeline_cursor;
 353   Cursor cross_cursor;
 354   Cursor hourglass_cursor;
 355   Cursor horizontal_drag_cursor;
 356
 357   /* Window whose cursor is hourglass_cursor.  This window is
 358      temporarily mapped to display an hourglass cursor.  */
 359   Window hourglass_window;
 360
 361   /* Non-zero means hourglass cursor is currently displayed.  */
 362   unsigned hourglass_p : 1;
 363
 364   /* Flag to set when the window needs to be completely repainted.  */
 365   int needs_exposure;
 366
 367   /* What kind of text cursor is drawn in this window right now?
 368      (If there is no cursor (phys_cursor_x < 0), then this means nothing.)  */
 369   enum text_cursor_kinds current_cursor;
 370
 371   /* What kind of text cursor should we draw in the future?
 372      This should always be filled_box_cursor or bar_cursor.  */
 373   enum text_cursor_kinds desired_cursor;
 374
 375   /* Width of bar cursor (if we are using that).  */
 376   int cursor_width;
 377
 378   DWORD dwStyle;
 379
 380   /* The size of the extra width currently allotted for vertical
 381      scroll bars, in pixels.  */
 382   int vertical_scroll_bar_extra;
 383
 384   /* The extra width currently allotted for the areas in which
 385      truncation marks, continuation marks, and overlay arrows are
 386      displayed.  */
 387   int flags_areas_extra;
 388
 389   /* This is the gravity value for the specified window position.  */
 390   int win_gravity;
 391
 392   /* The geometry flags for this window.  */
 393   int size_hint_flags;
 394
 395   /* This is the Emacs structure for the display this frame is on.  */
 396   /* struct w32_display_info *display_info; */
 397
 398   /* Nonzero means our parent is another application's window
 399      and was explicitly specified.  */
 400   char explicit_parent;
 401
 402   /* Nonzero means tried already to make this frame visible.  */
 403   char asked_for_visible;
 404
 405   /* Nonzero means menubar is currently active.  */
 406   char menubar_active;
 407
 408   /* Nonzero means menubar is about to become active, but should be
 409      brought up to date first.  */
 410   volatile char pending_menu_activation;
 411
 412   /* Relief GCs, colors etc.  */
 413   struct relief
 414   {
 415     XGCValues *gc;
 416     unsigned long pixel;
 417     int allocated_p;
 418   }
 419   black_relief, white_relief;
 420
 421   /* The background for which the above relief GCs were set up.
 422      They are changed only when a different background is involved.  */
 423   unsigned long relief_background;
 424 };
 425
 426 extern struct w32_output w32term_display;
 427
 428 /* Return the window associated with the frame F.  */
 429 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 430
 431 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 432 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 433 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 434 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 435 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.w32->internal_border_width)
 436 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.w32->line_height)
 437 /* Width of the default font of frame F.  Must be defined by each
 438    terminal specific header.  */
 439 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 440 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 441
 442 /* This gives the w32_display_info structure for the display F is on.  */
 443 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 444 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 445
 446 /* This is the 'font_info *' which frame F has.  */
 447 #define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
 448
 449 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 450 #define PIXEL_WIDTH(f) ((f)->output_data.w32->pixel_width)
 451 #define PIXEL_HEIGHT(f) ((f)->output_data.w32->pixel_height)
 452
 453 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.w32->desired_cursor)
 454
 455 /* Value is the smallest width of any character in any font on frame F.  */
 456
 457 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 458      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 459
 460 /* Value is the smallest height of any font on frame F.  */
 461
 462 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 463      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 464
 465 /* Return a pointer to the image cache of frame F.  */
 466
 467 #define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
 468
 469 \f
 470 /* Pixel width of the bitmaps drawn to indicate truncation,
 471    continuation etc.  */
 472
 473 #define FRAME_FLAGS_BITMAP_WIDTH(f)     8
 474 #define FRAME_FLAGS_BITMAP_HEIGHT(f)    8
 475
 476 /* Total width of areas reserved for drawing truncation bitmaps,
 477    continuation bitmaps and alike.  The width is in canonical char
 478    units of the frame.  This must currently be the case because window
 479    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 480    able to split windows horizontally nicely.  */
 481
 482 #define FRAME_X_FLAGS_AREA_COLS(F)                              \
 483      ((2 * FRAME_FLAGS_BITMAP_WIDTH ((F)) + CANON_X_UNIT ((F)) - 1)     \
 484       / CANON_X_UNIT ((F)))
 485
 486 /* Total width of flags areas in pixels.  */
 487
 488 #define FRAME_X_FLAGS_AREA_WIDTH(F) \
 489      (FRAME_X_FLAGS_AREA_COLS ((F)) * CANON_X_UNIT ((F)))
 490
 491 /* Pixel-width of the left flags area.  */
 492
 493 #define FRAME_X_LEFT_FLAGS_AREA_WIDTH(F) \
 494      (FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 495
 496 /* Pixel-width of the right flags area.  Note that we are doing
 497    integer arithmetic here, so don't loose a pixel if the total
 498    width is an odd number.  */
 499
 500 #define FRAME_X_RIGHT_FLAGS_AREA_WIDTH(F)       \
 501      (FRAME_X_FLAGS_AREA_WIDTH (F) - FRAME_X_FLAGS_AREA_WIDTH (F) / 2)
 502
 503
 504 \f
 505 /* W32-specific scroll bar stuff.  */
 506
 507 /* We represent scroll bars as lisp vectors.  This allows us to place
 508    references to them in windows without worrying about whether we'll
 509    end up with windows referring to dead scroll bars; the garbage
 510    collector will free it when its time comes.
 511
 512    We use struct scroll_bar as a template for accessing fields of the
 513    vector.  */
 514
 515 struct scroll_bar {
 516
 517   /* These fields are shared by all vectors.  */
 518   EMACS_INT size_from_Lisp_Vector_struct;
 519   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 520
 521   /* The window we're a scroll bar for.  */
 522   Lisp_Object window;
 523
 524   /* The next and previous in the chain of scroll bars in this frame.  */
 525   Lisp_Object next, prev;
 526
 527   /* The window representing this scroll bar.  Since this is a full
 528      32-bit quantity, we store it split into two 32-bit values.  */
 529   Lisp_Object w32_window_low, w32_window_high;
 530
 531   /* Same as above for the widget.  */
 532   Lisp_Object w32_widget_low, w32_widget_high;
 533
 534   /* The position and size of the scroll bar in pixels, relative to the
 535      frame.  */
 536   Lisp_Object top, left, width, height;
 537
 538   /* The starting and ending positions of the handle, relative to the
 539      handle area (i.e. zero is the top position, not
 540      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 541      hasn't been drawn yet.
 542
 543      These are not actually the locations where the beginning and end
 544      are drawn; in order to keep handles from becoming invisible when
 545      editing large files, we establish a minimum height by always
 546      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 547      where they would be normally; the bottom and top are in a
 548      different co-ordinate system.  */
 549   Lisp_Object start, end;
 550
 551   /* If the scroll bar handle is currently being dragged by the user,
 552      this is the number of pixels from the top of the handle to the
 553      place where the user grabbed it.  If the handle isn't currently
 554      being dragged, this is Qnil.  */
 555   Lisp_Object dragging;
 556 };
 557
 558 /* The number of elements a vector holding a struct scroll_bar needs.  */
 559 #define SCROLL_BAR_VEC_SIZE                                     \
 560   ((sizeof (struct scroll_bar)                                  \
 561     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 562    / sizeof (Lisp_Object))
 563
 564 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 565 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 566
 567
 568 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 569 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 570
 571 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 572 #define SCROLL_BAR_UNPACK(low, high, int32) \
 573   (XSETINT ((low),   (int32)        & 0xffff), \
 574    XSETINT ((high), ((int32) >> 16) & 0xffff))
 575
 576
 577 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 578 #define SCROLL_BAR_W32_WINDOW(ptr) \
 579   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 580
 581 /* Store a window id in a struct scroll_bar.  */
 582 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 583   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 584
 585 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 586 #define SCROLL_BAR_X_WIDGET(ptr) \
 587   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 588
 589 /* Store a widget id in a struct scroll_bar.  */
 590 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 591   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 592
 593 /* Return the inside width of a vertical scroll bar, given the outside
 594    width.  */
 595 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 596   ((width) \
 597    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 598    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 599    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 600
 601 /* Return the length of the rectangle within which the top of the
 602    handle must stay.  This isn't equivalent to the inside height,
 603    because the scroll bar handle has a minimum height.
 604
 605    This is the real range of motion for the scroll bar, so when we're
 606    scaling buffer positions to scroll bar positions, we use this, not
 607    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 608 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 609   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 610
 611 /* Return the inside height of vertical scroll bar, given the outside
 612    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 613 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 614   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 615
 616
 617 /* Border widths for scroll bars.
 618
 619    Scroll bar windows don't have any borders; their border width is
 620    set to zero, and we redraw borders ourselves.  This makes the code
 621    a bit cleaner, since we don't have to convert between outside width
 622    (used when relating to the rest of the screen) and inside width
 623    (used when sizing and drawing the scroll bar window itself).
 624
 625    The handle moves up and down/back and forth in a rectangle inset
 626    from the edges of the scroll bar.  These are widths by which we
 627    inset the handle boundaries from the scroll bar edges.  */
 628 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 629 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 630 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 631 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 632
 633 /* Minimum lengths for scroll bar handles, in pixels.  */
 634 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 635
 636 /* Trimming off a few pixels from each side prevents
 637    text from glomming up against the scroll bar */
 638 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 639
 640 \f
 641 /* Manipulating pixel sizes and character sizes.
 642    Knowledge of which factors affect the overall size of the window should
 643    be hidden in these macros, if that's possible.
 644
 645    Return the upper/left pixel position of the character cell on frame F
 646    at ROW/COL.  */
 647 #define CHAR_TO_PIXEL_ROW(f, row) \
 648   ((f)->output_data.w32->internal_border_width \
 649    + (row) * (f)->output_data.w32->line_height)
 650 #define CHAR_TO_PIXEL_COL(f, col) \
 651   ((f)->output_data.w32->internal_border_width \
 652    + (col) * FONT_WIDTH ((f)->output_data.w32->font))
 653
 654 /* Return the pixel width/height of frame F if it has
 655    WIDTH columns/HEIGHT rows.  */
 656 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 657   (CHAR_TO_PIXEL_COL (f, width) \
 658    + (f)->output_data.w32->vertical_scroll_bar_extra \
 659    + (f)->output_data.w32->flags_areas_extra \
 660    + (f)->output_data.w32->internal_border_width)
 661 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 662   (CHAR_TO_PIXEL_ROW (f, height) \
 663    + (f)->output_data.w32->internal_border_width)
 664
 665
 666 /* Return the row/column (zero-based) of the character cell containing
 667    the pixel on FRAME at ROW/COL.  */
 668 #define PIXEL_TO_CHAR_ROW(f, row) \
 669   (((row) - (f)->output_data.w32->internal_border_width) \
 670    / (f)->output_data.w32->line_height)
 671 #define PIXEL_TO_CHAR_COL(f, col) \
 672   (((col) - (f)->output_data.w32->internal_border_width) \
 673    / FONT_WIDTH ((f)->output_data.w32->font))
 674
 675 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 676    frame F?  */
 677 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 678   (PIXEL_TO_CHAR_COL (f, ((width) \
 679                           - (f)->output_data.w32->internal_border_width \
 680                           - (f)->output_data.w32->flags_areas_extra \
 681                           - (f)->output_data.w32->vertical_scroll_bar_extra)))
 682 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 683   (PIXEL_TO_CHAR_ROW (f, ((height) \
 684                           - (f)->output_data.w32->internal_border_width)))
 685
 686 \f
 687 extern void w32_fill_rect ();
 688 extern void w32_clear_window ();
 689
 690 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 691 { \
 692     RECT rect; \
 693     rect.left = x; \
 694     rect.top = y; \
 695     rect.right = x + nx; \
 696     rect.bottom = y + ny; \
 697     w32_fill_rect (f,hdc,pix,&rect); \
 698 }
 699
 700 #define w32_clear_rect(f,hdc,lprect) \
 701 w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
 702
 703 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 704 w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
 705
 706 extern struct font_info *w32_load_font ();
 707 extern void w32_unload_font ();
 708
 709 /* Define for earlier versions of Visual C */
 710 #ifndef WM_MOUSEWHEEL
 711 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 712 #endif /* WM_MOUSEWHEEL */
 713 #ifndef MSH_MOUSEWHEEL
 714 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 715 #endif /* MSH_MOUSEWHEEL */
 716
 717 #define WM_EMACS_START                 (WM_USER + 1)
 718 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 719 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 720 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 721 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 722 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 723 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 724 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 725 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 726 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 727 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 728 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 729 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 730 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 731 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 732 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 733 #define WM_EMACS_END                   (WM_EMACS_START + 15)
 734
 735 #define WND_FONTWIDTH_INDEX    (0)
 736 #define WND_LINEHEIGHT_INDEX   (4)
 737 #define WND_BORDER_INDEX       (8)
 738 #define WND_SCROLLBAR_INDEX    (12)
 739 #define WND_BACKGROUND_INDEX   (16)
 740 #define WND_LAST_INDEX         (20)
 741
 742 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 743
 744 extern DWORD dwWindowsThreadId;
 745 extern HANDLE hWindowsThread;
 746 extern DWORD dwMainThreadId;
 747 extern HANDLE hMainThread;
 748
 749 typedef struct W32Msg {
 750     MSG msg;
 751     DWORD dwModifiers;
 752     RECT rect;
 753 } W32Msg;
 754
 755 /* Structure for recording message when input thread must return a
 756    result that depends on lisp thread to compute.  Lisp thread can
 757    complete deferred messages out of order.  */
 758 typedef struct deferred_msg
 759 {
 760   struct deferred_msg * next;
 761   W32Msg                w32msg;
 762   LRESULT               result;
 763   int                   completed;
 764 } deferred_msg;
 765
 766 extern CRITICAL_SECTION critsect;
 767
 768 extern void init_crit ();
 769 extern void delete_crit ();
 770
 771 extern void signal_quit ();
 772
 773 #define enter_crit() EnterCriticalSection (&critsect)
 774 #define leave_crit() LeaveCriticalSection (&critsect)
 775
 776 extern void select_palette (struct frame * f, HDC hdc);
 777 extern void deselect_palette (struct frame * f, HDC hdc);
 778 extern HDC get_frame_dc (struct frame * f);
 779 extern int release_frame_dc (struct frame * f, HDC hDC);
 780
 781 extern void drain_message_queue ();
 782
 783 extern BOOL get_next_msg ();
 784 extern BOOL post_msg ();
 785 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 786 extern void wait_for_sync ();
 787
 788 extern BOOL parse_button ();
 789
 790 /* Keypad command key support.  W32 doesn't have virtual keys defined
 791    for the function keys on the keypad (they are mapped to the standard
 792    fuction keys), so we define our own.  */
 793 #define VK_NUMPAD_BEGIN         0x92
 794 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 795 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 796 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 797 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 798 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 799 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 800 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 801 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 802 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 803 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 804 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 805 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 806
 807 #ifndef VK_LWIN
 808 /* Older compiler environments don't have these defined.  */
 809 #define VK_LWIN                 0x5B
 810 #define VK_RWIN                 0x5C
 811 #define VK_APPS                 0x5D
 812 #endif
 813
 814 /* Support for treating Windows and Apps keys as modifiers.  These
 815    constants must not overlap with any of the dwControlKeyState flags in
 816    KEY_EVENT_RECORD.  */
 817 #define LEFT_WIN_PRESSED       0x8000
 818 #define RIGHT_WIN_PRESSED      0x4000
 819 #define APPS_PRESSED           0x2000
 820
 821 struct image;
 822 struct face;
 823
 824 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 825 struct frame * check_x_frame (Lisp_Object);
 826 EXFUN (Fx_display_color_p, 1);
 827 EXFUN (Fx_display_grayscale_p, 1);
 828 int image_ascent P_ ((struct image *, struct face *));