window.h 16.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Window definitions for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1993, 1995 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

Gerd Moellmann's avatar
Gerd Moellmann committed
21 22 23 24
#ifndef WINDOW_H_INCLUDED
#define WINDOW_H_INCLUDED

#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30 31 32 33 34

/* Windows are allocated as if they were vectors, but then the
Lisp data type is changed to Lisp_Window.  They are garbage
collected along with the vectors.

All windows in use are arranged into a tree, with pointers up and down.

Windows that are leaves of the tree are actually displayed
and show the contents of buffers.  Windows that are not leaves
are used for representing the way groups of leaf windows are
Jim Blandy's avatar
Jim Blandy committed
35
arranged on the frame.  Leaf windows never become non-leaves.
Jim Blandy's avatar
Jim Blandy committed
36 37 38 39 40 41 42 43 44 45
They are deleted only by calling delete-window on them (but
this can be done implicitly).  Combination windows can be created
and deleted at any time.

A leaf window has a non-nil buffer field, and also
 has markers in its start and pointm fields.  Non-leaf windows
 have nil in these fields.

Non-leaf windows are either vertical or horizontal combinations.

Jim Blandy's avatar
Jim Blandy committed
46
A vertical combination window has children that are arranged on the frame
Jim Blandy's avatar
Jim Blandy committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
one above the next.  Its vchild field points to the uppermost child.
The parent field of each of the children points to the vertical
combination window.  The next field of each child points to the
child below it, or is nil for the lowest child.  The prev field
of each child points to the child above it, or is nil for the
highest child.

A horizontal combination window has children that are side by side.
Its hchild field points to the leftmost child.  In each child
the next field points to the child to the right and the prev field
points to the child to the left.

The children of a vertical combination window may be leaf windows
or horizontal combination windows.  The children of a horizontal
combination window may be leaf windows or vertical combination windows.

At the top of the tree are two windows which have nil as parent.
The second of these is minibuf_window.  The first one manages all
Jim Blandy's avatar
Jim Blandy committed
65
the frame area that is not minibuffer, and is called the root window.
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70
Different windows can be the root at different times;
initially the root window is a leaf window, but if more windows
are created then that leaf window ceases to be root and a newly
made combination window becomes root instead.

Jim Blandy's avatar
Jim Blandy committed
71 72 73 74
In any case, on screens which have an ordinary window and a
minibuffer, prev of the minibuf window is the root window and next of
the root window is the minibuf window.  On minibufferless screens or
minibuffer-only screens, the root window and the minibuffer window are
75
one and the same, so its prev and next members are nil.
Jim Blandy's avatar
Jim Blandy committed
76

77
A dead window has its buffer, hchild, and vchild windows all nil.  */
Jim Blandy's avatar
Jim Blandy committed
78

Gerd Moellmann's avatar
Gerd Moellmann committed
79 80 81 82 83 84 85 86 87
struct cursor_pos
{
  /* Pixel position.  These are always window relative.  */
  int x, y;

  /* Glyph matrix position.  */
  int hpos, vpos;
};

