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