annotate src/devslots.h @ 980:2ec85ed291da

[xemacs-hg @ 2002-08-30 08:05:30 by youngs] 2002-08-29 Jerry James <james@xemacs.org> * lisp.h: structrures -> structures.
author youngs
date Fri, 30 Aug 2002 08:05:32 +0000
parents 79c6ff3eef26
children e22b0213b713
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
1 /* Definitions of marked slots in consoles
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
2 Copyright (C) 1990, 1992, 1993 Free Software Foundation, Inc.
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 617
diff changeset
3 Copyright (C) 2002 Ben Wing.
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
4
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
5 This file is part of XEmacs.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
6
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify it
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
10 later version.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
11
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
15 for more details.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
16
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
21
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
22 /* Synched up with: Not in FSF. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
23
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
24 /* We define the Lisp_Objects in the device structure in a separate file
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
25 because there are numerous places we want to iterate over them, such
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
26 as when defining them in the structure, initializing them, or marking
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
27 them.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
28
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
29 To use, define MARKED_SLOT before including this file. In the structure
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
30 definition, you also need to define FRAME_SLOT_DECLARATION. No need to
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
31 undefine either value; that happens automatically. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
32
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
33 /* Name of this device, for resourcing and printing purposes.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
34 If not explicitly given, it's initialized in a device-specific
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
35 manner. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
36 MARKED_SLOT (name);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
37
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
38 /* What this device is connected to */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
39 MARKED_SLOT (connection);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
40
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
41 /* A canonical name for the connection that is used to determine
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
42 whether `make-device' is being called on an existing device. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
43 MARKED_SLOT (canon_connection);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
44
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
45 /* List of frames on this device. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
46 MARKED_SLOT (frame_list);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
47
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
48 /* The console this device is on. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
49 MARKED_SLOT (console);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
50
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
51 /* Frame which is "currently selected". This is what `selected-frame'
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
52 returns and is the default frame for many operations. This may
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
53 not be the same as frame_with_focus; `select-frame' changes the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
54 selected_frame but not the frame_with_focus. However, eventually
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
55 either the two values will be the same, or frame_with_focus will
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
56 be nil: right before waiting for an event, the focus is changed
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
57 to point to the selected_frame if XEmacs currently has the focus
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
58 on this device. Note that frame_with_focus may be nil (none of the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
59 frames on this device have the window-system focus), but
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
60 selected_frame will never be nil if there are any frames on
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
61 the device. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
62 MARKED_SLOT (selected_frame);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
63 /* Frame that currently contains the window-manager focus, or none.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
64 Note that we've split frame_with_focus into two variables.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
65 frame_with_focus_real is the value we use most of the time,
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
66 but frame_with_focus_for_hooks is used for running the select-frame-hook
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
67 and deselect-frame-hook. We do this because we split the focus handling
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
68 into two parts: one part (deals with drawing the solid/box cursor)
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
69 runs as soon as a focus event is received; the other (running the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
70 hooks) runs after any pending sit-for/sleep-for/accept-process-output
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
71 calls are done. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
72 MARKED_SLOT (frame_with_focus_real);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
73 MARKED_SLOT (frame_with_focus_for_hooks);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
74 /* If we have recently issued a request to change the focus as a
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
75 result of select-frame having been called, the following variable
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
76 records the frame we are trying to focus on. The reason for this
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
77 is that the window manager may not grant our request to change
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
78 the focus (so we can't just change frame_with_focus), and we don't
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
79 want to keep sending requests again and again to the window manager.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
80 This variable is reset whenever a focus-change event is seen. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
81 MARKED_SLOT (frame_that_ought_to_have_focus);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
82
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
83 /* Color class of this device. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
84 MARKED_SLOT (device_class);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
85
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
86 /* Alist of values for user-defined tags in this device. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
87 MARKED_SLOT (user_defined_tags);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
88
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
89 /* Hash tables for device-specific objects (fonts, colors, etc).
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
90 These are key-weak hash tables (or hash tables containing key-weak
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
91 hash tables) so that they disappear when the key goes away. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
92
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
93 /* This is a simple key-weak hash table hashing color names to
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
94 instances. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
95 MARKED_SLOT (color_instance_cache);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
96
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
97 /* This is a simple key-weak hash table hashing font names to
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
98 instances. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
99 MARKED_SLOT (font_instance_cache);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
100
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
101 #ifdef MULE
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
102 /* This is a bi-level cache, where the hash table in this slot here
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
103 indexes charset objects to key-weak hash tables, which in turn
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
104 index font names to more specific font names that match the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
105 given charset's registry. This speeds up the horrendously
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
106 slow XListFonts() operation that needs to be done in order
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
107 to determine an appropriate font. */
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 617
diff changeset
108 MARKED_SLOT (charset_font_cache_stage_1);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 617
diff changeset
109
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 617
diff changeset
110 /* Similar cache for stage 2, if it exists. See objects.c. */
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 617
diff changeset
111 MARKED_SLOT (charset_font_cache_stage_2);
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
112 #endif
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
113
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
114 /* This is a bi-level cache, where the hash table in this slot here
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
115 indexes image-instance-type masks (there are currently 6
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
116 image-instance types and thus 64 possible masks) to key-weak hash
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
117 tables like the one for colors. */
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
118 MARKED_SLOT (image_instance_cache);
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
119
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents:
diff changeset
120 #undef MARKED_SLOT