428
|
1 /* Window definitions for XEmacs.
|
|
2 Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995
|
|
3 Free Software Foundation, Inc.
|
|
4 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
|
872
|
5 Copyright (C) 1995, 1996, 2002 Ben Wing.
|
428
|
6 Copyright (C) 1996 Chuck Thompson.
|
|
7
|
|
8 This file is part of XEmacs.
|
|
9
|
|
10 XEmacs is free software; you can redistribute it and/or modify it
|
|
11 under the terms of the GNU General Public License as published by the
|
|
12 Free Software Foundation; either version 2, or (at your option) any
|
|
13 later version.
|
|
14
|
|
15 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
18 for more details.
|
|
19
|
|
20 You should have received a copy of the GNU General Public License
|
|
21 along with XEmacs; see the file COPYING. If not, write to
|
|
22 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
23 Boston, MA 02111-1307, USA. */
|
|
24
|
|
25 /* Synched up with: FSF 19.30. */
|
|
26
|
440
|
27 #ifndef INCLUDED_window_h_
|
|
28 #define INCLUDED_window_h_
|
428
|
29
|
|
30 #include "redisplay.h"
|
|
31 #ifdef HAVE_SCROLLBARS
|
|
32 #include "scrollbar.h"
|
|
33 #endif
|
|
34
|
872
|
35 struct window;
|
428
|
36
|
617
|
37 DECLARE_LRECORD (window, struct window);
|
|
38 #define XWINDOW(x) XRECORD (x, window, struct window)
|
|
39 #define wrap_window(p) wrap_record (p, window)
|
|
40 #define WINDOWP(x) RECORDP (x, window)
|
|
41 #define CHECK_WINDOW(x) CHECK_RECORD (x, window)
|
|
42 #define CONCHECK_WINDOW(x) CONCHECK_RECORD (x, window)
|
|
43
|
872
|
44 /* Basic properties available to non-privileged users; redefined in
|
|
45 window-impl.h */
|
428
|
46
|
872
|
47 int window_live_p (struct window *w);
|
|
48 Lisp_Object window_frame (struct window *w);
|
|
49 Lisp_Object window_buffer (struct window *w);
|
428
|
50
|
872
|
51 #define WINDOW_LIVE_P(w) window_live_p (w)
|
|
52 #define WINDOW_FRAME(w) window_frame (w)
|
|
53 #define WINDOW_BUFFER(w) window_buffer (w)
|
428
|
54
|
872
|
55 #define WINDOW_XFRAME(w) XFRAME (WINDOW_FRAME (w))
|
|
56 #define WINDOW_DEVICE(w) XFRAME_DEVICE (WINDOW_FRAME (w))
|
|
57 #define WINDOW_XDEVICE(w) XDEVICE (WINDOW_DEVICE (w))
|
|
58 #define WINDOW_CONSOLE(w) XDEVICE_CONSOLE (WINDOW_DEVICE (w))
|
|
59 #define WINDOW_XCONSOLE(w) XCONSOLE (WINDOW_CONSOLE (w))
|
|
60 #define WINDOW_XBUFFER(w) XBUFFER (WINDOW_BUFFER (w))
|
428
|
61
|
872
|
62 #define XWINDOW_FRAME(w) WINDOW_FRAME (XWINDOW (w))
|
|
63 #define XWINDOW_XFRAME(w) XFRAME (XWINDOW_FRAME (w))
|
|
64 #define XWINDOW_DEVICE(w) XFRAME_DEVICE (XWINDOW_FRAME (w))
|
|
65 #define XWINDOW_XDEVICE(w) XDEVICE (XWINDOW_DEVICE (w))
|
|
66 #define XWINDOW_CONSOLE(w) XDEVICE_CONSOLE (XWINDOW_DEVICE (w))
|
|
67 #define XWINDOW_XCONSOLE(w) XCONSOLE (XWINDOW_CONSOLE (w))
|
|
68 #define XWINDOW_BUFFER(w) WINDOW_BUFFER (XWINDOW (w))
|
|
69 #define XWINDOW_XBUFFER(w) XBUFFER (XWINDOW_BUFFER (w))
|
428
|
70
|
|
71 #define CHECK_LIVE_WINDOW(x) do { \
|
|
72 CHECK_WINDOW (x); \
|
|
73 if (!WINDOW_LIVE_P (XWINDOW (x))) \
|
|
74 dead_wrong_type_argument (Qwindow_live_p, (x)); \
|
|
75 } while (0)
|
|
76 #define CONCHECK_LIVE_WINDOW(x) do { \
|
|
77 CONCHECK_WINDOW (x); \
|
|
78 if (!WINDOW_LIVE_P (XWINDOW (x))) \
|
|
79 x = wrong_type_argument (Qwindow_live_p, (x)); \
|
|
80 } while (0)
|
|
81
|
872
|
82 struct window_mirror;
|
428
|
83
|
872
|
84 DECLARE_LRECORD (window_mirror, struct window_mirror);
|
|
85 #define XWINDOW_MIRROR(x) XRECORD (x, window_mirror, struct window_mirror)
|
|
86 #define wrap_window_mirror(p) wrap_record (p, window_mirror)
|
|
87 #define WINDOW_MIRRORP(x) RECORDP (x, window_mirror)
|
|
88 #define CHECK_WINDOW_MIRROR(x) CHECK_RECORD (x, window_mirror)
|
|
89 #define CONCHECK_WINDOW_MIRROR(x) CONCHECK_RECORD (x, window_mirror)
|
428
|
90
|
|
91 DECLARE_LRECORD (window_configuration, struct window_config);
|
|
92
|
|
93 EXFUN (Fget_buffer_window, 3);
|
|
94 EXFUN (Fmove_to_window_line, 2);
|
|
95 EXFUN (Frecenter, 2);
|
444
|
96 EXFUN (Freplace_buffer_in_windows, 3);
|
428
|
97 EXFUN (Fselect_window, 2);
|
|
98 EXFUN (Fselected_window, 1);
|
440
|
99 EXFUN (Fset_window_buffer, 3);
|
428
|
100 EXFUN (Fset_window_hscroll, 2);
|
|
101 EXFUN (Fset_window_point, 2);
|
|
102 EXFUN (Fset_window_start, 3);
|
|
103 EXFUN (Fwindow_buffer, 1);
|
|
104 EXFUN (Fwindow_highest_p, 1);
|
|
105 EXFUN (Fwindow_point, 1);
|
|
106 EXFUN (Fwindow_start, 1);
|
872
|
107 EXFUN (Fcurrent_window_configuration, 1);
|
|
108
|
|
109 Lisp_Object save_window_excursion_unwind (Lisp_Object);
|
|
110 Lisp_Object display_buffer (Lisp_Object, Lisp_Object, Lisp_Object);
|
428
|
111
|
|
112 /* The minibuffer window of the selected frame.
|
|
113 Note that you cannot test for minibufferness of an arbitrary window
|
|
114 by comparing against this; but you can test for minibufferness of
|
|
115 the selected window or of any window that is displayed. */
|
|
116 extern Lisp_Object minibuf_window;
|
|
117
|
|
118 /* Prompt to display in front of the minibuffer contents, or nil */
|
|
119 extern Lisp_Object Vminibuf_prompt;
|
|
120 /* Prompt to display in front of the minibuffer prompt, or nil */
|
|
121 extern Lisp_Object Vminibuf_preprompt;
|
|
122
|
|
123 Lisp_Object allocate_window (void);
|
|
124 int window_char_width (struct window *, int include_margins_p);
|
|
125 int window_char_height (struct window *, int include_gutters_p);
|
|
126 int window_displayed_height (struct window *);
|
|
127 int window_is_leftmost (struct window *w);
|
|
128 int window_is_rightmost (struct window *w);
|
|
129 int window_is_lowest (struct window *w);
|
|
130 int window_is_highest (struct window *w);
|
|
131 int window_truncation_on (struct window *w);
|
|
132 int window_needs_vertical_divider (struct window *);
|
|
133 int window_scrollbar_width (struct window *w);
|
|
134 int window_scrollbar_height (struct window *w);
|
|
135 int window_modeline_height (struct window *w);
|
|
136 int window_left_margin_width (struct window *w);
|
|
137 int window_right_margin_width (struct window *w);
|
|
138 int window_top_gutter_height (struct window *w);
|
|
139 int window_bottom_gutter_height (struct window *w);
|
|
140 int window_left_gutter_width (struct window *w, int modeline);
|
|
141 int window_right_gutter_width (struct window *w, int modeline);
|
|
142
|
|
143 void delete_all_subwindows (struct window *w);
|
|
144 void set_window_pixheight (Lisp_Object window, int pixheight,
|
|
145 int nodelete);
|
|
146 void set_window_pixwidth (Lisp_Object window, int pixwidth,
|
|
147 int nodelete);
|
|
148 void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
|
578
|
149 Error_Behavior errb);
|
428
|
150 int buffer_window_count (struct buffer *b, struct frame *f);
|
|
151 int buffer_window_mru (struct window *w);
|
|
152 void check_frame_size (struct frame *frame, int *rows, int *cols);
|
440
|
153 int frame_pixsize_valid_p (struct frame *frame, int width, int height);
|
|
154 int frame_size_valid_p (struct frame *frame, int rows, int cols);
|
428
|
155 struct window *decode_window (Lisp_Object window);
|
|
156 struct window *find_window_by_pixel_pos (int pix_x, int pix_y, Lisp_Object win);
|
|
157
|
|
158 void free_window_mirror (struct window_mirror *mir);
|
|
159 Lisp_Object real_window (struct window_mirror *mir, int no_abort);
|
|
160 struct window_mirror *find_window_mirror (struct window *w);
|
|
161 display_line_dynarr *window_display_lines (struct window *w, int);
|
|
162 struct buffer *window_display_buffer (struct window *w);
|
|
163 void set_window_display_buffer (struct window *w, struct buffer *b);
|
|
164 void update_frame_window_mirror (struct frame *f);
|
|
165
|
|
166 int map_windows (struct frame *f,
|
|
167 int (*mapfun) (struct window *w, void *closure),
|
|
168 void *closure);
|
|
169 void some_window_value_changed (Lisp_Object specifier, struct window *w,
|
|
170 Lisp_Object oldval);
|
|
171 int invalidate_vertical_divider_cache_in_window (struct window *w,
|
|
172 void *u_n_u_s_e_d);
|
|
173 int window_divider_width (struct window *w);
|
|
174
|
440
|
175 #endif /* INCLUDED_window_h_ */
|