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