* lisp/emacs-lisp/pcase.el (pcase-UPAT, pcase-QPAT): New edebug specs.
[emacs.git] / src / data.c
blobdefcd06a2edbfe2c5b362e18e83787b84d6723cb
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;
87 static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
88 Lisp_Object Qwindow;
89 static Lisp_Object Qfloat, Qwindow_configuration;
90 static Lisp_Object Qprocess;
91 static Lisp_Object Qcompiled_function, Qframe, Qvector;
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 XSYMBOL (symbol)->function = 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 XSYMBOL (symbol)->function = definition;
640 /* Handle automatic advice activation */
641 if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
643 call2 (Qad_activate_internal, symbol, Qnil);
644 definition = XSYMBOL (symbol)->function;
646 return definition;
649 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
650 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
651 Associates the function with the current load file, if any.
652 The optional third argument DOCSTRING specifies the documentation string
653 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
654 determined by DEFINITION. */)
655 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
657 CHECK_SYMBOL (symbol);
658 if (CONSP (XSYMBOL (symbol)->function)
659 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
660 LOADHIST_ATTACH (Fcons (Qt, symbol));
661 if (!NILP (Vpurify_flag)
662 /* If `definition' is a keymap, immutable (and copying) is wrong. */
663 && !KEYMAPP (definition))
664 definition = Fpurecopy (definition);
665 definition = Ffset (symbol, definition);
666 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
667 if (!NILP (docstring))
668 Fput (symbol, Qfunction_documentation, docstring);
669 return definition;
672 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
673 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
674 (register Lisp_Object symbol, Lisp_Object newplist)
676 CHECK_SYMBOL (symbol);
677 XSYMBOL (symbol)->plist = newplist;
678 return newplist;
681 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
682 doc: /* Return minimum and maximum number of args allowed for SUBR.
683 SUBR must be a built-in function.
684 The returned value is a pair (MIN . MAX). MIN is the minimum number
685 of args. MAX is the maximum number or the symbol `many', for a
686 function with `&rest' args, or `unevalled' for a special form. */)
687 (Lisp_Object subr)
689 short minargs, maxargs;
690 CHECK_SUBR (subr);
691 minargs = XSUBR (subr)->min_args;
692 maxargs = XSUBR (subr)->max_args;
693 if (maxargs == MANY)
694 return Fcons (make_number (minargs), Qmany);
695 else if (maxargs == UNEVALLED)
696 return Fcons (make_number (minargs), Qunevalled);
697 else
698 return Fcons (make_number (minargs), make_number (maxargs));
701 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
702 doc: /* Return name of subroutine SUBR.
703 SUBR must be a built-in function. */)
704 (Lisp_Object subr)
706 const char *name;
707 CHECK_SUBR (subr);
708 name = XSUBR (subr)->symbol_name;
709 return build_string (name);
712 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
713 doc: /* Return the interactive form of CMD or nil if none.
714 If CMD is not a command, the return value is nil.
715 Value, if non-nil, is a list \(interactive SPEC). */)
716 (Lisp_Object cmd)
718 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
720 if (NILP (fun) || EQ (fun, Qunbound))
721 return Qnil;
723 /* Use an `interactive-form' property if present, analogous to the
724 function-documentation property. */
725 fun = cmd;
726 while (SYMBOLP (fun))
728 Lisp_Object tmp = Fget (fun, Qinteractive_form);
729 if (!NILP (tmp))
730 return tmp;
731 else
732 fun = Fsymbol_function (fun);
735 if (SUBRP (fun))
737 const char *spec = XSUBR (fun)->intspec;
738 if (spec)
739 return list2 (Qinteractive,
740 (*spec != '(') ? build_string (spec) :
741 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
743 else if (COMPILEDP (fun))
745 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
746 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
748 else if (CONSP (fun))
750 Lisp_Object funcar = XCAR (fun);
751 if (EQ (funcar, Qclosure))
752 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
753 else if (EQ (funcar, Qlambda))
754 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
755 else if (EQ (funcar, Qautoload))
757 struct gcpro gcpro1;
758 GCPRO1 (cmd);
759 do_autoload (fun, cmd);
760 UNGCPRO;
761 return Finteractive_form (cmd);
764 return Qnil;
768 /***********************************************************************
769 Getting and Setting Values of Symbols
770 ***********************************************************************/
772 /* Return the symbol holding SYMBOL's value. Signal
773 `cyclic-variable-indirection' if SYMBOL's chain of variable
774 indirections contains a loop. */
776 struct Lisp_Symbol *
777 indirect_variable (struct Lisp_Symbol *symbol)
779 struct Lisp_Symbol *tortoise, *hare;
781 hare = tortoise = symbol;
783 while (hare->redirect == SYMBOL_VARALIAS)
785 hare = SYMBOL_ALIAS (hare);
786 if (hare->redirect != SYMBOL_VARALIAS)
787 break;
789 hare = SYMBOL_ALIAS (hare);
790 tortoise = SYMBOL_ALIAS (tortoise);
792 if (hare == tortoise)
794 Lisp_Object tem;
795 XSETSYMBOL (tem, symbol);
796 xsignal1 (Qcyclic_variable_indirection, tem);
800 return hare;
804 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
805 doc: /* Return the variable at the end of OBJECT's variable chain.
806 If OBJECT is a symbol, follow all variable indirections and return the final
807 variable. If OBJECT is not a symbol, just return it.
808 Signal a cyclic-variable-indirection error if there is a loop in the
809 variable chain of symbols. */)
810 (Lisp_Object object)
812 if (SYMBOLP (object))
814 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
815 XSETSYMBOL (object, sym);
817 return object;
821 /* Given the raw contents of a symbol value cell,
822 return the Lisp value of the symbol.
823 This does not handle buffer-local variables; use
824 swap_in_symval_forwarding for that. */
826 Lisp_Object
827 do_symval_forwarding (register union Lisp_Fwd *valcontents)
829 register Lisp_Object val;
830 switch (XFWDTYPE (valcontents))
832 case Lisp_Fwd_Int:
833 XSETINT (val, *XINTFWD (valcontents)->intvar);
834 return val;
836 case Lisp_Fwd_Bool:
837 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
839 case Lisp_Fwd_Obj:
840 return *XOBJFWD (valcontents)->objvar;
842 case Lisp_Fwd_Buffer_Obj:
843 return PER_BUFFER_VALUE (current_buffer,
844 XBUFFER_OBJFWD (valcontents)->offset);
846 case Lisp_Fwd_Kboard_Obj:
847 /* We used to simply use current_kboard here, but from Lisp
848 code, its value is often unexpected. It seems nicer to
849 allow constructions like this to work as intuitively expected:
851 (with-selected-frame frame
852 (define-key local-function-map "\eOP" [f1]))
854 On the other hand, this affects the semantics of
855 last-command and real-last-command, and people may rely on
856 that. I took a quick look at the Lisp codebase, and I
857 don't think anything will break. --lorentey */
858 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
859 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
860 default: abort ();
864 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
865 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
866 buffer-independent contents of the value cell: forwarded just one
867 step past the buffer-localness.
869 BUF non-zero means set the value in buffer BUF instead of the
870 current buffer. This only plays a role for per-buffer variables. */
872 static void
873 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
875 switch (XFWDTYPE (valcontents))
877 case Lisp_Fwd_Int:
878 CHECK_NUMBER (newval);
879 *XINTFWD (valcontents)->intvar = XINT (newval);
880 break;
882 case Lisp_Fwd_Bool:
883 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
884 break;
886 case Lisp_Fwd_Obj:
887 *XOBJFWD (valcontents)->objvar = newval;
889 /* If this variable is a default for something stored
890 in the buffer itself, such as default-fill-column,
891 find the buffers that don't have local values for it
892 and update them. */
893 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
894 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
896 int offset = ((char *) XOBJFWD (valcontents)->objvar
897 - (char *) &buffer_defaults);
898 int idx = PER_BUFFER_IDX (offset);
900 Lisp_Object tail;
902 if (idx <= 0)
903 break;
905 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
907 Lisp_Object lbuf;
908 struct buffer *b;
910 lbuf = Fcdr (XCAR (tail));
911 if (!BUFFERP (lbuf)) continue;
912 b = XBUFFER (lbuf);
914 if (! PER_BUFFER_VALUE_P (b, idx))
915 PER_BUFFER_VALUE (b, offset) = newval;
918 break;
920 case Lisp_Fwd_Buffer_Obj:
922 int offset = XBUFFER_OBJFWD (valcontents)->offset;
923 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
925 if (!(NILP (type) || NILP (newval)
926 || (XINT (type) == LISP_INT_TAG
927 ? INTEGERP (newval)
928 : XTYPE (newval) == XINT (type))))
929 buffer_slot_type_mismatch (newval, XINT (type));
931 if (buf == NULL)
932 buf = current_buffer;
933 PER_BUFFER_VALUE (buf, offset) = newval;
935 break;
937 case Lisp_Fwd_Kboard_Obj:
939 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
940 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
941 *(Lisp_Object *) p = newval;
943 break;
945 default:
946 abort (); /* goto def; */
950 /* Set up SYMBOL to refer to its global binding.
951 This makes it safe to alter the status of other bindings. */
953 void
954 swap_in_global_binding (struct Lisp_Symbol *symbol)
956 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
958 /* Unload the previously loaded binding. */
959 if (blv->fwd)
960 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
962 /* Select the global binding in the symbol. */
963 blv->valcell = blv->defcell;
964 if (blv->fwd)
965 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
967 /* Indicate that the global binding is set up now. */
968 blv->where = Qnil;
969 SET_BLV_FOUND (blv, 0);
972 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
973 VALCONTENTS is the contents of its value cell,
974 which points to a struct Lisp_Buffer_Local_Value.
976 Return the value forwarded one step past the buffer-local stage.
977 This could be another forwarding pointer. */
979 static void
980 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
982 register Lisp_Object tem1;
984 eassert (blv == SYMBOL_BLV (symbol));
986 tem1 = blv->where;
988 if (NILP (tem1)
989 || (blv->frame_local
990 ? !EQ (selected_frame, tem1)
991 : current_buffer != XBUFFER (tem1)))
994 /* Unload the previously loaded binding. */
995 tem1 = blv->valcell;
996 if (blv->fwd)
997 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
998 /* Choose the new binding. */
1000 Lisp_Object var;
1001 XSETSYMBOL (var, symbol);
1002 if (blv->frame_local)
1004 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1005 blv->where = selected_frame;
1007 else
1009 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1010 XSETBUFFER (blv->where, current_buffer);
1013 if (!(blv->found = !NILP (tem1)))
1014 tem1 = blv->defcell;
1016 /* Load the new binding. */
1017 blv->valcell = tem1;
1018 if (blv->fwd)
1019 store_symval_forwarding (blv->fwd, BLV_VALUE (blv), NULL);
1023 /* Find the value of a symbol, returning Qunbound if it's not bound.
1024 This is helpful for code which just wants to get a variable's value
1025 if it has one, without signaling an error.
1026 Note that it must not be possible to quit
1027 within this function. Great care is required for this. */
1029 Lisp_Object
1030 find_symbol_value (Lisp_Object symbol)
1032 struct Lisp_Symbol *sym;
1034 CHECK_SYMBOL (symbol);
1035 sym = XSYMBOL (symbol);
1037 start:
1038 switch (sym->redirect)
1040 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1041 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1042 case SYMBOL_LOCALIZED:
1044 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1045 swap_in_symval_forwarding (sym, blv);
1046 return blv->fwd ? do_symval_forwarding (blv->fwd) : BLV_VALUE (blv);
1048 /* FALLTHROUGH */
1049 case SYMBOL_FORWARDED:
1050 return do_symval_forwarding (SYMBOL_FWD (sym));
1051 default: abort ();
1055 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1056 doc: /* Return SYMBOL's value. Error if that is void. */)
1057 (Lisp_Object symbol)
1059 Lisp_Object val;
1061 val = find_symbol_value (symbol);
1062 if (!EQ (val, Qunbound))
1063 return val;
1065 xsignal1 (Qvoid_variable, symbol);
1068 DEFUN ("set", Fset, Sset, 2, 2, 0,
1069 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1070 (register Lisp_Object symbol, Lisp_Object newval)
1072 set_internal (symbol, newval, Qnil, 0);
1073 return newval;
1076 /* Return 1 if SYMBOL currently has a let-binding
1077 which was made in the buffer that is now current. */
1079 static int
1080 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1082 struct specbinding *p;
1084 for (p = specpdl_ptr; p > specpdl; )
1085 if ((--p)->func == NULL
1086 && CONSP (p->symbol))
1088 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1089 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1090 if (symbol == let_bound_symbol
1091 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1092 return 1;
1095 return 0;
1098 static int
1099 let_shadows_global_binding_p (Lisp_Object symbol)
1101 struct specbinding *p;
1103 for (p = specpdl_ptr; p > specpdl; )
1104 if ((--p)->func == NULL && EQ (p->symbol, symbol))
1105 return 1;
1107 return 0;
1110 /* Store the value NEWVAL into SYMBOL.
1111 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1112 (nil stands for the current buffer/frame).
1114 If BINDFLAG is zero, then if this symbol is supposed to become
1115 local in every buffer where it is set, then we make it local.
1116 If BINDFLAG is nonzero, we don't do that. */
1118 void
1119 set_internal (register Lisp_Object symbol, register Lisp_Object newval, register Lisp_Object where, int bindflag)
1121 int voide = EQ (newval, Qunbound);
1122 struct Lisp_Symbol *sym;
1123 Lisp_Object tem1;
1125 /* If restoring in a dead buffer, do nothing. */
1126 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1127 return; */
1129 CHECK_SYMBOL (symbol);
1130 if (SYMBOL_CONSTANT_P (symbol))
1132 if (NILP (Fkeywordp (symbol))
1133 || !EQ (newval, Fsymbol_value (symbol)))
1134 xsignal1 (Qsetting_constant, symbol);
1135 else
1136 /* Allow setting keywords to their own value. */
1137 return;
1140 sym = XSYMBOL (symbol);
1142 start:
1143 switch (sym->redirect)
1145 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1146 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1147 case SYMBOL_LOCALIZED:
1149 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1150 if (NILP (where))
1152 if (blv->frame_local)
1153 where = selected_frame;
1154 else
1155 XSETBUFFER (where, current_buffer);
1157 /* If the current buffer is not the buffer whose binding is
1158 loaded, or if there may be frame-local bindings and the frame
1159 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1160 the default binding is loaded, the loaded binding may be the
1161 wrong one. */
1162 if (!EQ (blv->where, where)
1163 /* Also unload a global binding (if the var is local_if_set). */
1164 || (EQ (blv->valcell, blv->defcell)))
1166 /* The currently loaded binding is not necessarily valid.
1167 We need to unload it, and choose a new binding. */
1169 /* Write out `realvalue' to the old loaded binding. */
1170 if (blv->fwd)
1171 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1173 /* Find the new binding. */
1174 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1175 tem1 = Fassq (symbol,
1176 (blv->frame_local
1177 ? XFRAME (where)->param_alist
1178 : BVAR (XBUFFER (where), local_var_alist)));
1179 blv->where = where;
1180 blv->found = 1;
1182 if (NILP (tem1))
1184 /* This buffer still sees the default value. */
1186 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1187 or if this is `let' rather than `set',
1188 make CURRENT-ALIST-ELEMENT point to itself,
1189 indicating that we're seeing the default value.
1190 Likewise if the variable has been let-bound
1191 in the current buffer. */
1192 if (bindflag || !blv->local_if_set
1193 || let_shadows_buffer_binding_p (sym))
1195 blv->found = 0;
1196 tem1 = blv->defcell;
1198 /* If it's a local_if_set, being set not bound,
1199 and we're not within a let that was made for this buffer,
1200 create a new buffer-local binding for the variable.
1201 That means, give this buffer a new assoc for a local value
1202 and load that binding. */
1203 else
1205 /* local_if_set is only supported for buffer-local
1206 bindings, not for frame-local bindings. */
1207 eassert (!blv->frame_local);
1208 tem1 = Fcons (symbol, XCDR (blv->defcell));
1209 BVAR (XBUFFER (where), local_var_alist)
1210 = Fcons (tem1, BVAR (XBUFFER (where), local_var_alist));
1214 /* Record which binding is now loaded. */
1215 blv->valcell = tem1;
1218 /* Store the new value in the cons cell. */
1219 SET_BLV_VALUE (blv, newval);
1221 if (blv->fwd)
1223 if (voide)
1224 /* If storing void (making the symbol void), forward only through
1225 buffer-local indicator, not through Lisp_Objfwd, etc. */
1226 blv->fwd = NULL;
1227 else
1228 store_symval_forwarding (blv->fwd, newval,
1229 BUFFERP (where)
1230 ? XBUFFER (where) : current_buffer);
1232 break;
1234 case SYMBOL_FORWARDED:
1236 struct buffer *buf
1237 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1238 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1239 if (BUFFER_OBJFWDP (innercontents))
1241 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1242 int idx = PER_BUFFER_IDX (offset);
1243 if (idx > 0
1244 && !bindflag
1245 && !let_shadows_buffer_binding_p (sym))
1246 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1249 if (voide)
1250 { /* If storing void (making the symbol void), forward only through
1251 buffer-local indicator, not through Lisp_Objfwd, etc. */
1252 sym->redirect = SYMBOL_PLAINVAL;
1253 SET_SYMBOL_VAL (sym, newval);
1255 else
1256 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1257 break;
1259 default: abort ();
1261 return;
1264 /* Access or set a buffer-local symbol's default value. */
1266 /* Return the default value of SYMBOL, but don't check for voidness.
1267 Return Qunbound if it is void. */
1269 static Lisp_Object
1270 default_value (Lisp_Object symbol)
1272 struct Lisp_Symbol *sym;
1274 CHECK_SYMBOL (symbol);
1275 sym = XSYMBOL (symbol);
1277 start:
1278 switch (sym->redirect)
1280 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1281 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1282 case SYMBOL_LOCALIZED:
1284 /* If var is set up for a buffer that lacks a local value for it,
1285 the current value is nominally the default value.
1286 But the `realvalue' slot may be more up to date, since
1287 ordinary setq stores just that slot. So use that. */
1288 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1289 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1290 return do_symval_forwarding (blv->fwd);
1291 else
1292 return XCDR (blv->defcell);
1294 case SYMBOL_FORWARDED:
1296 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1298 /* For a built-in buffer-local variable, get the default value
1299 rather than letting do_symval_forwarding get the current value. */
1300 if (BUFFER_OBJFWDP (valcontents))
1302 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1303 if (PER_BUFFER_IDX (offset) != 0)
1304 return PER_BUFFER_DEFAULT (offset);
1307 /* For other variables, get the current value. */
1308 return do_symval_forwarding (valcontents);
1310 default: abort ();
1314 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1315 doc: /* Return t if SYMBOL has a non-void default value.
1316 This is the value that is seen in buffers that do not have their own values
1317 for this variable. */)
1318 (Lisp_Object symbol)
1320 register Lisp_Object value;
1322 value = default_value (symbol);
1323 return (EQ (value, Qunbound) ? Qnil : Qt);
1326 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1327 doc: /* Return SYMBOL's default value.
1328 This is the value that is seen in buffers that do not have their own values
1329 for this variable. The default value is meaningful for variables with
1330 local bindings in certain buffers. */)
1331 (Lisp_Object symbol)
1333 register Lisp_Object value;
1335 value = default_value (symbol);
1336 if (!EQ (value, Qunbound))
1337 return value;
1339 xsignal1 (Qvoid_variable, symbol);
1342 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1343 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1344 The default value is seen in buffers that do not have their own values
1345 for this variable. */)
1346 (Lisp_Object symbol, Lisp_Object value)
1348 struct Lisp_Symbol *sym;
1350 CHECK_SYMBOL (symbol);
1351 if (SYMBOL_CONSTANT_P (symbol))
1353 if (NILP (Fkeywordp (symbol))
1354 || !EQ (value, Fdefault_value (symbol)))
1355 xsignal1 (Qsetting_constant, symbol);
1356 else
1357 /* Allow setting keywords to their own value. */
1358 return value;
1360 sym = XSYMBOL (symbol);
1362 start:
1363 switch (sym->redirect)
1365 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1366 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1367 case SYMBOL_LOCALIZED:
1369 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1371 /* Store new value into the DEFAULT-VALUE slot. */
1372 XSETCDR (blv->defcell, value);
1374 /* If the default binding is now loaded, set the REALVALUE slot too. */
1375 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1376 store_symval_forwarding (blv->fwd, value, NULL);
1377 return value;
1379 case SYMBOL_FORWARDED:
1381 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1383 /* Handle variables like case-fold-search that have special slots
1384 in the buffer.
1385 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1386 if (BUFFER_OBJFWDP (valcontents))
1388 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1389 int idx = PER_BUFFER_IDX (offset);
1391 PER_BUFFER_DEFAULT (offset) = value;
1393 /* If this variable is not always local in all buffers,
1394 set it in the buffers that don't nominally have a local value. */
1395 if (idx > 0)
1397 struct buffer *b;
1399 for (b = all_buffers; b; b = b->header.next.buffer)
1400 if (!PER_BUFFER_VALUE_P (b, idx))
1401 PER_BUFFER_VALUE (b, offset) = value;
1403 return value;
1405 else
1406 return Fset (symbol, value);
1408 default: abort ();
1412 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1413 doc: /* Set the default value of variable VAR to VALUE.
1414 VAR, the variable name, is literal (not evaluated);
1415 VALUE is an expression: it is evaluated and its value returned.
1416 The default value of a variable is seen in buffers
1417 that do not have their own values for the variable.
1419 More generally, you can use multiple variables and values, as in
1420 (setq-default VAR VALUE VAR VALUE...)
1421 This sets each VAR's default value to the corresponding VALUE.
1422 The VALUE for the Nth VAR can refer to the new default values
1423 of previous VARs.
1424 usage: (setq-default [VAR VALUE]...) */)
1425 (Lisp_Object args)
1427 register Lisp_Object args_left;
1428 register Lisp_Object val, symbol;
1429 struct gcpro gcpro1;
1431 if (NILP (args))
1432 return Qnil;
1434 args_left = args;
1435 GCPRO1 (args);
1439 val = eval_sub (Fcar (Fcdr (args_left)));
1440 symbol = XCAR (args_left);
1441 Fset_default (symbol, val);
1442 args_left = Fcdr (XCDR (args_left));
1444 while (!NILP (args_left));
1446 UNGCPRO;
1447 return val;
1450 /* Lisp functions for creating and removing buffer-local variables. */
1452 union Lisp_Val_Fwd
1454 Lisp_Object value;
1455 union Lisp_Fwd *fwd;
1458 static struct Lisp_Buffer_Local_Value *
1459 make_blv (struct Lisp_Symbol *sym, int forwarded, union Lisp_Val_Fwd valcontents)
1461 struct Lisp_Buffer_Local_Value *blv
1462 = xmalloc (sizeof (struct Lisp_Buffer_Local_Value));
1463 Lisp_Object symbol;
1464 Lisp_Object tem;
1466 XSETSYMBOL (symbol, sym);
1467 tem = Fcons (symbol, (forwarded
1468 ? do_symval_forwarding (valcontents.fwd)
1469 : valcontents.value));
1471 /* Buffer_Local_Values cannot have as realval a buffer-local
1472 or keyboard-local forwarding. */
1473 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1474 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1475 blv->fwd = forwarded ? valcontents.fwd : NULL;
1476 blv->where = Qnil;
1477 blv->frame_local = 0;
1478 blv->local_if_set = 0;
1479 blv->defcell = tem;
1480 blv->valcell = tem;
1481 SET_BLV_FOUND (blv, 0);
1482 return blv;
1485 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1486 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1487 doc: /* Make VARIABLE become buffer-local whenever it is set.
1488 At any time, the value for the current buffer is in effect,
1489 unless the variable has never been set in this buffer,
1490 in which case the default value is in effect.
1491 Note that binding the variable with `let', or setting it while
1492 a `let'-style binding made in this buffer is in effect,
1493 does not make the variable buffer-local. Return VARIABLE.
1495 In most cases it is better to use `make-local-variable',
1496 which makes a variable local in just one buffer.
1498 The function `default-value' gets the default value and `set-default' sets it. */)
1499 (register Lisp_Object variable)
1501 struct Lisp_Symbol *sym;
1502 struct Lisp_Buffer_Local_Value *blv = NULL;
1503 union Lisp_Val_Fwd valcontents IF_LINT (= {0});
1504 int forwarded IF_LINT (= 0);
1506 CHECK_SYMBOL (variable);
1507 sym = XSYMBOL (variable);
1509 start:
1510 switch (sym->redirect)
1512 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1513 case SYMBOL_PLAINVAL:
1514 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1515 if (EQ (valcontents.value, Qunbound))
1516 valcontents.value = Qnil;
1517 break;
1518 case SYMBOL_LOCALIZED:
1519 blv = SYMBOL_BLV (sym);
1520 if (blv->frame_local)
1521 error ("Symbol %s may not be buffer-local",
1522 SDATA (SYMBOL_NAME (variable)));
1523 break;
1524 case SYMBOL_FORWARDED:
1525 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1526 if (KBOARD_OBJFWDP (valcontents.fwd))
1527 error ("Symbol %s may not be buffer-local",
1528 SDATA (SYMBOL_NAME (variable)));
1529 else if (BUFFER_OBJFWDP (valcontents.fwd))
1530 return variable;
1531 break;
1532 default: abort ();
1535 if (sym->constant)
1536 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1538 if (!blv)
1540 blv = make_blv (sym, forwarded, valcontents);
1541 sym->redirect = SYMBOL_LOCALIZED;
1542 SET_SYMBOL_BLV (sym, blv);
1544 Lisp_Object symbol;
1545 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1546 if (let_shadows_global_binding_p (symbol))
1547 message ("Making %s buffer-local while let-bound!",
1548 SDATA (SYMBOL_NAME (variable)));
1552 blv->local_if_set = 1;
1553 return variable;
1556 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1557 1, 1, "vMake Local Variable: ",
1558 doc: /* Make VARIABLE have a separate value in the current buffer.
1559 Other buffers will continue to share a common default value.
1560 \(The buffer-local value of VARIABLE starts out as the same value
1561 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1562 Return VARIABLE.
1564 If the variable is already arranged to become local when set,
1565 this function causes a local value to exist for this buffer,
1566 just as setting the variable would do.
1568 This function returns VARIABLE, and therefore
1569 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1570 works.
1572 See also `make-variable-buffer-local'.
1574 Do not use `make-local-variable' to make a hook variable buffer-local.
1575 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1576 (register Lisp_Object variable)
1578 register Lisp_Object tem;
1579 int forwarded IF_LINT (= 0);
1580 union Lisp_Val_Fwd valcontents IF_LINT (= {0});
1581 struct Lisp_Symbol *sym;
1582 struct Lisp_Buffer_Local_Value *blv = NULL;
1584 CHECK_SYMBOL (variable);
1585 sym = XSYMBOL (variable);
1587 start:
1588 switch (sym->redirect)
1590 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1591 case SYMBOL_PLAINVAL:
1592 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1593 case SYMBOL_LOCALIZED:
1594 blv = SYMBOL_BLV (sym);
1595 if (blv->frame_local)
1596 error ("Symbol %s may not be buffer-local",
1597 SDATA (SYMBOL_NAME (variable)));
1598 break;
1599 case SYMBOL_FORWARDED:
1600 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1601 if (KBOARD_OBJFWDP (valcontents.fwd))
1602 error ("Symbol %s may not be buffer-local",
1603 SDATA (SYMBOL_NAME (variable)));
1604 break;
1605 default: abort ();
1608 if (sym->constant)
1609 error ("Symbol %s may not be buffer-local",
1610 SDATA (SYMBOL_NAME (variable)));
1612 if (blv ? blv->local_if_set
1613 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1615 tem = Fboundp (variable);
1616 /* Make sure the symbol has a local value in this particular buffer,
1617 by setting it to the same value it already has. */
1618 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1619 return variable;
1621 if (!blv)
1623 blv = make_blv (sym, forwarded, valcontents);
1624 sym->redirect = SYMBOL_LOCALIZED;
1625 SET_SYMBOL_BLV (sym, blv);
1627 Lisp_Object symbol;
1628 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1629 if (let_shadows_global_binding_p (symbol))
1630 message ("Making %s local to %s while let-bound!",
1631 SDATA (SYMBOL_NAME (variable)),
1632 SDATA (BVAR (current_buffer, name)));
1636 /* Make sure this buffer has its own value of symbol. */
1637 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1638 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1639 if (NILP (tem))
1641 if (let_shadows_buffer_binding_p (sym))
1642 message ("Making %s buffer-local while locally let-bound!",
1643 SDATA (SYMBOL_NAME (variable)));
1645 /* Swap out any local binding for some other buffer, and make
1646 sure the current value is permanently recorded, if it's the
1647 default value. */
1648 find_symbol_value (variable);
1650 BVAR (current_buffer, local_var_alist)
1651 = Fcons (Fcons (variable, XCDR (blv->defcell)),
1652 BVAR (current_buffer, local_var_alist));
1654 /* Make sure symbol does not think it is set up for this buffer;
1655 force it to look once again for this buffer's value. */
1656 if (current_buffer == XBUFFER (blv->where))
1657 blv->where = Qnil;
1658 /* blv->valcell = blv->defcell;
1659 * SET_BLV_FOUND (blv, 0); */
1660 blv->found = 0;
1663 /* If the symbol forwards into a C variable, then load the binding
1664 for this buffer now. If C code modifies the variable before we
1665 load the binding in, then that new value will clobber the default
1666 binding the next time we unload it. */
1667 if (blv->fwd)
1668 swap_in_symval_forwarding (sym, blv);
1670 return variable;
1673 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1674 1, 1, "vKill Local Variable: ",
1675 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1676 From now on the default value will apply in this buffer. Return VARIABLE. */)
1677 (register Lisp_Object variable)
1679 register Lisp_Object tem;
1680 struct Lisp_Buffer_Local_Value *blv;
1681 struct Lisp_Symbol *sym;
1683 CHECK_SYMBOL (variable);
1684 sym = XSYMBOL (variable);
1686 start:
1687 switch (sym->redirect)
1689 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1690 case SYMBOL_PLAINVAL: return variable;
1691 case SYMBOL_FORWARDED:
1693 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1694 if (BUFFER_OBJFWDP (valcontents))
1696 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1697 int idx = PER_BUFFER_IDX (offset);
1699 if (idx > 0)
1701 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1702 PER_BUFFER_VALUE (current_buffer, offset)
1703 = PER_BUFFER_DEFAULT (offset);
1706 return variable;
1708 case SYMBOL_LOCALIZED:
1709 blv = SYMBOL_BLV (sym);
1710 if (blv->frame_local)
1711 return variable;
1712 break;
1713 default: abort ();
1716 /* Get rid of this buffer's alist element, if any. */
1717 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1718 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1719 if (!NILP (tem))
1720 BVAR (current_buffer, local_var_alist)
1721 = Fdelq (tem, BVAR (current_buffer, local_var_alist));
1723 /* If the symbol is set up with the current buffer's binding
1724 loaded, recompute its value. We have to do it now, or else
1725 forwarded objects won't work right. */
1727 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1728 if (EQ (buf, blv->where))
1730 blv->where = Qnil;
1731 /* blv->valcell = blv->defcell;
1732 * SET_BLV_FOUND (blv, 0); */
1733 blv->found = 0;
1734 find_symbol_value (variable);
1738 return variable;
1741 /* Lisp functions for creating and removing buffer-local variables. */
1743 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1744 when/if this is removed. */
1746 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1747 1, 1, "vMake Variable Frame Local: ",
1748 doc: /* Enable VARIABLE to have frame-local bindings.
1749 This does not create any frame-local bindings for VARIABLE,
1750 it just makes them possible.
1752 A frame-local binding is actually a frame parameter value.
1753 If a frame F has a value for the frame parameter named VARIABLE,
1754 that also acts as a frame-local binding for VARIABLE in F--
1755 provided this function has been called to enable VARIABLE
1756 to have frame-local bindings at all.
1758 The only way to create a frame-local binding for VARIABLE in a frame
1759 is to set the VARIABLE frame parameter of that frame. See
1760 `modify-frame-parameters' for how to set frame parameters.
1762 Note that since Emacs 23.1, variables cannot be both buffer-local and
1763 frame-local any more (buffer-local bindings used to take precedence over
1764 frame-local bindings). */)
1765 (register Lisp_Object variable)
1767 int forwarded;
1768 union Lisp_Val_Fwd valcontents;
1769 struct Lisp_Symbol *sym;
1770 struct Lisp_Buffer_Local_Value *blv = NULL;
1772 CHECK_SYMBOL (variable);
1773 sym = XSYMBOL (variable);
1775 start:
1776 switch (sym->redirect)
1778 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1779 case SYMBOL_PLAINVAL:
1780 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1781 if (EQ (valcontents.value, Qunbound))
1782 valcontents.value = Qnil;
1783 break;
1784 case SYMBOL_LOCALIZED:
1785 if (SYMBOL_BLV (sym)->frame_local)
1786 return variable;
1787 else
1788 error ("Symbol %s may not be frame-local",
1789 SDATA (SYMBOL_NAME (variable)));
1790 case SYMBOL_FORWARDED:
1791 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1792 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1793 error ("Symbol %s may not be frame-local",
1794 SDATA (SYMBOL_NAME (variable)));
1795 break;
1796 default: abort ();
1799 if (sym->constant)
1800 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1802 blv = make_blv (sym, forwarded, valcontents);
1803 blv->frame_local = 1;
1804 sym->redirect = SYMBOL_LOCALIZED;
1805 SET_SYMBOL_BLV (sym, blv);
1807 Lisp_Object symbol;
1808 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1809 if (let_shadows_global_binding_p (symbol))
1810 message ("Making %s frame-local while let-bound!",
1811 SDATA (SYMBOL_NAME (variable)));
1813 return variable;
1816 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1817 1, 2, 0,
1818 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1819 BUFFER defaults to the current buffer. */)
1820 (register Lisp_Object variable, Lisp_Object buffer)
1822 register struct buffer *buf;
1823 struct Lisp_Symbol *sym;
1825 if (NILP (buffer))
1826 buf = current_buffer;
1827 else
1829 CHECK_BUFFER (buffer);
1830 buf = XBUFFER (buffer);
1833 CHECK_SYMBOL (variable);
1834 sym = XSYMBOL (variable);
1836 start:
1837 switch (sym->redirect)
1839 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1840 case SYMBOL_PLAINVAL: return Qnil;
1841 case SYMBOL_LOCALIZED:
1843 Lisp_Object tail, elt, tmp;
1844 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1845 XSETBUFFER (tmp, buf);
1846 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1848 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1850 elt = XCAR (tail);
1851 if (EQ (variable, XCAR (elt)))
1853 eassert (!blv->frame_local);
1854 eassert (BLV_FOUND (blv) || !EQ (blv->where, tmp));
1855 return Qt;
1858 eassert (!BLV_FOUND (blv) || !EQ (blv->where, tmp));
1859 return Qnil;
1861 case SYMBOL_FORWARDED:
1863 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1864 if (BUFFER_OBJFWDP (valcontents))
1866 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1867 int idx = PER_BUFFER_IDX (offset);
1868 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1869 return Qt;
1871 return Qnil;
1873 default: abort ();
1877 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1878 1, 2, 0,
1879 doc: /* Non-nil if VARIABLE will be local in buffer BUFFER when set there.
1880 More precisely, this means that setting the variable \(with `set' or`setq'),
1881 while it does not have a `let'-style binding that was made in BUFFER,
1882 will produce a buffer local binding. See Info node
1883 `(elisp)Creating Buffer-Local'.
1884 BUFFER defaults to the current buffer. */)
1885 (register Lisp_Object variable, Lisp_Object buffer)
1887 struct Lisp_Symbol *sym;
1889 CHECK_SYMBOL (variable);
1890 sym = XSYMBOL (variable);
1892 start:
1893 switch (sym->redirect)
1895 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1896 case SYMBOL_PLAINVAL: return Qnil;
1897 case SYMBOL_LOCALIZED:
1899 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1900 if (blv->local_if_set)
1901 return Qt;
1902 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1903 return Flocal_variable_p (variable, buffer);
1905 case SYMBOL_FORWARDED:
1906 /* All BUFFER_OBJFWD slots become local if they are set. */
1907 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1908 default: abort ();
1912 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1913 1, 1, 0,
1914 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1915 If the current binding is buffer-local, the value is the current buffer.
1916 If the current binding is frame-local, the value is the selected frame.
1917 If the current binding is global (the default), the value is nil. */)
1918 (register Lisp_Object variable)
1920 struct Lisp_Symbol *sym;
1922 CHECK_SYMBOL (variable);
1923 sym = XSYMBOL (variable);
1925 /* Make sure the current binding is actually swapped in. */
1926 find_symbol_value (variable);
1928 start:
1929 switch (sym->redirect)
1931 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1932 case SYMBOL_PLAINVAL: return Qnil;
1933 case SYMBOL_FORWARDED:
1935 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1936 if (KBOARD_OBJFWDP (valcontents))
1937 return Fframe_terminal (Fselected_frame ());
1938 else if (!BUFFER_OBJFWDP (valcontents))
1939 return Qnil;
1941 /* FALLTHROUGH */
1942 case SYMBOL_LOCALIZED:
1943 /* For a local variable, record both the symbol and which
1944 buffer's or frame's value we are saving. */
1945 if (!NILP (Flocal_variable_p (variable, Qnil)))
1946 return Fcurrent_buffer ();
1947 else if (sym->redirect == SYMBOL_LOCALIZED
1948 && BLV_FOUND (SYMBOL_BLV (sym)))
1949 return SYMBOL_BLV (sym)->where;
1950 else
1951 return Qnil;
1952 default: abort ();
1956 /* This code is disabled now that we use the selected frame to return
1957 keyboard-local-values. */
1958 #if 0
1959 extern struct terminal *get_terminal (Lisp_Object display, int);
1961 DEFUN ("terminal-local-value", Fterminal_local_value,
1962 Sterminal_local_value, 2, 2, 0,
1963 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1964 If SYMBOL is not a terminal-local variable, then return its normal
1965 value, like `symbol-value'.
1967 TERMINAL may be a terminal object, a frame, or nil (meaning the
1968 selected frame's terminal device). */)
1969 (Lisp_Object symbol, Lisp_Object terminal)
1971 Lisp_Object result;
1972 struct terminal *t = get_terminal (terminal, 1);
1973 push_kboard (t->kboard);
1974 result = Fsymbol_value (symbol);
1975 pop_kboard ();
1976 return result;
1979 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
1980 Sset_terminal_local_value, 3, 3, 0,
1981 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1982 If VARIABLE is not a terminal-local variable, then set its normal
1983 binding, like `set'.
1985 TERMINAL may be a terminal object, a frame, or nil (meaning the
1986 selected frame's terminal device). */)
1987 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1989 Lisp_Object result;
1990 struct terminal *t = get_terminal (terminal, 1);
1991 push_kboard (d->kboard);
1992 result = Fset (symbol, value);
1993 pop_kboard ();
1994 return result;
1996 #endif
1998 /* Find the function at the end of a chain of symbol function indirections. */
2000 /* If OBJECT is a symbol, find the end of its function chain and
2001 return the value found there. If OBJECT is not a symbol, just
2002 return it. If there is a cycle in the function chain, signal a
2003 cyclic-function-indirection error.
2005 This is like Findirect_function, except that it doesn't signal an
2006 error if the chain ends up unbound. */
2007 Lisp_Object
2008 indirect_function (register Lisp_Object object)
2010 Lisp_Object tortoise, hare;
2012 hare = tortoise = object;
2014 for (;;)
2016 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2017 break;
2018 hare = XSYMBOL (hare)->function;
2019 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2020 break;
2021 hare = XSYMBOL (hare)->function;
2023 tortoise = XSYMBOL (tortoise)->function;
2025 if (EQ (hare, tortoise))
2026 xsignal1 (Qcyclic_function_indirection, object);
2029 return hare;
2032 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2033 doc: /* Return the function at the end of OBJECT's function chain.
2034 If OBJECT is not a symbol, just return it. Otherwise, follow all
2035 function indirections to find the final function binding and return it.
2036 If the final symbol in the chain is unbound, signal a void-function error.
2037 Optional arg NOERROR non-nil means to return nil instead of signaling.
2038 Signal a cyclic-function-indirection error if there is a loop in the
2039 function chain of symbols. */)
2040 (register Lisp_Object object, Lisp_Object noerror)
2042 Lisp_Object result;
2044 /* Optimize for no indirection. */
2045 result = object;
2046 if (SYMBOLP (result) && !EQ (result, Qunbound)
2047 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2048 result = indirect_function (result);
2049 if (!EQ (result, Qunbound))
2050 return result;
2052 if (NILP (noerror))
2053 xsignal1 (Qvoid_function, object);
2055 return Qnil;
2058 /* Extract and set vector and string elements */
2060 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2061 doc: /* Return the element of ARRAY at index IDX.
2062 ARRAY may be a vector, a string, a char-table, a bool-vector,
2063 or a byte-code object. IDX starts at 0. */)
2064 (register Lisp_Object array, Lisp_Object idx)
2066 register EMACS_INT idxval;
2068 CHECK_NUMBER (idx);
2069 idxval = XINT (idx);
2070 if (STRINGP (array))
2072 int c;
2073 ptrdiff_t idxval_byte;
2075 if (idxval < 0 || idxval >= SCHARS (array))
2076 args_out_of_range (array, idx);
2077 if (! STRING_MULTIBYTE (array))
2078 return make_number ((unsigned char) SREF (array, idxval));
2079 idxval_byte = string_char_to_byte (array, idxval);
2081 c = STRING_CHAR (SDATA (array) + idxval_byte);
2082 return make_number (c);
2084 else if (BOOL_VECTOR_P (array))
2086 int val;
2088 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2089 args_out_of_range (array, idx);
2091 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2092 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2094 else if (CHAR_TABLE_P (array))
2096 CHECK_CHARACTER (idx);
2097 return CHAR_TABLE_REF (array, idxval);
2099 else
2101 ptrdiff_t size = 0;
2102 if (VECTORP (array))
2103 size = ASIZE (array);
2104 else if (COMPILEDP (array))
2105 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2106 else
2107 wrong_type_argument (Qarrayp, array);
2109 if (idxval < 0 || idxval >= size)
2110 args_out_of_range (array, idx);
2111 return AREF (array, idxval);
2115 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2116 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2117 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2118 bool-vector. IDX starts at 0. */)
2119 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2121 register EMACS_INT idxval;
2123 CHECK_NUMBER (idx);
2124 idxval = XINT (idx);
2125 CHECK_ARRAY (array, Qarrayp);
2126 CHECK_IMPURE (array);
2128 if (VECTORP (array))
2130 if (idxval < 0 || idxval >= ASIZE (array))
2131 args_out_of_range (array, idx);
2132 XVECTOR (array)->contents[idxval] = newelt;
2134 else if (BOOL_VECTOR_P (array))
2136 int val;
2138 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2139 args_out_of_range (array, idx);
2141 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2143 if (! NILP (newelt))
2144 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2145 else
2146 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2147 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2149 else if (CHAR_TABLE_P (array))
2151 CHECK_CHARACTER (idx);
2152 CHAR_TABLE_SET (array, idxval, newelt);
2154 else
2156 int c;
2158 if (idxval < 0 || idxval >= SCHARS (array))
2159 args_out_of_range (array, idx);
2160 CHECK_CHARACTER (newelt);
2161 c = XFASTINT (newelt);
2163 if (STRING_MULTIBYTE (array))
2165 ptrdiff_t idxval_byte, nbytes;
2166 int prev_bytes, new_bytes;
2167 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2169 nbytes = SBYTES (array);
2170 idxval_byte = string_char_to_byte (array, idxval);
2171 p1 = SDATA (array) + idxval_byte;
2172 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2173 new_bytes = CHAR_STRING (c, p0);
2174 if (prev_bytes != new_bytes)
2176 /* We must relocate the string data. */
2177 ptrdiff_t nchars = SCHARS (array);
2178 unsigned char *str;
2179 USE_SAFE_ALLOCA;
2181 SAFE_ALLOCA (str, unsigned char *, nbytes);
2182 memcpy (str, SDATA (array), nbytes);
2183 allocate_string_data (XSTRING (array), nchars,
2184 nbytes + new_bytes - prev_bytes);
2185 memcpy (SDATA (array), str, idxval_byte);
2186 p1 = SDATA (array) + idxval_byte;
2187 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2188 nbytes - (idxval_byte + prev_bytes));
2189 SAFE_FREE ();
2190 clear_string_char_byte_cache ();
2192 while (new_bytes--)
2193 *p1++ = *p0++;
2195 else
2197 if (! SINGLE_BYTE_CHAR_P (c))
2199 int i;
2201 for (i = SBYTES (array) - 1; i >= 0; i--)
2202 if (SREF (array, i) >= 0x80)
2203 args_out_of_range (array, newelt);
2204 /* ARRAY is an ASCII string. Convert it to a multibyte
2205 string, and try `aset' again. */
2206 STRING_SET_MULTIBYTE (array);
2207 return Faset (array, idx, newelt);
2209 SSET (array, idxval, c);
2213 return newelt;
2216 /* Arithmetic functions */
2218 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2220 static Lisp_Object
2221 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2223 double f1 = 0, f2 = 0;
2224 int floatp = 0;
2226 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2227 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2229 if (FLOATP (num1) || FLOATP (num2))
2231 floatp = 1;
2232 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2233 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2236 switch (comparison)
2238 case equal:
2239 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2240 return Qt;
2241 return Qnil;
2243 case notequal:
2244 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2245 return Qt;
2246 return Qnil;
2248 case less:
2249 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2250 return Qt;
2251 return Qnil;
2253 case less_or_equal:
2254 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2255 return Qt;
2256 return Qnil;
2258 case grtr:
2259 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2260 return Qt;
2261 return Qnil;
2263 case grtr_or_equal:
2264 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2265 return Qt;
2266 return Qnil;
2268 default:
2269 abort ();
2273 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2274 doc: /* Return t if two args, both numbers or markers, are equal. */)
2275 (register Lisp_Object num1, Lisp_Object num2)
2277 return arithcompare (num1, num2, equal);
2280 DEFUN ("<", Flss, Slss, 2, 2, 0,
2281 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2282 (register Lisp_Object num1, Lisp_Object num2)
2284 return arithcompare (num1, num2, less);
2287 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2288 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2289 (register Lisp_Object num1, Lisp_Object num2)
2291 return arithcompare (num1, num2, grtr);
2294 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2295 doc: /* Return t if first arg is less than or equal to second arg.
2296 Both must be numbers or markers. */)
2297 (register Lisp_Object num1, Lisp_Object num2)
2299 return arithcompare (num1, num2, less_or_equal);
2302 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2303 doc: /* Return t if first arg is greater than or equal to second arg.
2304 Both must be numbers or markers. */)
2305 (register Lisp_Object num1, Lisp_Object num2)
2307 return arithcompare (num1, num2, grtr_or_equal);
2310 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2311 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2312 (register Lisp_Object num1, Lisp_Object num2)
2314 return arithcompare (num1, num2, notequal);
2317 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2318 doc: /* Return t if NUMBER is zero. */)
2319 (register Lisp_Object number)
2321 CHECK_NUMBER_OR_FLOAT (number);
2323 if (FLOATP (number))
2325 if (XFLOAT_DATA (number) == 0.0)
2326 return Qt;
2327 return Qnil;
2330 if (!XINT (number))
2331 return Qt;
2332 return Qnil;
2335 /* Convert the cons-of-integers, integer, or float value C to an
2336 unsigned value with maximum value MAX. Signal an error if C does not
2337 have a valid format or is out of range. */
2338 uintmax_t
2339 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2341 int valid = 0;
2342 uintmax_t val IF_LINT (= 0);
2343 if (INTEGERP (c))
2345 valid = 0 <= XINT (c);
2346 val = XINT (c);
2348 else if (FLOATP (c))
2350 double d = XFLOAT_DATA (c);
2351 if (0 <= d
2352 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2354 val = d;
2355 valid = 1;
2358 else if (CONSP (c) && NATNUMP (XCAR (c)))
2360 uintmax_t top = XFASTINT (XCAR (c));
2361 Lisp_Object rest = XCDR (c);
2362 if (top <= UINTMAX_MAX >> 24 >> 16
2363 && CONSP (rest)
2364 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2365 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2367 uintmax_t mid = XFASTINT (XCAR (rest));
2368 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2369 valid = 1;
2371 else if (top <= UINTMAX_MAX >> 16)
2373 if (CONSP (rest))
2374 rest = XCAR (rest);
2375 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2377 val = top << 16 | XFASTINT (rest);
2378 valid = 1;
2383 if (! (valid && val <= max))
2384 error ("Not an in-range integer, float, or cons of integers");
2385 return val;
2388 /* Convert the cons-of-integers, integer, or float value C to a signed
2389 value with extrema MIN and MAX. Signal an error if C does not have
2390 a valid format or is out of range. */
2391 intmax_t
2392 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2394 int valid = 0;
2395 intmax_t val IF_LINT (= 0);
2396 if (INTEGERP (c))
2398 val = XINT (c);
2399 valid = 1;
2401 else if (FLOATP (c))
2403 double d = XFLOAT_DATA (c);
2404 if (min <= d
2405 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2407 val = d;
2408 valid = 1;
2411 else if (CONSP (c) && INTEGERP (XCAR (c)))
2413 intmax_t top = XINT (XCAR (c));
2414 Lisp_Object rest = XCDR (c);
2415 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2416 && CONSP (rest)
2417 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2418 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2420 intmax_t mid = XFASTINT (XCAR (rest));
2421 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2422 valid = 1;
2424 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2426 if (CONSP (rest))
2427 rest = XCAR (rest);
2428 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2430 val = top << 16 | XFASTINT (rest);
2431 valid = 1;
2436 if (! (valid && min <= val && val <= max))
2437 error ("Not an in-range integer, float, or cons of integers");
2438 return val;
2441 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2442 doc: /* Return the decimal representation of NUMBER as a string.
2443 Uses a minus sign if negative.
2444 NUMBER may be an integer or a floating point number. */)
2445 (Lisp_Object number)
2447 char buffer[VALBITS];
2449 CHECK_NUMBER_OR_FLOAT (number);
2451 if (FLOATP (number))
2453 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
2455 float_to_string (pigbuf, XFLOAT_DATA (number));
2456 return build_string (pigbuf);
2459 sprintf (buffer, "%"pI"d", XINT (number));
2460 return build_string (buffer);
2463 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2464 doc: /* Parse STRING as a decimal number and return the number.
2465 This parses both integers and floating point numbers.
2466 It ignores leading spaces and tabs, and all trailing chars.
2468 If BASE, interpret STRING as a number in that base. If BASE isn't
2469 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2470 If the base used is not 10, STRING is always parsed as integer. */)
2471 (register Lisp_Object string, Lisp_Object base)
2473 register char *p;
2474 register int b;
2475 Lisp_Object val;
2477 CHECK_STRING (string);
2479 if (NILP (base))
2480 b = 10;
2481 else
2483 CHECK_NUMBER (base);
2484 if (! (2 <= XINT (base) && XINT (base) <= 16))
2485 xsignal1 (Qargs_out_of_range, base);
2486 b = XINT (base);
2489 p = SSDATA (string);
2490 while (*p == ' ' || *p == '\t')
2491 p++;
2493 val = string_to_number (p, b, 1);
2494 return NILP (val) ? make_number (0) : val;
2497 enum arithop
2499 Aadd,
2500 Asub,
2501 Amult,
2502 Adiv,
2503 Alogand,
2504 Alogior,
2505 Alogxor,
2506 Amax,
2507 Amin
2510 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2511 ptrdiff_t, Lisp_Object *);
2512 static Lisp_Object
2513 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2515 register Lisp_Object val;
2516 ptrdiff_t argnum;
2517 register EMACS_INT accum = 0;
2518 register EMACS_INT next;
2520 int overflow = 0;
2521 ptrdiff_t ok_args;
2522 EMACS_INT ok_accum;
2524 switch (SWITCH_ENUM_CAST (code))
2526 case Alogior:
2527 case Alogxor:
2528 case Aadd:
2529 case Asub:
2530 accum = 0;
2531 break;
2532 case Amult:
2533 accum = 1;
2534 break;
2535 case Alogand:
2536 accum = -1;
2537 break;
2538 default:
2539 break;
2542 for (argnum = 0; argnum < nargs; argnum++)
2544 if (! overflow)
2546 ok_args = argnum;
2547 ok_accum = accum;
2550 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2551 val = args[argnum];
2552 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2554 if (FLOATP (val))
2555 return float_arith_driver (ok_accum, ok_args, code,
2556 nargs, args);
2557 args[argnum] = val;
2558 next = XINT (args[argnum]);
2559 switch (SWITCH_ENUM_CAST (code))
2561 case Aadd:
2562 if (INT_ADD_OVERFLOW (accum, next))
2564 overflow = 1;
2565 accum &= INTMASK;
2567 accum += next;
2568 break;
2569 case Asub:
2570 if (INT_SUBTRACT_OVERFLOW (accum, next))
2572 overflow = 1;
2573 accum &= INTMASK;
2575 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2576 break;
2577 case Amult:
2578 if (INT_MULTIPLY_OVERFLOW (accum, next))
2580 EMACS_UINT a = accum, b = next, ab = a * b;
2581 overflow = 1;
2582 accum = ab & INTMASK;
2584 else
2585 accum *= next;
2586 break;
2587 case Adiv:
2588 if (!argnum)
2589 accum = next;
2590 else
2592 if (next == 0)
2593 xsignal0 (Qarith_error);
2594 accum /= next;
2596 break;
2597 case Alogand:
2598 accum &= next;
2599 break;
2600 case Alogior:
2601 accum |= next;
2602 break;
2603 case Alogxor:
2604 accum ^= next;
2605 break;
2606 case Amax:
2607 if (!argnum || next > accum)
2608 accum = next;
2609 break;
2610 case Amin:
2611 if (!argnum || next < accum)
2612 accum = next;
2613 break;
2617 XSETINT (val, accum);
2618 return val;
2621 #undef isnan
2622 #define isnan(x) ((x) != (x))
2624 static Lisp_Object
2625 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2626 ptrdiff_t nargs, Lisp_Object *args)
2628 register Lisp_Object val;
2629 double next;
2631 for (; argnum < nargs; argnum++)
2633 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2634 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2636 if (FLOATP (val))
2638 next = XFLOAT_DATA (val);
2640 else
2642 args[argnum] = val; /* runs into a compiler bug. */
2643 next = XINT (args[argnum]);
2645 switch (SWITCH_ENUM_CAST (code))
2647 case Aadd:
2648 accum += next;
2649 break;
2650 case Asub:
2651 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2652 break;
2653 case Amult:
2654 accum *= next;
2655 break;
2656 case Adiv:
2657 if (!argnum)
2658 accum = next;
2659 else
2661 if (! IEEE_FLOATING_POINT && next == 0)
2662 xsignal0 (Qarith_error);
2663 accum /= next;
2665 break;
2666 case Alogand:
2667 case Alogior:
2668 case Alogxor:
2669 return wrong_type_argument (Qinteger_or_marker_p, val);
2670 case Amax:
2671 if (!argnum || isnan (next) || next > accum)
2672 accum = next;
2673 break;
2674 case Amin:
2675 if (!argnum || isnan (next) || next < accum)
2676 accum = next;
2677 break;
2681 return make_float (accum);
2685 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2686 doc: /* Return sum of any number of arguments, which are numbers or markers.
2687 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2688 (ptrdiff_t nargs, Lisp_Object *args)
2690 return arith_driver (Aadd, nargs, args);
2693 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2694 doc: /* Negate number or subtract numbers or markers and return the result.
2695 With one arg, negates it. With more than one arg,
2696 subtracts all but the first from the first.
2697 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2698 (ptrdiff_t nargs, Lisp_Object *args)
2700 return arith_driver (Asub, nargs, args);
2703 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2704 doc: /* Return product of any number of arguments, which are numbers or markers.
2705 usage: (* &rest NUMBERS-OR-MARKERS) */)
2706 (ptrdiff_t nargs, Lisp_Object *args)
2708 return arith_driver (Amult, nargs, args);
2711 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2712 doc: /* Return first argument divided by all the remaining arguments.
2713 The arguments must be numbers or markers.
2714 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2715 (ptrdiff_t nargs, Lisp_Object *args)
2717 ptrdiff_t argnum;
2718 for (argnum = 2; argnum < nargs; argnum++)
2719 if (FLOATP (args[argnum]))
2720 return float_arith_driver (0, 0, Adiv, nargs, args);
2721 return arith_driver (Adiv, nargs, args);
2724 DEFUN ("%", Frem, Srem, 2, 2, 0,
2725 doc: /* Return remainder of X divided by Y.
2726 Both must be integers or markers. */)
2727 (register Lisp_Object x, Lisp_Object y)
2729 Lisp_Object val;
2731 CHECK_NUMBER_COERCE_MARKER (x);
2732 CHECK_NUMBER_COERCE_MARKER (y);
2734 if (XINT (y) == 0)
2735 xsignal0 (Qarith_error);
2737 XSETINT (val, XINT (x) % XINT (y));
2738 return val;
2741 #ifndef HAVE_FMOD
2742 double
2743 fmod (double f1, double f2)
2745 double r = f1;
2747 if (f2 < 0.0)
2748 f2 = -f2;
2750 /* If the magnitude of the result exceeds that of the divisor, or
2751 the sign of the result does not agree with that of the dividend,
2752 iterate with the reduced value. This does not yield a
2753 particularly accurate result, but at least it will be in the
2754 range promised by fmod. */
2756 r -= f2 * floor (r / f2);
2757 while (f2 <= (r < 0 ? -r : r) || ((r < 0) != (f1 < 0) && ! isnan (r)));
2759 return r;
2761 #endif /* ! HAVE_FMOD */
2763 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2764 doc: /* Return X modulo Y.
2765 The result falls between zero (inclusive) and Y (exclusive).
2766 Both X and Y must be numbers or markers. */)
2767 (register Lisp_Object x, Lisp_Object y)
2769 Lisp_Object val;
2770 EMACS_INT i1, i2;
2772 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2773 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2775 if (FLOATP (x) || FLOATP (y))
2776 return fmod_float (x, y);
2778 i1 = XINT (x);
2779 i2 = XINT (y);
2781 if (i2 == 0)
2782 xsignal0 (Qarith_error);
2784 i1 %= i2;
2786 /* If the "remainder" comes out with the wrong sign, fix it. */
2787 if (i2 < 0 ? i1 > 0 : i1 < 0)
2788 i1 += i2;
2790 XSETINT (val, i1);
2791 return val;
2794 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2795 doc: /* Return largest of all the arguments (which must be numbers or markers).
2796 The value is always a number; markers are converted to numbers.
2797 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2798 (ptrdiff_t nargs, Lisp_Object *args)
2800 return arith_driver (Amax, nargs, args);
2803 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2804 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2805 The value is always a number; markers are converted to numbers.
2806 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2807 (ptrdiff_t nargs, Lisp_Object *args)
2809 return arith_driver (Amin, nargs, args);
2812 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2813 doc: /* Return bitwise-and of all the arguments.
2814 Arguments may be integers, or markers converted to integers.
2815 usage: (logand &rest INTS-OR-MARKERS) */)
2816 (ptrdiff_t nargs, Lisp_Object *args)
2818 return arith_driver (Alogand, nargs, args);
2821 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2822 doc: /* Return bitwise-or of all the arguments.
2823 Arguments may be integers, or markers converted to integers.
2824 usage: (logior &rest INTS-OR-MARKERS) */)
2825 (ptrdiff_t nargs, Lisp_Object *args)
2827 return arith_driver (Alogior, nargs, args);
2830 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2831 doc: /* Return bitwise-exclusive-or of all the arguments.
2832 Arguments may be integers, or markers converted to integers.
2833 usage: (logxor &rest INTS-OR-MARKERS) */)
2834 (ptrdiff_t nargs, Lisp_Object *args)
2836 return arith_driver (Alogxor, nargs, args);
2839 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2840 doc: /* Return VALUE with its bits shifted left by COUNT.
2841 If COUNT is negative, shifting is actually to the right.
2842 In this case, the sign bit is duplicated. */)
2843 (register Lisp_Object value, Lisp_Object count)
2845 register Lisp_Object val;
2847 CHECK_NUMBER (value);
2848 CHECK_NUMBER (count);
2850 if (XINT (count) >= BITS_PER_EMACS_INT)
2851 XSETINT (val, 0);
2852 else if (XINT (count) > 0)
2853 XSETINT (val, XINT (value) << XFASTINT (count));
2854 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2855 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2856 else
2857 XSETINT (val, XINT (value) >> -XINT (count));
2858 return val;
2861 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2862 doc: /* Return VALUE with its bits shifted left by COUNT.
2863 If COUNT is negative, shifting is actually to the right.
2864 In this case, zeros are shifted in on the left. */)
2865 (register Lisp_Object value, Lisp_Object count)
2867 register Lisp_Object val;
2869 CHECK_NUMBER (value);
2870 CHECK_NUMBER (count);
2872 if (XINT (count) >= BITS_PER_EMACS_INT)
2873 XSETINT (val, 0);
2874 else if (XINT (count) > 0)
2875 XSETINT (val, XUINT (value) << XFASTINT (count));
2876 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2877 XSETINT (val, 0);
2878 else
2879 XSETINT (val, XUINT (value) >> -XINT (count));
2880 return val;
2883 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2884 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2885 Markers are converted to integers. */)
2886 (register Lisp_Object number)
2888 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2890 if (FLOATP (number))
2891 return (make_float (1.0 + XFLOAT_DATA (number)));
2893 XSETINT (number, XINT (number) + 1);
2894 return number;
2897 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2898 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2899 Markers are converted to integers. */)
2900 (register Lisp_Object number)
2902 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2904 if (FLOATP (number))
2905 return (make_float (-1.0 + XFLOAT_DATA (number)));
2907 XSETINT (number, XINT (number) - 1);
2908 return number;
2911 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2912 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2913 (register Lisp_Object number)
2915 CHECK_NUMBER (number);
2916 XSETINT (number, ~XINT (number));
2917 return number;
2920 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2921 doc: /* Return the byteorder for the machine.
2922 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2923 lowercase l) for small endian machines. */)
2924 (void)
2926 unsigned i = 0x04030201;
2927 int order = *(char *)&i == 1 ? 108 : 66;
2929 return make_number (order);
2934 void
2935 syms_of_data (void)
2937 Lisp_Object error_tail, arith_tail;
2939 DEFSYM (Qquote, "quote");
2940 DEFSYM (Qlambda, "lambda");
2941 DEFSYM (Qsubr, "subr");
2942 DEFSYM (Qerror_conditions, "error-conditions");
2943 DEFSYM (Qerror_message, "error-message");
2944 DEFSYM (Qtop_level, "top-level");
2946 DEFSYM (Qerror, "error");
2947 DEFSYM (Quser_error, "user-error");
2948 DEFSYM (Qquit, "quit");
2949 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2950 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2951 DEFSYM (Qvoid_function, "void-function");
2952 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2953 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2954 DEFSYM (Qvoid_variable, "void-variable");
2955 DEFSYM (Qsetting_constant, "setting-constant");
2956 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2958 DEFSYM (Qinvalid_function, "invalid-function");
2959 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2960 DEFSYM (Qno_catch, "no-catch");
2961 DEFSYM (Qend_of_file, "end-of-file");
2962 DEFSYM (Qarith_error, "arith-error");
2963 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2964 DEFSYM (Qend_of_buffer, "end-of-buffer");
2965 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2966 DEFSYM (Qtext_read_only, "text-read-only");
2967 DEFSYM (Qmark_inactive, "mark-inactive");
2969 DEFSYM (Qlistp, "listp");
2970 DEFSYM (Qconsp, "consp");
2971 DEFSYM (Qsymbolp, "symbolp");
2972 DEFSYM (Qkeywordp, "keywordp");
2973 DEFSYM (Qintegerp, "integerp");
2974 DEFSYM (Qnatnump, "natnump");
2975 DEFSYM (Qwholenump, "wholenump");
2976 DEFSYM (Qstringp, "stringp");
2977 DEFSYM (Qarrayp, "arrayp");
2978 DEFSYM (Qsequencep, "sequencep");
2979 DEFSYM (Qbufferp, "bufferp");
2980 DEFSYM (Qvectorp, "vectorp");
2981 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2982 DEFSYM (Qmarkerp, "markerp");
2983 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2984 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2985 DEFSYM (Qboundp, "boundp");
2986 DEFSYM (Qfboundp, "fboundp");
2988 DEFSYM (Qfloatp, "floatp");
2989 DEFSYM (Qnumberp, "numberp");
2990 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
2992 DEFSYM (Qchar_table_p, "char-table-p");
2993 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
2995 DEFSYM (Qsubrp, "subrp");
2996 DEFSYM (Qunevalled, "unevalled");
2997 DEFSYM (Qmany, "many");
2999 DEFSYM (Qcdr, "cdr");
3001 /* Handle automatic advice activation. */
3002 DEFSYM (Qad_advice_info, "ad-advice-info");
3003 DEFSYM (Qad_activate_internal, "ad-activate-internal");
3005 error_tail = pure_cons (Qerror, Qnil);
3007 /* ERROR is used as a signaler for random errors for which nothing else is
3008 right. */
3010 Fput (Qerror, Qerror_conditions,
3011 error_tail);
3012 Fput (Qerror, Qerror_message,
3013 make_pure_c_string ("error"));
3015 #define PUT_ERROR(sym, tail, msg) \
3016 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3017 Fput (sym, Qerror_message, make_pure_c_string (msg))
3019 PUT_ERROR (Qquit, Qnil, "Quit");
3021 PUT_ERROR (Quser_error, error_tail, "");
3022 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3023 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3024 PUT_ERROR (Qvoid_function, error_tail,
3025 "Symbol's function definition is void");
3026 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3027 "Symbol's chain of function indirections contains a loop");
3028 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3029 "Symbol's chain of variable indirections contains a loop");
3030 DEFSYM (Qcircular_list, "circular-list");
3031 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3032 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3033 PUT_ERROR (Qsetting_constant, error_tail,
3034 "Attempt to set a constant symbol");
3035 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3036 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3037 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3038 "Wrong number of arguments");
3039 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3040 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3042 arith_tail = pure_cons (Qarith_error, error_tail);
3043 Fput (Qarith_error, Qerror_conditions, arith_tail);
3044 Fput (Qarith_error, Qerror_message, make_pure_c_string ("Arithmetic error"));
3046 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3047 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3048 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3049 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3050 "Text is read-only");
3052 DEFSYM (Qrange_error, "range-error");
3053 DEFSYM (Qdomain_error, "domain-error");
3054 DEFSYM (Qsingularity_error, "singularity-error");
3055 DEFSYM (Qoverflow_error, "overflow-error");
3056 DEFSYM (Qunderflow_error, "underflow-error");
3058 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3060 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3062 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3063 "Arithmetic singularity error");
3065 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3066 "Arithmetic overflow error");
3067 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3068 "Arithmetic underflow error");
3070 staticpro (&Qnil);
3071 staticpro (&Qt);
3072 staticpro (&Qunbound);
3074 /* Types that type-of returns. */
3075 DEFSYM (Qinteger, "integer");
3076 DEFSYM (Qsymbol, "symbol");
3077 DEFSYM (Qstring, "string");
3078 DEFSYM (Qcons, "cons");
3079 DEFSYM (Qmarker, "marker");
3080 DEFSYM (Qoverlay, "overlay");
3081 DEFSYM (Qfloat, "float");
3082 DEFSYM (Qwindow_configuration, "window-configuration");
3083 DEFSYM (Qprocess, "process");
3084 DEFSYM (Qwindow, "window");
3085 /* DEFSYM (Qsubr, "subr"); */
3086 DEFSYM (Qcompiled_function, "compiled-function");
3087 DEFSYM (Qbuffer, "buffer");
3088 DEFSYM (Qframe, "frame");
3089 DEFSYM (Qvector, "vector");
3090 DEFSYM (Qchar_table, "char-table");
3091 DEFSYM (Qbool_vector, "bool-vector");
3092 DEFSYM (Qhash_table, "hash-table");
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 XSYMBOL (Qwholenump)->function = 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 static void arith_error (int) NO_RETURN;
3212 #endif
3214 static void
3215 arith_error (int signo)
3217 sigsetmask (SIGEMPTYMASK);
3219 SIGNAL_THREAD_CHECK (signo);
3220 xsignal0 (Qarith_error);
3223 void
3224 init_data (void)
3226 /* Don't do this if just dumping out.
3227 We don't want to call `signal' in this case
3228 so that we don't have trouble with dumping
3229 signal-delivering routines in an inconsistent state. */
3230 #ifndef CANNOT_DUMP
3231 if (!initialized)
3232 return;
3233 #endif /* CANNOT_DUMP */
3234 signal (SIGFPE, arith_error);