(timeout-event-p): Function deleted.
[emacs.git] / src / w32term.h
blob3d027de1e8d19af214b3b6f9e65399c1f9da259f
1 /* Definitions and headers for communication with Win32 GUI.
2 Copyright (C) 1995 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 2, or (at your option)
9 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; 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. */
21 /* Added by Kevin Gallo */
23 #include <win32.h>
25 /* The class of this X application. */
26 #define EMACS_CLASS "Emacs"
28 #define BLACK_PIX_DEFAULT(f) RGB(0,0,0)
29 #define WHITE_PIX_DEFAULT(f) RGB(255,255,255)
31 #define FONT_WIDTH(f) ((f)->tm.tmAveCharWidth)
32 #define FONT_HEIGHT(f) ((f)->tm.tmHeight)
33 #define FONT_BASE(f) ((f)->tm.tmAscent)
35 #define CHECK_WIN32_FRAME(f, frame) \
36 if (NILP (frame)) \
37 f = selected_frame; \
38 else \
39 { \
40 CHECK_LIVE_FRAME (frame, 0); \
41 f = XFRAME (frame); \
42 } \
43 if (! FRAME_WIN32_P (f))
45 /* Indicates whether we are in the readsocket call and the message we
46 are processing in the current loop */
48 extern MSG CurMsg;
49 extern BOOL bUseDflt;
51 extern struct frame *x_window_to_frame ();
53 enum text_cursor_kinds {
54 filled_box_cursor, hollow_box_cursor, bar_cursor
57 /* This data type is used for the font_table field
58 of struct win32_display_info. */
60 struct font_info
62 XFontStruct *font;
63 char *name;
66 /* Structure recording bitmaps and reference count.
67 If REFCOUNT is 0 then this record is free to be reused. */
69 struct win32_bitmap_record
71 Pixmap pixmap;
72 char *file;
73 HINSTANCE hinst; /* Used to load the file */
74 int refcount;
75 /* Record some info about this pixmap. */
76 int height, width, depth;
79 /* For each display (currently only one on win32), we have a structure that
80 records information about it. */
82 struct win32_display_info
84 /* Chain of all win32_display_info structures. */
85 struct win32_display_info *next;
86 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
87 The same cons cell also appears in x_display_name_list. */
88 Lisp_Object name_list_element;
89 /* Number of frames that are on this display. */
90 int reference_count;
91 /* Number of planes on this screen. */
92 int n_planes;
93 /* Number of bits per pixel on this screen. */
94 int n_cbits;
95 /* Dimensions of this screen. */
96 int height, width;
97 int height_in,width_in;
98 /* Mask of things that cause the mouse to be grabbed. */
99 int grabbed;
100 /* The root window of this screen. */
101 Window root_window;
102 /* The cursor to use for vertical scroll bars. */
103 Cursor vertical_scroll_bar_cursor;
105 /* A table of all the fonts we have already loaded. */
106 struct font_info *font_table;
108 /* The current capacity of x_font_table. */
109 int font_table_size;
111 /* These variables describe the range of text currently shown
112 in its mouse-face, together with the window they apply to.
113 As long as the mouse stays within this range, we need not
114 redraw anything on its account. */
115 int mouse_face_beg_row, mouse_face_beg_col;
116 int mouse_face_end_row, mouse_face_end_col;
117 int mouse_face_past_end;
118 Lisp_Object mouse_face_window;
119 int mouse_face_face_id;
121 /* 1 if a mouse motion event came and we didn't handle it right away because
122 gc was in progress. */
123 int mouse_face_deferred_gc;
125 /* FRAME and X, Y position of mouse when last checked for
126 highlighting. X and Y can be negative or out of range for the frame. */
127 struct frame *mouse_face_mouse_frame;
128 int mouse_face_mouse_x, mouse_face_mouse_y;
130 /* Nonzero means defer mouse-motion highlighting. */
131 int mouse_face_defer;
133 char *win32_id_name;
135 /* The number of fonts actually stored in win32_font_table.
136 font_table[n] is used and valid iff 0 <= n < n_fonts.
137 0 <= n_fonts <= font_table_size. */
138 int n_fonts;
140 /* Pointer to bitmap records. */
141 struct win32_bitmap_record *bitmaps;
143 /* Allocated size of bitmaps field. */
144 int bitmaps_size;
146 /* Last used bitmap index. */
147 int bitmaps_last;
149 /* The frame (if any) which has the window that has keyboard focus.
150 Zero if none. This is examined by Ffocus_frame in w32fns.c. Note
151 that a mere EnterNotify event can set this; if you need to know the
152 last frame specified in a FocusIn or FocusOut event, use
153 win32_focus_event_frame. */
154 struct frame *win32_focus_frame;
156 /* The last frame mentioned in a FocusIn or FocusOut event. This is
157 separate from win32_focus_frame, because whether or not LeaveNotify
158 events cause us to lose focus depends on whether or not we have
159 received a FocusIn event for it. */
160 struct frame *win32_focus_event_frame;
162 /* The frame which currently has the visual highlight, and should get
163 keyboard input (other sorts of input have the frame encoded in the
164 event). It points to the focus frame's selected window's
165 frame. It differs from win32_focus_frame when we're using a global
166 minibuffer. */
167 struct frame *win32_highlight_frame;
170 /* This is a chain of structures for all the displays currently in use. */
171 extern struct win32_display_info one_win32_display_info;
173 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
174 one for each element of win32_display_list and in the same order.
175 NAME is the name of the frame.
176 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
177 extern Lisp_Object win32_display_name_list;
179 extern struct win32_display_info *x_display_info_for_display ();
180 extern struct win32_display_info *x_display_info_for_name ();
182 extern struct win32_display_info *win32_term_init ();
184 /* Each Win32 frame object points to its own struct win32_display object
185 in the output_data.win32 field. The win32_display structure contains all
186 the information that is specific to Win32 windows. */
188 struct win32_output
190 /* Position of the Win32 window (x and y offsets in root window). */
191 int left_pos;
192 int top_pos;
194 /* Border width of the Win32 window as known by the window system. */
195 int border_width;
197 /* Size of the Win32 window in pixels. */
198 int pixel_height, pixel_width;
200 /* Height of a line, in pixels. */
201 int line_height;
203 /* Width of the internal border. This is a line of background color
204 just inside the window's border. When the frame is selected,
205 a highlighting is displayed inside the internal border. */
206 int internal_border_width;
208 /* The window used for this frame.
209 May be zero while the frame object is being created
210 and the window has not yet been created. */
211 Window window_desc;
213 /* The window that is the parent of this window.
214 Usually this is a window that was made by the window manager,
215 but it can be the root window, and it can be explicitly specified
216 (see the explicit_parent field, below). */
217 Window parent_desc;
219 XFontStruct *font;
221 /* Pixel values used for various purposes.
222 border_pixel may be -1 meaning use a gray tile. */
223 unsigned long background_pixel;
224 unsigned long foreground_pixel;
225 unsigned long cursor_pixel;
226 unsigned long border_pixel;
227 unsigned long mouse_pixel;
228 unsigned long cursor_foreground_pixel;
230 /* Descriptor for the cursor in use for this window. */
231 Cursor text_cursor;
232 Cursor nontext_cursor;
233 Cursor modeline_cursor;
234 Cursor cross_cursor;
236 /* Flag to set when the window needs to be completely repainted. */
237 int needs_exposure;
239 /* What kind of text cursor is drawn in this window right now?
240 (If there is no cursor (phys_cursor_x < 0), then this means nothing.) */
241 enum text_cursor_kinds current_cursor;
243 /* What kind of text cursor should we draw in the future?
244 This should always be filled_box_cursor or bar_cursor. */
245 enum text_cursor_kinds desired_cursor;
247 /* Width of bar cursor (if we are using that). */
248 int cursor_width;
250 DWORD dwStyle;
252 /* The size of the extra width currently allotted for vertical
253 scroll bars, in pixels. */
254 int vertical_scroll_bar_extra;
256 /* Table of parameter faces for this frame. Any resources (pixel
257 values, fonts) referred to here have been allocated explicitly
258 for this face, and should be freed if we change the face. */
259 struct face **param_faces;
260 int n_param_faces;
262 /* Table of computed faces for this frame. These are the faces
263 whose indexes go into the upper bits of a glyph, computed by
264 combining the parameter faces specified by overlays, text
265 properties, and what have you. The resources mentioned here
266 are all shared with parameter faces. */
267 struct face **computed_faces;
268 int n_computed_faces; /* How many are valid */
269 int size_computed_faces; /* How many are allocated */
271 /* This is the gravity value for the specified window position. */
272 int win_gravity;
274 /* The geometry flags for this window. */
275 int size_hint_flags;
277 /* This is the Emacs structure for the display this frame is on. */
278 /* struct win32_display_info *display_info; */
280 /* Nonzero means our parent is another application's window
281 and was explicitly specified. */
282 char explicit_parent;
284 /* Nonzero means tried already to make this frame visible. */
285 char asked_for_visible;
288 /* Get at the computed faces of an X window frame. */
289 #define FRAME_PARAM_FACES(f) ((f)->output_data.win32->param_faces)
290 #define FRAME_N_PARAM_FACES(f) ((f)->output_data.win32->n_param_faces)
291 #define FRAME_DEFAULT_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[0])
292 #define FRAME_MODE_LINE_PARAM_FACE(f) (FRAME_PARAM_FACES (f)[1])
294 #define FRAME_COMPUTED_FACES(f) ((f)->output_data.win32->computed_faces)
295 #define FRAME_N_COMPUTED_FACES(f) ((f)->output_data.win32->n_computed_faces)
296 #define FRAME_SIZE_COMPUTED_FACES(f) ((f)->output_data.win32->size_computed_faces)
297 #define FRAME_DEFAULT_FACE(f) ((f)->output_data.win32->computed_faces[0])
298 #define FRAME_MODE_LINE_FACE(f) ((f)->output_data.win32->computed_faces[1])
300 /* Return the window associated with the frame F. */
301 #define FRAME_WIN32_WINDOW(f) ((f)->output_data.win32->window_desc)
303 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.win32->foreground_pixel)
304 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.win32->background_pixel)
305 #define FRAME_FONT(f) ((f)->output_data.win32->font)
306 #define FRAME_INTERNAL_BORDER_WIDTH(f) ((f)->output_data.win32->internal_border_width)
308 /* This gives the win32_display_info structure for the display F is on. */
309 #define FRAME_WIN32_DISPLAY_INFO(f) (&one_win32_display_info)
311 /* These two really ought to be called FRAME_PIXEL_{WIDTH,HEIGHT}. */
312 #define PIXEL_WIDTH(f) ((f)->output_data.win32->pixel_width)
313 #define PIXEL_HEIGHT(f) ((f)->output_data.win32->pixel_height)
314 #define FRAME_LINE_HEIGHT(f) ((f)->output_data.win32->line_height)
316 #define FRAME_DESIRED_CURSOR(f) ((f)->output_data.win32->desired_cursor)
319 /* Win32-specific scroll bar stuff. */
321 /* We represent scroll bars as lisp vectors. This allows us to place
322 references to them in windows without worrying about whether we'll
323 end up with windows referring to dead scroll bars; the garbage
324 collector will free it when its time comes.
326 We use struct scroll_bar as a template for accessing fields of the
327 vector. */
329 struct scroll_bar {
331 /* These fields are shared by all vectors. */
332 EMACS_INT size_from_Lisp_Vector_struct;
333 struct Lisp_Vector *next_from_Lisp_Vector_struct;
335 /* The window we're a scroll bar for. */
336 Lisp_Object window;
338 /* The next and previous in the chain of scroll bars in this frame. */
339 Lisp_Object next, prev;
341 /* The window representing this scroll bar. Since this is a full
342 32-bit quantity, we store it split into two 32-bit values. */
343 Lisp_Object win32_window_low, win32_window_high;
345 /* The position and size of the scroll bar in pixels, relative to the
346 frame. */
347 Lisp_Object top, left, width, height;
349 /* The starting and ending positions of the handle, relative to the
350 handle area (i.e. zero is the top position, not
351 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
352 hasn't been drawn yet.
354 These are not actually the locations where the beginning and end
355 are drawn; in order to keep handles from becoming invisible when
356 editing large files, we establish a minimum height by always
357 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
358 where they would be normally; the bottom and top are in a
359 different co-ordinate system. */
360 Lisp_Object start, end;
362 /* If the scroll bar handle is currently being dragged by the user,
363 this is the number of pixels from the top of the handle to the
364 place where the user grabbed it. If the handle isn't currently
365 being dragged, this is Qnil. */
366 Lisp_Object dragging;
369 /* The number of elements a vector holding a struct scroll_bar needs. */
370 #define SCROLL_BAR_VEC_SIZE \
371 ((sizeof (struct scroll_bar) \
372 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
373 / sizeof (Lisp_Object))
375 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
376 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
379 /* Building a 32-bit C integer from two 16-bit lisp integers. */
380 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
382 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
383 #define SCROLL_BAR_UNPACK(low, high, int32) \
384 (XSETINT ((low), (int32) & 0xffff), \
385 XSETINT ((high), ((int32) >> 16) & 0xffff))
388 /* Extract the window id of the scroll bar from a struct scroll_bar. */
389 #define SCROLL_BAR_WIN32_WINDOW(ptr) \
390 ((Window) SCROLL_BAR_PACK ((ptr)->win32_window_low, (ptr)->win32_window_high))
392 /* Store a window id in a struct scroll_bar. */
393 #define SET_SCROLL_BAR_WIN32_WINDOW(ptr, id) \
394 (SCROLL_BAR_UNPACK ((ptr)->win32_window_low, (ptr)->win32_window_high, (int) id))
397 /* Return the outside pixel height for a vertical scroll bar HEIGHT
398 rows high on frame F. */
399 #define VERTICAL_SCROLL_BAR_PIXEL_HEIGHT(f, height) \
400 ((height) * (f)->output_data.win32->line_height)
402 /* Return the inside width of a vertical scroll bar, given the outside
403 width. */
404 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(width) \
405 ((width) - VERTICAL_SCROLL_BAR_LEFT_BORDER - VERTICAL_SCROLL_BAR_RIGHT_BORDER)
407 /* Return the length of the rectangle within which the top of the
408 handle must stay. This isn't equivalent to the inside height,
409 because the scroll bar handle has a minimum height.
411 This is the real range of motion for the scroll bar, so when we're
412 scaling buffer positions to scroll bar positions, we use this, not
413 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
414 #define VERTICAL_SCROLL_BAR_TOP_RANGE(height) \
415 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (height) - VERTICAL_SCROLL_BAR_MIN_HANDLE)
417 /* Return the inside height of vertical scroll bar, given the outside
418 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
419 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(height) \
420 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
423 /* Border widths for scroll bars.
425 Scroll bar windows don't have any borders; their border width is
426 set to zero, and we redraw borders ourselves. This makes the code
427 a bit cleaner, since we don't have to convert between outside width
428 (used when relating to the rest of the screen) and inside width
429 (used when sizing and drawing the scroll bar window itself).
431 The handle moves up and down/back and forth in a rectangle inset
432 from the edges of the scroll bar. These are widths by which we
433 inset the handle boundaries from the scroll bar edges. */
434 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
435 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
436 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
437 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
439 /* Minimum lengths for scroll bar handles, in pixels. */
440 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (0)
443 /* Manipulating pixel sizes and character sizes.
444 Knowledge of which factors affect the overall size of the window should
445 be hidden in these macros, if that's possible.
447 Return the upper/left pixel position of the character cell on frame F
448 at ROW/COL. */
449 #define CHAR_TO_PIXEL_ROW(f, row) \
450 ((f)->output_data.win32->internal_border_width \
451 + (row) * (f)->output_data.win32->line_height)
452 #define CHAR_TO_PIXEL_COL(f, col) \
453 ((f)->output_data.win32->internal_border_width \
454 + (col) * FONT_WIDTH ((f)->output_data.win32->font))
456 /* Return the pixel width/height of frame F if it has
457 WIDTH columns/HEIGHT rows. */
458 #define CHAR_TO_PIXEL_WIDTH(f, width) \
459 (CHAR_TO_PIXEL_COL (f, width) \
460 + (f)->output_data.win32->vertical_scroll_bar_extra \
461 + (f)->output_data.win32->internal_border_width)
462 #define CHAR_TO_PIXEL_HEIGHT(f, height) \
463 (CHAR_TO_PIXEL_ROW (f, height) \
464 + (f)->output_data.win32->internal_border_width)
467 /* Return the row/column (zero-based) of the character cell containing
468 the pixel on FRAME at ROW/COL. */
469 #define PIXEL_TO_CHAR_ROW(f, row) \
470 (((row) - (f)->output_data.win32->internal_border_width) \
471 / (f)->output_data.win32->line_height)
472 #define PIXEL_TO_CHAR_COL(f, col) \
473 (((col) - (f)->output_data.win32->internal_border_width) \
474 / FONT_WIDTH ((f)->output_data.win32->font))
476 /* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
477 frame F? */
478 #define PIXEL_TO_CHAR_WIDTH(f, width) \
479 (PIXEL_TO_CHAR_COL (f, ((width) \
480 - (f)->output_data.win32->internal_border_width \
481 - (f)->output_data.win32->vertical_scroll_bar_extra)))
482 #define PIXEL_TO_CHAR_HEIGHT(f, height) \
483 (PIXEL_TO_CHAR_ROW (f, ((height) \
484 - (f)->output_data.win32->internal_border_width)))
486 /* Interface to the face code functions. */
488 /* Create the first two computed faces for a frame -- the ones that
489 have GC's. */
490 extern void init_frame_faces (/* FRAME_PTR */);
492 /* Free the resources for the faces associated with a frame. */
493 extern void free_frame_faces (/* FRAME_PTR */);
495 /* Given a computed face, find or make an equivalent display face
496 in face_vector, and return a pointer to it. */
497 extern struct face *intern_face (/* FRAME_PTR, struct face * */);
499 /* Given a frame and a face name, return the face's ID number, or
500 zero if it isn't a recognized face name. */
501 extern int face_name_id_number (/* FRAME_PTR, Lisp_Object */);
503 /* Return non-zero if FONT1 and FONT2 have the same size bounding box.
504 We assume that they're both character-cell fonts. */
505 extern int same_size_fonts (/* XFontStruct *, XFontStruct * */);
507 /* Recompute the GC's for the default and modeline faces.
508 We call this after changing frame parameters on which those GC's
509 depend. */
510 extern void recompute_basic_faces (/* FRAME_PTR */);
512 /* Return the face ID associated with a buffer position POS. Store
513 into *ENDPTR the next position at which a different face is
514 needed. This does not take account of glyphs that specify their
515 own face codes. F is the frame in use for display, and W is a
516 window displaying the current buffer.
518 REGION_BEG, REGION_END delimit the region, so it can be highlighted. */
519 extern int compute_char_face (/* FRAME_PTR frame,
520 struct window *w,
521 int pos,
522 int region_beg, int region_end,
523 int *endptr */);
524 /* Return the face ID to use to display a special glyph which selects
525 FACE_CODE as the face ID, assuming that ordinarily the face would
526 be BASIC_FACE. F is the frame. */
527 extern int compute_glyph_face (/* FRAME_PTR, int */);
529 extern void win32_fill_rect ();
530 extern void win32_clear_window ();
532 #define win32_fill_area(f,hdc,pix,x,y,nx,ny) \
534 RECT rect; \
535 rect.left = x; \
536 rect.top = y; \
537 rect.right = x + nx; \
538 rect.bottom = y + ny; \
539 win32_fill_rect (f,hdc,pix,&rect); \
542 #define win32_clear_rect(f,hdc,lprect) \
543 win32_fill_rect (f,hdc,f->output_data.win32->background_pixel,lprect)
545 #define win32_clear_area(f,hdc,x,y,nx,ny) \
546 win32_fill_area (f,hdc,f->output_data.win32->background_pixel,x,y,nx,ny)
548 extern XFontStruct *win32_load_font ();
549 extern void win32_unload_font ();
551 extern HDC map_mode();
553 #define my_get_dc(hwnd) (map_mode (GetDC (hwnd)))
555 #define WM_EMACS_START (WM_USER + 1)
556 #define WM_EMACS_KILL (WM_EMACS_START + 0x00)
557 #define WM_EMACS_CREATEWINDOW (WM_EMACS_START + 0x01)
558 #define WM_EMACS_DONE (WM_EMACS_START + 0x02)
559 #define WM_EMACS_CREATESCROLLBAR (WM_EMACS_START + 0x03)
560 #define WM_EMACS_DESTROYWINDOW (WM_EMACS_START + 0x04)
561 #define WM_EMACS_END (WM_EMACS_START + 0x10)
563 #define WND_X_UNITS_INDEX (0)
564 #define WND_Y_UNITS_INDEX (4)
565 #define WND_BACKGROUND_INDEX (8)
567 #define WND_LAST_INDEX (16)
568 #define WND_EXTRA_BYTES (WND_LAST_INDEX)
570 extern DWORD dwWinThreadId;
571 extern HANDLE hWinThread;
572 extern DWORD dwMainThreadId;
573 extern HANDLE hMainThread;
575 typedef struct Win32Msg {
576 MSG msg;
577 DWORD dwModifiers;
578 RECT rect;
579 } Win32Msg;
581 extern void init_crit ();
582 extern void enter_crit ();
583 extern void leave_crit ();
584 extern void delete_crit ();
586 extern BOOL get_next_msg ();
587 extern BOOL post_msg ();
588 extern void wait_for_sync ();
590 extern BOOL parse_button ();