]> code.delx.au - gnu-emacs/blob - src/data.c
Move INTEGER_TO_CONS body out of .h file
[gnu-emacs] / src / data.c
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2015 Free Software
3 Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
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.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20
21 #include <config.h>
22 #include <stdio.h>
23
24 #include <byteswap.h>
25 #include <count-one-bits.h>
26 #include <count-trailing-zeros.h>
27 #include <intprops.h>
28
29 #include "lisp.h"
30 #include "puresize.h"
31 #include "character.h"
32 #include "buffer.h"
33 #include "keyboard.h"
34 #include "frame.h"
35 #include "keymap.h"
36
37 static void swap_in_symval_forwarding (struct Lisp_Symbol *,
38 struct Lisp_Buffer_Local_Value *);
39
40 static bool
41 BOOLFWDP (union Lisp_Fwd *a)
42 {
43 return XFWDTYPE (a) == Lisp_Fwd_Bool;
44 }
45 static bool
46 INTFWDP (union Lisp_Fwd *a)
47 {
48 return XFWDTYPE (a) == Lisp_Fwd_Int;
49 }
50 static bool
51 KBOARD_OBJFWDP (union Lisp_Fwd *a)
52 {
53 return XFWDTYPE (a) == Lisp_Fwd_Kboard_Obj;
54 }
55 static bool
56 OBJFWDP (union Lisp_Fwd *a)
57 {
58 return XFWDTYPE (a) == Lisp_Fwd_Obj;
59 }
60
61 static struct Lisp_Boolfwd *
62 XBOOLFWD (union Lisp_Fwd *a)
63 {
64 eassert (BOOLFWDP (a));
65 return &a->u_boolfwd;
66 }
67 static struct Lisp_Kboard_Objfwd *
68 XKBOARD_OBJFWD (union Lisp_Fwd *a)
69 {
70 eassert (KBOARD_OBJFWDP (a));
71 return &a->u_kboard_objfwd;
72 }
73 static struct Lisp_Intfwd *
74 XINTFWD (union Lisp_Fwd *a)
75 {
76 eassert (INTFWDP (a));
77 return &a->u_intfwd;
78 }
79 static struct Lisp_Objfwd *
80 XOBJFWD (union Lisp_Fwd *a)
81 {
82 eassert (OBJFWDP (a));
83 return &a->u_objfwd;
84 }
85
86 static void
87 CHECK_SUBR (Lisp_Object x)
88 {
89 CHECK_TYPE (SUBRP (x), Qsubrp, x);
90 }
91
92 static void
93 set_blv_found (struct Lisp_Buffer_Local_Value *blv, int found)
94 {
95 eassert (found == !EQ (blv->defcell, blv->valcell));
96 blv->found = found;
97 }
98
99 static Lisp_Object
100 blv_value (struct Lisp_Buffer_Local_Value *blv)
101 {
102 return XCDR (blv->valcell);
103 }
104
105 static void
106 set_blv_value (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
107 {
108 XSETCDR (blv->valcell, val);
109 }
110
111 static void
112 set_blv_where (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
113 {
114 blv->where = val;
115 }
116
117 static void
118 set_blv_defcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
119 {
120 blv->defcell = val;
121 }
122
123 static void
124 set_blv_valcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
125 {
126 blv->valcell = val;
127 }
128
129 static _Noreturn void
130 wrong_length_argument (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
131 {
132 Lisp_Object size1 = make_number (bool_vector_size (a1));
133 Lisp_Object size2 = make_number (bool_vector_size (a2));
134 if (NILP (a3))
135 xsignal2 (Qwrong_length_argument, size1, size2);
136 else
137 xsignal3 (Qwrong_length_argument, size1, size2,
138 make_number (bool_vector_size (a3)));
139 }
140
141 Lisp_Object
142 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
143 {
144 /* If VALUE is not even a valid Lisp object, we'd want to abort here
145 where we can get a backtrace showing where it came from. We used
146 to try and do that by checking the tagbits, but nowadays all
147 tagbits are potentially valid. */
148 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
149 * emacs_abort (); */
150
151 xsignal2 (Qwrong_type_argument, predicate, value);
152 }
153
154 void
155 pure_write_error (Lisp_Object obj)
156 {
157 xsignal2 (Qerror, build_string ("Attempt to modify read-only object"), obj);
158 }
159
160 void
161 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
162 {
163 xsignal2 (Qargs_out_of_range, a1, a2);
164 }
165
166 void
167 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
168 {
169 xsignal3 (Qargs_out_of_range, a1, a2, a3);
170 }
171
172 \f
173 /* Data type predicates. */
174
175 DEFUN ("eq", Feq, Seq, 2, 2, 0,
176 doc: /* Return t if the two args are the same Lisp object. */
177 attributes: const)
178 (Lisp_Object obj1, Lisp_Object obj2)
179 {
180 if (EQ (obj1, obj2))
181 return Qt;
182 return Qnil;
183 }
184
185 DEFUN ("null", Fnull, Snull, 1, 1, 0,
186 doc: /* Return t if OBJECT is nil, and return nil otherwise. */
187 attributes: const)
188 (Lisp_Object object)
189 {
190 if (NILP (object))
191 return Qt;
192 return Qnil;
193 }
194
195 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
196 doc: /* Return a symbol representing the type of OBJECT.
197 The symbol returned names the object's basic type;
198 for example, (type-of 1) returns `integer'. */)
199 (Lisp_Object object)
200 {
201 switch (XTYPE (object))
202 {
203 case_Lisp_Int:
204 return Qinteger;
205
206 case Lisp_Symbol:
207 return Qsymbol;
208
209 case Lisp_String:
210 return Qstring;
211
212 case Lisp_Cons:
213 return Qcons;
214
215 case Lisp_Misc:
216 switch (XMISCTYPE (object))
217 {
218 case Lisp_Misc_Marker:
219 return Qmarker;
220 case Lisp_Misc_Overlay:
221 return Qoverlay;
222 case Lisp_Misc_Float:
223 return Qfloat;
224 case Lisp_Misc_Finalizer:
225 return Qfinalizer;
226 default:
227 emacs_abort ();
228 }
229
230 case Lisp_Vectorlike:
231 if (WINDOW_CONFIGURATIONP (object))
232 return Qwindow_configuration;
233 if (PROCESSP (object))
234 return Qprocess;
235 if (WINDOWP (object))
236 return Qwindow;
237 if (SUBRP (object))
238 return Qsubr;
239 if (COMPILEDP (object))
240 return Qcompiled_function;
241 if (BUFFERP (object))
242 return Qbuffer;
243 if (CHAR_TABLE_P (object))
244 return Qchar_table;
245 if (BOOL_VECTOR_P (object))
246 return Qbool_vector;
247 if (FRAMEP (object))
248 return Qframe;
249 if (HASH_TABLE_P (object))
250 return Qhash_table;
251 if (FONT_SPEC_P (object))
252 return Qfont_spec;
253 if (FONT_ENTITY_P (object))
254 return Qfont_entity;
255 if (FONT_OBJECT_P (object))
256 return Qfont_object;
257 return Qvector;
258
259 case Lisp_Float:
260 return Qfloat;
261
262 default:
263 emacs_abort ();
264 }
265 }
266
267 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
268 doc: /* Return t if OBJECT is a cons cell. */
269 attributes: const)
270 (Lisp_Object object)
271 {
272 if (CONSP (object))
273 return Qt;
274 return Qnil;
275 }
276
277 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
278 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */
279 attributes: const)
280 (Lisp_Object object)
281 {
282 if (CONSP (object))
283 return Qnil;
284 return Qt;
285 }
286
287 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
288 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
289 Otherwise, return nil. */
290 attributes: const)
291 (Lisp_Object object)
292 {
293 if (CONSP (object) || NILP (object))
294 return Qt;
295 return Qnil;
296 }
297
298 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
299 doc: /* Return t if OBJECT is not a list. Lists include nil. */
300 attributes: const)
301 (Lisp_Object object)
302 {
303 if (CONSP (object) || NILP (object))
304 return Qnil;
305 return Qt;
306 }
307 \f
308 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
309 doc: /* Return t if OBJECT is a symbol. */
310 attributes: const)
311 (Lisp_Object object)
312 {
313 if (SYMBOLP (object))
314 return Qt;
315 return Qnil;
316 }
317
318 /* Define this in C to avoid unnecessarily consing up the symbol
319 name. */
320 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
321 doc: /* Return t if OBJECT is a keyword.
322 This means that it is a symbol with a print name beginning with `:'
323 interned in the initial obarray. */)
324 (Lisp_Object object)
325 {
326 if (SYMBOLP (object)
327 && SREF (SYMBOL_NAME (object), 0) == ':'
328 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
329 return Qt;
330 return Qnil;
331 }
332
333 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
334 doc: /* Return t if OBJECT is a vector. */)
335 (Lisp_Object object)
336 {
337 if (VECTORP (object))
338 return Qt;
339 return Qnil;
340 }
341
342 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
343 doc: /* Return t if OBJECT is a string. */
344 attributes: const)
345 (Lisp_Object object)
346 {
347 if (STRINGP (object))
348 return Qt;
349 return Qnil;
350 }
351
352 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
353 1, 1, 0,
354 doc: /* Return t if OBJECT is a multibyte string.
355 Return nil if OBJECT is either a unibyte string, or not a string. */)
356 (Lisp_Object object)
357 {
358 if (STRINGP (object) && STRING_MULTIBYTE (object))
359 return Qt;
360 return Qnil;
361 }
362
363 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
364 doc: /* Return t if OBJECT is a char-table. */)
365 (Lisp_Object object)
366 {
367 if (CHAR_TABLE_P (object))
368 return Qt;
369 return Qnil;
370 }
371
372 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
373 Svector_or_char_table_p, 1, 1, 0,
374 doc: /* Return t if OBJECT is a char-table or vector. */)
375 (Lisp_Object object)
376 {
377 if (VECTORP (object) || CHAR_TABLE_P (object))
378 return Qt;
379 return Qnil;
380 }
381
382 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
383 doc: /* Return t if OBJECT is a bool-vector. */)
384 (Lisp_Object object)
385 {
386 if (BOOL_VECTOR_P (object))
387 return Qt;
388 return Qnil;
389 }
390
391 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
392 doc: /* Return t if OBJECT is an array (string or vector). */)
393 (Lisp_Object object)
394 {
395 if (ARRAYP (object))
396 return Qt;
397 return Qnil;
398 }
399
400 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
401 doc: /* Return t if OBJECT is a sequence (list or array). */)
402 (register Lisp_Object object)
403 {
404 if (CONSP (object) || NILP (object) || ARRAYP (object))
405 return Qt;
406 return Qnil;
407 }
408
409 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
410 doc: /* Return t if OBJECT is an editor buffer. */)
411 (Lisp_Object object)
412 {
413 if (BUFFERP (object))
414 return Qt;
415 return Qnil;
416 }
417
418 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
419 doc: /* Return t if OBJECT is a marker (editor pointer). */)
420 (Lisp_Object object)
421 {
422 if (MARKERP (object))
423 return Qt;
424 return Qnil;
425 }
426
427 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
428 doc: /* Return t if OBJECT is a built-in function. */)
429 (Lisp_Object object)
430 {
431 if (SUBRP (object))
432 return Qt;
433 return Qnil;
434 }
435
436 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
437 1, 1, 0,
438 doc: /* Return t if OBJECT is a byte-compiled function object. */)
439 (Lisp_Object object)
440 {
441 if (COMPILEDP (object))
442 return Qt;
443 return Qnil;
444 }
445
446 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
447 doc: /* Return t if OBJECT is a character or a string. */
448 attributes: const)
449 (register Lisp_Object object)
450 {
451 if (CHARACTERP (object) || STRINGP (object))
452 return Qt;
453 return Qnil;
454 }
455 \f
456 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
457 doc: /* Return t if OBJECT is an integer. */
458 attributes: const)
459 (Lisp_Object object)
460 {
461 if (INTEGERP (object))
462 return Qt;
463 return Qnil;
464 }
465
466 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
467 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
468 (register Lisp_Object object)
469 {
470 if (MARKERP (object) || INTEGERP (object))
471 return Qt;
472 return Qnil;
473 }
474
475 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
476 doc: /* Return t if OBJECT is a nonnegative integer. */
477 attributes: const)
478 (Lisp_Object object)
479 {
480 if (NATNUMP (object))
481 return Qt;
482 return Qnil;
483 }
484
485 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
486 doc: /* Return t if OBJECT is a number (floating point or integer). */
487 attributes: const)
488 (Lisp_Object object)
489 {
490 if (NUMBERP (object))
491 return Qt;
492 else
493 return Qnil;
494 }
495
496 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
497 Snumber_or_marker_p, 1, 1, 0,
498 doc: /* Return t if OBJECT is a number or a marker. */)
499 (Lisp_Object object)
500 {
501 if (NUMBERP (object) || MARKERP (object))
502 return Qt;
503 return Qnil;
504 }
505
506 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
507 doc: /* Return t if OBJECT is a floating point number. */
508 attributes: const)
509 (Lisp_Object object)
510 {
511 if (FLOATP (object))
512 return Qt;
513 return Qnil;
514 }
515
516 \f
517 /* Extract and set components of lists. */
518
519 DEFUN ("car", Fcar, Scar, 1, 1, 0,
520 doc: /* Return the car of LIST. If arg is nil, return nil.
521 Error if arg is not nil and not a cons cell. See also `car-safe'.
522
523 See Info node `(elisp)Cons Cells' for a discussion of related basic
524 Lisp concepts such as car, cdr, cons cell and list. */)
525 (register Lisp_Object list)
526 {
527 return CAR (list);
528 }
529
530 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
531 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
532 (Lisp_Object object)
533 {
534 return CAR_SAFE (object);
535 }
536
537 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
538 doc: /* Return the cdr of LIST. If arg is nil, return nil.
539 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
540
541 See Info node `(elisp)Cons Cells' for a discussion of related basic
542 Lisp concepts such as cdr, car, cons cell and list. */)
543 (register Lisp_Object list)
544 {
545 return CDR (list);
546 }
547
548 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
549 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
550 (Lisp_Object object)
551 {
552 return CDR_SAFE (object);
553 }
554
555 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
556 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
557 (register Lisp_Object cell, Lisp_Object newcar)
558 {
559 CHECK_CONS (cell);
560 CHECK_IMPURE (cell, XCONS (cell));
561 XSETCAR (cell, newcar);
562 return newcar;
563 }
564
565 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
566 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
567 (register Lisp_Object cell, Lisp_Object newcdr)
568 {
569 CHECK_CONS (cell);
570 CHECK_IMPURE (cell, XCONS (cell));
571 XSETCDR (cell, newcdr);
572 return newcdr;
573 }
574 \f
575 /* Extract and set components of symbols. */
576
577 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
578 doc: /* Return t if SYMBOL's value is not void.
579 Note that if `lexical-binding' is in effect, this refers to the
580 global value outside of any lexical scope. */)
581 (register Lisp_Object symbol)
582 {
583 Lisp_Object valcontents;
584 struct Lisp_Symbol *sym;
585 CHECK_SYMBOL (symbol);
586 sym = XSYMBOL (symbol);
587
588 start:
589 switch (sym->redirect)
590 {
591 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
592 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
593 case SYMBOL_LOCALIZED:
594 {
595 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
596 if (blv->fwd)
597 /* In set_internal, we un-forward vars when their value is
598 set to Qunbound. */
599 return Qt;
600 else
601 {
602 swap_in_symval_forwarding (sym, blv);
603 valcontents = blv_value (blv);
604 }
605 break;
606 }
607 case SYMBOL_FORWARDED:
608 /* In set_internal, we un-forward vars when their value is
609 set to Qunbound. */
610 return Qt;
611 default: emacs_abort ();
612 }
613
614 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
615 }
616
617 /* FIXME: Make it an alias for function-symbol! */
618 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
619 doc: /* Return t if SYMBOL's function definition is not void. */)
620 (register Lisp_Object symbol)
621 {
622 CHECK_SYMBOL (symbol);
623 return NILP (XSYMBOL (symbol)->function) ? Qnil : Qt;
624 }
625
626 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
627 doc: /* Make SYMBOL's value be void.
628 Return SYMBOL. */)
629 (register Lisp_Object symbol)
630 {
631 CHECK_SYMBOL (symbol);
632 if (SYMBOL_CONSTANT_P (symbol))
633 xsignal1 (Qsetting_constant, symbol);
634 Fset (symbol, Qunbound);
635 return symbol;
636 }
637
638 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
639 doc: /* Make SYMBOL's function definition be nil.
640 Return SYMBOL. */)
641 (register Lisp_Object symbol)
642 {
643 CHECK_SYMBOL (symbol);
644 if (NILP (symbol) || EQ (symbol, Qt))
645 xsignal1 (Qsetting_constant, symbol);
646 set_symbol_function (symbol, Qnil);
647 return symbol;
648 }
649
650 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
651 doc: /* Return SYMBOL's function definition, or nil if that is void. */)
652 (register Lisp_Object symbol)
653 {
654 CHECK_SYMBOL (symbol);
655 return XSYMBOL (symbol)->function;
656 }
657
658 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
659 doc: /* Return SYMBOL's property list. */)
660 (register Lisp_Object symbol)
661 {
662 CHECK_SYMBOL (symbol);
663 return XSYMBOL (symbol)->plist;
664 }
665
666 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
667 doc: /* Return SYMBOL's name, a string. */)
668 (register Lisp_Object symbol)
669 {
670 register Lisp_Object name;
671
672 CHECK_SYMBOL (symbol);
673 name = SYMBOL_NAME (symbol);
674 return name;
675 }
676
677 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
678 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
679 (register Lisp_Object symbol, Lisp_Object definition)
680 {
681 register Lisp_Object function;
682 CHECK_SYMBOL (symbol);
683
684 function = XSYMBOL (symbol)->function;
685
686 if (!NILP (Vautoload_queue) && !NILP (function))
687 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
688
689 if (AUTOLOADP (function))
690 Fput (symbol, Qautoload, XCDR (function));
691
692 /* Convert to eassert or remove after GC bug is found. In the
693 meantime, check unconditionally, at a slight perf hit. */
694 if (! valid_lisp_object_p (definition))
695 emacs_abort ();
696
697 set_symbol_function (symbol, definition);
698
699 return definition;
700 }
701
702 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
703 doc: /* Set SYMBOL's function definition to DEFINITION.
704 Associates the function with the current load file, if any.
705 The optional third argument DOCSTRING specifies the documentation string
706 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
707 determined by DEFINITION.
708
709 Internally, this normally uses `fset', but if SYMBOL has a
710 `defalias-fset-function' property, the associated value is used instead.
711
712 The return value is undefined. */)
713 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
714 {
715 CHECK_SYMBOL (symbol);
716 if (!NILP (Vpurify_flag)
717 /* If `definition' is a keymap, immutable (and copying) is wrong. */
718 && !KEYMAPP (definition))
719 definition = Fpurecopy (definition);
720
721 {
722 bool autoload = AUTOLOADP (definition);
723 if (NILP (Vpurify_flag) || !autoload)
724 { /* Only add autoload entries after dumping, because the ones before are
725 not useful and else we get loads of them from the loaddefs.el. */
726
727 if (AUTOLOADP (XSYMBOL (symbol)->function))
728 /* Remember that the function was already an autoload. */
729 LOADHIST_ATTACH (Fcons (Qt, symbol));
730 LOADHIST_ATTACH (Fcons (autoload ? Qautoload : Qdefun, symbol));
731 }
732 }
733
734 { /* Handle automatic advice activation. */
735 Lisp_Object hook = Fget (symbol, Qdefalias_fset_function);
736 if (!NILP (hook))
737 call2 (hook, symbol, definition);
738 else
739 Ffset (symbol, definition);
740 }
741
742 if (!NILP (docstring))
743 Fput (symbol, Qfunction_documentation, docstring);
744 /* We used to return `definition', but now that `defun' and `defmacro' expand
745 to a call to `defalias', we return `symbol' for backward compatibility
746 (bug#11686). */
747 return symbol;
748 }
749
750 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
751 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
752 (register Lisp_Object symbol, Lisp_Object newplist)
753 {
754 CHECK_SYMBOL (symbol);
755 set_symbol_plist (symbol, newplist);
756 return newplist;
757 }
758
759 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
760 doc: /* Return minimum and maximum number of args allowed for SUBR.
761 SUBR must be a built-in function.
762 The returned value is a pair (MIN . MAX). MIN is the minimum number
763 of args. MAX is the maximum number or the symbol `many', for a
764 function with `&rest' args, or `unevalled' for a special form. */)
765 (Lisp_Object subr)
766 {
767 short minargs, maxargs;
768 CHECK_SUBR (subr);
769 minargs = XSUBR (subr)->min_args;
770 maxargs = XSUBR (subr)->max_args;
771 return Fcons (make_number (minargs),
772 maxargs == MANY ? Qmany
773 : maxargs == UNEVALLED ? Qunevalled
774 : make_number (maxargs));
775 }
776
777 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
778 doc: /* Return name of subroutine SUBR.
779 SUBR must be a built-in function. */)
780 (Lisp_Object subr)
781 {
782 const char *name;
783 CHECK_SUBR (subr);
784 name = XSUBR (subr)->symbol_name;
785 return build_string (name);
786 }
787
788 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
789 doc: /* Return the interactive form of CMD or nil if none.
790 If CMD is not a command, the return value is nil.
791 Value, if non-nil, is a list (interactive SPEC). */)
792 (Lisp_Object cmd)
793 {
794 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
795
796 if (NILP (fun))
797 return Qnil;
798
799 /* Use an `interactive-form' property if present, analogous to the
800 function-documentation property. */
801 fun = cmd;
802 while (SYMBOLP (fun))
803 {
804 Lisp_Object tmp = Fget (fun, Qinteractive_form);
805 if (!NILP (tmp))
806 return tmp;
807 else
808 fun = Fsymbol_function (fun);
809 }
810
811 if (SUBRP (fun))
812 {
813 const char *spec = XSUBR (fun)->intspec;
814 if (spec)
815 return list2 (Qinteractive,
816 (*spec != '(') ? build_string (spec) :
817 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
818 }
819 else if (COMPILEDP (fun))
820 {
821 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
822 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
823 }
824 else if (AUTOLOADP (fun))
825 return Finteractive_form (Fautoload_do_load (fun, cmd, Qnil));
826 else if (CONSP (fun))
827 {
828 Lisp_Object funcar = XCAR (fun);
829 if (EQ (funcar, Qclosure))
830 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
831 else if (EQ (funcar, Qlambda))
832 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
833 }
834 return Qnil;
835 }
836
837 \f
838 /***********************************************************************
839 Getting and Setting Values of Symbols
840 ***********************************************************************/
841
842 /* Return the symbol holding SYMBOL's value. Signal
843 `cyclic-variable-indirection' if SYMBOL's chain of variable
844 indirections contains a loop. */
845
846 struct Lisp_Symbol *
847 indirect_variable (struct Lisp_Symbol *symbol)
848 {
849 struct Lisp_Symbol *tortoise, *hare;
850
851 hare = tortoise = symbol;
852
853 while (hare->redirect == SYMBOL_VARALIAS)
854 {
855 hare = SYMBOL_ALIAS (hare);
856 if (hare->redirect != SYMBOL_VARALIAS)
857 break;
858
859 hare = SYMBOL_ALIAS (hare);
860 tortoise = SYMBOL_ALIAS (tortoise);
861
862 if (hare == tortoise)
863 {
864 Lisp_Object tem;
865 XSETSYMBOL (tem, symbol);
866 xsignal1 (Qcyclic_variable_indirection, tem);
867 }
868 }
869
870 return hare;
871 }
872
873
874 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
875 doc: /* Return the variable at the end of OBJECT's variable chain.
876 If OBJECT is a symbol, follow its variable indirections (if any), and
877 return the variable at the end of the chain of aliases. See Info node
878 `(elisp)Variable Aliases'.
879
880 If OBJECT is not a symbol, just return it. If there is a loop in the
881 chain of aliases, signal a `cyclic-variable-indirection' error. */)
882 (Lisp_Object object)
883 {
884 if (SYMBOLP (object))
885 {
886 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
887 XSETSYMBOL (object, sym);
888 }
889 return object;
890 }
891
892
893 /* Given the raw contents of a symbol value cell,
894 return the Lisp value of the symbol.
895 This does not handle buffer-local variables; use
896 swap_in_symval_forwarding for that. */
897
898 Lisp_Object
899 do_symval_forwarding (register union Lisp_Fwd *valcontents)
900 {
901 register Lisp_Object val;
902 switch (XFWDTYPE (valcontents))
903 {
904 case Lisp_Fwd_Int:
905 XSETINT (val, *XINTFWD (valcontents)->intvar);
906 return val;
907
908 case Lisp_Fwd_Bool:
909 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
910
911 case Lisp_Fwd_Obj:
912 return *XOBJFWD (valcontents)->objvar;
913
914 case Lisp_Fwd_Buffer_Obj:
915 return per_buffer_value (current_buffer,
916 XBUFFER_OBJFWD (valcontents)->offset);
917
918 case Lisp_Fwd_Kboard_Obj:
919 /* We used to simply use current_kboard here, but from Lisp
920 code, its value is often unexpected. It seems nicer to
921 allow constructions like this to work as intuitively expected:
922
923 (with-selected-frame frame
924 (define-key local-function-map "\eOP" [f1]))
925
926 On the other hand, this affects the semantics of
927 last-command and real-last-command, and people may rely on
928 that. I took a quick look at the Lisp codebase, and I
929 don't think anything will break. --lorentey */
930 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
931 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
932 default: emacs_abort ();
933 }
934 }
935
936 /* Used to signal a user-friendly error when symbol WRONG is
937 not a member of CHOICE, which should be a list of symbols. */
938
939 void
940 wrong_choice (Lisp_Object choice, Lisp_Object wrong)
941 {
942 ptrdiff_t i = 0, len = XINT (Flength (choice));
943 Lisp_Object obj, *args;
944 AUTO_STRING (one_of, "One of ");
945 AUTO_STRING (comma, ", ");
946 AUTO_STRING (or, " or ");
947 AUTO_STRING (should_be_specified, " should be specified");
948
949 USE_SAFE_ALLOCA;
950 SAFE_ALLOCA_LISP (args, len * 2 + 1);
951
952 args[i++] = one_of;
953
954 for (obj = choice; !NILP (obj); obj = XCDR (obj))
955 {
956 args[i++] = SYMBOL_NAME (XCAR (obj));
957 args[i++] = (NILP (XCDR (obj)) ? should_be_specified
958 : NILP (XCDR (XCDR (obj))) ? or : comma);
959 }
960
961 obj = Fconcat (i, args);
962 SAFE_FREE ();
963 xsignal2 (Qerror, obj, wrong);
964 }
965
966 /* Used to signal a user-friendly error if WRONG is not a number or
967 integer/floating-point number outsize of inclusive MIN..MAX range. */
968
969 static void
970 wrong_range (Lisp_Object min, Lisp_Object max, Lisp_Object wrong)
971 {
972 AUTO_STRING (value_should_be_from, "Value should be from ");
973 AUTO_STRING (to, " to ");
974 xsignal2 (Qerror,
975 CALLN (Fconcat, value_should_be_from, Fnumber_to_string (min),
976 to, Fnumber_to_string (max)),
977 wrong);
978 }
979
980 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
981 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
982 buffer-independent contents of the value cell: forwarded just one
983 step past the buffer-localness.
984
985 BUF non-zero means set the value in buffer BUF instead of the
986 current buffer. This only plays a role for per-buffer variables. */
987
988 static void
989 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
990 {
991 switch (XFWDTYPE (valcontents))
992 {
993 case Lisp_Fwd_Int:
994 CHECK_NUMBER (newval);
995 *XINTFWD (valcontents)->intvar = XINT (newval);
996 break;
997
998 case Lisp_Fwd_Bool:
999 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
1000 break;
1001
1002 case Lisp_Fwd_Obj:
1003 *XOBJFWD (valcontents)->objvar = newval;
1004
1005 /* If this variable is a default for something stored
1006 in the buffer itself, such as default-fill-column,
1007 find the buffers that don't have local values for it
1008 and update them. */
1009 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
1010 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
1011 {
1012 int offset = ((char *) XOBJFWD (valcontents)->objvar
1013 - (char *) &buffer_defaults);
1014 int idx = PER_BUFFER_IDX (offset);
1015
1016 Lisp_Object tail, buf;
1017
1018 if (idx <= 0)
1019 break;
1020
1021 FOR_EACH_LIVE_BUFFER (tail, buf)
1022 {
1023 struct buffer *b = XBUFFER (buf);
1024
1025 if (! PER_BUFFER_VALUE_P (b, idx))
1026 set_per_buffer_value (b, offset, newval);
1027 }
1028 }
1029 break;
1030
1031 case Lisp_Fwd_Buffer_Obj:
1032 {
1033 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1034 Lisp_Object predicate = XBUFFER_OBJFWD (valcontents)->predicate;
1035
1036 if (!NILP (newval))
1037 {
1038 if (SYMBOLP (predicate))
1039 {
1040 Lisp_Object prop;
1041
1042 if ((prop = Fget (predicate, Qchoice), !NILP (prop)))
1043 {
1044 if (NILP (Fmemq (newval, prop)))
1045 wrong_choice (prop, newval);
1046 }
1047 else if ((prop = Fget (predicate, Qrange), !NILP (prop)))
1048 {
1049 Lisp_Object min = XCAR (prop), max = XCDR (prop);
1050
1051 if (!NUMBERP (newval)
1052 || !NILP (arithcompare (newval, min, ARITH_LESS))
1053 || !NILP (arithcompare (newval, max, ARITH_GRTR)))
1054 wrong_range (min, max, newval);
1055 }
1056 else if (FUNCTIONP (predicate))
1057 {
1058 if (NILP (call1 (predicate, newval)))
1059 wrong_type_argument (predicate, newval);
1060 }
1061 }
1062 }
1063 if (buf == NULL)
1064 buf = current_buffer;
1065 set_per_buffer_value (buf, offset, newval);
1066 }
1067 break;
1068
1069 case Lisp_Fwd_Kboard_Obj:
1070 {
1071 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
1072 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
1073 *(Lisp_Object *) p = newval;
1074 }
1075 break;
1076
1077 default:
1078 emacs_abort (); /* goto def; */
1079 }
1080 }
1081
1082 /* Set up SYMBOL to refer to its global binding. This makes it safe
1083 to alter the status of other bindings. BEWARE: this may be called
1084 during the mark phase of GC, where we assume that Lisp_Object slots
1085 of BLV are marked after this function has changed them. */
1086
1087 void
1088 swap_in_global_binding (struct Lisp_Symbol *symbol)
1089 {
1090 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
1091
1092 /* Unload the previously loaded binding. */
1093 if (blv->fwd)
1094 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1095
1096 /* Select the global binding in the symbol. */
1097 set_blv_valcell (blv, blv->defcell);
1098 if (blv->fwd)
1099 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
1100
1101 /* Indicate that the global binding is set up now. */
1102 set_blv_where (blv, Qnil);
1103 set_blv_found (blv, 0);
1104 }
1105
1106 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
1107 VALCONTENTS is the contents of its value cell,
1108 which points to a struct Lisp_Buffer_Local_Value.
1109
1110 Return the value forwarded one step past the buffer-local stage.
1111 This could be another forwarding pointer. */
1112
1113 static void
1114 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1115 {
1116 register Lisp_Object tem1;
1117
1118 eassert (blv == SYMBOL_BLV (symbol));
1119
1120 tem1 = blv->where;
1121
1122 if (NILP (tem1)
1123 || (blv->frame_local
1124 ? !EQ (selected_frame, tem1)
1125 : current_buffer != XBUFFER (tem1)))
1126 {
1127
1128 /* Unload the previously loaded binding. */
1129 tem1 = blv->valcell;
1130 if (blv->fwd)
1131 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1132 /* Choose the new binding. */
1133 {
1134 Lisp_Object var;
1135 XSETSYMBOL (var, symbol);
1136 if (blv->frame_local)
1137 {
1138 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1139 set_blv_where (blv, selected_frame);
1140 }
1141 else
1142 {
1143 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1144 set_blv_where (blv, Fcurrent_buffer ());
1145 }
1146 }
1147 if (!(blv->found = !NILP (tem1)))
1148 tem1 = blv->defcell;
1149
1150 /* Load the new binding. */
1151 set_blv_valcell (blv, tem1);
1152 if (blv->fwd)
1153 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1154 }
1155 }
1156 \f
1157 /* Find the value of a symbol, returning Qunbound if it's not bound.
1158 This is helpful for code which just wants to get a variable's value
1159 if it has one, without signaling an error.
1160 Note that it must not be possible to quit
1161 within this function. Great care is required for this. */
1162
1163 Lisp_Object
1164 find_symbol_value (Lisp_Object symbol)
1165 {
1166 struct Lisp_Symbol *sym;
1167
1168 CHECK_SYMBOL (symbol);
1169 sym = XSYMBOL (symbol);
1170
1171 start:
1172 switch (sym->redirect)
1173 {
1174 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1175 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1176 case SYMBOL_LOCALIZED:
1177 {
1178 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1179 swap_in_symval_forwarding (sym, blv);
1180 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1181 }
1182 /* FALLTHROUGH */
1183 case SYMBOL_FORWARDED:
1184 return do_symval_forwarding (SYMBOL_FWD (sym));
1185 default: emacs_abort ();
1186 }
1187 }
1188
1189 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1190 doc: /* Return SYMBOL's value. Error if that is void.
1191 Note that if `lexical-binding' is in effect, this returns the
1192 global value outside of any lexical scope. */)
1193 (Lisp_Object symbol)
1194 {
1195 Lisp_Object val;
1196
1197 val = find_symbol_value (symbol);
1198 if (!EQ (val, Qunbound))
1199 return val;
1200
1201 xsignal1 (Qvoid_variable, symbol);
1202 }
1203
1204 DEFUN ("set", Fset, Sset, 2, 2, 0,
1205 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1206 (register Lisp_Object symbol, Lisp_Object newval)
1207 {
1208 set_internal (symbol, newval, Qnil, 0);
1209 return newval;
1210 }
1211
1212 /* Store the value NEWVAL into SYMBOL.
1213 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1214 (nil stands for the current buffer/frame).
1215
1216 If BINDFLAG is false, then if this symbol is supposed to become
1217 local in every buffer where it is set, then we make it local.
1218 If BINDFLAG is true, we don't do that. */
1219
1220 void
1221 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1222 bool bindflag)
1223 {
1224 bool voide = EQ (newval, Qunbound);
1225 struct Lisp_Symbol *sym;
1226 Lisp_Object tem1;
1227
1228 /* If restoring in a dead buffer, do nothing. */
1229 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1230 return; */
1231
1232 CHECK_SYMBOL (symbol);
1233 if (SYMBOL_CONSTANT_P (symbol))
1234 {
1235 if (NILP (Fkeywordp (symbol))
1236 || !EQ (newval, Fsymbol_value (symbol)))
1237 xsignal1 (Qsetting_constant, symbol);
1238 else
1239 /* Allow setting keywords to their own value. */
1240 return;
1241 }
1242
1243 maybe_set_redisplay (symbol);
1244 sym = XSYMBOL (symbol);
1245
1246 start:
1247 switch (sym->redirect)
1248 {
1249 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1250 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1251 case SYMBOL_LOCALIZED:
1252 {
1253 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1254 if (NILP (where))
1255 {
1256 if (blv->frame_local)
1257 where = selected_frame;
1258 else
1259 XSETBUFFER (where, current_buffer);
1260 }
1261 /* If the current buffer is not the buffer whose binding is
1262 loaded, or if there may be frame-local bindings and the frame
1263 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1264 the default binding is loaded, the loaded binding may be the
1265 wrong one. */
1266 if (!EQ (blv->where, where)
1267 /* Also unload a global binding (if the var is local_if_set). */
1268 || (EQ (blv->valcell, blv->defcell)))
1269 {
1270 /* The currently loaded binding is not necessarily valid.
1271 We need to unload it, and choose a new binding. */
1272
1273 /* Write out `realvalue' to the old loaded binding. */
1274 if (blv->fwd)
1275 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1276
1277 /* Find the new binding. */
1278 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1279 tem1 = assq_no_quit (symbol,
1280 (blv->frame_local
1281 ? XFRAME (where)->param_alist
1282 : BVAR (XBUFFER (where), local_var_alist)));
1283 set_blv_where (blv, where);
1284 blv->found = 1;
1285
1286 if (NILP (tem1))
1287 {
1288 /* This buffer still sees the default value. */
1289
1290 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1291 or if this is `let' rather than `set',
1292 make CURRENT-ALIST-ELEMENT point to itself,
1293 indicating that we're seeing the default value.
1294 Likewise if the variable has been let-bound
1295 in the current buffer. */
1296 if (bindflag || !blv->local_if_set
1297 || let_shadows_buffer_binding_p (sym))
1298 {
1299 blv->found = 0;
1300 tem1 = blv->defcell;
1301 }
1302 /* If it's a local_if_set, being set not bound,
1303 and we're not within a let that was made for this buffer,
1304 create a new buffer-local binding for the variable.
1305 That means, give this buffer a new assoc for a local value
1306 and load that binding. */
1307 else
1308 {
1309 /* local_if_set is only supported for buffer-local
1310 bindings, not for frame-local bindings. */
1311 eassert (!blv->frame_local);
1312 tem1 = Fcons (symbol, XCDR (blv->defcell));
1313 bset_local_var_alist
1314 (XBUFFER (where),
1315 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1316 }
1317 }
1318
1319 /* Record which binding is now loaded. */
1320 set_blv_valcell (blv, tem1);
1321 }
1322
1323 /* Store the new value in the cons cell. */
1324 set_blv_value (blv, newval);
1325
1326 if (blv->fwd)
1327 {
1328 if (voide)
1329 /* If storing void (making the symbol void), forward only through
1330 buffer-local indicator, not through Lisp_Objfwd, etc. */
1331 blv->fwd = NULL;
1332 else
1333 store_symval_forwarding (blv->fwd, newval,
1334 BUFFERP (where)
1335 ? XBUFFER (where) : current_buffer);
1336 }
1337 break;
1338 }
1339 case SYMBOL_FORWARDED:
1340 {
1341 struct buffer *buf
1342 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1343 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1344 if (BUFFER_OBJFWDP (innercontents))
1345 {
1346 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1347 int idx = PER_BUFFER_IDX (offset);
1348 if (idx > 0
1349 && !bindflag
1350 && !let_shadows_buffer_binding_p (sym))
1351 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1352 }
1353
1354 if (voide)
1355 { /* If storing void (making the symbol void), forward only through
1356 buffer-local indicator, not through Lisp_Objfwd, etc. */
1357 sym->redirect = SYMBOL_PLAINVAL;
1358 SET_SYMBOL_VAL (sym, newval);
1359 }
1360 else
1361 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1362 break;
1363 }
1364 default: emacs_abort ();
1365 }
1366 return;
1367 }
1368 \f
1369 /* Access or set a buffer-local symbol's default value. */
1370
1371 /* Return the default value of SYMBOL, but don't check for voidness.
1372 Return Qunbound if it is void. */
1373
1374 static Lisp_Object
1375 default_value (Lisp_Object symbol)
1376 {
1377 struct Lisp_Symbol *sym;
1378
1379 CHECK_SYMBOL (symbol);
1380 sym = XSYMBOL (symbol);
1381
1382 start:
1383 switch (sym->redirect)
1384 {
1385 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1386 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1387 case SYMBOL_LOCALIZED:
1388 {
1389 /* If var is set up for a buffer that lacks a local value for it,
1390 the current value is nominally the default value.
1391 But the `realvalue' slot may be more up to date, since
1392 ordinary setq stores just that slot. So use that. */
1393 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1394 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1395 return do_symval_forwarding (blv->fwd);
1396 else
1397 return XCDR (blv->defcell);
1398 }
1399 case SYMBOL_FORWARDED:
1400 {
1401 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1402
1403 /* For a built-in buffer-local variable, get the default value
1404 rather than letting do_symval_forwarding get the current value. */
1405 if (BUFFER_OBJFWDP (valcontents))
1406 {
1407 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1408 if (PER_BUFFER_IDX (offset) != 0)
1409 return per_buffer_default (offset);
1410 }
1411
1412 /* For other variables, get the current value. */
1413 return do_symval_forwarding (valcontents);
1414 }
1415 default: emacs_abort ();
1416 }
1417 }
1418
1419 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1420 doc: /* Return t if SYMBOL has a non-void default value.
1421 This is the value that is seen in buffers that do not have their own values
1422 for this variable. */)
1423 (Lisp_Object symbol)
1424 {
1425 register Lisp_Object value;
1426
1427 value = default_value (symbol);
1428 return (EQ (value, Qunbound) ? Qnil : Qt);
1429 }
1430
1431 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1432 doc: /* Return SYMBOL's default value.
1433 This is the value that is seen in buffers that do not have their own values
1434 for this variable. The default value is meaningful for variables with
1435 local bindings in certain buffers. */)
1436 (Lisp_Object symbol)
1437 {
1438 Lisp_Object value = default_value (symbol);
1439 if (!EQ (value, Qunbound))
1440 return value;
1441
1442 xsignal1 (Qvoid_variable, symbol);
1443 }
1444
1445 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1446 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1447 The default value is seen in buffers that do not have their own values
1448 for this variable. */)
1449 (Lisp_Object symbol, Lisp_Object value)
1450 {
1451 struct Lisp_Symbol *sym;
1452
1453 CHECK_SYMBOL (symbol);
1454 if (SYMBOL_CONSTANT_P (symbol))
1455 {
1456 if (NILP (Fkeywordp (symbol))
1457 || !EQ (value, Fdefault_value (symbol)))
1458 xsignal1 (Qsetting_constant, symbol);
1459 else
1460 /* Allow setting keywords to their own value. */
1461 return value;
1462 }
1463 sym = XSYMBOL (symbol);
1464
1465 start:
1466 switch (sym->redirect)
1467 {
1468 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1469 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1470 case SYMBOL_LOCALIZED:
1471 {
1472 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1473
1474 /* Store new value into the DEFAULT-VALUE slot. */
1475 XSETCDR (blv->defcell, value);
1476
1477 /* If the default binding is now loaded, set the REALVALUE slot too. */
1478 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1479 store_symval_forwarding (blv->fwd, value, NULL);
1480 return value;
1481 }
1482 case SYMBOL_FORWARDED:
1483 {
1484 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1485
1486 /* Handle variables like case-fold-search that have special slots
1487 in the buffer.
1488 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1489 if (BUFFER_OBJFWDP (valcontents))
1490 {
1491 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1492 int idx = PER_BUFFER_IDX (offset);
1493
1494 set_per_buffer_default (offset, value);
1495
1496 /* If this variable is not always local in all buffers,
1497 set it in the buffers that don't nominally have a local value. */
1498 if (idx > 0)
1499 {
1500 struct buffer *b;
1501
1502 FOR_EACH_BUFFER (b)
1503 if (!PER_BUFFER_VALUE_P (b, idx))
1504 set_per_buffer_value (b, offset, value);
1505 }
1506 return value;
1507 }
1508 else
1509 return Fset (symbol, value);
1510 }
1511 default: emacs_abort ();
1512 }
1513 }
1514
1515 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1516 doc: /* Set the default value of variable VAR to VALUE.
1517 VAR, the variable name, is literal (not evaluated);
1518 VALUE is an expression: it is evaluated and its value returned.
1519 The default value of a variable is seen in buffers
1520 that do not have their own values for the variable.
1521
1522 More generally, you can use multiple variables and values, as in
1523 (setq-default VAR VALUE VAR VALUE...)
1524 This sets each VAR's default value to the corresponding VALUE.
1525 The VALUE for the Nth VAR can refer to the new default values
1526 of previous VARs.
1527 usage: (setq-default [VAR VALUE]...) */)
1528 (Lisp_Object args)
1529 {
1530 Lisp_Object args_left, symbol, val;
1531
1532 args_left = val = args;
1533
1534 while (CONSP (args_left))
1535 {
1536 val = eval_sub (Fcar (XCDR (args_left)));
1537 symbol = XCAR (args_left);
1538 Fset_default (symbol, val);
1539 args_left = Fcdr (XCDR (args_left));
1540 }
1541
1542 return val;
1543 }
1544 \f
1545 /* Lisp functions for creating and removing buffer-local variables. */
1546
1547 union Lisp_Val_Fwd
1548 {
1549 Lisp_Object value;
1550 union Lisp_Fwd *fwd;
1551 };
1552
1553 static struct Lisp_Buffer_Local_Value *
1554 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1555 union Lisp_Val_Fwd valcontents)
1556 {
1557 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1558 Lisp_Object symbol;
1559 Lisp_Object tem;
1560
1561 XSETSYMBOL (symbol, sym);
1562 tem = Fcons (symbol, (forwarded
1563 ? do_symval_forwarding (valcontents.fwd)
1564 : valcontents.value));
1565
1566 /* Buffer_Local_Values cannot have as realval a buffer-local
1567 or keyboard-local forwarding. */
1568 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1569 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1570 blv->fwd = forwarded ? valcontents.fwd : NULL;
1571 set_blv_where (blv, Qnil);
1572 blv->frame_local = 0;
1573 blv->local_if_set = 0;
1574 set_blv_defcell (blv, tem);
1575 set_blv_valcell (blv, tem);
1576 set_blv_found (blv, 0);
1577 return blv;
1578 }
1579
1580 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1581 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1582 doc: /* Make VARIABLE become buffer-local whenever it is set.
1583 At any time, the value for the current buffer is in effect,
1584 unless the variable has never been set in this buffer,
1585 in which case the default value is in effect.
1586 Note that binding the variable with `let', or setting it while
1587 a `let'-style binding made in this buffer is in effect,
1588 does not make the variable buffer-local. Return VARIABLE.
1589
1590 This globally affects all uses of this variable, so it belongs together with
1591 the variable declaration, rather than with its uses (if you just want to make
1592 a variable local to the current buffer for one particular use, use
1593 `make-local-variable'). Buffer-local bindings are normally cleared
1594 while setting up a new major mode, unless they have a `permanent-local'
1595 property.
1596
1597 The function `default-value' gets the default value and `set-default' sets it. */)
1598 (register Lisp_Object variable)
1599 {
1600 struct Lisp_Symbol *sym;
1601 struct Lisp_Buffer_Local_Value *blv = NULL;
1602 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1603 bool forwarded IF_LINT (= 0);
1604
1605 CHECK_SYMBOL (variable);
1606 sym = XSYMBOL (variable);
1607
1608 start:
1609 switch (sym->redirect)
1610 {
1611 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1612 case SYMBOL_PLAINVAL:
1613 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1614 if (EQ (valcontents.value, Qunbound))
1615 valcontents.value = Qnil;
1616 break;
1617 case SYMBOL_LOCALIZED:
1618 blv = SYMBOL_BLV (sym);
1619 if (blv->frame_local)
1620 error ("Symbol %s may not be buffer-local",
1621 SDATA (SYMBOL_NAME (variable)));
1622 break;
1623 case SYMBOL_FORWARDED:
1624 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1625 if (KBOARD_OBJFWDP (valcontents.fwd))
1626 error ("Symbol %s may not be buffer-local",
1627 SDATA (SYMBOL_NAME (variable)));
1628 else if (BUFFER_OBJFWDP (valcontents.fwd))
1629 return variable;
1630 break;
1631 default: emacs_abort ();
1632 }
1633
1634 if (sym->constant)
1635 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1636
1637 if (!blv)
1638 {
1639 blv = make_blv (sym, forwarded, valcontents);
1640 sym->redirect = SYMBOL_LOCALIZED;
1641 SET_SYMBOL_BLV (sym, blv);
1642 {
1643 Lisp_Object symbol;
1644 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1645 if (let_shadows_global_binding_p (symbol))
1646 {
1647 AUTO_STRING (format, "Making %s buffer-local while let-bound!");
1648 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1649 }
1650 }
1651 }
1652
1653 blv->local_if_set = 1;
1654 return variable;
1655 }
1656
1657 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1658 1, 1, "vMake Local Variable: ",
1659 doc: /* Make VARIABLE have a separate value in the current buffer.
1660 Other buffers will continue to share a common default value.
1661 (The buffer-local value of VARIABLE starts out as the same value
1662 VARIABLE previously had. If VARIABLE was void, it remains void.)
1663 Return VARIABLE.
1664
1665 If the variable is already arranged to become local when set,
1666 this function causes a local value to exist for this buffer,
1667 just as setting the variable would do.
1668
1669 This function returns VARIABLE, and therefore
1670 (set (make-local-variable \\='VARIABLE) VALUE-EXP)
1671 works.
1672
1673 See also `make-variable-buffer-local'.
1674
1675 Do not use `make-local-variable' to make a hook variable buffer-local.
1676 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1677 (Lisp_Object variable)
1678 {
1679 Lisp_Object tem;
1680 bool forwarded IF_LINT (= 0);
1681 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1682 struct Lisp_Symbol *sym;
1683 struct Lisp_Buffer_Local_Value *blv = NULL;
1684
1685 CHECK_SYMBOL (variable);
1686 sym = XSYMBOL (variable);
1687
1688 start:
1689 switch (sym->redirect)
1690 {
1691 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1692 case SYMBOL_PLAINVAL:
1693 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1694 case SYMBOL_LOCALIZED:
1695 blv = SYMBOL_BLV (sym);
1696 if (blv->frame_local)
1697 error ("Symbol %s may not be buffer-local",
1698 SDATA (SYMBOL_NAME (variable)));
1699 break;
1700 case SYMBOL_FORWARDED:
1701 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1702 if (KBOARD_OBJFWDP (valcontents.fwd))
1703 error ("Symbol %s may not be buffer-local",
1704 SDATA (SYMBOL_NAME (variable)));
1705 break;
1706 default: emacs_abort ();
1707 }
1708
1709 if (sym->constant)
1710 error ("Symbol %s may not be buffer-local",
1711 SDATA (SYMBOL_NAME (variable)));
1712
1713 if (blv ? blv->local_if_set
1714 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1715 {
1716 tem = Fboundp (variable);
1717 /* Make sure the symbol has a local value in this particular buffer,
1718 by setting it to the same value it already has. */
1719 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1720 return variable;
1721 }
1722 if (!blv)
1723 {
1724 blv = make_blv (sym, forwarded, valcontents);
1725 sym->redirect = SYMBOL_LOCALIZED;
1726 SET_SYMBOL_BLV (sym, blv);
1727 {
1728 Lisp_Object symbol;
1729 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1730 if (let_shadows_global_binding_p (symbol))
1731 {
1732 AUTO_STRING (format, "Making %s local to %s while let-bound!");
1733 CALLN (Fmessage, format, SYMBOL_NAME (variable),
1734 BVAR (current_buffer, name));
1735 }
1736 }
1737 }
1738
1739 /* Make sure this buffer has its own value of symbol. */
1740 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1741 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1742 if (NILP (tem))
1743 {
1744 if (let_shadows_buffer_binding_p (sym))
1745 {
1746 AUTO_STRING (format,
1747 "Making %s buffer-local while locally let-bound!");
1748 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1749 }
1750
1751 /* Swap out any local binding for some other buffer, and make
1752 sure the current value is permanently recorded, if it's the
1753 default value. */
1754 find_symbol_value (variable);
1755
1756 bset_local_var_alist
1757 (current_buffer,
1758 Fcons (Fcons (variable, XCDR (blv->defcell)),
1759 BVAR (current_buffer, local_var_alist)));
1760
1761 /* Make sure symbol does not think it is set up for this buffer;
1762 force it to look once again for this buffer's value. */
1763 if (current_buffer == XBUFFER (blv->where))
1764 set_blv_where (blv, Qnil);
1765 set_blv_found (blv, 0);
1766 }
1767
1768 /* If the symbol forwards into a C variable, then load the binding
1769 for this buffer now. If C code modifies the variable before we
1770 load the binding in, then that new value will clobber the default
1771 binding the next time we unload it. */
1772 if (blv->fwd)
1773 swap_in_symval_forwarding (sym, blv);
1774
1775 return variable;
1776 }
1777
1778 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1779 1, 1, "vKill Local Variable: ",
1780 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1781 From now on the default value will apply in this buffer. Return VARIABLE. */)
1782 (register Lisp_Object variable)
1783 {
1784 register Lisp_Object tem;
1785 struct Lisp_Buffer_Local_Value *blv;
1786 struct Lisp_Symbol *sym;
1787
1788 CHECK_SYMBOL (variable);
1789 sym = XSYMBOL (variable);
1790
1791 start:
1792 switch (sym->redirect)
1793 {
1794 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1795 case SYMBOL_PLAINVAL: return variable;
1796 case SYMBOL_FORWARDED:
1797 {
1798 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1799 if (BUFFER_OBJFWDP (valcontents))
1800 {
1801 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1802 int idx = PER_BUFFER_IDX (offset);
1803
1804 if (idx > 0)
1805 {
1806 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1807 set_per_buffer_value (current_buffer, offset,
1808 per_buffer_default (offset));
1809 }
1810 }
1811 return variable;
1812 }
1813 case SYMBOL_LOCALIZED:
1814 blv = SYMBOL_BLV (sym);
1815 if (blv->frame_local)
1816 return variable;
1817 break;
1818 default: emacs_abort ();
1819 }
1820
1821 /* Get rid of this buffer's alist element, if any. */
1822 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1823 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1824 if (!NILP (tem))
1825 bset_local_var_alist
1826 (current_buffer,
1827 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1828
1829 /* If the symbol is set up with the current buffer's binding
1830 loaded, recompute its value. We have to do it now, or else
1831 forwarded objects won't work right. */
1832 {
1833 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1834 if (EQ (buf, blv->where))
1835 {
1836 set_blv_where (blv, Qnil);
1837 blv->found = 0;
1838 find_symbol_value (variable);
1839 }
1840 }
1841
1842 return variable;
1843 }
1844
1845 /* Lisp functions for creating and removing buffer-local variables. */
1846
1847 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1848 when/if this is removed. */
1849
1850 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1851 1, 1, "vMake Variable Frame Local: ",
1852 doc: /* Enable VARIABLE to have frame-local bindings.
1853 This does not create any frame-local bindings for VARIABLE,
1854 it just makes them possible.
1855
1856 A frame-local binding is actually a frame parameter value.
1857 If a frame F has a value for the frame parameter named VARIABLE,
1858 that also acts as a frame-local binding for VARIABLE in F--
1859 provided this function has been called to enable VARIABLE
1860 to have frame-local bindings at all.
1861
1862 The only way to create a frame-local binding for VARIABLE in a frame
1863 is to set the VARIABLE frame parameter of that frame. See
1864 `modify-frame-parameters' for how to set frame parameters.
1865
1866 Note that since Emacs 23.1, variables cannot be both buffer-local and
1867 frame-local any more (buffer-local bindings used to take precedence over
1868 frame-local bindings). */)
1869 (Lisp_Object variable)
1870 {
1871 bool forwarded;
1872 union Lisp_Val_Fwd valcontents;
1873 struct Lisp_Symbol *sym;
1874 struct Lisp_Buffer_Local_Value *blv = NULL;
1875
1876 CHECK_SYMBOL (variable);
1877 sym = XSYMBOL (variable);
1878
1879 start:
1880 switch (sym->redirect)
1881 {
1882 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1883 case SYMBOL_PLAINVAL:
1884 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1885 if (EQ (valcontents.value, Qunbound))
1886 valcontents.value = Qnil;
1887 break;
1888 case SYMBOL_LOCALIZED:
1889 if (SYMBOL_BLV (sym)->frame_local)
1890 return variable;
1891 else
1892 error ("Symbol %s may not be frame-local",
1893 SDATA (SYMBOL_NAME (variable)));
1894 case SYMBOL_FORWARDED:
1895 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1896 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1897 error ("Symbol %s may not be frame-local",
1898 SDATA (SYMBOL_NAME (variable)));
1899 break;
1900 default: emacs_abort ();
1901 }
1902
1903 if (sym->constant)
1904 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1905
1906 blv = make_blv (sym, forwarded, valcontents);
1907 blv->frame_local = 1;
1908 sym->redirect = SYMBOL_LOCALIZED;
1909 SET_SYMBOL_BLV (sym, blv);
1910 {
1911 Lisp_Object symbol;
1912 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1913 if (let_shadows_global_binding_p (symbol))
1914 {
1915 AUTO_STRING (format, "Making %s frame-local while let-bound!");
1916 CALLN (Fmessage, format, SYMBOL_NAME (variable));
1917 }
1918 }
1919 return variable;
1920 }
1921
1922 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1923 1, 2, 0,
1924 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1925 BUFFER defaults to the current buffer. */)
1926 (Lisp_Object variable, Lisp_Object buffer)
1927 {
1928 struct buffer *buf = decode_buffer (buffer);
1929 struct Lisp_Symbol *sym;
1930
1931 CHECK_SYMBOL (variable);
1932 sym = XSYMBOL (variable);
1933
1934 start:
1935 switch (sym->redirect)
1936 {
1937 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1938 case SYMBOL_PLAINVAL: return Qnil;
1939 case SYMBOL_LOCALIZED:
1940 {
1941 Lisp_Object tail, elt, tmp;
1942 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1943 XSETBUFFER (tmp, buf);
1944 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1945
1946 if (EQ (blv->where, tmp)) /* The binding is already loaded. */
1947 return blv_found (blv) ? Qt : Qnil;
1948 else
1949 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1950 {
1951 elt = XCAR (tail);
1952 if (EQ (variable, XCAR (elt)))
1953 {
1954 eassert (!blv->frame_local);
1955 return Qt;
1956 }
1957 }
1958 return Qnil;
1959 }
1960 case SYMBOL_FORWARDED:
1961 {
1962 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1963 if (BUFFER_OBJFWDP (valcontents))
1964 {
1965 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1966 int idx = PER_BUFFER_IDX (offset);
1967 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1968 return Qt;
1969 }
1970 return Qnil;
1971 }
1972 default: emacs_abort ();
1973 }
1974 }
1975
1976 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1977 1, 2, 0,
1978 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1979 BUFFER defaults to the current buffer.
1980
1981 More precisely, return non-nil if either VARIABLE already has a local
1982 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1983 `make-variable-buffer-local'). */)
1984 (register Lisp_Object variable, Lisp_Object buffer)
1985 {
1986 struct Lisp_Symbol *sym;
1987
1988 CHECK_SYMBOL (variable);
1989 sym = XSYMBOL (variable);
1990
1991 start:
1992 switch (sym->redirect)
1993 {
1994 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1995 case SYMBOL_PLAINVAL: return Qnil;
1996 case SYMBOL_LOCALIZED:
1997 {
1998 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1999 if (blv->local_if_set)
2000 return Qt;
2001 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
2002 return Flocal_variable_p (variable, buffer);
2003 }
2004 case SYMBOL_FORWARDED:
2005 /* All BUFFER_OBJFWD slots become local if they are set. */
2006 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
2007 default: emacs_abort ();
2008 }
2009 }
2010
2011 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
2012 1, 1, 0,
2013 doc: /* Return a value indicating where VARIABLE's current binding comes from.
2014 If the current binding is buffer-local, the value is the current buffer.
2015 If the current binding is frame-local, the value is the selected frame.
2016 If the current binding is global (the default), the value is nil. */)
2017 (register Lisp_Object variable)
2018 {
2019 struct Lisp_Symbol *sym;
2020
2021 CHECK_SYMBOL (variable);
2022 sym = XSYMBOL (variable);
2023
2024 /* Make sure the current binding is actually swapped in. */
2025 find_symbol_value (variable);
2026
2027 start:
2028 switch (sym->redirect)
2029 {
2030 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
2031 case SYMBOL_PLAINVAL: return Qnil;
2032 case SYMBOL_FORWARDED:
2033 {
2034 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
2035 if (KBOARD_OBJFWDP (valcontents))
2036 return Fframe_terminal (selected_frame);
2037 else if (!BUFFER_OBJFWDP (valcontents))
2038 return Qnil;
2039 }
2040 /* FALLTHROUGH */
2041 case SYMBOL_LOCALIZED:
2042 /* For a local variable, record both the symbol and which
2043 buffer's or frame's value we are saving. */
2044 if (!NILP (Flocal_variable_p (variable, Qnil)))
2045 return Fcurrent_buffer ();
2046 else if (sym->redirect == SYMBOL_LOCALIZED
2047 && blv_found (SYMBOL_BLV (sym)))
2048 return SYMBOL_BLV (sym)->where;
2049 else
2050 return Qnil;
2051 default: emacs_abort ();
2052 }
2053 }
2054
2055 /* This code is disabled now that we use the selected frame to return
2056 keyboard-local-values. */
2057 #if 0
2058 extern struct terminal *get_terminal (Lisp_Object display, int);
2059
2060 DEFUN ("terminal-local-value", Fterminal_local_value,
2061 Sterminal_local_value, 2, 2, 0,
2062 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
2063 If SYMBOL is not a terminal-local variable, then return its normal
2064 value, like `symbol-value'.
2065
2066 TERMINAL may be a terminal object, a frame, or nil (meaning the
2067 selected frame's terminal device). */)
2068 (Lisp_Object symbol, Lisp_Object terminal)
2069 {
2070 Lisp_Object result;
2071 struct terminal *t = get_terminal (terminal, 1);
2072 push_kboard (t->kboard);
2073 result = Fsymbol_value (symbol);
2074 pop_kboard ();
2075 return result;
2076 }
2077
2078 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
2079 Sset_terminal_local_value, 3, 3, 0,
2080 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2081 If VARIABLE is not a terminal-local variable, then set its normal
2082 binding, like `set'.
2083
2084 TERMINAL may be a terminal object, a frame, or nil (meaning the
2085 selected frame's terminal device). */)
2086 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2087 {
2088 Lisp_Object result;
2089 struct terminal *t = get_terminal (terminal, 1);
2090 push_kboard (d->kboard);
2091 result = Fset (symbol, value);
2092 pop_kboard ();
2093 return result;
2094 }
2095 #endif
2096 \f
2097 /* Find the function at the end of a chain of symbol function indirections. */
2098
2099 /* If OBJECT is a symbol, find the end of its function chain and
2100 return the value found there. If OBJECT is not a symbol, just
2101 return it. If there is a cycle in the function chain, signal a
2102 cyclic-function-indirection error.
2103
2104 This is like Findirect_function, except that it doesn't signal an
2105 error if the chain ends up unbound. */
2106 Lisp_Object
2107 indirect_function (register Lisp_Object object)
2108 {
2109 Lisp_Object tortoise, hare;
2110
2111 hare = tortoise = object;
2112
2113 for (;;)
2114 {
2115 if (!SYMBOLP (hare) || NILP (hare))
2116 break;
2117 hare = XSYMBOL (hare)->function;
2118 if (!SYMBOLP (hare) || NILP (hare))
2119 break;
2120 hare = XSYMBOL (hare)->function;
2121
2122 tortoise = XSYMBOL (tortoise)->function;
2123
2124 if (EQ (hare, tortoise))
2125 xsignal1 (Qcyclic_function_indirection, object);
2126 }
2127
2128 return hare;
2129 }
2130
2131 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2132 doc: /* Return the function at the end of OBJECT's function chain.
2133 If OBJECT is not a symbol, just return it. Otherwise, follow all
2134 function indirections to find the final function binding and return it.
2135 Signal a cyclic-function-indirection error if there is a loop in the
2136 function chain of symbols. */)
2137 (register Lisp_Object object, Lisp_Object noerror)
2138 {
2139 Lisp_Object result;
2140
2141 /* Optimize for no indirection. */
2142 result = object;
2143 if (SYMBOLP (result) && !NILP (result)
2144 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2145 result = indirect_function (result);
2146 if (!NILP (result))
2147 return result;
2148
2149 return Qnil;
2150 }
2151 \f
2152 /* Extract and set vector and string elements. */
2153
2154 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2155 doc: /* Return the element of ARRAY at index IDX.
2156 ARRAY may be a vector, a string, a char-table, a bool-vector,
2157 or a byte-code object. IDX starts at 0. */)
2158 (register Lisp_Object array, Lisp_Object idx)
2159 {
2160 register EMACS_INT idxval;
2161
2162 CHECK_NUMBER (idx);
2163 idxval = XINT (idx);
2164 if (STRINGP (array))
2165 {
2166 int c;
2167 ptrdiff_t idxval_byte;
2168
2169 if (idxval < 0 || idxval >= SCHARS (array))
2170 args_out_of_range (array, idx);
2171 if (! STRING_MULTIBYTE (array))
2172 return make_number ((unsigned char) SREF (array, idxval));
2173 idxval_byte = string_char_to_byte (array, idxval);
2174
2175 c = STRING_CHAR (SDATA (array) + idxval_byte);
2176 return make_number (c);
2177 }
2178 else if (BOOL_VECTOR_P (array))
2179 {
2180 if (idxval < 0 || idxval >= bool_vector_size (array))
2181 args_out_of_range (array, idx);
2182 return bool_vector_ref (array, idxval);
2183 }
2184 else if (CHAR_TABLE_P (array))
2185 {
2186 CHECK_CHARACTER (idx);
2187 return CHAR_TABLE_REF (array, idxval);
2188 }
2189 else
2190 {
2191 ptrdiff_t size = 0;
2192 if (VECTORP (array))
2193 size = ASIZE (array);
2194 else if (COMPILEDP (array))
2195 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2196 else
2197 wrong_type_argument (Qarrayp, array);
2198
2199 if (idxval < 0 || idxval >= size)
2200 args_out_of_range (array, idx);
2201 return AREF (array, idxval);
2202 }
2203 }
2204
2205 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2206 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2207 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2208 bool-vector. IDX starts at 0. */)
2209 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2210 {
2211 register EMACS_INT idxval;
2212
2213 CHECK_NUMBER (idx);
2214 idxval = XINT (idx);
2215 CHECK_ARRAY (array, Qarrayp);
2216
2217 if (VECTORP (array))
2218 {
2219 CHECK_IMPURE (array, XVECTOR (array));
2220 if (idxval < 0 || idxval >= ASIZE (array))
2221 args_out_of_range (array, idx);
2222 ASET (array, idxval, newelt);
2223 }
2224 else if (BOOL_VECTOR_P (array))
2225 {
2226 if (idxval < 0 || idxval >= bool_vector_size (array))
2227 args_out_of_range (array, idx);
2228 bool_vector_set (array, idxval, !NILP (newelt));
2229 }
2230 else if (CHAR_TABLE_P (array))
2231 {
2232 CHECK_CHARACTER (idx);
2233 CHAR_TABLE_SET (array, idxval, newelt);
2234 }
2235 else
2236 {
2237 int c;
2238
2239 CHECK_IMPURE (array, XSTRING (array));
2240 if (idxval < 0 || idxval >= SCHARS (array))
2241 args_out_of_range (array, idx);
2242 CHECK_CHARACTER (newelt);
2243 c = XFASTINT (newelt);
2244
2245 if (STRING_MULTIBYTE (array))
2246 {
2247 ptrdiff_t idxval_byte, nbytes;
2248 int prev_bytes, new_bytes;
2249 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2250
2251 nbytes = SBYTES (array);
2252 idxval_byte = string_char_to_byte (array, idxval);
2253 p1 = SDATA (array) + idxval_byte;
2254 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2255 new_bytes = CHAR_STRING (c, p0);
2256 if (prev_bytes != new_bytes)
2257 {
2258 /* We must relocate the string data. */
2259 ptrdiff_t nchars = SCHARS (array);
2260 USE_SAFE_ALLOCA;
2261 unsigned char *str = SAFE_ALLOCA (nbytes);
2262
2263 memcpy (str, SDATA (array), nbytes);
2264 allocate_string_data (XSTRING (array), nchars,
2265 nbytes + new_bytes - prev_bytes);
2266 memcpy (SDATA (array), str, idxval_byte);
2267 p1 = SDATA (array) + idxval_byte;
2268 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2269 nbytes - (idxval_byte + prev_bytes));
2270 SAFE_FREE ();
2271 clear_string_char_byte_cache ();
2272 }
2273 while (new_bytes--)
2274 *p1++ = *p0++;
2275 }
2276 else
2277 {
2278 if (! SINGLE_BYTE_CHAR_P (c))
2279 {
2280 ptrdiff_t i;
2281
2282 for (i = SBYTES (array) - 1; i >= 0; i--)
2283 if (SREF (array, i) >= 0x80)
2284 args_out_of_range (array, newelt);
2285 /* ARRAY is an ASCII string. Convert it to a multibyte
2286 string, and try `aset' again. */
2287 STRING_SET_MULTIBYTE (array);
2288 return Faset (array, idx, newelt);
2289 }
2290 SSET (array, idxval, c);
2291 }
2292 }
2293
2294 return newelt;
2295 }
2296 \f
2297 /* Arithmetic functions */
2298
2299 Lisp_Object
2300 arithcompare (Lisp_Object num1, Lisp_Object num2, enum Arith_Comparison comparison)
2301 {
2302 double f1 = 0, f2 = 0;
2303 bool floatp = 0;
2304
2305 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2306 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2307
2308 if (FLOATP (num1) || FLOATP (num2))
2309 {
2310 floatp = 1;
2311 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2312 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2313 }
2314
2315 switch (comparison)
2316 {
2317 case ARITH_EQUAL:
2318 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2319 return Qt;
2320 return Qnil;
2321
2322 case ARITH_NOTEQUAL:
2323 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2324 return Qt;
2325 return Qnil;
2326
2327 case ARITH_LESS:
2328 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2329 return Qt;
2330 return Qnil;
2331
2332 case ARITH_LESS_OR_EQUAL:
2333 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2334 return Qt;
2335 return Qnil;
2336
2337 case ARITH_GRTR:
2338 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2339 return Qt;
2340 return Qnil;
2341
2342 case ARITH_GRTR_OR_EQUAL:
2343 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2344 return Qt;
2345 return Qnil;
2346
2347 default:
2348 emacs_abort ();
2349 }
2350 }
2351
2352 static Lisp_Object
2353 arithcompare_driver (ptrdiff_t nargs, Lisp_Object *args,
2354 enum Arith_Comparison comparison)
2355 {
2356 ptrdiff_t argnum;
2357 for (argnum = 1; argnum < nargs; ++argnum)
2358 {
2359 if (EQ (Qnil, arithcompare (args[argnum - 1], args[argnum], comparison)))
2360 return Qnil;
2361 }
2362 return Qt;
2363 }
2364
2365 DEFUN ("=", Feqlsign, Seqlsign, 1, MANY, 0,
2366 doc: /* Return t if args, all numbers or markers, are equal.
2367 usage: (= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2368 (ptrdiff_t nargs, Lisp_Object *args)
2369 {
2370 return arithcompare_driver (nargs, args, ARITH_EQUAL);
2371 }
2372
2373 DEFUN ("<", Flss, Slss, 1, MANY, 0,
2374 doc: /* Return t if each arg (a number or marker), is less than the next arg.
2375 usage: (< NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2376 (ptrdiff_t nargs, Lisp_Object *args)
2377 {
2378 return arithcompare_driver (nargs, args, ARITH_LESS);
2379 }
2380
2381 DEFUN (">", Fgtr, Sgtr, 1, MANY, 0,
2382 doc: /* Return t if each arg (a number or marker) is greater than the next arg.
2383 usage: (> NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2384 (ptrdiff_t nargs, Lisp_Object *args)
2385 {
2386 return arithcompare_driver (nargs, args, ARITH_GRTR);
2387 }
2388
2389 DEFUN ("<=", Fleq, Sleq, 1, MANY, 0,
2390 doc: /* Return t if each arg (a number or marker) is less than or equal to the next.
2391 usage: (<= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2392 (ptrdiff_t nargs, Lisp_Object *args)
2393 {
2394 return arithcompare_driver (nargs, args, ARITH_LESS_OR_EQUAL);
2395 }
2396
2397 DEFUN (">=", Fgeq, Sgeq, 1, MANY, 0,
2398 doc: /* Return t if each arg (a number or marker) is greater than or equal to the next.
2399 usage: (>= NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2400 (ptrdiff_t nargs, Lisp_Object *args)
2401 {
2402 return arithcompare_driver (nargs, args, ARITH_GRTR_OR_EQUAL);
2403 }
2404
2405 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2406 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2407 (register Lisp_Object num1, Lisp_Object num2)
2408 {
2409 return arithcompare (num1, num2, ARITH_NOTEQUAL);
2410 }
2411 \f
2412 /* Convert the integer I to a cons-of-integers, where I is not in
2413 fixnum range. */
2414
2415 #define INTBIG_TO_LISP(i, extremum) \
2416 (eassert (FIXNUM_OVERFLOW_P (i)), \
2417 (! (FIXNUM_OVERFLOW_P ((extremum) >> 16) \
2418 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2419 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2420 : ! (FIXNUM_OVERFLOW_P ((extremum) >> 16 >> 24) \
2421 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2422 ? Fcons (make_number ((i) >> 16 >> 24), \
2423 Fcons (make_number ((i) >> 16 & 0xffffff), \
2424 make_number ((i) & 0xffff))) \
2425 : make_float (i)))
2426
2427 Lisp_Object
2428 intbig_to_lisp (intmax_t i)
2429 {
2430 return INTBIG_TO_LISP (i, INTMAX_MIN);
2431 }
2432
2433 Lisp_Object
2434 uintbig_to_lisp (uintmax_t i)
2435 {
2436 return INTBIG_TO_LISP (i, UINTMAX_MAX);
2437 }
2438
2439 /* Convert the cons-of-integers, integer, or float value C to an
2440 unsigned value with maximum value MAX. Signal an error if C does not
2441 have a valid format or is out of range. */
2442 uintmax_t
2443 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2444 {
2445 bool valid = 0;
2446 uintmax_t val IF_LINT (= 0);
2447 if (INTEGERP (c))
2448 {
2449 valid = 0 <= XINT (c);
2450 val = XINT (c);
2451 }
2452 else if (FLOATP (c))
2453 {
2454 double d = XFLOAT_DATA (c);
2455 if (0 <= d
2456 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2457 {
2458 val = d;
2459 valid = 1;
2460 }
2461 }
2462 else if (CONSP (c) && NATNUMP (XCAR (c)))
2463 {
2464 uintmax_t top = XFASTINT (XCAR (c));
2465 Lisp_Object rest = XCDR (c);
2466 if (top <= UINTMAX_MAX >> 24 >> 16
2467 && CONSP (rest)
2468 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2469 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2470 {
2471 uintmax_t mid = XFASTINT (XCAR (rest));
2472 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2473 valid = 1;
2474 }
2475 else if (top <= UINTMAX_MAX >> 16)
2476 {
2477 if (CONSP (rest))
2478 rest = XCAR (rest);
2479 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2480 {
2481 val = top << 16 | XFASTINT (rest);
2482 valid = 1;
2483 }
2484 }
2485 }
2486
2487 if (! (valid && val <= max))
2488 error ("Not an in-range integer, float, or cons of integers");
2489 return val;
2490 }
2491
2492 /* Convert the cons-of-integers, integer, or float value C to a signed
2493 value with extrema MIN and MAX. Signal an error if C does not have
2494 a valid format or is out of range. */
2495 intmax_t
2496 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2497 {
2498 bool valid = 0;
2499 intmax_t val IF_LINT (= 0);
2500 if (INTEGERP (c))
2501 {
2502 val = XINT (c);
2503 valid = 1;
2504 }
2505 else if (FLOATP (c))
2506 {
2507 double d = XFLOAT_DATA (c);
2508 if (min <= d
2509 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2510 {
2511 val = d;
2512 valid = 1;
2513 }
2514 }
2515 else if (CONSP (c) && INTEGERP (XCAR (c)))
2516 {
2517 intmax_t top = XINT (XCAR (c));
2518 Lisp_Object rest = XCDR (c);
2519 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2520 && CONSP (rest)
2521 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2522 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2523 {
2524 intmax_t mid = XFASTINT (XCAR (rest));
2525 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2526 valid = 1;
2527 }
2528 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2529 {
2530 if (CONSP (rest))
2531 rest = XCAR (rest);
2532 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2533 {
2534 val = top << 16 | XFASTINT (rest);
2535 valid = 1;
2536 }
2537 }
2538 }
2539
2540 if (! (valid && min <= val && val <= max))
2541 error ("Not an in-range integer, float, or cons of integers");
2542 return val;
2543 }
2544 \f
2545 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2546 doc: /* Return the decimal representation of NUMBER as a string.
2547 Uses a minus sign if negative.
2548 NUMBER may be an integer or a floating point number. */)
2549 (Lisp_Object number)
2550 {
2551 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2552 int len;
2553
2554 CHECK_NUMBER_OR_FLOAT (number);
2555
2556 if (FLOATP (number))
2557 len = float_to_string (buffer, XFLOAT_DATA (number));
2558 else
2559 len = sprintf (buffer, "%"pI"d", XINT (number));
2560
2561 return make_unibyte_string (buffer, len);
2562 }
2563
2564 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2565 doc: /* Parse STRING as a decimal number and return the number.
2566 Ignore leading spaces and tabs, and all trailing chars. Return 0 if
2567 STRING cannot be parsed as an integer or floating point number.
2568
2569 If BASE, interpret STRING as a number in that base. If BASE isn't
2570 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2571 If the base used is not 10, STRING is always parsed as an integer. */)
2572 (register Lisp_Object string, Lisp_Object base)
2573 {
2574 register char *p;
2575 register int b;
2576 Lisp_Object val;
2577
2578 CHECK_STRING (string);
2579
2580 if (NILP (base))
2581 b = 10;
2582 else
2583 {
2584 CHECK_NUMBER (base);
2585 if (! (2 <= XINT (base) && XINT (base) <= 16))
2586 xsignal1 (Qargs_out_of_range, base);
2587 b = XINT (base);
2588 }
2589
2590 p = SSDATA (string);
2591 while (*p == ' ' || *p == '\t')
2592 p++;
2593
2594 val = string_to_number (p, b, 1);
2595 return NILP (val) ? make_number (0) : val;
2596 }
2597 \f
2598 enum arithop
2599 {
2600 Aadd,
2601 Asub,
2602 Amult,
2603 Adiv,
2604 Alogand,
2605 Alogior,
2606 Alogxor,
2607 Amax,
2608 Amin
2609 };
2610
2611 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2612 ptrdiff_t, Lisp_Object *);
2613 static Lisp_Object
2614 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2615 {
2616 Lisp_Object val;
2617 ptrdiff_t argnum, ok_args;
2618 EMACS_INT accum = 0;
2619 EMACS_INT next, ok_accum;
2620 bool overflow = 0;
2621
2622 switch (code)
2623 {
2624 case Alogior:
2625 case Alogxor:
2626 case Aadd:
2627 case Asub:
2628 accum = 0;
2629 break;
2630 case Amult:
2631 case Adiv:
2632 accum = 1;
2633 break;
2634 case Alogand:
2635 accum = -1;
2636 break;
2637 default:
2638 break;
2639 }
2640
2641 for (argnum = 0; argnum < nargs; argnum++)
2642 {
2643 if (! overflow)
2644 {
2645 ok_args = argnum;
2646 ok_accum = accum;
2647 }
2648
2649 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2650 val = args[argnum];
2651 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2652
2653 if (FLOATP (val))
2654 return float_arith_driver (ok_accum, ok_args, code,
2655 nargs, args);
2656 args[argnum] = val;
2657 next = XINT (args[argnum]);
2658 switch (code)
2659 {
2660 case Aadd:
2661 overflow |= INT_ADD_WRAPV (accum, next, &accum);
2662 break;
2663 case Asub:
2664 if (! argnum)
2665 accum = nargs == 1 ? - next : next;
2666 else
2667 overflow |= INT_SUBTRACT_WRAPV (accum, next, &accum);
2668 break;
2669 case Amult:
2670 overflow |= INT_MULTIPLY_WRAPV (accum, next, &accum);
2671 break;
2672 case Adiv:
2673 if (! (argnum || nargs == 1))
2674 accum = next;
2675 else
2676 {
2677 if (next == 0)
2678 xsignal0 (Qarith_error);
2679 if (INT_DIVIDE_OVERFLOW (accum, next))
2680 overflow = true;
2681 else
2682 accum /= next;
2683 }
2684 break;
2685 case Alogand:
2686 accum &= next;
2687 break;
2688 case Alogior:
2689 accum |= next;
2690 break;
2691 case Alogxor:
2692 accum ^= next;
2693 break;
2694 case Amax:
2695 if (!argnum || next > accum)
2696 accum = next;
2697 break;
2698 case Amin:
2699 if (!argnum || next < accum)
2700 accum = next;
2701 break;
2702 }
2703 }
2704
2705 XSETINT (val, accum);
2706 return val;
2707 }
2708
2709 #undef isnan
2710 #define isnan(x) ((x) != (x))
2711
2712 static Lisp_Object
2713 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2714 ptrdiff_t nargs, Lisp_Object *args)
2715 {
2716 register Lisp_Object val;
2717 double next;
2718
2719 for (; argnum < nargs; argnum++)
2720 {
2721 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2722 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2723
2724 if (FLOATP (val))
2725 {
2726 next = XFLOAT_DATA (val);
2727 }
2728 else
2729 {
2730 args[argnum] = val; /* runs into a compiler bug. */
2731 next = XINT (args[argnum]);
2732 }
2733 switch (code)
2734 {
2735 case Aadd:
2736 accum += next;
2737 break;
2738 case Asub:
2739 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2740 break;
2741 case Amult:
2742 accum *= next;
2743 break;
2744 case Adiv:
2745 if (! (argnum || nargs == 1))
2746 accum = next;
2747 else
2748 {
2749 if (! IEEE_FLOATING_POINT && next == 0)
2750 xsignal0 (Qarith_error);
2751 accum /= next;
2752 }
2753 break;
2754 case Alogand:
2755 case Alogior:
2756 case Alogxor:
2757 return wrong_type_argument (Qinteger_or_marker_p, val);
2758 case Amax:
2759 if (!argnum || isnan (next) || next > accum)
2760 accum = next;
2761 break;
2762 case Amin:
2763 if (!argnum || isnan (next) || next < accum)
2764 accum = next;
2765 break;
2766 }
2767 }
2768
2769 return make_float (accum);
2770 }
2771
2772
2773 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2774 doc: /* Return sum of any number of arguments, which are numbers or markers.
2775 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2776 (ptrdiff_t nargs, Lisp_Object *args)
2777 {
2778 return arith_driver (Aadd, nargs, args);
2779 }
2780
2781 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2782 doc: /* Negate number or subtract numbers or markers and return the result.
2783 With one arg, negates it. With more than one arg,
2784 subtracts all but the first from the first.
2785 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2786 (ptrdiff_t nargs, Lisp_Object *args)
2787 {
2788 return arith_driver (Asub, nargs, args);
2789 }
2790
2791 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2792 doc: /* Return product of any number of arguments, which are numbers or markers.
2793 usage: (* &rest NUMBERS-OR-MARKERS) */)
2794 (ptrdiff_t nargs, Lisp_Object *args)
2795 {
2796 return arith_driver (Amult, nargs, args);
2797 }
2798
2799 DEFUN ("/", Fquo, Squo, 1, MANY, 0,
2800 doc: /* Divide number by divisors and return the result.
2801 With two or more arguments, return first argument divided by the rest.
2802 With one argument, return 1 divided by the argument.
2803 The arguments must be numbers or markers.
2804 usage: (/ NUMBER &rest DIVISORS) */)
2805 (ptrdiff_t nargs, Lisp_Object *args)
2806 {
2807 ptrdiff_t argnum;
2808 for (argnum = 2; argnum < nargs; argnum++)
2809 if (FLOATP (args[argnum]))
2810 return float_arith_driver (0, 0, Adiv, nargs, args);
2811 return arith_driver (Adiv, nargs, args);
2812 }
2813
2814 DEFUN ("%", Frem, Srem, 2, 2, 0,
2815 doc: /* Return remainder of X divided by Y.
2816 Both must be integers or markers. */)
2817 (register Lisp_Object x, Lisp_Object y)
2818 {
2819 Lisp_Object val;
2820
2821 CHECK_NUMBER_COERCE_MARKER (x);
2822 CHECK_NUMBER_COERCE_MARKER (y);
2823
2824 if (XINT (y) == 0)
2825 xsignal0 (Qarith_error);
2826
2827 XSETINT (val, XINT (x) % XINT (y));
2828 return val;
2829 }
2830
2831 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2832 doc: /* Return X modulo Y.
2833 The result falls between zero (inclusive) and Y (exclusive).
2834 Both X and Y must be numbers or markers. */)
2835 (register Lisp_Object x, Lisp_Object y)
2836 {
2837 Lisp_Object val;
2838 EMACS_INT i1, i2;
2839
2840 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2841 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2842
2843 if (FLOATP (x) || FLOATP (y))
2844 return fmod_float (x, y);
2845
2846 i1 = XINT (x);
2847 i2 = XINT (y);
2848
2849 if (i2 == 0)
2850 xsignal0 (Qarith_error);
2851
2852 i1 %= i2;
2853
2854 /* If the "remainder" comes out with the wrong sign, fix it. */
2855 if (i2 < 0 ? i1 > 0 : i1 < 0)
2856 i1 += i2;
2857
2858 XSETINT (val, i1);
2859 return val;
2860 }
2861
2862 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2863 doc: /* Return largest of all the arguments (which must be numbers or markers).
2864 The value is always a number; markers are converted to numbers.
2865 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2866 (ptrdiff_t nargs, Lisp_Object *args)
2867 {
2868 return arith_driver (Amax, nargs, args);
2869 }
2870
2871 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2872 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2873 The value is always a number; markers are converted to numbers.
2874 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2875 (ptrdiff_t nargs, Lisp_Object *args)
2876 {
2877 return arith_driver (Amin, nargs, args);
2878 }
2879
2880 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2881 doc: /* Return bitwise-and of all the arguments.
2882 Arguments may be integers, or markers converted to integers.
2883 usage: (logand &rest INTS-OR-MARKERS) */)
2884 (ptrdiff_t nargs, Lisp_Object *args)
2885 {
2886 return arith_driver (Alogand, nargs, args);
2887 }
2888
2889 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2890 doc: /* Return bitwise-or of all the arguments.
2891 Arguments may be integers, or markers converted to integers.
2892 usage: (logior &rest INTS-OR-MARKERS) */)
2893 (ptrdiff_t nargs, Lisp_Object *args)
2894 {
2895 return arith_driver (Alogior, nargs, args);
2896 }
2897
2898 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2899 doc: /* Return bitwise-exclusive-or of all the arguments.
2900 Arguments may be integers, or markers converted to integers.
2901 usage: (logxor &rest INTS-OR-MARKERS) */)
2902 (ptrdiff_t nargs, Lisp_Object *args)
2903 {
2904 return arith_driver (Alogxor, nargs, args);
2905 }
2906
2907 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2908 doc: /* Return VALUE with its bits shifted left by COUNT.
2909 If COUNT is negative, shifting is actually to the right.
2910 In this case, the sign bit is duplicated. */)
2911 (register Lisp_Object value, Lisp_Object count)
2912 {
2913 register Lisp_Object val;
2914
2915 CHECK_NUMBER (value);
2916 CHECK_NUMBER (count);
2917
2918 if (XINT (count) >= BITS_PER_EMACS_INT)
2919 XSETINT (val, 0);
2920 else if (XINT (count) > 0)
2921 XSETINT (val, XUINT (value) << XFASTINT (count));
2922 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2923 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2924 else
2925 XSETINT (val, XINT (value) >> -XINT (count));
2926 return val;
2927 }
2928
2929 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2930 doc: /* Return VALUE with its bits shifted left by COUNT.
2931 If COUNT is negative, shifting is actually to the right.
2932 In this case, zeros are shifted in on the left. */)
2933 (register Lisp_Object value, Lisp_Object count)
2934 {
2935 register Lisp_Object val;
2936
2937 CHECK_NUMBER (value);
2938 CHECK_NUMBER (count);
2939
2940 if (XINT (count) >= BITS_PER_EMACS_INT)
2941 XSETINT (val, 0);
2942 else if (XINT (count) > 0)
2943 XSETINT (val, XUINT (value) << XFASTINT (count));
2944 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2945 XSETINT (val, 0);
2946 else
2947 XSETINT (val, XUINT (value) >> -XINT (count));
2948 return val;
2949 }
2950
2951 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2952 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2953 Markers are converted to integers. */)
2954 (register Lisp_Object number)
2955 {
2956 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2957
2958 if (FLOATP (number))
2959 return (make_float (1.0 + XFLOAT_DATA (number)));
2960
2961 XSETINT (number, XINT (number) + 1);
2962 return number;
2963 }
2964
2965 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2966 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2967 Markers are converted to integers. */)
2968 (register Lisp_Object number)
2969 {
2970 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2971
2972 if (FLOATP (number))
2973 return (make_float (-1.0 + XFLOAT_DATA (number)));
2974
2975 XSETINT (number, XINT (number) - 1);
2976 return number;
2977 }
2978
2979 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2980 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2981 (register Lisp_Object number)
2982 {
2983 CHECK_NUMBER (number);
2984 XSETINT (number, ~XINT (number));
2985 return number;
2986 }
2987
2988 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2989 doc: /* Return the byteorder for the machine.
2990 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2991 lowercase l) for small endian machines. */
2992 attributes: const)
2993 (void)
2994 {
2995 unsigned i = 0x04030201;
2996 int order = *(char *)&i == 1 ? 108 : 66;
2997
2998 return make_number (order);
2999 }
3000
3001 /* Because we round up the bool vector allocate size to word_size
3002 units, we can safely read past the "end" of the vector in the
3003 operations below. These extra bits are always zero. */
3004
3005 static bits_word
3006 bool_vector_spare_mask (EMACS_INT nr_bits)
3007 {
3008 return (((bits_word) 1) << (nr_bits % BITS_PER_BITS_WORD)) - 1;
3009 }
3010
3011 /* Info about unsigned long long, falling back on unsigned long
3012 if unsigned long long is not available. */
3013
3014 #if HAVE_UNSIGNED_LONG_LONG_INT && defined ULLONG_MAX
3015 enum { BITS_PER_ULL = CHAR_BIT * sizeof (unsigned long long) };
3016 # define ULL_MAX ULLONG_MAX
3017 #else
3018 enum { BITS_PER_ULL = CHAR_BIT * sizeof (unsigned long) };
3019 # define ULL_MAX ULONG_MAX
3020 # define count_one_bits_ll count_one_bits_l
3021 # define count_trailing_zeros_ll count_trailing_zeros_l
3022 #endif
3023
3024 /* Shift VAL right by the width of an unsigned long long.
3025 BITS_PER_ULL must be less than BITS_PER_BITS_WORD. */
3026
3027 static bits_word
3028 shift_right_ull (bits_word w)
3029 {
3030 /* Pacify bogus GCC warning about shift count exceeding type width. */
3031 int shift = BITS_PER_ULL - BITS_PER_BITS_WORD < 0 ? BITS_PER_ULL : 0;
3032 return w >> shift;
3033 }
3034
3035 /* Return the number of 1 bits in W. */
3036
3037 static int
3038 count_one_bits_word (bits_word w)
3039 {
3040 if (BITS_WORD_MAX <= UINT_MAX)
3041 return count_one_bits (w);
3042 else if (BITS_WORD_MAX <= ULONG_MAX)
3043 return count_one_bits_l (w);
3044 else
3045 {
3046 int i = 0, count = 0;
3047 while (count += count_one_bits_ll (w),
3048 (i += BITS_PER_ULL) < BITS_PER_BITS_WORD)
3049 w = shift_right_ull (w);
3050 return count;
3051 }
3052 }
3053
3054 enum bool_vector_op { bool_vector_exclusive_or,
3055 bool_vector_union,
3056 bool_vector_intersection,
3057 bool_vector_set_difference,
3058 bool_vector_subsetp };
3059
3060 static Lisp_Object
3061 bool_vector_binop_driver (Lisp_Object a,
3062 Lisp_Object b,
3063 Lisp_Object dest,
3064 enum bool_vector_op op)
3065 {
3066 EMACS_INT nr_bits;
3067 bits_word *adata, *bdata, *destdata;
3068 ptrdiff_t i = 0;
3069 ptrdiff_t nr_words;
3070
3071 CHECK_BOOL_VECTOR (a);
3072 CHECK_BOOL_VECTOR (b);
3073
3074 nr_bits = bool_vector_size (a);
3075 if (bool_vector_size (b) != nr_bits)
3076 wrong_length_argument (a, b, dest);
3077
3078 nr_words = bool_vector_words (nr_bits);
3079 adata = bool_vector_data (a);
3080 bdata = bool_vector_data (b);
3081
3082 if (NILP (dest))
3083 {
3084 dest = make_uninit_bool_vector (nr_bits);
3085 destdata = bool_vector_data (dest);
3086 }
3087 else
3088 {
3089 CHECK_BOOL_VECTOR (dest);
3090 destdata = bool_vector_data (dest);
3091 if (bool_vector_size (dest) != nr_bits)
3092 wrong_length_argument (a, b, dest);
3093
3094 switch (op)
3095 {
3096 case bool_vector_exclusive_or:
3097 for (; i < nr_words; i++)
3098 if (destdata[i] != (adata[i] ^ bdata[i]))
3099 goto set_dest;
3100 break;
3101
3102 case bool_vector_subsetp:
3103 for (; i < nr_words; i++)
3104 if (adata[i] &~ bdata[i])
3105 return Qnil;
3106 return Qt;
3107
3108 case bool_vector_union:
3109 for (; i < nr_words; i++)
3110 if (destdata[i] != (adata[i] | bdata[i]))
3111 goto set_dest;
3112 break;
3113
3114 case bool_vector_intersection:
3115 for (; i < nr_words; i++)
3116 if (destdata[i] != (adata[i] & bdata[i]))
3117 goto set_dest;
3118 break;
3119
3120 case bool_vector_set_difference:
3121 for (; i < nr_words; i++)
3122 if (destdata[i] != (adata[i] &~ bdata[i]))
3123 goto set_dest;
3124 break;
3125 }
3126
3127 return Qnil;
3128 }
3129
3130 set_dest:
3131 switch (op)
3132 {
3133 case bool_vector_exclusive_or:
3134 for (; i < nr_words; i++)
3135 destdata[i] = adata[i] ^ bdata[i];
3136 break;
3137
3138 case bool_vector_union:
3139 for (; i < nr_words; i++)
3140 destdata[i] = adata[i] | bdata[i];
3141 break;
3142
3143 case bool_vector_intersection:
3144 for (; i < nr_words; i++)
3145 destdata[i] = adata[i] & bdata[i];
3146 break;
3147
3148 case bool_vector_set_difference:
3149 for (; i < nr_words; i++)
3150 destdata[i] = adata[i] &~ bdata[i];
3151 break;
3152
3153 default:
3154 eassume (0);
3155 }
3156
3157 return dest;
3158 }
3159
3160 /* PRECONDITION must be true. Return VALUE. This odd construction
3161 works around a bogus GCC diagnostic "shift count >= width of type". */
3162
3163 static int
3164 pre_value (bool precondition, int value)
3165 {
3166 eassume (precondition);
3167 return precondition ? value : 0;
3168 }
3169
3170 /* Compute the number of trailing zero bits in val. If val is zero,
3171 return the number of bits in val. */
3172 static int
3173 count_trailing_zero_bits (bits_word val)
3174 {
3175 if (BITS_WORD_MAX == UINT_MAX)
3176 return count_trailing_zeros (val);
3177 if (BITS_WORD_MAX == ULONG_MAX)
3178 return count_trailing_zeros_l (val);
3179 if (BITS_WORD_MAX == ULL_MAX)
3180 return count_trailing_zeros_ll (val);
3181
3182 /* The rest of this code is for the unlikely platform where bits_word differs
3183 in width from unsigned int, unsigned long, and unsigned long long. */
3184 val |= ~ BITS_WORD_MAX;
3185 if (BITS_WORD_MAX <= UINT_MAX)
3186 return count_trailing_zeros (val);
3187 if (BITS_WORD_MAX <= ULONG_MAX)
3188 return count_trailing_zeros_l (val);
3189 else
3190 {
3191 int count;
3192 for (count = 0;
3193 count < BITS_PER_BITS_WORD - BITS_PER_ULL;
3194 count += BITS_PER_ULL)
3195 {
3196 if (val & ULL_MAX)
3197 return count + count_trailing_zeros_ll (val);
3198 val = shift_right_ull (val);
3199 }
3200
3201 if (BITS_PER_BITS_WORD % BITS_PER_ULL != 0
3202 && BITS_WORD_MAX == (bits_word) -1)
3203 val |= (bits_word) 1 << pre_value (ULONG_MAX < BITS_WORD_MAX,
3204 BITS_PER_BITS_WORD % BITS_PER_ULL);
3205 return count + count_trailing_zeros_ll (val);
3206 }
3207 }
3208
3209 static bits_word
3210 bits_word_to_host_endian (bits_word val)
3211 {
3212 #ifndef WORDS_BIGENDIAN
3213 return val;
3214 #else
3215 if (BITS_WORD_MAX >> 31 == 1)
3216 return bswap_32 (val);
3217 # if HAVE_UNSIGNED_LONG_LONG
3218 if (BITS_WORD_MAX >> 31 >> 31 >> 1 == 1)
3219 return bswap_64 (val);
3220 # endif
3221 {
3222 int i;
3223 bits_word r = 0;
3224 for (i = 0; i < sizeof val; i++)
3225 {
3226 r = ((r << 1 << (CHAR_BIT - 1))
3227 | (val & ((1u << 1 << (CHAR_BIT - 1)) - 1)));
3228 val = val >> 1 >> (CHAR_BIT - 1);
3229 }
3230 return r;
3231 }
3232 #endif
3233 }
3234
3235 DEFUN ("bool-vector-exclusive-or", Fbool_vector_exclusive_or,
3236 Sbool_vector_exclusive_or, 2, 3, 0,
3237 doc: /* Return A ^ B, bitwise exclusive or.
3238 If optional third argument C is given, store result into C.
3239 A, B, and C must be bool vectors of the same length.
3240 Return the destination vector if it changed or nil otherwise. */)
3241 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3242 {
3243 return bool_vector_binop_driver (a, b, c, bool_vector_exclusive_or);
3244 }
3245
3246 DEFUN ("bool-vector-union", Fbool_vector_union,
3247 Sbool_vector_union, 2, 3, 0,
3248 doc: /* Return A | B, bitwise or.
3249 If optional third argument C is given, store result into C.
3250 A, B, and C must be bool vectors of the same length.
3251 Return the destination vector if it changed or nil otherwise. */)
3252 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3253 {
3254 return bool_vector_binop_driver (a, b, c, bool_vector_union);
3255 }
3256
3257 DEFUN ("bool-vector-intersection", Fbool_vector_intersection,
3258 Sbool_vector_intersection, 2, 3, 0,
3259 doc: /* Return A & B, bitwise and.
3260 If optional third argument C is given, store result into C.
3261 A, B, and C must be bool vectors of the same length.
3262 Return the destination vector if it changed or nil otherwise. */)
3263 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3264 {
3265 return bool_vector_binop_driver (a, b, c, bool_vector_intersection);
3266 }
3267
3268 DEFUN ("bool-vector-set-difference", Fbool_vector_set_difference,
3269 Sbool_vector_set_difference, 2, 3, 0,
3270 doc: /* Return A &~ B, set difference.
3271 If optional third argument C is given, store result into C.
3272 A, B, and C must be bool vectors of the same length.
3273 Return the destination vector if it changed or nil otherwise. */)
3274 (Lisp_Object a, Lisp_Object b, Lisp_Object c)
3275 {
3276 return bool_vector_binop_driver (a, b, c, bool_vector_set_difference);
3277 }
3278
3279 DEFUN ("bool-vector-subsetp", Fbool_vector_subsetp,
3280 Sbool_vector_subsetp, 2, 2, 0,
3281 doc: /* Return t if every t value in A is also t in B, nil otherwise.
3282 A and B must be bool vectors of the same length. */)
3283 (Lisp_Object a, Lisp_Object b)
3284 {
3285 return bool_vector_binop_driver (a, b, b, bool_vector_subsetp);
3286 }
3287
3288 DEFUN ("bool-vector-not", Fbool_vector_not,
3289 Sbool_vector_not, 1, 2, 0,
3290 doc: /* Compute ~A, set complement.
3291 If optional second argument B is given, store result into B.
3292 A and B must be bool vectors of the same length.
3293 Return the destination vector. */)
3294 (Lisp_Object a, Lisp_Object b)
3295 {
3296 EMACS_INT nr_bits;
3297 bits_word *bdata, *adata;
3298 ptrdiff_t i;
3299
3300 CHECK_BOOL_VECTOR (a);
3301 nr_bits = bool_vector_size (a);
3302
3303 if (NILP (b))
3304 b = make_uninit_bool_vector (nr_bits);
3305 else
3306 {
3307 CHECK_BOOL_VECTOR (b);
3308 if (bool_vector_size (b) != nr_bits)
3309 wrong_length_argument (a, b, Qnil);
3310 }
3311
3312 bdata = bool_vector_data (b);
3313 adata = bool_vector_data (a);
3314
3315 for (i = 0; i < nr_bits / BITS_PER_BITS_WORD; i++)
3316 bdata[i] = BITS_WORD_MAX & ~adata[i];
3317
3318 if (nr_bits % BITS_PER_BITS_WORD)
3319 {
3320 bits_word mword = bits_word_to_host_endian (adata[i]);
3321 mword = ~mword;
3322 mword &= bool_vector_spare_mask (nr_bits);
3323 bdata[i] = bits_word_to_host_endian (mword);
3324 }
3325
3326 return b;
3327 }
3328
3329 DEFUN ("bool-vector-count-population", Fbool_vector_count_population,
3330 Sbool_vector_count_population, 1, 1, 0,
3331 doc: /* Count how many elements in A are t.
3332 A is a bool vector. To count A's nil elements, subtract the return
3333 value from A's length. */)
3334 (Lisp_Object a)
3335 {
3336 EMACS_INT count;
3337 EMACS_INT nr_bits;
3338 bits_word *adata;
3339 ptrdiff_t i, nwords;
3340
3341 CHECK_BOOL_VECTOR (a);
3342
3343 nr_bits = bool_vector_size (a);
3344 nwords = bool_vector_words (nr_bits);
3345 count = 0;
3346 adata = bool_vector_data (a);
3347
3348 for (i = 0; i < nwords; i++)
3349 count += count_one_bits_word (adata[i]);
3350
3351 return make_number (count);
3352 }
3353
3354 DEFUN ("bool-vector-count-consecutive", Fbool_vector_count_consecutive,
3355 Sbool_vector_count_consecutive, 3, 3, 0,
3356 doc: /* Count how many consecutive elements in A equal B starting at I.
3357 A is a bool vector, B is t or nil, and I is an index into A. */)
3358 (Lisp_Object a, Lisp_Object b, Lisp_Object i)
3359 {
3360 EMACS_INT count;
3361 EMACS_INT nr_bits;
3362 int offset;
3363 bits_word *adata;
3364 bits_word twiddle;
3365 bits_word mword; /* Machine word. */
3366 ptrdiff_t pos, pos0;
3367 ptrdiff_t nr_words;
3368
3369 CHECK_BOOL_VECTOR (a);
3370 CHECK_NATNUM (i);
3371
3372 nr_bits = bool_vector_size (a);
3373 if (XFASTINT (i) > nr_bits) /* Allow one past the end for convenience */
3374 args_out_of_range (a, i);
3375
3376 adata = bool_vector_data (a);
3377 nr_words = bool_vector_words (nr_bits);
3378 pos = XFASTINT (i) / BITS_PER_BITS_WORD;
3379 offset = XFASTINT (i) % BITS_PER_BITS_WORD;
3380 count = 0;
3381
3382 /* By XORing with twiddle, we transform the problem of "count
3383 consecutive equal values" into "count the zero bits". The latter
3384 operation usually has hardware support. */
3385 twiddle = NILP (b) ? 0 : BITS_WORD_MAX;
3386
3387 /* Scan the remainder of the mword at the current offset. */
3388 if (pos < nr_words && offset != 0)
3389 {
3390 mword = bits_word_to_host_endian (adata[pos]);
3391 mword ^= twiddle;
3392 mword >>= offset;
3393
3394 /* Do not count the pad bits. */
3395 mword |= (bits_word) 1 << (BITS_PER_BITS_WORD - offset);
3396
3397 count = count_trailing_zero_bits (mword);
3398 pos++;
3399 if (count + offset < BITS_PER_BITS_WORD)
3400 return make_number (count);
3401 }
3402
3403 /* Scan whole words until we either reach the end of the vector or
3404 find an mword that doesn't completely match. twiddle is
3405 endian-independent. */
3406 pos0 = pos;
3407 while (pos < nr_words && adata[pos] == twiddle)
3408 pos++;
3409 count += (pos - pos0) * BITS_PER_BITS_WORD;
3410
3411 if (pos < nr_words)
3412 {
3413 /* If we stopped because of a mismatch, see how many bits match
3414 in the current mword. */
3415 mword = bits_word_to_host_endian (adata[pos]);
3416 mword ^= twiddle;
3417 count += count_trailing_zero_bits (mword);
3418 }
3419 else if (nr_bits % BITS_PER_BITS_WORD != 0)
3420 {
3421 /* If we hit the end, we might have overshot our count. Reduce
3422 the total by the number of spare bits at the end of the
3423 vector. */
3424 count -= BITS_PER_BITS_WORD - nr_bits % BITS_PER_BITS_WORD;
3425 }
3426
3427 return make_number (count);
3428 }
3429
3430 \f
3431 void
3432 syms_of_data (void)
3433 {
3434 Lisp_Object error_tail, arith_tail;
3435
3436 DEFSYM (Qquote, "quote");
3437 DEFSYM (Qlambda, "lambda");
3438 DEFSYM (Qsubr, "subr");
3439 DEFSYM (Qerror_conditions, "error-conditions");
3440 DEFSYM (Qerror_message, "error-message");
3441 DEFSYM (Qtop_level, "top-level");
3442
3443 DEFSYM (Qerror, "error");
3444 DEFSYM (Quser_error, "user-error");
3445 DEFSYM (Qquit, "quit");
3446 DEFSYM (Qwrong_length_argument, "wrong-length-argument");
3447 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
3448 DEFSYM (Qargs_out_of_range, "args-out-of-range");
3449 DEFSYM (Qvoid_function, "void-function");
3450 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
3451 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
3452 DEFSYM (Qvoid_variable, "void-variable");
3453 DEFSYM (Qsetting_constant, "setting-constant");
3454 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
3455
3456 DEFSYM (Qinvalid_function, "invalid-function");
3457 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
3458 DEFSYM (Qno_catch, "no-catch");
3459 DEFSYM (Qend_of_file, "end-of-file");
3460 DEFSYM (Qarith_error, "arith-error");
3461 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
3462 DEFSYM (Qend_of_buffer, "end-of-buffer");
3463 DEFSYM (Qbuffer_read_only, "buffer-read-only");
3464 DEFSYM (Qtext_read_only, "text-read-only");
3465 DEFSYM (Qmark_inactive, "mark-inactive");
3466
3467 DEFSYM (Qlistp, "listp");
3468 DEFSYM (Qconsp, "consp");
3469 DEFSYM (Qsymbolp, "symbolp");
3470 DEFSYM (Qintegerp, "integerp");
3471 DEFSYM (Qnatnump, "natnump");
3472 DEFSYM (Qwholenump, "wholenump");
3473 DEFSYM (Qstringp, "stringp");
3474 DEFSYM (Qarrayp, "arrayp");
3475 DEFSYM (Qsequencep, "sequencep");
3476 DEFSYM (Qbufferp, "bufferp");
3477 DEFSYM (Qvectorp, "vectorp");
3478 DEFSYM (Qbool_vector_p, "bool-vector-p");
3479 DEFSYM (Qchar_or_string_p, "char-or-string-p");
3480 DEFSYM (Qmarkerp, "markerp");
3481 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
3482 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
3483 DEFSYM (Qfboundp, "fboundp");
3484
3485 DEFSYM (Qfloatp, "floatp");
3486 DEFSYM (Qnumberp, "numberp");
3487 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
3488
3489 DEFSYM (Qchar_table_p, "char-table-p");
3490 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
3491
3492 DEFSYM (Qsubrp, "subrp");
3493 DEFSYM (Qunevalled, "unevalled");
3494 DEFSYM (Qmany, "many");
3495
3496 DEFSYM (Qcdr, "cdr");
3497
3498 error_tail = pure_cons (Qerror, Qnil);
3499
3500 /* ERROR is used as a signaler for random errors for which nothing else is
3501 right. */
3502
3503 Fput (Qerror, Qerror_conditions,
3504 error_tail);
3505 Fput (Qerror, Qerror_message,
3506 build_pure_c_string ("error"));
3507
3508 #define PUT_ERROR(sym, tail, msg) \
3509 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3510 Fput (sym, Qerror_message, build_pure_c_string (msg))
3511
3512 PUT_ERROR (Qquit, Qnil, "Quit");
3513
3514 PUT_ERROR (Quser_error, error_tail, "");
3515 PUT_ERROR (Qwrong_length_argument, error_tail, "Wrong length argument");
3516 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3517 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3518 PUT_ERROR (Qvoid_function, error_tail,
3519 "Symbol's function definition is void");
3520 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3521 "Symbol's chain of function indirections contains a loop");
3522 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3523 "Symbol's chain of variable indirections contains a loop");
3524 DEFSYM (Qcircular_list, "circular-list");
3525 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3526 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3527 PUT_ERROR (Qsetting_constant, error_tail,
3528 "Attempt to set a constant symbol");
3529 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3530 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3531 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3532 "Wrong number of arguments");
3533 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3534 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3535
3536 arith_tail = pure_cons (Qarith_error, error_tail);
3537 Fput (Qarith_error, Qerror_conditions, arith_tail);
3538 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3539
3540 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3541 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3542 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3543 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3544 "Text is read-only");
3545
3546 DEFSYM (Qrange_error, "range-error");
3547 DEFSYM (Qdomain_error, "domain-error");
3548 DEFSYM (Qsingularity_error, "singularity-error");
3549 DEFSYM (Qoverflow_error, "overflow-error");
3550 DEFSYM (Qunderflow_error, "underflow-error");
3551
3552 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3553
3554 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3555
3556 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3557 "Arithmetic singularity error");
3558
3559 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3560 "Arithmetic overflow error");
3561 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3562 "Arithmetic underflow error");
3563
3564 /* Types that type-of returns. */
3565 DEFSYM (Qinteger, "integer");
3566 DEFSYM (Qsymbol, "symbol");
3567 DEFSYM (Qstring, "string");
3568 DEFSYM (Qcons, "cons");
3569 DEFSYM (Qmarker, "marker");
3570 DEFSYM (Qoverlay, "overlay");
3571 DEFSYM (Qfinalizer, "finalizer");
3572 DEFSYM (Qfloat, "float");
3573 DEFSYM (Qwindow_configuration, "window-configuration");
3574 DEFSYM (Qprocess, "process");
3575 DEFSYM (Qwindow, "window");
3576 DEFSYM (Qcompiled_function, "compiled-function");
3577 DEFSYM (Qbuffer, "buffer");
3578 DEFSYM (Qframe, "frame");
3579 DEFSYM (Qvector, "vector");
3580 DEFSYM (Qchar_table, "char-table");
3581 DEFSYM (Qbool_vector, "bool-vector");
3582 DEFSYM (Qhash_table, "hash-table");
3583
3584 DEFSYM (Qdefun, "defun");
3585
3586 DEFSYM (Qfont_spec, "font-spec");
3587 DEFSYM (Qfont_entity, "font-entity");
3588 DEFSYM (Qfont_object, "font-object");
3589
3590 DEFSYM (Qinteractive_form, "interactive-form");
3591 DEFSYM (Qdefalias_fset_function, "defalias-fset-function");
3592
3593 defsubr (&Sindirect_variable);
3594 defsubr (&Sinteractive_form);
3595 defsubr (&Seq);
3596 defsubr (&Snull);
3597 defsubr (&Stype_of);
3598 defsubr (&Slistp);
3599 defsubr (&Snlistp);
3600 defsubr (&Sconsp);
3601 defsubr (&Satom);
3602 defsubr (&Sintegerp);
3603 defsubr (&Sinteger_or_marker_p);
3604 defsubr (&Snumberp);
3605 defsubr (&Snumber_or_marker_p);
3606 defsubr (&Sfloatp);
3607 defsubr (&Snatnump);
3608 defsubr (&Ssymbolp);
3609 defsubr (&Skeywordp);
3610 defsubr (&Sstringp);
3611 defsubr (&Smultibyte_string_p);
3612 defsubr (&Svectorp);
3613 defsubr (&Schar_table_p);
3614 defsubr (&Svector_or_char_table_p);
3615 defsubr (&Sbool_vector_p);
3616 defsubr (&Sarrayp);
3617 defsubr (&Ssequencep);
3618 defsubr (&Sbufferp);
3619 defsubr (&Smarkerp);
3620 defsubr (&Ssubrp);
3621 defsubr (&Sbyte_code_function_p);
3622 defsubr (&Schar_or_string_p);
3623 defsubr (&Scar);
3624 defsubr (&Scdr);
3625 defsubr (&Scar_safe);
3626 defsubr (&Scdr_safe);
3627 defsubr (&Ssetcar);
3628 defsubr (&Ssetcdr);
3629 defsubr (&Ssymbol_function);
3630 defsubr (&Sindirect_function);
3631 defsubr (&Ssymbol_plist);
3632 defsubr (&Ssymbol_name);
3633 defsubr (&Smakunbound);
3634 defsubr (&Sfmakunbound);
3635 defsubr (&Sboundp);
3636 defsubr (&Sfboundp);
3637 defsubr (&Sfset);
3638 defsubr (&Sdefalias);
3639 defsubr (&Ssetplist);
3640 defsubr (&Ssymbol_value);
3641 defsubr (&Sset);
3642 defsubr (&Sdefault_boundp);
3643 defsubr (&Sdefault_value);
3644 defsubr (&Sset_default);
3645 defsubr (&Ssetq_default);
3646 defsubr (&Smake_variable_buffer_local);
3647 defsubr (&Smake_local_variable);
3648 defsubr (&Skill_local_variable);
3649 defsubr (&Smake_variable_frame_local);
3650 defsubr (&Slocal_variable_p);
3651 defsubr (&Slocal_variable_if_set_p);
3652 defsubr (&Svariable_binding_locus);
3653 #if 0 /* XXX Remove this. --lorentey */
3654 defsubr (&Sterminal_local_value);
3655 defsubr (&Sset_terminal_local_value);
3656 #endif
3657 defsubr (&Saref);
3658 defsubr (&Saset);
3659 defsubr (&Snumber_to_string);
3660 defsubr (&Sstring_to_number);
3661 defsubr (&Seqlsign);
3662 defsubr (&Slss);
3663 defsubr (&Sgtr);
3664 defsubr (&Sleq);
3665 defsubr (&Sgeq);
3666 defsubr (&Sneq);
3667 defsubr (&Splus);
3668 defsubr (&Sminus);
3669 defsubr (&Stimes);
3670 defsubr (&Squo);
3671 defsubr (&Srem);
3672 defsubr (&Smod);
3673 defsubr (&Smax);
3674 defsubr (&Smin);
3675 defsubr (&Slogand);
3676 defsubr (&Slogior);
3677 defsubr (&Slogxor);
3678 defsubr (&Slsh);
3679 defsubr (&Sash);
3680 defsubr (&Sadd1);
3681 defsubr (&Ssub1);
3682 defsubr (&Slognot);
3683 defsubr (&Sbyteorder);
3684 defsubr (&Ssubr_arity);
3685 defsubr (&Ssubr_name);
3686
3687 defsubr (&Sbool_vector_exclusive_or);
3688 defsubr (&Sbool_vector_union);
3689 defsubr (&Sbool_vector_intersection);
3690 defsubr (&Sbool_vector_set_difference);
3691 defsubr (&Sbool_vector_not);
3692 defsubr (&Sbool_vector_subsetp);
3693 defsubr (&Sbool_vector_count_consecutive);
3694 defsubr (&Sbool_vector_count_population);
3695
3696 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3697
3698 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3699 doc: /* The largest value that is representable in a Lisp integer. */);
3700 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3701 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3702
3703 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3704 doc: /* The smallest value that is representable in a Lisp integer. */);
3705 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3706 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;
3707 }