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