|
428
|
1 @c -*-texinfo-*-
|
|
|
2 @c This is part of the XEmacs Lisp Reference Manual.
|
|
|
3 @c Copyright (C) 1995, 1996 Ben Wing.
|
|
1135
|
4 @c Copyright (C) 2002 Free Software Foundation, Inc.
|
|
428
|
5 @c See the file lispref.texi for copying conditions.
|
|
|
6 @setfilename ../../info/specifiers.info
|
|
|
7 @node Specifiers, Faces and Window-System Objects, Extents, top
|
|
|
8 @chapter Specifiers
|
|
|
9 @cindex specifier
|
|
|
10
|
|
|
11 A specifier is an object used to keep track of a property whose value
|
|
1135
|
12 should vary according to @emph{display context}, a window, a frame, or
|
|
|
13 device. The value of many built-in properties, such as the font,
|
|
|
14 foreground, background, and such properties of a face and variables
|
|
|
15 such as @code{modeline-shadow-thickness} and
|
|
|
16 @code{top-toolbar-height}, is actually a specifier object. The
|
|
|
17 specifier object, in turn, is ``instanced'' in a particular situation
|
|
|
18 to yield the real value of the property in the current context.
|
|
428
|
19
|
|
|
20 @defun specifierp object
|
|
|
21 This function returns non-@code{nil} if @var{object} is a specifier.
|
|
|
22 @end defun
|
|
|
23
|
|
|
24 @menu
|
|
440
|
25 * Introduction to Specifiers:: Specifiers provide a clean way for
|
|
|
26 display and other properties to vary
|
|
|
27 (under user control) in a wide variety
|
|
|
28 of contexts.
|
|
1135
|
29 * Simple Specifier Usage:: Getting started with specifiers.
|
|
440
|
30 * Specifiers In-Depth:: Gory details about specifier innards.
|
|
|
31 * Specifier Instancing:: Instancing means obtaining the ``value'' of
|
|
|
32 a specifier in a particular context.
|
|
|
33 * Specifier Types:: Specifiers come in different flavors.
|
|
|
34 * Adding Specifications:: Specifications control a specifier's ``value''
|
|
|
35 by giving conditions under which a
|
|
|
36 particular value is valid.
|
|
|
37 * Retrieving Specifications:: Querying a specifier's specifications.
|
|
|
38 * Specifier Tag Functions:: Working with specifier tags.
|
|
428
|
39 * Specifier Instancing Functions::
|
|
440
|
40 Functions to instance a specifier.
|
|
|
41 * Specifier Example:: Making all this stuff clearer.
|
|
|
42 * Creating Specifiers:: Creating specifiers for your own use.
|
|
428
|
43 * Specifier Validation Functions::
|
|
440
|
44 Validating the components of a specifier.
|
|
428
|
45 * Other Specification Functions::
|
|
440
|
46 Other ways of working with specifications.
|
|
428
|
47 @end menu
|
|
|
48
|
|
|
49 @node Introduction to Specifiers
|
|
|
50 @section Introduction to Specifiers
|
|
|
51
|
|
1135
|
52 Perhaps the most useful way to explain specifiers is via an analogy.
|
|
|
53 Emacs Lisp programmers are used to @emph{buffer-local variables}
|
|
|
54 @ref{buffer-local variables}. For example, the variable
|
|
428
|
55 @code{modeline-format}, which controls the format of the modeline, can
|
|
|
56 have different values depending on the particular buffer being edited.
|
|
|
57 The variable has a default value which most modes will use, but a
|
|
1135
|
58 specialized package such as Calendar might change the variable so as
|
|
|
59 to tailor the modeline to its own purposes. Other variables are
|
|
|
60 perhaps best thought of as ``mode local,'' such as font-lock keywords,
|
|
|
61 but they are implemented as buffer locals.
|
|
428
|
62
|
|
|
63 Other properties (such as those that can be changed by the
|
|
|
64 @code{modify-frame-parameters} function, for example the color of the
|
|
|
65 text cursor) can have frame-local values, although it might also make
|
|
|
66 sense for them to have buffer-local values. In other cases, you might
|
|
|
67 want the property to vary depending on the particular window within the
|
|
|
68 frame that applies (e.g. the top or bottom window in a split frame), the
|
|
|
69 device type that that frame appears on (X or tty), etc. Perhaps you can
|
|
|
70 envision some more complicated scenario where you want a particular
|
|
|
71 value in a specified buffer, another value in all other buffers
|
|
|
72 displayed on a particular frame, another value in all other buffers
|
|
|
73 displayed in all other frames on any mono (two-color, e.g. black and
|
|
|
74 white only) displays, and a default value in all other circumstances.
|
|
|
75
|
|
1135
|
76 Specifiers generalize both buffer- and frame-local properties.
|
|
|
77 Specifiers vary according to the @emph{display} context. Font-lock
|
|
|
78 keywords in a buffer will be the same no matter which window the
|
|
|
79 buffer is displayed in, but windows on TTY devices will simply not be
|
|
|
80 capable of the flexibility that windows on modern GUI devices are.
|
|
|
81 Specifiers provide a way for the programmer to @emph{declare} that a
|
|
|
82 emphasized text should be italic on GUI devices and inverse video on
|
|
|
83 TTYs. They also provide a way for the programmer to declare
|
|
|
84 fallbacks, so that a color specified as ``chartreuse'' where possible
|
|
|
85 can fall back to ``yellow'' on devices where only ANSI (4-bit) color
|
|
|
86 is available. The complex calculations and device querying are
|
|
|
87 transparent to both user and programmer. You ask for what you want;
|
|
|
88 it's up to XEmacs to provide it, or a reasonable approximation.
|
|
|
89
|
|
|
90 We call such a declaration a @dfn{specification}. A @dfn{specification}
|
|
|
91 applies in a particular @dfn{locale}, which is a window, buffer, frame,
|
|
|
92 device, or the global locale. The value part of the specification is
|
|
|
93 called an @dfn{instantiator}. The process of determining the value in a
|
|
|
94 particular context, or @dfn{domain}, is called @dfn{instantiation} or
|
|
|
95 @dfn{instancing}. A domain is a window, frame, or device.
|
|
|
96
|
|
|
97 The difference between @dfn{locale} and @dfn{domain} is somewhat subtle.
|
|
|
98 You may think of a locale as a class of domains, which may span
|
|
|
99 different devices. Since the specification is abstract (a Lisp form),
|
|
|
100 you can state it without reference to a device. On the other hand, when
|
|
|
101 you instantiate a specification, you must know the type of the device.
|
|
|
102 It is useless to specify that ``blue mean italic'' on a monochrome
|
|
|
103 device. Thus instantiation requires specification of the device on
|
|
|
104 which it will be rendered.
|
|
|
105
|
|
|
106 Thus a @dfn{specifier} allows a great deal of flexibility in
|
|
|
107 controlling exactly what value a property has in which circumstances.
|
|
|
108 It is most commonly used for display properties, such as an image or
|
|
|
109 the foreground color of a face. As a simple example, you can specify
|
|
|
110 that the foreground of the default face be
|
|
428
|
111
|
|
|
112 @itemize @bullet
|
|
|
113 @item
|
|
|
114 blue for a particular buffer
|
|
|
115 @item
|
|
|
116 green for all other buffers
|
|
|
117 @end itemize
|
|
|
118
|
|
|
119 As a more complicated example, you could specify that the foreground of
|
|
|
120 the default face be
|
|
|
121
|
|
|
122 @itemize @bullet
|
|
|
123 @item
|
|
|
124 forest green for all buffers displayed in a particular Emacs window, or
|
|
|
125 green if the X server doesn't recognize the color @samp{forest green}
|
|
|
126 @item
|
|
|
127 blue for all buffers displayed in a particular frame
|
|
|
128 @item
|
|
|
129 red for all other buffers displayed on a color device
|
|
|
130 @item
|
|
|
131 white for all other buffers
|
|
|
132 @end itemize
|
|
|
133
|
|
1135
|
134 @node Simple Specifier Usage
|
|
|
135 @section Simple Specifier Usage
|
|
|
136 @cindex specifier examples
|
|
|
137 @cindex examples, specifier
|
|
|
138 @cindex adding a button to a toolbar
|
|
|
139 @cindex toolbar button, adding
|
|
|
140
|
|
|
141 A useful specifier application is adding a button to a toolbar. XEmacs
|
|
|
142 provides several toolbars, one along each edge of the frame. Normally
|
|
|
143 only one is used at a time, the default. The default toolbar is
|
|
|
144 actually a specifier object which is the value of @code{default-toolbar}.
|
|
|
145
|
|
|
146 The specification of a toolbar is simple: it is a list of buttons.
|
|
|
147 Each button is a vector with four elements: an icon, a command, the
|
|
|
148 enabled flag, and a help string. Let's retrieve the instance of the
|
|
|
149 toolbar you see in the selected frame.
|
|
|
150
|
|
|
151 @example
|
|
|
152 (specifier-instance default-toolbar)
|
|
|
153 @end example
|
|
|
154
|
|
|
155 The value returned is, as promised, a list of vectors. Now let's build
|
|
|
156 up a button, and add it to the toolbar. Our button will invoke the last
|
|
|
157 defined keyboard macro. This is an alternative to
|
|
|
158 @code{name-last-kbd-macro} for creating a persistent macro, rather than
|
|
|
159 an alias for @kbd{C-x e}.
|
|
|
160
|
|
|
161 A toolbar button icon can be quite sophisticated, with different images
|
|
|
162 for button up, button down, and disabled states, and a similar set with
|
|
|
163 captions. We'll use a very simple icon, but we have to jump through a
|
|
|
164 few non-obvious hoops designed to support the sophisticated applications.
|
|
|
165 The rest of the button descriptor is straightforward.
|
|
|
166
|
|
|
167 @example
|
|
|
168 (setq toolbar-my-kbd-macro-button
|
|
|
169 `[ (list (make-glyph "MyKbdMac"))
|
|
|
170 (lambda () (interactive) (execute-kbd-macro ,last-kbd-macro))
|
|
|
171 t
|
|
|
172 "Execute a previously defined keyboard macro." ])
|
|
|
173
|
|
|
174 (set-specifier default-toolbar
|
|
|
175 (cons toolbar-my-kbd-macro-button
|
|
|
176 (specifier-specs default-toolbar 'global))
|
|
|
177 'global)
|
|
|
178 @end example
|
|
|
179
|
|
|
180 To remove the button, just substitute the function @code{delete} for the
|
|
|
181 @code{cons} above.
|
|
|
182
|
|
|
183 What is the difference between @code{specifier-instance}, which we used
|
|
|
184 in the example of retrieving the toolbar descriptor, and
|
|
|
185 @code{specifier-specs}, which was used in the toolbar manipulating code?
|
|
|
186 @code{specifier-specs} retrieves a copy of the instantiator, which is
|
|
|
187 abstract and does not depend on context. @code{specifier-instance}, on
|
|
|
188 the other hand, actually instantiates the specification, and returns the
|
|
|
189 result for the given context. Another way to express this is:
|
|
|
190 @code{specifier-specs} takes a @emph{locale} as an argument, while
|
|
|
191 @code{specifier-instance} takes a @emph{domain}. The reason for
|
|
|
192 providing @code{specifier-instance} is that sometimes you wish to see
|
|
|
193 the object that XEmacs will actually use. @code{specifier-specs}, on
|
|
|
194 the other hand, shows you what the programmer (or user) requested. When
|
|
|
195 a program manipulates specifications, clearly it's the latter that is
|
|
|
196 desirable.
|
|
|
197
|
|
|
198 In the case of the toolbar descriptor, it turns out that these are the
|
|
|
199 same: the instancing process is trivial. However, many specifications
|
|
|
200 have non-trivial instancing. Compare the results of the following forms
|
|
|
201 on my system. (The @samp{(cdr (first ...))} form is due to my use of
|
|
|
202 Mule. On non-Mule XEmacsen, just use @code{specifier-specs}.)
|
|
|
203
|
|
|
204 @example
|
|
|
205 (cdr (first (specifier-specs (face-font 'default) 'global)))
|
|
|
206 => "-*--14-*jisx0208*-0"
|
|
|
207
|
|
|
208 (specifier-instance (face-font 'default))
|
|
|
209 #<font-instance "-*--14-*jisx0208*-0" on #<x-device on ":0.0" 0x970> 0xe0028b 0x176b>
|
|
|
210 @end example
|
|
|
211
|
|
|
212 In this case, @code{specifier-instance} returns an opaque object;
|
|
|
213 programs can't work on it, they can only pass it around. Worse, in some
|
|
|
214 environments the instantiation will fail, resulting in a different value
|
|
|
215 (when another instantiation succeeds), or worse yet, an error, if all
|
|
|
216 attempts to instance the specifier fail. @code{specifier-instance} is
|
|
|
217 context-dependent, even for the exact same specification.
|
|
|
218 @code{specifier-specs} is deterministic, and only depends on the
|
|
|
219 specifications.
|
|
|
220
|
|
|
221 Note that in the toolbar-changing code we operate in the global locale.
|
|
|
222 This means that narrower locales, if they have specifications, will
|
|
|
223 shadow our changes. (Specifier instancing does not merge
|
|
|
224 specifications. It selects the "highest-priority successful
|
|
|
225 specification" and instances that.)
|
|
|
226
|
|
|
227 In fact, in our example, it seems pretty likely that different buffers
|
|
|
228 @emph{should} have different buttons. (The icon can be the same, but
|
|
|
229 the keyboard macro you create in a Dired buffer is highly unlikely to be
|
|
|
230 useful in a LaTeX buffer!) Here's one way to implement this:
|
|
|
231
|
|
|
232 @example
|
|
|
233 (setq toolbar-my-kbd-macro-button
|
|
|
234 `[ (list (make-glyph "MyKbdMac"))
|
|
|
235 (lambda () (interactive) (execute-kbd-macro ,last-kbd-macro))
|
|
|
236 t
|
|
|
237 "Execute a previously defined keyboard macro." ])
|
|
|
238
|
|
|
239 (set-specifier default-toolbar
|
|
|
240 (cons toolbar-my-kbd-macro-button
|
|
|
241 (cond ((specifier-specs default-toolbar
|
|
|
242 (current-buffer)))
|
|
|
243 ((specifier-specs default-toolbar
|
|
|
244 'global)))
|
|
|
245 (current-buffer))
|
|
|
246 @end example
|
|
|
247
|
|
|
248 Finally, a cautionary note: the use of @code{specifier-specs} in the
|
|
|
249 code above is for expository purposes. Don't use it in production code.
|
|
|
250 In fact, the @code{set-specifier} form above is likely to fail
|
|
|
251 occasionally, because you can add many specifications for the same
|
|
|
252 locale.
|
|
|
253
|
|
|
254 In these cases, @code{specifier-specs} will return a list. A further
|
|
|
255 refinement is that a specification may be associated with a set of
|
|
|
256 @dfn{specifier tags}. If the list of specifier tags is non-nil, then
|
|
|
257 @code{specifier-specs} will return a cons of the tag set and the
|
|
|
258 instantiator. Evidently @code{specifier-specs} is a bit unreliable.
|
|
|
259 (For toolbars, the code above should work 99% of the time, because
|
|
|
260 toolbars are rarely changed. Since instantiation is trivial, multiple
|
|
|
261 specs are not useful---the first one always succeeds.)
|
|
|
262
|
|
|
263 In fact, @code{specifier-specs} is intended to be used to display specs
|
|
|
264 to humans with a minimum of clutter. The robust way to access
|
|
|
265 specifications is via @code{specifier-spec-list}. @xref{Adding
|
|
|
266 Specifications}, for the definition of @dfn{spec-list}.
|
|
|
267 @xref{Retrieving Specifications} for documentation of
|
|
|
268 @code{specifier-specs} and @code{specifier-spec-list}. To get the
|
|
|
269 desired effect, replace the form @code{(specifier-spec default-toolbar
|
|
|
270 'global)} with
|
|
|
271
|
|
|
272 @example
|
|
|
273 (cdr (second (first (specifier-spec-list default-toolbar 'global))))
|
|
|
274 @end example
|
|
|
275
|
|
|
276 (It should be obvious why the example uses the lazy unreliable method!)
|
|
|
277
|
|
428
|
278 @node Specifiers In-Depth
|
|
|
279 @section In-Depth Overview of a Specifier
|
|
|
280 @cindex specification (in a specifier)
|
|
|
281 @cindex domain (in a specifier)
|
|
|
282 @cindex locale (in a specifier)
|
|
|
283 @cindex instantiator (in a specifier)
|
|
|
284 @cindex instancing (in a specifier)
|
|
|
285 @cindex instance (in a specifier)
|
|
|
286 @cindex inst-list (in a specifier)
|
|
|
287 @cindex inst-pair (in a specifier)
|
|
|
288 @cindex tag (in a specifier)
|
|
|
289 @cindex tag set (in a specifier)
|
|
|
290 @cindex specifier, specification
|
|
|
291 @cindex specifier, domain
|
|
|
292 @cindex specifier, locale
|
|
|
293 @cindex specifier, instantiator
|
|
|
294 @cindex specifier, instancing
|
|
|
295 @cindex specifier, instance
|
|
|
296 @cindex specifier, inst-list
|
|
|
297 @cindex specifier, inst-pair
|
|
|
298 @cindex specifier, tag
|
|
|
299 @cindex specifier, tag set
|
|
|
300
|
|
1135
|
301 Having variables vary according the editing context is very useful, and
|
|
|
302 the buffer is the natural ``atomic'' unit of editing context. In a GUI
|
|
|
303 environment, it can be similarly useful to have variables whose values
|
|
|
304 vary according to display context. The atomic unit of display context
|
|
|
305 is the Emacs window. Buffers are cleanly grouped by modes, but windows
|
|
|
306 are not so easily pigeonholed. On the one hand, a window displays a
|
|
|
307 buffer, and thus one possible hierarchy is window, buffer, mode. On the
|
|
|
308 other, a window is a component of a frame. This generates the window,
|
|
|
309 frame, device hierarchy. Finally, there are objects such as toolbars
|
|
|
310 whose properties are described by specifiers. These do not fit
|
|
|
311 naturally into either hierarchy. This problem is as yet not cleanly
|
|
|
312 solved.
|
|
|
313
|
|
|
314 Another potential source of conceptual confusion is the instantiation
|
|
|
315 process. Instantiating a buffer-local variable is simple: at any given
|
|
|
316 point in time there is a current buffer, and its local values are used
|
|
|
317 and set whenever the variable is accessed, unless the programmer goes to
|
|
|
318 some special effort (uses @code{default-value} and @code{set-default}.
|
|
|
319 However, a specifier object encapsulates a set of @dfn{specifications},
|
|
|
320 each of which says what its value should be if a particular condition
|
|
|
321 applies. Several such conditions might apply simultaneously in a given
|
|
|
322 window.
|
|
|
323
|
|
428
|
324 For example, one specification might be ``The value should be
|
|
|
325 darkseagreen2 on X devices'' another might be ``The value should be blue
|
|
1135
|
326 in the *Help* buffer''. So what do we do for "the *Help* buffer on an X
|
|
|
327 device"? The answer is simple: give each type of locale a priority and
|
|
|
328 check them in priority order, returning the first instantiator that
|
|
|
329 successfully instantiates a value.
|
|
|
330
|
|
428
|
331 Given a specifier, a logical question is ``What is its value in a
|
|
|
332 particular situation?'' This involves looking through the specifications
|
|
|
333 to see which ones apply to this particular situation, and perhaps
|
|
|
334 preferring one over another if more than one applies. In specifier
|
|
|
335 terminology, a ``particular situation'' is called a @dfn{domain}, and
|
|
|
336 determining its value in a particular domain is called @dfn{instancing}.
|
|
|
337 Most of the time, a domain is identified by a particular window. For
|
|
|
338 example, if the redisplay engine is drawing text in the default face in
|
|
|
339 a particular window, it retrieves the specifier for the foreground color
|
|
|
340 of the default face and @dfn{instances} it in the domain given by that
|
|
|
341 window; in other words, it asks the specifier, ``What is your value in
|
|
|
342 this window?''.
|
|
|
343
|
|
1135
|
344 Note that the redisplay example is in a sense canonical. That is,
|
|
|
345 specifiers are designed to present a uniform and @emph{efficient} API
|
|
|
346 to redisplay. It is the efficiency constraint that motivates the
|
|
|
347 introduction of specifier tags, and many restrictions on access (for
|
|
|
348 example, a buffer is not a domain, and you cannot instantiate a
|
|
|
349 specifier over a buffer).
|
|
|
350
|
|
428
|
351 More specifically, a specifier contains a set of @dfn{specifications},
|
|
|
352 each of which associates a @dfn{locale} (a window object, a buffer
|
|
|
353 object, a frame object, a device object, or the symbol @code{global})
|
|
|
354 with an @dfn{inst-list}, which is a list of one or more
|
|
|
355 @dfn{inst-pairs}. (For each possible locale, there can be at most one
|
|
|
356 specification containing that locale.) Each inst-pair is a cons of a
|
|
|
357 @dfn{tag set} (an unordered list of zero or more symbols, or @dfn{tags})
|
|
|
358 and an @dfn{instantiator} (the allowed form of this varies depending on
|
|
|
359 the type of specifier). In a given specification, there may be more
|
|
|
360 than one inst-pair with the same tag set; this is unlike for locales.
|
|
|
361
|
|
|
362 The tag set is used to restrict the sorts of devices over which the
|
|
|
363 instantiator is valid and to uniquely identify instantiators added by a
|
|
|
364 particular application, so that different applications can work on the
|
|
|
365 same specifier and not interfere with each other. Each tag can have a
|
|
|
366 @dfn{predicate} associated with it, which is a function of one argument
|
|
|
367 (a device) that specifies whether the tag matches that particular
|
|
|
368 device. (If a tag does not have a predicate, it matches all devices.)
|
|
|
369 All tags in a tag set must match a device for the associated inst-pair
|
|
|
370 to be instantiable over that device. (A null tag set is perfectly
|
|
1135
|
371 valid, and trivially matches all devices.)
|
|
428
|
372
|
|
1135
|
373 @c #### don't we have more device types now, gtk, ms-windows, mac-carbon?
|
|
428
|
374 The valid device types (normally @code{x}, @code{tty}, and
|
|
|
375 @code{stream}) and device classes (normally @code{color},
|
|
|
376 @code{grayscale}, and @code{mono}) can always be used as tags, and match
|
|
|
377 devices of the associated type or class (@pxref{Consoles and Devices}).
|
|
|
378 User-defined tags may be defined, with an optional predicate specified.
|
|
|
379 An application can create its own tag, use it to mark all its
|
|
|
380 instantiators, and be fairly confident that it will not interfere with
|
|
440
|
381 other applications that modify the same specifier---Functions that add
|
|
428
|
382 a specification to a specifier usually only overwrite existing
|
|
|
383 inst-pairs with the same tag set as was given, and a particular tag or
|
|
|
384 tag set can be specified when removing instantiators.
|
|
|
385
|
|
|
386 When a specifier is instanced in a domain, both the locale and the tag
|
|
|
387 set can be viewed as specifying necessary conditions that must apply in
|
|
|
388 that domain for an instantiator to be considered as a possible result of
|
|
|
389 the instancing. More specific locales always override more general
|
|
|
390 locales (thus, there is no particular ordering of the specifications in
|
|
|
391 a specifier); however, the tag sets are simply considered in the order
|
|
|
392 that the inst-pairs occur in the specification's inst-list.
|
|
|
393
|
|
|
394 Note also that the actual object that results from the instancing
|
|
|
395 (called an @dfn{instance object}) may not be the same as the instantiator
|
|
|
396 from which it was derived. For some specifier types (such as integer
|
|
|
397 specifiers and boolean specifiers), the instantiator will be returned
|
|
|
398 directly as the instance object. For other types, however, this
|
|
|
399 is not the case. For example, for font specifiers, the instantiator
|
|
|
400 is a font-description string and the instance object is a font-instance
|
|
|
401 object, which describes how the font is displayed on a particular device.
|
|
|
402 A font-instance object encapsulates such things as the actual font name
|
|
|
403 used to display the font on that device (a font-description string
|
|
|
404 under X is usually a wildcard specification that may resolve to
|
|
|
405 different font names, with possibly different foundries, widths, etc.,
|
|
|
406 on different devices), the extra properties of that font on that
|
|
|
407 device, etc. Furthermore, this conversion (called @dfn{instantiation})
|
|
440
|
408 might fail---a font or color might not exist on a particular device,
|
|
428
|
409 for example.
|
|
|
410
|
|
|
411 @node Specifier Instancing
|
|
|
412 @section How a Specifier Is Instanced
|
|
|
413 @cindex fallback (in a specifier)
|
|
|
414 @cindex specifier, fallback
|
|
|
415
|
|
|
416 Instancing of a specifier in a particular window domain proceeds as
|
|
|
417 follows:
|
|
|
418
|
|
|
419 @itemize @bullet
|
|
|
420 @item
|
|
|
421 First, XEmacs searches for a specification whose locale is the same as
|
|
|
422 the window. If that fails, the search is repeated, looking for a locale
|
|
|
423 that is the same as the window's buffer. If that fails, the search is
|
|
|
424 repeated using the window's frame, then using the device that frame is
|
|
|
425 on. Finally, the specification whose locale is the symbol @code{global}
|
|
|
426 (if there is such a specification) is considered.
|
|
|
427 @item
|
|
|
428 The inst-pairs contained in the specification that was found are
|
|
|
429 considered in their order in the inst-list, looking for one whose tag
|
|
|
430 set matches the device that is derived from the window domain. (The
|
|
|
431 tag set is an unordered list of zero or more tag symbols. For all
|
|
|
432 tags that have predicates associated with them, the predicate must
|
|
|
433 match the device.)
|
|
|
434 @item
|
|
|
435 If a matching tag set is found, the corresponding instantiator is passed
|
|
|
436 to the specifier's instantiation method, which is specific to the type
|
|
|
437 of the specifier. If it succeeds, the resulting instance object is
|
|
|
438 returned as the result of the instancing and the instancing is done.
|
|
|
439 Otherwise, the operation continues, looking for another matching
|
|
|
440 inst-pair in the current specification.
|
|
|
441 @item
|
|
|
442 When there are no more inst-pairs to be considered in the current
|
|
|
443 specification, the search starts over, looking for another specification
|
|
|
444 as in the first step above.
|
|
|
445 @item
|
|
|
446 If all specifications are exhausted and no instance object can be
|
|
|
447 derived, the instancing fails. (Actually, this is not completely true.
|
|
|
448 Some specifier objects for built-in properties have a @dfn{fallback}
|
|
|
449 value, which is either an inst-list or another specifier object, that is
|
|
|
450 consulted if the instancing is about to fail. If it is an inst-list,
|
|
|
451 the searching proceeds using the inst-pairs in that list. If it is a
|
|
|
452 specifier, the entire instancing starts over using that specifier
|
|
|
453 instead of the given one. Fallback values are set by the C code and
|
|
|
454 cannot be modified, except perhaps indirectly, using any Lisp functions.
|
|
|
455 The purpose of them is to supply some values to make sure that
|
|
|
456 instancing of built-in properties can't fail and to implement some basic
|
|
|
457 specifier inheritance, such as the fact that faces inherit their
|
|
|
458 properties from the @code{default} face.)
|
|
|
459 @end itemize
|
|
|
460
|
|
|
461 It is also possible to instance a specifier over a frame domain or
|
|
|
462 device domain instead of over a window domain. The C code, for example,
|
|
|
463 instances the @code{top-toolbar-height} variable over a frame domain in
|
|
|
464 order to determine the height of a frame's top toolbar. Instancing over
|
|
|
465 a frame or device is similar to instancing over a window except that
|
|
|
466 specifications for locales that cannot be derived from the domain are
|
|
|
467 ignored. Specifically, instancing over a frame looks first for frame
|
|
|
468 locales, then device locales, then the @code{global} locale. Instancing
|
|
|
469 over a device domain looks only for device locales and the @code{global}
|
|
|
470 locale.
|
|
|
471
|
|
|
472 @node Specifier Types
|
|
|
473 @section Specifier Types
|
|
|
474
|
|
|
475 There are various different types of specifiers. The type of a
|
|
|
476 specifier controls what sorts of instantiators are valid, how an
|
|
|
477 instantiator is instantiated, etc. Here is a list of built-in specifier
|
|
|
478 types:
|
|
|
479
|
|
|
480 @table @code
|
|
|
481 @item boolean
|
|
|
482 The valid instantiators are the symbols @code{t} and @code{nil}.
|
|
|
483 Instance objects are the same as instantiators so no special
|
|
|
484 instantiation function is needed.
|
|
|
485
|
|
|
486 @item integer
|
|
|
487 The valid instantiators are integers. Instance objects are the same as
|
|
|
488 instantiators so no special instantiation function is needed.
|
|
|
489 @code{modeline-shadow-thickness} is an example of an integer specifier
|
|
|
490 (negative thicknesses indicate that the shadow is drawn recessed instead
|
|
|
491 of raised).
|
|
|
492
|
|
|
493 @item natnum
|
|
|
494 The valid instantiators are natnums (non-negative integers). Instance
|
|
|
495 objects are the same as instantiators so no special instantiation
|
|
|
496 function is needed. Natnum specifiers are used for dimension variables
|
|
|
497 such as @code{top-toolbar-height}.
|
|
|
498
|
|
|
499 @item generic
|
|
|
500 All Lisp objects are valid instantiators. Instance objects are the same
|
|
|
501 as instantiators so no special instantiation function is needed.
|
|
|
502
|
|
|
503 @item font
|
|
|
504 The valid instantiators are strings describing fonts or vectors
|
|
|
505 indicating inheritance from the font of some face. Instance objects are
|
|
|
506 font-instance objects, which are specific to a particular device. The
|
|
|
507 instantiation method for font specifiers can fail, unlike for integer,
|
|
|
508 natnum, boolean, and generic specifiers.
|
|
|
509
|
|
|
510 @item color
|
|
|
511 The valid instantiators are strings describing colors or vectors
|
|
|
512 indicating inheritance from the foreground or background of some face.
|
|
|
513 Instance objects are color-instance objects, which are specific to a
|
|
|
514 particular device. The instantiation method for color specifiers can fail,
|
|
|
515 as for font specifiers.
|
|
|
516
|
|
|
517 @item image
|
|
|
518 Images are perhaps the most complicated type of built-in specifier. The
|
|
|
519 valid instantiators are strings (a filename, inline data for a pixmap,
|
|
|
520 or text to be displayed in a text glyph) or vectors describing inline
|
|
|
521 data of various sorts or indicating inheritance from the
|
|
|
522 background-pixmap property of some face. Instance objects are either
|
|
|
523 strings (for text images), image-instance objects (for pixmap images),
|
|
|
524 or subwindow objects (for subwindow images). The instantiation method
|
|
|
525 for image specifiers can fail, as for font and color specifiers.
|
|
|
526
|
|
|
527 @item face-boolean
|
|
|
528 The valid instantiators are the symbols @code{t} and @code{nil} and
|
|
|
529 vectors indicating inheritance from a boolean property of some face.
|
|
|
530 Specifiers of this sort are used for all of the built-in boolean
|
|
|
531 properties of faces. Instance objects are either the symbol @code{t}
|
|
|
532 or the symbol @code{nil}.
|
|
|
533
|
|
|
534 @item toolbar
|
|
|
535 The valid instantiators are toolbar descriptors, which are lists
|
|
|
536 of toolbar-button descriptors (each of which is a vector of two
|
|
|
537 or four elements). @xref{Toolbar}, for more information.
|
|
|
538 @end table
|
|
|
539
|
|
|
540 Color and font instance objects can also be used in turn as
|
|
|
541 instantiators for a new color or font instance object. Since these
|
|
|
542 instance objects are device-specific, the instantiator can be used
|
|
|
543 directly as the new instance object, but only if they are of the same
|
|
|
544 device. If the devices differ, the base color or font of the
|
|
|
545 instantiating object is effectively used instead as the instantiator.
|
|
|
546
|
|
|
547 @xref{Faces and Window-System Objects}, for more information on fonts,
|
|
|
548 colors, and face-boolean specifiers. @xref{Glyphs}, for more information
|
|
|
549 about image specifiers. @xref{Toolbar}, for more information on toolbar
|
|
|
550 specifiers.
|
|
|
551
|
|
|
552 @defun specifier-type specifier
|
|
|
553 This function returns the type of @var{specifier}. The returned value
|
|
|
554 will be a symbol: one of @code{integer}, @code{boolean}, etc., as
|
|
|
555 listed in the above table.
|
|
|
556 @end defun
|
|
|
557
|
|
|
558 Functions are also provided to query whether an object is a particular
|
|
|
559 kind of specifier:
|
|
|
560
|
|
|
561 @defun boolean-specifier-p object
|
|
|
562 This function returns non-@code{nil} if @var{object} is a boolean
|
|
|
563 specifier.
|
|
|
564 @end defun
|
|
|
565
|
|
|
566 @defun integer-specifier-p object
|
|
|
567 This function returns non-@code{nil} if @var{object} is an integer
|
|
|
568 specifier.
|
|
|
569 @end defun
|
|
|
570
|
|
|
571 @defun natnum-specifier-p object
|
|
|
572 This function returns non-@code{nil} if @var{object} is a natnum
|
|
|
573 specifier.
|
|
|
574 @end defun
|
|
|
575
|
|
|
576 @defun generic-specifier-p object
|
|
|
577 This function returns non-@code{nil} if @var{object} is a generic
|
|
|
578 specifier.
|
|
|
579 @end defun
|
|
|
580
|
|
|
581 @defun face-boolean-specifier-p object
|
|
|
582 This function returns non-@code{nil} if @var{object} is a face-boolean
|
|
|
583 specifier.
|
|
|
584 @end defun
|
|
|
585
|
|
|
586 @defun toolbar-specifier-p object
|
|
|
587 This function returns non-@code{nil} if @var{object} is a toolbar
|
|
|
588 specifier.
|
|
|
589 @end defun
|
|
|
590
|
|
|
591 @defun font-specifier-p object
|
|
|
592 This function returns non-@code{nil} if @var{object} is a font
|
|
|
593 specifier.
|
|
|
594 @end defun
|
|
|
595
|
|
|
596 @defun color-specifier-p object
|
|
|
597 This function returns non-@code{nil} if @var{object} is a color
|
|
|
598 specifier.
|
|
|
599 @end defun
|
|
|
600
|
|
|
601 @defun image-specifier-p object
|
|
|
602 This function returns non-@code{nil} if @var{object} is an image
|
|
|
603 specifier.
|
|
|
604 @end defun
|
|
|
605
|
|
|
606 @node Adding Specifications
|
|
|
607 @section Adding specifications to a Specifier
|
|
|
608
|
|
|
609 @defun add-spec-to-specifier specifier instantiator &optional locale tag-set how-to-add
|
|
|
610 This function adds a specification to @var{specifier}. The
|
|
|
611 specification maps from @var{locale} (which should be a window, buffer,
|
|
|
612 frame, device, or the symbol @code{global}, and defaults to
|
|
|
613 @code{global}) to @var{instantiator}, whose allowed values depend on the
|
|
|
614 type of the specifier. Optional argument @var{tag-set} limits the
|
|
|
615 instantiator to apply only to the specified tag set, which should be a
|
|
|
616 list of tags all of which must match the device being instantiated over
|
|
|
617 (tags are a device type, a device class, or tags defined with
|
|
|
618 @code{define-specifier-tag}). Specifying a single symbol for
|
|
|
619 @var{tag-set} is equivalent to specifying a one-element list containing
|
|
|
620 that symbol. Optional argument @var{how-to-add} specifies what to do if
|
|
|
621 there are already specifications in the specifier. It should be one of
|
|
|
622
|
|
|
623 @table @code
|
|
|
624 @item prepend
|
|
|
625 Put at the beginning of the current list of instantiators for @var{locale}.
|
|
|
626 @item append
|
|
|
627 Add to the end of the current list of instantiators for @var{locale}.
|
|
|
628 @item remove-tag-set-prepend
|
|
|
629 This is the default. Remove any existing instantiators whose tag set is
|
|
|
630 the same as @var{tag-set}; then put the new instantiator at the
|
|
|
631 beginning of the current list.
|
|
|
632 @item remove-tag-set-append
|
|
|
633 Remove any existing instantiators whose tag set is the same as
|
|
|
634 @var{tag-set}; then put the new instantiator at the end of the current
|
|
|
635 list.
|
|
|
636 @item remove-locale
|
|
|
637 Remove all previous instantiators for this locale before adding the new
|
|
|
638 spec.
|
|
|
639 @item remove-locale-type
|
|
|
640 Remove all specifications for all locales of the same type as
|
|
|
641 @var{locale} (this includes @var{locale} itself) before adding the new
|
|
|
642 spec.
|
|
|
643 @item remove-all
|
|
|
644 Remove all specifications from the specifier before adding the new spec.
|
|
|
645 @end table
|
|
|
646
|
|
|
647 @code{remove-tag-set-prepend} is the default.
|
|
|
648
|
|
|
649 You can retrieve the specifications for a particular locale or locale type
|
|
|
650 with the function @code{specifier-spec-list} or @code{specifier-specs}.
|
|
|
651 @end defun
|
|
|
652
|
|
|
653 @defun add-spec-list-to-specifier specifier spec-list &optional how-to-add
|
|
|
654 This function adds a @dfn{spec-list} (a list of specifications) to
|
|
|
655 @var{specifier}. The format of a spec-list is
|
|
|
656
|
|
|
657 @example
|
|
|
658 @code{((@var{locale} (@var{tag-set} . @var{instantiator}) ...) ...)}
|
|
|
659 @end example
|
|
|
660
|
|
|
661 where
|
|
|
662
|
|
|
663 @itemize @bullet
|
|
|
664 @item
|
|
|
665 @var{locale} := a window, a buffer, a frame, a device, or @code{global}
|
|
|
666 @item
|
|
|
667 @var{tag-set} := an unordered list of zero or more @var{tags}, each of
|
|
|
668 which is a symbol
|
|
|
669 @item
|
|
|
670 @var{tag} := a device class (@pxref{Consoles and Devices}), a device type,
|
|
|
671 or a tag defined with @code{define-specifier-tag}
|
|
|
672 @item
|
|
|
673 @var{instantiator} := format determined by the type of specifier
|
|
|
674 @end itemize
|
|
|
675
|
|
|
676 The pair @code{(@var{tag-set} . @var{instantiator})} is called an
|
|
|
677 @dfn{inst-pair}. A list of inst-pairs is called an @dfn{inst-list}.
|
|
|
678 The pair @code{(@var{locale} . @var{inst-list})} is called a
|
|
|
679 @dfn{specification}. A spec-list, then, can be viewed as a list of
|
|
|
680 specifications.
|
|
|
681
|
|
|
682 @var{how-to-add} specifies how to combine the new specifications with
|
|
|
683 the existing ones, and has the same semantics as for
|
|
|
684 @code{add-spec-to-specifier}.
|
|
|
685
|
|
|
686 In many circumstances, the higher-level function @code{set-specifier} is
|
|
|
687 more convenient and should be used instead.
|
|
|
688 @end defun
|
|
|
689
|
|
444
|
690 @defspec let-specifier specifier-list &rest body
|
|
428
|
691 This special form temporarily adds specifications to specifiers,
|
|
|
692 evaluates forms in @var{body} and restores the specifiers to their
|
|
|
693 previous states. The specifiers and their temporary specifications are
|
|
|
694 listed in @var{specifier-list}.
|
|
|
695
|
|
|
696 The format of @var{specifier-list} is
|
|
|
697
|
|
|
698 @example
|
|
|
699 ((@var{specifier} @var{value} &optional @var{locale} @var{tag-set} @var{how-to-add}) ...)
|
|
|
700 @end example
|
|
|
701
|
|
|
702 @var{specifier} is the specifier to be temporarily modified.
|
|
|
703 @var{value} is the instantiator to be temporarily added to specifier in
|
|
|
704 @var{locale}. @var{locale}, @var{tag-set} and @var{how-to-add} have the
|
|
|
705 same meaning as in @code{add-spec-to-specifier}.
|
|
|
706
|
|
|
707 This special form is implemented as a macro; the code resulting from
|
|
|
708 macro expansion will add specifications to specifiers using
|
|
|
709 @code{add-spec-to-specifier}. After forms in @var{body} are evaluated,
|
|
|
710 the temporary specifications are removed and old specifier spec-lists
|
|
|
711 are restored.
|
|
|
712
|
|
|
713 @var{locale}, @var{tag-set} and @var{how-to-add} may be omitted, and
|
|
|
714 default to @code{nil}. The value of the last form in @var{body} is
|
|
|
715 returned.
|
|
|
716
|
|
|
717 NOTE: If you want the specifier's instance to change in all
|
|
|
718 circumstances, use @code{(selected-window)} as the @var{locale}. If
|
|
|
719 @var{locale} is @code{nil} or omitted, it defaults to @code{global}.
|
|
|
720
|
|
|
721 The following example removes the 3D modeline effect in the currently
|
|
|
722 selected window for the duration of a second:
|
|
|
723
|
|
|
724 @example
|
|
|
725 (let-specifier ((modeline-shadow-thickness 0 (selected-window)))
|
|
|
726 (sit-for 1))
|
|
|
727 @end example
|
|
444
|
728 @end defspec
|
|
428
|
729
|
|
444
|
730 @defun set-specifier specifier value &optional locale tag-set how-to-add
|
|
428
|
731 This function adds some specifications to @var{specifier}. @var{value}
|
|
|
732 can be a single instantiator or tagged instantiator (added as a global
|
|
|
733 specification), a list of tagged and/or untagged instantiators (added as
|
|
|
734 a global specification), a cons of a locale and instantiator or locale
|
|
|
735 and instantiator list, a list of such conses, or nearly any other
|
|
|
736 reasonable form. More specifically, @var{value} can be anything
|
|
|
737 accepted by @code{canonicalize-spec-list}.
|
|
|
738
|
|
444
|
739 @var{locale}, @var{tag-set}, and @var{how-to-add} are the same as in
|
|
|
740 @code{add-spec-to-specifier}.
|
|
428
|
741
|
|
|
742 Note that @code{set-specifier} is exactly complementary to
|
|
|
743 @code{specifier-specs} except in the case where @var{specifier} has no
|
|
|
744 specs at all in it but @code{nil} is a valid instantiator (in that case,
|
|
|
745 @code{specifier-specs} will return @code{nil} (meaning no specs) and
|
|
|
746 @code{set-specifier} will interpret the @code{nil} as meaning ``I'm
|
|
|
747 adding a global instantiator and its value is @code{nil}''), or in
|
|
|
748 strange cases where there is an ambiguity between a spec-list and an
|
|
|
749 inst-list, etc. (The built-in specifier types are designed in such a way
|
|
|
750 as to avoid any such ambiguities.)
|
|
|
751
|
|
|
752 If you want to work with spec-lists, you should probably not use these
|
|
|
753 functions, but should use the lower-level functions
|
|
|
754 @code{specifier-spec-list} and @code{add-spec-list-to-specifier}. These
|
|
|
755 functions always work with fully-qualified spec-lists; thus, there is no
|
|
|
756 ambiguity.
|
|
|
757 @end defun
|
|
|
758
|
|
|
759 @defun canonicalize-inst-pair inst-pair specifier-type &optional noerror
|
|
|
760 This function canonicalizes the given @var{inst-pair}.
|
|
|
761
|
|
|
762 @var{specifier-type} specifies the type of specifier that this
|
|
|
763 @var{spec-list} will be used for.
|
|
|
764
|
|
|
765 Canonicalizing means converting to the full form for an inst-pair, i.e.
|
|
|
766 @code{(@var{tag-set} . @var{instantiator})}. A single, untagged
|
|
|
767 instantiator is given a tag set of @code{nil} (the empty set), and a
|
|
|
768 single tag is converted into a tag set consisting only of that tag.
|
|
|
769
|
|
|
770 If @var{noerror} is non-@code{nil}, signal an error if the inst-pair is
|
|
|
771 invalid; otherwise return @code{t}.
|
|
|
772 @end defun
|
|
|
773
|
|
|
774 @defun canonicalize-inst-list inst-list specifier-type &optional noerror
|
|
|
775 This function canonicalizes the given @var{inst-list} (a list of
|
|
|
776 inst-pairs).
|
|
|
777
|
|
|
778 @var{specifier-type} specifies the type of specifier that this @var{inst-list}
|
|
|
779 will be used for.
|
|
|
780
|
|
|
781 Canonicalizing means converting to the full form for an inst-list, i.e.
|
|
|
782 @code{((@var{tag-set} . @var{instantiator}) ...)}. This function
|
|
|
783 accepts a single inst-pair or any abbreviation thereof or a list of
|
|
|
784 (possibly abbreviated) inst-pairs. (See @code{canonicalize-inst-pair}.)
|
|
|
785
|
|
|
786 If @var{noerror} is non-@code{nil}, signal an error if the inst-list is
|
|
|
787 invalid; otherwise return @code{t}.
|
|
|
788 @end defun
|
|
|
789
|
|
|
790 @defun canonicalize-spec spec specifier-type &optional noerror
|
|
|
791 This function canonicalizes the given @var{spec} (a specification).
|
|
|
792
|
|
|
793 @var{specifier-type} specifies the type of specifier that this
|
|
|
794 @var{spec-list} will be used for.
|
|
|
795
|
|
|
796 Canonicalizing means converting to the full form for a spec, i.e.
|
|
|
797 @code{(@var{locale} (@var{tag-set} . @var{instantiator}) ...)}. This
|
|
|
798 function accepts a possibly abbreviated inst-list or a cons of a locale
|
|
|
799 and a possibly abbreviated inst-list. (See
|
|
|
800 @code{canonicalize-inst-list}.)
|
|
|
801
|
|
|
802 If @var{noerror} is @code{nil}, signal an error if the specification is
|
|
|
803 invalid; otherwise return @code{t}.
|
|
|
804 @end defun
|
|
|
805
|
|
|
806 @defun canonicalize-spec-list spec-list specifier-type &optional noerror
|
|
|
807 This function canonicalizes the given @var{spec-list} (a list of
|
|
|
808 specifications).
|
|
|
809
|
|
|
810 @var{specifier-type} specifies the type of specifier that this
|
|
|
811 @var{spec-list} will be used for.
|
|
|
812
|
|
|
813 Canonicalizing means converting to the full form for a spec-list, i.e.
|
|
|
814 @code{((@var{locale} (@var{tag-set} . @var{instantiator}) ...) ...)}.
|
|
|
815 This function accepts a possibly abbreviated specification or a list of
|
|
|
816 such things. (See @code{canonicalize-spec}.) This is the function used
|
|
|
817 to convert spec-lists accepted by @code{set-specifier} and such into a
|
|
|
818 form suitable for @code{add-spec-list-to-specifier}.
|
|
|
819
|
|
|
820 This function tries extremely hard to resolve any ambiguities,
|
|
|
821 and the built-in specifier types (font, image, toolbar, etc.) are
|
|
|
822 designed so that there won't be any ambiguities.
|
|
|
823
|
|
|
824 If @var{noerror} is @code{nil}, signal an error if the spec-list is
|
|
|
825 invalid; otherwise return @code{t}.
|
|
|
826 @end defun
|
|
|
827
|
|
|
828 @node Retrieving Specifications
|
|
|
829 @section Retrieving the Specifications from a Specifier
|
|
|
830
|
|
|
831 @defun specifier-spec-list specifier &optional locale tag-set exact-p
|
|
|
832 This function returns the spec-list of specifications for
|
|
|
833 @var{specifier} in @var{locale}.
|
|
|
834
|
|
|
835 If @var{locale} is a particular locale (a window, buffer, frame, device,
|
|
|
836 or the symbol @code{global}), a spec-list consisting of the
|
|
|
837 specification for that locale will be returned.
|
|
|
838
|
|
444
|
839 If @var{locale} is a locale type (i.e. one of the symbols @code{window},
|
|
428
|
840 @code{buffer}, @code{frame}, or @code{device}), a spec-list of the
|
|
|
841 specifications for all locales of that type will be returned.
|
|
|
842
|
|
|
843 If @var{locale} is @code{nil} or the symbol @code{all}, a spec-list of
|
|
|
844 all specifications in @var{specifier} will be returned.
|
|
|
845
|
|
|
846 @var{locale} can also be a list of locales, locale types, and/or
|
|
|
847 @code{all}; the result is as if @code{specifier-spec-list} were called
|
|
|
848 on each element of the list and the results concatenated together.
|
|
|
849
|
|
|
850 Only instantiators where @var{tag-set} (a list of zero or more tags) is
|
|
|
851 a subset of (or possibly equal to) the instantiator's tag set are
|
|
444
|
852 returned. (The default value of @code{nil} is a subset of all tag sets,
|
|
428
|
853 so in this case no instantiators will be screened out.) If @var{exact-p}
|
|
|
854 is non-@code{nil}, however, @var{tag-set} must be equal to an
|
|
|
855 instantiator's tag set for the instantiator to be returned.
|
|
|
856 @end defun
|
|
|
857
|
|
|
858 @defun specifier-specs specifier &optional locale tag-set exact-p
|
|
|
859 This function returns the specification(s) for @var{specifier} in
|
|
|
860 @var{locale}.
|
|
|
861
|
|
|
862 If @var{locale} is a single locale or is a list of one element
|
|
|
863 containing a single locale, then a ``short form'' of the instantiators
|
|
|
864 for that locale will be returned. Otherwise, this function is identical
|
|
|
865 to @code{specifier-spec-list}.
|
|
|
866
|
|
|
867 The ``short form'' is designed for readability and not for ease of use
|
|
|
868 in Lisp programs, and is as follows:
|
|
|
869
|
|
|
870 @enumerate
|
|
|
871 @item
|
|
|
872 If there is only one instantiator, then an inst-pair (i.e. cons of tag
|
|
|
873 and instantiator) will be returned; otherwise a list of inst-pairs will
|
|
|
874 be returned.
|
|
|
875 @item
|
|
|
876 For each inst-pair returned, if the instantiator's tag is @code{any},
|
|
|
877 the tag will be removed and the instantiator itself will be returned
|
|
|
878 instead of the inst-pair.
|
|
|
879 @item
|
|
|
880 If there is only one instantiator, its value is @code{nil}, and its tag
|
|
|
881 is @code{any}, a one-element list containing @code{nil} will be returned
|
|
|
882 rather than just @code{nil}, to distinguish this case from there being
|
|
|
883 no instantiators at all.
|
|
|
884 @end enumerate
|
|
|
885
|
|
|
886 @end defun
|
|
|
887
|
|
|
888 @defun specifier-fallback specifier
|
|
|
889 This function returns the fallback value for @var{specifier}. Fallback
|
|
|
890 values are provided by the C code for certain built-in specifiers to
|
|
|
891 make sure that instancing won't fail even if all specs are removed from
|
|
|
892 the specifier, or to implement simple inheritance behavior (e.g. this
|
|
|
893 method is used to ensure that faces other than @code{default} inherit
|
|
|
894 their attributes from @code{default}). By design, you cannot change the
|
|
|
895 fallback value, and specifiers created with @code{make-specifier} will
|
|
|
896 never have a fallback (although a similar, Lisp-accessible capability
|
|
|
897 may be provided in the future to allow for inheritance).
|
|
|
898
|
|
|
899 The fallback value will be an inst-list that is instanced like
|
|
|
900 any other inst-list, a specifier of the same type as @var{specifier}
|
|
|
901 (results in inheritance), or @code{nil} for no fallback.
|
|
|
902
|
|
|
903 When you instance a specifier, you can explicitly request that the
|
|
|
904 fallback not be consulted. (The C code does this, for example, when
|
|
|
905 merging faces.) See @code{specifier-instance}.
|
|
|
906 @end defun
|
|
|
907
|
|
|
908 @node Specifier Tag Functions
|
|
|
909 @section Working With Specifier Tags
|
|
|
910
|
|
|
911 A specifier tag set is an entity that is attached to an instantiator
|
|
|
912 and can be used to restrict the scope of that instantiator to a
|
|
|
913 particular device class or device type and/or to mark instantiators
|
|
|
914 added by a particular package so that they can be later removed.
|
|
|
915
|
|
442
|
916 A specifier tag set consists of a list of zero or more specifier tags,
|
|
428
|
917 each of which is a symbol that is recognized by XEmacs as a tag. (The
|
|
|
918 valid device types and device classes are always tags, as are any tags
|
|
|
919 defined by @code{define-specifier-tag}.) It is called a ``tag set'' (as
|
|
|
920 opposed to a list) because the order of the tags or the number of times
|
|
|
921 a particular tag occurs does not matter.
|
|
|
922
|
|
|
923 Each tag has a predicate associated with it, which specifies whether
|
|
|
924 that tag applies to a particular device. The tags which are device
|
|
|
925 types and classes match devices of that type or class. User-defined
|
|
|
926 tags can have any predicate, or none (meaning that all devices match).
|
|
|
927 When attempting to instance a specifier, a particular instantiator is
|
|
|
928 only considered if the device of the domain being instanced over matches
|
|
|
929 all tags in the tag set attached to that instantiator.
|
|
|
930
|
|
|
931 Most of the time, a tag set is not specified, and the instantiator gets
|
|
|
932 a null tag set, which matches all devices.
|
|
|
933
|
|
|
934 @defun valid-specifier-tag-p tag
|
|
|
935 This function returns non-@code{nil} if @var{tag} is a valid specifier
|
|
|
936 tag.
|
|
|
937 @end defun
|
|
|
938
|
|
|
939 @defun valid-specifier-tag-set-p tag-set
|
|
|
940 This function returns non-@code{nil} if @var{tag-set} is a valid
|
|
|
941 specifier tag set.
|
|
|
942 @end defun
|
|
|
943
|
|
|
944 @defun canonicalize-tag-set tag-set
|
|
|
945 This function canonicalizes the given tag set. Two canonicalized tag
|
|
|
946 sets can be compared with @code{equal} to see if they represent the same
|
|
|
947 tag set. (Specifically, canonicalizing involves sorting by symbol name
|
|
|
948 and removing duplicates.)
|
|
|
949 @end defun
|
|
|
950
|
|
|
951 @defun device-matches-specifier-tag-set-p device tag-set
|
|
|
952 This function returns non-@code{nil} if @var{device} matches specifier
|
|
|
953 tag set @var{tag-set}. This means that @var{device} matches each tag in
|
|
|
954 the tag set.
|
|
|
955 @end defun
|
|
|
956
|
|
|
957 @defun define-specifier-tag tag &optional predicate
|
|
|
958 This function defines a new specifier tag. If @var{predicate} is
|
|
|
959 specified, it should be a function of one argument (a device) that
|
|
|
960 specifies whether the tag matches that particular device. If
|
|
|
961 @var{predicate} is omitted, the tag matches all devices.
|
|
|
962
|
|
|
963 You can redefine an existing user-defined specifier tag. However, you
|
|
|
964 cannot redefine the built-in specifier tags (the device types and
|
|
|
965 classes) or the symbols @code{nil}, @code{t}, @code{all}, or
|
|
|
966 @code{global}.
|
|
|
967 @end defun
|
|
|
968
|
|
|
969 @defun device-matching-specifier-tag-list &optional device
|
|
|
970 This function returns a list of all specifier tags matching
|
|
|
971 @var{device}. @var{device} defaults to the selected device if omitted.
|
|
|
972 @end defun
|
|
|
973
|
|
|
974 @defun specifier-tag-list
|
|
|
975 This function returns a list of all currently-defined specifier tags.
|
|
|
976 This includes the built-in ones (the device types and classes).
|
|
|
977 @end defun
|
|
|
978
|
|
|
979 @defun specifier-tag-predicate tag
|
|
|
980 This function returns the predicate for the given specifier tag.
|
|
|
981 @end defun
|
|
|
982
|
|
|
983 @node Specifier Instancing Functions
|
|
|
984 @section Functions for Instancing a Specifier
|
|
|
985
|
|
|
986 @defun specifier-instance specifier &optional domain default no-fallback
|
|
|
987 This function instantiates @var{specifier} (return its value) in
|
|
|
988 @var{domain}. If no instance can be generated for this domain, return
|
|
|
989 @var{default}.
|
|
|
990
|
|
|
991 @var{domain} should be a window, frame, or device. Other values that
|
|
|
992 are legal as a locale (e.g. a buffer) are not valid as a domain because
|
|
|
993 they do not provide enough information to identify a particular device
|
|
|
994 (see @code{valid-specifier-domain-p}). @var{domain} defaults to the
|
|
|
995 selected window if omitted.
|
|
|
996
|
|
|
997 @dfn{Instantiating} a specifier in a particular domain means determining
|
|
|
998 the specifier's ``value'' in that domain. This is accomplished by
|
|
|
999 searching through the specifications in the specifier that correspond to
|
|
|
1000 all locales that can be derived from the given domain, from specific to
|
|
|
1001 general. In most cases, the domain is an Emacs window. In that case
|
|
|
1002 specifications are searched for as follows:
|
|
|
1003
|
|
|
1004 @enumerate
|
|
|
1005 @item
|
|
|
1006 A specification whose locale is the window itself;
|
|
|
1007 @item
|
|
|
1008 A specification whose locale is the window's buffer;
|
|
|
1009 @item
|
|
|
1010 A specification whose locale is the window's frame;
|
|
|
1011 @item
|
|
|
1012 A specification whose locale is the window's frame's device;
|
|
|
1013 @item
|
|
|
1014 A specification whose locale is the symbol @code{global}.
|
|
|
1015 @end enumerate
|
|
|
1016
|
|
|
1017 If all of those fail, then the C-code-provided fallback value for this
|
|
|
1018 specifier is consulted (see @code{specifier-fallback}). If it is an
|
|
|
1019 inst-list, then this function attempts to instantiate that list just as
|
|
|
1020 when a specification is located in the first five steps above. If the
|
|
|
1021 fallback is a specifier, @code{specifier-instance} is called recursively
|
|
|
1022 on this specifier and the return value used. Note, however, that if the
|
|
|
1023 optional argument @var{no-fallback} is non-@code{nil}, the fallback
|
|
|
1024 value will not be consulted.
|
|
|
1025
|
|
|
1026 Note that there may be more than one specification matching a particular
|
|
|
1027 locale; all such specifications are considered before looking for any
|
|
|
1028 specifications for more general locales. Any particular specification
|
|
|
1029 that is found may be rejected because it is tagged to a particular
|
|
|
1030 device class (e.g. @code{color}) or device type (e.g. @code{x}) or both
|
|
|
1031 and the device for the given domain does not match this, or because the
|
|
|
1032 specification is not valid for the device of the given domain (e.g. the
|
|
|
1033 font or color name does not exist for this particular X server).
|
|
|
1034
|
|
|
1035 The returned value is dependent on the type of specifier. For example,
|
|
|
1036 for a font specifier (as returned by the @code{face-font} function), the
|
|
|
1037 returned value will be a font-instance object. For images, the returned
|
|
|
1038 value will be a string, pixmap, or subwindow.
|
|
|
1039 @end defun
|
|
|
1040
|
|
|
1041 @defun specifier-instance-from-inst-list specifier domain inst-list &optional default
|
|
|
1042 This function attempts to convert a particular inst-list into an
|
|
|
1043 instance. This attempts to instantiate @var{inst-list} in the given
|
|
|
1044 @var{domain}, as if @var{inst-list} existed in a specification in
|
|
|
1045 @var{specifier}. If the instantiation fails, @var{default} is returned.
|
|
|
1046 In most circumstances, you should not use this function; use
|
|
|
1047 @code{specifier-instance} instead.
|
|
|
1048 @end defun
|
|
|
1049
|
|
|
1050 @node Specifier Example
|
|
|
1051 @section Example of Specifier Usage
|
|
|
1052
|
|
|
1053 Now let us present an example to clarify the theoretical discussions we
|
|
|
1054 have been through. In this example, we will use the general specifier
|
|
|
1055 functions for clarity. Keep in mind that many types of specifiers, and
|
|
|
1056 some other types of objects that are associated with specifiers
|
|
|
1057 (e.g. faces), provide convenience functions making it easier to work
|
|
|
1058 with objects of that type.
|
|
|
1059
|
|
|
1060 Let us consider the background color of the default face. A specifier
|
|
|
1061 is used to specify how that color will appear in different domains.
|
|
|
1062 First, let's retrieve the specifier:
|
|
|
1063
|
|
|
1064 @example
|
|
|
1065 (setq sp (face-property 'default 'background))
|
|
|
1066 @result{} #<color-specifier 0x3da>
|
|
|
1067 @end example
|
|
|
1068
|
|
|
1069 @example
|
|
|
1070 (specifier-specs sp)
|
|
|
1071 @result{} ((#<buffer "device.c"> (nil . "forest green"))
|
|
|
1072 (#<window on "Makefile" 0x8a2b> (nil . "hot pink"))
|
|
|
1073 (#<x-frame "emacs" 0x4ac> (nil . "puke orange")
|
|
440
|
1074 (nil . "moccasin"))
|
|
428
|
1075 (#<x-frame "VM" 0x4ac> (nil . "magenta"))
|
|
440
|
1076 (global ((tty) . "cyan") (nil . "white"))
|
|
428
|
1077 )
|
|
|
1078 @end example
|
|
|
1079
|
|
|
1080 Then, say we want to determine what the background color of the default
|
|
|
1081 face is for the window currently displaying the buffer @samp{*scratch*}.
|
|
|
1082 We call
|
|
|
1083
|
|
|
1084 @example
|
|
|
1085 (get-buffer-window "*scratch*")
|
|
|
1086 @result{} #<window on "*scratch*" 0x4ad>
|
|
|
1087 (window-frame (get-buffer-window "*scratch*"))
|
|
|
1088 @result{} #<x-frame "emacs" 0x4ac>
|
|
|
1089 (specifier-instance sp (get-buffer-window "*scratch*"))
|
|
|
1090 @result{} #<color-instance moccasin 47=(FFFF,E4E4,B5B5) 0x6309>
|
|
|
1091 @end example
|
|
|
1092
|
|
|
1093 Note that we passed a window to @code{specifier-instance}, not a buffer.
|
|
|
1094 We cannot pass a buffer because a buffer by itself does not provide enough
|
|
|
1095 information. The buffer might not be displayed anywhere at all, or
|
|
|
1096 could be displayed in many different frames on different devices.
|
|
|
1097
|
|
|
1098 The result is arrived at like this:
|
|
|
1099
|
|
|
1100 @enumerate
|
|
|
1101 @item
|
|
|
1102 First, we look for a specification matching the buffer displayed in the
|
|
440
|
1103 window, i.e. @samp{*scratch*}. There are none, so we proceed.
|
|
428
|
1104 @item
|
|
|
1105 Then, we look for a specification matching the window itself. Again, there
|
|
|
1106 are none.
|
|
|
1107 @item
|
|
|
1108 Then, we look for a specification matching the window's frame. The
|
|
|
1109 specification @code{(#<x-frame "emacs" 0x4ac> . "puke orange")} is
|
|
|
1110 found. We call the instantiation method for colors, passing it the
|
|
|
1111 locale we were searching over (i.e. the window, in this case) and the
|
|
|
1112 instantiator (@samp{"puke orange"}). However, the particular device
|
|
|
1113 which this window is on (let's say it's an X connection) doesn't
|
|
|
1114 recognize the color @samp{"puke orange"}, so the specification is
|
|
|
1115 rejected.
|
|
|
1116 @item
|
|
|
1117 So we continue looking for a specification matching the window's frame.
|
|
|
1118 We find @samp{(#<x-frame "emacs" 0x4ac> . "moccasin")}. Again, we
|
|
|
1119 call the instantiation method for colors. This time, the X server
|
|
|
1120 our window is on recognizes the color @samp{moccasin}, and so the
|
|
|
1121 instantiation method succeeds and returns a color instance.
|
|
|
1122 @end enumerate
|
|
|
1123
|
|
|
1124 @node Creating Specifiers
|
|
|
1125 @section Creating New Specifier Objects
|
|
|
1126
|
|
|
1127 @defun make-specifier type
|
|
|
1128 This function creates a new specifier.
|
|
|
1129
|
|
|
1130 A specifier is an object that can be used to keep track of a property
|
|
|
1131 whose value can be per-buffer, per-window, per-frame, or per-device,
|
|
|
1132 and can further be restricted to a particular device-type or device-class.
|
|
|
1133 Specifiers are used, for example, for the various built-in properties of a
|
|
|
1134 face; this allows a face to have different values in different frames,
|
|
444
|
1135 buffers, etc. For more information, see @code{specifier-instance},
|
|
|
1136 @code{specifier-specs}, and @code{add-spec-to-specifier}; or, for a detailed
|
|
428
|
1137 description of specifiers, including how they are instantiated over a
|
|
|
1138 particular domain (i.e. how their value in that domain is determined),
|
|
|
1139 see the chapter on specifiers in the XEmacs Lisp Reference Manual.
|
|
|
1140
|
|
|
1141 @var{type} specifies the particular type of specifier, and should be one
|
|
|
1142 of the symbols @code{generic}, @code{integer}, @code{natnum},
|
|
|
1143 @code{boolean}, @code{color}, @code{font}, @code{image},
|
|
|
1144 @code{face-boolean}, or @code{toolbar}.
|
|
|
1145
|
|
|
1146 For more information on particular types of specifiers, see the
|
|
442
|
1147 functions @code{make-generic-specifier}, @code{make-integer-specifier},
|
|
|
1148 @code{make-natnum-specifier}, @code{make-boolean-specifier},
|
|
|
1149 @code{make-color-specifier}, @code{make-font-specifier},
|
|
|
1150 @code{make-image-specifier}, @code{make-face-boolean-specifier}, and
|
|
|
1151 @code{make-toolbar-specifier}.
|
|
428
|
1152 @end defun
|
|
|
1153
|
|
|
1154 @defun make-specifier-and-init type spec-list &optional dont-canonicalize
|
|
|
1155 This function creates and initialize a new specifier.
|
|
|
1156
|
|
|
1157 This is a front-end onto @code{make-specifier} that allows you to create
|
|
|
1158 a specifier and add specs to it at the same time. @var{type} specifies
|
|
|
1159 the specifier type. @var{spec-list} supplies the specification(s) to be
|
|
|
1160 added to the specifier. Normally, almost any reasonable abbreviation of
|
|
|
1161 the full spec-list form is accepted, and is converted to the full form;
|
|
|
1162 however, if optional argument @var{dont-canonicalize} is non-@code{nil},
|
|
|
1163 this conversion is not performed, and the @var{spec-list} must already
|
|
|
1164 be in full form. See @code{canonicalize-spec-list}.
|
|
|
1165 @end defun
|
|
|
1166
|
|
442
|
1167 @defun make-integer-specifier spec-list
|
|
|
1168
|
|
|
1169 Return a new @code{integer} specifier object with the given
|
|
|
1170 specification list. @var{spec-list} can be a list of specifications
|
|
|
1171 (each of which is a cons of a locale and a list of instantiators), a
|
|
|
1172 single instantiator, or a list of instantiators.
|
|
|
1173
|
|
|
1174 Valid instantiators for integer specifiers are integers.
|
|
|
1175 @end defun
|
|
|
1176
|
|
|
1177 @defun make-boolean-specifier spec-list
|
|
|
1178
|
|
|
1179 Return a new @code{boolean} specifier object with the given
|
|
|
1180 specification list. @var{spec-list} can be a list of specifications
|
|
|
1181 (each of which is a cons of a locale and a list of instantiators), a
|
|
|
1182 single instantiator, or a list of instantiators.
|
|
|
1183
|
|
|
1184 Valid instantiators for boolean specifiers are @code{t} and @code{nil}.
|
|
|
1185 @end defun
|
|
|
1186
|
|
|
1187 @defun make-natnum-specifier spec-list
|
|
|
1188
|
|
|
1189 Return a new @code{natnum} specifier object with the given specification
|
|
|
1190 list. @var{spec-list} can be a list of specifications (each of which is
|
|
|
1191 a cons of a locale and a list of instantiators), a single instantiator,
|
|
|
1192 or a list of instantiators.
|
|
|
1193
|
|
|
1194 Valid instantiators for natnum specifiers are non-negative integers.
|
|
|
1195 @end defun
|
|
|
1196
|
|
|
1197 @defun make-generic-specifier spec-list
|
|
|
1198
|
|
|
1199 Return a new @code{generic} specifier object with the given
|
|
|
1200 specification list. @var{spec-list} can be a list of specifications
|
|
|
1201 (each of which is a cons of a locale and a list of instantiators), a
|
|
|
1202 single instantiator, or a list of instantiators.
|
|
|
1203
|
|
|
1204 Valid instantiators for generic specifiers are all Lisp values. They
|
|
|
1205 are returned back unchanged when a specifier is instantiated.
|
|
|
1206 @end defun
|
|
|
1207
|
|
|
1208 @defun make-display-table-specifier spec-list
|
|
|
1209
|
|
|
1210 Return a new @code{display-table} specifier object with the given spec
|
|
|
1211 list. @var{spec-list} can be a list of specifications (each of which is
|
|
|
1212 a cons of a locale and a list of instantiators), a single instantiator,
|
|
|
1213 or a list of instantiators.
|
|
|
1214
|
|
|
1215 Valid instantiators for display-table specifiers are described in detail
|
|
|
1216 in the doc string for @code{current-display-table} (@pxref{Active
|
|
|
1217 Display Table}).
|
|
|
1218 @end defun
|
|
|
1219
|
|
428
|
1220 @node Specifier Validation Functions
|
|
|
1221 @section Functions for Checking the Validity of Specifier Components
|
|
|
1222
|
|
|
1223 @defun valid-specifier-domain-p domain
|
|
|
1224 This function returns non-@code{nil} if @var{domain} is a valid
|
|
|
1225 specifier domain. A domain is used to instance a specifier
|
|
|
1226 (i.e. determine the specifier's value in that domain). Valid domains
|
|
|
1227 are a window, frame, or device. (@code{nil} is not valid.)
|
|
|
1228 @end defun
|
|
|
1229
|
|
|
1230 @defun valid-specifier-locale-p locale
|
|
|
1231 This function returns non-@code{nil} if @var{locale} is a valid
|
|
|
1232 specifier locale. Valid locales are a device, a frame, a window, a
|
|
|
1233 buffer, and @code{global}. (@code{nil} is not valid.)
|
|
|
1234 @end defun
|
|
|
1235
|
|
|
1236 @defun valid-specifier-locale-type-p locale-type
|
|
444
|
1237 Given a specifier @var{locale-type}, this function returns non-@code{nil} if it
|
|
428
|
1238 is valid. Valid locale types are the symbols @code{global},
|
|
|
1239 @code{device}, @code{frame}, @code{window}, and @code{buffer}. (Note,
|
|
|
1240 however, that in functions that accept either a locale or a locale type,
|
|
|
1241 @code{global} is considered an individual locale.)
|
|
|
1242 @end defun
|
|
|
1243
|
|
|
1244 @defun valid-specifier-type-p specifier-type
|
|
|
1245 Given a @var{specifier-type}, this function returns non-@code{nil} if it
|
|
|
1246 is valid. Valid types are @code{generic}, @code{integer},
|
|
|
1247 @code{boolean}, @code{color}, @code{font}, @code{image},
|
|
|
1248 @code{face-boolean}, and @code{toolbar}.
|
|
|
1249 @end defun
|
|
|
1250
|
|
|
1251 @defun valid-specifier-tag-p tag
|
|
|
1252 This function returns non-@code{nil} if @var{tag} is a valid specifier
|
|
|
1253 tag.
|
|
|
1254 @end defun
|
|
|
1255
|
|
|
1256 @defun valid-instantiator-p instantiator specifier-type
|
|
|
1257 This function returns non-@code{nil} if @var{instantiator} is valid for
|
|
|
1258 @var{specifier-type}.
|
|
|
1259 @end defun
|
|
|
1260
|
|
|
1261 @defun valid-inst-list-p inst-list type
|
|
|
1262 This function returns non-@code{nil} if @var{inst-list} is valid for
|
|
|
1263 specifier type @var{type}.
|
|
|
1264 @end defun
|
|
|
1265
|
|
|
1266 @defun valid-spec-list-p spec-list type
|
|
|
1267 This function returns non-@code{nil} if @var{spec-list} is valid for
|
|
|
1268 specifier type @var{type}.
|
|
|
1269 @end defun
|
|
|
1270
|
|
|
1271 @defun check-valid-instantiator instantiator specifier-type
|
|
|
1272 This function signals an error if @var{instantiator} is invalid for
|
|
|
1273 @var{specifier-type}.
|
|
|
1274 @end defun
|
|
|
1275
|
|
|
1276 @defun check-valid-inst-list inst-list type
|
|
|
1277 This function signals an error if @var{inst-list} is invalid for
|
|
|
1278 specifier type @var{type}.
|
|
|
1279 @end defun
|
|
|
1280
|
|
|
1281 @defun check-valid-spec-list spec-list type
|
|
|
1282 This function signals an error if @var{spec-list} is invalid for
|
|
|
1283 specifier type @var{type}.
|
|
|
1284 @end defun
|
|
|
1285
|
|
|
1286 @node Other Specification Functions
|
|
|
1287 @section Other Functions for Working with Specifications in a Specifier
|
|
|
1288
|
|
|
1289 @defun copy-specifier specifier &optional dest locale tag-set exact-p how-to-add
|
|
|
1290 This function copies @var{specifier} to @var{dest}, or creates a new one
|
|
|
1291 if @var{dest} is @code{nil}.
|
|
|
1292
|
|
|
1293 If @var{dest} is @code{nil} or omitted, a new specifier will be created
|
|
|
1294 and the specifications copied into it. Otherwise, the specifications
|
|
|
1295 will be copied into the existing specifier in @var{dest}.
|
|
|
1296
|
|
|
1297 If @var{locale} is @code{nil} or the symbol @code{all}, all
|
|
|
1298 specifications will be copied. If @var{locale} is a particular locale,
|
|
|
1299 the specification for that particular locale will be copied. If
|
|
|
1300 @var{locale} is a locale type, the specifications for all locales of
|
|
|
1301 that type will be copied. @var{locale} can also be a list of locales,
|
|
|
1302 locale types, and/or @code{all}; this is equivalent to calling
|
|
|
1303 @code{copy-specifier} for each of the elements of the list. See
|
|
|
1304 @code{specifier-spec-list} for more information about @var{locale}.
|
|
|
1305
|
|
|
1306 Only instantiators where @var{tag-set} (a list of zero or more tags) is
|
|
|
1307 a subset of (or possibly equal to) the instantiator's tag set are
|
|
|
1308 copied. (The default value of @code{nil} is a subset of all tag sets,
|
|
|
1309 so in this case no instantiators will be screened out.) If @var{exact-p}
|
|
|
1310 is non-@code{nil}, however, @var{tag-set} must be equal to an
|
|
|
1311 instantiator's tag set for the instantiator to be copied.
|
|
|
1312
|
|
|
1313 Optional argument @var{how-to-add} specifies what to do with existing
|
|
444
|
1314 specifications in @var{dest}. If @code{nil}, then whichever locales or locale
|
|
428
|
1315 types are copied will first be completely erased in @var{dest}.
|
|
|
1316 Otherwise, it is the same as in @code{add-spec-to-specifier}.
|
|
|
1317 @end defun
|
|
|
1318
|
|
|
1319 @defun remove-specifier specifier &optional locale tag-set exact-p
|
|
|
1320 This function removes specification(s) for @var{specifier}.
|
|
|
1321
|
|
|
1322 If @var{locale} is a particular locale (a buffer, window, frame, device,
|
|
|
1323 or the symbol @code{global}), the specification for that locale will be
|
|
|
1324 removed.
|
|
|
1325
|
|
|
1326 If instead, @var{locale} is a locale type (i.e. a symbol @code{buffer},
|
|
|
1327 @code{window}, @code{frame}, or @code{device}), the specifications for
|
|
|
1328 all locales of that type will be removed.
|
|
|
1329
|
|
|
1330 If @var{locale} is @code{nil} or the symbol @code{all}, all
|
|
|
1331 specifications will be removed.
|
|
|
1332
|
|
|
1333 @var{locale} can also be a list of locales, locale types, and/or
|
|
|
1334 @code{all}; this is equivalent to calling @code{remove-specifier} for
|
|
|
1335 each of the elements in the list.
|
|
|
1336
|
|
|
1337 Only instantiators where @var{tag-set} (a list of zero or more tags) is
|
|
|
1338 a subset of (or possibly equal to) the instantiator's tag set are
|
|
|
1339 removed. (The default value of @code{nil} is a subset of all tag sets,
|
|
|
1340 so in this case no instantiators will be screened out.) If @var{exact-p}
|
|
|
1341 is non-@code{nil}, however, @var{tag-set} must be equal to an
|
|
|
1342 instantiator's tag set for the instantiator to be removed.
|
|
|
1343 @end defun
|
|
|
1344
|
|
|
1345 @defun map-specifier specifier func &optional locale maparg
|
|
|
1346 This function applies @var{func} to the specification(s) for
|
|
|
1347 @var{locale} in @var{specifier}.
|
|
|
1348
|
|
|
1349 If @var{locale} is a locale, @var{func} will be called for that locale.
|
|
|
1350 If @var{locale} is a locale type, @var{func} will be mapped over all
|
|
|
1351 locales of that type. If @var{locale} is @code{nil} or the symbol
|
|
|
1352 @code{all}, @var{func} will be mapped over all locales in
|
|
|
1353 @var{specifier}.
|
|
|
1354
|
|
|
1355 @var{func} is called with four arguments: the @var{specifier}, the
|
|
|
1356 locale being mapped over, the inst-list for that locale, and the
|
|
|
1357 optional @var{maparg}. If any invocation of @var{func} returns
|
|
|
1358 non-@code{nil}, the mapping will stop and the returned value becomes the
|
|
|
1359 value returned from @code{map-specifier}. Otherwise,
|
|
|
1360 @code{map-specifier} returns @code{nil}.
|
|
|
1361 @end defun
|
|
|
1362
|
|
|
1363 @defun specifier-locale-type-from-locale locale
|
|
|
1364 Given a specifier @var{locale}, this function returns its type.
|
|
|
1365 @end defun
|
|
|
1366
|
