1 /* Window definitions for GNU Emacs.
2 Copyright (C) 1985, 1986, 1993, 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)
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 #ifndef WINDOW_H_INCLUDED
22 #define WINDOW_H_INCLUDED
24 #include "dispextern.h"
26 /* Windows are allocated as if they were vectors, but then the
27 Lisp data type is changed to Lisp_Window. They are garbage
28 collected along with the vectors.
30 All windows in use are arranged into a tree, with pointers up and down.
32 Windows that are leaves of the tree are actually displayed
33 and show the contents of buffers. Windows that are not leaves
34 are used for representing the way groups of leaf windows are
35 arranged on the frame. Leaf windows never become non-leaves.
36 They are deleted only by calling delete-window on them (but
37 this can be done implicitly). Combination windows can be created
38 and deleted at any time.
40 A leaf window has a non-nil buffer field, and also
41 has markers in its start and pointm fields. Non-leaf windows
42 have nil in these fields.
44 Non-leaf windows are either vertical or horizontal combinations.
46 A vertical combination window has children that are arranged on the frame
47 one above the next. Its vchild field points to the uppermost child.
48 The parent field of each of the children points to the vertical
49 combination window. The next field of each child points to the
50 child below it, or is nil for the lowest child. The prev field
51 of each child points to the child above it, or is nil for the
54 A horizontal combination window has children that are side by side.
55 Its hchild field points to the leftmost child. In each child
56 the next field points to the child to the right and the prev field
57 points to the child to the left.
59 The children of a vertical combination window may be leaf windows
60 or horizontal combination windows. The children of a horizontal
61 combination window may be leaf windows or vertical combination windows.
63 At the top of the tree are two windows which have nil as parent.
64 The second of these is minibuf_window. The first one manages all
65 the frame area that is not minibuffer, and is called the root window.
66 Different windows can be the root at different times;
67 initially the root window is a leaf window, but if more windows
68 are created then that leaf window ceases to be root and a newly
69 made combination window becomes root instead.
71 In any case, on screens which have an ordinary window and a
72 minibuffer, prev of the minibuf window is the root window and next of
73 the root window is the minibuf window. On minibufferless screens or
74 minibuffer-only screens, the root window and the minibuffer window are
75 one and the same, so its prev and next members are nil.
77 A dead window has its buffer, hchild, and vchild windows all nil. */
81 /* Pixel position. These are always window relative. */
84 /* Glyph matrix position. */
90 /* The first two fields are really the header of a vector */
91 /* The window code does not refer to them. */
93 struct Lisp_Vector
*vec_next
;
94 /* The frame this window is on. */
96 /* t if this window is a minibuffer window. */
98 /* Following child (to right or down) at same level of tree */
100 /* Preceding child (to left or up) at same level of tree */
102 /* First child of this window. */
103 /* vchild is used if this is a vertical combination,
104 hchild if this is a horizontal combination. */
105 Lisp_Object hchild
, vchild
;
106 /* The window this one is a child of. */
108 /* The upper left corner coordinates of this window,
109 as integers relative to upper left corner of frame = 0, 0 */
112 /* The size of the window */
115 /* The buffer displayed in this window */
116 /* Of the fields vchild, hchild and buffer, only one is non-nil. */
118 /* A marker pointing to where in the text to start displaying */
120 /* A marker pointing to where in the text point is in this window,
121 used only when the window is not selected.
122 This exists so that when multiple windows show one buffer
123 each one can have its own value of point. */
125 /* Non-nil means next redisplay must use the value of start
126 set up for it in advance. Set by scrolling commands. */
127 Lisp_Object force_start
;
128 /* Non-nil means we have explicitly changed the value of start,
129 but that the next redisplay is not obliged to use the new value. */
130 Lisp_Object optional_new_start
;
131 /* Number of columns display within the window is scrolled to the left. */
133 /* Number saying how recently window was selected */
134 Lisp_Object use_time
;
135 /* Unique number of window assigned when it was created */
136 Lisp_Object sequence_number
;
137 /* No permanent meaning; used by save-window-excursion's bookkeeping */
139 /* text.modified of displayed buffer as of last time display completed */
140 Lisp_Object last_modified
;
141 /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update. */
142 Lisp_Object last_overlay_modified
;
143 /* Value of point at that time */
144 Lisp_Object last_point
;
145 /* Non-nil if the buffer was "modified" when the window
147 Lisp_Object last_had_star
;
148 /* This window's vertical scroll bar. This field is only for use
149 by the window-system-dependent code which implements the
150 scroll bars; it can store anything it likes here. If this
151 window is newly created and we haven't displayed a scroll bar in
152 it yet, or if the frame doesn't have any scroll bars, this is nil. */
153 Lisp_Object vertical_scroll_bar
;
155 /* Width of left and right marginal areas. A value of nil means
157 Lisp_Object left_margin_width
;
158 Lisp_Object right_margin_width
;
160 /* The rest are currently not used or only half used */
161 /* Frame coords of mark as of last time display completed */
162 /* May be nil if mark does not exist or was not on frame */
163 Lisp_Object last_mark_x
;
164 Lisp_Object last_mark_y
;
165 /* Z - the buffer position of the last glyph in the current matrix
166 of W. Only valid if WINDOW_END_VALID is not nil. */
167 Lisp_Object window_end_pos
;
168 /* Glyph matrix row of the last glyph in the current matrix
169 of W. Only valid if WINDOW_END_VALID is not nil. */
170 Lisp_Object window_end_vpos
;
171 /* t if window_end_pos is truly valid.
172 This is nil if nontrivial redisplay is preempted
173 since in that case the frame image that window_end_pos
174 did not get onto the frame. */
175 Lisp_Object window_end_valid
;
176 /* Non-nil means must regenerate mode line of this window */
177 Lisp_Object update_mode_line
;
178 /* Non-nil means current value of `start'
179 was the beginning of a line when it was chosen. */
180 Lisp_Object start_at_line_beg
;
181 /* Display-table to use for displaying chars in this window.
182 Nil means use the buffer's own display-table. */
183 Lisp_Object display_table
;
184 /* Non-nil means window is marked as dedicated. */
185 Lisp_Object dedicated
;
186 /* Line number and position of a line somewhere above the
187 top of the screen. */
188 /* If this field is nil, it means we don't have a base line. */
189 Lisp_Object base_line_number
;
190 /* If this field is nil, it means we don't have a base line.
191 If it is a buffer, it means don't display the line number
192 as long as the window shows that buffer. */
193 Lisp_Object base_line_pos
;
194 /* If we have highlighted the region (or any part of it),
195 this is the mark position that we used, as an integer. */
196 Lisp_Object region_showing
;
197 /* The column number currently displayed in this window's mode line,
198 or nil if column numbers are not being displayed. */
199 Lisp_Object column_number_displayed
;
200 /* If redisplay in this window goes beyond this buffer position,
201 must run the redisplay-end-trigger-hook. */
202 Lisp_Object redisplay_end_trigger
;
204 /* No Lisp data may follow below this point without changing
205 mark_object in alloc.c. The member current_matrix must be the
206 first non-Lisp member. */
208 /* Glyph matrices. */
209 struct glyph_matrix
*current_matrix
;
210 struct glyph_matrix
*desired_matrix
;
212 /* Cursor position as of last update that completed without
213 pause. This is the position of last_point. */
214 struct cursor_pos last_cursor
;
216 /* Intended cursor position. This is a position within the
218 struct cursor_pos cursor
;
220 /* Where the cursor actually is. */
221 struct cursor_pos phys_cursor
;
223 /* Cursor type last drawn on the window. Used for X frames; -1
225 int phys_cursor_type
;
227 /* This is handy for undrawing the cursor. */
228 int phys_cursor_ascent
, phys_cursor_height
;
230 /* Non-zero means the cursor is currently displayed. This can be
231 set to zero by functions overpainting the cursor image. */
232 unsigned phys_cursor_on_p
: 1;
234 /* 0 means cursor is logically on, 1 means it's off. Used for
236 unsigned cursor_off_p
: 1;
238 /* Value of cursor_off_p as of the last redisplay. */
239 unsigned last_cursor_off_p
: 1;
241 /* 1 means desired matrix has been build and window must be
242 updated in update_frame. */
243 unsigned must_be_updated_p
: 1;
245 /* Flag indicating that this window is not a real one.
246 Currently only used for menu bar windows of frames. */
247 unsigned pseudo_window_p
: 1;
249 /* Amount by which lines of this window are scrolled in
250 y-direction (smooth scrolling). */
253 /* Z_BYTE - the buffer position of the last glyph in the current matrix
254 of W. Only valid if WINDOW_END_VALID is not nil. */
255 int window_end_bytepos
;
258 /* 1 if W is a minibuffer window. */
260 #define MINI_WINDOW_P(W) (!EQ ((W)->mini_p, Qnil))
262 /* Return the window column at which the text in window W starts.
263 This is different from the `left' field because it does not include
264 a left-hand scroll bar if any. */
266 #define WINDOW_LEFT_MARGIN(W) \
267 (XFASTINT ((W)->left) \
268 + FRAME_LEFT_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME (W))))
270 /* Return the window column before which window W ends.
271 This includes a right-hand scroll bar, if any. */
273 #define WINDOW_RIGHT_EDGE(W) \
274 (XFASTINT ((W)->left) + XFASTINT ((W)->width))
276 /* Return the window column before which the text in window W ends.
277 This is different from WINDOW_RIGHT_EDGE because it does not include
278 a scroll bar or window-separating line on the right edge. */
280 #define WINDOW_RIGHT_MARGIN(W) \
281 (WINDOW_RIGHT_EDGE (W) \
282 - (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (W))) \
283 ? FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (W))) \
286 /* 1 if window W takes up the full width of its frame. */
288 #define WINDOW_FULL_WIDTH_P(W) \
289 (XFASTINT ((W)->width) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W))))
291 /* 1 if window W's has no other windows to its right in its frame. */
293 #define WINDOW_RIGHTMOST_P(W) \
294 (WINDOW_RIGHT_EDGE (W) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W))))
297 /* This is the window in which the terminal's cursor should
298 be left when nothing is being done with it. This must
299 always be a leaf window, and its buffer is selected by
300 the top level editing loop at the end of each command.
302 This value is always the same as
303 FRAME_SELECTED_WINDOW (selected_frame). */
305 extern Lisp_Object selected_window
;
307 /* This is a time stamp for window selection, so we can find the least
308 recently used window. Its only users are Fselect_window,
309 init_window_once, and make_frame. */
311 extern int window_select_count
;
313 /* The minibuffer window of the selected frame.
314 Note that you cannot test for minibufferness of an arbitrary window
315 by comparing against this; use the MINI_WINDOW_P macro instead. */
317 extern Lisp_Object minibuf_window
;
319 /* Non-nil => window to for C-M-v to scroll when the minibuffer is
322 extern Lisp_Object Vminibuf_scroll_window
;
324 /* Nil or a symbol naming the window system under which emacs is
325 running ('x is the only current possibility) */
327 extern Lisp_Object Vwindow_system
;
329 /* Version number of X windows: 10, 11 or nil. */
331 extern Lisp_Object Vwindow_system_version
;
333 /* Window that the mouse is over (nil if no mouse support). */
335 extern Lisp_Object Vmouse_window
;
337 /* Last mouse-click event (nil if no mouse support). */
339 extern Lisp_Object Vmouse_event
;
341 EXFUN (Fnext_window
, 3);
342 EXFUN (Fselect_window
, 1);
343 EXFUN (Fdisplay_buffer
, 3);
344 EXFUN (Fset_window_buffer
, 2);
345 EXFUN (Fset_window_hscroll
, 2);
346 EXFUN (Fwindow_hscroll
, 1);
347 EXFUN (Fset_window_vscroll
, 2);
348 EXFUN (Fwindow_vscroll
, 1);
349 EXFUN (Fset_window_margins
, 3);
350 extern Lisp_Object make_window
P_ ((void));
351 extern void delete_window
P_ ((Lisp_Object
));
352 extern Lisp_Object window_from_coordinates
P_ ((struct frame
*, int, int, int *, int));
353 EXFUN (Fwindow_dedicated_p
, 1);
354 extern int window_height
P_ ((Lisp_Object
));
355 extern int window_width
P_ ((Lisp_Object
));
356 extern void set_window_height
P_ ((Lisp_Object
, int, int));
357 extern void set_window_width
P_ ((Lisp_Object
, int, int));
358 extern void change_window_height
P_ ((int, int));
359 extern void delete_all_subwindows
P_ ((struct window
*));
361 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
362 means it's allowed to run hooks. See make_frame for a case where
365 void set_window_buffer
P_ ((Lisp_Object window
, Lisp_Object buffer
,
368 /* Prompt to display in front of the minibuffer contents. */
370 extern Lisp_Object minibuf_prompt
;
372 /* The visual width of the above. */
374 extern int minibuf_prompt_width
;
376 /* Message to display instead of minibuffer contents. This is what
377 the functions error and message make, and command echoing uses it
378 as well. It overrides the minibuf_prompt as well as the buffer. */
380 extern char *echo_area_glyphs
;
382 /* A Lisp string to display instead of mini-buffer contents, analogous
383 to echo_area_glyphs. If this is a string, display that string.
384 Otherwise, if echo_area_glyphs is non-null, display that. */
386 extern Lisp_Object echo_area_message
;
388 /* This is the length of the message in echo_area_glyphs. */
390 extern int echo_area_glyphs_length
;
392 /* Value of echo_area_glyphs when it was last acted on. If this is
393 nonzero, there is a message on the frame in the minibuffer and it
394 should be erased as soon as it is no longer requested to appear. */
396 extern char *previous_echo_glyphs
;
398 extern Lisp_Object previous_echo_area_message
;
400 /* This is the window where the echo area message was displayed. It
401 is always a minibuffer window, but it may not be the same window
402 currently active as a minibuffer. */
404 extern Lisp_Object echo_area_window
;
406 /* Depth in recursive edits. */
408 extern int command_loop_level
;
410 /* Depth in minibuffer invocations. */
412 extern int minibuf_level
;
414 /* true iff we should redraw the mode lines on the next redisplay. */
416 extern int update_mode_lines
;
418 /* Minimum value of GPT - BEG since last redisplay that finished. */
420 extern int beg_unchanged
;
422 /* Minimum value of Z - GPT since last redisplay that finished. */
424 extern int end_unchanged
;
426 /* MODIFF as of last redisplay that finished; if it matches MODIFF,
427 beg_unchanged and end_unchanged contain no useful information. */
429 extern int unchanged_modified
;
431 /* BUF_OVERLAY_MODIFF of current buffer, as of last redisplay that
432 finished; if it matches BUF_OVERLAY_MODIFF, beg_unchanged and
433 end_unchanged contain no useful information. */
435 extern int overlay_unchanged_modified
;
437 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since
438 last redisplay that finished. */
440 extern int clip_changed
;
442 /* Nonzero if window sizes or contents have changed since last
443 redisplay that finished */
445 extern int windows_or_buffers_changed
;
447 /* Number of windows displaying the selected buffer. Normally this is
448 1, but it can be more. */
450 extern int buffer_shared
;
452 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
453 minimum allowable size. */
455 extern void check_frame_size
P_ ((struct frame
*frame
, int *rows
, int *cols
));
457 /* Return a pointer to the glyph W's physical cursor is on. Value is
458 null if W's current matrix is invalid, so that no meaningfull glyph
461 struct glyph
*get_phys_cursor_glyph
P_ ((struct window
*w
));
463 #endif /* not WINDOW_H_INCLUDED */