--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/window.h	Mon Aug 13 08:45:50 2007 +0200
@@ -0,0 +1,441 @@
+/* Window definitions for XEmacs.
+   Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995
+   Free Software Foundation, Inc.
+   Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
+   Copyright (C) 1995, 1996 Ben Wing.
+   Copyright (C) 1996 Chuck Thompson.
+
+This file is part of XEmacs.
+
+XEmacs is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2, or (at your option) any
+later version.
+
+XEmacs 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 XEmacs; see the file COPYING.  If not, write to
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
+
+/* Synched up with: FSF 19.30. */
+
+#ifndef _XEMACS_WINDOW_H_
+#define _XEMACS_WINDOW_H_
+
+#include "redisplay.h"
+#include "scrollbar.h"
+
+/* 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
+arranged on the frame.  Leaf windows never become non-leaves.
+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.
+
+A vertical combination window has children that are arranged on the frame
+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
+the frame area that is not minibuffer, and is called the root window.
+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.
+
+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
+one and the same, so its prev and next members are nil.
+
+A dead window has the `dead' flag set on it.  Note that unlike other
+dead objects, dead windows can be made live again through restoring a
+window configuration.  This means that the values in a dead window
+need to be preserved, except for those that are reconstructed by from
+the window configuration. */
+
+struct window
+{
+  struct lcrecord_header header;
+
+  /* The frame this window is on.  */
+  Lisp_Object frame;
+  /* 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,
+     as integers (pixels) relative to upper left corner of frame = 0, 0 */
+  int pixel_left;
+  int pixel_top;
+  /* The size of the window (in pixels) */
+  int pixel_height;
+  int pixel_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 */
+  /* need one for each set of display structures */
+  Lisp_Object start[3];
+  /* 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.  */
+  /* need one for each set of display structures */
+  Lisp_Object pointm[3];
+  /* A marker pointing to where in the text the scrollbar is pointing */
+  Lisp_Object sb_point;
+  /* Number of columns display within the window is scrolled to the left. */
+  int hscroll;
+  /* Number saying how recently window was selected */
+  Lisp_Object use_time;
+  /* text.modified of displayed buffer as of last time display completed */
+  Lisp_Object last_modified[3];
+  /* Value of point at that time */
+  Lisp_Object last_point[3];
+  /* Value of start at that time */
+  Lisp_Object last_start[3];
+  /* buf.face_change as of last time display completed */
+  Lisp_Object last_facechange[3];
+
+  /* face cache elements correct for this window and its current buffer */
+  face_cachel_dynarr *face_cachels;
+  /* glyph cache elements correct for this window and its current buffer */
+  glyph_cachel_dynarr *glyph_cachels;
+
+
+  /* List of starting positions for display lines.  Only valid if
+     buffer has not changed. */
+  line_start_cache_dynarr *line_start_cache;
+  Lisp_Object line_cache_last_updated;
+  int line_cache_validation_override;
+
+  /* Length of longest line currently displayed.  Used to control the
+     width of the horizontal scrollbars. */
+  int max_line_len;
+
+  /* Frame coords of point at that time */
+  int last_point_x[3];
+  int last_point_y[3];
+
+  /* Number of characters in buffer past bottom of window,
+     as of last redisplay that finished. */
+  /* need one for each set of display structures */
+  int window_end_pos[3];
+
+  /* Non-nil means window is marked as dedicated.  */
+  Lisp_Object dedicated;
+
+#if 0 /* FSFmacs */
+  /* 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;
+#endif
+  /* If redisplay in this window goes beyond this buffer position,
+     must run the redisplay-end-trigger-functions.  */
+  Lisp_Object redisplay_end_trigger;
+
+  /* Set by redisplay to the last position seen.  This is used
+     to implement the redisplay-end-trigger-functions. */
+  Bufpos last_redisplay_pos;
+
+  /* specifier values cached in the struct window: */
+
+  /* Display-table to use for displaying chars in this window. */
+  Lisp_Object display_table;
+  /* Thickness of modeline shadow, in pixels.  If negative, draw
+     as recessed. */
+  Lisp_Object modeline_shadow_thickness;
+  /* Non-nil means to display a modeline for the buffer. */
+  Lisp_Object has_modeline_p;
+#ifdef HAVE_SCROLLBARS
+  /* Width of vertical scrollbars. */
+  Lisp_Object scrollbar_width;
+  /* Height of horizontal scrollbars. */
+  Lisp_Object scrollbar_height;
+  /* Pointer to use for vertical and horizontal scrollbars. */
+  Lisp_Object scrollbar_pointer;
+#endif
+#ifdef HAVE_TOOLBARS
+  /* Toolbar specification for each of the four positions.
+     This is not a size hog because the value here is not copied,
+     and will be shared with the specs in the specifier. */
+  Lisp_Object toolbar[4];
+  /* Toolbar size for each of the four positions. */
+  Lisp_Object toolbar_size[4];
+  /* Toolbar visibility status for each of the four positions. */
+  Lisp_Object toolbar_visible_p[4];
+  /* Caption status of toolbar. */
+  Lisp_Object toolbar_buttons_captioned_p;
+  /* The following four don't really need to be cached except
+     that we need to know when they've changed. */
+  Lisp_Object default_toolbar;
+  Lisp_Object default_toolbar_width, default_toolbar_height;
+  Lisp_Object default_toolbar_visible_p;
+#endif
+  Lisp_Object left_margin_width, right_margin_width;
+  Lisp_Object minimum_line_ascent, minimum_line_descent;
+  Lisp_Object use_left_overflow, use_right_overflow;
+#ifdef HAVE_MENUBARS
+  /* Visibility of menubar. */
+  Lisp_Object menubar_visible_p;
+#endif
+  Lisp_Object text_cursor_visible_p;
+
+  /* one-bit flags: */
+
+  /* marker used when restoring a window configuration */
+  unsigned int config_mark :1;
+  /* Non-zero means window was dead. */
+  unsigned int dead :1;
+  /* Non-zero means next redisplay must use the value of start
+     set up for it in advance.  Set by scrolling commands.  */
+  unsigned int force_start :1;
+  /* Non-zero means must regenerate modeline of this window */
+  unsigned int redo_modeline :1;
+  /* Non-zero means current value of `start'
+     was the beginning of a line when it was chosen.  */
+  unsigned int start_at_line_beg :1;
+  /* new redisplay flag */
+  unsigned int windows_changed :1;
+  unsigned int shadow_thickness_changed :1;
+  };
+
+#define CURRENT_DISP		0
+#define DESIRED_DISP		1
+#define CMOTION_DISP		2
+
+struct window_mirror
+{
+  /* Frame this mirror is on. */
+  struct frame *frame;
+
+  /* Following child (to right or down) at same level of tree */
+  struct window_mirror *next;
+
+  /* There is no prev field because we never traverse this structure
+     backwards.  Same goes for the parent field. */
+
+  /* First child of this window. */
+  /* vchild is used if this is a vertical combination,
+     hchild if this is a horizontal combination. */
+  struct window_mirror *hchild, *vchild;
+
+  /* Dynamic array of display lines */
+  display_line_dynarr *current_display_lines;
+  display_line_dynarr *desired_display_lines;
+
+  /* Buffer current_display_lines represent. */
+  struct buffer *buffer;
+
+#ifdef HAVE_SCROLLBARS
+  /* Scrollbars associated with window, if any. */
+  struct scrollbar_instance *scrollbar_vertical_instance;
+  struct scrollbar_instance *scrollbar_horizontal_instance;
+#endif
+
+  /* Flag indicating whether a subwindow is currently being displayed. */
+  int subwindows_being_displayed :1;
+
+  /* Keep track of the truncation status in this window so we can
+     detect when it has changed.  #### Magic variables would be a huge
+     win here. */
+  int truncate_win :1;
+};
+
+#ifdef emacs  /* some things other than emacs want the structs */
+
+DECLARE_LRECORD (window, struct window);
+#define XWINDOW(x) XRECORD (x, window, struct window)
+#define XSETWINDOW(x, p) XSETRECORD (x, p, window)
+#define WINDOWP(x) RECORDP (x, window)
+#define GC_WINDOWP(x) GC_RECORDP (x, window)
+#define CHECK_WINDOW(x) CHECK_RECORD (x, window)
+#define CONCHECK_WINDOW(x) CONCHECK_RECORD (x, window)
+
+extern Lisp_Object Qwindow_live_p;
+
+#define WINDOW_LIVE_P(x) (!(x)->dead)
+#define CHECK_LIVE_WINDOW(x)						\
+  do { CHECK_WINDOW (x);						\
+       if (!WINDOW_LIVE_P (XWINDOW (x)))				\
+	 dead_wrong_type_argument (Qwindow_live_p, (x));		\
+     } while (0)
+#define CONCHECK_LIVE_WINDOW(x)						\
+  do { CONCHECK_WINDOW (x);						\
+       if (!WINDOW_LIVE_P (XWINDOW (x)))				\
+	 x = wrong_type_argument (Qwindow_live_p, (x));			\
+     } while (0)
+
+/* 1 if W is a minibuffer window.  */
+#define MINI_WINDOW_P(W)  (!EQ ((W)->mini_p, Qnil))
+
+/* 1 if we are dealing with a parentless window (this includes the
+   root window on a frame and the minibuffer window; both of these
+   are siblings). */
+#define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent)
+
+/* Set all redisplay flags indicating a window has changed */
+#define MARK_WINDOWS_CHANGED(w) do {					\
+  (w)->windows_changed = 1;						\
+  if (!NILP (w->frame))							\
+    MARK_FRAME_WINDOWS_CHANGED (XFRAME (w->frame));			\
+  else									\
+    windows_changed = 1; } while (0)
+
+#define WINDOW_TTY_P(w) FRAME_TTY_P (XFRAME ((w)->frame))
+#define WINDOW_X_P(w) FRAME_X_P (XFRAME ((w)->frame))
+#define WINDOW_NS_P(w) FRAME_NS_P (XFRAME ((w)->frame))
+#define WINDOW_WIN_P(w) FRAME_WIN_P (XFRAME ((w)->frame))
+
+DECLARE_LRECORD (window_configuration, struct window_config);
+
+/* The minibuffer window of the selected frame.
+   Note that you cannot test for minibufferness of an arbitrary window
+   by comparing against this; but you can test for minibufferness of
+   the selected window or of any window that is displayed.  */
+extern Lisp_Object minibuf_window;
+
+/* Non-nil => window to for C-M-v to scroll
+   when the minibuffer is selected.  */
+extern Lisp_Object Vminibuf_scroll_window;
+
+/* Prompt to display in front of the minibuffer contents, or nil */
+extern Lisp_Object Vminibuf_prompt;
+
+/* Depth in minibuffer invocations */
+extern int minibuf_level;
+
+Lisp_Object allocate_window (void);
+int window_char_width (struct window *, int include_margins_p);
+int window_char_height (struct window *, int include_gutters_p);
+int window_displayed_height (struct window *);
+int window_is_leftmost (struct window *w);
+int window_is_rightmost (struct window *w);
+int window_truncation_on (struct window *w);
+int window_needs_vertical_divider (struct window *);
+int window_scrollbar_width (struct window *w);
+int window_scrollbar_height (struct window *w);
+int window_modeline_height (struct window *w);
+int window_left_margin_width (struct window *w);
+int window_right_margin_width (struct window *w);
+int window_top_gutter_height (struct window *w);
+int window_bottom_gutter_height (struct window *w);
+int window_left_gutter_width (struct window *w, int modeline);
+int window_right_gutter_width (struct window *w, int modeline);
+int window_bottom_toolbar_height (struct window *w);
+
+void delete_all_subwindows (struct window *w);
+void set_window_pixheight (Lisp_Object window, int pixheight,
+			   int nodelete);
+void set_window_pixwidth (Lisp_Object window, int pixwidth,
+			  int nodelete);
+void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
+		    Error_behavior errb);
+int buffer_window_count (struct buffer *b, struct frame *f);
+int buffer_window_mru (struct window *w);
+void check_frame_size (struct frame *frame, int *rows, int *cols);
+void mark_windows_in_use (Lisp_Object window, int mark);
+struct window *decode_window (Lisp_Object window);
+struct window *find_window_by_pixel_pos (unsigned int pix_x,
+					 unsigned int pix_y,
+					 Lisp_Object win);
+
+/* new functions to handle the window mirror */
+void free_window_mirror (struct window_mirror *mir);
+Lisp_Object real_window (struct window_mirror *mir, int no_abort);
+struct window_mirror *find_window_mirror (struct window *w);
+display_line_dynarr *window_display_lines (struct window *w, int);
+struct buffer *window_display_buffer (struct window *w);
+void set_window_display_buffer (struct window *w, struct buffer *b);
+void update_frame_window_mirror (struct frame *f);
+
+int map_windows (struct frame *f,
+		 int (*mapfun) (struct window *w, void *closure),
+		 void *closure);
+void some_window_value_changed (Lisp_Object specifier, struct window *w,
+				Lisp_Object oldval);
+
+#define WINDOW_FRAME(w) ((w)->frame)
+#define WINDOW_BUFFER(w) ((w)->buffer)
+#define WINDOW_DEVICE(w) FRAME_DEVICE (XFRAME (WINDOW_FRAME (w)))
+#define WINDOW_CONSOLE(w) DEVICE_CONSOLE (XDEVICE (WINDOW_DEVICE (w)))
+
+/* XEmacs window size and positioning macros. */
+#define WINDOW_TOP(w) ((w)->pixel_top)
+#define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w))
+#define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height)
+#define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w))
+#define WINDOW_LEFT(w) ((w)->pixel_left)
+#define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0))
+#define WINDOW_MODELINE_LEFT(w)	\
+  (WINDOW_LEFT (w) + window_left_gutter_width (w, 1))
+#define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width)
+#define WINDOW_TEXT_RIGHT(w)	\
+  (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0))
+#define WINDOW_MODELINE_RIGHT(w)	\
+  (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1))
+
+#define WINDOW_HEIGHT(w) ((w)->pixel_height)
+#define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w))
+#define WINDOW_WIDTH(w) ((w)->pixel_width)
+#define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w))
+
+#define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p))
+
+#define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win)		\
+ abs ((!WINDOW_HAS_MODELINE_P (win)				\
+       ? ((XINT (win->modeline_shadow_thickness) > 1)		\
+	  ? XINT (win->modeline_shadow_thickness) - 1		\
+	  : ((XINT (win->modeline_shadow_thickness) < -1)	\
+	     ? XINT (win->modeline_shadow_thickness) + 1	\
+	     : XINT (win->modeline_shadow_thickness)))		\
+       : XINT (win->modeline_shadow_thickness)))
+
+#define MODELINE_SHADOW_THICKNESS(win)				\
+ (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10 		\
+  ? 10								\
+  : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win))
+
+#endif /* emacs */
+
+#endif /* _XEMACS_WINDOW_H_ */