* doc/misc/info.texi (Help-Xref): Add submenu.
[emacs.git] / src / w32term.h
blobe3b65f0ffaf75d98eef50a6c3878a072759819b9
1 /* Definitions and headers for communication on the Microsoft Windows API.
2 Copyright (C) 1995, 2001-2014 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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 3 of the License, or
9 (at your option) any later version.
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.
16 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/>. */
19 /* Added by Kevin Gallo */
21 #include "w32gui.h"
22 #include "frame.h"
23 #include "atimer.h"
26 #define BLACK_PIX_DEFAULT(f) PALETTERGB(0,0,0)
27 #define WHITE_PIX_DEFAULT(f) PALETTERGB(255,255,255)
29 #define CP_DEFAULT 1004
31 /* Indicates whether we are in the readsocket call and the message we
32 are processing in the current loop */
34 extern MSG CurMsg;
35 extern BOOL bUseDflt;
37 /* Structure recording bitmaps and reference count.
38 If REFCOUNT is 0 then this record is free to be reused. */
40 struct w32_bitmap_record
42 Pixmap pixmap;
43 char *file;
44 HINSTANCE hinst; /* Used to load the file */
45 int refcount;
46 /* Record some info about this pixmap. */
47 int height, width, depth;
50 struct w32_palette_entry {
51 struct w32_palette_entry * next;
52 PALETTEENTRY entry;
53 #if 0
54 unsigned refcount;
55 #endif
58 extern void w32_regenerate_palette (struct frame *f);
59 extern void w32_fullscreen_rect (HWND hwnd, int fsmode, RECT normal,
60 RECT *rect);
63 /* For each display (currently only one on w32), we have a structure that
64 records information about it. */
66 struct w32_display_info
68 /* Chain of all w32_display_info structures. */
69 struct w32_display_info *next;
71 /* The generic display parameters corresponding to this w32 display. */
72 struct terminal *terminal;
74 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE). */
75 Lisp_Object name_list_element;
77 /* Number of frames that are on this display. */
78 int reference_count;
80 /* Dots per inch of the screen. */
81 double resx, resy;
83 /* Number of planes on this screen. */
84 int n_planes;
86 /* Number of bits per pixel on this screen. */
87 int n_cbits;
89 /* Mask of things that cause the mouse to be grabbed. */
90 int grabbed;
92 /* Emacs bitmap-id of the default icon bitmap for this frame.
93 Or -1 if none has been allocated yet. */
94 ptrdiff_t icon_bitmap_id;
96 /* The root window of this screen. */
97 Window root_window;
99 /* The cursor to use for vertical scroll bars. */
100 Cursor vertical_scroll_bar_cursor;
102 /* Resource data base */
103 XrmDatabase xrdb;
105 /* color palette information. */
106 int has_palette;
107 struct w32_palette_entry * color_list;
108 unsigned num_colors;
109 HPALETTE palette;
111 /* deferred action flags checked when starting frame update. */
112 int regen_palette;
114 /* Keystroke that has been faked by Emacs and will be ignored when
115 received; value is reset after key is received. */
116 int faked_key;
118 /* Minimum width over all characters in all fonts in font_table. */
119 int smallest_char_width;
121 /* Minimum font height over all fonts in font_table. */
122 int smallest_font_height;
124 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
125 XGCValues *scratch_cursor_gc;
127 /* Information about the range of text currently shown in
128 mouse-face. */
129 Mouse_HLInfo mouse_highlight;
131 char *w32_id_name;
133 /* The number of fonts actually stored in w32_font_table.
134 font_table[n] is used and valid if 0 <= n < n_fonts. 0 <=
135 n_fonts <= font_table_size. and font_table[i].name != 0. */
136 int n_fonts;
138 /* Pointer to bitmap records. */
139 struct w32_bitmap_record *bitmaps;
141 /* Allocated size of bitmaps field. */
142 ptrdiff_t bitmaps_size;
144 /* Last used bitmap index. */
145 ptrdiff_t bitmaps_last;
147 /* The frame (if any) which has the window that has keyboard focus.
148 Zero if none. This is examined by Ffocus_frame in w32fns.c. Note
149 that a mere EnterNotify event can set this; if you need to know the
150 last frame specified in a FocusIn or FocusOut event, use
151 w32_focus_event_frame. */
152 struct frame *w32_focus_frame;
154 /* The last frame mentioned in a FocusIn or FocusOut event. This is
155 separate from w32_focus_frame, because whether or not LeaveNotify
156 events cause us to lose focus depends on whether or not we have
157 received a FocusIn event for it. */
158 struct frame *w32_focus_event_frame;
160 /* The frame which currently has the visual highlight, and should get
161 keyboard input (other sorts of input have the frame encoded in the
162 event). It points to the focus frame's selected window's
163 frame. It differs from w32_focus_frame when we're using a global
164 minibuffer. */
165 struct frame *x_highlight_frame;
167 /* The frame waiting to be auto-raised in w32_read_socket. */
168 struct frame *w32_pending_autoraise_frame;
170 /* The frame where the mouse was last time we reported a mouse event. */
171 struct frame *last_mouse_frame;
173 /* The frame where the mouse was last time we reported a mouse motion. */
174 struct frame *last_mouse_motion_frame;
176 /* The frame where the mouse was last time we reported a mouse position. */
177 struct frame *last_mouse_glyph_frame;
179 /* Position where the mouse was last time we reported a motion.
180 This is a position on last_mouse_motion_frame. */
181 int last_mouse_motion_x;
182 int last_mouse_motion_y;
184 /* Where the mouse was last time we reported a mouse position.
185 This is a rectangle on last_mouse_glyph_frame. */
186 RECT last_mouse_glyph;
188 /* The scroll bar in which the last motion event occurred. */
189 struct scroll_bar *last_mouse_scroll_bar;
191 /* Mouse position on the scroll bar above.
192 FIXME: shouldn't it be a member of struct scroll_bar? */
193 int last_mouse_scroll_bar_pos;
195 /* Time of last mouse movement. */
196 Time last_mouse_movement_time;
199 /* This is a chain of structures for all the displays currently in use. */
200 extern struct w32_display_info *x_display_list;
201 extern struct w32_display_info one_w32_display_info;
203 extern struct frame *x_window_to_frame (struct w32_display_info *, HWND);
205 struct w32_display_info *x_display_info_for_name (Lisp_Object);
207 Lisp_Object display_x_get_resource (struct w32_display_info *,
208 Lisp_Object, Lisp_Object,
209 Lisp_Object, Lisp_Object);
211 /* also defined in xterm.h XXX: factor out to common header */
213 extern struct w32_display_info *w32_term_init (Lisp_Object,
214 char *, char *);
215 extern int w32_defined_color (struct frame *f, const char *color,
216 XColor *color_def, int alloc);
217 extern void x_set_window_size (struct frame *f, int change_grav,
218 int width, int height, bool pixelwise);
219 extern int x_display_pixel_height (struct w32_display_info *);
220 extern int x_display_pixel_width (struct w32_display_info *);
221 extern Lisp_Object x_get_focus_frame (struct frame *);
222 extern void x_set_mouse_position (struct frame *f, int h, int v);
223 extern void x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y);
224 extern void x_make_frame_visible (struct frame *f);
225 extern void x_make_frame_invisible (struct frame *f);
226 extern void x_iconify_frame (struct frame *f);
227 extern void x_set_frame_alpha (struct frame *f);
228 extern void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
229 extern void x_set_tool_bar_lines (struct frame *f,
230 Lisp_Object value,
231 Lisp_Object oldval);
232 extern void x_activate_menubar (struct frame *);
233 extern int x_bitmap_icon (struct frame *, Lisp_Object);
234 extern void initialize_frame_menubar (struct frame *);
235 extern void x_free_frame_resources (struct frame *);
236 extern void x_real_positions (struct frame *, int *, int *);
238 /* w32inevt.c */
239 extern int w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId);
240 extern int w32_kbd_mods_to_emacs (DWORD mods, WORD key);
243 extern Lisp_Object x_get_focus_frame (struct frame *);
245 /* w32console.c */
246 extern void w32con_hide_cursor (void);
247 extern void w32con_show_cursor (void);
250 #define PIX_TYPE COLORREF
252 /* Each W32 frame object points to its own struct w32_display object
253 in the output_data.w32 field. The w32_display structure contains all
254 the information that is specific to W32 windows. */
256 /* Put some things in x_output for compatibility.
257 NTEMACS_TODO: Move all common things here to eliminate unnecessary
258 diffs between X and w32 code. */
259 struct x_output
261 /* Keep track of focus. May be EXPLICIT if we received a FocusIn for this
262 frame, or IMPLICIT if we received an EnterNotify.
263 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
264 int focus_state;
267 enum
269 /* Values for focus_state, used as bit mask.
270 EXPLICIT means we received a FocusIn for the frame and know it has
271 the focus. IMPLICIT means we received an EnterNotify and the frame
272 may have the focus if no window manager is running.
273 FocusOut and LeaveNotify clears EXPLICIT/IMPLICIT. */
274 FOCUS_NONE = 0,
275 FOCUS_IMPLICIT = 1,
276 FOCUS_EXPLICIT = 2
279 struct w32_output
281 /* Placeholder for things accessed through output_data.x. */
282 struct x_output x_compatible;
284 /* Menubar "widget" handle. */
285 HMENU menubar_widget;
287 /* Original palette (used to deselect real palette after drawing) */
288 HPALETTE old_palette;
290 /* Here are the Graphics Contexts for the default font. */
291 XGCValues *cursor_gc; /* cursor drawing */
293 /* The window used for this frame.
294 May be zero while the frame object is being created
295 and the window has not yet been created. */
296 Window window_desc;
298 /* The window that is the parent of this window.
299 Usually this is a window that was made by the window manager,
300 but it can be the root window, and it can be explicitly specified
301 (see the explicit_parent field, below). */
302 Window parent_desc;
304 /* Default ASCII font of this frame. */
305 struct font *font;
307 /* The baseline offset of the default ASCII font. */
308 int baseline_offset;
310 /* If a fontset is specified for this frame instead of font, this
311 value contains an ID of the fontset, else -1. */
312 int fontset;
314 /* Pixel values used for various purposes.
315 border_pixel may be -1 meaning use a gray tile. */
316 COLORREF cursor_pixel;
317 COLORREF border_pixel;
318 COLORREF mouse_pixel;
319 COLORREF cursor_foreground_pixel;
321 /* Foreground color for scroll bars. A value of -1 means use the
322 default (black for non-toolkit scroll bars). */
323 COLORREF scroll_bar_foreground_pixel;
325 /* Background color for scroll bars. A value of -1 means use the
326 default (background color of the frame for non-toolkit scroll
327 bars). */
328 COLORREF scroll_bar_background_pixel;
330 /* Descriptor for the cursor in use for this window. */
331 Cursor text_cursor;
332 Cursor nontext_cursor;
333 Cursor modeline_cursor;
334 Cursor hand_cursor;
335 Cursor hourglass_cursor;
336 Cursor horizontal_drag_cursor;
337 Cursor vertical_drag_cursor;
339 /* Non-zero means hourglass cursor is currently displayed. */
340 unsigned hourglass_p : 1;
342 /* Non-hourglass cursor that is currently active. */
343 Cursor current_cursor;
345 DWORD dwStyle;
347 /* This is the Emacs structure for the display this frame is on. */
348 /* struct w32_display_info *display_info; */
350 /* Nonzero means our parent is another application's window
351 and was explicitly specified. */
352 unsigned explicit_parent : 1;
354 /* Nonzero means tried already to make this frame visible. */
355 unsigned asked_for_visible : 1;
357 /* Nonzero means menubar is currently active. */
358 unsigned menubar_active : 1;
360 /* Relief GCs, colors etc. */
361 struct relief
363 XGCValues *gc;
364 unsigned long pixel;
366 black_relief, white_relief;
368 /* The background for which the above relief GCs were set up.
369 They are changed only when a different background is involved. */
370 unsigned long relief_background;
372 /* Frame geometry and full-screen mode before it was resized by
373 specifying the 'fullscreen' frame parameter. Used to restore the
374 geometry when 'fullscreen' is reset to nil. */
375 WINDOWPLACEMENT normal_placement;
376 int prev_fsmode;
379 extern struct w32_output w32term_display;
381 /* Return the X output data for frame F. */
382 #define FRAME_X_OUTPUT(f) ((f)->output_data.w32)
384 /* Return the window associated with the frame F. */
385 #define FRAME_W32_WINDOW(f) ((f)->output_data.w32->window_desc)
386 #define FRAME_X_WINDOW(f) FRAME_W32_WINDOW (f)
388 #define FRAME_FONT(f) ((f)->output_data.w32->font)
389 #define FRAME_FONTSET(f) ((f)->output_data.w32->fontset)
390 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.w32->baseline_offset)
392 /* This gives the w32_display_info structure for the display F is on. */
393 #define FRAME_DISPLAY_INFO(f) (&one_w32_display_info)
395 /* This is the `Display *' which frame F is on. */
396 #define FRAME_X_DISPLAY(f) (0)
398 #define FRAME_NORMAL_PLACEMENT(F) ((F)->output_data.w32->normal_placement)
399 #define FRAME_PREV_FSMODE(F) ((F)->output_data.w32->prev_fsmode)
402 /* W32-specific scroll bar stuff. */
404 /* We represent scroll bars as lisp vectors. This allows us to place
405 references to them in windows without worrying about whether we'll
406 end up with windows referring to dead scroll bars; the garbage
407 collector will free it when its time comes.
409 We use struct scroll_bar as a template for accessing fields of the
410 vector. */
412 struct scroll_bar {
414 /* This field is shared by all vectors. */
415 struct vectorlike_header header;
417 /* The window we're a scroll bar for. */
418 Lisp_Object window;
420 /* The next and previous in the chain of scroll bars in this frame. */
421 Lisp_Object next, prev;
423 /* The window representing this scroll bar. Since this is a full
424 32-bit quantity, we store it split into two 32-bit values. */
425 Lisp_Object w32_window_low, w32_window_high;
427 /* Same as above for the widget. */
428 Lisp_Object w32_widget_low, w32_widget_high;
430 /* The position and size of the scroll bar in pixels, relative to the
431 frame. */
432 int top, left, width, height;
434 /* The starting and ending positions of the handle, relative to the
435 handle area (i.e. zero is the top position, not
436 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
437 hasn't been drawn yet.
439 These are not actually the locations where the beginning and end
440 are drawn; in order to keep handles from becoming invisible when
441 editing large files, we establish a minimum height by always
442 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
443 where they would be normally; the bottom and top are in a
444 different co-ordinate system. */
445 int start, end;
447 /* If the scroll bar handle is currently being dragged by the user,
448 this is the number of pixels from the top of the handle to the
449 place where the user grabbed it. If the handle isn't currently
450 being dragged, this is Qnil. */
451 int dragging;
454 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
455 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
457 #ifdef _WIN64
458 /* Building a 64-bit C integer from two 32-bit lisp integers. */
459 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 32 | XINT (low))
461 /* Setting two lisp integers to the low and high words of a 64-bit C int. */
462 #define SCROLL_BAR_UNPACK(low, high, int64) \
463 (XSETINT ((low), ((DWORDLONG)(int64)) & 0xffffffff), \
464 XSETINT ((high), ((DWORDLONG)(int64) >> 32) & 0xffffffff))
465 #else /* not _WIN64 */
466 /* Building a 32-bit C integer from two 16-bit lisp integers. */
467 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
469 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
470 #define SCROLL_BAR_UNPACK(low, high, int32) \
471 (XSETINT ((low), (int32) & 0xffff), \
472 XSETINT ((high), ((int32) >> 16) & 0xffff))
473 #endif /* not _WIN64 */
475 /* Extract the window id of the scroll bar from a struct scroll_bar. */
476 #define SCROLL_BAR_W32_WINDOW(ptr) \
477 ((Window) SCROLL_BAR_PACK ((ptr)->w32_window_low, (ptr)->w32_window_high))
479 /* Store a window id in a struct scroll_bar. */
480 #define SET_SCROLL_BAR_W32_WINDOW(ptr, id) \
481 (SCROLL_BAR_UNPACK ((ptr)->w32_window_low, (ptr)->w32_window_high, (intptr_t) id))
483 /* Return the inside width of a vertical scroll bar, given the outside
484 width. */
485 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
486 ((width) \
487 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
488 - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
490 /* Return the length of the rectangle within which the top of the
491 handle must stay. This isn't equivalent to the inside height,
492 because the scroll bar handle has a minimum height.
494 This is the real range of motion for the scroll bar, so when we're
495 scaling buffer positions to scroll bar positions, we use this, not
496 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
497 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
498 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
500 /* Return the inside height of vertical scroll bar, given the outside
501 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
502 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
503 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
506 /* Border widths for scroll bars.
508 Scroll bar windows don't have any borders; their border width is
509 set to zero, and we redraw borders ourselves. This makes the code
510 a bit cleaner, since we don't have to convert between outside width
511 (used when relating to the rest of the screen) and inside width
512 (used when sizing and drawing the scroll bar window itself).
514 The handle moves up and down/back and forth in a rectangle inset
515 from the edges of the scroll bar. These are widths by which we
516 inset the handle boundaries from the scroll bar edges. */
517 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
518 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
519 #define VERTICAL_SCROLL_BAR_TOP_BORDER (vertical_scroll_bar_top_border)
520 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (vertical_scroll_bar_bottom_border)
522 /* Minimum lengths for scroll bar handles, in pixels. */
523 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (vertical_scroll_bar_min_handle)
525 struct frame; /* from frame.h */
527 extern void w32_fill_rect (struct frame *, HDC, COLORREF, RECT *);
528 extern void w32_clear_window (struct frame *);
530 #define w32_fill_area(f,hdc,pix,x,y,nx,ny) \
531 do { \
532 RECT rect; \
533 rect.left = x; \
534 rect.top = y; \
535 rect.right = x + nx; \
536 rect.bottom = y + ny; \
537 w32_fill_rect (f,hdc,pix,&rect); \
538 } while (0)
540 #define w32_fill_area_abs(f,hdc,pix,x0,y0,x1,y1) \
541 do { \
542 RECT rect; \
543 rect.left = x0; \
544 rect.top = y0; \
545 rect.right = x1; \
546 rect.bottom = y1; \
547 w32_fill_rect (f,hdc,pix,&rect); \
548 } while (0)
550 #define w32_clear_rect(f,hdc,lprect) \
551 w32_fill_rect (f, hdc, FRAME_BACKGROUND_PIXEL (f), lprect)
553 #define w32_clear_area(f,hdc,px,py,nx,ny) \
554 w32_fill_area (f, hdc, FRAME_BACKGROUND_PIXEL (f), px, py, nx, ny)
556 /* Define for earlier versions of Visual C */
557 #ifndef WM_MOUSEWHEEL
558 #define WM_MOUSEWHEEL (WM_MOUSELAST + 1)
559 #endif /* WM_MOUSEWHEEL */
560 #ifndef MSH_MOUSEWHEEL
561 #define MSH_MOUSEWHEEL "MSWHEEL_ROLLMSG"
562 #endif /* MSH_MOUSEWHEEL */
563 #ifndef WM_XBUTTONDOWN
564 #define WM_XBUTTONDOWN (WM_MOUSEWHEEL + 1)
565 #define WM_XBUTTONUP (WM_MOUSEWHEEL + 2)
566 #endif /* WM_XBUTTONDOWN */
567 #ifndef WM_MOUSEHWHEEL
568 #define WM_MOUSEHWHEEL (WM_MOUSEWHEEL + 4)
569 #endif /* WM_MOUSEHWHEEL */
570 #ifndef WM_APPCOMMAND
571 #define WM_APPCOMMAND 0x319
572 #define GET_APPCOMMAND_LPARAM(lParam) (HIWORD(lParam) & 0x7fff)
573 #endif
574 #ifndef WM_UNICHAR
575 #define WM_UNICHAR 0x109
576 #endif
577 #ifndef UNICODE_NOCHAR
578 #define UNICODE_NOCHAR 0xFFFF
579 #endif
581 #define WM_EMACS_START (WM_USER + 1)
582 #define WM_EMACS_KILL (WM_EMACS_START + 0)
583 #define WM_EMACS_CREATEWINDOW (WM_EMACS_START + 1)
584 #define WM_EMACS_DONE (WM_EMACS_START + 2)
585 #define WM_EMACS_CREATESCROLLBAR (WM_EMACS_START + 3)
586 #define WM_EMACS_SHOWWINDOW (WM_EMACS_START + 4)
587 #define WM_EMACS_SETWINDOWPOS (WM_EMACS_START + 5)
588 #define WM_EMACS_DESTROYWINDOW (WM_EMACS_START + 6)
589 #define WM_EMACS_TRACKPOPUPMENU (WM_EMACS_START + 7)
590 #define WM_EMACS_SETFOCUS (WM_EMACS_START + 8)
591 #define WM_EMACS_SETFOREGROUND (WM_EMACS_START + 9)
592 #define WM_EMACS_SETLOCALE (WM_EMACS_START + 10)
593 #define WM_EMACS_SETKEYBOARDLAYOUT (WM_EMACS_START + 11)
594 #define WM_EMACS_REGISTER_HOT_KEY (WM_EMACS_START + 12)
595 #define WM_EMACS_UNREGISTER_HOT_KEY (WM_EMACS_START + 13)
596 #define WM_EMACS_TOGGLE_LOCK_KEY (WM_EMACS_START + 14)
597 #define WM_EMACS_TRACK_CARET (WM_EMACS_START + 15)
598 #define WM_EMACS_DESTROY_CARET (WM_EMACS_START + 16)
599 #define WM_EMACS_SHOW_CARET (WM_EMACS_START + 17)
600 #define WM_EMACS_HIDE_CARET (WM_EMACS_START + 18)
601 #define WM_EMACS_SETCURSOR (WM_EMACS_START + 19)
602 #define WM_EMACS_PAINT (WM_EMACS_START + 20)
603 #define WM_EMACS_BRINGTOTOP (WM_EMACS_START + 21)
604 #define WM_EMACS_INPUT_READY (WM_EMACS_START + 22)
605 #define WM_EMACS_FILENOTIFY (WM_EMACS_START + 23)
606 #define WM_EMACS_END (WM_EMACS_START + 24)
608 #define WND_FONTWIDTH_INDEX (0)
609 #define WND_LINEHEIGHT_INDEX (4)
610 #define WND_BORDER_INDEX (8)
611 #define WND_SCROLLBAR_INDEX (12)
612 #define WND_BACKGROUND_INDEX (16)
613 #define WND_LAST_INDEX (20)
615 #define WND_EXTRA_BYTES (WND_LAST_INDEX)
617 extern DWORD dwWindowsThreadId;
618 extern HANDLE hWindowsThread;
619 extern DWORD dwMainThreadId;
620 extern HANDLE hMainThread;
622 typedef struct W32Msg {
623 MSG msg;
624 DWORD dwModifiers;
625 RECT rect;
626 } W32Msg;
628 extern BOOL prepend_msg (W32Msg *lpmsg);
630 /* Structure for recording message when input thread must return a
631 result that depends on lisp thread to compute. Lisp thread can
632 complete deferred messages out of order. */
633 typedef struct deferred_msg
635 struct deferred_msg * next;
636 W32Msg w32msg;
637 LRESULT result;
638 int completed;
639 } deferred_msg;
641 extern CRITICAL_SECTION critsect;
643 extern void init_crit (void);
644 extern void delete_crit (void);
646 extern void signal_quit (void);
648 #define enter_crit() EnterCriticalSection (&critsect)
649 #define leave_crit() LeaveCriticalSection (&critsect)
651 extern void select_palette (struct frame * f, HDC hdc);
652 extern void deselect_palette (struct frame * f, HDC hdc);
653 extern HDC get_frame_dc (struct frame * f);
654 extern int release_frame_dc (struct frame * f, HDC hDC);
656 extern int drain_message_queue (void);
658 extern BOOL get_next_msg (W32Msg *, BOOL);
659 extern BOOL post_msg (W32Msg *);
660 extern void complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result);
662 extern BOOL parse_button (int, int, int *, int *);
664 extern void w32_sys_ring_bell (struct frame *f);
665 extern void x_delete_display (struct w32_display_info *dpyinfo);
667 extern volatile int notification_buffer_in_use;
668 extern BYTE file_notifications[16384];
669 extern DWORD notifications_size;
670 extern void *notifications_desc;
671 extern Lisp_Object w32_get_watch_object (void *);
672 extern Lisp_Object lispy_file_action (DWORD);
673 extern int handle_file_notifications (struct input_event *);
675 extern void w32_initialize_display_info (Lisp_Object);
676 extern void initialize_w32_display (struct terminal *, int *, int *);
678 /* Keypad command key support. W32 doesn't have virtual keys defined
679 for the function keys on the keypad (they are mapped to the standard
680 function keys), so we define our own. */
681 #define VK_NUMPAD_BEGIN 0x92
682 #define VK_NUMPAD_CLEAR (VK_NUMPAD_BEGIN + 0)
683 #define VK_NUMPAD_ENTER (VK_NUMPAD_BEGIN + 1)
684 #define VK_NUMPAD_PRIOR (VK_NUMPAD_BEGIN + 2)
685 #define VK_NUMPAD_NEXT (VK_NUMPAD_BEGIN + 3)
686 #define VK_NUMPAD_END (VK_NUMPAD_BEGIN + 4)
687 #define VK_NUMPAD_HOME (VK_NUMPAD_BEGIN + 5)
688 #define VK_NUMPAD_LEFT (VK_NUMPAD_BEGIN + 6)
689 #define VK_NUMPAD_UP (VK_NUMPAD_BEGIN + 7)
690 #define VK_NUMPAD_RIGHT (VK_NUMPAD_BEGIN + 8)
691 #define VK_NUMPAD_DOWN (VK_NUMPAD_BEGIN + 9)
692 #define VK_NUMPAD_INSERT (VK_NUMPAD_BEGIN + 10)
693 #define VK_NUMPAD_DELETE (VK_NUMPAD_BEGIN + 11)
695 #ifndef VK_LWIN
696 /* Older compiler environments don't have these defined. */
697 #define VK_LWIN 0x5B
698 #define VK_RWIN 0x5C
699 #define VK_APPS 0x5D
700 #endif
702 /* Support for treating Windows and Apps keys as modifiers. These
703 constants must not overlap with any of the dwControlKeyState flags in
704 KEY_EVENT_RECORD. */
705 #define LEFT_WIN_PRESSED 0x8000
706 #define RIGHT_WIN_PRESSED 0x4000
707 #define APPS_PRESSED 0x2000
709 /* The current ANSI input codepage for GUI sessions. */
710 extern int w32_keyboard_codepage;
712 /* When compiling on Windows 9x/ME and NT 3.x, the following are not defined
713 (even though they are supported on 98 and ME. */
714 #ifndef WM_MOUSELEAVE
715 #define WM_MOUSELEAVE 0x02A3
716 #define TME_LEAVE 0x00000002;
718 typedef struct tagTRACKMOUSEEVENT
720 DWORD cbSize;
721 DWORD dwFlags;
722 HWND hwndTrack;
723 DWORD dwHoverTime;
724 } TRACKMOUSEEVENT;
725 #endif
727 struct image;
728 struct face;
730 XGCValues *XCreateGC (void *, Window, unsigned long, XGCValues *);
732 typedef DWORD (WINAPI * ClipboardSequence_Proc) (void);
733 typedef BOOL (WINAPI * AppendMenuW_Proc) (
734 IN HMENU,
735 IN UINT,
736 IN UINT_PTR,
737 IN LPCWSTR);
739 extern HWND w32_system_caret_hwnd;
740 extern int w32_system_caret_height;
741 extern int w32_system_caret_x;
742 extern int w32_system_caret_y;
743 extern struct window *w32_system_caret_window;
744 extern int w32_system_caret_hdr_height;
745 extern int w32_system_caret_mode_height;
747 #ifdef _MSC_VER
748 #ifndef EnumSystemLocales
749 /* MSVC headers define these only for _WIN32_WINNT >= 0x0500. */
750 typedef BOOL (CALLBACK *LOCALE_ENUMPROCA)(LPSTR);
751 typedef BOOL (CALLBACK *LOCALE_ENUMPROCW)(LPWSTR);
752 BOOL WINAPI EnumSystemLocalesA(LOCALE_ENUMPROCA,DWORD);
753 BOOL WINAPI EnumSystemLocalesW(LOCALE_ENUMPROCW,DWORD);
754 #ifdef UNICODE
755 #define EnumSystemLocales EnumSystemLocalesW
756 #else
757 #define EnumSystemLocales EnumSystemLocalesA
758 #endif
759 #endif
760 #endif
762 #if EMACSDEBUG
763 extern const char*
764 w32_name_of_message (UINT msg);
765 #endif /* EMACSDEBUG */
767 #ifdef NTGUI_UNICODE
768 extern Lisp_Object ntgui_encode_system (Lisp_Object str);
769 #define GUISTR(x) (L ## x)
770 #define GUI_ENCODE_FILE GUI_ENCODE_SYSTEM
771 #define GUI_ENCODE_SYSTEM(x) ntgui_encode_system (x)
772 #define GUI_FN(fn) fn ## W
773 typedef wchar_t guichar_t;
774 #else /* !NTGUI_UNICODE */
775 #define GUISTR(x) x
776 #define GUI_ENCODE_FILE ENCODE_FILE
777 #define GUI_ENCODE_SYSTEM ENCODE_SYSTEM
778 #define GUI_FN(fn) fn
779 typedef char guichar_t;
780 #endif /* NTGUI_UNICODE */
782 #define GUI_SDATA(x) ((guichar_t*) SDATA (x))
784 extern Lisp_Object w32_popup_dialog (struct frame *, Lisp_Object, Lisp_Object);
786 extern void syms_of_w32term (void);
787 extern void syms_of_w32menu (void);
788 extern void syms_of_w32fns (void);
790 extern void globals_of_w32menu (void);
791 extern void globals_of_w32fns (void);
792 extern void globals_of_w32notify (void);
794 #ifdef CYGWIN
795 extern int w32_message_fd;
796 #endif /* CYGWIN */