* src/data.c (Fsymbol_value): Doc fix re lexical-binding.
[emacs.git] / src / data.c
blobff2c0d94b9d7fad7707671411ab57157824530dc
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <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, Qmany, Qunevalled;
80 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
81 static Lisp_Object Qdefun;
83 Lisp_Object Qinteractive_form;
85 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
88 Lisp_Object
89 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
91 /* If VALUE is not even a valid Lisp object, we'd want to abort here
92 where we can get a backtrace showing where it came from. We used
93 to try and do that by checking the tagbits, but nowadays all
94 tagbits are potentially valid. */
95 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
96 * emacs_abort (); */
98 xsignal2 (Qwrong_type_argument, predicate, value);
101 void
102 pure_write_error (void)
104 error ("Attempt to modify read-only object");
107 void
108 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
110 xsignal2 (Qargs_out_of_range, a1, a2);
113 void
114 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
116 xsignal3 (Qargs_out_of_range, a1, a2, a3);
120 /* Data type predicates. */
122 DEFUN ("eq", Feq, Seq, 2, 2, 0,
123 doc: /* Return t if the two args are the same Lisp object. */)
124 (Lisp_Object obj1, Lisp_Object obj2)
126 if (EQ (obj1, obj2))
127 return Qt;
128 return Qnil;
131 DEFUN ("null", Fnull, Snull, 1, 1, 0,
132 doc: /* Return t if OBJECT is nil. */)
133 (Lisp_Object object)
135 if (NILP (object))
136 return Qt;
137 return Qnil;
140 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
141 doc: /* Return a symbol representing the type of OBJECT.
142 The symbol returned names the object's basic type;
143 for example, (type-of 1) returns `integer'. */)
144 (Lisp_Object object)
146 switch (XTYPE (object))
148 case_Lisp_Int:
149 return Qinteger;
151 case Lisp_Symbol:
152 return Qsymbol;
154 case Lisp_String:
155 return Qstring;
157 case Lisp_Cons:
158 return Qcons;
160 case Lisp_Misc:
161 switch (XMISCTYPE (object))
163 case Lisp_Misc_Marker:
164 return Qmarker;
165 case Lisp_Misc_Overlay:
166 return Qoverlay;
167 case Lisp_Misc_Float:
168 return Qfloat;
170 emacs_abort ();
172 case Lisp_Vectorlike:
173 if (WINDOW_CONFIGURATIONP (object))
174 return Qwindow_configuration;
175 if (PROCESSP (object))
176 return Qprocess;
177 if (WINDOWP (object))
178 return Qwindow;
179 if (SUBRP (object))
180 return Qsubr;
181 if (COMPILEDP (object))
182 return Qcompiled_function;
183 if (BUFFERP (object))
184 return Qbuffer;
185 if (CHAR_TABLE_P (object))
186 return Qchar_table;
187 if (BOOL_VECTOR_P (object))
188 return Qbool_vector;
189 if (FRAMEP (object))
190 return Qframe;
191 if (HASH_TABLE_P (object))
192 return Qhash_table;
193 if (FONT_SPEC_P (object))
194 return Qfont_spec;
195 if (FONT_ENTITY_P (object))
196 return Qfont_entity;
197 if (FONT_OBJECT_P (object))
198 return Qfont_object;
199 return Qvector;
201 case Lisp_Float:
202 return Qfloat;
204 default:
205 emacs_abort ();
209 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
210 doc: /* Return t if OBJECT is a cons cell. */)
211 (Lisp_Object object)
213 if (CONSP (object))
214 return Qt;
215 return Qnil;
218 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
219 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
220 (Lisp_Object object)
222 if (CONSP (object))
223 return Qnil;
224 return Qt;
227 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
228 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
229 Otherwise, return nil. */)
230 (Lisp_Object object)
232 if (CONSP (object) || NILP (object))
233 return Qt;
234 return Qnil;
237 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
238 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
239 (Lisp_Object object)
241 if (CONSP (object) || NILP (object))
242 return Qnil;
243 return Qt;
246 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
247 doc: /* Return t if OBJECT is a symbol. */)
248 (Lisp_Object object)
250 if (SYMBOLP (object))
251 return Qt;
252 return Qnil;
255 /* Define this in C to avoid unnecessarily consing up the symbol
256 name. */
257 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
258 doc: /* Return t if OBJECT is a keyword.
259 This means that it is a symbol with a print name beginning with `:'
260 interned in the initial obarray. */)
261 (Lisp_Object object)
263 if (SYMBOLP (object)
264 && SREF (SYMBOL_NAME (object), 0) == ':'
265 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
266 return Qt;
267 return Qnil;
270 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
271 doc: /* Return t if OBJECT is a vector. */)
272 (Lisp_Object object)
274 if (VECTORP (object))
275 return Qt;
276 return Qnil;
279 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
280 doc: /* Return t if OBJECT is a string. */)
281 (Lisp_Object object)
283 if (STRINGP (object))
284 return Qt;
285 return Qnil;
288 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
289 1, 1, 0,
290 doc: /* Return t if OBJECT is a multibyte string. */)
291 (Lisp_Object object)
293 if (STRINGP (object) && STRING_MULTIBYTE (object))
294 return Qt;
295 return Qnil;
298 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
299 doc: /* Return t if OBJECT is a char-table. */)
300 (Lisp_Object object)
302 if (CHAR_TABLE_P (object))
303 return Qt;
304 return Qnil;
307 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
308 Svector_or_char_table_p, 1, 1, 0,
309 doc: /* Return t if OBJECT is a char-table or vector. */)
310 (Lisp_Object object)
312 if (VECTORP (object) || CHAR_TABLE_P (object))
313 return Qt;
314 return Qnil;
317 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
318 doc: /* Return t if OBJECT is a bool-vector. */)
319 (Lisp_Object object)
321 if (BOOL_VECTOR_P (object))
322 return Qt;
323 return Qnil;
326 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
327 doc: /* Return t if OBJECT is an array (string or vector). */)
328 (Lisp_Object object)
330 if (ARRAYP (object))
331 return Qt;
332 return Qnil;
335 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
336 doc: /* Return t if OBJECT is a sequence (list or array). */)
337 (register Lisp_Object object)
339 if (CONSP (object) || NILP (object) || ARRAYP (object))
340 return Qt;
341 return Qnil;
344 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
345 doc: /* Return t if OBJECT is an editor buffer. */)
346 (Lisp_Object object)
348 if (BUFFERP (object))
349 return Qt;
350 return Qnil;
353 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
354 doc: /* Return t if OBJECT is a marker (editor pointer). */)
355 (Lisp_Object object)
357 if (MARKERP (object))
358 return Qt;
359 return Qnil;
362 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
363 doc: /* Return t if OBJECT is a built-in function. */)
364 (Lisp_Object object)
366 if (SUBRP (object))
367 return Qt;
368 return Qnil;
371 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
372 1, 1, 0,
373 doc: /* Return t if OBJECT is a byte-compiled function object. */)
374 (Lisp_Object object)
376 if (COMPILEDP (object))
377 return Qt;
378 return Qnil;
381 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
382 doc: /* Return t if OBJECT is a character or a string. */)
383 (register Lisp_Object object)
385 if (CHARACTERP (object) || STRINGP (object))
386 return Qt;
387 return Qnil;
390 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
391 doc: /* Return t if OBJECT is an integer. */)
392 (Lisp_Object object)
394 if (INTEGERP (object))
395 return Qt;
396 return Qnil;
399 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
400 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
401 (register Lisp_Object object)
403 if (MARKERP (object) || INTEGERP (object))
404 return Qt;
405 return Qnil;
408 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
409 doc: /* Return t if OBJECT is a nonnegative integer. */)
410 (Lisp_Object object)
412 if (NATNUMP (object))
413 return Qt;
414 return Qnil;
417 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
418 doc: /* Return t if OBJECT is a number (floating point or integer). */)
419 (Lisp_Object object)
421 if (NUMBERP (object))
422 return Qt;
423 else
424 return Qnil;
427 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
428 Snumber_or_marker_p, 1, 1, 0,
429 doc: /* Return t if OBJECT is a number or a marker. */)
430 (Lisp_Object object)
432 if (NUMBERP (object) || MARKERP (object))
433 return Qt;
434 return Qnil;
437 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
438 doc: /* Return t if OBJECT is a floating point number. */)
439 (Lisp_Object object)
441 if (FLOATP (object))
442 return Qt;
443 return Qnil;
447 /* Extract and set components of lists */
449 DEFUN ("car", Fcar, Scar, 1, 1, 0,
450 doc: /* Return the car of LIST. If arg is nil, return nil.
451 Error if arg is not nil and not a cons cell. See also `car-safe'.
453 See Info node `(elisp)Cons Cells' for a discussion of related basic
454 Lisp concepts such as car, cdr, cons cell and list. */)
455 (register Lisp_Object list)
457 return CAR (list);
460 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
461 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
462 (Lisp_Object object)
464 return CAR_SAFE (object);
467 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
468 doc: /* Return the cdr of LIST. If arg is nil, return nil.
469 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
471 See Info node `(elisp)Cons Cells' for a discussion of related basic
472 Lisp concepts such as cdr, car, cons cell and list. */)
473 (register Lisp_Object list)
475 return CDR (list);
478 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
479 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
480 (Lisp_Object object)
482 return CDR_SAFE (object);
485 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
486 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
487 (register Lisp_Object cell, Lisp_Object newcar)
489 CHECK_CONS (cell);
490 CHECK_IMPURE (cell);
491 XSETCAR (cell, newcar);
492 return newcar;
495 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
496 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
497 (register Lisp_Object cell, Lisp_Object newcdr)
499 CHECK_CONS (cell);
500 CHECK_IMPURE (cell);
501 XSETCDR (cell, newcdr);
502 return newcdr;
505 /* Extract and set components of symbols. */
507 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
508 doc: /* Return t if SYMBOL's value is not void. */)
509 (register Lisp_Object symbol)
511 Lisp_Object valcontents;
512 struct Lisp_Symbol *sym;
513 CHECK_SYMBOL (symbol);
514 sym = XSYMBOL (symbol);
516 start:
517 switch (sym->redirect)
519 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
520 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
521 case SYMBOL_LOCALIZED:
523 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
524 if (blv->fwd)
525 /* In set_internal, we un-forward vars when their value is
526 set to Qunbound. */
527 return Qt;
528 else
530 swap_in_symval_forwarding (sym, blv);
531 valcontents = blv_value (blv);
533 break;
535 case SYMBOL_FORWARDED:
536 /* In set_internal, we un-forward vars when their value is
537 set to Qunbound. */
538 return Qt;
539 default: emacs_abort ();
542 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
545 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
546 doc: /* Return t if SYMBOL's function definition is not void. */)
547 (register Lisp_Object symbol)
549 CHECK_SYMBOL (symbol);
550 return EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt;
553 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
554 doc: /* Make SYMBOL's value be void.
555 Return SYMBOL. */)
556 (register Lisp_Object symbol)
558 CHECK_SYMBOL (symbol);
559 if (SYMBOL_CONSTANT_P (symbol))
560 xsignal1 (Qsetting_constant, symbol);
561 Fset (symbol, Qunbound);
562 return symbol;
565 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
566 doc: /* Make SYMBOL's function definition be void.
567 Return SYMBOL. */)
568 (register Lisp_Object symbol)
570 CHECK_SYMBOL (symbol);
571 if (NILP (symbol) || EQ (symbol, Qt))
572 xsignal1 (Qsetting_constant, symbol);
573 set_symbol_function (symbol, Qunbound);
574 return symbol;
577 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
578 doc: /* Return SYMBOL's function definition. Error if that is void. */)
579 (register Lisp_Object symbol)
581 CHECK_SYMBOL (symbol);
582 if (!EQ (XSYMBOL (symbol)->function, Qunbound))
583 return XSYMBOL (symbol)->function;
584 xsignal1 (Qvoid_function, symbol);
587 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
588 doc: /* Return SYMBOL's property list. */)
589 (register Lisp_Object symbol)
591 CHECK_SYMBOL (symbol);
592 return XSYMBOL (symbol)->plist;
595 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
596 doc: /* Return SYMBOL's name, a string. */)
597 (register Lisp_Object symbol)
599 register Lisp_Object name;
601 CHECK_SYMBOL (symbol);
602 name = SYMBOL_NAME (symbol);
603 return name;
606 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
607 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
608 (register Lisp_Object symbol, Lisp_Object definition)
610 register Lisp_Object function;
612 CHECK_SYMBOL (symbol);
613 if (NILP (symbol) || EQ (symbol, Qt))
614 xsignal1 (Qsetting_constant, symbol);
616 function = XSYMBOL (symbol)->function;
618 if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
619 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
621 if (CONSP (function) && EQ (XCAR (function), Qautoload))
622 Fput (symbol, Qautoload, XCDR (function));
624 set_symbol_function (symbol, definition);
625 /* Handle automatic advice activation. */
626 if (CONSP (XSYMBOL (symbol)->plist)
627 && !NILP (Fget (symbol, Qad_advice_info)))
629 call2 (Qad_activate_internal, symbol, Qnil);
630 definition = XSYMBOL (symbol)->function;
632 return definition;
635 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
636 doc: /* Set SYMBOL's function definition to DEFINITION.
637 Associates the function with the current load file, if any.
638 The optional third argument DOCSTRING specifies the documentation string
639 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
640 determined by DEFINITION.
641 The return value is undefined. */)
642 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
644 CHECK_SYMBOL (symbol);
645 if (CONSP (XSYMBOL (symbol)->function)
646 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
647 LOADHIST_ATTACH (Fcons (Qt, symbol));
648 if (!NILP (Vpurify_flag)
649 /* If `definition' is a keymap, immutable (and copying) is wrong. */
650 && !KEYMAPP (definition))
651 definition = Fpurecopy (definition);
652 definition = Ffset (symbol, definition);
653 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
654 if (!NILP (docstring))
655 Fput (symbol, Qfunction_documentation, docstring);
656 /* We used to return `definition', but now that `defun' and `defmacro' expand
657 to a call to `defalias', we return `symbol' for backward compatibility
658 (bug#11686). */
659 return symbol;
662 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
663 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
664 (register Lisp_Object symbol, Lisp_Object newplist)
666 CHECK_SYMBOL (symbol);
667 set_symbol_plist (symbol, newplist);
668 return newplist;
671 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
672 doc: /* Return minimum and maximum number of args allowed for SUBR.
673 SUBR must be a built-in function.
674 The returned value is a pair (MIN . MAX). MIN is the minimum number
675 of args. MAX is the maximum number or the symbol `many', for a
676 function with `&rest' args, or `unevalled' for a special form. */)
677 (Lisp_Object subr)
679 short minargs, maxargs;
680 CHECK_SUBR (subr);
681 minargs = XSUBR (subr)->min_args;
682 maxargs = XSUBR (subr)->max_args;
683 if (maxargs == MANY)
684 return Fcons (make_number (minargs), Qmany);
685 else if (maxargs == UNEVALLED)
686 return Fcons (make_number (minargs), Qunevalled);
687 else
688 return Fcons (make_number (minargs), make_number (maxargs));
691 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
692 doc: /* Return name of subroutine SUBR.
693 SUBR must be a built-in function. */)
694 (Lisp_Object subr)
696 const char *name;
697 CHECK_SUBR (subr);
698 name = XSUBR (subr)->symbol_name;
699 return build_string (name);
702 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
703 doc: /* Return the interactive form of CMD or nil if none.
704 If CMD is not a command, the return value is nil.
705 Value, if non-nil, is a list \(interactive SPEC). */)
706 (Lisp_Object cmd)
708 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
710 if (NILP (fun) || EQ (fun, Qunbound))
711 return Qnil;
713 /* Use an `interactive-form' property if present, analogous to the
714 function-documentation property. */
715 fun = cmd;
716 while (SYMBOLP (fun))
718 Lisp_Object tmp = Fget (fun, Qinteractive_form);
719 if (!NILP (tmp))
720 return tmp;
721 else
722 fun = Fsymbol_function (fun);
725 if (SUBRP (fun))
727 const char *spec = XSUBR (fun)->intspec;
728 if (spec)
729 return list2 (Qinteractive,
730 (*spec != '(') ? build_string (spec) :
731 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
733 else if (COMPILEDP (fun))
735 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
736 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
738 else if (CONSP (fun))
740 Lisp_Object funcar = XCAR (fun);
741 if (EQ (funcar, Qclosure))
742 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
743 else if (EQ (funcar, Qlambda))
744 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
745 else if (EQ (funcar, Qautoload))
747 struct gcpro gcpro1;
748 GCPRO1 (cmd);
749 Fautoload_do_load (fun, cmd, Qnil);
750 UNGCPRO;
751 return Finteractive_form (cmd);
754 return Qnil;
758 /***********************************************************************
759 Getting and Setting Values of Symbols
760 ***********************************************************************/
762 /* Return the symbol holding SYMBOL's value. Signal
763 `cyclic-variable-indirection' if SYMBOL's chain of variable
764 indirections contains a loop. */
766 struct Lisp_Symbol *
767 indirect_variable (struct Lisp_Symbol *symbol)
769 struct Lisp_Symbol *tortoise, *hare;
771 hare = tortoise = symbol;
773 while (hare->redirect == SYMBOL_VARALIAS)
775 hare = SYMBOL_ALIAS (hare);
776 if (hare->redirect != SYMBOL_VARALIAS)
777 break;
779 hare = SYMBOL_ALIAS (hare);
780 tortoise = SYMBOL_ALIAS (tortoise);
782 if (hare == tortoise)
784 Lisp_Object tem;
785 XSETSYMBOL (tem, symbol);
786 xsignal1 (Qcyclic_variable_indirection, tem);
790 return hare;
794 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
795 doc: /* Return the variable at the end of OBJECT's variable chain.
796 If OBJECT is a symbol, follow its variable indirections (if any), and
797 return the variable at the end of the chain of aliases. See Info node
798 `(elisp)Variable Aliases'.
800 If OBJECT is not a symbol, just return it. If there is a loop in the
801 chain of aliases, signal a `cyclic-variable-indirection' error. */)
802 (Lisp_Object object)
804 if (SYMBOLP (object))
806 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
807 XSETSYMBOL (object, sym);
809 return object;
813 /* Given the raw contents of a symbol value cell,
814 return the Lisp value of the symbol.
815 This does not handle buffer-local variables; use
816 swap_in_symval_forwarding for that. */
818 Lisp_Object
819 do_symval_forwarding (register union Lisp_Fwd *valcontents)
821 register Lisp_Object val;
822 switch (XFWDTYPE (valcontents))
824 case Lisp_Fwd_Int:
825 XSETINT (val, *XINTFWD (valcontents)->intvar);
826 return val;
828 case Lisp_Fwd_Bool:
829 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
831 case Lisp_Fwd_Obj:
832 return *XOBJFWD (valcontents)->objvar;
834 case Lisp_Fwd_Buffer_Obj:
835 return per_buffer_value (current_buffer,
836 XBUFFER_OBJFWD (valcontents)->offset);
838 case Lisp_Fwd_Kboard_Obj:
839 /* We used to simply use current_kboard here, but from Lisp
840 code, its value is often unexpected. It seems nicer to
841 allow constructions like this to work as intuitively expected:
843 (with-selected-frame frame
844 (define-key local-function-map "\eOP" [f1]))
846 On the other hand, this affects the semantics of
847 last-command and real-last-command, and people may rely on
848 that. I took a quick look at the Lisp codebase, and I
849 don't think anything will break. --lorentey */
850 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
851 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
852 default: emacs_abort ();
856 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
857 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
858 buffer-independent contents of the value cell: forwarded just one
859 step past the buffer-localness.
861 BUF non-zero means set the value in buffer BUF instead of the
862 current buffer. This only plays a role for per-buffer variables. */
864 static void
865 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
867 switch (XFWDTYPE (valcontents))
869 case Lisp_Fwd_Int:
870 CHECK_NUMBER (newval);
871 *XINTFWD (valcontents)->intvar = XINT (newval);
872 break;
874 case Lisp_Fwd_Bool:
875 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
876 break;
878 case Lisp_Fwd_Obj:
879 *XOBJFWD (valcontents)->objvar = newval;
881 /* If this variable is a default for something stored
882 in the buffer itself, such as default-fill-column,
883 find the buffers that don't have local values for it
884 and update them. */
885 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
886 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
888 int offset = ((char *) XOBJFWD (valcontents)->objvar
889 - (char *) &buffer_defaults);
890 int idx = PER_BUFFER_IDX (offset);
892 Lisp_Object tail;
894 if (idx <= 0)
895 break;
897 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
899 Lisp_Object lbuf;
900 struct buffer *b;
902 lbuf = Fcdr (XCAR (tail));
903 if (!BUFFERP (lbuf)) continue;
904 b = XBUFFER (lbuf);
906 if (! PER_BUFFER_VALUE_P (b, idx))
907 set_per_buffer_value (b, offset, newval);
910 break;
912 case Lisp_Fwd_Buffer_Obj:
914 int offset = XBUFFER_OBJFWD (valcontents)->offset;
915 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
917 if (!(NILP (type) || NILP (newval)
918 || (XINT (type) == Lisp_Int0
919 ? INTEGERP (newval)
920 : XTYPE (newval) == XINT (type))))
921 buffer_slot_type_mismatch (newval, XINT (type));
923 if (buf == NULL)
924 buf = current_buffer;
925 set_per_buffer_value (buf, offset, newval);
927 break;
929 case Lisp_Fwd_Kboard_Obj:
931 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
932 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
933 *(Lisp_Object *) p = newval;
935 break;
937 default:
938 emacs_abort (); /* goto def; */
942 /* Set up SYMBOL to refer to its global binding. This makes it safe
943 to alter the status of other bindings. BEWARE: this may be called
944 during the mark phase of GC, where we assume that Lisp_Object slots
945 of BLV are marked after this function has changed them. */
947 void
948 swap_in_global_binding (struct Lisp_Symbol *symbol)
950 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
952 /* Unload the previously loaded binding. */
953 if (blv->fwd)
954 set_blv_value (blv, do_symval_forwarding (blv->fwd));
956 /* Select the global binding in the symbol. */
957 set_blv_valcell (blv, blv->defcell);
958 if (blv->fwd)
959 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
961 /* Indicate that the global binding is set up now. */
962 set_blv_where (blv, Qnil);
963 set_blv_found (blv, 0);
966 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
967 VALCONTENTS is the contents of its value cell,
968 which points to a struct Lisp_Buffer_Local_Value.
970 Return the value forwarded one step past the buffer-local stage.
971 This could be another forwarding pointer. */
973 static void
974 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
976 register Lisp_Object tem1;
978 eassert (blv == SYMBOL_BLV (symbol));
980 tem1 = blv->where;
982 if (NILP (tem1)
983 || (blv->frame_local
984 ? !EQ (selected_frame, tem1)
985 : current_buffer != XBUFFER (tem1)))
988 /* Unload the previously loaded binding. */
989 tem1 = blv->valcell;
990 if (blv->fwd)
991 set_blv_value (blv, do_symval_forwarding (blv->fwd));
992 /* Choose the new binding. */
994 Lisp_Object var;
995 XSETSYMBOL (var, symbol);
996 if (blv->frame_local)
998 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
999 set_blv_where (blv, selected_frame);
1001 else
1003 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1004 set_blv_where (blv, Fcurrent_buffer ());
1007 if (!(blv->found = !NILP (tem1)))
1008 tem1 = blv->defcell;
1010 /* Load the new binding. */
1011 set_blv_valcell (blv, tem1);
1012 if (blv->fwd)
1013 store_symval_forwarding (blv->fwd, blv_value (blv), NULL);
1017 /* Find the value of a symbol, returning Qunbound if it's not bound.
1018 This is helpful for code which just wants to get a variable's value
1019 if it has one, without signaling an error.
1020 Note that it must not be possible to quit
1021 within this function. Great care is required for this. */
1023 Lisp_Object
1024 find_symbol_value (Lisp_Object symbol)
1026 struct Lisp_Symbol *sym;
1028 CHECK_SYMBOL (symbol);
1029 sym = XSYMBOL (symbol);
1031 start:
1032 switch (sym->redirect)
1034 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1035 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1036 case SYMBOL_LOCALIZED:
1038 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1039 swap_in_symval_forwarding (sym, blv);
1040 return blv->fwd ? do_symval_forwarding (blv->fwd) : blv_value (blv);
1042 /* FALLTHROUGH */
1043 case SYMBOL_FORWARDED:
1044 return do_symval_forwarding (SYMBOL_FWD (sym));
1045 default: emacs_abort ();
1049 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1050 doc: /* Return SYMBOL's value. Error if that is void.
1051 Note that if `lexical-binding' is in effect, this returns the
1052 global value outside of any lexical scope. */)
1053 (Lisp_Object symbol)
1055 Lisp_Object val;
1057 val = find_symbol_value (symbol);
1058 if (!EQ (val, Qunbound))
1059 return val;
1061 xsignal1 (Qvoid_variable, symbol);
1064 DEFUN ("set", Fset, Sset, 2, 2, 0,
1065 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1066 (register Lisp_Object symbol, Lisp_Object newval)
1068 set_internal (symbol, newval, Qnil, 0);
1069 return newval;
1072 /* Return true if SYMBOL currently has a let-binding
1073 which was made in the buffer that is now current. */
1075 static bool
1076 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1078 struct specbinding *p;
1080 for (p = specpdl_ptr; p > specpdl; )
1081 if ((--p)->func == NULL
1082 && CONSP (p->symbol))
1084 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1085 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1086 if (symbol == let_bound_symbol
1087 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1088 return 1;
1091 return 0;
1094 static bool
1095 let_shadows_global_binding_p (Lisp_Object symbol)
1097 struct specbinding *p;
1099 for (p = specpdl_ptr; p > specpdl; )
1100 if ((--p)->func == NULL && EQ (p->symbol, symbol))
1101 return 1;
1103 return 0;
1106 /* Store the value NEWVAL into SYMBOL.
1107 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1108 (nil stands for the current buffer/frame).
1110 If BINDFLAG is false, then if this symbol is supposed to become
1111 local in every buffer where it is set, then we make it local.
1112 If BINDFLAG is true, we don't do that. */
1114 void
1115 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1116 bool bindflag)
1118 bool voide = EQ (newval, Qunbound);
1119 struct Lisp_Symbol *sym;
1120 Lisp_Object tem1;
1122 /* If restoring in a dead buffer, do nothing. */
1123 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1124 return; */
1126 CHECK_SYMBOL (symbol);
1127 if (SYMBOL_CONSTANT_P (symbol))
1129 if (NILP (Fkeywordp (symbol))
1130 || !EQ (newval, Fsymbol_value (symbol)))
1131 xsignal1 (Qsetting_constant, symbol);
1132 else
1133 /* Allow setting keywords to their own value. */
1134 return;
1137 sym = XSYMBOL (symbol);
1139 start:
1140 switch (sym->redirect)
1142 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1143 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1144 case SYMBOL_LOCALIZED:
1146 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1147 if (NILP (where))
1149 if (blv->frame_local)
1150 where = selected_frame;
1151 else
1152 XSETBUFFER (where, current_buffer);
1154 /* If the current buffer is not the buffer whose binding is
1155 loaded, or if there may be frame-local bindings and the frame
1156 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1157 the default binding is loaded, the loaded binding may be the
1158 wrong one. */
1159 if (!EQ (blv->where, where)
1160 /* Also unload a global binding (if the var is local_if_set). */
1161 || (EQ (blv->valcell, blv->defcell)))
1163 /* The currently loaded binding is not necessarily valid.
1164 We need to unload it, and choose a new binding. */
1166 /* Write out `realvalue' to the old loaded binding. */
1167 if (blv->fwd)
1168 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1170 /* Find the new binding. */
1171 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1172 tem1 = Fassq (symbol,
1173 (blv->frame_local
1174 ? XFRAME (where)->param_alist
1175 : BVAR (XBUFFER (where), local_var_alist)));
1176 set_blv_where (blv, where);
1177 blv->found = 1;
1179 if (NILP (tem1))
1181 /* This buffer still sees the default value. */
1183 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1184 or if this is `let' rather than `set',
1185 make CURRENT-ALIST-ELEMENT point to itself,
1186 indicating that we're seeing the default value.
1187 Likewise if the variable has been let-bound
1188 in the current buffer. */
1189 if (bindflag || !blv->local_if_set
1190 || let_shadows_buffer_binding_p (sym))
1192 blv->found = 0;
1193 tem1 = blv->defcell;
1195 /* If it's a local_if_set, being set not bound,
1196 and we're not within a let that was made for this buffer,
1197 create a new buffer-local binding for the variable.
1198 That means, give this buffer a new assoc for a local value
1199 and load that binding. */
1200 else
1202 /* local_if_set is only supported for buffer-local
1203 bindings, not for frame-local bindings. */
1204 eassert (!blv->frame_local);
1205 tem1 = Fcons (symbol, XCDR (blv->defcell));
1206 bset_local_var_alist
1207 (XBUFFER (where),
1208 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1212 /* Record which binding is now loaded. */
1213 set_blv_valcell (blv, tem1);
1216 /* Store the new value in the cons cell. */
1217 set_blv_value (blv, newval);
1219 if (blv->fwd)
1221 if (voide)
1222 /* If storing void (making the symbol void), forward only through
1223 buffer-local indicator, not through Lisp_Objfwd, etc. */
1224 blv->fwd = NULL;
1225 else
1226 store_symval_forwarding (blv->fwd, newval,
1227 BUFFERP (where)
1228 ? XBUFFER (where) : current_buffer);
1230 break;
1232 case SYMBOL_FORWARDED:
1234 struct buffer *buf
1235 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1236 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1237 if (BUFFER_OBJFWDP (innercontents))
1239 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1240 int idx = PER_BUFFER_IDX (offset);
1241 if (idx > 0
1242 && !bindflag
1243 && !let_shadows_buffer_binding_p (sym))
1244 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1247 if (voide)
1248 { /* If storing void (making the symbol void), forward only through
1249 buffer-local indicator, not through Lisp_Objfwd, etc. */
1250 sym->redirect = SYMBOL_PLAINVAL;
1251 SET_SYMBOL_VAL (sym, newval);
1253 else
1254 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1255 break;
1257 default: emacs_abort ();
1259 return;
1262 /* Access or set a buffer-local symbol's default value. */
1264 /* Return the default value of SYMBOL, but don't check for voidness.
1265 Return Qunbound if it is void. */
1267 static Lisp_Object
1268 default_value (Lisp_Object symbol)
1270 struct Lisp_Symbol *sym;
1272 CHECK_SYMBOL (symbol);
1273 sym = XSYMBOL (symbol);
1275 start:
1276 switch (sym->redirect)
1278 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1279 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1280 case SYMBOL_LOCALIZED:
1282 /* If var is set up for a buffer that lacks a local value for it,
1283 the current value is nominally the default value.
1284 But the `realvalue' slot may be more up to date, since
1285 ordinary setq stores just that slot. So use that. */
1286 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1287 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1288 return do_symval_forwarding (blv->fwd);
1289 else
1290 return XCDR (blv->defcell);
1292 case SYMBOL_FORWARDED:
1294 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1296 /* For a built-in buffer-local variable, get the default value
1297 rather than letting do_symval_forwarding get the current value. */
1298 if (BUFFER_OBJFWDP (valcontents))
1300 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1301 if (PER_BUFFER_IDX (offset) != 0)
1302 return per_buffer_default (offset);
1305 /* For other variables, get the current value. */
1306 return do_symval_forwarding (valcontents);
1308 default: emacs_abort ();
1312 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1313 doc: /* Return t if SYMBOL has a non-void default value.
1314 This is the value that is seen in buffers that do not have their own values
1315 for this variable. */)
1316 (Lisp_Object symbol)
1318 register Lisp_Object value;
1320 value = default_value (symbol);
1321 return (EQ (value, Qunbound) ? Qnil : Qt);
1324 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1325 doc: /* Return SYMBOL's default value.
1326 This is the value that is seen in buffers that do not have their own values
1327 for this variable. The default value is meaningful for variables with
1328 local bindings in certain buffers. */)
1329 (Lisp_Object symbol)
1331 register Lisp_Object value;
1333 value = default_value (symbol);
1334 if (!EQ (value, Qunbound))
1335 return value;
1337 xsignal1 (Qvoid_variable, symbol);
1340 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1341 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1342 The default value is seen in buffers that do not have their own values
1343 for this variable. */)
1344 (Lisp_Object symbol, Lisp_Object value)
1346 struct Lisp_Symbol *sym;
1348 CHECK_SYMBOL (symbol);
1349 if (SYMBOL_CONSTANT_P (symbol))
1351 if (NILP (Fkeywordp (symbol))
1352 || !EQ (value, Fdefault_value (symbol)))
1353 xsignal1 (Qsetting_constant, symbol);
1354 else
1355 /* Allow setting keywords to their own value. */
1356 return value;
1358 sym = XSYMBOL (symbol);
1360 start:
1361 switch (sym->redirect)
1363 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1364 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1365 case SYMBOL_LOCALIZED:
1367 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1369 /* Store new value into the DEFAULT-VALUE slot. */
1370 XSETCDR (blv->defcell, value);
1372 /* If the default binding is now loaded, set the REALVALUE slot too. */
1373 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1374 store_symval_forwarding (blv->fwd, value, NULL);
1375 return value;
1377 case SYMBOL_FORWARDED:
1379 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1381 /* Handle variables like case-fold-search that have special slots
1382 in the buffer.
1383 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1384 if (BUFFER_OBJFWDP (valcontents))
1386 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1387 int idx = PER_BUFFER_IDX (offset);
1389 set_per_buffer_default (offset, value);
1391 /* If this variable is not always local in all buffers,
1392 set it in the buffers that don't nominally have a local value. */
1393 if (idx > 0)
1395 struct buffer *b;
1397 FOR_EACH_BUFFER (b)
1398 if (!PER_BUFFER_VALUE_P (b, idx))
1399 set_per_buffer_value (b, offset, value);
1401 return value;
1403 else
1404 return Fset (symbol, value);
1406 default: emacs_abort ();
1410 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1411 doc: /* Set the default value of variable VAR to VALUE.
1412 VAR, the variable name, is literal (not evaluated);
1413 VALUE is an expression: it is evaluated and its value returned.
1414 The default value of a variable is seen in buffers
1415 that do not have their own values for the variable.
1417 More generally, you can use multiple variables and values, as in
1418 (setq-default VAR VALUE VAR VALUE...)
1419 This sets each VAR's default value to the corresponding VALUE.
1420 The VALUE for the Nth VAR can refer to the new default values
1421 of previous VARs.
1422 usage: (setq-default [VAR VALUE]...) */)
1423 (Lisp_Object args)
1425 register Lisp_Object args_left;
1426 register Lisp_Object val, symbol;
1427 struct gcpro gcpro1;
1429 if (NILP (args))
1430 return Qnil;
1432 args_left = args;
1433 GCPRO1 (args);
1437 val = eval_sub (Fcar (Fcdr (args_left)));
1438 symbol = XCAR (args_left);
1439 Fset_default (symbol, val);
1440 args_left = Fcdr (XCDR (args_left));
1442 while (!NILP (args_left));
1444 UNGCPRO;
1445 return val;
1448 /* Lisp functions for creating and removing buffer-local variables. */
1450 union Lisp_Val_Fwd
1452 Lisp_Object value;
1453 union Lisp_Fwd *fwd;
1456 static struct Lisp_Buffer_Local_Value *
1457 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1458 union Lisp_Val_Fwd valcontents)
1460 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1461 Lisp_Object symbol;
1462 Lisp_Object tem;
1464 XSETSYMBOL (symbol, sym);
1465 tem = Fcons (symbol, (forwarded
1466 ? do_symval_forwarding (valcontents.fwd)
1467 : valcontents.value));
1469 /* Buffer_Local_Values cannot have as realval a buffer-local
1470 or keyboard-local forwarding. */
1471 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1472 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1473 blv->fwd = forwarded ? valcontents.fwd : NULL;
1474 set_blv_where (blv, Qnil);
1475 blv->frame_local = 0;
1476 blv->local_if_set = 0;
1477 set_blv_defcell (blv, tem);
1478 set_blv_valcell (blv, tem);
1479 set_blv_found (blv, 0);
1480 return blv;
1483 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1484 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1485 doc: /* Make VARIABLE become buffer-local whenever it is set.
1486 At any time, the value for the current buffer is in effect,
1487 unless the variable has never been set in this buffer,
1488 in which case the default value is in effect.
1489 Note that binding the variable with `let', or setting it while
1490 a `let'-style binding made in this buffer is in effect,
1491 does not make the variable buffer-local. Return VARIABLE.
1493 In most cases it is better to use `make-local-variable',
1494 which makes a variable local in just one buffer.
1496 The function `default-value' gets the default value and `set-default' sets it. */)
1497 (register Lisp_Object variable)
1499 struct Lisp_Symbol *sym;
1500 struct Lisp_Buffer_Local_Value *blv = NULL;
1501 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1502 bool forwarded IF_LINT (= 0);
1504 CHECK_SYMBOL (variable);
1505 sym = XSYMBOL (variable);
1507 start:
1508 switch (sym->redirect)
1510 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1511 case SYMBOL_PLAINVAL:
1512 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1513 if (EQ (valcontents.value, Qunbound))
1514 valcontents.value = Qnil;
1515 break;
1516 case SYMBOL_LOCALIZED:
1517 blv = SYMBOL_BLV (sym);
1518 if (blv->frame_local)
1519 error ("Symbol %s may not be buffer-local",
1520 SDATA (SYMBOL_NAME (variable)));
1521 break;
1522 case SYMBOL_FORWARDED:
1523 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1524 if (KBOARD_OBJFWDP (valcontents.fwd))
1525 error ("Symbol %s may not be buffer-local",
1526 SDATA (SYMBOL_NAME (variable)));
1527 else if (BUFFER_OBJFWDP (valcontents.fwd))
1528 return variable;
1529 break;
1530 default: emacs_abort ();
1533 if (sym->constant)
1534 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1536 if (!blv)
1538 blv = make_blv (sym, forwarded, valcontents);
1539 sym->redirect = SYMBOL_LOCALIZED;
1540 SET_SYMBOL_BLV (sym, blv);
1542 Lisp_Object symbol;
1543 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1544 if (let_shadows_global_binding_p (symbol))
1545 message ("Making %s buffer-local while let-bound!",
1546 SDATA (SYMBOL_NAME (variable)));
1550 blv->local_if_set = 1;
1551 return variable;
1554 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1555 1, 1, "vMake Local Variable: ",
1556 doc: /* Make VARIABLE have a separate value in the current buffer.
1557 Other buffers will continue to share a common default value.
1558 \(The buffer-local value of VARIABLE starts out as the same value
1559 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1560 Return VARIABLE.
1562 If the variable is already arranged to become local when set,
1563 this function causes a local value to exist for this buffer,
1564 just as setting the variable would do.
1566 This function returns VARIABLE, and therefore
1567 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1568 works.
1570 See also `make-variable-buffer-local'.
1572 Do not use `make-local-variable' to make a hook variable buffer-local.
1573 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1574 (Lisp_Object variable)
1576 Lisp_Object tem;
1577 bool forwarded IF_LINT (= 0);
1578 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1579 struct Lisp_Symbol *sym;
1580 struct Lisp_Buffer_Local_Value *blv = NULL;
1582 CHECK_SYMBOL (variable);
1583 sym = XSYMBOL (variable);
1585 start:
1586 switch (sym->redirect)
1588 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1589 case SYMBOL_PLAINVAL:
1590 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1591 case SYMBOL_LOCALIZED:
1592 blv = SYMBOL_BLV (sym);
1593 if (blv->frame_local)
1594 error ("Symbol %s may not be buffer-local",
1595 SDATA (SYMBOL_NAME (variable)));
1596 break;
1597 case SYMBOL_FORWARDED:
1598 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1599 if (KBOARD_OBJFWDP (valcontents.fwd))
1600 error ("Symbol %s may not be buffer-local",
1601 SDATA (SYMBOL_NAME (variable)));
1602 break;
1603 default: emacs_abort ();
1606 if (sym->constant)
1607 error ("Symbol %s may not be buffer-local",
1608 SDATA (SYMBOL_NAME (variable)));
1610 if (blv ? blv->local_if_set
1611 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1613 tem = Fboundp (variable);
1614 /* Make sure the symbol has a local value in this particular buffer,
1615 by setting it to the same value it already has. */
1616 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1617 return variable;
1619 if (!blv)
1621 blv = make_blv (sym, forwarded, valcontents);
1622 sym->redirect = SYMBOL_LOCALIZED;
1623 SET_SYMBOL_BLV (sym, blv);
1625 Lisp_Object symbol;
1626 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1627 if (let_shadows_global_binding_p (symbol))
1628 message ("Making %s local to %s while let-bound!",
1629 SDATA (SYMBOL_NAME (variable)),
1630 SDATA (BVAR (current_buffer, name)));
1634 /* Make sure this buffer has its own value of symbol. */
1635 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1636 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1637 if (NILP (tem))
1639 if (let_shadows_buffer_binding_p (sym))
1640 message ("Making %s buffer-local while locally let-bound!",
1641 SDATA (SYMBOL_NAME (variable)));
1643 /* Swap out any local binding for some other buffer, and make
1644 sure the current value is permanently recorded, if it's the
1645 default value. */
1646 find_symbol_value (variable);
1648 bset_local_var_alist
1649 (current_buffer,
1650 Fcons (Fcons (variable, XCDR (blv->defcell)),
1651 BVAR (current_buffer, local_var_alist)));
1653 /* Make sure symbol does not think it is set up for this buffer;
1654 force it to look once again for this buffer's value. */
1655 if (current_buffer == XBUFFER (blv->where))
1656 set_blv_where (blv, Qnil);
1657 set_blv_found (blv, 0);
1660 /* If the symbol forwards into a C variable, then load the binding
1661 for this buffer now. If C code modifies the variable before we
1662 load the binding in, then that new value will clobber the default
1663 binding the next time we unload it. */
1664 if (blv->fwd)
1665 swap_in_symval_forwarding (sym, blv);
1667 return variable;
1670 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1671 1, 1, "vKill Local Variable: ",
1672 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1673 From now on the default value will apply in this buffer. Return VARIABLE. */)
1674 (register Lisp_Object variable)
1676 register Lisp_Object tem;
1677 struct Lisp_Buffer_Local_Value *blv;
1678 struct Lisp_Symbol *sym;
1680 CHECK_SYMBOL (variable);
1681 sym = XSYMBOL (variable);
1683 start:
1684 switch (sym->redirect)
1686 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1687 case SYMBOL_PLAINVAL: return variable;
1688 case SYMBOL_FORWARDED:
1690 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1691 if (BUFFER_OBJFWDP (valcontents))
1693 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1694 int idx = PER_BUFFER_IDX (offset);
1696 if (idx > 0)
1698 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1699 set_per_buffer_value (current_buffer, offset,
1700 per_buffer_default (offset));
1703 return variable;
1705 case SYMBOL_LOCALIZED:
1706 blv = SYMBOL_BLV (sym);
1707 if (blv->frame_local)
1708 return variable;
1709 break;
1710 default: emacs_abort ();
1713 /* Get rid of this buffer's alist element, if any. */
1714 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1715 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1716 if (!NILP (tem))
1717 bset_local_var_alist
1718 (current_buffer,
1719 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1721 /* If the symbol is set up with the current buffer's binding
1722 loaded, recompute its value. We have to do it now, or else
1723 forwarded objects won't work right. */
1725 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1726 if (EQ (buf, blv->where))
1728 set_blv_where (blv, Qnil);
1729 blv->found = 0;
1730 find_symbol_value (variable);
1734 return variable;
1737 /* Lisp functions for creating and removing buffer-local variables. */
1739 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1740 when/if this is removed. */
1742 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1743 1, 1, "vMake Variable Frame Local: ",
1744 doc: /* Enable VARIABLE to have frame-local bindings.
1745 This does not create any frame-local bindings for VARIABLE,
1746 it just makes them possible.
1748 A frame-local binding is actually a frame parameter value.
1749 If a frame F has a value for the frame parameter named VARIABLE,
1750 that also acts as a frame-local binding for VARIABLE in F--
1751 provided this function has been called to enable VARIABLE
1752 to have frame-local bindings at all.
1754 The only way to create a frame-local binding for VARIABLE in a frame
1755 is to set the VARIABLE frame parameter of that frame. See
1756 `modify-frame-parameters' for how to set frame parameters.
1758 Note that since Emacs 23.1, variables cannot be both buffer-local and
1759 frame-local any more (buffer-local bindings used to take precedence over
1760 frame-local bindings). */)
1761 (Lisp_Object variable)
1763 bool forwarded;
1764 union Lisp_Val_Fwd valcontents;
1765 struct Lisp_Symbol *sym;
1766 struct Lisp_Buffer_Local_Value *blv = NULL;
1768 CHECK_SYMBOL (variable);
1769 sym = XSYMBOL (variable);
1771 start:
1772 switch (sym->redirect)
1774 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1775 case SYMBOL_PLAINVAL:
1776 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1777 if (EQ (valcontents.value, Qunbound))
1778 valcontents.value = Qnil;
1779 break;
1780 case SYMBOL_LOCALIZED:
1781 if (SYMBOL_BLV (sym)->frame_local)
1782 return variable;
1783 else
1784 error ("Symbol %s may not be frame-local",
1785 SDATA (SYMBOL_NAME (variable)));
1786 case SYMBOL_FORWARDED:
1787 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1788 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1789 error ("Symbol %s may not be frame-local",
1790 SDATA (SYMBOL_NAME (variable)));
1791 break;
1792 default: emacs_abort ();
1795 if (sym->constant)
1796 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1798 blv = make_blv (sym, forwarded, valcontents);
1799 blv->frame_local = 1;
1800 sym->redirect = SYMBOL_LOCALIZED;
1801 SET_SYMBOL_BLV (sym, blv);
1803 Lisp_Object symbol;
1804 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1805 if (let_shadows_global_binding_p (symbol))
1806 message ("Making %s frame-local while let-bound!",
1807 SDATA (SYMBOL_NAME (variable)));
1809 return variable;
1812 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1813 1, 2, 0,
1814 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1815 BUFFER defaults to the current buffer. */)
1816 (register Lisp_Object variable, Lisp_Object buffer)
1818 register struct buffer *buf;
1819 struct Lisp_Symbol *sym;
1821 if (NILP (buffer))
1822 buf = current_buffer;
1823 else
1825 CHECK_BUFFER (buffer);
1826 buf = XBUFFER (buffer);
1829 CHECK_SYMBOL (variable);
1830 sym = XSYMBOL (variable);
1832 start:
1833 switch (sym->redirect)
1835 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1836 case SYMBOL_PLAINVAL: return Qnil;
1837 case SYMBOL_LOCALIZED:
1839 Lisp_Object tail, elt, tmp;
1840 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1841 XSETBUFFER (tmp, buf);
1842 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1844 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1846 elt = XCAR (tail);
1847 if (EQ (variable, XCAR (elt)))
1849 eassert (!blv->frame_local);
1850 eassert (blv_found (blv) || !EQ (blv->where, tmp));
1851 return Qt;
1854 eassert (!blv_found (blv) || !EQ (blv->where, tmp));
1855 return Qnil;
1857 case SYMBOL_FORWARDED:
1859 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1860 if (BUFFER_OBJFWDP (valcontents))
1862 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1863 int idx = PER_BUFFER_IDX (offset);
1864 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1865 return Qt;
1867 return Qnil;
1869 default: emacs_abort ();
1873 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1874 1, 2, 0,
1875 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1876 BUFFER defaults to the current buffer.
1878 More precisely, return non-nil if either VARIABLE already has a local
1879 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1880 `make-variable-buffer-local'). */)
1881 (register Lisp_Object variable, Lisp_Object buffer)
1883 struct Lisp_Symbol *sym;
1885 CHECK_SYMBOL (variable);
1886 sym = XSYMBOL (variable);
1888 start:
1889 switch (sym->redirect)
1891 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1892 case SYMBOL_PLAINVAL: return Qnil;
1893 case SYMBOL_LOCALIZED:
1895 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1896 if (blv->local_if_set)
1897 return Qt;
1898 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1899 return Flocal_variable_p (variable, buffer);
1901 case SYMBOL_FORWARDED:
1902 /* All BUFFER_OBJFWD slots become local if they are set. */
1903 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1904 default: emacs_abort ();
1908 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1909 1, 1, 0,
1910 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1911 If the current binding is buffer-local, the value is the current buffer.
1912 If the current binding is frame-local, the value is the selected frame.
1913 If the current binding is global (the default), the value is nil. */)
1914 (register Lisp_Object variable)
1916 struct Lisp_Symbol *sym;
1918 CHECK_SYMBOL (variable);
1919 sym = XSYMBOL (variable);
1921 /* Make sure the current binding is actually swapped in. */
1922 find_symbol_value (variable);
1924 start:
1925 switch (sym->redirect)
1927 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1928 case SYMBOL_PLAINVAL: return Qnil;
1929 case SYMBOL_FORWARDED:
1931 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1932 if (KBOARD_OBJFWDP (valcontents))
1933 return Fframe_terminal (Fselected_frame ());
1934 else if (!BUFFER_OBJFWDP (valcontents))
1935 return Qnil;
1937 /* FALLTHROUGH */
1938 case SYMBOL_LOCALIZED:
1939 /* For a local variable, record both the symbol and which
1940 buffer's or frame's value we are saving. */
1941 if (!NILP (Flocal_variable_p (variable, Qnil)))
1942 return Fcurrent_buffer ();
1943 else if (sym->redirect == SYMBOL_LOCALIZED
1944 && blv_found (SYMBOL_BLV (sym)))
1945 return SYMBOL_BLV (sym)->where;
1946 else
1947 return Qnil;
1948 default: emacs_abort ();
1952 /* This code is disabled now that we use the selected frame to return
1953 keyboard-local-values. */
1954 #if 0
1955 extern struct terminal *get_terminal (Lisp_Object display, int);
1957 DEFUN ("terminal-local-value", Fterminal_local_value,
1958 Sterminal_local_value, 2, 2, 0,
1959 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1960 If SYMBOL is not a terminal-local variable, then return its normal
1961 value, like `symbol-value'.
1963 TERMINAL may be a terminal object, a frame, or nil (meaning the
1964 selected frame's terminal device). */)
1965 (Lisp_Object symbol, Lisp_Object terminal)
1967 Lisp_Object result;
1968 struct terminal *t = get_terminal (terminal, 1);
1969 push_kboard (t->kboard);
1970 result = Fsymbol_value (symbol);
1971 pop_kboard ();
1972 return result;
1975 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
1976 Sset_terminal_local_value, 3, 3, 0,
1977 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1978 If VARIABLE is not a terminal-local variable, then set its normal
1979 binding, like `set'.
1981 TERMINAL may be a terminal object, a frame, or nil (meaning the
1982 selected frame's terminal device). */)
1983 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1985 Lisp_Object result;
1986 struct terminal *t = get_terminal (terminal, 1);
1987 push_kboard (d->kboard);
1988 result = Fset (symbol, value);
1989 pop_kboard ();
1990 return result;
1992 #endif
1994 /* Find the function at the end of a chain of symbol function indirections. */
1996 /* If OBJECT is a symbol, find the end of its function chain and
1997 return the value found there. If OBJECT is not a symbol, just
1998 return it. If there is a cycle in the function chain, signal a
1999 cyclic-function-indirection error.
2001 This is like Findirect_function, except that it doesn't signal an
2002 error if the chain ends up unbound. */
2003 Lisp_Object
2004 indirect_function (register Lisp_Object object)
2006 Lisp_Object tortoise, hare;
2008 hare = tortoise = object;
2010 for (;;)
2012 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2013 break;
2014 hare = XSYMBOL (hare)->function;
2015 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2016 break;
2017 hare = XSYMBOL (hare)->function;
2019 tortoise = XSYMBOL (tortoise)->function;
2021 if (EQ (hare, tortoise))
2022 xsignal1 (Qcyclic_function_indirection, object);
2025 return hare;
2028 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2029 doc: /* Return the function at the end of OBJECT's function chain.
2030 If OBJECT is not a symbol, just return it. Otherwise, follow all
2031 function indirections to find the final function binding and return it.
2032 If the final symbol in the chain is unbound, signal a void-function error.
2033 Optional arg NOERROR non-nil means to return nil instead of signaling.
2034 Signal a cyclic-function-indirection error if there is a loop in the
2035 function chain of symbols. */)
2036 (register Lisp_Object object, Lisp_Object noerror)
2038 Lisp_Object result;
2040 /* Optimize for no indirection. */
2041 result = object;
2042 if (SYMBOLP (result) && !EQ (result, Qunbound)
2043 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2044 result = indirect_function (result);
2045 if (!EQ (result, Qunbound))
2046 return result;
2048 if (NILP (noerror))
2049 xsignal1 (Qvoid_function, object);
2051 return Qnil;
2054 /* Extract and set vector and string elements. */
2056 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2057 doc: /* Return the element of ARRAY at index IDX.
2058 ARRAY may be a vector, a string, a char-table, a bool-vector,
2059 or a byte-code object. IDX starts at 0. */)
2060 (register Lisp_Object array, Lisp_Object idx)
2062 register EMACS_INT idxval;
2064 CHECK_NUMBER (idx);
2065 idxval = XINT (idx);
2066 if (STRINGP (array))
2068 int c;
2069 ptrdiff_t idxval_byte;
2071 if (idxval < 0 || idxval >= SCHARS (array))
2072 args_out_of_range (array, idx);
2073 if (! STRING_MULTIBYTE (array))
2074 return make_number ((unsigned char) SREF (array, idxval));
2075 idxval_byte = string_char_to_byte (array, idxval);
2077 c = STRING_CHAR (SDATA (array) + idxval_byte);
2078 return make_number (c);
2080 else if (BOOL_VECTOR_P (array))
2082 int val;
2084 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2085 args_out_of_range (array, idx);
2087 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2088 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2090 else if (CHAR_TABLE_P (array))
2092 CHECK_CHARACTER (idx);
2093 return CHAR_TABLE_REF (array, idxval);
2095 else
2097 ptrdiff_t size = 0;
2098 if (VECTORP (array))
2099 size = ASIZE (array);
2100 else if (COMPILEDP (array))
2101 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2102 else
2103 wrong_type_argument (Qarrayp, array);
2105 if (idxval < 0 || idxval >= size)
2106 args_out_of_range (array, idx);
2107 return AREF (array, idxval);
2111 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2112 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2113 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2114 bool-vector. IDX starts at 0. */)
2115 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2117 register EMACS_INT idxval;
2119 CHECK_NUMBER (idx);
2120 idxval = XINT (idx);
2121 CHECK_ARRAY (array, Qarrayp);
2122 CHECK_IMPURE (array);
2124 if (VECTORP (array))
2126 if (idxval < 0 || idxval >= ASIZE (array))
2127 args_out_of_range (array, idx);
2128 ASET (array, idxval, newelt);
2130 else if (BOOL_VECTOR_P (array))
2132 int val;
2134 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2135 args_out_of_range (array, idx);
2137 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2139 if (! NILP (newelt))
2140 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2141 else
2142 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2143 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2145 else if (CHAR_TABLE_P (array))
2147 CHECK_CHARACTER (idx);
2148 CHAR_TABLE_SET (array, idxval, newelt);
2150 else
2152 int c;
2154 if (idxval < 0 || idxval >= SCHARS (array))
2155 args_out_of_range (array, idx);
2156 CHECK_CHARACTER (newelt);
2157 c = XFASTINT (newelt);
2159 if (STRING_MULTIBYTE (array))
2161 ptrdiff_t idxval_byte, nbytes;
2162 int prev_bytes, new_bytes;
2163 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2165 nbytes = SBYTES (array);
2166 idxval_byte = string_char_to_byte (array, idxval);
2167 p1 = SDATA (array) + idxval_byte;
2168 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2169 new_bytes = CHAR_STRING (c, p0);
2170 if (prev_bytes != new_bytes)
2172 /* We must relocate the string data. */
2173 ptrdiff_t nchars = SCHARS (array);
2174 USE_SAFE_ALLOCA;
2175 unsigned char *str = SAFE_ALLOCA (nbytes);
2177 memcpy (str, SDATA (array), nbytes);
2178 allocate_string_data (XSTRING (array), nchars,
2179 nbytes + new_bytes - prev_bytes);
2180 memcpy (SDATA (array), str, idxval_byte);
2181 p1 = SDATA (array) + idxval_byte;
2182 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2183 nbytes - (idxval_byte + prev_bytes));
2184 SAFE_FREE ();
2185 clear_string_char_byte_cache ();
2187 while (new_bytes--)
2188 *p1++ = *p0++;
2190 else
2192 if (! SINGLE_BYTE_CHAR_P (c))
2194 int i;
2196 for (i = SBYTES (array) - 1; i >= 0; i--)
2197 if (SREF (array, i) >= 0x80)
2198 args_out_of_range (array, newelt);
2199 /* ARRAY is an ASCII string. Convert it to a multibyte
2200 string, and try `aset' again. */
2201 STRING_SET_MULTIBYTE (array);
2202 return Faset (array, idx, newelt);
2204 SSET (array, idxval, c);
2208 return newelt;
2211 /* Arithmetic functions */
2213 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2215 static Lisp_Object
2216 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2218 double f1 = 0, f2 = 0;
2219 bool floatp = 0;
2221 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2222 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2224 if (FLOATP (num1) || FLOATP (num2))
2226 floatp = 1;
2227 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2228 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2231 switch (comparison)
2233 case equal:
2234 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2235 return Qt;
2236 return Qnil;
2238 case notequal:
2239 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2240 return Qt;
2241 return Qnil;
2243 case less:
2244 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2245 return Qt;
2246 return Qnil;
2248 case less_or_equal:
2249 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2250 return Qt;
2251 return Qnil;
2253 case grtr:
2254 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2255 return Qt;
2256 return Qnil;
2258 case grtr_or_equal:
2259 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2260 return Qt;
2261 return Qnil;
2263 default:
2264 emacs_abort ();
2268 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2269 doc: /* Return t if two args, both numbers or markers, are equal. */)
2270 (register Lisp_Object num1, Lisp_Object num2)
2272 return arithcompare (num1, num2, equal);
2275 DEFUN ("<", Flss, Slss, 2, 2, 0,
2276 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2277 (register Lisp_Object num1, Lisp_Object num2)
2279 return arithcompare (num1, num2, less);
2282 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2283 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2284 (register Lisp_Object num1, Lisp_Object num2)
2286 return arithcompare (num1, num2, grtr);
2289 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2290 doc: /* Return t if first arg is less than or equal to second arg.
2291 Both must be numbers or markers. */)
2292 (register Lisp_Object num1, Lisp_Object num2)
2294 return arithcompare (num1, num2, less_or_equal);
2297 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2298 doc: /* Return t if first arg is greater than or equal to second arg.
2299 Both must be numbers or markers. */)
2300 (register Lisp_Object num1, Lisp_Object num2)
2302 return arithcompare (num1, num2, grtr_or_equal);
2305 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2306 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2307 (register Lisp_Object num1, Lisp_Object num2)
2309 return arithcompare (num1, num2, notequal);
2312 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2313 doc: /* Return t if NUMBER is zero. */)
2314 (register Lisp_Object number)
2316 CHECK_NUMBER_OR_FLOAT (number);
2318 if (FLOATP (number))
2320 if (XFLOAT_DATA (number) == 0.0)
2321 return Qt;
2322 return Qnil;
2325 if (!XINT (number))
2326 return Qt;
2327 return Qnil;
2330 /* Convert the cons-of-integers, integer, or float value C to an
2331 unsigned value with maximum value MAX. Signal an error if C does not
2332 have a valid format or is out of range. */
2333 uintmax_t
2334 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2336 bool valid = 0;
2337 uintmax_t val IF_LINT (= 0);
2338 if (INTEGERP (c))
2340 valid = 0 <= XINT (c);
2341 val = XINT (c);
2343 else if (FLOATP (c))
2345 double d = XFLOAT_DATA (c);
2346 if (0 <= d
2347 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2349 val = d;
2350 valid = 1;
2353 else if (CONSP (c) && NATNUMP (XCAR (c)))
2355 uintmax_t top = XFASTINT (XCAR (c));
2356 Lisp_Object rest = XCDR (c);
2357 if (top <= UINTMAX_MAX >> 24 >> 16
2358 && CONSP (rest)
2359 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2360 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2362 uintmax_t mid = XFASTINT (XCAR (rest));
2363 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2364 valid = 1;
2366 else if (top <= UINTMAX_MAX >> 16)
2368 if (CONSP (rest))
2369 rest = XCAR (rest);
2370 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2372 val = top << 16 | XFASTINT (rest);
2373 valid = 1;
2378 if (! (valid && val <= max))
2379 error ("Not an in-range integer, float, or cons of integers");
2380 return val;
2383 /* Convert the cons-of-integers, integer, or float value C to a signed
2384 value with extrema MIN and MAX. Signal an error if C does not have
2385 a valid format or is out of range. */
2386 intmax_t
2387 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2389 bool valid = 0;
2390 intmax_t val IF_LINT (= 0);
2391 if (INTEGERP (c))
2393 val = XINT (c);
2394 valid = 1;
2396 else if (FLOATP (c))
2398 double d = XFLOAT_DATA (c);
2399 if (min <= d
2400 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2402 val = d;
2403 valid = 1;
2406 else if (CONSP (c) && INTEGERP (XCAR (c)))
2408 intmax_t top = XINT (XCAR (c));
2409 Lisp_Object rest = XCDR (c);
2410 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2411 && CONSP (rest)
2412 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2413 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2415 intmax_t mid = XFASTINT (XCAR (rest));
2416 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2417 valid = 1;
2419 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2421 if (CONSP (rest))
2422 rest = XCAR (rest);
2423 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2425 val = top << 16 | XFASTINT (rest);
2426 valid = 1;
2431 if (! (valid && min <= val && val <= max))
2432 error ("Not an in-range integer, float, or cons of integers");
2433 return val;
2436 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2437 doc: /* Return the decimal representation of NUMBER as a string.
2438 Uses a minus sign if negative.
2439 NUMBER may be an integer or a floating point number. */)
2440 (Lisp_Object number)
2442 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2443 int len;
2445 CHECK_NUMBER_OR_FLOAT (number);
2447 if (FLOATP (number))
2448 len = float_to_string (buffer, XFLOAT_DATA (number));
2449 else
2450 len = sprintf (buffer, "%"pI"d", XINT (number));
2452 return make_unibyte_string (buffer, len);
2455 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2456 doc: /* Parse STRING as a decimal number and return the number.
2457 This parses both integers and floating point numbers.
2458 It ignores leading spaces and tabs, and all trailing chars.
2460 If BASE, interpret STRING as a number in that base. If BASE isn't
2461 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2462 If the base used is not 10, STRING is always parsed as integer. */)
2463 (register Lisp_Object string, Lisp_Object base)
2465 register char *p;
2466 register int b;
2467 Lisp_Object val;
2469 CHECK_STRING (string);
2471 if (NILP (base))
2472 b = 10;
2473 else
2475 CHECK_NUMBER (base);
2476 if (! (2 <= XINT (base) && XINT (base) <= 16))
2477 xsignal1 (Qargs_out_of_range, base);
2478 b = XINT (base);
2481 p = SSDATA (string);
2482 while (*p == ' ' || *p == '\t')
2483 p++;
2485 val = string_to_number (p, b, 1);
2486 return NILP (val) ? make_number (0) : val;
2489 enum arithop
2491 Aadd,
2492 Asub,
2493 Amult,
2494 Adiv,
2495 Alogand,
2496 Alogior,
2497 Alogxor,
2498 Amax,
2499 Amin
2502 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2503 ptrdiff_t, Lisp_Object *);
2504 static Lisp_Object
2505 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2507 Lisp_Object val;
2508 ptrdiff_t argnum, ok_args;
2509 EMACS_INT accum = 0;
2510 EMACS_INT next, ok_accum;
2511 bool overflow = 0;
2513 switch (code)
2515 case Alogior:
2516 case Alogxor:
2517 case Aadd:
2518 case Asub:
2519 accum = 0;
2520 break;
2521 case Amult:
2522 accum = 1;
2523 break;
2524 case Alogand:
2525 accum = -1;
2526 break;
2527 default:
2528 break;
2531 for (argnum = 0; argnum < nargs; argnum++)
2533 if (! overflow)
2535 ok_args = argnum;
2536 ok_accum = accum;
2539 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2540 val = args[argnum];
2541 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2543 if (FLOATP (val))
2544 return float_arith_driver (ok_accum, ok_args, code,
2545 nargs, args);
2546 args[argnum] = val;
2547 next = XINT (args[argnum]);
2548 switch (code)
2550 case Aadd:
2551 if (INT_ADD_OVERFLOW (accum, next))
2553 overflow = 1;
2554 accum &= INTMASK;
2556 accum += next;
2557 break;
2558 case Asub:
2559 if (INT_SUBTRACT_OVERFLOW (accum, next))
2561 overflow = 1;
2562 accum &= INTMASK;
2564 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2565 break;
2566 case Amult:
2567 if (INT_MULTIPLY_OVERFLOW (accum, next))
2569 EMACS_UINT a = accum, b = next, ab = a * b;
2570 overflow = 1;
2571 accum = ab & INTMASK;
2573 else
2574 accum *= next;
2575 break;
2576 case Adiv:
2577 if (!argnum)
2578 accum = next;
2579 else
2581 if (next == 0)
2582 xsignal0 (Qarith_error);
2583 accum /= next;
2585 break;
2586 case Alogand:
2587 accum &= next;
2588 break;
2589 case Alogior:
2590 accum |= next;
2591 break;
2592 case Alogxor:
2593 accum ^= next;
2594 break;
2595 case Amax:
2596 if (!argnum || next > accum)
2597 accum = next;
2598 break;
2599 case Amin:
2600 if (!argnum || next < accum)
2601 accum = next;
2602 break;
2606 XSETINT (val, accum);
2607 return val;
2610 #undef isnan
2611 #define isnan(x) ((x) != (x))
2613 static Lisp_Object
2614 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2615 ptrdiff_t nargs, Lisp_Object *args)
2617 register Lisp_Object val;
2618 double next;
2620 for (; argnum < nargs; argnum++)
2622 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2623 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2625 if (FLOATP (val))
2627 next = XFLOAT_DATA (val);
2629 else
2631 args[argnum] = val; /* runs into a compiler bug. */
2632 next = XINT (args[argnum]);
2634 switch (code)
2636 case Aadd:
2637 accum += next;
2638 break;
2639 case Asub:
2640 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2641 break;
2642 case Amult:
2643 accum *= next;
2644 break;
2645 case Adiv:
2646 if (!argnum)
2647 accum = next;
2648 else
2650 if (! IEEE_FLOATING_POINT && next == 0)
2651 xsignal0 (Qarith_error);
2652 accum /= next;
2654 break;
2655 case Alogand:
2656 case Alogior:
2657 case Alogxor:
2658 return wrong_type_argument (Qinteger_or_marker_p, val);
2659 case Amax:
2660 if (!argnum || isnan (next) || next > accum)
2661 accum = next;
2662 break;
2663 case Amin:
2664 if (!argnum || isnan (next) || next < accum)
2665 accum = next;
2666 break;
2670 return make_float (accum);
2674 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2675 doc: /* Return sum of any number of arguments, which are numbers or markers.
2676 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2677 (ptrdiff_t nargs, Lisp_Object *args)
2679 return arith_driver (Aadd, nargs, args);
2682 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2683 doc: /* Negate number or subtract numbers or markers and return the result.
2684 With one arg, negates it. With more than one arg,
2685 subtracts all but the first from the first.
2686 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2687 (ptrdiff_t nargs, Lisp_Object *args)
2689 return arith_driver (Asub, nargs, args);
2692 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2693 doc: /* Return product of any number of arguments, which are numbers or markers.
2694 usage: (* &rest NUMBERS-OR-MARKERS) */)
2695 (ptrdiff_t nargs, Lisp_Object *args)
2697 return arith_driver (Amult, nargs, args);
2700 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2701 doc: /* Return first argument divided by all the remaining arguments.
2702 The arguments must be numbers or markers.
2703 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2704 (ptrdiff_t nargs, Lisp_Object *args)
2706 ptrdiff_t argnum;
2707 for (argnum = 2; argnum < nargs; argnum++)
2708 if (FLOATP (args[argnum]))
2709 return float_arith_driver (0, 0, Adiv, nargs, args);
2710 return arith_driver (Adiv, nargs, args);
2713 DEFUN ("%", Frem, Srem, 2, 2, 0,
2714 doc: /* Return remainder of X divided by Y.
2715 Both must be integers or markers. */)
2716 (register Lisp_Object x, Lisp_Object y)
2718 Lisp_Object val;
2720 CHECK_NUMBER_COERCE_MARKER (x);
2721 CHECK_NUMBER_COERCE_MARKER (y);
2723 if (XINT (y) == 0)
2724 xsignal0 (Qarith_error);
2726 XSETINT (val, XINT (x) % XINT (y));
2727 return val;
2730 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2731 doc: /* Return X modulo Y.
2732 The result falls between zero (inclusive) and Y (exclusive).
2733 Both X and Y must be numbers or markers. */)
2734 (register Lisp_Object x, Lisp_Object y)
2736 Lisp_Object val;
2737 EMACS_INT i1, i2;
2739 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2740 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2742 if (FLOATP (x) || FLOATP (y))
2743 return fmod_float (x, y);
2745 i1 = XINT (x);
2746 i2 = XINT (y);
2748 if (i2 == 0)
2749 xsignal0 (Qarith_error);
2751 i1 %= i2;
2753 /* If the "remainder" comes out with the wrong sign, fix it. */
2754 if (i2 < 0 ? i1 > 0 : i1 < 0)
2755 i1 += i2;
2757 XSETINT (val, i1);
2758 return val;
2761 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2762 doc: /* Return largest of all the arguments (which must be numbers or markers).
2763 The value is always a number; markers are converted to numbers.
2764 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2765 (ptrdiff_t nargs, Lisp_Object *args)
2767 return arith_driver (Amax, nargs, args);
2770 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2771 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2772 The value is always a number; markers are converted to numbers.
2773 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2774 (ptrdiff_t nargs, Lisp_Object *args)
2776 return arith_driver (Amin, nargs, args);
2779 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2780 doc: /* Return bitwise-and of all the arguments.
2781 Arguments may be integers, or markers converted to integers.
2782 usage: (logand &rest INTS-OR-MARKERS) */)
2783 (ptrdiff_t nargs, Lisp_Object *args)
2785 return arith_driver (Alogand, nargs, args);
2788 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2789 doc: /* Return bitwise-or of all the arguments.
2790 Arguments may be integers, or markers converted to integers.
2791 usage: (logior &rest INTS-OR-MARKERS) */)
2792 (ptrdiff_t nargs, Lisp_Object *args)
2794 return arith_driver (Alogior, nargs, args);
2797 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2798 doc: /* Return bitwise-exclusive-or of all the arguments.
2799 Arguments may be integers, or markers converted to integers.
2800 usage: (logxor &rest INTS-OR-MARKERS) */)
2801 (ptrdiff_t nargs, Lisp_Object *args)
2803 return arith_driver (Alogxor, nargs, args);
2806 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2807 doc: /* Return VALUE with its bits shifted left by COUNT.
2808 If COUNT is negative, shifting is actually to the right.
2809 In this case, the sign bit is duplicated. */)
2810 (register Lisp_Object value, Lisp_Object count)
2812 register Lisp_Object val;
2814 CHECK_NUMBER (value);
2815 CHECK_NUMBER (count);
2817 if (XINT (count) >= BITS_PER_EMACS_INT)
2818 XSETINT (val, 0);
2819 else if (XINT (count) > 0)
2820 XSETINT (val, XINT (value) << XFASTINT (count));
2821 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2822 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2823 else
2824 XSETINT (val, XINT (value) >> -XINT (count));
2825 return val;
2828 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2829 doc: /* Return VALUE with its bits shifted left by COUNT.
2830 If COUNT is negative, shifting is actually to the right.
2831 In this case, zeros are shifted in on the left. */)
2832 (register Lisp_Object value, Lisp_Object count)
2834 register Lisp_Object val;
2836 CHECK_NUMBER (value);
2837 CHECK_NUMBER (count);
2839 if (XINT (count) >= BITS_PER_EMACS_INT)
2840 XSETINT (val, 0);
2841 else if (XINT (count) > 0)
2842 XSETINT (val, XUINT (value) << XFASTINT (count));
2843 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2844 XSETINT (val, 0);
2845 else
2846 XSETINT (val, XUINT (value) >> -XINT (count));
2847 return val;
2850 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2851 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2852 Markers are converted to integers. */)
2853 (register Lisp_Object number)
2855 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2857 if (FLOATP (number))
2858 return (make_float (1.0 + XFLOAT_DATA (number)));
2860 XSETINT (number, XINT (number) + 1);
2861 return number;
2864 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2865 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2866 Markers are converted to integers. */)
2867 (register Lisp_Object number)
2869 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2871 if (FLOATP (number))
2872 return (make_float (-1.0 + XFLOAT_DATA (number)));
2874 XSETINT (number, XINT (number) - 1);
2875 return number;
2878 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2879 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2880 (register Lisp_Object number)
2882 CHECK_NUMBER (number);
2883 XSETINT (number, ~XINT (number));
2884 return number;
2887 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2888 doc: /* Return the byteorder for the machine.
2889 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2890 lowercase l) for small endian machines. */)
2891 (void)
2893 unsigned i = 0x04030201;
2894 int order = *(char *)&i == 1 ? 108 : 66;
2896 return make_number (order);
2901 void
2902 syms_of_data (void)
2904 Lisp_Object error_tail, arith_tail;
2906 DEFSYM (Qquote, "quote");
2907 DEFSYM (Qlambda, "lambda");
2908 DEFSYM (Qsubr, "subr");
2909 DEFSYM (Qerror_conditions, "error-conditions");
2910 DEFSYM (Qerror_message, "error-message");
2911 DEFSYM (Qtop_level, "top-level");
2913 DEFSYM (Qerror, "error");
2914 DEFSYM (Quser_error, "user-error");
2915 DEFSYM (Qquit, "quit");
2916 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2917 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2918 DEFSYM (Qvoid_function, "void-function");
2919 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2920 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2921 DEFSYM (Qvoid_variable, "void-variable");
2922 DEFSYM (Qsetting_constant, "setting-constant");
2923 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2925 DEFSYM (Qinvalid_function, "invalid-function");
2926 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2927 DEFSYM (Qno_catch, "no-catch");
2928 DEFSYM (Qend_of_file, "end-of-file");
2929 DEFSYM (Qarith_error, "arith-error");
2930 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2931 DEFSYM (Qend_of_buffer, "end-of-buffer");
2932 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2933 DEFSYM (Qtext_read_only, "text-read-only");
2934 DEFSYM (Qmark_inactive, "mark-inactive");
2936 DEFSYM (Qlistp, "listp");
2937 DEFSYM (Qconsp, "consp");
2938 DEFSYM (Qsymbolp, "symbolp");
2939 DEFSYM (Qkeywordp, "keywordp");
2940 DEFSYM (Qintegerp, "integerp");
2941 DEFSYM (Qnatnump, "natnump");
2942 DEFSYM (Qwholenump, "wholenump");
2943 DEFSYM (Qstringp, "stringp");
2944 DEFSYM (Qarrayp, "arrayp");
2945 DEFSYM (Qsequencep, "sequencep");
2946 DEFSYM (Qbufferp, "bufferp");
2947 DEFSYM (Qvectorp, "vectorp");
2948 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2949 DEFSYM (Qmarkerp, "markerp");
2950 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2951 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2952 DEFSYM (Qboundp, "boundp");
2953 DEFSYM (Qfboundp, "fboundp");
2955 DEFSYM (Qfloatp, "floatp");
2956 DEFSYM (Qnumberp, "numberp");
2957 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
2959 DEFSYM (Qchar_table_p, "char-table-p");
2960 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
2962 DEFSYM (Qsubrp, "subrp");
2963 DEFSYM (Qunevalled, "unevalled");
2964 DEFSYM (Qmany, "many");
2966 DEFSYM (Qcdr, "cdr");
2968 /* Handle automatic advice activation. */
2969 DEFSYM (Qad_advice_info, "ad-advice-info");
2970 DEFSYM (Qad_activate_internal, "ad-activate-internal");
2972 error_tail = pure_cons (Qerror, Qnil);
2974 /* ERROR is used as a signaler for random errors for which nothing else is
2975 right. */
2977 Fput (Qerror, Qerror_conditions,
2978 error_tail);
2979 Fput (Qerror, Qerror_message,
2980 build_pure_c_string ("error"));
2982 #define PUT_ERROR(sym, tail, msg) \
2983 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
2984 Fput (sym, Qerror_message, build_pure_c_string (msg))
2986 PUT_ERROR (Qquit, Qnil, "Quit");
2988 PUT_ERROR (Quser_error, error_tail, "");
2989 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
2990 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
2991 PUT_ERROR (Qvoid_function, error_tail,
2992 "Symbol's function definition is void");
2993 PUT_ERROR (Qcyclic_function_indirection, error_tail,
2994 "Symbol's chain of function indirections contains a loop");
2995 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
2996 "Symbol's chain of variable indirections contains a loop");
2997 DEFSYM (Qcircular_list, "circular-list");
2998 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
2999 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
3000 PUT_ERROR (Qsetting_constant, error_tail,
3001 "Attempt to set a constant symbol");
3002 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3003 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3004 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3005 "Wrong number of arguments");
3006 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3007 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3009 arith_tail = pure_cons (Qarith_error, error_tail);
3010 Fput (Qarith_error, Qerror_conditions, arith_tail);
3011 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3013 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3014 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3015 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3016 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3017 "Text is read-only");
3019 DEFSYM (Qrange_error, "range-error");
3020 DEFSYM (Qdomain_error, "domain-error");
3021 DEFSYM (Qsingularity_error, "singularity-error");
3022 DEFSYM (Qoverflow_error, "overflow-error");
3023 DEFSYM (Qunderflow_error, "underflow-error");
3025 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3027 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3029 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3030 "Arithmetic singularity error");
3032 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3033 "Arithmetic overflow error");
3034 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3035 "Arithmetic underflow error");
3037 staticpro (&Qnil);
3038 staticpro (&Qt);
3039 staticpro (&Qunbound);
3041 /* Types that type-of returns. */
3042 DEFSYM (Qinteger, "integer");
3043 DEFSYM (Qsymbol, "symbol");
3044 DEFSYM (Qstring, "string");
3045 DEFSYM (Qcons, "cons");
3046 DEFSYM (Qmarker, "marker");
3047 DEFSYM (Qoverlay, "overlay");
3048 DEFSYM (Qfloat, "float");
3049 DEFSYM (Qwindow_configuration, "window-configuration");
3050 DEFSYM (Qprocess, "process");
3051 DEFSYM (Qwindow, "window");
3052 DEFSYM (Qcompiled_function, "compiled-function");
3053 DEFSYM (Qbuffer, "buffer");
3054 DEFSYM (Qframe, "frame");
3055 DEFSYM (Qvector, "vector");
3056 DEFSYM (Qchar_table, "char-table");
3057 DEFSYM (Qbool_vector, "bool-vector");
3058 DEFSYM (Qhash_table, "hash-table");
3059 DEFSYM (Qmisc, "misc");
3061 DEFSYM (Qdefun, "defun");
3063 DEFSYM (Qfont_spec, "font-spec");
3064 DEFSYM (Qfont_entity, "font-entity");
3065 DEFSYM (Qfont_object, "font-object");
3067 DEFSYM (Qinteractive_form, "interactive-form");
3069 defsubr (&Sindirect_variable);
3070 defsubr (&Sinteractive_form);
3071 defsubr (&Seq);
3072 defsubr (&Snull);
3073 defsubr (&Stype_of);
3074 defsubr (&Slistp);
3075 defsubr (&Snlistp);
3076 defsubr (&Sconsp);
3077 defsubr (&Satom);
3078 defsubr (&Sintegerp);
3079 defsubr (&Sinteger_or_marker_p);
3080 defsubr (&Snumberp);
3081 defsubr (&Snumber_or_marker_p);
3082 defsubr (&Sfloatp);
3083 defsubr (&Snatnump);
3084 defsubr (&Ssymbolp);
3085 defsubr (&Skeywordp);
3086 defsubr (&Sstringp);
3087 defsubr (&Smultibyte_string_p);
3088 defsubr (&Svectorp);
3089 defsubr (&Schar_table_p);
3090 defsubr (&Svector_or_char_table_p);
3091 defsubr (&Sbool_vector_p);
3092 defsubr (&Sarrayp);
3093 defsubr (&Ssequencep);
3094 defsubr (&Sbufferp);
3095 defsubr (&Smarkerp);
3096 defsubr (&Ssubrp);
3097 defsubr (&Sbyte_code_function_p);
3098 defsubr (&Schar_or_string_p);
3099 defsubr (&Scar);
3100 defsubr (&Scdr);
3101 defsubr (&Scar_safe);
3102 defsubr (&Scdr_safe);
3103 defsubr (&Ssetcar);
3104 defsubr (&Ssetcdr);
3105 defsubr (&Ssymbol_function);
3106 defsubr (&Sindirect_function);
3107 defsubr (&Ssymbol_plist);
3108 defsubr (&Ssymbol_name);
3109 defsubr (&Smakunbound);
3110 defsubr (&Sfmakunbound);
3111 defsubr (&Sboundp);
3112 defsubr (&Sfboundp);
3113 defsubr (&Sfset);
3114 defsubr (&Sdefalias);
3115 defsubr (&Ssetplist);
3116 defsubr (&Ssymbol_value);
3117 defsubr (&Sset);
3118 defsubr (&Sdefault_boundp);
3119 defsubr (&Sdefault_value);
3120 defsubr (&Sset_default);
3121 defsubr (&Ssetq_default);
3122 defsubr (&Smake_variable_buffer_local);
3123 defsubr (&Smake_local_variable);
3124 defsubr (&Skill_local_variable);
3125 defsubr (&Smake_variable_frame_local);
3126 defsubr (&Slocal_variable_p);
3127 defsubr (&Slocal_variable_if_set_p);
3128 defsubr (&Svariable_binding_locus);
3129 #if 0 /* XXX Remove this. --lorentey */
3130 defsubr (&Sterminal_local_value);
3131 defsubr (&Sset_terminal_local_value);
3132 #endif
3133 defsubr (&Saref);
3134 defsubr (&Saset);
3135 defsubr (&Snumber_to_string);
3136 defsubr (&Sstring_to_number);
3137 defsubr (&Seqlsign);
3138 defsubr (&Slss);
3139 defsubr (&Sgtr);
3140 defsubr (&Sleq);
3141 defsubr (&Sgeq);
3142 defsubr (&Sneq);
3143 defsubr (&Szerop);
3144 defsubr (&Splus);
3145 defsubr (&Sminus);
3146 defsubr (&Stimes);
3147 defsubr (&Squo);
3148 defsubr (&Srem);
3149 defsubr (&Smod);
3150 defsubr (&Smax);
3151 defsubr (&Smin);
3152 defsubr (&Slogand);
3153 defsubr (&Slogior);
3154 defsubr (&Slogxor);
3155 defsubr (&Slsh);
3156 defsubr (&Sash);
3157 defsubr (&Sadd1);
3158 defsubr (&Ssub1);
3159 defsubr (&Slognot);
3160 defsubr (&Sbyteorder);
3161 defsubr (&Ssubr_arity);
3162 defsubr (&Ssubr_name);
3164 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3166 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3167 doc: /* The largest value that is representable in a Lisp integer. */);
3168 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3169 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3171 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3172 doc: /* The smallest value that is representable in a Lisp integer. */);
3173 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3174 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;