w32term.h 25.9 KB
Newer Older
1
/* Definitions and headers for communication on the Microsoft Windows API.
2
   Copyright (C) 1995, 2001-2012 Free Software Foundation, Inc.
Geoff Voelker's avatar
Geoff Voelker committed
3 4 5

This file is part of GNU Emacs.

6
GNU Emacs is free software: you can redistribute it and/or modify
Geoff Voelker's avatar
Geoff Voelker committed
7
it under the terms of the GNU General Public License as published by
8 9
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Geoff Voelker's avatar
Geoff Voelker committed
10 11 12 13 14 15 16

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Geoff Voelker's avatar
Geoff Voelker committed
18 19 20

/* Added by Kevin Gallo */

21
#include "w32gui.h"
Daniel Colascione's avatar
Daniel Colascione committed
22 23
#include "frame.h"
#include "atimer.h"
Geoff Voelker's avatar
Geoff Voelker committed
24 25


26 27
#define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
#define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
Geoff Voelker's avatar
Geoff Voelker committed
28

29 30 31 32
#define FONT_WIDTH(f)     ((f)->max_width)
#define FONT_HEIGHT(f)    ((f)->height)
#define FONT_BASE(f)      ((f)->ascent)
#define FONT_DESCENT(f)   ((f)->descent)
Geoff Voelker's avatar
Geoff Voelker committed
33

Jason Rumney's avatar
Jason Rumney committed
34 35
#define CP_DEFAULT 1004

36
#define CHECK_W32_FRAME(f, frame)		\
Geoff Voelker's avatar
Geoff Voelker committed
37
  if (NILP (frame))				\
38
    f = SELECTED_FRAME ();			\
Geoff Voelker's avatar
Geoff Voelker committed
39 40 41 42 43
  else						\
    {						\
      CHECK_LIVE_FRAME (frame, 0);		\
      f = XFRAME (frame);			\
    }						\
44
  if (! FRAME_W32_P (f))
Geoff Voelker's avatar
Geoff Voelker committed
45 46 47 48 49 50 51 52 53 54

/* Indicates whether we are in the readsocket call and the message we
   are processing in the current loop */

extern MSG CurMsg;
extern BOOL bUseDflt;

/* Structure recording bitmaps and reference count.
   If REFCOUNT is 0 then this record is free to be reused.  */

55
struct w32_bitmap_record
Geoff Voelker's avatar
Geoff Voelker committed
56 57 58 59 60 61 62 63
{
  Pixmap pixmap;
  char *file;
  HINSTANCE hinst; /* Used to load the file */
  int refcount;
  /* Record some info about this pixmap.  */
  int height, width, depth;
};
64

65 66
struct w32_palette_entry {
  struct w32_palette_entry * next;
67 68 69 70 71 72
  PALETTEENTRY entry;
#if 0
  unsigned refcount;
#endif
};

Juanma Barranquero's avatar
Juanma Barranquero committed
73
extern void w32_regenerate_palette (struct frame *f);
74

Geoff Voelker's avatar
Geoff Voelker committed
75

76
/* For each display (currently only one on w32), we have a structure that
Geoff Voelker's avatar
Geoff Voelker committed
77 78
   records information about it.  */

