src/w32term.h

   1 /* Definitions and headers for communication on the Microsoft W32 API.
   2    Copyright (C) 1995, 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Added by Kevin Gallo */
  22
  23 #include "w32gui.h"
  24
  25 /* The class of this X application.  */
  26 #define EMACS_CLASS "Emacs"
  27 \f
  28 #define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
  29 #define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
  30
  31 #define FONT_WIDTH(f)       \
  32   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmAveCharWidth)
  33 #define FONT_HEIGHT(f)      \
  34    ((f)->bdf ? (f)->bdf->height : (f)->tm.tmHeight)
  35 #define FONT_BASE(f)        \
  36   ((f)->bdf ? (f)->bdf->ury : (f)->tm.tmAscent)
  37 #define FONT_DESCENT(f)     \
  38   ((f)->bdf ? -((f)->bdf->lly) : (f)->tm.tmDescent)
  39 #define FONT_MAX_WIDTH(f)   \
  40   ((f)->bdf ? (f)->bdf->width : (f)->tm.tmMaxCharWidth)
  41
  42 #define CP_DEFAULT 1004
  43 /* Special pseudo-codepages. */
  44 #define CP_8BIT      -1
  45 #define CP_UNICODE   -2
  46 #define CP_UNKNOWN   -3
  47
  48 #define CHECK_W32_FRAME(f, frame)               \
  49   if (NILP (frame))                             \
  50     f = SELECTED_FRAME ();                      \
  51   else                                          \
  52     {                                           \
  53       CHECK_LIVE_FRAME (frame, 0);              \
  54       f = XFRAME (frame);                       \
  55     }                                           \
  56   if (! FRAME_W32_P (f))
  57
  58 /* Indicates whether we are in the readsocket call and the message we
  59    are processing in the current loop */
  60
  61 extern MSG CurMsg;
  62 extern BOOL bUseDflt;
  63
  64 extern struct frame *x_window_to_frame ();
  65
  66 /* Structure recording bitmaps and reference count.
  67    If REFCOUNT is 0 then this record is free to be reused.  */
  68
  69 struct w32_bitmap_record
  70 {
  71   Pixmap pixmap;
  72   char *file;
  73   HINSTANCE hinst; /* Used to load the file */
  74   int refcount;
  75   /* Record some info about this pixmap.  */
  76   int height, width, depth;
  77 };
  78
  79 /* Palette book-keeping stuff for mapping requested colors into the
  80    system palette.  Keep a ref-counted list of requested colors and
  81    regenerate the app palette whenever the requested list changes. */
  82
  83 extern Lisp_Object Vw32_enable_palette;
  84
  85 struct w32_palette_entry {
  86   struct w32_palette_entry * next;
  87   PALETTEENTRY entry;
  88 #if 0
  89   unsigned refcount;
  90 #endif
  91 };
  92
  93 extern void w32_regenerate_palette(struct frame *f);
  94
  95 \f
  96 /* For each display (currently only one on w32), we have a structure that
  97    records information about it.  */
  98
  99 struct w32_display_info
 100 {
 101   /* Chain of all w32_display_info structures.  */
 102   struct w32_display_info *next;
 103
 104   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
 105      The same cons cell also appears in x_display_name_list.  */
 106   Lisp_Object name_list_element;
 107
 108   /* Number of frames that are on this display.  */
 109   int reference_count;
 110
 111   /* Dots per inch of the screen.  */
 112   double resx, resy;
 113
 114   /* Number of planes on this screen.  */
 115   int n_planes;
 116
 117   /* Number of bits per pixel on this screen.  */
 118   int n_cbits;
 119
 120   /* Dimensions of this screen.  */
 121   int height, width;
 122   int height_in,width_in;
 123
 124   /* Mask of things that cause the mouse to be grabbed.  */
 125   int grabbed;
 126
 127   /* Emacs bitmap-id of the default icon bitmap for this frame.
 128      Or -1 if none has been allocated yet.  */
 129   int icon_bitmap_id;
 130
 131   /* The root window of this screen.  */
 132   Window root_window;
 133
 134   /* The cursor to use for vertical scroll bars.  */
 135   Cursor vertical_scroll_bar_cursor;
 136
 137   /* Resource data base */
 138   char *xrdb;
 139
 140   /* color palette information.  */
 141   int has_palette;
 142   struct w32_palette_entry * color_list;
 143   unsigned num_colors;
 144   HPALETTE palette;
 145
 146   /* deferred action flags checked when starting frame update.  */
 147   int regen_palette;
 148
 149   /* Keystroke that has been faked by Emacs and will be ignored when
 150      received; value is reset after key is received.  */
 151   int faked_key;
 152
 153   /* A table of all the fonts we have already loaded.  */
 154   struct font_info *font_table;
 155
 156   /* The current capacity of font_table.  */
 157   int font_table_size;
 158
 159   /* Minimum width over all characters in all fonts in font_table.  */
 160   int smallest_char_width;
 161
 162   /* Minimum font height over all fonts in font_table.  */
 163   int smallest_font_height;
 164
 165   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 166   XGCValues *scratch_cursor_gc;
 167
 168   /* These variables describe the range of text currently shown in its
 169      mouse-face, together with the window they apply to. As long as
 170      the mouse stays within this range, we need not redraw anything on
 171      its account.  Rows and columns are glyph matrix positions in
 172      MOUSE_FACE_WINDOW.  */
 173   int mouse_face_beg_row, mouse_face_beg_col;
 174   int mouse_face_beg_x, mouse_face_beg_y;
 175   int mouse_face_end_row, mouse_face_end_col;
 176   int mouse_face_end_x, mouse_face_end_y;
 177   int mouse_face_past_end;
 178   Lisp_Object mouse_face_window;
 179   int mouse_face_face_id;
 180   Lisp_Object mouse_face_overlay;
 181
 182   /* 1 if a mouse motion event came and we didn't handle it right away because
 183      gc was in progress.  */
 184   int mouse_face_deferred_gc;
 185
 186   /* FRAME and X, Y position of mouse when last checked for
 187      highlighting.  X and Y can be negative or out of range for the frame.  */
 188   struct frame *mouse_face_mouse_frame;
 189   int mouse_face_mouse_x, mouse_face_mouse_y;
 190
 191   /* Nonzero means defer mouse-motion highlighting.  */
 192   int mouse_face_defer;
 193
 194   /* Nonzero means that the mouse highlight should not be shown.  */
 195   int mouse_face_hidden;
 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 *x_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_compatible;
 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   Cursor hand_cursor;
 357
 358   /* Window whose cursor is hourglass_cursor.  This window is
 359      temporarily mapped to display an hourglass cursor.  */
 360   Window hourglass_window;
 361
 362   /* Non-zero means hourglass cursor is currently displayed.  */
 363   unsigned hourglass_p : 1;
 364
 365   /* Flag to set when the window needs to be completely repainted.  */
 366   int needs_exposure;
 367
 368   DWORD dwStyle;
 369
 370   /* The size of the extra width currently allotted for vertical
 371      scroll bars, in pixels.  */
 372   int vertical_scroll_bar_extra;
 373
 374   /* The extra width currently allotted for the areas in which
 375      truncation marks, continuation marks, and overlay arrows are
 376      displayed.  */
 377   int left_fringe_width, right_fringe_width;
 378   int fringe_cols, fringes_extra;
 379
 380   /* This is the gravity value for the specified window position.  */
 381   int win_gravity;
 382
 383   /* The geometry flags for this window.  */
 384   int size_hint_flags;
 385
 386   /* This is the Emacs structure for the display this frame is on.  */
 387   /* struct w32_display_info *display_info; */
 388
 389   /* Nonzero means our parent is another application's window
 390      and was explicitly specified.  */
 391   char explicit_parent;
 392
 393   /* Nonzero means tried already to make this frame visible.  */
 394   char asked_for_visible;
 395
 396   /* Nonzero means menubar is currently active.  */
 397   char menubar_active;
 398
 399   /* Nonzero means a menu command is being processed.  */
 400   char menu_command_in_progress;
 401
 402   /* Nonzero means menubar is about to become active, but should be
 403      brought up to date first.  */
 404   volatile char pending_menu_activation;
 405
 406   /* Relief GCs, colors etc.  */
 407   struct relief
 408   {
 409     XGCValues *gc;
 410     unsigned long pixel;
 411     int allocated_p;
 412   }
 413   black_relief, white_relief;
 414
 415   /* The background for which the above relief GCs were set up.
 416      They are changed only when a different background is involved.  */
 417   unsigned long relief_background;
 418
 419   /* See enum below */
 420   int want_fullscreen;
 421
 422   /* This many pixels are the difference between the outer window (i.e. the
 423      left of the window manager decoration) and FRAME_W32_WINDOW. */
 424   int x_pixels_diff;
 425
 426   /* This many pixels are the difference between the outer window (i.e. the
 427      top of the window manager titlebar) and FRAME_W32_WINDOW. */
 428   int y_pixels_diff;
 429 };
 430
 431 extern struct w32_output w32term_display;
 432
 433 enum
 434 {
 435   /* Values used as a bit mask, BOTH == WIDTH | HEIGHT.  */
 436   FULLSCREEN_NONE       = 0,
 437   FULLSCREEN_WIDTH      = 1,
 438   FULLSCREEN_HEIGHT     = 2,
 439   FULLSCREEN_BOTH       = 3,
 440   FULLSCREEN_WAIT       = 4,
 441   FULLSCREEN_MOVE_WAIT  = 8,
 442 };
 443
 444 /* Return the X output data for frame F.  */
 445 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
 446
 447 /* Return the window associated with the frame F.  */
 448 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
 449 #define FRAME_X_WINDOW(f) ((f)->output_data.w32->window_desc)
 450
 451 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 452 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 453 #define FRAME_FONT(f) ((f)->output_data.w32->font)
 454 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
 455 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.w32->internal_border_width)
 456 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.w32->line_height)
 457 /* Width of the default font of frame F.  Must be defined by each
 458    terminal specific header.  */
 459 #define FRAME_DEFAULT_FONT_WIDTH(F)     FONT_WIDTH (FRAME_FONT (F))
 460 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
 461
 462 /* This gives the w32_display_info structure for the display F is on.  */
 463 #define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
 464 #define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
 465
 466 /* This is the `Display *' which frame F is on.  */
 467 #define FRAME_X_DISPLAY(f) (0)
 468
 469 /* This is the 'font_info *' which frame F has.  */
 470 #define FRAME_W32_FONT_TABLE(f) (FRAME_W32_DISPLAY_INFO (f)->font_table)
 471
 472 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}.  */
 473 #define PIXEL_WIDTH(f) ((f)->output_data.w32->pixel_width)
 474 #define PIXEL_HEIGHT(f) ((f)->output_data.w32->pixel_height)
 475
 476 /* Value is the smallest width of any character in any font on frame F.  */
 477
 478 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 479      FRAME_W32_DISPLAY_INFO(F)->smallest_char_width
 480
 481 /* Value is the smallest height of any font on frame F.  */
 482
 483 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 484      FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
 485
 486 /* Return a pointer to the image cache of frame F.  */
 487
 488 #define FRAME_X_IMAGE_CACHE(F) FRAME_W32_DISPLAY_INFO ((F))->image_cache
 489
 490 \f
 491 /* Total width of fringes reserved for drawing truncation bitmaps,
 492    continuation bitmaps and alike.  The width is in canonical char
 493    units of the frame.  This must currently be the case because window
 494    sizes aren't pixel values.  If it weren't the case, we wouldn't be
 495    able to split windows horizontally nicely.  */
 496
 497 #define FRAME_X_FRINGE_COLS(F)  ((F)->output_data.w32->fringe_cols)
 498
 499 /* Total width of fringes in pixels.  */
 500
 501 #define FRAME_X_FRINGE_WIDTH(F) ((F)->output_data.w32->fringes_extra)
 502
 503 /* Pixel-width of the left and right fringe.  */
 504
 505 #define FRAME_X_LEFT_FRINGE_WIDTH(F) ((F)->output_data.w32->left_fringe_width)
 506 #define FRAME_X_RIGHT_FRINGE_WIDTH(F) ((F)->output_data.w32->right_fringe_width)
 507
 508
 509 \f
 510 /* W32-specific scroll bar stuff.  */
 511
 512 /* We represent scroll bars as lisp vectors.  This allows us to place
 513    references to them in windows without worrying about whether we'll
 514    end up with windows referring to dead scroll bars; the garbage
 515    collector will free it when its time comes.
 516
 517    We use struct scroll_bar as a template for accessing fields of the
 518    vector.  */
 519
 520 struct scroll_bar {
 521
 522   /* These fields are shared by all vectors.  */
 523   EMACS_INT size_from_Lisp_Vector_struct;
 524   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 525
 526   /* The window we're a scroll bar for.  */
 527   Lisp_Object window;
 528
 529   /* The next and previous in the chain of scroll bars in this frame.  */
 530   Lisp_Object next, prev;
 531
 532   /* The window representing this scroll bar.  Since this is a full
 533      32-bit quantity, we store it split into two 32-bit values.  */
 534   Lisp_Object w32_window_low, w32_window_high;
 535
 536   /* Same as above for the widget.  */
 537   Lisp_Object w32_widget_low, w32_widget_high;
 538
 539   /* The position and size of the scroll bar in pixels, relative to the
 540      frame.  */
 541   Lisp_Object top, left, width, height;
 542
 543   /* The starting and ending positions of the handle, relative to the
 544      handle area (i.e. zero is the top position, not
 545      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 546      hasn't been drawn yet.
 547
 548      These are not actually the locations where the beginning and end
 549      are drawn; in order to keep handles from becoming invisible when
 550      editing large files, we establish a minimum height by always
 551      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 552      where they would be normally; the bottom and top are in a
 553      different co-ordinate system.  */
 554   Lisp_Object start, end;
 555
 556   /* If the scroll bar handle is currently being dragged by the user,
 557      this is the number of pixels from the top of the handle to the
 558      place where the user grabbed it.  If the handle isn't currently
 559      being dragged, this is Qnil.  */
 560   Lisp_Object dragging;
 561 };
 562
 563 /* The number of elements a vector holding a struct scroll_bar needs.  */
 564 #define SCROLL_BAR_VEC_SIZE                                     \
 565   ((sizeof (struct scroll_bar)                                  \
 566     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 567    / sizeof (Lisp_Object))
 568
 569 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 570 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 571
 572
 573 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 574 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 575
 576 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 577 #define SCROLL_BAR_UNPACK(low, high, int32) \
 578   (XSETINT ((low),   (int32)        & 0xffff), \
 579    XSETINT ((high), ((int32) >> 16) & 0xffff))
 580
 581
 582 /* Extract the window id of the scroll bar from a struct scroll_bar.  */
 583 #define SCROLL_BAR_W32_WINDOW(ptr) \
 584   ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
 585
 586 /* Store a window id in a struct scroll_bar.  */
 587 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
 588   (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (int) id))
 589
 590 /* Extract the X widget of the scroll bar from a struct scroll_bar.  */
 591 #define SCROLL_BAR_X_WIDGET(ptr) \
 592   ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
 593
 594 /* Store a widget id in a struct scroll_bar.  */
 595 #define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
 596   (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
 597
 598 /* Return the inside width of a vertical scroll bar, given the outside
 599    width.  */
 600 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 601   ((width) \
 602    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 603    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 604    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 605
 606 /* Return the length of the rectangle within which the top of the
 607    handle must stay.  This isn't equivalent to the inside height,
 608    because the scroll bar handle has a minimum height.
 609
 610    This is the real range of motion for the scroll bar, so when we're
 611    scaling buffer positions to scroll bar positions, we use this, not
 612    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 613 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 614   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
 615
 616 /* Return the inside height of vertical scroll bar, given the outside
 617    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 618 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 619   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 620
 621
 622 /* Border widths for scroll bars.
 623
 624    Scroll bar windows don't have any borders; their border width is
 625    set to zero, and we redraw borders ourselves.  This makes the code
 626    a bit cleaner, since we don't have to convert between outside width
 627    (used when relating to the rest of the screen) and inside width
 628    (used when sizing and drawing the scroll bar window itself).
 629
 630    The handle moves up and down/back and forth in a rectangle inset
 631    from the edges of the scroll bar.  These are widths by which we
 632    inset the handle boundaries from the scroll bar edges.  */
 633 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 634 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 635 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
 636 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
 637
 638 /* Minimum lengths for scroll bar handles, in pixels.  */
 639 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
 640
 641 /* Trimming off a few pixels from each side prevents
 642    text from glomming up against the scroll bar */
 643 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 644
 645 \f
 646 /* Manipulating pixel sizes and character sizes.
 647    Knowledge of which factors affect the overall size of the window should
 648    be hidden in these macros, if that's possible.
 649
 650    Return the upper/left pixel position of the character cell on frame F
 651    at ROW/COL.  */
 652 #define CHAR_TO_PIXEL_ROW(f, row) \
 653   ((f)->output_data.w32->internal_border_width \
 654    + (row) * (f)->output_data.w32->line_height)
 655 #define CHAR_TO_PIXEL_COL(f, col) \
 656   ((f)->output_data.w32->internal_border_width \
 657    + (col) * FONT_WIDTH ((f)->output_data.w32->font))
 658
 659 /* Return the pixel width/height of frame F if it has
 660    WIDTH columns/HEIGHT rows.  */
 661 #define CHAR_TO_PIXEL_WIDTH(f, width) \
 662   (CHAR_TO_PIXEL_COL (f, width) \
 663    + (f)->output_data.w32->vertical_scroll_bar_extra \
 664    + (f)->output_data.w32->fringes_extra \
 665    + (f)->output_data.w32->internal_border_width)
 666 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
 667   (CHAR_TO_PIXEL_ROW (f, height) \
 668    + (f)->output_data.w32->internal_border_width)
 669
 670
 671 /* Return the row/column (zero-based) of the character cell containing
 672    the pixel on FRAME at ROW/COL.  */
 673 #define PIXEL_TO_CHAR_ROW(f, row) \
 674   (((row) - (f)->output_data.w32->internal_border_width) \
 675    / (f)->output_data.w32->line_height)
 676 #define PIXEL_TO_CHAR_COL(f, col) \
 677   (((col) - (f)->output_data.w32->internal_border_width) \
 678    / FONT_WIDTH ((f)->output_data.w32->font))
 679
 680 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
 681    frame F?  */
 682 #define PIXEL_TO_CHAR_WIDTH(f, width) \
 683   (PIXEL_TO_CHAR_COL (f, ((width) \
 684                           - (f)->output_data.w32->internal_border_width \
 685                           - (f)->output_data.w32->fringes_extra \
 686                           - (f)->output_data.w32->vertical_scroll_bar_extra)))
 687 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
 688   (PIXEL_TO_CHAR_ROW (f, ((height) \
 689                           - (f)->output_data.w32->internal_border_width)))
 690
 691 \f
 692 extern void w32_fill_rect ();
 693 extern void w32_clear_window ();
 694
 695 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
 696 { \
 697     RECT rect; \
 698     rect.left = x; \
 699     rect.top = y; \
 700     rect.right = x + nx; \
 701     rect.bottom = y + ny; \
 702     w32_fill_rect (f,hdc,pix,&rect); \
 703 }
 704
 705 #define w32_clear_rect(f,hdc,lprect) \
 706 w32_fill_rect (f,hdc,f->output_data.x->background_pixel,lprect)
 707
 708 #define w32_clear_area(f,hdc,px,py,nx,ny) \
 709 w32_fill_area (f,hdc,f->output_data.x->background_pixel,px,py,nx,ny)
 710
 711 extern struct font_info *w32_load_font ();
 712 extern void w32_unload_font ();
 713
 714 extern void x_fullscreen_adjust P_ ((struct frame *f, int *, int *,
 715                                      int *, int *));
 716
 717 /* Define for earlier versions of Visual C */
 718 #ifndef WM_MOUSEWHEEL
 719 #define WM_MOUSEWHEEL                  (WM_MOUSELAST + 1)
 720 #endif /* WM_MOUSEWHEEL */
 721 #ifndef MSH_MOUSEWHEEL
 722 #define MSH_MOUSEWHEEL                 "MSWHEEL_ROLLMSG"
 723 #endif /* MSH_MOUSEWHEEL */
 724 #ifndef WM_XBUTTONDOWN
 725 #define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
 726 #define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
 727 #endif /* WM_XBUTTONDOWN */
 728
 729 #define WM_EMACS_START                 (WM_USER + 1)
 730 #define WM_EMACS_KILL                  (WM_EMACS_START + 0)
 731 #define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
 732 #define WM_EMACS_DONE                  (WM_EMACS_START + 2)
 733 #define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
 734 #define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
 735 #define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
 736 #define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
 737 #define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
 738 #define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
 739 #define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
 740 #define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
 741 #define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
 742 #define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
 743 #define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
 744 #define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
 745 #define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
 746 #define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
 747 #define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
 748 #define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
 749 #define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
 750 #define WM_EMACS_END                   (WM_EMACS_START + 20)
 751
 752 #define WND_FONTWIDTH_INDEX    (0)
 753 #define WND_LINEHEIGHT_INDEX   (4)
 754 #define WND_BORDER_INDEX       (8)
 755 #define WND_SCROLLBAR_INDEX    (12)
 756 #define WND_BACKGROUND_INDEX   (16)
 757 #define WND_LAST_INDEX         (20)
 758
 759 #define WND_EXTRA_BYTES     (WND_LAST_INDEX)
 760
 761 extern DWORD dwWindowsThreadId;
 762 extern HANDLE hWindowsThread;
 763 extern DWORD dwMainThreadId;
 764 extern HANDLE hMainThread;
 765
 766 typedef struct W32Msg {
 767     MSG msg;
 768     DWORD dwModifiers;
 769     RECT rect;
 770 } W32Msg;
 771
 772 /* Structure for recording message when input thread must return a
 773    result that depends on lisp thread to compute.  Lisp thread can
 774    complete deferred messages out of order.  */
 775 typedef struct deferred_msg
 776 {
 777   struct deferred_msg * next;
 778   W32Msg                w32msg;
 779   LRESULT               result;
 780   int                   completed;
 781 } deferred_msg;
 782
 783 extern CRITICAL_SECTION critsect;
 784
 785 extern void init_crit ();
 786 extern void delete_crit ();
 787
 788 extern void signal_quit ();
 789
 790 #define enter_crit() EnterCriticalSection (&critsect)
 791 #define leave_crit() LeaveCriticalSection (&critsect)
 792
 793 extern void select_palette (struct frame * f, HDC hdc);
 794 extern void deselect_palette (struct frame * f, HDC hdc);
 795 extern HDC get_frame_dc (struct frame * f);
 796 extern int release_frame_dc (struct frame * f, HDC hDC);
 797
 798 extern void drain_message_queue ();
 799
 800 extern BOOL get_next_msg ();
 801 extern BOOL post_msg ();
 802 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
 803 extern void wait_for_sync ();
 804
 805 extern BOOL parse_button ();
 806
 807 /* Keypad command key support.  W32 doesn't have virtual keys defined
 808    for the function keys on the keypad (they are mapped to the standard
 809    fuction keys), so we define our own.  */
 810 #define VK_NUMPAD_BEGIN         0x92
 811 #define VK_NUMPAD_CLEAR         (VK_NUMPAD_BEGIN + 0)
 812 #define VK_NUMPAD_ENTER         (VK_NUMPAD_BEGIN + 1)
 813 #define VK_NUMPAD_PRIOR         (VK_NUMPAD_BEGIN + 2)
 814 #define VK_NUMPAD_NEXT          (VK_NUMPAD_BEGIN + 3)
 815 #define VK_NUMPAD_END           (VK_NUMPAD_BEGIN + 4)
 816 #define VK_NUMPAD_HOME          (VK_NUMPAD_BEGIN + 5)
 817 #define VK_NUMPAD_LEFT          (VK_NUMPAD_BEGIN + 6)
 818 #define VK_NUMPAD_UP            (VK_NUMPAD_BEGIN + 7)
 819 #define VK_NUMPAD_RIGHT         (VK_NUMPAD_BEGIN + 8)
 820 #define VK_NUMPAD_DOWN          (VK_NUMPAD_BEGIN + 9)
 821 #define VK_NUMPAD_INSERT        (VK_NUMPAD_BEGIN + 10)
 822 #define VK_NUMPAD_DELETE        (VK_NUMPAD_BEGIN + 11)
 823
 824 #ifndef VK_LWIN
 825 /* Older compiler environments don't have these defined.  */
 826 #define VK_LWIN                 0x5B
 827 #define VK_RWIN                 0x5C
 828 #define VK_APPS                 0x5D
 829 #endif
 830
 831 /* Support for treating Windows and Apps keys as modifiers.  These
 832    constants must not overlap with any of the dwControlKeyState flags in
 833    KEY_EVENT_RECORD.  */
 834 #define LEFT_WIN_PRESSED       0x8000
 835 #define RIGHT_WIN_PRESSED      0x4000
 836 #define APPS_PRESSED           0x2000
 837
 838 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
 839    (even though they are supported on 98 and ME.  */
 840 #ifndef WM_MOUSELEAVE
 841 #define WM_MOUSELEAVE 0x02A3
 842 #define TME_LEAVE 0x00000002;
 843
 844 typedef struct tagTRACKMOUSEEVENT
 845 {
 846   DWORD cbSize;
 847   DWORD dwFlags;
 848   HWND hwndTrack;
 849   DWORD dwHoverTime;
 850 } TRACKMOUSEEVENT;
 851 #endif
 852
 853 struct image;
 854 struct face;
 855
 856 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
 857 struct frame * check_x_frame (Lisp_Object);
 858 EXFUN (Fx_display_color_p, 1);
 859 EXFUN (Fx_display_grayscale_p, 1);
 860 int image_ascent P_ ((struct image *, struct face *));
 861
 862 #define FONT_TYPE_FOR_UNIBYTE(font, ch)                 \
 863   ((font)->bdf ? BDF_1D_FONT : ANSI_FONT)
 864
 865 #define FONT_TYPE_FOR_MULTIBYTE(font, ch)               \
 866   (!(font)->bdf                                         \
 867    ? UNICODE_FONT                                       \
 868    : ((CHARSET_DIMENSION (CHAR_CHARSET ((ch))) == 1)    \
 869       ? BDF_1D_FONT : BDF_2D_FONT))