vc-hooks.el workaround for bug#11490
[emacs.git] / src / data.c
blobabcdd4dca0d0953918e8dbfacc0ca2e03fe1b758
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 (Lisp_Object symbol)
1053 Lisp_Object val;
1055 val = find_symbol_value (symbol);
1056 if (!EQ (val, Qunbound))
1057 return val;
1059 xsignal1 (Qvoid_variable, symbol);
1062 DEFUN ("set", Fset, Sset, 2, 2, 0,
1063 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1064 (register Lisp_Object symbol, Lisp_Object newval)
1066 set_internal (symbol, newval, Qnil, 0);
1067 return newval;
1070 /* Return true if SYMBOL currently has a let-binding
1071 which was made in the buffer that is now current. */
1073 static bool
1074 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1076 struct specbinding *p;
1078 for (p = specpdl_ptr; p > specpdl; )
1079 if ((--p)->func == NULL
1080 && CONSP (p->symbol))
1082 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1083 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1084 if (symbol == let_bound_symbol
1085 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1086 return 1;
1089 return 0;
1092 static bool
1093 let_shadows_global_binding_p (Lisp_Object symbol)
1095 struct specbinding *p;
1097 for (p = specpdl_ptr; p > specpdl; )
1098 if ((--p)->func == NULL && EQ (p->symbol, symbol))
1099 return 1;
1101 return 0;
1104 /* Store the value NEWVAL into SYMBOL.
1105 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1106 (nil stands for the current buffer/frame).
1108 If BINDFLAG is false, then if this symbol is supposed to become
1109 local in every buffer where it is set, then we make it local.
1110 If BINDFLAG is true, we don't do that. */
1112 void
1113 set_internal (Lisp_Object symbol, Lisp_Object newval, Lisp_Object where,
1114 bool bindflag)
1116 bool voide = EQ (newval, Qunbound);
1117 struct Lisp_Symbol *sym;
1118 Lisp_Object tem1;
1120 /* If restoring in a dead buffer, do nothing. */
1121 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1122 return; */
1124 CHECK_SYMBOL (symbol);
1125 if (SYMBOL_CONSTANT_P (symbol))
1127 if (NILP (Fkeywordp (symbol))
1128 || !EQ (newval, Fsymbol_value (symbol)))
1129 xsignal1 (Qsetting_constant, symbol);
1130 else
1131 /* Allow setting keywords to their own value. */
1132 return;
1135 sym = XSYMBOL (symbol);
1137 start:
1138 switch (sym->redirect)
1140 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1141 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1142 case SYMBOL_LOCALIZED:
1144 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1145 if (NILP (where))
1147 if (blv->frame_local)
1148 where = selected_frame;
1149 else
1150 XSETBUFFER (where, current_buffer);
1152 /* If the current buffer is not the buffer whose binding is
1153 loaded, or if there may be frame-local bindings and the frame
1154 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1155 the default binding is loaded, the loaded binding may be the
1156 wrong one. */
1157 if (!EQ (blv->where, where)
1158 /* Also unload a global binding (if the var is local_if_set). */
1159 || (EQ (blv->valcell, blv->defcell)))
1161 /* The currently loaded binding is not necessarily valid.
1162 We need to unload it, and choose a new binding. */
1164 /* Write out `realvalue' to the old loaded binding. */
1165 if (blv->fwd)
1166 set_blv_value (blv, do_symval_forwarding (blv->fwd));
1168 /* Find the new binding. */
1169 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1170 tem1 = Fassq (symbol,
1171 (blv->frame_local
1172 ? XFRAME (where)->param_alist
1173 : BVAR (XBUFFER (where), local_var_alist)));
1174 set_blv_where (blv, where);
1175 blv->found = 1;
1177 if (NILP (tem1))
1179 /* This buffer still sees the default value. */
1181 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1182 or if this is `let' rather than `set',
1183 make CURRENT-ALIST-ELEMENT point to itself,
1184 indicating that we're seeing the default value.
1185 Likewise if the variable has been let-bound
1186 in the current buffer. */
1187 if (bindflag || !blv->local_if_set
1188 || let_shadows_buffer_binding_p (sym))
1190 blv->found = 0;
1191 tem1 = blv->defcell;
1193 /* If it's a local_if_set, being set not bound,
1194 and we're not within a let that was made for this buffer,
1195 create a new buffer-local binding for the variable.
1196 That means, give this buffer a new assoc for a local value
1197 and load that binding. */
1198 else
1200 /* local_if_set is only supported for buffer-local
1201 bindings, not for frame-local bindings. */
1202 eassert (!blv->frame_local);
1203 tem1 = Fcons (symbol, XCDR (blv->defcell));
1204 bset_local_var_alist
1205 (XBUFFER (where),
1206 Fcons (tem1, BVAR (XBUFFER (where), local_var_alist)));
1210 /* Record which binding is now loaded. */
1211 set_blv_valcell (blv, tem1);
1214 /* Store the new value in the cons cell. */
1215 set_blv_value (blv, newval);
1217 if (blv->fwd)
1219 if (voide)
1220 /* If storing void (making the symbol void), forward only through
1221 buffer-local indicator, not through Lisp_Objfwd, etc. */
1222 blv->fwd = NULL;
1223 else
1224 store_symval_forwarding (blv->fwd, newval,
1225 BUFFERP (where)
1226 ? XBUFFER (where) : current_buffer);
1228 break;
1230 case SYMBOL_FORWARDED:
1232 struct buffer *buf
1233 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1234 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1235 if (BUFFER_OBJFWDP (innercontents))
1237 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1238 int idx = PER_BUFFER_IDX (offset);
1239 if (idx > 0
1240 && !bindflag
1241 && !let_shadows_buffer_binding_p (sym))
1242 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1245 if (voide)
1246 { /* If storing void (making the symbol void), forward only through
1247 buffer-local indicator, not through Lisp_Objfwd, etc. */
1248 sym->redirect = SYMBOL_PLAINVAL;
1249 SET_SYMBOL_VAL (sym, newval);
1251 else
1252 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1253 break;
1255 default: emacs_abort ();
1257 return;
1260 /* Access or set a buffer-local symbol's default value. */
1262 /* Return the default value of SYMBOL, but don't check for voidness.
1263 Return Qunbound if it is void. */
1265 static Lisp_Object
1266 default_value (Lisp_Object symbol)
1268 struct Lisp_Symbol *sym;
1270 CHECK_SYMBOL (symbol);
1271 sym = XSYMBOL (symbol);
1273 start:
1274 switch (sym->redirect)
1276 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1277 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1278 case SYMBOL_LOCALIZED:
1280 /* If var is set up for a buffer that lacks a local value for it,
1281 the current value is nominally the default value.
1282 But the `realvalue' slot may be more up to date, since
1283 ordinary setq stores just that slot. So use that. */
1284 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1285 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1286 return do_symval_forwarding (blv->fwd);
1287 else
1288 return XCDR (blv->defcell);
1290 case SYMBOL_FORWARDED:
1292 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1294 /* For a built-in buffer-local variable, get the default value
1295 rather than letting do_symval_forwarding get the current value. */
1296 if (BUFFER_OBJFWDP (valcontents))
1298 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1299 if (PER_BUFFER_IDX (offset) != 0)
1300 return per_buffer_default (offset);
1303 /* For other variables, get the current value. */
1304 return do_symval_forwarding (valcontents);
1306 default: emacs_abort ();
1310 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1311 doc: /* Return t if SYMBOL has a non-void default value.
1312 This is the value that is seen in buffers that do not have their own values
1313 for this variable. */)
1314 (Lisp_Object symbol)
1316 register Lisp_Object value;
1318 value = default_value (symbol);
1319 return (EQ (value, Qunbound) ? Qnil : Qt);
1322 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1323 doc: /* Return SYMBOL's default value.
1324 This is the value that is seen in buffers that do not have their own values
1325 for this variable. The default value is meaningful for variables with
1326 local bindings in certain buffers. */)
1327 (Lisp_Object symbol)
1329 register Lisp_Object value;
1331 value = default_value (symbol);
1332 if (!EQ (value, Qunbound))
1333 return value;
1335 xsignal1 (Qvoid_variable, symbol);
1338 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1339 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1340 The default value is seen in buffers that do not have their own values
1341 for this variable. */)
1342 (Lisp_Object symbol, Lisp_Object value)
1344 struct Lisp_Symbol *sym;
1346 CHECK_SYMBOL (symbol);
1347 if (SYMBOL_CONSTANT_P (symbol))
1349 if (NILP (Fkeywordp (symbol))
1350 || !EQ (value, Fdefault_value (symbol)))
1351 xsignal1 (Qsetting_constant, symbol);
1352 else
1353 /* Allow setting keywords to their own value. */
1354 return value;
1356 sym = XSYMBOL (symbol);
1358 start:
1359 switch (sym->redirect)
1361 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1362 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1363 case SYMBOL_LOCALIZED:
1365 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1367 /* Store new value into the DEFAULT-VALUE slot. */
1368 XSETCDR (blv->defcell, value);
1370 /* If the default binding is now loaded, set the REALVALUE slot too. */
1371 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1372 store_symval_forwarding (blv->fwd, value, NULL);
1373 return value;
1375 case SYMBOL_FORWARDED:
1377 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1379 /* Handle variables like case-fold-search that have special slots
1380 in the buffer.
1381 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1382 if (BUFFER_OBJFWDP (valcontents))
1384 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1385 int idx = PER_BUFFER_IDX (offset);
1387 set_per_buffer_default (offset, value);
1389 /* If this variable is not always local in all buffers,
1390 set it in the buffers that don't nominally have a local value. */
1391 if (idx > 0)
1393 struct buffer *b;
1395 FOR_EACH_BUFFER (b)
1396 if (!PER_BUFFER_VALUE_P (b, idx))
1397 set_per_buffer_value (b, offset, value);
1399 return value;
1401 else
1402 return Fset (symbol, value);
1404 default: emacs_abort ();
1408 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1409 doc: /* Set the default value of variable VAR to VALUE.
1410 VAR, the variable name, is literal (not evaluated);
1411 VALUE is an expression: it is evaluated and its value returned.
1412 The default value of a variable is seen in buffers
1413 that do not have their own values for the variable.
1415 More generally, you can use multiple variables and values, as in
1416 (setq-default VAR VALUE VAR VALUE...)
1417 This sets each VAR's default value to the corresponding VALUE.
1418 The VALUE for the Nth VAR can refer to the new default values
1419 of previous VARs.
1420 usage: (setq-default [VAR VALUE]...) */)
1421 (Lisp_Object args)
1423 register Lisp_Object args_left;
1424 register Lisp_Object val, symbol;
1425 struct gcpro gcpro1;
1427 if (NILP (args))
1428 return Qnil;
1430 args_left = args;
1431 GCPRO1 (args);
1435 val = eval_sub (Fcar (Fcdr (args_left)));
1436 symbol = XCAR (args_left);
1437 Fset_default (symbol, val);
1438 args_left = Fcdr (XCDR (args_left));
1440 while (!NILP (args_left));
1442 UNGCPRO;
1443 return val;
1446 /* Lisp functions for creating and removing buffer-local variables. */
1448 union Lisp_Val_Fwd
1450 Lisp_Object value;
1451 union Lisp_Fwd *fwd;
1454 static struct Lisp_Buffer_Local_Value *
1455 make_blv (struct Lisp_Symbol *sym, bool forwarded,
1456 union Lisp_Val_Fwd valcontents)
1458 struct Lisp_Buffer_Local_Value *blv = xmalloc (sizeof *blv);
1459 Lisp_Object symbol;
1460 Lisp_Object tem;
1462 XSETSYMBOL (symbol, sym);
1463 tem = Fcons (symbol, (forwarded
1464 ? do_symval_forwarding (valcontents.fwd)
1465 : valcontents.value));
1467 /* Buffer_Local_Values cannot have as realval a buffer-local
1468 or keyboard-local forwarding. */
1469 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1470 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1471 blv->fwd = forwarded ? valcontents.fwd : NULL;
1472 set_blv_where (blv, Qnil);
1473 blv->frame_local = 0;
1474 blv->local_if_set = 0;
1475 set_blv_defcell (blv, tem);
1476 set_blv_valcell (blv, tem);
1477 set_blv_found (blv, 0);
1478 return blv;
1481 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1482 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1483 doc: /* Make VARIABLE become buffer-local whenever it is set.
1484 At any time, the value for the current buffer is in effect,
1485 unless the variable has never been set in this buffer,
1486 in which case the default value is in effect.
1487 Note that binding the variable with `let', or setting it while
1488 a `let'-style binding made in this buffer is in effect,
1489 does not make the variable buffer-local. Return VARIABLE.
1491 In most cases it is better to use `make-local-variable',
1492 which makes a variable local in just one buffer.
1494 The function `default-value' gets the default value and `set-default' sets it. */)
1495 (register Lisp_Object variable)
1497 struct Lisp_Symbol *sym;
1498 struct Lisp_Buffer_Local_Value *blv = NULL;
1499 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1500 bool forwarded IF_LINT (= 0);
1502 CHECK_SYMBOL (variable);
1503 sym = XSYMBOL (variable);
1505 start:
1506 switch (sym->redirect)
1508 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1509 case SYMBOL_PLAINVAL:
1510 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1511 if (EQ (valcontents.value, Qunbound))
1512 valcontents.value = Qnil;
1513 break;
1514 case SYMBOL_LOCALIZED:
1515 blv = SYMBOL_BLV (sym);
1516 if (blv->frame_local)
1517 error ("Symbol %s may not be buffer-local",
1518 SDATA (SYMBOL_NAME (variable)));
1519 break;
1520 case SYMBOL_FORWARDED:
1521 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1522 if (KBOARD_OBJFWDP (valcontents.fwd))
1523 error ("Symbol %s may not be buffer-local",
1524 SDATA (SYMBOL_NAME (variable)));
1525 else if (BUFFER_OBJFWDP (valcontents.fwd))
1526 return variable;
1527 break;
1528 default: emacs_abort ();
1531 if (sym->constant)
1532 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1534 if (!blv)
1536 blv = make_blv (sym, forwarded, valcontents);
1537 sym->redirect = SYMBOL_LOCALIZED;
1538 SET_SYMBOL_BLV (sym, blv);
1540 Lisp_Object symbol;
1541 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1542 if (let_shadows_global_binding_p (symbol))
1543 message ("Making %s buffer-local while let-bound!",
1544 SDATA (SYMBOL_NAME (variable)));
1548 blv->local_if_set = 1;
1549 return variable;
1552 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1553 1, 1, "vMake Local Variable: ",
1554 doc: /* Make VARIABLE have a separate value in the current buffer.
1555 Other buffers will continue to share a common default value.
1556 \(The buffer-local value of VARIABLE starts out as the same value
1557 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1558 Return VARIABLE.
1560 If the variable is already arranged to become local when set,
1561 this function causes a local value to exist for this buffer,
1562 just as setting the variable would do.
1564 This function returns VARIABLE, and therefore
1565 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1566 works.
1568 See also `make-variable-buffer-local'.
1570 Do not use `make-local-variable' to make a hook variable buffer-local.
1571 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1572 (Lisp_Object variable)
1574 Lisp_Object tem;
1575 bool forwarded IF_LINT (= 0);
1576 union Lisp_Val_Fwd valcontents IF_LINT (= {LISP_INITIALLY_ZERO});
1577 struct Lisp_Symbol *sym;
1578 struct Lisp_Buffer_Local_Value *blv = NULL;
1580 CHECK_SYMBOL (variable);
1581 sym = XSYMBOL (variable);
1583 start:
1584 switch (sym->redirect)
1586 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1587 case SYMBOL_PLAINVAL:
1588 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1589 case SYMBOL_LOCALIZED:
1590 blv = SYMBOL_BLV (sym);
1591 if (blv->frame_local)
1592 error ("Symbol %s may not be buffer-local",
1593 SDATA (SYMBOL_NAME (variable)));
1594 break;
1595 case SYMBOL_FORWARDED:
1596 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1597 if (KBOARD_OBJFWDP (valcontents.fwd))
1598 error ("Symbol %s may not be buffer-local",
1599 SDATA (SYMBOL_NAME (variable)));
1600 break;
1601 default: emacs_abort ();
1604 if (sym->constant)
1605 error ("Symbol %s may not be buffer-local",
1606 SDATA (SYMBOL_NAME (variable)));
1608 if (blv ? blv->local_if_set
1609 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1611 tem = Fboundp (variable);
1612 /* Make sure the symbol has a local value in this particular buffer,
1613 by setting it to the same value it already has. */
1614 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1615 return variable;
1617 if (!blv)
1619 blv = make_blv (sym, forwarded, valcontents);
1620 sym->redirect = SYMBOL_LOCALIZED;
1621 SET_SYMBOL_BLV (sym, blv);
1623 Lisp_Object symbol;
1624 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1625 if (let_shadows_global_binding_p (symbol))
1626 message ("Making %s local to %s while let-bound!",
1627 SDATA (SYMBOL_NAME (variable)),
1628 SDATA (BVAR (current_buffer, name)));
1632 /* Make sure this buffer has its own value of symbol. */
1633 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1634 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1635 if (NILP (tem))
1637 if (let_shadows_buffer_binding_p (sym))
1638 message ("Making %s buffer-local while locally let-bound!",
1639 SDATA (SYMBOL_NAME (variable)));
1641 /* Swap out any local binding for some other buffer, and make
1642 sure the current value is permanently recorded, if it's the
1643 default value. */
1644 find_symbol_value (variable);
1646 bset_local_var_alist
1647 (current_buffer,
1648 Fcons (Fcons (variable, XCDR (blv->defcell)),
1649 BVAR (current_buffer, local_var_alist)));
1651 /* Make sure symbol does not think it is set up for this buffer;
1652 force it to look once again for this buffer's value. */
1653 if (current_buffer == XBUFFER (blv->where))
1654 set_blv_where (blv, Qnil);
1655 set_blv_found (blv, 0);
1658 /* If the symbol forwards into a C variable, then load the binding
1659 for this buffer now. If C code modifies the variable before we
1660 load the binding in, then that new value will clobber the default
1661 binding the next time we unload it. */
1662 if (blv->fwd)
1663 swap_in_symval_forwarding (sym, blv);
1665 return variable;
1668 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1669 1, 1, "vKill Local Variable: ",
1670 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1671 From now on the default value will apply in this buffer. Return VARIABLE. */)
1672 (register Lisp_Object variable)
1674 register Lisp_Object tem;
1675 struct Lisp_Buffer_Local_Value *blv;
1676 struct Lisp_Symbol *sym;
1678 CHECK_SYMBOL (variable);
1679 sym = XSYMBOL (variable);
1681 start:
1682 switch (sym->redirect)
1684 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1685 case SYMBOL_PLAINVAL: return variable;
1686 case SYMBOL_FORWARDED:
1688 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1689 if (BUFFER_OBJFWDP (valcontents))
1691 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1692 int idx = PER_BUFFER_IDX (offset);
1694 if (idx > 0)
1696 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1697 set_per_buffer_value (current_buffer, offset,
1698 per_buffer_default (offset));
1701 return variable;
1703 case SYMBOL_LOCALIZED:
1704 blv = SYMBOL_BLV (sym);
1705 if (blv->frame_local)
1706 return variable;
1707 break;
1708 default: emacs_abort ();
1711 /* Get rid of this buffer's alist element, if any. */
1712 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1713 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1714 if (!NILP (tem))
1715 bset_local_var_alist
1716 (current_buffer,
1717 Fdelq (tem, BVAR (current_buffer, local_var_alist)));
1719 /* If the symbol is set up with the current buffer's binding
1720 loaded, recompute its value. We have to do it now, or else
1721 forwarded objects won't work right. */
1723 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1724 if (EQ (buf, blv->where))
1726 set_blv_where (blv, Qnil);
1727 blv->found = 0;
1728 find_symbol_value (variable);
1732 return variable;
1735 /* Lisp functions for creating and removing buffer-local variables. */
1737 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1738 when/if this is removed. */
1740 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1741 1, 1, "vMake Variable Frame Local: ",
1742 doc: /* Enable VARIABLE to have frame-local bindings.
1743 This does not create any frame-local bindings for VARIABLE,
1744 it just makes them possible.
1746 A frame-local binding is actually a frame parameter value.
1747 If a frame F has a value for the frame parameter named VARIABLE,
1748 that also acts as a frame-local binding for VARIABLE in F--
1749 provided this function has been called to enable VARIABLE
1750 to have frame-local bindings at all.
1752 The only way to create a frame-local binding for VARIABLE in a frame
1753 is to set the VARIABLE frame parameter of that frame. See
1754 `modify-frame-parameters' for how to set frame parameters.
1756 Note that since Emacs 23.1, variables cannot be both buffer-local and
1757 frame-local any more (buffer-local bindings used to take precedence over
1758 frame-local bindings). */)
1759 (Lisp_Object variable)
1761 bool forwarded;
1762 union Lisp_Val_Fwd valcontents;
1763 struct Lisp_Symbol *sym;
1764 struct Lisp_Buffer_Local_Value *blv = NULL;
1766 CHECK_SYMBOL (variable);
1767 sym = XSYMBOL (variable);
1769 start:
1770 switch (sym->redirect)
1772 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1773 case SYMBOL_PLAINVAL:
1774 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1775 if (EQ (valcontents.value, Qunbound))
1776 valcontents.value = Qnil;
1777 break;
1778 case SYMBOL_LOCALIZED:
1779 if (SYMBOL_BLV (sym)->frame_local)
1780 return variable;
1781 else
1782 error ("Symbol %s may not be frame-local",
1783 SDATA (SYMBOL_NAME (variable)));
1784 case SYMBOL_FORWARDED:
1785 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1786 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1787 error ("Symbol %s may not be frame-local",
1788 SDATA (SYMBOL_NAME (variable)));
1789 break;
1790 default: emacs_abort ();
1793 if (sym->constant)
1794 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1796 blv = make_blv (sym, forwarded, valcontents);
1797 blv->frame_local = 1;
1798 sym->redirect = SYMBOL_LOCALIZED;
1799 SET_SYMBOL_BLV (sym, blv);
1801 Lisp_Object symbol;
1802 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1803 if (let_shadows_global_binding_p (symbol))
1804 message ("Making %s frame-local while let-bound!",
1805 SDATA (SYMBOL_NAME (variable)));
1807 return variable;
1810 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1811 1, 2, 0,
1812 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1813 BUFFER defaults to the current buffer. */)
1814 (register Lisp_Object variable, Lisp_Object buffer)
1816 register struct buffer *buf;
1817 struct Lisp_Symbol *sym;
1819 if (NILP (buffer))
1820 buf = current_buffer;
1821 else
1823 CHECK_BUFFER (buffer);
1824 buf = XBUFFER (buffer);
1827 CHECK_SYMBOL (variable);
1828 sym = XSYMBOL (variable);
1830 start:
1831 switch (sym->redirect)
1833 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1834 case SYMBOL_PLAINVAL: return Qnil;
1835 case SYMBOL_LOCALIZED:
1837 Lisp_Object tail, elt, tmp;
1838 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1839 XSETBUFFER (tmp, buf);
1840 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1842 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1844 elt = XCAR (tail);
1845 if (EQ (variable, XCAR (elt)))
1847 eassert (!blv->frame_local);
1848 eassert (blv_found (blv) || !EQ (blv->where, tmp));
1849 return Qt;
1852 eassert (!blv_found (blv) || !EQ (blv->where, tmp));
1853 return Qnil;
1855 case SYMBOL_FORWARDED:
1857 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1858 if (BUFFER_OBJFWDP (valcontents))
1860 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1861 int idx = PER_BUFFER_IDX (offset);
1862 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1863 return Qt;
1865 return Qnil;
1867 default: emacs_abort ();
1871 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1872 1, 2, 0,
1873 doc: /* Non-nil if VARIABLE is local in buffer BUFFER when set there.
1874 BUFFER defaults to the current buffer.
1876 More precisely, return non-nil if either VARIABLE already has a local
1877 value in BUFFER, or if VARIABLE is automatically buffer-local (see
1878 `make-variable-buffer-local'). */)
1879 (register Lisp_Object variable, Lisp_Object buffer)
1881 struct Lisp_Symbol *sym;
1883 CHECK_SYMBOL (variable);
1884 sym = XSYMBOL (variable);
1886 start:
1887 switch (sym->redirect)
1889 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1890 case SYMBOL_PLAINVAL: return Qnil;
1891 case SYMBOL_LOCALIZED:
1893 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1894 if (blv->local_if_set)
1895 return Qt;
1896 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1897 return Flocal_variable_p (variable, buffer);
1899 case SYMBOL_FORWARDED:
1900 /* All BUFFER_OBJFWD slots become local if they are set. */
1901 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1902 default: emacs_abort ();
1906 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1907 1, 1, 0,
1908 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1909 If the current binding is buffer-local, the value is the current buffer.
1910 If the current binding is frame-local, the value is the selected frame.
1911 If the current binding is global (the default), the value is nil. */)
1912 (register Lisp_Object variable)
1914 struct Lisp_Symbol *sym;
1916 CHECK_SYMBOL (variable);
1917 sym = XSYMBOL (variable);
1919 /* Make sure the current binding is actually swapped in. */
1920 find_symbol_value (variable);
1922 start:
1923 switch (sym->redirect)
1925 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1926 case SYMBOL_PLAINVAL: return Qnil;
1927 case SYMBOL_FORWARDED:
1929 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1930 if (KBOARD_OBJFWDP (valcontents))
1931 return Fframe_terminal (Fselected_frame ());
1932 else if (!BUFFER_OBJFWDP (valcontents))
1933 return Qnil;
1935 /* FALLTHROUGH */
1936 case SYMBOL_LOCALIZED:
1937 /* For a local variable, record both the symbol and which
1938 buffer's or frame's value we are saving. */
1939 if (!NILP (Flocal_variable_p (variable, Qnil)))
1940 return Fcurrent_buffer ();
1941 else if (sym->redirect == SYMBOL_LOCALIZED
1942 && blv_found (SYMBOL_BLV (sym)))
1943 return SYMBOL_BLV (sym)->where;
1944 else
1945 return Qnil;
1946 default: emacs_abort ();
1950 /* This code is disabled now that we use the selected frame to return
1951 keyboard-local-values. */
1952 #if 0
1953 extern struct terminal *get_terminal (Lisp_Object display, int);
1955 DEFUN ("terminal-local-value", Fterminal_local_value,
1956 Sterminal_local_value, 2, 2, 0,
1957 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1958 If SYMBOL is not a terminal-local variable, then return its normal
1959 value, like `symbol-value'.
1961 TERMINAL may be a terminal object, a frame, or nil (meaning the
1962 selected frame's terminal device). */)
1963 (Lisp_Object symbol, Lisp_Object terminal)
1965 Lisp_Object result;
1966 struct terminal *t = get_terminal (terminal, 1);
1967 push_kboard (t->kboard);
1968 result = Fsymbol_value (symbol);
1969 pop_kboard ();
1970 return result;
1973 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
1974 Sset_terminal_local_value, 3, 3, 0,
1975 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1976 If VARIABLE is not a terminal-local variable, then set its normal
1977 binding, like `set'.
1979 TERMINAL may be a terminal object, a frame, or nil (meaning the
1980 selected frame's terminal device). */)
1981 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1983 Lisp_Object result;
1984 struct terminal *t = get_terminal (terminal, 1);
1985 push_kboard (d->kboard);
1986 result = Fset (symbol, value);
1987 pop_kboard ();
1988 return result;
1990 #endif
1992 /* Find the function at the end of a chain of symbol function indirections. */
1994 /* If OBJECT is a symbol, find the end of its function chain and
1995 return the value found there. If OBJECT is not a symbol, just
1996 return it. If there is a cycle in the function chain, signal a
1997 cyclic-function-indirection error.
1999 This is like Findirect_function, except that it doesn't signal an
2000 error if the chain ends up unbound. */
2001 Lisp_Object
2002 indirect_function (register Lisp_Object object)
2004 Lisp_Object tortoise, hare;
2006 hare = tortoise = object;
2008 for (;;)
2010 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2011 break;
2012 hare = XSYMBOL (hare)->function;
2013 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2014 break;
2015 hare = XSYMBOL (hare)->function;
2017 tortoise = XSYMBOL (tortoise)->function;
2019 if (EQ (hare, tortoise))
2020 xsignal1 (Qcyclic_function_indirection, object);
2023 return hare;
2026 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2027 doc: /* Return the function at the end of OBJECT's function chain.
2028 If OBJECT is not a symbol, just return it. Otherwise, follow all
2029 function indirections to find the final function binding and return it.
2030 If the final symbol in the chain is unbound, signal a void-function error.
2031 Optional arg NOERROR non-nil means to return nil instead of signaling.
2032 Signal a cyclic-function-indirection error if there is a loop in the
2033 function chain of symbols. */)
2034 (register Lisp_Object object, Lisp_Object noerror)
2036 Lisp_Object result;
2038 /* Optimize for no indirection. */
2039 result = object;
2040 if (SYMBOLP (result) && !EQ (result, Qunbound)
2041 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2042 result = indirect_function (result);
2043 if (!EQ (result, Qunbound))
2044 return result;
2046 if (NILP (noerror))
2047 xsignal1 (Qvoid_function, object);
2049 return Qnil;
2052 /* Extract and set vector and string elements. */
2054 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2055 doc: /* Return the element of ARRAY at index IDX.
2056 ARRAY may be a vector, a string, a char-table, a bool-vector,
2057 or a byte-code object. IDX starts at 0. */)
2058 (register Lisp_Object array, Lisp_Object idx)
2060 register EMACS_INT idxval;
2062 CHECK_NUMBER (idx);
2063 idxval = XINT (idx);
2064 if (STRINGP (array))
2066 int c;
2067 ptrdiff_t idxval_byte;
2069 if (idxval < 0 || idxval >= SCHARS (array))
2070 args_out_of_range (array, idx);
2071 if (! STRING_MULTIBYTE (array))
2072 return make_number ((unsigned char) SREF (array, idxval));
2073 idxval_byte = string_char_to_byte (array, idxval);
2075 c = STRING_CHAR (SDATA (array) + idxval_byte);
2076 return make_number (c);
2078 else if (BOOL_VECTOR_P (array))
2080 int val;
2082 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2083 args_out_of_range (array, idx);
2085 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2086 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2088 else if (CHAR_TABLE_P (array))
2090 CHECK_CHARACTER (idx);
2091 return CHAR_TABLE_REF (array, idxval);
2093 else
2095 ptrdiff_t size = 0;
2096 if (VECTORP (array))
2097 size = ASIZE (array);
2098 else if (COMPILEDP (array))
2099 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2100 else
2101 wrong_type_argument (Qarrayp, array);
2103 if (idxval < 0 || idxval >= size)
2104 args_out_of_range (array, idx);
2105 return AREF (array, idxval);
2109 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2110 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2111 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2112 bool-vector. IDX starts at 0. */)
2113 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2115 register EMACS_INT idxval;
2117 CHECK_NUMBER (idx);
2118 idxval = XINT (idx);
2119 CHECK_ARRAY (array, Qarrayp);
2120 CHECK_IMPURE (array);
2122 if (VECTORP (array))
2124 if (idxval < 0 || idxval >= ASIZE (array))
2125 args_out_of_range (array, idx);
2126 ASET (array, idxval, newelt);
2128 else if (BOOL_VECTOR_P (array))
2130 int val;
2132 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2133 args_out_of_range (array, idx);
2135 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2137 if (! NILP (newelt))
2138 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2139 else
2140 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2141 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2143 else if (CHAR_TABLE_P (array))
2145 CHECK_CHARACTER (idx);
2146 CHAR_TABLE_SET (array, idxval, newelt);
2148 else
2150 int c;
2152 if (idxval < 0 || idxval >= SCHARS (array))
2153 args_out_of_range (array, idx);
2154 CHECK_CHARACTER (newelt);
2155 c = XFASTINT (newelt);
2157 if (STRING_MULTIBYTE (array))
2159 ptrdiff_t idxval_byte, nbytes;
2160 int prev_bytes, new_bytes;
2161 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2163 nbytes = SBYTES (array);
2164 idxval_byte = string_char_to_byte (array, idxval);
2165 p1 = SDATA (array) + idxval_byte;
2166 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2167 new_bytes = CHAR_STRING (c, p0);
2168 if (prev_bytes != new_bytes)
2170 /* We must relocate the string data. */
2171 ptrdiff_t nchars = SCHARS (array);
2172 USE_SAFE_ALLOCA;
2173 unsigned char *str = SAFE_ALLOCA (nbytes);
2175 memcpy (str, SDATA (array), nbytes);
2176 allocate_string_data (XSTRING (array), nchars,
2177 nbytes + new_bytes - prev_bytes);
2178 memcpy (SDATA (array), str, idxval_byte);
2179 p1 = SDATA (array) + idxval_byte;
2180 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2181 nbytes - (idxval_byte + prev_bytes));
2182 SAFE_FREE ();
2183 clear_string_char_byte_cache ();
2185 while (new_bytes--)
2186 *p1++ = *p0++;
2188 else
2190 if (! SINGLE_BYTE_CHAR_P (c))
2192 int i;
2194 for (i = SBYTES (array) - 1; i >= 0; i--)
2195 if (SREF (array, i) >= 0x80)
2196 args_out_of_range (array, newelt);
2197 /* ARRAY is an ASCII string. Convert it to a multibyte
2198 string, and try `aset' again. */
2199 STRING_SET_MULTIBYTE (array);
2200 return Faset (array, idx, newelt);
2202 SSET (array, idxval, c);
2206 return newelt;
2209 /* Arithmetic functions */
2211 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2213 static Lisp_Object
2214 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2216 double f1 = 0, f2 = 0;
2217 bool floatp = 0;
2219 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2220 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2222 if (FLOATP (num1) || FLOATP (num2))
2224 floatp = 1;
2225 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2226 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2229 switch (comparison)
2231 case equal:
2232 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2233 return Qt;
2234 return Qnil;
2236 case notequal:
2237 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2238 return Qt;
2239 return Qnil;
2241 case less:
2242 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2243 return Qt;
2244 return Qnil;
2246 case less_or_equal:
2247 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2248 return Qt;
2249 return Qnil;
2251 case grtr:
2252 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2253 return Qt;
2254 return Qnil;
2256 case grtr_or_equal:
2257 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2258 return Qt;
2259 return Qnil;
2261 default:
2262 emacs_abort ();
2266 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2267 doc: /* Return t if two args, both numbers or markers, are equal. */)
2268 (register Lisp_Object num1, Lisp_Object num2)
2270 return arithcompare (num1, num2, equal);
2273 DEFUN ("<", Flss, Slss, 2, 2, 0,
2274 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2275 (register Lisp_Object num1, Lisp_Object num2)
2277 return arithcompare (num1, num2, less);
2280 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2281 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2282 (register Lisp_Object num1, Lisp_Object num2)
2284 return arithcompare (num1, num2, grtr);
2287 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2288 doc: /* Return t if first arg is less than or equal to second arg.
2289 Both must be numbers or markers. */)
2290 (register Lisp_Object num1, Lisp_Object num2)
2292 return arithcompare (num1, num2, less_or_equal);
2295 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2296 doc: /* Return t if first arg is greater than or equal to second arg.
2297 Both must be numbers or markers. */)
2298 (register Lisp_Object num1, Lisp_Object num2)
2300 return arithcompare (num1, num2, grtr_or_equal);
2303 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2304 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2305 (register Lisp_Object num1, Lisp_Object num2)
2307 return arithcompare (num1, num2, notequal);
2310 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2311 doc: /* Return t if NUMBER is zero. */)
2312 (register Lisp_Object number)
2314 CHECK_NUMBER_OR_FLOAT (number);
2316 if (FLOATP (number))
2318 if (XFLOAT_DATA (number) == 0.0)
2319 return Qt;
2320 return Qnil;
2323 if (!XINT (number))
2324 return Qt;
2325 return Qnil;
2328 /* Convert the cons-of-integers, integer, or float value C to an
2329 unsigned value with maximum value MAX. Signal an error if C does not
2330 have a valid format or is out of range. */
2331 uintmax_t
2332 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2334 bool valid = 0;
2335 uintmax_t val IF_LINT (= 0);
2336 if (INTEGERP (c))
2338 valid = 0 <= XINT (c);
2339 val = XINT (c);
2341 else if (FLOATP (c))
2343 double d = XFLOAT_DATA (c);
2344 if (0 <= d
2345 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2347 val = d;
2348 valid = 1;
2351 else if (CONSP (c) && NATNUMP (XCAR (c)))
2353 uintmax_t top = XFASTINT (XCAR (c));
2354 Lisp_Object rest = XCDR (c);
2355 if (top <= UINTMAX_MAX >> 24 >> 16
2356 && CONSP (rest)
2357 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2358 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2360 uintmax_t mid = XFASTINT (XCAR (rest));
2361 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2362 valid = 1;
2364 else if (top <= UINTMAX_MAX >> 16)
2366 if (CONSP (rest))
2367 rest = XCAR (rest);
2368 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2370 val = top << 16 | XFASTINT (rest);
2371 valid = 1;
2376 if (! (valid && val <= max))
2377 error ("Not an in-range integer, float, or cons of integers");
2378 return val;
2381 /* Convert the cons-of-integers, integer, or float value C to a signed
2382 value with extrema MIN and MAX. Signal an error if C does not have
2383 a valid format or is out of range. */
2384 intmax_t
2385 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2387 bool valid = 0;
2388 intmax_t val IF_LINT (= 0);
2389 if (INTEGERP (c))
2391 val = XINT (c);
2392 valid = 1;
2394 else if (FLOATP (c))
2396 double d = XFLOAT_DATA (c);
2397 if (min <= d
2398 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2400 val = d;
2401 valid = 1;
2404 else if (CONSP (c) && INTEGERP (XCAR (c)))
2406 intmax_t top = XINT (XCAR (c));
2407 Lisp_Object rest = XCDR (c);
2408 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2409 && CONSP (rest)
2410 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2411 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2413 intmax_t mid = XFASTINT (XCAR (rest));
2414 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2415 valid = 1;
2417 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2419 if (CONSP (rest))
2420 rest = XCAR (rest);
2421 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2423 val = top << 16 | XFASTINT (rest);
2424 valid = 1;
2429 if (! (valid && min <= val && val <= max))
2430 error ("Not an in-range integer, float, or cons of integers");
2431 return val;
2434 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2435 doc: /* Return the decimal representation of NUMBER as a string.
2436 Uses a minus sign if negative.
2437 NUMBER may be an integer or a floating point number. */)
2438 (Lisp_Object number)
2440 char buffer[max (FLOAT_TO_STRING_BUFSIZE, INT_BUFSIZE_BOUND (EMACS_INT))];
2441 int len;
2443 CHECK_NUMBER_OR_FLOAT (number);
2445 if (FLOATP (number))
2446 len = float_to_string (buffer, XFLOAT_DATA (number));
2447 else
2448 len = sprintf (buffer, "%"pI"d", XINT (number));
2450 return make_unibyte_string (buffer, len);
2453 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2454 doc: /* Parse STRING as a decimal number and return the number.
2455 This parses both integers and floating point numbers.
2456 It ignores leading spaces and tabs, and all trailing chars.
2458 If BASE, interpret STRING as a number in that base. If BASE isn't
2459 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2460 If the base used is not 10, STRING is always parsed as integer. */)
2461 (register Lisp_Object string, Lisp_Object base)
2463 register char *p;
2464 register int b;
2465 Lisp_Object val;
2467 CHECK_STRING (string);
2469 if (NILP (base))
2470 b = 10;
2471 else
2473 CHECK_NUMBER (base);
2474 if (! (2 <= XINT (base) && XINT (base) <= 16))
2475 xsignal1 (Qargs_out_of_range, base);
2476 b = XINT (base);
2479 p = SSDATA (string);
2480 while (*p == ' ' || *p == '\t')
2481 p++;
2483 val = string_to_number (p, b, 1);
2484 return NILP (val) ? make_number (0) : val;
2487 enum arithop
2489 Aadd,
2490 Asub,
2491 Amult,
2492 Adiv,
2493 Alogand,
2494 Alogior,
2495 Alogxor,
2496 Amax,
2497 Amin
2500 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2501 ptrdiff_t, Lisp_Object *);
2502 static Lisp_Object
2503 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2505 Lisp_Object val;
2506 ptrdiff_t argnum, ok_args;
2507 EMACS_INT accum = 0;
2508 EMACS_INT next, ok_accum;
2509 bool overflow = 0;
2511 switch (code)
2513 case Alogior:
2514 case Alogxor:
2515 case Aadd:
2516 case Asub:
2517 accum = 0;
2518 break;
2519 case Amult:
2520 accum = 1;
2521 break;
2522 case Alogand:
2523 accum = -1;
2524 break;
2525 default:
2526 break;
2529 for (argnum = 0; argnum < nargs; argnum++)
2531 if (! overflow)
2533 ok_args = argnum;
2534 ok_accum = accum;
2537 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2538 val = args[argnum];
2539 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2541 if (FLOATP (val))
2542 return float_arith_driver (ok_accum, ok_args, code,
2543 nargs, args);
2544 args[argnum] = val;
2545 next = XINT (args[argnum]);
2546 switch (code)
2548 case Aadd:
2549 if (INT_ADD_OVERFLOW (accum, next))
2551 overflow = 1;
2552 accum &= INTMASK;
2554 accum += next;
2555 break;
2556 case Asub:
2557 if (INT_SUBTRACT_OVERFLOW (accum, next))
2559 overflow = 1;
2560 accum &= INTMASK;
2562 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2563 break;
2564 case Amult:
2565 if (INT_MULTIPLY_OVERFLOW (accum, next))
2567 EMACS_UINT a = accum, b = next, ab = a * b;
2568 overflow = 1;
2569 accum = ab & INTMASK;
2571 else
2572 accum *= next;
2573 break;
2574 case Adiv:
2575 if (!argnum)
2576 accum = next;
2577 else
2579 if (next == 0)
2580 xsignal0 (Qarith_error);
2581 accum /= next;
2583 break;
2584 case Alogand:
2585 accum &= next;
2586 break;
2587 case Alogior:
2588 accum |= next;
2589 break;
2590 case Alogxor:
2591 accum ^= next;
2592 break;
2593 case Amax:
2594 if (!argnum || next > accum)
2595 accum = next;
2596 break;
2597 case Amin:
2598 if (!argnum || next < accum)
2599 accum = next;
2600 break;
2604 XSETINT (val, accum);
2605 return val;
2608 #undef isnan
2609 #define isnan(x) ((x) != (x))
2611 static Lisp_Object
2612 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2613 ptrdiff_t nargs, Lisp_Object *args)
2615 register Lisp_Object val;
2616 double next;
2618 for (; argnum < nargs; argnum++)
2620 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2621 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2623 if (FLOATP (val))
2625 next = XFLOAT_DATA (val);
2627 else
2629 args[argnum] = val; /* runs into a compiler bug. */
2630 next = XINT (args[argnum]);
2632 switch (code)
2634 case Aadd:
2635 accum += next;
2636 break;
2637 case Asub:
2638 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2639 break;
2640 case Amult:
2641 accum *= next;
2642 break;
2643 case Adiv:
2644 if (!argnum)
2645 accum = next;
2646 else
2648 if (! IEEE_FLOATING_POINT && next == 0)
2649 xsignal0 (Qarith_error);
2650 accum /= next;
2652 break;
2653 case Alogand:
2654 case Alogior:
2655 case Alogxor:
2656 return wrong_type_argument (Qinteger_or_marker_p, val);
2657 case Amax:
2658 if (!argnum || isnan (next) || next > accum)
2659 accum = next;
2660 break;
2661 case Amin:
2662 if (!argnum || isnan (next) || next < accum)
2663 accum = next;
2664 break;
2668 return make_float (accum);
2672 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2673 doc: /* Return sum of any number of arguments, which are numbers or markers.
2674 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2675 (ptrdiff_t nargs, Lisp_Object *args)
2677 return arith_driver (Aadd, nargs, args);
2680 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2681 doc: /* Negate number or subtract numbers or markers and return the result.
2682 With one arg, negates it. With more than one arg,
2683 subtracts all but the first from the first.
2684 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2685 (ptrdiff_t nargs, Lisp_Object *args)
2687 return arith_driver (Asub, nargs, args);
2690 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2691 doc: /* Return product of any number of arguments, which are numbers or markers.
2692 usage: (* &rest NUMBERS-OR-MARKERS) */)
2693 (ptrdiff_t nargs, Lisp_Object *args)
2695 return arith_driver (Amult, nargs, args);
2698 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2699 doc: /* Return first argument divided by all the remaining arguments.
2700 The arguments must be numbers or markers.
2701 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2702 (ptrdiff_t nargs, Lisp_Object *args)
2704 ptrdiff_t argnum;
2705 for (argnum = 2; argnum < nargs; argnum++)
2706 if (FLOATP (args[argnum]))
2707 return float_arith_driver (0, 0, Adiv, nargs, args);
2708 return arith_driver (Adiv, nargs, args);
2711 DEFUN ("%", Frem, Srem, 2, 2, 0,
2712 doc: /* Return remainder of X divided by Y.
2713 Both must be integers or markers. */)
2714 (register Lisp_Object x, Lisp_Object y)
2716 Lisp_Object val;
2718 CHECK_NUMBER_COERCE_MARKER (x);
2719 CHECK_NUMBER_COERCE_MARKER (y);
2721 if (XINT (y) == 0)
2722 xsignal0 (Qarith_error);
2724 XSETINT (val, XINT (x) % XINT (y));
2725 return val;
2728 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2729 doc: /* Return X modulo Y.
2730 The result falls between zero (inclusive) and Y (exclusive).
2731 Both X and Y must be numbers or markers. */)
2732 (register Lisp_Object x, Lisp_Object y)
2734 Lisp_Object val;
2735 EMACS_INT i1, i2;
2737 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2738 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2740 if (FLOATP (x) || FLOATP (y))
2741 return fmod_float (x, y);
2743 i1 = XINT (x);
2744 i2 = XINT (y);
2746 if (i2 == 0)
2747 xsignal0 (Qarith_error);
2749 i1 %= i2;
2751 /* If the "remainder" comes out with the wrong sign, fix it. */
2752 if (i2 < 0 ? i1 > 0 : i1 < 0)
2753 i1 += i2;
2755 XSETINT (val, i1);
2756 return val;
2759 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2760 doc: /* Return largest of all the arguments (which must be numbers or markers).
2761 The value is always a number; markers are converted to numbers.
2762 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2763 (ptrdiff_t nargs, Lisp_Object *args)
2765 return arith_driver (Amax, nargs, args);
2768 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2769 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2770 The value is always a number; markers are converted to numbers.
2771 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2772 (ptrdiff_t nargs, Lisp_Object *args)
2774 return arith_driver (Amin, nargs, args);
2777 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2778 doc: /* Return bitwise-and of all the arguments.
2779 Arguments may be integers, or markers converted to integers.
2780 usage: (logand &rest INTS-OR-MARKERS) */)
2781 (ptrdiff_t nargs, Lisp_Object *args)
2783 return arith_driver (Alogand, nargs, args);
2786 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2787 doc: /* Return bitwise-or of all the arguments.
2788 Arguments may be integers, or markers converted to integers.
2789 usage: (logior &rest INTS-OR-MARKERS) */)
2790 (ptrdiff_t nargs, Lisp_Object *args)
2792 return arith_driver (Alogior, nargs, args);
2795 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2796 doc: /* Return bitwise-exclusive-or of all the arguments.
2797 Arguments may be integers, or markers converted to integers.
2798 usage: (logxor &rest INTS-OR-MARKERS) */)
2799 (ptrdiff_t nargs, Lisp_Object *args)
2801 return arith_driver (Alogxor, nargs, args);
2804 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2805 doc: /* Return VALUE with its bits shifted left by COUNT.
2806 If COUNT is negative, shifting is actually to the right.
2807 In this case, the sign bit is duplicated. */)
2808 (register Lisp_Object value, Lisp_Object count)
2810 register Lisp_Object val;
2812 CHECK_NUMBER (value);
2813 CHECK_NUMBER (count);
2815 if (XINT (count) >= BITS_PER_EMACS_INT)
2816 XSETINT (val, 0);
2817 else if (XINT (count) > 0)
2818 XSETINT (val, XINT (value) << XFASTINT (count));
2819 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2820 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2821 else
2822 XSETINT (val, XINT (value) >> -XINT (count));
2823 return val;
2826 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2827 doc: /* Return VALUE with its bits shifted left by COUNT.
2828 If COUNT is negative, shifting is actually to the right.
2829 In this case, zeros are shifted in on the left. */)
2830 (register Lisp_Object value, Lisp_Object count)
2832 register Lisp_Object val;
2834 CHECK_NUMBER (value);
2835 CHECK_NUMBER (count);
2837 if (XINT (count) >= BITS_PER_EMACS_INT)
2838 XSETINT (val, 0);
2839 else if (XINT (count) > 0)
2840 XSETINT (val, XUINT (value) << XFASTINT (count));
2841 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2842 XSETINT (val, 0);
2843 else
2844 XSETINT (val, XUINT (value) >> -XINT (count));
2845 return val;
2848 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2849 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2850 Markers are converted to integers. */)
2851 (register Lisp_Object number)
2853 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2855 if (FLOATP (number))
2856 return (make_float (1.0 + XFLOAT_DATA (number)));
2858 XSETINT (number, XINT (number) + 1);
2859 return number;
2862 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2863 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2864 Markers are converted to integers. */)
2865 (register Lisp_Object number)
2867 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2869 if (FLOATP (number))
2870 return (make_float (-1.0 + XFLOAT_DATA (number)));
2872 XSETINT (number, XINT (number) - 1);
2873 return number;
2876 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2877 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2878 (register Lisp_Object number)
2880 CHECK_NUMBER (number);
2881 XSETINT (number, ~XINT (number));
2882 return number;
2885 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2886 doc: /* Return the byteorder for the machine.
2887 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2888 lowercase l) for small endian machines. */)
2889 (void)
2891 unsigned i = 0x04030201;
2892 int order = *(char *)&i == 1 ? 108 : 66;
2894 return make_number (order);
2899 void
2900 syms_of_data (void)
2902 Lisp_Object error_tail, arith_tail;
2904 DEFSYM (Qquote, "quote");
2905 DEFSYM (Qlambda, "lambda");
2906 DEFSYM (Qsubr, "subr");
2907 DEFSYM (Qerror_conditions, "error-conditions");
2908 DEFSYM (Qerror_message, "error-message");
2909 DEFSYM (Qtop_level, "top-level");
2911 DEFSYM (Qerror, "error");
2912 DEFSYM (Quser_error, "user-error");
2913 DEFSYM (Qquit, "quit");
2914 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2915 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2916 DEFSYM (Qvoid_function, "void-function");
2917 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2918 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2919 DEFSYM (Qvoid_variable, "void-variable");
2920 DEFSYM (Qsetting_constant, "setting-constant");
2921 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2923 DEFSYM (Qinvalid_function, "invalid-function");
2924 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2925 DEFSYM (Qno_catch, "no-catch");
2926 DEFSYM (Qend_of_file, "end-of-file");
2927 DEFSYM (Qarith_error, "arith-error");
2928 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2929 DEFSYM (Qend_of_buffer, "end-of-buffer");
2930 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2931 DEFSYM (Qtext_read_only, "text-read-only");
2932 DEFSYM (Qmark_inactive, "mark-inactive");
2934 DEFSYM (Qlistp, "listp");
2935 DEFSYM (Qconsp, "consp");
2936 DEFSYM (Qsymbolp, "symbolp");
2937 DEFSYM (Qkeywordp, "keywordp");
2938 DEFSYM (Qintegerp, "integerp");
2939 DEFSYM (Qnatnump, "natnump");
2940 DEFSYM (Qwholenump, "wholenump");
2941 DEFSYM (Qstringp, "stringp");
2942 DEFSYM (Qarrayp, "arrayp");
2943 DEFSYM (Qsequencep, "sequencep");
2944 DEFSYM (Qbufferp, "bufferp");
2945 DEFSYM (Qvectorp, "vectorp");
2946 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2947 DEFSYM (Qmarkerp, "markerp");
2948 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2949 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2950 DEFSYM (Qboundp, "boundp");
2951 DEFSYM (Qfboundp, "fboundp");
2953 DEFSYM (Qfloatp, "floatp");
2954 DEFSYM (Qnumberp, "numberp");
2955 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
2957 DEFSYM (Qchar_table_p, "char-table-p");
2958 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
2960 DEFSYM (Qsubrp, "subrp");
2961 DEFSYM (Qunevalled, "unevalled");
2962 DEFSYM (Qmany, "many");
2964 DEFSYM (Qcdr, "cdr");
2966 /* Handle automatic advice activation. */
2967 DEFSYM (Qad_advice_info, "ad-advice-info");
2968 DEFSYM (Qad_activate_internal, "ad-activate-internal");
2970 error_tail = pure_cons (Qerror, Qnil);
2972 /* ERROR is used as a signaler for random errors for which nothing else is
2973 right. */
2975 Fput (Qerror, Qerror_conditions,
2976 error_tail);
2977 Fput (Qerror, Qerror_message,
2978 build_pure_c_string ("error"));
2980 #define PUT_ERROR(sym, tail, msg) \
2981 Fput (sym, Qerror_conditions, pure_cons (sym, tail)); \
2982 Fput (sym, Qerror_message, build_pure_c_string (msg))
2984 PUT_ERROR (Qquit, Qnil, "Quit");
2986 PUT_ERROR (Quser_error, error_tail, "");
2987 PUT_ERROR (Qwrong_type_argument, error_tail, "Wrong type argument");
2988 PUT_ERROR (Qargs_out_of_range, error_tail, "Args out of range");
2989 PUT_ERROR (Qvoid_function, error_tail,
2990 "Symbol's function definition is void");
2991 PUT_ERROR (Qcyclic_function_indirection, error_tail,
2992 "Symbol's chain of function indirections contains a loop");
2993 PUT_ERROR (Qcyclic_variable_indirection, error_tail,
2994 "Symbol's chain of variable indirections contains a loop");
2995 DEFSYM (Qcircular_list, "circular-list");
2996 PUT_ERROR (Qcircular_list, error_tail, "List contains a loop");
2997 PUT_ERROR (Qvoid_variable, error_tail, "Symbol's value as variable is void");
2998 PUT_ERROR (Qsetting_constant, error_tail,
2999 "Attempt to set a constant symbol");
3000 PUT_ERROR (Qinvalid_read_syntax, error_tail, "Invalid read syntax");
3001 PUT_ERROR (Qinvalid_function, error_tail, "Invalid function");
3002 PUT_ERROR (Qwrong_number_of_arguments, error_tail,
3003 "Wrong number of arguments");
3004 PUT_ERROR (Qno_catch, error_tail, "No catch for tag");
3005 PUT_ERROR (Qend_of_file, error_tail, "End of file during parsing");
3007 arith_tail = pure_cons (Qarith_error, error_tail);
3008 Fput (Qarith_error, Qerror_conditions, arith_tail);
3009 Fput (Qarith_error, Qerror_message, build_pure_c_string ("Arithmetic error"));
3011 PUT_ERROR (Qbeginning_of_buffer, error_tail, "Beginning of buffer");
3012 PUT_ERROR (Qend_of_buffer, error_tail, "End of buffer");
3013 PUT_ERROR (Qbuffer_read_only, error_tail, "Buffer is read-only");
3014 PUT_ERROR (Qtext_read_only, pure_cons (Qbuffer_read_only, error_tail),
3015 "Text is read-only");
3017 DEFSYM (Qrange_error, "range-error");
3018 DEFSYM (Qdomain_error, "domain-error");
3019 DEFSYM (Qsingularity_error, "singularity-error");
3020 DEFSYM (Qoverflow_error, "overflow-error");
3021 DEFSYM (Qunderflow_error, "underflow-error");
3023 PUT_ERROR (Qdomain_error, arith_tail, "Arithmetic domain error");
3025 PUT_ERROR (Qrange_error, arith_tail, "Arithmetic range error");
3027 PUT_ERROR (Qsingularity_error, Fcons (Qdomain_error, arith_tail),
3028 "Arithmetic singularity error");
3030 PUT_ERROR (Qoverflow_error, Fcons (Qdomain_error, arith_tail),
3031 "Arithmetic overflow error");
3032 PUT_ERROR (Qunderflow_error, Fcons (Qdomain_error, arith_tail),
3033 "Arithmetic underflow error");
3035 staticpro (&Qnil);
3036 staticpro (&Qt);
3037 staticpro (&Qunbound);
3039 /* Types that type-of returns. */
3040 DEFSYM (Qinteger, "integer");
3041 DEFSYM (Qsymbol, "symbol");
3042 DEFSYM (Qstring, "string");
3043 DEFSYM (Qcons, "cons");
3044 DEFSYM (Qmarker, "marker");
3045 DEFSYM (Qoverlay, "overlay");
3046 DEFSYM (Qfloat, "float");
3047 DEFSYM (Qwindow_configuration, "window-configuration");
3048 DEFSYM (Qprocess, "process");
3049 DEFSYM (Qwindow, "window");
3050 DEFSYM (Qcompiled_function, "compiled-function");
3051 DEFSYM (Qbuffer, "buffer");
3052 DEFSYM (Qframe, "frame");
3053 DEFSYM (Qvector, "vector");
3054 DEFSYM (Qchar_table, "char-table");
3055 DEFSYM (Qbool_vector, "bool-vector");
3056 DEFSYM (Qhash_table, "hash-table");
3057 DEFSYM (Qmisc, "misc");
3059 DEFSYM (Qdefun, "defun");
3061 DEFSYM (Qfont_spec, "font-spec");
3062 DEFSYM (Qfont_entity, "font-entity");
3063 DEFSYM (Qfont_object, "font-object");
3065 DEFSYM (Qinteractive_form, "interactive-form");
3067 defsubr (&Sindirect_variable);
3068 defsubr (&Sinteractive_form);
3069 defsubr (&Seq);
3070 defsubr (&Snull);
3071 defsubr (&Stype_of);
3072 defsubr (&Slistp);
3073 defsubr (&Snlistp);
3074 defsubr (&Sconsp);
3075 defsubr (&Satom);
3076 defsubr (&Sintegerp);
3077 defsubr (&Sinteger_or_marker_p);
3078 defsubr (&Snumberp);
3079 defsubr (&Snumber_or_marker_p);
3080 defsubr (&Sfloatp);
3081 defsubr (&Snatnump);
3082 defsubr (&Ssymbolp);
3083 defsubr (&Skeywordp);
3084 defsubr (&Sstringp);
3085 defsubr (&Smultibyte_string_p);
3086 defsubr (&Svectorp);
3087 defsubr (&Schar_table_p);
3088 defsubr (&Svector_or_char_table_p);
3089 defsubr (&Sbool_vector_p);
3090 defsubr (&Sarrayp);
3091 defsubr (&Ssequencep);
3092 defsubr (&Sbufferp);
3093 defsubr (&Smarkerp);
3094 defsubr (&Ssubrp);
3095 defsubr (&Sbyte_code_function_p);
3096 defsubr (&Schar_or_string_p);
3097 defsubr (&Scar);
3098 defsubr (&Scdr);
3099 defsubr (&Scar_safe);
3100 defsubr (&Scdr_safe);
3101 defsubr (&Ssetcar);
3102 defsubr (&Ssetcdr);
3103 defsubr (&Ssymbol_function);
3104 defsubr (&Sindirect_function);
3105 defsubr (&Ssymbol_plist);
3106 defsubr (&Ssymbol_name);
3107 defsubr (&Smakunbound);
3108 defsubr (&Sfmakunbound);
3109 defsubr (&Sboundp);
3110 defsubr (&Sfboundp);
3111 defsubr (&Sfset);
3112 defsubr (&Sdefalias);
3113 defsubr (&Ssetplist);
3114 defsubr (&Ssymbol_value);
3115 defsubr (&Sset);
3116 defsubr (&Sdefault_boundp);
3117 defsubr (&Sdefault_value);
3118 defsubr (&Sset_default);
3119 defsubr (&Ssetq_default);
3120 defsubr (&Smake_variable_buffer_local);
3121 defsubr (&Smake_local_variable);
3122 defsubr (&Skill_local_variable);
3123 defsubr (&Smake_variable_frame_local);
3124 defsubr (&Slocal_variable_p);
3125 defsubr (&Slocal_variable_if_set_p);
3126 defsubr (&Svariable_binding_locus);
3127 #if 0 /* XXX Remove this. --lorentey */
3128 defsubr (&Sterminal_local_value);
3129 defsubr (&Sset_terminal_local_value);
3130 #endif
3131 defsubr (&Saref);
3132 defsubr (&Saset);
3133 defsubr (&Snumber_to_string);
3134 defsubr (&Sstring_to_number);
3135 defsubr (&Seqlsign);
3136 defsubr (&Slss);
3137 defsubr (&Sgtr);
3138 defsubr (&Sleq);
3139 defsubr (&Sgeq);
3140 defsubr (&Sneq);
3141 defsubr (&Szerop);
3142 defsubr (&Splus);
3143 defsubr (&Sminus);
3144 defsubr (&Stimes);
3145 defsubr (&Squo);
3146 defsubr (&Srem);
3147 defsubr (&Smod);
3148 defsubr (&Smax);
3149 defsubr (&Smin);
3150 defsubr (&Slogand);
3151 defsubr (&Slogior);
3152 defsubr (&Slogxor);
3153 defsubr (&Slsh);
3154 defsubr (&Sash);
3155 defsubr (&Sadd1);
3156 defsubr (&Ssub1);
3157 defsubr (&Slognot);
3158 defsubr (&Sbyteorder);
3159 defsubr (&Ssubr_arity);
3160 defsubr (&Ssubr_name);
3162 set_symbol_function (Qwholenump, XSYMBOL (Qnatnump)->function);
3164 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3165 doc: /* The largest value that is representable in a Lisp integer. */);
3166 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3167 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3169 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3170 doc: /* The smallest value that is representable in a Lisp integer. */);
3171 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3172 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;