Jim Blandy's avatar
Jim Blandy committed
88 89 90 91
struct window
  {
    /* The first two fields are really the header of a vector */
    /* The window code does not refer to them.  */
92
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
93
    struct Lisp_Vector *vec_next;
Jim Blandy's avatar
Jim Blandy committed
94 95
    /* The frame this window is on.  */
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
96 97 98 99 100 101 102 103 104 105 106 107 108
    /* t if this window is a minibuffer window.  */
    Lisp_Object mini_p;
    /* Following child (to right or down) at same level of tree */
    Lisp_Object next;
    /* Preceding child (to left or up) at same level of tree */
    Lisp_Object prev;
    /* First child of this window. */
    /* vchild is used if this is a vertical combination,
       hchild if this is a horizontal combination. */
    Lisp_Object hchild, vchild;
    /* The window this one is a child of. */
    Lisp_Object parent;
    /* The upper left corner coordinates of this window,
Jim Blandy's avatar
Jim Blandy committed
109
       as integers relative to upper left corner of frame = 0, 0 */
Jim Blandy's avatar
Jim Blandy committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    Lisp_Object left;
    Lisp_Object top;
    /* The size of the window */
    Lisp_Object height;
    Lisp_Object width;
    /* The buffer displayed in this window */
    /* Of the fields vchild, hchild and buffer, only one is non-nil.  */
    Lisp_Object buffer;
    /* A marker pointing to where in the text to start displaying */
    Lisp_Object start;
    /* A marker pointing to where in the text point is in this window,
       used only when the window is not selected.
       This exists so that when multiple windows show one buffer
       each one can have its own value of point.  */
    Lisp_Object pointm;
    /* Non-nil means next redisplay must use the value of start
       set up for it in advance.  Set by scrolling commands.  */
    Lisp_Object force_start;
128 129 130
    /* Non-nil means we have explicitly changed the value of start,
       but that the next redisplay is not obliged to use the new value.  */
    Lisp_Object optional_new_start;
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136 137 138 139 140
    /* Number of columns display within the window is scrolled to the left.  */
    Lisp_Object hscroll;
    /* Number saying how recently window was selected */
    Lisp_Object use_time;
    /* Unique number of window assigned when it was created */
    Lisp_Object sequence_number;
    /* No permanent meaning; used by save-window-excursion's bookkeeping */
    Lisp_Object temslot;
    /* text.modified of displayed buffer as of last time display completed */
    Lisp_Object last_modified;
141 142
    /* BUF_OVERLAY_MODIFIED of displayed buffer as of last complete update.  */
    Lisp_Object last_overlay_modified;
Jim Blandy's avatar
Jim Blandy committed
143 144
    /* Value of point at that time */
    Lisp_Object last_point;
145 146 147
    /* Non-nil if the buffer was "modified" when the window
       was last updated.  */
    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 151 152 153
       scroll bars; it can store anything it likes here.  If this
       window is newly created and we haven't displayed a scroll bar in
       it yet, or if the frame doesn't have any scroll bars, this is nil.  */
    Lisp_Object vertical_scroll_bar;
154

Gerd Moellmann's avatar
Gerd Moellmann committed
155 156 157 158 159
    /* Width of left and right marginal areas.  A value of nil means
       no margin.  */
    Lisp_Object left_margin_width;
    Lisp_Object right_margin_width;

Jim Blandy's avatar
Jim Blandy committed
160
/* The rest are currently not used or only half used */
Jim Blandy's avatar
Jim Blandy committed
161 162
    /* Frame coords of mark as of last time display completed */
    /* May be nil if mark does not exist or was not on frame */
Jim Blandy's avatar
Jim Blandy committed
163 164
    Lisp_Object last_mark_x;
    Lisp_Object last_mark_y;
Gerd Moellmann's avatar
Gerd Moellmann committed
165 166
    /* Z - the buffer position of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
Jim Blandy's avatar
Jim Blandy committed
167
    Lisp_Object window_end_pos;
Gerd Moellmann's avatar
Gerd Moellmann committed
168 169 170
    /* Glyph matrix row of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
    Lisp_Object window_end_vpos;
Jim Blandy's avatar
Jim Blandy committed
171 172
    /* t if window_end_pos is truly valid.
       This is nil if nontrivial redisplay is preempted
Jim Blandy's avatar
Jim Blandy committed
173 174
       since in that case the frame image that window_end_pos
       did not get onto the frame.  */
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181 182 183 184 185
    Lisp_Object window_end_valid;
    /* Non-nil means must regenerate mode line of this window */
    Lisp_Object update_mode_line;
    /* Non-nil means current value of `start'
       was the beginning of a line when it was chosen.  */
    Lisp_Object start_at_line_beg;
    /* Display-table to use for displaying chars in this window.
       Nil means use the buffer's own display-table.  */
    Lisp_Object display_table;
    /* Non-nil means window is marked as dedicated.  */
    Lisp_Object dedicated;
186 187 188 189 190 191 192 193
    /* Line number and position of a line somewhere above the
       top of the screen.  */
    /* If this field is nil, it means we don't have a base line.  */
    Lisp_Object base_line_number;
    /* If this field is nil, it means we don't have a base line.
       If it is a buffer, it means don't display the line number
       as long as the window shows that buffer.  */
    Lisp_Object base_line_pos;
194 195 196
    /* If we have highlighted the region (or any part of it),
       this is the mark position that we used, as an integer.  */
    Lisp_Object region_showing;
197 198 199
    /* The column number currently displayed in this window's mode line,
       or nil if column numbers are not being displayed.  */
    Lisp_Object column_number_displayed;
200 201 202
    /* If redisplay in this window goes beyond this buffer position,
       must run the redisplay-end-trigger-hook.  */
    Lisp_Object redisplay_end_trigger;
203 204
    /* Non-nil means don't delete this window for becoming "too small".  */
    Lisp_Object too_small_ok;
Gerd Moellmann's avatar
Gerd Moellmann committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    
    /* No Lisp data may follow below this point without changing
       mark_object in alloc.c.  The member current_matrix must be the
       first non-Lisp member.  */

    /* Glyph matrices.  */
    struct glyph_matrix *current_matrix;
    struct glyph_matrix *desired_matrix;

    /* Cursor position as of last update that completed without
       pause.  This is the position of last_point.  */
    struct cursor_pos last_cursor;

    /* Intended cursor position.   This is a position within the
       glyph matrix.  */
    struct cursor_pos cursor;
    
    /* Where the cursor actually is.  */
    struct cursor_pos phys_cursor;
    
    /* Cursor type last drawn on the window.  Used for X frames; -1
       initially.  */
    int phys_cursor_type;

    /* This is handy for undrawing the cursor.  */
    int phys_cursor_ascent, phys_cursor_height;
    
    /* Non-zero means the cursor is currently displayed.  This can be
       set to zero by functions overpainting the cursor image.  */
    unsigned phys_cursor_on_p : 1;

    /* 0 means cursor is logically on, 1 means it's off.  Used for
       blinking cursor.  */
    unsigned cursor_off_p : 1;

    /* Value of cursor_off_p as of the last redisplay.  */
    unsigned last_cursor_off_p : 1;

    /* 1 means desired matrix has been build and window must be
       updated in update_frame.  */
    unsigned must_be_updated_p : 1;

    /* Flag indicating that this window is not a real one.
       Currently only used for menu bar windows of frames.  */
    unsigned pseudo_window_p : 1;

    /* Amount by which lines of this window are scrolled in
       y-direction (smooth scrolling).  */
    int vscroll;
    
    /* Z_BYTE - the buffer position of the last glyph in the current matrix
       of W.  Only valid if WINDOW_END_VALID is not nil.  */
    int window_end_bytepos;
258 259 260 261 262

    /* 1 means the window start of this window is frozen and may not
       be changed during redisplay.  If point is not in the window,
       accept that.  */
    unsigned frozen_window_start_p : 1;
263 264 265 266 267

    /* 1 means that this window's height is temporarily fixed.  Used
       in resize_mini_window to precent resizing selected_window, if
       possible.  */
    unsigned height_fixed_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
268
};
Jim Blandy's avatar
Jim Blandy committed
269 270 271

