* term.c: Fix minor fdopen-related file descriptor leaks.
[emacs.git] / src / data.c
blobdedbd51f36e19c54959afa17255fa12135ed5b1e
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2013 Free Software
3 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 <stdio.h>
24 #include <intprops.h>
26 #include "lisp.h"
27 #include "puresize.h"
28 #include "character.h"
29 #include "buffer.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "syssignal.h"
33 #include "termhooks.h" /* For FRAME_KBOARD reference in y-or-n-p. */
34 #include "font.h"
35 #include "keymap.h"
37 Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
38 static Lisp_Object Qsubr;
39 Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
40 Lisp_Object Qerror, Quser_error, Qquit, Qargs_out_of_range;
41 static Lisp_Object Qwrong_type_argument;
42 Lisp_Object Qvoid_variable, Qvoid_function;
43 static Lisp_Object Qcyclic_function_indirection;
44 static Lisp_Object Qcyclic_variable_indirection;
45 Lisp_Object Qcircular_list;
46 static Lisp_Object Qsetting_constant;
47 Lisp_Object Qinvalid_read_syntax;
48 Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
49 Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
50 Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
51 Lisp_Object Qtext_read_only;
53 Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
54 static Lisp_Object Qnatnump;
55 Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
56 Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
57 Lisp_Object Qbuffer_or_string_p;
58 static Lisp_Object Qkeywordp, Qboundp;
59 Lisp_Object Qfboundp;
60 Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
62 Lisp_Object Qcdr;
63 static Lisp_Object Qad_advice_info, Qad_activate_internal;
65 static Lisp_Object Qdomain_error, Qsingularity_error, Qunderflow_error;
66 Lisp_Object Qrange_error, Qoverflow_error;
68 Lisp_Object Qfloatp;
69 Lisp_Object Qnumberp, Qnumber_or_marker_p;
71 Lisp_Object Qinteger, Qsymbol;
72 static Lisp_Object Qcons, Qfloat, Qmisc, Qstring, Qvector;
73 Lisp_Object Qwindow;
74 static Lisp_Object Qoverlay, Qwindow_configuration;
75 static Lisp_Object Qprocess, Qmarker;
76 static Lisp_Object Qcompiled_function, Qframe;
77 Lisp_Object Qbuffer;
78 static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
79 static Lisp_Object Qsubrp;
80 static Lisp_Object Qmany, Qunevalled;
81 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
82 static Lisp_Object Qdefun;
84 Lisp_Object Qinteractive_form;
85 static Lisp_Object Qdefalias_fset_function;
87 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
89 static bool
90 BOOLFWDP (union Lisp_Fwd *a)
92 return XFWDTYPE (a) == Lisp_Fwd_Bool;
94 static bool
95 INTFWDP (union Lisp_Fwd *a)
97 return XFWDTYPE (a) == Lisp_Fwd_Int;
99 static bool
100 KBOARD_OBJFWDP (union Lisp_Fwd *a)
102 return XFWDTYPE (a) == Lisp_Fwd_Kboard_Obj;
104 static bool
105 OBJFWDP (union Lisp_Fwd *a)
107 return XFWDTYPE (a) == Lisp_Fwd_Obj;
110 static struct Lisp_Boolfwd *
111 XBOOLFWD (union Lisp_Fwd *a)
113 eassert (BOOLFWDP (a));
114 return &a->u_boolfwd;
116 static struct Lisp_Kboard_Objfwd *
117 XKBOARD_OBJFWD (union Lisp_Fwd *a)
119 eassert (KBOARD_OBJFWDP (a));
120 return &a->u_kboard_objfwd;
122 static struct Lisp_Intfwd *
123 XINTFWD (union Lisp_Fwd *a)
125 eassert (INTFWDP (a));
126 return &a->u_intfwd;
128 static struct Lisp_Objfwd *
129 XOBJFWD (union Lisp_Fwd *a)
131 eassert (OBJFWDP (a));
132 return &a->u_objfwd;
135 static void
136 CHECK_SUBR (Lisp_Object x)
138 CHECK_TYPE (SUBRP (x), Qsubrp, x);
141 static void
142 set_blv_found (struct Lisp_Buffer_Local_Value *blv, int found)
144 eassert (found == !EQ (blv->defcell, blv->valcell));
145 blv->found = found;
148 static Lisp_Object
149 blv_value (struct Lisp_Buffer_Local_Value *blv)
151 return XCDR (blv->valcell);
154 static void
155 set_blv_value (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
157 XSETCDR (blv->valcell, val);
160 static void
161 set_blv_where (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
163 blv->where = val;
166 static void
167 set_blv_defcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
169 blv->defcell = val;
172 static void
173 set_blv_valcell (struct Lisp_Buffer_Local_Value *blv, Lisp_Object val)
175 blv->valcell = val;
178 Lisp_Object
179 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
181 /* If VALUE is not even a valid Lisp object, we'd want to abort here
182 where we can get a backtrace showing where it came from. We used
183 to try and do that by checking the tagbits, but nowadays all
184 tagbits are potentially valid. */
185 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
186 * emacs_abort (); */
188 xsignal2 (Qwrong_type_argument, predicate, value);
191 void
192 pure_write_error (Lisp_Object obj)
194 xsignal2 (Qerror, build_string ("Attempt to modify read-only object"), obj);
197 void
198 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
200 xsignal2 (Qargs_out_of_range, a1, a2);
203 void
204 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
206 xsignal3 (Qargs_out_of_range, a1, a2, a3);
210 /* Data type predicates. */
212 DEFUN ("eq", Feq, Seq, 2, 2, 0,
213 doc: /* Return t if the two args are the same Lisp object. */)
214 (Lisp_Object obj1, Lisp_Object obj2)
216 if (EQ (obj1, obj2))
217 return Qt;
218 return Qnil;
221 DEFUN ("null", Fnull, Snull, 1, 1, 0,
222 doc: /* Return t if OBJECT is nil. */)
223 (Lisp_Object object)
225 if (NILP (object))
226 return Qt;
227 return Qnil;
230 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
231 doc: /* Return a symbol representing the type of OBJECT.
232 The symbol returned names the object's basic type;
233 for example, (type-of 1) returns `integer'. */)
234 (Lisp_Object object)
236 switch (XTYPE (object))
238 case_Lisp_Int:
239 return Qinteger;
241 case Lisp_Symbol:
242 return Qsymbol;
244 case Lisp_String:
245 return Qstring;
247 case Lisp_Cons:
248 return Qcons;
250 case Lisp_Misc:
251 switch (XMISCTYPE (object))
253 case Lisp_Misc_Marker:
254 return Qmarker;
255 case Lisp_Misc_Overlay:
256 return Qoverlay;
257 case Lisp_Misc_Float:
258 return Qfloat;
260 emacs_abort ();
262 case Lisp_Vectorlike:
263 if (WINDOW_CONFIGURATIONP (object))
264 return Qwindow_configuration;
265 if (PROCESSP (object))
266 return Qprocess;
267 if (WINDOWP (object))
268 return Qwindow;
269 if (SUBRP (object))
270 return Qsubr;
271 if (COMPILEDP (object))
272 return Qcompiled_function;
273 if (BUFFERP (object))
274 return Qbuffer;
275 if (CHAR_TABLE_P (object))
276 return Qchar_table;
277 if (BOOL_VECTOR_P (object))
278 return Qbool_vector;
279 if (FRAMEP (object))
280 return Qframe;
281 if (HASH_TABLE_P (object))
282 return Qhash_table;
283 if (FONT_SPEC_P (object))
284 return Qfont_spec;
285 if (FONT_ENTITY_P (object))
286 return Qfont_entity;
287 if (FONT_OBJECT_P (object))
288 return Qfont_object;
289 return Qvector;
291 case Lisp_Float:
292 return Qfloat;
294 default:
295 emacs_abort ();
299 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
300 doc: /* Return t if OBJECT is a cons cell. */)
301 (Lisp_Object object)
303 if (CONSP (object))
304 return Qt;
305 return Qnil;
308 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
309 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
310 (Lisp_Object object)
312 if (CONSP (object))
313 return Qnil;
314 return Qt;
317 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
318 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
319 Otherwise, return nil. */)
320 (Lisp_Object object)
322 if (CONSP (object) || NILP (object))
323 return Qt;
324 return Qnil;
327 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
328 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
329 (Lisp_Object object)
331 if (CONSP (object) || NILP (object))
332 return Qnil;
333 return Qt;
336 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
337 doc: /* Return t if OBJECT is a symbol. */)
338 (Lisp_Object object)
340 if (SYMBOLP (object))
341 return Qt;
342 return Qnil;
345 /* Define this in C to avoid unnecessarily consing up the symbol
346 name. */
347 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
348 doc: /* Return t if OBJECT is a keyword.
349 This means that it is a symbol with a print name beginning with `:'
350 interned in the initial obarray. */)
351 (Lisp_Object object)
353 if (SYMBOLP (object)
354 && SREF (SYMBOL_NAME (object), 0) == ':'
355 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
356 return Qt;
357 return Qnil;
360 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
361 doc: /* Return t if OBJECT is a vector. */)
362 (Lisp_Object object)
364 if (VECTORP (object))
365 return Qt;
366 return Qnil;
369 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
370 doc: /* Return t if OBJECT is a string. */)
371 (Lisp_Object object)
373 if (STRINGP (object))
374 return Qt;
375 return Qnil;
378 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
379 1, 1, 0,
380 doc: /* Return t if OBJECT is a multibyte string.
381 Return nil if OBJECT is either a unibyte string, or not a string. */)
382 (Lisp_Object object)
384 if (STRINGP (object) && STRING_MULTIBYTE (object))
385 return Qt;
386 return Qnil;
389 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
390 doc: /* Return t if OBJECT is a char-table. */)
391 (Lisp_Object object)
393 if (CHAR_TABLE_P (object))
394 return Qt;
395 return Qnil;
398 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
399 Svector_or_char_table_p, 1, 1, 0,
400 doc: /* Return t if OBJECT is a char-table or vector. */)
401 (Lisp_Object object)
403 if (VECTORP (object) || CHAR_TABLE_P (object))
404 return Qt;
405 return Qnil;
408 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
409 doc: /* Return t if OBJECT is a bool-vector. */)
410 (Lisp_Object object)
412 if (BOOL_VECTOR_P (object))
413 return Qt;
414 return Qnil;
417 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
418 doc: /* Return t if OBJECT is an array (string or vector). */)
419 (Lisp_Object object)
421 if (ARRAYP (object))
422 return Qt;
423 return Qnil;
426 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
427 doc: /* Return t if OBJECT is a sequence (list or array). */)
428 (register Lisp_Object object)
430 if (CONSP (object) || NILP (object) || ARRAYP (object))
431 return Qt;
432 return Qnil;
435 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
436 doc: /* Return t if OBJECT is an editor buffer. */)
437 (Lisp_Object object)
439 if (BUFFERP (object))
440 return Qt;
441 return Qnil;
444 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
445 doc: /* Return t if OBJECT is a marker (editor pointer). */)
446 (Lisp_Object object)
448 if (MARKERP (object))
449 return Qt;
450 return Qnil;
453 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
454 doc: /* Return t if OBJECT is a built-in function. */)
455 (Lisp_Object object)
457 if (SUBRP (object))
458 return Qt;
459 return Qnil;
462 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
463 1, 1, 0,
464 doc: /* Return t if OBJECT is a byte-compiled function object. */)
465 (Lisp_Object object)
467 if (COMPILEDP (object))
468 return Qt;
469 return Qnil;
472 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
473 doc: /* Return t if OBJECT is a character or a string. */)
474 (register Lisp_Object object)
476 if (CHARACTERP (object) || STRINGP (object))
477 return Qt;
478 return Qnil;
481 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
482 doc: /* Return t if OBJECT is an integer. */)
483 (Lisp_Object object)
485 if (INTEGERP (object))
486 return Qt;
487 return Qnil;
490 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
491 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
492 (register Lisp_Object object)
494 if (MARKERP (object) || INTEGERP (object))
495 return Qt;
496 return Qnil;
499 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
500 doc: /* Return t if OBJECT is a nonnegative integer. */)
501 (Lisp_Object object)
503 if (NATNUMP (object))
504 return Qt;
505 return Qnil;
508 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
509 doc: /* Return t if OBJECT is a number (floating point or integer). */)
510 (Lisp_Object object)
512 if (NUMBERP (object))
513 return Qt;
514 else
515 return Qnil;
518 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
519 Snumber_or_marker_p, 1, 1, 0,
520 doc: /* Return t if OBJECT is a number or a marker. */)
521 (Lisp_Object object)
523 if (NUMBERP (object) || MARKERP (object))
524 return Qt;
525 return Qnil;
528 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
529 doc: /* Return t if OBJECT is a floating point number. */)
530 (Lisp_Object object)
532 if (FLOATP (object))
533 return Qt;
534 return Qnil;
538 /* Extract and set components of lists. */
540 DEFUN ("car", Fcar, Scar, 1, 1, 0,
541 doc: /* Return the car of LIST. If arg is nil, return nil.
542 Error if arg is not nil and not a cons cell. See also `car-safe'.
544 See Info node `(elisp)Cons Cells' for a discussion of related basic
545 Lisp concepts such as car, cdr, cons cell and list. */)
546 (register Lisp_Object list)
548 return CAR (list);
551 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
552 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
553 (Lisp_Object object)
555 return CAR_SAFE (object);
558 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
559 doc: /* Return the cdr of LIST. If arg is nil, return nil.
560 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
562 See Info node `(elisp)Cons Cells' for a discussion of related basic
563 Lisp concepts such as cdr, car, cons cell and list. */)
564 (register Lisp_Object list)
566 return CDR (list);
569 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
570 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
571 (Lisp_Object object)
573 return CDR_SAFE (object);
576 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
577 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
578 (register Lisp_Object cell, Lisp_Object newcar)
580 CHECK_CONS (cell);
581 CHECK_IMPURE (cell);
582 XSETCAR (cell, newcar);
583 return newcar;
586 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
587 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
588 (register Lisp_Object cell, Lisp_Object newcdr)
590 CHECK_CONS (cell);
591 CHECK_IMPURE (cell);
592 XSETCDR (cell, newcdr);
593 return newcdr;
596 /* Extract and set components of symbols. */
598 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
599 doc: /* Return t if SYMBOL's value is not void.
600 Note that if `lexical-binding' is in effect, this refers to the
601 global value outside of any lexical scope. */)
602 (register Lisp_Object symbol)
604 Lisp_Object valcontents;
605 struct Lisp_Symbol *sym;
606 CHECK_SYMBOL (symbol);
607 sym = XSYMBOL (symbol);
609 start:
610 switch (sym->redirect)
612 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
613 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
614 case SYMBOL_LOCALIZED:
616 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
617 if (blv->fwd)
618 /* In set_internal, we un-forward vars when their value is
619 set to Qunbound. */
620 return Qt;
621 else
623 swap_in_symval_forwarding (sym, blv);
624 valcontents = blv_value (blv);
626 break;
628 case SYMBOL_FORWARDED:
629 /* In set_internal, we un-forward vars when their value is
630 set to Qunbound. */
631 return Qt;
632 default: emacs_abort ();
635 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
638 /* FIXME: Make it an alias for function-symbol! */
639 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
640 doc: /* Return t if SYMBOL's function definition is not void. */)
641 (register Lisp_Object symbol)
643 CHECK_SYMBOL (symbol);
644 return NILP (XSYMBOL (symbol)->function) ? Qnil : Qt;
647 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
648 doc: /* Make SYMBOL's value be void.
649 Return SYMBOL. */)
650 (register Lisp_Object symbol)
652 CHECK_SYMBOL (symbol);
653 if (SYMBOL_CONSTANT_P (symbol))
654 xsignal1 (Qsetting_constant, symbol);
655 Fset (symbol, Qunbound);
656 return symbol;
659 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
660 doc: /* Make SYMBOL's function definition be nil.
661 Return SYMBOL. */)
662 (register Lisp_Object symbol)
664 CHECK_SYMBOL (symbol);
665 if (NILP (symbol) || EQ (symbol, Qt))
666 xsignal1 (Qsetting_constant, symbol);
667 set_symbol_function (symbol, Qnil);
668 return symbol;
671 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
672 doc: /* Return SYMBOL's function definition. Error if that is void. */)
673 (register Lisp_Object symbol)
675 CHECK_SYMBOL (symbol);
676 return XSYMBOL (symbol)->function;
679 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
680 doc: /* Return SYMBOL's property list. */)
681 (register Lisp_Object symbol)
683 CHECK_SYMBOL (symbol);
684 return XSYMBOL (symbol)->plist;
687 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
688 doc: /* Return SYMBOL's name, a string. */)
689 (register Lisp_Object symbol)
691 register Lisp_Object name;
693 CHECK_SYMBOL (symbol);
694 name = SYMBOL_NAME (symbol);
695 return name;
698 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
699 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
700 (register Lisp_Object symbol, Lisp_Object definition)
702 register Lisp_Object function;
703 CHECK_SYMBOL (symbol);
705 function = XSYMBOL (symbol)->function;
707 if (!NILP (Vautoload_queue) && !NILP (function))
708 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
710 if (AUTOLOADP (function))
711 Fput (symbol, Qautoload, XCDR (function));
713 set_symbol_function (symbol, definition);
715 return definition;
718 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
719 doc: /* Set SYMBOL's function definition to DEFINITION.
720 Associates the function with the current load file, if any.
721 The optional third argument DOCSTRING specifies the documentation string
722 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
723 determined by DEFINITION.
724 The return value is undefined. */)
725 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
727 CHECK_SYMBOL (symbol);
728 if (!NILP (Vpurify_flag)
729 /* If `definition' is a keymap, immutable (and copying) is wrong. */
730 && !KEYMAPP (definition))
731 definition = Fpurecopy (definition);
734 bool autoload = AUTOLOADP (definition);
735 if (NILP (Vpurify_flag) || !autoload)
736 { /* Only add autoload entries after dumping, because the ones before are
737 not useful and else we get loads of them from the loaddefs.el. */
739 if (AUTOLOADP (XSYMBOL (symbol)->function))
740 /* Remember that the function was already an autoload. */
741 LOADHIST_ATTACH (Fcons (Qt, symbol));
742 LOADHIST_ATTACH (Fcons (autoload ? Qautoload : Qdefun, symbol));
746 { /* Handle automatic advice activation. */
747 Lisp_Object hook = Fget (symbol, Qdefalias_fset_function);
748 if (!NILP (hook))
749 call2 (hook, symbol, definition);
750 else
751 Ffset (symbol, definition);
754 if (!NILP (docstring))
755 Fput (symbol, Qfunction_documentation, docstring);
756 /* We used to return `definition', but now that `defun' and `defmacro' expand
757 to a call to `defalias', we return `symbol' for backward compatibility
758 (bug#11686). */
759 return symbol;
762 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
763 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
764 (register Lisp_Object symbol, Lisp_Object newplist)
766 CHECK_SYMBOL (symbol);
767 set_symbol_plist (symbol, newplist);
768 return newplist;
771 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
772 doc: /* Return minimum and maximum number of args allowed for SUBR.
773 SUBR must be a built-in function.
774 The returned value is a pair (MIN . MAX). MIN is the minimum number
775 of args. MAX is the maximum number or the symbol `many', for a
776 function with `&rest' args, or `unevalled' for a special form. */)
777 (Lisp_Object subr)
779 short minargs, maxargs;
780 CHECK_SUBR (subr);
781 minargs = XSUBR (subr)->min_args;
782 maxargs = XSUBR (subr)->max_args;
783 return Fcons (make_number (minargs),
784 maxargs == MANY ? Qmany
785 : maxargs == UNEVALLED ? Qunevalled
786 : make_number (maxargs));
789 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
790 doc: /* Return name of subroutine SUBR.
791 SUBR must be a built-in function. */)
792 (Lisp_Object subr)
794 const char *name;
795 CHECK_SUBR (subr);
796 name = XSUBR (subr)->symbol_name;
797 return build_string (name);
800 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
801 doc: /* Return the interactive form of CMD or nil if none.
802 If CMD is not a command, the return value is nil.
803 Value, if non-nil, is a list \(interactive SPEC). */)
804 (Lisp_Object cmd)
806 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
808 if (NILP (fun))
809 return Qnil;
811 /* Use an `interactive-form' property if present, analogous to the
812 function-documentation property. */
813 fun = cmd;
814 while (SYMBOLP (fun))
816 Lisp_Object tmp = Fget (fun, Qinteractive_form);
817 if (!NILP (tmp))
818 return tmp;
819 else
820 fun = Fsymbol_function (fun);
823 if (SUBRP (fun))
825 const char *spec = XSUBR (fun)->intspec;
826 if (spec)
827 return list2 (Qinteractive,
828 (*spec != '(') ? build_string (spec) :
829 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
831 else if (COMPILEDP (fun))
833 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
834 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
836 else if (AUTOLOADP (fun))
837 return Finteractive_form (Fautoload_do_load (fun, cmd, Qnil));
838 else if (CONSP (fun))
840 Lisp_Object funcar = XCAR (fun);
841 if (EQ (funcar, Qclosure))
842 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
843 else if (EQ (funcar, Qlambda))
844 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
846 return Qnil;
850 /***********************************************************************
851 Getting and Setting Values of Symbols
852 ***********************************************************************/
854 /* Return the symbol holding SYMBOL's value. Signal
855 `cyclic-variable-indirection' if SYMBOL's chain of variable
856 indirections contains a loop. */
858 struct Lisp_Symbol *
859 indirect_variable (struct Lisp_Symbol *symbol)
861 struct Lisp_Symbol *tortoise, *hare;
863 hare = tortoise = symbol;
865 while (hare->redirect == SYMBOL_VARALIAS)
867 hare = SYMBOL_ALIAS (hare);
868 if (hare->redirect != SYMBOL_VARALIAS)
869 break;
871 hare = SYMBOL_ALIAS (hare);
872 tortoise = SYMBOL_ALIAS (tortoise);
874 if (hare == tortoise)
876 Lisp_Object tem;
877 XSETSYMBOL (tem, symbol);
878 xsignal1 (Qcyclic_variable_indirection, tem);
882 return hare;
886 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
887 doc: /* Return the variable at the end of OBJECT's variable chain.
888 If OBJECT is a symbol, follow its variable indirections (if any), and
889 return the variable at the end of the chain of aliases. See Info node
890 `(elisp)Variable Aliases'.
892 If OBJECT is not a symbol, just return it. If there is a loop in the
893 chain of aliases, signal a `cyclic-variable-indirection' error. */)
894 (Lisp_Object object)
896 if (SYMBOLP (object))
898 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
899 XSETSYMBOL (object, sym);
901 return object;
905 /* Given the raw contents of a symbol value cell,
906 return the Lisp value of the symbol.
907 This does not handle buffer-local variables; use
908 swap_in_symval_forwarding for that. */
910 Lisp_Object
911 do_symval_forwarding (register union Lisp_Fwd *valcontents)
913 register Lisp_Object val;
914 switch (XFWDTYPE (valcontents))
916 case Lisp_Fwd_Int:
917 XSETINT (val, *XINTFWD (valcontents)->intvar);
918 return val;
920 case Lisp_Fwd_Bool:
921 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
923 case Lisp_Fwd_Obj:
924 return *XOBJFWD (valcontents)->objvar;
926 case Lisp_Fwd_Buffer_Obj:
927 return per_buffer_value (current_buffer,
928 XBUFFER_OBJFWD (valcontents)->offset);
930 case Lisp_Fwd_Kboard_Obj:
931 /* We used to simply use current_kboard here, but from Lisp
932 code, its value is often unexpected. It seems nicer to
933 allow constructions like this to work as intuitively expected:
935 (with-selected-frame frame
936 (define-key local-function-map "\eOP" [f1]))
938 On the other hand, this affects the semantics of
939 last-command and real-last-command, and people may rely on
940 that. I took a quick look at the Lisp codebase, and I
941 don't think anything will break. --lorentey */
942 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
943 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
944 default: emacs_abort ();
948 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
949 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
950 buffer-independent contents of the value cell: forwarded just one
951 step past the buffer-localness.
953 BUF non-zero means set the value in buffer BUF instead of the
954 current buffer. This only plays a role for per-buffer variables. */
956 static void
957 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
959 switch (XFWDTYPE (valcontents))
961 case Lisp_Fwd_Int:
962 CHECK_NUMBER (newval);
963 *XINTFWD (valcontents)->intvar = XINT (newval);
964 break;
966 case Lisp_Fwd_Bool:
967 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
968 break;
970 case Lisp_Fwd_Obj:
971 *XOBJFWD (valcontents)->objvar = newval;
973 /* If this variable is a default for something stored
974 in the buffer itself, such as default-fill-column,
975 find the buffers that don't have local values for it
976 and update them. */
977 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
978 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
980 int offset = ((char *) XOBJFWD (valcontents)->objvar
981 - (char *) &buffer_defaults);
982 int idx = PER_BUFFER_IDX (offset);
984 Lisp_Object tail;
986 if (idx <= 0)
987 break;
989 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
991 Lisp_Object lbuf;
992 struct buffer *b;
994 lbuf = Fcdr (XCAR (tail));
995 if (!BUFFERP (lbuf)) continue;
996 b = XBUFFER (lbuf);
998 if (! PER_BUFFER_VALUE_P (b, idx))
999 set_per_buffer_value (b, offset, newval);
1002 break;
1004 case Lisp_Fwd_Buffer_Obj:
1006 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1007 Lisp_Object predicate = XBUFFER_OBJFWD (valcontents)->predicate;
1009 if (!NILP (predicate) && !NILP (newval)
1010 && NILP (call1 (predicate, newval)))
1011 wrong_type_argument (predicate, newval);
1013 if (buf == NULL)
1014 buf = current_buffer;
1015 set_per_buffer_value (buf, offset, newval);
1017 break;
1019 case Lisp_Fwd_Kboard_Obj:
1021 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
1022 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
1023 *(Lisp_Object *) p = newval;
1025 break;
1027 default:
1028 emacs_abort (); /* goto def; */
1032 /* Set up SYMBOL to refer to its global binding. This makes it safe
1033 to alter the status of other bindings. BEWARE: this may be called
1034 during the mark phase of GC, where we assume that Lisp_Object slots
1035 of BLV are marked after this function has changed them. */
1037 void
1038 swap_in_global_binding (struct Lisp_Symbol *symbol)
1040 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
1042 /* Unload the previously loaded binding. */
1043 if (blv->fwd)
1044 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1046 /* Select the global binding in the symbol. */
1047 set_blv_valcell (blv, blv->defcell);
1048 if (blv->fwd)
1049 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
1051 /* Indicate that the global binding is set up now. */
1052 set_blv_where (blv, Qnil);
1053 set_blv_found (blv, 0);
1056 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
1057 VALCONTENTS is the contents of its value cell,
1058 which points to a struct Lisp_Buffer_Local_Value.
1060 Return the value forwarded one step past the buffer-local stage.
1061 This could be another forwarding pointer. */
1063 static void
1064 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1066 register Lisp_Object tem1;
1068 eassert (blv == SYMBOL_BLV (symbol));
1070 tem1 = blv->where;
1072 if (NILP (tem1)
1073 || (blv->frame_local
1074 ? !EQ (selected_frame, tem1)
1075 : current_buffer != XBUFFER (tem1)))
1078 /* Unload the previously loaded binding. */
1079 tem1 = blv->valcell;
1080 if (blv->fwd)
1081 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1082 /* Choose the new binding. */
1084 Lisp_Object var;
1085 XSETSYMBOL (var, symbol);
1086 if (blv->frame_local)
1088 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1089 set_blv_where (blv, selected_frame);
1091 else
1093 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1094 set_blv_where (blv, Fcurrent_buffer ());
1097 if (!(blv->found = !NILP (tem1)))
1098 tem1 = blv->defcell;
1100 /* Load the new binding. */
1101 set_blv_valcell (blv, tem1);
1102 if (blv->fwd)
1103 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1107 /* Find the value of a symbol, returning Qunbound if it's not bound.
1108 This is helpful for code which just wants to get a variable's value
1109 if it has one, without signaling an error.
1110 Note that it must not be possible to quit
1111 within this function. Great care is required for this. */
1113 Lisp_Object
1114 find_symbol_value (Lisp_Object symbol)
1116 struct Lisp_Symbol *sym;
1118 CHECK_SYMBOL (symbol);
1119 sym = XSYMBOL (symbol);
1121 start:
1122 switch (sym->redirect)
1124 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1125 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1126 case SYMBOL_LOCALIZED:
1128 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1129 swap_in_symval_forwarding (sym, blv);
1130 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1132 /* FALLTHROUGH */
1133 case SYMBOL_FORWARDED:
1134 return do_symval_forwarding (SYMBOL_FWD (sym));
1135 default: emacs_abort ();
1139 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1140 doc: /* Return SYMBOL's value. Error if that is void.
1141 Note that if `lexical-binding' is in effect, this returns the
1142 global value outside of any lexical scope. */)
1143 (Lisp_Object symbol)
1145 Lisp_Object val;
1147 val = find_symbol_value (symbol);
1148 if (!EQ (val, Qunbound))
1149 return val;
1151 xsignal1 (Qvoid_variable, symbol);
1154 DEFUN ("set", Fset, Sset, 2, 2, 0,
1155 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1156 (register Lisp_Object symbol, Lisp_Object newval)
1158 set_internal (symbol, newval, Qnil, 0);
1159 return newval;
1162 /* Store the value NEWVAL into SYMBOL.
1163 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1164 (nil stands for the current buffer/frame).
1166 If BINDFLAG is false, then if this symbol is supposed to become
1167 local in every buffer where it is set, then we make it local.
1168 If BINDFLAG is true, we don't do that. */
1170 void
1171 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1172 bool bindflag)
1174 bool voide = EQ (newval, Qunbound);
1175 struct Lisp_Symbol *sym;
1176 Lisp_Object tem1;
1178 /* If restoring in a dead buffer, do nothing. */
1179 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1180 return; */
1182 CHECK_SYMBOL (symbol);
1183 if (SYMBOL_CONSTANT_P (symbol))
1185 if (NILP (Fkeywordp (symbol))
1186 || !EQ (newval, Fsymbol_value (symbol)))
1187 xsignal1 (Qsetting_constant, symbol);
1188 else
1189 /* Allow setting keywords to their own value. */
1190 return;
1193 sym = XSYMBOL (symbol);
1195 start:
1196 switch (sym->redirect)
1198 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1199 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1200 case SYMBOL_LOCALIZED:
1202 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1203 if (NILP (where))
1205 if (blv->frame_local)
1206 where = selected_frame;
1207 else
1208 XSETBUFFER (where, current_buffer);
1210 /* If the current buffer is not the buffer whose binding is
1211 loaded, or if there may be frame-local bindings and the frame
1212 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1213 the default binding is loaded, the loaded binding may be the
1214 wrong one. */
1215 if (!EQ (blv->where, where)
1216 /* Also unload a global binding (if the var is local_if_set). */
1217 || (EQ (blv->valcell, blv->defcell)))
1219 /* The currently loaded binding is not necessarily valid.
1220 We need to unload it, and choose a new binding. */
1222 /* Write out `realvalue' to the old loaded binding. */
1223 if (blv->fwd)
1224 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1226 /* Find the new binding. */
1227 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1228 tem1 = Fassq (symbol,
1229 (blv->frame_local
1230 ? XFRAME (where)->param_alist
1231 : BVAR (XBUFFER (where), local_var_alist)));
1232 set_blv_where (blv, where);
1233 blv->found = 1;
1235 if (NILP (tem1))
1237 /* This buffer still sees the default value. */
1239 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1240 or if this is `let' rather than `set',
1241 make CURRENT-ALIST-ELEMENT point to itself,
1242 indicating that we're seeing the default value.
1243 Likewise if the variable has been let-bound
1244 in the current buffer. */
1245 if (bindflag || !blv->local_if_set
1246 || let_shadows_buffer_binding_p (sym))
1248 blv->found = 0;
1249 tem1 = blv->defcell;
1251 /* If it's a local_if_set, being set not bound,
1252 and we're not within a let that was made for this buffer,
1253 create a new buffer-local binding for the variable.
1254 That means, give this buffer a new assoc for a local value
1255 and load that binding. */
1256 else
1258 /* local_if_set is only supported for buffer-local
1259 bindings, not for frame-local bindings. */
1260 eassert (!blv->frame_local);
1261 tem1 = Fcons (symbol, XCDR (blv->defcell));
1262 bset_local_var_alist
1263 (XBUFFER (where),
1264 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1268 /* Record which binding is now loaded. */
1269 set_blv_valcell (blv, tem1);
1272 /* Store the new value in the cons cell. */
1273 set_blv_value (blv, newval);
1275 if (blv->fwd)
1277 if (voide)
1278 /* If storing void (making the symbol void), forward only through
1279 buffer-local indicator, not through Lisp_Objfwd, etc. */
1280 blv->fwd = NULL;
1281 else
1282 store_symval_forwarding (blv->fwd, newval,
1283 BUFFERP (where)
1284 ? XBUFFER (where) : current_buffer);
1286 break;
1288 case SYMBOL_FORWARDED:
1290 struct buffer *buf
1291 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1292 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1293 if (BUFFER_OBJFWDP (innercontents))
1295 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1296 int idx = PER_BUFFER_IDX (offset);
1297 if (idx > 0
1298 && !bindflag
1299 && !let_shadows_buffer_binding_p (sym))
1300 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1303 if (voide)
1304 { /* If storing void (making the symbol void), forward only through
1305 buffer-local indicator, not through Lisp_Objfwd, etc. */
1306 sym->redirect = SYMBOL_PLAINVAL;
1307 SET_SYMBOL_VAL (sym, newval);
1309 else
1310 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1311 break;
1313 default: emacs_abort ();
1315 return;
1318 /* Access or set a buffer-local symbol's default value. */
1320 /* Return the default value of SYMBOL, but don't check for voidness.
1321 Return Qunbound if it is void. */
1323 static Lisp_Object
1324 default_value (Lisp_Object symbol)
1326 struct Lisp_Symbol *sym;
1328 CHECK_SYMBOL (symbol);
1329 sym = XSYMBOL (symbol);
1331 start:
1332 switch (sym->redirect)
1334 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1335 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1336 case SYMBOL_LOCALIZED:
1338 /* If var is set up for a buffer that lacks a local value for it,
1339 the current value is nominally the default value.
1340 But the `realvalue' slot may be more up to date, since
1341 ordinary setq stores just that slot. So use that. */
1342 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1343 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1344 return do_symval_forwarding (blv->fwd);
1345 else
1346 return XCDR (blv->defcell);
1348 case SYMBOL_FORWARDED:
1350 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1352 /* For a built-in buffer-local variable, get the default value
1353 rather than letting do_symval_forwarding get the current value. */
1354 if (BUFFER_OBJFWDP (valcontents))
1356 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1357 if (PER_BUFFER_IDX (offset) != 0)
1358 return per_buffer_default (offset);
1361 /* For other variables, get the current value. */
1362 return do_symval_forwarding (valcontents);
1364 default: emacs_abort ();
1368 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1369 doc: /* Return t if SYMBOL has a non-void default value.
1370 This is the value that is seen in buffers that do not have their own values
1371 for this variable. */)
1372 (Lisp_Object symbol)
1374 register Lisp_Object value;
1376 value = default_value (symbol);
1377 return (EQ (value, Qunbound) ? Qnil : Qt);
1380 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1381 doc: /* Return SYMBOL's default value.
1382 This is the value that is seen in buffers that do not have their own values
1383 for this variable. The default value is meaningful for variables with
1384 local bindings in certain buffers. */)
1385 (Lisp_Object symbol)
1387 register Lisp_Object value;
1389 value = default_value (symbol);
1390 if (!EQ (value, Qunbound))
1391 return value;
1393 xsignal1 (Qvoid_variable, symbol);
1396 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1397 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1398 The default value is seen in buffers that do not have their own values
1399 for this variable. */)
1400 (Lisp_Object symbol, Lisp_Object value)
1402 struct Lisp_Symbol *sym;
1404 CHECK_SYMBOL (symbol);
1405 if (SYMBOL_CONSTANT_P (symbol))
1407 if (NILP (Fkeywordp (symbol))
1408 || !EQ (value, Fdefault_value (symbol)))
1409 xsignal1 (Qsetting_constant, symbol);
1410 else
1411 /* Allow setting keywords to their own value. */
1412 return value;
1414 sym = XSYMBOL (symbol);
1416 start:
1417 switch (sym->redirect)
1419 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1420 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1421 case SYMBOL_LOCALIZED:
1423 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1425 /* Store new value into the DEFAULT-VALUE slot. */
1426 XSETCDR (blv->defcell, value);
1428 /* If the default binding is now loaded, set the REALVALUE slot too. */
1429 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1430 store_symval_forwarding (blv->fwd, value, NULL);
1431 return value;
1433 case SYMBOL_FORWARDED:
1435 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1437 /* Handle variables like case-fold-search that have special slots
1438 in the buffer.
1439 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1440 if (BUFFER_OBJFWDP (valcontents))
1442 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1443 int idx = PER_BUFFER_IDX (offset);
1445 set_per_buffer_default (offset, value);
1447 /* If this variable is not always local in all buffers,
1448 set it in the buffers that don't nominally have a local value. */
1449 if (idx > 0)
1451 struct buffer *b;
1453 FOR_EACH_BUFFER (b)
1454 if (!PER_BUFFER_VALUE_P (b, idx))
1455 set_per_buffer_value (b, offset, value);
1457 return value;
1459 else
1460 return Fset (symbol, value);
1462 default: emacs_abort ();
1466 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1467 doc: /* Set the default value of variable VAR to VALUE.
1468 VAR, the variable name, is literal (not evaluated);
1469 VALUE is an expression: it is evaluated and its value returned.
1470 The default value of a variable is seen in buffers
1471 that do not have their own values for the variable.
1473 More generally, you can use multiple variables and values, as in
1474 (setq-default VAR VALUE VAR VALUE...)
1475 This sets each VAR's default value to the corresponding VALUE.
1476 The VALUE for the Nth VAR can refer to the new default values
1477 of previous VARs.
1478 usage: (setq-default [VAR VALUE]...) */)
1479 (Lisp_Object args)
1481 register Lisp_Object args_left;
1482 register Lisp_Object val, symbol;
1483 struct gcpro gcpro1;
1485 if (NILP (args))
1486 return Qnil;
1488 args_left = args;
1489 GCPRO1 (args);
1493 val = eval_sub (Fcar (Fcdr (args_left)));
1494 symbol = XCAR (args_left);
1495 Fset_default (symbol, val);
1496 args_left = Fcdr (XCDR (args_left));
1498 while (!NILP (args_left));
1500 UNGCPRO;
1501 return val;
1504 /* Lisp functions for creating and removing buffer-local variables. */
1506 union Lisp_Val_Fwd
1508 Lisp_Object value;
1509 union Lisp_Fwd *fwd;
1512 static struct Lisp_Buffer_Local_Value *
1513 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1514 union Lisp_Val_Fwd valcontents)
1516 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1517 Lisp_Object symbol;
1518 Lisp_Object tem;
1520 XSETSYMBOL (symbol, sym);
1521 tem = Fcons (symbol, (forwarded
1522 ? do_symval_forwarding (valcontents.fwd)
1523 : valcontents.value));
1525 /* Buffer_Local_Values cannot have as realval a buffer-local
1526 or keyboard-local forwarding. */
1527 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1528 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1529 blv->fwd = forwarded ? valcontents.fwd : NULL;
1530 set_blv_where (blv, Qnil);
1531 blv->frame_local = 0;
1532 blv->local_if_set = 0;
1533 set_blv_defcell (blv, tem);
1534 set_blv_valcell (blv, tem);
1535 set_blv_found (blv, 0);
1536 return blv;
1539 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1540 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1541 doc: /* Make VARIABLE become buffer-local whenever it is set.
1542 At any time, the value for the current buffer is in effect,
1543 unless the variable has never been set in this buffer,
1544 in which case the default value is in effect.
1545 Note that binding the variable with `let', or setting it while
1546 a `let'-style binding made in this buffer is in effect,
1547 does not make the variable buffer-local. Return VARIABLE.
1549 In most cases it is better to use `make-local-variable',
1550 which makes a variable local in just one buffer.
1552 The function `default-value' gets the default value and `set-default' sets it. */)
1553 (register Lisp_Object variable)
1555 struct Lisp_Symbol *sym;
1556 struct Lisp_Buffer_Local_Value *blv = NULL;
1557 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1558 bool forwarded IF_LINT (= 0);
1560 CHECK_SYMBOL (variable);
1561 sym = XSYMBOL (variable);
1563 start:
1564 switch (sym->redirect)
1566 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1567 case SYMBOL_PLAINVAL:
1568 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1569 if (EQ (valcontents.value, Qunbound))
1570 valcontents.value = Qnil;
1571 break;
1572 case SYMBOL_LOCALIZED:
1573 blv = SYMBOL_BLV (sym);
1574 if (blv->frame_local)
1575 error ("Symbol %s may not be buffer-local",
1576 SDATA (SYMBOL_NAME (variable)));
1577 break;
1578 case SYMBOL_FORWARDED:
1579 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1580 if (KBOARD_OBJFWDP (valcontents.fwd))
1581 error ("Symbol %s may not be buffer-local",
1582 SDATA (SYMBOL_NAME (variable)));
1583 else if (BUFFER_OBJFWDP (valcontents.fwd))
1584 return variable;
1585 break;
1586 default: emacs_abort ();
1589 if (sym->constant)
1590 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1592 if (!blv)
1594 blv = make_blv (sym, forwarded, valcontents);
1595 sym->redirect = SYMBOL_LOCALIZED;
1596 SET_SYMBOL_BLV (sym, blv);
1598 Lisp_Object symbol;
1599 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1600 if (let_shadows_global_binding_p (symbol))
1601 message ("Making %s buffer-local while let-bound!",
1602 SDATA (SYMBOL_NAME (variable)));
1606 blv->local_if_set = 1;
1607 return variable;
1610 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1611 1, 1, "vMake Local Variable: ",
1612 doc: /* Make VARIABLE have a separate value in the current buffer.
1613 Other buffers will continue to share a common default value.
1614 \(The buffer-local value of VARIABLE starts out as the same value
1615 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1616 Return VARIABLE.
1618 If the variable is already arranged to become local when set,
1619 this function causes a local value to exist for this buffer,
1620 just as setting the variable would do.
1622 This function returns VARIABLE, and therefore
1623 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1624 works.
1626 See also `make-variable-buffer-local'.
1628 Do not use `make-local-variable' to make a hook variable buffer-local.
1629 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1630 (Lisp_Object variable)
1632 Lisp_Object tem;
1633 bool forwarded IF_LINT (= 0);
1634 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1635 struct Lisp_Symbol *sym;
1636 struct Lisp_Buffer_Local_Value *blv = NULL;
1638 CHECK_SYMBOL (variable);
1639 sym = XSYMBOL (variable);
1641 start:
1642 switch (sym->redirect)
1644 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1645 case SYMBOL_PLAINVAL:
1646 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1647 case SYMBOL_LOCALIZED:
1648 blv = SYMBOL_BLV (sym);
1649 if (blv->frame_local)
1650 error ("Symbol %s may not be buffer-local",
1651 SDATA (SYMBOL_NAME (variable)));
1652 break;
1653 case SYMBOL_FORWARDED:
1654 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1655 if (KBOARD_OBJFWDP (valcontents.fwd))
1656 error ("Symbol %s may not be buffer-local",
1657 SDATA (SYMBOL_NAME (variable)));
1658 break;
1659 default: emacs_abort ();
1662 if (sym->constant)
1663 error ("Symbol %s may not be buffer-local",
1664 SDATA (SYMBOL_NAME (variable)));
1666 if (blv ? blv->local_if_set
1667 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1669 tem = Fboundp (variable);
1670 /* Make sure the symbol has a local value in this particular buffer,
1671 by setting it to the same value it already has. */
1672 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1673 return variable;
1675 if (!blv)
1677 blv = make_blv (sym, forwarded, valcontents);
1678 sym->redirect = SYMBOL_LOCALIZED;
1679 SET_SYMBOL_BLV (sym, blv);
1681 Lisp_Object symbol;
1682 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1683 if (let_shadows_global_binding_p (symbol))
1684 message ("Making %s local to %s while let-bound!",
1685 SDATA (SYMBOL_NAME (variable)),
1686 SDATA (BVAR (current_buffer, name)));
1690 /* Make sure this buffer has its own value of symbol. */
1691 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1692 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1693 if (NILP (tem))
1695 if (let_shadows_buffer_binding_p (sym))
1696 message ("Making %s buffer-local while locally let-bound!",
1697 SDATA (SYMBOL_NAME (variable)));
1699 /* Swap out any local binding for some other buffer, and make
1700 sure the current value is permanently recorded, if it's the
1701 default value. */
1702 find_symbol_value (variable);
1704 bset_local_var_alist
1705 (current_buffer,
1706 Fcons (Fcons (variable, XCDR (blv->defcell)),
1707 BVAR (current_buffer, local_var_alist)));
1709 /* Make sure symbol does not think it is set up for this buffer;
1710 force it to look once again for this buffer's value. */
1711 if (current_buffer == XBUFFER (blv->where))
1712 set_blv_where (blv, Qnil);
1713 set_blv_found (blv, 0);
1716 /* If the symbol forwards into a C variable, then load the binding
1717 for this buffer now. If C code modifies the variable before we
1718 load the binding in, then that new value will clobber the default
1719 binding the next time we unload it. */
1720 if (blv->fwd)
1721 swap_in_symval_forwarding (sym, blv);
1723 return variable;
1726 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1727 1, 1, "vKill Local Variable: ",
1728 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1729 From now on the default value will apply in this buffer. Return VARIABLE. */)
1730 (register Lisp_Object variable)
1732 register Lisp_Object tem;
1733 struct Lisp_Buffer_Local_Value *blv;
1734 struct Lisp_Symbol *sym;
1736 CHECK_SYMBOL (variable);
1737 sym = XSYMBOL (variable);
1739 start:
1740 switch (sym->redirect)
1742 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1743 case SYMBOL_PLAINVAL: return variable;
1744 case SYMBOL_FORWARDED:
1746 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1747 if (BUFFER_OBJFWDP (valcontents))
1749 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1750 int idx = PER_BUFFER_IDX (offset);
1752 if (idx > 0)
1754 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1755 set_per_buffer_value (current_buffer, offset,
1756 per_buffer_default (offset));
1759 return variable;
1761 case SYMBOL_LOCALIZED:
1762 blv = SYMBOL_BLV (sym);
1763 if (blv->frame_local)
1764 return variable;
1765 break;
1766 default: emacs_abort ();
1769 /* Get rid of this buffer's alist element, if any. */
1770 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1771 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1772 if (!NILP (tem))
1773 bset_local_var_alist
1774 (current_buffer,
1775 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1777 /* If the symbol is set up with the current buffer's binding
1778 loaded, recompute its value. We have to do it now, or else
1779 forwarded objects won't work right. */
1781 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1782 if (EQ (buf, blv->where))
1784 set_blv_where (blv, Qnil);
1785 blv->found = 0;
1786 find_symbol_value (variable);
1790 return variable;
1793 /* Lisp functions for creating and removing buffer-local variables. */
1795 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1796 when/if this is removed. */
1798 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1799 1, 1, "vMake Variable Frame Local: ",
1800 doc: /* Enable VARIABLE to have frame-local bindings.
1801 This does not create any frame-local bindings for VARIABLE,
1802 it just makes them possible.
1804 A frame-local binding is actually a frame parameter value.
1805 If a frame F has a value for the frame parameter named VARIABLE,
1806 that also acts as a frame-local binding for VARIABLE in F--
1807 provided this function has been called to enable VARIABLE
1808 to have frame-local bindings at all.
1810 The only way to create a frame-local binding for VARIABLE in a frame
1811 is to set the VARIABLE frame parameter of that frame. See
1812 `modify-frame-parameters' for how to set frame parameters.
1814 Note that since Emacs 23.1, variables cannot be both buffer-local and
1815 frame-local any more (buffer-local bindings used to take precedence over
1816 frame-local bindings). */)
1817 (Lisp_Object variable)
1819 bool forwarded;
1820 union Lisp_Val_Fwd valcontents;
1821 struct Lisp_Symbol *sym;
1822 struct Lisp_Buffer_Local_Value *blv = NULL;
1824 CHECK_SYMBOL (variable);
1825 sym = XSYMBOL (variable);
1827 start:
1828 switch (sym->redirect)
1830 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1831 case SYMBOL_PLAINVAL:
1832 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1833 if (EQ (valcontents.value, Qunbound))
1834 valcontents.value = Qnil;
1835 break;
1836 case SYMBOL_LOCALIZED:
1837 if (SYMBOL_BLV (sym)->frame_local)
1838 return variable;
1839 else
1840 error ("Symbol %s may not be frame-local",
1841 SDATA (SYMBOL_NAME (variable)));
1842 case SYMBOL_FORWARDED:
1843 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1844 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1845 error ("Symbol %s may not be frame-local",
1846 SDATA (SYMBOL_NAME (variable)));
1847 break;
1848 default: emacs_abort ();
1851 if (sym->constant)
1852 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1854 blv = make_blv (sym, forwarded, valcontents);
1855 blv->frame_local = 1;
1856 sym->redirect = SYMBOL_LOCALIZED;
1857 SET_SYMBOL_BLV (sym, blv);
1859 Lisp_Object symbol;
1860 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1861 if (let_shadows_global_binding_p (symbol))
1862 message ("Making %s frame-local while let-bound!",
1863 SDATA (SYMBOL_NAME (variable)));
1865 return variable;
1868 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1869 1, 2, 0,
1870 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1871 BUFFER defaults to the current buffer. */)
1872 (register Lisp_Object variable, Lisp_Object buffer)
1874 register struct buffer *buf;
1875 struct Lisp_Symbol *sym;
1877 if (NILP (buffer))
1878 buf = current_buffer;
1879 else
1881 CHECK_BUFFER (buffer);
1882 buf = XBUFFER (buffer);
1885 CHECK_SYMBOL (variable);
1886 sym = XSYMBOL (variable);
1888 start:
1889 switch (sym->redirect)
1891 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1892 case SYMBOL_PLAINVAL: return Qnil;
1893 case SYMBOL_LOCALIZED:
1895 Lisp_Object tail, elt, tmp;
1896 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1897 XSETBUFFER (tmp, buf);
1898 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1900 if (EQ (blv->where, tmp)) /* The binding is already loaded. */
1901 return blv_found (blv) ? Qt : Qnil;
1902 else
1903 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1905 elt = XCAR (tail);
1906 if (EQ (variable, XCAR (elt)))
1908 eassert (!blv->frame_local);
1909 return Qt;
1912 return Qnil;
1914 case SYMBOL_FORWARDED:
1916 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1917 if (BUFFER_OBJFWDP (valcontents))
1919 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1920 int idx = PER_BUFFER_IDX (offset);
1921 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1922 return Qt;
1924 return Qnil;
1926 default: emacs_abort ();
1930 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1931 1, 2, 0,
1932 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1933 BUFFER defaults to the current buffer.
1935 More precisely, return non-nil if either VARIABLE already has a local
1936 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1937 `make-variable-buffer-local'). */)
1938 (register Lisp_Object variable, Lisp_Object buffer)
1940 struct Lisp_Symbol *sym;
1942 CHECK_SYMBOL (variable);
1943 sym = XSYMBOL (variable);
1945 start:
1946 switch (sym->redirect)
1948 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1949 case SYMBOL_PLAINVAL: return Qnil;
1950 case SYMBOL_LOCALIZED:
1952 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1953 if (blv->local_if_set)
1954 return Qt;
1955 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1956 return Flocal_variable_p (variable, buffer);
1958 case SYMBOL_FORWARDED:
1959 /* All BUFFER_OBJFWD slots become local if they are set. */
1960 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1961 default: emacs_abort ();
1965 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1966 1, 1, 0,
1967 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1968 If the current binding is buffer-local, the value is the current buffer.
1969 If the current binding is frame-local, the value is the selected frame.
1970 If the current binding is global (the default), the value is nil. */)
1971 (register Lisp_Object variable)
1973 struct Lisp_Symbol *sym;
1975 CHECK_SYMBOL (variable);
1976 sym = XSYMBOL (variable);
1978 /* Make sure the current binding is actually swapped in. */
1979 find_symbol_value (variable);
1981 start:
1982 switch (sym->redirect)
1984 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1985 case SYMBOL_PLAINVAL: return Qnil;
1986 case SYMBOL_FORWARDED:
1988 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1989 if (KBOARD_OBJFWDP (valcontents))
1990 return Fframe_terminal (Fselected_frame ());
1991 else if (!BUFFER_OBJFWDP (valcontents))
1992 return Qnil;
1994 /* FALLTHROUGH */
1995 case SYMBOL_LOCALIZED:
1996 /* For a local variable, record both the symbol and which
1997 buffer's or frame's value we are saving. */
1998 if (!NILP (Flocal_variable_p (variable, Qnil)))
1999 return Fcurrent_buffer ();
2000 else if (sym->redirect == SYMBOL_LOCALIZED
2001 && blv_found (SYMBOL_BLV (sym)))
2002 return SYMBOL_BLV (sym)->where;
2003 else
2004 return Qnil;
2005 default: emacs_abort ();
2009 /* This code is disabled now that we use the selected frame to return
2010 keyboard-local-values. */
2011 #if 0
2012 extern struct terminal *get_terminal (Lisp_Object display, int);
2014 DEFUN ("terminal-local-value", Fterminal_local_value,
2015 Sterminal_local_value, 2, 2, 0,
2016 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
2017 If SYMBOL is not a terminal-local variable, then return its normal
2018 value, like `symbol-value'.
2020 TERMINAL may be a terminal object, a frame, or nil (meaning the
2021 selected frame's terminal device). */)
2022 (Lisp_Object symbol, Lisp_Object terminal)
2024 Lisp_Object result;
2025 struct terminal *t = get_terminal (terminal, 1);
2026 push_kboard (t->kboard);
2027 result = Fsymbol_value (symbol);
2028 pop_kboard ();
2029 return result;
2032 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
2033 Sset_terminal_local_value, 3, 3, 0,
2034 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2035 If VARIABLE is not a terminal-local variable, then set its normal
2036 binding, like `set'.
2038 TERMINAL may be a terminal object, a frame, or nil (meaning the
2039 selected frame's terminal device). */)
2040 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2042 Lisp_Object result;
2043 struct terminal *t = get_terminal (terminal, 1);
2044 push_kboard (d->kboard);
2045 result = Fset (symbol, value);
2046 pop_kboard ();
2047 return result;
2049 #endif
2051 /* Find the function at the end of a chain of symbol function indirections. */
2053 /* If OBJECT is a symbol, find the end of its function chain and
2054 return the value found there. If OBJECT is not a symbol, just
2055 return it. If there is a cycle in the function chain, signal a
2056 cyclic-function-indirection error.
2058 This is like Findirect_function, except that it doesn't signal an
2059 error if the chain ends up unbound. */
2060 Lisp_Object
2061 indirect_function (register Lisp_Object object)
2063 Lisp_Object tortoise, hare;
2065 hare = tortoise = object;
2067 for (;;)
2069 if (!SYMBOLP (hare) || NILP (hare))
2070 break;
2071 hare = XSYMBOL (hare)->function;
2072 if (!SYMBOLP (hare) || NILP (hare))
2073 break;
2074 hare = XSYMBOL (hare)->function;
2076 tortoise = XSYMBOL (tortoise)->function;
2078 if (EQ (hare, tortoise))
2079 xsignal1 (Qcyclic_function_indirection, object);
2082 return hare;
2085 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2086 doc: /* Return the function at the end of OBJECT's function chain.
2087 If OBJECT is not a symbol, just return it. Otherwise, follow all
2088 function indirections to find the final function binding and return it.
2089 If the final symbol in the chain is unbound, signal a void-function error.
2090 Optional arg NOERROR non-nil means to return nil instead of signaling.
2091 Signal a cyclic-function-indirection error if there is a loop in the
2092 function chain of symbols. */)
2093 (register Lisp_Object object, Lisp_Object noerror)
2095 Lisp_Object result;
2097 /* Optimize for no indirection. */
2098 result = object;
2099 if (SYMBOLP (result) && !NILP (result)
2100 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2101 result = indirect_function (result);
2102 if (!NILP (result))
2103 return result;
2105 if (NILP (noerror))
2106 xsignal1 (Qvoid_function, object);
2108 return Qnil;
2111 /* Extract and set vector and string elements. */
2113 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2114 doc: /* Return the element of ARRAY at index IDX.
2115 ARRAY may be a vector, a string, a char-table, a bool-vector,
2116 or a byte-code object. IDX starts at 0. */)
2117 (register Lisp_Object array, Lisp_Object idx)
2119 register EMACS_INT idxval;
2121 CHECK_NUMBER (idx);
2122 idxval = XINT (idx);
2123 if (STRINGP (array))
2125 int c;
2126 ptrdiff_t idxval_byte;
2128 if (idxval < 0 || idxval >= SCHARS (array))
2129 args_out_of_range (array, idx);
2130 if (! STRING_MULTIBYTE (array))
2131 return make_number ((unsigned char) SREF (array, idxval));
2132 idxval_byte = string_char_to_byte (array, idxval);
2134 c = STRING_CHAR (SDATA (array) + idxval_byte);
2135 return make_number (c);
2137 else if (BOOL_VECTOR_P (array))
2139 int val;
2141 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2142 args_out_of_range (array, idx);
2144 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2145 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2147 else if (CHAR_TABLE_P (array))
2149 CHECK_CHARACTER (idx);
2150 return CHAR_TABLE_REF (array, idxval);
2152 else
2154 ptrdiff_t size = 0;
2155 if (VECTORP (array))
2156 size = ASIZE (array);
2157 else if (COMPILEDP (array))
2158 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2159 else
2160 wrong_type_argument (Qarrayp, array);
2162 if (idxval < 0 || idxval >= size)
2163 args_out_of_range (array, idx);
2164 return AREF (array, idxval);
2168 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2169 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2170 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2171 bool-vector. IDX starts at 0. */)
2172 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2174 register EMACS_INT idxval;
2176 CHECK_NUMBER (idx);
2177 idxval = XINT (idx);
2178 CHECK_ARRAY (array, Qarrayp);
2179 CHECK_IMPURE (array);
2181 if (VECTORP (array))
2183 if (idxval < 0 || idxval >= ASIZE (array))
2184 args_out_of_range (array, idx);
2185 ASET (array, idxval, newelt);
2187 else if (BOOL_VECTOR_P (array))
2189 int val;
2191 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2192 args_out_of_range (array, idx);
2194 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2196 if (! NILP (newelt))
2197 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2198 else
2199 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2200 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2202 else if (CHAR_TABLE_P (array))
2204 CHECK_CHARACTER (idx);
2205 CHAR_TABLE_SET (array, idxval, newelt);
2207 else
2209 int c;
2211 if (idxval < 0 || idxval >= SCHARS (array))
2212 args_out_of_range (array, idx);
2213 CHECK_CHARACTER (newelt);
2214 c = XFASTINT (newelt);
2216 if (STRING_MULTIBYTE (array))
2218 ptrdiff_t idxval_byte, nbytes;
2219 int prev_bytes, new_bytes;
2220 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2222 nbytes = SBYTES (array);
2223 idxval_byte = string_char_to_byte (array, idxval);
2224 p1 = SDATA (array) + idxval_byte;
2225 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2226 new_bytes = CHAR_STRING (c, p0);
2227 if (prev_bytes != new_bytes)
2229 /* We must relocate the string data. */
2230 ptrdiff_t nchars = SCHARS (array);
2231 USE_SAFE_ALLOCA;
2232 unsigned char *str = SAFE_ALLOCA (nbytes);
2234 memcpy (str, SDATA (array), nbytes);
2235 allocate_string_data (XSTRING (array), nchars,
2236 nbytes + new_bytes - prev_bytes);
2237 memcpy (SDATA (array), str, idxval_byte);
2238 p1 = SDATA (array) + idxval_byte;
2239 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2240 nbytes - (idxval_byte + prev_bytes));
2241 SAFE_FREE ();
2242 clear_string_char_byte_cache ();
2244 while (new_bytes--)
2245 *p1++ = *p0++;
2247 else
2249 if (! SINGLE_BYTE_CHAR_P (c))
2251 int i;
2253 for (i = SBYTES (array) - 1; i >= 0; i--)
2254 if (SREF (array, i) >= 0x80)
2255 args_out_of_range (array, newelt);
2256 /* ARRAY is an ASCII string. Convert it to a multibyte
2257 string, and try `aset' again. */
2258 STRING_SET_MULTIBYTE (array);
2259 return Faset (array, idx, newelt);
2261 SSET (array, idxval, c);
2265 return newelt;
2268 /* Arithmetic functions */
2270 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2272 static Lisp_Object
2273 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2275 double f1 = 0, f2 = 0;
2276 bool floatp = 0;
2278 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2279 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2281 if (FLOATP (num1) || FLOATP (num2))
2283 floatp = 1;
2284 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2285 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2288 switch (comparison)
2290 case equal:
2291 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2292 return Qt;
2293 return Qnil;
2295 case notequal:
2296 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2297 return Qt;
2298 return Qnil;
2300 case less:
2301 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2302 return Qt;
2303 return Qnil;
2305 case less_or_equal:
2306 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2307 return Qt;
2308 return Qnil;
2310 case grtr:
2311 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2312 return Qt;
2313 return Qnil;
2315 case grtr_or_equal:
2316 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2317 return Qt;
2318 return Qnil;
2320 default:
2321 emacs_abort ();
2325 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2326 doc: /* Return t if two args, both numbers or markers, are equal. */)
2327 (register Lisp_Object num1, Lisp_Object num2)
2329 return arithcompare (num1, num2, equal);
2332 DEFUN ("<", Flss, Slss, 2, 2, 0,
2333 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2334 (register Lisp_Object num1, Lisp_Object num2)
2336 return arithcompare (num1, num2, less);
2339 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2340 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2341 (register Lisp_Object num1, Lisp_Object num2)
2343 return arithcompare (num1, num2, grtr);
2346 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2347 doc: /* Return t if first arg is less than or equal to second arg.
2348 Both must be numbers or markers. */)
2349 (register Lisp_Object num1, Lisp_Object num2)
2351 return arithcompare (num1, num2, less_or_equal);
2354 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2355 doc: /* Return t if first arg is greater than or equal to second arg.
2356 Both must be numbers or markers. */)
2357 (register Lisp_Object num1, Lisp_Object num2)
2359 return arithcompare (num1, num2, grtr_or_equal);
2362 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2363 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2364 (register Lisp_Object num1, Lisp_Object num2)
2366 return arithcompare (num1, num2, notequal);
2369 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2370 doc: /* Return t if NUMBER is zero. */)
2371 (register Lisp_Object number)
2373 CHECK_NUMBER_OR_FLOAT (number);
2375 if (FLOATP (number))
2377 if (XFLOAT_DATA (number) == 0.0)
2378 return Qt;
2379 return Qnil;
2382 if (!XINT (number))
2383 return Qt;
2384 return Qnil;
2387 /* Convert the cons-of-integers, integer, or float value C to an
2388 unsigned value with maximum value MAX. Signal an error if C does not
2389 have a valid format or is out of range. */
2390 uintmax_t
2391 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2393 bool valid = 0;
2394 uintmax_t val IF_LINT (= 0);
2395 if (INTEGERP (c))
2397 valid = 0 <= XINT (c);
2398 val = XINT (c);
2400 else if (FLOATP (c))
2402 double d = XFLOAT_DATA (c);
2403 if (0 <= d
2404 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2406 val = d;
2407 valid = 1;
2410 else if (CONSP (c) && NATNUMP (XCAR (c)))
2412 uintmax_t top = XFASTINT (XCAR (c));
2413 Lisp_Object rest = XCDR (c);
2414 if (top <= UINTMAX_MAX >> 24 >> 16
2415 && CONSP (rest)
2416 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2417 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2419 uintmax_t mid = XFASTINT (XCAR (rest));
2420 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2421 valid = 1;
2423 else if (top <= UINTMAX_MAX >> 16)
2425 if (CONSP (rest))
2426 rest = XCAR (rest);
2427 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2429 val = top << 16 | XFASTINT (rest);
2430 valid = 1;
2435 if (! (valid && val <= max))
2436 error ("Not an in-range integer, float, or cons of integers");
2437 return val;
2440 /* Convert the cons-of-integers, integer, or float value C to a signed
2441 value with extrema MIN and MAX. Signal an error if C does not have
2442 a valid format or is out of range. */
2443 intmax_t
2444 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2446 bool valid = 0;
2447 intmax_t val IF_LINT (= 0);
2448 if (INTEGERP (c))
2450 val = XINT (c);
2451 valid = 1;
2453 else if (FLOATP (c))
2455 double d = XFLOAT_DATA (c);
2456 if (min <= d
2457 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2459 val = d;
2460 valid = 1;
2463 else if (CONSP (c) && INTEGERP (XCAR (c)))
2465 intmax_t top = XINT (XCAR (c));
2466 Lisp_Object rest = XCDR (c);
2467 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2468 && CONSP (rest)
2469 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2470 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2472 intmax_t mid = XFASTINT (XCAR (rest));
2473 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2474 valid = 1;
2476 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2478 if (CONSP (rest))
2479 rest = XCAR (rest);
2480 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2482 val = top << 16 | XFASTINT (rest);
2483 valid = 1;
2488 if (! (valid && min <= val && val <= max))
2489 error ("Not an in-range integer, float, or cons of integers");
2490 return val;
2493 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2494 doc: /* Return the decimal representation of NUMBER as a string.
2495 Uses a minus sign if negative.
2496 NUMBER may be an integer or a floating point number. */)
2497 (Lisp_Object number)
2499 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2500 int len;
2502 CHECK_NUMBER_OR_FLOAT (number);
2504 if (FLOATP (number))
2505 len = float_to_string (buffer, XFLOAT_DATA (number));
2506 else
2507 len = sprintf (buffer, "%"pI"d", XINT (number));
2509 return make_unibyte_string (buffer, len);
2512 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2513 doc: /* Parse STRING as a decimal number and return the number.
2514 This parses both integers and floating point numbers.
2515 It ignores leading spaces and tabs, and all trailing chars.
2517 If BASE, interpret STRING as a number in that base. If BASE isn't
2518 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2519 If the base used is not 10, STRING is always parsed as integer. */)
2520 (register Lisp_Object string, Lisp_Object base)
2522 register char *p;
2523 register int b;
2524 Lisp_Object val;
2526 CHECK_STRING (string);
2528 if (NILP (base))
2529 b = 10;
2530 else
2532 CHECK_NUMBER (base);
2533 if (! (2 <= XINT (base) && XINT (base) <= 16))
2534 xsignal1 (Qargs_out_of_range, base);
2535 b = XINT (base);
2538 p = SSDATA (string);
2539 while (*p == ' ' || *p == '\t')
2540 p++;
2542 val = string_to_number (p, b, 1);
2543 return NILP (val) ? make_number (0) : val;
2546 enum arithop
2548 Aadd,
2549 Asub,
2550 Amult,
2551 Adiv,
2552 Alogand,
2553 Alogior,
2554 Alogxor,
2555 Amax,
2556 Amin
2559 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2560 ptrdiff_t, Lisp_Object *);
2561 static Lisp_Object
2562 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2564 Lisp_Object val;
2565 ptrdiff_t argnum, ok_args;
2566 EMACS_INT accum = 0;
2567 EMACS_INT next, ok_accum;
2568 bool overflow = 0;
2570 switch (code)
2572 case Alogior:
2573 case Alogxor:
2574 case Aadd:
2575 case Asub:
2576 accum = 0;
2577 break;
2578 case Amult:
2579 accum = 1;
2580 break;
2581 case Alogand:
2582 accum = -1;
2583 break;
2584 default:
2585 break;
2588 for (argnum = 0; argnum < nargs; argnum++)
2590 if (! overflow)
2592 ok_args = argnum;
2593 ok_accum = accum;
2596 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2597 val = args[argnum];
2598 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2600 if (FLOATP (val))
2601 return float_arith_driver (ok_accum, ok_args, code,
2602 nargs, args);
2603 args[argnum] = val;
2604 next = XINT (args[argnum]);
2605 switch (code)
2607 case Aadd:
2608 if (INT_ADD_OVERFLOW (accum, next))
2610 overflow = 1;
2611 accum &= INTMASK;
2613 accum += next;
2614 break;
2615 case Asub:
2616 if (INT_SUBTRACT_OVERFLOW (accum, next))
2618 overflow = 1;
2619 accum &= INTMASK;
2621 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2622 break;
2623 case Amult:
2624 if (INT_MULTIPLY_OVERFLOW (accum, next))
2626 EMACS_UINT a = accum, b = next, ab = a * b;
2627 overflow = 1;
2628 accum = ab & INTMASK;
2630 else
2631 accum *= next;
2632 break;
2633 case Adiv:
2634 if (!argnum)
2635 accum = next;
2636 else
2638 if (next == 0)
2639 xsignal0 (Qarith_error);
2640 accum /= next;
2642 break;
2643 case Alogand:
2644 accum &= next;
2645 break;
2646 case Alogior:
2647 accum |= next;
2648 break;
2649 case Alogxor:
2650 accum ^= next;
2651 break;
2652 case Amax:
2653 if (!argnum || next > accum)
2654 accum = next;
2655 break;
2656 case Amin:
2657 if (!argnum || next < accum)
2658 accum = next;
2659 break;
2663 XSETINT (val, accum);
2664 return val;
2667 #undef isnan
2668 #define isnan(x) ((x) != (x))
2670 static Lisp_Object
2671 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2672 ptrdiff_t nargs, Lisp_Object *args)
2674 register Lisp_Object val;
2675 double next;
2677 for (; argnum < nargs; argnum++)
2679 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2680 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2682 if (FLOATP (val))
2684 next = XFLOAT_DATA (val);
2686 else
2688 args[argnum] = val; /* runs into a compiler bug. */
2689 next = XINT (args[argnum]);
2691 switch (code)
2693 case Aadd:
2694 accum += next;
2695 break;
2696 case Asub:
2697 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2698 break;
2699 case Amult:
2700 accum *= next;
2701 break;
2702 case Adiv:
2703 if (!argnum)
2704 accum = next;
2705 else
2707 if (! IEEE_FLOATING_POINT && next == 0)
2708 xsignal0 (Qarith_error);
2709 accum /= next;
2711 break;
2712 case Alogand:
2713 case Alogior:
2714 case Alogxor:
2715 return wrong_type_argument (Qinteger_or_marker_p, val);
2716 case Amax:
2717 if (!argnum || isnan (next) || next > accum)
2718 accum = next;
2719 break;
2720 case Amin:
2721 if (!argnum || isnan (next) || next < accum)
2722 accum = next;
2723 break;
2727 return make_float (accum);
2731 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2732 doc: /* Return sum of any number of arguments, which are numbers or markers.
2733 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2734 (ptrdiff_t nargs, Lisp_Object *args)
2736 return arith_driver (Aadd, nargs, args);
2739 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2740 doc: /* Negate number or subtract numbers or markers and return the result.
2741 With one arg, negates it. With more than one arg,
2742 subtracts all but the first from the first.
2743 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2744 (ptrdiff_t nargs, Lisp_Object *args)
2746 return arith_driver (Asub, nargs, args);
2749 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2750 doc: /* Return product of any number of arguments, which are numbers or markers.
2751 usage: (* &rest NUMBERS-OR-MARKERS) */)
2752 (ptrdiff_t nargs, Lisp_Object *args)
2754 return arith_driver (Amult, nargs, args);
2757 DEFUN ("/", Fquo, Squo, 1, MANY, 0,
2758 doc: /* Return first argument divided by all the remaining arguments.
2759 The arguments must be numbers or markers.
2760 usage: (/ DIVIDEND &rest DIVISORS) */)
2761 (ptrdiff_t nargs, Lisp_Object *args)
2763 ptrdiff_t argnum;
2764 for (argnum = 2; argnum < nargs; argnum++)
2765 if (FLOATP (args[argnum]))
2766 return float_arith_driver (0, 0, Adiv, nargs, args);
2767 return arith_driver (Adiv, nargs, args);
2770 DEFUN ("%", Frem, Srem, 2, 2, 0,
2771 doc: /* Return remainder of X divided by Y.
2772 Both must be integers or markers. */)
2773 (register Lisp_Object x, Lisp_Object y)
2775 Lisp_Object val;
2777 CHECK_NUMBER_COERCE_MARKER (x);
2778 CHECK_NUMBER_COERCE_MARKER (y);
2780 if (XINT (y) == 0)
2781 xsignal0 (Qarith_error);
2783 XSETINT (val, XINT (x) % XINT (y));
2784 return val;
2787 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2788 doc: /* Return X modulo Y.
2789 The result falls between zero (inclusive) and Y (exclusive).
2790 Both X and Y must be numbers or markers. */)
2791 (register Lisp_Object x, Lisp_Object y)
2793 Lisp_Object val;
2794 EMACS_INT i1, i2;
2796 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2797 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2799 if (FLOATP (x) || FLOATP (y))
2800 return fmod_float (x, y);
2802 i1 = XINT (x);
2803 i2 = XINT (y);
2805 if (i2 == 0)
2806 xsignal0 (Qarith_error);
2808 i1 %= i2;
2810 /* If the "remainder" comes out with the wrong sign, fix it. */
2811 if (i2 < 0 ? i1 > 0 : i1 < 0)
2812 i1 += i2;
2814 XSETINT (val, i1);
2815 return val;
2818 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2819 doc: /* Return largest of all the arguments (which must be numbers or markers).
2820 The value is always a number; markers are converted to numbers.
2821 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2822 (ptrdiff_t nargs, Lisp_Object *args)
2824 return arith_driver (Amax, nargs, args);
2827 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2828 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2829 The value is always a number; markers are converted to numbers.
2830 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2831 (ptrdiff_t nargs, Lisp_Object *args)
2833 return arith_driver (Amin, nargs, args);
2836 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2837 doc: /* Return bitwise-and of all the arguments.
2838 Arguments may be integers, or markers converted to integers.
2839 usage: (logand &rest INTS-OR-MARKERS) */)
2840 (ptrdiff_t nargs, Lisp_Object *args)
2842 return arith_driver (Alogand, nargs, args);
2845 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2846 doc: /* Return bitwise-or of all the arguments.
2847 Arguments may be integers, or markers converted to integers.
2848 usage: (logior &rest INTS-OR-MARKERS) */)
2849 (ptrdiff_t nargs, Lisp_Object *args)
2851 return arith_driver (Alogior, nargs, args);
2854 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2855 doc: /* Return bitwise-exclusive-or of all the arguments.
2856 Arguments may be integers, or markers converted to integers.
2857 usage: (logxor &rest INTS-OR-MARKERS) */)
2858 (ptrdiff_t nargs, Lisp_Object *args)
2860 return arith_driver (Alogxor, nargs, args);
2863 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2864 doc: /* Return VALUE with its bits shifted left by COUNT.
2865 If COUNT is negative, shifting is actually to the right.
2866 In this case, the sign bit is duplicated. */)
2867 (register Lisp_Object value, Lisp_Object count)
2869 register Lisp_Object val;
2871 CHECK_NUMBER (value);
2872 CHECK_NUMBER (count);
2874 if (XINT (count) >= BITS_PER_EMACS_INT)
2875 XSETINT (val, 0);
2876 else if (XINT (count) > 0)
2877 XSETINT (val, XINT (value) << XFASTINT (count));
2878 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2879 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2880 else
2881 XSETINT (val, XINT (value) >> -XINT (count));
2882 return val;
2885 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2886 doc: /* Return VALUE with its bits shifted left by COUNT.
2887 If COUNT is negative, shifting is actually to the right.
2888 In this case, zeros are shifted in on the left. */)
2889 (register Lisp_Object value, Lisp_Object count)
2891 register Lisp_Object val;
2893 CHECK_NUMBER (value);
2894 CHECK_NUMBER (count);
2896 if (XINT (count) >= BITS_PER_EMACS_INT)
2897 XSETINT (val, 0);
2898 else if (XINT (count) > 0)
2899 XSETINT (val, XUINT (value) << XFASTINT (count));
2900 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2901 XSETINT (val, 0);
2902 else
2903 XSETINT (val, XUINT (value) >> -XINT (count));
2904 return val;
2907 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2908 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2909 Markers are converted to integers. */)
2910 (register Lisp_Object number)
2912 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2914 if (FLOATP (number))
2915 return (make_float (1.0 + XFLOAT_DATA (number)));
2917 XSETINT (number, XINT (number) + 1);
2918 return number;
2921 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2922 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2923 Markers are converted to integers. */)
2924 (register Lisp_Object number)
2926 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2928 if (FLOATP (number))
2929 return (make_float (-1.0 + XFLOAT_DATA (number)));
2931 XSETINT (number, XINT (number) - 1);
2932 return number;
2935 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2936 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2937 (register Lisp_Object number)
2939 CHECK_NUMBER (number);
2940 XSETINT (number, ~XINT (number));
2941 return number;
2944 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2945 doc: /* Return the byteorder for the machine.
2946 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2947 lowercase l) for small endian machines. */)
2948 (void)
2950 unsigned i = 0x04030201;
2951 int order = *(char *)&i == 1 ? 108 : 66;
2953 return make_number (order);
2958 void
2959 syms_of_data (void)
2961 Lisp_Object error_tail, arith_tail;
2963 DEFSYM (Qquote, "quote");
2964 DEFSYM (Qlambda, "lambda");
2965 DEFSYM (Qsubr, "subr");
2966 DEFSYM (Qerror_conditions, "error-conditions");
2967 DEFSYM (Qerror_message, "error-message");
2968 DEFSYM (Qtop_level, "top-level");
2970 DEFSYM (Qerror, "error");
2971 DEFSYM (Quser_error, "user-error");
2972 DEFSYM (Qquit, "quit");
2973 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2974 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2975 DEFSYM (Qvoid_function, "void-function");
2976 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2977 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2978 DEFSYM (Qvoid_variable, "void-variable");
2979 DEFSYM (Qsetting_constant, "setting-constant");
2980 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2982 DEFSYM (Qinvalid_function, "invalid-function");
2983 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2984 DEFSYM (Qno_catch, "no-catch");
2985 DEFSYM (Qend_of_file, "end-of-file");
2986 DEFSYM (Qarith_error, "arith-error");
2987 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2988 DEFSYM (Qend_of_buffer, "end-of-buffer");
2989 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2990 DEFSYM (Qtext_read_only, "text-read-only");
2991 DEFSYM (Qmark_inactive, "mark-inactive");
2993 DEFSYM (Qlistp, "listp");
2994 DEFSYM (Qconsp, "consp");
2995 DEFSYM (Qsymbolp, "symbolp");
2996 DEFSYM (Qkeywordp, "keywordp");
2997 DEFSYM (Qintegerp, "integerp");
2998 DEFSYM (Qnatnump, "natnump");
2999 DEFSYM (Qwholenump, "wholenump");
3000 DEFSYM (Qstringp, "stringp");
3001 DEFSYM (Qarrayp, "arrayp");
3002 DEFSYM (Qsequencep, "sequencep");
3003 DEFSYM (Qbufferp, "bufferp");
3004 DEFSYM (Qvectorp, "vectorp");
3005 DEFSYM (Qchar_or_string_p, "char-or-string-p");
3006 DEFSYM (Qmarkerp, "markerp");
3007 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
3008 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
3009 DEFSYM (Qboundp, "boundp");
3010 DEFSYM (Qfboundp, "fboundp");
3012 DEFSYM (Qfloatp, "floatp");
3013 DEFSYM (Qnumberp, "numberp");
3014 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
3016 DEFSYM (Qchar_table_p, "char-table-p");
3017 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
3019 DEFSYM (Qsubrp, "subrp");
3020 DEFSYM (Qunevalled, "unevalled");
3021 DEFSYM (Qmany, "many");
3023 DEFSYM (Qcdr, "cdr");
3025 /* Handle automatic advice activation. */
3026 DEFSYM (Qad_advice_info, "ad-advice-info");
3027 DEFSYM (Qad_activate_internal, "ad-activate-internal");
3029 error_tail = pure_cons (Qerror, Qnil);
3031 /* ERROR is used as a signaler for random errors for which nothing else is
3032 right. */
3034 Fput (Qerror, Qerror_conditions,
3035 error_tail);
3036 Fput (Qerror, Qerror_message,
3037 build_pure_c_string ("error"));
3039 #define PUT_ERROR(sym, tail, msg) \
3040 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3041 Fput (sym, Qerror_message, build_pure_c_string (msg))
3043 PUT_ERROR (Qquit, Qnil, "Quit");
3045 PUT_ERROR (Quser_error, error_tail, "");
3046 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3047 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3048 PUT_ERROR (Qvoid_function, error_tail,
3049 "Symbol's function definition is void");
3050 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3051 "Symbol's chain of function indirections contains a loop");
3052 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3053 "Symbol's chain of variable indirections contains a loop");
3054 DEFSYM (Qcircular_list, "circular-list");
3055 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3056 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3057 PUT_ERROR (Qsetting_constant, error_tail,
3058 "Attempt to set a constant symbol");
3059 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3060 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3061 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3062 "Wrong number of arguments");
3063 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3064 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3066 arith_tail = pure_cons (Qarith_error, error_tail);
3067 Fput (Qarith_error, Qerror_conditions, arith_tail);
3068 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3070 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3071 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3072 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3073 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3074 "Text is read-only");
3076 DEFSYM (Qrange_error, "range-error");
3077 DEFSYM (Qdomain_error, "domain-error");
3078 DEFSYM (Qsingularity_error, "singularity-error");
3079 DEFSYM (Qoverflow_error, "overflow-error");
3080 DEFSYM (Qunderflow_error, "underflow-error");
3082 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3084 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3086 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3087 "Arithmetic singularity error");
3089 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3090 "Arithmetic overflow error");
3091 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3092 "Arithmetic underflow error");
3094 staticpro (&Qnil);
3095 staticpro (&Qt);
3096 staticpro (&Qunbound);
3098 /* Types that type-of returns. */
3099 DEFSYM (Qinteger, "integer");
3100 DEFSYM (Qsymbol, "symbol");
3101 DEFSYM (Qstring, "string");
3102 DEFSYM (Qcons, "cons");
3103 DEFSYM (Qmarker, "marker");
3104 DEFSYM (Qoverlay, "overlay");
3105 DEFSYM (Qfloat, "float");
3106 DEFSYM (Qwindow_configuration, "window-configuration");
3107 DEFSYM (Qprocess, "process");
3108 DEFSYM (Qwindow, "window");
3109 DEFSYM (Qcompiled_function, "compiled-function");
3110 DEFSYM (Qbuffer, "buffer");
3111 DEFSYM (Qframe, "frame");
3112 DEFSYM (Qvector, "vector");
3113 DEFSYM (Qchar_table, "char-table");
3114 DEFSYM (Qbool_vector, "bool-vector");
3115 DEFSYM (Qhash_table, "hash-table");
3116 DEFSYM (Qmisc, "misc");
3118 DEFSYM (Qdefun, "defun");
3120 DEFSYM (Qfont_spec, "font-spec");
3121 DEFSYM (Qfont_entity, "font-entity");
3122 DEFSYM (Qfont_object, "font-object");
3124 DEFSYM (Qinteractive_form, "interactive-form");
3125 DEFSYM (Qdefalias_fset_function, "defalias-fset-function");
3127 defsubr (&Sindirect_variable);
3128 defsubr (&Sinteractive_form);
3129 defsubr (&Seq);
3130 defsubr (&Snull);
3131 defsubr (&Stype_of);
3132 defsubr (&Slistp);
3133 defsubr (&Snlistp);
3134 defsubr (&Sconsp);
3135 defsubr (&Satom);
3136 defsubr (&Sintegerp);
3137 defsubr (&Sinteger_or_marker_p);
3138 defsubr (&Snumberp);
3139 defsubr (&Snumber_or_marker_p);
3140 defsubr (&Sfloatp);
3141 defsubr (&Snatnump);
3142 defsubr (&Ssymbolp);
3143 defsubr (&Skeywordp);
3144 defsubr (&Sstringp);
3145 defsubr (&Smultibyte_string_p);
3146 defsubr (&Svectorp);
3147 defsubr (&Schar_table_p);
3148 defsubr (&Svector_or_char_table_p);
3149 defsubr (&Sbool_vector_p);
3150 defsubr (&Sarrayp);
3151 defsubr (&Ssequencep);
3152 defsubr (&Sbufferp);
3153 defsubr (&Smarkerp);
3154 defsubr (&Ssubrp);
3155 defsubr (&Sbyte_code_function_p);
3156 defsubr (&Schar_or_string_p);
3157 defsubr (&Scar);
3158 defsubr (&Scdr);
3159 defsubr (&Scar_safe);
3160 defsubr (&Scdr_safe);
3161 defsubr (&Ssetcar);
3162 defsubr (&Ssetcdr);
3163 defsubr (&Ssymbol_function);
3164 defsubr (&Sindirect_function);
3165 defsubr (&Ssymbol_plist);
3166 defsubr (&Ssymbol_name);
3167 defsubr (&Smakunbound);
3168 defsubr (&Sfmakunbound);
3169 defsubr (&Sboundp);
3170 defsubr (&Sfboundp);
3171 defsubr (&Sfset);
3172 defsubr (&Sdefalias);
3173 defsubr (&Ssetplist);
3174 defsubr (&Ssymbol_value);
3175 defsubr (&Sset);
3176 defsubr (&Sdefault_boundp);
3177 defsubr (&Sdefault_value);
3178 defsubr (&Sset_default);
3179 defsubr (&Ssetq_default);
3180 defsubr (&Smake_variable_buffer_local);
3181 defsubr (&Smake_local_variable);
3182 defsubr (&Skill_local_variable);
3183 defsubr (&Smake_variable_frame_local);
3184 defsubr (&Slocal_variable_p);
3185 defsubr (&Slocal_variable_if_set_p);
3186 defsubr (&Svariable_binding_locus);
3187 #if 0 /* XXX Remove this. --lorentey */
3188 defsubr (&Sterminal_local_value);
3189 defsubr (&Sset_terminal_local_value);
3190 #endif
3191 defsubr (&Saref);
3192 defsubr (&Saset);
3193 defsubr (&Snumber_to_string);
3194 defsubr (&Sstring_to_number);
3195 defsubr (&Seqlsign);
3196 defsubr (&Slss);
3197 defsubr (&Sgtr);
3198 defsubr (&Sleq);
3199 defsubr (&Sgeq);
3200 defsubr (&Sneq);
3201 defsubr (&Szerop);
3202 defsubr (&Splus);
3203 defsubr (&Sminus);
3204 defsubr (&Stimes);
3205 defsubr (&Squo);
3206 defsubr (&Srem);
3207 defsubr (&Smod);
3208 defsubr (&Smax);
3209 defsubr (&Smin);
3210 defsubr (&Slogand);
3211 defsubr (&Slogior);
3212 defsubr (&Slogxor);
3213 defsubr (&Slsh);
3214 defsubr (&Sash);
3215 defsubr (&Sadd1);
3216 defsubr (&Ssub1);
3217 defsubr (&Slognot);
3218 defsubr (&Sbyteorder);
3219 defsubr (&Ssubr_arity);
3220 defsubr (&Ssubr_name);
3222 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3224 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3225 doc: /* The largest value that is representable in a Lisp integer. */);
3226 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3227 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3229 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3230 doc: /* The smallest value that is representable in a Lisp integer. */);
3231 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3232 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;