* process.h (PSET): Remove.
[emacs.git] / src / data.c
blob6cd3649d45f3b3554b83f016a2196463c2c16107
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include <intprops.h>
28 #include "lisp.h"
29 #include "puresize.h"
30 #include "character.h"
31 #include "buffer.h"
32 #include "keyboard.h"
33 #include "frame.h"
34 #include "syssignal.h"
35 #include "termhooks.h" /* For FRAME_KBOARD reference in y-or-n-p. */
36 #include "font.h"
37 #include "keymap.h"
39 #include <float.h>
40 /* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
41 #ifndef IEEE_FLOATING_POINT
42 #if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
43 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
44 #define IEEE_FLOATING_POINT 1
45 #else
46 #define IEEE_FLOATING_POINT 0
47 #endif
48 #endif
50 #include <math.h>
52 Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
53 static Lisp_Object Qsubr;
54 Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
55 Lisp_Object Qerror, Quser_error, Qquit, Qargs_out_of_range;
56 static Lisp_Object Qwrong_type_argument;
57 Lisp_Object Qvoid_variable, Qvoid_function;
58 static Lisp_Object Qcyclic_function_indirection;
59 static Lisp_Object Qcyclic_variable_indirection;
60 Lisp_Object Qcircular_list;
61 static Lisp_Object Qsetting_constant;
62 Lisp_Object Qinvalid_read_syntax;
63 Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
64 Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
65 Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
66 Lisp_Object Qtext_read_only;
68 Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
69 static Lisp_Object Qnatnump;
70 Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
71 Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
72 Lisp_Object Qbuffer_or_string_p;
73 static Lisp_Object Qkeywordp, Qboundp;
74 Lisp_Object Qfboundp;
75 Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
77 Lisp_Object Qcdr;
78 static Lisp_Object Qad_advice_info, Qad_activate_internal;
80 Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
81 Lisp_Object Qoverflow_error, Qunderflow_error;
83 Lisp_Object Qfloatp;
84 Lisp_Object Qnumberp, Qnumber_or_marker_p;
86 Lisp_Object Qinteger, Qinterval, Qfloat, Qvector;
87 Lisp_Object Qsymbol, Qstring, Qcons, Qmisc;
88 Lisp_Object Qwindow;
89 static Lisp_Object Qoverlay, Qwindow_configuration;
90 static Lisp_Object Qprocess, Qmarker;
91 static Lisp_Object Qcompiled_function, Qframe;
92 Lisp_Object Qbuffer;
93 static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
94 static Lisp_Object Qsubrp, Qmany, Qunevalled;
95 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
96 static Lisp_Object Qdefun;
98 Lisp_Object Qinteractive_form;
100 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
103 Lisp_Object
104 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
106 /* If VALUE is not even a valid Lisp object, we'd want to abort here
107 where we can get a backtrace showing where it came from. We used
108 to try and do that by checking the tagbits, but nowadays all
109 tagbits are potentially valid. */
110 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
111 * abort (); */
113 xsignal2 (Qwrong_type_argument, predicate, value);
116 void
117 pure_write_error (void)
119 error ("Attempt to modify read-only object");
122 void
123 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
125 xsignal2 (Qargs_out_of_range, a1, a2);
128 void
129 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
131 xsignal3 (Qargs_out_of_range, a1, a2, a3);
135 /* Data type predicates. */
137 DEFUN ("eq", Feq, Seq, 2, 2, 0,
138 doc: /* Return t if the two args are the same Lisp object. */)
139 (Lisp_Object obj1, Lisp_Object obj2)
141 if (EQ (obj1, obj2))
142 return Qt;
143 return Qnil;
146 DEFUN ("null", Fnull, Snull, 1, 1, 0,
147 doc: /* Return t if OBJECT is nil. */)
148 (Lisp_Object object)
150 if (NILP (object))
151 return Qt;
152 return Qnil;
155 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
156 doc: /* Return a symbol representing the type of OBJECT.
157 The symbol returned names the object's basic type;
158 for example, (type-of 1) returns `integer'. */)
159 (Lisp_Object object)
161 switch (XTYPE (object))
163 case_Lisp_Int:
164 return Qinteger;
166 case Lisp_Symbol:
167 return Qsymbol;
169 case Lisp_String:
170 return Qstring;
172 case Lisp_Cons:
173 return Qcons;
175 case Lisp_Misc:
176 switch (XMISCTYPE (object))
178 case Lisp_Misc_Marker:
179 return Qmarker;
180 case Lisp_Misc_Overlay:
181 return Qoverlay;
182 case Lisp_Misc_Float:
183 return Qfloat;
185 abort ();
187 case Lisp_Vectorlike:
188 if (WINDOW_CONFIGURATIONP (object))
189 return Qwindow_configuration;
190 if (PROCESSP (object))
191 return Qprocess;
192 if (WINDOWP (object))
193 return Qwindow;
194 if (SUBRP (object))
195 return Qsubr;
196 if (COMPILEDP (object))
197 return Qcompiled_function;
198 if (BUFFERP (object))
199 return Qbuffer;
200 if (CHAR_TABLE_P (object))
201 return Qchar_table;
202 if (BOOL_VECTOR_P (object))
203 return Qbool_vector;
204 if (FRAMEP (object))
205 return Qframe;
206 if (HASH_TABLE_P (object))
207 return Qhash_table;
208 if (FONT_SPEC_P (object))
209 return Qfont_spec;
210 if (FONT_ENTITY_P (object))
211 return Qfont_entity;
212 if (FONT_OBJECT_P (object))
213 return Qfont_object;
214 return Qvector;
216 case Lisp_Float:
217 return Qfloat;
219 default:
220 abort ();
224 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
225 doc: /* Return t if OBJECT is a cons cell. */)
226 (Lisp_Object object)
228 if (CONSP (object))
229 return Qt;
230 return Qnil;
233 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
234 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
235 (Lisp_Object object)
237 if (CONSP (object))
238 return Qnil;
239 return Qt;
242 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
243 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
244 Otherwise, return nil. */)
245 (Lisp_Object object)
247 if (CONSP (object) || NILP (object))
248 return Qt;
249 return Qnil;
252 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
253 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
254 (Lisp_Object object)
256 if (CONSP (object) || NILP (object))
257 return Qnil;
258 return Qt;
261 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
262 doc: /* Return t if OBJECT is a symbol. */)
263 (Lisp_Object object)
265 if (SYMBOLP (object))
266 return Qt;
267 return Qnil;
270 /* Define this in C to avoid unnecessarily consing up the symbol
271 name. */
272 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
273 doc: /* Return t if OBJECT is a keyword.
274 This means that it is a symbol with a print name beginning with `:'
275 interned in the initial obarray. */)
276 (Lisp_Object object)
278 if (SYMBOLP (object)
279 && SREF (SYMBOL_NAME (object), 0) == ':'
280 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
281 return Qt;
282 return Qnil;
285 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
286 doc: /* Return t if OBJECT is a vector. */)
287 (Lisp_Object object)
289 if (VECTORP (object))
290 return Qt;
291 return Qnil;
294 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
295 doc: /* Return t if OBJECT is a string. */)
296 (Lisp_Object object)
298 if (STRINGP (object))
299 return Qt;
300 return Qnil;
303 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
304 1, 1, 0,
305 doc: /* Return t if OBJECT is a multibyte string. */)
306 (Lisp_Object object)
308 if (STRINGP (object) && STRING_MULTIBYTE (object))
309 return Qt;
310 return Qnil;
313 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
314 doc: /* Return t if OBJECT is a char-table. */)
315 (Lisp_Object object)
317 if (CHAR_TABLE_P (object))
318 return Qt;
319 return Qnil;
322 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
323 Svector_or_char_table_p, 1, 1, 0,
324 doc: /* Return t if OBJECT is a char-table or vector. */)
325 (Lisp_Object object)
327 if (VECTORP (object) || CHAR_TABLE_P (object))
328 return Qt;
329 return Qnil;
332 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
333 doc: /* Return t if OBJECT is a bool-vector. */)
334 (Lisp_Object object)
336 if (BOOL_VECTOR_P (object))
337 return Qt;
338 return Qnil;
341 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
342 doc: /* Return t if OBJECT is an array (string or vector). */)
343 (Lisp_Object object)
345 if (ARRAYP (object))
346 return Qt;
347 return Qnil;
350 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
351 doc: /* Return t if OBJECT is a sequence (list or array). */)
352 (register Lisp_Object object)
354 if (CONSP (object) || NILP (object) || ARRAYP (object))
355 return Qt;
356 return Qnil;
359 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
360 doc: /* Return t if OBJECT is an editor buffer. */)
361 (Lisp_Object object)
363 if (BUFFERP (object))
364 return Qt;
365 return Qnil;
368 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
369 doc: /* Return t if OBJECT is a marker (editor pointer). */)
370 (Lisp_Object object)
372 if (MARKERP (object))
373 return Qt;
374 return Qnil;
377 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
378 doc: /* Return t if OBJECT is a built-in function. */)
379 (Lisp_Object object)
381 if (SUBRP (object))
382 return Qt;
383 return Qnil;
386 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
387 1, 1, 0,
388 doc: /* Return t if OBJECT is a byte-compiled function object. */)
389 (Lisp_Object object)
391 if (COMPILEDP (object))
392 return Qt;
393 return Qnil;
396 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
397 doc: /* Return t if OBJECT is a character or a string. */)
398 (register Lisp_Object object)
400 if (CHARACTERP (object) || STRINGP (object))
401 return Qt;
402 return Qnil;
405 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
406 doc: /* Return t if OBJECT is an integer. */)
407 (Lisp_Object object)
409 if (INTEGERP (object))
410 return Qt;
411 return Qnil;
414 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
415 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
416 (register Lisp_Object object)
418 if (MARKERP (object) || INTEGERP (object))
419 return Qt;
420 return Qnil;
423 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
424 doc: /* Return t if OBJECT is a nonnegative integer. */)
425 (Lisp_Object object)
427 if (NATNUMP (object))
428 return Qt;
429 return Qnil;
432 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
433 doc: /* Return t if OBJECT is a number (floating point or integer). */)
434 (Lisp_Object object)
436 if (NUMBERP (object))
437 return Qt;
438 else
439 return Qnil;
442 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
443 Snumber_or_marker_p, 1, 1, 0,
444 doc: /* Return t if OBJECT is a number or a marker. */)
445 (Lisp_Object object)
447 if (NUMBERP (object) || MARKERP (object))
448 return Qt;
449 return Qnil;
452 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
453 doc: /* Return t if OBJECT is a floating point number. */)
454 (Lisp_Object object)
456 if (FLOATP (object))
457 return Qt;
458 return Qnil;
462 /* Extract and set components of lists */
464 DEFUN ("car", Fcar, Scar, 1, 1, 0,
465 doc: /* Return the car of LIST. If arg is nil, return nil.
466 Error if arg is not nil and not a cons cell. See also `car-safe'.
468 See Info node `(elisp)Cons Cells' for a discussion of related basic
469 Lisp concepts such as car, cdr, cons cell and list. */)
470 (register Lisp_Object list)
472 return CAR (list);
475 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
476 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
477 (Lisp_Object object)
479 return CAR_SAFE (object);
482 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
483 doc: /* Return the cdr of LIST. If arg is nil, return nil.
484 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
486 See Info node `(elisp)Cons Cells' for a discussion of related basic
487 Lisp concepts such as cdr, car, cons cell and list. */)
488 (register Lisp_Object list)
490 return CDR (list);
493 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
494 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
495 (Lisp_Object object)
497 return CDR_SAFE (object);
500 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
501 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
502 (register Lisp_Object cell, Lisp_Object newcar)
504 CHECK_CONS (cell);
505 CHECK_IMPURE (cell);
506 XSETCAR (cell, newcar);
507 return newcar;
510 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
511 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
512 (register Lisp_Object cell, Lisp_Object newcdr)
514 CHECK_CONS (cell);
515 CHECK_IMPURE (cell);
516 XSETCDR (cell, newcdr);
517 return newcdr;
520 /* Extract and set components of symbols. */
522 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
523 doc: /* Return t if SYMBOL's value is not void. */)
524 (register Lisp_Object symbol)
526 Lisp_Object valcontents;
527 struct Lisp_Symbol *sym;
528 CHECK_SYMBOL (symbol);
529 sym = XSYMBOL (symbol);
531 start:
532 switch (sym->redirect)
534 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
535 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
536 case SYMBOL_LOCALIZED:
538 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
539 if (blv->fwd)
540 /* In set_internal, we un-forward vars when their value is
541 set to Qunbound. */
542 return Qt;
543 else
545 swap_in_symval_forwarding (sym, blv);
546 valcontents = blv_value (blv);
548 break;
550 case SYMBOL_FORWARDED:
551 /* In set_internal, we un-forward vars when their value is
552 set to Qunbound. */
553 return Qt;
554 default: abort ();
557 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
560 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
561 doc: /* Return t if SYMBOL's function definition is not void. */)
562 (register Lisp_Object symbol)
564 CHECK_SYMBOL (symbol);
565 return EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt;
568 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
569 doc: /* Make SYMBOL's value be void.
570 Return SYMBOL. */)
571 (register Lisp_Object symbol)
573 CHECK_SYMBOL (symbol);
574 if (SYMBOL_CONSTANT_P (symbol))
575 xsignal1 (Qsetting_constant, symbol);
576 Fset (symbol, Qunbound);
577 return symbol;
580 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
581 doc: /* Make SYMBOL's function definition be void.
582 Return SYMBOL. */)
583 (register Lisp_Object symbol)
585 CHECK_SYMBOL (symbol);
586 if (NILP (symbol) || EQ (symbol, Qt))
587 xsignal1 (Qsetting_constant, symbol);
588 set_symbol_function (symbol, Qunbound);
589 return symbol;
592 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
593 doc: /* Return SYMBOL's function definition. Error if that is void. */)
594 (register Lisp_Object symbol)
596 CHECK_SYMBOL (symbol);
597 if (!EQ (XSYMBOL (symbol)->function, Qunbound))
598 return XSYMBOL (symbol)->function;
599 xsignal1 (Qvoid_function, symbol);
602 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
603 doc: /* Return SYMBOL's property list. */)
604 (register Lisp_Object symbol)
606 CHECK_SYMBOL (symbol);
607 return XSYMBOL (symbol)->plist;
610 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
611 doc: /* Return SYMBOL's name, a string. */)
612 (register Lisp_Object symbol)
614 register Lisp_Object name;
616 CHECK_SYMBOL (symbol);
617 name = SYMBOL_NAME (symbol);
618 return name;
621 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
622 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
623 (register Lisp_Object symbol, Lisp_Object definition)
625 register Lisp_Object function;
627 CHECK_SYMBOL (symbol);
628 if (NILP (symbol) || EQ (symbol, Qt))
629 xsignal1 (Qsetting_constant, symbol);
631 function = XSYMBOL (symbol)->function;
633 if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
634 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
636 if (CONSP (function) && EQ (XCAR (function), Qautoload))
637 Fput (symbol, Qautoload, XCDR (function));
639 set_symbol_function (symbol, definition);
640 /* Handle automatic advice activation. */
641 if (CONSP (XSYMBOL (symbol)->plist)
642 && !NILP (Fget (symbol, Qad_advice_info)))
644 call2 (Qad_activate_internal, symbol, Qnil);
645 definition = XSYMBOL (symbol)->function;
647 return definition;
650 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
651 doc: /* Set SYMBOL's function definition to DEFINITION.
652 Associates the function with the current load file, if any.
653 The optional third argument DOCSTRING specifies the documentation string
654 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
655 determined by DEFINITION.
656 The return value is undefined. */)
657 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
659 CHECK_SYMBOL (symbol);
660 if (CONSP (XSYMBOL (symbol)->function)
661 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
662 LOADHIST_ATTACH (Fcons (Qt, symbol));
663 if (!NILP (Vpurify_flag)
664 /* If `definition' is a keymap, immutable (and copying) is wrong. */
665 && !KEYMAPP (definition))
666 definition = Fpurecopy (definition);
667 definition = Ffset (symbol, definition);
668 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
669 if (!NILP (docstring))
670 Fput (symbol, Qfunction_documentation, docstring);
671 /* We used to return `definition', but now that `defun' and `defmacro' expand
672 to a call to `defalias', we return `symbol' for backward compatibility
673 (bug#11686). */
674 return symbol;
677 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
678 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
679 (register Lisp_Object symbol, Lisp_Object newplist)
681 CHECK_SYMBOL (symbol);
682 set_symbol_plist (symbol, newplist);
683 return newplist;
686 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
687 doc: /* Return minimum and maximum number of args allowed for SUBR.
688 SUBR must be a built-in function.
689 The returned value is a pair (MIN . MAX). MIN is the minimum number
690 of args. MAX is the maximum number or the symbol `many', for a
691 function with `&rest' args, or `unevalled' for a special form. */)
692 (Lisp_Object subr)
694 short minargs, maxargs;
695 CHECK_SUBR (subr);
696 minargs = XSUBR (subr)->min_args;
697 maxargs = XSUBR (subr)->max_args;
698 if (maxargs == MANY)
699 return Fcons (make_number (minargs), Qmany);
700 else if (maxargs == UNEVALLED)
701 return Fcons (make_number (minargs), Qunevalled);
702 else
703 return Fcons (make_number (minargs), make_number (maxargs));
706 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
707 doc: /* Return name of subroutine SUBR.
708 SUBR must be a built-in function. */)
709 (Lisp_Object subr)
711 const char *name;
712 CHECK_SUBR (subr);
713 name = XSUBR (subr)->symbol_name;
714 return build_string (name);
717 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
718 doc: /* Return the interactive form of CMD or nil if none.
719 If CMD is not a command, the return value is nil.
720 Value, if non-nil, is a list \(interactive SPEC). */)
721 (Lisp_Object cmd)
723 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
725 if (NILP (fun) || EQ (fun, Qunbound))
726 return Qnil;
728 /* Use an `interactive-form' property if present, analogous to the
729 function-documentation property. */
730 fun = cmd;
731 while (SYMBOLP (fun))
733 Lisp_Object tmp = Fget (fun, Qinteractive_form);
734 if (!NILP (tmp))
735 return tmp;
736 else
737 fun = Fsymbol_function (fun);
740 if (SUBRP (fun))
742 const char *spec = XSUBR (fun)->intspec;
743 if (spec)
744 return list2 (Qinteractive,
745 (*spec != '(') ? build_string (spec) :
746 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
748 else if (COMPILEDP (fun))
750 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
751 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
753 else if (CONSP (fun))
755 Lisp_Object funcar = XCAR (fun);
756 if (EQ (funcar, Qclosure))
757 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
758 else if (EQ (funcar, Qlambda))
759 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
760 else if (EQ (funcar, Qautoload))
762 struct gcpro gcpro1;
763 GCPRO1 (cmd);
764 Fautoload_do_load (fun, cmd, Qnil);
765 UNGCPRO;
766 return Finteractive_form (cmd);
769 return Qnil;
773 /***********************************************************************
774 Getting and Setting Values of Symbols
775 ***********************************************************************/
777 /* Return the symbol holding SYMBOL's value. Signal
778 `cyclic-variable-indirection' if SYMBOL's chain of variable
779 indirections contains a loop. */
781 struct Lisp_Symbol *
782 indirect_variable (struct Lisp_Symbol *symbol)
784 struct Lisp_Symbol *tortoise, *hare;
786 hare = tortoise = symbol;
788 while (hare->redirect == SYMBOL_VARALIAS)
790 hare = SYMBOL_ALIAS (hare);
791 if (hare->redirect != SYMBOL_VARALIAS)
792 break;
794 hare = SYMBOL_ALIAS (hare);
795 tortoise = SYMBOL_ALIAS (tortoise);
797 if (hare == tortoise)
799 Lisp_Object tem;
800 XSETSYMBOL (tem, symbol);
801 xsignal1 (Qcyclic_variable_indirection, tem);
805 return hare;
809 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
810 doc: /* Return the variable at the end of OBJECT's variable chain.
811 If OBJECT is a symbol, follow its variable indirections (if any), and
812 return the variable at the end of the chain of aliases. See Info node
813 `(elisp)Variable Aliases'.
815 If OBJECT is not a symbol, just return it. If there is a loop in the
816 chain of aliases, signal a `cyclic-variable-indirection' error. */)
817 (Lisp_Object object)
819 if (SYMBOLP (object))
821 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
822 XSETSYMBOL (object, sym);
824 return object;
828 /* Given the raw contents of a symbol value cell,
829 return the Lisp value of the symbol.
830 This does not handle buffer-local variables; use
831 swap_in_symval_forwarding for that. */
833 Lisp_Object
834 do_symval_forwarding (register union Lisp_Fwd *valcontents)
836 register Lisp_Object val;
837 switch (XFWDTYPE (valcontents))
839 case Lisp_Fwd_Int:
840 XSETINT (val, *XINTFWD (valcontents)->intvar);
841 return val;
843 case Lisp_Fwd_Bool:
844 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
846 case Lisp_Fwd_Obj:
847 return *XOBJFWD (valcontents)->objvar;
849 case Lisp_Fwd_Buffer_Obj:
850 return PER_BUFFER_VALUE (current_buffer,
851 XBUFFER_OBJFWD (valcontents)->offset);
853 case Lisp_Fwd_Kboard_Obj:
854 /* We used to simply use current_kboard here, but from Lisp
855 code, its value is often unexpected. It seems nicer to
856 allow constructions like this to work as intuitively expected:
858 (with-selected-frame frame
859 (define-key local-function-map "\eOP" [f1]))
861 On the other hand, this affects the semantics of
862 last-command and real-last-command, and people may rely on
863 that. I took a quick look at the Lisp codebase, and I
864 don't think anything will break. --lorentey */
865 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
866 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
867 default: abort ();
871 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
872 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
873 buffer-independent contents of the value cell: forwarded just one
874 step past the buffer-localness.
876 BUF non-zero means set the value in buffer BUF instead of the
877 current buffer. This only plays a role for per-buffer variables. */
879 static void
880 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
882 switch (XFWDTYPE (valcontents))
884 case Lisp_Fwd_Int:
885 CHECK_NUMBER (newval);
886 *XINTFWD (valcontents)->intvar = XINT (newval);
887 break;
889 case Lisp_Fwd_Bool:
890 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
891 break;
893 case Lisp_Fwd_Obj:
894 *XOBJFWD (valcontents)->objvar = newval;
896 /* If this variable is a default for something stored
897 in the buffer itself, such as default-fill-column,
898 find the buffers that don't have local values for it
899 and update them. */
900 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
901 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
903 int offset = ((char *) XOBJFWD (valcontents)->objvar
904 - (char *) &buffer_defaults);
905 int idx = PER_BUFFER_IDX (offset);
907 Lisp_Object tail;
909 if (idx <= 0)
910 break;
912 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
914 Lisp_Object lbuf;
915 struct buffer *b;
917 lbuf = Fcdr (XCAR (tail));
918 if (!BUFFERP (lbuf)) continue;
919 b = XBUFFER (lbuf);
921 if (! PER_BUFFER_VALUE_P (b, idx))
922 PER_BUFFER_VALUE (b, offset) = newval;
925 break;
927 case Lisp_Fwd_Buffer_Obj:
929 int offset = XBUFFER_OBJFWD (valcontents)->offset;
930 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
932 if (!(NILP (type) || NILP (newval)
933 || (XINT (type) == Lisp_Int0
934 ? INTEGERP (newval)
935 : XTYPE (newval) == XINT (type))))
936 buffer_slot_type_mismatch (newval, XINT (type));
938 if (buf == NULL)
939 buf = current_buffer;
940 PER_BUFFER_VALUE (buf, offset) = newval;
942 break;
944 case Lisp_Fwd_Kboard_Obj:
946 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
947 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
948 *(Lisp_Object *) p = newval;
950 break;
952 default:
953 abort (); /* goto def; */
957 /* Set up SYMBOL to refer to its global binding.
958 This makes it safe to alter the status of other bindings. */
960 void
961 swap_in_global_binding (struct Lisp_Symbol *symbol)
963 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
965 /* Unload the previously loaded binding. */
966 if (blv->fwd)
967 set_blv_value (blv, do_symval_forwarding (blv->fwd));
969 /* Select the global binding in the symbol. */
970 set_blv_valcell (blv, blv->defcell);
971 if (blv->fwd)
972 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
974 /* Indicate that the global binding is set up now. */
975 set_blv_where (blv, Qnil);
976 set_blv_found (blv, 0);
979 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
980 VALCONTENTS is the contents of its value cell,
981 which points to a struct Lisp_Buffer_Local_Value.
983 Return the value forwarded one step past the buffer-local stage.
984 This could be another forwarding pointer. */
986 static void
987 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
989 register Lisp_Object tem1;
991 eassert (blv == SYMBOL_BLV (symbol));
993 tem1 = blv->where;
995 if (NILP (tem1)
996 || (blv->frame_local
997 ? !EQ (selected_frame, tem1)
998 : current_buffer != XBUFFER (tem1)))
1001 /* Unload the previously loaded binding. */
1002 tem1 = blv->valcell;
1003 if (blv->fwd)
1004 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1005 /* Choose the new binding. */
1007 Lisp_Object var;
1008 XSETSYMBOL (var, symbol);
1009 if (blv->frame_local)
1011 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1012 set_blv_where (blv, selected_frame);
1014 else
1016 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1017 XSETBUFFER (blv->where, current_buffer);
1020 if (!(blv->found = !NILP (tem1)))
1021 tem1 = blv->defcell;
1023 /* Load the new binding. */
1024 set_blv_valcell (blv, tem1);
1025 if (blv->fwd)
1026 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1030 /* Find the value of a symbol, returning Qunbound if it's not bound.
1031 This is helpful for code which just wants to get a variable's value
1032 if it has one, without signaling an error.
1033 Note that it must not be possible to quit
1034 within this function. Great care is required for this. */
1036 Lisp_Object
1037 find_symbol_value (Lisp_Object symbol)
1039 struct Lisp_Symbol *sym;
1041 CHECK_SYMBOL (symbol);
1042 sym = XSYMBOL (symbol);
1044 start:
1045 switch (sym->redirect)
1047 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1048 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1049 case SYMBOL_LOCALIZED:
1051 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1052 swap_in_symval_forwarding (sym, blv);
1053 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1055 /* FALLTHROUGH */
1056 case SYMBOL_FORWARDED:
1057 return do_symval_forwarding (SYMBOL_FWD (sym));
1058 default: abort ();
1062 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1063 doc: /* Return SYMBOL's value. Error if that is void. */)
1064 (Lisp_Object symbol)
1066 Lisp_Object val;
1068 val = find_symbol_value (symbol);
1069 if (!EQ (val, Qunbound))
1070 return val;
1072 xsignal1 (Qvoid_variable, symbol);
1075 DEFUN ("set", Fset, Sset, 2, 2, 0,
1076 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1077 (register Lisp_Object symbol, Lisp_Object newval)
1079 set_internal (symbol, newval, Qnil, 0);
1080 return newval;
1083 /* Return 1 if SYMBOL currently has a let-binding
1084 which was made in the buffer that is now current. */
1086 static int
1087 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1089 struct specbinding *p;
1091 for (p = specpdl_ptr; p > specpdl; )
1092 if ((--p)->func == NULL
1093 && CONSP (p->symbol))
1095 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1096 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1097 if (symbol == let_bound_symbol
1098 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1099 return 1;
1102 return 0;
1105 static int
1106 let_shadows_global_binding_p (Lisp_Object symbol)
1108 struct specbinding *p;
1110 for (p = specpdl_ptr; p > specpdl; )
1111 if ((--p)->func == NULL && EQ (p->symbol, symbol))
1112 return 1;
1114 return 0;
1117 /* Store the value NEWVAL into SYMBOL.
1118 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1119 (nil stands for the current buffer/frame).
1121 If BINDFLAG is zero, then if this symbol is supposed to become
1122 local in every buffer where it is set, then we make it local.
1123 If BINDFLAG is nonzero, we don't do that. */
1125 void
1126 set_internal (register Lisp_Object symbol, register Lisp_Object newval, register Lisp_Object where, int bindflag)
1128 int voide = EQ (newval, Qunbound);
1129 struct Lisp_Symbol *sym;
1130 Lisp_Object tem1;
1132 /* If restoring in a dead buffer, do nothing. */
1133 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1134 return; */
1136 CHECK_SYMBOL (symbol);
1137 if (SYMBOL_CONSTANT_P (symbol))
1139 if (NILP (Fkeywordp (symbol))
1140 || !EQ (newval, Fsymbol_value (symbol)))
1141 xsignal1 (Qsetting_constant, symbol);
1142 else
1143 /* Allow setting keywords to their own value. */
1144 return;
1147 sym = XSYMBOL (symbol);
1149 start:
1150 switch (sym->redirect)
1152 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1153 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1154 case SYMBOL_LOCALIZED:
1156 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1157 if (NILP (where))
1159 if (blv->frame_local)
1160 where = selected_frame;
1161 else
1162 XSETBUFFER (where, current_buffer);
1164 /* If the current buffer is not the buffer whose binding is
1165 loaded, or if there may be frame-local bindings and the frame
1166 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1167 the default binding is loaded, the loaded binding may be the
1168 wrong one. */
1169 if (!EQ (blv->where, where)
1170 /* Also unload a global binding (if the var is local_if_set). */
1171 || (EQ (blv->valcell, blv->defcell)))
1173 /* The currently loaded binding is not necessarily valid.
1174 We need to unload it, and choose a new binding. */
1176 /* Write out `realvalue' to the old loaded binding. */
1177 if (blv->fwd)
1178 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1180 /* Find the new binding. */
1181 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1182 tem1 = Fassq (symbol,
1183 (blv->frame_local
1184 ? XFRAME (where)->param_alist
1185 : BVAR (XBUFFER (where), local_var_alist)));
1186 set_blv_where (blv, where);
1187 set_blv_found (blv, 1);
1189 if (NILP (tem1))
1191 /* This buffer still sees the default value. */
1193 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1194 or if this is `let' rather than `set',
1195 make CURRENT-ALIST-ELEMENT point to itself,
1196 indicating that we're seeing the default value.
1197 Likewise if the variable has been let-bound
1198 in the current buffer. */
1199 if (bindflag || !blv->local_if_set
1200 || let_shadows_buffer_binding_p (sym))
1202 set_blv_found (blv, 0);
1203 tem1 = blv->defcell;
1205 /* If it's a local_if_set, being set not bound,
1206 and we're not within a let that was made for this buffer,
1207 create a new buffer-local binding for the variable.
1208 That means, give this buffer a new assoc for a local value
1209 and load that binding. */
1210 else
1212 /* local_if_set is only supported for buffer-local
1213 bindings, not for frame-local bindings. */
1214 eassert (!blv->frame_local);
1215 tem1 = Fcons (symbol, XCDR (blv->defcell));
1216 BSET (XBUFFER (where), local_var_alist,
1217 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1221 /* Record which binding is now loaded. */
1222 set_blv_valcell (blv, tem1);
1225 /* Store the new value in the cons cell. */
1226 set_blv_value (blv, newval);
1228 if (blv->fwd)
1230 if (voide)
1231 /* If storing void (making the symbol void), forward only through
1232 buffer-local indicator, not through Lisp_Objfwd, etc. */
1233 blv->fwd = NULL;
1234 else
1235 store_symval_forwarding (blv->fwd, newval,
1236 BUFFERP (where)
1237 ? XBUFFER (where) : current_buffer);
1239 break;
1241 case SYMBOL_FORWARDED:
1243 struct buffer *buf
1244 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1245 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1246 if (BUFFER_OBJFWDP (innercontents))
1248 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1249 int idx = PER_BUFFER_IDX (offset);
1250 if (idx > 0
1251 && !bindflag
1252 && !let_shadows_buffer_binding_p (sym))
1253 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1256 if (voide)
1257 { /* If storing void (making the symbol void), forward only through
1258 buffer-local indicator, not through Lisp_Objfwd, etc. */
1259 sym->redirect = SYMBOL_PLAINVAL;
1260 SET_SYMBOL_VAL (sym, newval);
1262 else
1263 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1264 break;
1266 default: abort ();
1268 return;
1271 /* Access or set a buffer-local symbol's default value. */
1273 /* Return the default value of SYMBOL, but don't check for voidness.
1274 Return Qunbound if it is void. */
1276 static Lisp_Object
1277 default_value (Lisp_Object symbol)
1279 struct Lisp_Symbol *sym;
1281 CHECK_SYMBOL (symbol);
1282 sym = XSYMBOL (symbol);
1284 start:
1285 switch (sym->redirect)
1287 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1288 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1289 case SYMBOL_LOCALIZED:
1291 /* If var is set up for a buffer that lacks a local value for it,
1292 the current value is nominally the default value.
1293 But the `realvalue' slot may be more up to date, since
1294 ordinary setq stores just that slot. So use that. */
1295 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1296 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1297 return do_symval_forwarding (blv->fwd);
1298 else
1299 return XCDR (blv->defcell);
1301 case SYMBOL_FORWARDED:
1303 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1305 /* For a built-in buffer-local variable, get the default value
1306 rather than letting do_symval_forwarding get the current value. */
1307 if (BUFFER_OBJFWDP (valcontents))
1309 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1310 if (PER_BUFFER_IDX (offset) != 0)
1311 return PER_BUFFER_DEFAULT (offset);
1314 /* For other variables, get the current value. */
1315 return do_symval_forwarding (valcontents);
1317 default: abort ();
1321 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1322 doc: /* Return t if SYMBOL has a non-void default value.
1323 This is the value that is seen in buffers that do not have their own values
1324 for this variable. */)
1325 (Lisp_Object symbol)
1327 register Lisp_Object value;
1329 value = default_value (symbol);
1330 return (EQ (value, Qunbound) ? Qnil : Qt);
1333 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1334 doc: /* Return SYMBOL's default value.
1335 This is the value that is seen in buffers that do not have their own values
1336 for this variable. The default value is meaningful for variables with
1337 local bindings in certain buffers. */)
1338 (Lisp_Object symbol)
1340 register Lisp_Object value;
1342 value = default_value (symbol);
1343 if (!EQ (value, Qunbound))
1344 return value;
1346 xsignal1 (Qvoid_variable, symbol);
1349 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1350 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1351 The default value is seen in buffers that do not have their own values
1352 for this variable. */)
1353 (Lisp_Object symbol, Lisp_Object value)
1355 struct Lisp_Symbol *sym;
1357 CHECK_SYMBOL (symbol);
1358 if (SYMBOL_CONSTANT_P (symbol))
1360 if (NILP (Fkeywordp (symbol))
1361 || !EQ (value, Fdefault_value (symbol)))
1362 xsignal1 (Qsetting_constant, symbol);
1363 else
1364 /* Allow setting keywords to their own value. */
1365 return value;
1367 sym = XSYMBOL (symbol);
1369 start:
1370 switch (sym->redirect)
1372 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1373 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1374 case SYMBOL_LOCALIZED:
1376 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1378 /* Store new value into the DEFAULT-VALUE slot. */
1379 XSETCDR (blv->defcell, value);
1381 /* If the default binding is now loaded, set the REALVALUE slot too. */
1382 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1383 store_symval_forwarding (blv->fwd, value, NULL);
1384 return value;
1386 case SYMBOL_FORWARDED:
1388 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1390 /* Handle variables like case-fold-search that have special slots
1391 in the buffer.
1392 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1393 if (BUFFER_OBJFWDP (valcontents))
1395 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1396 int idx = PER_BUFFER_IDX (offset);
1398 PER_BUFFER_DEFAULT (offset) = value;
1400 /* If this variable is not always local in all buffers,
1401 set it in the buffers that don't nominally have a local value. */
1402 if (idx > 0)
1404 struct buffer *b;
1406 FOR_EACH_BUFFER (b)
1407 if (!PER_BUFFER_VALUE_P (b, idx))
1408 PER_BUFFER_VALUE (b, offset) = value;
1410 return value;
1412 else
1413 return Fset (symbol, value);
1415 default: abort ();
1419 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1420 doc: /* Set the default value of variable VAR to VALUE.
1421 VAR, the variable name, is literal (not evaluated);
1422 VALUE is an expression: it is evaluated and its value returned.
1423 The default value of a variable is seen in buffers
1424 that do not have their own values for the variable.
1426 More generally, you can use multiple variables and values, as in
1427 (setq-default VAR VALUE VAR VALUE...)
1428 This sets each VAR's default value to the corresponding VALUE.
1429 The VALUE for the Nth VAR can refer to the new default values
1430 of previous VARs.
1431 usage: (setq-default [VAR VALUE]...) */)
1432 (Lisp_Object args)
1434 register Lisp_Object args_left;
1435 register Lisp_Object val, symbol;
1436 struct gcpro gcpro1;
1438 if (NILP (args))
1439 return Qnil;
1441 args_left = args;
1442 GCPRO1 (args);
1446 val = eval_sub (Fcar (Fcdr (args_left)));
1447 symbol = XCAR (args_left);
1448 Fset_default (symbol, val);
1449 args_left = Fcdr (XCDR (args_left));
1451 while (!NILP (args_left));
1453 UNGCPRO;
1454 return val;
1457 /* Lisp functions for creating and removing buffer-local variables. */
1459 union Lisp_Val_Fwd
1461 Lisp_Object value;
1462 union Lisp_Fwd *fwd;
1465 static struct Lisp_Buffer_Local_Value *
1466 make_blv (struct Lisp_Symbol *sym, int forwarded, union Lisp_Val_Fwd valcontents)
1468 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1469 Lisp_Object symbol;
1470 Lisp_Object tem;
1472 XSETSYMBOL (symbol, sym);
1473 tem = Fcons (symbol, (forwarded
1474 ? do_symval_forwarding (valcontents.fwd)
1475 : valcontents.value));
1477 /* Buffer_Local_Values cannot have as realval a buffer-local
1478 or keyboard-local forwarding. */
1479 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1480 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1481 blv->fwd = forwarded ? valcontents.fwd : NULL;
1482 set_blv_where (blv, Qnil);
1483 blv->frame_local = 0;
1484 blv->local_if_set = 0;
1485 set_blv_defcell (blv, tem);
1486 set_blv_valcell (blv, tem);
1487 set_blv_found (blv, 0);
1488 return blv;
1491 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1492 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1493 doc: /* Make VARIABLE become buffer-local whenever it is set.
1494 At any time, the value for the current buffer is in effect,
1495 unless the variable has never been set in this buffer,
1496 in which case the default value is in effect.
1497 Note that binding the variable with `let', or setting it while
1498 a `let'-style binding made in this buffer is in effect,
1499 does not make the variable buffer-local. Return VARIABLE.
1501 In most cases it is better to use `make-local-variable',
1502 which makes a variable local in just one buffer.
1504 The function `default-value' gets the default value and `set-default' sets it. */)
1505 (register Lisp_Object variable)
1507 struct Lisp_Symbol *sym;
1508 struct Lisp_Buffer_Local_Value *blv = NULL;
1509 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1510 int forwarded IF_LINT (= 0);
1512 CHECK_SYMBOL (variable);
1513 sym = XSYMBOL (variable);
1515 start:
1516 switch (sym->redirect)
1518 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1519 case SYMBOL_PLAINVAL:
1520 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1521 if (EQ (valcontents.value, Qunbound))
1522 valcontents.value = Qnil;
1523 break;
1524 case SYMBOL_LOCALIZED:
1525 blv = SYMBOL_BLV (sym);
1526 if (blv->frame_local)
1527 error ("Symbol %s may not be buffer-local",
1528 SDATA (SYMBOL_NAME (variable)));
1529 break;
1530 case SYMBOL_FORWARDED:
1531 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1532 if (KBOARD_OBJFWDP (valcontents.fwd))
1533 error ("Symbol %s may not be buffer-local",
1534 SDATA (SYMBOL_NAME (variable)));
1535 else if (BUFFER_OBJFWDP (valcontents.fwd))
1536 return variable;
1537 break;
1538 default: abort ();
1541 if (sym->constant)
1542 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1544 if (!blv)
1546 blv = make_blv (sym, forwarded, valcontents);
1547 sym->redirect = SYMBOL_LOCALIZED;
1548 SET_SYMBOL_BLV (sym, blv);
1550 Lisp_Object symbol;
1551 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1552 if (let_shadows_global_binding_p (symbol))
1553 message ("Making %s buffer-local while let-bound!",
1554 SDATA (SYMBOL_NAME (variable)));
1558 blv->local_if_set = 1;
1559 return variable;
1562 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1563 1, 1, "vMake Local Variable: ",
1564 doc: /* Make VARIABLE have a separate value in the current buffer.
1565 Other buffers will continue to share a common default value.
1566 \(The buffer-local value of VARIABLE starts out as the same value
1567 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1568 Return VARIABLE.
1570 If the variable is already arranged to become local when set,
1571 this function causes a local value to exist for this buffer,
1572 just as setting the variable would do.
1574 This function returns VARIABLE, and therefore
1575 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1576 works.
1578 See also `make-variable-buffer-local'.
1580 Do not use `make-local-variable' to make a hook variable buffer-local.
1581 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1582 (register Lisp_Object variable)
1584 register Lisp_Object tem;
1585 int forwarded IF_LINT (= 0);
1586 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1587 struct Lisp_Symbol *sym;
1588 struct Lisp_Buffer_Local_Value *blv = NULL;
1590 CHECK_SYMBOL (variable);
1591 sym = XSYMBOL (variable);
1593 start:
1594 switch (sym->redirect)
1596 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1597 case SYMBOL_PLAINVAL:
1598 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1599 case SYMBOL_LOCALIZED:
1600 blv = SYMBOL_BLV (sym);
1601 if (blv->frame_local)
1602 error ("Symbol %s may not be buffer-local",
1603 SDATA (SYMBOL_NAME (variable)));
1604 break;
1605 case SYMBOL_FORWARDED:
1606 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1607 if (KBOARD_OBJFWDP (valcontents.fwd))
1608 error ("Symbol %s may not be buffer-local",
1609 SDATA (SYMBOL_NAME (variable)));
1610 break;
1611 default: abort ();
1614 if (sym->constant)
1615 error ("Symbol %s may not be buffer-local",
1616 SDATA (SYMBOL_NAME (variable)));
1618 if (blv ? blv->local_if_set
1619 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1621 tem = Fboundp (variable);
1622 /* Make sure the symbol has a local value in this particular buffer,
1623 by setting it to the same value it already has. */
1624 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1625 return variable;
1627 if (!blv)
1629 blv = make_blv (sym, forwarded, valcontents);
1630 sym->redirect = SYMBOL_LOCALIZED;
1631 SET_SYMBOL_BLV (sym, blv);
1633 Lisp_Object symbol;
1634 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1635 if (let_shadows_global_binding_p (symbol))
1636 message ("Making %s local to %s while let-bound!",
1637 SDATA (SYMBOL_NAME (variable)),
1638 SDATA (BVAR (current_buffer, name)));
1642 /* Make sure this buffer has its own value of symbol. */
1643 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1644 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1645 if (NILP (tem))
1647 if (let_shadows_buffer_binding_p (sym))
1648 message ("Making %s buffer-local while locally let-bound!",
1649 SDATA (SYMBOL_NAME (variable)));
1651 /* Swap out any local binding for some other buffer, and make
1652 sure the current value is permanently recorded, if it's the
1653 default value. */
1654 find_symbol_value (variable);
1656 BSET (current_buffer, local_var_alist,
1657 Fcons (Fcons (variable, XCDR (blv->defcell)),
1658 BVAR (current_buffer, local_var_alist)));
1660 /* Make sure symbol does not think it is set up for this buffer;
1661 force it to look once again for this buffer's value. */
1662 if (current_buffer == XBUFFER (blv->where))
1663 set_blv_where (blv, Qnil);
1664 set_blv_found (blv, 0);
1667 /* If the symbol forwards into a C variable, then load the binding
1668 for this buffer now. If C code modifies the variable before we
1669 load the binding in, then that new value will clobber the default
1670 binding the next time we unload it. */
1671 if (blv->fwd)
1672 swap_in_symval_forwarding (sym, blv);
1674 return variable;
1677 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1678 1, 1, "vKill Local Variable: ",
1679 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1680 From now on the default value will apply in this buffer. Return VARIABLE. */)
1681 (register Lisp_Object variable)
1683 register Lisp_Object tem;
1684 struct Lisp_Buffer_Local_Value *blv;
1685 struct Lisp_Symbol *sym;
1687 CHECK_SYMBOL (variable);
1688 sym = XSYMBOL (variable);
1690 start:
1691 switch (sym->redirect)
1693 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1694 case SYMBOL_PLAINVAL: return variable;
1695 case SYMBOL_FORWARDED:
1697 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1698 if (BUFFER_OBJFWDP (valcontents))
1700 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1701 int idx = PER_BUFFER_IDX (offset);
1703 if (idx > 0)
1705 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1706 PER_BUFFER_VALUE (current_buffer, offset)
1707 = PER_BUFFER_DEFAULT (offset);
1710 return variable;
1712 case SYMBOL_LOCALIZED:
1713 blv = SYMBOL_BLV (sym);
1714 if (blv->frame_local)
1715 return variable;
1716 break;
1717 default: abort ();
1720 /* Get rid of this buffer's alist element, if any. */
1721 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1722 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1723 if (!NILP (tem))
1724 BSET (current_buffer, local_var_alist,
1725 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1727 /* If the symbol is set up with the current buffer's binding
1728 loaded, recompute its value. We have to do it now, or else
1729 forwarded objects won't work right. */
1731 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1732 if (EQ (buf, blv->where))
1734 set_blv_where (blv, Qnil);
1735 set_blv_found (blv, 0);
1736 find_symbol_value (variable);
1740 return variable;
1743 /* Lisp functions for creating and removing buffer-local variables. */
1745 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1746 when/if this is removed. */
1748 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1749 1, 1, "vMake Variable Frame Local: ",
1750 doc: /* Enable VARIABLE to have frame-local bindings.
1751 This does not create any frame-local bindings for VARIABLE,
1752 it just makes them possible.
1754 A frame-local binding is actually a frame parameter value.
1755 If a frame F has a value for the frame parameter named VARIABLE,
1756 that also acts as a frame-local binding for VARIABLE in F--
1757 provided this function has been called to enable VARIABLE
1758 to have frame-local bindings at all.
1760 The only way to create a frame-local binding for VARIABLE in a frame
1761 is to set the VARIABLE frame parameter of that frame. See
1762 `modify-frame-parameters' for how to set frame parameters.
1764 Note that since Emacs 23.1, variables cannot be both buffer-local and
1765 frame-local any more (buffer-local bindings used to take precedence over
1766 frame-local bindings). */)
1767 (register Lisp_Object variable)
1769 int forwarded;
1770 union Lisp_Val_Fwd valcontents;
1771 struct Lisp_Symbol *sym;
1772 struct Lisp_Buffer_Local_Value *blv = NULL;
1774 CHECK_SYMBOL (variable);
1775 sym = XSYMBOL (variable);
1777 start:
1778 switch (sym->redirect)
1780 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1781 case SYMBOL_PLAINVAL:
1782 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1783 if (EQ (valcontents.value, Qunbound))
1784 valcontents.value = Qnil;
1785 break;
1786 case SYMBOL_LOCALIZED:
1787 if (SYMBOL_BLV (sym)->frame_local)
1788 return variable;
1789 else
1790 error ("Symbol %s may not be frame-local",
1791 SDATA (SYMBOL_NAME (variable)));
1792 case SYMBOL_FORWARDED:
1793 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1794 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1795 error ("Symbol %s may not be frame-local",
1796 SDATA (SYMBOL_NAME (variable)));
1797 break;
1798 default: abort ();
1801 if (sym->constant)
1802 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1804 blv = make_blv (sym, forwarded, valcontents);
1805 blv->frame_local = 1;
1806 sym->redirect = SYMBOL_LOCALIZED;
1807 SET_SYMBOL_BLV (sym, blv);
1809 Lisp_Object symbol;
1810 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1811 if (let_shadows_global_binding_p (symbol))
1812 message ("Making %s frame-local while let-bound!",
1813 SDATA (SYMBOL_NAME (variable)));
1815 return variable;
1818 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1819 1, 2, 0,
1820 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1821 BUFFER defaults to the current buffer. */)
1822 (register Lisp_Object variable, Lisp_Object buffer)
1824 register struct buffer *buf;
1825 struct Lisp_Symbol *sym;
1827 if (NILP (buffer))
1828 buf = current_buffer;
1829 else
1831 CHECK_BUFFER (buffer);
1832 buf = XBUFFER (buffer);
1835 CHECK_SYMBOL (variable);
1836 sym = XSYMBOL (variable);
1838 start:
1839 switch (sym->redirect)
1841 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1842 case SYMBOL_PLAINVAL: return Qnil;
1843 case SYMBOL_LOCALIZED:
1845 Lisp_Object tail, elt, tmp;
1846 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1847 XSETBUFFER (tmp, buf);
1848 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1850 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1852 elt = XCAR (tail);
1853 if (EQ (variable, XCAR (elt)))
1855 eassert (!blv->frame_local);
1856 eassert (blv_found (blv) || !EQ (blv->where, tmp));
1857 return Qt;
1860 eassert (!blv_found (blv) || !EQ (blv->where, tmp));
1861 return Qnil;
1863 case SYMBOL_FORWARDED:
1865 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1866 if (BUFFER_OBJFWDP (valcontents))
1868 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1869 int idx = PER_BUFFER_IDX (offset);
1870 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1871 return Qt;
1873 return Qnil;
1875 default: abort ();
1879 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1880 1, 2, 0,
1881 doc: /* Non-nil if VARIABLE will be local in buffer BUFFER when set there.
1882 More precisely, this means that setting the variable \(with `set' or`setq'),
1883 while it does not have a `let'-style binding that was made in BUFFER,
1884 will produce a buffer local binding. See Info node
1885 `(elisp)Creating Buffer-Local'.
1886 BUFFER defaults to the current buffer. */)
1887 (register Lisp_Object variable, Lisp_Object buffer)
1889 struct Lisp_Symbol *sym;
1891 CHECK_SYMBOL (variable);
1892 sym = XSYMBOL (variable);
1894 start:
1895 switch (sym->redirect)
1897 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1898 case SYMBOL_PLAINVAL: return Qnil;
1899 case SYMBOL_LOCALIZED:
1901 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1902 if (blv->local_if_set)
1903 return Qt;
1904 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1905 return Flocal_variable_p (variable, buffer);
1907 case SYMBOL_FORWARDED:
1908 /* All BUFFER_OBJFWD slots become local if they are set. */
1909 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1910 default: abort ();
1914 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1915 1, 1, 0,
1916 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1917 If the current binding is buffer-local, the value is the current buffer.
1918 If the current binding is frame-local, the value is the selected frame.
1919 If the current binding is global (the default), the value is nil. */)
1920 (register Lisp_Object variable)
1922 struct Lisp_Symbol *sym;
1924 CHECK_SYMBOL (variable);
1925 sym = XSYMBOL (variable);
1927 /* Make sure the current binding is actually swapped in. */
1928 find_symbol_value (variable);
1930 start:
1931 switch (sym->redirect)
1933 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1934 case SYMBOL_PLAINVAL: return Qnil;
1935 case SYMBOL_FORWARDED:
1937 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1938 if (KBOARD_OBJFWDP (valcontents))
1939 return Fframe_terminal (Fselected_frame ());
1940 else if (!BUFFER_OBJFWDP (valcontents))
1941 return Qnil;
1943 /* FALLTHROUGH */
1944 case SYMBOL_LOCALIZED:
1945 /* For a local variable, record both the symbol and which
1946 buffer's or frame's value we are saving. */
1947 if (!NILP (Flocal_variable_p (variable, Qnil)))
1948 return Fcurrent_buffer ();
1949 else if (sym->redirect == SYMBOL_LOCALIZED
1950 && blv_found (SYMBOL_BLV (sym)))
1951 return SYMBOL_BLV (sym)->where;
1952 else
1953 return Qnil;
1954 default: abort ();
1958 /* This code is disabled now that we use the selected frame to return
1959 keyboard-local-values. */
1960 #if 0
1961 extern struct terminal *get_terminal (Lisp_Object display, int);
1963 DEFUN ("terminal-local-value", Fterminal_local_value,
1964 Sterminal_local_value, 2, 2, 0,
1965 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1966 If SYMBOL is not a terminal-local variable, then return its normal
1967 value, like `symbol-value'.
1969 TERMINAL may be a terminal object, a frame, or nil (meaning the
1970 selected frame's terminal device). */)
1971 (Lisp_Object symbol, Lisp_Object terminal)
1973 Lisp_Object result;
1974 struct terminal *t = get_terminal (terminal, 1);
1975 push_kboard (t->kboard);
1976 result = Fsymbol_value (symbol);
1977 pop_kboard ();
1978 return result;
1981 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
1982 Sset_terminal_local_value, 3, 3, 0,
1983 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1984 If VARIABLE is not a terminal-local variable, then set its normal
1985 binding, like `set'.
1987 TERMINAL may be a terminal object, a frame, or nil (meaning the
1988 selected frame's terminal device). */)
1989 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1991 Lisp_Object result;
1992 struct terminal *t = get_terminal (terminal, 1);
1993 push_kboard (d->kboard);
1994 result = Fset (symbol, value);
1995 pop_kboard ();
1996 return result;
1998 #endif
2000 /* Find the function at the end of a chain of symbol function indirections. */
2002 /* If OBJECT is a symbol, find the end of its function chain and
2003 return the value found there. If OBJECT is not a symbol, just
2004 return it. If there is a cycle in the function chain, signal a
2005 cyclic-function-indirection error.
2007 This is like Findirect_function, except that it doesn't signal an
2008 error if the chain ends up unbound. */
2009 Lisp_Object
2010 indirect_function (register Lisp_Object object)
2012 Lisp_Object tortoise, hare;
2014 hare = tortoise = object;
2016 for (;;)
2018 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2019 break;
2020 hare = XSYMBOL (hare)->function;
2021 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2022 break;
2023 hare = XSYMBOL (hare)->function;
2025 tortoise = XSYMBOL (tortoise)->function;
2027 if (EQ (hare, tortoise))
2028 xsignal1 (Qcyclic_function_indirection, object);
2031 return hare;
2034 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2035 doc: /* Return the function at the end of OBJECT's function chain.
2036 If OBJECT is not a symbol, just return it. Otherwise, follow all
2037 function indirections to find the final function binding and return it.
2038 If the final symbol in the chain is unbound, signal a void-function error.
2039 Optional arg NOERROR non-nil means to return nil instead of signaling.
2040 Signal a cyclic-function-indirection error if there is a loop in the
2041 function chain of symbols. */)
2042 (register Lisp_Object object, Lisp_Object noerror)
2044 Lisp_Object result;
2046 /* Optimize for no indirection. */
2047 result = object;
2048 if (SYMBOLP (result) && !EQ (result, Qunbound)
2049 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2050 result = indirect_function (result);
2051 if (!EQ (result, Qunbound))
2052 return result;
2054 if (NILP (noerror))
2055 xsignal1 (Qvoid_function, object);
2057 return Qnil;
2060 /* Extract and set vector and string elements. */
2062 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2063 doc: /* Return the element of ARRAY at index IDX.
2064 ARRAY may be a vector, a string, a char-table, a bool-vector,
2065 or a byte-code object. IDX starts at 0. */)
2066 (register Lisp_Object array, Lisp_Object idx)
2068 register EMACS_INT idxval;
2070 CHECK_NUMBER (idx);
2071 idxval = XINT (idx);
2072 if (STRINGP (array))
2074 int c;
2075 ptrdiff_t idxval_byte;
2077 if (idxval < 0 || idxval >= SCHARS (array))
2078 args_out_of_range (array, idx);
2079 if (! STRING_MULTIBYTE (array))
2080 return make_number ((unsigned char) SREF (array, idxval));
2081 idxval_byte = string_char_to_byte (array, idxval);
2083 c = STRING_CHAR (SDATA (array) + idxval_byte);
2084 return make_number (c);
2086 else if (BOOL_VECTOR_P (array))
2088 int val;
2090 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2091 args_out_of_range (array, idx);
2093 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2094 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2096 else if (CHAR_TABLE_P (array))
2098 CHECK_CHARACTER (idx);
2099 return CHAR_TABLE_REF (array, idxval);
2101 else
2103 ptrdiff_t size = 0;
2104 if (VECTORP (array))
2105 size = ASIZE (array);
2106 else if (COMPILEDP (array))
2107 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2108 else
2109 wrong_type_argument (Qarrayp, array);
2111 if (idxval < 0 || idxval >= size)
2112 args_out_of_range (array, idx);
2113 return AREF (array, idxval);
2117 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2118 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2119 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2120 bool-vector. IDX starts at 0. */)
2121 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2123 register EMACS_INT idxval;
2125 CHECK_NUMBER (idx);
2126 idxval = XINT (idx);
2127 CHECK_ARRAY (array, Qarrayp);
2128 CHECK_IMPURE (array);
2130 if (VECTORP (array))
2132 if (idxval < 0 || idxval >= ASIZE (array))
2133 args_out_of_range (array, idx);
2134 ASET (array, idxval, newelt);
2136 else if (BOOL_VECTOR_P (array))
2138 int val;
2140 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2141 args_out_of_range (array, idx);
2143 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2145 if (! NILP (newelt))
2146 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2147 else
2148 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2149 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2151 else if (CHAR_TABLE_P (array))
2153 CHECK_CHARACTER (idx);
2154 CHAR_TABLE_SET (array, idxval, newelt);
2156 else
2158 int c;
2160 if (idxval < 0 || idxval >= SCHARS (array))
2161 args_out_of_range (array, idx);
2162 CHECK_CHARACTER (newelt);
2163 c = XFASTINT (newelt);
2165 if (STRING_MULTIBYTE (array))
2167 ptrdiff_t idxval_byte, nbytes;
2168 int prev_bytes, new_bytes;
2169 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2171 nbytes = SBYTES (array);
2172 idxval_byte = string_char_to_byte (array, idxval);
2173 p1 = SDATA (array) + idxval_byte;
2174 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2175 new_bytes = CHAR_STRING (c, p0);
2176 if (prev_bytes != new_bytes)
2178 /* We must relocate the string data. */
2179 ptrdiff_t nchars = SCHARS (array);
2180 USE_SAFE_ALLOCA;
2181 unsigned char *str = SAFE_ALLOCA (nbytes);
2183 memcpy (str, SDATA (array), nbytes);
2184 allocate_string_data (XSTRING (array), nchars,
2185 nbytes + new_bytes - prev_bytes);
2186 memcpy (SDATA (array), str, idxval_byte);
2187 p1 = SDATA (array) + idxval_byte;
2188 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2189 nbytes - (idxval_byte + prev_bytes));
2190 SAFE_FREE ();
2191 clear_string_char_byte_cache ();
2193 while (new_bytes--)
2194 *p1++ = *p0++;
2196 else
2198 if (! SINGLE_BYTE_CHAR_P (c))
2200 int i;
2202 for (i = SBYTES (array) - 1; i >= 0; i--)
2203 if (SREF (array, i) >= 0x80)
2204 args_out_of_range (array, newelt);
2205 /* ARRAY is an ASCII string. Convert it to a multibyte
2206 string, and try `aset' again. */
2207 STRING_SET_MULTIBYTE (array);
2208 return Faset (array, idx, newelt);
2210 SSET (array, idxval, c);
2214 return newelt;
2217 /* Arithmetic functions */
2219 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2221 static Lisp_Object
2222 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2224 double f1 = 0, f2 = 0;
2225 int floatp = 0;
2227 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2228 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2230 if (FLOATP (num1) || FLOATP (num2))
2232 floatp = 1;
2233 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2234 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2237 switch (comparison)
2239 case equal:
2240 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2241 return Qt;
2242 return Qnil;
2244 case notequal:
2245 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2246 return Qt;
2247 return Qnil;
2249 case less:
2250 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2251 return Qt;
2252 return Qnil;
2254 case less_or_equal:
2255 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2256 return Qt;
2257 return Qnil;
2259 case grtr:
2260 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2261 return Qt;
2262 return Qnil;
2264 case grtr_or_equal:
2265 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2266 return Qt;
2267 return Qnil;
2269 default:
2270 abort ();
2274 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2275 doc: /* Return t if two args, both numbers or markers, are equal. */)
2276 (register Lisp_Object num1, Lisp_Object num2)
2278 return arithcompare (num1, num2, equal);
2281 DEFUN ("<", Flss, Slss, 2, 2, 0,
2282 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2283 (register Lisp_Object num1, Lisp_Object num2)
2285 return arithcompare (num1, num2, less);
2288 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2289 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2290 (register Lisp_Object num1, Lisp_Object num2)
2292 return arithcompare (num1, num2, grtr);
2295 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2296 doc: /* Return t if first arg is less than or equal to second arg.
2297 Both must be numbers or markers. */)
2298 (register Lisp_Object num1, Lisp_Object num2)
2300 return arithcompare (num1, num2, less_or_equal);
2303 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2304 doc: /* Return t if first arg is greater than or equal to second arg.
2305 Both must be numbers or markers. */)
2306 (register Lisp_Object num1, Lisp_Object num2)
2308 return arithcompare (num1, num2, grtr_or_equal);
2311 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2312 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2313 (register Lisp_Object num1, Lisp_Object num2)
2315 return arithcompare (num1, num2, notequal);
2318 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2319 doc: /* Return t if NUMBER is zero. */)
2320 (register Lisp_Object number)
2322 CHECK_NUMBER_OR_FLOAT (number);
2324 if (FLOATP (number))
2326 if (XFLOAT_DATA (number) == 0.0)
2327 return Qt;
2328 return Qnil;
2331 if (!XINT (number))
2332 return Qt;
2333 return Qnil;
2336 /* Convert the cons-of-integers, integer, or float value C to an
2337 unsigned value with maximum value MAX. Signal an error if C does not
2338 have a valid format or is out of range. */
2339 uintmax_t
2340 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2342 int valid = 0;
2343 uintmax_t val IF_LINT (= 0);
2344 if (INTEGERP (c))
2346 valid = 0 <= XINT (c);
2347 val = XINT (c);
2349 else if (FLOATP (c))
2351 double d = XFLOAT_DATA (c);
2352 if (0 <= d
2353 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2355 val = d;
2356 valid = 1;
2359 else if (CONSP (c) && NATNUMP (XCAR (c)))
2361 uintmax_t top = XFASTINT (XCAR (c));
2362 Lisp_Object rest = XCDR (c);
2363 if (top <= UINTMAX_MAX >> 24 >> 16
2364 && CONSP (rest)
2365 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2366 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2368 uintmax_t mid = XFASTINT (XCAR (rest));
2369 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2370 valid = 1;
2372 else if (top <= UINTMAX_MAX >> 16)
2374 if (CONSP (rest))
2375 rest = XCAR (rest);
2376 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2378 val = top << 16 | XFASTINT (rest);
2379 valid = 1;
2384 if (! (valid && val <= max))
2385 error ("Not an in-range integer, float, or cons of integers");
2386 return val;
2389 /* Convert the cons-of-integers, integer, or float value C to a signed
2390 value with extrema MIN and MAX. Signal an error if C does not have
2391 a valid format or is out of range. */
2392 intmax_t
2393 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2395 int valid = 0;
2396 intmax_t val IF_LINT (= 0);
2397 if (INTEGERP (c))
2399 val = XINT (c);
2400 valid = 1;
2402 else if (FLOATP (c))
2404 double d = XFLOAT_DATA (c);
2405 if (min <= d
2406 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2408 val = d;
2409 valid = 1;
2412 else if (CONSP (c) && INTEGERP (XCAR (c)))
2414 intmax_t top = XINT (XCAR (c));
2415 Lisp_Object rest = XCDR (c);
2416 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2417 && CONSP (rest)
2418 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2419 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2421 intmax_t mid = XFASTINT (XCAR (rest));
2422 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2423 valid = 1;
2425 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2427 if (CONSP (rest))
2428 rest = XCAR (rest);
2429 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2431 val = top << 16 | XFASTINT (rest);
2432 valid = 1;
2437 if (! (valid && min <= val && val <= max))
2438 error ("Not an in-range integer, float, or cons of integers");
2439 return val;
2442 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2443 doc: /* Return the decimal representation of NUMBER as a string.
2444 Uses a minus sign if negative.
2445 NUMBER may be an integer or a floating point number. */)
2446 (Lisp_Object number)
2448 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2449 int len;
2451 CHECK_NUMBER_OR_FLOAT (number);
2453 if (FLOATP (number))
2454 len = float_to_string (buffer, XFLOAT_DATA (number));
2455 else
2456 len = sprintf (buffer, "%"pI"d", XINT (number));
2458 return make_unibyte_string (buffer, len);
2461 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2462 doc: /* Parse STRING as a decimal number and return the number.
2463 This parses both integers and floating point numbers.
2464 It ignores leading spaces and tabs, and all trailing chars.
2466 If BASE, interpret STRING as a number in that base. If BASE isn't
2467 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2468 If the base used is not 10, STRING is always parsed as integer. */)
2469 (register Lisp_Object string, Lisp_Object base)
2471 register char *p;
2472 register int b;
2473 Lisp_Object val;
2475 CHECK_STRING (string);
2477 if (NILP (base))
2478 b = 10;
2479 else
2481 CHECK_NUMBER (base);
2482 if (! (2 <= XINT (base) && XINT (base) <= 16))
2483 xsignal1 (Qargs_out_of_range, base);
2484 b = XINT (base);
2487 p = SSDATA (string);
2488 while (*p == ' ' || *p == '\t')
2489 p++;
2491 val = string_to_number (p, b, 1);
2492 return NILP (val) ? make_number (0) : val;
2495 enum arithop
2497 Aadd,
2498 Asub,
2499 Amult,
2500 Adiv,
2501 Alogand,
2502 Alogior,
2503 Alogxor,
2504 Amax,
2505 Amin
2508 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2509 ptrdiff_t, Lisp_Object *);
2510 static Lisp_Object
2511 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2513 register Lisp_Object val;
2514 ptrdiff_t argnum;
2515 register EMACS_INT accum = 0;
2516 register EMACS_INT next;
2518 int overflow = 0;
2519 ptrdiff_t ok_args;
2520 EMACS_INT ok_accum;
2522 switch (code)
2524 case Alogior:
2525 case Alogxor:
2526 case Aadd:
2527 case Asub:
2528 accum = 0;
2529 break;
2530 case Amult:
2531 accum = 1;
2532 break;
2533 case Alogand:
2534 accum = -1;
2535 break;
2536 default:
2537 break;
2540 for (argnum = 0; argnum < nargs; argnum++)
2542 if (! overflow)
2544 ok_args = argnum;
2545 ok_accum = accum;
2548 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2549 val = args[argnum];
2550 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2552 if (FLOATP (val))
2553 return float_arith_driver (ok_accum, ok_args, code,
2554 nargs, args);
2555 args[argnum] = val;
2556 next = XINT (args[argnum]);
2557 switch (code)
2559 case Aadd:
2560 if (INT_ADD_OVERFLOW (accum, next))
2562 overflow = 1;
2563 accum &= INTMASK;
2565 accum += next;
2566 break;
2567 case Asub:
2568 if (INT_SUBTRACT_OVERFLOW (accum, next))
2570 overflow = 1;
2571 accum &= INTMASK;
2573 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2574 break;
2575 case Amult:
2576 if (INT_MULTIPLY_OVERFLOW (accum, next))
2578 EMACS_UINT a = accum, b = next, ab = a * b;
2579 overflow = 1;
2580 accum = ab & INTMASK;
2582 else
2583 accum *= next;
2584 break;
2585 case Adiv:
2586 if (!argnum)
2587 accum = next;
2588 else
2590 if (next == 0)
2591 xsignal0 (Qarith_error);
2592 accum /= next;
2594 break;
2595 case Alogand:
2596 accum &= next;
2597 break;
2598 case Alogior:
2599 accum |= next;
2600 break;
2601 case Alogxor:
2602 accum ^= next;
2603 break;
2604 case Amax:
2605 if (!argnum || next > accum)
2606 accum = next;
2607 break;
2608 case Amin:
2609 if (!argnum || next < accum)
2610 accum = next;
2611 break;
2615 XSETINT (val, accum);
2616 return val;
2619 #undef isnan
2620 #define isnan(x) ((x) != (x))
2622 static Lisp_Object
2623 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2624 ptrdiff_t nargs, Lisp_Object *args)
2626 register Lisp_Object val;
2627 double next;
2629 for (; argnum < nargs; argnum++)
2631 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2632 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2634 if (FLOATP (val))
2636 next = XFLOAT_DATA (val);
2638 else
2640 args[argnum] = val; /* runs into a compiler bug. */
2641 next = XINT (args[argnum]);
2643 switch (code)
2645 case Aadd:
2646 accum += next;
2647 break;
2648 case Asub:
2649 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2650 break;
2651 case Amult:
2652 accum *= next;
2653 break;
2654 case Adiv:
2655 if (!argnum)
2656 accum = next;
2657 else
2659 if (! IEEE_FLOATING_POINT && next == 0)
2660 xsignal0 (Qarith_error);
2661 accum /= next;
2663 break;
2664 case Alogand:
2665 case Alogior:
2666 case Alogxor:
2667 return wrong_type_argument (Qinteger_or_marker_p, val);
2668 case Amax:
2669 if (!argnum || isnan (next) || next > accum)
2670 accum = next;
2671 break;
2672 case Amin:
2673 if (!argnum || isnan (next) || next < accum)
2674 accum = next;
2675 break;
2679 return make_float (accum);
2683 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2684 doc: /* Return sum of any number of arguments, which are numbers or markers.
2685 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2686 (ptrdiff_t nargs, Lisp_Object *args)
2688 return arith_driver (Aadd, nargs, args);
2691 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2692 doc: /* Negate number or subtract numbers or markers and return the result.
2693 With one arg, negates it. With more than one arg,
2694 subtracts all but the first from the first.
2695 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2696 (ptrdiff_t nargs, Lisp_Object *args)
2698 return arith_driver (Asub, nargs, args);
2701 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2702 doc: /* Return product of any number of arguments, which are numbers or markers.
2703 usage: (* &rest NUMBERS-OR-MARKERS) */)
2704 (ptrdiff_t nargs, Lisp_Object *args)
2706 return arith_driver (Amult, nargs, args);
2709 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2710 doc: /* Return first argument divided by all the remaining arguments.
2711 The arguments must be numbers or markers.
2712 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2713 (ptrdiff_t nargs, Lisp_Object *args)
2715 ptrdiff_t argnum;
2716 for (argnum = 2; argnum < nargs; argnum++)
2717 if (FLOATP (args[argnum]))
2718 return float_arith_driver (0, 0, Adiv, nargs, args);
2719 return arith_driver (Adiv, nargs, args);
2722 DEFUN ("%", Frem, Srem, 2, 2, 0,
2723 doc: /* Return remainder of X divided by Y.
2724 Both must be integers or markers. */)
2725 (register Lisp_Object x, Lisp_Object y)
2727 Lisp_Object val;
2729 CHECK_NUMBER_COERCE_MARKER (x);
2730 CHECK_NUMBER_COERCE_MARKER (y);
2732 if (XINT (y) == 0)
2733 xsignal0 (Qarith_error);
2735 XSETINT (val, XINT (x) % XINT (y));
2736 return val;
2739 #ifndef HAVE_FMOD
2740 double
2741 fmod (double f1, double f2)
2743 double r = f1;
2745 if (f2 < 0.0)
2746 f2 = -f2;
2748 /* If the magnitude of the result exceeds that of the divisor, or
2749 the sign of the result does not agree with that of the dividend,
2750 iterate with the reduced value. This does not yield a
2751 particularly accurate result, but at least it will be in the
2752 range promised by fmod. */
2754 r -= f2 * floor (r / f2);
2755 while (f2 <= (r < 0 ? -r : r) || ((r < 0) != (f1 < 0) && ! isnan (r)));
2757 return r;
2759 #endif /* ! HAVE_FMOD */
2761 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2762 doc: /* Return X modulo Y.
2763 The result falls between zero (inclusive) and Y (exclusive).
2764 Both X and Y must be numbers or markers. */)
2765 (register Lisp_Object x, Lisp_Object y)
2767 Lisp_Object val;
2768 EMACS_INT i1, i2;
2770 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2771 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2773 if (FLOATP (x) || FLOATP (y))
2774 return fmod_float (x, y);
2776 i1 = XINT (x);
2777 i2 = XINT (y);
2779 if (i2 == 0)
2780 xsignal0 (Qarith_error);
2782 i1 %= i2;
2784 /* If the "remainder" comes out with the wrong sign, fix it. */
2785 if (i2 < 0 ? i1 > 0 : i1 < 0)
2786 i1 += i2;
2788 XSETINT (val, i1);
2789 return val;
2792 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2793 doc: /* Return largest of all the arguments (which must be numbers or markers).
2794 The value is always a number; markers are converted to numbers.
2795 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2796 (ptrdiff_t nargs, Lisp_Object *args)
2798 return arith_driver (Amax, nargs, args);
2801 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2802 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2803 The value is always a number; markers are converted to numbers.
2804 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2805 (ptrdiff_t nargs, Lisp_Object *args)
2807 return arith_driver (Amin, nargs, args);
2810 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2811 doc: /* Return bitwise-and of all the arguments.
2812 Arguments may be integers, or markers converted to integers.
2813 usage: (logand &rest INTS-OR-MARKERS) */)
2814 (ptrdiff_t nargs, Lisp_Object *args)
2816 return arith_driver (Alogand, nargs, args);
2819 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2820 doc: /* Return bitwise-or of all the arguments.
2821 Arguments may be integers, or markers converted to integers.
2822 usage: (logior &rest INTS-OR-MARKERS) */)
2823 (ptrdiff_t nargs, Lisp_Object *args)
2825 return arith_driver (Alogior, nargs, args);
2828 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2829 doc: /* Return bitwise-exclusive-or of all the arguments.
2830 Arguments may be integers, or markers converted to integers.
2831 usage: (logxor &rest INTS-OR-MARKERS) */)
2832 (ptrdiff_t nargs, Lisp_Object *args)
2834 return arith_driver (Alogxor, nargs, args);
2837 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2838 doc: /* Return VALUE with its bits shifted left by COUNT.
2839 If COUNT is negative, shifting is actually to the right.
2840 In this case, the sign bit is duplicated. */)
2841 (register Lisp_Object value, Lisp_Object count)
2843 register Lisp_Object val;
2845 CHECK_NUMBER (value);
2846 CHECK_NUMBER (count);
2848 if (XINT (count) >= BITS_PER_EMACS_INT)
2849 XSETINT (val, 0);
2850 else if (XINT (count) > 0)
2851 XSETINT (val, XINT (value) << XFASTINT (count));
2852 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2853 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2854 else
2855 XSETINT (val, XINT (value) >> -XINT (count));
2856 return val;
2859 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2860 doc: /* Return VALUE with its bits shifted left by COUNT.
2861 If COUNT is negative, shifting is actually to the right.
2862 In this case, zeros are shifted in on the left. */)
2863 (register Lisp_Object value, Lisp_Object count)
2865 register Lisp_Object val;
2867 CHECK_NUMBER (value);
2868 CHECK_NUMBER (count);
2870 if (XINT (count) >= BITS_PER_EMACS_INT)
2871 XSETINT (val, 0);
2872 else if (XINT (count) > 0)
2873 XSETINT (val, XUINT (value) << XFASTINT (count));
2874 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2875 XSETINT (val, 0);
2876 else
2877 XSETINT (val, XUINT (value) >> -XINT (count));
2878 return val;
2881 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2882 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2883 Markers are converted to integers. */)
2884 (register Lisp_Object number)
2886 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2888 if (FLOATP (number))
2889 return (make_float (1.0 + XFLOAT_DATA (number)));
2891 XSETINT (number, XINT (number) + 1);
2892 return number;
2895 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2896 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2897 Markers are converted to integers. */)
2898 (register Lisp_Object number)
2900 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2902 if (FLOATP (number))
2903 return (make_float (-1.0 + XFLOAT_DATA (number)));
2905 XSETINT (number, XINT (number) - 1);
2906 return number;
2909 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2910 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2911 (register Lisp_Object number)
2913 CHECK_NUMBER (number);
2914 XSETINT (number, ~XINT (number));
2915 return number;
2918 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2919 doc: /* Return the byteorder for the machine.
2920 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2921 lowercase l) for small endian machines. */)
2922 (void)
2924 unsigned i = 0x04030201;
2925 int order = *(char *)&i == 1 ? 108 : 66;
2927 return make_number (order);
2932 void
2933 syms_of_data (void)
2935 Lisp_Object error_tail, arith_tail;
2937 DEFSYM (Qquote, "quote");
2938 DEFSYM (Qlambda, "lambda");
2939 DEFSYM (Qsubr, "subr");
2940 DEFSYM (Qerror_conditions, "error-conditions");
2941 DEFSYM (Qerror_message, "error-message");
2942 DEFSYM (Qtop_level, "top-level");
2944 DEFSYM (Qerror, "error");
2945 DEFSYM (Quser_error, "user-error");
2946 DEFSYM (Qquit, "quit");
2947 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2948 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2949 DEFSYM (Qvoid_function, "void-function");
2950 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2951 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2952 DEFSYM (Qvoid_variable, "void-variable");
2953 DEFSYM (Qsetting_constant, "setting-constant");
2954 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2956 DEFSYM (Qinvalid_function, "invalid-function");
2957 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2958 DEFSYM (Qno_catch, "no-catch");
2959 DEFSYM (Qend_of_file, "end-of-file");
2960 DEFSYM (Qarith_error, "arith-error");
2961 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2962 DEFSYM (Qend_of_buffer, "end-of-buffer");
2963 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2964 DEFSYM (Qtext_read_only, "text-read-only");
2965 DEFSYM (Qmark_inactive, "mark-inactive");
2967 DEFSYM (Qlistp, "listp");
2968 DEFSYM (Qconsp, "consp");
2969 DEFSYM (Qsymbolp, "symbolp");
2970 DEFSYM (Qkeywordp, "keywordp");
2971 DEFSYM (Qintegerp, "integerp");
2972 DEFSYM (Qnatnump, "natnump");
2973 DEFSYM (Qwholenump, "wholenump");
2974 DEFSYM (Qstringp, "stringp");
2975 DEFSYM (Qarrayp, "arrayp");
2976 DEFSYM (Qsequencep, "sequencep");
2977 DEFSYM (Qbufferp, "bufferp");
2978 DEFSYM (Qvectorp, "vectorp");
2979 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2980 DEFSYM (Qmarkerp, "markerp");
2981 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2982 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2983 DEFSYM (Qboundp, "boundp");
2984 DEFSYM (Qfboundp, "fboundp");
2986 DEFSYM (Qfloatp, "floatp");
2987 DEFSYM (Qnumberp, "numberp");
2988 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
2990 DEFSYM (Qchar_table_p, "char-table-p");
2991 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
2993 DEFSYM (Qsubrp, "subrp");
2994 DEFSYM (Qunevalled, "unevalled");
2995 DEFSYM (Qmany, "many");
2997 DEFSYM (Qcdr, "cdr");
2999 /* Handle automatic advice activation. */
3000 DEFSYM (Qad_advice_info, "ad-advice-info");
3001 DEFSYM (Qad_activate_internal, "ad-activate-internal");
3003 error_tail = pure_cons (Qerror, Qnil);
3005 /* ERROR is used as a signaler for random errors for which nothing else is
3006 right. */
3008 Fput (Qerror, Qerror_conditions,
3009 error_tail);
3010 Fput (Qerror, Qerror_message,
3011 build_pure_c_string ("error"));
3013 #define PUT_ERROR(sym, tail, msg) \
3014 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3015 Fput (sym, Qerror_message, build_pure_c_string (msg))
3017 PUT_ERROR (Qquit, Qnil, "Quit");
3019 PUT_ERROR (Quser_error, error_tail, "");
3020 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3021 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3022 PUT_ERROR (Qvoid_function, error_tail,
3023 "Symbol's function definition is void");
3024 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3025 "Symbol's chain of function indirections contains a loop");
3026 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3027 "Symbol's chain of variable indirections contains a loop");
3028 DEFSYM (Qcircular_list, "circular-list");
3029 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3030 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3031 PUT_ERROR (Qsetting_constant, error_tail,
3032 "Attempt to set a constant symbol");
3033 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3034 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3035 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3036 "Wrong number of arguments");
3037 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3038 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3040 arith_tail = pure_cons (Qarith_error, error_tail);
3041 Fput (Qarith_error, Qerror_conditions, arith_tail);
3042 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3044 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3045 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3046 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3047 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3048 "Text is read-only");
3050 DEFSYM (Qrange_error, "range-error");
3051 DEFSYM (Qdomain_error, "domain-error");
3052 DEFSYM (Qsingularity_error, "singularity-error");
3053 DEFSYM (Qoverflow_error, "overflow-error");
3054 DEFSYM (Qunderflow_error, "underflow-error");
3056 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3058 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3060 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3061 "Arithmetic singularity error");
3063 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3064 "Arithmetic overflow error");
3065 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3066 "Arithmetic underflow error");
3068 staticpro (&Qnil);
3069 staticpro (&Qt);
3070 staticpro (&Qunbound);
3072 /* Types that type-of returns. */
3073 DEFSYM (Qinteger, "integer");
3074 DEFSYM (Qsymbol, "symbol");
3075 DEFSYM (Qstring, "string");
3076 DEFSYM (Qcons, "cons");
3077 DEFSYM (Qmarker, "marker");
3078 DEFSYM (Qoverlay, "overlay");
3079 DEFSYM (Qfloat, "float");
3080 DEFSYM (Qwindow_configuration, "window-configuration");
3081 DEFSYM (Qprocess, "process");
3082 DEFSYM (Qwindow, "window");
3083 DEFSYM (Qcompiled_function, "compiled-function");
3084 DEFSYM (Qbuffer, "buffer");
3085 DEFSYM (Qframe, "frame");
3086 DEFSYM (Qvector, "vector");
3087 DEFSYM (Qchar_table, "char-table");
3088 DEFSYM (Qbool_vector, "bool-vector");
3089 DEFSYM (Qhash_table, "hash-table");
3090 /* Used by Fgarbage_collect. */
3091 DEFSYM (Qinterval, "interval");
3092 DEFSYM (Qmisc, "misc");
3094 DEFSYM (Qdefun, "defun");
3096 DEFSYM (Qfont_spec, "font-spec");
3097 DEFSYM (Qfont_entity, "font-entity");
3098 DEFSYM (Qfont_object, "font-object");
3100 DEFSYM (Qinteractive_form, "interactive-form");
3102 defsubr (&Sindirect_variable);
3103 defsubr (&Sinteractive_form);
3104 defsubr (&Seq);
3105 defsubr (&Snull);
3106 defsubr (&Stype_of);
3107 defsubr (&Slistp);
3108 defsubr (&Snlistp);
3109 defsubr (&Sconsp);
3110 defsubr (&Satom);
3111 defsubr (&Sintegerp);
3112 defsubr (&Sinteger_or_marker_p);
3113 defsubr (&Snumberp);
3114 defsubr (&Snumber_or_marker_p);
3115 defsubr (&Sfloatp);
3116 defsubr (&Snatnump);
3117 defsubr (&Ssymbolp);
3118 defsubr (&Skeywordp);
3119 defsubr (&Sstringp);
3120 defsubr (&Smultibyte_string_p);
3121 defsubr (&Svectorp);
3122 defsubr (&Schar_table_p);
3123 defsubr (&Svector_or_char_table_p);
3124 defsubr (&Sbool_vector_p);
3125 defsubr (&Sarrayp);
3126 defsubr (&Ssequencep);
3127 defsubr (&Sbufferp);
3128 defsubr (&Smarkerp);
3129 defsubr (&Ssubrp);
3130 defsubr (&Sbyte_code_function_p);
3131 defsubr (&Schar_or_string_p);
3132 defsubr (&Scar);
3133 defsubr (&Scdr);
3134 defsubr (&Scar_safe);
3135 defsubr (&Scdr_safe);
3136 defsubr (&Ssetcar);
3137 defsubr (&Ssetcdr);
3138 defsubr (&Ssymbol_function);
3139 defsubr (&Sindirect_function);
3140 defsubr (&Ssymbol_plist);
3141 defsubr (&Ssymbol_name);
3142 defsubr (&Smakunbound);
3143 defsubr (&Sfmakunbound);
3144 defsubr (&Sboundp);
3145 defsubr (&Sfboundp);
3146 defsubr (&Sfset);
3147 defsubr (&Sdefalias);
3148 defsubr (&Ssetplist);
3149 defsubr (&Ssymbol_value);
3150 defsubr (&Sset);
3151 defsubr (&Sdefault_boundp);
3152 defsubr (&Sdefault_value);
3153 defsubr (&Sset_default);
3154 defsubr (&Ssetq_default);
3155 defsubr (&Smake_variable_buffer_local);
3156 defsubr (&Smake_local_variable);
3157 defsubr (&Skill_local_variable);
3158 defsubr (&Smake_variable_frame_local);
3159 defsubr (&Slocal_variable_p);
3160 defsubr (&Slocal_variable_if_set_p);
3161 defsubr (&Svariable_binding_locus);
3162 #if 0 /* XXX Remove this. --lorentey */
3163 defsubr (&Sterminal_local_value);
3164 defsubr (&Sset_terminal_local_value);
3165 #endif
3166 defsubr (&Saref);
3167 defsubr (&Saset);
3168 defsubr (&Snumber_to_string);
3169 defsubr (&Sstring_to_number);
3170 defsubr (&Seqlsign);
3171 defsubr (&Slss);
3172 defsubr (&Sgtr);
3173 defsubr (&Sleq);
3174 defsubr (&Sgeq);
3175 defsubr (&Sneq);
3176 defsubr (&Szerop);
3177 defsubr (&Splus);
3178 defsubr (&Sminus);
3179 defsubr (&Stimes);
3180 defsubr (&Squo);
3181 defsubr (&Srem);
3182 defsubr (&Smod);
3183 defsubr (&Smax);
3184 defsubr (&Smin);
3185 defsubr (&Slogand);
3186 defsubr (&Slogior);
3187 defsubr (&Slogxor);
3188 defsubr (&Slsh);
3189 defsubr (&Sash);
3190 defsubr (&Sadd1);
3191 defsubr (&Ssub1);
3192 defsubr (&Slognot);
3193 defsubr (&Sbyteorder);
3194 defsubr (&Ssubr_arity);
3195 defsubr (&Ssubr_name);
3197 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3199 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3200 doc: /* The largest value that is representable in a Lisp integer. */);
3201 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3202 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3204 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3205 doc: /* The smallest value that is representable in a Lisp integer. */);
3206 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3207 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;
3210 #ifndef FORWARD_SIGNAL_TO_MAIN_THREAD
3211 _Noreturn
3212 #endif
3213 static void
3214 arith_error (int signo)
3216 sigsetmask (SIGEMPTYMASK);
3218 SIGNAL_THREAD_CHECK (signo);
3219 xsignal0 (Qarith_error);
3222 void
3223 init_data (void)
3225 /* Don't do this if just dumping out.
3226 We don't want to call `signal' in this case
3227 so that we don't have trouble with dumping
3228 signal-delivering routines in an inconsistent state. */
3229 #ifndef CANNOT_DUMP
3230 if (!initialized)
3231 return;
3232 #endif /* CANNOT_DUMP */
3233 signal (SIGFPE, arith_error);