428
|
1 /* Define console object for XEmacs.
|
872
|
2 Copyright (C) 1996, 2002 Ben Wing
|
428
|
3
|
|
4 This file is part of XEmacs.
|
|
5
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
7 under the terms of the GNU General Public License as published by the
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
9 later version.
|
|
10
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 for more details.
|
|
15
|
|
16 You should have received a copy of the GNU General Public License
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
19 Boston, MA 02111-1307, USA. */
|
|
20
|
|
21 /* Synched up with: Not in FSF. */
|
|
22
|
|
23 /* Written by Ben Wing. */
|
|
24
|
440
|
25 #ifndef INCLUDED_console_h_
|
|
26 #define INCLUDED_console_h_
|
428
|
27
|
|
28 /* Devices and consoles are similar entities. The idea is that
|
|
29 a console represents a physical keyboard/mouse/other-input-source
|
|
30 while a device represents a display where frames appear on.
|
|
31 In the X world, a console is a "Display" while a device is a
|
|
32 "Screen". Implementationally, it can sometimes get confusing:
|
|
33 under X, multiple devices on a single console are different
|
|
34 "Display" connections to what is in reality the same Display on
|
|
35 the same server. Because of this, input comes from the device
|
|
36 and not from the console. This is OK because events are basically
|
|
37 always tagged to a particular X window (i.e. frame),
|
|
38 which exists on only one screen; therefore the event won't be
|
|
39 reported multiple times even if there are multiple devices on
|
|
40 the same physical display. This is an implementation detail
|
|
41 specific to X consoles (e.g. under NeXTstep or Windows, this
|
|
42 could be different, and input would come directly from the console).
|
|
43 */
|
|
44
|
|
45
|
|
46 /* GCC does not like forward enum declaration. This needs to be
|
|
47 defined here. What a disgust! */
|
|
48
|
934
|
49 #ifdef USE_KKCC
|
|
50 enum console_variant
|
|
51 {
|
|
52 dead_console,
|
|
53 tty_console,
|
|
54 gtk_console,
|
|
55 x_console,
|
|
56 mswindows_console,
|
|
57 stream_console
|
|
58 };
|
|
59
|
|
60 #endif /* USE_KKCC */
|
|
61
|
428
|
62 enum device_metrics
|
|
63 {
|
|
64 DM_color_default, DM_color_select, DM_color_balloon, DM_color_3d_face,
|
|
65 DM_color_3d_light, DM_color_3d_dark, DM_color_menu, DM_color_menu_highlight,
|
|
66 DM_color_menu_button, DM_color_menu_disabled, DM_color_toolbar,
|
|
67 DM_color_scrollbar, DM_color_desktop, DM_color_workspace, DM_font_default,
|
|
68 DM_font_menubar, DM_font_dialog, DM_size_cursor, DM_size_scrollbar,
|
|
69 DM_size_menu, DM_size_toolbar, DM_size_toolbar_button,
|
|
70 DM_size_toolbar_border, DM_size_icon, DM_size_icon_small, DM_size_device,
|
440
|
71 DM_size_workspace, DM_offset_workspace, DM_size_device_mm, DM_device_dpi,
|
|
72 DM_num_bit_planes, DM_num_color_cells, DM_mouse_buttons, DM_swap_buttons,
|
|
73 DM_show_sounds, DM_slow_device, DM_security
|
428
|
74 };
|
|
75
|
872
|
76 struct console;
|
428
|
77
|
|
78 DECLARE_LRECORD (console, struct console);
|
|
79 #define XCONSOLE(x) XRECORD (x, console, struct console)
|
617
|
80 #define wrap_console(p) wrap_record (p, console)
|
428
|
81 #define CONSOLEP(x) RECORDP (x, console)
|
|
82 #define CHECK_CONSOLE(x) CHECK_RECORD (x, console)
|
|
83 #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console)
|
|
84
|
872
|
85 /* Basic properties available to non-privileged users; redefined in
|
|
86 console-impl.h */
|
|
87
|
874
|
88 struct console_methods;
|
|
89
|
872
|
90 int console_live_p (struct console *c);
|
|
91 Lisp_Object console_device_list (struct console *c);
|
|
92
|
|
93 #define CONSOLE_LIVE_P(c) console_live_p (c)
|
|
94 #define CONSOLE_DEVICE_LIST(c) console_device_list (c)
|
|
95
|
428
|
96 #define CHECK_LIVE_CONSOLE(x) do { \
|
|
97 CHECK_CONSOLE (x); \
|
|
98 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \
|
|
99 dead_wrong_type_argument (Qconsole_live_p, (x)); \
|
|
100 } while (0)
|
|
101 #define CONCHECK_LIVE_CONSOLE(x) do { \
|
|
102 CONCHECK_CONSOLE (x); \
|
|
103 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \
|
|
104 x = wrong_type_argument (Qconsole_live_p, (x)); \
|
|
105 } while (0)
|
|
106
|
|
107 #define CDFW_CONSOLE(obj) \
|
|
108 (WINDOWP (obj) ? WINDOW_CONSOLE (XWINDOW (obj)) \
|
|
109 : (FRAMEP (obj) ? FRAME_CONSOLE (XFRAME (obj)) \
|
|
110 : (DEVICEP (obj) ? DEVICE_CONSOLE (XDEVICE (obj)) \
|
|
111 : (CONSOLEP (obj) ? obj \
|
|
112 : Qnil))))
|
|
113
|
|
114 #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list)
|
|
115 #define CONSOLE_DEVICE_LOOP(devcons, con) \
|
|
116 LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con))
|
|
117
|
872
|
118 EXFUN (Fconsole_disable_input, 1);
|
|
119 EXFUN (Fdelete_console, 2);
|
|
120 EXFUN (Fselect_console, 1);
|
|
121 EXFUN (Fselected_console, 0);
|
|
122
|
|
123 extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook;
|
|
124 extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console;
|
|
125
|
|
126 int valid_console_type_p (Lisp_Object type);
|
428
|
127
|
|
128 Lisp_Object create_console (Lisp_Object name, Lisp_Object type,
|
|
129 Lisp_Object connection, Lisp_Object props);
|
|
130 void select_console_1 (Lisp_Object);
|
|
131 struct console *decode_console (Lisp_Object);
|
|
132 void add_entry_to_console_type_list (Lisp_Object symbol,
|
|
133 struct console_methods *type);
|
|
134 struct console_methods *decode_console_type (Lisp_Object type,
|
578
|
135 Error_Behavior errb);
|
934
|
136
|
|
137 #ifdef USE_KKCC
|
|
138 enum console_variant get_console_variant (Lisp_Object type);
|
|
139 #endif /* USE_KKCC */
|
|
140
|
428
|
141 void delete_console_internal (struct console *con, int force,
|
|
142 int from_kill_emacs, int from_io_error);
|
|
143 void io_error_delete_console (Lisp_Object console);
|
|
144 void set_console_last_nonminibuf_frame (struct console *con,
|
|
145 Lisp_Object frame);
|
872
|
146 void stuff_buffered_input (Lisp_Object);
|
428
|
147
|
440
|
148 #endif /* INCLUDED_console_h_ */
|