/* 1 if W is a minibuffer window.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
272
#define MINI_WINDOW_P(W)	(!EQ ((W)->mini_p, Qnil))
Jim Blandy's avatar
Jim Blandy committed
273

Gerd Moellmann's avatar
Gerd Moellmann committed
274
/* Return the window column at which the text in window W starts.
275 276 277 278 279 280 281
   This is different from the `left' field because it does not include
   a left-hand scroll bar if any.  */
   
#define WINDOW_LEFT_MARGIN(W) \
     (XFASTINT ((W)->left) \
      + FRAME_LEFT_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME (W))))

Gerd Moellmann's avatar
Gerd Moellmann committed
282
/* Return the window column before which window W ends.
283 284 285 286 287
   This includes a right-hand scroll bar, if any.  */

#define WINDOW_RIGHT_EDGE(W) \
     (XFASTINT ((W)->left) + XFASTINT ((W)->width))

Gerd Moellmann's avatar
Gerd Moellmann committed
288
/* Return the window column before which the text in window W ends.
289
   This is different from WINDOW_RIGHT_EDGE because it does not include
290 291
   a scroll bar or window-separating line on the right edge.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295 296
#define WINDOW_RIGHT_MARGIN(W) \
     (WINDOW_RIGHT_EDGE (W) \
      - (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (W))) \
         ? FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (W))) \
         : 0))
297 298 299 300 301 302 303 304 305 306 307

/* 1 if window W takes up the full width of its frame.  */ 

