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