79
struct w32_display_info
Geoff Voelker's avatar
Geoff Voelker committed
80
{
81 82
  /* Chain of all w32_display_info structures.  */
  struct w32_display_info *next;
83

84 85 86
  /* The generic display parameters corresponding to this w32 display.  */
  struct terminal *terminal;

Geoff Voelker's avatar
Geoff Voelker committed
87 88 89
  /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
     The same cons cell also appears in x_display_name_list.  */
  Lisp_Object name_list_element;
90

Geoff Voelker's avatar
Geoff Voelker committed
91 92
  /* Number of frames that are on this display.  */
  int reference_count;
93 94 95 96

  /* Dots per inch of the screen.  */
  double resx, resy;

Geoff Voelker's avatar
Geoff Voelker committed
97 98
  /* Number of planes on this screen.  */
  int n_planes;
99

Geoff Voelker's avatar
Geoff Voelker committed
100 101
  /* Number of bits per pixel on this screen.  */
  int n_cbits;
102

Geoff Voelker's avatar
Geoff Voelker committed
103 104
  /* Mask of things that cause the mouse to be grabbed.  */
  int grabbed;
105 106 107

  /* Emacs bitmap-id of the default icon bitmap for this frame.
     Or -1 if none has been allocated yet.  */
108
  ptrdiff_t icon_bitmap_id;
109

Geoff Voelker's avatar
Geoff Voelker committed
110 111
  /* The root window of this screen.  */
  Window root_window;
112

Geoff Voelker's avatar
Geoff Voelker committed
113 114 115
  /* The cursor to use for vertical scroll bars.  */
  Cursor vertical_scroll_bar_cursor;

116
  /* Resource data base */
117
  XrmDatabase xrdb;
118

119
  /* color palette information.  */
120
  int has_palette;
121
  struct w32_palette_entry * color_list;
122 123 124
  unsigned num_colors;
  HPALETTE palette;

125
  /* deferred action flags checked when starting frame update.  */
126 127
  int regen_palette;

128 129 130 131
  /* Keystroke that has been faked by Emacs and will be ignored when
     received; value is reset after key is received.  */
  int faked_key;

132 133 134 135 136 137 138 139 140
  /* Minimum width over all characters in all fonts in font_table.  */
  int smallest_char_width;

  /* Minimum font height over all fonts in font_table.  */
  int smallest_font_height;

  /* Reusable Graphics Context for drawing a cursor in a non-default face. */
  XGCValues *scratch_cursor_gc;

141 142 143
  /* Information about the range of text currently shown in
     mouse-face.  */
  Mouse_HLInfo mouse_highlight;
144

145
  char *w32_id_name;
Geoff Voelker's avatar
Geoff Voelker committed
146

147
  /* The number of fonts actually stored in w32_font_table.
Glenn Morris's avatar
Glenn Morris committed
148
     font_table[n] is used and valid if 0 <= n < n_fonts. 0 <=
149
     n_fonts <= font_table_size. and font_table[i].name != 0. */
Geoff Voelker's avatar
Geoff Voelker committed
150 151 152
  int n_fonts;

  /* Pointer to bitmap records.  */
153
  struct w32_bitmap_record *bitmaps;
Geoff Voelker's avatar
Geoff Voelker committed
154 155

  /* Allocated size of bitmaps field.  */
156
  ptrdiff_t bitmaps_size;
Geoff Voelker's avatar
Geoff Voelker committed
157 158

  /* Last used bitmap index.  */
159
  ptrdiff_t bitmaps_last;
Geoff Voelker's avatar
Geoff Voelker committed
160 161 162 163 164

  /* The frame (if any) which has the window that has keyboard focus.
     Zero if none.  This is examined by Ffocus_frame in w32fns.c.  Note
     that a mere EnterNotify event can set this; if you need to know the
     last frame specified in a FocusIn or FocusOut event, use
165 166
     w32_focus_event_frame.  */
  struct frame *w32_focus_frame;
Geoff Voelker's avatar
Geoff Voelker committed
167 168

  /* The last frame mentioned in a FocusIn or FocusOut event.  This is
169
     separate from w32_focus_frame, because whether or not LeaveNotify
Geoff Voelker's avatar
Geoff Voelker committed
170 171
     events cause us to lose focus depends on whether or not we have
     received a FocusIn event for it.  */
172
  struct frame *w32_focus_event_frame;
Geoff Voelker's avatar
Geoff Voelker committed
173 174 175 176

  /* The frame which currently has the visual highlight, and should get
     keyboard input (other sorts of input have the frame encoded in the
     event).  It points to the focus frame's selected window's
177
     frame.  It differs from w32_focus_frame when we're using a global
Geoff Voelker's avatar
Geoff Voelker committed
178
     minibuffer.  */
179
  struct frame *x_highlight_frame;
Geoff Voelker's avatar
Geoff Voelker committed
180 181 182
};

/* This is a chain of structures for all the displays currently in use.  */
Andrew Innes's avatar
Andrew Innes committed
183
extern struct w32_display_info *x_display_list;
184
extern struct w32_display_info one_w32_display_info;
Geoff Voelker's avatar
Geoff Voelker committed
185 186

/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
187
   one for each element of w32_display_list and in the same order.
Geoff Voelker's avatar
Geoff Voelker committed
188 189
   NAME is the name of the frame.
   FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
190
extern Lisp_Object w32_display_name_list;
Geoff Voelker's avatar
Geoff Voelker committed
191

192 193 194
extern struct frame *x_window_to_frame (struct w32_display_info *, HWND);

struct w32_display_info *x_display_info_for_name (Lisp_Object);
Geoff Voelker's avatar
Geoff Voelker committed
195

Jan D's avatar
Jan D committed
196 197 198
Lisp_Object display_x_get_resource (struct w32_display_info *,
                                    Lisp_Object, Lisp_Object,
                                    Lisp_Object, Lisp_Object);
