Mercurial > hg > xemacs-beta
annotate src/specifier.h @ 4539:061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
lib-src/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* make-docfile.c (main): Allow more than one -d argument, followed
by a directory to change to.
(put_filename): Don't strip directory information; with previous
change, allows retrieval of Lisp function and variable origin
files from #'built-in-symbol-file relative to lisp-directory.
(scan_lisp_file): Don't add an extraneous newline after the file
name, put_filename has added the newline already.
lisp/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* loadup.el (load-history):
Add the contents of current-load-list to load-history before
clearing it. Move the variable declarations earlier in the file to
a format understood by make-docfile.c.
* custom.el (custom-declare-variable): Add the variable's symbol
to the current file's load history entry correctly, don't use a
cons. Eliminate a comment that we don't need to worry about, we
don't need to check the `initialized' C variable in Lisp.
* bytecomp.el (byte-compile-output-file-form):
Merge Andreas Schwab's pre-GPLv3 GNU change of 19970831 here;
treat #'custom-declare-variable correctly, generating the
docstrings in a format understood by make-docfile.c.
* loadhist.el (symbol-file): Correct behaviour for checking
autoloaded macros and functions when supplied with a TYPE
argument. Accept fully-qualified paths from
#'built-in-symbol-file; if a path is not fully-qualified, return
it relative to lisp-directory if the filename corresponds to a
Lisp file, and relative to (concat source-directory "/src/")
otherwise.
* make-docfile.el (preloaded-file-list):
Rationalise some let bindings a little. Use the "-d" argument to
make-docfile.c to supply Lisp paths relative to lisp-directory,
not absolutely. Add in loadup.el explicitly to the list of files
to be processed by make-docfile.c--it doesn't make sense to add it
to preloaded-file-list, since that is used for purposes of
byte-compilation too.
src/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* doc.c (Fbuilt_in_symbol_file):
Return a subr's filename immediately if we've found it. Check for
compiled function and compiled macro docstrings in DOC too, and
return them if they exist.
The branch of the if statement focused on functions may have
executed, but we may still want to check variable bindings; an
else clause isn't appropriate.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sat, 27 Dec 2008 14:05:50 +0000 |
| parents | d00347ec8289 |
| children | d95c102a96d3 e0db3c197671 |
| rev | line source |
|---|---|
| 428 | 1 /* Generic specifier list implementation |
| 2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois. | |
| 826 | 3 Copyright (C) 1995, 1996, 2002 Ben Wing |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
| 7 XEmacs is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 9 Free Software Foundation; either version 2, or (at your option) any | |
| 10 later version. | |
| 11 | |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 18 along with XEmacs; see the file COPYING. If not, write to | |
| 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 20 Boston, MA 02111-1307, USA. */ | |
| 21 | |
| 22 /* Synched up with: Not in FSF. */ | |
| 23 | |
| 440 | 24 #ifndef INCLUDED_specifier_h_ |
| 25 #define INCLUDED_specifier_h_ | |
| 428 | 26 |
| 27 /* | |
| 28 MAGIC SPECIFIERS | |
| 29 ================ | |
| 30 | |
| 31 Magic specifiers are used to provide fallback values for window | |
| 32 system provided specifications, reflecting user preferences on the | |
| 33 window system, such as default fonts, colors, scrollbar thickness | |
| 34 etc. | |
| 35 | |
| 36 A magic specifier consists of two specifier objects. The first one | |
| 37 behaves like a normal specifier in all senses. The second one, a | |
| 38 ghost specifier, is a fallback value for the first one, and contains | |
| 39 values provided by window system, resources etc. which reflect | |
| 40 default settings for values being specified. | |
| 41 | |
| 42 A magic specifier has an "ultimate" fallback value, as any usual | |
| 43 specifier does. This value, an inst-list, is stored in the fallback | |
| 44 slot of the ghost specifier object. | |
| 45 | |
| 46 Ghost specifiers have the following properties: | |
| 47 - Have back pointers to their parent specifiers. | |
| 48 - Do not have instance data. Instead, they share parent's instance | |
| 49 data. | |
| 50 - Have the same methods structure pointer. | |
| 51 - Share parent's caching scheme. | |
| 52 - Store fallback value instead of their parents. | |
| 53 | |
| 54 Ghost specifiers normally are not modifiable at the lisp level, and | |
| 55 only used to supply fallback instance values. They are accessible | |
| 56 via (specifier-fallback), but are read-only. Although, under | |
| 57 certain rare conditions, modification of ghost objects is allowed. | |
| 58 This behavior is controlled by the global variable | |
| 59 Vunlock_ghost_specifiers. It is not exposed to lisp, and is set | |
| 60 during calls to lisp functions which initialize global, device and | |
| 61 frame defaults, such as | |
| 62 init-{global,frame,device}-{faces,toolbars,etc}. | |
| 63 | |
| 64 Thus, values supplied by resources or other means of a window system | |
| 65 stored in externally unmodifiable ghost objects. Regular lisp code | |
| 66 may thus freely modify the normal part of a magic specifier, and | |
| 67 removing a specification for a particular domain causes the | |
| 68 specification to consider ghost-provided fallback values, or its own | |
| 69 fallback value. | |
| 70 | |
| 71 Rules of conduct for magic specifiers | |
| 72 ------------------------------------- | |
| 73 1. recompute_*() functions always operate on the whole specifier | |
| 74 when passed only a ghost object, by substituting it with their | |
| 75 parent bodily object. | |
| 76 2. All specifier methods, except for instantiate method, are passed | |
| 77 the bodily object of the magic specifier. Instantiate method is | |
| 78 passed the specifier being instantiated. | |
| 79 3. Only bodily objects are passed to set_specifier_caching function, | |
| 80 and only these may be cached. | |
| 81 4. All specifiers are added to Vall_specifiers list, both bodily and | |
| 82 ghost. The pair of objects is always removed from the list at the | |
| 83 same time. | |
| 84 */ | |
| 85 | |
| 1204 | 86 extern const struct sized_memory_description specifier_methods_description; |
| 428 | 87 |
| 88 struct specifier_methods | |
| 89 { | |
| 442 | 90 const char *name; |
| 428 | 91 Lisp_Object predicate_symbol; |
| 92 | |
| 93 /* Implementation specific methods: */ | |
| 94 | |
| 95 /* Create method: Initialize specifier data. Optional. */ | |
| 96 void (*create_method) (Lisp_Object specifier); | |
| 97 | |
| 98 /* Mark method: Mark any lisp object within specifier data | |
| 99 structure. Not required if no specifier data are Lisp_Objects. */ | |
| 100 void (*mark_method) (Lisp_Object specifier); | |
| 101 | |
| 102 /* Equal method: Compare two specifiers. This is called after | |
| 103 ensuring that the two specifiers are of the same type, and have | |
| 104 the same specs. Quit is inhibited during the call so it is safe | |
| 105 to call internal_equal(). | |
| 106 | |
| 107 If this function is not present, specifiers considered equal when | |
| 108 the above conditions are met, i.e. as if the method returned | |
| 109 non-zero. */ | |
| 110 int (*equal_method) (Lisp_Object sp1, Lisp_Object sp2, int depth); | |
| 111 | |
| 112 /* Hash method: Hash specifier instance data. This has to hash only | |
| 113 data structure of the specifier, as specs are hashed by the core | |
| 114 code. | |
| 115 | |
| 116 If this function is not present, hashing behaves as if it | |
| 117 returned zero. */ | |
| 2515 | 118 Hashcode (*hash_method) (Lisp_Object specifier, int depth); |
| 428 | 119 |
| 120 /* Validate method: Given an instantiator, verify that it's | |
| 121 valid for this specifier type. If not, signal an error. | |
| 122 | |
| 123 If this function is not present, all instantiators are considered | |
| 124 valid. */ | |
| 125 void (*validate_method) (Lisp_Object instantiator); | |
| 126 | |
| 434 | 127 |
| 128 /* Copy method: Given an instantiator, copy the bits that we need to | |
| 129 for this specifier type. | |
| 130 | |
| 131 If this function is not present, then Fcopy_tree is used. */ | |
| 132 Lisp_Object (*copy_instantiator_method) (Lisp_Object instantiator); | |
| 133 | |
| 428 | 134 /* Validate-matchspec method: Given a matchspec, verify that it's |
| 135 valid for this specifier type. If not, signal an error. | |
| 136 | |
| 137 If this function is not present, *no* matchspecs are considered | |
| 138 valid. Note that this differs from validate_method(). */ | |
| 139 void (*validate_matchspec_method) (Lisp_Object matchspec); | |
| 140 | |
| 141 /* Instantiate method: Return SPECIFIER instance in DOMAIN, | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
142 specified by INSTANTIATOR. MATCHSPEC specifies additional |
| 428 | 143 constraints on the instance value (see the docstring for |
| 144 Fspecifier_matching_instance function). MATCHSPEC is passed | |
| 145 Qunbound when no matching constraints are imposed. The method is | |
| 146 called via call_with_suspended_errors(), so allowed to eval | |
| 147 safely. | |
| 148 | |
| 149 DEPTH is a lisp integer denoting current depth of instantiation | |
| 150 calls. This parameter should be passed as the initial depth value | |
| 151 to functions which also instantiate specifiers (of which I can | |
| 152 name specifier_instance) to avoid creating "external" | |
| 153 specification loops. | |
| 154 | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
155 NO_FALLBACK indicates that the method should not try the fallbacks |
|
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
156 (and thus simply return Qunbound) in case of a failure to instantiate. |
|
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
157 |
| 442 | 158 This method must presume that both INSTANTIATOR and MATCHSPEC are |
| 428 | 159 already validated by the corresponding validate_* methods, and |
| 160 may abort if they are invalid. | |
| 161 | |
| 162 Return value is an instance, which is returned immediately to the | |
| 163 caller, or Qunbound to continue instantiation lookup chain. | |
| 164 | |
| 165 If this function is not present, INSTANTIATOR is used as the | |
| 166 specifier instance. This is the usual case for "simple" | |
| 167 specifiers, like integer and boolean. */ | |
| 168 Lisp_Object (*instantiate_method) (Lisp_Object specifier, | |
| 169 Lisp_Object matchspec, | |
| 170 Lisp_Object domain, | |
| 171 Lisp_Object instantiator, | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
172 Lisp_Object depth, |
|
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
173 int no_fallback); |
| 428 | 174 |
| 175 /* Going-to-add method: Called when an instantiator is about | |
| 176 to be added to a specifier. This function can specify | |
| 177 that different instantiators should be used instead by | |
| 178 returning an inst-list (possibly containing zero elements). | |
| 179 If the instantiator is fine as-is, return Qt. The | |
| 180 instantiator has been copied with copy-tree, so feel | |
| 181 free to reuse parts of it to create a new instantiator. | |
| 182 The tag-set, however, is not copied and is not canonicalized | |
| 183 (that will be done on the result of this function). */ | |
| 184 Lisp_Object (*going_to_add_method) (Lisp_Object specifier, | |
| 185 Lisp_Object locale, | |
| 186 Lisp_Object tag_set, | |
| 187 Lisp_Object instantiator); | |
| 188 | |
| 189 /* After-change method: Called when the SPECIFIER has just been | |
| 190 changed in LOCALE. The method is called upon: | |
| 191 * Removing and adding specs to/from the specifier; | |
| 192 * Changing the specifier fallback. | |
| 193 | |
| 194 #### The method may have called more than once per each specifier | |
| 195 change. | |
| 196 | |
| 197 #### Do not still know if this can safely eval. */ | |
| 198 void (*after_change_method) (Lisp_Object specifier, | |
| 199 Lisp_Object locale); | |
| 200 | |
| 1204 | 201 /* Specifier extra data: Specifier objects can have extra data, specific |
| 202 to the type of specifier, stored at the end of the object. To have | |
| 203 this, a specifier declares a structure of type `struct TYPE_specifier' | |
| 204 containing the data and uses DEFINE_SPECIFIER_TYPE_WITH_DATA and | |
| 205 INITIALIZE_SPECIFIER_TYPE_WITH_DATA instead of the plain versions. | |
| 206 Then, a pointer to the `struct TYPE_specifier' can be obtained from a | |
| 207 specifier object using SPECIFIER_TYPE_DATA. | |
| 771 | 208 |
| 1204 | 209 A data description of the extra data must also be provided, in the |
| 210 form of a memory_description named TYPE_specifier_description. */ | |
| 211 | |
| 212 /* Description of extra data structure; initialized when | |
| 771 | 213 INITIALIZE_SPECIFIER_TYPE_WITH_DATA is called. */ |
| 1204 | 214 const struct sized_memory_description *extra_description; |
| 771 | 215 |
| 216 /* Size of extra data structure; initialized when | |
| 217 INITIALIZE_SPECIFIER_TYPE_WITH_DATA is called. */ | |
| 428 | 218 int extra_data_size; |
| 219 }; | |
| 220 | |
| 221 struct Lisp_Specifier | |
| 222 { | |
| 3017 | 223 struct LCRECORD_HEADER header; |
| 428 | 224 struct specifier_methods *methods; |
| 225 | |
| 226 /* we keep a chained list of all current specifiers, for GC cleanup | |
| 227 purposes. Do NOT mark through this, or specifiers will never | |
| 228 be GC'd. */ | |
| 229 Lisp_Object next_specifier; | |
| 230 | |
| 231 /* This is a straight list of instantiators. */ | |
| 232 Lisp_Object global_specs; | |
| 233 | |
| 234 /* These are all assoc lists where the key is the type of object the | |
| 235 list represents (buffer, window, etc.) and the associated list is | |
| 236 the actual list of instantiators. */ | |
| 237 Lisp_Object device_specs; | |
| 238 Lisp_Object frame_specs; | |
| 239 /* window_specs is actually a key-assoc weak list. See specifier.c | |
| 240 for an explanation of why (it boils down to the fact that | |
| 241 dead windows can become live again through window configurations). | |
| 242 */ | |
| 243 Lisp_Object window_specs; | |
| 244 Lisp_Object buffer_specs; | |
| 245 | |
| 246 struct specifier_caching *caching; | |
| 247 | |
| 248 /* This can be either nil, for a plain, non-magic specifier object, | |
| 249 t for the normal part of the magic specifier, or #<specifier> for | |
| 250 the ghost part of the magic specifier, a pointer to its parent | |
| 251 object */ | |
| 252 Lisp_Object magic_parent; | |
| 253 | |
| 254 /* Fallback value. For magic specifiers, it is a pointer to the ghost. */ | |
| 255 Lisp_Object fallback; | |
| 256 | |
| 257 /* type-specific extra data attached to a specifier */ | |
| 456 | 258 max_align_t data[1]; |
| 428 | 259 }; |
| 440 | 260 typedef struct Lisp_Specifier Lisp_Specifier; |
| 428 | 261 |
| 440 | 262 DECLARE_LRECORD (specifier, Lisp_Specifier); |
| 263 #define XSPECIFIER(x) XRECORD (x, specifier, Lisp_Specifier) | |
| 617 | 264 #define wrap_specifier(p) wrap_record (p, specifier) |
| 428 | 265 #define SPECIFIERP(x) RECORDP (x, specifier) |
| 266 #define CHECK_SPECIFIER(x) CHECK_RECORD (x, specifier) | |
| 267 #define CONCHECK_SPECIFIER(x) CONCHECK_RECORD (x, specifier) | |
| 268 | |
| 269 /***** Calling a specifier method *****/ | |
| 270 | |
| 271 #define RAW_SPECMETH(sp, m) ((sp)->methods->m##_method) | |
| 272 #define HAS_SPECMETH_P(sp, m) (!!RAW_SPECMETH (sp, m)) | |
| 273 #define SPECMETH(sp, m, args) (((sp)->methods->m##_method) args) | |
| 274 | |
| 275 /* Call a void-returning specifier method, if it exists. */ | |
| 440 | 276 #define MAYBE_SPECMETH(sp, m, args) do { \ |
| 277 Lisp_Specifier *maybe_specmeth_sp = (sp); \ | |
| 278 if (HAS_SPECMETH_P (maybe_specmeth_sp, m)) \ | |
| 279 SPECMETH (maybe_specmeth_sp, m, args); \ | |
| 428 | 280 } while (0) |
| 281 | |
| 282 /***** Defining new specifier types *****/ | |
| 283 | |
| 1204 | 284 extern const struct sized_memory_description specifier_empty_extra_description; |
| 428 | 285 |
| 800 | 286 #ifdef ERROR_CHECK_TYPES |
| 428 | 287 #define DECLARE_SPECIFIER_TYPE(type) \ |
| 288 extern struct specifier_methods * type##_specifier_methods; \ | |
| 826 | 289 DECLARE_INLINE_HEADER ( \ |
| 290 struct type##_specifier * \ | |
| 440 | 291 error_check_##type##_specifier_data (Lisp_Specifier *sp) \ |
| 826 | 292 ) \ |
| 428 | 293 { \ |
| 294 if (SPECIFIERP (sp->magic_parent)) \ | |
| 295 { \ | |
| 296 assert (SPECIFIER_TYPE_P (sp, type)); \ | |
| 297 sp = XSPECIFIER (sp->magic_parent); \ | |
| 298 } \ | |
| 299 else \ | |
| 300 assert (NILP (sp->magic_parent) || EQ (sp->magic_parent, Qt)); \ | |
| 301 assert (SPECIFIER_TYPE_P (sp, type)); \ | |
| 302 return (struct type##_specifier *) sp->data; \ | |
| 303 } \ | |
| 826 | 304 DECLARE_INLINE_HEADER ( \ |
| 305 Lisp_Specifier * \ | |
| 438 | 306 error_check_##type##_specifier_type (Lisp_Object obj) \ |
| 826 | 307 ) \ |
| 438 | 308 { \ |
| 440 | 309 Lisp_Specifier *sp = XSPECIFIER (obj); \ |
| 438 | 310 assert (SPECIFIER_TYPE_P (sp, type)); \ |
| 311 return sp; \ | |
| 312 } \ | |
| 428 | 313 DECLARE_NOTHING |
| 314 #else | |
| 442 | 315 #define DECLARE_SPECIFIER_TYPE(type) \ |
| 428 | 316 extern struct specifier_methods * type##_specifier_methods |
| 800 | 317 #endif /* ERROR_CHECK_TYPES */ |
| 428 | 318 |
| 442 | 319 #define DEFINE_SPECIFIER_TYPE(type) \ |
| 428 | 320 struct specifier_methods * type##_specifier_methods |
| 321 | |
| 1204 | 322 #define DEFINE_SPECIFIER_TYPE_WITH_DATA(type) \ |
| 323 struct specifier_methods * type##_specifier_methods; \ | |
| 324 static const struct sized_memory_description type##_specifier_description_0 \ | |
| 325 = { \ | |
| 326 sizeof (struct type##_specifier), \ | |
| 327 type##_specifier_description \ | |
| 328 } | |
| 329 | |
| 771 | 330 #define INITIALIZE_SPECIFIER_TYPE(type, obj_name, pred_sym) do { \ |
| 331 type##_specifier_methods = xnew_and_zero (struct specifier_methods); \ | |
| 332 type##_specifier_methods->name = obj_name; \ | |
| 333 type##_specifier_methods->extra_description = \ | |
| 1204 | 334 &specifier_empty_extra_description; \ |
| 771 | 335 defsymbol_nodump (&type##_specifier_methods->predicate_symbol, pred_sym); \ |
| 336 add_entry_to_specifier_type_list (Q##type, type##_specifier_methods); \ | |
| 2367 | 337 dump_add_root_block_ptr (&type##_specifier_methods, \ |
| 771 | 338 &specifier_methods_description); \ |
| 428 | 339 } while (0) |
| 340 | |
| 442 | 341 #define REINITIALIZE_SPECIFIER_TYPE(type) do { \ |
| 428 | 342 staticpro_nodump (&type##_specifier_methods->predicate_symbol); \ |
| 343 } while (0) | |
| 344 | |
| 345 #define INITIALIZE_SPECIFIER_TYPE_WITH_DATA(type, obj_name, pred_sym) \ | |
| 346 do { \ | |
| 347 INITIALIZE_SPECIFIER_TYPE (type, obj_name, pred_sym); \ | |
| 348 type##_specifier_methods->extra_data_size = \ | |
| 349 sizeof (struct type##_specifier); \ | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
350 type##_specifier_methods->extra_description = \ |
| 1204 | 351 &type##_specifier_description_0; \ |
| 428 | 352 } while (0) |
| 353 | |
| 354 /* Declare that specifier-type TYPE has method METH; used in | |
| 355 initialization routines */ | |
| 356 #define SPECIFIER_HAS_METHOD(type, meth) \ | |
| 357 (type##_specifier_methods->meth##_method = type##_##meth) | |
| 358 | |
| 359 /***** Macros for accessing specifier types *****/ | |
| 360 | |
| 361 #define SPECIFIER_TYPE_P(sp, type) \ | |
| 362 ((sp)->methods == type##_specifier_methods) | |
| 363 | |
| 364 /* Any of the two of the magic spec */ | |
| 365 #define MAGIC_SPECIFIER_P(sp) (!NILP((sp)->magic_parent)) | |
| 366 /* Normal part of the magic specifier */ | |
| 367 #define BODILY_SPECIFIER_P(sp) EQ ((sp)->magic_parent, Qt) | |
| 368 /* Ghost part of the magic specifier */ | |
| 369 #define GHOST_SPECIFIER_P(sp) SPECIFIERP((sp)->magic_parent) | |
| 370 | |
| 371 #define GHOST_SPECIFIER(sp) XSPECIFIER ((sp)->fallback) | |
| 372 | |
| 800 | 373 #ifdef ERROR_CHECK_TYPES |
| 428 | 374 # define SPECIFIER_TYPE_DATA(sp, type) \ |
| 375 error_check_##type##_specifier_data (sp) | |
| 376 #else | |
| 377 # define SPECIFIER_TYPE_DATA(sp, type) \ | |
| 378 ((struct type##_specifier *) \ | |
| 379 (GHOST_SPECIFIER_P(sp) \ | |
| 380 ? XSPECIFIER((sp)->magic_parent)->data \ | |
| 381 : (sp)->data)) | |
| 382 #endif | |
| 383 | |
| 800 | 384 #ifdef ERROR_CHECK_TYPES |
| 438 | 385 # define XSPECIFIER_TYPE(x, type) \ |
| 386 error_check_##type##_specifier_type (x) | |
| 387 #else | |
| 388 # define XSPECIFIER_TYPE(x, type) XSPECIFIER (x) | |
| 800 | 389 #endif /* ERROR_CHECK_TYPES */ |
| 428 | 390 |
| 442 | 391 #define SPECIFIER_TYPEP(x, type) \ |
| 428 | 392 (SPECIFIERP (x) && SPECIFIER_TYPE_P (XSPECIFIER (x), type)) |
| 393 #define CHECK_SPECIFIER_TYPE(x, type) do { \ | |
| 394 CHECK_SPECIFIER (x); \ | |
| 395 if (!SPECIFIER_TYPE_P (XSPECIFIER (x), type)) \ | |
| 396 dead_wrong_type_argument \ | |
| 397 (type##_specifier_methods->predicate_symbol, x); \ | |
| 398 } while (0) | |
| 399 #define CONCHECK_SPECIFIER_TYPE(x, type) do { \ | |
| 400 CONCHECK_SPECIFIER (x); \ | |
| 401 if (!(SPECIFIER_TYPEP (x, type))) \ | |
| 402 x = wrong_type_argument \ | |
| 403 (type##_specifier_methods->predicate_symbol, x); \ | |
| 404 } while (0) | |
| 405 | |
| 406 /***** Miscellaneous structures *****/ | |
| 407 | |
| 408 enum spec_locale_type | |
| 409 { | |
| 410 LOCALE_GLOBAL, | |
| 411 LOCALE_DEVICE, | |
| 412 LOCALE_FRAME, | |
| 413 LOCALE_WINDOW, | |
| 414 LOCALE_BUFFER | |
| 415 }; | |
| 416 | |
| 417 enum spec_add_meth | |
| 418 { | |
| 419 SPEC_PREPEND, | |
| 420 SPEC_APPEND, | |
| 421 SPEC_REMOVE_TAG_SET_PREPEND, | |
| 422 SPEC_REMOVE_TAG_SET_APPEND, | |
| 423 SPEC_REMOVE_LOCALE, | |
| 424 SPEC_REMOVE_LOCALE_TYPE, | |
| 425 SPEC_REMOVE_ALL | |
| 426 }; | |
| 427 | |
| 428 struct specifier_caching | |
| 429 { | |
| 3092 | 430 #ifdef NEW_GC |
| 431 struct lrecord_header header; | |
| 432 #endif /* NEW_GC */ | |
| 428 | 433 int offset_into_struct_window; |
| 434 void (*value_changed_in_window) (Lisp_Object specifier, struct window *w, | |
| 435 Lisp_Object oldval); | |
| 436 int offset_into_struct_frame; | |
| 437 void (*value_changed_in_frame) (Lisp_Object specifier, struct frame *f, | |
| 438 Lisp_Object oldval); | |
| 444 | 439 int always_recompute; |
| 428 | 440 }; |
| 441 | |
| 3092 | 442 #ifdef NEW_GC |
| 443 DECLARE_LRECORD (specifier_caching, struct specifier_caching); | |
| 444 #define XSPECIFIER_CACHING(x) \ | |
| 445 XRECORD (x, specifier_caching, struct specifier_caching) | |
| 446 #define wrap_specifier_caching(p) \ | |
| 447 wrap_record (p, specifier_caching) | |
| 448 #define SPECIFIER_CACHINGP(x) RECORDP (x, specifier_caching) | |
| 449 #define CHECK_SPECIFIER_CACHING(x) \ | |
| 450 CHECK_RECORD (x, specifier_caching) | |
| 451 #define CONCHECK_SPECIFIER_CACHING(x) \ | |
| 452 CONCHECK_RECORD (x, specifier_caching) | |
| 453 #endif /* NEW_GC */ | |
| 454 | |
| 442 | 455 /* #### get image instances out of domains! */ |
| 456 | |
| 2500 | 457 /* #### I think the following should ABORT() rather than return nil |
| 442 | 458 when an invalid domain is given; much more likely we'll catch design |
| 459 errors early. --ben */ | |
| 460 | |
| 461 /* This turns out to be used heavily so we make it a macro to make it | |
| 462 inline. Also, the majority of the time the object will turn out to | |
| 463 be a window so we move it from being checked last to being checked | |
| 464 first. */ | |
| 465 #define DOMAIN_DEVICE(obj) \ | |
| 466 (WINDOWP (obj) ? WINDOW_DEVICE (XWINDOW (obj)) \ | |
| 467 : (FRAMEP (obj) ? FRAME_DEVICE (XFRAME (obj)) \ | |
| 468 : (DEVICEP (obj) ? obj \ | |
| 469 : (IMAGE_INSTANCEP (obj) ? image_instance_device (obj) \ | |
| 470 : Qnil)))) | |
| 471 | |
| 472 #define DOMAIN_FRAME(obj) \ | |
| 473 (WINDOWP (obj) ? WINDOW_FRAME (XWINDOW (obj)) \ | |
| 474 : (FRAMEP (obj) ? obj \ | |
| 475 : (IMAGE_INSTANCEP (obj) ? image_instance_frame (obj) \ | |
| 476 : Qnil))) | |
| 477 | |
| 478 #define DOMAIN_WINDOW(obj) \ | |
| 479 (WINDOWP (obj) ? obj \ | |
| 480 : (IMAGE_INSTANCEP (obj) ? image_instance_window (obj) \ | |
| 481 : Qnil)) | |
| 482 | |
| 483 #define DOMAIN_LIVE_P(obj) \ | |
| 484 (WINDOWP (obj) ? WINDOW_LIVE_P (XWINDOW (obj)) \ | |
| 485 : (FRAMEP (obj) ? FRAME_LIVE_P (XFRAME (obj)) \ | |
| 486 : (DEVICEP (obj) ? DEVICE_LIVE_P (XDEVICE (obj)) \ | |
| 487 : (IMAGE_INSTANCEP (obj) ? image_instance_live_p (obj) \ | |
| 488 : 0)))) | |
| 489 | |
| 490 #define DOMAIN_XDEVICE(obj) \ | |
| 491 (XDEVICE (DOMAIN_DEVICE (obj))) | |
| 492 #define DOMAIN_XFRAME(obj) \ | |
| 493 (XFRAME (DOMAIN_FRAME (obj))) | |
| 494 #define DOMAIN_XWINDOW(obj) \ | |
| 495 (XWINDOW (DOMAIN_WINDOW (obj))) | |
| 496 | |
| 428 | 497 EXFUN (Fcopy_specifier, 6); |
| 498 EXFUN (Fmake_specifier, 1); | |
| 499 EXFUN (Fset_specifier_dirty_flag, 1); | |
| 500 EXFUN (Fspecifier_instance, 4); | |
| 501 EXFUN (Fvalid_specifier_locale_p, 1); | |
| 502 | |
| 503 extern Lisp_Object Qfallback, Qnatnum; | |
| 504 | |
| 505 Lisp_Object make_magic_specifier (Lisp_Object type); | |
| 506 Lisp_Object decode_locale_list (Lisp_Object locale); | |
| 507 extern enum spec_add_meth | |
| 508 decode_how_to_add_specification (Lisp_Object how_to_add); | |
| 509 Lisp_Object decode_specifier_tag_set (Lisp_Object tag_set); | |
| 442 | 510 Lisp_Object decode_domain (Lisp_Object domain); |
| 428 | 511 |
| 512 void add_entry_to_specifier_type_list (Lisp_Object symbol, | |
| 513 struct specifier_methods *meths); | |
| 514 void set_specifier_caching (Lisp_Object specifier, | |
| 515 int struct_window_offset, | |
| 516 void (*value_changed_in_window) | |
| 517 (Lisp_Object specifier, struct window *w, | |
| 518 Lisp_Object oldval), | |
| 519 int struct_frame_offset, | |
| 520 void (*value_changed_in_frame) | |
| 521 (Lisp_Object specifier, struct frame *f, | |
| 444 | 522 Lisp_Object oldval), |
| 523 int always_recompute); | |
| 428 | 524 void set_specifier_fallback (Lisp_Object specifier, |
| 525 Lisp_Object fallback); | |
| 526 void recompute_all_cached_specifiers_in_window (struct window *w); | |
| 527 void recompute_all_cached_specifiers_in_frame (struct frame *f); | |
| 528 | |
| 529 /* Counterparts of Fadd_spec_to_specifier and Fremove_specifier, which | |
| 530 operate directly on ghost objects given a magic specifier. */ | |
| 531 void add_spec_to_ghost_specifier (Lisp_Object specifier, Lisp_Object instantiator, | |
| 532 Lisp_Object locale, Lisp_Object tag_set, | |
| 533 Lisp_Object how_to_add); | |
| 534 void remove_ghost_specifier (Lisp_Object specifier, Lisp_Object locale, | |
| 535 Lisp_Object tag_set, Lisp_Object exact_p); | |
| 536 | |
| 537 int unlock_ghost_specifiers_protected (void); | |
| 538 | |
| 539 void cleanup_specifiers (void); | |
| 540 void prune_specifiers (void); | |
| 541 void setup_device_initial_specifier_tags (struct device *d); | |
| 3659 | 542 void setup_charset_initial_specifier_tags (Lisp_Object charset); |
| 428 | 543 void kill_specifier_buffer_locals (Lisp_Object buffer); |
| 544 | |
| 545 DECLARE_SPECIFIER_TYPE (generic); | |
| 546 #define XGENERIC_SPECIFIER(x) XSPECIFIER_TYPE (x, generic) | |
| 547 #define GENERIC_SPECIFIERP(x) SPECIFIER_TYPEP (x, generic) | |
| 548 #define CHECK_GENERIC_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, generic) | |
| 549 #define CONCHECK_GENERIC_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, generic) | |
| 550 | |
| 551 DECLARE_SPECIFIER_TYPE (integer); | |
| 552 #define XINTEGER_SPECIFIER(x) XSPECIFIER_TYPE (x, integer) | |
| 553 #define INTEGER_SPECIFIERP(x) SPECIFIER_TYPEP (x, integer) | |
| 554 #define CHECK_INTEGER_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, integer) | |
| 555 #define CONCHECK_INTEGER_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, integer) | |
| 556 | |
| 557 DECLARE_SPECIFIER_TYPE (natnum); | |
| 558 #define XNATNUM_SPECIFIER(x) XSPECIFIER_TYPE (x, natnum) | |
| 559 #define NATNUM_SPECIFIERP(x) SPECIFIER_TYPEP (x, natnum) | |
| 560 #define CHECK_NATNUM_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, natnum) | |
| 561 #define CONCHECK_NATNUM_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, natnum) | |
| 562 | |
| 563 DECLARE_SPECIFIER_TYPE (boolean); | |
| 564 #define XBOOLEAN_SPECIFIER(x) XSPECIFIER_TYPE (x, boolean) | |
| 565 #define BOOLEAN_SPECIFIERP(x) SPECIFIER_TYPEP (x, boolean) | |
| 566 #define CHECK_BOOLEAN_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, boolean) | |
| 567 #define CONCHECK_BOOLEAN_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, boolean) | |
| 568 | |
| 569 DECLARE_SPECIFIER_TYPE (display_table); | |
| 570 #define XDISPLAYTABLE_SPECIFIER(x) XSPECIFIER_TYPE (x, display_table) | |
| 571 #define DISPLAYTABLE_SPECIFIERP(x) SPECIFIER_TYPEP (x, display_table) | |
| 572 #define CHECK_DISPLAYTABLE_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, display_table) | |
| 573 #define CONCHECK_DISPLAYTABLE_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, display_table) | |
| 574 | |
| 3659 | 575 /* The various stages of font instantiation; initial means "find a font for |
| 576 CHARSET that matches the charset's registries" and final means "find a | |
| 577 font for CHARSET that matches iso10646-1, since we haven't found a font | |
| 578 that matches its registry." */ | |
| 579 enum font_specifier_matchspec_stages { | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
580 initial, |
| 3659 | 581 final, |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
582 impossible, |
| 3659 | 583 }; |
| 584 | |
| 585 Lisp_Object define_specifier_tag(Lisp_Object tag, | |
|
4430
d00347ec8289
Fix instantiate_method prototype
Didier Verna <didier@xemacs.org>
parents:
3659
diff
changeset
|
586 Lisp_Object device_predicate, |
| 3659 | 587 Lisp_Object charset_predicate); |
| 588 | |
| 440 | 589 #endif /* INCLUDED_specifier_h_ */ |