Don't display ‘’ as `' under X in en_GB
[emacs.git] / src / data.c
blob80f2ac9f90477664548243901f9971d9784e1f31
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2015 Free Software
3 Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <stdio.h>
24 #include <byteswap.h>
25 #include <count-one-bits.h>
26 #include <count-trailing-zeros.h>
27 #include <intprops.h>
29 #include "lisp.h"
30 #include "puresize.h"
31 #include "character.h"
32 #include "buffer.h"
33 #include "keyboard.h"
34 #include "frame.h"
35 #include "syssignal.h"
36 #include "termhooks.h" /* For FRAME_KBOARD reference in y-or-n-p. */
37 #include "font.h"
38 #include "keymap.h"
40 static void swap_in_symval_forwarding (struct Lisp_Symbol *,
41 struct Lisp_Buffer_Local_Value *);
43 static bool
44 BOOLFWDP (union Lisp_Fwd *a)
46 return XFWDTYPE (a) == Lisp_Fwd_Bool;
48 static bool
49 INTFWDP (union Lisp_Fwd *a)
51 return XFWDTYPE (a) == Lisp_Fwd_Int;
53 static bool
54 KBOARD_OBJFWDP (union Lisp_Fwd *a)
56 return XFWDTYPE (a) == Lisp_Fwd_Kboard_Obj;
58 static bool
59 OBJFWDP (union Lisp_Fwd *a)
61 return XFWDTYPE (a) == Lisp_Fwd_Obj;
64 static struct Lisp_Boolfwd *
65 XBOOLFWD (union Lisp_Fwd *a)
67 eassert (BOOLFWDP (a));
68 return &a->u_boolfwd;
70 static struct Lisp_Kboard_Objfwd *
71 XKBOARD_OBJFWD (union Lisp_Fwd *a)
73 eassert (KBOARD_OBJFWDP (a));
74 return &a->u_kboard_objfwd;
76 static struct Lisp_Intfwd *
77 XINTFWD (union Lisp_Fwd *a)
79 eassert (INTFWDP (a));
80 return &a->u_intfwd;
82 static struct Lisp_Objfwd *
83 XOBJFWD (union Lisp_Fwd *a)
85 eassert (OBJFWDP (a));
86 return &a->u_objfwd;
89 static void
90 CHECK_SUBR (Lisp_Object x)
92 CHECK_TYPE (SUBRP (x), Qsubrp, x);
95 static void
96 set_blv_found (struct Lisp_Buffer_Local_Value *blv, int found)
98 eassert (found == !EQ (blv->defcell, blv->valcell));
99 blv->found = found;
102 static Lisp_Object
103 blv_value (struct Lisp_Buffer_Local_Value *blv)
105 return XCDR (blv->valcell);
108 static void
109 set_blv_value (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
111 XSETCDR (blv->valcell, val);
114 static void
115 set_blv_where (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
117 blv->where = val;
120 static void
121 set_blv_defcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
123 blv->defcell = val;
126 static void
127 set_blv_valcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
129 blv->valcell = val;
132 static _Noreturn void
133 wrong_length_argument (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
135 Lisp_Object size1 = make_number (bool_vector_size (a1));
136 Lisp_Object size2 = make_number (bool_vector_size (a2));
137 if (NILP (a3))
138 xsignal2 (Qwrong_length_argument, size1, size2);
139 else
140 xsignal3 (Qwrong_length_argument, size1, size2,
141 make_number (bool_vector_size (a3)));
144 Lisp_Object
145 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
147 /* If VALUE is not even a valid Lisp object, we'd want to abort here
148 where we can get a backtrace showing where it came from. We used
149 to try and do that by checking the tagbits, but nowadays all
150 tagbits are potentially valid. */
151 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
152 * emacs_abort (); */
154 xsignal2 (Qwrong_type_argument, predicate, value);
157 void
158 pure_write_error (Lisp_Object obj)
160 xsignal2 (Qerror, build_string ("Attempt to modify read-only object"), obj);
163 void
164 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
166 xsignal2 (Qargs_out_of_range, a1, a2);
169 void
170 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
172 xsignal3 (Qargs_out_of_range, a1, a2, a3);
176 /* Data type predicates. */
178 DEFUN ("eq", Feq, Seq, 2, 2, 0,
179 doc: /* Return t if the two args are the same Lisp object. */
180 attributes: const)
181 (Lisp_Object obj1, Lisp_Object obj2)
183 if (EQ (obj1, obj2))
184 return Qt;
185 return Qnil;
188 DEFUN ("null", Fnull, Snull, 1, 1, 0,
189 doc: /* Return t if OBJECT is nil, and return nil otherwise. */
190 attributes: const)
191 (Lisp_Object object)
193 if (NILP (object))
194 return Qt;
195 return Qnil;
198 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
199 doc: /* Return a symbol representing the type of OBJECT.
200 The symbol returned names the object's basic type;
201 for example, (type-of 1) returns `integer'. */)
202 (Lisp_Object object)
204 switch (XTYPE (object))
206 case_Lisp_Int:
207 return Qinteger;
209 case Lisp_Symbol:
210 return Qsymbol;
212 case Lisp_String:
213 return Qstring;
215 case Lisp_Cons:
216 return Qcons;
218 case Lisp_Misc:
219 switch (XMISCTYPE (object))
221 case Lisp_Misc_Marker:
222 return Qmarker;
223 case Lisp_Misc_Overlay:
224 return Qoverlay;
225 case Lisp_Misc_Float:
226 return Qfloat;
227 case Lisp_Misc_Finalizer:
228 return Qfinalizer;
230 emacs_abort ();
232 case Lisp_Vectorlike:
233 if (WINDOW_CONFIGURATIONP (object))
234 return Qwindow_configuration;
235 if (PROCESSP (object))
236 return Qprocess;
237 if (WINDOWP (object))
238 return Qwindow;
239 if (SUBRP (object))
240 return Qsubr;
241 if (COMPILEDP (object))
242 return Qcompiled_function;
243 if (BUFFERP (object))
244 return Qbuffer;
245 if (CHAR_TABLE_P (object))
246 return Qchar_table;
247 if (BOOL_VECTOR_P (object))
248 return Qbool_vector;
249 if (FRAMEP (object))
250 return Qframe;
251 if (HASH_TABLE_P (object))
252 return Qhash_table;
253 if (FONT_SPEC_P (object))
254 return Qfont_spec;
255 if (FONT_ENTITY_P (object))
256 return Qfont_entity;
257 if (FONT_OBJECT_P (object))
258 return Qfont_object;
259 return Qvector;
261 case Lisp_Float:
262 return Qfloat;
264 default:
265 emacs_abort ();
269 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
270 doc: /* Return t if OBJECT is a cons cell. */
271 attributes: const)
272 (Lisp_Object object)
274 if (CONSP (object))
275 return Qt;
276 return Qnil;
279 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
280 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */
281 attributes: const)
282 (Lisp_Object object)
284 if (CONSP (object))
285 return Qnil;
286 return Qt;
289 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
290 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
291 Otherwise, return nil. */
292 attributes: const)
293 (Lisp_Object object)
295 if (CONSP (object) || NILP (object))
296 return Qt;
297 return Qnil;
300 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
301 doc: /* Return t if OBJECT is not a list. Lists include nil. */
302 attributes: const)
303 (Lisp_Object object)
305 if (CONSP (object) || NILP (object))
306 return Qnil;
307 return Qt;
310 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
311 doc: /* Return t if OBJECT is a symbol. */
312 attributes: const)
313 (Lisp_Object object)
315 if (SYMBOLP (object))
316 return Qt;
317 return Qnil;
320 /* Define this in C to avoid unnecessarily consing up the symbol
321 name. */
322 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
323 doc: /* Return t if OBJECT is a keyword.
324 This means that it is a symbol with a print name beginning with `:'
325 interned in the initial obarray. */)
326 (Lisp_Object object)
328 if (SYMBOLP (object)
329 && SREF (SYMBOL_NAME (object), 0) == ':'
330 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
331 return Qt;
332 return Qnil;
335 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
336 doc: /* Return t if OBJECT is a vector. */)
337 (Lisp_Object object)
339 if (VECTORP (object))
340 return Qt;
341 return Qnil;
344 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
345 doc: /* Return t if OBJECT is a string. */
346 attributes: const)
347 (Lisp_Object object)
349 if (STRINGP (object))
350 return Qt;
351 return Qnil;
354 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
355 1, 1, 0,
356 doc: /* Return t if OBJECT is a multibyte string.
357 Return nil if OBJECT is either a unibyte string, or not a string. */)
358 (Lisp_Object object)
360 if (STRINGP (object) && STRING_MULTIBYTE (object))
361 return Qt;
362 return Qnil;
365 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
366 doc: /* Return t if OBJECT is a char-table. */)
367 (Lisp_Object object)
369 if (CHAR_TABLE_P (object))
370 return Qt;
371 return Qnil;
374 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
375 Svector_or_char_table_p, 1, 1, 0,
376 doc: /* Return t if OBJECT is a char-table or vector. */)
377 (Lisp_Object object)
379 if (VECTORP (object) || CHAR_TABLE_P (object))
380 return Qt;
381 return Qnil;
384 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
385 doc: /* Return t if OBJECT is a bool-vector. */)
386 (Lisp_Object object)
388 if (BOOL_VECTOR_P (object))
389 return Qt;
390 return Qnil;
393 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
394 doc: /* Return t if OBJECT is an array (string or vector). */)
395 (Lisp_Object object)
397 if (ARRAYP (object))
398 return Qt;
399 return Qnil;
402 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
403 doc: /* Return t if OBJECT is a sequence (list or array). */)
404 (register Lisp_Object object)
406 if (CONSP (object) || NILP (object) || ARRAYP (object))
407 return Qt;
408 return Qnil;
411 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
412 doc: /* Return t if OBJECT is an editor buffer. */)
413 (Lisp_Object object)
415 if (BUFFERP (object))
416 return Qt;
417 return Qnil;
420 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
421 doc: /* Return t if OBJECT is a marker (editor pointer). */)
422 (Lisp_Object object)
424 if (MARKERP (object))
425 return Qt;
426 return Qnil;
429 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
430 doc: /* Return t if OBJECT is a built-in function. */)
431 (Lisp_Object object)
433 if (SUBRP (object))
434 return Qt;
435 return Qnil;
438 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
439 1, 1, 0,
440 doc: /* Return t if OBJECT is a byte-compiled function object. */)
441 (Lisp_Object object)
443 if (COMPILEDP (object))
444 return Qt;
445 return Qnil;
448 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
449 doc: /* Return t if OBJECT is a character or a string. */
450 attributes: const)
451 (register Lisp_Object object)
453 if (CHARACTERP (object) || STRINGP (object))
454 return Qt;
455 return Qnil;
458 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
459 doc: /* Return t if OBJECT is an integer. */
460 attributes: const)
461 (Lisp_Object object)
463 if (INTEGERP (object))
464 return Qt;
465 return Qnil;
468 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
469 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
470 (register Lisp_Object object)
472 if (MARKERP (object) || INTEGERP (object))
473 return Qt;
474 return Qnil;
477 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
478 doc: /* Return t if OBJECT is a nonnegative integer. */
479 attributes: const)
480 (Lisp_Object object)
482 if (NATNUMP (object))
483 return Qt;
484 return Qnil;
487 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
488 doc: /* Return t if OBJECT is a number (floating point or integer). */
489 attributes: const)
490 (Lisp_Object object)
492 if (NUMBERP (object))
493 return Qt;
494 else
495 return Qnil;
498 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
499 Snumber_or_marker_p, 1, 1, 0,
500 doc: /* Return t if OBJECT is a number or a marker. */)
501 (Lisp_Object object)
503 if (NUMBERP (object) || MARKERP (object))
504 return Qt;
505 return Qnil;
508 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
509 doc: /* Return t if OBJECT is a floating point number. */
510 attributes: const)
511 (Lisp_Object object)
513 if (FLOATP (object))
514 return Qt;
515 return Qnil;
519 /* Extract and set components of lists. */
521 DEFUN ("car", Fcar, Scar, 1, 1, 0,
522 doc: /* Return the car of LIST. If arg is nil, return nil.
523 Error if arg is not nil and not a cons cell. See also `car-safe'.
525 See Info node `(elisp)Cons Cells' for a discussion of related basic
526 Lisp concepts such as car, cdr, cons cell and list. */)
527 (register Lisp_Object list)
529 return CAR (list);
532 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
533 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
534 (Lisp_Object object)
536 return CAR_SAFE (object);
539 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
540 doc: /* Return the cdr of LIST. If arg is nil, return nil.
541 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
543 See Info node `(elisp)Cons Cells' for a discussion of related basic
544 Lisp concepts such as cdr, car, cons cell and list. */)
545 (register Lisp_Object list)
547 return CDR (list);
550 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
551 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
552 (Lisp_Object object)
554 return CDR_SAFE (object);
557 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
558 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
559 (register Lisp_Object cell, Lisp_Object newcar)
561 CHECK_CONS (cell);
562 CHECK_IMPURE (cell);
563 XSETCAR (cell, newcar);
564 return newcar;
567 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
568 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
569 (register Lisp_Object cell, Lisp_Object newcdr)
571 CHECK_CONS (cell);
572 CHECK_IMPURE (cell);
573 XSETCDR (cell, newcdr);
574 return newcdr;
577 /* Extract and set components of symbols. */
579 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
580 doc: /* Return t if SYMBOL's value is not void.
581 Note that if `lexical-binding' is in effect, this refers to the
582 global value outside of any lexical scope. */)
583 (register Lisp_Object symbol)
585 Lisp_Object valcontents;
586 struct Lisp_Symbol *sym;
587 CHECK_SYMBOL (symbol);
588 sym = XSYMBOL (symbol);
590 start:
591 switch (sym->redirect)
593 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
594 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
595 case SYMBOL_LOCALIZED:
597 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
598 if (blv->fwd)
599 /* In set_internal, we un-forward vars when their value is
600 set to Qunbound. */
601 return Qt;
602 else
604 swap_in_symval_forwarding (sym, blv);
605 valcontents = blv_value (blv);
607 break;
609 case SYMBOL_FORWARDED:
610 /* In set_internal, we un-forward vars when their value is
611 set to Qunbound. */
612 return Qt;
613 default: emacs_abort ();
616 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
619 /* FIXME: Make it an alias for function-symbol! */
620 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
621 doc: /* Return t if SYMBOL's function definition is not void. */)
622 (register Lisp_Object symbol)
624 CHECK_SYMBOL (symbol);
625 return NILP (XSYMBOL (symbol)->function) ? Qnil : Qt;
628 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
629 doc: /* Make SYMBOL's value be void.
630 Return SYMBOL. */)
631 (register Lisp_Object symbol)
633 CHECK_SYMBOL (symbol);
634 if (SYMBOL_CONSTANT_P (symbol))
635 xsignal1 (Qsetting_constant, symbol);
636 Fset (symbol, Qunbound);
637 return symbol;
640 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
641 doc: /* Make SYMBOL's function definition be nil.
642 Return SYMBOL. */)
643 (register Lisp_Object symbol)
645 CHECK_SYMBOL (symbol);
646 if (NILP (symbol) || EQ (symbol, Qt))
647 xsignal1 (Qsetting_constant, symbol);
648 set_symbol_function (symbol, Qnil);
649 return symbol;
652 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
653 doc: /* Return SYMBOL's function definition, or nil if that is void. */)
654 (register Lisp_Object symbol)
656 CHECK_SYMBOL (symbol);
657 return XSYMBOL (symbol)->function;
660 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
661 doc: /* Return SYMBOL's property list. */)
662 (register Lisp_Object symbol)
664 CHECK_SYMBOL (symbol);
665 return XSYMBOL (symbol)->plist;
668 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
669 doc: /* Return SYMBOL's name, a string. */)
670 (register Lisp_Object symbol)
672 register Lisp_Object name;
674 CHECK_SYMBOL (symbol);
675 name = SYMBOL_NAME (symbol);
676 return name;
679 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
680 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
681 (register Lisp_Object symbol, Lisp_Object definition)
683 register Lisp_Object function;
684 CHECK_SYMBOL (symbol);
686 function = XSYMBOL (symbol)->function;
688 if (!NILP (Vautoload_queue) && !NILP (function))
689 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
691 if (AUTOLOADP (function))
692 Fput (symbol, Qautoload, XCDR (function));
694 /* Convert to eassert or remove after GC bug is found. In the
695 meantime, check unconditionally, at a slight perf hit. */
696 if (! valid_lisp_object_p (definition))
697 emacs_abort ();
699 set_symbol_function (symbol, definition);
701 return definition;
704 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
705 doc: /* Set SYMBOL's function definition to DEFINITION.
706 Associates the function with the current load file, if any.
707 The optional third argument DOCSTRING specifies the documentation string
708 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
709 determined by DEFINITION.
711 Internally, this normally uses `fset', but if SYMBOL has a
712 `defalias-fset-function' property, the associated value is used instead.
714 The return value is undefined. */)
715 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
717 CHECK_SYMBOL (symbol);
718 if (!NILP (Vpurify_flag)
719 /* If `definition' is a keymap, immutable (and copying) is wrong. */
720 && !KEYMAPP (definition))
721 definition = Fpurecopy (definition);
724 bool autoload = AUTOLOADP (definition);
725 if (NILP (Vpurify_flag) || !autoload)
726 { /* Only add autoload entries after dumping, because the ones before are
727 not useful and else we get loads of them from the loaddefs.el. */
729 if (AUTOLOADP (XSYMBOL (symbol)->function))
730 /* Remember that the function was already an autoload. */
731 LOADHIST_ATTACH (Fcons (Qt, symbol));
732 LOADHIST_ATTACH (Fcons (autoload ? Qautoload : Qdefun, symbol));
736 { /* Handle automatic advice activation. */
737 Lisp_Object hook = Fget (symbol, Qdefalias_fset_function);
738 if (!NILP (hook))
739 call2 (hook, symbol, definition);
740 else
741 Ffset (symbol, definition);
744 if (!NILP (docstring))
745 Fput (symbol, Qfunction_documentation, docstring);
746 /* We used to return `definition', but now that `defun' and `defmacro' expand
747 to a call to `defalias', we return `symbol' for backward compatibility
748 (bug#11686). */
749 return symbol;
752 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
753 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
754 (register Lisp_Object symbol, Lisp_Object newplist)
756 CHECK_SYMBOL (symbol);
757 set_symbol_plist (symbol, newplist);
758 return newplist;
761 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
762 doc: /* Return minimum and maximum number of args allowed for SUBR.
763 SUBR must be a built-in function.
764 The returned value is a pair (MIN . MAX). MIN is the minimum number
765 of args. MAX is the maximum number or the symbol `many', for a
766 function with `&rest' args, or `unevalled' for a special form. */)
767 (Lisp_Object subr)
769 short minargs, maxargs;
770 CHECK_SUBR (subr);
771 minargs = XSUBR (subr)->min_args;
772 maxargs = XSUBR (subr)->max_args;
773 return Fcons (make_number (minargs),
774 maxargs == MANY ? Qmany
775 : maxargs == UNEVALLED ? Qunevalled
776 : make_number (maxargs));
779 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
780 doc: /* Return name of subroutine SUBR.
781 SUBR must be a built-in function. */)
782 (Lisp_Object subr)
784 const char *name;
785 CHECK_SUBR (subr);
786 name = XSUBR (subr)->symbol_name;
787 return build_string (name);
790 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
791 doc: /* Return the interactive form of CMD or nil if none.
792 If CMD is not a command, the return value is nil.
793 Value, if non-nil, is a list \(interactive SPEC). */)
794 (Lisp_Object cmd)
796 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
798 if (NILP (fun))
799 return Qnil;
801 /* Use an `interactive-form' property if present, analogous to the
802 function-documentation property. */
803 fun = cmd;
804 while (SYMBOLP (fun))
806 Lisp_Object tmp = Fget (fun, Qinteractive_form);
807 if (!NILP (tmp))
808 return tmp;
809 else
810 fun = Fsymbol_function (fun);
813 if (SUBRP (fun))
815 const char *spec = XSUBR (fun)->intspec;
816 if (spec)
817 return list2 (Qinteractive,
818 (*spec != '(') ? build_string (spec) :
819 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
821 else if (COMPILEDP (fun))
823 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
824 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
826 else if (AUTOLOADP (fun))
827 return Finteractive_form (Fautoload_do_load (fun, cmd, Qnil));
828 else if (CONSP (fun))
830 Lisp_Object funcar = XCAR (fun);
831 if (EQ (funcar, Qclosure))
832 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
833 else if (EQ (funcar, Qlambda))
834 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
836 return Qnil;
840 /***********************************************************************
841 Getting and Setting Values of Symbols
842 ***********************************************************************/
844 /* Return the symbol holding SYMBOL's value. Signal
845 `cyclic-variable-indirection' if SYMBOL's chain of variable
846 indirections contains a loop. */
848 struct Lisp_Symbol *
849 indirect_variable (struct Lisp_Symbol *symbol)
851 struct Lisp_Symbol *tortoise, *hare;
853 hare = tortoise = symbol;
855 while (hare->redirect == SYMBOL_VARALIAS)
857 hare = SYMBOL_ALIAS (hare);
858 if (hare->redirect != SYMBOL_VARALIAS)
859 break;
861 hare = SYMBOL_ALIAS (hare);
862 tortoise = SYMBOL_ALIAS (tortoise);
864 if (hare == tortoise)
866 Lisp_Object tem;
867 XSETSYMBOL (tem, symbol);
868 xsignal1 (Qcyclic_variable_indirection, tem);
872 return hare;
876 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
877 doc: /* Return the variable at the end of OBJECT's variable chain.
878 If OBJECT is a symbol, follow its variable indirections (if any), and
879 return the variable at the end of the chain of aliases. See Info node
880 `(elisp)Variable Aliases'.
882 If OBJECT is not a symbol, just return it. If there is a loop in the
883 chain of aliases, signal a `cyclic-variable-indirection' error. */)
884 (Lisp_Object object)
886 if (SYMBOLP (object))
888 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
889 XSETSYMBOL (object, sym);
891 return object;
895 /* Given the raw contents of a symbol value cell,
896 return the Lisp value of the symbol.
897 This does not handle buffer-local variables; use
898 swap_in_symval_forwarding for that. */
900 Lisp_Object
901 do_symval_forwarding (register union Lisp_Fwd *valcontents)
903 register Lisp_Object val;
904 switch (XFWDTYPE (valcontents))
906 case Lisp_Fwd_Int:
907 XSETINT (val, *XINTFWD (valcontents)->intvar);
908 return val;
910 case Lisp_Fwd_Bool:
911 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
913 case Lisp_Fwd_Obj:
914 return *XOBJFWD (valcontents)->objvar;
916 case Lisp_Fwd_Buffer_Obj:
917 return per_buffer_value (current_buffer,
918 XBUFFER_OBJFWD (valcontents)->offset);
920 case Lisp_Fwd_Kboard_Obj:
921 /* We used to simply use current_kboard here, but from Lisp
922 code, its value is often unexpected. It seems nicer to
923 allow constructions like this to work as intuitively expected:
925 (with-selected-frame frame
926 (define-key local-function-map "\eOP" [f1]))
928 On the other hand, this affects the semantics of
929 last-command and real-last-command, and people may rely on
930 that. I took a quick look at the Lisp codebase, and I
931 don't think anything will break. --lorentey */
932 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
933 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
934 default: emacs_abort ();
938 /* Used to signal a user-friendly error when symbol WRONG is
939 not a member of CHOICE, which should be a list of symbols. */
941 void
942 wrong_choice (Lisp_Object choice, Lisp_Object wrong)
944 ptrdiff_t i = 0, len = XINT (Flength (choice));
945 Lisp_Object obj, *args;
946 AUTO_STRING (one_of, "One of ");
947 AUTO_STRING (comma, ", ");
948 AUTO_STRING (or, " or ");
949 AUTO_STRING (should_be_specified, " should be specified");
951 USE_SAFE_ALLOCA;
952 SAFE_ALLOCA_LISP (args, len * 2 + 1);
954 args[i++] = one_of;
956 for (obj = choice; !NILP (obj); obj = XCDR (obj))
958 args[i++] = SYMBOL_NAME (XCAR (obj));
959 args[i++] = (NILP (XCDR (obj)) ? should_be_specified
960 : NILP (XCDR (XCDR (obj))) ? or : comma);
963 obj = Fconcat (i, args);
964 SAFE_FREE ();
965 xsignal2 (Qerror, obj, wrong);
968 /* Used to signal a user-friendly error if WRONG is not a number or
969 integer/floating-point number outsize of inclusive MIN..MAX range. */
971 static void
972 wrong_range (Lisp_Object min, Lisp_Object max, Lisp_Object wrong)
974 AUTO_STRING (value_should_be_from, "Value should be from ");
975 AUTO_STRING (to, " to ");
976 xsignal2 (Qerror,
977 CALLN (Fconcat, value_should_be_from, Fnumber_to_string (min),
978 to, Fnumber_to_string (max)),
979 wrong);
982 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
983 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
984 buffer-independent contents of the value cell: forwarded just one
985 step past the buffer-localness.
987 BUF non-zero means set the value in buffer BUF instead of the
988 current buffer. This only plays a role for per-buffer variables. */
990 static void
991 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
993 switch (XFWDTYPE (valcontents))
995 case Lisp_Fwd_Int:
996 CHECK_NUMBER (newval);
997 *XINTFWD (valcontents)->intvar = XINT (newval);
998 break;
1000 case Lisp_Fwd_Bool:
1001 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
1002 break;
1004 case Lisp_Fwd_Obj:
1005 *XOBJFWD (valcontents)->objvar = newval;
1007 /* If this variable is a default for something stored
1008 in the buffer itself, such as default-fill-column,
1009 find the buffers that don't have local values for it
1010 and update them. */
1011 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
1012 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
1014 int offset = ((char *) XOBJFWD (valcontents)->objvar
1015 - (char *) &buffer_defaults);
1016 int idx = PER_BUFFER_IDX (offset);
1018 Lisp_Object tail, buf;
1020 if (idx <= 0)
1021 break;
1023 FOR_EACH_LIVE_BUFFER (tail, buf)
1025 struct buffer *b = XBUFFER (buf);
1027 if (! PER_BUFFER_VALUE_P (b, idx))
1028 set_per_buffer_value (b, offset, newval);
1031 break;
1033 case Lisp_Fwd_Buffer_Obj:
1035 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1036 Lisp_Object predicate = XBUFFER_OBJFWD (valcontents)->predicate;
1038 if (!NILP (newval))
1040 if (SYMBOLP (predicate))
1042 Lisp_Object prop;
1044 if ((prop = Fget (predicate, Qchoice), !NILP (prop)))
1046 if (NILP (Fmemq (newval, prop)))
1047 wrong_choice (prop, newval);
1049 else if ((prop = Fget (predicate, Qrange), !NILP (prop)))
1051 Lisp_Object min = XCAR (prop), max = XCDR (prop);
1053 if (!NUMBERP (newval)
1054 || !NILP (arithcompare (newval, min, ARITH_LESS))
1055 || !NILP (arithcompare (newval, max, ARITH_GRTR)))
1056 wrong_range (min, max, newval);
1058 else if (FUNCTIONP (predicate))
1060 if (NILP (call1 (predicate, newval)))
1061 wrong_type_argument (predicate, newval);
1065 if (buf == NULL)
1066 buf = current_buffer;
1067 set_per_buffer_value (buf, offset, newval);
1069 break;
1071 case Lisp_Fwd_Kboard_Obj:
1073 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
1074 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
1075 *(Lisp_Object *) p = newval;
1077 break;
1079 default:
1080 emacs_abort (); /* goto def; */
1084 /* Set up SYMBOL to refer to its global binding. This makes it safe
1085 to alter the status of other bindings. BEWARE: this may be called
1086 during the mark phase of GC, where we assume that Lisp_Object slots
1087 of BLV are marked after this function has changed them. */
1089 void
1090 swap_in_global_binding (struct Lisp_Symbol *symbol)
1092 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
1094 /* Unload the previously loaded binding. */
1095 if (blv->fwd)
1096 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1098 /* Select the global binding in the symbol. */
1099 set_blv_valcell (blv, blv->defcell);
1100 if (blv->fwd)
1101 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
1103 /* Indicate that the global binding is set up now. */
1104 set_blv_where (blv, Qnil);
1105 set_blv_found (blv, 0);
1108 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
1109 VALCONTENTS is the contents of its value cell,
1110 which points to a struct Lisp_Buffer_Local_Value.
1112 Return the value forwarded one step past the buffer-local stage.
1113 This could be another forwarding pointer. */
1115 static void
1116 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1118 register Lisp_Object tem1;
1120 eassert (blv == SYMBOL_BLV (symbol));
1122 tem1 = blv->where;
1124 if (NILP (tem1)
1125 || (blv->frame_local
1126 ? !EQ (selected_frame, tem1)
1127 : current_buffer != XBUFFER (tem1)))
1130 /* Unload the previously loaded binding. */
1131 tem1 = blv->valcell;
1132 if (blv->fwd)
1133 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1134 /* Choose the new binding. */
1136 Lisp_Object var;
1137 XSETSYMBOL (var, symbol);
1138 if (blv->frame_local)
1140 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1141 set_blv_where (blv, selected_frame);
1143 else
1145 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1146 set_blv_where (blv, Fcurrent_buffer ());
1149 if (!(blv->found = !NILP (tem1)))
1150 tem1 = blv->defcell;
1152 /* Load the new binding. */
1153 set_blv_valcell (blv, tem1);
1154 if (blv->fwd)
1155 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1159 /* Find the value of a symbol, returning Qunbound if it's not bound.
1160 This is helpful for code which just wants to get a variable's value
1161 if it has one, without signaling an error.
1162 Note that it must not be possible to quit
1163 within this function. Great care is required for this. */
1165 Lisp_Object
1166 find_symbol_value (Lisp_Object symbol)
1168 struct Lisp_Symbol *sym;
1170 CHECK_SYMBOL (symbol);
1171 sym = XSYMBOL (symbol);
1173 start:
1174 switch (sym->redirect)
1176 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1177 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1178 case SYMBOL_LOCALIZED:
1180 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1181 swap_in_symval_forwarding (sym, blv);
1182 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1184 /* FALLTHROUGH */
1185 case SYMBOL_FORWARDED:
1186 return do_symval_forwarding (SYMBOL_FWD (sym));
1187 default: emacs_abort ();
1191 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1192 doc: /* Return SYMBOL's value. Error if that is void.
1193 Note that if `lexical-binding' is in effect, this returns the
1194 global value outside of any lexical scope. */)
1195 (Lisp_Object symbol)
1197 Lisp_Object val;
1199 val = find_symbol_value (symbol);
1200 if (!EQ (val, Qunbound))
1201 return val;
1203 xsignal1 (Qvoid_variable, symbol);
1206 DEFUN ("set", Fset, Sset, 2, 2, 0,
1207 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1208 (register Lisp_Object symbol, Lisp_Object newval)
1210 set_internal (symbol, newval, Qnil, 0);
1211 return newval;
1214 /* Store the value NEWVAL into SYMBOL.
1215 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1216 (nil stands for the current buffer/frame).
1218 If BINDFLAG is false, then if this symbol is supposed to become
1219 local in every buffer where it is set, then we make it local.
1220 If BINDFLAG is true, we don't do that. */
1222 void
1223 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1224 bool bindflag)
1226 bool voide = EQ (newval, Qunbound);
1227 struct Lisp_Symbol *sym;
1228 Lisp_Object tem1;
1230 /* If restoring in a dead buffer, do nothing. */
1231 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1232 return; */
1234 CHECK_SYMBOL (symbol);
1235 if (SYMBOL_CONSTANT_P (symbol))
1237 if (NILP (Fkeywordp (symbol))
1238 || !EQ (newval, Fsymbol_value (symbol)))
1239 xsignal1 (Qsetting_constant, symbol);
1240 else
1241 /* Allow setting keywords to their own value. */
1242 return;
1245 sym = XSYMBOL (symbol);
1247 start:
1248 switch (sym->redirect)
1250 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1251 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1252 case SYMBOL_LOCALIZED:
1254 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1255 if (NILP (where))
1257 if (blv->frame_local)
1258 where = selected_frame;
1259 else
1260 XSETBUFFER (where, current_buffer);
1262 /* If the current buffer is not the buffer whose binding is
1263 loaded, or if there may be frame-local bindings and the frame
1264 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1265 the default binding is loaded, the loaded binding may be the
1266 wrong one. */
1267 if (!EQ (blv->where, where)
1268 /* Also unload a global binding (if the var is local_if_set). */
1269 || (EQ (blv->valcell, blv->defcell)))
1271 /* The currently loaded binding is not necessarily valid.
1272 We need to unload it, and choose a new binding. */
1274 /* Write out `realvalue' to the old loaded binding. */
1275 if (blv->fwd)
1276 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1278 /* Find the new binding. */
1279 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1280 tem1 = assq_no_quit (symbol,
1281 (blv->frame_local
1282 ? XFRAME (where)->param_alist
1283 : BVAR (XBUFFER (where), local_var_alist)));
1284 set_blv_where (blv, where);
1285 blv->found = 1;
1287 if (NILP (tem1))
1289 /* This buffer still sees the default value. */
1291 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1292 or if this is `let' rather than `set',
1293 make CURRENT-ALIST-ELEMENT point to itself,
1294 indicating that we're seeing the default value.
1295 Likewise if the variable has been let-bound
1296 in the current buffer. */
1297 if (bindflag || !blv->local_if_set
1298 || let_shadows_buffer_binding_p (sym))
1300 blv->found = 0;
1301 tem1 = blv->defcell;
1303 /* If it's a local_if_set, being set not bound,
1304 and we're not within a let that was made for this buffer,
1305 create a new buffer-local binding for the variable.
1306 That means, give this buffer a new assoc for a local value
1307 and load that binding. */
1308 else
1310 /* local_if_set is only supported for buffer-local
1311 bindings, not for frame-local bindings. */
1312 eassert (!blv->frame_local);
1313 tem1 = Fcons (symbol, XCDR (blv->defcell));
1314 bset_local_var_alist
1315 (XBUFFER (where),
1316 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1320 /* Record which binding is now loaded. */
1321 set_blv_valcell (blv, tem1);
1324 /* Store the new value in the cons cell. */
1325 set_blv_value (blv, newval);
1327 if (blv->fwd)
1329 if (voide)
1330 /* If storing void (making the symbol void), forward only through
1331 buffer-local indicator, not through Lisp_Objfwd, etc. */
1332 blv->fwd = NULL;
1333 else
1334 store_symval_forwarding (blv->fwd, newval,
1335 BUFFERP (where)
1336 ? XBUFFER (where) : current_buffer);
1338 break;
1340 case SYMBOL_FORWARDED:
1342 struct buffer *buf
1343 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1344 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1345 if (BUFFER_OBJFWDP (innercontents))
1347 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1348 int idx = PER_BUFFER_IDX (offset);
1349 if (idx > 0
1350 && !bindflag
1351 && !let_shadows_buffer_binding_p (sym))
1352 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1355 if (voide)
1356 { /* If storing void (making the symbol void), forward only through
1357 buffer-local indicator, not through Lisp_Objfwd, etc. */
1358 sym->redirect = SYMBOL_PLAINVAL;
1359 SET_SYMBOL_VAL (sym, newval);
1361 else
1362 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1363 break;
1365 default: emacs_abort ();
1367 return;
1370 /* Access or set a buffer-local symbol's default value. */
1372 /* Return the default value of SYMBOL, but don't check for voidness.
1373 Return Qunbound if it is void. */
1375 static Lisp_Object
1376 default_value (Lisp_Object symbol)
1378 struct Lisp_Symbol *sym;
1380 CHECK_SYMBOL (symbol);
1381 sym = XSYMBOL (symbol);
1383 start:
1384 switch (sym->redirect)
1386 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1387 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1388 case SYMBOL_LOCALIZED:
1390 /* If var is set up for a buffer that lacks a local value for it,
1391 the current value is nominally the default value.
1392 But the `realvalue' slot may be more up to date, since
1393 ordinary setq stores just that slot. So use that. */
1394 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1395 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1396 return do_symval_forwarding (blv->fwd);
1397 else
1398 return XCDR (blv->defcell);
1400 case SYMBOL_FORWARDED:
1402 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1404 /* For a built-in buffer-local variable, get the default value
1405 rather than letting do_symval_forwarding get the current value. */
1406 if (BUFFER_OBJFWDP (valcontents))
1408 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1409 if (PER_BUFFER_IDX (offset) != 0)
1410 return per_buffer_default (offset);
1413 /* For other variables, get the current value. */
1414 return do_symval_forwarding (valcontents);
1416 default: emacs_abort ();
1420 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1421 doc: /* Return t if SYMBOL has a non-void default value.
1422 This is the value that is seen in buffers that do not have their own values
1423 for this variable. */)
1424 (Lisp_Object symbol)
1426 register Lisp_Object value;
1428 value = default_value (symbol);
1429 return (EQ (value, Qunbound) ? Qnil : Qt);
1432 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1433 doc: /* Return SYMBOL's default value.
1434 This is the value that is seen in buffers that do not have their own values
1435 for this variable. The default value is meaningful for variables with
1436 local bindings in certain buffers. */)
1437 (Lisp_Object symbol)
1439 Lisp_Object value = default_value (symbol);
1440 if (!EQ (value, Qunbound))
1441 return value;
1443 xsignal1 (Qvoid_variable, symbol);
1446 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1447 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1448 The default value is seen in buffers that do not have their own values
1449 for this variable. */)
1450 (Lisp_Object symbol, Lisp_Object value)
1452 struct Lisp_Symbol *sym;
1454 CHECK_SYMBOL (symbol);
1455 if (SYMBOL_CONSTANT_P (symbol))
1457 if (NILP (Fkeywordp (symbol))
1458 || !EQ (value, Fdefault_value (symbol)))
1459 xsignal1 (Qsetting_constant, symbol);
1460 else
1461 /* Allow setting keywords to their own value. */
1462 return value;
1464 sym = XSYMBOL (symbol);
1466 start:
1467 switch (sym->redirect)
1469 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1470 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1471 case SYMBOL_LOCALIZED:
1473 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1475 /* Store new value into the DEFAULT-VALUE slot. */
1476 XSETCDR (blv->defcell, value);
1478 /* If the default binding is now loaded, set the REALVALUE slot too. */
1479 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1480 store_symval_forwarding (blv->fwd, value, NULL);
1481 return value;
1483 case SYMBOL_FORWARDED:
1485 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1487 /* Handle variables like case-fold-search that have special slots
1488 in the buffer.
1489 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1490 if (BUFFER_OBJFWDP (valcontents))
1492 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1493 int idx = PER_BUFFER_IDX (offset);
1495 set_per_buffer_default (offset, value);
1497 /* If this variable is not always local in all buffers,
1498 set it in the buffers that don't nominally have a local value. */
1499 if (idx > 0)
1501 struct buffer *b;
1503 FOR_EACH_BUFFER (b)
1504 if (!PER_BUFFER_VALUE_P (b, idx))
1505 set_per_buffer_value (b, offset, value);
1507 return value;
1509 else
1510 return Fset (symbol, value);
1512 default: emacs_abort ();
1516 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1517 doc: /* Set the default value of variable VAR to VALUE.
1518 VAR, the variable name, is literal (not evaluated);
1519 VALUE is an expression: it is evaluated and its value returned.
1520 The default value of a variable is seen in buffers
1521 that do not have their own values for the variable.
1523 More generally, you can use multiple variables and values, as in
1524 (setq-default VAR VALUE VAR VALUE...)
1525 This sets each VAR's default value to the corresponding VALUE.
1526 The VALUE for the Nth VAR can refer to the new default values
1527 of previous VARs.
1528 usage: (setq-default [VAR VALUE]...) */)
1529 (Lisp_Object args)
1531 Lisp_Object args_left, symbol, val;
1532 struct gcpro gcpro1;
1534 args_left = val = args;
1535 GCPRO1 (args);
1537 while (CONSP (args_left))
1539 val = eval_sub (Fcar (XCDR (args_left)));
1540 symbol = XCAR (args_left);
1541 Fset_default (symbol, val);
1542 args_left = Fcdr (XCDR (args_left));
1545 UNGCPRO;
1546 return val;
1549 /* Lisp functions for creating and removing buffer-local variables. */
1551 union Lisp_Val_Fwd
1553 Lisp_Object value;
1554 union Lisp_Fwd *fwd;
1557 static struct Lisp_Buffer_Local_Value *
1558 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1559 union Lisp_Val_Fwd valcontents)
1561 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1562 Lisp_Object symbol;
1563 Lisp_Object tem;
1565 XSETSYMBOL (symbol, sym);
1566 tem = Fcons (symbol, (forwarded
1567 ? do_symval_forwarding (valcontents.fwd)
1568 : valcontents.value));
1570 /* Buffer_Local_Values cannot have as realval a buffer-local
1571 or keyboard-local forwarding. */
1572 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1573 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1574 blv->fwd = forwarded ? valcontents.fwd : NULL;
1575 set_blv_where (blv, Qnil);
1576 blv->frame_local = 0;
1577 blv->local_if_set = 0;
1578 set_blv_defcell (blv, tem);
1579 set_blv_valcell (blv, tem);
1580 set_blv_found (blv, 0);
1581 return blv;
1584 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1585 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1586 doc: /* Make VARIABLE become buffer-local whenever it is set.
1587 At any time, the value for the current buffer is in effect,
1588 unless the variable has never been set in this buffer,
1589 in which case the default value is in effect.
1590 Note that binding the variable with `let', or setting it while
1591 a `let'-style binding made in this buffer is in effect,
1592 does not make the variable buffer-local. Return VARIABLE.
1594 This globally affects all uses of this variable, so it belongs together with
1595 the variable declaration, rather than with its uses (if you just want to make
1596 a variable local to the current buffer for one particular use, use
1597 `make-local-variable'). Buffer-local bindings are normally cleared
1598 while setting up a new major mode, unless they have a `permanent-local'
1599 property.
1601 The function `default-value' gets the default value and `set-default' sets it. */)
1602 (register Lisp_Object variable)
1604 struct Lisp_Symbol *sym;
1605 struct Lisp_Buffer_Local_Value *blv = NULL;
1606 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1607 bool forwarded IF_LINT (= 0);
1609 CHECK_SYMBOL (variable);
1610 sym = XSYMBOL (variable);
1612 start:
1613 switch (sym->redirect)
1615 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1616 case SYMBOL_PLAINVAL:
1617 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1618 if (EQ (valcontents.value, Qunbound))
1619 valcontents.value = Qnil;
1620 break;
1621 case SYMBOL_LOCALIZED:
1622 blv = SYMBOL_BLV (sym);
1623 if (blv->frame_local)
1624 error ("Symbol %s may not be buffer-local",
1625 SDATA (SYMBOL_NAME (variable)));
1626 break;
1627 case SYMBOL_FORWARDED:
1628 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1629 if (KBOARD_OBJFWDP (valcontents.fwd))
1630 error ("Symbol %s may not be buffer-local",
1631 SDATA (SYMBOL_NAME (variable)));
1632 else if (BUFFER_OBJFWDP (valcontents.fwd))
1633 return variable;
1634 break;
1635 default: emacs_abort ();
1638 if (sym->constant)
1639 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1641 if (!blv)
1643 blv = make_blv (sym, forwarded, valcontents);
1644 sym->redirect = SYMBOL_LOCALIZED;
1645 SET_SYMBOL_BLV (sym, blv);
1647 Lisp_Object symbol;
1648 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1649 if (let_shadows_global_binding_p (symbol))
1651 AUTO_STRING (format, "Making %s buffer-local while let-bound!");
1652 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1657 blv->local_if_set = 1;
1658 return variable;
1661 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1662 1, 1, "vMake Local Variable: ",
1663 doc: /* Make VARIABLE have a separate value in the current buffer.
1664 Other buffers will continue to share a common default value.
1665 \(The buffer-local value of VARIABLE starts out as the same value
1666 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1667 Return VARIABLE.
1669 If the variable is already arranged to become local when set,
1670 this function causes a local value to exist for this buffer,
1671 just as setting the variable would do.
1673 This function returns VARIABLE, and therefore
1674 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1675 works.
1677 See also `make-variable-buffer-local'.
1679 Do not use `make-local-variable' to make a hook variable buffer-local.
1680 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1681 (Lisp_Object variable)
1683 Lisp_Object tem;
1684 bool forwarded IF_LINT (= 0);
1685 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1686 struct Lisp_Symbol *sym;
1687 struct Lisp_Buffer_Local_Value *blv = NULL;
1689 CHECK_SYMBOL (variable);
1690 sym = XSYMBOL (variable);
1692 start:
1693 switch (sym->redirect)
1695 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1696 case SYMBOL_PLAINVAL:
1697 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1698 case SYMBOL_LOCALIZED:
1699 blv = SYMBOL_BLV (sym);
1700 if (blv->frame_local)
1701 error ("Symbol %s may not be buffer-local",
1702 SDATA (SYMBOL_NAME (variable)));
1703 break;
1704 case SYMBOL_FORWARDED:
1705 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1706 if (KBOARD_OBJFWDP (valcontents.fwd))
1707 error ("Symbol %s may not be buffer-local",
1708 SDATA (SYMBOL_NAME (variable)));
1709 break;
1710 default: emacs_abort ();
1713 if (sym->constant)
1714 error ("Symbol %s may not be buffer-local",
1715 SDATA (SYMBOL_NAME (variable)));
1717 if (blv ? blv->local_if_set
1718 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1720 tem = Fboundp (variable);
1721 /* Make sure the symbol has a local value in this particular buffer,
1722 by setting it to the same value it already has. */
1723 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1724 return variable;
1726 if (!blv)
1728 blv = make_blv (sym, forwarded, valcontents);
1729 sym->redirect = SYMBOL_LOCALIZED;
1730 SET_SYMBOL_BLV (sym, blv);
1732 Lisp_Object symbol;
1733 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1734 if (let_shadows_global_binding_p (symbol))
1736 AUTO_STRING (format, "Making %s local to %s while let-bound!");
1737 CALLN (Fmessage, format, SYMBOL_NAME (variable),
1738 BVAR (current_buffer, name));
1743 /* Make sure this buffer has its own value of symbol. */
1744 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1745 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1746 if (NILP (tem))
1748 if (let_shadows_buffer_binding_p (sym))
1750 AUTO_STRING (format,
1751 "Making %s buffer-local while locally let-bound!");
1752 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1755 /* Swap out any local binding for some other buffer, and make
1756 sure the current value is permanently recorded, if it's the
1757 default value. */
1758 find_symbol_value (variable);
1760 bset_local_var_alist
1761 (current_buffer,
1762 Fcons (Fcons (variable, XCDR (blv->defcell)),
1763 BVAR (current_buffer, local_var_alist)));
1765 /* Make sure symbol does not think it is set up for this buffer;
1766 force it to look once again for this buffer's value. */
1767 if (current_buffer == XBUFFER (blv->where))
1768 set_blv_where (blv, Qnil);
1769 set_blv_found (blv, 0);
1772 /* If the symbol forwards into a C variable, then load the binding
1773 for this buffer now. If C code modifies the variable before we
1774 load the binding in, then that new value will clobber the default
1775 binding the next time we unload it. */
1776 if (blv->fwd)
1777 swap_in_symval_forwarding (sym, blv);
1779 return variable;
1782 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1783 1, 1, "vKill Local Variable: ",
1784 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1785 From now on the default value will apply in this buffer. Return VARIABLE. */)
1786 (register Lisp_Object variable)
1788 register Lisp_Object tem;
1789 struct Lisp_Buffer_Local_Value *blv;
1790 struct Lisp_Symbol *sym;
1792 CHECK_SYMBOL (variable);
1793 sym = XSYMBOL (variable);
1795 start:
1796 switch (sym->redirect)
1798 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1799 case SYMBOL_PLAINVAL: return variable;
1800 case SYMBOL_FORWARDED:
1802 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1803 if (BUFFER_OBJFWDP (valcontents))
1805 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1806 int idx = PER_BUFFER_IDX (offset);
1808 if (idx > 0)
1810 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1811 set_per_buffer_value (current_buffer, offset,
1812 per_buffer_default (offset));
1815 return variable;
1817 case SYMBOL_LOCALIZED:
1818 blv = SYMBOL_BLV (sym);
1819 if (blv->frame_local)
1820 return variable;
1821 break;
1822 default: emacs_abort ();
1825 /* Get rid of this buffer's alist element, if any. */
1826 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1827 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1828 if (!NILP (tem))
1829 bset_local_var_alist
1830 (current_buffer,
1831 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1833 /* If the symbol is set up with the current buffer's binding
1834 loaded, recompute its value. We have to do it now, or else
1835 forwarded objects won't work right. */
1837 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1838 if (EQ (buf, blv->where))
1840 set_blv_where (blv, Qnil);
1841 blv->found = 0;
1842 find_symbol_value (variable);
1846 return variable;
1849 /* Lisp functions for creating and removing buffer-local variables. */
1851 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1852 when/if this is removed. */
1854 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1855 1, 1, "vMake Variable Frame Local: ",
1856 doc: /* Enable VARIABLE to have frame-local bindings.
1857 This does not create any frame-local bindings for VARIABLE,
1858 it just makes them possible.
1860 A frame-local binding is actually a frame parameter value.
1861 If a frame F has a value for the frame parameter named VARIABLE,
1862 that also acts as a frame-local binding for VARIABLE in F--
1863 provided this function has been called to enable VARIABLE
1864 to have frame-local bindings at all.
1866 The only way to create a frame-local binding for VARIABLE in a frame
1867 is to set the VARIABLE frame parameter of that frame. See
1868 `modify-frame-parameters' for how to set frame parameters.
1870 Note that since Emacs 23.1, variables cannot be both buffer-local and
1871 frame-local any more (buffer-local bindings used to take precedence over
1872 frame-local bindings). */)
1873 (Lisp_Object variable)
1875 bool forwarded;
1876 union Lisp_Val_Fwd valcontents;
1877 struct Lisp_Symbol *sym;
1878 struct Lisp_Buffer_Local_Value *blv = NULL;
1880 CHECK_SYMBOL (variable);
1881 sym = XSYMBOL (variable);
1883 start:
1884 switch (sym->redirect)
1886 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1887 case SYMBOL_PLAINVAL:
1888 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1889 if (EQ (valcontents.value, Qunbound))
1890 valcontents.value = Qnil;
1891 break;
1892 case SYMBOL_LOCALIZED:
1893 if (SYMBOL_BLV (sym)->frame_local)
1894 return variable;
1895 else
1896 error ("Symbol %s may not be frame-local",
1897 SDATA (SYMBOL_NAME (variable)));
1898 case SYMBOL_FORWARDED:
1899 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1900 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1901 error ("Symbol %s may not be frame-local",
1902 SDATA (SYMBOL_NAME (variable)));
1903 break;
1904 default: emacs_abort ();
1907 if (sym->constant)
1908 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1910 blv = make_blv (sym, forwarded, valcontents);
1911 blv->frame_local = 1;
1912 sym->redirect = SYMBOL_LOCALIZED;
1913 SET_SYMBOL_BLV (sym, blv);
1915 Lisp_Object symbol;
1916 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1917 if (let_shadows_global_binding_p (symbol))
1919 AUTO_STRING (format, "Making %s frame-local while let-bound!");
1920 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1923 return variable;
1926 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1927 1, 2, 0,
1928 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1929 BUFFER defaults to the current buffer. */)
1930 (Lisp_Object variable, Lisp_Object buffer)
1932 struct buffer *buf = decode_buffer (buffer);
1933 struct Lisp_Symbol *sym;
1935 CHECK_SYMBOL (variable);
1936 sym = XSYMBOL (variable);
1938 start:
1939 switch (sym->redirect)
1941 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1942 case SYMBOL_PLAINVAL: return Qnil;
1943 case SYMBOL_LOCALIZED:
1945 Lisp_Object tail, elt, tmp;
1946 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1947 XSETBUFFER (tmp, buf);
1948 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1950 if (EQ (blv->where, tmp)) /* The binding is already loaded. */
1951 return blv_found (blv) ? Qt : Qnil;
1952 else
1953 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1955 elt = XCAR (tail);
1956 if (EQ (variable, XCAR (elt)))
1958 eassert (!blv->frame_local);
1959 return Qt;
1962 return Qnil;
1964 case SYMBOL_FORWARDED:
1966 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1967 if (BUFFER_OBJFWDP (valcontents))
1969 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1970 int idx = PER_BUFFER_IDX (offset);
1971 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1972 return Qt;
1974 return Qnil;
1976 default: emacs_abort ();
1980 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1981 1, 2, 0,
1982 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1983 BUFFER defaults to the current buffer.
1985 More precisely, return non-nil if either VARIABLE already has a local
1986 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1987 `make-variable-buffer-local'). */)
1988 (register Lisp_Object variable, Lisp_Object buffer)
1990 struct Lisp_Symbol *sym;
1992 CHECK_SYMBOL (variable);
1993 sym = XSYMBOL (variable);
1995 start:
1996 switch (sym->redirect)
1998 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1999 case SYMBOL_PLAINVAL: return Qnil;
2000 case SYMBOL_LOCALIZED:
2002 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
2003 if (blv->local_if_set)
2004 return Qt;
2005 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
2006 return Flocal_variable_p (variable, buffer);
2008 case SYMBOL_FORWARDED:
2009 /* All BUFFER_OBJFWD slots become local if they are set. */
2010 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
2011 default: emacs_abort ();
2015 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
2016 1, 1, 0,
2017 doc: /* Return a value indicating where VARIABLE's current binding comes from.
2018 If the current binding is buffer-local, the value is the current buffer.
2019 If the current binding is frame-local, the value is the selected frame.
2020 If the current binding is global (the default), the value is nil. */)
2021 (register Lisp_Object variable)
2023 struct Lisp_Symbol *sym;
2025 CHECK_SYMBOL (variable);
2026 sym = XSYMBOL (variable);
2028 /* Make sure the current binding is actually swapped in. */
2029 find_symbol_value (variable);
2031 start:
2032 switch (sym->redirect)
2034 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
2035 case SYMBOL_PLAINVAL: return Qnil;
2036 case SYMBOL_FORWARDED:
2038 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
2039 if (KBOARD_OBJFWDP (valcontents))
2040 return Fframe_terminal (selected_frame);
2041 else if (!BUFFER_OBJFWDP (valcontents))
2042 return Qnil;
2044 /* FALLTHROUGH */
2045 case SYMBOL_LOCALIZED:
2046 /* For a local variable, record both the symbol and which
2047 buffer's or frame's value we are saving. */
2048 if (!NILP (Flocal_variable_p (variable, Qnil)))
2049 return Fcurrent_buffer ();
2050 else if (sym->redirect == SYMBOL_LOCALIZED
2051 && blv_found (SYMBOL_BLV (sym)))
2052 return SYMBOL_BLV (sym)->where;
2053 else
2054 return Qnil;
2055 default: emacs_abort ();
2059 /* This code is disabled now that we use the selected frame to return
2060 keyboard-local-values. */
2061 #if 0
2062 extern struct terminal *get_terminal (Lisp_Object display, int);
2064 DEFUN ("terminal-local-value", Fterminal_local_value,
2065 Sterminal_local_value, 2, 2, 0,
2066 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
2067 If SYMBOL is not a terminal-local variable, then return its normal
2068 value, like `symbol-value'.
2070 TERMINAL may be a terminal object, a frame, or nil (meaning the
2071 selected frame's terminal device). */)
2072 (Lisp_Object symbol, Lisp_Object terminal)
2074 Lisp_Object result;
2075 struct terminal *t = get_terminal (terminal, 1);
2076 push_kboard (t->kboard);
2077 result = Fsymbol_value (symbol);
2078 pop_kboard ();
2079 return result;
2082 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
2083 Sset_terminal_local_value, 3, 3, 0,
2084 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2085 If VARIABLE is not a terminal-local variable, then set its normal
2086 binding, like `set'.
2088 TERMINAL may be a terminal object, a frame, or nil (meaning the
2089 selected frame's terminal device). */)
2090 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2092 Lisp_Object result;
2093 struct terminal *t = get_terminal (terminal, 1);
2094 push_kboard (d->kboard);
2095 result = Fset (symbol, value);
2096 pop_kboard ();
2097 return result;
2099 #endif
2101 /* Find the function at the end of a chain of symbol function indirections. */
2103 /* If OBJECT is a symbol, find the end of its function chain and
2104 return the value found there. If OBJECT is not a symbol, just
2105 return it. If there is a cycle in the function chain, signal a
2106 cyclic-function-indirection error.
2108 This is like Findirect_function, except that it doesn't signal an
2109 error if the chain ends up unbound. */
2110 Lisp_Object
2111 indirect_function (register Lisp_Object object)
2113 Lisp_Object tortoise, hare;
2115 hare = tortoise = object;
2117 for (;;)
2119 if (!SYMBOLP (hare) || NILP (hare))
2120 break;
2121 hare = XSYMBOL (hare)->function;
2122 if (!SYMBOLP (hare) || NILP (hare))
2123 break;
2124 hare = XSYMBOL (hare)->function;
2126 tortoise = XSYMBOL (tortoise)->function;
2128 if (EQ (hare, tortoise))
2129 xsignal1 (Qcyclic_function_indirection, object);
2132 return hare;
2135 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2136 doc: /* Return the function at the end of OBJECT's function chain.
2137 If OBJECT is not a symbol, just return it. Otherwise, follow all
2138 function indirections to find the final function binding and return it.
2139 Signal a cyclic-function-indirection error if there is a loop in the
2140 function chain of symbols. */)
2141 (register Lisp_Object object, Lisp_Object noerror)
2143 Lisp_Object result;
2145 /* Optimize for no indirection. */
2146 result = object;
2147 if (SYMBOLP (result) && !NILP (result)
2148 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2149 result = indirect_function (result);
2150 if (!NILP (result))
2151 return result;
2153 return Qnil;
2156 /* Extract and set vector and string elements. */
2158 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2159 doc: /* Return the element of ARRAY at index IDX.
2160 ARRAY may be a vector, a string, a char-table, a bool-vector,
2161 or a byte-code object. IDX starts at 0. */)
2162 (register Lisp_Object array, Lisp_Object idx)
2164 register EMACS_INT idxval;
2166 CHECK_NUMBER (idx);
2167 idxval = XINT (idx);
2168 if (STRINGP (array))
2170 int c;
2171 ptrdiff_t idxval_byte;
2173 if (idxval < 0 || idxval >= SCHARS (array))
2174 args_out_of_range (array, idx);
2175 if (! STRING_MULTIBYTE (array))
2176 return make_number ((unsigned char) SREF (array, idxval));
2177 idxval_byte = string_char_to_byte (array, idxval);
2179 c = STRING_CHAR (SDATA (array) + idxval_byte);
2180 return make_number (c);
2182 else if (BOOL_VECTOR_P (array))
2184 if (idxval < 0 || idxval >= bool_vector_size (array))
2185 args_out_of_range (array, idx);
2186 return bool_vector_ref (array, idxval);
2188 else if (CHAR_TABLE_P (array))
2190 CHECK_CHARACTER (idx);
2191 return CHAR_TABLE_REF (array, idxval);
2193 else
2195 ptrdiff_t size = 0;
2196 if (VECTORP (array))
2197 size = ASIZE (array);
2198 else if (COMPILEDP (array))
2199 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2200 else
2201 wrong_type_argument (Qarrayp, array);
2203 if (idxval < 0 || idxval >= size)
2204 args_out_of_range (array, idx);
2205 return AREF (array, idxval);
2209 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2210 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2211 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2212 bool-vector. IDX starts at 0. */)
2213 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2215 register EMACS_INT idxval;
2217 CHECK_NUMBER (idx);
2218 idxval = XINT (idx);
2219 CHECK_ARRAY (array, Qarrayp);
2220 CHECK_IMPURE (array);
2222 if (VECTORP (array))
2224 if (idxval < 0 || idxval >= ASIZE (array))
2225 args_out_of_range (array, idx);
2226 ASET (array, idxval, newelt);
2228 else if (BOOL_VECTOR_P (array))
2230 if (idxval < 0 || idxval >= bool_vector_size (array))
2231 args_out_of_range (array, idx);
2232 bool_vector_set (array, idxval, !NILP (newelt));
2234 else if (CHAR_TABLE_P (array))
2236 CHECK_CHARACTER (idx);
2237 CHAR_TABLE_SET (array, idxval, newelt);
2239 else
2241 int c;
2243 if (idxval < 0 || idxval >= SCHARS (array))
2244 args_out_of_range (array, idx);
2245 CHECK_CHARACTER (newelt);
2246 c = XFASTINT (newelt);
2248 if (STRING_MULTIBYTE (array))
2250 ptrdiff_t idxval_byte, nbytes;
2251 int prev_bytes, new_bytes;
2252 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2254 nbytes = SBYTES (array);
2255 idxval_byte = string_char_to_byte (array, idxval);
2256 p1 = SDATA (array) + idxval_byte;
2257 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2258 new_bytes = CHAR_STRING (c, p0);
2259 if (prev_bytes != new_bytes)
2261 /* We must relocate the string data. */
2262 ptrdiff_t nchars = SCHARS (array);
2263 USE_SAFE_ALLOCA;
2264 unsigned char *str = SAFE_ALLOCA (nbytes);
2266 memcpy (str, SDATA (array), nbytes);
2267 allocate_string_data (XSTRING (array), nchars,
2268 nbytes + new_bytes - prev_bytes);
2269 memcpy (SDATA (array), str, idxval_byte);
2270 p1 = SDATA (array) + idxval_byte;
2271 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2272 nbytes - (idxval_byte + prev_bytes));
2273 SAFE_FREE ();
2274 clear_string_char_byte_cache ();
2276 while (new_bytes--)
2277 *p1++ = *p0++;
2279 else
2281 if (! SINGLE_BYTE_CHAR_P (c))
2283 ptrdiff_t i;
2285 for (i = SBYTES (array) - 1; i >= 0; i--)
2286 if (SREF (array, i) >= 0x80)
2287 args_out_of_range (array, newelt);
2288 /* ARRAY is an ASCII string. Convert it to a multibyte
2289 string, and try `aset' again. */
2290 STRING_SET_MULTIBYTE (array);
2291 return Faset (array, idx, newelt);
2293 SSET (array, idxval, c);
2297 return newelt;
2300 /* Arithmetic functions */
2302 Lisp_Object
2303 arithcompare (Lisp_Object num1, Lisp_Object num2, enum Arith_Comparison comparison)
2305 double f1 = 0, f2 = 0;
2306 bool floatp = 0;
2308 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2309 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2311 if (FLOATP (num1) || FLOATP (num2))
2313 floatp = 1;
2314 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2315 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2318 switch (comparison)
2320 case ARITH_EQUAL:
2321 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2322 return Qt;
2323 return Qnil;
2325 case ARITH_NOTEQUAL:
2326 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2327 return Qt;
2328 return Qnil;
2330 case ARITH_LESS:
2331 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2332 return Qt;
2333 return Qnil;
2335 case ARITH_LESS_OR_EQUAL:
2336 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2337 return Qt;
2338 return Qnil;
2340 case ARITH_GRTR:
2341 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2342 return Qt;
2343 return Qnil;
2345 case ARITH_GRTR_OR_EQUAL:
2346 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2347 return Qt;
2348 return Qnil;
2350 default:
2351 emacs_abort ();
2355 static Lisp_Object
2356 arithcompare_driver (ptrdiff_t nargs, Lisp_Object *args,
2357 enum Arith_Comparison comparison)
2359 ptrdiff_t argnum;
2360 for (argnum = 1; argnum < nargs; ++argnum)
2362 if (EQ (Qnil, arithcompare (args[argnum - 1], args[argnum], comparison)))
2363 return Qnil;
2365 return Qt;
2368 DEFUN ("=", Feqlsign, Seqlsign, 1, MANY, 0,
2369 doc: /* Return t if args, all numbers or markers, are equal.
2370 usage: (= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2371 (ptrdiff_t nargs, Lisp_Object *args)
2373 return arithcompare_driver (nargs, args, ARITH_EQUAL);
2376 DEFUN ("<", Flss, Slss, 1, MANY, 0,
2377 doc: /* Return t if each arg (a number or marker), is less than the next arg.
2378 usage: (< NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2379 (ptrdiff_t nargs, Lisp_Object *args)
2381 return arithcompare_driver (nargs, args, ARITH_LESS);
2384 DEFUN (">", Fgtr, Sgtr, 1, MANY, 0,
2385 doc: /* Return t if each arg (a number or marker) is greater than the next arg.
2386 usage: (> NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2387 (ptrdiff_t nargs, Lisp_Object *args)
2389 return arithcompare_driver (nargs, args, ARITH_GRTR);
2392 DEFUN ("<=", Fleq, Sleq, 1, MANY, 0,
2393 doc: /* Return t if each arg (a number or marker) is less than or equal to the next.
2394 usage: (<= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2395 (ptrdiff_t nargs, Lisp_Object *args)
2397 return arithcompare_driver (nargs, args, ARITH_LESS_OR_EQUAL);
2400 DEFUN (">=", Fgeq, Sgeq, 1, MANY, 0,
2401 doc: /* Return t if each arg (a number or marker) is greater than or equal to the next.
2402 usage: (>= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2403 (ptrdiff_t nargs, Lisp_Object *args)
2405 return arithcompare_driver (nargs, args, ARITH_GRTR_OR_EQUAL);
2408 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2409 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2410 (register Lisp_Object num1, Lisp_Object num2)
2412 return arithcompare (num1, num2, ARITH_NOTEQUAL);
2415 /* Convert the cons-of-integers, integer, or float value C to an
2416 unsigned value with maximum value MAX. Signal an error if C does not
2417 have a valid format or is out of range. */
2418 uintmax_t
2419 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2421 bool valid = 0;
2422 uintmax_t val IF_LINT (= 0);
2423 if (INTEGERP (c))
2425 valid = 0 <= XINT (c);
2426 val = XINT (c);
2428 else if (FLOATP (c))
2430 double d = XFLOAT_DATA (c);
2431 if (0 <= d
2432 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2434 val = d;
2435 valid = 1;
2438 else if (CONSP (c) && NATNUMP (XCAR (c)))
2440 uintmax_t top = XFASTINT (XCAR (c));
2441 Lisp_Object rest = XCDR (c);
2442 if (top <= UINTMAX_MAX >> 24 >> 16
2443 && CONSP (rest)
2444 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2445 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2447 uintmax_t mid = XFASTINT (XCAR (rest));
2448 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2449 valid = 1;
2451 else if (top <= UINTMAX_MAX >> 16)
2453 if (CONSP (rest))
2454 rest = XCAR (rest);
2455 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2457 val = top << 16 | XFASTINT (rest);
2458 valid = 1;
2463 if (! (valid && val <= max))
2464 error ("Not an in-range integer, float, or cons of integers");
2465 return val;
2468 /* Convert the cons-of-integers, integer, or float value C to a signed
2469 value with extrema MIN and MAX. Signal an error if C does not have
2470 a valid format or is out of range. */
2471 intmax_t
2472 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2474 bool valid = 0;
2475 intmax_t val IF_LINT (= 0);
2476 if (INTEGERP (c))
2478 val = XINT (c);
2479 valid = 1;
2481 else if (FLOATP (c))
2483 double d = XFLOAT_DATA (c);
2484 if (min <= d
2485 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2487 val = d;
2488 valid = 1;
2491 else if (CONSP (c) && INTEGERP (XCAR (c)))
2493 intmax_t top = XINT (XCAR (c));
2494 Lisp_Object rest = XCDR (c);
2495 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2496 && CONSP (rest)
2497 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2498 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2500 intmax_t mid = XFASTINT (XCAR (rest));
2501 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2502 valid = 1;
2504 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2506 if (CONSP (rest))
2507 rest = XCAR (rest);
2508 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2510 val = top << 16 | XFASTINT (rest);
2511 valid = 1;
2516 if (! (valid && min <= val && val <= max))
2517 error ("Not an in-range integer, float, or cons of integers");
2518 return val;
2521 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2522 doc: /* Return the decimal representation of NUMBER as a string.
2523 Uses a minus sign if negative.
2524 NUMBER may be an integer or a floating point number. */)
2525 (Lisp_Object number)
2527 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2528 int len;
2530 CHECK_NUMBER_OR_FLOAT (number);
2532 if (FLOATP (number))
2533 len = float_to_string (buffer, XFLOAT_DATA (number));
2534 else
2535 len = sprintf (buffer, "%"pI"d", XINT (number));
2537 return make_unibyte_string (buffer, len);
2540 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2541 doc: /* Parse STRING as a decimal number and return the number.
2542 Ignore leading spaces and tabs, and all trailing chars. Return 0 if
2543 STRING cannot be parsed as an integer or floating point number.
2545 If BASE, interpret STRING as a number in that base. If BASE isn't
2546 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2547 If the base used is not 10, STRING is always parsed as an integer. */)
2548 (register Lisp_Object string, Lisp_Object base)
2550 register char *p;
2551 register int b;
2552 Lisp_Object val;
2554 CHECK_STRING (string);
2556 if (NILP (base))
2557 b = 10;
2558 else
2560 CHECK_NUMBER (base);
2561 if (! (2 <= XINT (base) && XINT (base) <= 16))
2562 xsignal1 (Qargs_out_of_range, base);
2563 b = XINT (base);
2566 p = SSDATA (string);
2567 while (*p == ' ' || *p == '\t')
2568 p++;
2570 val = string_to_number (p, b, 1);
2571 return NILP (val) ? make_number (0) : val;
2574 enum arithop
2576 Aadd,
2577 Asub,
2578 Amult,
2579 Adiv,
2580 Alogand,
2581 Alogior,
2582 Alogxor,
2583 Amax,
2584 Amin
2587 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2588 ptrdiff_t, Lisp_Object *);
2589 static Lisp_Object
2590 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2592 Lisp_Object val;
2593 ptrdiff_t argnum, ok_args;
2594 EMACS_INT accum = 0;
2595 EMACS_INT next, ok_accum;
2596 bool overflow = 0;
2598 switch (code)
2600 case Alogior:
2601 case Alogxor:
2602 case Aadd:
2603 case Asub:
2604 accum = 0;
2605 break;
2606 case Amult:
2607 accum = 1;
2608 break;
2609 case Alogand:
2610 accum = -1;
2611 break;
2612 default:
2613 break;
2616 for (argnum = 0; argnum < nargs; argnum++)
2618 if (! overflow)
2620 ok_args = argnum;
2621 ok_accum = accum;
2624 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2625 val = args[argnum];
2626 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2628 if (FLOATP (val))
2629 return float_arith_driver (ok_accum, ok_args, code,
2630 nargs, args);
2631 args[argnum] = val;
2632 next = XINT (args[argnum]);
2633 switch (code)
2635 case Aadd:
2636 if (INT_ADD_OVERFLOW (accum, next))
2638 overflow = 1;
2639 accum &= INTMASK;
2641 accum += next;
2642 break;
2643 case Asub:
2644 if (INT_SUBTRACT_OVERFLOW (accum, next))
2646 overflow = 1;
2647 accum &= INTMASK;
2649 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2650 break;
2651 case Amult:
2652 if (INT_MULTIPLY_OVERFLOW (accum, next))
2654 EMACS_UINT a = accum, b = next, ab = a * b;
2655 overflow = 1;
2656 accum = ab & INTMASK;
2658 else
2659 accum *= next;
2660 break;
2661 case Adiv:
2662 if (!argnum)
2663 accum = next;
2664 else
2666 if (next == 0)
2667 xsignal0 (Qarith_error);
2668 accum /= next;
2670 break;
2671 case Alogand:
2672 accum &= next;
2673 break;
2674 case Alogior:
2675 accum |= next;
2676 break;
2677 case Alogxor:
2678 accum ^= next;
2679 break;
2680 case Amax:
2681 if (!argnum || next > accum)
2682 accum = next;
2683 break;
2684 case Amin:
2685 if (!argnum || next < accum)
2686 accum = next;
2687 break;
2691 XSETINT (val, accum);
2692 return val;
2695 #undef isnan
2696 #define isnan(x) ((x) != (x))
2698 static Lisp_Object
2699 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2700 ptrdiff_t nargs, Lisp_Object *args)
2702 register Lisp_Object val;
2703 double next;
2705 for (; argnum < nargs; argnum++)
2707 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2708 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2710 if (FLOATP (val))
2712 next = XFLOAT_DATA (val);
2714 else
2716 args[argnum] = val; /* runs into a compiler bug. */
2717 next = XINT (args[argnum]);
2719 switch (code)
2721 case Aadd:
2722 accum += next;
2723 break;
2724 case Asub:
2725 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2726 break;
2727 case Amult:
2728 accum *= next;
2729 break;
2730 case Adiv:
2731 if (!argnum)
2732 accum = next;
2733 else
2735 if (! IEEE_FLOATING_POINT && next == 0)
2736 xsignal0 (Qarith_error);
2737 accum /= next;
2739 break;
2740 case Alogand:
2741 case Alogior:
2742 case Alogxor:
2743 return wrong_type_argument (Qinteger_or_marker_p, val);
2744 case Amax:
2745 if (!argnum || isnan (next) || next > accum)
2746 accum = next;
2747 break;
2748 case Amin:
2749 if (!argnum || isnan (next) || next < accum)
2750 accum = next;
2751 break;
2755 return make_float (accum);
2759 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2760 doc: /* Return sum of any number of arguments, which are numbers or markers.
2761 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2762 (ptrdiff_t nargs, Lisp_Object *args)
2764 return arith_driver (Aadd, nargs, args);
2767 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2768 doc: /* Negate number or subtract numbers or markers and return the result.
2769 With one arg, negates it. With more than one arg,
2770 subtracts all but the first from the first.
2771 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2772 (ptrdiff_t nargs, Lisp_Object *args)
2774 return arith_driver (Asub, nargs, args);
2777 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2778 doc: /* Return product of any number of arguments, which are numbers or markers.
2779 usage: (* &rest NUMBERS-OR-MARKERS) */)
2780 (ptrdiff_t nargs, Lisp_Object *args)
2782 return arith_driver (Amult, nargs, args);
2785 DEFUN ("/", Fquo, Squo, 1, MANY, 0,
2786 doc: /* Return first argument divided by all the remaining arguments.
2787 The arguments must be numbers or markers.
2788 usage: (/ DIVIDEND &rest DIVISORS) */)
2789 (ptrdiff_t nargs, Lisp_Object *args)
2791 ptrdiff_t argnum;
2792 for (argnum = 2; argnum < nargs; argnum++)
2793 if (FLOATP (args[argnum]))
2794 return float_arith_driver (0, 0, Adiv, nargs, args);
2795 return arith_driver (Adiv, nargs, args);
2798 DEFUN ("%", Frem, Srem, 2, 2, 0,
2799 doc: /* Return remainder of X divided by Y.
2800 Both must be integers or markers. */)
2801 (register Lisp_Object x, Lisp_Object y)
2803 Lisp_Object val;
2805 CHECK_NUMBER_COERCE_MARKER (x);
2806 CHECK_NUMBER_COERCE_MARKER (y);
2808 if (XINT (y) == 0)
2809 xsignal0 (Qarith_error);
2811 XSETINT (val, XINT (x) % XINT (y));
2812 return val;
2815 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2816 doc: /* Return X modulo Y.
2817 The result falls between zero (inclusive) and Y (exclusive).
2818 Both X and Y must be numbers or markers. */)
2819 (register Lisp_Object x, Lisp_Object y)
2821 Lisp_Object val;
2822 EMACS_INT i1, i2;
2824 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2825 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2827 if (FLOATP (x) || FLOATP (y))
2828 return fmod_float (x, y);
2830 i1 = XINT (x);
2831 i2 = XINT (y);
2833 if (i2 == 0)
2834 xsignal0 (Qarith_error);
2836 i1 %= i2;
2838 /* If the "remainder" comes out with the wrong sign, fix it. */
2839 if (i2 < 0 ? i1 > 0 : i1 < 0)
2840 i1 += i2;
2842 XSETINT (val, i1);
2843 return val;
2846 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2847 doc: /* Return largest of all the arguments (which must be numbers or markers).
2848 The value is always a number; markers are converted to numbers.
2849 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2850 (ptrdiff_t nargs, Lisp_Object *args)
2852 return arith_driver (Amax, nargs, args);
2855 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2856 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2857 The value is always a number; markers are converted to numbers.
2858 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2859 (ptrdiff_t nargs, Lisp_Object *args)
2861 return arith_driver (Amin, nargs, args);
2864 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2865 doc: /* Return bitwise-and of all the arguments.
2866 Arguments may be integers, or markers converted to integers.
2867 usage: (logand &rest INTS-OR-MARKERS) */)
2868 (ptrdiff_t nargs, Lisp_Object *args)
2870 return arith_driver (Alogand, nargs, args);
2873 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2874 doc: /* Return bitwise-or of all the arguments.
2875 Arguments may be integers, or markers converted to integers.
2876 usage: (logior &rest INTS-OR-MARKERS) */)
2877 (ptrdiff_t nargs, Lisp_Object *args)
2879 return arith_driver (Alogior, nargs, args);
2882 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2883 doc: /* Return bitwise-exclusive-or of all the arguments.
2884 Arguments may be integers, or markers converted to integers.
2885 usage: (logxor &rest INTS-OR-MARKERS) */)
2886 (ptrdiff_t nargs, Lisp_Object *args)
2888 return arith_driver (Alogxor, nargs, args);
2891 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2892 doc: /* Return VALUE with its bits shifted left by COUNT.
2893 If COUNT is negative, shifting is actually to the right.
2894 In this case, the sign bit is duplicated. */)
2895 (register Lisp_Object value, Lisp_Object count)
2897 register Lisp_Object val;
2899 CHECK_NUMBER (value);
2900 CHECK_NUMBER (count);
2902 if (XINT (count) >= BITS_PER_EMACS_INT)
2903 XSETINT (val, 0);
2904 else if (XINT (count) > 0)
2905 XSETINT (val, XUINT (value) << XFASTINT (count));
2906 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2907 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2908 else
2909 XSETINT (val, XINT (value) >> -XINT (count));
2910 return val;
2913 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2914 doc: /* Return VALUE with its bits shifted left by COUNT.
2915 If COUNT is negative, shifting is actually to the right.
2916 In this case, zeros are shifted in on the left. */)
2917 (register Lisp_Object value, Lisp_Object count)
2919 register Lisp_Object val;
2921 CHECK_NUMBER (value);
2922 CHECK_NUMBER (count);
2924 if (XINT (count) >= BITS_PER_EMACS_INT)
2925 XSETINT (val, 0);
2926 else if (XINT (count) > 0)
2927 XSETINT (val, XUINT (value) << XFASTINT (count));
2928 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2929 XSETINT (val, 0);
2930 else
2931 XSETINT (val, XUINT (value) >> -XINT (count));
2932 return val;
2935 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2936 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2937 Markers are converted to integers. */)
2938 (register Lisp_Object number)
2940 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2942 if (FLOATP (number))
2943 return (make_float (1.0 + XFLOAT_DATA (number)));
2945 XSETINT (number, XINT (number) + 1);
2946 return number;
2949 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2950 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2951 Markers are converted to integers. */)
2952 (register Lisp_Object number)
2954 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2956 if (FLOATP (number))
2957 return (make_float (-1.0 + XFLOAT_DATA (number)));
2959 XSETINT (number, XINT (number) - 1);
2960 return number;
2963 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2964 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2965 (register Lisp_Object number)
2967 CHECK_NUMBER (number);
2968 XSETINT (number, ~XINT (number));
2969 return number;
2972 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2973 doc: /* Return the byteorder for the machine.
2974 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2975 lowercase l) for small endian machines. */
2976 attributes: const)
2977 (void)
2979 unsigned i = 0x04030201;
2980 int order = *(char *)&i == 1 ? 108 : 66;
2982 return make_number (order);
2985 /* Because we round up the bool vector allocate size to word_size
2986 units, we can safely read past the "end" of the vector in the
2987 operations below. These extra bits are always zero. */
2989 static bits_word
2990 bool_vector_spare_mask (EMACS_INT nr_bits)
2992 return (((bits_word) 1) << (nr_bits % BITS_PER_BITS_WORD)) - 1;
2995 /* Info about unsigned long long, falling back on unsigned long
2996 if unsigned long long is not available. */
2998 #if HAVE_UNSIGNED_LONG_LONG_INT && defined ULLONG_MAX
2999 enum { BITS_PER_ULL = CHAR_BIT * sizeof (unsigned long long) };
3000 # define ULL_MAX ULLONG_MAX
3001 #else
3002 enum { BITS_PER_ULL = CHAR_BIT * sizeof (unsigned long) };
3003 # define ULL_MAX ULONG_MAX
3004 # define count_one_bits_ll count_one_bits_l
3005 # define count_trailing_zeros_ll count_trailing_zeros_l
3006 #endif
3008 /* Shift VAL right by the width of an unsigned long long.
3009 BITS_PER_ULL must be less than BITS_PER_BITS_WORD. */
3011 static bits_word
3012 shift_right_ull (bits_word w)
3014 /* Pacify bogus GCC warning about shift count exceeding type width. */
3015 int shift = BITS_PER_ULL - BITS_PER_BITS_WORD < 0 ? BITS_PER_ULL : 0;
3016 return w >> shift;
3019 /* Return the number of 1 bits in W. */
3021 static int
3022 count_one_bits_word (bits_word w)
3024 if (BITS_WORD_MAX <= UINT_MAX)
3025 return count_one_bits (w);
3026 else if (BITS_WORD_MAX <= ULONG_MAX)
3027 return count_one_bits_l (w);
3028 else
3030 int i = 0, count = 0;
3031 while (count += count_one_bits_ll (w),
3032 (i += BITS_PER_ULL) < BITS_PER_BITS_WORD)
3033 w = shift_right_ull (w);
3034 return count;
3038 enum bool_vector_op { bool_vector_exclusive_or,
3039 bool_vector_union,
3040 bool_vector_intersection,
3041 bool_vector_set_difference,
3042 bool_vector_subsetp };
3044 static Lisp_Object
3045 bool_vector_binop_driver (Lisp_Object a,
3046 Lisp_Object b,
3047 Lisp_Object dest,
3048 enum bool_vector_op op)
3050 EMACS_INT nr_bits;
3051 bits_word *adata, *bdata, *destdata;
3052 ptrdiff_t i = 0;
3053 ptrdiff_t nr_words;
3055 CHECK_BOOL_VECTOR (a);
3056 CHECK_BOOL_VECTOR (b);
3058 nr_bits = bool_vector_size (a);
3059 if (bool_vector_size (b) != nr_bits)
3060 wrong_length_argument (a, b, dest);
3062 nr_words = bool_vector_words (nr_bits);
3063 adata = bool_vector_data (a);
3064 bdata = bool_vector_data (b);
3066 if (NILP (dest))
3068 dest = make_uninit_bool_vector (nr_bits);
3069 destdata = bool_vector_data (dest);
3071 else
3073 CHECK_BOOL_VECTOR (dest);
3074 destdata = bool_vector_data (dest);
3075 if (bool_vector_size (dest) != nr_bits)
3076 wrong_length_argument (a, b, dest);
3078 switch (op)
3080 case bool_vector_exclusive_or:
3081 for (; i < nr_words; i++)
3082 if (destdata[i] != (adata[i] ^ bdata[i]))
3083 goto set_dest;
3084 break;
3086 case bool_vector_subsetp:
3087 for (; i < nr_words; i++)
3088 if (adata[i] &~ bdata[i])
3089 return Qnil;
3090 return Qt;
3092 case bool_vector_union:
3093 for (; i < nr_words; i++)
3094 if (destdata[i] != (adata[i] | bdata[i]))
3095 goto set_dest;
3096 break;
3098 case bool_vector_intersection:
3099 for (; i < nr_words; i++)
3100 if (destdata[i] != (adata[i] & bdata[i]))
3101 goto set_dest;
3102 break;
3104 case bool_vector_set_difference:
3105 for (; i < nr_words; i++)
3106 if (destdata[i] != (adata[i] &~ bdata[i]))
3107 goto set_dest;
3108 break;
3111 return Qnil;
3114 set_dest:
3115 switch (op)
3117 case bool_vector_exclusive_or:
3118 for (; i < nr_words; i++)
3119 destdata[i] = adata[i] ^ bdata[i];
3120 break;
3122 case bool_vector_union:
3123 for (; i < nr_words; i++)
3124 destdata[i] = adata[i] | bdata[i];
3125 break;
3127 case bool_vector_intersection:
3128 for (; i < nr_words; i++)
3129 destdata[i] = adata[i] & bdata[i];
3130 break;
3132 case bool_vector_set_difference:
3133 for (; i < nr_words; i++)
3134 destdata[i] = adata[i] &~ bdata[i];
3135 break;
3137 default:
3138 eassume (0);
3141 return dest;
3144 /* PRECONDITION must be true. Return VALUE. This odd construction
3145 works around a bogus GCC diagnostic "shift count >= width of type". */
3147 static int
3148 pre_value (bool precondition, int value)
3150 eassume (precondition);
3151 return precondition ? value : 0;
3154 /* Compute the number of trailing zero bits in val. If val is zero,
3155 return the number of bits in val. */
3156 static int
3157 count_trailing_zero_bits (bits_word val)
3159 if (BITS_WORD_MAX == UINT_MAX)
3160 return count_trailing_zeros (val);
3161 if (BITS_WORD_MAX == ULONG_MAX)
3162 return count_trailing_zeros_l (val);
3163 if (BITS_WORD_MAX == ULL_MAX)
3164 return count_trailing_zeros_ll (val);
3166 /* The rest of this code is for the unlikely platform where bits_word differs
3167 in width from unsigned int, unsigned long, and unsigned long long. */
3168 val |= ~ BITS_WORD_MAX;
3169 if (BITS_WORD_MAX <= UINT_MAX)
3170 return count_trailing_zeros (val);
3171 if (BITS_WORD_MAX <= ULONG_MAX)
3172 return count_trailing_zeros_l (val);
3173 else
3175 int count;
3176 for (count = 0;
3177 count < BITS_PER_BITS_WORD - BITS_PER_ULL;
3178 count += BITS_PER_ULL)
3180 if (val & ULL_MAX)
3181 return count + count_trailing_zeros_ll (val);
3182 val = shift_right_ull (val);
3185 if (BITS_PER_BITS_WORD % BITS_PER_ULL != 0
3186 && BITS_WORD_MAX == (bits_word) -1)
3187 val |= (bits_word) 1 << pre_value (ULONG_MAX < BITS_WORD_MAX,
3188 BITS_PER_BITS_WORD % BITS_PER_ULL);
3189 return count + count_trailing_zeros_ll (val);
3193 static bits_word
3194 bits_word_to_host_endian (bits_word val)
3196 #ifndef WORDS_BIGENDIAN
3197 return val;
3198 #else
3199 if (BITS_WORD_MAX >> 31 == 1)
3200 return bswap_32 (val);
3201 # if HAVE_UNSIGNED_LONG_LONG
3202 if (BITS_WORD_MAX >> 31 >> 31 >> 1 == 1)
3203 return bswap_64 (val);
3204 # endif
3206 int i;
3207 bits_word r = 0;
3208 for (i = 0; i < sizeof val; i++)
3210 r = ((r << 1 << (CHAR_BIT - 1))
3211 | (val & ((1u << 1 << (CHAR_BIT - 1)) - 1)));
3212 val = val >> 1 >> (CHAR_BIT - 1);
3214 return r;
3216 #endif
3219 DEFUN ("bool-vector-exclusive-or", Fbool_vector_exclusive_or,
3220 Sbool_vector_exclusive_or, 2, 3, 0,
3221 doc: /* Return A ^ B, bitwise exclusive or.
3222 If optional third argument C is given, store result into C.
3223 A, B, and C must be bool vectors of the same length.
3224 Return the destination vector if it changed or nil otherwise. */)
3225 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3227 return bool_vector_binop_driver (a, b, c, bool_vector_exclusive_or);
3230 DEFUN ("bool-vector-union", Fbool_vector_union,
3231 Sbool_vector_union, 2, 3, 0,
3232 doc: /* Return A | B, bitwise or.
3233 If optional third argument C is given, store result into C.
3234 A, B, and C must be bool vectors of the same length.
3235 Return the destination vector if it changed or nil otherwise. */)
3236 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3238 return bool_vector_binop_driver (a, b, c, bool_vector_union);
3241 DEFUN ("bool-vector-intersection", Fbool_vector_intersection,
3242 Sbool_vector_intersection, 2, 3, 0,
3243 doc: /* Return A & B, bitwise and.
3244 If optional third argument C is given, store result into C.
3245 A, B, and C must be bool vectors of the same length.
3246 Return the destination vector if it changed or nil otherwise. */)
3247 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3249 return bool_vector_binop_driver (a, b, c, bool_vector_intersection);
3252 DEFUN ("bool-vector-set-difference", Fbool_vector_set_difference,
3253 Sbool_vector_set_difference, 2, 3, 0,
3254 doc: /* Return A &~ B, set difference.
3255 If optional third argument C is given, store result into C.
3256 A, B, and C must be bool vectors of the same length.
3257 Return the destination vector if it changed or nil otherwise. */)
3258 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3260 return bool_vector_binop_driver (a, b, c, bool_vector_set_difference);
3263 DEFUN ("bool-vector-subsetp", Fbool_vector_subsetp,
3264 Sbool_vector_subsetp, 2, 2, 0,
3265 doc: /* Return t if every t value in A is also t in B, nil otherwise.
3266 A and B must be bool vectors of the same length. */)
3267 (Lisp_Object a, Lisp_Object b)
3269 return bool_vector_binop_driver (a, b, b, bool_vector_subsetp);
3272 DEFUN ("bool-vector-not", Fbool_vector_not,
3273 Sbool_vector_not, 1, 2, 0,
3274 doc: /* Compute ~A, set complement.
3275 If optional second argument B is given, store result into B.
3276 A and B must be bool vectors of the same length.
3277 Return the destination vector. */)
3278 (Lisp_Object a, Lisp_Object b)
3280 EMACS_INT nr_bits;
3281 bits_word *bdata, *adata;
3282 ptrdiff_t i;
3284 CHECK_BOOL_VECTOR (a);
3285 nr_bits = bool_vector_size (a);
3287 if (NILP (b))
3288 b = make_uninit_bool_vector (nr_bits);
3289 else
3291 CHECK_BOOL_VECTOR (b);
3292 if (bool_vector_size (b) != nr_bits)
3293 wrong_length_argument (a, b, Qnil);
3296 bdata = bool_vector_data (b);
3297 adata = bool_vector_data (a);
3299 for (i = 0; i < nr_bits / BITS_PER_BITS_WORD; i++)
3300 bdata[i] = BITS_WORD_MAX & ~adata[i];
3302 if (nr_bits % BITS_PER_BITS_WORD)
3304 bits_word mword = bits_word_to_host_endian (adata[i]);
3305 mword = ~mword;
3306 mword &= bool_vector_spare_mask (nr_bits);
3307 bdata[i] = bits_word_to_host_endian (mword);
3310 return b;
3313 DEFUN ("bool-vector-count-population", Fbool_vector_count_population,
3314 Sbool_vector_count_population, 1, 1, 0,
3315 doc: /* Count how many elements in A are t.
3316 A is a bool vector. To count A's nil elements, subtract the return
3317 value from A's length. */)
3318 (Lisp_Object a)
3320 EMACS_INT count;
3321 EMACS_INT nr_bits;
3322 bits_word *adata;
3323 ptrdiff_t i, nwords;
3325 CHECK_BOOL_VECTOR (a);
3327 nr_bits = bool_vector_size (a);
3328 nwords = bool_vector_words (nr_bits);
3329 count = 0;
3330 adata = bool_vector_data (a);
3332 for (i = 0; i < nwords; i++)
3333 count += count_one_bits_word (adata[i]);
3335 return make_number (count);
3338 DEFUN ("bool-vector-count-consecutive", Fbool_vector_count_consecutive,
3339 Sbool_vector_count_consecutive, 3, 3, 0,
3340 doc: /* Count how many consecutive elements in A equal B starting at I.
3341 A is a bool vector, B is t or nil, and I is an index into A. */)
3342 (Lisp_Object a, Lisp_Object b, Lisp_Object i)
3344 EMACS_INT count;
3345 EMACS_INT nr_bits;
3346 int offset;
3347 bits_word *adata;
3348 bits_word twiddle;
3349 bits_word mword; /* Machine word. */
3350 ptrdiff_t pos, pos0;
3351 ptrdiff_t nr_words;
3353 CHECK_BOOL_VECTOR (a);
3354 CHECK_NATNUM (i);
3356 nr_bits = bool_vector_size (a);
3357 if (XFASTINT (i) > nr_bits) /* Allow one past the end for convenience */
3358 args_out_of_range (a, i);
3360 adata = bool_vector_data (a);
3361 nr_words = bool_vector_words (nr_bits);
3362 pos = XFASTINT (i) / BITS_PER_BITS_WORD;
3363 offset = XFASTINT (i) % BITS_PER_BITS_WORD;
3364 count = 0;
3366 /* By XORing with twiddle, we transform the problem of "count
3367 consecutive equal values" into "count the zero bits". The latter
3368 operation usually has hardware support. */
3369 twiddle = NILP (b) ? 0 : BITS_WORD_MAX;
3371 /* Scan the remainder of the mword at the current offset. */
3372 if (pos < nr_words && offset != 0)
3374 mword = bits_word_to_host_endian (adata[pos]);
3375 mword ^= twiddle;
3376 mword >>= offset;
3378 /* Do not count the pad bits. */
3379 mword |= (bits_word) 1 << (BITS_PER_BITS_WORD - offset);
3381 count = count_trailing_zero_bits (mword);
3382 pos++;
3383 if (count + offset < BITS_PER_BITS_WORD)
3384 return make_number (count);
3387 /* Scan whole words until we either reach the end of the vector or
3388 find an mword that doesn't completely match. twiddle is
3389 endian-independent. */
3390 pos0 = pos;
3391 while (pos < nr_words && adata[pos] == twiddle)
3392 pos++;
3393 count += (pos - pos0) * BITS_PER_BITS_WORD;
3395 if (pos < nr_words)
3397 /* If we stopped because of a mismatch, see how many bits match
3398 in the current mword. */
3399 mword = bits_word_to_host_endian (adata[pos]);
3400 mword ^= twiddle;
3401 count += count_trailing_zero_bits (mword);
3403 else if (nr_bits % BITS_PER_BITS_WORD != 0)
3405 /* If we hit the end, we might have overshot our count. Reduce
3406 the total by the number of spare bits at the end of the
3407 vector. */
3408 count -= BITS_PER_BITS_WORD - nr_bits % BITS_PER_BITS_WORD;
3411 return make_number (count);
3415 void
3416 syms_of_data (void)
3418 Lisp_Object error_tail, arith_tail;
3420 DEFSYM (Qquote, "quote");
3421 DEFSYM (Qlambda, "lambda");
3422 DEFSYM (Qsubr, "subr");
3423 DEFSYM (Qerror_conditions, "error-conditions");
3424 DEFSYM (Qerror_message, "error-message");
3425 DEFSYM (Qtop_level, "top-level");
3427 DEFSYM (Qerror, "error");
3428 DEFSYM (Quser_error, "user-error");
3429 DEFSYM (Qquit, "quit");
3430 DEFSYM (Qwrong_length_argument, "wrong-length-argument");
3431 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
3432 DEFSYM (Qargs_out_of_range, "args-out-of-range");
3433 DEFSYM (Qvoid_function, "void-function");
3434 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
3435 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
3436 DEFSYM (Qvoid_variable, "void-variable");
3437 DEFSYM (Qsetting_constant, "setting-constant");
3438 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
3440 DEFSYM (Qinvalid_function, "invalid-function");
3441 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
3442 DEFSYM (Qno_catch, "no-catch");
3443 DEFSYM (Qend_of_file, "end-of-file");
3444 DEFSYM (Qarith_error, "arith-error");
3445 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
3446 DEFSYM (Qend_of_buffer, "end-of-buffer");
3447 DEFSYM (Qbuffer_read_only, "buffer-read-only");
3448 DEFSYM (Qtext_read_only, "text-read-only");
3449 DEFSYM (Qmark_inactive, "mark-inactive");
3451 DEFSYM (Qlistp, "listp");
3452 DEFSYM (Qconsp, "consp");
3453 DEFSYM (Qsymbolp, "symbolp");
3454 DEFSYM (Qintegerp, "integerp");
3455 DEFSYM (Qnatnump, "natnump");
3456 DEFSYM (Qwholenump, "wholenump");
3457 DEFSYM (Qstringp, "stringp");
3458 DEFSYM (Qarrayp, "arrayp");
3459 DEFSYM (Qsequencep, "sequencep");
3460 DEFSYM (Qbufferp, "bufferp");
3461 DEFSYM (Qvectorp, "vectorp");
3462 DEFSYM (Qbool_vector_p, "bool-vector-p");
3463 DEFSYM (Qchar_or_string_p, "char-or-string-p");
3464 DEFSYM (Qmarkerp, "markerp");
3465 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
3466 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
3467 DEFSYM (Qfboundp, "fboundp");
3469 DEFSYM (Qfloatp, "floatp");
3470 DEFSYM (Qnumberp, "numberp");
3471 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
3473 DEFSYM (Qchar_table_p, "char-table-p");
3474 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
3476 DEFSYM (Qsubrp, "subrp");
3477 DEFSYM (Qunevalled, "unevalled");
3478 DEFSYM (Qmany, "many");
3480 DEFSYM (Qcdr, "cdr");
3482 error_tail = pure_cons (Qerror, Qnil);
3484 /* ERROR is used as a signaler for random errors for which nothing else is
3485 right. */
3487 Fput (Qerror, Qerror_conditions,
3488 error_tail);
3489 Fput (Qerror, Qerror_message,
3490 build_pure_c_string ("error"));
3492 #define PUT_ERROR(sym, tail, msg) \
3493 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3494 Fput (sym, Qerror_message, build_pure_c_string (msg))
3496 PUT_ERROR (Qquit, Qnil, "Quit");
3498 PUT_ERROR (Quser_error, error_tail, "");
3499 PUT_ERROR (Qwrong_length_argument, error_tail, "Wrong length argument");
3500 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3501 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3502 PUT_ERROR (Qvoid_function, error_tail,
3503 "Symbol's function definition is void");
3504 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3505 "Symbol's chain of function indirections contains a loop");
3506 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3507 "Symbol's chain of variable indirections contains a loop");
3508 DEFSYM (Qcircular_list, "circular-list");
3509 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3510 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3511 PUT_ERROR (Qsetting_constant, error_tail,
3512 "Attempt to set a constant symbol");
3513 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3514 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3515 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3516 "Wrong number of arguments");
3517 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3518 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3520 arith_tail = pure_cons (Qarith_error, error_tail);
3521 Fput (Qarith_error, Qerror_conditions, arith_tail);
3522 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3524 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3525 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3526 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3527 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3528 "Text is read-only");
3530 DEFSYM (Qrange_error, "range-error");
3531 DEFSYM (Qdomain_error, "domain-error");
3532 DEFSYM (Qsingularity_error, "singularity-error");
3533 DEFSYM (Qoverflow_error, "overflow-error");
3534 DEFSYM (Qunderflow_error, "underflow-error");
3536 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3538 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3540 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3541 "Arithmetic singularity error");
3543 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3544 "Arithmetic overflow error");
3545 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3546 "Arithmetic underflow error");
3548 /* Types that type-of returns. */
3549 DEFSYM (Qinteger, "integer");
3550 DEFSYM (Qsymbol, "symbol");
3551 DEFSYM (Qstring, "string");
3552 DEFSYM (Qcons, "cons");
3553 DEFSYM (Qmarker, "marker");
3554 DEFSYM (Qoverlay, "overlay");
3555 DEFSYM (Qfinalizer, "finalizer");
3556 DEFSYM (Qfloat, "float");
3557 DEFSYM (Qwindow_configuration, "window-configuration");
3558 DEFSYM (Qprocess, "process");
3559 DEFSYM (Qwindow, "window");
3560 DEFSYM (Qcompiled_function, "compiled-function");
3561 DEFSYM (Qbuffer, "buffer");
3562 DEFSYM (Qframe, "frame");
3563 DEFSYM (Qvector, "vector");
3564 DEFSYM (Qchar_table, "char-table");
3565 DEFSYM (Qbool_vector, "bool-vector");
3566 DEFSYM (Qhash_table, "hash-table");
3568 DEFSYM (Qdefun, "defun");
3570 DEFSYM (Qfont_spec, "font-spec");
3571 DEFSYM (Qfont_entity, "font-entity");
3572 DEFSYM (Qfont_object, "font-object");
3574 DEFSYM (Qinteractive_form, "interactive-form");
3575 DEFSYM (Qdefalias_fset_function, "defalias-fset-function");
3577 defsubr (&Sindirect_variable);
3578 defsubr (&Sinteractive_form);
3579 defsubr (&Seq);
3580 defsubr (&Snull);
3581 defsubr (&Stype_of);
3582 defsubr (&Slistp);
3583 defsubr (&Snlistp);
3584 defsubr (&Sconsp);
3585 defsubr (&Satom);
3586 defsubr (&Sintegerp);
3587 defsubr (&Sinteger_or_marker_p);
3588 defsubr (&Snumberp);
3589 defsubr (&Snumber_or_marker_p);
3590 defsubr (&Sfloatp);
3591 defsubr (&Snatnump);
3592 defsubr (&Ssymbolp);
3593 defsubr (&Skeywordp);
3594 defsubr (&Sstringp);
3595 defsubr (&Smultibyte_string_p);
3596 defsubr (&Svectorp);
3597 defsubr (&Schar_table_p);
3598 defsubr (&Svector_or_char_table_p);
3599 defsubr (&Sbool_vector_p);
3600 defsubr (&Sarrayp);
3601 defsubr (&Ssequencep);
3602 defsubr (&Sbufferp);
3603 defsubr (&Smarkerp);
3604 defsubr (&Ssubrp);
3605 defsubr (&Sbyte_code_function_p);
3606 defsubr (&Schar_or_string_p);
3607 defsubr (&Scar);
3608 defsubr (&Scdr);
3609 defsubr (&Scar_safe);
3610 defsubr (&Scdr_safe);
3611 defsubr (&Ssetcar);
3612 defsubr (&Ssetcdr);
3613 defsubr (&Ssymbol_function);
3614 defsubr (&Sindirect_function);
3615 defsubr (&Ssymbol_plist);
3616 defsubr (&Ssymbol_name);
3617 defsubr (&Smakunbound);
3618 defsubr (&Sfmakunbound);
3619 defsubr (&Sboundp);
3620 defsubr (&Sfboundp);
3621 defsubr (&Sfset);
3622 defsubr (&Sdefalias);
3623 defsubr (&Ssetplist);
3624 defsubr (&Ssymbol_value);
3625 defsubr (&Sset);
3626 defsubr (&Sdefault_boundp);
3627 defsubr (&Sdefault_value);
3628 defsubr (&Sset_default);
3629 defsubr (&Ssetq_default);
3630 defsubr (&Smake_variable_buffer_local);
3631 defsubr (&Smake_local_variable);
3632 defsubr (&Skill_local_variable);
3633 defsubr (&Smake_variable_frame_local);
3634 defsubr (&Slocal_variable_p);
3635 defsubr (&Slocal_variable_if_set_p);
3636 defsubr (&Svariable_binding_locus);
3637 #if 0 /* XXX Remove this. --lorentey */
3638 defsubr (&Sterminal_local_value);
3639 defsubr (&Sset_terminal_local_value);
3640 #endif
3641 defsubr (&Saref);
3642 defsubr (&Saset);
3643 defsubr (&Snumber_to_string);
3644 defsubr (&Sstring_to_number);
3645 defsubr (&Seqlsign);
3646 defsubr (&Slss);
3647 defsubr (&Sgtr);
3648 defsubr (&Sleq);
3649 defsubr (&Sgeq);
3650 defsubr (&Sneq);
3651 defsubr (&Splus);
3652 defsubr (&Sminus);
3653 defsubr (&Stimes);
3654 defsubr (&Squo);
3655 defsubr (&Srem);
3656 defsubr (&Smod);
3657 defsubr (&Smax);
3658 defsubr (&Smin);
3659 defsubr (&Slogand);
3660 defsubr (&Slogior);
3661 defsubr (&Slogxor);
3662 defsubr (&Slsh);
3663 defsubr (&Sash);
3664 defsubr (&Sadd1);
3665 defsubr (&Ssub1);
3666 defsubr (&Slognot);
3667 defsubr (&Sbyteorder);
3668 defsubr (&Ssubr_arity);
3669 defsubr (&Ssubr_name);
3671 defsubr (&Sbool_vector_exclusive_or);
3672 defsubr (&Sbool_vector_union);
3673 defsubr (&Sbool_vector_intersection);
3674 defsubr (&Sbool_vector_set_difference);
3675 defsubr (&Sbool_vector_not);
3676 defsubr (&Sbool_vector_subsetp);
3677 defsubr (&Sbool_vector_count_consecutive);
3678 defsubr (&Sbool_vector_count_population);
3680 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3682 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3683 doc: /* The largest value that is representable in a Lisp integer. */);
3684 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3685 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3687 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3688 doc: /* The smallest value that is representable in a Lisp integer. */);
3689 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3690 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;