199

Daniel Colascione's avatar
Daniel Colascione committed
200 201 202 203
extern void x_focus_on_frame (struct frame *f);

/* also defined in xterm.h XXX: factor out to common header */

204 205
extern struct w32_display_info *w32_term_init (Lisp_Object,
					       char *, char *);
Daniel Colascione's avatar
Daniel Colascione committed
206
extern void check_w32 (void);
Daniel Colascione's avatar
Daniel Colascione committed
207
extern int w32_defined_color (FRAME_PTR f, const char *color,
Daniel Colascione's avatar
Daniel Colascione committed
208 209 210
                              XColor *color_def, int alloc);
extern void x_set_window_size (struct frame *f, int change_grav,
                              int cols, int rows);
Jan D's avatar
Jan D committed
211 212
extern int x_display_pixel_height (struct w32_display_info *);
extern int x_display_pixel_width (struct w32_display_info *);
Daniel Colascione's avatar
Daniel Colascione committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
extern void x_sync (struct frame *);
extern Lisp_Object x_get_focus_frame (struct frame *);
extern void x_set_mouse_position (struct frame *f, int h, int v);
extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
extern void x_make_frame_visible (struct frame *f);
extern void x_make_frame_invisible (struct frame *f);
extern void x_iconify_frame (struct frame *f);
extern int x_char_width (struct frame *f);
extern int x_char_height (struct frame *f);
extern int x_pixel_width (struct frame *f);
extern int x_pixel_height (struct frame *f);
extern void x_set_frame_alpha (struct frame *f);
extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
extern void x_set_tool_bar_lines (struct frame *f,
                                  Lisp_Object value,
                                  Lisp_Object oldval);
extern void x_activate_menubar (struct frame *);
extern int x_bitmap_icon (struct frame *, Lisp_Object);
extern void initialize_frame_menubar (struct frame *);
extern void x_free_frame_resources (struct frame *);
extern void x_real_positions (struct frame *, int *, int *);

/* w32inevt.c */
extern int w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId);
extern int w32_kbd_mods_to_emacs (DWORD mods, WORD key);

239

Fabrice Popineau's avatar
Fabrice Popineau committed
240 241
extern Lisp_Object x_get_focus_frame (struct frame *);

Geoff Voelker's avatar
Geoff Voelker committed
242

243 244
#define PIX_TYPE COLORREF

245 246 247
/* Each W32 frame object points to its own struct w32_display object
   in the output_data.w32 field.  The w32_display structure contains all
   the information that is specific to W32 windows.  */
Geoff Voelker's avatar
Geoff Voelker committed
248

249
/* Put some things in x_output for compatibility.
Paul Eggert's avatar
Paul Eggert committed
250
   NTEMACS_TODO: Move all common things here to eliminate unnecessary
251 252 253
   diffs between X and w32 code.  */
struct x_output
{
254
#if 0 /* These are also defined in struct frame.  Use that instead.  */
255 256
  PIX_TYPE background_pixel;
  PIX_TYPE foreground_pixel;
257
#endif
Jason Rumney's avatar
Jason Rumney committed
258 259 260 261 262 263

  /* Keep track of focus.  May be EXPLICIT if we received a FocusIn for this
     frame, or IMPLICIT if we received an EnterNotify.
     FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
  int focus_state;

264 265
};

Jason Rumney's avatar
Jason Rumney committed
266 267 268 269
enum
{
  /* Values for focus_state, used as bit mask.
     EXPLICIT means we received a FocusIn for the frame and know it has
Paul Eggert's avatar
Paul Eggert committed
270
     the focus.  IMPLICIT means we received an EnterNotify and the frame
Jason Rumney's avatar
Jason Rumney committed
271 272 273 274 275 276
     may have the focus if no window manager is running.
     FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
  FOCUS_NONE     = 0,
  FOCUS_IMPLICIT = 1,
  FOCUS_EXPLICIT = 2
};
277

278
struct w32_output
Geoff Voelker's avatar
Geoff Voelker committed
279
{
280
  /* Placeholder for things accessed through output_data.x.  */
281
  struct x_output x_compatible;
282

283 284 285
  /* Menubar "widget" handle.  */
  HMENU menubar_widget;

286 287 288
  /* Original palette (used to deselect real palette after drawing) */
  HPALETTE old_palette;

289 290 291
  /* Here are the Graphics Contexts for the default font.  */
  XGCValues *cursor_gc;				/* cursor drawing */

Geoff Voelker's avatar
Geoff Voelker committed
292 293 294 295 296 297 298 299 300 301 302
  /* The window used for this frame.
     May be zero while the frame object is being created
     and the window has not yet been created.  */
  Window window_desc;

