Avoid compilation warnings with GCC 7 on MS-Windows
[emacs.git] / src / data.c
blobfeca0a6f376089cc28a36445fee19110e9dcc26b
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2017 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 (at
10 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 <https://www.gnu.org/licenses/>. */
21 #include <config.h>
23 #include <math.h>
24 #include <stdio.h>
26 #include <byteswap.h>
27 #include <count-one-bits.h>
28 #include <count-trailing-zeros.h>
29 #include <intprops.h>
31 #include "lisp.h"
32 #include "puresize.h"
33 #include "character.h"
34 #include "buffer.h"
35 #include "keyboard.h"
36 #include "process.h"
37 #include "frame.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 _Noreturn void
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);
175 void
176 circular_list (Lisp_Object list)
178 xsignal1 (Qcircular_list, list);
182 /* Data type predicates. */
184 DEFUN ("eq", Feq, Seq, 2, 2, 0,
185 doc: /* Return t if the two args are the same Lisp object. */
186 attributes: const)
187 (Lisp_Object obj1, Lisp_Object obj2)
189 if (EQ (obj1, obj2))
190 return Qt;
191 return Qnil;
194 DEFUN ("null", Fnull, Snull, 1, 1, 0,
195 doc: /* Return t if OBJECT is nil, and return nil otherwise. */
196 attributes: const)
197 (Lisp_Object object)
199 if (NILP (object))
200 return Qt;
201 return Qnil;
204 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
205 doc: /* Return a symbol representing the type of OBJECT.
206 The symbol returned names the object's basic type;
207 for example, (type-of 1) returns `integer'. */)
208 (Lisp_Object object)
210 switch (XTYPE (object))
212 case_Lisp_Int:
213 return Qinteger;
215 case Lisp_Symbol:
216 return Qsymbol;
218 case Lisp_String:
219 return Qstring;
221 case Lisp_Cons:
222 return Qcons;
224 case Lisp_Misc:
225 switch (XMISCTYPE (object))
227 case Lisp_Misc_Marker:
228 return Qmarker;
229 case Lisp_Misc_Overlay:
230 return Qoverlay;
231 case Lisp_Misc_Finalizer:
232 return Qfinalizer;
233 #ifdef HAVE_MODULES
234 case Lisp_Misc_User_Ptr:
235 return Quser_ptr;
236 #endif
237 default:
238 emacs_abort ();
241 case Lisp_Vectorlike:
242 switch (PSEUDOVECTOR_TYPE (XVECTOR (object)))
244 case PVEC_NORMAL_VECTOR: return Qvector;
245 case PVEC_WINDOW_CONFIGURATION: return Qwindow_configuration;
246 case PVEC_PROCESS: return Qprocess;
247 case PVEC_WINDOW: return Qwindow;
248 case PVEC_SUBR: return Qsubr;
249 case PVEC_COMPILED: return Qcompiled_function;
250 case PVEC_BUFFER: return Qbuffer;
251 case PVEC_CHAR_TABLE: return Qchar_table;
252 case PVEC_BOOL_VECTOR: return Qbool_vector;
253 case PVEC_FRAME: return Qframe;
254 case PVEC_HASH_TABLE: return Qhash_table;
255 case PVEC_FONT:
256 if (FONT_SPEC_P (object))
257 return Qfont_spec;
258 if (FONT_ENTITY_P (object))
259 return Qfont_entity;
260 if (FONT_OBJECT_P (object))
261 return Qfont_object;
262 else
263 emacs_abort (); /* return Qfont? */
264 case PVEC_THREAD: return Qthread;
265 case PVEC_MUTEX: return Qmutex;
266 case PVEC_CONDVAR: return Qcondition_variable;
267 case PVEC_TERMINAL: return Qterminal;
268 case PVEC_RECORD:
270 Lisp_Object t = AREF (object, 0);
271 if (RECORDP (t) && 1 < PVSIZE (t))
272 /* Return the type name field of the class! */
273 return AREF (t, 1);
274 else
275 return t;
277 case PVEC_MODULE_FUNCTION:
278 return Qmodule_function;
279 /* "Impossible" cases. */
280 case PVEC_XWIDGET:
281 case PVEC_OTHER:
282 case PVEC_XWIDGET_VIEW:
283 case PVEC_SUB_CHAR_TABLE:
284 case PVEC_FREE: ;
286 emacs_abort ();
288 case Lisp_Float:
289 return Qfloat;
291 default:
292 emacs_abort ();
296 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
297 doc: /* Return t if OBJECT is a cons cell. */
298 attributes: const)
299 (Lisp_Object object)
301 if (CONSP (object))
302 return Qt;
303 return Qnil;
306 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
307 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */
308 attributes: const)
309 (Lisp_Object object)
311 if (CONSP (object))
312 return Qnil;
313 return Qt;
316 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
317 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
318 Otherwise, return nil. */
319 attributes: const)
320 (Lisp_Object object)
322 if (CONSP (object) || NILP (object))
323 return Qt;
324 return Qnil;
327 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
328 doc: /* Return t if OBJECT is not a list. Lists include nil. */
329 attributes: const)
330 (Lisp_Object object)
332 if (CONSP (object) || NILP (object))
333 return Qnil;
334 return Qt;
337 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
338 doc: /* Return t if OBJECT is a symbol. */
339 attributes: const)
340 (Lisp_Object object)
342 if (SYMBOLP (object))
343 return Qt;
344 return Qnil;
347 /* Define this in C to avoid unnecessarily consing up the symbol
348 name. */
349 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
350 doc: /* Return t if OBJECT is a keyword.
351 This means that it is a symbol with a print name beginning with `:'
352 interned in the initial obarray. */)
353 (Lisp_Object object)
355 if (SYMBOLP (object)
356 && SREF (SYMBOL_NAME (object), 0) == ':'
357 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
358 return Qt;
359 return Qnil;
362 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
363 doc: /* Return t if OBJECT is a vector. */)
364 (Lisp_Object object)
366 if (VECTORP (object))
367 return Qt;
368 return Qnil;
371 DEFUN ("recordp", Frecordp, Srecordp, 1, 1, 0,
372 doc: /* Return t if OBJECT is a record. */)
373 (Lisp_Object object)
375 if (RECORDP (object))
376 return Qt;
377 return Qnil;
380 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
381 doc: /* Return t if OBJECT is a string. */
382 attributes: const)
383 (Lisp_Object object)
385 if (STRINGP (object))
386 return Qt;
387 return Qnil;
390 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
391 1, 1, 0,
392 doc: /* Return t if OBJECT is a multibyte string.
393 Return nil if OBJECT is either a unibyte string, or not a string. */)
394 (Lisp_Object object)
396 if (STRINGP (object) && STRING_MULTIBYTE (object))
397 return Qt;
398 return Qnil;
401 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
402 doc: /* Return t if OBJECT is a char-table. */)
403 (Lisp_Object object)
405 if (CHAR_TABLE_P (object))
406 return Qt;
407 return Qnil;
410 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
411 Svector_or_char_table_p, 1, 1, 0,
412 doc: /* Return t if OBJECT is a char-table or vector. */)
413 (Lisp_Object object)
415 if (VECTORP (object) || CHAR_TABLE_P (object))
416 return Qt;
417 return Qnil;
420 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
421 doc: /* Return t if OBJECT is a bool-vector. */)
422 (Lisp_Object object)
424 if (BOOL_VECTOR_P (object))
425 return Qt;
426 return Qnil;
429 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
430 doc: /* Return t if OBJECT is an array (string or vector). */)
431 (Lisp_Object object)
433 if (ARRAYP (object))
434 return Qt;
435 return Qnil;
438 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
439 doc: /* Return t if OBJECT is a sequence (list or array). */)
440 (register Lisp_Object object)
442 if (CONSP (object) || NILP (object) || ARRAYP (object))
443 return Qt;
444 return Qnil;
447 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
448 doc: /* Return t if OBJECT is an editor buffer. */)
449 (Lisp_Object object)
451 if (BUFFERP (object))
452 return Qt;
453 return Qnil;
456 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
457 doc: /* Return t if OBJECT is a marker (editor pointer). */)
458 (Lisp_Object object)
460 if (MARKERP (object))
461 return Qt;
462 return Qnil;
465 #ifdef HAVE_MODULES
466 DEFUN ("user-ptrp", Fuser_ptrp, Suser_ptrp, 1, 1, 0,
467 doc: /* Return t if OBJECT is a module user pointer. */)
468 (Lisp_Object object)
470 if (USER_PTRP (object))
471 return Qt;
472 return Qnil;
474 #endif
476 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
477 doc: /* Return t if OBJECT is a built-in function. */)
478 (Lisp_Object object)
480 if (SUBRP (object))
481 return Qt;
482 return Qnil;
485 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
486 1, 1, 0,
487 doc: /* Return t if OBJECT is a byte-compiled function object. */)
488 (Lisp_Object object)
490 if (COMPILEDP (object))
491 return Qt;
492 return Qnil;
495 DEFUN ("module-function-p", Fmodule_function_p, Smodule_function_p, 1, 1, NULL,
496 doc: /* Return t if OBJECT is a function loaded from a dynamic module. */
497 attributes: const)
498 (Lisp_Object object)
500 return MODULE_FUNCTIONP (object) ? Qt : Qnil;
503 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
504 doc: /* Return t if OBJECT is a character or a string. */
505 attributes: const)
506 (register Lisp_Object object)
508 if (CHARACTERP (object) || STRINGP (object))
509 return Qt;
510 return Qnil;
513 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
514 doc: /* Return t if OBJECT is an integer. */
515 attributes: const)
516 (Lisp_Object object)
518 if (INTEGERP (object))
519 return Qt;
520 return Qnil;
523 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
524 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
525 (register Lisp_Object object)
527 if (MARKERP (object) || INTEGERP (object))
528 return Qt;
529 return Qnil;
532 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
533 doc: /* Return t if OBJECT is a nonnegative integer. */
534 attributes: const)
535 (Lisp_Object object)
537 if (NATNUMP (object))
538 return Qt;
539 return Qnil;
542 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
543 doc: /* Return t if OBJECT is a number (floating point or integer). */
544 attributes: const)
545 (Lisp_Object object)
547 if (NUMBERP (object))
548 return Qt;
549 else
550 return Qnil;
553 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
554 Snumber_or_marker_p, 1, 1, 0,
555 doc: /* Return t if OBJECT is a number or a marker. */)
556 (Lisp_Object object)
558 if (NUMBERP (object) || MARKERP (object))
559 return Qt;
560 return Qnil;
563 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
564 doc: /* Return t if OBJECT is a floating point number. */
565 attributes: const)
566 (Lisp_Object object)
568 if (FLOATP (object))
569 return Qt;
570 return Qnil;
573 DEFUN ("threadp", Fthreadp, Sthreadp, 1, 1, 0,
574 doc: /* Return t if OBJECT is a thread. */)
575 (Lisp_Object object)
577 if (THREADP (object))
578 return Qt;
579 return Qnil;
582 DEFUN ("mutexp", Fmutexp, Smutexp, 1, 1, 0,
583 doc: /* Return t if OBJECT is a mutex. */)
584 (Lisp_Object object)
586 if (MUTEXP (object))
587 return Qt;
588 return Qnil;
591 DEFUN ("condition-variable-p", Fcondition_variable_p, Scondition_variable_p,
592 1, 1, 0,
593 doc: /* Return t if OBJECT is a condition variable. */)
594 (Lisp_Object object)
596 if (CONDVARP (object))
597 return Qt;
598 return Qnil;
601 /* Extract and set components of lists. */
603 DEFUN ("car", Fcar, Scar, 1, 1, 0,
604 doc: /* Return the car of LIST. If arg is nil, return nil.
605 Error if arg is not nil and not a cons cell. See also `car-safe'.
607 See Info node `(elisp)Cons Cells' for a discussion of related basic
608 Lisp concepts such as car, cdr, cons cell and list. */)
609 (register Lisp_Object list)
611 return CAR (list);
614 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
615 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
616 (Lisp_Object object)
618 return CAR_SAFE (object);
621 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
622 doc: /* Return the cdr of LIST. If arg is nil, return nil.
623 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
625 See Info node `(elisp)Cons Cells' for a discussion of related basic
626 Lisp concepts such as cdr, car, cons cell and list. */)
627 (register Lisp_Object list)
629 return CDR (list);
632 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
633 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
634 (Lisp_Object object)
636 return CDR_SAFE (object);
639 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
640 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
641 (register Lisp_Object cell, Lisp_Object newcar)
643 CHECK_CONS (cell);
644 CHECK_IMPURE (cell, XCONS (cell));
645 XSETCAR (cell, newcar);
646 return newcar;
649 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
650 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
651 (register Lisp_Object cell, Lisp_Object newcdr)
653 CHECK_CONS (cell);
654 CHECK_IMPURE (cell, XCONS (cell));
655 XSETCDR (cell, newcdr);
656 return newcdr;
659 /* Extract and set components of symbols. */
661 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
662 doc: /* Return t if SYMBOL's value is not void.
663 Note that if `lexical-binding' is in effect, this refers to the
664 global value outside of any lexical scope. */)
665 (register Lisp_Object symbol)
667 Lisp_Object valcontents;
668 struct Lisp_Symbol *sym;
669 CHECK_SYMBOL (symbol);
670 sym = XSYMBOL (symbol);
672 start:
673 switch (sym->redirect)
675 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
676 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
677 case SYMBOL_LOCALIZED:
679 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
680 if (blv->fwd)
681 /* In set_internal, we un-forward vars when their value is
682 set to Qunbound. */
683 return Qt;
684 else
686 swap_in_symval_forwarding (sym, blv);
687 valcontents = blv_value (blv);
689 break;
691 case SYMBOL_FORWARDED:
692 /* In set_internal, we un-forward vars when their value is
693 set to Qunbound. */
694 return Qt;
695 default: emacs_abort ();
698 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
701 /* It has been previously suggested to make this function an alias for
702 symbol-function, but upon discussion at Bug#23957, there is a risk
703 breaking backward compatibility, as some users of fboundp may
704 expect `t' in particular, rather than any true value. */
705 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
706 doc: /* Return t if SYMBOL's function definition is not void. */)
707 (register Lisp_Object symbol)
709 CHECK_SYMBOL (symbol);
710 return NILP (XSYMBOL (symbol)->function) ? Qnil : Qt;
713 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
714 doc: /* Make SYMBOL's value be void.
715 Return SYMBOL. */)
716 (register Lisp_Object symbol)
718 CHECK_SYMBOL (symbol);
719 if (SYMBOL_CONSTANT_P (symbol))
720 xsignal1 (Qsetting_constant, symbol);
721 Fset (symbol, Qunbound);
722 return symbol;
725 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
726 doc: /* Make SYMBOL's function definition be nil.
727 Return SYMBOL. */)
728 (register Lisp_Object symbol)
730 CHECK_SYMBOL (symbol);
731 if (NILP (symbol) || EQ (symbol, Qt))
732 xsignal1 (Qsetting_constant, symbol);
733 set_symbol_function (symbol, Qnil);
734 return symbol;
737 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
738 doc: /* Return SYMBOL's function definition, or nil if that is void. */)
739 (register Lisp_Object symbol)
741 CHECK_SYMBOL (symbol);
742 return XSYMBOL (symbol)->function;
745 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
746 doc: /* Return SYMBOL's property list. */)
747 (register Lisp_Object symbol)
749 CHECK_SYMBOL (symbol);
750 return XSYMBOL (symbol)->plist;
753 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
754 doc: /* Return SYMBOL's name, a string. */)
755 (register Lisp_Object symbol)
757 register Lisp_Object name;
759 CHECK_SYMBOL (symbol);
760 name = SYMBOL_NAME (symbol);
761 return name;
764 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
765 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
766 (register Lisp_Object symbol, Lisp_Object definition)
768 register Lisp_Object function;
769 CHECK_SYMBOL (symbol);
770 /* Perhaps not quite the right error signal, but seems good enough. */
771 if (NILP (symbol))
772 xsignal1 (Qsetting_constant, symbol);
774 function = XSYMBOL (symbol)->function;
776 if (!NILP (Vautoload_queue) && !NILP (function))
777 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
779 if (AUTOLOADP (function))
780 Fput (symbol, Qautoload, XCDR (function));
782 /* Convert to eassert or remove after GC bug is found. In the
783 meantime, check unconditionally, at a slight perf hit. */
784 if (! valid_lisp_object_p (definition))
785 emacs_abort ();
787 set_symbol_function (symbol, definition);
789 return definition;
792 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
793 doc: /* Set SYMBOL's function definition to DEFINITION.
794 Associates the function with the current load file, if any.
795 The optional third argument DOCSTRING specifies the documentation string
796 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
797 determined by DEFINITION.
799 Internally, this normally uses `fset', but if SYMBOL has a
800 `defalias-fset-function' property, the associated value is used instead.
802 The return value is undefined. */)
803 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
805 CHECK_SYMBOL (symbol);
806 if (!NILP (Vpurify_flag)
807 /* If `definition' is a keymap, immutable (and copying) is wrong. */
808 && !KEYMAPP (definition))
809 definition = Fpurecopy (definition);
812 bool autoload = AUTOLOADP (definition);
813 if (NILP (Vpurify_flag) || !autoload)
814 { /* Only add autoload entries after dumping, because the ones before are
815 not useful and else we get loads of them from the loaddefs.el. */
817 if (AUTOLOADP (XSYMBOL (symbol)->function))
818 /* Remember that the function was already an autoload. */
819 LOADHIST_ATTACH (Fcons (Qt, symbol));
820 LOADHIST_ATTACH (Fcons (autoload ? Qautoload : Qdefun, symbol));
824 { /* Handle automatic advice activation. */
825 Lisp_Object hook = Fget (symbol, Qdefalias_fset_function);
826 if (!NILP (hook))
827 call2 (hook, symbol, definition);
828 else
829 Ffset (symbol, definition);
832 if (!NILP (docstring))
833 Fput (symbol, Qfunction_documentation, docstring);
834 /* We used to return `definition', but now that `defun' and `defmacro' expand
835 to a call to `defalias', we return `symbol' for backward compatibility
836 (bug#11686). */
837 return symbol;
840 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
841 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
842 (register Lisp_Object symbol, Lisp_Object newplist)
844 CHECK_SYMBOL (symbol);
845 set_symbol_plist (symbol, newplist);
846 return newplist;
849 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
850 doc: /* Return minimum and maximum number of args allowed for SUBR.
851 SUBR must be a built-in function.
852 The returned value is a pair (MIN . MAX). MIN is the minimum number
853 of args. MAX is the maximum number or the symbol `many', for a
854 function with `&rest' args, or `unevalled' for a special form. */)
855 (Lisp_Object subr)
857 short minargs, maxargs;
858 CHECK_SUBR (subr);
859 minargs = XSUBR (subr)->min_args;
860 maxargs = XSUBR (subr)->max_args;
861 return Fcons (make_number (minargs),
862 maxargs == MANY ? Qmany
863 : maxargs == UNEVALLED ? Qunevalled
864 : make_number (maxargs));
867 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
868 doc: /* Return name of subroutine SUBR.
869 SUBR must be a built-in function. */)
870 (Lisp_Object subr)
872 const char *name;
873 CHECK_SUBR (subr);
874 name = XSUBR (subr)->symbol_name;
875 return build_string (name);
878 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
879 doc: /* Return the interactive form of CMD or nil if none.
880 If CMD is not a command, the return value is nil.
881 Value, if non-nil, is a list (interactive SPEC). */)
882 (Lisp_Object cmd)
884 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
886 if (NILP (fun))
887 return Qnil;
889 /* Use an `interactive-form' property if present, analogous to the
890 function-documentation property. */
891 fun = cmd;
892 while (SYMBOLP (fun))
894 Lisp_Object tmp = Fget (fun, Qinteractive_form);
895 if (!NILP (tmp))
896 return tmp;
897 else
898 fun = Fsymbol_function (fun);
901 if (SUBRP (fun))
903 const char *spec = XSUBR (fun)->intspec;
904 if (spec)
905 return list2 (Qinteractive,
906 (*spec != '(') ? build_string (spec) :
907 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
909 else if (COMPILEDP (fun))
911 if (PVSIZE (fun) > COMPILED_INTERACTIVE)
912 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
914 else if (AUTOLOADP (fun))
915 return Finteractive_form (Fautoload_do_load (fun, cmd, Qnil));
916 else if (CONSP (fun))
918 Lisp_Object funcar = XCAR (fun);
919 if (EQ (funcar, Qclosure))
920 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
921 else if (EQ (funcar, Qlambda))
922 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
924 return Qnil;
928 /***********************************************************************
929 Getting and Setting Values of Symbols
930 ***********************************************************************/
932 /* Return the symbol holding SYMBOL's value. Signal
933 `cyclic-variable-indirection' if SYMBOL's chain of variable
934 indirections contains a loop. */
936 struct Lisp_Symbol *
937 indirect_variable (struct Lisp_Symbol *symbol)
939 struct Lisp_Symbol *tortoise, *hare;
941 hare = tortoise = symbol;
943 while (hare->redirect == SYMBOL_VARALIAS)
945 hare = SYMBOL_ALIAS (hare);
946 if (hare->redirect != SYMBOL_VARALIAS)
947 break;
949 hare = SYMBOL_ALIAS (hare);
950 tortoise = SYMBOL_ALIAS (tortoise);
952 if (hare == tortoise)
954 Lisp_Object tem;
955 XSETSYMBOL (tem, symbol);
956 xsignal1 (Qcyclic_variable_indirection, tem);
960 return hare;
964 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
965 doc: /* Return the variable at the end of OBJECT's variable chain.
966 If OBJECT is a symbol, follow its variable indirections (if any), and
967 return the variable at the end of the chain of aliases. See Info node
968 `(elisp)Variable Aliases'.
970 If OBJECT is not a symbol, just return it. If there is a loop in the
971 chain of aliases, signal a `cyclic-variable-indirection' error. */)
972 (Lisp_Object object)
974 if (SYMBOLP (object))
976 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
977 XSETSYMBOL (object, sym);
979 return object;
983 /* Given the raw contents of a symbol value cell,
984 return the Lisp value of the symbol.
985 This does not handle buffer-local variables; use
986 swap_in_symval_forwarding for that. */
988 Lisp_Object
989 do_symval_forwarding (register union Lisp_Fwd *valcontents)
991 register Lisp_Object val;
992 switch (XFWDTYPE (valcontents))
994 case Lisp_Fwd_Int:
995 XSETINT (val, *XINTFWD (valcontents)->intvar);
996 return val;
998 case Lisp_Fwd_Bool:
999 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
1001 case Lisp_Fwd_Obj:
1002 return *XOBJFWD (valcontents)->objvar;
1004 case Lisp_Fwd_Buffer_Obj:
1005 return per_buffer_value (current_buffer,
1006 XBUFFER_OBJFWD (valcontents)->offset);
1008 case Lisp_Fwd_Kboard_Obj:
1009 /* We used to simply use current_kboard here, but from Lisp
1010 code, its value is often unexpected. It seems nicer to
1011 allow constructions like this to work as intuitively expected:
1013 (with-selected-frame frame
1014 (define-key local-function-map "\eOP" [f1]))
1016 On the other hand, this affects the semantics of
1017 last-command and real-last-command, and people may rely on
1018 that. I took a quick look at the Lisp codebase, and I
1019 don't think anything will break. --lorentey */
1020 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
1021 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
1022 default: emacs_abort ();
1026 /* Used to signal a user-friendly error when symbol WRONG is
1027 not a member of CHOICE, which should be a list of symbols. */
1029 void
1030 wrong_choice (Lisp_Object choice, Lisp_Object wrong)
1032 ptrdiff_t i = 0, len = XINT (Flength (choice));
1033 Lisp_Object obj, *args;
1034 AUTO_STRING (one_of, "One of ");
1035 AUTO_STRING (comma, ", ");
1036 AUTO_STRING (or, " or ");
1037 AUTO_STRING (should_be_specified, " should be specified");
1039 USE_SAFE_ALLOCA;
1040 SAFE_ALLOCA_LISP (args, len * 2 + 1);
1042 args[i++] = one_of;
1044 for (obj = choice; !NILP (obj); obj = XCDR (obj))
1046 args[i++] = SYMBOL_NAME (XCAR (obj));
1047 args[i++] = (NILP (XCDR (obj)) ? should_be_specified
1048 : NILP (XCDR (XCDR (obj))) ? or : comma);
1051 obj = Fconcat (i, args);
1052 SAFE_FREE ();
1053 xsignal2 (Qerror, obj, wrong);
1056 /* Used to signal a user-friendly error if WRONG is not a number or
1057 integer/floating-point number outsize of inclusive MIN..MAX range. */
1059 static void
1060 wrong_range (Lisp_Object min, Lisp_Object max, Lisp_Object wrong)
1062 AUTO_STRING (value_should_be_from, "Value should be from ");
1063 AUTO_STRING (to, " to ");
1064 xsignal2 (Qerror,
1065 CALLN (Fconcat, value_should_be_from, Fnumber_to_string (min),
1066 to, Fnumber_to_string (max)),
1067 wrong);
1070 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
1071 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
1072 buffer-independent contents of the value cell: forwarded just one
1073 step past the buffer-localness.
1075 BUF non-zero means set the value in buffer BUF instead of the
1076 current buffer. This only plays a role for per-buffer variables. */
1078 static void
1079 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
1081 switch (XFWDTYPE (valcontents))
1083 case Lisp_Fwd_Int:
1084 CHECK_NUMBER (newval);
1085 *XINTFWD (valcontents)->intvar = XINT (newval);
1086 break;
1088 case Lisp_Fwd_Bool:
1089 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
1090 break;
1092 case Lisp_Fwd_Obj:
1093 *XOBJFWD (valcontents)->objvar = newval;
1095 /* If this variable is a default for something stored
1096 in the buffer itself, such as default-fill-column,
1097 find the buffers that don't have local values for it
1098 and update them. */
1099 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
1100 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
1102 int offset = ((char *) XOBJFWD (valcontents)->objvar
1103 - (char *) &buffer_defaults);
1104 int idx = PER_BUFFER_IDX (offset);
1106 Lisp_Object tail, buf;
1108 if (idx <= 0)
1109 break;
1111 FOR_EACH_LIVE_BUFFER (tail, buf)
1113 struct buffer *b = XBUFFER (buf);
1115 if (! PER_BUFFER_VALUE_P (b, idx))
1116 set_per_buffer_value (b, offset, newval);
1119 break;
1121 case Lisp_Fwd_Buffer_Obj:
1123 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1124 Lisp_Object predicate = XBUFFER_OBJFWD (valcontents)->predicate;
1126 if (!NILP (newval))
1128 if (SYMBOLP (predicate))
1130 Lisp_Object prop;
1132 if ((prop = Fget (predicate, Qchoice), !NILP (prop)))
1134 if (NILP (Fmemq (newval, prop)))
1135 wrong_choice (prop, newval);
1137 else if ((prop = Fget (predicate, Qrange), !NILP (prop)))
1139 Lisp_Object min = XCAR (prop), max = XCDR (prop);
1140 if (! NUMBERP (newval)
1141 || NILP (CALLN (Fleq, min, newval, max)))
1142 wrong_range (min, max, newval);
1144 else if (FUNCTIONP (predicate))
1146 if (NILP (call1 (predicate, newval)))
1147 wrong_type_argument (predicate, newval);
1151 if (buf == NULL)
1152 buf = current_buffer;
1153 set_per_buffer_value (buf, offset, newval);
1155 break;
1157 case Lisp_Fwd_Kboard_Obj:
1159 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
1160 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
1161 *(Lisp_Object *) p = newval;
1163 break;
1165 default:
1166 emacs_abort (); /* goto def; */
1170 /* Set up SYMBOL to refer to its global binding. This makes it safe
1171 to alter the status of other bindings. BEWARE: this may be called
1172 during the mark phase of GC, where we assume that Lisp_Object slots
1173 of BLV are marked after this function has changed them. */
1175 void
1176 swap_in_global_binding (struct Lisp_Symbol *symbol)
1178 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
1180 /* Unload the previously loaded binding. */
1181 if (blv->fwd)
1182 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1184 /* Select the global binding in the symbol. */
1185 set_blv_valcell (blv, blv->defcell);
1186 if (blv->fwd)
1187 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
1189 /* Indicate that the global binding is set up now. */
1190 set_blv_where (blv, Qnil);
1191 set_blv_found (blv, 0);
1194 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
1195 VALCONTENTS is the contents of its value cell,
1196 which points to a struct Lisp_Buffer_Local_Value.
1198 Return the value forwarded one step past the buffer-local stage.
1199 This could be another forwarding pointer. */
1201 static void
1202 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1204 register Lisp_Object tem1;
1206 eassert (blv == SYMBOL_BLV (symbol));
1208 tem1 = blv->where;
1210 if (NILP (tem1)
1211 || current_buffer != XBUFFER (tem1))
1214 /* Unload the previously loaded binding. */
1215 tem1 = blv->valcell;
1216 if (blv->fwd)
1217 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1218 /* Choose the new binding. */
1220 Lisp_Object var;
1221 XSETSYMBOL (var, symbol);
1222 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1223 set_blv_where (blv, Fcurrent_buffer ());
1225 if (!(blv->found = !NILP (tem1)))
1226 tem1 = blv->defcell;
1228 /* Load the new binding. */
1229 set_blv_valcell (blv, tem1);
1230 if (blv->fwd)
1231 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1235 /* Find the value of a symbol, returning Qunbound if it's not bound.
1236 This is helpful for code which just wants to get a variable's value
1237 if it has one, without signaling an error.
1238 Note that it must not be possible to quit
1239 within this function. Great care is required for this. */
1241 Lisp_Object
1242 find_symbol_value (Lisp_Object symbol)
1244 struct Lisp_Symbol *sym;
1246 CHECK_SYMBOL (symbol);
1247 sym = XSYMBOL (symbol);
1249 start:
1250 switch (sym->redirect)
1252 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1253 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1254 case SYMBOL_LOCALIZED:
1256 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1257 swap_in_symval_forwarding (sym, blv);
1258 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1260 /* FALLTHROUGH */
1261 case SYMBOL_FORWARDED:
1262 return do_symval_forwarding (SYMBOL_FWD (sym));
1263 default: emacs_abort ();
1267 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1268 doc: /* Return SYMBOL's value. Error if that is void.
1269 Note that if `lexical-binding' is in effect, this returns the
1270 global value outside of any lexical scope. */)
1271 (Lisp_Object symbol)
1273 Lisp_Object val;
1275 val = find_symbol_value (symbol);
1276 if (!EQ (val, Qunbound))
1277 return val;
1279 xsignal1 (Qvoid_variable, symbol);
1282 DEFUN ("set", Fset, Sset, 2, 2, 0,
1283 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1284 (register Lisp_Object symbol, Lisp_Object newval)
1286 set_internal (symbol, newval, Qnil, SET_INTERNAL_SET);
1287 return newval;
1290 /* Store the value NEWVAL into SYMBOL.
1291 If buffer-locality is an issue, WHERE specifies which context to use.
1292 (nil stands for the current buffer/frame).
1294 If BINDFLAG is SET_INTERNAL_SET, then if this symbol is supposed to
1295 become local in every buffer where it is set, then we make it
1296 local. If BINDFLAG is SET_INTERNAL_BIND or SET_INTERNAL_UNBIND, we
1297 don't do that. */
1299 void
1300 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1301 enum Set_Internal_Bind bindflag)
1303 bool voide = EQ (newval, Qunbound);
1304 struct Lisp_Symbol *sym;
1305 Lisp_Object tem1;
1307 /* If restoring in a dead buffer, do nothing. */
1308 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1309 return; */
1311 CHECK_SYMBOL (symbol);
1312 sym = XSYMBOL (symbol);
1313 switch (sym->trapped_write)
1315 case SYMBOL_NOWRITE:
1316 if (NILP (Fkeywordp (symbol))
1317 || !EQ (newval, Fsymbol_value (symbol)))
1318 xsignal1 (Qsetting_constant, symbol);
1319 else
1320 /* Allow setting keywords to their own value. */
1321 return;
1323 case SYMBOL_TRAPPED_WRITE:
1324 /* Setting due to thread-switching doesn't count. */
1325 if (bindflag != SET_INTERNAL_THREAD_SWITCH)
1326 notify_variable_watchers (symbol, voide? Qnil : newval,
1327 (bindflag == SET_INTERNAL_BIND? Qlet :
1328 bindflag == SET_INTERNAL_UNBIND? Qunlet :
1329 voide? Qmakunbound : Qset),
1330 where);
1331 /* FALLTHROUGH! */
1332 case SYMBOL_UNTRAPPED_WRITE:
1333 break;
1335 default: emacs_abort ();
1338 start:
1339 switch (sym->redirect)
1341 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1342 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1343 case SYMBOL_LOCALIZED:
1345 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1346 if (NILP (where))
1347 XSETBUFFER (where, current_buffer);
1349 /* If the current buffer is not the buffer whose binding is
1350 loaded, or if it's a Lisp_Buffer_Local_Value and
1351 the default binding is loaded, the loaded binding may be the
1352 wrong one. */
1353 if (!EQ (blv->where, where)
1354 /* Also unload a global binding (if the var is local_if_set). */
1355 || (EQ (blv->valcell, blv->defcell)))
1357 /* The currently loaded binding is not necessarily valid.
1358 We need to unload it, and choose a new binding. */
1360 /* Write out `realvalue' to the old loaded binding. */
1361 if (blv->fwd)
1362 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1364 /* Find the new binding. */
1365 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1366 tem1 = assq_no_quit (symbol,
1367 BVAR (XBUFFER (where), local_var_alist));
1368 set_blv_where (blv, where);
1369 blv->found = 1;
1371 if (NILP (tem1))
1373 /* This buffer still sees the default value. */
1375 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1376 or if this is `let' rather than `set',
1377 make CURRENT-ALIST-ELEMENT point to itself,
1378 indicating that we're seeing the default value.
1379 Likewise if the variable has been let-bound
1380 in the current buffer. */
1381 if (bindflag || !blv->local_if_set
1382 || let_shadows_buffer_binding_p (sym))
1384 blv->found = 0;
1385 tem1 = blv->defcell;
1387 /* If it's a local_if_set, being set not bound,
1388 and we're not within a let that was made for this buffer,
1389 create a new buffer-local binding for the variable.
1390 That means, give this buffer a new assoc for a local value
1391 and load that binding. */
1392 else
1394 tem1 = Fcons (symbol, XCDR (blv->defcell));
1395 bset_local_var_alist
1396 (XBUFFER (where),
1397 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1401 /* Record which binding is now loaded. */
1402 set_blv_valcell (blv, tem1);
1405 /* Store the new value in the cons cell. */
1406 set_blv_value (blv, newval);
1408 if (blv->fwd)
1410 if (voide)
1411 /* If storing void (making the symbol void), forward only through
1412 buffer-local indicator, not through Lisp_Objfwd, etc. */
1413 blv->fwd = NULL;
1414 else
1415 store_symval_forwarding (blv->fwd, newval,
1416 BUFFERP (where)
1417 ? XBUFFER (where) : current_buffer);
1419 break;
1421 case SYMBOL_FORWARDED:
1423 struct buffer *buf
1424 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1425 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1426 if (BUFFER_OBJFWDP (innercontents))
1428 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1429 int idx = PER_BUFFER_IDX (offset);
1430 if (idx > 0
1431 && bindflag == SET_INTERNAL_SET
1432 && !let_shadows_buffer_binding_p (sym))
1433 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1436 if (voide)
1437 { /* If storing void (making the symbol void), forward only through
1438 buffer-local indicator, not through Lisp_Objfwd, etc. */
1439 sym->redirect = SYMBOL_PLAINVAL;
1440 SET_SYMBOL_VAL (sym, newval);
1442 else
1443 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1444 break;
1446 default: emacs_abort ();
1448 return;
1451 static void
1452 set_symbol_trapped_write (Lisp_Object symbol, enum symbol_trapped_write trap)
1454 struct Lisp_Symbol *sym = XSYMBOL (symbol);
1455 if (sym->trapped_write == SYMBOL_NOWRITE)
1456 xsignal1 (Qtrapping_constant, symbol);
1457 sym->trapped_write = trap;
1460 static void
1461 restore_symbol_trapped_write (Lisp_Object symbol)
1463 set_symbol_trapped_write (symbol, SYMBOL_TRAPPED_WRITE);
1466 static void
1467 harmonize_variable_watchers (Lisp_Object alias, Lisp_Object base_variable)
1469 if (!EQ (base_variable, alias)
1470 && EQ (base_variable, Findirect_variable (alias)))
1471 set_symbol_trapped_write
1472 (alias, XSYMBOL (base_variable)->trapped_write);
1475 DEFUN ("add-variable-watcher", Fadd_variable_watcher, Sadd_variable_watcher,
1476 2, 2, 0,
1477 doc: /* Cause WATCH-FUNCTION to be called when SYMBOL is set.
1479 It will be called with 4 arguments: (SYMBOL NEWVAL OPERATION WHERE).
1480 SYMBOL is the variable being changed.
1481 NEWVAL is the value it will be changed to.
1482 OPERATION is a symbol representing the kind of change, one of: `set',
1483 `let', `unlet', `makunbound', and `defvaralias'.
1484 WHERE is a buffer if the buffer-local value of the variable being
1485 changed, nil otherwise.
1487 All writes to aliases of SYMBOL will call WATCH-FUNCTION too. */)
1488 (Lisp_Object symbol, Lisp_Object watch_function)
1490 symbol = Findirect_variable (symbol);
1491 set_symbol_trapped_write (symbol, SYMBOL_TRAPPED_WRITE);
1492 map_obarray (Vobarray, harmonize_variable_watchers, symbol);
1494 Lisp_Object watchers = Fget (symbol, Qwatchers);
1495 Lisp_Object member = Fmember (watch_function, watchers);
1496 if (NILP (member))
1497 Fput (symbol, Qwatchers, Fcons (watch_function, watchers));
1498 return Qnil;
1501 DEFUN ("remove-variable-watcher", Fremove_variable_watcher, Sremove_variable_watcher,
1502 2, 2, 0,
1503 doc: /* Undo the effect of `add-variable-watcher'.
1504 Remove WATCH-FUNCTION from the list of functions to be called when
1505 SYMBOL (or its aliases) are set. */)
1506 (Lisp_Object symbol, Lisp_Object watch_function)
1508 symbol = Findirect_variable (symbol);
1509 Lisp_Object watchers = Fget (symbol, Qwatchers);
1510 watchers = Fdelete (watch_function, watchers);
1511 if (NILP (watchers))
1513 set_symbol_trapped_write (symbol, SYMBOL_UNTRAPPED_WRITE);
1514 map_obarray (Vobarray, harmonize_variable_watchers, symbol);
1516 Fput (symbol, Qwatchers, watchers);
1517 return Qnil;
1520 DEFUN ("get-variable-watchers", Fget_variable_watchers, Sget_variable_watchers,
1521 1, 1, 0,
1522 doc: /* Return a list of SYMBOL's active watchers. */)
1523 (Lisp_Object symbol)
1525 return (SYMBOL_TRAPPED_WRITE_P (symbol) == SYMBOL_TRAPPED_WRITE)
1526 ? Fget (Findirect_variable (symbol), Qwatchers)
1527 : Qnil;
1530 void
1531 notify_variable_watchers (Lisp_Object symbol,
1532 Lisp_Object newval,
1533 Lisp_Object operation,
1534 Lisp_Object where)
1536 symbol = Findirect_variable (symbol);
1538 ptrdiff_t count = SPECPDL_INDEX ();
1539 record_unwind_protect (restore_symbol_trapped_write, symbol);
1540 /* Avoid recursion. */
1541 set_symbol_trapped_write (symbol, SYMBOL_UNTRAPPED_WRITE);
1543 if (NILP (where)
1544 && !EQ (operation, Qset_default) && !EQ (operation, Qmakunbound)
1545 && !NILP (Flocal_variable_if_set_p (symbol, Fcurrent_buffer ())))
1547 XSETBUFFER (where, current_buffer);
1550 if (EQ (operation, Qset_default))
1551 operation = Qset;
1553 for (Lisp_Object watchers = Fget (symbol, Qwatchers);
1554 CONSP (watchers);
1555 watchers = XCDR (watchers))
1557 Lisp_Object watcher = XCAR (watchers);
1558 /* Call subr directly to avoid gc. */
1559 if (SUBRP (watcher))
1561 Lisp_Object args[] = { symbol, newval, operation, where };
1562 funcall_subr (XSUBR (watcher), ARRAYELTS (args), args);
1564 else
1565 CALLN (Ffuncall, watcher, symbol, newval, operation, where);
1568 unbind_to (count, Qnil);
1572 /* Access or set a buffer-local symbol's default value. */
1574 /* Return the default value of SYMBOL, but don't check for voidness.
1575 Return Qunbound if it is void. */
1577 static Lisp_Object
1578 default_value (Lisp_Object symbol)
1580 struct Lisp_Symbol *sym;
1582 CHECK_SYMBOL (symbol);
1583 sym = XSYMBOL (symbol);
1585 start:
1586 switch (sym->redirect)
1588 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1589 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1590 case SYMBOL_LOCALIZED:
1592 /* If var is set up for a buffer that lacks a local value for it,
1593 the current value is nominally the default value.
1594 But the `realvalue' slot may be more up to date, since
1595 ordinary setq stores just that slot. So use that. */
1596 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1597 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1598 return do_symval_forwarding (blv->fwd);
1599 else
1600 return XCDR (blv->defcell);
1602 case SYMBOL_FORWARDED:
1604 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1606 /* For a built-in buffer-local variable, get the default value
1607 rather than letting do_symval_forwarding get the current value. */
1608 if (BUFFER_OBJFWDP (valcontents))
1610 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1611 if (PER_BUFFER_IDX (offset) != 0)
1612 return per_buffer_default (offset);
1615 /* For other variables, get the current value. */
1616 return do_symval_forwarding (valcontents);
1618 default: emacs_abort ();
1622 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1623 doc: /* Return t if SYMBOL has a non-void default value.
1624 This is the value that is seen in buffers that do not have their own values
1625 for this variable. */)
1626 (Lisp_Object symbol)
1628 register Lisp_Object value;
1630 value = default_value (symbol);
1631 return (EQ (value, Qunbound) ? Qnil : Qt);
1634 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1635 doc: /* Return SYMBOL's default value.
1636 This is the value that is seen in buffers that do not have their own values
1637 for this variable. The default value is meaningful for variables with
1638 local bindings in certain buffers. */)
1639 (Lisp_Object symbol)
1641 Lisp_Object value = default_value (symbol);
1642 if (!EQ (value, Qunbound))
1643 return value;
1645 xsignal1 (Qvoid_variable, symbol);
1648 void
1649 set_default_internal (Lisp_Object symbol, Lisp_Object value,
1650 enum Set_Internal_Bind bindflag)
1652 struct Lisp_Symbol *sym;
1654 CHECK_SYMBOL (symbol);
1655 sym = XSYMBOL (symbol);
1656 switch (sym->trapped_write)
1658 case SYMBOL_NOWRITE:
1659 if (NILP (Fkeywordp (symbol))
1660 || !EQ (value, Fsymbol_value (symbol)))
1661 xsignal1 (Qsetting_constant, symbol);
1662 else
1663 /* Allow setting keywords to their own value. */
1664 return;
1666 case SYMBOL_TRAPPED_WRITE:
1667 /* Don't notify here if we're going to call Fset anyway. */
1668 if (sym->redirect != SYMBOL_PLAINVAL
1669 /* Setting due to thread switching doesn't count. */
1670 && bindflag != SET_INTERNAL_THREAD_SWITCH)
1671 notify_variable_watchers (symbol, value, Qset_default, Qnil);
1672 /* FALLTHROUGH! */
1673 case SYMBOL_UNTRAPPED_WRITE:
1674 break;
1676 default: emacs_abort ();
1679 start:
1680 switch (sym->redirect)
1682 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1683 case SYMBOL_PLAINVAL: set_internal (symbol, value, Qnil, bindflag); return;
1684 case SYMBOL_LOCALIZED:
1686 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1688 /* Store new value into the DEFAULT-VALUE slot. */
1689 XSETCDR (blv->defcell, value);
1691 /* If the default binding is now loaded, set the REALVALUE slot too. */
1692 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1693 store_symval_forwarding (blv->fwd, value, NULL);
1694 return;
1696 case SYMBOL_FORWARDED:
1698 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1700 /* Handle variables like case-fold-search that have special slots
1701 in the buffer.
1702 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1703 if (BUFFER_OBJFWDP (valcontents))
1705 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1706 int idx = PER_BUFFER_IDX (offset);
1708 set_per_buffer_default (offset, value);
1710 /* If this variable is not always local in all buffers,
1711 set it in the buffers that don't nominally have a local value. */
1712 if (idx > 0)
1714 struct buffer *b;
1716 FOR_EACH_BUFFER (b)
1717 if (!PER_BUFFER_VALUE_P (b, idx))
1718 set_per_buffer_value (b, offset, value);
1721 else
1722 set_internal (symbol, value, Qnil, bindflag);
1723 return;
1725 default: emacs_abort ();
1729 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1730 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1731 The default value is seen in buffers that do not have their own values
1732 for this variable. */)
1733 (Lisp_Object symbol, Lisp_Object value)
1735 set_default_internal (symbol, value, SET_INTERNAL_SET);
1736 return value;
1739 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1740 doc: /* Set the default value of variable VAR to VALUE.
1741 VAR, the variable name, is literal (not evaluated);
1742 VALUE is an expression: it is evaluated and its value returned.
1743 The default value of a variable is seen in buffers
1744 that do not have their own values for the variable.
1746 More generally, you can use multiple variables and values, as in
1747 (setq-default VAR VALUE VAR VALUE...)
1748 This sets each VAR's default value to the corresponding VALUE.
1749 The VALUE for the Nth VAR can refer to the new default values
1750 of previous VARs.
1751 usage: (setq-default [VAR VALUE]...) */)
1752 (Lisp_Object args)
1754 Lisp_Object args_left, symbol, val;
1756 args_left = val = args;
1758 while (CONSP (args_left))
1760 val = eval_sub (Fcar (XCDR (args_left)));
1761 symbol = XCAR (args_left);
1762 Fset_default (symbol, val);
1763 args_left = Fcdr (XCDR (args_left));
1766 return val;
1769 /* Lisp functions for creating and removing buffer-local variables. */
1771 union Lisp_Val_Fwd
1773 Lisp_Object value;
1774 union Lisp_Fwd *fwd;
1777 static struct Lisp_Buffer_Local_Value *
1778 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1779 union Lisp_Val_Fwd valcontents)
1781 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1782 Lisp_Object symbol;
1783 Lisp_Object tem;
1785 XSETSYMBOL (symbol, sym);
1786 tem = Fcons (symbol, (forwarded
1787 ? do_symval_forwarding (valcontents.fwd)
1788 : valcontents.value));
1790 /* Buffer_Local_Values cannot have as realval a buffer-local
1791 or keyboard-local forwarding. */
1792 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1793 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1794 blv->fwd = forwarded ? valcontents.fwd : NULL;
1795 set_blv_where (blv, Qnil);
1796 blv->local_if_set = 0;
1797 set_blv_defcell (blv, tem);
1798 set_blv_valcell (blv, tem);
1799 set_blv_found (blv, 0);
1800 return blv;
1803 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1804 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1805 doc: /* Make VARIABLE become buffer-local whenever it is set.
1806 At any time, the value for the current buffer is in effect,
1807 unless the variable has never been set in this buffer,
1808 in which case the default value is in effect.
1809 Note that binding the variable with `let', or setting it while
1810 a `let'-style binding made in this buffer is in effect,
1811 does not make the variable buffer-local. Return VARIABLE.
1813 This globally affects all uses of this variable, so it belongs together with
1814 the variable declaration, rather than with its uses (if you just want to make
1815 a variable local to the current buffer for one particular use, use
1816 `make-local-variable'). Buffer-local bindings are normally cleared
1817 while setting up a new major mode, unless they have a `permanent-local'
1818 property.
1820 The function `default-value' gets the default value and `set-default' sets it. */)
1821 (register Lisp_Object variable)
1823 struct Lisp_Symbol *sym;
1824 struct Lisp_Buffer_Local_Value *blv = NULL;
1825 union Lisp_Val_Fwd valcontents;
1826 bool forwarded UNINIT;
1828 CHECK_SYMBOL (variable);
1829 sym = XSYMBOL (variable);
1831 start:
1832 switch (sym->redirect)
1834 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1835 case SYMBOL_PLAINVAL:
1836 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1837 if (EQ (valcontents.value, Qunbound))
1838 valcontents.value = Qnil;
1839 break;
1840 case SYMBOL_LOCALIZED:
1841 blv = SYMBOL_BLV (sym);
1842 break;
1843 case SYMBOL_FORWARDED:
1844 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1845 if (KBOARD_OBJFWDP (valcontents.fwd))
1846 error ("Symbol %s may not be buffer-local",
1847 SDATA (SYMBOL_NAME (variable)));
1848 else if (BUFFER_OBJFWDP (valcontents.fwd))
1849 return variable;
1850 break;
1851 default: emacs_abort ();
1854 if (SYMBOL_CONSTANT_P (variable))
1855 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1857 if (!blv)
1859 blv = make_blv (sym, forwarded, valcontents);
1860 sym->redirect = SYMBOL_LOCALIZED;
1861 SET_SYMBOL_BLV (sym, blv);
1864 blv->local_if_set = 1;
1865 return variable;
1868 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1869 1, 1, "vMake Local Variable: ",
1870 doc: /* Make VARIABLE have a separate value in the current buffer.
1871 Other buffers will continue to share a common default value.
1872 \(The buffer-local value of VARIABLE starts out as the same value
1873 VARIABLE previously had. If VARIABLE was void, it remains void.)
1874 Return VARIABLE.
1876 If the variable is already arranged to become local when set,
1877 this function causes a local value to exist for this buffer,
1878 just as setting the variable would do.
1880 This function returns VARIABLE, and therefore
1881 (set (make-local-variable \\='VARIABLE) VALUE-EXP)
1882 works.
1884 See also `make-variable-buffer-local'.
1886 Do not use `make-local-variable' to make a hook variable buffer-local.
1887 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1888 (Lisp_Object variable)
1890 Lisp_Object tem;
1891 bool forwarded;
1892 union Lisp_Val_Fwd valcontents;
1893 struct Lisp_Symbol *sym;
1894 struct Lisp_Buffer_Local_Value *blv = NULL;
1896 CHECK_SYMBOL (variable);
1897 sym = XSYMBOL (variable);
1899 start:
1900 switch (sym->redirect)
1902 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1903 case SYMBOL_PLAINVAL:
1904 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1905 case SYMBOL_LOCALIZED:
1906 blv = SYMBOL_BLV (sym);
1907 break;
1908 case SYMBOL_FORWARDED:
1909 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1910 if (KBOARD_OBJFWDP (valcontents.fwd))
1911 error ("Symbol %s may not be buffer-local",
1912 SDATA (SYMBOL_NAME (variable)));
1913 break;
1914 default: emacs_abort ();
1917 if (sym->trapped_write == SYMBOL_NOWRITE)
1918 error ("Symbol %s may not be buffer-local",
1919 SDATA (SYMBOL_NAME (variable)));
1921 if (blv ? blv->local_if_set
1922 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1924 tem = Fboundp (variable);
1925 /* Make sure the symbol has a local value in this particular buffer,
1926 by setting it to the same value it already has. */
1927 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1928 return variable;
1930 if (!blv)
1932 blv = make_blv (sym, forwarded, valcontents);
1933 sym->redirect = SYMBOL_LOCALIZED;
1934 SET_SYMBOL_BLV (sym, blv);
1937 /* Make sure this buffer has its own value of symbol. */
1938 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1939 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1940 if (NILP (tem))
1942 if (let_shadows_buffer_binding_p (sym))
1944 AUTO_STRING (format,
1945 "Making %s buffer-local while locally let-bound!");
1946 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1949 /* Swap out any local binding for some other buffer, and make
1950 sure the current value is permanently recorded, if it's the
1951 default value. */
1952 find_symbol_value (variable);
1954 bset_local_var_alist
1955 (current_buffer,
1956 Fcons (Fcons (variable, XCDR (blv->defcell)),
1957 BVAR (current_buffer, local_var_alist)));
1959 /* Make sure symbol does not think it is set up for this buffer;
1960 force it to look once again for this buffer's value. */
1961 if (current_buffer == XBUFFER (blv->where))
1962 set_blv_where (blv, Qnil);
1963 set_blv_found (blv, 0);
1966 /* If the symbol forwards into a C variable, then load the binding
1967 for this buffer now. If C code modifies the variable before we
1968 load the binding in, then that new value will clobber the default
1969 binding the next time we unload it. */
1970 if (blv->fwd)
1971 swap_in_symval_forwarding (sym, blv);
1973 return variable;
1976 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1977 1, 1, "vKill Local Variable: ",
1978 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1979 From now on the default value will apply in this buffer. Return VARIABLE. */)
1980 (register Lisp_Object variable)
1982 register Lisp_Object tem;
1983 struct Lisp_Buffer_Local_Value *blv;
1984 struct Lisp_Symbol *sym;
1986 CHECK_SYMBOL (variable);
1987 sym = XSYMBOL (variable);
1989 start:
1990 switch (sym->redirect)
1992 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1993 case SYMBOL_PLAINVAL: return variable;
1994 case SYMBOL_FORWARDED:
1996 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1997 if (BUFFER_OBJFWDP (valcontents))
1999 int offset = XBUFFER_OBJFWD (valcontents)->offset;
2000 int idx = PER_BUFFER_IDX (offset);
2002 if (idx > 0)
2004 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
2005 set_per_buffer_value (current_buffer, offset,
2006 per_buffer_default (offset));
2009 return variable;
2011 case SYMBOL_LOCALIZED:
2012 blv = SYMBOL_BLV (sym);
2013 break;
2014 default: emacs_abort ();
2017 if (sym->trapped_write == SYMBOL_TRAPPED_WRITE)
2018 notify_variable_watchers (variable, Qnil, Qmakunbound, Fcurrent_buffer ());
2020 /* Get rid of this buffer's alist element, if any. */
2021 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
2022 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
2023 if (!NILP (tem))
2024 bset_local_var_alist
2025 (current_buffer,
2026 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
2028 /* If the symbol is set up with the current buffer's binding
2029 loaded, recompute its value. We have to do it now, or else
2030 forwarded objects won't work right. */
2032 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
2033 if (EQ (buf, blv->where))
2035 set_blv_where (blv, Qnil);
2036 blv->found = 0;
2037 find_symbol_value (variable);
2041 return variable;
2044 /* Lisp functions for creating and removing buffer-local variables. */
2046 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
2047 1, 2, 0,
2048 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
2049 BUFFER defaults to the current buffer. */)
2050 (Lisp_Object variable, Lisp_Object buffer)
2052 struct buffer *buf = decode_buffer (buffer);
2053 struct Lisp_Symbol *sym;
2055 CHECK_SYMBOL (variable);
2056 sym = XSYMBOL (variable);
2058 start:
2059 switch (sym->redirect)
2061 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
2062 case SYMBOL_PLAINVAL: return Qnil;
2063 case SYMBOL_LOCALIZED:
2065 Lisp_Object tail, elt, tmp;
2066 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
2067 XSETBUFFER (tmp, buf);
2068 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
2070 if (EQ (blv->where, tmp)) /* The binding is already loaded. */
2071 return blv_found (blv) ? Qt : Qnil;
2072 else
2073 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
2075 elt = XCAR (tail);
2076 if (EQ (variable, XCAR (elt)))
2077 return Qt;
2079 return Qnil;
2081 case SYMBOL_FORWARDED:
2083 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
2084 if (BUFFER_OBJFWDP (valcontents))
2086 int offset = XBUFFER_OBJFWD (valcontents)->offset;
2087 int idx = PER_BUFFER_IDX (offset);
2088 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
2089 return Qt;
2091 return Qnil;
2093 default: emacs_abort ();
2097 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
2098 1, 2, 0,
2099 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
2100 BUFFER defaults to the current buffer.
2102 More precisely, return non-nil if either VARIABLE already has a local
2103 value in BUFFER, or if VARIABLE is automatically buffer-local (see
2104 `make-variable-buffer-local'). */)
2105 (register Lisp_Object variable, Lisp_Object buffer)
2107 struct Lisp_Symbol *sym;
2109 CHECK_SYMBOL (variable);
2110 sym = XSYMBOL (variable);
2112 start:
2113 switch (sym->redirect)
2115 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
2116 case SYMBOL_PLAINVAL: return Qnil;
2117 case SYMBOL_LOCALIZED:
2119 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
2120 if (blv->local_if_set)
2121 return Qt;
2122 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
2123 return Flocal_variable_p (variable, buffer);
2125 case SYMBOL_FORWARDED:
2126 /* All BUFFER_OBJFWD slots become local if they are set. */
2127 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
2128 default: emacs_abort ();
2132 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
2133 1, 1, 0,
2134 doc: /* Return a value indicating where VARIABLE's current binding comes from.
2135 If the current binding is buffer-local, the value is the current buffer.
2136 If the current binding is global (the default), the value is nil. */)
2137 (register Lisp_Object variable)
2139 struct Lisp_Symbol *sym;
2141 CHECK_SYMBOL (variable);
2142 sym = XSYMBOL (variable);
2144 /* Make sure the current binding is actually swapped in. */
2145 find_symbol_value (variable);
2147 start:
2148 switch (sym->redirect)
2150 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
2151 case SYMBOL_PLAINVAL: return Qnil;
2152 case SYMBOL_FORWARDED:
2154 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
2155 if (KBOARD_OBJFWDP (valcontents))
2156 return Fframe_terminal (selected_frame);
2157 else if (!BUFFER_OBJFWDP (valcontents))
2158 return Qnil;
2160 FALLTHROUGH;
2161 case SYMBOL_LOCALIZED:
2162 /* For a local variable, record both the symbol and which
2163 buffer's or frame's value we are saving. */
2164 if (!NILP (Flocal_variable_p (variable, Qnil)))
2165 return Fcurrent_buffer ();
2166 else if (sym->redirect == SYMBOL_LOCALIZED
2167 && blv_found (SYMBOL_BLV (sym)))
2168 return SYMBOL_BLV (sym)->where;
2169 else
2170 return Qnil;
2171 default: emacs_abort ();
2175 /* This code is disabled now that we use the selected frame to return
2176 keyboard-local-values. */
2177 #if 0
2178 extern struct terminal *get_terminal (Lisp_Object display, int);
2180 DEFUN ("terminal-local-value", Fterminal_local_value,
2181 Sterminal_local_value, 2, 2, 0,
2182 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
2183 If SYMBOL is not a terminal-local variable, then return its normal
2184 value, like `symbol-value'.
2186 TERMINAL may be a terminal object, a frame, or nil (meaning the
2187 selected frame's terminal device). */)
2188 (Lisp_Object symbol, Lisp_Object terminal)
2190 Lisp_Object result;
2191 struct terminal *t = get_terminal (terminal, 1);
2192 push_kboard (t->kboard);
2193 result = Fsymbol_value (symbol);
2194 pop_kboard ();
2195 return result;
2198 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
2199 Sset_terminal_local_value, 3, 3, 0,
2200 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2201 If VARIABLE is not a terminal-local variable, then set its normal
2202 binding, like `set'.
2204 TERMINAL may be a terminal object, a frame, or nil (meaning the
2205 selected frame's terminal device). */)
2206 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2208 Lisp_Object result;
2209 struct terminal *t = get_terminal (terminal, 1);
2210 push_kboard (d->kboard);
2211 result = Fset (symbol, value);
2212 pop_kboard ();
2213 return result;
2215 #endif
2217 /* Find the function at the end of a chain of symbol function indirections. */
2219 /* If OBJECT is a symbol, find the end of its function chain and
2220 return the value found there. If OBJECT is not a symbol, just
2221 return it. If there is a cycle in the function chain, signal a
2222 cyclic-function-indirection error.
2224 This is like Findirect_function, except that it doesn't signal an
2225 error if the chain ends up unbound. */
2226 Lisp_Object
2227 indirect_function (register Lisp_Object object)
2229 Lisp_Object tortoise, hare;
2231 hare = tortoise = object;
2233 for (;;)
2235 if (!SYMBOLP (hare) || NILP (hare))
2236 break;
2237 hare = XSYMBOL (hare)->function;
2238 if (!SYMBOLP (hare) || NILP (hare))
2239 break;
2240 hare = XSYMBOL (hare)->function;
2242 tortoise = XSYMBOL (tortoise)->function;
2244 if (EQ (hare, tortoise))
2245 xsignal1 (Qcyclic_function_indirection, object);
2248 return hare;
2251 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2252 doc: /* Return the function at the end of OBJECT's function chain.
2253 If OBJECT is not a symbol, just return it. Otherwise, follow all
2254 function indirections to find the final function binding and return it.
2255 Signal a cyclic-function-indirection error if there is a loop in the
2256 function chain of symbols. */)
2257 (register Lisp_Object object, Lisp_Object noerror)
2259 Lisp_Object result;
2261 /* Optimize for no indirection. */
2262 result = object;
2263 if (SYMBOLP (result) && !NILP (result)
2264 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2265 result = indirect_function (result);
2266 if (!NILP (result))
2267 return result;
2269 return Qnil;
2272 /* Extract and set vector and string elements. */
2274 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2275 doc: /* Return the element of ARG at index IDX.
2276 ARG may be a vector, a string, a char-table, a bool-vector, a record,
2277 or a byte-code object. IDX starts at 0. */)
2278 (register Lisp_Object array, Lisp_Object idx)
2280 register EMACS_INT idxval;
2282 CHECK_NUMBER (idx);
2283 idxval = XINT (idx);
2284 if (STRINGP (array))
2286 int c;
2287 ptrdiff_t idxval_byte;
2289 if (idxval < 0 || idxval >= SCHARS (array))
2290 args_out_of_range (array, idx);
2291 if (! STRING_MULTIBYTE (array))
2292 return make_number ((unsigned char) SREF (array, idxval));
2293 idxval_byte = string_char_to_byte (array, idxval);
2295 c = STRING_CHAR (SDATA (array) + idxval_byte);
2296 return make_number (c);
2298 else if (BOOL_VECTOR_P (array))
2300 if (idxval < 0 || idxval >= bool_vector_size (array))
2301 args_out_of_range (array, idx);
2302 return bool_vector_ref (array, idxval);
2304 else if (CHAR_TABLE_P (array))
2306 CHECK_CHARACTER (idx);
2307 return CHAR_TABLE_REF (array, idxval);
2309 else
2311 ptrdiff_t size = 0;
2312 if (VECTORP (array))
2313 size = ASIZE (array);
2314 else if (COMPILEDP (array) || RECORDP (array))
2315 size = PVSIZE (array);
2316 else
2317 wrong_type_argument (Qarrayp, array);
2319 if (idxval < 0 || idxval >= size)
2320 args_out_of_range (array, idx);
2321 return AREF (array, idxval);
2325 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2326 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2327 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2328 bool-vector. IDX starts at 0. */)
2329 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2331 register EMACS_INT idxval;
2333 CHECK_NUMBER (idx);
2334 idxval = XINT (idx);
2335 if (! RECORDP (array))
2336 CHECK_ARRAY (array, Qarrayp);
2338 if (VECTORP (array))
2340 CHECK_IMPURE (array, XVECTOR (array));
2341 if (idxval < 0 || idxval >= ASIZE (array))
2342 args_out_of_range (array, idx);
2343 ASET (array, idxval, newelt);
2345 else if (BOOL_VECTOR_P (array))
2347 if (idxval < 0 || idxval >= bool_vector_size (array))
2348 args_out_of_range (array, idx);
2349 bool_vector_set (array, idxval, !NILP (newelt));
2351 else if (CHAR_TABLE_P (array))
2353 CHECK_CHARACTER (idx);
2354 CHAR_TABLE_SET (array, idxval, newelt);
2356 else if (RECORDP (array))
2358 if (idxval < 0 || idxval >= PVSIZE (array))
2359 args_out_of_range (array, idx);
2360 ASET (array, idxval, newelt);
2362 else /* STRINGP */
2364 int c;
2366 CHECK_IMPURE (array, XSTRING (array));
2367 if (idxval < 0 || idxval >= SCHARS (array))
2368 args_out_of_range (array, idx);
2369 CHECK_CHARACTER (newelt);
2370 c = XFASTINT (newelt);
2372 if (STRING_MULTIBYTE (array))
2374 ptrdiff_t idxval_byte, nbytes;
2375 int prev_bytes, new_bytes;
2376 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2378 nbytes = SBYTES (array);
2379 idxval_byte = string_char_to_byte (array, idxval);
2380 p1 = SDATA (array) + idxval_byte;
2381 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2382 new_bytes = CHAR_STRING (c, p0);
2383 if (prev_bytes != new_bytes)
2385 /* We must relocate the string data. */
2386 ptrdiff_t nchars = SCHARS (array);
2387 USE_SAFE_ALLOCA;
2388 unsigned char *str = SAFE_ALLOCA (nbytes);
2390 memcpy (str, SDATA (array), nbytes);
2391 allocate_string_data (XSTRING (array), nchars,
2392 nbytes + new_bytes - prev_bytes);
2393 memcpy (SDATA (array), str, idxval_byte);
2394 p1 = SDATA (array) + idxval_byte;
2395 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2396 nbytes - (idxval_byte + prev_bytes));
2397 SAFE_FREE ();
2398 clear_string_char_byte_cache ();
2400 while (new_bytes--)
2401 *p1++ = *p0++;
2403 else
2405 if (! SINGLE_BYTE_CHAR_P (c))
2407 ptrdiff_t i;
2409 for (i = SBYTES (array) - 1; i >= 0; i--)
2410 if (SREF (array, i) >= 0x80)
2411 args_out_of_range (array, newelt);
2412 /* ARRAY is an ASCII string. Convert it to a multibyte
2413 string, and try `aset' again. */
2414 STRING_SET_MULTIBYTE (array);
2415 return Faset (array, idx, newelt);
2417 SSET (array, idxval, c);
2421 return newelt;
2424 /* Arithmetic functions */
2426 Lisp_Object
2427 arithcompare (Lisp_Object num1, Lisp_Object num2,
2428 enum Arith_Comparison comparison)
2430 double f1, f2;
2431 EMACS_INT i1, i2;
2432 bool fneq;
2433 bool test;
2435 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2436 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2438 /* If either arg is floating point, set F1 and F2 to the 'double'
2439 approximations of the two arguments, and set FNEQ if floating-point
2440 comparison reports that F1 is not equal to F2, possibly because F1
2441 or F2 is a NaN. Regardless, set I1 and I2 to integers that break
2442 ties if the floating-point comparison is either not done or reports
2443 equality. */
2445 if (FLOATP (num1))
2447 f1 = XFLOAT_DATA (num1);
2448 if (FLOATP (num2))
2450 i1 = i2 = 0;
2451 f2 = XFLOAT_DATA (num2);
2453 else
2455 /* Compare a float NUM1 to an integer NUM2 by converting the
2456 integer I2 (i.e., NUM2) to the double F2 (a conversion that
2457 can round on some platforms, if I2 is large enough), and then
2458 converting F2 back to the integer I1 (a conversion that is
2459 always exact), so that I1 exactly equals ((double) NUM2). If
2460 floating-point comparison reports a tie, NUM1 = F1 = F2 = I1
2461 (exactly) so I1 - I2 = NUM1 - NUM2 (exactly), so comparing I1
2462 to I2 will break the tie correctly. */
2463 i1 = f2 = i2 = XINT (num2);
2465 fneq = f1 != f2;
2467 else
2469 i1 = XINT (num1);
2470 if (FLOATP (num2))
2472 /* Compare an integer NUM1 to a float NUM2. This is the
2473 converse of comparing float to integer (see above). */
2474 i2 = f1 = i1;
2475 f2 = XFLOAT_DATA (num2);
2476 fneq = f1 != f2;
2478 else
2480 i2 = XINT (num2);
2481 fneq = false;
2485 switch (comparison)
2487 case ARITH_EQUAL:
2488 test = !fneq && i1 == i2;
2489 break;
2491 case ARITH_NOTEQUAL:
2492 test = fneq || i1 != i2;
2493 break;
2495 case ARITH_LESS:
2496 test = fneq ? f1 < f2 : i1 < i2;
2497 break;
2499 case ARITH_LESS_OR_EQUAL:
2500 test = fneq ? f1 <= f2 : i1 <= i2;
2501 break;
2503 case ARITH_GRTR:
2504 test = fneq ? f1 > f2 : i1 > i2;
2505 break;
2507 case ARITH_GRTR_OR_EQUAL:
2508 test = fneq ? f1 >= f2 : i1 >= i2;
2509 break;
2511 default:
2512 eassume (false);
2515 return test ? Qt : Qnil;
2518 static Lisp_Object
2519 arithcompare_driver (ptrdiff_t nargs, Lisp_Object *args,
2520 enum Arith_Comparison comparison)
2522 for (ptrdiff_t i = 1; i < nargs; i++)
2523 if (NILP (arithcompare (args[i - 1], args[i], comparison)))
2524 return Qnil;
2525 return Qt;
2528 DEFUN ("=", Feqlsign, Seqlsign, 1, MANY, 0,
2529 doc: /* Return t if args, all numbers or markers, are equal.
2530 usage: (= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2531 (ptrdiff_t nargs, Lisp_Object *args)
2533 return arithcompare_driver (nargs, args, ARITH_EQUAL);
2536 DEFUN ("<", Flss, Slss, 1, MANY, 0,
2537 doc: /* Return t if each arg (a number or marker), is less than the next arg.
2538 usage: (< NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2539 (ptrdiff_t nargs, Lisp_Object *args)
2541 return arithcompare_driver (nargs, args, ARITH_LESS);
2544 DEFUN (">", Fgtr, Sgtr, 1, MANY, 0,
2545 doc: /* Return t if each arg (a number or marker) is greater than the next arg.
2546 usage: (> NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2547 (ptrdiff_t nargs, Lisp_Object *args)
2549 return arithcompare_driver (nargs, args, ARITH_GRTR);
2552 DEFUN ("<=", Fleq, Sleq, 1, MANY, 0,
2553 doc: /* Return t if each arg (a number or marker) is less than or equal to the next.
2554 usage: (<= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2555 (ptrdiff_t nargs, Lisp_Object *args)
2557 return arithcompare_driver (nargs, args, ARITH_LESS_OR_EQUAL);
2560 DEFUN (">=", Fgeq, Sgeq, 1, MANY, 0,
2561 doc: /* Return t if each arg (a number or marker) is greater than or equal to the next.
2562 usage: (>= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2563 (ptrdiff_t nargs, Lisp_Object *args)
2565 return arithcompare_driver (nargs, args, ARITH_GRTR_OR_EQUAL);
2568 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2569 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2570 (register Lisp_Object num1, Lisp_Object num2)
2572 return arithcompare (num1, num2, ARITH_NOTEQUAL);
2575 /* Convert the integer I to a cons-of-integers, where I is not in
2576 fixnum range. */
2578 #define INTBIG_TO_LISP(i, extremum) \
2579 (eassert (FIXNUM_OVERFLOW_P (i)), \
2580 (! (FIXNUM_OVERFLOW_P ((extremum) >> 16) \
2581 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2582 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2583 : ! (FIXNUM_OVERFLOW_P ((extremum) >> 16 >> 24) \
2584 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2585 ? Fcons (make_number ((i) >> 16 >> 24), \
2586 Fcons (make_number ((i) >> 16 & 0xffffff), \
2587 make_number ((i) & 0xffff))) \
2588 : make_float (i)))
2590 Lisp_Object
2591 intbig_to_lisp (intmax_t i)
2593 return INTBIG_TO_LISP (i, INTMAX_MIN);
2596 Lisp_Object
2597 uintbig_to_lisp (uintmax_t i)
2599 return INTBIG_TO_LISP (i, UINTMAX_MAX);
2602 /* Convert the cons-of-integers, integer, or float value C to an
2603 unsigned value with maximum value MAX, where MAX is one less than a
2604 power of 2. Signal an error if C does not have a valid format or
2605 is out of range. */
2606 uintmax_t
2607 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2609 bool valid = false;
2610 uintmax_t val UNINIT;
2611 if (INTEGERP (c))
2613 valid = XINT (c) >= 0;
2614 val = XINT (c);
2616 else if (FLOATP (c))
2618 double d = XFLOAT_DATA (c);
2619 if (d >= 0 && d < 1.0 + max)
2621 val = d;
2622 valid = val == d;
2625 else if (CONSP (c) && NATNUMP (XCAR (c)))
2627 uintmax_t top = XFASTINT (XCAR (c));
2628 Lisp_Object rest = XCDR (c);
2629 if (top <= UINTMAX_MAX >> 24 >> 16
2630 && CONSP (rest)
2631 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2632 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2634 uintmax_t mid = XFASTINT (XCAR (rest));
2635 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2636 valid = true;
2638 else if (top <= UINTMAX_MAX >> 16)
2640 if (CONSP (rest))
2641 rest = XCAR (rest);
2642 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2644 val = top << 16 | XFASTINT (rest);
2645 valid = true;
2650 if (! (valid && val <= max))
2651 error ("Not an in-range integer, integral float, or cons of integers");
2652 return val;
2655 /* Convert the cons-of-integers, integer, or float value C to a signed
2656 value with extrema MIN and MAX. MAX should be one less than a
2657 power of 2, and MIN should be zero or the negative of a power of 2.
2658 Signal an error if C does not have a valid format or is out of
2659 range. */
2660 intmax_t
2661 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2663 bool valid = false;
2664 intmax_t val UNINIT;
2665 if (INTEGERP (c))
2667 val = XINT (c);
2668 valid = true;
2670 else if (FLOATP (c))
2672 double d = XFLOAT_DATA (c);
2673 if (d >= min && d < 1.0 + max)
2675 val = d;
2676 valid = val == d;
2679 else if (CONSP (c) && INTEGERP (XCAR (c)))
2681 intmax_t top = XINT (XCAR (c));
2682 Lisp_Object rest = XCDR (c);
2683 if (top >= INTMAX_MIN >> 24 >> 16 && top <= INTMAX_MAX >> 24 >> 16
2684 && CONSP (rest)
2685 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2686 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2688 intmax_t mid = XFASTINT (XCAR (rest));
2689 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2690 valid = true;
2692 else if (top >= INTMAX_MIN >> 16 && top <= INTMAX_MAX >> 16)
2694 if (CONSP (rest))
2695 rest = XCAR (rest);
2696 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2698 val = top << 16 | XFASTINT (rest);
2699 valid = true;
2704 if (! (valid && min <= val && val <= max))
2705 error ("Not an in-range integer, integral float, or cons of integers");
2706 return val;
2709 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2710 doc: /* Return the decimal representation of NUMBER as a string.
2711 Uses a minus sign if negative.
2712 NUMBER may be an integer or a floating point number. */)
2713 (Lisp_Object number)
2715 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2716 int len;
2718 CHECK_NUMBER_OR_FLOAT (number);
2720 if (FLOATP (number))
2721 len = float_to_string (buffer, XFLOAT_DATA (number));
2722 else
2723 len = sprintf (buffer, "%"pI"d", XINT (number));
2725 return make_unibyte_string (buffer, len);
2728 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2729 doc: /* Parse STRING as a decimal number and return the number.
2730 Ignore leading spaces and tabs, and all trailing chars. Return 0 if
2731 STRING cannot be parsed as an integer or floating point number.
2733 If BASE, interpret STRING as a number in that base. If BASE isn't
2734 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2735 If the base used is not 10, STRING is always parsed as an integer. */)
2736 (register Lisp_Object string, Lisp_Object base)
2738 register char *p;
2739 register int b;
2740 Lisp_Object val;
2742 CHECK_STRING (string);
2744 if (NILP (base))
2745 b = 10;
2746 else
2748 CHECK_NUMBER (base);
2749 if (! (XINT (base) >= 2 && XINT (base) <= 16))
2750 xsignal1 (Qargs_out_of_range, base);
2751 b = XINT (base);
2754 p = SSDATA (string);
2755 while (*p == ' ' || *p == '\t')
2756 p++;
2758 val = string_to_number (p, b, 1);
2759 return NILP (val) ? make_number (0) : val;
2762 enum arithop
2764 Aadd,
2765 Asub,
2766 Amult,
2767 Adiv,
2768 Alogand,
2769 Alogior,
2770 Alogxor
2773 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2774 ptrdiff_t, Lisp_Object *);
2775 static Lisp_Object
2776 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2778 Lisp_Object val;
2779 ptrdiff_t argnum, ok_args;
2780 EMACS_INT accum = 0;
2781 EMACS_INT next, ok_accum;
2782 bool overflow = 0;
2784 switch (code)
2786 case Alogior:
2787 case Alogxor:
2788 case Aadd:
2789 case Asub:
2790 accum = 0;
2791 break;
2792 case Amult:
2793 case Adiv:
2794 accum = 1;
2795 break;
2796 case Alogand:
2797 accum = -1;
2798 break;
2799 default:
2800 break;
2803 for (argnum = 0; argnum < nargs; argnum++)
2805 if (! overflow)
2807 ok_args = argnum;
2808 ok_accum = accum;
2811 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2812 val = args[argnum];
2813 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2815 if (FLOATP (val))
2816 return float_arith_driver (ok_accum, ok_args, code,
2817 nargs, args);
2818 args[argnum] = val;
2819 next = XINT (args[argnum]);
2820 switch (code)
2822 case Aadd:
2823 overflow |= INT_ADD_WRAPV (accum, next, &accum);
2824 break;
2825 case Asub:
2826 if (! argnum)
2827 accum = nargs == 1 ? - next : next;
2828 else
2829 overflow |= INT_SUBTRACT_WRAPV (accum, next, &accum);
2830 break;
2831 case Amult:
2832 overflow |= INT_MULTIPLY_WRAPV (accum, next, &accum);
2833 break;
2834 case Adiv:
2835 if (! (argnum || nargs == 1))
2836 accum = next;
2837 else
2839 if (next == 0)
2840 xsignal0 (Qarith_error);
2841 if (INT_DIVIDE_OVERFLOW (accum, next))
2842 overflow = true;
2843 else
2844 accum /= next;
2846 break;
2847 case Alogand:
2848 accum &= next;
2849 break;
2850 case Alogior:
2851 accum |= next;
2852 break;
2853 case Alogxor:
2854 accum ^= next;
2855 break;
2859 XSETINT (val, accum);
2860 return val;
2863 #ifndef isnan
2864 # define isnan(x) ((x) != (x))
2865 #endif
2867 static Lisp_Object
2868 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2869 ptrdiff_t nargs, Lisp_Object *args)
2871 register Lisp_Object val;
2872 double next;
2874 for (; argnum < nargs; argnum++)
2876 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2877 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2879 if (FLOATP (val))
2881 next = XFLOAT_DATA (val);
2883 else
2885 args[argnum] = val; /* runs into a compiler bug. */
2886 next = XINT (args[argnum]);
2888 switch (code)
2890 case Aadd:
2891 accum += next;
2892 break;
2893 case Asub:
2894 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2895 break;
2896 case Amult:
2897 accum *= next;
2898 break;
2899 case Adiv:
2900 if (! (argnum || nargs == 1))
2901 accum = next;
2902 else
2904 if (! IEEE_FLOATING_POINT && next == 0)
2905 xsignal0 (Qarith_error);
2906 accum /= next;
2908 break;
2909 case Alogand:
2910 case Alogior:
2911 case Alogxor:
2912 wrong_type_argument (Qinteger_or_marker_p, val);
2916 return make_float (accum);
2920 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2921 doc: /* Return sum of any number of arguments, which are numbers or markers.
2922 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2923 (ptrdiff_t nargs, Lisp_Object *args)
2925 return arith_driver (Aadd, nargs, args);
2928 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2929 doc: /* Negate number or subtract numbers or markers and return the result.
2930 With one arg, negates it. With more than one arg,
2931 subtracts all but the first from the first.
2932 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2933 (ptrdiff_t nargs, Lisp_Object *args)
2935 return arith_driver (Asub, nargs, args);
2938 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2939 doc: /* Return product of any number of arguments, which are numbers or markers.
2940 usage: (* &rest NUMBERS-OR-MARKERS) */)
2941 (ptrdiff_t nargs, Lisp_Object *args)
2943 return arith_driver (Amult, nargs, args);
2946 DEFUN ("/", Fquo, Squo, 1, MANY, 0,
2947 doc: /* Divide number by divisors and return the result.
2948 With two or more arguments, return first argument divided by the rest.
2949 With one argument, return 1 divided by the argument.
2950 The arguments must be numbers or markers.
2951 usage: (/ NUMBER &rest DIVISORS) */)
2952 (ptrdiff_t nargs, Lisp_Object *args)
2954 ptrdiff_t argnum;
2955 for (argnum = 2; argnum < nargs; argnum++)
2956 if (FLOATP (args[argnum]))
2957 return float_arith_driver (0, 0, Adiv, nargs, args);
2958 return arith_driver (Adiv, nargs, args);
2961 DEFUN ("%", Frem, Srem, 2, 2, 0,
2962 doc: /* Return remainder of X divided by Y.
2963 Both must be integers or markers. */)
2964 (register Lisp_Object x, Lisp_Object y)
2966 Lisp_Object val;
2968 CHECK_NUMBER_COERCE_MARKER (x);
2969 CHECK_NUMBER_COERCE_MARKER (y);
2971 if (XINT (y) == 0)
2972 xsignal0 (Qarith_error);
2974 XSETINT (val, XINT (x) % XINT (y));
2975 return val;
2978 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2979 doc: /* Return X modulo Y.
2980 The result falls between zero (inclusive) and Y (exclusive).
2981 Both X and Y must be numbers or markers. */)
2982 (register Lisp_Object x, Lisp_Object y)
2984 Lisp_Object val;
2985 EMACS_INT i1, i2;
2987 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2988 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2990 if (FLOATP (x) || FLOATP (y))
2991 return fmod_float (x, y);
2993 i1 = XINT (x);
2994 i2 = XINT (y);
2996 if (i2 == 0)
2997 xsignal0 (Qarith_error);
2999 i1 %= i2;
3001 /* If the "remainder" comes out with the wrong sign, fix it. */
3002 if (i2 < 0 ? i1 > 0 : i1 < 0)
3003 i1 += i2;
3005 XSETINT (val, i1);
3006 return val;
3009 static Lisp_Object
3010 minmax_driver (ptrdiff_t nargs, Lisp_Object *args,
3011 enum Arith_Comparison comparison)
3013 eassume (0 < nargs);
3014 Lisp_Object accum;
3015 for (ptrdiff_t argnum = 0; argnum < nargs; argnum++)
3017 Lisp_Object val = args[argnum];
3018 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
3019 if (argnum == 0 || !NILP (arithcompare (val, accum, comparison)))
3020 accum = val;
3021 else if (FLOATP (accum) && isnan (XFLOAT_DATA (accum)))
3022 return accum;
3024 return accum;
3027 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
3028 doc: /* Return largest of all the arguments (which must be numbers or markers).
3029 The value is always a number; markers are converted to numbers.
3030 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
3031 (ptrdiff_t nargs, Lisp_Object *args)
3033 return minmax_driver (nargs, args, ARITH_GRTR);
3036 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
3037 doc: /* Return smallest of all the arguments (which must be numbers or markers).
3038 The value is always a number; markers are converted to numbers.
3039 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
3040 (ptrdiff_t nargs, Lisp_Object *args)
3042 return minmax_driver (nargs, args, ARITH_LESS);
3045 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
3046 doc: /* Return bitwise-and of all the arguments.
3047 Arguments may be integers, or markers converted to integers.
3048 usage: (logand &rest INTS-OR-MARKERS) */)
3049 (ptrdiff_t nargs, Lisp_Object *args)
3051 return arith_driver (Alogand, nargs, args);
3054 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
3055 doc: /* Return bitwise-or of all the arguments.
3056 Arguments may be integers, or markers converted to integers.
3057 usage: (logior &rest INTS-OR-MARKERS) */)
3058 (ptrdiff_t nargs, Lisp_Object *args)
3060 return arith_driver (Alogior, nargs, args);
3063 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
3064 doc: /* Return bitwise-exclusive-or of all the arguments.
3065 Arguments may be integers, or markers converted to integers.
3066 usage: (logxor &rest INTS-OR-MARKERS) */)
3067 (ptrdiff_t nargs, Lisp_Object *args)
3069 return arith_driver (Alogxor, nargs, args);
3072 static Lisp_Object
3073 ash_lsh_impl (Lisp_Object value, Lisp_Object count, bool lsh)
3075 /* This code assumes that signed right shifts are arithmetic. */
3076 verify ((EMACS_INT) -1 >> 1 == -1);
3078 Lisp_Object val;
3080 CHECK_NUMBER (value);
3081 CHECK_NUMBER (count);
3083 if (XINT (count) >= EMACS_INT_WIDTH)
3084 XSETINT (val, 0);
3085 else if (XINT (count) > 0)
3086 XSETINT (val, XUINT (value) << XINT (count));
3087 else if (XINT (count) <= -EMACS_INT_WIDTH)
3088 XSETINT (val, lsh ? 0 : XINT (value) < 0 ? -1 : 0);
3089 else
3090 XSETINT (val, (lsh ? XUINT (value) >> -XINT (count)
3091 : XINT (value) >> -XINT (count)));
3092 return val;
3095 DEFUN ("ash", Fash, Sash, 2, 2, 0,
3096 doc: /* Return VALUE with its bits shifted left by COUNT.
3097 If COUNT is negative, shifting is actually to the right.
3098 In this case, the sign bit is duplicated. */)
3099 (register Lisp_Object value, Lisp_Object count)
3101 return ash_lsh_impl (value, count, false);
3104 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
3105 doc: /* Return VALUE with its bits shifted left by COUNT.
3106 If COUNT is negative, shifting is actually to the right.
3107 In this case, zeros are shifted in on the left. */)
3108 (register Lisp_Object value, Lisp_Object count)
3110 return ash_lsh_impl (value, count, true);
3113 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
3114 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
3115 Markers are converted to integers. */)
3116 (register Lisp_Object number)
3118 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
3120 if (FLOATP (number))
3121 return (make_float (1.0 + XFLOAT_DATA (number)));
3123 XSETINT (number, XINT (number) + 1);
3124 return number;
3127 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
3128 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
3129 Markers are converted to integers. */)
3130 (register Lisp_Object number)
3132 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
3134 if (FLOATP (number))
3135 return (make_float (-1.0 + XFLOAT_DATA (number)));
3137 XSETINT (number, XINT (number) - 1);
3138 return number;
3141 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
3142 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
3143 (register Lisp_Object number)
3145 CHECK_NUMBER (number);
3146 XSETINT (number, ~XINT (number));
3147 return number;
3150 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
3151 doc: /* Return the byteorder for the machine.
3152 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
3153 lowercase l) for small endian machines. */
3154 attributes: const)
3155 (void)
3157 unsigned i = 0x04030201;
3158 int order = *(char *)&i == 1 ? 108 : 66;
3160 return make_number (order);
3163 /* Because we round up the bool vector allocate size to word_size
3164 units, we can safely read past the "end" of the vector in the
3165 operations below. These extra bits are always zero. */
3167 static bits_word
3168 bool_vector_spare_mask (EMACS_INT nr_bits)
3170 return (((bits_word) 1) << (nr_bits % BITS_PER_BITS_WORD)) - 1;
3173 /* Info about unsigned long long, falling back on unsigned long
3174 if unsigned long long is not available. */
3176 #if HAVE_UNSIGNED_LONG_LONG_INT && defined ULLONG_WIDTH
3177 enum { ULL_WIDTH = ULLONG_WIDTH };
3178 # define ULL_MAX ULLONG_MAX
3179 #else
3180 enum { ULL_WIDTH = ULONG_WIDTH };
3181 # define ULL_MAX ULONG_MAX
3182 # define count_one_bits_ll count_one_bits_l
3183 # define count_trailing_zeros_ll count_trailing_zeros_l
3184 #endif
3186 /* Shift VAL right by the width of an unsigned long long.
3187 ULL_WIDTH must be less than BITS_PER_BITS_WORD. */
3189 static bits_word
3190 shift_right_ull (bits_word w)
3192 /* Pacify bogus GCC warning about shift count exceeding type width. */
3193 int shift = ULL_WIDTH - BITS_PER_BITS_WORD < 0 ? ULL_WIDTH : 0;
3194 return w >> shift;
3197 /* Return the number of 1 bits in W. */
3199 static int
3200 count_one_bits_word (bits_word w)
3202 if (BITS_WORD_MAX <= UINT_MAX)
3203 return count_one_bits (w);
3204 else if (BITS_WORD_MAX <= ULONG_MAX)
3205 return count_one_bits_l (w);
3206 else
3208 int i = 0, count = 0;
3209 while (count += count_one_bits_ll (w),
3210 (i += ULL_WIDTH) < BITS_PER_BITS_WORD)
3211 w = shift_right_ull (w);
3212 return count;
3216 enum bool_vector_op { bool_vector_exclusive_or,
3217 bool_vector_union,
3218 bool_vector_intersection,
3219 bool_vector_set_difference,
3220 bool_vector_subsetp };
3222 static Lisp_Object
3223 bool_vector_binop_driver (Lisp_Object a,
3224 Lisp_Object b,
3225 Lisp_Object dest,
3226 enum bool_vector_op op)
3228 EMACS_INT nr_bits;
3229 bits_word *adata, *bdata, *destdata;
3230 ptrdiff_t i = 0;
3231 ptrdiff_t nr_words;
3233 CHECK_BOOL_VECTOR (a);
3234 CHECK_BOOL_VECTOR (b);
3236 nr_bits = bool_vector_size (a);
3237 if (bool_vector_size (b) != nr_bits)
3238 wrong_length_argument (a, b, dest);
3240 nr_words = bool_vector_words (nr_bits);
3241 adata = bool_vector_data (a);
3242 bdata = bool_vector_data (b);
3244 if (NILP (dest))
3246 dest = make_uninit_bool_vector (nr_bits);
3247 destdata = bool_vector_data (dest);
3249 else
3251 CHECK_BOOL_VECTOR (dest);
3252 destdata = bool_vector_data (dest);
3253 if (bool_vector_size (dest) != nr_bits)
3254 wrong_length_argument (a, b, dest);
3256 switch (op)
3258 case bool_vector_exclusive_or:
3259 for (; i < nr_words; i++)
3260 if (destdata[i] != (adata[i] ^ bdata[i]))
3261 goto set_dest;
3262 break;
3264 case bool_vector_subsetp:
3265 for (; i < nr_words; i++)
3266 if (adata[i] &~ bdata[i])
3267 return Qnil;
3268 return Qt;
3270 case bool_vector_union:
3271 for (; i < nr_words; i++)
3272 if (destdata[i] != (adata[i] | bdata[i]))
3273 goto set_dest;
3274 break;
3276 case bool_vector_intersection:
3277 for (; i < nr_words; i++)
3278 if (destdata[i] != (adata[i] & bdata[i]))
3279 goto set_dest;
3280 break;
3282 case bool_vector_set_difference:
3283 for (; i < nr_words; i++)
3284 if (destdata[i] != (adata[i] &~ bdata[i]))
3285 goto set_dest;
3286 break;
3289 return Qnil;
3292 set_dest:
3293 switch (op)
3295 case bool_vector_exclusive_or:
3296 for (; i < nr_words; i++)
3297 destdata[i] = adata[i] ^ bdata[i];
3298 break;
3300 case bool_vector_union:
3301 for (; i < nr_words; i++)
3302 destdata[i] = adata[i] | bdata[i];
3303 break;
3305 case bool_vector_intersection:
3306 for (; i < nr_words; i++)
3307 destdata[i] = adata[i] & bdata[i];
3308 break;
3310 case bool_vector_set_difference:
3311 for (; i < nr_words; i++)
3312 destdata[i] = adata[i] &~ bdata[i];
3313 break;
3315 default:
3316 eassume (0);
3319 return dest;
3322 /* PRECONDITION must be true. Return VALUE. This odd construction
3323 works around a bogus GCC diagnostic "shift count >= width of type". */
3325 static int
3326 pre_value (bool precondition, int value)
3328 eassume (precondition);
3329 return precondition ? value : 0;
3332 /* Compute the number of trailing zero bits in val. If val is zero,
3333 return the number of bits in val. */
3334 static int
3335 count_trailing_zero_bits (bits_word val)
3337 if (BITS_WORD_MAX == UINT_MAX)
3338 return count_trailing_zeros (val);
3339 if (BITS_WORD_MAX == ULONG_MAX)
3340 return count_trailing_zeros_l (val);
3341 if (BITS_WORD_MAX == ULL_MAX)
3342 return count_trailing_zeros_ll (val);
3344 /* The rest of this code is for the unlikely platform where bits_word differs
3345 in width from unsigned int, unsigned long, and unsigned long long. */
3346 val |= ~ BITS_WORD_MAX;
3347 if (BITS_WORD_MAX <= UINT_MAX)
3348 return count_trailing_zeros (val);
3349 if (BITS_WORD_MAX <= ULONG_MAX)
3350 return count_trailing_zeros_l (val);
3351 else
3353 int count;
3354 for (count = 0;
3355 count < BITS_PER_BITS_WORD - ULL_WIDTH;
3356 count += ULL_WIDTH)
3358 if (val & ULL_MAX)
3359 return count + count_trailing_zeros_ll (val);
3360 val = shift_right_ull (val);
3363 if (BITS_PER_BITS_WORD % ULL_WIDTH != 0
3364 && BITS_WORD_MAX == (bits_word) -1)
3365 val |= (bits_word) 1 << pre_value (ULONG_MAX < BITS_WORD_MAX,
3366 BITS_PER_BITS_WORD % ULL_WIDTH);
3367 return count + count_trailing_zeros_ll (val);
3371 static bits_word
3372 bits_word_to_host_endian (bits_word val)
3374 #ifndef WORDS_BIGENDIAN
3375 return val;
3376 #else
3377 if (BITS_WORD_MAX >> 31 == 1)
3378 return bswap_32 (val);
3379 # if HAVE_UNSIGNED_LONG_LONG
3380 if (BITS_WORD_MAX >> 31 >> 31 >> 1 == 1)
3381 return bswap_64 (val);
3382 # endif
3384 int i;
3385 bits_word r = 0;
3386 for (i = 0; i < sizeof val; i++)
3388 r = ((r << 1 << (CHAR_BIT - 1))
3389 | (val & ((1u << 1 << (CHAR_BIT - 1)) - 1)));
3390 val = val >> 1 >> (CHAR_BIT - 1);
3392 return r;
3394 #endif
3397 DEFUN ("bool-vector-exclusive-or", Fbool_vector_exclusive_or,
3398 Sbool_vector_exclusive_or, 2, 3, 0,
3399 doc: /* Return A ^ B, bitwise exclusive or.
3400 If optional third argument C is given, store result into C.
3401 A, B, and C must be bool vectors of the same length.
3402 Return the destination vector if it changed or nil otherwise. */)
3403 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3405 return bool_vector_binop_driver (a, b, c, bool_vector_exclusive_or);
3408 DEFUN ("bool-vector-union", Fbool_vector_union,
3409 Sbool_vector_union, 2, 3, 0,
3410 doc: /* Return A | B, bitwise or.
3411 If optional third argument C is given, store result into C.
3412 A, B, and C must be bool vectors of the same length.
3413 Return the destination vector if it changed or nil otherwise. */)
3414 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3416 return bool_vector_binop_driver (a, b, c, bool_vector_union);
3419 DEFUN ("bool-vector-intersection", Fbool_vector_intersection,
3420 Sbool_vector_intersection, 2, 3, 0,
3421 doc: /* Return A & B, bitwise and.
3422 If optional third argument C is given, store result into C.
3423 A, B, and C must be bool vectors of the same length.
3424 Return the destination vector if it changed or nil otherwise. */)
3425 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3427 return bool_vector_binop_driver (a, b, c, bool_vector_intersection);
3430 DEFUN ("bool-vector-set-difference", Fbool_vector_set_difference,
3431 Sbool_vector_set_difference, 2, 3, 0,
3432 doc: /* Return A &~ B, set difference.
3433 If optional third argument C is given, store result into C.
3434 A, B, and C must be bool vectors of the same length.
3435 Return the destination vector if it changed or nil otherwise. */)
3436 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3438 return bool_vector_binop_driver (a, b, c, bool_vector_set_difference);
3441 DEFUN ("bool-vector-subsetp", Fbool_vector_subsetp,
3442 Sbool_vector_subsetp, 2, 2, 0,
3443 doc: /* Return t if every t value in A is also t in B, nil otherwise.
3444 A and B must be bool vectors of the same length. */)
3445 (Lisp_Object a, Lisp_Object b)
3447 return bool_vector_binop_driver (a, b, b, bool_vector_subsetp);
3450 DEFUN ("bool-vector-not", Fbool_vector_not,
3451 Sbool_vector_not, 1, 2, 0,
3452 doc: /* Compute ~A, set complement.
3453 If optional second argument B is given, store result into B.
3454 A and B must be bool vectors of the same length.
3455 Return the destination vector. */)
3456 (Lisp_Object a, Lisp_Object b)
3458 EMACS_INT nr_bits;
3459 bits_word *bdata, *adata;
3460 ptrdiff_t i;
3462 CHECK_BOOL_VECTOR (a);
3463 nr_bits = bool_vector_size (a);
3465 if (NILP (b))
3466 b = make_uninit_bool_vector (nr_bits);
3467 else
3469 CHECK_BOOL_VECTOR (b);
3470 if (bool_vector_size (b) != nr_bits)
3471 wrong_length_argument (a, b, Qnil);
3474 bdata = bool_vector_data (b);
3475 adata = bool_vector_data (a);
3477 for (i = 0; i < nr_bits / BITS_PER_BITS_WORD; i++)
3478 bdata[i] = BITS_WORD_MAX & ~adata[i];
3480 if (nr_bits % BITS_PER_BITS_WORD)
3482 bits_word mword = bits_word_to_host_endian (adata[i]);
3483 mword = ~mword;
3484 mword &= bool_vector_spare_mask (nr_bits);
3485 bdata[i] = bits_word_to_host_endian (mword);
3488 return b;
3491 DEFUN ("bool-vector-count-population", Fbool_vector_count_population,
3492 Sbool_vector_count_population, 1, 1, 0,
3493 doc: /* Count how many elements in A are t.
3494 A is a bool vector. To count A's nil elements, subtract the return
3495 value from A's length. */)
3496 (Lisp_Object a)
3498 EMACS_INT count;
3499 EMACS_INT nr_bits;
3500 bits_word *adata;
3501 ptrdiff_t i, nwords;
3503 CHECK_BOOL_VECTOR (a);
3505 nr_bits = bool_vector_size (a);
3506 nwords = bool_vector_words (nr_bits);
3507 count = 0;
3508 adata = bool_vector_data (a);
3510 for (i = 0; i < nwords; i++)
3511 count += count_one_bits_word (adata[i]);
3513 return make_number (count);
3516 DEFUN ("bool-vector-count-consecutive", Fbool_vector_count_consecutive,
3517 Sbool_vector_count_consecutive, 3, 3, 0,
3518 doc: /* Count how many consecutive elements in A equal B starting at I.
3519 A is a bool vector, B is t or nil, and I is an index into A. */)
3520 (Lisp_Object a, Lisp_Object b, Lisp_Object i)
3522 EMACS_INT count;
3523 EMACS_INT nr_bits;
3524 int offset;
3525 bits_word *adata;
3526 bits_word twiddle;
3527 bits_word mword; /* Machine word. */
3528 ptrdiff_t pos, pos0;
3529 ptrdiff_t nr_words;
3531 CHECK_BOOL_VECTOR (a);
3532 CHECK_NATNUM (i);
3534 nr_bits = bool_vector_size (a);
3535 if (XFASTINT (i) > nr_bits) /* Allow one past the end for convenience */
3536 args_out_of_range (a, i);
3538 adata = bool_vector_data (a);
3539 nr_words = bool_vector_words (nr_bits);
3540 pos = XFASTINT (i) / BITS_PER_BITS_WORD;
3541 offset = XFASTINT (i) % BITS_PER_BITS_WORD;
3542 count = 0;
3544 /* By XORing with twiddle, we transform the problem of "count
3545 consecutive equal values" into "count the zero bits". The latter
3546 operation usually has hardware support. */
3547 twiddle = NILP (b) ? 0 : BITS_WORD_MAX;
3549 /* Scan the remainder of the mword at the current offset. */
3550 if (pos < nr_words && offset != 0)
3552 mword = bits_word_to_host_endian (adata[pos]);
3553 mword ^= twiddle;
3554 mword >>= offset;
3556 /* Do not count the pad bits. */
3557 mword |= (bits_word) 1 << (BITS_PER_BITS_WORD - offset);
3559 count = count_trailing_zero_bits (mword);
3560 pos++;
3561 if (count + offset < BITS_PER_BITS_WORD)
3562 return make_number (count);
3565 /* Scan whole words until we either reach the end of the vector or
3566 find an mword that doesn't completely match. twiddle is
3567 endian-independent. */
3568 pos0 = pos;
3569 while (pos < nr_words && adata[pos] == twiddle)
3570 pos++;
3571 count += (pos - pos0) * BITS_PER_BITS_WORD;
3573 if (pos < nr_words)
3575 /* If we stopped because of a mismatch, see how many bits match
3576 in the current mword. */
3577 mword = bits_word_to_host_endian (adata[pos]);
3578 mword ^= twiddle;
3579 count += count_trailing_zero_bits (mword);
3581 else if (nr_bits % BITS_PER_BITS_WORD != 0)
3583 /* If we hit the end, we might have overshot our count. Reduce
3584 the total by the number of spare bits at the end of the
3585 vector. */
3586 count -= BITS_PER_BITS_WORD - nr_bits % BITS_PER_BITS_WORD;
3589 return make_number (count);
3593 void
3594 syms_of_data (void)
3596 Lisp_Object error_tail, arith_tail;
3598 DEFSYM (Qquote, "quote");
3599 DEFSYM (Qlambda, "lambda");
3600 DEFSYM (Qerror_conditions, "error-conditions");
3601 DEFSYM (Qerror_message, "error-message");
3602 DEFSYM (Qtop_level, "top-level");
3604 DEFSYM (Qerror, "error");
3605 DEFSYM (Quser_error, "user-error");
3606 DEFSYM (Qquit, "quit");
3607 DEFSYM (Qwrong_length_argument, "wrong-length-argument");
3608 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
3609 DEFSYM (Qargs_out_of_range, "args-out-of-range");
3610 DEFSYM (Qvoid_function, "void-function");
3611 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
3612 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
3613 DEFSYM (Qvoid_variable, "void-variable");
3614 DEFSYM (Qsetting_constant, "setting-constant");
3615 DEFSYM (Qtrapping_constant, "trapping-constant");
3616 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
3618 DEFSYM (Qinvalid_function, "invalid-function");
3619 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
3620 DEFSYM (Qno_catch, "no-catch");
3621 DEFSYM (Qend_of_file, "end-of-file");
3622 DEFSYM (Qarith_error, "arith-error");
3623 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
3624 DEFSYM (Qend_of_buffer, "end-of-buffer");
3625 DEFSYM (Qbuffer_read_only, "buffer-read-only");
3626 DEFSYM (Qtext_read_only, "text-read-only");
3627 DEFSYM (Qmark_inactive, "mark-inactive");
3629 DEFSYM (Qlistp, "listp");
3630 DEFSYM (Qconsp, "consp");
3631 DEFSYM (Qsymbolp, "symbolp");
3632 DEFSYM (Qintegerp, "integerp");
3633 DEFSYM (Qnatnump, "natnump");
3634 DEFSYM (Qwholenump, "wholenump");
3635 DEFSYM (Qstringp, "stringp");
3636 DEFSYM (Qarrayp, "arrayp");
3637 DEFSYM (Qsequencep, "sequencep");
3638 DEFSYM (Qbufferp, "bufferp");
3639 DEFSYM (Qvectorp, "vectorp");
3640 DEFSYM (Qrecordp, "recordp");
3641 DEFSYM (Qbool_vector_p, "bool-vector-p");
3642 DEFSYM (Qchar_or_string_p, "char-or-string-p");
3643 DEFSYM (Qmarkerp, "markerp");
3644 #ifdef HAVE_MODULES
3645 DEFSYM (Quser_ptrp, "user-ptrp");
3646 #endif
3647 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
3648 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
3649 DEFSYM (Qfboundp, "fboundp");
3651 DEFSYM (Qfloatp, "floatp");
3652 DEFSYM (Qnumberp, "numberp");
3653 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
3655 DEFSYM (Qchar_table_p, "char-table-p");
3656 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
3658 DEFSYM (Qsubrp, "subrp");
3659 DEFSYM (Qunevalled, "unevalled");
3660 DEFSYM (Qmany, "many");
3662 DEFSYM (Qcdr, "cdr");
3664 error_tail = pure_cons (Qerror, Qnil);
3666 /* ERROR is used as a signaler for random errors for which nothing else is
3667 right. */
3669 Fput (Qerror, Qerror_conditions,
3670 error_tail);
3671 Fput (Qerror, Qerror_message,
3672 build_pure_c_string ("error"));
3674 #define PUT_ERROR(sym, tail, msg) \
3675 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3676 Fput (sym, Qerror_message, build_pure_c_string (msg))
3678 PUT_ERROR (Qquit, Qnil, "Quit");
3680 PUT_ERROR (Quser_error, error_tail, "");
3681 PUT_ERROR (Qwrong_length_argument, error_tail, "Wrong length argument");
3682 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3683 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3684 PUT_ERROR (Qvoid_function, error_tail,
3685 "Symbol's function definition is void");
3686 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3687 "Symbol's chain of function indirections contains a loop");
3688 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3689 "Symbol's chain of variable indirections contains a loop");
3690 DEFSYM (Qcircular_list, "circular-list");
3691 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3692 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3693 PUT_ERROR (Qsetting_constant, error_tail,
3694 "Attempt to set a constant symbol");
3695 PUT_ERROR (Qtrapping_constant, error_tail,
3696 "Attempt to trap writes to a constant symbol");
3697 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3698 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3699 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3700 "Wrong number of arguments");
3701 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3702 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3704 arith_tail = pure_cons (Qarith_error, error_tail);
3705 Fput (Qarith_error, Qerror_conditions, arith_tail);
3706 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3708 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3709 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3710 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3711 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3712 "Text is read-only");
3714 DEFSYM (Qrange_error, "range-error");
3715 DEFSYM (Qdomain_error, "domain-error");
3716 DEFSYM (Qsingularity_error, "singularity-error");
3717 DEFSYM (Qoverflow_error, "overflow-error");
3718 DEFSYM (Qunderflow_error, "underflow-error");
3720 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3722 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3724 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3725 "Arithmetic singularity error");
3727 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3728 "Arithmetic overflow error");
3729 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3730 "Arithmetic underflow error");
3732 /* Types that type-of returns. */
3733 DEFSYM (Qinteger, "integer");
3734 DEFSYM (Qsymbol, "symbol");
3735 DEFSYM (Qstring, "string");
3736 DEFSYM (Qcons, "cons");
3737 DEFSYM (Qmarker, "marker");
3738 DEFSYM (Qoverlay, "overlay");
3739 DEFSYM (Qfinalizer, "finalizer");
3740 #ifdef HAVE_MODULES
3741 DEFSYM (Qmodule_function, "module-function");
3742 DEFSYM (Quser_ptr, "user-ptr");
3743 #endif
3744 DEFSYM (Qfloat, "float");
3745 DEFSYM (Qwindow_configuration, "window-configuration");
3746 DEFSYM (Qprocess, "process");
3747 DEFSYM (Qwindow, "window");
3748 DEFSYM (Qsubr, "subr");
3749 DEFSYM (Qcompiled_function, "compiled-function");
3750 DEFSYM (Qbuffer, "buffer");
3751 DEFSYM (Qframe, "frame");
3752 DEFSYM (Qvector, "vector");
3753 DEFSYM (Qrecord, "record");
3754 DEFSYM (Qchar_table, "char-table");
3755 DEFSYM (Qbool_vector, "bool-vector");
3756 DEFSYM (Qhash_table, "hash-table");
3757 DEFSYM (Qthread, "thread");
3758 DEFSYM (Qmutex, "mutex");
3759 DEFSYM (Qcondition_variable, "condition-variable");
3760 DEFSYM (Qfont_spec, "font-spec");
3761 DEFSYM (Qfont_entity, "font-entity");
3762 DEFSYM (Qfont_object, "font-object");
3763 DEFSYM (Qterminal, "terminal");
3765 DEFSYM (Qdefun, "defun");
3767 DEFSYM (Qinteractive_form, "interactive-form");
3768 DEFSYM (Qdefalias_fset_function, "defalias-fset-function");
3770 defsubr (&Sindirect_variable);
3771 defsubr (&Sinteractive_form);
3772 defsubr (&Seq);
3773 defsubr (&Snull);
3774 defsubr (&Stype_of);
3775 defsubr (&Slistp);
3776 defsubr (&Snlistp);
3777 defsubr (&Sconsp);
3778 defsubr (&Satom);
3779 defsubr (&Sintegerp);
3780 defsubr (&Sinteger_or_marker_p);
3781 defsubr (&Snumberp);
3782 defsubr (&Snumber_or_marker_p);
3783 defsubr (&Sfloatp);
3784 defsubr (&Snatnump);
3785 defsubr (&Ssymbolp);
3786 defsubr (&Skeywordp);
3787 defsubr (&Sstringp);
3788 defsubr (&Smultibyte_string_p);
3789 defsubr (&Svectorp);
3790 defsubr (&Srecordp);
3791 defsubr (&Schar_table_p);
3792 defsubr (&Svector_or_char_table_p);
3793 defsubr (&Sbool_vector_p);
3794 defsubr (&Sarrayp);
3795 defsubr (&Ssequencep);
3796 defsubr (&Sbufferp);
3797 defsubr (&Smarkerp);
3798 defsubr (&Ssubrp);
3799 defsubr (&Sbyte_code_function_p);
3800 defsubr (&Smodule_function_p);
3801 defsubr (&Schar_or_string_p);
3802 defsubr (&Sthreadp);
3803 defsubr (&Smutexp);
3804 defsubr (&Scondition_variable_p);
3805 defsubr (&Scar);
3806 defsubr (&Scdr);
3807 defsubr (&Scar_safe);
3808 defsubr (&Scdr_safe);
3809 defsubr (&Ssetcar);
3810 defsubr (&Ssetcdr);
3811 defsubr (&Ssymbol_function);
3812 defsubr (&Sindirect_function);
3813 defsubr (&Ssymbol_plist);
3814 defsubr (&Ssymbol_name);
3815 defsubr (&Smakunbound);
3816 defsubr (&Sfmakunbound);
3817 defsubr (&Sboundp);
3818 defsubr (&Sfboundp);
3819 defsubr (&Sfset);
3820 defsubr (&Sdefalias);
3821 defsubr (&Ssetplist);
3822 defsubr (&Ssymbol_value);
3823 defsubr (&Sset);
3824 defsubr (&Sdefault_boundp);
3825 defsubr (&Sdefault_value);
3826 defsubr (&Sset_default);
3827 defsubr (&Ssetq_default);
3828 defsubr (&Smake_variable_buffer_local);
3829 defsubr (&Smake_local_variable);
3830 defsubr (&Skill_local_variable);
3831 defsubr (&Slocal_variable_p);
3832 defsubr (&Slocal_variable_if_set_p);
3833 defsubr (&Svariable_binding_locus);
3834 #if 0 /* XXX Remove this. --lorentey */
3835 defsubr (&Sterminal_local_value);
3836 defsubr (&Sset_terminal_local_value);
3837 #endif
3838 defsubr (&Saref);
3839 defsubr (&Saset);
3840 defsubr (&Snumber_to_string);
3841 defsubr (&Sstring_to_number);
3842 defsubr (&Seqlsign);
3843 defsubr (&Slss);
3844 defsubr (&Sgtr);
3845 defsubr (&Sleq);
3846 defsubr (&Sgeq);
3847 defsubr (&Sneq);
3848 defsubr (&Splus);
3849 defsubr (&Sminus);
3850 defsubr (&Stimes);
3851 defsubr (&Squo);
3852 defsubr (&Srem);
3853 defsubr (&Smod);
3854 defsubr (&Smax);
3855 defsubr (&Smin);
3856 defsubr (&Slogand);
3857 defsubr (&Slogior);
3858 defsubr (&Slogxor);
3859 defsubr (&Slsh);
3860 defsubr (&Sash);
3861 defsubr (&Sadd1);
3862 defsubr (&Ssub1);
3863 defsubr (&Slognot);
3864 defsubr (&Sbyteorder);
3865 defsubr (&Ssubr_arity);
3866 defsubr (&Ssubr_name);
3867 #ifdef HAVE_MODULES
3868 defsubr (&Suser_ptrp);
3869 #endif
3871 defsubr (&Sbool_vector_exclusive_or);
3872 defsubr (&Sbool_vector_union);
3873 defsubr (&Sbool_vector_intersection);
3874 defsubr (&Sbool_vector_set_difference);
3875 defsubr (&Sbool_vector_not);
3876 defsubr (&Sbool_vector_subsetp);
3877 defsubr (&Sbool_vector_count_consecutive);
3878 defsubr (&Sbool_vector_count_population);
3880 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3882 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3883 doc: /* The largest value that is representable in a Lisp integer. */);
3884 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3885 make_symbol_constant (intern_c_string ("most-positive-fixnum"));
3887 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3888 doc: /* The smallest value that is representable in a Lisp integer. */);
3889 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3890 make_symbol_constant (intern_c_string ("most-negative-fixnum"));
3892 DEFSYM (Qwatchers, "watchers");
3893 DEFSYM (Qmakunbound, "makunbound");
3894 DEFSYM (Qunlet, "unlet");
3895 DEFSYM (Qset, "set");
3896 DEFSYM (Qset_default, "set-default");
3897 defsubr (&Sadd_variable_watcher);
3898 defsubr (&Sremove_variable_watcher);
3899 defsubr (&Sget_variable_watchers);