/* Define frame-object for GNU Emacs.
- Copyright (C) 1988, 1992 Free Software Foundation, Inc.
+ Copyright (C) 1993 Free Software Foundation, Inc.
This file is part of GNU Emacs.
along with GNU Emacs; see the file COPYING. If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+\f
+/* Miscellanea. */
+
+/* Nonzero means don't assume anything about current
+ contents of actual terminal frame */
+extern int frame_garbaged;
+/* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
+ print. */
+extern int message_buf_print;
+
+\f
/* The structure representing a frame.
We declare this even if MULTI_FRAME is not defined, because when
/* Name of this frame: a Lisp string. See also `explicit_name'. */
Lisp_Object name;
- /* The frame which should recieve keystrokes that occur in this
- frame. This is usually the frame itself, but if the frame is
- minibufferless, this points to the minibuffer frame when it is
- active. */
+ /* The frame which should receive keystrokes that occur in this
+ frame, or nil if they should go to the frame itself. This is
+ usually nil, but if the frame is minibufferless, we can use this
+ to redirect keystrokes to a surrogate minibuffer frame when
+ needed.
+
+ Note that a value of nil is different than having the field point
+ to the frame itself. Whenever the Fselect_frame function is used
+ to shift from one frame to the other, any redirections to the
+ original frame are shifted to the newly selected frame; if
+ focus_frame is nil, Fselect_frame will leave it alone. */
Lisp_Object focus_frame;
/* This frame's root window. Every frame has one.
or modified with modify-frame-parameters. */
Lisp_Object param_alist;
+ /* List of scroll bars on this frame.
+ Actually, we don't specify exactly what is stored here at all; the
+ scroll bar implementation code can use it to store anything it likes.
+ This field is marked by the garbage collector. It is here
+ instead of in the `display' structure so that the garbage
+ collector doesn't need to look inside the window-system-dependent
+ structure. */
+ Lisp_Object scroll_bars;
+ Lisp_Object condemned_scroll_bars;
+
+ /* List of elements to display in the menu bar.
+ The elements have the form (KEY STRING . nil) to start;
+ when they are displayed, the hpos of the left edge goes in the cddr. */
+ Lisp_Object menu_bar_items;
+
+ /* Alist of elements (FACE-NAME . FACE-VECTOR-DATA). */
+ Lisp_Object face_alist;
+
/* The output method says how the contents of this frame
are displayed. It could be using termcap, or using an X window. */
enum output_method output_method;
it is defined in xterm.h. */
union display { struct x_display *x; int nothing; } display;
+ /* Number of lines of menu bar. */
+ int menu_bar_lines;
+
+#ifdef USE_X_TOOLKIT
+ /* Nonzero means using a menu bar that comes from the X toolkit. */
+ int external_menu_bar;
+#endif
+
/* Nonzero if last attempt at redisplay on this frame was preempted. */
char display_preempted;
/* visible is nonzero if the frame is currently displayed; we check
it to see if we should bother updating the frame's contents.
+ DON'T SET IT DIRECTLY; instead, use FRAME_SET_VISIBLE.
+
+ Note that, since invisible frames aren't updated, whenever a
+ frame becomes visible again, it must be marked as garbaged. The
+ FRAME_SAMPLE_VISIBILITY macro takes care of this.
iconified is nonzero if the frame is currently iconified.
These should probably be considered read-only by everyone except
FRAME_SAMPLE_VISIBILITY.
- This two are mutually exclusive. They might both be zero, if the
+ These two are mutually exclusive. They might both be zero, if the
frame has been made invisible without an icon. */
char visible, iconified;
show no modeline for that window. */
char wants_modeline;
+ /* Non-zero if the hardware device this frame is displaying on can
+ support scroll bars. */
+ char can_have_scroll_bars;
+
+ /* If can_have_scroll_bars is non-zero, this is non-zero if we should
+ actually display them on this frame. */
+ char has_vertical_scroll_bars;
+
/* Non-0 means raise this frame to the top of the heap when selected. */
char auto_raise;
#define WINDOW_FRAME(w) (w)->frame
-#define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
#define FRAME_LIVE_P(f) ((f)->display.nothing != 0)
#define FRAME_TERMCAP_P(f) ((f)->output_method == output_termcap)
#define FRAME_X_P(f) ((f)->output_method == output_x_window)
#define FRAME_WIDTH(f) (f)->width
#define FRAME_NEW_HEIGHT(f) (f)->new_height
#define FRAME_NEW_WIDTH(f) (f)->new_width
+#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
+#define FRAME_EXTERNAL_MENU_BAR(f) (f)->external_menu_bar
#define FRAME_CURSOR_X(f) (f)->cursor_x
#define FRAME_CURSOR_Y(f) (f)->cursor_y
-#define FRAME_VISIBLE_P(f) (f)->visible
+#define FRAME_VISIBLE_P(f) ((f)->visible != 0)
+#define FRAME_SET_VISIBLE(f,p) \
+ ((f)->async_visible = (p), FRAME_SAMPLE_VISIBILITY (f))
#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1, f->garbaged = 1)
#define FRAME_GARBAGED_P(f) (f)->garbaged
#define FRAME_NO_SPLIT_P(f) (f)->no_split
#define FRAME_MESSAGE_BUF(f) (f)->message_buf
#define FRAME_SCROLL_BOTTOM_VPOS(f) (f)->scroll_bottom_vpos
#define FRAME_FOCUS_FRAME(f) (f)->focus_frame
+#define FRAME_CAN_HAVE_SCROLL_BARS(f) ((f)->can_have_scroll_bars)
+#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) ((f)->has_vertical_scroll_bars)
+#define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
+#define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
+#define FRAME_MENU_BAR_ITEMS(f) ((f)->menu_bar_items)
/* Emacs's redisplay code could become confused if a frame's
visibility changes at arbitrary times. For example, if a frame is
the async_visible and async_iconified flags; the redisplay code
calls the FRAME_SAMPLE_VISIBILITY macro before doing any redisplay,
which sets visible and iconified from their asynchronous
- counterparts. */
+ counterparts.
+
+ Synchronous code must use the FRAME_SET_VISIBLE macro.
+
+ Also, if a frame used to be invisible, but has just become visible,
+ it must be marked as garbaged, since redisplay hasn't been keeping
+ up its contents. */
#define FRAME_SAMPLE_VISIBILITY(f) \
- ((f)->visible = (f)->async_visible, \
+ (((f)->async_visible && ! (f)->visible) ? SET_FRAME_GARBAGED (f) : 0, \
+ (f)->visible = (f)->async_visible, \
(f)->iconified = (f)->async_iconified)
#define CHECK_FRAME(x, i) \
{ \
if (! FRAMEP (x) \
|| ! FRAME_LIVE_P (XFRAME (x))) \
- x = wrong_type_argument (Qlive_frame_p, (x)); \
+ x = wrong_type_argument (Qframe_live_p, (x)); \
}
/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
`for' loop which iterates over the elements of Vframe_list. The
- loop will set FRAME_VAR, a FRAME_PTR, to each frame in
+ loop will set FRAME_VAR, a Lisp_Object, to each frame in
Vframe_list in succession and execute the statement. LIST_VAR
- should be a Lisp_Object; it is used to iterate through the
+ should be a Lisp_Object too; it is used to iterate through the
Vframe_list.
If MULTI_FRAME isn't defined, then this loop expands to something which
#define FOR_EACH_FRAME(list_var, frame_var) \
for ((list_var) = Vframe_list; \
(CONSP (list_var) \
- && (frame_var = XFRAME (XCONS (list_var)->car), 1)); \
+ && (frame_var = XCONS (list_var)->car, 1)); \
list_var = XCONS (list_var)->cdr)
-extern Lisp_Object Qframep, Qlive_frame_p;
+extern Lisp_Object Qframep, Qframe_live_p, Qicon;
extern struct frame *selected_frame;
extern struct frame *last_nonminibuf_frame;
extern struct frame *make_minibuffer_frame ();
extern struct frame *make_frame_without_minibuffer ();
-/* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
- print. */
-extern int message_buf_print;
-
extern Lisp_Object Vframe_list;
extern Lisp_Object Vdefault_frame_alist;
extern int selected_frame;
extern int last_nonminibuf_frame;
-/* Nonzero means FRAME_MESSAGE_BUF (selected_frame) is being used by
- print. */
-extern int message_buf_print;
-
#define XFRAME(f) selected_frame
#define WINDOW_FRAME(w) selected_frame
-#define FRAMEP(f) (XTYPE(f) == Lisp_Frame)
#define FRAME_LIVE_P(f) 1
#define FRAME_TERMCAP_P(f) 1
#define FRAME_X_P(f) 0
#define FRAME_WIDTH(f) (the_only_frame.width)
#define FRAME_NEW_HEIGHT(f) (the_only_frame.new_height)
#define FRAME_NEW_WIDTH(f) (the_only_frame.new_width)
+#define FRAME_MENU_BAR_LINES(f) (the_only_frame.menu_bar_lines)
#define FRAME_CURSOR_X(f) (the_only_frame.cursor_x)
#define FRAME_CURSOR_Y(f) (the_only_frame.cursor_y)
+#define FRAME_SET_VISIBLE(f,p) (p)
#define FRAME_VISIBLE_P(f) 1
#define SET_FRAME_GARBAGED(f) (frame_garbaged = 1)
#define FRAME_GARBAGED_P(f) (frame_garbaged)
#define FRAME_NO_SPLIT_P(f) 0
#define FRAME_WANTS_MODELINE_P(f) 1
#define FRAME_ICONIFIED_P(f) 0
-#define FRAME_MINIBUF_WINDOW(f) (the_only_frame.root_window)
+#define FRAME_MINIBUF_WINDOW(f) (minibuf_window)
#define FRAME_ROOT_WINDOW(f) (the_only_frame.root_window)
#define FRAME_SELECTED_WINDOW(f) (selected_window)
#define SET_GLYPHS_FRAME(glyphs,frame) do ; while (0)
#define FRAME_DELETEN_COST(frame) (the_only_frame.delete_n_lines_cost)
#define FRAME_MESSAGE_BUF(f) (the_only_frame.message_buf)
#define FRAME_SCROLL_BOTTOM_VPOS(f) (the_only_frame.scroll_bottom_vpos)
-#define FRAME_FOCUS_FRAME(f) (0)
+#define FRAME_FOCUS_FRAME(f) (Qnil)
+#define FRAME_CAN_HAVE_SCROLL_BARS(f) (the_only_frame.can_have_scroll_bars)
+#define FRAME_HAS_VERTICAL_SCROLL_BARS(f) \
+ (the_only_frame.has_vertical_scroll_bars)
+#define FRAME_SCROLL_BARS(f) (the_only_frame.scroll_bars)
+#define FRAME_CONDEMNED_SCROLL_BARS(f) (the_only_frame.condemned_scroll_bars)
+#define FRAME_MENU_BAR_ITEMS(f) (the_only_frame.menu_bar_items)
/* See comments in definition above. */
#define FRAME_SAMPLE_VISIBILITY(f) (0)
/* FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
`for' loop which iterates over the elements of Vframe_list. The
- loop will set FRAME_VAR, a FRAME_PTR, to each frame in
+ loop will set FRAME_VAR, a Lisp_Object, to each frame in
Vframe_list in succession and execute the statement. LIST_VAR
- should be a Lisp_Object; it is used to iterate through the
+ should be a Lisp_Object too; it is used to iterate through the
Vframe_list.
If MULTI_FRAME _is_ defined, then this loop expands to a real
`for' loop which traverses Vframe_list using LIST_VAR and
FRAME_VAR. */
#define FOR_EACH_FRAME(list_var, frame_var) \
- for (frame_var = (FRAME_PTR) 1; frame_var; frame_var = (FRAME_PTR) 0)
+ for (list_var = Qt; frame_var = selected_frame, ! NILP (list_var); list_var = Qnil)
#endif /* not MULTI_FRAME */
+
+\f
+/* Device- and MULTI_FRAME-independent scroll bar stuff. */
+
+/* The number of columns a vertical scroll bar occupies. */
+#define VERTICAL_SCROLL_BAR_WIDTH (2)
+
+/* Return the starting column (zero-based) of the vertical scroll bar
+ for window W. The column before this one is the last column we can
+ use for text. If the window touches the right edge of the frame,
+ we have extra space allocated for it. Otherwise, the scroll bar
+ takes over the window's rightmost columns. */
+#define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
+ (((XINT ((w)->left) + XINT ((w)->width)) \
+ < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
+ ? XINT ((w)->left) + XINT ((w)->width) - VERTICAL_SCROLL_BAR_WIDTH \
+ : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w))))
+
+/* Return the height in lines of the vertical scroll bar in w. If the
+ window has a mode line, don't make the scroll bar extend that far. */
+#define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))