  /* The window that is the parent of this window.
     Usually this is a window that was made by the window manager,
     but it can be the root window, and it can be explicitly specified
     (see the explicit_parent field, below).  */
  Window parent_desc;

303
  /* Default ASCII font of this frame. */
304
  struct font *font;
305

306 307
  /* The baseline offset of the default ASCII font.  */
  int baseline_offset;
308 309 310 311 312

  /* If a fontset is specified for this frame instead of font, this
     value contains an ID of the fontset, else -1.  */
  int fontset;

Geoff Voelker's avatar
Geoff Voelker committed
313 314
  /* Pixel values used for various purposes.
     border_pixel may be -1 meaning use a gray tile.  */
315 316 317 318 319 320 321 322
  COLORREF cursor_pixel;
  COLORREF border_pixel;
  COLORREF mouse_pixel;
  COLORREF cursor_foreground_pixel;

  /* Foreground color for scroll bars.  A value of -1 means use the
     default (black for non-toolkit scroll bars).  */
  COLORREF scroll_bar_foreground_pixel;
323

324 325 326 327
  /* Background color for scroll bars.  A value of -1 means use the
     default (background color of the frame for non-toolkit scroll
     bars).  */
  COLORREF scroll_bar_background_pixel;
Geoff Voelker's avatar
Geoff Voelker committed
328 329 330 331 332

  /* Descriptor for the cursor in use for this window.  */
  Cursor text_cursor;
  Cursor nontext_cursor;
  Cursor modeline_cursor;
333
  Cursor hand_cursor;
334
  Cursor hourglass_cursor;
335
  Cursor horizontal_drag_cursor;
336

337 338
  /* Non-zero means hourglass cursor is currently displayed.  */
  unsigned hourglass_p : 1;
Geoff Voelker's avatar
Geoff Voelker committed
339

340 341 342
  /* Non-hourglass cursor that is currently active.  */
  Cursor current_cursor;

Geoff Voelker's avatar
Geoff Voelker committed
343 344 345
  DWORD dwStyle;

  /* This is the Emacs structure for the display this frame is on.  */
346
  /* struct w32_display_info *display_info; */
Geoff Voelker's avatar
Geoff Voelker committed
347 348 349 350 351 352 353

  /* Nonzero means our parent is another application's window
     and was explicitly specified.  */
  char explicit_parent;

  /* Nonzero means tried already to make this frame visible.  */
  char asked_for_visible;
354 355 356 357 358 359 360

  /* Nonzero means menubar is currently active.  */
  char menubar_active;

  /* Nonzero means menubar is about to become active, but should be
     brought up to date first.  */
  volatile char pending_menu_activation;
361 362 363 364 365 366 367 368 369 370 371 372 373

  /* Relief GCs, colors etc.  */
  struct relief
  {
    XGCValues *gc;
    unsigned long pixel;
    int allocated_p;
  }
  black_relief, white_relief;

  /* The background for which the above relief GCs were set up.
     They are changed only when a different background is involved.  */
  unsigned long relief_background;
Geoff Voelker's avatar
Geoff Voelker committed
374 375
};

376 377
extern struct w32_output w32term_display;

378 379 380
/* Return the X output data for frame F.  */
#define FRAME_X_OUTPUT(f) ((f)->output_data.w32)

Geoff Voelker's avatar
Geoff Voelker committed
381
/* Return the window associated with the frame F.  */
382
#define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
383
#define FRAME_X_WINDOW(f) FRAME_W32_WINDOW (f)
Geoff Voelker's avatar
Geoff Voelker committed
384

385
#define FRAME_FONT(f) ((f)->output_data.w32->font)
386
#define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
387
#define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
Geoff Voelker's avatar
Geoff Voelker committed
388

389 390
/* This gives the w32_display_info structure for the display F is on.  */
#define FRAME_W32_DISPLAY_INFO(f) (&one_w32_display_info)
391
#define FRAME_X_DISPLAY_INFO(f) (&one_w32_display_info)
Geoff Voelker's avatar
Geoff Voelker committed
392

393 394 395
/* This is the `Display *' which frame F is on.  */
#define FRAME_X_DISPLAY(f) (0)

396 397 398 399 400 401 402 403 404
/* Value is the smallest width of any character in any font on frame F.  */

#define FRAME_SMALLEST_CHAR_WIDTH(F) \
     FRAME_W32_DISPLAY_INFO(F)->smallest_char_width