#define WINDOW_FULL_WIDTH_P(W) \
     (XFASTINT ((W)->width) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W))))

/* 1 if window W's has no other windows to its right in its frame.  */ 

#define WINDOW_RIGHTMOST_P(W) \
     (WINDOW_RIGHT_EDGE (W) == FRAME_WINDOW_WIDTH (XFRAME (WINDOW_FRAME (W))))
     
Gerd Moellmann's avatar
Gerd Moellmann committed
308

Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314
/* This is the window in which the terminal's cursor should
   be left when nothing is being done with it.  This must
   always be a leaf window, and its buffer is selected by
   the top level editing loop at the end of each command.

   This value is always the same as
Jim Blandy's avatar
Jim Blandy committed
315
    FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320

extern Lisp_Object selected_window;

/* This is a time stamp for window selection, so we can find the least
   recently used window.  Its only users are Fselect_window,
Jim Blandy's avatar
Jim Blandy committed
321
   init_window_once, and make_frame.  */
Jim Blandy's avatar
Jim Blandy committed
322 323 324

extern int window_select_count;

Jim Blandy's avatar
Jim Blandy committed
325
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
326
   Note that you cannot test for minibufferness of an arbitrary window
Jim Blandy's avatar
Jim Blandy committed
327
   by comparing against this; use the MINI_WINDOW_P macro instead.  */
Jim Blandy's avatar
Jim Blandy committed
328 329 330

extern Lisp_Object minibuf_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
331 332 333
/* Non-nil => window to for C-M-v to scroll when the minibuffer is
   selected.  */

Jim Blandy's avatar
Jim Blandy committed
334 335
extern Lisp_Object Vminibuf_scroll_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
336 337 338
/* Nil or a symbol naming the window system under which emacs is
   running ('x is the only current possibility) */

Jim Blandy's avatar
Jim Blandy committed
339 340 341
extern Lisp_Object Vwindow_system;

