src/w32term.h

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