/* Value is the smallest height of any font on frame F.  */

#define FRAME_SMALLEST_FONT_HEIGHT(F) \
     FRAME_W32_DISPLAY_INFO(F)->smallest_font_height
Geoff Voelker's avatar
Geoff Voelker committed
405

406
/* W32-specific scroll bar stuff.  */
Geoff Voelker's avatar
Geoff Voelker committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429

/* We represent scroll bars as lisp vectors.  This allows us to place
   references to them in windows without worrying about whether we'll
   end up with windows referring to dead scroll bars; the garbage
   collector will free it when its time comes.

   We use struct scroll_bar as a template for accessing fields of the
   vector.  */

struct scroll_bar {

  /* These fields are shared by all vectors.  */
  EMACS_INT size_from_Lisp_Vector_struct;
  struct Lisp_Vector *next_from_Lisp_Vector_struct;

  /* The window we're a scroll bar for.  */
  Lisp_Object window;

  /* The next and previous in the chain of scroll bars in this frame.  */
  Lisp_Object next, prev;

  /* The window representing this scroll bar.  Since this is a full
     32-bit quantity, we store it split into two 32-bit values.  */
430
  Lisp_Object w32_window_low, w32_window_high;
Geoff Voelker's avatar
Geoff Voelker committed
431

432 433 434
  /* Same as above for the widget.  */
  Lisp_Object w32_widget_low, w32_widget_high;

Geoff Voelker's avatar
Geoff Voelker committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
  /* The position and size of the scroll bar in pixels, relative to the
     frame.  */
  Lisp_Object top, left, width, height;

  /* The starting and ending positions of the handle, relative to the
     handle area (i.e. zero is the top position, not
     SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
     hasn't been drawn yet.

     These are not actually the locations where the beginning and end
     are drawn; in order to keep handles from becoming invisible when
     editing large files, we establish a minimum height by always
     drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
     where they would be normally; the bottom and top are in a
     different co-ordinate system.  */
  Lisp_Object start, end;

  /* If the scroll bar handle is currently being dragged by the user,
     this is the number of pixels from the top of the handle to the
     place where the user grabbed it.  If the handle isn't currently
     being dragged, this is Qnil.  */
  Lisp_Object dragging;
457 458 459 460

  /* t if the background of the fringe that is adjacent to a scroll
     bar is extended to the gap between the fringe and the bar.  */
  Lisp_Object fringe_extended_p;
Geoff Voelker's avatar
Geoff Voelker committed
461 462 463 464 465 466
};

/* The number of elements a vector holding a struct scroll_bar needs.  */
#define SCROLL_BAR_VEC_SIZE					\
  ((sizeof (struct scroll_bar)					\
    - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))	\
467
   / word_size)
Geoff Voelker's avatar
Geoff Voelker committed
468 469 470 471

/* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
#define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))

472 473 474
#ifdef _WIN64
/* Building a 64-bit C integer from two 32-bit lisp integers.  */
#define SCROLL_BAR_PACK(low, high) (XINT (high) << 32 | XINT (low))
Geoff Voelker's avatar
Geoff Voelker committed
475

476 477 478 479 480
/* Setting two lisp integers to the low and high words of a 64-bit C int.  */
#define SCROLL_BAR_UNPACK(low, high, int64) \
  (XSETINT ((low),   ((DWORDLONG)(int64))        & 0xffffffff), \
   XSETINT ((high), ((DWORDLONG)(int64) >> 32) & 0xffffffff))
#else  /* not _WIN64 */
Geoff Voelker's avatar
Geoff Voelker committed
481 482 483 484 485 486 487
/* Building a 32-bit C integer from two 16-bit lisp integers.  */
#define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))

/* Setting two lisp integers to the low and high words of a 32-bit C int.  */
#define SCROLL_BAR_UNPACK(low, high, int32) \
  (XSETINT ((low),   (int32)        & 0xffff), \
   XSETINT ((high), ((int32) >> 16) & 0xffff))
488
#endif	/* not _WIN64 */
Geoff Voelker's avatar
Geoff Voelker committed
489 490

/* Extract the window id of the scroll bar from a struct scroll_bar.  */
491 492
#define SCROLL_BAR_W32_WINDOW(ptr) \
  ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
Geoff Voelker's avatar
Geoff Voelker committed
493 494

/* Store a window id in a struct scroll_bar.  */
495
#define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
496
  (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (intptr_t) id))
Geoff Voelker's avatar
Geoff Voelker committed
497