/* Version number of X windows: 10, 11 or nil.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
342

Jim Blandy's avatar
Jim Blandy committed
343 344 345
extern Lisp_Object Vwindow_system_version;

/* Window that the mouse is over (nil if no mouse support).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
346

Jim Blandy's avatar
Jim Blandy committed
347 348 349
extern Lisp_Object Vmouse_window;

/* Last mouse-click event (nil if no mouse support).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
350

Jim Blandy's avatar
Jim Blandy committed
351 352
extern Lisp_Object Vmouse_event;

Andreas Schwab's avatar
Andreas Schwab committed
353 354
EXFUN (Fnext_window, 3);
EXFUN (Fselect_window, 1);
355
EXFUN (Fdisplay_buffer, 3);
Andreas Schwab's avatar
Andreas Schwab committed
356
EXFUN (Fset_window_buffer, 2);
Gerd Moellmann's avatar
Gerd Moellmann committed
357 358 359 360 361
EXFUN (Fset_window_hscroll, 2);
EXFUN (Fwindow_hscroll, 1);
EXFUN (Fset_window_vscroll, 2);
EXFUN (Fwindow_vscroll, 1);
EXFUN (Fset_window_margins, 3);
Andreas Schwab's avatar
Andreas Schwab committed
362 363
extern Lisp_Object make_window P_ ((void));
extern void delete_window P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
364
extern Lisp_Object window_from_coordinates P_ ((struct frame *, int, int, int *, int));
Andreas Schwab's avatar
Andreas Schwab committed
365 366 367 368 369 370 371
EXFUN (Fwindow_dedicated_p, 1);
extern int window_height P_ ((Lisp_Object));
extern int window_width P_ ((Lisp_Object));
extern void set_window_height P_ ((Lisp_Object, int, int));
extern void set_window_width P_ ((Lisp_Object, int, int));
extern void change_window_height P_ ((int, int));
extern void delete_all_subwindows P_ ((struct window *));
372
extern void freeze_window_starts P_ ((struct frame *, int));
373
extern void foreach_window ();
Jim Blandy's avatar
Jim Blandy committed
374

Gerd Moellmann's avatar
Gerd Moellmann committed
375 376 377 378 379 380 381
/* Make WINDOW display BUFFER as its contents.  RUN_HOOKS_P non-zero
   means it's allowed to run hooks.  See make_frame for a case where
   it's not allowed.  */

void set_window_buffer P_ ((Lisp_Object window, Lisp_Object buffer,
			    int run_hooks_p));

Jim Blandy's avatar
Jim Blandy committed
382
/* Prompt to display in front of the minibuffer contents.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
383

384
extern Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
385

Jim Blandy's avatar
Jim Blandy committed
386
/* The visual width of the above.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
387

Jim Blandy's avatar
Jim Blandy committed
388 389
extern int minibuf_prompt_width;

Gerd Moellmann's avatar
Gerd Moellmann committed
390 391 392 393
/* This is the window where the echo area message was displayed.  It
   is always a minibuffer window, but it may not be the same window
   currently active as a minibuffer.  */

394 395
extern Lisp_Object echo_area_window;

Jim Blandy's avatar
Jim Blandy committed
396
/* Depth in recursive edits.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
397

Jim Blandy's avatar
Jim Blandy committed
398 399 400
extern int command_loop_level;

/* Depth in minibuffer invocations.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
401

Jim Blandy's avatar
Jim Blandy committed
402 403 404
extern int minibuf_level;

/* true iff we should redraw the mode lines on the next redisplay.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
405

Jim Blandy's avatar
Jim Blandy committed
406 407
extern int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
408 409 410
/* Nonzero if BEGV - BEG or Z - ZV of current buffer has changed since
   last redisplay that finished.  */

Jim Blandy's avatar
Jim Blandy committed
411 412
extern int clip_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
413 414 415
/* Nonzero if window sizes or contents have changed since last
   redisplay that finished */

Jim Blandy's avatar
Jim Blandy committed
416 417
extern int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
418 419 420
/* Number of windows displaying the selected buffer.  Normally this is
   1, but it can be more.  */

Jim Blandy's avatar
Jim Blandy committed
421
extern int buffer_shared;
Jim Blandy's avatar
Jim Blandy committed
422 423 424

/* If *ROWS or *COLS are too small a size for FRAME, set them to the
   minimum allowable size.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
425

Andreas Schwab's avatar
Andreas Schwab committed
426
extern void check_frame_size P_ ((struct frame *frame, int *rows, int *cols));
Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429 430 431 432 433 434

/* Return a pointer to the glyph W's physical cursor is on.  Value is
   null if W's current matrix is invalid, so that no meaningfull glyph
   can be returned.  */

struct glyph *get_phys_cursor_glyph P_ ((struct window *w));

#endif /* not WINDOW_H_INCLUDED */