annotate src/window.h @ 111107:f3721a6253a8

Fix mouse highlight in bidi-reordered continued lines. xdisp.c (row_containing_pos): Don't return too early when CHARPOS is in a bidi-reordered continued line. Return immediately when the first hit is found in a line that is not continued, or when an exact match for CHARPOS is found. (mouse_face_from_buffer_pos): Rewrite to not assume that START_CHARPOS is always in mouse_face_beg_row. If necessary, swap mouse_face_beg_row and mouse_face_end_row so that the former is always above the latter or identical to it. Continued lines that begin or end outside of the visible region still don't work.

  1 /* Window definitions for GNU Emacs.
  2    Copyright (C) 1985, 1986, 1993, 1995, 1997, 1998, 1999, 2000, 2001,
  3                  2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
  4                  Free Software Foundation, Inc.
  5 
  6 This file is part of GNU Emacs.
  7 
  8 GNU Emacs is free software: you can redistribute it and/or modify
  9 it under the terms of the GNU General Public License as published by
 10 the Free Software Foundation, either version 3 of the License, or
 11 (at your option) any later version.
 12 
 13 GNU Emacs is distributed in the hope that it will be useful,
 14 but WITHOUT ANY WARRANTY; without even the implied warranty of
 15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16 GNU General Public License for more details.
 17 
 18 You should have received a copy of the GNU General Public License
 19 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
 20 
 21 #ifndef WINDOW_H_INCLUDED
 22 #define WINDOW_H_INCLUDED
 23 
 24 #include "dispextern.h"
 25 
 26 extern Lisp_Object Qleft, Qright;
 27 
 28 /* Windows are allocated as if they were vectors, but then the
 29 Lisp data type is changed to Lisp_Window.  They are garbage
 30 collected along with the vectors.
 31 
 32 All windows in use are arranged into a tree, with pointers up and down.
 33 
 34 Windows that are leaves of the tree are actually displayed
 35 and show the contents of buffers.  Windows that are not leaves
 36 are used for representing the way groups of leaf windows are
 37 arranged on the frame.  Leaf windows never become non-leaves.
 38 They are deleted only by calling delete-window on them (but
 39 this can be done implicitly).  Combination windows can be created
 40 and deleted at any time.
 41 
 42 A leaf window has a non-nil buffer field, and also
 43  has markers in its start and pointm fields.  Non-leaf windows
 44  have nil in these fields.
 45 
 46 Non-leaf windows are either vertical or horizontal combinations.
 47 
 48 A vertical combination window has children that are arranged on the frame
 49 one above the next.  Its vchild field points to the uppermost child.
 50 The parent field of each of the children points to the vertical
 51 combination window.  The next field of each child points to the
 52 child below it, or is nil for the lowest child.  The prev field
 53 of each child points to the child above it, or is nil for the
 54 highest child.
 55 
 56 A horizontal combination window has children that are side by side.
 57 Its hchild field points to the leftmost child.  In each child
 58 the next field points to the child to the right and the prev field
 59 points to the child to the left.
 60 
 61 The children of a vertical combination window may be leaf windows
 62 or horizontal combination windows.  The children of a horizontal
 63 combination window may be leaf windows or vertical combination windows.
 64 
 65 At the top of the tree are two windows which have nil as parent.
 66 The second of these is minibuf_window.  The first one manages all
 67 the frame area that is not minibuffer, and is called the root window.
 68 Different windows can be the root at different times;
 69 initially the root window is a leaf window, but if more windows
 70 are created then that leaf window ceases to be root and a newly
 71 made combination window becomes root instead.
 72 
 73 In any case, on screens which have an ordinary window and a
 74 minibuffer, prev of the minibuf window is the root window and next of
 75 the root window is the minibuf window.  On minibufferless screens or
 76 minibuffer-only screens, the root window and the minibuffer window are
 77 one and the same, so its prev and next members are nil.
 78 
 79 A dead window has its buffer, hchild, and vchild windows all nil.  */
 80 
 81 struct cursor_pos
 82 {
 83   /* Pixel position.  These are always window relative.  */
 84   int x, y;
 85 
 86   /* Glyph matrix position.  */
 87   int hpos, vpos;
 88 };
 89 
 90 struct window
 91   {
 92     /* The first two fields are really the header of a vector */
 93     /* The window code does not refer to them.  */
 94     EMACS_UINT size;
 95     struct Lisp_Vector *vec_next;
 96     /* The frame this window is on.  */
 97     Lisp_Object frame;
 98     /* t if this window is a minibuffer window.  */
 99     Lisp_Object mini_p;
100     /* Following child (to right or down) at same level of tree */
101     Lisp_Object next;
102     /* Preceding child (to left or up) at same level of tree */
103     Lisp_Object prev;
104     /* First child of this window. */
105     /* vchild is used if this is a vertical combination,
106        hchild if this is a horizontal combination. */
107     Lisp_Object hchild, vchild;
108     /* The window this one is a child of. */
109     Lisp_Object parent;
110     /* The upper left corner coordinates of this window,
111        as integers relative to upper left corner of frame = 0, 0 */
112     Lisp_Object left_col;
113     Lisp_Object top_line;
114     /* The size of the window */
115     Lisp_Object total_lines;
116     Lisp_Object total_cols;
117     /* The buffer displayed in this window */
118     /* Of the fields vchild, hchild and buffer, only one is non-nil.  */
119     Lisp_Object buffer;
120     /* A marker pointing to where in the text to start displaying.
121        BIDI Note: This is the _logical-order_ start, i.e. the smallest
122        buffer position visible in the window, not necessarily the
123        character displayed in the top left corner of the window.  */
124     Lisp_Object start;
125     /* A marker pointing to where in the text point is in this window,
126        used only when the window is not selected.
127        This exists so that when multiple windows show one buffer
128        each one can have its own value of point.  */
129     Lisp_Object pointm;
130     /* Non-nil means next redisplay must use the value of start
131        set up for it in advance.  Set by scrolling commands.  */
132     Lisp_Object force_start;
133     /* Non-nil means we have explicitly changed the value of start,
134        but that the next redisplay is not obliged to use the new value.
135        This is used in Fdelete_other_windows to force a call to
136        Vwindow_scroll_functions; also by Frecenter with argument.  */
137     Lisp_Object optional_new_start;
138     /* Number of columns display within the window is scrolled to the left.  */
139     Lisp_Object hscroll;
140     /* Minimum hscroll for automatic hscrolling.  This is the value
141        the user has set, by set-window-hscroll for example.  */
142     Lisp_Object min_hscroll;
143     /* Number saying how recently window was selected */
144     Lisp_Object use_time;
145     /* Unique number of window assigned when it was created */
146     Lisp_Object sequence_number;
147     /* No permanent meaning; used by save-window-excursion's bookkeeping */
148     Lisp_Object temslot;
149     /* text.modified of displayed buffer as of last time display completed */
150     Lisp_Object last_modified;
151     /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update.  */
152     Lisp_Object last_overlay_modified;
153     /* Value of point at that time */
154     Lisp_Object last_point;
155     /* Non-nil if the buffer was "modified" when the window
156        was last updated.  */
157     Lisp_Object last_had_star;
158     /* This window's vertical scroll bar.  This field is only for use
159        by the window-system-dependent code which implements the
160        scroll bars; it can store anything it likes here.  If this
161        window is newly created and we haven't displayed a scroll bar in
162        it yet, or if the frame doesn't have any scroll bars, this is nil.  */
163     Lisp_Object vertical_scroll_bar;
164 
165     /* Width of left and right marginal areas.  A value of nil means
166        no margin.  */
167     Lisp_Object left_margin_cols, right_margin_cols;
168 
169     /* Width of left and right fringes.
170        A value of nil or t means use frame values.  */
171     Lisp_Object left_fringe_width, right_fringe_width;
172 
173   /* Non-nil means fringes are drawn outside display margins;
174      othersize draw them between margin areas and text.  */
175     Lisp_Object fringes_outside_margins;
176 
177     /* Pixel width of scroll bars.
178        A value of nil or t means use frame values.  */
179     Lisp_Object scroll_bar_width;
180     /* Type of vertical scroll bar.  A value of nil means
181        no scroll bar.  A value of t means use frame value.  */
182     Lisp_Object vertical_scroll_bar_type;
183 
184     /* Frame coords of mark as of last time display completed */
185     /* May be nil if mark does not exist or was not on frame */
186     Lisp_Object last_mark_x;
187     Lisp_Object last_mark_y;
188     /* Z - the buffer position of the last glyph in the current matrix
189        of W.  Only valid if WINDOW_END_VALID is not nil.  */
190     Lisp_Object window_end_pos;
191     /* Glyph matrix row of the last glyph in the current matrix
192        of W.  Only valid if WINDOW_END_VALID is not nil.  */
193     Lisp_Object window_end_vpos;
194     /* t if window_end_pos is truly valid.
195        This is nil if nontrivial redisplay is preempted
196        since in that case the frame image that window_end_pos
197        did not get onto the frame.  */
198     Lisp_Object window_end_valid;
199     /* Non-nil means must regenerate mode line of this window */
200     Lisp_Object update_mode_line;
201     /* Non-nil means current value of `start'
202        was the beginning of a line when it was chosen.  */
203     Lisp_Object start_at_line_beg;
204     /* Display-table to use for displaying chars in this window.
205        Nil means use the buffer's own display-table.  */
206     Lisp_Object display_table;
207     /* Non-nil means window is marked as dedicated.  */
208     Lisp_Object dedicated;
209     /* Line number and position of a line somewhere above the
210        top of the screen.  */
211     /* If this field is nil, it means we don't have a base line.  */
212     Lisp_Object base_line_number;
213     /* If this field is nil, it means we don't have a base line.
214        If it is a buffer, it means don't display the line number
215        as long as the window shows that buffer.  */
216     Lisp_Object base_line_pos;
217     /* If we have highlighted the region (or any part of it),
218        this is the mark position that we used, as an integer.  */
219     Lisp_Object region_showing;
220     /* The column number currently displayed in this window's mode line,
221        or nil if column numbers are not being displayed.  */
222     Lisp_Object column_number_displayed;
223     /* If redisplay in this window goes beyond this buffer position,
224        must run the redisplay-end-trigger-hook.  */
225     Lisp_Object redisplay_end_trigger;
226     /* Non-nil means resizing windows will attempt to resize this window
227        proportionally.  */
228     Lisp_Object resize_proportionally;
229 
230     /* Original window height and top before mini-window was enlarged. */
231     Lisp_Object orig_total_lines, orig_top_line;
232 
233     /* An alist with parameteres.  */
234     Lisp_Object window_parameters;
235 
236     /* No Lisp data may follow below this point without changing
237        mark_object in alloc.c.  The member current_matrix must be the
238        first non-Lisp member.  */
239 
240     /* Glyph matrices.  */
241     struct glyph_matrix *current_matrix;
242     struct glyph_matrix *desired_matrix;
243 
244     /* Scaling factor for the glyph_matrix size calculation in this window.
245        Used if window contains many small images or uses proportional fonts,
246        as the normal  may yield a matrix which is too small.  */
247     int nrows_scale_factor, ncols_scale_factor;
248 
249     /* Cursor position as of last update that completed without
250        pause.  This is the position of last_point.  */
251     struct cursor_pos last_cursor;
252 
253     /* Intended cursor position.   This is a position within the
254        glyph matrix.  */
255     struct cursor_pos cursor;
256 
257     /* Where the cursor actually is.  */
258     struct cursor_pos phys_cursor;
259 
260     /* Cursor type and width of last cursor drawn on the window.
261        Used for X and w32 frames; -1 initially.  */
262     int phys_cursor_type, phys_cursor_width;
263 
264     /* This is handy for undrawing the cursor.  */
265     int phys_cursor_ascent, phys_cursor_height;
266 
267     /* Non-zero means the cursor is currently displayed.  This can be
268        set to zero by functions overpainting the cursor image.  */
269     unsigned phys_cursor_on_p : 1;
270 
271     /* 0 means cursor is logically on, 1 means it's off.  Used for
272        blinking cursor.  */
273     unsigned cursor_off_p : 1;
274 
275     /* Value of cursor_off_p as of the last redisplay.  */
276     unsigned last_cursor_off_p : 1;
277 
278     /* 1 means desired matrix has been build and window must be
279        updated in update_frame.  */
280     unsigned must_be_updated_p : 1;
281 
282     /* Flag indicating that this window is not a real one.
283        Currently only used for menu bar windows of frames.  */
284     unsigned pseudo_window_p : 1;
285 
286     /* 1 means the window start of this window is frozen and may not
287        be changed during redisplay.  If point is not in the window,
288        accept that.  */
289     unsigned frozen_window_start_p : 1;
290 
291     /* Amount by which lines of this window are scrolled in
292        y-direction (smooth scrolling).  */
293     int vscroll;
294 
295     /* Z_BYTE - the buffer position of the last glyph in the current matrix
296        of W.  Only valid if WINDOW_END_VALID is not nil.  */
297     int window_end_bytepos;
298 };
299 
300 /* 1 if W is a minibuffer window.  */
301 
302 #define MINI_WINDOW_P(W)	(!NILP ((W)->mini_p))
303 
304 /* General window layout:
305 
306    LEFT_EDGE_COL         RIGHT_EDGE_COL
307    |                                  |
308    |                                  |
309    |  BOX_LEFT_EDGE_COL               |
310    |  |           BOX_RIGHT_EDGE_COL  |
311    |  |                            |  |
312    v  v                            v  v
313    <-><-><---><-----------><---><-><->
314     ^  ^   ^        ^        ^   ^  ^
315     |  |   |        |        |   |  |
316     |  |   |        |        |   |  +-- RIGHT_SCROLL_BAR_COLS
317     |  |   |        |        |   +----- RIGHT_FRINGE_WIDTH
318     |  |   |        |        +--------- RIGHT_MARGIN_COLS
319     |  |   |        |
320     |  |   |        +------------------ TEXT_AREA_COLS
321     |  |   |
322     |  |   +--------------------------- LEFT_MARGIN_COLS
323     |  +------------------------------- LEFT_FRINGE_WIDTH
324     +---------------------------------- LEFT_SCROLL_BAR_COLS
325 
326 */
327 
328 
329 /* A handy macro.  */
330 
331 #define WINDOW_XFRAME(W) \
332   (XFRAME (WINDOW_FRAME ((W))))
333 
334 /* Return the canonical column width of the frame of window W.  */
335 
336 #define WINDOW_FRAME_COLUMN_WIDTH(W) \
337   (FRAME_COLUMN_WIDTH (WINDOW_XFRAME ((W))))
338 
339 /* Return the canonical column width of the frame of window W.  */
340 
341 #define WINDOW_FRAME_LINE_HEIGHT(W) \
342   (FRAME_LINE_HEIGHT (WINDOW_XFRAME ((W))))
343 
344 /* Return the width of window W in canonical column units.
345    This includes scroll bars and fringes.  */
346 
347 #define WINDOW_TOTAL_COLS(W) \
348   (XFASTINT ((W)->total_cols))
349 
350 /* Return the height of window W in canonical line units.
351    This includes header and mode lines, if any.  */
352 
353 #define WINDOW_TOTAL_LINES(W) \
354   (XFASTINT ((W)->total_lines))
355 
356 /* Return the total pixel width of window W.  */
357 
358 #define WINDOW_TOTAL_WIDTH(W) \
359   (WINDOW_TOTAL_COLS (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
360 
361 /* Return the total pixel height of window W.  */
362 
363 #define WINDOW_TOTAL_HEIGHT(W) \
364   (WINDOW_TOTAL_LINES (W) * WINDOW_FRAME_LINE_HEIGHT (W))
365 
366 
367 /* Return the canonical frame column at which window W starts.
368    This includes a left-hand scroll bar, if any.  */
369 
370 #define WINDOW_LEFT_EDGE_COL(W) \
371   (XFASTINT ((W)->left_col))
372 
373 /* Return the canonical frame column before which window W ends.
374    This includes a right-hand scroll bar, if any.  */
375 
376 #define WINDOW_RIGHT_EDGE_COL(W) \
377   (WINDOW_LEFT_EDGE_COL (W) + WINDOW_TOTAL_COLS (W))
378 
379 /* Return the canonical frame line at which window W starts.
380    This includes a header line, if any.  */
381 
382 #define WINDOW_TOP_EDGE_LINE(W) \
383   (XFASTINT ((W)->top_line))
384 
385 /* Return the canonical frame line before which window W ends.
386    This includes a mode line, if any.  */
387 
388 #define WINDOW_BOTTOM_EDGE_LINE(W) \
389   (WINDOW_TOP_EDGE_LINE (W) + WINDOW_TOTAL_LINES (W))
390 
391 
392 /* Return the frame x-position at which window W starts.
393    This includes a left-hand scroll bar, if any.  */
394 
395 #define WINDOW_LEFT_EDGE_X(W) \
396   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
397    + WINDOW_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
398 
399 /* Return the frame x- position before which window W ends.
400    This includes a right-hand scroll bar, if any.  */
401 
402 #define WINDOW_RIGHT_EDGE_X(W) \
403   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
404    + WINDOW_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
405 
406 /* 1 if W is a menu bar window.  */
407 
408 #define WINDOW_MENU_BAR_P(W) \
409   (WINDOWP (WINDOW_XFRAME (W)->menu_bar_window) \
410    && (W) == XWINDOW (WINDOW_XFRAME (W)->menu_bar_window))
411 
412 /* 1 if W is a tool bar window.  */
413 
414 #define WINDOW_TOOL_BAR_P(W) \
415   (WINDOWP (WINDOW_XFRAME (W)->tool_bar_window) \
416    && (W) == XWINDOW (WINDOW_XFRAME (W)->tool_bar_window))
417 
418 /* Return the frame y-position at which window W starts.
419    This includes a header line, if any.  */
420 
421 #define WINDOW_TOP_EDGE_Y(W) \
422   (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
423     ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
424    + WINDOW_TOP_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
425 
426 /* Return the frame y-position before which window W ends.
427    This includes a mode line, if any.  */
428 
429 #define WINDOW_BOTTOM_EDGE_Y(W) \
430   (((WINDOW_MENU_BAR_P (W) || WINDOW_TOOL_BAR_P (W)) \
431     ? 0 : FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W))) \
432    + WINDOW_BOTTOM_EDGE_LINE (W) * WINDOW_FRAME_LINE_HEIGHT (W))
433 
434 
435 /* 1 if window W takes up the full width of its frame.  */
436 
437 #define WINDOW_FULL_WIDTH_P(W) \
438   (WINDOW_TOTAL_COLS (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
439 
440 /* 1 if window W's has no other windows to its left in its frame.  */
441 
442 #define WINDOW_LEFTMOST_P(W) \
443   (WINDOW_LEFT_EDGE_COL (W) == 0)
444 
445 /* 1 if window W's has no other windows to its right in its frame.  */
446 
447 #define WINDOW_RIGHTMOST_P(W) \
448   (WINDOW_RIGHT_EDGE_COL (W) == FRAME_TOTAL_COLS (WINDOW_XFRAME (W)))
449 
450 
451 /* Return the frame column at which the text (or left fringe) in
452    window W starts.  This is different from the `LEFT_EDGE' because it
453    does not include a left-hand scroll bar if any.  */
454 
455 #define WINDOW_BOX_LEFT_EDGE_COL(W) \
456   (WINDOW_LEFT_EDGE_COL (W) \
457    + WINDOW_LEFT_SCROLL_BAR_COLS (W))
458 
459 /* Return the window column before which the text in window W ends.
460    This is different from WINDOW_RIGHT_EDGE_COL because it does not
461    include a scroll bar or window-separating line on the right edge.  */
462 
463 #define WINDOW_BOX_RIGHT_EDGE_COL(W) \
464   (WINDOW_RIGHT_EDGE_COL (W) \
465    - WINDOW_RIGHT_SCROLL_BAR_COLS (W))
466 
467 
468 /* Return the frame position at which the text (or left fringe) in
469    window W starts.  This is different from the `LEFT_EDGE' because it
470    does not include a left-hand scroll bar if any.  */
471 
472 #define WINDOW_BOX_LEFT_EDGE_X(W) \
473   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
474    + WINDOW_BOX_LEFT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
475 
476 /* Return the window column before which the text in window W ends.
477    This is different from WINDOW_RIGHT_EDGE_COL because it does not
478    include a scroll bar or window-separating line on the right edge.  */
479 
480 #define WINDOW_BOX_RIGHT_EDGE_X(W) \
481   (FRAME_INTERNAL_BORDER_WIDTH (WINDOW_XFRAME (W)) \
482    + WINDOW_BOX_RIGHT_EDGE_COL (W) * WINDOW_FRAME_COLUMN_WIDTH (W))
483 
484 
485 /* Width of left margin area in columns.  */
486 
487 #define WINDOW_LEFT_MARGIN_COLS(W)			\
488   (NILP ((W)->left_margin_cols)				\
489    ? 0							\
490    : XINT ((W)->left_margin_cols))
491 
492 /* Width of right marginal area in columns.  */
493 
494 #define WINDOW_RIGHT_MARGIN_COLS(W)			\
495   (NILP ((W)->right_margin_cols)			\
496    ? 0							\
497    : XINT ((W)->right_margin_cols))
498 
499 /* Width of left margin area in pixels.  */
500 
501 #define WINDOW_LEFT_MARGIN_WIDTH(W)			\
502   (NILP ((W)->left_margin_cols)				\
503    ? 0							\
504    : (XINT ((W)->left_margin_cols)			\
505       * WINDOW_FRAME_COLUMN_WIDTH (W)))
506 
507 /* Width of right marginal area in pixels.  */
508 
509 #define WINDOW_RIGHT_MARGIN_WIDTH(W)			\
510   (NILP ((W)->right_margin_cols)			\
511    ? 0							\
512    : (XINT ((W)->right_margin_cols)			\
513       * WINDOW_FRAME_COLUMN_WIDTH (W)))
514 
515 /* Total width of fringes reserved for drawing truncation bitmaps,
516    continuation bitmaps and alike.  The width is in canonical char
517    units of the frame.  This must currently be the case because window
518    sizes aren't pixel values.  If it weren't the case, we wouldn't be
519    able to split windows horizontally nicely.  */
520 
521 #define WINDOW_FRINGE_COLS(W)				\
522   ((INTEGERP ((W)->left_fringe_width)			\
523     || INTEGERP ((W)->right_fringe_width))		\
524    ? ((WINDOW_LEFT_FRINGE_WIDTH (W)			\
525        + WINDOW_RIGHT_FRINGE_WIDTH (W)			\
526        + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
527       / WINDOW_FRAME_COLUMN_WIDTH (W))			\
528    : FRAME_FRINGE_COLS (WINDOW_XFRAME (W)))
529 
530 /* Column-width of the left and right fringe.  */
531 
532 #define WINDOW_LEFT_FRINGE_COLS(W)			\
533   ((WINDOW_LEFT_FRINGE_WIDTH ((W))			\
534     + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
535    / WINDOW_FRAME_COLUMN_WIDTH (W))
536 
537 #define WINDOW_RIGHT_FRINGE_COLS(W)			\
538   ((WINDOW_RIGHT_FRINGE_WIDTH ((W))			\
539     + WINDOW_FRAME_COLUMN_WIDTH (W) - 1)		\
540    / WINDOW_FRAME_COLUMN_WIDTH (W))
541 
542 /* Pixel-width of the left and right fringe.  */
543 
544 #define WINDOW_LEFT_FRINGE_WIDTH(W)			\
545   (INTEGERP ((W)->left_fringe_width)			\
546    ? XFASTINT ((W)->left_fringe_width)			\
547    : FRAME_LEFT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
548 
549 #define WINDOW_RIGHT_FRINGE_WIDTH(W)			\
550   (INTEGERP ((W)->right_fringe_width)			\
551    ? XFASTINT ((W)->right_fringe_width)			\
552    : FRAME_RIGHT_FRINGE_WIDTH (WINDOW_XFRAME (W)))
553 
554 /* Total width of fringes in pixels.  */
555 
556 #define WINDOW_TOTAL_FRINGE_WIDTH(W)		\
557   (WINDOW_LEFT_FRINGE_WIDTH (W) + WINDOW_RIGHT_FRINGE_WIDTH (W))
558 
559 /* Are fringes outside display margins in window W.  */
560 
561 #define WINDOW_HAS_FRINGES_OUTSIDE_MARGINS(W)	\
562   (!NILP ((W)->fringes_outside_margins))
563 
564 /* Say whether scroll bars are currently enabled for window W,
565    and which side they are on.  */
566 
567 #define WINDOW_VERTICAL_SCROLL_BAR_TYPE(w)		\
568   (EQ ((w)->vertical_scroll_bar_type, Qt)		\
569    ? FRAME_VERTICAL_SCROLL_BAR_TYPE (WINDOW_XFRAME (w))	\
570    : EQ ((w)->vertical_scroll_bar_type, Qleft)		\
571    ? vertical_scroll_bar_left				\
572    : EQ ((w)->vertical_scroll_bar_type, Qright)		\
573    ? vertical_scroll_bar_right				\
574    : vertical_scroll_bar_none)				\
575 
576 #define WINDOW_HAS_VERTICAL_SCROLL_BAR(w)		\
577   (EQ ((w)->vertical_scroll_bar_type, Qt)		\
578    ? FRAME_HAS_VERTICAL_SCROLL_BARS (WINDOW_XFRAME (w))	\
579    : !NILP ((w)->vertical_scroll_bar_type))
580 
581 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT(w)		\
582   (EQ ((w)->vertical_scroll_bar_type, Qt)			\
583    ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (WINDOW_XFRAME (w))	\
584    : EQ ((w)->vertical_scroll_bar_type, Qleft))
585 
586 #define WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT(w)		\
587   (EQ ((w)->vertical_scroll_bar_type, Qt)			\
588    ? FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (WINDOW_XFRAME (w))\
589    : EQ ((w)->vertical_scroll_bar_type, Qright))
590 
591 /* Width that a scroll bar in window W should have, if there is one.
592    Measured in pixels.  If scroll bars are turned off, this is still
593    nonzero.  */
594 
595 #define WINDOW_CONFIG_SCROLL_BAR_WIDTH(w)		\
596   (INTEGERP ((w)->scroll_bar_width)			\
597    ? XFASTINT ((w)->scroll_bar_width)			\
598    : FRAME_CONFIG_SCROLL_BAR_WIDTH (WINDOW_XFRAME (w)))
599 
600 /* Width that a scroll bar in window W should have, if there is one.
601    Measured in columns (characters).  If scroll bars are turned off,
602    this is still nonzero.  */
603 
604 #define WINDOW_CONFIG_SCROLL_BAR_COLS(w)		\
605   (INTEGERP ((w)->scroll_bar_width)			\
606    ? ((XFASTINT ((w)->scroll_bar_width)			\
607        + WINDOW_FRAME_COLUMN_WIDTH (w) - 1)		\
608       / WINDOW_FRAME_COLUMN_WIDTH (w))			\
609    : FRAME_CONFIG_SCROLL_BAR_COLS (WINDOW_XFRAME (w)))
610 
611 /* Width of a scroll bar in window W, measured in columns (characters),
612    but only if scroll bars are on the left.  If scroll bars are on
613    the right in this frame, or there are no scroll bars, value is 0.  */
614 
615 #define WINDOW_LEFT_SCROLL_BAR_COLS(w)	       \
616   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
617    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w))       \
618    : 0)
619 
620 /* Width of a left scroll bar area in window W , measured in pixels.  */
621 
622 #define WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH(w) \
623   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) \
624    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
625    : 0)
626 
627 /* Width of a scroll bar in window W, measured in columns (characters),
628    but only if scroll bars are on the right.  If scroll bars are on
629    the left in this frame, or there are no scroll bars, value is 0.  */
630 
631 #define WINDOW_RIGHT_SCROLL_BAR_COLS(w)		\
632   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w) \
633    ? WINDOW_CONFIG_SCROLL_BAR_COLS (w)		\
634    : 0)
635 
636 /* Width of a left scroll bar area in window W , measured in pixels.  */
637 
638 #define WINDOW_RIGHT_SCROLL_BAR_AREA_WIDTH(w)				 \
639   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)				 \
640    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
641    : 0)
642 
643 
644 /* Actual width of a scroll bar in window W, measured in columns.  */
645 
646 #define WINDOW_SCROLL_BAR_COLS(w)	       \
647   (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)	       \
648    ? WINDOW_CONFIG_SCROLL_BAR_COLS (w)	       \
649    : 0)
650 
651 /* Width of a left scroll bar area in window W , measured in pixels.  */
652 
653 #define WINDOW_SCROLL_BAR_AREA_WIDTH(w)					 \
654   (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)					\
655    ? (WINDOW_CONFIG_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)) \
656    : 0)
657 
658 
659 /* Return the frame position where the scroll bar of window W starts.  */
660 
661 #define WINDOW_SCROLL_BAR_AREA_X(W)		\
662   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (W)	\
663    ? WINDOW_BOX_RIGHT_EDGE_X (W)		\
664    : WINDOW_LEFT_EDGE_X (W))
665 
666 
667 /* Height in pixels, and in lines, of the mode line.
668    May be zero if W doesn't have a mode line.  */
669 
670 #define WINDOW_MODE_LINE_HEIGHT(W)	\
671   (WINDOW_WANTS_MODELINE_P ((W))	\
672    ? CURRENT_MODE_LINE_HEIGHT (W)	\
673    : 0)
674 
675 #define WINDOW_MODE_LINE_LINES(W)		\
676   (!! WINDOW_WANTS_MODELINE_P ((W)))
677 
678 /* Height in pixels, and in lines, of the header line.
679    Zero if W doesn't have a header line.  */
680 
681 #define WINDOW_HEADER_LINE_HEIGHT(W)	\
682   (WINDOW_WANTS_HEADER_LINE_P ((W))	\
683    ? CURRENT_HEADER_LINE_HEIGHT (W)	\
684    : 0)
685 
686 #define WINDOW_HEADER_LINE_LINES(W)		\
687   (!! WINDOW_WANTS_HEADER_LINE_P ((W)))
688 
689 /* Pixel height of window W without mode line.  */
690 
691 #define WINDOW_BOX_HEIGHT_NO_MODE_LINE(W)	\
692   (WINDOW_TOTAL_HEIGHT ((W))			\
693    - WINDOW_MODE_LINE_HEIGHT ((W)))
694 
695 /* Pixel height of window W without mode and header line.  */
696 
697 #define WINDOW_BOX_TEXT_HEIGHT(W)		\
698   (WINDOW_TOTAL_HEIGHT ((W))			\
699    - WINDOW_MODE_LINE_HEIGHT ((W))		\
700    - WINDOW_HEADER_LINE_HEIGHT ((W)))
701 
702 
703 /* Convert window W relative pixel X to frame pixel coordinates.  */
704 
705 #define WINDOW_TO_FRAME_PIXEL_X(W, X)		\
706   ((X) + WINDOW_BOX_LEFT_EDGE_X ((W)))
707 
708 /* Convert window W relative pixel Y to frame pixel coordinates.  */
709 
710 #define WINDOW_TO_FRAME_PIXEL_Y(W, Y)		\
711   ((Y) + WINDOW_TOP_EDGE_Y ((W)))
712 
713 /* Convert frame relative pixel X to window relative pixel X.  */
714 
715 #define FRAME_TO_WINDOW_PIXEL_X(W, X)		\
716   ((X) - WINDOW_BOX_LEFT_EDGE_X ((W)))
717 
718 /* Convert frame relative pixel Y to window relative pixel Y.  */
719 
720 #define FRAME_TO_WINDOW_PIXEL_Y(W, Y)		\
721   ((Y) - WINDOW_TOP_EDGE_Y ((W)))
722 
723 /* Convert a text area relative x-position in window W to frame X
724    pixel coordinates.  */
725 
726 #define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)		\
727   (window_box_left ((W), TEXT_AREA) + (X))
728 
729 /* This is the window in which the terminal's cursor should
730    be left when nothing is being done with it.  This must
731    always be a leaf window, and its buffer is selected by
732    the top level editing loop at the end of each command.
733 
734    This value is always the same as
735     FRAME_SELECTED_WINDOW (selected_frame).  */
736 
737 extern Lisp_Object selected_window;
738 
739 /* This is a time stamp for window selection, so we can find the least
740    recently used window.  Its only users are Fselect_window,
741    init_window_once, and make_frame.  */
742 
743 extern int window_select_count;
744 
745 /* The minibuffer window of the selected frame.
746    Note that you cannot test for minibufferness of an arbitrary window
747    by comparing against this; use the MINI_WINDOW_P macro instead.  */
748 
749 extern Lisp_Object minibuf_window;
750 
751 /* Non-nil means it is the window whose mode line should be
752    shown as the selected window when the minibuffer is selected.  */
753 
754 extern Lisp_Object minibuf_selected_window;
755 
756 /* Non-nil => window to for C-M-v to scroll when the minibuffer is
757    selected.  */
758 
759 extern Lisp_Object Vminibuf_scroll_window;
760 
761 /* Nil or a symbol naming the window system under which emacs is
762    running ('x is the only current possibility) */
763 
764 extern Lisp_Object Vinitial_window_system;
765 
766 /* Version number of X windows: 10, 11 or nil.  */
767 
768 extern Lisp_Object Vwindow_system_version;
769 
770 /* Window that the mouse is over (nil if no mouse support).  */
771 
772 extern Lisp_Object Vmouse_window;
773 
774 /* Last mouse-click event (nil if no mouse support).  */
775 
776 extern Lisp_Object Vmouse_event;
777 
778 EXFUN (Fnext_window, 3);
779 EXFUN (Fselect_window, 2);
780 EXFUN (Fset_window_buffer, 3);
781 EXFUN (Fset_window_hscroll, 2);
782 EXFUN (Fwindow_hscroll, 1);
783 EXFUN (Fset_window_vscroll, 3);
784 EXFUN (Fwindow_vscroll, 2);
785 EXFUN (Fset_window_margins, 3);
786 EXFUN (Fwindow_live_p, 1);
787 EXFUN (Fset_window_point, 2);
788 extern Lisp_Object make_window (void);
789 extern void delete_window (Lisp_Object);
790 extern Lisp_Object window_from_coordinates (struct frame *, int, int,
791                                             enum window_part *,
792                                             int *, int*, int);
793 EXFUN (Fwindow_dedicated_p, 1);
794 extern int window_height (Lisp_Object);
795 extern int window_width (Lisp_Object);
796 EXFUN (Fwindow_full_width_p, 1);
797 extern void set_window_height (Lisp_Object, int, int);
798 extern void set_window_width (Lisp_Object, int, int);
799 extern void change_window_heights (Lisp_Object, int);
800 extern void delete_all_subwindows (struct window *);
801 extern void freeze_window_starts (struct frame *, int);
802 extern void foreach_window (struct frame *,
803                             int (* fn) (struct window *, void *),
804                             void *);
805 extern void grow_mini_window (struct window *, int);
806 extern void shrink_mini_window (struct window *);
807 
808 void run_window_configuration_change_hook (struct frame *f);
809 
810 /* Make WINDOW display BUFFER as its contents.  RUN_HOOKS_P non-zero
811    means it's allowed to run hooks.  See make_frame for a case where
812    it's not allowed.  */
813 
814 void set_window_buffer (Lisp_Object window, Lisp_Object buffer,
815                         int run_hooks_p, int keep_margins_p);
816 
817 /* Prompt to display in front of the minibuffer contents.  */
818 
819 extern Lisp_Object minibuf_prompt;
820 
821 /* The visual width of the above.  */
822 
823 extern int minibuf_prompt_width;
824 
825 /* This is the window where the echo area message was displayed.  It
826    is always a minibuffer window, but it may not be the same window
827    currently active as a minibuffer.  */
828 
829 extern Lisp_Object echo_area_window;
830 
831 /* Depth in recursive edits.  */
832 
833 extern int command_loop_level;
834 
835 /* Depth in minibuffer invocations.  */
836 
837 extern int minibuf_level;
838 
839 /* true if we should redraw the mode lines on the next redisplay.  */
840 
841 extern int update_mode_lines;
842 
843 /* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since
844    last redisplay that finished.  */
845 
846 extern int clip_changed;
847 
848 /* Nonzero if window sizes or contents have changed since last
849    redisplay that finished */
850 
851 extern int windows_or_buffers_changed;
852 
853 /* Nonzero means a frame's cursor type has been changed.  */
854 
855 extern int cursor_type_changed;
856 
857 /* Number of windows displaying the selected buffer.  Normally this is
858    1, but it can be more.  */
859 
860 extern int buffer_shared;
861 
862 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
863    minimum allowable size.  */
864 
865 extern void check_frame_size (struct frame *frame, int *rows, int *cols);
866 
867 /* Return a pointer to the glyph W's physical cursor is on.  Value is
868    null if W's current matrix is invalid, so that no meaningfull glyph
869    can be returned.  */
870 
871 struct glyph *get_phys_cursor_glyph (struct window *w);
872 
873 /* Value is non-zero if WINDOW is a live window.  */
874 
875 #define WINDOW_LIVE_P(WINDOW) \
876      (WINDOWP ((WINDOW)) && !NILP (XWINDOW ((WINDOW))->buffer))
877 
878 
879 /* These used to be in lisp.h.  */
880 
881 extern Lisp_Object Qwindowp, Qwindow_live_p;
882 extern Lisp_Object Vwindow_list;
883 
884 EXFUN (Fwindow_end, 2);
885 EXFUN (Fselected_window, 0);
886 EXFUN (Fwindow_minibuffer_p, 1);
887 EXFUN (Fdelete_window, 1);
888 EXFUN (Fwindow_buffer, 1);
889 EXFUN (Fget_buffer_window, 2);
890 EXFUN (Fsave_window_excursion, UNEVALLED);
891 EXFUN (Fsplit_window, 3);
892 EXFUN (Fset_window_configuration, 1);
893 EXFUN (Fcurrent_window_configuration, 1);
894 extern int compare_window_configurations (Lisp_Object, Lisp_Object, int);
895 EXFUN (Fcoordinates_in_window_p, 2);
896 EXFUN (Fwindow_at, 3);
897 EXFUN (Fpos_visible_in_window_p, 3);
898 extern void mark_window_cursors_off (struct window *);
899 extern int window_internal_height (struct window *);
900 extern int window_internal_width (struct window *);
901 EXFUN (Frecenter, 1);
902 EXFUN (Fscroll_other_window, 1);
903 EXFUN (Fset_window_start, 3);
904 extern void temp_output_buffer_show (Lisp_Object);
905 extern void replace_buffer_in_all_windows (Lisp_Object);
906 extern void init_window_once (void);
907 extern void init_window (void);
908 extern void syms_of_window (void);
909 extern void keys_of_window (void);
910 
911 extern int window_box_text_cols (struct window *w);
912 
913 #endif /* not WINDOW_H_INCLUDED */
914 
915 /* arch-tag: d4a6942f-e433-4ffe-ac10-2c3574f28577
916    (do not change this comment) */