498 499 500
/* Extract the X widget of the scroll bar from a struct scroll_bar.  */
#define SCROLL_BAR_X_WIDGET(ptr) \
  ((Widget) SCROLL_BAR_PACK ((ptr)->x_widget_low, (ptr)->x_widget_high))
Geoff Voelker's avatar
Geoff Voelker committed
501

502 503 504
/* Store a widget id in a struct scroll_bar.  */
#define SET_SCROLL_BAR_X_WIDGET(ptr, w) \
  (SCROLL_BAR_UNPACK ((ptr)->x_widget_low, (ptr)->x_widget_high, (int) w))
Geoff Voelker's avatar
Geoff Voelker committed
505 506 507

/* Return the inside width of a vertical scroll bar, given the outside
   width.  */
508 509 510 511 512
#define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
  ((width) \
   - VERTICAL_SCROLL_BAR_LEFT_BORDER \
   - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
   - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
Geoff Voelker's avatar
Geoff Voelker committed
513 514 515

/* Return the length of the rectangle within which the top of the
   handle must stay.  This isn't equivalent to the inside height,
516
   because the scroll bar handle has a minimum height.
Geoff Voelker's avatar
Geoff Voelker committed
517 518 519 520

   This is the real range of motion for the scroll bar, so when we're
   scaling buffer positions to scroll bar positions, we use this, not
   VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
521 522
#define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
  (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
Geoff Voelker's avatar
Geoff Voelker committed
523 524 525

/* Return the inside height of vertical scroll bar, given the outside
   height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
526
#define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
Geoff Voelker's avatar
Geoff Voelker committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
  ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)


/* Border widths for scroll bars.

   Scroll bar windows don't have any borders; their border width is
   set to zero, and we redraw borders ourselves.  This makes the code
   a bit cleaner, since we don't have to convert between outside width
   (used when relating to the rest of the screen) and inside width
   (used when sizing and drawing the scroll bar window itself).

   The handle moves up and down/back and forth in a rectangle inset
   from the edges of the scroll bar.  These are widths by which we
   inset the handle boundaries from the scroll bar edges.  */
#define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
#define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
543 544
#define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
#define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
Geoff Voelker's avatar
Geoff Voelker committed
545 546

/* Minimum lengths for scroll bar handles, in pixels.  */
547 548
#define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)

549 550 551
/* Trimming off a few pixels from each side prevents
   text from glomming up against the scroll bar */
#define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
Geoff Voelker's avatar
Geoff Voelker committed
552

553

554 555 556 557
struct frame;  /* from frame.h */

extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
extern void w32_clear_window (struct frame *);
Geoff Voelker's avatar
Geoff Voelker committed
558

559
#define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
560
do { \
Geoff Voelker's avatar
Geoff Voelker committed
561 562 563 564 565
    RECT rect; \
    rect.left = x; \
    rect.top = y; \
    rect.right = x + nx; \
    rect.bottom = y + ny; \
566
    w32_fill_rect (f,hdc,pix,&rect); \
567
} while (0)
Geoff Voelker's avatar
Geoff Voelker committed
568

569
#define w32_clear_rect(f,hdc,lprect) \
570
  w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
Geoff Voelker's avatar
Geoff Voelker committed
571

572
#define w32_clear_area(f,hdc,px,py,nx,ny) \
573
  w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
Geoff Voelker's avatar
Geoff Voelker committed
574

575 576
/* Define for earlier versions of Visual C */
#ifndef WM_MOUSEWHEEL
577
#define WM_MOUSEWHEEL 		       (WM_MOUSELAST + 1)
578
#endif /* WM_MOUSEWHEEL */
579 580 581
#ifndef MSH_MOUSEWHEEL
#define MSH_MOUSEWHEEL		       "MSWHEEL_ROLLMSG"
#endif /* MSH_MOUSEWHEEL */
582 583 584 585
#ifndef WM_XBUTTONDOWN
#define WM_XBUTTONDOWN                 (WM_MOUSEWHEEL + 1)
#define WM_XBUTTONUP                   (WM_MOUSEWHEEL + 2)
#endif /* WM_XBUTTONDOWN */
586 587 588
#ifndef WM_MOUSEHWHEEL
#define WM_MOUSEHWHEEL                 (WM_MOUSEWHEEL + 4)
#endif /* WM_MOUSEHWHEEL  */
589 590 591 592
#ifndef WM_APPCOMMAND
#define WM_APPCOMMAND 0x319
#define GET_APPCOMMAND_LPARAM(lParam)  (HIWORD(lParam) & 0x7fff)
#endif
593
#ifndef WM_UNICHAR
594 595 596 597 598
#define WM_UNICHAR 0x109
#endif
#ifndef UNICODE_NOCHAR
#define UNICODE_NOCHAR 0xFFFF
#endif
599

Geoff Voelker's avatar
Geoff Voelker committed
600
#define WM_EMACS_START                 (WM_USER + 1)
601 602 603 604 605 606 607 608 609 610 611 612 613 614
#define WM_EMACS_KILL                  (WM_EMACS_START + 0)
#define WM_EMACS_CREATEWINDOW          (WM_EMACS_START + 1)
#define WM_EMACS_DONE                  (WM_EMACS_START + 2)
#define WM_EMACS_CREATESCROLLBAR       (WM_EMACS_START + 3)
#define WM_EMACS_SHOWWINDOW            (WM_EMACS_START + 4)
#define WM_EMACS_SETWINDOWPOS          (WM_EMACS_START + 5)
#define WM_EMACS_DESTROYWINDOW         (WM_EMACS_START + 6)
#define WM_EMACS_TRACKPOPUPMENU        (WM_EMACS_START + 7)
#define WM_EMACS_SETFOCUS              (WM_EMACS_START + 8)
#define WM_EMACS_SETFOREGROUND         (WM_EMACS_START + 9)
#define WM_EMACS_SETLOCALE             (WM_EMACS_START + 10)
#define WM_EMACS_SETKEYBOARDLAYOUT     (WM_EMACS_START + 11)
#define WM_EMACS_REGISTER_HOT_KEY      (WM_EMACS_START + 12)
#define WM_EMACS_UNREGISTER_HOT_KEY    (WM_EMACS_START + 13)
615
#define WM_EMACS_TOGGLE_LOCK_KEY       (WM_EMACS_START + 14)
616 617
#define WM_EMACS_TRACK_CARET           (WM_EMACS_START + 15)
#define WM_EMACS_DESTROY_CARET         (WM_EMACS_START + 16)
618 619
#define WM_EMACS_SHOW_CARET            (WM_EMACS_START + 17)
#define WM_EMACS_HIDE_CARET            (WM_EMACS_START + 18)
620
#define WM_EMACS_SETCURSOR             (WM_EMACS_START + 19)
621
#define WM_EMACS_PAINT                 (WM_EMACS_START + 20)
Daniel Colascione's avatar
Daniel Colascione committed
622 623 624
#define WM_EMACS_BRINGTOTOP            (WM_EMACS_START + 21)
#define WM_EMACS_INPUT_READY           (WM_EMACS_START + 22)
#define WM_EMACS_END                   (WM_EMACS_START + 23)
Geoff Voelker's avatar
Geoff Voelker committed
625

626 627 628 629 630
#define WND_FONTWIDTH_INDEX    (0)
#define WND_LINEHEIGHT_INDEX   (4)
#define WND_BORDER_INDEX       (8)
#define WND_SCROLLBAR_INDEX    (12)
#define WND_BACKGROUND_INDEX   (16)
631
#define WND_LAST_INDEX         (20)
Geoff Voelker's avatar
Geoff Voelker committed
632 633 634

#define WND_EXTRA_BYTES     (WND_LAST_INDEX)

635 636
extern DWORD dwWindowsThreadId;
extern HANDLE hWindowsThread;
Geoff Voelker's avatar
Geoff Voelker committed
637 638 639
extern DWORD dwMainThreadId;
extern HANDLE hMainThread;

640
typedef struct W32Msg {
Geoff Voelker's avatar
Geoff Voelker committed
641 642 643
    MSG msg;
    DWORD dwModifiers;
    RECT rect;
644
} W32Msg;
Geoff Voelker's avatar
Geoff Voelker committed
645

Daniel Colascione's avatar
Daniel Colascione committed
646 647
extern BOOL prepend_msg (W32Msg *lpmsg);

648 649 650 651 652 653 654 655 656 657 658
/* Structure for recording message when input thread must return a
   result that depends on lisp thread to compute.  Lisp thread can
   complete deferred messages out of order.  */
typedef struct deferred_msg
{
  struct deferred_msg * next;
  W32Msg                w32msg;
  LRESULT               result;
  int                   completed;
} deferred_msg;

659 660
extern CRITICAL_SECTION critsect;

661 662
extern void init_crit (void);
extern void delete_crit (void);
Geoff Voelker's avatar
Geoff Voelker committed
663

664
extern void signal_quit (void);
665

666 667 668 669 670 671 672 673
#define enter_crit() EnterCriticalSection (&critsect)
#define leave_crit() LeaveCriticalSection (&critsect)

extern void select_palette (struct frame * f, HDC hdc);
extern void deselect_palette (struct frame * f, HDC hdc);
extern HDC get_frame_dc (struct frame * f);
extern int release_frame_dc (struct frame * f, HDC hDC);

674
extern void drain_message_queue (void);
675

676 677
extern BOOL get_next_msg (W32Msg *, BOOL);
extern BOOL post_msg (W32Msg *);
678
extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
Geoff Voelker's avatar
Geoff Voelker committed
679

680
extern BOOL parse_button (int, int, int *, int *);
681

682 683
extern void w32_sys_ring_bell (struct frame *f);
extern void x_delete_display (struct w32_display_info *dpyinfo);
684 685 686
extern void w32_initialize_display_info (Lisp_Object);
extern void initialize_w32_display (struct terminal *);

687

688
/* Keypad command key support.  W32 doesn't have virtual keys defined
689
   for the function keys on the keypad (they are mapped to the standard
Paul Eggert's avatar
Paul Eggert committed
690
   function keys), so we define our own.  */
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
#define VK_NUMPAD_BEGIN		0x92
#define VK_NUMPAD_CLEAR		(VK_NUMPAD_BEGIN + 0)
#define VK_NUMPAD_ENTER		(VK_NUMPAD_BEGIN + 1)
#define VK_NUMPAD_PRIOR		(VK_NUMPAD_BEGIN + 2)
#define VK_NUMPAD_NEXT		(VK_NUMPAD_BEGIN + 3)
#define VK_NUMPAD_END		(VK_NUMPAD_BEGIN + 4)
#define VK_NUMPAD_HOME		(VK_NUMPAD_BEGIN + 5)
#define VK_NUMPAD_LEFT		(VK_NUMPAD_BEGIN + 6)
#define VK_NUMPAD_UP		(VK_NUMPAD_BEGIN + 7)
#define VK_NUMPAD_RIGHT		(VK_NUMPAD_BEGIN + 8)
#define VK_NUMPAD_DOWN		(VK_NUMPAD_BEGIN + 9)
#define VK_NUMPAD_INSERT	(VK_NUMPAD_BEGIN + 10)
#define VK_NUMPAD_DELETE	(VK_NUMPAD_BEGIN + 11)

#ifndef VK_LWIN
/* Older compiler environments don't have these defined.  */
#define VK_LWIN			0x5B
#define VK_RWIN			0x5C
#define VK_APPS			0x5D
#endif
711 712 713 714 715 716 717

/* Support for treating Windows and Apps keys as modifiers.  These
   constants must not overlap with any of the dwControlKeyState flags in
   KEY_EVENT_RECORD.  */
#define LEFT_WIN_PRESSED       0x8000
#define RIGHT_WIN_PRESSED      0x4000
#define APPS_PRESSED           0x2000
718

719 720 721
/* The current ANSI input codepage for GUI sessions.  */
extern int w32_keyboard_codepage;

722 723 724 725 726 727
/* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
   (even though they are supported on 98 and ME.  */
#ifndef WM_MOUSELEAVE
#define WM_MOUSELEAVE 0x02A3
#define TME_LEAVE 0x00000002;

728
typedef struct tagTRACKMOUSEEVENT
729 730 731 732 733 734 735 736
{
  DWORD cbSize;
  DWORD dwFlags;
  HWND hwndTrack;
  DWORD dwHoverTime;
} TRACKMOUSEEVENT;
#endif

737 738 739
struct image;
struct face;

740 741
XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
struct frame * check_x_frame (Lisp_Object);
742

743
typedef DWORD (WINAPI * ClipboardSequence_Proc) (void);
744 745 746 747 748
typedef BOOL (WINAPI * AppendMenuW_Proc) (
    IN HMENU,
    IN UINT,
    IN UINT_PTR,
    IN LPCWSTR);
Kenichi Handa's avatar
Kenichi Handa committed
749

750 751 752 753
extern HWND w32_system_caret_hwnd;
extern int w32_system_caret_height;
extern int w32_system_caret_x;
extern int w32_system_caret_y;
Daniel Colascione's avatar
Daniel Colascione committed
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769

#if EMACSDEBUG
extern const char*
w32_name_of_message (UINT msg);
#endif /* EMACSDEBUG */

extern void syms_of_w32term (void);
extern void syms_of_w32menu (void);
extern void syms_of_w32fns (void);

extern void globals_of_w32menu (void);
extern void globals_of_w32fns (void);

#ifdef CYGWIN
extern int w32_message_fd;
#endif /* CYGWIN */