Fix previous commit.
[emacs.git] / src / data.c
blob9f4bd1f1c027da39d2edc79102e0bc8e38b9a533
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, buf;
986 if (idx <= 0)
987 break;
989 FOR_EACH_LIVE_BUFFER (tail, buf)
991 struct buffer *b = XBUFFER (buf);
993 if (! PER_BUFFER_VALUE_P (b, idx))
994 set_per_buffer_value (b, offset, newval);
997 break;
999 case Lisp_Fwd_Buffer_Obj:
1001 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1002 Lisp_Object predicate = XBUFFER_OBJFWD (valcontents)->predicate;
1004 if (!NILP (predicate) && !NILP (newval)
1005 && NILP (call1 (predicate, newval)))
1006 wrong_type_argument (predicate, newval);
1008 if (buf == NULL)
1009 buf = current_buffer;
1010 set_per_buffer_value (buf, offset, newval);
1012 break;
1014 case Lisp_Fwd_Kboard_Obj:
1016 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
1017 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
1018 *(Lisp_Object *) p = newval;
1020 break;
1022 default:
1023 emacs_abort (); /* goto def; */
1027 /* Set up SYMBOL to refer to its global binding. This makes it safe
1028 to alter the status of other bindings. BEWARE: this may be called
1029 during the mark phase of GC, where we assume that Lisp_Object slots
1030 of BLV are marked after this function has changed them. */
1032 void
1033 swap_in_global_binding (struct Lisp_Symbol *symbol)
1035 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
1037 /* Unload the previously loaded binding. */
1038 if (blv->fwd)
1039 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1041 /* Select the global binding in the symbol. */
1042 set_blv_valcell (blv, blv->defcell);
1043 if (blv->fwd)
1044 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
1046 /* Indicate that the global binding is set up now. */
1047 set_blv_where (blv, Qnil);
1048 set_blv_found (blv, 0);
1051 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
1052 VALCONTENTS is the contents of its value cell,
1053 which points to a struct Lisp_Buffer_Local_Value.
1055 Return the value forwarded one step past the buffer-local stage.
1056 This could be another forwarding pointer. */
1058 static void
1059 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1061 register Lisp_Object tem1;
1063 eassert (blv == SYMBOL_BLV (symbol));
1065 tem1 = blv->where;
1067 if (NILP (tem1)
1068 || (blv->frame_local
1069 ? !EQ (selected_frame, tem1)
1070 : current_buffer != XBUFFER (tem1)))
1073 /* Unload the previously loaded binding. */
1074 tem1 = blv->valcell;
1075 if (blv->fwd)
1076 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1077 /* Choose the new binding. */
1079 Lisp_Object var;
1080 XSETSYMBOL (var, symbol);
1081 if (blv->frame_local)
1083 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1084 set_blv_where (blv, selected_frame);
1086 else
1088 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1089 set_blv_where (blv, Fcurrent_buffer ());
1092 if (!(blv->found = !NILP (tem1)))
1093 tem1 = blv->defcell;
1095 /* Load the new binding. */
1096 set_blv_valcell (blv, tem1);
1097 if (blv->fwd)
1098 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1102 /* Find the value of a symbol, returning Qunbound if it's not bound.
1103 This is helpful for code which just wants to get a variable's value
1104 if it has one, without signaling an error.
1105 Note that it must not be possible to quit
1106 within this function. Great care is required for this. */
1108 Lisp_Object
1109 find_symbol_value (Lisp_Object symbol)
1111 struct Lisp_Symbol *sym;
1113 CHECK_SYMBOL (symbol);
1114 sym = XSYMBOL (symbol);
1116 start:
1117 switch (sym->redirect)
1119 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1120 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1121 case SYMBOL_LOCALIZED:
1123 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1124 swap_in_symval_forwarding (sym, blv);
1125 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1127 /* FALLTHROUGH */
1128 case SYMBOL_FORWARDED:
1129 return do_symval_forwarding (SYMBOL_FWD (sym));
1130 default: emacs_abort ();
1134 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1135 doc: /* Return SYMBOL's value. Error if that is void.
1136 Note that if `lexical-binding' is in effect, this returns the
1137 global value outside of any lexical scope. */)
1138 (Lisp_Object symbol)
1140 Lisp_Object val;
1142 val = find_symbol_value (symbol);
1143 if (!EQ (val, Qunbound))
1144 return val;
1146 xsignal1 (Qvoid_variable, symbol);
1149 DEFUN ("set", Fset, Sset, 2, 2, 0,
1150 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1151 (register Lisp_Object symbol, Lisp_Object newval)
1153 set_internal (symbol, newval, Qnil, 0);
1154 return newval;
1157 /* Store the value NEWVAL into SYMBOL.
1158 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1159 (nil stands for the current buffer/frame).
1161 If BINDFLAG is false, then if this symbol is supposed to become
1162 local in every buffer where it is set, then we make it local.
1163 If BINDFLAG is true, we don't do that. */
1165 void
1166 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1167 bool bindflag)
1169 bool voide = EQ (newval, Qunbound);
1170 struct Lisp_Symbol *sym;
1171 Lisp_Object tem1;
1173 /* If restoring in a dead buffer, do nothing. */
1174 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1175 return; */
1177 CHECK_SYMBOL (symbol);
1178 if (SYMBOL_CONSTANT_P (symbol))
1180 if (NILP (Fkeywordp (symbol))
1181 || !EQ (newval, Fsymbol_value (symbol)))
1182 xsignal1 (Qsetting_constant, symbol);
1183 else
1184 /* Allow setting keywords to their own value. */
1185 return;
1188 sym = XSYMBOL (symbol);
1190 start:
1191 switch (sym->redirect)
1193 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1194 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1195 case SYMBOL_LOCALIZED:
1197 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1198 if (NILP (where))
1200 if (blv->frame_local)
1201 where = selected_frame;
1202 else
1203 XSETBUFFER (where, current_buffer);
1205 /* If the current buffer is not the buffer whose binding is
1206 loaded, or if there may be frame-local bindings and the frame
1207 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1208 the default binding is loaded, the loaded binding may be the
1209 wrong one. */
1210 if (!EQ (blv->where, where)
1211 /* Also unload a global binding (if the var is local_if_set). */
1212 || (EQ (blv->valcell, blv->defcell)))
1214 /* The currently loaded binding is not necessarily valid.
1215 We need to unload it, and choose a new binding. */
1217 /* Write out `realvalue' to the old loaded binding. */
1218 if (blv->fwd)
1219 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1221 /* Find the new binding. */
1222 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1223 tem1 = Fassq (symbol,
1224 (blv->frame_local
1225 ? XFRAME (where)->param_alist
1226 : BVAR (XBUFFER (where), local_var_alist)));
1227 set_blv_where (blv, where);
1228 blv->found = 1;
1230 if (NILP (tem1))
1232 /* This buffer still sees the default value. */
1234 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1235 or if this is `let' rather than `set',
1236 make CURRENT-ALIST-ELEMENT point to itself,
1237 indicating that we're seeing the default value.
1238 Likewise if the variable has been let-bound
1239 in the current buffer. */
1240 if (bindflag || !blv->local_if_set
1241 || let_shadows_buffer_binding_p (sym))
1243 blv->found = 0;
1244 tem1 = blv->defcell;
1246 /* If it's a local_if_set, being set not bound,
1247 and we're not within a let that was made for this buffer,
1248 create a new buffer-local binding for the variable.
1249 That means, give this buffer a new assoc for a local value
1250 and load that binding. */
1251 else
1253 /* local_if_set is only supported for buffer-local
1254 bindings, not for frame-local bindings. */
1255 eassert (!blv->frame_local);
1256 tem1 = Fcons (symbol, XCDR (blv->defcell));
1257 bset_local_var_alist
1258 (XBUFFER (where),
1259 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1263 /* Record which binding is now loaded. */
1264 set_blv_valcell (blv, tem1);
1267 /* Store the new value in the cons cell. */
1268 set_blv_value (blv, newval);
1270 if (blv->fwd)
1272 if (voide)
1273 /* If storing void (making the symbol void), forward only through
1274 buffer-local indicator, not through Lisp_Objfwd, etc. */
1275 blv->fwd = NULL;
1276 else
1277 store_symval_forwarding (blv->fwd, newval,
1278 BUFFERP (where)
1279 ? XBUFFER (where) : current_buffer);
1281 break;
1283 case SYMBOL_FORWARDED:
1285 struct buffer *buf
1286 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1287 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1288 if (BUFFER_OBJFWDP (innercontents))
1290 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1291 int idx = PER_BUFFER_IDX (offset);
1292 if (idx > 0
1293 && !bindflag
1294 && !let_shadows_buffer_binding_p (sym))
1295 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1298 if (voide)
1299 { /* If storing void (making the symbol void), forward only through
1300 buffer-local indicator, not through Lisp_Objfwd, etc. */
1301 sym->redirect = SYMBOL_PLAINVAL;
1302 SET_SYMBOL_VAL (sym, newval);
1304 else
1305 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1306 break;
1308 default: emacs_abort ();
1310 return;
1313 /* Access or set a buffer-local symbol's default value. */
1315 /* Return the default value of SYMBOL, but don't check for voidness.
1316 Return Qunbound if it is void. */
1318 static Lisp_Object
1319 default_value (Lisp_Object symbol)
1321 struct Lisp_Symbol *sym;
1323 CHECK_SYMBOL (symbol);
1324 sym = XSYMBOL (symbol);
1326 start:
1327 switch (sym->redirect)
1329 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1330 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1331 case SYMBOL_LOCALIZED:
1333 /* If var is set up for a buffer that lacks a local value for it,
1334 the current value is nominally the default value.
1335 But the `realvalue' slot may be more up to date, since
1336 ordinary setq stores just that slot. So use that. */
1337 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1338 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1339 return do_symval_forwarding (blv->fwd);
1340 else
1341 return XCDR (blv->defcell);
1343 case SYMBOL_FORWARDED:
1345 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1347 /* For a built-in buffer-local variable, get the default value
1348 rather than letting do_symval_forwarding get the current value. */
1349 if (BUFFER_OBJFWDP (valcontents))
1351 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1352 if (PER_BUFFER_IDX (offset) != 0)
1353 return per_buffer_default (offset);
1356 /* For other variables, get the current value. */
1357 return do_symval_forwarding (valcontents);
1359 default: emacs_abort ();
1363 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1364 doc: /* Return t if SYMBOL has a non-void default value.
1365 This is the value that is seen in buffers that do not have their own values
1366 for this variable. */)
1367 (Lisp_Object symbol)
1369 register Lisp_Object value;
1371 value = default_value (symbol);
1372 return (EQ (value, Qunbound) ? Qnil : Qt);
1375 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1376 doc: /* Return SYMBOL's default value.
1377 This is the value that is seen in buffers that do not have their own values
1378 for this variable. The default value is meaningful for variables with
1379 local bindings in certain buffers. */)
1380 (Lisp_Object symbol)
1382 Lisp_Object value = default_value (symbol);
1383 if (!EQ (value, Qunbound))
1384 return value;
1386 xsignal1 (Qvoid_variable, symbol);
1389 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1390 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1391 The default value is seen in buffers that do not have their own values
1392 for this variable. */)
1393 (Lisp_Object symbol, Lisp_Object value)
1395 struct Lisp_Symbol *sym;
1397 CHECK_SYMBOL (symbol);
1398 if (SYMBOL_CONSTANT_P (symbol))
1400 if (NILP (Fkeywordp (symbol))
1401 || !EQ (value, Fdefault_value (symbol)))
1402 xsignal1 (Qsetting_constant, symbol);
1403 else
1404 /* Allow setting keywords to their own value. */
1405 return value;
1407 sym = XSYMBOL (symbol);
1409 start:
1410 switch (sym->redirect)
1412 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1413 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1414 case SYMBOL_LOCALIZED:
1416 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1418 /* Store new value into the DEFAULT-VALUE slot. */
1419 XSETCDR (blv->defcell, value);
1421 /* If the default binding is now loaded, set the REALVALUE slot too. */
1422 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1423 store_symval_forwarding (blv->fwd, value, NULL);
1424 return value;
1426 case SYMBOL_FORWARDED:
1428 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1430 /* Handle variables like case-fold-search that have special slots
1431 in the buffer.
1432 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1433 if (BUFFER_OBJFWDP (valcontents))
1435 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1436 int idx = PER_BUFFER_IDX (offset);
1438 set_per_buffer_default (offset, value);
1440 /* If this variable is not always local in all buffers,
1441 set it in the buffers that don't nominally have a local value. */
1442 if (idx > 0)
1444 struct buffer *b;
1446 FOR_EACH_BUFFER (b)
1447 if (!PER_BUFFER_VALUE_P (b, idx))
1448 set_per_buffer_value (b, offset, value);
1450 return value;
1452 else
1453 return Fset (symbol, value);
1455 default: emacs_abort ();
1459 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1460 doc: /* Set the default value of variable VAR to VALUE.
1461 VAR, the variable name, is literal (not evaluated);
1462 VALUE is an expression: it is evaluated and its value returned.
1463 The default value of a variable is seen in buffers
1464 that do not have their own values for the variable.
1466 More generally, you can use multiple variables and values, as in
1467 (setq-default VAR VALUE VAR VALUE...)
1468 This sets each VAR's default value to the corresponding VALUE.
1469 The VALUE for the Nth VAR can refer to the new default values
1470 of previous VARs.
1471 usage: (setq-default [VAR VALUE]...) */)
1472 (Lisp_Object args)
1474 Lisp_Object args_left, symbol, val;
1475 struct gcpro gcpro1;
1477 args_left = val = args;
1478 GCPRO1 (args);
1480 while (CONSP (args_left))
1482 val = eval_sub (Fcar (XCDR (args_left)));
1483 symbol = XCAR (args_left);
1484 Fset_default (symbol, val);
1485 args_left = Fcdr (XCDR (args_left));
1488 UNGCPRO;
1489 return val;
1492 /* Lisp functions for creating and removing buffer-local variables. */
1494 union Lisp_Val_Fwd
1496 Lisp_Object value;
1497 union Lisp_Fwd *fwd;
1500 static struct Lisp_Buffer_Local_Value *
1501 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1502 union Lisp_Val_Fwd valcontents)
1504 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1505 Lisp_Object symbol;
1506 Lisp_Object tem;
1508 XSETSYMBOL (symbol, sym);
1509 tem = Fcons (symbol, (forwarded
1510 ? do_symval_forwarding (valcontents.fwd)
1511 : valcontents.value));
1513 /* Buffer_Local_Values cannot have as realval a buffer-local
1514 or keyboard-local forwarding. */
1515 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1516 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1517 blv->fwd = forwarded ? valcontents.fwd : NULL;
1518 set_blv_where (blv, Qnil);
1519 blv->frame_local = 0;
1520 blv->local_if_set = 0;
1521 set_blv_defcell (blv, tem);
1522 set_blv_valcell (blv, tem);
1523 set_blv_found (blv, 0);
1524 return blv;
1527 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1528 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1529 doc: /* Make VARIABLE become buffer-local whenever it is set.
1530 At any time, the value for the current buffer is in effect,
1531 unless the variable has never been set in this buffer,
1532 in which case the default value is in effect.
1533 Note that binding the variable with `let', or setting it while
1534 a `let'-style binding made in this buffer is in effect,
1535 does not make the variable buffer-local. Return VARIABLE.
1537 In most cases it is better to use `make-local-variable',
1538 which makes a variable local in just one buffer.
1540 The function `default-value' gets the default value and `set-default' sets it. */)
1541 (register Lisp_Object variable)
1543 struct Lisp_Symbol *sym;
1544 struct Lisp_Buffer_Local_Value *blv = NULL;
1545 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1546 bool forwarded IF_LINT (= 0);
1548 CHECK_SYMBOL (variable);
1549 sym = XSYMBOL (variable);
1551 start:
1552 switch (sym->redirect)
1554 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1555 case SYMBOL_PLAINVAL:
1556 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1557 if (EQ (valcontents.value, Qunbound))
1558 valcontents.value = Qnil;
1559 break;
1560 case SYMBOL_LOCALIZED:
1561 blv = SYMBOL_BLV (sym);
1562 if (blv->frame_local)
1563 error ("Symbol %s may not be buffer-local",
1564 SDATA (SYMBOL_NAME (variable)));
1565 break;
1566 case SYMBOL_FORWARDED:
1567 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1568 if (KBOARD_OBJFWDP (valcontents.fwd))
1569 error ("Symbol %s may not be buffer-local",
1570 SDATA (SYMBOL_NAME (variable)));
1571 else if (BUFFER_OBJFWDP (valcontents.fwd))
1572 return variable;
1573 break;
1574 default: emacs_abort ();
1577 if (sym->constant)
1578 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1580 if (!blv)
1582 blv = make_blv (sym, forwarded, valcontents);
1583 sym->redirect = SYMBOL_LOCALIZED;
1584 SET_SYMBOL_BLV (sym, blv);
1586 Lisp_Object symbol;
1587 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1588 if (let_shadows_global_binding_p (symbol))
1589 message ("Making %s buffer-local while let-bound!",
1590 SDATA (SYMBOL_NAME (variable)));
1594 blv->local_if_set = 1;
1595 return variable;
1598 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1599 1, 1, "vMake Local Variable: ",
1600 doc: /* Make VARIABLE have a separate value in the current buffer.
1601 Other buffers will continue to share a common default value.
1602 \(The buffer-local value of VARIABLE starts out as the same value
1603 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1604 Return VARIABLE.
1606 If the variable is already arranged to become local when set,
1607 this function causes a local value to exist for this buffer,
1608 just as setting the variable would do.
1610 This function returns VARIABLE, and therefore
1611 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1612 works.
1614 See also `make-variable-buffer-local'.
1616 Do not use `make-local-variable' to make a hook variable buffer-local.
1617 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1618 (Lisp_Object variable)
1620 Lisp_Object tem;
1621 bool forwarded IF_LINT (= 0);
1622 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1623 struct Lisp_Symbol *sym;
1624 struct Lisp_Buffer_Local_Value *blv = NULL;
1626 CHECK_SYMBOL (variable);
1627 sym = XSYMBOL (variable);
1629 start:
1630 switch (sym->redirect)
1632 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1633 case SYMBOL_PLAINVAL:
1634 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1635 case SYMBOL_LOCALIZED:
1636 blv = SYMBOL_BLV (sym);
1637 if (blv->frame_local)
1638 error ("Symbol %s may not be buffer-local",
1639 SDATA (SYMBOL_NAME (variable)));
1640 break;
1641 case SYMBOL_FORWARDED:
1642 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1643 if (KBOARD_OBJFWDP (valcontents.fwd))
1644 error ("Symbol %s may not be buffer-local",
1645 SDATA (SYMBOL_NAME (variable)));
1646 break;
1647 default: emacs_abort ();
1650 if (sym->constant)
1651 error ("Symbol %s may not be buffer-local",
1652 SDATA (SYMBOL_NAME (variable)));
1654 if (blv ? blv->local_if_set
1655 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1657 tem = Fboundp (variable);
1658 /* Make sure the symbol has a local value in this particular buffer,
1659 by setting it to the same value it already has. */
1660 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1661 return variable;
1663 if (!blv)
1665 blv = make_blv (sym, forwarded, valcontents);
1666 sym->redirect = SYMBOL_LOCALIZED;
1667 SET_SYMBOL_BLV (sym, blv);
1669 Lisp_Object symbol;
1670 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1671 if (let_shadows_global_binding_p (symbol))
1672 message ("Making %s local to %s while let-bound!",
1673 SDATA (SYMBOL_NAME (variable)),
1674 SDATA (BVAR (current_buffer, name)));
1678 /* Make sure this buffer has its own value of symbol. */
1679 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1680 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1681 if (NILP (tem))
1683 if (let_shadows_buffer_binding_p (sym))
1684 message ("Making %s buffer-local while locally let-bound!",
1685 SDATA (SYMBOL_NAME (variable)));
1687 /* Swap out any local binding for some other buffer, and make
1688 sure the current value is permanently recorded, if it's the
1689 default value. */
1690 find_symbol_value (variable);
1692 bset_local_var_alist
1693 (current_buffer,
1694 Fcons (Fcons (variable, XCDR (blv->defcell)),
1695 BVAR (current_buffer, local_var_alist)));
1697 /* Make sure symbol does not think it is set up for this buffer;
1698 force it to look once again for this buffer's value. */
1699 if (current_buffer == XBUFFER (blv->where))
1700 set_blv_where (blv, Qnil);
1701 set_blv_found (blv, 0);
1704 /* If the symbol forwards into a C variable, then load the binding
1705 for this buffer now. If C code modifies the variable before we
1706 load the binding in, then that new value will clobber the default
1707 binding the next time we unload it. */
1708 if (blv->fwd)
1709 swap_in_symval_forwarding (sym, blv);
1711 return variable;
1714 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1715 1, 1, "vKill Local Variable: ",
1716 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1717 From now on the default value will apply in this buffer. Return VARIABLE. */)
1718 (register Lisp_Object variable)
1720 register Lisp_Object tem;
1721 struct Lisp_Buffer_Local_Value *blv;
1722 struct Lisp_Symbol *sym;
1724 CHECK_SYMBOL (variable);
1725 sym = XSYMBOL (variable);
1727 start:
1728 switch (sym->redirect)
1730 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1731 case SYMBOL_PLAINVAL: return variable;
1732 case SYMBOL_FORWARDED:
1734 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1735 if (BUFFER_OBJFWDP (valcontents))
1737 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1738 int idx = PER_BUFFER_IDX (offset);
1740 if (idx > 0)
1742 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1743 set_per_buffer_value (current_buffer, offset,
1744 per_buffer_default (offset));
1747 return variable;
1749 case SYMBOL_LOCALIZED:
1750 blv = SYMBOL_BLV (sym);
1751 if (blv->frame_local)
1752 return variable;
1753 break;
1754 default: emacs_abort ();
1757 /* Get rid of this buffer's alist element, if any. */
1758 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1759 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1760 if (!NILP (tem))
1761 bset_local_var_alist
1762 (current_buffer,
1763 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1765 /* If the symbol is set up with the current buffer's binding
1766 loaded, recompute its value. We have to do it now, or else
1767 forwarded objects won't work right. */
1769 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1770 if (EQ (buf, blv->where))
1772 set_blv_where (blv, Qnil);
1773 blv->found = 0;
1774 find_symbol_value (variable);
1778 return variable;
1781 /* Lisp functions for creating and removing buffer-local variables. */
1783 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1784 when/if this is removed. */
1786 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1787 1, 1, "vMake Variable Frame Local: ",
1788 doc: /* Enable VARIABLE to have frame-local bindings.
1789 This does not create any frame-local bindings for VARIABLE,
1790 it just makes them possible.
1792 A frame-local binding is actually a frame parameter value.
1793 If a frame F has a value for the frame parameter named VARIABLE,
1794 that also acts as a frame-local binding for VARIABLE in F--
1795 provided this function has been called to enable VARIABLE
1796 to have frame-local bindings at all.
1798 The only way to create a frame-local binding for VARIABLE in a frame
1799 is to set the VARIABLE frame parameter of that frame. See
1800 `modify-frame-parameters' for how to set frame parameters.
1802 Note that since Emacs 23.1, variables cannot be both buffer-local and
1803 frame-local any more (buffer-local bindings used to take precedence over
1804 frame-local bindings). */)
1805 (Lisp_Object variable)
1807 bool forwarded;
1808 union Lisp_Val_Fwd valcontents;
1809 struct Lisp_Symbol *sym;
1810 struct Lisp_Buffer_Local_Value *blv = NULL;
1812 CHECK_SYMBOL (variable);
1813 sym = XSYMBOL (variable);
1815 start:
1816 switch (sym->redirect)
1818 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1819 case SYMBOL_PLAINVAL:
1820 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1821 if (EQ (valcontents.value, Qunbound))
1822 valcontents.value = Qnil;
1823 break;
1824 case SYMBOL_LOCALIZED:
1825 if (SYMBOL_BLV (sym)->frame_local)
1826 return variable;
1827 else
1828 error ("Symbol %s may not be frame-local",
1829 SDATA (SYMBOL_NAME (variable)));
1830 case SYMBOL_FORWARDED:
1831 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1832 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1833 error ("Symbol %s may not be frame-local",
1834 SDATA (SYMBOL_NAME (variable)));
1835 break;
1836 default: emacs_abort ();
1839 if (sym->constant)
1840 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1842 blv = make_blv (sym, forwarded, valcontents);
1843 blv->frame_local = 1;
1844 sym->redirect = SYMBOL_LOCALIZED;
1845 SET_SYMBOL_BLV (sym, blv);
1847 Lisp_Object symbol;
1848 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1849 if (let_shadows_global_binding_p (symbol))
1850 message ("Making %s frame-local while let-bound!",
1851 SDATA (SYMBOL_NAME (variable)));
1853 return variable;
1856 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1857 1, 2, 0,
1858 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1859 BUFFER defaults to the current buffer. */)
1860 (register Lisp_Object variable, Lisp_Object buffer)
1862 register struct buffer *buf;
1863 struct Lisp_Symbol *sym;
1865 if (NILP (buffer))
1866 buf = current_buffer;
1867 else
1869 CHECK_BUFFER (buffer);
1870 buf = XBUFFER (buffer);
1873 CHECK_SYMBOL (variable);
1874 sym = XSYMBOL (variable);
1876 start:
1877 switch (sym->redirect)
1879 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1880 case SYMBOL_PLAINVAL: return Qnil;
1881 case SYMBOL_LOCALIZED:
1883 Lisp_Object tail, elt, tmp;
1884 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1885 XSETBUFFER (tmp, buf);
1886 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1888 if (EQ (blv->where, tmp)) /* The binding is already loaded. */
1889 return blv_found (blv) ? Qt : Qnil;
1890 else
1891 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1893 elt = XCAR (tail);
1894 if (EQ (variable, XCAR (elt)))
1896 eassert (!blv->frame_local);
1897 return Qt;
1900 return Qnil;
1902 case SYMBOL_FORWARDED:
1904 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1905 if (BUFFER_OBJFWDP (valcontents))
1907 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1908 int idx = PER_BUFFER_IDX (offset);
1909 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1910 return Qt;
1912 return Qnil;
1914 default: emacs_abort ();
1918 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1919 1, 2, 0,
1920 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1921 BUFFER defaults to the current buffer.
1923 More precisely, return non-nil if either VARIABLE already has a local
1924 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1925 `make-variable-buffer-local'). */)
1926 (register Lisp_Object variable, Lisp_Object buffer)
1928 struct Lisp_Symbol *sym;
1930 CHECK_SYMBOL (variable);
1931 sym = XSYMBOL (variable);
1933 start:
1934 switch (sym->redirect)
1936 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1937 case SYMBOL_PLAINVAL: return Qnil;
1938 case SYMBOL_LOCALIZED:
1940 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1941 if (blv->local_if_set)
1942 return Qt;
1943 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1944 return Flocal_variable_p (variable, buffer);
1946 case SYMBOL_FORWARDED:
1947 /* All BUFFER_OBJFWD slots become local if they are set. */
1948 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1949 default: emacs_abort ();
1953 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1954 1, 1, 0,
1955 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1956 If the current binding is buffer-local, the value is the current buffer.
1957 If the current binding is frame-local, the value is the selected frame.
1958 If the current binding is global (the default), the value is nil. */)
1959 (register Lisp_Object variable)
1961 struct Lisp_Symbol *sym;
1963 CHECK_SYMBOL (variable);
1964 sym = XSYMBOL (variable);
1966 /* Make sure the current binding is actually swapped in. */
1967 find_symbol_value (variable);
1969 start:
1970 switch (sym->redirect)
1972 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1973 case SYMBOL_PLAINVAL: return Qnil;
1974 case SYMBOL_FORWARDED:
1976 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1977 if (KBOARD_OBJFWDP (valcontents))
1978 return Fframe_terminal (selected_frame);
1979 else if (!BUFFER_OBJFWDP (valcontents))
1980 return Qnil;
1982 /* FALLTHROUGH */
1983 case SYMBOL_LOCALIZED:
1984 /* For a local variable, record both the symbol and which
1985 buffer's or frame's value we are saving. */
1986 if (!NILP (Flocal_variable_p (variable, Qnil)))
1987 return Fcurrent_buffer ();
1988 else if (sym->redirect == SYMBOL_LOCALIZED
1989 && blv_found (SYMBOL_BLV (sym)))
1990 return SYMBOL_BLV (sym)->where;
1991 else
1992 return Qnil;
1993 default: emacs_abort ();
1997 /* This code is disabled now that we use the selected frame to return
1998 keyboard-local-values. */
1999 #if 0
2000 extern struct terminal *get_terminal (Lisp_Object display, int);
2002 DEFUN ("terminal-local-value", Fterminal_local_value,
2003 Sterminal_local_value, 2, 2, 0,
2004 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
2005 If SYMBOL is not a terminal-local variable, then return its normal
2006 value, like `symbol-value'.
2008 TERMINAL may be a terminal object, a frame, or nil (meaning the
2009 selected frame's terminal device). */)
2010 (Lisp_Object symbol, Lisp_Object terminal)
2012 Lisp_Object result;
2013 struct terminal *t = get_terminal (terminal, 1);
2014 push_kboard (t->kboard);
2015 result = Fsymbol_value (symbol);
2016 pop_kboard ();
2017 return result;
2020 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
2021 Sset_terminal_local_value, 3, 3, 0,
2022 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2023 If VARIABLE is not a terminal-local variable, then set its normal
2024 binding, like `set'.
2026 TERMINAL may be a terminal object, a frame, or nil (meaning the
2027 selected frame's terminal device). */)
2028 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2030 Lisp_Object result;
2031 struct terminal *t = get_terminal (terminal, 1);
2032 push_kboard (d->kboard);
2033 result = Fset (symbol, value);
2034 pop_kboard ();
2035 return result;
2037 #endif
2039 /* Find the function at the end of a chain of symbol function indirections. */
2041 /* If OBJECT is a symbol, find the end of its function chain and
2042 return the value found there. If OBJECT is not a symbol, just
2043 return it. If there is a cycle in the function chain, signal a
2044 cyclic-function-indirection error.
2046 This is like Findirect_function, except that it doesn't signal an
2047 error if the chain ends up unbound. */
2048 Lisp_Object
2049 indirect_function (register Lisp_Object object)
2051 Lisp_Object tortoise, hare;
2053 hare = tortoise = object;
2055 for (;;)
2057 if (!SYMBOLP (hare) || NILP (hare))
2058 break;
2059 hare = XSYMBOL (hare)->function;
2060 if (!SYMBOLP (hare) || NILP (hare))
2061 break;
2062 hare = XSYMBOL (hare)->function;
2064 tortoise = XSYMBOL (tortoise)->function;
2066 if (EQ (hare, tortoise))
2067 xsignal1 (Qcyclic_function_indirection, object);
2070 return hare;
2073 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2074 doc: /* Return the function at the end of OBJECT's function chain.
2075 If OBJECT is not a symbol, just return it. Otherwise, follow all
2076 function indirections to find the final function binding and return it.
2077 If the final symbol in the chain is unbound, signal a void-function error.
2078 Optional arg NOERROR non-nil means to return nil instead of signaling.
2079 Signal a cyclic-function-indirection error if there is a loop in the
2080 function chain of symbols. */)
2081 (register Lisp_Object object, Lisp_Object noerror)
2083 Lisp_Object result;
2085 /* Optimize for no indirection. */
2086 result = object;
2087 if (SYMBOLP (result) && !NILP (result)
2088 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2089 result = indirect_function (result);
2090 if (!NILP (result))
2091 return result;
2093 if (NILP (noerror))
2094 xsignal1 (Qvoid_function, object);
2096 return Qnil;
2099 /* Extract and set vector and string elements. */
2101 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2102 doc: /* Return the element of ARRAY at index IDX.
2103 ARRAY may be a vector, a string, a char-table, a bool-vector,
2104 or a byte-code object. IDX starts at 0. */)
2105 (register Lisp_Object array, Lisp_Object idx)
2107 register EMACS_INT idxval;
2109 CHECK_NUMBER (idx);
2110 idxval = XINT (idx);
2111 if (STRINGP (array))
2113 int c;
2114 ptrdiff_t idxval_byte;
2116 if (idxval < 0 || idxval >= SCHARS (array))
2117 args_out_of_range (array, idx);
2118 if (! STRING_MULTIBYTE (array))
2119 return make_number ((unsigned char) SREF (array, idxval));
2120 idxval_byte = string_char_to_byte (array, idxval);
2122 c = STRING_CHAR (SDATA (array) + idxval_byte);
2123 return make_number (c);
2125 else if (BOOL_VECTOR_P (array))
2127 int val;
2129 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2130 args_out_of_range (array, idx);
2132 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2133 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2135 else if (CHAR_TABLE_P (array))
2137 CHECK_CHARACTER (idx);
2138 return CHAR_TABLE_REF (array, idxval);
2140 else
2142 ptrdiff_t size = 0;
2143 if (VECTORP (array))
2144 size = ASIZE (array);
2145 else if (COMPILEDP (array))
2146 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2147 else
2148 wrong_type_argument (Qarrayp, array);
2150 if (idxval < 0 || idxval >= size)
2151 args_out_of_range (array, idx);
2152 return AREF (array, idxval);
2156 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2157 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2158 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2159 bool-vector. IDX starts at 0. */)
2160 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2162 register EMACS_INT idxval;
2164 CHECK_NUMBER (idx);
2165 idxval = XINT (idx);
2166 CHECK_ARRAY (array, Qarrayp);
2167 CHECK_IMPURE (array);
2169 if (VECTORP (array))
2171 if (idxval < 0 || idxval >= ASIZE (array))
2172 args_out_of_range (array, idx);
2173 ASET (array, idxval, newelt);
2175 else if (BOOL_VECTOR_P (array))
2177 int val;
2179 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2180 args_out_of_range (array, idx);
2182 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2184 if (! NILP (newelt))
2185 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2186 else
2187 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2188 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2190 else if (CHAR_TABLE_P (array))
2192 CHECK_CHARACTER (idx);
2193 CHAR_TABLE_SET (array, idxval, newelt);
2195 else
2197 int c;
2199 if (idxval < 0 || idxval >= SCHARS (array))
2200 args_out_of_range (array, idx);
2201 CHECK_CHARACTER (newelt);
2202 c = XFASTINT (newelt);
2204 if (STRING_MULTIBYTE (array))
2206 ptrdiff_t idxval_byte, nbytes;
2207 int prev_bytes, new_bytes;
2208 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2210 nbytes = SBYTES (array);
2211 idxval_byte = string_char_to_byte (array, idxval);
2212 p1 = SDATA (array) + idxval_byte;
2213 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2214 new_bytes = CHAR_STRING (c, p0);
2215 if (prev_bytes != new_bytes)
2217 /* We must relocate the string data. */
2218 ptrdiff_t nchars = SCHARS (array);
2219 USE_SAFE_ALLOCA;
2220 unsigned char *str = SAFE_ALLOCA (nbytes);
2222 memcpy (str, SDATA (array), nbytes);
2223 allocate_string_data (XSTRING (array), nchars,
2224 nbytes + new_bytes - prev_bytes);
2225 memcpy (SDATA (array), str, idxval_byte);
2226 p1 = SDATA (array) + idxval_byte;
2227 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2228 nbytes - (idxval_byte + prev_bytes));
2229 SAFE_FREE ();
2230 clear_string_char_byte_cache ();
2232 while (new_bytes--)
2233 *p1++ = *p0++;
2235 else
2237 if (! SINGLE_BYTE_CHAR_P (c))
2239 int i;
2241 for (i = SBYTES (array) - 1; i >= 0; i--)
2242 if (SREF (array, i) >= 0x80)
2243 args_out_of_range (array, newelt);
2244 /* ARRAY is an ASCII string. Convert it to a multibyte
2245 string, and try `aset' again. */
2246 STRING_SET_MULTIBYTE (array);
2247 return Faset (array, idx, newelt);
2249 SSET (array, idxval, c);
2253 return newelt;
2256 /* Arithmetic functions */
2258 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2260 static Lisp_Object
2261 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2263 double f1 = 0, f2 = 0;
2264 bool floatp = 0;
2266 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2267 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2269 if (FLOATP (num1) || FLOATP (num2))
2271 floatp = 1;
2272 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2273 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2276 switch (comparison)
2278 case equal:
2279 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2280 return Qt;
2281 return Qnil;
2283 case notequal:
2284 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2285 return Qt;
2286 return Qnil;
2288 case less:
2289 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2290 return Qt;
2291 return Qnil;
2293 case less_or_equal:
2294 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2295 return Qt;
2296 return Qnil;
2298 case grtr:
2299 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2300 return Qt;
2301 return Qnil;
2303 case grtr_or_equal:
2304 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2305 return Qt;
2306 return Qnil;
2308 default:
2309 emacs_abort ();
2313 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2314 doc: /* Return t if two args, both numbers or markers, are equal. */)
2315 (register Lisp_Object num1, Lisp_Object num2)
2317 return arithcompare (num1, num2, equal);
2320 DEFUN ("<", Flss, Slss, 2, 2, 0,
2321 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2322 (register Lisp_Object num1, Lisp_Object num2)
2324 return arithcompare (num1, num2, less);
2327 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2328 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2329 (register Lisp_Object num1, Lisp_Object num2)
2331 return arithcompare (num1, num2, grtr);
2334 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2335 doc: /* Return t if first arg is less than or equal to second arg.
2336 Both must be numbers or markers. */)
2337 (register Lisp_Object num1, Lisp_Object num2)
2339 return arithcompare (num1, num2, less_or_equal);
2342 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2343 doc: /* Return t if first arg is greater than or equal to second arg.
2344 Both must be numbers or markers. */)
2345 (register Lisp_Object num1, Lisp_Object num2)
2347 return arithcompare (num1, num2, grtr_or_equal);
2350 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2351 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2352 (register Lisp_Object num1, Lisp_Object num2)
2354 return arithcompare (num1, num2, notequal);
2357 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2358 doc: /* Return t if NUMBER is zero. */)
2359 (register Lisp_Object number)
2361 CHECK_NUMBER_OR_FLOAT (number);
2363 if (FLOATP (number))
2365 if (XFLOAT_DATA (number) == 0.0)
2366 return Qt;
2367 return Qnil;
2370 if (!XINT (number))
2371 return Qt;
2372 return Qnil;
2375 /* Convert the cons-of-integers, integer, or float value C to an
2376 unsigned value with maximum value MAX. Signal an error if C does not
2377 have a valid format or is out of range. */
2378 uintmax_t
2379 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2381 bool valid = 0;
2382 uintmax_t val IF_LINT (= 0);
2383 if (INTEGERP (c))
2385 valid = 0 <= XINT (c);
2386 val = XINT (c);
2388 else if (FLOATP (c))
2390 double d = XFLOAT_DATA (c);
2391 if (0 <= d
2392 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2394 val = d;
2395 valid = 1;
2398 else if (CONSP (c) && NATNUMP (XCAR (c)))
2400 uintmax_t top = XFASTINT (XCAR (c));
2401 Lisp_Object rest = XCDR (c);
2402 if (top <= UINTMAX_MAX >> 24 >> 16
2403 && CONSP (rest)
2404 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2405 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2407 uintmax_t mid = XFASTINT (XCAR (rest));
2408 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2409 valid = 1;
2411 else if (top <= UINTMAX_MAX >> 16)
2413 if (CONSP (rest))
2414 rest = XCAR (rest);
2415 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2417 val = top << 16 | XFASTINT (rest);
2418 valid = 1;
2423 if (! (valid && val <= max))
2424 error ("Not an in-range integer, float, or cons of integers");
2425 return val;
2428 /* Convert the cons-of-integers, integer, or float value C to a signed
2429 value with extrema MIN and MAX. Signal an error if C does not have
2430 a valid format or is out of range. */
2431 intmax_t
2432 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2434 bool valid = 0;
2435 intmax_t val IF_LINT (= 0);
2436 if (INTEGERP (c))
2438 val = XINT (c);
2439 valid = 1;
2441 else if (FLOATP (c))
2443 double d = XFLOAT_DATA (c);
2444 if (min <= d
2445 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2447 val = d;
2448 valid = 1;
2451 else if (CONSP (c) && INTEGERP (XCAR (c)))
2453 intmax_t top = XINT (XCAR (c));
2454 Lisp_Object rest = XCDR (c);
2455 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2456 && CONSP (rest)
2457 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2458 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2460 intmax_t mid = XFASTINT (XCAR (rest));
2461 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2462 valid = 1;
2464 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2466 if (CONSP (rest))
2467 rest = XCAR (rest);
2468 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2470 val = top << 16 | XFASTINT (rest);
2471 valid = 1;
2476 if (! (valid && min <= val && val <= max))
2477 error ("Not an in-range integer, float, or cons of integers");
2478 return val;
2481 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2482 doc: /* Return the decimal representation of NUMBER as a string.
2483 Uses a minus sign if negative.
2484 NUMBER may be an integer or a floating point number. */)
2485 (Lisp_Object number)
2487 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2488 int len;
2490 CHECK_NUMBER_OR_FLOAT (number);
2492 if (FLOATP (number))
2493 len = float_to_string (buffer, XFLOAT_DATA (number));
2494 else
2495 len = sprintf (buffer, "%"pI"d", XINT (number));
2497 return make_unibyte_string (buffer, len);
2500 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2501 doc: /* Parse STRING as a decimal number and return the number.
2502 This parses both integers and floating point numbers.
2503 It ignores leading spaces and tabs, and all trailing chars.
2505 If BASE, interpret STRING as a number in that base. If BASE isn't
2506 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2507 If the base used is not 10, STRING is always parsed as integer. */)
2508 (register Lisp_Object string, Lisp_Object base)
2510 register char *p;
2511 register int b;
2512 Lisp_Object val;
2514 CHECK_STRING (string);
2516 if (NILP (base))
2517 b = 10;
2518 else
2520 CHECK_NUMBER (base);
2521 if (! (2 <= XINT (base) && XINT (base) <= 16))
2522 xsignal1 (Qargs_out_of_range, base);
2523 b = XINT (base);
2526 p = SSDATA (string);
2527 while (*p == ' ' || *p == '\t')
2528 p++;
2530 val = string_to_number (p, b, 1);
2531 return NILP (val) ? make_number (0) : val;
2534 enum arithop
2536 Aadd,
2537 Asub,
2538 Amult,
2539 Adiv,
2540 Alogand,
2541 Alogior,
2542 Alogxor,
2543 Amax,
2544 Amin
2547 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2548 ptrdiff_t, Lisp_Object *);
2549 static Lisp_Object
2550 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2552 Lisp_Object val;
2553 ptrdiff_t argnum, ok_args;
2554 EMACS_INT accum = 0;
2555 EMACS_INT next, ok_accum;
2556 bool overflow = 0;
2558 switch (code)
2560 case Alogior:
2561 case Alogxor:
2562 case Aadd:
2563 case Asub:
2564 accum = 0;
2565 break;
2566 case Amult:
2567 accum = 1;
2568 break;
2569 case Alogand:
2570 accum = -1;
2571 break;
2572 default:
2573 break;
2576 for (argnum = 0; argnum < nargs; argnum++)
2578 if (! overflow)
2580 ok_args = argnum;
2581 ok_accum = accum;
2584 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2585 val = args[argnum];
2586 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2588 if (FLOATP (val))
2589 return float_arith_driver (ok_accum, ok_args, code,
2590 nargs, args);
2591 args[argnum] = val;
2592 next = XINT (args[argnum]);
2593 switch (code)
2595 case Aadd:
2596 if (INT_ADD_OVERFLOW (accum, next))
2598 overflow = 1;
2599 accum &= INTMASK;
2601 accum += next;
2602 break;
2603 case Asub:
2604 if (INT_SUBTRACT_OVERFLOW (accum, next))
2606 overflow = 1;
2607 accum &= INTMASK;
2609 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2610 break;
2611 case Amult:
2612 if (INT_MULTIPLY_OVERFLOW (accum, next))
2614 EMACS_UINT a = accum, b = next, ab = a * b;
2615 overflow = 1;
2616 accum = ab & INTMASK;
2618 else
2619 accum *= next;
2620 break;
2621 case Adiv:
2622 if (!argnum)
2623 accum = next;
2624 else
2626 if (next == 0)
2627 xsignal0 (Qarith_error);
2628 accum /= next;
2630 break;
2631 case Alogand:
2632 accum &= next;
2633 break;
2634 case Alogior:
2635 accum |= next;
2636 break;
2637 case Alogxor:
2638 accum ^= next;
2639 break;
2640 case Amax:
2641 if (!argnum || next > accum)
2642 accum = next;
2643 break;
2644 case Amin:
2645 if (!argnum || next < accum)
2646 accum = next;
2647 break;
2651 XSETINT (val, accum);
2652 return val;
2655 #undef isnan
2656 #define isnan(x) ((x) != (x))
2658 static Lisp_Object
2659 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2660 ptrdiff_t nargs, Lisp_Object *args)
2662 register Lisp_Object val;
2663 double next;
2665 for (; argnum < nargs; argnum++)
2667 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2668 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2670 if (FLOATP (val))
2672 next = XFLOAT_DATA (val);
2674 else
2676 args[argnum] = val; /* runs into a compiler bug. */
2677 next = XINT (args[argnum]);
2679 switch (code)
2681 case Aadd:
2682 accum += next;
2683 break;
2684 case Asub:
2685 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2686 break;
2687 case Amult:
2688 accum *= next;
2689 break;
2690 case Adiv:
2691 if (!argnum)
2692 accum = next;
2693 else
2695 if (! IEEE_FLOATING_POINT && next == 0)
2696 xsignal0 (Qarith_error);
2697 accum /= next;
2699 break;
2700 case Alogand:
2701 case Alogior:
2702 case Alogxor:
2703 return wrong_type_argument (Qinteger_or_marker_p, val);
2704 case Amax:
2705 if (!argnum || isnan (next) || next > accum)
2706 accum = next;
2707 break;
2708 case Amin:
2709 if (!argnum || isnan (next) || next < accum)
2710 accum = next;
2711 break;
2715 return make_float (accum);
2719 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2720 doc: /* Return sum of any number of arguments, which are numbers or markers.
2721 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2722 (ptrdiff_t nargs, Lisp_Object *args)
2724 return arith_driver (Aadd, nargs, args);
2727 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2728 doc: /* Negate number or subtract numbers or markers and return the result.
2729 With one arg, negates it. With more than one arg,
2730 subtracts all but the first from the first.
2731 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2732 (ptrdiff_t nargs, Lisp_Object *args)
2734 return arith_driver (Asub, nargs, args);
2737 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2738 doc: /* Return product of any number of arguments, which are numbers or markers.
2739 usage: (* &rest NUMBERS-OR-MARKERS) */)
2740 (ptrdiff_t nargs, Lisp_Object *args)
2742 return arith_driver (Amult, nargs, args);
2745 DEFUN ("/", Fquo, Squo, 1, MANY, 0,
2746 doc: /* Return first argument divided by all the remaining arguments.
2747 The arguments must be numbers or markers.
2748 usage: (/ DIVIDEND &rest DIVISORS) */)
2749 (ptrdiff_t nargs, Lisp_Object *args)
2751 ptrdiff_t argnum;
2752 for (argnum = 2; argnum < nargs; argnum++)
2753 if (FLOATP (args[argnum]))
2754 return float_arith_driver (0, 0, Adiv, nargs, args);
2755 return arith_driver (Adiv, nargs, args);
2758 DEFUN ("%", Frem, Srem, 2, 2, 0,
2759 doc: /* Return remainder of X divided by Y.
2760 Both must be integers or markers. */)
2761 (register Lisp_Object x, Lisp_Object y)
2763 Lisp_Object val;
2765 CHECK_NUMBER_COERCE_MARKER (x);
2766 CHECK_NUMBER_COERCE_MARKER (y);
2768 if (XINT (y) == 0)
2769 xsignal0 (Qarith_error);
2771 XSETINT (val, XINT (x) % XINT (y));
2772 return val;
2775 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2776 doc: /* Return X modulo Y.
2777 The result falls between zero (inclusive) and Y (exclusive).
2778 Both X and Y must be numbers or markers. */)
2779 (register Lisp_Object x, Lisp_Object y)
2781 Lisp_Object val;
2782 EMACS_INT i1, i2;
2784 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2785 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2787 if (FLOATP (x) || FLOATP (y))
2788 return fmod_float (x, y);
2790 i1 = XINT (x);
2791 i2 = XINT (y);
2793 if (i2 == 0)
2794 xsignal0 (Qarith_error);
2796 i1 %= i2;
2798 /* If the "remainder" comes out with the wrong sign, fix it. */
2799 if (i2 < 0 ? i1 > 0 : i1 < 0)
2800 i1 += i2;
2802 XSETINT (val, i1);
2803 return val;
2806 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2807 doc: /* Return largest of all the arguments (which must be numbers or markers).
2808 The value is always a number; markers are converted to numbers.
2809 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2810 (ptrdiff_t nargs, Lisp_Object *args)
2812 return arith_driver (Amax, nargs, args);
2815 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2816 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2817 The value is always a number; markers are converted to numbers.
2818 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2819 (ptrdiff_t nargs, Lisp_Object *args)
2821 return arith_driver (Amin, nargs, args);
2824 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2825 doc: /* Return bitwise-and of all the arguments.
2826 Arguments may be integers, or markers converted to integers.
2827 usage: (logand &rest INTS-OR-MARKERS) */)
2828 (ptrdiff_t nargs, Lisp_Object *args)
2830 return arith_driver (Alogand, nargs, args);
2833 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2834 doc: /* Return bitwise-or of all the arguments.
2835 Arguments may be integers, or markers converted to integers.
2836 usage: (logior &rest INTS-OR-MARKERS) */)
2837 (ptrdiff_t nargs, Lisp_Object *args)
2839 return arith_driver (Alogior, nargs, args);
2842 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2843 doc: /* Return bitwise-exclusive-or of all the arguments.
2844 Arguments may be integers, or markers converted to integers.
2845 usage: (logxor &rest INTS-OR-MARKERS) */)
2846 (ptrdiff_t nargs, Lisp_Object *args)
2848 return arith_driver (Alogxor, nargs, args);
2851 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2852 doc: /* Return VALUE with its bits shifted left by COUNT.
2853 If COUNT is negative, shifting is actually to the right.
2854 In this case, the sign bit is duplicated. */)
2855 (register Lisp_Object value, Lisp_Object count)
2857 register Lisp_Object val;
2859 CHECK_NUMBER (value);
2860 CHECK_NUMBER (count);
2862 if (XINT (count) >= BITS_PER_EMACS_INT)
2863 XSETINT (val, 0);
2864 else if (XINT (count) > 0)
2865 XSETINT (val, XINT (value) << XFASTINT (count));
2866 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2867 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2868 else
2869 XSETINT (val, XINT (value) >> -XINT (count));
2870 return val;
2873 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2874 doc: /* Return VALUE with its bits shifted left by COUNT.
2875 If COUNT is negative, shifting is actually to the right.
2876 In this case, zeros are shifted in on the left. */)
2877 (register Lisp_Object value, Lisp_Object count)
2879 register Lisp_Object val;
2881 CHECK_NUMBER (value);
2882 CHECK_NUMBER (count);
2884 if (XINT (count) >= BITS_PER_EMACS_INT)
2885 XSETINT (val, 0);
2886 else if (XINT (count) > 0)
2887 XSETINT (val, XUINT (value) << XFASTINT (count));
2888 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2889 XSETINT (val, 0);
2890 else
2891 XSETINT (val, XUINT (value) >> -XINT (count));
2892 return val;
2895 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2896 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2897 Markers are converted to integers. */)
2898 (register Lisp_Object number)
2900 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2902 if (FLOATP (number))
2903 return (make_float (1.0 + XFLOAT_DATA (number)));
2905 XSETINT (number, XINT (number) + 1);
2906 return number;
2909 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2910 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2911 Markers are converted to integers. */)
2912 (register Lisp_Object number)
2914 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2916 if (FLOATP (number))
2917 return (make_float (-1.0 + XFLOAT_DATA (number)));
2919 XSETINT (number, XINT (number) - 1);
2920 return number;
2923 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2924 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2925 (register Lisp_Object number)
2927 CHECK_NUMBER (number);
2928 XSETINT (number, ~XINT (number));
2929 return number;
2932 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2933 doc: /* Return the byteorder for the machine.
2934 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2935 lowercase l) for small endian machines. */)
2936 (void)
2938 unsigned i = 0x04030201;
2939 int order = *(char *)&i == 1 ? 108 : 66;
2941 return make_number (order);
2946 void
2947 syms_of_data (void)
2949 Lisp_Object error_tail, arith_tail;
2951 DEFSYM (Qquote, "quote");
2952 DEFSYM (Qlambda, "lambda");
2953 DEFSYM (Qsubr, "subr");
2954 DEFSYM (Qerror_conditions, "error-conditions");
2955 DEFSYM (Qerror_message, "error-message");
2956 DEFSYM (Qtop_level, "top-level");
2958 DEFSYM (Qerror, "error");
2959 DEFSYM (Quser_error, "user-error");
2960 DEFSYM (Qquit, "quit");
2961 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2962 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2963 DEFSYM (Qvoid_function, "void-function");
2964 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2965 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2966 DEFSYM (Qvoid_variable, "void-variable");
2967 DEFSYM (Qsetting_constant, "setting-constant");
2968 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2970 DEFSYM (Qinvalid_function, "invalid-function");
2971 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2972 DEFSYM (Qno_catch, "no-catch");
2973 DEFSYM (Qend_of_file, "end-of-file");
2974 DEFSYM (Qarith_error, "arith-error");
2975 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2976 DEFSYM (Qend_of_buffer, "end-of-buffer");
2977 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2978 DEFSYM (Qtext_read_only, "text-read-only");
2979 DEFSYM (Qmark_inactive, "mark-inactive");
2981 DEFSYM (Qlistp, "listp");
2982 DEFSYM (Qconsp, "consp");
2983 DEFSYM (Qsymbolp, "symbolp");
2984 DEFSYM (Qkeywordp, "keywordp");
2985 DEFSYM (Qintegerp, "integerp");
2986 DEFSYM (Qnatnump, "natnump");
2987 DEFSYM (Qwholenump, "wholenump");
2988 DEFSYM (Qstringp, "stringp");
2989 DEFSYM (Qarrayp, "arrayp");
2990 DEFSYM (Qsequencep, "sequencep");
2991 DEFSYM (Qbufferp, "bufferp");
2992 DEFSYM (Qvectorp, "vectorp");
2993 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2994 DEFSYM (Qmarkerp, "markerp");
2995 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2996 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2997 DEFSYM (Qboundp, "boundp");
2998 DEFSYM (Qfboundp, "fboundp");
3000 DEFSYM (Qfloatp, "floatp");
3001 DEFSYM (Qnumberp, "numberp");
3002 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
3004 DEFSYM (Qchar_table_p, "char-table-p");
3005 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
3007 DEFSYM (Qsubrp, "subrp");
3008 DEFSYM (Qunevalled, "unevalled");
3009 DEFSYM (Qmany, "many");
3011 DEFSYM (Qcdr, "cdr");
3013 /* Handle automatic advice activation. */
3014 DEFSYM (Qad_advice_info, "ad-advice-info");
3015 DEFSYM (Qad_activate_internal, "ad-activate-internal");
3017 error_tail = pure_cons (Qerror, Qnil);
3019 /* ERROR is used as a signaler for random errors for which nothing else is
3020 right. */
3022 Fput (Qerror, Qerror_conditions,
3023 error_tail);
3024 Fput (Qerror, Qerror_message,
3025 build_pure_c_string ("error"));
3027 #define PUT_ERROR(sym, tail, msg) \
3028 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
3029 Fput (sym, Qerror_message, build_pure_c_string (msg))
3031 PUT_ERROR (Qquit, Qnil, "Quit");
3033 PUT_ERROR (Quser_error, error_tail, "");
3034 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
3035 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
3036 PUT_ERROR (Qvoid_function, error_tail,
3037 "Symbol's function definition is void");
3038 PUT_ERROR (Qcyclic_function_indirection, error_tail,
3039 "Symbol's chain of function indirections contains a loop");
3040 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
3041 "Symbol's chain of variable indirections contains a loop");
3042 DEFSYM (Qcircular_list, "circular-list");
3043 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
3044 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3045 PUT_ERROR (Qsetting_constant, error_tail,
3046 "Attempt to set a constant symbol");
3047 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3048 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3049 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3050 "Wrong number of arguments");
3051 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3052 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3054 arith_tail = pure_cons (Qarith_error, error_tail);
3055 Fput (Qarith_error, Qerror_conditions, arith_tail);
3056 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3058 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3059 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3060 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3061 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3062 "Text is read-only");
3064 DEFSYM (Qrange_error, "range-error");
3065 DEFSYM (Qdomain_error, "domain-error");
3066 DEFSYM (Qsingularity_error, "singularity-error");
3067 DEFSYM (Qoverflow_error, "overflow-error");
3068 DEFSYM (Qunderflow_error, "underflow-error");
3070 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3072 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3074 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3075 "Arithmetic singularity error");
3077 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3078 "Arithmetic overflow error");
3079 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3080 "Arithmetic underflow error");
3082 staticpro (&Qnil);
3083 staticpro (&Qt);
3084 staticpro (&Qunbound);
3086 /* Types that type-of returns. */
3087 DEFSYM (Qinteger, "integer");
3088 DEFSYM (Qsymbol, "symbol");
3089 DEFSYM (Qstring, "string");
3090 DEFSYM (Qcons, "cons");
3091 DEFSYM (Qmarker, "marker");
3092 DEFSYM (Qoverlay, "overlay");
3093 DEFSYM (Qfloat, "float");
3094 DEFSYM (Qwindow_configuration, "window-configuration");
3095 DEFSYM (Qprocess, "process");
3096 DEFSYM (Qwindow, "window");
3097 DEFSYM (Qcompiled_function, "compiled-function");
3098 DEFSYM (Qbuffer, "buffer");
3099 DEFSYM (Qframe, "frame");
3100 DEFSYM (Qvector, "vector");
3101 DEFSYM (Qchar_table, "char-table");
3102 DEFSYM (Qbool_vector, "bool-vector");
3103 DEFSYM (Qhash_table, "hash-table");
3104 DEFSYM (Qmisc, "misc");
3106 DEFSYM (Qdefun, "defun");
3108 DEFSYM (Qfont_spec, "font-spec");
3109 DEFSYM (Qfont_entity, "font-entity");
3110 DEFSYM (Qfont_object, "font-object");
3112 DEFSYM (Qinteractive_form, "interactive-form");
3113 DEFSYM (Qdefalias_fset_function, "defalias-fset-function");
3115 defsubr (&Sindirect_variable);
3116 defsubr (&Sinteractive_form);
3117 defsubr (&Seq);
3118 defsubr (&Snull);
3119 defsubr (&Stype_of);
3120 defsubr (&Slistp);
3121 defsubr (&Snlistp);
3122 defsubr (&Sconsp);
3123 defsubr (&Satom);
3124 defsubr (&Sintegerp);
3125 defsubr (&Sinteger_or_marker_p);
3126 defsubr (&Snumberp);
3127 defsubr (&Snumber_or_marker_p);
3128 defsubr (&Sfloatp);
3129 defsubr (&Snatnump);
3130 defsubr (&Ssymbolp);
3131 defsubr (&Skeywordp);
3132 defsubr (&Sstringp);
3133 defsubr (&Smultibyte_string_p);
3134 defsubr (&Svectorp);
3135 defsubr (&Schar_table_p);
3136 defsubr (&Svector_or_char_table_p);
3137 defsubr (&Sbool_vector_p);
3138 defsubr (&Sarrayp);
3139 defsubr (&Ssequencep);
3140 defsubr (&Sbufferp);
3141 defsubr (&Smarkerp);
3142 defsubr (&Ssubrp);
3143 defsubr (&Sbyte_code_function_p);
3144 defsubr (&Schar_or_string_p);
3145 defsubr (&Scar);
3146 defsubr (&Scdr);
3147 defsubr (&Scar_safe);
3148 defsubr (&Scdr_safe);
3149 defsubr (&Ssetcar);
3150 defsubr (&Ssetcdr);
3151 defsubr (&Ssymbol_function);
3152 defsubr (&Sindirect_function);
3153 defsubr (&Ssymbol_plist);
3154 defsubr (&Ssymbol_name);
3155 defsubr (&Smakunbound);
3156 defsubr (&Sfmakunbound);
3157 defsubr (&Sboundp);
3158 defsubr (&Sfboundp);
3159 defsubr (&Sfset);
3160 defsubr (&Sdefalias);
3161 defsubr (&Ssetplist);
3162 defsubr (&Ssymbol_value);
3163 defsubr (&Sset);
3164 defsubr (&Sdefault_boundp);
3165 defsubr (&Sdefault_value);
3166 defsubr (&Sset_default);
3167 defsubr (&Ssetq_default);
3168 defsubr (&Smake_variable_buffer_local);
3169 defsubr (&Smake_local_variable);
3170 defsubr (&Skill_local_variable);
3171 defsubr (&Smake_variable_frame_local);
3172 defsubr (&Slocal_variable_p);
3173 defsubr (&Slocal_variable_if_set_p);
3174 defsubr (&Svariable_binding_locus);
3175 #if 0 /* XXX Remove this. --lorentey */
3176 defsubr (&Sterminal_local_value);
3177 defsubr (&Sset_terminal_local_value);
3178 #endif
3179 defsubr (&Saref);
3180 defsubr (&Saset);
3181 defsubr (&Snumber_to_string);
3182 defsubr (&Sstring_to_number);
3183 defsubr (&Seqlsign);
3184 defsubr (&Slss);
3185 defsubr (&Sgtr);
3186 defsubr (&Sleq);
3187 defsubr (&Sgeq);
3188 defsubr (&Sneq);
3189 defsubr (&Szerop);
3190 defsubr (&Splus);
3191 defsubr (&Sminus);
3192 defsubr (&Stimes);
3193 defsubr (&Squo);
3194 defsubr (&Srem);
3195 defsubr (&Smod);
3196 defsubr (&Smax);
3197 defsubr (&Smin);
3198 defsubr (&Slogand);
3199 defsubr (&Slogior);
3200 defsubr (&Slogxor);
3201 defsubr (&Slsh);
3202 defsubr (&Sash);
3203 defsubr (&Sadd1);
3204 defsubr (&Ssub1);
3205 defsubr (&Slognot);
3206 defsubr (&Sbyteorder);
3207 defsubr (&Ssubr_arity);
3208 defsubr (&Ssubr_name);
3210 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3212 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3213 doc: /* The largest value that is representable in a Lisp integer. */);
3214 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3215 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3217 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3218 doc: /* The smallest value that is representable in a Lisp integer. */);
3219 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3220 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;