Add missing copyright years.
[emacs.git] / src / data.c
blob0a2d4b855de44f201f48de68921e39ee76b61970
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <setjmp.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"
36 #ifdef STDC_HEADERS
37 #include <float.h>
38 #endif
40 /* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
41 #ifndef IEEE_FLOATING_POINT
42 #if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
43 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
44 #define IEEE_FLOATING_POINT 1
45 #else
46 #define IEEE_FLOATING_POINT 0
47 #endif
48 #endif
50 #include <math.h>
52 #if !defined (atof)
53 extern double atof (const char *);
54 #endif /* !atof */
56 Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
57 Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
58 Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
59 Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
60 Lisp_Object Qcyclic_variable_indirection, Qcircular_list;
61 Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
62 Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
63 Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
64 Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
65 Lisp_Object Qtext_read_only;
67 Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
68 Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
69 Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
70 Lisp_Object Qbuffer_or_string_p, Qkeywordp;
71 Lisp_Object Qboundp, Qfboundp;
72 Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
74 Lisp_Object Qcdr;
75 Lisp_Object Qad_advice_info, Qad_activate_internal;
77 Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
78 Lisp_Object Qoverflow_error, Qunderflow_error;
80 Lisp_Object Qfloatp;
81 Lisp_Object Qnumberp, Qnumber_or_marker_p;
83 Lisp_Object Qinteger;
84 static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
85 Lisp_Object Qwindow;
86 static Lisp_Object Qfloat, Qwindow_configuration;
87 Lisp_Object Qprocess;
88 static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
89 static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
90 static Lisp_Object Qsubrp, Qmany, Qunevalled;
91 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
93 Lisp_Object Qinteractive_form;
95 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
97 Lisp_Object Vmost_positive_fixnum, Vmost_negative_fixnum;
100 void
101 circular_list_error (Lisp_Object list)
103 xsignal (Qcircular_list, list);
107 Lisp_Object
108 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
110 /* If VALUE is not even a valid Lisp object, we'd want to abort here
111 where we can get a backtrace showing where it came from. We used
112 to try and do that by checking the tagbits, but nowadays all
113 tagbits are potentially valid. */
114 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
115 * abort (); */
117 xsignal2 (Qwrong_type_argument, predicate, value);
120 void
121 pure_write_error (void)
123 error ("Attempt to modify read-only object");
126 void
127 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
129 xsignal2 (Qargs_out_of_range, a1, a2);
132 void
133 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
135 xsignal3 (Qargs_out_of_range, a1, a2, a3);
139 /* Data type predicates */
141 DEFUN ("eq", Feq, Seq, 2, 2, 0,
142 doc: /* Return t if the two args are the same Lisp object. */)
143 (Lisp_Object obj1, Lisp_Object obj2)
145 if (EQ (obj1, obj2))
146 return Qt;
147 return Qnil;
150 DEFUN ("null", Fnull, Snull, 1, 1, 0,
151 doc: /* Return t if OBJECT is nil. */)
152 (Lisp_Object object)
154 if (NILP (object))
155 return Qt;
156 return Qnil;
159 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
160 doc: /* Return a symbol representing the type of OBJECT.
161 The symbol returned names the object's basic type;
162 for example, (type-of 1) returns `integer'. */)
163 (Lisp_Object object)
165 switch (XTYPE (object))
167 case_Lisp_Int:
168 return Qinteger;
170 case Lisp_Symbol:
171 return Qsymbol;
173 case Lisp_String:
174 return Qstring;
176 case Lisp_Cons:
177 return Qcons;
179 case Lisp_Misc:
180 switch (XMISCTYPE (object))
182 case Lisp_Misc_Marker:
183 return Qmarker;
184 case Lisp_Misc_Overlay:
185 return Qoverlay;
186 case Lisp_Misc_Float:
187 return Qfloat;
189 abort ();
191 case Lisp_Vectorlike:
192 if (WINDOW_CONFIGURATIONP (object))
193 return Qwindow_configuration;
194 if (PROCESSP (object))
195 return Qprocess;
196 if (WINDOWP (object))
197 return Qwindow;
198 if (SUBRP (object))
199 return Qsubr;
200 if (COMPILEDP (object))
201 return Qcompiled_function;
202 if (BUFFERP (object))
203 return Qbuffer;
204 if (CHAR_TABLE_P (object))
205 return Qchar_table;
206 if (BOOL_VECTOR_P (object))
207 return Qbool_vector;
208 if (FRAMEP (object))
209 return Qframe;
210 if (HASH_TABLE_P (object))
211 return Qhash_table;
212 if (FONT_SPEC_P (object))
213 return Qfont_spec;
214 if (FONT_ENTITY_P (object))
215 return Qfont_entity;
216 if (FONT_OBJECT_P (object))
217 return Qfont_object;
218 return Qvector;
220 case Lisp_Float:
221 return Qfloat;
223 default:
224 abort ();
228 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
229 doc: /* Return t if OBJECT is a cons cell. */)
230 (Lisp_Object object)
232 if (CONSP (object))
233 return Qt;
234 return Qnil;
237 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
238 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
239 (Lisp_Object object)
241 if (CONSP (object))
242 return Qnil;
243 return Qt;
246 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
247 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
248 Otherwise, return nil. */)
249 (Lisp_Object object)
251 if (CONSP (object) || NILP (object))
252 return Qt;
253 return Qnil;
256 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
257 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
258 (Lisp_Object object)
260 if (CONSP (object) || NILP (object))
261 return Qnil;
262 return Qt;
265 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
266 doc: /* Return t if OBJECT is a symbol. */)
267 (Lisp_Object object)
269 if (SYMBOLP (object))
270 return Qt;
271 return Qnil;
274 /* Define this in C to avoid unnecessarily consing up the symbol
275 name. */
276 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
277 doc: /* Return t if OBJECT is a keyword.
278 This means that it is a symbol with a print name beginning with `:'
279 interned in the initial obarray. */)
280 (Lisp_Object object)
282 if (SYMBOLP (object)
283 && SREF (SYMBOL_NAME (object), 0) == ':'
284 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
285 return Qt;
286 return Qnil;
289 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
290 doc: /* Return t if OBJECT is a vector. */)
291 (Lisp_Object object)
293 if (VECTORP (object))
294 return Qt;
295 return Qnil;
298 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
299 doc: /* Return t if OBJECT is a string. */)
300 (Lisp_Object object)
302 if (STRINGP (object))
303 return Qt;
304 return Qnil;
307 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
308 1, 1, 0,
309 doc: /* Return t if OBJECT is a multibyte string. */)
310 (Lisp_Object object)
312 if (STRINGP (object) && STRING_MULTIBYTE (object))
313 return Qt;
314 return Qnil;
317 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
318 doc: /* Return t if OBJECT is a char-table. */)
319 (Lisp_Object object)
321 if (CHAR_TABLE_P (object))
322 return Qt;
323 return Qnil;
326 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
327 Svector_or_char_table_p, 1, 1, 0,
328 doc: /* Return t if OBJECT is a char-table or vector. */)
329 (Lisp_Object object)
331 if (VECTORP (object) || CHAR_TABLE_P (object))
332 return Qt;
333 return Qnil;
336 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
337 doc: /* Return t if OBJECT is a bool-vector. */)
338 (Lisp_Object object)
340 if (BOOL_VECTOR_P (object))
341 return Qt;
342 return Qnil;
345 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
346 doc: /* Return t if OBJECT is an array (string or vector). */)
347 (Lisp_Object object)
349 if (ARRAYP (object))
350 return Qt;
351 return Qnil;
354 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
355 doc: /* Return t if OBJECT is a sequence (list or array). */)
356 (register Lisp_Object object)
358 if (CONSP (object) || NILP (object) || ARRAYP (object))
359 return Qt;
360 return Qnil;
363 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
364 doc: /* Return t if OBJECT is an editor buffer. */)
365 (Lisp_Object object)
367 if (BUFFERP (object))
368 return Qt;
369 return Qnil;
372 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
373 doc: /* Return t if OBJECT is a marker (editor pointer). */)
374 (Lisp_Object object)
376 if (MARKERP (object))
377 return Qt;
378 return Qnil;
381 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
382 doc: /* Return t if OBJECT is a built-in function. */)
383 (Lisp_Object object)
385 if (SUBRP (object))
386 return Qt;
387 return Qnil;
390 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
391 1, 1, 0,
392 doc: /* Return t if OBJECT is a byte-compiled function object. */)
393 (Lisp_Object object)
395 if (COMPILEDP (object))
396 return Qt;
397 return Qnil;
400 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
401 doc: /* Return t if OBJECT is a character or a string. */)
402 (register Lisp_Object object)
404 if (CHARACTERP (object) || STRINGP (object))
405 return Qt;
406 return Qnil;
409 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
410 doc: /* Return t if OBJECT is an integer. */)
411 (Lisp_Object object)
413 if (INTEGERP (object))
414 return Qt;
415 return Qnil;
418 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
419 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
420 (register Lisp_Object object)
422 if (MARKERP (object) || INTEGERP (object))
423 return Qt;
424 return Qnil;
427 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
428 doc: /* Return t if OBJECT is a nonnegative integer. */)
429 (Lisp_Object object)
431 if (NATNUMP (object))
432 return Qt;
433 return Qnil;
436 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
437 doc: /* Return t if OBJECT is a number (floating point or integer). */)
438 (Lisp_Object object)
440 if (NUMBERP (object))
441 return Qt;
442 else
443 return Qnil;
446 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
447 Snumber_or_marker_p, 1, 1, 0,
448 doc: /* Return t if OBJECT is a number or a marker. */)
449 (Lisp_Object object)
451 if (NUMBERP (object) || MARKERP (object))
452 return Qt;
453 return Qnil;
456 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
457 doc: /* Return t if OBJECT is a floating point number. */)
458 (Lisp_Object object)
460 if (FLOATP (object))
461 return Qt;
462 return Qnil;
466 /* Extract and set components of lists */
468 DEFUN ("car", Fcar, Scar, 1, 1, 0,
469 doc: /* Return the car of LIST. If arg is nil, return nil.
470 Error if arg is not nil and not a cons cell. See also `car-safe'.
472 See Info node `(elisp)Cons Cells' for a discussion of related basic
473 Lisp concepts such as car, cdr, cons cell and list. */)
474 (register Lisp_Object list)
476 return CAR (list);
479 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
480 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
481 (Lisp_Object object)
483 return CAR_SAFE (object);
486 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
487 doc: /* Return the cdr of LIST. If arg is nil, return nil.
488 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
490 See Info node `(elisp)Cons Cells' for a discussion of related basic
491 Lisp concepts such as cdr, car, cons cell and list. */)
492 (register Lisp_Object list)
494 return CDR (list);
497 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
498 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
499 (Lisp_Object object)
501 return CDR_SAFE (object);
504 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
505 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
506 (register Lisp_Object cell, Lisp_Object newcar)
508 CHECK_CONS (cell);
509 CHECK_IMPURE (cell);
510 XSETCAR (cell, newcar);
511 return newcar;
514 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
515 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
516 (register Lisp_Object cell, Lisp_Object newcdr)
518 CHECK_CONS (cell);
519 CHECK_IMPURE (cell);
520 XSETCDR (cell, newcdr);
521 return newcdr;
524 /* Extract and set components of symbols */
526 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
527 doc: /* Return t if SYMBOL's value is not void. */)
528 (register Lisp_Object symbol)
530 Lisp_Object valcontents;
531 struct Lisp_Symbol *sym;
532 CHECK_SYMBOL (symbol);
533 sym = XSYMBOL (symbol);
535 start:
536 switch (sym->redirect)
538 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
539 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
540 case SYMBOL_LOCALIZED:
542 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
543 if (blv->fwd)
544 /* In set_internal, we un-forward vars when their value is
545 set to Qunbound. */
546 return Qt;
547 else
549 swap_in_symval_forwarding (sym, blv);
550 valcontents = BLV_VALUE (blv);
552 break;
554 case SYMBOL_FORWARDED:
555 /* In set_internal, we un-forward vars when their value is
556 set to Qunbound. */
557 return Qt;
558 default: abort ();
561 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
564 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
565 doc: /* Return t if SYMBOL's function definition is not void. */)
566 (register Lisp_Object symbol)
568 CHECK_SYMBOL (symbol);
569 return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
572 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
573 doc: /* Make SYMBOL's value be void.
574 Return SYMBOL. */)
575 (register Lisp_Object symbol)
577 CHECK_SYMBOL (symbol);
578 if (SYMBOL_CONSTANT_P (symbol))
579 xsignal1 (Qsetting_constant, symbol);
580 Fset (symbol, Qunbound);
581 return symbol;
584 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
585 doc: /* Make SYMBOL's function definition be void.
586 Return SYMBOL. */)
587 (register Lisp_Object symbol)
589 CHECK_SYMBOL (symbol);
590 if (NILP (symbol) || EQ (symbol, Qt))
591 xsignal1 (Qsetting_constant, symbol);
592 XSYMBOL (symbol)->function = Qunbound;
593 return symbol;
596 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
597 doc: /* Return SYMBOL's function definition. Error if that is void. */)
598 (register Lisp_Object symbol)
600 CHECK_SYMBOL (symbol);
601 if (!EQ (XSYMBOL (symbol)->function, Qunbound))
602 return XSYMBOL (symbol)->function;
603 xsignal1 (Qvoid_function, symbol);
606 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
607 doc: /* Return SYMBOL's property list. */)
608 (register Lisp_Object symbol)
610 CHECK_SYMBOL (symbol);
611 return XSYMBOL (symbol)->plist;
614 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
615 doc: /* Return SYMBOL's name, a string. */)
616 (register Lisp_Object symbol)
618 register Lisp_Object name;
620 CHECK_SYMBOL (symbol);
621 name = SYMBOL_NAME (symbol);
622 return name;
625 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
626 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
627 (register Lisp_Object symbol, Lisp_Object definition)
629 register Lisp_Object function;
631 CHECK_SYMBOL (symbol);
632 if (NILP (symbol) || EQ (symbol, Qt))
633 xsignal1 (Qsetting_constant, symbol);
635 function = XSYMBOL (symbol)->function;
637 if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
638 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
640 if (CONSP (function) && EQ (XCAR (function), Qautoload))
641 Fput (symbol, Qautoload, XCDR (function));
643 XSYMBOL (symbol)->function = definition;
644 /* Handle automatic advice activation */
645 if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
647 call2 (Qad_activate_internal, symbol, Qnil);
648 definition = XSYMBOL (symbol)->function;
650 return definition;
653 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
654 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
655 Associates the function with the current load file, if any.
656 The optional third argument DOCSTRING specifies the documentation string
657 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
658 determined by DEFINITION. */)
659 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
661 CHECK_SYMBOL (symbol);
662 if (CONSP (XSYMBOL (symbol)->function)
663 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
664 LOADHIST_ATTACH (Fcons (Qt, symbol));
665 definition = Ffset (symbol, definition);
666 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
667 if (!NILP (docstring))
668 Fput (symbol, Qfunction_documentation, docstring);
669 return definition;
672 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
673 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
674 (register Lisp_Object symbol, Lisp_Object newplist)
676 CHECK_SYMBOL (symbol);
677 XSYMBOL (symbol)->plist = newplist;
678 return newplist;
681 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
682 doc: /* Return minimum and maximum number of args allowed for SUBR.
683 SUBR must be a built-in function.
684 The returned value is a pair (MIN . MAX). MIN is the minimum number
685 of args. MAX is the maximum number or the symbol `many', for a
686 function with `&rest' args, or `unevalled' for a special form. */)
687 (Lisp_Object subr)
689 short minargs, maxargs;
690 CHECK_SUBR (subr);
691 minargs = XSUBR (subr)->min_args;
692 maxargs = XSUBR (subr)->max_args;
693 if (maxargs == MANY)
694 return Fcons (make_number (minargs), Qmany);
695 else if (maxargs == UNEVALLED)
696 return Fcons (make_number (minargs), Qunevalled);
697 else
698 return Fcons (make_number (minargs), make_number (maxargs));
701 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
702 doc: /* Return name of subroutine SUBR.
703 SUBR must be a built-in function. */)
704 (Lisp_Object subr)
706 const char *name;
707 CHECK_SUBR (subr);
708 name = XSUBR (subr)->symbol_name;
709 return make_string (name, strlen (name));
712 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
713 doc: /* Return the interactive form of CMD or nil if none.
714 If CMD is not a command, the return value is nil.
715 Value, if non-nil, is a list \(interactive SPEC). */)
716 (Lisp_Object cmd)
718 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
720 if (NILP (fun) || EQ (fun, Qunbound))
721 return Qnil;
723 /* Use an `interactive-form' property if present, analogous to the
724 function-documentation property. */
725 fun = cmd;
726 while (SYMBOLP (fun))
728 Lisp_Object tmp = Fget (fun, Qinteractive_form);
729 if (!NILP (tmp))
730 return tmp;
731 else
732 fun = Fsymbol_function (fun);
735 if (SUBRP (fun))
737 const char *spec = XSUBR (fun)->intspec;
738 if (spec)
739 return list2 (Qinteractive,
740 (*spec != '(') ? build_string (spec) :
741 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
743 else if (COMPILEDP (fun))
745 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
746 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
748 else if (CONSP (fun))
750 Lisp_Object funcar = XCAR (fun);
751 if (EQ (funcar, Qlambda))
752 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
753 else if (EQ (funcar, Qautoload))
755 struct gcpro gcpro1;
756 GCPRO1 (cmd);
757 do_autoload (fun, cmd);
758 UNGCPRO;
759 return Finteractive_form (cmd);
762 return Qnil;
766 /***********************************************************************
767 Getting and Setting Values of Symbols
768 ***********************************************************************/
770 /* Return the symbol holding SYMBOL's value. Signal
771 `cyclic-variable-indirection' if SYMBOL's chain of variable
772 indirections contains a loop. */
774 struct Lisp_Symbol *
775 indirect_variable (struct Lisp_Symbol *symbol)
777 struct Lisp_Symbol *tortoise, *hare;
779 hare = tortoise = symbol;
781 while (hare->redirect == SYMBOL_VARALIAS)
783 hare = SYMBOL_ALIAS (hare);
784 if (hare->redirect != SYMBOL_VARALIAS)
785 break;
787 hare = SYMBOL_ALIAS (hare);
788 tortoise = SYMBOL_ALIAS (tortoise);
790 if (hare == tortoise)
792 Lisp_Object tem;
793 XSETSYMBOL (tem, symbol);
794 xsignal1 (Qcyclic_variable_indirection, tem);
798 return hare;
802 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
803 doc: /* Return the variable at the end of OBJECT's variable chain.
804 If OBJECT is a symbol, follow all variable indirections and return the final
805 variable. If OBJECT is not a symbol, just return it.
806 Signal a cyclic-variable-indirection error if there is a loop in the
807 variable chain of symbols. */)
808 (Lisp_Object object)
810 if (SYMBOLP (object))
811 XSETSYMBOL (object, indirect_variable (XSYMBOL (object)));
812 return object;
816 /* Given the raw contents of a symbol value cell,
817 return the Lisp value of the symbol.
818 This does not handle buffer-local variables; use
819 swap_in_symval_forwarding for that. */
821 #define do_blv_forwarding(blv) \
822 ((blv)->forwarded ? do_symval_forwarding (BLV_FWD (blv)) : BLV_VALUE (blv))
824 Lisp_Object
825 do_symval_forwarding (register union Lisp_Fwd *valcontents)
827 register Lisp_Object val;
828 switch (XFWDTYPE (valcontents))
830 case Lisp_Fwd_Int:
831 XSETINT (val, *XINTFWD (valcontents)->intvar);
832 return val;
834 case Lisp_Fwd_Bool:
835 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
837 case Lisp_Fwd_Obj:
838 return *XOBJFWD (valcontents)->objvar;
840 case Lisp_Fwd_Buffer_Obj:
841 return PER_BUFFER_VALUE (current_buffer,
842 XBUFFER_OBJFWD (valcontents)->offset);
844 case Lisp_Fwd_Kboard_Obj:
845 /* We used to simply use current_kboard here, but from Lisp
846 code, it's value is often unexpected. It seems nicer to
847 allow constructions like this to work as intuitively expected:
849 (with-selected-frame frame
850 (define-key local-function-map "\eOP" [f1]))
852 On the other hand, this affects the semantics of
853 last-command and real-last-command, and people may rely on
854 that. I took a quick look at the Lisp codebase, and I
855 don't think anything will break. --lorentey */
856 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
857 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
858 default: abort ();
862 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
863 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
864 buffer-independent contents of the value cell: forwarded just one
865 step past the buffer-localness.
867 BUF non-zero means set the value in buffer BUF instead of the
868 current buffer. This only plays a role for per-buffer variables. */
870 #define store_blv_forwarding(blv, newval, buf) \
871 do { \
872 if ((blv)->forwarded) \
873 store_symval_forwarding (BLV_FWD (blv), (newval), (buf)); \
874 else \
875 SET_BLV_VALUE (blv, newval); \
876 } while (0)
878 static void
879 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
881 switch (XFWDTYPE (valcontents))
883 case Lisp_Fwd_Int:
884 CHECK_NUMBER (newval);
885 *XINTFWD (valcontents)->intvar = XINT (newval);
886 break;
888 case Lisp_Fwd_Bool:
889 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
890 break;
892 case Lisp_Fwd_Obj:
893 *XOBJFWD (valcontents)->objvar = newval;
895 /* If this variable is a default for something stored
896 in the buffer itself, such as default-fill-column,
897 find the buffers that don't have local values for it
898 and update them. */
899 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
900 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
902 int offset = ((char *) XOBJFWD (valcontents)->objvar
903 - (char *) &buffer_defaults);
904 int idx = PER_BUFFER_IDX (offset);
906 Lisp_Object tail;
908 if (idx <= 0)
909 break;
911 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
913 Lisp_Object buf;
914 struct buffer *b;
916 buf = Fcdr (XCAR (tail));
917 if (!BUFFERP (buf)) continue;
918 b = XBUFFER (buf);
920 if (! PER_BUFFER_VALUE_P (b, idx))
921 PER_BUFFER_VALUE (b, offset) = newval;
924 break;
926 case Lisp_Fwd_Buffer_Obj:
928 int offset = XBUFFER_OBJFWD (valcontents)->offset;
929 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
931 if (!(NILP (type) || NILP (newval)
932 || (XINT (type) == LISP_INT_TAG
933 ? INTEGERP (newval)
934 : XTYPE (newval) == XINT (type))))
935 buffer_slot_type_mismatch (newval, XINT (type));
937 if (buf == NULL)
938 buf = current_buffer;
939 PER_BUFFER_VALUE (buf, offset) = newval;
941 break;
943 case Lisp_Fwd_Kboard_Obj:
945 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
946 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
947 *(Lisp_Object *) p = newval;
949 break;
951 default:
952 abort (); /* goto def; */
956 /* Set up SYMBOL to refer to its global binding.
957 This makes it safe to alter the status of other bindings. */
959 void
960 swap_in_global_binding (struct Lisp_Symbol *symbol)
962 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
964 /* Unload the previously loaded binding. */
965 if (blv->fwd)
966 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
968 /* Select the global binding in the symbol. */
969 blv->valcell = blv->defcell;
970 if (blv->fwd)
971 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
973 /* Indicate that the global binding is set up now. */
974 blv->where = Qnil;
975 SET_BLV_FOUND (blv, 0);
978 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
979 VALCONTENTS is the contents of its value cell,
980 which points to a struct Lisp_Buffer_Local_Value.
982 Return the value forwarded one step past the buffer-local stage.
983 This could be another forwarding pointer. */
985 static void
986 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
988 register Lisp_Object tem1;
990 eassert (blv == SYMBOL_BLV (symbol));
992 tem1 = blv->where;
994 if (NILP (tem1)
995 || (blv->frame_local
996 ? !EQ (selected_frame, tem1)
997 : current_buffer != XBUFFER (tem1)))
1000 /* Unload the previously loaded binding. */
1001 tem1 = blv->valcell;
1002 if (blv->fwd)
1003 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1004 /* Choose the new binding. */
1006 Lisp_Object var;
1007 XSETSYMBOL (var, symbol);
1008 if (blv->frame_local)
1010 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1011 blv->where = selected_frame;
1013 else
1015 tem1 = assq_no_quit (var, current_buffer->local_var_alist);
1016 XSETBUFFER (blv->where, current_buffer);
1019 if (!(blv->found = !NILP (tem1)))
1020 tem1 = blv->defcell;
1022 /* Load the new binding. */
1023 blv->valcell = tem1;
1024 if (blv->fwd)
1025 store_symval_forwarding (blv->fwd, BLV_VALUE (blv), NULL);
1029 /* Find the value of a symbol, returning Qunbound if it's not bound.
1030 This is helpful for code which just wants to get a variable's value
1031 if it has one, without signaling an error.
1032 Note that it must not be possible to quit
1033 within this function. Great care is required for this. */
1035 Lisp_Object
1036 find_symbol_value (Lisp_Object symbol)
1038 struct Lisp_Symbol *sym;
1040 CHECK_SYMBOL (symbol);
1041 sym = XSYMBOL (symbol);
1043 start:
1044 switch (sym->redirect)
1046 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1047 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1048 case SYMBOL_LOCALIZED:
1050 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1051 swap_in_symval_forwarding (sym, blv);
1052 return blv->fwd ? do_symval_forwarding (blv->fwd) : BLV_VALUE (blv);
1054 /* FALLTHROUGH */
1055 case SYMBOL_FORWARDED:
1056 return do_symval_forwarding (SYMBOL_FWD (sym));
1057 default: abort ();
1061 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1062 doc: /* Return SYMBOL's value. Error if that is void. */)
1063 (Lisp_Object symbol)
1065 Lisp_Object val;
1067 val = find_symbol_value (symbol);
1068 if (!EQ (val, Qunbound))
1069 return val;
1071 xsignal1 (Qvoid_variable, symbol);
1074 DEFUN ("set", Fset, Sset, 2, 2, 0,
1075 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1076 (register Lisp_Object symbol, Lisp_Object newval)
1078 set_internal (symbol, newval, Qnil, 0);
1079 return newval;
1082 /* Return 1 if SYMBOL currently has a let-binding
1083 which was made in the buffer that is now current. */
1085 static int
1086 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1088 struct specbinding *p;
1090 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1091 if (p->func == NULL
1092 && CONSP (p->symbol))
1094 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1095 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1096 if (symbol == let_bound_symbol
1097 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1098 break;
1101 return p >= specpdl;
1104 static int
1105 let_shadows_global_binding_p (Lisp_Object symbol)
1107 struct specbinding *p;
1109 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1110 if (p->func == NULL && EQ (p->symbol, symbol))
1111 break;
1113 return p >= specpdl;
1116 /* Store the value NEWVAL into SYMBOL.
1117 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1118 (nil stands for the current buffer/frame).
1120 If BINDFLAG is zero, then if this symbol is supposed to become
1121 local in every buffer where it is set, then we make it local.
1122 If BINDFLAG is nonzero, we don't do that. */
1124 void
1125 set_internal (register Lisp_Object symbol, register Lisp_Object newval, register Lisp_Object where, int bindflag)
1127 int voide = EQ (newval, Qunbound);
1128 struct Lisp_Symbol *sym;
1129 Lisp_Object tem1;
1131 /* If restoring in a dead buffer, do nothing. */
1132 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1133 return; */
1135 CHECK_SYMBOL (symbol);
1136 if (SYMBOL_CONSTANT_P (symbol))
1138 if (NILP (Fkeywordp (symbol))
1139 || !EQ (newval, Fsymbol_value (symbol)))
1140 xsignal1 (Qsetting_constant, symbol);
1141 else
1142 /* Allow setting keywords to their own value. */
1143 return;
1146 sym = XSYMBOL (symbol);
1148 start:
1149 switch (sym->redirect)
1151 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1152 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1153 case SYMBOL_LOCALIZED:
1155 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1156 if (NILP (where))
1158 if (blv->frame_local)
1159 where = selected_frame;
1160 else
1161 XSETBUFFER (where, current_buffer);
1163 /* If the current buffer is not the buffer whose binding is
1164 loaded, or if there may be frame-local bindings and the frame
1165 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1166 the default binding is loaded, the loaded binding may be the
1167 wrong one. */
1168 if (!EQ (blv->where, where)
1169 /* Also unload a global binding (if the var is local_if_set). */
1170 || (EQ (blv->valcell, blv->defcell)))
1172 /* The currently loaded binding is not necessarily valid.
1173 We need to unload it, and choose a new binding. */
1175 /* Write out `realvalue' to the old loaded binding. */
1176 if (blv->fwd)
1177 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1179 /* Find the new binding. */
1180 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1181 tem1 = Fassq (symbol,
1182 (blv->frame_local
1183 ? XFRAME (where)->param_alist
1184 : XBUFFER (where)->local_var_alist));
1185 blv->where = where;
1186 blv->found = 1;
1188 if (NILP (tem1))
1190 /* This buffer still sees the default value. */
1192 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1193 or if this is `let' rather than `set',
1194 make CURRENT-ALIST-ELEMENT point to itself,
1195 indicating that we're seeing the default value.
1196 Likewise if the variable has been let-bound
1197 in the current buffer. */
1198 if (bindflag || !blv->local_if_set
1199 || let_shadows_buffer_binding_p (sym))
1201 blv->found = 0;
1202 tem1 = blv->defcell;
1204 /* If it's a local_if_set, being set not bound,
1205 and we're not within a let that was made for this buffer,
1206 create a new buffer-local binding for the variable.
1207 That means, give this buffer a new assoc for a local value
1208 and load that binding. */
1209 else
1211 /* local_if_set is only supported for buffer-local
1212 bindings, not for frame-local bindings. */
1213 eassert (!blv->frame_local);
1214 tem1 = Fcons (symbol, XCDR (blv->defcell));
1215 XBUFFER (where)->local_var_alist
1216 = Fcons (tem1, XBUFFER (where)->local_var_alist);
1220 /* Record which binding is now loaded. */
1221 blv->valcell = tem1;
1224 /* Store the new value in the cons cell. */
1225 SET_BLV_VALUE (blv, newval);
1227 if (blv->fwd)
1229 if (voide)
1230 /* If storing void (making the symbol void), forward only through
1231 buffer-local indicator, not through Lisp_Objfwd, etc. */
1232 blv->fwd = NULL;
1233 else
1234 store_symval_forwarding (blv->fwd, newval,
1235 BUFFERP (where)
1236 ? XBUFFER (where) : current_buffer);
1238 break;
1240 case SYMBOL_FORWARDED:
1242 struct buffer *buf
1243 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1244 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1245 if (BUFFER_OBJFWDP (innercontents))
1247 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1248 int idx = PER_BUFFER_IDX (offset);
1249 if (idx > 0
1250 && !bindflag
1251 && !let_shadows_buffer_binding_p (sym))
1252 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1255 if (voide)
1256 { /* If storing void (making the symbol void), forward only through
1257 buffer-local indicator, not through Lisp_Objfwd, etc. */
1258 sym->redirect = SYMBOL_PLAINVAL;
1259 SET_SYMBOL_VAL (sym, newval);
1261 else
1262 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1263 break;
1265 default: abort ();
1267 return;
1270 /* Access or set a buffer-local symbol's default value. */
1272 /* Return the default value of SYMBOL, but don't check for voidness.
1273 Return Qunbound if it is void. */
1275 Lisp_Object
1276 default_value (Lisp_Object symbol)
1278 struct Lisp_Symbol *sym;
1280 CHECK_SYMBOL (symbol);
1281 sym = XSYMBOL (symbol);
1283 start:
1284 switch (sym->redirect)
1286 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1287 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1288 case SYMBOL_LOCALIZED:
1290 /* If var is set up for a buffer that lacks a local value for it,
1291 the current value is nominally the default value.
1292 But the `realvalue' slot may be more up to date, since
1293 ordinary setq stores just that slot. So use that. */
1294 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1295 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1296 return do_symval_forwarding (blv->fwd);
1297 else
1298 return XCDR (blv->defcell);
1300 case SYMBOL_FORWARDED:
1302 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1304 /* For a built-in buffer-local variable, get the default value
1305 rather than letting do_symval_forwarding get the current value. */
1306 if (BUFFER_OBJFWDP (valcontents))
1308 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1309 if (PER_BUFFER_IDX (offset) != 0)
1310 return PER_BUFFER_DEFAULT (offset);
1313 /* For other variables, get the current value. */
1314 return do_symval_forwarding (valcontents);
1316 default: abort ();
1320 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1321 doc: /* Return t if SYMBOL has a non-void default value.
1322 This is the value that is seen in buffers that do not have their own values
1323 for this variable. */)
1324 (Lisp_Object symbol)
1326 register Lisp_Object value;
1328 value = default_value (symbol);
1329 return (EQ (value, Qunbound) ? Qnil : Qt);
1332 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1333 doc: /* Return SYMBOL's default value.
1334 This is the value that is seen in buffers that do not have their own values
1335 for this variable. The default value is meaningful for variables with
1336 local bindings in certain buffers. */)
1337 (Lisp_Object symbol)
1339 register Lisp_Object value;
1341 value = default_value (symbol);
1342 if (!EQ (value, Qunbound))
1343 return value;
1345 xsignal1 (Qvoid_variable, symbol);
1348 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1349 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1350 The default value is seen in buffers that do not have their own values
1351 for this variable. */)
1352 (Lisp_Object symbol, Lisp_Object value)
1354 struct Lisp_Symbol *sym;
1356 CHECK_SYMBOL (symbol);
1357 if (SYMBOL_CONSTANT_P (symbol))
1359 if (NILP (Fkeywordp (symbol))
1360 || !EQ (value, Fdefault_value (symbol)))
1361 xsignal1 (Qsetting_constant, symbol);
1362 else
1363 /* Allow setting keywords to their own value. */
1364 return value;
1366 sym = XSYMBOL (symbol);
1368 start:
1369 switch (sym->redirect)
1371 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1372 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1373 case SYMBOL_LOCALIZED:
1375 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1377 /* Store new value into the DEFAULT-VALUE slot. */
1378 XSETCDR (blv->defcell, value);
1380 /* If the default binding is now loaded, set the REALVALUE slot too. */
1381 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1382 store_symval_forwarding (blv->fwd, value, NULL);
1383 return value;
1385 case SYMBOL_FORWARDED:
1387 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1389 /* Handle variables like case-fold-search that have special slots
1390 in the buffer.
1391 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1392 if (BUFFER_OBJFWDP (valcontents))
1394 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1395 int idx = PER_BUFFER_IDX (offset);
1397 PER_BUFFER_DEFAULT (offset) = value;
1399 /* If this variable is not always local in all buffers,
1400 set it in the buffers that don't nominally have a local value. */
1401 if (idx > 0)
1403 struct buffer *b;
1405 for (b = all_buffers; b; b = b->next)
1406 if (!PER_BUFFER_VALUE_P (b, idx))
1407 PER_BUFFER_VALUE (b, offset) = value;
1409 return value;
1411 else
1412 return Fset (symbol, value);
1414 default: abort ();
1418 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1419 doc: /* Set the default value of variable VAR to VALUE.
1420 VAR, the variable name, is literal (not evaluated);
1421 VALUE is an expression: it is evaluated and its value returned.
1422 The default value of a variable is seen in buffers
1423 that do not have their own values for the variable.
1425 More generally, you can use multiple variables and values, as in
1426 (setq-default VAR VALUE VAR VALUE...)
1427 This sets each VAR's default value to the corresponding VALUE.
1428 The VALUE for the Nth VAR can refer to the new default values
1429 of previous VARs.
1430 usage: (setq-default [VAR VALUE]...) */)
1431 (Lisp_Object args)
1433 register Lisp_Object args_left;
1434 register Lisp_Object val, symbol;
1435 struct gcpro gcpro1;
1437 if (NILP (args))
1438 return Qnil;
1440 args_left = args;
1441 GCPRO1 (args);
1445 val = Feval (Fcar (Fcdr (args_left)));
1446 symbol = XCAR (args_left);
1447 Fset_default (symbol, val);
1448 args_left = Fcdr (XCDR (args_left));
1450 while (!NILP (args_left));
1452 UNGCPRO;
1453 return val;
1456 /* Lisp functions for creating and removing buffer-local variables. */
1458 union Lisp_Val_Fwd
1460 Lisp_Object value;
1461 union Lisp_Fwd *fwd;
1464 static struct Lisp_Buffer_Local_Value *
1465 make_blv (struct Lisp_Symbol *sym, int forwarded, union Lisp_Val_Fwd valcontents)
1467 struct Lisp_Buffer_Local_Value *blv
1468 = xmalloc (sizeof (struct Lisp_Buffer_Local_Value));
1469 Lisp_Object symbol;
1470 Lisp_Object tem;
1472 XSETSYMBOL (symbol, sym);
1473 tem = Fcons (symbol, (forwarded
1474 ? do_symval_forwarding (valcontents.fwd)
1475 : valcontents.value));
1477 /* Buffer_Local_Values cannot have as realval a buffer-local
1478 or keyboard-local forwarding. */
1479 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1480 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1481 blv->fwd = forwarded ? valcontents.fwd : NULL;
1482 blv->where = Qnil;
1483 blv->frame_local = 0;
1484 blv->local_if_set = 0;
1485 blv->defcell = tem;
1486 blv->valcell = tem;
1487 SET_BLV_FOUND (blv, 0);
1488 return blv;
1491 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local, Smake_variable_buffer_local,
1492 1, 1, "vMake Variable Buffer Local: ",
1493 doc: /* Make VARIABLE become buffer-local whenever it is set.
1494 At any time, the value for the current buffer is in effect,
1495 unless the variable has never been set in this buffer,
1496 in which case the default value is in effect.
1497 Note that binding the variable with `let', or setting it while
1498 a `let'-style binding made in this buffer is in effect,
1499 does not make the variable buffer-local. Return VARIABLE.
1501 In most cases it is better to use `make-local-variable',
1502 which makes a variable local in just one buffer.
1504 The function `default-value' gets the default value and `set-default' sets it. */)
1505 (register Lisp_Object variable)
1507 struct Lisp_Symbol *sym;
1508 struct Lisp_Buffer_Local_Value *blv = NULL;
1509 union Lisp_Val_Fwd valcontents;
1510 int forwarded;
1512 CHECK_SYMBOL (variable);
1513 sym = XSYMBOL (variable);
1515 start:
1516 switch (sym->redirect)
1518 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1519 case SYMBOL_PLAINVAL:
1520 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1521 if (EQ (valcontents.value, Qunbound))
1522 valcontents.value = Qnil;
1523 break;
1524 case SYMBOL_LOCALIZED:
1525 blv = SYMBOL_BLV (sym);
1526 if (blv->frame_local)
1527 error ("Symbol %s may not be buffer-local",
1528 SDATA (SYMBOL_NAME (variable)));
1529 break;
1530 case SYMBOL_FORWARDED:
1531 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1532 if (KBOARD_OBJFWDP (valcontents.fwd))
1533 error ("Symbol %s may not be buffer-local",
1534 SDATA (SYMBOL_NAME (variable)));
1535 else if (BUFFER_OBJFWDP (valcontents.fwd))
1536 return variable;
1537 break;
1538 default: abort ();
1541 if (sym->constant)
1542 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1544 if (!blv)
1546 blv = make_blv (sym, forwarded, valcontents);
1547 sym->redirect = SYMBOL_LOCALIZED;
1548 SET_SYMBOL_BLV (sym, blv);
1550 Lisp_Object symbol;
1551 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1552 if (let_shadows_global_binding_p (symbol))
1553 message ("Making %s buffer-local while let-bound!",
1554 SDATA (SYMBOL_NAME (variable)));
1558 blv->local_if_set = 1;
1559 return variable;
1562 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1563 1, 1, "vMake Local Variable: ",
1564 doc: /* Make VARIABLE have a separate value in the current buffer.
1565 Other buffers will continue to share a common default value.
1566 \(The buffer-local value of VARIABLE starts out as the same value
1567 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1568 Return VARIABLE.
1570 If the variable is already arranged to become local when set,
1571 this function causes a local value to exist for this buffer,
1572 just as setting the variable would do.
1574 This function returns VARIABLE, and therefore
1575 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1576 works.
1578 See also `make-variable-buffer-local'.
1580 Do not use `make-local-variable' to make a hook variable buffer-local.
1581 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1582 (register Lisp_Object variable)
1584 register Lisp_Object tem;
1585 int forwarded;
1586 union Lisp_Val_Fwd valcontents;
1587 struct Lisp_Symbol *sym;
1588 struct Lisp_Buffer_Local_Value *blv = NULL;
1590 CHECK_SYMBOL (variable);
1591 sym = XSYMBOL (variable);
1593 start:
1594 switch (sym->redirect)
1596 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1597 case SYMBOL_PLAINVAL:
1598 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1599 case SYMBOL_LOCALIZED:
1600 blv = SYMBOL_BLV (sym);
1601 if (blv->frame_local)
1602 error ("Symbol %s may not be buffer-local",
1603 SDATA (SYMBOL_NAME (variable)));
1604 break;
1605 case SYMBOL_FORWARDED:
1606 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1607 if (KBOARD_OBJFWDP (valcontents.fwd))
1608 error ("Symbol %s may not be buffer-local",
1609 SDATA (SYMBOL_NAME (variable)));
1610 break;
1611 default: abort ();
1614 if (sym->constant)
1615 error ("Symbol %s may not be buffer-local",
1616 SDATA (SYMBOL_NAME (variable)));
1618 if (blv ? blv->local_if_set
1619 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1621 tem = Fboundp (variable);
1622 /* Make sure the symbol has a local value in this particular buffer,
1623 by setting it to the same value it already has. */
1624 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1625 return variable;
1627 if (!blv)
1629 blv = make_blv (sym, forwarded, valcontents);
1630 sym->redirect = SYMBOL_LOCALIZED;
1631 SET_SYMBOL_BLV (sym, blv);
1633 Lisp_Object symbol;
1634 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1635 if (let_shadows_global_binding_p (symbol))
1636 message ("Making %s local to %s while let-bound!",
1637 SDATA (SYMBOL_NAME (variable)),
1638 SDATA (current_buffer->name));
1642 /* Make sure this buffer has its own value of symbol. */
1643 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1644 tem = Fassq (variable, current_buffer->local_var_alist);
1645 if (NILP (tem))
1647 if (let_shadows_buffer_binding_p (sym))
1648 message ("Making %s buffer-local while locally let-bound!",
1649 SDATA (SYMBOL_NAME (variable)));
1651 /* Swap out any local binding for some other buffer, and make
1652 sure the current value is permanently recorded, if it's the
1653 default value. */
1654 find_symbol_value (variable);
1656 current_buffer->local_var_alist
1657 = Fcons (Fcons (variable, XCDR (blv->defcell)),
1658 current_buffer->local_var_alist);
1660 /* Make sure symbol does not think it is set up for this buffer;
1661 force it to look once again for this buffer's value. */
1662 if (current_buffer == XBUFFER (blv->where))
1663 blv->where = Qnil;
1664 /* blv->valcell = blv->defcell;
1665 * SET_BLV_FOUND (blv, 0); */
1666 blv->found = 0;
1669 /* If the symbol forwards into a C variable, then load the binding
1670 for this buffer now. If C code modifies the variable before we
1671 load the binding in, then that new value will clobber the default
1672 binding the next time we unload it. */
1673 if (blv->fwd)
1674 swap_in_symval_forwarding (sym, blv);
1676 return variable;
1679 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1680 1, 1, "vKill Local Variable: ",
1681 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1682 From now on the default value will apply in this buffer. Return VARIABLE. */)
1683 (register Lisp_Object variable)
1685 register Lisp_Object tem;
1686 struct Lisp_Buffer_Local_Value *blv;
1687 struct Lisp_Symbol *sym;
1689 CHECK_SYMBOL (variable);
1690 sym = XSYMBOL (variable);
1692 start:
1693 switch (sym->redirect)
1695 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1696 case SYMBOL_PLAINVAL: return variable;
1697 case SYMBOL_FORWARDED:
1699 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1700 if (BUFFER_OBJFWDP (valcontents))
1702 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1703 int idx = PER_BUFFER_IDX (offset);
1705 if (idx > 0)
1707 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1708 PER_BUFFER_VALUE (current_buffer, offset)
1709 = PER_BUFFER_DEFAULT (offset);
1712 return variable;
1714 case SYMBOL_LOCALIZED:
1715 blv = SYMBOL_BLV (sym);
1716 if (blv->frame_local)
1717 return variable;
1718 break;
1719 default: abort ();
1722 /* Get rid of this buffer's alist element, if any. */
1723 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1724 tem = Fassq (variable, current_buffer->local_var_alist);
1725 if (!NILP (tem))
1726 current_buffer->local_var_alist
1727 = Fdelq (tem, current_buffer->local_var_alist);
1729 /* If the symbol is set up with the current buffer's binding
1730 loaded, recompute its value. We have to do it now, or else
1731 forwarded objects won't work right. */
1733 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1734 if (EQ (buf, blv->where))
1736 blv->where = Qnil;
1737 /* blv->valcell = blv->defcell;
1738 * SET_BLV_FOUND (blv, 0); */
1739 blv->found = 0;
1740 find_symbol_value (variable);
1744 return variable;
1747 /* Lisp functions for creating and removing buffer-local variables. */
1749 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1750 when/if this is removed. */
1752 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1753 1, 1, "vMake Variable Frame Local: ",
1754 doc: /* Enable VARIABLE to have frame-local bindings.
1755 This does not create any frame-local bindings for VARIABLE,
1756 it just makes them possible.
1758 A frame-local binding is actually a frame parameter value.
1759 If a frame F has a value for the frame parameter named VARIABLE,
1760 that also acts as a frame-local binding for VARIABLE in F--
1761 provided this function has been called to enable VARIABLE
1762 to have frame-local bindings at all.
1764 The only way to create a frame-local binding for VARIABLE in a frame
1765 is to set the VARIABLE frame parameter of that frame. See
1766 `modify-frame-parameters' for how to set frame parameters.
1768 Note that since Emacs 23.1, variables cannot be both buffer-local and
1769 frame-local any more (buffer-local bindings used to take precedence over
1770 frame-local bindings). */)
1771 (register Lisp_Object variable)
1773 int forwarded;
1774 union Lisp_Val_Fwd valcontents;
1775 struct Lisp_Symbol *sym;
1776 struct Lisp_Buffer_Local_Value *blv = NULL;
1778 CHECK_SYMBOL (variable);
1779 sym = XSYMBOL (variable);
1781 start:
1782 switch (sym->redirect)
1784 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1785 case SYMBOL_PLAINVAL:
1786 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1787 if (EQ (valcontents.value, Qunbound))
1788 valcontents.value = Qnil;
1789 break;
1790 case SYMBOL_LOCALIZED:
1791 if (SYMBOL_BLV (sym)->frame_local)
1792 return variable;
1793 else
1794 error ("Symbol %s may not be frame-local",
1795 SDATA (SYMBOL_NAME (variable)));
1796 case SYMBOL_FORWARDED:
1797 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1798 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1799 error ("Symbol %s may not be frame-local",
1800 SDATA (SYMBOL_NAME (variable)));
1801 break;
1802 default: abort ();
1805 if (sym->constant)
1806 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1808 blv = make_blv (sym, forwarded, valcontents);
1809 blv->frame_local = 1;
1810 sym->redirect = SYMBOL_LOCALIZED;
1811 SET_SYMBOL_BLV (sym, blv);
1813 Lisp_Object symbol;
1814 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1815 if (let_shadows_global_binding_p (symbol))
1816 message ("Making %s frame-local while let-bound!",
1817 SDATA (SYMBOL_NAME (variable)));
1819 return variable;
1822 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1823 1, 2, 0,
1824 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1825 BUFFER defaults to the current buffer. */)
1826 (register Lisp_Object variable, Lisp_Object buffer)
1828 register struct buffer *buf;
1829 struct Lisp_Symbol *sym;
1831 if (NILP (buffer))
1832 buf = current_buffer;
1833 else
1835 CHECK_BUFFER (buffer);
1836 buf = XBUFFER (buffer);
1839 CHECK_SYMBOL (variable);
1840 sym = XSYMBOL (variable);
1842 start:
1843 switch (sym->redirect)
1845 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1846 case SYMBOL_PLAINVAL: return Qnil;
1847 case SYMBOL_LOCALIZED:
1849 Lisp_Object tail, elt, tmp;
1850 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1851 XSETBUFFER (tmp, buf);
1852 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1854 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1856 elt = XCAR (tail);
1857 if (EQ (variable, XCAR (elt)))
1859 eassert (!blv->frame_local);
1860 eassert (BLV_FOUND (blv) || !EQ (blv->where, tmp));
1861 return Qt;
1864 eassert (!BLV_FOUND (blv) || !EQ (blv->where, tmp));
1865 return Qnil;
1867 case SYMBOL_FORWARDED:
1869 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1870 if (BUFFER_OBJFWDP (valcontents))
1872 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1873 int idx = PER_BUFFER_IDX (offset);
1874 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1875 return Qt;
1877 return Qnil;
1879 default: abort ();
1883 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1884 1, 2, 0,
1885 doc: /* Non-nil if VARIABLE will be local in buffer BUFFER when set there.
1886 More precisely, this means that setting the variable \(with `set' or`setq'),
1887 while it does not have a `let'-style binding that was made in BUFFER,
1888 will produce a buffer local binding. See Info node
1889 `(elisp)Creating Buffer-Local'.
1890 BUFFER defaults to the current buffer. */)
1891 (register Lisp_Object variable, Lisp_Object buffer)
1893 struct Lisp_Symbol *sym;
1895 CHECK_SYMBOL (variable);
1896 sym = XSYMBOL (variable);
1898 start:
1899 switch (sym->redirect)
1901 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1902 case SYMBOL_PLAINVAL: return Qnil;
1903 case SYMBOL_LOCALIZED:
1905 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1906 if (blv->local_if_set)
1907 return Qt;
1908 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1909 return Flocal_variable_p (variable, buffer);
1911 case SYMBOL_FORWARDED:
1912 /* All BUFFER_OBJFWD slots become local if they are set. */
1913 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1914 default: abort ();
1918 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1919 1, 1, 0,
1920 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1921 If the current binding is buffer-local, the value is the current buffer.
1922 If the current binding is frame-local, the value is the selected frame.
1923 If the current binding is global (the default), the value is nil. */)
1924 (register Lisp_Object variable)
1926 struct Lisp_Symbol *sym;
1928 CHECK_SYMBOL (variable);
1929 sym = XSYMBOL (variable);
1931 /* Make sure the current binding is actually swapped in. */
1932 find_symbol_value (variable);
1934 start:
1935 switch (sym->redirect)
1937 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1938 case SYMBOL_PLAINVAL: return Qnil;
1939 case SYMBOL_FORWARDED:
1941 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1942 if (KBOARD_OBJFWDP (valcontents))
1943 return Fframe_terminal (Fselected_frame ());
1944 else if (!BUFFER_OBJFWDP (valcontents))
1945 return Qnil;
1947 /* FALLTHROUGH */
1948 case SYMBOL_LOCALIZED:
1949 /* For a local variable, record both the symbol and which
1950 buffer's or frame's value we are saving. */
1951 if (!NILP (Flocal_variable_p (variable, Qnil)))
1952 return Fcurrent_buffer ();
1953 else if (sym->redirect == SYMBOL_LOCALIZED
1954 && BLV_FOUND (SYMBOL_BLV (sym)))
1955 return SYMBOL_BLV (sym)->where;
1956 else
1957 return Qnil;
1958 default: abort ();
1962 /* This code is disabled now that we use the selected frame to return
1963 keyboard-local-values. */
1964 #if 0
1965 extern struct terminal *get_terminal (Lisp_Object display, int);
1967 DEFUN ("terminal-local-value", Fterminal_local_value, Sterminal_local_value, 2, 2, 0,
1968 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1969 If SYMBOL is not a terminal-local variable, then return its normal
1970 value, like `symbol-value'.
1972 TERMINAL may be a terminal object, a frame, or nil (meaning the
1973 selected frame's terminal device). */)
1974 (Lisp_Object symbol, Lisp_Object terminal)
1976 Lisp_Object result;
1977 struct terminal *t = get_terminal (terminal, 1);
1978 push_kboard (t->kboard);
1979 result = Fsymbol_value (symbol);
1980 pop_kboard ();
1981 return result;
1984 DEFUN ("set-terminal-local-value", Fset_terminal_local_value, Sset_terminal_local_value, 3, 3, 0,
1985 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1986 If VARIABLE is not a terminal-local variable, then set its normal
1987 binding, like `set'.
1989 TERMINAL may be a terminal object, a frame, or nil (meaning the
1990 selected frame's terminal device). */)
1991 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1993 Lisp_Object result;
1994 struct terminal *t = get_terminal (terminal, 1);
1995 push_kboard (d->kboard);
1996 result = Fset (symbol, value);
1997 pop_kboard ();
1998 return result;
2000 #endif
2002 /* Find the function at the end of a chain of symbol function indirections. */
2004 /* If OBJECT is a symbol, find the end of its function chain and
2005 return the value found there. If OBJECT is not a symbol, just
2006 return it. If there is a cycle in the function chain, signal a
2007 cyclic-function-indirection error.
2009 This is like Findirect_function, except that it doesn't signal an
2010 error if the chain ends up unbound. */
2011 Lisp_Object
2012 indirect_function (register Lisp_Object object)
2014 Lisp_Object tortoise, hare;
2016 hare = tortoise = object;
2018 for (;;)
2020 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2021 break;
2022 hare = XSYMBOL (hare)->function;
2023 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2024 break;
2025 hare = XSYMBOL (hare)->function;
2027 tortoise = XSYMBOL (tortoise)->function;
2029 if (EQ (hare, tortoise))
2030 xsignal1 (Qcyclic_function_indirection, object);
2033 return hare;
2036 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2037 doc: /* Return the function at the end of OBJECT's function chain.
2038 If OBJECT is not a symbol, just return it. Otherwise, follow all
2039 function indirections to find the final function binding and return it.
2040 If the final symbol in the chain is unbound, signal a void-function error.
2041 Optional arg NOERROR non-nil means to return nil instead of signalling.
2042 Signal a cyclic-function-indirection error if there is a loop in the
2043 function chain of symbols. */)
2044 (register Lisp_Object object, Lisp_Object noerror)
2046 Lisp_Object result;
2048 /* Optimize for no indirection. */
2049 result = object;
2050 if (SYMBOLP (result) && !EQ (result, Qunbound)
2051 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2052 result = indirect_function (result);
2053 if (!EQ (result, Qunbound))
2054 return result;
2056 if (NILP (noerror))
2057 xsignal1 (Qvoid_function, object);
2059 return Qnil;
2062 /* Extract and set vector and string elements */
2064 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2065 doc: /* Return the element of ARRAY at index IDX.
2066 ARRAY may be a vector, a string, a char-table, a bool-vector,
2067 or a byte-code object. IDX starts at 0. */)
2068 (register Lisp_Object array, Lisp_Object idx)
2070 register EMACS_INT idxval;
2072 CHECK_NUMBER (idx);
2073 idxval = XINT (idx);
2074 if (STRINGP (array))
2076 int c;
2077 EMACS_INT idxval_byte;
2079 if (idxval < 0 || idxval >= SCHARS (array))
2080 args_out_of_range (array, idx);
2081 if (! STRING_MULTIBYTE (array))
2082 return make_number ((unsigned char) SREF (array, idxval));
2083 idxval_byte = string_char_to_byte (array, idxval);
2085 c = STRING_CHAR (SDATA (array) + idxval_byte);
2086 return make_number (c);
2088 else if (BOOL_VECTOR_P (array))
2090 int val;
2092 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2093 args_out_of_range (array, idx);
2095 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2096 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2098 else if (CHAR_TABLE_P (array))
2100 CHECK_CHARACTER (idx);
2101 return CHAR_TABLE_REF (array, idxval);
2103 else
2105 int size = 0;
2106 if (VECTORP (array))
2107 size = XVECTOR (array)->size;
2108 else if (COMPILEDP (array))
2109 size = XVECTOR (array)->size & PSEUDOVECTOR_SIZE_MASK;
2110 else
2111 wrong_type_argument (Qarrayp, array);
2113 if (idxval < 0 || idxval >= size)
2114 args_out_of_range (array, idx);
2115 return XVECTOR (array)->contents[idxval];
2119 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2120 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2121 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2122 bool-vector. IDX starts at 0. */)
2123 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2125 register EMACS_INT idxval;
2127 CHECK_NUMBER (idx);
2128 idxval = XINT (idx);
2129 CHECK_ARRAY (array, Qarrayp);
2130 CHECK_IMPURE (array);
2132 if (VECTORP (array))
2134 if (idxval < 0 || idxval >= XVECTOR (array)->size)
2135 args_out_of_range (array, idx);
2136 XVECTOR (array)->contents[idxval] = newelt;
2138 else if (BOOL_VECTOR_P (array))
2140 int val;
2142 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2143 args_out_of_range (array, idx);
2145 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2147 if (! NILP (newelt))
2148 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2149 else
2150 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2151 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2153 else if (CHAR_TABLE_P (array))
2155 CHECK_CHARACTER (idx);
2156 CHAR_TABLE_SET (array, idxval, newelt);
2158 else if (STRING_MULTIBYTE (array))
2160 EMACS_INT idxval_byte, prev_bytes, new_bytes, nbytes;
2161 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2163 if (idxval < 0 || idxval >= SCHARS (array))
2164 args_out_of_range (array, idx);
2165 CHECK_CHARACTER (newelt);
2167 nbytes = SBYTES (array);
2169 idxval_byte = string_char_to_byte (array, idxval);
2170 p1 = SDATA (array) + idxval_byte;
2171 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2172 new_bytes = CHAR_STRING (XINT (newelt), p0);
2173 if (prev_bytes != new_bytes)
2175 /* We must relocate the string data. */
2176 EMACS_INT nchars = SCHARS (array);
2177 unsigned char *str;
2178 USE_SAFE_ALLOCA;
2180 SAFE_ALLOCA (str, unsigned char *, nbytes);
2181 memcpy (str, SDATA (array), nbytes);
2182 allocate_string_data (XSTRING (array), nchars,
2183 nbytes + new_bytes - prev_bytes);
2184 memcpy (SDATA (array), str, idxval_byte);
2185 p1 = SDATA (array) + idxval_byte;
2186 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2187 nbytes - (idxval_byte + prev_bytes));
2188 SAFE_FREE ();
2189 clear_string_char_byte_cache ();
2191 while (new_bytes--)
2192 *p1++ = *p0++;
2194 else
2196 if (idxval < 0 || idxval >= SCHARS (array))
2197 args_out_of_range (array, idx);
2198 CHECK_NUMBER (newelt);
2200 if (XINT (newelt) >= 0 && ! SINGLE_BYTE_CHAR_P (XINT (newelt)))
2202 int i;
2204 for (i = SBYTES (array) - 1; i >= 0; i--)
2205 if (SREF (array, i) >= 0x80)
2206 args_out_of_range (array, newelt);
2207 /* ARRAY is an ASCII string. Convert it to a multibyte
2208 string, and try `aset' again. */
2209 STRING_SET_MULTIBYTE (array);
2210 return Faset (array, idx, newelt);
2212 SSET (array, idxval, XINT (newelt));
2215 return newelt;
2218 /* Arithmetic functions */
2220 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2222 Lisp_Object
2223 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2225 double f1 = 0, f2 = 0;
2226 int floatp = 0;
2228 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2229 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2231 if (FLOATP (num1) || FLOATP (num2))
2233 floatp = 1;
2234 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2235 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2238 switch (comparison)
2240 case equal:
2241 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2242 return Qt;
2243 return Qnil;
2245 case notequal:
2246 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2247 return Qt;
2248 return Qnil;
2250 case less:
2251 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2252 return Qt;
2253 return Qnil;
2255 case less_or_equal:
2256 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2257 return Qt;
2258 return Qnil;
2260 case grtr:
2261 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2262 return Qt;
2263 return Qnil;
2265 case grtr_or_equal:
2266 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2267 return Qt;
2268 return Qnil;
2270 default:
2271 abort ();
2275 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2276 doc: /* Return t if two args, both numbers or markers, are equal. */)
2277 (register Lisp_Object num1, Lisp_Object num2)
2279 return arithcompare (num1, num2, equal);
2282 DEFUN ("<", Flss, Slss, 2, 2, 0,
2283 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2284 (register Lisp_Object num1, Lisp_Object num2)
2286 return arithcompare (num1, num2, less);
2289 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2290 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2291 (register Lisp_Object num1, Lisp_Object num2)
2293 return arithcompare (num1, num2, grtr);
2296 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2297 doc: /* Return t if first arg is less than or equal to second arg.
2298 Both must be numbers or markers. */)
2299 (register Lisp_Object num1, Lisp_Object num2)
2301 return arithcompare (num1, num2, less_or_equal);
2304 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2305 doc: /* Return t if first arg is greater than or equal to second arg.
2306 Both must be numbers or markers. */)
2307 (register Lisp_Object num1, Lisp_Object num2)
2309 return arithcompare (num1, num2, grtr_or_equal);
2312 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2313 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2314 (register Lisp_Object num1, Lisp_Object num2)
2316 return arithcompare (num1, num2, notequal);
2319 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2320 doc: /* Return t if NUMBER is zero. */)
2321 (register Lisp_Object number)
2323 CHECK_NUMBER_OR_FLOAT (number);
2325 if (FLOATP (number))
2327 if (XFLOAT_DATA (number) == 0.0)
2328 return Qt;
2329 return Qnil;
2332 if (!XINT (number))
2333 return Qt;
2334 return Qnil;
2337 /* Convert between long values and pairs of Lisp integers.
2338 Note that long_to_cons returns a single Lisp integer
2339 when the value fits in one. */
2341 Lisp_Object
2342 long_to_cons (long unsigned int i)
2344 unsigned long top = i >> 16;
2345 unsigned int bot = i & 0xFFFF;
2346 if (top == 0)
2347 return make_number (bot);
2348 if (top == (unsigned long)-1 >> 16)
2349 return Fcons (make_number (-1), make_number (bot));
2350 return Fcons (make_number (top), make_number (bot));
2353 unsigned long
2354 cons_to_long (Lisp_Object c)
2356 Lisp_Object top, bot;
2357 if (INTEGERP (c))
2358 return XINT (c);
2359 top = XCAR (c);
2360 bot = XCDR (c);
2361 if (CONSP (bot))
2362 bot = XCAR (bot);
2363 return ((XINT (top) << 16) | XINT (bot));
2366 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2367 doc: /* Return the decimal representation of NUMBER as a string.
2368 Uses a minus sign if negative.
2369 NUMBER may be an integer or a floating point number. */)
2370 (Lisp_Object number)
2372 char buffer[VALBITS];
2374 CHECK_NUMBER_OR_FLOAT (number);
2376 if (FLOATP (number))
2378 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
2380 float_to_string (pigbuf, XFLOAT_DATA (number));
2381 return build_string (pigbuf);
2384 if (sizeof (int) == sizeof (EMACS_INT))
2385 sprintf (buffer, "%d", (int) XINT (number));
2386 else if (sizeof (long) == sizeof (EMACS_INT))
2387 sprintf (buffer, "%ld", (long) XINT (number));
2388 else
2389 abort ();
2390 return build_string (buffer);
2393 INLINE static int
2394 digit_to_number (int character, int base)
2396 int digit;
2398 if (character >= '0' && character <= '9')
2399 digit = character - '0';
2400 else if (character >= 'a' && character <= 'z')
2401 digit = character - 'a' + 10;
2402 else if (character >= 'A' && character <= 'Z')
2403 digit = character - 'A' + 10;
2404 else
2405 return -1;
2407 if (digit >= base)
2408 return -1;
2409 else
2410 return digit;
2413 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2414 doc: /* Parse STRING as a decimal number and return the number.
2415 This parses both integers and floating point numbers.
2416 It ignores leading spaces and tabs, and all trailing chars.
2418 If BASE, interpret STRING as a number in that base. If BASE isn't
2419 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2420 If the base used is not 10, STRING is always parsed as integer. */)
2421 (register Lisp_Object string, Lisp_Object base)
2423 register unsigned char *p;
2424 register int b;
2425 int sign = 1;
2426 Lisp_Object val;
2428 CHECK_STRING (string);
2430 if (NILP (base))
2431 b = 10;
2432 else
2434 CHECK_NUMBER (base);
2435 b = XINT (base);
2436 if (b < 2 || b > 16)
2437 xsignal1 (Qargs_out_of_range, base);
2440 /* Skip any whitespace at the front of the number. Some versions of
2441 atoi do this anyway, so we might as well make Emacs lisp consistent. */
2442 p = SDATA (string);
2443 while (*p == ' ' || *p == '\t')
2444 p++;
2446 if (*p == '-')
2448 sign = -1;
2449 p++;
2451 else if (*p == '+')
2452 p++;
2454 if (isfloat_string (p, 1) && b == 10)
2455 val = make_float (sign * atof (p));
2456 else
2458 double v = 0;
2460 while (1)
2462 int digit = digit_to_number (*p++, b);
2463 if (digit < 0)
2464 break;
2465 v = v * b + digit;
2468 val = make_fixnum_or_float (sign * v);
2471 return val;
2475 enum arithop
2477 Aadd,
2478 Asub,
2479 Amult,
2480 Adiv,
2481 Alogand,
2482 Alogior,
2483 Alogxor,
2484 Amax,
2485 Amin
2488 static Lisp_Object float_arith_driver (double, int, enum arithop,
2489 int, Lisp_Object *);
2490 Lisp_Object
2491 arith_driver (enum arithop code, int nargs, register Lisp_Object *args)
2493 register Lisp_Object val;
2494 register int argnum;
2495 register EMACS_INT accum = 0;
2496 register EMACS_INT next;
2498 switch (SWITCH_ENUM_CAST (code))
2500 case Alogior:
2501 case Alogxor:
2502 case Aadd:
2503 case Asub:
2504 accum = 0;
2505 break;
2506 case Amult:
2507 accum = 1;
2508 break;
2509 case Alogand:
2510 accum = -1;
2511 break;
2512 default:
2513 break;
2516 for (argnum = 0; argnum < nargs; argnum++)
2518 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2519 val = args[argnum];
2520 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2522 if (FLOATP (val))
2523 return float_arith_driver ((double) accum, argnum, code,
2524 nargs, args);
2525 args[argnum] = val;
2526 next = XINT (args[argnum]);
2527 switch (SWITCH_ENUM_CAST (code))
2529 case Aadd:
2530 accum += next;
2531 break;
2532 case Asub:
2533 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2534 break;
2535 case Amult:
2536 accum *= next;
2537 break;
2538 case Adiv:
2539 if (!argnum)
2540 accum = next;
2541 else
2543 if (next == 0)
2544 xsignal0 (Qarith_error);
2545 accum /= next;
2547 break;
2548 case Alogand:
2549 accum &= next;
2550 break;
2551 case Alogior:
2552 accum |= next;
2553 break;
2554 case Alogxor:
2555 accum ^= next;
2556 break;
2557 case Amax:
2558 if (!argnum || next > accum)
2559 accum = next;
2560 break;
2561 case Amin:
2562 if (!argnum || next < accum)
2563 accum = next;
2564 break;
2568 XSETINT (val, accum);
2569 return val;
2572 #undef isnan
2573 #define isnan(x) ((x) != (x))
2575 static Lisp_Object
2576 float_arith_driver (double accum, register int argnum, enum arithop code, int nargs, register Lisp_Object *args)
2578 register Lisp_Object val;
2579 double next;
2581 for (; argnum < nargs; argnum++)
2583 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2584 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2586 if (FLOATP (val))
2588 next = XFLOAT_DATA (val);
2590 else
2592 args[argnum] = val; /* runs into a compiler bug. */
2593 next = XINT (args[argnum]);
2595 switch (SWITCH_ENUM_CAST (code))
2597 case Aadd:
2598 accum += next;
2599 break;
2600 case Asub:
2601 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2602 break;
2603 case Amult:
2604 accum *= next;
2605 break;
2606 case Adiv:
2607 if (!argnum)
2608 accum = next;
2609 else
2611 if (! IEEE_FLOATING_POINT && next == 0)
2612 xsignal0 (Qarith_error);
2613 accum /= next;
2615 break;
2616 case Alogand:
2617 case Alogior:
2618 case Alogxor:
2619 return wrong_type_argument (Qinteger_or_marker_p, val);
2620 case Amax:
2621 if (!argnum || isnan (next) || next > accum)
2622 accum = next;
2623 break;
2624 case Amin:
2625 if (!argnum || isnan (next) || next < accum)
2626 accum = next;
2627 break;
2631 return make_float (accum);
2635 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2636 doc: /* Return sum of any number of arguments, which are numbers or markers.
2637 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2638 (int nargs, Lisp_Object *args)
2640 return arith_driver (Aadd, nargs, args);
2643 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2644 doc: /* Negate number or subtract numbers or markers and return the result.
2645 With one arg, negates it. With more than one arg,
2646 subtracts all but the first from the first.
2647 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2648 (int nargs, Lisp_Object *args)
2650 return arith_driver (Asub, nargs, args);
2653 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2654 doc: /* Return product of any number of arguments, which are numbers or markers.
2655 usage: (* &rest NUMBERS-OR-MARKERS) */)
2656 (int nargs, Lisp_Object *args)
2658 return arith_driver (Amult, nargs, args);
2661 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2662 doc: /* Return first argument divided by all the remaining arguments.
2663 The arguments must be numbers or markers.
2664 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2665 (int nargs, Lisp_Object *args)
2667 int argnum;
2668 for (argnum = 2; argnum < nargs; argnum++)
2669 if (FLOATP (args[argnum]))
2670 return float_arith_driver (0, 0, Adiv, nargs, args);
2671 return arith_driver (Adiv, nargs, args);
2674 DEFUN ("%", Frem, Srem, 2, 2, 0,
2675 doc: /* Return remainder of X divided by Y.
2676 Both must be integers or markers. */)
2677 (register Lisp_Object x, Lisp_Object y)
2679 Lisp_Object val;
2681 CHECK_NUMBER_COERCE_MARKER (x);
2682 CHECK_NUMBER_COERCE_MARKER (y);
2684 if (XFASTINT (y) == 0)
2685 xsignal0 (Qarith_error);
2687 XSETINT (val, XINT (x) % XINT (y));
2688 return val;
2691 #ifndef HAVE_FMOD
2692 double
2693 fmod (f1, f2)
2694 double f1, f2;
2696 double r = f1;
2698 if (f2 < 0.0)
2699 f2 = -f2;
2701 /* If the magnitude of the result exceeds that of the divisor, or
2702 the sign of the result does not agree with that of the dividend,
2703 iterate with the reduced value. This does not yield a
2704 particularly accurate result, but at least it will be in the
2705 range promised by fmod. */
2707 r -= f2 * floor (r / f2);
2708 while (f2 <= (r < 0 ? -r : r) || ((r < 0) != (f1 < 0) && ! isnan (r)));
2710 return r;
2712 #endif /* ! HAVE_FMOD */
2714 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2715 doc: /* Return X modulo Y.
2716 The result falls between zero (inclusive) and Y (exclusive).
2717 Both X and Y must be numbers or markers. */)
2718 (register Lisp_Object x, Lisp_Object y)
2720 Lisp_Object val;
2721 EMACS_INT i1, i2;
2723 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2724 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2726 if (FLOATP (x) || FLOATP (y))
2727 return fmod_float (x, y);
2729 i1 = XINT (x);
2730 i2 = XINT (y);
2732 if (i2 == 0)
2733 xsignal0 (Qarith_error);
2735 i1 %= i2;
2737 /* If the "remainder" comes out with the wrong sign, fix it. */
2738 if (i2 < 0 ? i1 > 0 : i1 < 0)
2739 i1 += i2;
2741 XSETINT (val, i1);
2742 return val;
2745 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2746 doc: /* Return largest of all the arguments (which must be numbers or markers).
2747 The value is always a number; markers are converted to numbers.
2748 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2749 (int nargs, Lisp_Object *args)
2751 return arith_driver (Amax, nargs, args);
2754 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2755 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2756 The value is always a number; markers are converted to numbers.
2757 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2758 (int nargs, Lisp_Object *args)
2760 return arith_driver (Amin, nargs, args);
2763 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2764 doc: /* Return bitwise-and of all the arguments.
2765 Arguments may be integers, or markers converted to integers.
2766 usage: (logand &rest INTS-OR-MARKERS) */)
2767 (int nargs, Lisp_Object *args)
2769 return arith_driver (Alogand, nargs, args);
2772 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2773 doc: /* Return bitwise-or of all the arguments.
2774 Arguments may be integers, or markers converted to integers.
2775 usage: (logior &rest INTS-OR-MARKERS) */)
2776 (int nargs, Lisp_Object *args)
2778 return arith_driver (Alogior, nargs, args);
2781 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2782 doc: /* Return bitwise-exclusive-or of all the arguments.
2783 Arguments may be integers, or markers converted to integers.
2784 usage: (logxor &rest INTS-OR-MARKERS) */)
2785 (int nargs, Lisp_Object *args)
2787 return arith_driver (Alogxor, nargs, args);
2790 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2791 doc: /* Return VALUE with its bits shifted left by COUNT.
2792 If COUNT is negative, shifting is actually to the right.
2793 In this case, the sign bit is duplicated. */)
2794 (register Lisp_Object value, Lisp_Object count)
2796 register Lisp_Object val;
2798 CHECK_NUMBER (value);
2799 CHECK_NUMBER (count);
2801 if (XINT (count) >= BITS_PER_EMACS_INT)
2802 XSETINT (val, 0);
2803 else if (XINT (count) > 0)
2804 XSETINT (val, XINT (value) << XFASTINT (count));
2805 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2806 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2807 else
2808 XSETINT (val, XINT (value) >> -XINT (count));
2809 return val;
2812 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2813 doc: /* Return VALUE with its bits shifted left by COUNT.
2814 If COUNT is negative, shifting is actually to the right.
2815 In this case, zeros are shifted in on the left. */)
2816 (register Lisp_Object value, Lisp_Object count)
2818 register Lisp_Object val;
2820 CHECK_NUMBER (value);
2821 CHECK_NUMBER (count);
2823 if (XINT (count) >= BITS_PER_EMACS_INT)
2824 XSETINT (val, 0);
2825 else if (XINT (count) > 0)
2826 XSETINT (val, (EMACS_UINT) XUINT (value) << XFASTINT (count));
2827 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2828 XSETINT (val, 0);
2829 else
2830 XSETINT (val, (EMACS_UINT) XUINT (value) >> -XINT (count));
2831 return val;
2834 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2835 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2836 Markers are converted to integers. */)
2837 (register Lisp_Object number)
2839 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2841 if (FLOATP (number))
2842 return (make_float (1.0 + XFLOAT_DATA (number)));
2844 XSETINT (number, XINT (number) + 1);
2845 return number;
2848 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2849 doc: /* Return NUMBER minus 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 ("lognot", Flognot, Slognot, 1, 1, 0,
2863 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2864 (register Lisp_Object number)
2866 CHECK_NUMBER (number);
2867 XSETINT (number, ~XINT (number));
2868 return number;
2871 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2872 doc: /* Return the byteorder for the machine.
2873 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2874 lowercase l) for small endian machines. */)
2875 (void)
2877 unsigned i = 0x04030201;
2878 int order = *(char *)&i == 1 ? 108 : 66;
2880 return make_number (order);
2885 void
2886 syms_of_data (void)
2888 Lisp_Object error_tail, arith_tail;
2890 Qquote = intern_c_string ("quote");
2891 Qlambda = intern_c_string ("lambda");
2892 Qsubr = intern_c_string ("subr");
2893 Qerror_conditions = intern_c_string ("error-conditions");
2894 Qerror_message = intern_c_string ("error-message");
2895 Qtop_level = intern_c_string ("top-level");
2897 Qerror = intern_c_string ("error");
2898 Qquit = intern_c_string ("quit");
2899 Qwrong_type_argument = intern_c_string ("wrong-type-argument");
2900 Qargs_out_of_range = intern_c_string ("args-out-of-range");
2901 Qvoid_function = intern_c_string ("void-function");
2902 Qcyclic_function_indirection = intern_c_string ("cyclic-function-indirection");
2903 Qcyclic_variable_indirection = intern_c_string ("cyclic-variable-indirection");
2904 Qvoid_variable = intern_c_string ("void-variable");
2905 Qsetting_constant = intern_c_string ("setting-constant");
2906 Qinvalid_read_syntax = intern_c_string ("invalid-read-syntax");
2908 Qinvalid_function = intern_c_string ("invalid-function");
2909 Qwrong_number_of_arguments = intern_c_string ("wrong-number-of-arguments");
2910 Qno_catch = intern_c_string ("no-catch");
2911 Qend_of_file = intern_c_string ("end-of-file");
2912 Qarith_error = intern_c_string ("arith-error");
2913 Qbeginning_of_buffer = intern_c_string ("beginning-of-buffer");
2914 Qend_of_buffer = intern_c_string ("end-of-buffer");
2915 Qbuffer_read_only = intern_c_string ("buffer-read-only");
2916 Qtext_read_only = intern_c_string ("text-read-only");
2917 Qmark_inactive = intern_c_string ("mark-inactive");
2919 Qlistp = intern_c_string ("listp");
2920 Qconsp = intern_c_string ("consp");
2921 Qsymbolp = intern_c_string ("symbolp");
2922 Qkeywordp = intern_c_string ("keywordp");
2923 Qintegerp = intern_c_string ("integerp");
2924 Qnatnump = intern_c_string ("natnump");
2925 Qwholenump = intern_c_string ("wholenump");
2926 Qstringp = intern_c_string ("stringp");
2927 Qarrayp = intern_c_string ("arrayp");
2928 Qsequencep = intern_c_string ("sequencep");
2929 Qbufferp = intern_c_string ("bufferp");
2930 Qvectorp = intern_c_string ("vectorp");
2931 Qchar_or_string_p = intern_c_string ("char-or-string-p");
2932 Qmarkerp = intern_c_string ("markerp");
2933 Qbuffer_or_string_p = intern_c_string ("buffer-or-string-p");
2934 Qinteger_or_marker_p = intern_c_string ("integer-or-marker-p");
2935 Qboundp = intern_c_string ("boundp");
2936 Qfboundp = intern_c_string ("fboundp");
2938 Qfloatp = intern_c_string ("floatp");
2939 Qnumberp = intern_c_string ("numberp");
2940 Qnumber_or_marker_p = intern_c_string ("number-or-marker-p");
2942 Qchar_table_p = intern_c_string ("char-table-p");
2943 Qvector_or_char_table_p = intern_c_string ("vector-or-char-table-p");
2945 Qsubrp = intern_c_string ("subrp");
2946 Qunevalled = intern_c_string ("unevalled");
2947 Qmany = intern_c_string ("many");
2949 Qcdr = intern_c_string ("cdr");
2951 /* Handle automatic advice activation */
2952 Qad_advice_info = intern_c_string ("ad-advice-info");
2953 Qad_activate_internal = intern_c_string ("ad-activate-internal");
2955 error_tail = pure_cons (Qerror, Qnil);
2957 /* ERROR is used as a signaler for random errors for which nothing else is right */
2959 Fput (Qerror, Qerror_conditions,
2960 error_tail);
2961 Fput (Qerror, Qerror_message,
2962 make_pure_c_string ("error"));
2964 Fput (Qquit, Qerror_conditions,
2965 pure_cons (Qquit, Qnil));
2966 Fput (Qquit, Qerror_message,
2967 make_pure_c_string ("Quit"));
2969 Fput (Qwrong_type_argument, Qerror_conditions,
2970 pure_cons (Qwrong_type_argument, error_tail));
2971 Fput (Qwrong_type_argument, Qerror_message,
2972 make_pure_c_string ("Wrong type argument"));
2974 Fput (Qargs_out_of_range, Qerror_conditions,
2975 pure_cons (Qargs_out_of_range, error_tail));
2976 Fput (Qargs_out_of_range, Qerror_message,
2977 make_pure_c_string ("Args out of range"));
2979 Fput (Qvoid_function, Qerror_conditions,
2980 pure_cons (Qvoid_function, error_tail));
2981 Fput (Qvoid_function, Qerror_message,
2982 make_pure_c_string ("Symbol's function definition is void"));
2984 Fput (Qcyclic_function_indirection, Qerror_conditions,
2985 pure_cons (Qcyclic_function_indirection, error_tail));
2986 Fput (Qcyclic_function_indirection, Qerror_message,
2987 make_pure_c_string ("Symbol's chain of function indirections contains a loop"));
2989 Fput (Qcyclic_variable_indirection, Qerror_conditions,
2990 pure_cons (Qcyclic_variable_indirection, error_tail));
2991 Fput (Qcyclic_variable_indirection, Qerror_message,
2992 make_pure_c_string ("Symbol's chain of variable indirections contains a loop"));
2994 Qcircular_list = intern_c_string ("circular-list");
2995 staticpro (&Qcircular_list);
2996 Fput (Qcircular_list, Qerror_conditions,
2997 pure_cons (Qcircular_list, error_tail));
2998 Fput (Qcircular_list, Qerror_message,
2999 make_pure_c_string ("List contains a loop"));
3001 Fput (Qvoid_variable, Qerror_conditions,
3002 pure_cons (Qvoid_variable, error_tail));
3003 Fput (Qvoid_variable, Qerror_message,
3004 make_pure_c_string ("Symbol's value as variable is void"));
3006 Fput (Qsetting_constant, Qerror_conditions,
3007 pure_cons (Qsetting_constant, error_tail));
3008 Fput (Qsetting_constant, Qerror_message,
3009 make_pure_c_string ("Attempt to set a constant symbol"));
3011 Fput (Qinvalid_read_syntax, Qerror_conditions,
3012 pure_cons (Qinvalid_read_syntax, error_tail));
3013 Fput (Qinvalid_read_syntax, Qerror_message,
3014 make_pure_c_string ("Invalid read syntax"));
3016 Fput (Qinvalid_function, Qerror_conditions,
3017 pure_cons (Qinvalid_function, error_tail));
3018 Fput (Qinvalid_function, Qerror_message,
3019 make_pure_c_string ("Invalid function"));
3021 Fput (Qwrong_number_of_arguments, Qerror_conditions,
3022 pure_cons (Qwrong_number_of_arguments, error_tail));
3023 Fput (Qwrong_number_of_arguments, Qerror_message,
3024 make_pure_c_string ("Wrong number of arguments"));
3026 Fput (Qno_catch, Qerror_conditions,
3027 pure_cons (Qno_catch, error_tail));
3028 Fput (Qno_catch, Qerror_message,
3029 make_pure_c_string ("No catch for tag"));
3031 Fput (Qend_of_file, Qerror_conditions,
3032 pure_cons (Qend_of_file, error_tail));
3033 Fput (Qend_of_file, Qerror_message,
3034 make_pure_c_string ("End of file during parsing"));
3036 arith_tail = pure_cons (Qarith_error, error_tail);
3037 Fput (Qarith_error, Qerror_conditions,
3038 arith_tail);
3039 Fput (Qarith_error, Qerror_message,
3040 make_pure_c_string ("Arithmetic error"));
3042 Fput (Qbeginning_of_buffer, Qerror_conditions,
3043 pure_cons (Qbeginning_of_buffer, error_tail));
3044 Fput (Qbeginning_of_buffer, Qerror_message,
3045 make_pure_c_string ("Beginning of buffer"));
3047 Fput (Qend_of_buffer, Qerror_conditions,
3048 pure_cons (Qend_of_buffer, error_tail));
3049 Fput (Qend_of_buffer, Qerror_message,
3050 make_pure_c_string ("End of buffer"));
3052 Fput (Qbuffer_read_only, Qerror_conditions,
3053 pure_cons (Qbuffer_read_only, error_tail));
3054 Fput (Qbuffer_read_only, Qerror_message,
3055 make_pure_c_string ("Buffer is read-only"));
3057 Fput (Qtext_read_only, Qerror_conditions,
3058 pure_cons (Qtext_read_only, error_tail));
3059 Fput (Qtext_read_only, Qerror_message,
3060 make_pure_c_string ("Text is read-only"));
3062 Qrange_error = intern_c_string ("range-error");
3063 Qdomain_error = intern_c_string ("domain-error");
3064 Qsingularity_error = intern_c_string ("singularity-error");
3065 Qoverflow_error = intern_c_string ("overflow-error");
3066 Qunderflow_error = intern_c_string ("underflow-error");
3068 Fput (Qdomain_error, Qerror_conditions,
3069 pure_cons (Qdomain_error, arith_tail));
3070 Fput (Qdomain_error, Qerror_message,
3071 make_pure_c_string ("Arithmetic domain error"));
3073 Fput (Qrange_error, Qerror_conditions,
3074 pure_cons (Qrange_error, arith_tail));
3075 Fput (Qrange_error, Qerror_message,
3076 make_pure_c_string ("Arithmetic range error"));
3078 Fput (Qsingularity_error, Qerror_conditions,
3079 pure_cons (Qsingularity_error, Fcons (Qdomain_error, arith_tail)));
3080 Fput (Qsingularity_error, Qerror_message,
3081 make_pure_c_string ("Arithmetic singularity error"));
3083 Fput (Qoverflow_error, Qerror_conditions,
3084 pure_cons (Qoverflow_error, Fcons (Qdomain_error, arith_tail)));
3085 Fput (Qoverflow_error, Qerror_message,
3086 make_pure_c_string ("Arithmetic overflow error"));
3088 Fput (Qunderflow_error, Qerror_conditions,
3089 pure_cons (Qunderflow_error, Fcons (Qdomain_error, arith_tail)));
3090 Fput (Qunderflow_error, Qerror_message,
3091 make_pure_c_string ("Arithmetic underflow error"));
3093 staticpro (&Qrange_error);
3094 staticpro (&Qdomain_error);
3095 staticpro (&Qsingularity_error);
3096 staticpro (&Qoverflow_error);
3097 staticpro (&Qunderflow_error);
3099 staticpro (&Qnil);
3100 staticpro (&Qt);
3101 staticpro (&Qquote);
3102 staticpro (&Qlambda);
3103 staticpro (&Qsubr);
3104 staticpro (&Qunbound);
3105 staticpro (&Qerror_conditions);
3106 staticpro (&Qerror_message);
3107 staticpro (&Qtop_level);
3109 staticpro (&Qerror);
3110 staticpro (&Qquit);
3111 staticpro (&Qwrong_type_argument);
3112 staticpro (&Qargs_out_of_range);
3113 staticpro (&Qvoid_function);
3114 staticpro (&Qcyclic_function_indirection);
3115 staticpro (&Qcyclic_variable_indirection);
3116 staticpro (&Qvoid_variable);
3117 staticpro (&Qsetting_constant);
3118 staticpro (&Qinvalid_read_syntax);
3119 staticpro (&Qwrong_number_of_arguments);
3120 staticpro (&Qinvalid_function);
3121 staticpro (&Qno_catch);
3122 staticpro (&Qend_of_file);
3123 staticpro (&Qarith_error);
3124 staticpro (&Qbeginning_of_buffer);
3125 staticpro (&Qend_of_buffer);
3126 staticpro (&Qbuffer_read_only);
3127 staticpro (&Qtext_read_only);
3128 staticpro (&Qmark_inactive);
3130 staticpro (&Qlistp);
3131 staticpro (&Qconsp);
3132 staticpro (&Qsymbolp);
3133 staticpro (&Qkeywordp);
3134 staticpro (&Qintegerp);
3135 staticpro (&Qnatnump);
3136 staticpro (&Qwholenump);
3137 staticpro (&Qstringp);
3138 staticpro (&Qarrayp);
3139 staticpro (&Qsequencep);
3140 staticpro (&Qbufferp);
3141 staticpro (&Qvectorp);
3142 staticpro (&Qchar_or_string_p);
3143 staticpro (&Qmarkerp);
3144 staticpro (&Qbuffer_or_string_p);
3145 staticpro (&Qinteger_or_marker_p);
3146 staticpro (&Qfloatp);
3147 staticpro (&Qnumberp);
3148 staticpro (&Qnumber_or_marker_p);
3149 staticpro (&Qchar_table_p);
3150 staticpro (&Qvector_or_char_table_p);
3151 staticpro (&Qsubrp);
3152 staticpro (&Qmany);
3153 staticpro (&Qunevalled);
3155 staticpro (&Qboundp);
3156 staticpro (&Qfboundp);
3157 staticpro (&Qcdr);
3158 staticpro (&Qad_advice_info);
3159 staticpro (&Qad_activate_internal);
3161 /* Types that type-of returns. */
3162 Qinteger = intern_c_string ("integer");
3163 Qsymbol = intern_c_string ("symbol");
3164 Qstring = intern_c_string ("string");
3165 Qcons = intern_c_string ("cons");
3166 Qmarker = intern_c_string ("marker");
3167 Qoverlay = intern_c_string ("overlay");
3168 Qfloat = intern_c_string ("float");
3169 Qwindow_configuration = intern_c_string ("window-configuration");
3170 Qprocess = intern_c_string ("process");
3171 Qwindow = intern_c_string ("window");
3172 /* Qsubr = intern_c_string ("subr"); */
3173 Qcompiled_function = intern_c_string ("compiled-function");
3174 Qbuffer = intern_c_string ("buffer");
3175 Qframe = intern_c_string ("frame");
3176 Qvector = intern_c_string ("vector");
3177 Qchar_table = intern_c_string ("char-table");
3178 Qbool_vector = intern_c_string ("bool-vector");
3179 Qhash_table = intern_c_string ("hash-table");
3181 DEFSYM (Qfont_spec, "font-spec");
3182 DEFSYM (Qfont_entity, "font-entity");
3183 DEFSYM (Qfont_object, "font-object");
3185 DEFSYM (Qinteractive_form, "interactive-form");
3187 staticpro (&Qinteger);
3188 staticpro (&Qsymbol);
3189 staticpro (&Qstring);
3190 staticpro (&Qcons);
3191 staticpro (&Qmarker);
3192 staticpro (&Qoverlay);
3193 staticpro (&Qfloat);
3194 staticpro (&Qwindow_configuration);
3195 staticpro (&Qprocess);
3196 staticpro (&Qwindow);
3197 /* staticpro (&Qsubr); */
3198 staticpro (&Qcompiled_function);
3199 staticpro (&Qbuffer);
3200 staticpro (&Qframe);
3201 staticpro (&Qvector);
3202 staticpro (&Qchar_table);
3203 staticpro (&Qbool_vector);
3204 staticpro (&Qhash_table);
3206 defsubr (&Sindirect_variable);
3207 defsubr (&Sinteractive_form);
3208 defsubr (&Seq);
3209 defsubr (&Snull);
3210 defsubr (&Stype_of);
3211 defsubr (&Slistp);
3212 defsubr (&Snlistp);
3213 defsubr (&Sconsp);
3214 defsubr (&Satom);
3215 defsubr (&Sintegerp);
3216 defsubr (&Sinteger_or_marker_p);
3217 defsubr (&Snumberp);
3218 defsubr (&Snumber_or_marker_p);
3219 defsubr (&Sfloatp);
3220 defsubr (&Snatnump);
3221 defsubr (&Ssymbolp);
3222 defsubr (&Skeywordp);
3223 defsubr (&Sstringp);
3224 defsubr (&Smultibyte_string_p);
3225 defsubr (&Svectorp);
3226 defsubr (&Schar_table_p);
3227 defsubr (&Svector_or_char_table_p);
3228 defsubr (&Sbool_vector_p);
3229 defsubr (&Sarrayp);
3230 defsubr (&Ssequencep);
3231 defsubr (&Sbufferp);
3232 defsubr (&Smarkerp);
3233 defsubr (&Ssubrp);
3234 defsubr (&Sbyte_code_function_p);
3235 defsubr (&Schar_or_string_p);
3236 defsubr (&Scar);
3237 defsubr (&Scdr);
3238 defsubr (&Scar_safe);
3239 defsubr (&Scdr_safe);
3240 defsubr (&Ssetcar);
3241 defsubr (&Ssetcdr);
3242 defsubr (&Ssymbol_function);
3243 defsubr (&Sindirect_function);
3244 defsubr (&Ssymbol_plist);
3245 defsubr (&Ssymbol_name);
3246 defsubr (&Smakunbound);
3247 defsubr (&Sfmakunbound);
3248 defsubr (&Sboundp);
3249 defsubr (&Sfboundp);
3250 defsubr (&Sfset);
3251 defsubr (&Sdefalias);
3252 defsubr (&Ssetplist);
3253 defsubr (&Ssymbol_value);
3254 defsubr (&Sset);
3255 defsubr (&Sdefault_boundp);
3256 defsubr (&Sdefault_value);
3257 defsubr (&Sset_default);
3258 defsubr (&Ssetq_default);
3259 defsubr (&Smake_variable_buffer_local);
3260 defsubr (&Smake_local_variable);
3261 defsubr (&Skill_local_variable);
3262 defsubr (&Smake_variable_frame_local);
3263 defsubr (&Slocal_variable_p);
3264 defsubr (&Slocal_variable_if_set_p);
3265 defsubr (&Svariable_binding_locus);
3266 #if 0 /* XXX Remove this. --lorentey */
3267 defsubr (&Sterminal_local_value);
3268 defsubr (&Sset_terminal_local_value);
3269 #endif
3270 defsubr (&Saref);
3271 defsubr (&Saset);
3272 defsubr (&Snumber_to_string);
3273 defsubr (&Sstring_to_number);
3274 defsubr (&Seqlsign);
3275 defsubr (&Slss);
3276 defsubr (&Sgtr);
3277 defsubr (&Sleq);
3278 defsubr (&Sgeq);
3279 defsubr (&Sneq);
3280 defsubr (&Szerop);
3281 defsubr (&Splus);
3282 defsubr (&Sminus);
3283 defsubr (&Stimes);
3284 defsubr (&Squo);
3285 defsubr (&Srem);
3286 defsubr (&Smod);
3287 defsubr (&Smax);
3288 defsubr (&Smin);
3289 defsubr (&Slogand);
3290 defsubr (&Slogior);
3291 defsubr (&Slogxor);
3292 defsubr (&Slsh);
3293 defsubr (&Sash);
3294 defsubr (&Sadd1);
3295 defsubr (&Ssub1);
3296 defsubr (&Slognot);
3297 defsubr (&Sbyteorder);
3298 defsubr (&Ssubr_arity);
3299 defsubr (&Ssubr_name);
3301 XSYMBOL (Qwholenump)->function = XSYMBOL (Qnatnump)->function;
3303 DEFVAR_LISP ("most-positive-fixnum", &Vmost_positive_fixnum,
3304 doc: /* The largest value that is representable in a Lisp integer. */);
3305 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3306 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3308 DEFVAR_LISP ("most-negative-fixnum", &Vmost_negative_fixnum,
3309 doc: /* The smallest value that is representable in a Lisp integer. */);
3310 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3311 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;
3314 SIGTYPE
3315 arith_error (int signo)
3317 sigsetmask (SIGEMPTYMASK);
3319 SIGNAL_THREAD_CHECK (signo);
3320 xsignal0 (Qarith_error);
3323 void
3324 init_data (void)
3326 /* Don't do this if just dumping out.
3327 We don't want to call `signal' in this case
3328 so that we don't have trouble with dumping
3329 signal-delivering routines in an inconsistent state. */
3330 #ifndef CANNOT_DUMP
3331 if (!initialized)
3332 return;
3333 #endif /* CANNOT_DUMP */
3334 signal (SIGFPE, arith_error);
3336 #ifdef uts
3337 signal (SIGEMT, arith_error);
3338 #endif /* uts */