annotate src/console.h @ 874:d4ba25667ff4

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