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