* doc/lispref/os.texi (Notifications): Copyedits.
[emacs.git] / src / data.c
blobbd1d89992cb3cc9a902d857facc772c6b2275847
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include <intprops.h>
28 #include "lisp.h"
29 #include "puresize.h"
30 #include "character.h"
31 #include "buffer.h"
32 #include "keyboard.h"
33 #include "frame.h"
34 #include "syssignal.h"
35 #include "termhooks.h" /* For FRAME_KBOARD reference in y-or-n-p. */
36 #include "font.h"
38 #include <float.h>
39 /* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
40 #ifndef IEEE_FLOATING_POINT
41 #if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
42 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
43 #define IEEE_FLOATING_POINT 1
44 #else
45 #define IEEE_FLOATING_POINT 0
46 #endif
47 #endif
49 #include <math.h>
51 Lisp_Object Qnil, Qt, Qquote, Qlambda, Qunbound;
52 static Lisp_Object Qsubr;
53 Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
54 Lisp_Object Qerror, Qquit, Qargs_out_of_range;
55 static Lisp_Object Qwrong_type_argument;
56 Lisp_Object Qvoid_variable, Qvoid_function;
57 static Lisp_Object Qcyclic_function_indirection;
58 static Lisp_Object Qcyclic_variable_indirection;
59 Lisp_Object Qcircular_list;
60 static Lisp_Object Qsetting_constant;
61 Lisp_Object 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, Qwholenump, Qsymbolp, Qlistp, Qconsp;
68 static Lisp_Object Qnatnump;
69 Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
70 Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
71 Lisp_Object Qbuffer_or_string_p;
72 static Lisp_Object Qkeywordp, Qboundp;
73 Lisp_Object Qfboundp;
74 Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
76 Lisp_Object Qcdr;
77 static Lisp_Object Qad_advice_info, Qad_activate_internal;
79 Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
80 Lisp_Object Qoverflow_error, Qunderflow_error;
82 Lisp_Object Qfloatp;
83 Lisp_Object Qnumberp, Qnumber_or_marker_p;
85 Lisp_Object Qinteger;
86 static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
87 Lisp_Object Qwindow;
88 static Lisp_Object Qfloat, Qwindow_configuration;
89 static Lisp_Object Qprocess;
90 static Lisp_Object Qcompiled_function, Qframe, Qvector;
91 Lisp_Object Qbuffer;
92 static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
93 static Lisp_Object Qsubrp, Qmany, Qunevalled;
94 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
96 Lisp_Object Qinteractive_form;
98 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
101 Lisp_Object
102 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
104 /* If VALUE is not even a valid Lisp object, we'd want to abort here
105 where we can get a backtrace showing where it came from. We used
106 to try and do that by checking the tagbits, but nowadays all
107 tagbits are potentially valid. */
108 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
109 * abort (); */
111 xsignal2 (Qwrong_type_argument, predicate, value);
114 void
115 pure_write_error (void)
117 error ("Attempt to modify read-only object");
120 void
121 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
123 xsignal2 (Qargs_out_of_range, a1, a2);
126 void
127 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
129 xsignal3 (Qargs_out_of_range, a1, a2, a3);
133 /* Data type predicates */
135 DEFUN ("eq", Feq, Seq, 2, 2, 0,
136 doc: /* Return t if the two args are the same Lisp object. */)
137 (Lisp_Object obj1, Lisp_Object obj2)
139 if (EQ (obj1, obj2))
140 return Qt;
141 return Qnil;
144 DEFUN ("null", Fnull, Snull, 1, 1, 0,
145 doc: /* Return t if OBJECT is nil. */)
146 (Lisp_Object object)
148 if (NILP (object))
149 return Qt;
150 return Qnil;
153 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
154 doc: /* Return a symbol representing the type of OBJECT.
155 The symbol returned names the object's basic type;
156 for example, (type-of 1) returns `integer'. */)
157 (Lisp_Object object)
159 switch (XTYPE (object))
161 case_Lisp_Int:
162 return Qinteger;
164 case Lisp_Symbol:
165 return Qsymbol;
167 case Lisp_String:
168 return Qstring;
170 case Lisp_Cons:
171 return Qcons;
173 case Lisp_Misc:
174 switch (XMISCTYPE (object))
176 case Lisp_Misc_Marker:
177 return Qmarker;
178 case Lisp_Misc_Overlay:
179 return Qoverlay;
180 case Lisp_Misc_Float:
181 return Qfloat;
183 abort ();
185 case Lisp_Vectorlike:
186 if (WINDOW_CONFIGURATIONP (object))
187 return Qwindow_configuration;
188 if (PROCESSP (object))
189 return Qprocess;
190 if (WINDOWP (object))
191 return Qwindow;
192 if (SUBRP (object))
193 return Qsubr;
194 if (COMPILEDP (object))
195 return Qcompiled_function;
196 if (BUFFERP (object))
197 return Qbuffer;
198 if (CHAR_TABLE_P (object))
199 return Qchar_table;
200 if (BOOL_VECTOR_P (object))
201 return Qbool_vector;
202 if (FRAMEP (object))
203 return Qframe;
204 if (HASH_TABLE_P (object))
205 return Qhash_table;
206 if (FONT_SPEC_P (object))
207 return Qfont_spec;
208 if (FONT_ENTITY_P (object))
209 return Qfont_entity;
210 if (FONT_OBJECT_P (object))
211 return Qfont_object;
212 return Qvector;
214 case Lisp_Float:
215 return Qfloat;
217 default:
218 abort ();
222 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
223 doc: /* Return t if OBJECT is a cons cell. */)
224 (Lisp_Object object)
226 if (CONSP (object))
227 return Qt;
228 return Qnil;
231 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
232 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
233 (Lisp_Object object)
235 if (CONSP (object))
236 return Qnil;
237 return Qt;
240 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
241 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
242 Otherwise, return nil. */)
243 (Lisp_Object object)
245 if (CONSP (object) || NILP (object))
246 return Qt;
247 return Qnil;
250 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
251 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
252 (Lisp_Object object)
254 if (CONSP (object) || NILP (object))
255 return Qnil;
256 return Qt;
259 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
260 doc: /* Return t if OBJECT is a symbol. */)
261 (Lisp_Object object)
263 if (SYMBOLP (object))
264 return Qt;
265 return Qnil;
268 /* Define this in C to avoid unnecessarily consing up the symbol
269 name. */
270 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
271 doc: /* Return t if OBJECT is a keyword.
272 This means that it is a symbol with a print name beginning with `:'
273 interned in the initial obarray. */)
274 (Lisp_Object object)
276 if (SYMBOLP (object)
277 && SREF (SYMBOL_NAME (object), 0) == ':'
278 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
279 return Qt;
280 return Qnil;
283 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
284 doc: /* Return t if OBJECT is a vector. */)
285 (Lisp_Object object)
287 if (VECTORP (object))
288 return Qt;
289 return Qnil;
292 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
293 doc: /* Return t if OBJECT is a string. */)
294 (Lisp_Object object)
296 if (STRINGP (object))
297 return Qt;
298 return Qnil;
301 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
302 1, 1, 0,
303 doc: /* Return t if OBJECT is a multibyte string. */)
304 (Lisp_Object object)
306 if (STRINGP (object) && STRING_MULTIBYTE (object))
307 return Qt;
308 return Qnil;
311 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
312 doc: /* Return t if OBJECT is a char-table. */)
313 (Lisp_Object object)
315 if (CHAR_TABLE_P (object))
316 return Qt;
317 return Qnil;
320 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
321 Svector_or_char_table_p, 1, 1, 0,
322 doc: /* Return t if OBJECT is a char-table or vector. */)
323 (Lisp_Object object)
325 if (VECTORP (object) || CHAR_TABLE_P (object))
326 return Qt;
327 return Qnil;
330 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
331 doc: /* Return t if OBJECT is a bool-vector. */)
332 (Lisp_Object object)
334 if (BOOL_VECTOR_P (object))
335 return Qt;
336 return Qnil;
339 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
340 doc: /* Return t if OBJECT is an array (string or vector). */)
341 (Lisp_Object object)
343 if (ARRAYP (object))
344 return Qt;
345 return Qnil;
348 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
349 doc: /* Return t if OBJECT is a sequence (list or array). */)
350 (register Lisp_Object object)
352 if (CONSP (object) || NILP (object) || ARRAYP (object))
353 return Qt;
354 return Qnil;
357 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
358 doc: /* Return t if OBJECT is an editor buffer. */)
359 (Lisp_Object object)
361 if (BUFFERP (object))
362 return Qt;
363 return Qnil;
366 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
367 doc: /* Return t if OBJECT is a marker (editor pointer). */)
368 (Lisp_Object object)
370 if (MARKERP (object))
371 return Qt;
372 return Qnil;
375 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
376 doc: /* Return t if OBJECT is a built-in function. */)
377 (Lisp_Object object)
379 if (SUBRP (object))
380 return Qt;
381 return Qnil;
384 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
385 1, 1, 0,
386 doc: /* Return t if OBJECT is a byte-compiled function object. */)
387 (Lisp_Object object)
389 if (COMPILEDP (object))
390 return Qt;
391 return Qnil;
394 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
395 doc: /* Return t if OBJECT is a character or a string. */)
396 (register Lisp_Object object)
398 if (CHARACTERP (object) || STRINGP (object))
399 return Qt;
400 return Qnil;
403 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
404 doc: /* Return t if OBJECT is an integer. */)
405 (Lisp_Object object)
407 if (INTEGERP (object))
408 return Qt;
409 return Qnil;
412 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
413 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
414 (register Lisp_Object object)
416 if (MARKERP (object) || INTEGERP (object))
417 return Qt;
418 return Qnil;
421 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
422 doc: /* Return t if OBJECT is a nonnegative integer. */)
423 (Lisp_Object object)
425 if (NATNUMP (object))
426 return Qt;
427 return Qnil;
430 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
431 doc: /* Return t if OBJECT is a number (floating point or integer). */)
432 (Lisp_Object object)
434 if (NUMBERP (object))
435 return Qt;
436 else
437 return Qnil;
440 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
441 Snumber_or_marker_p, 1, 1, 0,
442 doc: /* Return t if OBJECT is a number or a marker. */)
443 (Lisp_Object object)
445 if (NUMBERP (object) || MARKERP (object))
446 return Qt;
447 return Qnil;
450 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
451 doc: /* Return t if OBJECT is a floating point number. */)
452 (Lisp_Object object)
454 if (FLOATP (object))
455 return Qt;
456 return Qnil;
460 /* Extract and set components of lists */
462 DEFUN ("car", Fcar, Scar, 1, 1, 0,
463 doc: /* Return the car of LIST. If arg is nil, return nil.
464 Error if arg is not nil and not a cons cell. See also `car-safe'.
466 See Info node `(elisp)Cons Cells' for a discussion of related basic
467 Lisp concepts such as car, cdr, cons cell and list. */)
468 (register Lisp_Object list)
470 return CAR (list);
473 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
474 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
475 (Lisp_Object object)
477 return CAR_SAFE (object);
480 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
481 doc: /* Return the cdr of LIST. If arg is nil, return nil.
482 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
484 See Info node `(elisp)Cons Cells' for a discussion of related basic
485 Lisp concepts such as cdr, car, cons cell and list. */)
486 (register Lisp_Object list)
488 return CDR (list);
491 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
492 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
493 (Lisp_Object object)
495 return CDR_SAFE (object);
498 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
499 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
500 (register Lisp_Object cell, Lisp_Object newcar)
502 CHECK_CONS (cell);
503 CHECK_IMPURE (cell);
504 XSETCAR (cell, newcar);
505 return newcar;
508 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
509 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
510 (register Lisp_Object cell, Lisp_Object newcdr)
512 CHECK_CONS (cell);
513 CHECK_IMPURE (cell);
514 XSETCDR (cell, newcdr);
515 return newcdr;
518 /* Extract and set components of symbols */
520 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
521 doc: /* Return t if SYMBOL's value is not void. */)
522 (register Lisp_Object symbol)
524 Lisp_Object valcontents;
525 struct Lisp_Symbol *sym;
526 CHECK_SYMBOL (symbol);
527 sym = XSYMBOL (symbol);
529 start:
530 switch (sym->redirect)
532 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
533 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
534 case SYMBOL_LOCALIZED:
536 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
537 if (blv->fwd)
538 /* In set_internal, we un-forward vars when their value is
539 set to Qunbound. */
540 return Qt;
541 else
543 swap_in_symval_forwarding (sym, blv);
544 valcontents = BLV_VALUE (blv);
546 break;
548 case SYMBOL_FORWARDED:
549 /* In set_internal, we un-forward vars when their value is
550 set to Qunbound. */
551 return Qt;
552 default: abort ();
555 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
558 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
559 doc: /* Return t if SYMBOL's function definition is not void. */)
560 (register Lisp_Object symbol)
562 CHECK_SYMBOL (symbol);
563 return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
566 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
567 doc: /* Make SYMBOL's value be void.
568 Return SYMBOL. */)
569 (register Lisp_Object symbol)
571 CHECK_SYMBOL (symbol);
572 if (SYMBOL_CONSTANT_P (symbol))
573 xsignal1 (Qsetting_constant, symbol);
574 Fset (symbol, Qunbound);
575 return symbol;
578 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
579 doc: /* Make SYMBOL's function definition be void.
580 Return SYMBOL. */)
581 (register Lisp_Object symbol)
583 CHECK_SYMBOL (symbol);
584 if (NILP (symbol) || EQ (symbol, Qt))
585 xsignal1 (Qsetting_constant, symbol);
586 XSYMBOL (symbol)->function = Qunbound;
587 return symbol;
590 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
591 doc: /* Return SYMBOL's function definition. Error if that is void. */)
592 (register Lisp_Object symbol)
594 CHECK_SYMBOL (symbol);
595 if (!EQ (XSYMBOL (symbol)->function, Qunbound))
596 return XSYMBOL (symbol)->function;
597 xsignal1 (Qvoid_function, symbol);
600 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
601 doc: /* Return SYMBOL's property list. */)
602 (register Lisp_Object symbol)
604 CHECK_SYMBOL (symbol);
605 return XSYMBOL (symbol)->plist;
608 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
609 doc: /* Return SYMBOL's name, a string. */)
610 (register Lisp_Object symbol)
612 register Lisp_Object name;
614 CHECK_SYMBOL (symbol);
615 name = SYMBOL_NAME (symbol);
616 return name;
619 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
620 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
621 (register Lisp_Object symbol, Lisp_Object definition)
623 register Lisp_Object function;
625 CHECK_SYMBOL (symbol);
626 if (NILP (symbol) || EQ (symbol, Qt))
627 xsignal1 (Qsetting_constant, symbol);
629 function = XSYMBOL (symbol)->function;
631 if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
632 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
634 if (CONSP (function) && EQ (XCAR (function), Qautoload))
635 Fput (symbol, Qautoload, XCDR (function));
637 XSYMBOL (symbol)->function = definition;
638 /* Handle automatic advice activation */
639 if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
641 call2 (Qad_activate_internal, symbol, Qnil);
642 definition = XSYMBOL (symbol)->function;
644 return definition;
647 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
648 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
649 Associates the function with the current load file, if any.
650 The optional third argument DOCSTRING specifies the documentation string
651 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
652 determined by DEFINITION. */)
653 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
655 CHECK_SYMBOL (symbol);
656 if (CONSP (XSYMBOL (symbol)->function)
657 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
658 LOADHIST_ATTACH (Fcons (Qt, symbol));
659 definition = Ffset (symbol, definition);
660 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
661 if (!NILP (docstring))
662 Fput (symbol, Qfunction_documentation, docstring);
663 return definition;
666 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
667 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
668 (register Lisp_Object symbol, Lisp_Object newplist)
670 CHECK_SYMBOL (symbol);
671 XSYMBOL (symbol)->plist = newplist;
672 return newplist;
675 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
676 doc: /* Return minimum and maximum number of args allowed for SUBR.
677 SUBR must be a built-in function.
678 The returned value is a pair (MIN . MAX). MIN is the minimum number
679 of args. MAX is the maximum number or the symbol `many', for a
680 function with `&rest' args, or `unevalled' for a special form. */)
681 (Lisp_Object subr)
683 short minargs, maxargs;
684 CHECK_SUBR (subr);
685 minargs = XSUBR (subr)->min_args;
686 maxargs = XSUBR (subr)->max_args;
687 if (maxargs == MANY)
688 return Fcons (make_number (minargs), Qmany);
689 else if (maxargs == UNEVALLED)
690 return Fcons (make_number (minargs), Qunevalled);
691 else
692 return Fcons (make_number (minargs), make_number (maxargs));
695 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
696 doc: /* Return name of subroutine SUBR.
697 SUBR must be a built-in function. */)
698 (Lisp_Object subr)
700 const char *name;
701 CHECK_SUBR (subr);
702 name = XSUBR (subr)->symbol_name;
703 return build_string (name);
706 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
707 doc: /* Return the interactive form of CMD or nil if none.
708 If CMD is not a command, the return value is nil.
709 Value, if non-nil, is a list \(interactive SPEC). */)
710 (Lisp_Object cmd)
712 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
714 if (NILP (fun) || EQ (fun, Qunbound))
715 return Qnil;
717 /* Use an `interactive-form' property if present, analogous to the
718 function-documentation property. */
719 fun = cmd;
720 while (SYMBOLP (fun))
722 Lisp_Object tmp = Fget (fun, Qinteractive_form);
723 if (!NILP (tmp))
724 return tmp;
725 else
726 fun = Fsymbol_function (fun);
729 if (SUBRP (fun))
731 const char *spec = XSUBR (fun)->intspec;
732 if (spec)
733 return list2 (Qinteractive,
734 (*spec != '(') ? build_string (spec) :
735 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
737 else if (COMPILEDP (fun))
739 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
740 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
742 else if (CONSP (fun))
744 Lisp_Object funcar = XCAR (fun);
745 if (EQ (funcar, Qclosure))
746 return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
747 else if (EQ (funcar, Qlambda))
748 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
749 else if (EQ (funcar, Qautoload))
751 struct gcpro gcpro1;
752 GCPRO1 (cmd);
753 do_autoload (fun, cmd);
754 UNGCPRO;
755 return Finteractive_form (cmd);
758 return Qnil;
762 /***********************************************************************
763 Getting and Setting Values of Symbols
764 ***********************************************************************/
766 /* Return the symbol holding SYMBOL's value. Signal
767 `cyclic-variable-indirection' if SYMBOL's chain of variable
768 indirections contains a loop. */
770 struct Lisp_Symbol *
771 indirect_variable (struct Lisp_Symbol *symbol)
773 struct Lisp_Symbol *tortoise, *hare;
775 hare = tortoise = symbol;
777 while (hare->redirect == SYMBOL_VARALIAS)
779 hare = SYMBOL_ALIAS (hare);
780 if (hare->redirect != SYMBOL_VARALIAS)
781 break;
783 hare = SYMBOL_ALIAS (hare);
784 tortoise = SYMBOL_ALIAS (tortoise);
786 if (hare == tortoise)
788 Lisp_Object tem;
789 XSETSYMBOL (tem, symbol);
790 xsignal1 (Qcyclic_variable_indirection, tem);
794 return hare;
798 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
799 doc: /* Return the variable at the end of OBJECT's variable chain.
800 If OBJECT is a symbol, follow all variable indirections and return the final
801 variable. If OBJECT is not a symbol, just return it.
802 Signal a cyclic-variable-indirection error if there is a loop in the
803 variable chain of symbols. */)
804 (Lisp_Object object)
806 if (SYMBOLP (object))
808 struct Lisp_Symbol *sym = indirect_variable (XSYMBOL (object));
809 XSETSYMBOL (object, sym);
811 return object;
815 /* Given the raw contents of a symbol value cell,
816 return the Lisp value of the symbol.
817 This does not handle buffer-local variables; use
818 swap_in_symval_forwarding for that. */
820 Lisp_Object
821 do_symval_forwarding (register union Lisp_Fwd *valcontents)
823 register Lisp_Object val;
824 switch (XFWDTYPE (valcontents))
826 case Lisp_Fwd_Int:
827 XSETINT (val, *XINTFWD (valcontents)->intvar);
828 return val;
830 case Lisp_Fwd_Bool:
831 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
833 case Lisp_Fwd_Obj:
834 return *XOBJFWD (valcontents)->objvar;
836 case Lisp_Fwd_Buffer_Obj:
837 return PER_BUFFER_VALUE (current_buffer,
838 XBUFFER_OBJFWD (valcontents)->offset);
840 case Lisp_Fwd_Kboard_Obj:
841 /* We used to simply use current_kboard here, but from Lisp
842 code, its value is often unexpected. It seems nicer to
843 allow constructions like this to work as intuitively expected:
845 (with-selected-frame frame
846 (define-key local-function-map "\eOP" [f1]))
848 On the other hand, this affects the semantics of
849 last-command and real-last-command, and people may rely on
850 that. I took a quick look at the Lisp codebase, and I
851 don't think anything will break. --lorentey */
852 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
853 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
854 default: abort ();
858 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
859 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
860 buffer-independent contents of the value cell: forwarded just one
861 step past the buffer-localness.
863 BUF non-zero means set the value in buffer BUF instead of the
864 current buffer. This only plays a role for per-buffer variables. */
866 static void
867 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
869 switch (XFWDTYPE (valcontents))
871 case Lisp_Fwd_Int:
872 CHECK_NUMBER (newval);
873 *XINTFWD (valcontents)->intvar = XINT (newval);
874 break;
876 case Lisp_Fwd_Bool:
877 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
878 break;
880 case Lisp_Fwd_Obj:
881 *XOBJFWD (valcontents)->objvar = newval;
883 /* If this variable is a default for something stored
884 in the buffer itself, such as default-fill-column,
885 find the buffers that don't have local values for it
886 and update them. */
887 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
888 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
890 int offset = ((char *) XOBJFWD (valcontents)->objvar
891 - (char *) &buffer_defaults);
892 int idx = PER_BUFFER_IDX (offset);
894 Lisp_Object tail;
896 if (idx <= 0)
897 break;
899 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
901 Lisp_Object lbuf;
902 struct buffer *b;
904 lbuf = Fcdr (XCAR (tail));
905 if (!BUFFERP (lbuf)) continue;
906 b = XBUFFER (lbuf);
908 if (! PER_BUFFER_VALUE_P (b, idx))
909 PER_BUFFER_VALUE (b, offset) = newval;
912 break;
914 case Lisp_Fwd_Buffer_Obj:
916 int offset = XBUFFER_OBJFWD (valcontents)->offset;
917 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
919 if (!(NILP (type) || NILP (newval)
920 || (XINT (type) == LISP_INT_TAG
921 ? INTEGERP (newval)
922 : XTYPE (newval) == XINT (type))))
923 buffer_slot_type_mismatch (newval, XINT (type));
925 if (buf == NULL)
926 buf = current_buffer;
927 PER_BUFFER_VALUE (buf, offset) = newval;
929 break;
931 case Lisp_Fwd_Kboard_Obj:
933 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
934 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
935 *(Lisp_Object *) p = newval;
937 break;
939 default:
940 abort (); /* goto def; */
944 /* Set up SYMBOL to refer to its global binding.
945 This makes it safe to alter the status of other bindings. */
947 void
948 swap_in_global_binding (struct Lisp_Symbol *symbol)
950 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
952 /* Unload the previously loaded binding. */
953 if (blv->fwd)
954 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
956 /* Select the global binding in the symbol. */
957 blv->valcell = blv->defcell;
958 if (blv->fwd)
959 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
961 /* Indicate that the global binding is set up now. */
962 blv->where = Qnil;
963 SET_BLV_FOUND (blv, 0);
966 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
967 VALCONTENTS is the contents of its value cell,
968 which points to a struct Lisp_Buffer_Local_Value.
970 Return the value forwarded one step past the buffer-local stage.
971 This could be another forwarding pointer. */
973 static void
974 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
976 register Lisp_Object tem1;
978 eassert (blv == SYMBOL_BLV (symbol));
980 tem1 = blv->where;
982 if (NILP (tem1)
983 || (blv->frame_local
984 ? !EQ (selected_frame, tem1)
985 : current_buffer != XBUFFER (tem1)))
988 /* Unload the previously loaded binding. */
989 tem1 = blv->valcell;
990 if (blv->fwd)
991 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
992 /* Choose the new binding. */
994 Lisp_Object var;
995 XSETSYMBOL (var, symbol);
996 if (blv->frame_local)
998 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
999 blv->where = selected_frame;
1001 else
1003 tem1 = assq_no_quit (var, BVAR (current_buffer, local_var_alist));
1004 XSETBUFFER (blv->where, current_buffer);
1007 if (!(blv->found = !NILP (tem1)))
1008 tem1 = blv->defcell;
1010 /* Load the new binding. */
1011 blv->valcell = tem1;
1012 if (blv->fwd)
1013 store_symval_forwarding (blv->fwd, BLV_VALUE (blv), NULL);
1017 /* Find the value of a symbol, returning Qunbound if it's not bound.
1018 This is helpful for code which just wants to get a variable's value
1019 if it has one, without signaling an error.
1020 Note that it must not be possible to quit
1021 within this function. Great care is required for this. */
1023 Lisp_Object
1024 find_symbol_value (Lisp_Object symbol)
1026 struct Lisp_Symbol *sym;
1028 CHECK_SYMBOL (symbol);
1029 sym = XSYMBOL (symbol);
1031 start:
1032 switch (sym->redirect)
1034 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1035 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1036 case SYMBOL_LOCALIZED:
1038 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1039 swap_in_symval_forwarding (sym, blv);
1040 return blv->fwd ? do_symval_forwarding (blv->fwd) : BLV_VALUE (blv);
1042 /* FALLTHROUGH */
1043 case SYMBOL_FORWARDED:
1044 return do_symval_forwarding (SYMBOL_FWD (sym));
1045 default: abort ();
1049 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1050 doc: /* Return SYMBOL's value. Error if that is void. */)
1051 (Lisp_Object symbol)
1053 Lisp_Object val;
1055 val = find_symbol_value (symbol);
1056 if (!EQ (val, Qunbound))
1057 return val;
1059 xsignal1 (Qvoid_variable, symbol);
1062 DEFUN ("set", Fset, Sset, 2, 2, 0,
1063 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1064 (register Lisp_Object symbol, Lisp_Object newval)
1066 set_internal (symbol, newval, Qnil, 0);
1067 return newval;
1070 /* Return 1 if SYMBOL currently has a let-binding
1071 which was made in the buffer that is now current. */
1073 static int
1074 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1076 struct specbinding *p;
1078 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1079 if (p->func == NULL
1080 && CONSP (p->symbol))
1082 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1083 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1084 if (symbol == let_bound_symbol
1085 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1086 break;
1089 return p >= specpdl;
1092 static int
1093 let_shadows_global_binding_p (Lisp_Object symbol)
1095 struct specbinding *p;
1097 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1098 if (p->func == NULL && EQ (p->symbol, symbol))
1099 break;
1101 return p >= specpdl;
1104 /* Store the value NEWVAL into SYMBOL.
1105 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1106 (nil stands for the current buffer/frame).
1108 If BINDFLAG is zero, then if this symbol is supposed to become
1109 local in every buffer where it is set, then we make it local.
1110 If BINDFLAG is nonzero, we don't do that. */
1112 void
1113 set_internal (register Lisp_Object symbol, register Lisp_Object newval, register Lisp_Object where, int bindflag)
1115 int voide = EQ (newval, Qunbound);
1116 struct Lisp_Symbol *sym;
1117 Lisp_Object tem1;
1119 /* If restoring in a dead buffer, do nothing. */
1120 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1121 return; */
1123 CHECK_SYMBOL (symbol);
1124 if (SYMBOL_CONSTANT_P (symbol))
1126 if (NILP (Fkeywordp (symbol))
1127 || !EQ (newval, Fsymbol_value (symbol)))
1128 xsignal1 (Qsetting_constant, symbol);
1129 else
1130 /* Allow setting keywords to their own value. */
1131 return;
1134 sym = XSYMBOL (symbol);
1136 start:
1137 switch (sym->redirect)
1139 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1140 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1141 case SYMBOL_LOCALIZED:
1143 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1144 if (NILP (where))
1146 if (blv->frame_local)
1147 where = selected_frame;
1148 else
1149 XSETBUFFER (where, current_buffer);
1151 /* If the current buffer is not the buffer whose binding is
1152 loaded, or if there may be frame-local bindings and the frame
1153 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1154 the default binding is loaded, the loaded binding may be the
1155 wrong one. */
1156 if (!EQ (blv->where, where)
1157 /* Also unload a global binding (if the var is local_if_set). */
1158 || (EQ (blv->valcell, blv->defcell)))
1160 /* The currently loaded binding is not necessarily valid.
1161 We need to unload it, and choose a new binding. */
1163 /* Write out `realvalue' to the old loaded binding. */
1164 if (blv->fwd)
1165 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1167 /* Find the new binding. */
1168 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1169 tem1 = Fassq (symbol,
1170 (blv->frame_local
1171 ? XFRAME (where)->param_alist
1172 : BVAR (XBUFFER (where), local_var_alist)));
1173 blv->where = where;
1174 blv->found = 1;
1176 if (NILP (tem1))
1178 /* This buffer still sees the default value. */
1180 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1181 or if this is `let' rather than `set',
1182 make CURRENT-ALIST-ELEMENT point to itself,
1183 indicating that we're seeing the default value.
1184 Likewise if the variable has been let-bound
1185 in the current buffer. */
1186 if (bindflag || !blv->local_if_set
1187 || let_shadows_buffer_binding_p (sym))
1189 blv->found = 0;
1190 tem1 = blv->defcell;
1192 /* If it's a local_if_set, being set not bound,
1193 and we're not within a let that was made for this buffer,
1194 create a new buffer-local binding for the variable.
1195 That means, give this buffer a new assoc for a local value
1196 and load that binding. */
1197 else
1199 /* local_if_set is only supported for buffer-local
1200 bindings, not for frame-local bindings. */
1201 eassert (!blv->frame_local);
1202 tem1 = Fcons (symbol, XCDR (blv->defcell));
1203 BVAR (XBUFFER (where), local_var_alist)
1204 = Fcons (tem1, BVAR (XBUFFER (where), local_var_alist));
1208 /* Record which binding is now loaded. */
1209 blv->valcell = tem1;
1212 /* Store the new value in the cons cell. */
1213 SET_BLV_VALUE (blv, newval);
1215 if (blv->fwd)
1217 if (voide)
1218 /* If storing void (making the symbol void), forward only through
1219 buffer-local indicator, not through Lisp_Objfwd, etc. */
1220 blv->fwd = NULL;
1221 else
1222 store_symval_forwarding (blv->fwd, newval,
1223 BUFFERP (where)
1224 ? XBUFFER (where) : current_buffer);
1226 break;
1228 case SYMBOL_FORWARDED:
1230 struct buffer *buf
1231 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1232 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1233 if (BUFFER_OBJFWDP (innercontents))
1235 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1236 int idx = PER_BUFFER_IDX (offset);
1237 if (idx > 0
1238 && !bindflag
1239 && !let_shadows_buffer_binding_p (sym))
1240 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1243 if (voide)
1244 { /* If storing void (making the symbol void), forward only through
1245 buffer-local indicator, not through Lisp_Objfwd, etc. */
1246 sym->redirect = SYMBOL_PLAINVAL;
1247 SET_SYMBOL_VAL (sym, newval);
1249 else
1250 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1251 break;
1253 default: abort ();
1255 return;
1258 /* Access or set a buffer-local symbol's default value. */
1260 /* Return the default value of SYMBOL, but don't check for voidness.
1261 Return Qunbound if it is void. */
1263 static Lisp_Object
1264 default_value (Lisp_Object symbol)
1266 struct Lisp_Symbol *sym;
1268 CHECK_SYMBOL (symbol);
1269 sym = XSYMBOL (symbol);
1271 start:
1272 switch (sym->redirect)
1274 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1275 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1276 case SYMBOL_LOCALIZED:
1278 /* If var is set up for a buffer that lacks a local value for it,
1279 the current value is nominally the default value.
1280 But the `realvalue' slot may be more up to date, since
1281 ordinary setq stores just that slot. So use that. */
1282 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1283 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1284 return do_symval_forwarding (blv->fwd);
1285 else
1286 return XCDR (blv->defcell);
1288 case SYMBOL_FORWARDED:
1290 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1292 /* For a built-in buffer-local variable, get the default value
1293 rather than letting do_symval_forwarding get the current value. */
1294 if (BUFFER_OBJFWDP (valcontents))
1296 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1297 if (PER_BUFFER_IDX (offset) != 0)
1298 return PER_BUFFER_DEFAULT (offset);
1301 /* For other variables, get the current value. */
1302 return do_symval_forwarding (valcontents);
1304 default: abort ();
1308 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1309 doc: /* Return t if SYMBOL has a non-void default value.
1310 This is the value that is seen in buffers that do not have their own values
1311 for this variable. */)
1312 (Lisp_Object symbol)
1314 register Lisp_Object value;
1316 value = default_value (symbol);
1317 return (EQ (value, Qunbound) ? Qnil : Qt);
1320 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1321 doc: /* Return SYMBOL's default value.
1322 This is the value that is seen in buffers that do not have their own values
1323 for this variable. The default value is meaningful for variables with
1324 local bindings in certain buffers. */)
1325 (Lisp_Object symbol)
1327 register Lisp_Object value;
1329 value = default_value (symbol);
1330 if (!EQ (value, Qunbound))
1331 return value;
1333 xsignal1 (Qvoid_variable, symbol);
1336 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1337 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1338 The default value is seen in buffers that do not have their own values
1339 for this variable. */)
1340 (Lisp_Object symbol, Lisp_Object value)
1342 struct Lisp_Symbol *sym;
1344 CHECK_SYMBOL (symbol);
1345 if (SYMBOL_CONSTANT_P (symbol))
1347 if (NILP (Fkeywordp (symbol))
1348 || !EQ (value, Fdefault_value (symbol)))
1349 xsignal1 (Qsetting_constant, symbol);
1350 else
1351 /* Allow setting keywords to their own value. */
1352 return value;
1354 sym = XSYMBOL (symbol);
1356 start:
1357 switch (sym->redirect)
1359 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1360 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1361 case SYMBOL_LOCALIZED:
1363 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1365 /* Store new value into the DEFAULT-VALUE slot. */
1366 XSETCDR (blv->defcell, value);
1368 /* If the default binding is now loaded, set the REALVALUE slot too. */
1369 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1370 store_symval_forwarding (blv->fwd, value, NULL);
1371 return value;
1373 case SYMBOL_FORWARDED:
1375 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1377 /* Handle variables like case-fold-search that have special slots
1378 in the buffer.
1379 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1380 if (BUFFER_OBJFWDP (valcontents))
1382 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1383 int idx = PER_BUFFER_IDX (offset);
1385 PER_BUFFER_DEFAULT (offset) = value;
1387 /* If this variable is not always local in all buffers,
1388 set it in the buffers that don't nominally have a local value. */
1389 if (idx > 0)
1391 struct buffer *b;
1393 for (b = all_buffers; b; b = b->header.next.buffer)
1394 if (!PER_BUFFER_VALUE_P (b, idx))
1395 PER_BUFFER_VALUE (b, offset) = value;
1397 return value;
1399 else
1400 return Fset (symbol, value);
1402 default: abort ();
1406 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1407 doc: /* Set the default value of variable VAR to VALUE.
1408 VAR, the variable name, is literal (not evaluated);
1409 VALUE is an expression: it is evaluated and its value returned.
1410 The default value of a variable is seen in buffers
1411 that do not have their own values for the variable.
1413 More generally, you can use multiple variables and values, as in
1414 (setq-default VAR VALUE VAR VALUE...)
1415 This sets each VAR's default value to the corresponding VALUE.
1416 The VALUE for the Nth VAR can refer to the new default values
1417 of previous VARs.
1418 usage: (setq-default [VAR VALUE]...) */)
1419 (Lisp_Object args)
1421 register Lisp_Object args_left;
1422 register Lisp_Object val, symbol;
1423 struct gcpro gcpro1;
1425 if (NILP (args))
1426 return Qnil;
1428 args_left = args;
1429 GCPRO1 (args);
1433 val = eval_sub (Fcar (Fcdr (args_left)));
1434 symbol = XCAR (args_left);
1435 Fset_default (symbol, val);
1436 args_left = Fcdr (XCDR (args_left));
1438 while (!NILP (args_left));
1440 UNGCPRO;
1441 return val;
1444 /* Lisp functions for creating and removing buffer-local variables. */
1446 union Lisp_Val_Fwd
1448 Lisp_Object value;
1449 union Lisp_Fwd *fwd;
1452 static struct Lisp_Buffer_Local_Value *
1453 make_blv (struct Lisp_Symbol *sym, int forwarded, union Lisp_Val_Fwd valcontents)
1455 struct Lisp_Buffer_Local_Value *blv
1456 = xmalloc (sizeof (struct Lisp_Buffer_Local_Value));
1457 Lisp_Object symbol;
1458 Lisp_Object tem;
1460 XSETSYMBOL (symbol, sym);
1461 tem = Fcons (symbol, (forwarded
1462 ? do_symval_forwarding (valcontents.fwd)
1463 : valcontents.value));
1465 /* Buffer_Local_Values cannot have as realval a buffer-local
1466 or keyboard-local forwarding. */
1467 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1468 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1469 blv->fwd = forwarded ? valcontents.fwd : NULL;
1470 blv->where = Qnil;
1471 blv->frame_local = 0;
1472 blv->local_if_set = 0;
1473 blv->defcell = tem;
1474 blv->valcell = tem;
1475 SET_BLV_FOUND (blv, 0);
1476 return blv;
1479 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local,
1480 Smake_variable_buffer_local, 1, 1, "vMake Variable Buffer Local: ",
1481 doc: /* Make VARIABLE become buffer-local whenever it is set.
1482 At any time, the value for the current buffer is in effect,
1483 unless the variable has never been set in this buffer,
1484 in which case the default value is in effect.
1485 Note that binding the variable with `let', or setting it while
1486 a `let'-style binding made in this buffer is in effect,
1487 does not make the variable buffer-local. Return VARIABLE.
1489 In most cases it is better to use `make-local-variable',
1490 which makes a variable local in just one buffer.
1492 The function `default-value' gets the default value and `set-default' sets it. */)
1493 (register Lisp_Object variable)
1495 struct Lisp_Symbol *sym;
1496 struct Lisp_Buffer_Local_Value *blv = NULL;
1497 union Lisp_Val_Fwd valcontents IF_LINT (= {0});
1498 int forwarded IF_LINT (= 0);
1500 CHECK_SYMBOL (variable);
1501 sym = XSYMBOL (variable);
1503 start:
1504 switch (sym->redirect)
1506 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1507 case SYMBOL_PLAINVAL:
1508 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1509 if (EQ (valcontents.value, Qunbound))
1510 valcontents.value = Qnil;
1511 break;
1512 case SYMBOL_LOCALIZED:
1513 blv = SYMBOL_BLV (sym);
1514 if (blv->frame_local)
1515 error ("Symbol %s may not be buffer-local",
1516 SDATA (SYMBOL_NAME (variable)));
1517 break;
1518 case SYMBOL_FORWARDED:
1519 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1520 if (KBOARD_OBJFWDP (valcontents.fwd))
1521 error ("Symbol %s may not be buffer-local",
1522 SDATA (SYMBOL_NAME (variable)));
1523 else if (BUFFER_OBJFWDP (valcontents.fwd))
1524 return variable;
1525 break;
1526 default: abort ();
1529 if (sym->constant)
1530 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1532 if (!blv)
1534 blv = make_blv (sym, forwarded, valcontents);
1535 sym->redirect = SYMBOL_LOCALIZED;
1536 SET_SYMBOL_BLV (sym, blv);
1538 Lisp_Object symbol;
1539 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1540 if (let_shadows_global_binding_p (symbol))
1541 message ("Making %s buffer-local while let-bound!",
1542 SDATA (SYMBOL_NAME (variable)));
1546 blv->local_if_set = 1;
1547 return variable;
1550 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1551 1, 1, "vMake Local Variable: ",
1552 doc: /* Make VARIABLE have a separate value in the current buffer.
1553 Other buffers will continue to share a common default value.
1554 \(The buffer-local value of VARIABLE starts out as the same value
1555 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1556 Return VARIABLE.
1558 If the variable is already arranged to become local when set,
1559 this function causes a local value to exist for this buffer,
1560 just as setting the variable would do.
1562 This function returns VARIABLE, and therefore
1563 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1564 works.
1566 See also `make-variable-buffer-local'.
1568 Do not use `make-local-variable' to make a hook variable buffer-local.
1569 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1570 (register Lisp_Object variable)
1572 register Lisp_Object tem;
1573 int forwarded IF_LINT (= 0);
1574 union Lisp_Val_Fwd valcontents IF_LINT (= {0});
1575 struct Lisp_Symbol *sym;
1576 struct Lisp_Buffer_Local_Value *blv = NULL;
1578 CHECK_SYMBOL (variable);
1579 sym = XSYMBOL (variable);
1581 start:
1582 switch (sym->redirect)
1584 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1585 case SYMBOL_PLAINVAL:
1586 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1587 case SYMBOL_LOCALIZED:
1588 blv = SYMBOL_BLV (sym);
1589 if (blv->frame_local)
1590 error ("Symbol %s may not be buffer-local",
1591 SDATA (SYMBOL_NAME (variable)));
1592 break;
1593 case SYMBOL_FORWARDED:
1594 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1595 if (KBOARD_OBJFWDP (valcontents.fwd))
1596 error ("Symbol %s may not be buffer-local",
1597 SDATA (SYMBOL_NAME (variable)));
1598 break;
1599 default: abort ();
1602 if (sym->constant)
1603 error ("Symbol %s may not be buffer-local",
1604 SDATA (SYMBOL_NAME (variable)));
1606 if (blv ? blv->local_if_set
1607 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1609 tem = Fboundp (variable);
1610 /* Make sure the symbol has a local value in this particular buffer,
1611 by setting it to the same value it already has. */
1612 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1613 return variable;
1615 if (!blv)
1617 blv = make_blv (sym, forwarded, valcontents);
1618 sym->redirect = SYMBOL_LOCALIZED;
1619 SET_SYMBOL_BLV (sym, blv);
1621 Lisp_Object symbol;
1622 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1623 if (let_shadows_global_binding_p (symbol))
1624 message ("Making %s local to %s while let-bound!",
1625 SDATA (SYMBOL_NAME (variable)),
1626 SDATA (BVAR (current_buffer, name)));
1630 /* Make sure this buffer has its own value of symbol. */
1631 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1632 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1633 if (NILP (tem))
1635 if (let_shadows_buffer_binding_p (sym))
1636 message ("Making %s buffer-local while locally let-bound!",
1637 SDATA (SYMBOL_NAME (variable)));
1639 /* Swap out any local binding for some other buffer, and make
1640 sure the current value is permanently recorded, if it's the
1641 default value. */
1642 find_symbol_value (variable);
1644 BVAR (current_buffer, local_var_alist)
1645 = Fcons (Fcons (variable, XCDR (blv->defcell)),
1646 BVAR (current_buffer, local_var_alist));
1648 /* Make sure symbol does not think it is set up for this buffer;
1649 force it to look once again for this buffer's value. */
1650 if (current_buffer == XBUFFER (blv->where))
1651 blv->where = Qnil;
1652 /* blv->valcell = blv->defcell;
1653 * SET_BLV_FOUND (blv, 0); */
1654 blv->found = 0;
1657 /* If the symbol forwards into a C variable, then load the binding
1658 for this buffer now. If C code modifies the variable before we
1659 load the binding in, then that new value will clobber the default
1660 binding the next time we unload it. */
1661 if (blv->fwd)
1662 swap_in_symval_forwarding (sym, blv);
1664 return variable;
1667 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1668 1, 1, "vKill Local Variable: ",
1669 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1670 From now on the default value will apply in this buffer. Return VARIABLE. */)
1671 (register Lisp_Object variable)
1673 register Lisp_Object tem;
1674 struct Lisp_Buffer_Local_Value *blv;
1675 struct Lisp_Symbol *sym;
1677 CHECK_SYMBOL (variable);
1678 sym = XSYMBOL (variable);
1680 start:
1681 switch (sym->redirect)
1683 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1684 case SYMBOL_PLAINVAL: return variable;
1685 case SYMBOL_FORWARDED:
1687 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1688 if (BUFFER_OBJFWDP (valcontents))
1690 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1691 int idx = PER_BUFFER_IDX (offset);
1693 if (idx > 0)
1695 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1696 PER_BUFFER_VALUE (current_buffer, offset)
1697 = PER_BUFFER_DEFAULT (offset);
1700 return variable;
1702 case SYMBOL_LOCALIZED:
1703 blv = SYMBOL_BLV (sym);
1704 if (blv->frame_local)
1705 return variable;
1706 break;
1707 default: abort ();
1710 /* Get rid of this buffer's alist element, if any. */
1711 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1712 tem = Fassq (variable, BVAR (current_buffer, local_var_alist));
1713 if (!NILP (tem))
1714 BVAR (current_buffer, local_var_alist)
1715 = Fdelq (tem, BVAR (current_buffer, local_var_alist));
1717 /* If the symbol is set up with the current buffer's binding
1718 loaded, recompute its value. We have to do it now, or else
1719 forwarded objects won't work right. */
1721 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1722 if (EQ (buf, blv->where))
1724 blv->where = Qnil;
1725 /* blv->valcell = blv->defcell;
1726 * SET_BLV_FOUND (blv, 0); */
1727 blv->found = 0;
1728 find_symbol_value (variable);
1732 return variable;
1735 /* Lisp functions for creating and removing buffer-local variables. */
1737 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1738 when/if this is removed. */
1740 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1741 1, 1, "vMake Variable Frame Local: ",
1742 doc: /* Enable VARIABLE to have frame-local bindings.
1743 This does not create any frame-local bindings for VARIABLE,
1744 it just makes them possible.
1746 A frame-local binding is actually a frame parameter value.
1747 If a frame F has a value for the frame parameter named VARIABLE,
1748 that also acts as a frame-local binding for VARIABLE in F--
1749 provided this function has been called to enable VARIABLE
1750 to have frame-local bindings at all.
1752 The only way to create a frame-local binding for VARIABLE in a frame
1753 is to set the VARIABLE frame parameter of that frame. See
1754 `modify-frame-parameters' for how to set frame parameters.
1756 Note that since Emacs 23.1, variables cannot be both buffer-local and
1757 frame-local any more (buffer-local bindings used to take precedence over
1758 frame-local bindings). */)
1759 (register Lisp_Object variable)
1761 int forwarded;
1762 union Lisp_Val_Fwd valcontents;
1763 struct Lisp_Symbol *sym;
1764 struct Lisp_Buffer_Local_Value *blv = NULL;
1766 CHECK_SYMBOL (variable);
1767 sym = XSYMBOL (variable);
1769 start:
1770 switch (sym->redirect)
1772 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1773 case SYMBOL_PLAINVAL:
1774 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1775 if (EQ (valcontents.value, Qunbound))
1776 valcontents.value = Qnil;
1777 break;
1778 case SYMBOL_LOCALIZED:
1779 if (SYMBOL_BLV (sym)->frame_local)
1780 return variable;
1781 else
1782 error ("Symbol %s may not be frame-local",
1783 SDATA (SYMBOL_NAME (variable)));
1784 case SYMBOL_FORWARDED:
1785 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1786 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1787 error ("Symbol %s may not be frame-local",
1788 SDATA (SYMBOL_NAME (variable)));
1789 break;
1790 default: abort ();
1793 if (sym->constant)
1794 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1796 blv = make_blv (sym, forwarded, valcontents);
1797 blv->frame_local = 1;
1798 sym->redirect = SYMBOL_LOCALIZED;
1799 SET_SYMBOL_BLV (sym, blv);
1801 Lisp_Object symbol;
1802 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1803 if (let_shadows_global_binding_p (symbol))
1804 message ("Making %s frame-local while let-bound!",
1805 SDATA (SYMBOL_NAME (variable)));
1807 return variable;
1810 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1811 1, 2, 0,
1812 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1813 BUFFER defaults to the current buffer. */)
1814 (register Lisp_Object variable, Lisp_Object buffer)
1816 register struct buffer *buf;
1817 struct Lisp_Symbol *sym;
1819 if (NILP (buffer))
1820 buf = current_buffer;
1821 else
1823 CHECK_BUFFER (buffer);
1824 buf = XBUFFER (buffer);
1827 CHECK_SYMBOL (variable);
1828 sym = XSYMBOL (variable);
1830 start:
1831 switch (sym->redirect)
1833 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1834 case SYMBOL_PLAINVAL: return Qnil;
1835 case SYMBOL_LOCALIZED:
1837 Lisp_Object tail, elt, tmp;
1838 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1839 XSETBUFFER (tmp, buf);
1840 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1842 for (tail = BVAR (buf, local_var_alist); CONSP (tail); tail = XCDR (tail))
1844 elt = XCAR (tail);
1845 if (EQ (variable, XCAR (elt)))
1847 eassert (!blv->frame_local);
1848 eassert (BLV_FOUND (blv) || !EQ (blv->where, tmp));
1849 return Qt;
1852 eassert (!BLV_FOUND (blv) || !EQ (blv->where, tmp));
1853 return Qnil;
1855 case SYMBOL_FORWARDED:
1857 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1858 if (BUFFER_OBJFWDP (valcontents))
1860 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1861 int idx = PER_BUFFER_IDX (offset);
1862 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1863 return Qt;
1865 return Qnil;
1867 default: abort ();
1871 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1872 1, 2, 0,
1873 doc: /* Non-nil if VARIABLE will be local in buffer BUFFER when set there.
1874 More precisely, this means that setting the variable \(with `set' or`setq'),
1875 while it does not have a `let'-style binding that was made in BUFFER,
1876 will produce a buffer local binding. See Info node
1877 `(elisp)Creating Buffer-Local'.
1878 BUFFER defaults to the current buffer. */)
1879 (register Lisp_Object variable, Lisp_Object buffer)
1881 struct Lisp_Symbol *sym;
1883 CHECK_SYMBOL (variable);
1884 sym = XSYMBOL (variable);
1886 start:
1887 switch (sym->redirect)
1889 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1890 case SYMBOL_PLAINVAL: return Qnil;
1891 case SYMBOL_LOCALIZED:
1893 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1894 if (blv->local_if_set)
1895 return Qt;
1896 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1897 return Flocal_variable_p (variable, buffer);
1899 case SYMBOL_FORWARDED:
1900 /* All BUFFER_OBJFWD slots become local if they are set. */
1901 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1902 default: abort ();
1906 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1907 1, 1, 0,
1908 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1909 If the current binding is buffer-local, the value is the current buffer.
1910 If the current binding is frame-local, the value is the selected frame.
1911 If the current binding is global (the default), the value is nil. */)
1912 (register Lisp_Object variable)
1914 struct Lisp_Symbol *sym;
1916 CHECK_SYMBOL (variable);
1917 sym = XSYMBOL (variable);
1919 /* Make sure the current binding is actually swapped in. */
1920 find_symbol_value (variable);
1922 start:
1923 switch (sym->redirect)
1925 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1926 case SYMBOL_PLAINVAL: return Qnil;
1927 case SYMBOL_FORWARDED:
1929 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1930 if (KBOARD_OBJFWDP (valcontents))
1931 return Fframe_terminal (Fselected_frame ());
1932 else if (!BUFFER_OBJFWDP (valcontents))
1933 return Qnil;
1935 /* FALLTHROUGH */
1936 case SYMBOL_LOCALIZED:
1937 /* For a local variable, record both the symbol and which
1938 buffer's or frame's value we are saving. */
1939 if (!NILP (Flocal_variable_p (variable, Qnil)))
1940 return Fcurrent_buffer ();
1941 else if (sym->redirect == SYMBOL_LOCALIZED
1942 && BLV_FOUND (SYMBOL_BLV (sym)))
1943 return SYMBOL_BLV (sym)->where;
1944 else
1945 return Qnil;
1946 default: abort ();
1950 /* This code is disabled now that we use the selected frame to return
1951 keyboard-local-values. */
1952 #if 0
1953 extern struct terminal *get_terminal (Lisp_Object display, int);
1955 DEFUN ("terminal-local-value", Fterminal_local_value,
1956 Sterminal_local_value, 2, 2, 0,
1957 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1958 If SYMBOL is not a terminal-local variable, then return its normal
1959 value, like `symbol-value'.
1961 TERMINAL may be a terminal object, a frame, or nil (meaning the
1962 selected frame's terminal device). */)
1963 (Lisp_Object symbol, Lisp_Object terminal)
1965 Lisp_Object result;
1966 struct terminal *t = get_terminal (terminal, 1);
1967 push_kboard (t->kboard);
1968 result = Fsymbol_value (symbol);
1969 pop_kboard ();
1970 return result;
1973 DEFUN ("set-terminal-local-value", Fset_terminal_local_value,
1974 Sset_terminal_local_value, 3, 3, 0,
1975 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
1976 If VARIABLE is not a terminal-local variable, then set its normal
1977 binding, like `set'.
1979 TERMINAL may be a terminal object, a frame, or nil (meaning the
1980 selected frame's terminal device). */)
1981 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
1983 Lisp_Object result;
1984 struct terminal *t = get_terminal (terminal, 1);
1985 push_kboard (d->kboard);
1986 result = Fset (symbol, value);
1987 pop_kboard ();
1988 return result;
1990 #endif
1992 /* Find the function at the end of a chain of symbol function indirections. */
1994 /* If OBJECT is a symbol, find the end of its function chain and
1995 return the value found there. If OBJECT is not a symbol, just
1996 return it. If there is a cycle in the function chain, signal a
1997 cyclic-function-indirection error.
1999 This is like Findirect_function, except that it doesn't signal an
2000 error if the chain ends up unbound. */
2001 Lisp_Object
2002 indirect_function (register Lisp_Object object)
2004 Lisp_Object tortoise, hare;
2006 hare = tortoise = object;
2008 for (;;)
2010 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2011 break;
2012 hare = XSYMBOL (hare)->function;
2013 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2014 break;
2015 hare = XSYMBOL (hare)->function;
2017 tortoise = XSYMBOL (tortoise)->function;
2019 if (EQ (hare, tortoise))
2020 xsignal1 (Qcyclic_function_indirection, object);
2023 return hare;
2026 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2027 doc: /* Return the function at the end of OBJECT's function chain.
2028 If OBJECT is not a symbol, just return it. Otherwise, follow all
2029 function indirections to find the final function binding and return it.
2030 If the final symbol in the chain is unbound, signal a void-function error.
2031 Optional arg NOERROR non-nil means to return nil instead of signaling.
2032 Signal a cyclic-function-indirection error if there is a loop in the
2033 function chain of symbols. */)
2034 (register Lisp_Object object, Lisp_Object noerror)
2036 Lisp_Object result;
2038 /* Optimize for no indirection. */
2039 result = object;
2040 if (SYMBOLP (result) && !EQ (result, Qunbound)
2041 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2042 result = indirect_function (result);
2043 if (!EQ (result, Qunbound))
2044 return result;
2046 if (NILP (noerror))
2047 xsignal1 (Qvoid_function, object);
2049 return Qnil;
2052 /* Extract and set vector and string elements */
2054 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2055 doc: /* Return the element of ARRAY at index IDX.
2056 ARRAY may be a vector, a string, a char-table, a bool-vector,
2057 or a byte-code object. IDX starts at 0. */)
2058 (register Lisp_Object array, Lisp_Object idx)
2060 register EMACS_INT idxval;
2062 CHECK_NUMBER (idx);
2063 idxval = XINT (idx);
2064 if (STRINGP (array))
2066 int c;
2067 EMACS_INT idxval_byte;
2069 if (idxval < 0 || idxval >= SCHARS (array))
2070 args_out_of_range (array, idx);
2071 if (! STRING_MULTIBYTE (array))
2072 return make_number ((unsigned char) SREF (array, idxval));
2073 idxval_byte = string_char_to_byte (array, idxval);
2075 c = STRING_CHAR (SDATA (array) + idxval_byte);
2076 return make_number (c);
2078 else if (BOOL_VECTOR_P (array))
2080 int val;
2082 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2083 args_out_of_range (array, idx);
2085 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2086 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2088 else if (CHAR_TABLE_P (array))
2090 CHECK_CHARACTER (idx);
2091 return CHAR_TABLE_REF (array, idxval);
2093 else
2095 int size = 0;
2096 if (VECTORP (array))
2097 size = ASIZE (array);
2098 else if (COMPILEDP (array))
2099 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2100 else
2101 wrong_type_argument (Qarrayp, array);
2103 if (idxval < 0 || idxval >= size)
2104 args_out_of_range (array, idx);
2105 return AREF (array, idxval);
2109 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2110 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2111 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2112 bool-vector. IDX starts at 0. */)
2113 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2115 register EMACS_INT idxval;
2117 CHECK_NUMBER (idx);
2118 idxval = XINT (idx);
2119 CHECK_ARRAY (array, Qarrayp);
2120 CHECK_IMPURE (array);
2122 if (VECTORP (array))
2124 if (idxval < 0 || idxval >= ASIZE (array))
2125 args_out_of_range (array, idx);
2126 XVECTOR (array)->contents[idxval] = newelt;
2128 else if (BOOL_VECTOR_P (array))
2130 int val;
2132 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2133 args_out_of_range (array, idx);
2135 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2137 if (! NILP (newelt))
2138 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2139 else
2140 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2141 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2143 else if (CHAR_TABLE_P (array))
2145 CHECK_CHARACTER (idx);
2146 CHAR_TABLE_SET (array, idxval, newelt);
2148 else
2150 int c;
2152 if (idxval < 0 || idxval >= SCHARS (array))
2153 args_out_of_range (array, idx);
2154 CHECK_CHARACTER (newelt);
2155 c = XFASTINT (newelt);
2157 if (STRING_MULTIBYTE (array))
2159 EMACS_INT idxval_byte, prev_bytes, new_bytes, nbytes;
2160 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2162 nbytes = SBYTES (array);
2163 idxval_byte = string_char_to_byte (array, idxval);
2164 p1 = SDATA (array) + idxval_byte;
2165 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2166 new_bytes = CHAR_STRING (c, p0);
2167 if (prev_bytes != new_bytes)
2169 /* We must relocate the string data. */
2170 EMACS_INT nchars = SCHARS (array);
2171 unsigned char *str;
2172 USE_SAFE_ALLOCA;
2174 SAFE_ALLOCA (str, unsigned char *, nbytes);
2175 memcpy (str, SDATA (array), nbytes);
2176 allocate_string_data (XSTRING (array), nchars,
2177 nbytes + new_bytes - prev_bytes);
2178 memcpy (SDATA (array), str, idxval_byte);
2179 p1 = SDATA (array) + idxval_byte;
2180 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2181 nbytes - (idxval_byte + prev_bytes));
2182 SAFE_FREE ();
2183 clear_string_char_byte_cache ();
2185 while (new_bytes--)
2186 *p1++ = *p0++;
2188 else
2190 if (! SINGLE_BYTE_CHAR_P (c))
2192 int i;
2194 for (i = SBYTES (array) - 1; i >= 0; i--)
2195 if (SREF (array, i) >= 0x80)
2196 args_out_of_range (array, newelt);
2197 /* ARRAY is an ASCII string. Convert it to a multibyte
2198 string, and try `aset' again. */
2199 STRING_SET_MULTIBYTE (array);
2200 return Faset (array, idx, newelt);
2202 SSET (array, idxval, c);
2206 return newelt;
2209 /* Arithmetic functions */
2211 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2213 static Lisp_Object
2214 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2216 double f1 = 0, f2 = 0;
2217 int floatp = 0;
2219 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2220 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2222 if (FLOATP (num1) || FLOATP (num2))
2224 floatp = 1;
2225 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2226 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2229 switch (comparison)
2231 case equal:
2232 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2233 return Qt;
2234 return Qnil;
2236 case notequal:
2237 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2238 return Qt;
2239 return Qnil;
2241 case less:
2242 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2243 return Qt;
2244 return Qnil;
2246 case less_or_equal:
2247 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2248 return Qt;
2249 return Qnil;
2251 case grtr:
2252 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2253 return Qt;
2254 return Qnil;
2256 case grtr_or_equal:
2257 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2258 return Qt;
2259 return Qnil;
2261 default:
2262 abort ();
2266 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2267 doc: /* Return t if two args, both numbers or markers, are equal. */)
2268 (register Lisp_Object num1, Lisp_Object num2)
2270 return arithcompare (num1, num2, equal);
2273 DEFUN ("<", Flss, Slss, 2, 2, 0,
2274 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2275 (register Lisp_Object num1, Lisp_Object num2)
2277 return arithcompare (num1, num2, less);
2280 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2281 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2282 (register Lisp_Object num1, Lisp_Object num2)
2284 return arithcompare (num1, num2, grtr);
2287 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2288 doc: /* Return t if first arg is less than or equal to second arg.
2289 Both must be numbers or markers. */)
2290 (register Lisp_Object num1, Lisp_Object num2)
2292 return arithcompare (num1, num2, less_or_equal);
2295 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2296 doc: /* Return t if first arg is greater than or equal to second arg.
2297 Both must be numbers or markers. */)
2298 (register Lisp_Object num1, Lisp_Object num2)
2300 return arithcompare (num1, num2, grtr_or_equal);
2303 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2304 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2305 (register Lisp_Object num1, Lisp_Object num2)
2307 return arithcompare (num1, num2, notequal);
2310 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2311 doc: /* Return t if NUMBER is zero. */)
2312 (register Lisp_Object number)
2314 CHECK_NUMBER_OR_FLOAT (number);
2316 if (FLOATP (number))
2318 if (XFLOAT_DATA (number) == 0.0)
2319 return Qt;
2320 return Qnil;
2323 if (!XINT (number))
2324 return Qt;
2325 return Qnil;
2328 /* Convert the cons-of-integers, integer, or float value C to an
2329 unsigned value with maximum value MAX. Signal an error if C does not
2330 have a valid format or is out of range. */
2331 uintmax_t
2332 cons_to_unsigned (Lisp_Object c, uintmax_t max)
2334 int valid = 0;
2335 uintmax_t val IF_LINT (= 0);
2336 if (INTEGERP (c))
2338 valid = 0 <= XINT (c);
2339 val = XINT (c);
2341 else if (FLOATP (c))
2343 double d = XFLOAT_DATA (c);
2344 if (0 <= d
2345 && d < (max == UINTMAX_MAX ? (double) UINTMAX_MAX + 1 : max + 1))
2347 val = d;
2348 valid = 1;
2351 else if (CONSP (c) && NATNUMP (XCAR (c)))
2353 uintmax_t top = XFASTINT (XCAR (c));
2354 Lisp_Object rest = XCDR (c);
2355 if (top <= UINTMAX_MAX >> 24 >> 16
2356 && CONSP (rest)
2357 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2358 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2360 uintmax_t mid = XFASTINT (XCAR (rest));
2361 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2362 valid = 1;
2364 else if (top <= UINTMAX_MAX >> 16)
2366 if (CONSP (rest))
2367 rest = XCAR (rest);
2368 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2370 val = top << 16 | XFASTINT (rest);
2371 valid = 1;
2376 if (! (valid && val <= max))
2377 error ("Not an in-range integer, float, or cons of integers");
2378 return val;
2381 /* Convert the cons-of-integers, integer, or float value C to a signed
2382 value with extrema MIN and MAX. Signal an error if C does not have
2383 a valid format or is out of range. */
2384 intmax_t
2385 cons_to_signed (Lisp_Object c, intmax_t min, intmax_t max)
2387 int valid = 0;
2388 intmax_t val IF_LINT (= 0);
2389 if (INTEGERP (c))
2391 val = XINT (c);
2392 valid = 1;
2394 else if (FLOATP (c))
2396 double d = XFLOAT_DATA (c);
2397 if (min <= d
2398 && d < (max == INTMAX_MAX ? (double) INTMAX_MAX + 1 : max + 1))
2400 val = d;
2401 valid = 1;
2404 else if (CONSP (c) && INTEGERP (XCAR (c)))
2406 intmax_t top = XINT (XCAR (c));
2407 Lisp_Object rest = XCDR (c);
2408 if (INTMAX_MIN >> 24 >> 16 <= top && top <= INTMAX_MAX >> 24 >> 16
2409 && CONSP (rest)
2410 && NATNUMP (XCAR (rest)) && XFASTINT (XCAR (rest)) < 1 << 24
2411 && NATNUMP (XCDR (rest)) && XFASTINT (XCDR (rest)) < 1 << 16)
2413 intmax_t mid = XFASTINT (XCAR (rest));
2414 val = top << 24 << 16 | mid << 16 | XFASTINT (XCDR (rest));
2415 valid = 1;
2417 else if (INTMAX_MIN >> 16 <= top && top <= INTMAX_MAX >> 16)
2419 if (CONSP (rest))
2420 rest = XCAR (rest);
2421 if (NATNUMP (rest) && XFASTINT (rest) < 1 << 16)
2423 val = top << 16 | XFASTINT (rest);
2424 valid = 1;
2429 if (! (valid && min <= val && val <= max))
2430 error ("Not an in-range integer, float, or cons of integers");
2431 return val;
2434 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2435 doc: /* Return the decimal representation of NUMBER as a string.
2436 Uses a minus sign if negative.
2437 NUMBER may be an integer or a floating point number. */)
2438 (Lisp_Object number)
2440 char buffer[VALBITS];
2442 CHECK_NUMBER_OR_FLOAT (number);
2444 if (FLOATP (number))
2446 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
2448 float_to_string (pigbuf, XFLOAT_DATA (number));
2449 return build_string (pigbuf);
2452 sprintf (buffer, "%"pI"d", XINT (number));
2453 return build_string (buffer);
2456 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2457 doc: /* Parse STRING as a decimal number and return the number.
2458 This parses both integers and floating point numbers.
2459 It ignores leading spaces and tabs, and all trailing chars.
2461 If BASE, interpret STRING as a number in that base. If BASE isn't
2462 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2463 If the base used is not 10, STRING is always parsed as integer. */)
2464 (register Lisp_Object string, Lisp_Object base)
2466 register char *p;
2467 register int b;
2468 Lisp_Object val;
2470 CHECK_STRING (string);
2472 if (NILP (base))
2473 b = 10;
2474 else
2476 CHECK_NUMBER (base);
2477 b = XINT (base);
2478 if (b < 2 || b > 16)
2479 xsignal1 (Qargs_out_of_range, base);
2482 p = SSDATA (string);
2483 while (*p == ' ' || *p == '\t')
2484 p++;
2486 val = string_to_number (p, b, 1);
2487 return NILP (val) ? make_number (0) : val;
2490 enum arithop
2492 Aadd,
2493 Asub,
2494 Amult,
2495 Adiv,
2496 Alogand,
2497 Alogior,
2498 Alogxor,
2499 Amax,
2500 Amin
2503 static Lisp_Object float_arith_driver (double, ptrdiff_t, enum arithop,
2504 ptrdiff_t, Lisp_Object *);
2505 static Lisp_Object
2506 arith_driver (enum arithop code, ptrdiff_t nargs, Lisp_Object *args)
2508 register Lisp_Object val;
2509 ptrdiff_t argnum;
2510 register EMACS_INT accum = 0;
2511 register EMACS_INT next;
2513 int overflow = 0;
2514 ptrdiff_t ok_args;
2515 EMACS_INT ok_accum;
2517 switch (SWITCH_ENUM_CAST (code))
2519 case Alogior:
2520 case Alogxor:
2521 case Aadd:
2522 case Asub:
2523 accum = 0;
2524 break;
2525 case Amult:
2526 accum = 1;
2527 break;
2528 case Alogand:
2529 accum = -1;
2530 break;
2531 default:
2532 break;
2535 for (argnum = 0; argnum < nargs; argnum++)
2537 if (! overflow)
2539 ok_args = argnum;
2540 ok_accum = accum;
2543 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2544 val = args[argnum];
2545 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2547 if (FLOATP (val))
2548 return float_arith_driver (ok_accum, ok_args, code,
2549 nargs, args);
2550 args[argnum] = val;
2551 next = XINT (args[argnum]);
2552 switch (SWITCH_ENUM_CAST (code))
2554 case Aadd:
2555 if (INT_ADD_OVERFLOW (accum, next))
2557 overflow = 1;
2558 accum &= INTMASK;
2560 accum += next;
2561 break;
2562 case Asub:
2563 if (INT_SUBTRACT_OVERFLOW (accum, next))
2565 overflow = 1;
2566 accum &= INTMASK;
2568 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2569 break;
2570 case Amult:
2571 if (INT_MULTIPLY_OVERFLOW (accum, next))
2573 EMACS_UINT a = accum, b = next, ab = a * b;
2574 overflow = 1;
2575 accum = ab & INTMASK;
2577 else
2578 accum *= next;
2579 break;
2580 case Adiv:
2581 if (!argnum)
2582 accum = next;
2583 else
2585 if (next == 0)
2586 xsignal0 (Qarith_error);
2587 accum /= next;
2589 break;
2590 case Alogand:
2591 accum &= next;
2592 break;
2593 case Alogior:
2594 accum |= next;
2595 break;
2596 case Alogxor:
2597 accum ^= next;
2598 break;
2599 case Amax:
2600 if (!argnum || next > accum)
2601 accum = next;
2602 break;
2603 case Amin:
2604 if (!argnum || next < accum)
2605 accum = next;
2606 break;
2610 XSETINT (val, accum);
2611 return val;
2614 #undef isnan
2615 #define isnan(x) ((x) != (x))
2617 static Lisp_Object
2618 float_arith_driver (double accum, ptrdiff_t argnum, enum arithop code,
2619 ptrdiff_t nargs, Lisp_Object *args)
2621 register Lisp_Object val;
2622 double next;
2624 for (; argnum < nargs; argnum++)
2626 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2627 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2629 if (FLOATP (val))
2631 next = XFLOAT_DATA (val);
2633 else
2635 args[argnum] = val; /* runs into a compiler bug. */
2636 next = XINT (args[argnum]);
2638 switch (SWITCH_ENUM_CAST (code))
2640 case Aadd:
2641 accum += next;
2642 break;
2643 case Asub:
2644 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2645 break;
2646 case Amult:
2647 accum *= next;
2648 break;
2649 case Adiv:
2650 if (!argnum)
2651 accum = next;
2652 else
2654 if (! IEEE_FLOATING_POINT && next == 0)
2655 xsignal0 (Qarith_error);
2656 accum /= next;
2658 break;
2659 case Alogand:
2660 case Alogior:
2661 case Alogxor:
2662 return wrong_type_argument (Qinteger_or_marker_p, val);
2663 case Amax:
2664 if (!argnum || isnan (next) || next > accum)
2665 accum = next;
2666 break;
2667 case Amin:
2668 if (!argnum || isnan (next) || next < accum)
2669 accum = next;
2670 break;
2674 return make_float (accum);
2678 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2679 doc: /* Return sum of any number of arguments, which are numbers or markers.
2680 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2681 (ptrdiff_t nargs, Lisp_Object *args)
2683 return arith_driver (Aadd, nargs, args);
2686 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2687 doc: /* Negate number or subtract numbers or markers and return the result.
2688 With one arg, negates it. With more than one arg,
2689 subtracts all but the first from the first.
2690 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2691 (ptrdiff_t nargs, Lisp_Object *args)
2693 return arith_driver (Asub, nargs, args);
2696 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2697 doc: /* Return product of any number of arguments, which are numbers or markers.
2698 usage: (* &rest NUMBERS-OR-MARKERS) */)
2699 (ptrdiff_t nargs, Lisp_Object *args)
2701 return arith_driver (Amult, nargs, args);
2704 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2705 doc: /* Return first argument divided by all the remaining arguments.
2706 The arguments must be numbers or markers.
2707 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2708 (ptrdiff_t nargs, Lisp_Object *args)
2710 ptrdiff_t argnum;
2711 for (argnum = 2; argnum < nargs; argnum++)
2712 if (FLOATP (args[argnum]))
2713 return float_arith_driver (0, 0, Adiv, nargs, args);
2714 return arith_driver (Adiv, nargs, args);
2717 DEFUN ("%", Frem, Srem, 2, 2, 0,
2718 doc: /* Return remainder of X divided by Y.
2719 Both must be integers or markers. */)
2720 (register Lisp_Object x, Lisp_Object y)
2722 Lisp_Object val;
2724 CHECK_NUMBER_COERCE_MARKER (x);
2725 CHECK_NUMBER_COERCE_MARKER (y);
2727 if (XFASTINT (y) == 0)
2728 xsignal0 (Qarith_error);
2730 XSETINT (val, XINT (x) % XINT (y));
2731 return val;
2734 #ifndef HAVE_FMOD
2735 double
2736 fmod (double f1, double f2)
2738 double r = f1;
2740 if (f2 < 0.0)
2741 f2 = -f2;
2743 /* If the magnitude of the result exceeds that of the divisor, or
2744 the sign of the result does not agree with that of the dividend,
2745 iterate with the reduced value. This does not yield a
2746 particularly accurate result, but at least it will be in the
2747 range promised by fmod. */
2749 r -= f2 * floor (r / f2);
2750 while (f2 <= (r < 0 ? -r : r) || ((r < 0) != (f1 < 0) && ! isnan (r)));
2752 return r;
2754 #endif /* ! HAVE_FMOD */
2756 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2757 doc: /* Return X modulo Y.
2758 The result falls between zero (inclusive) and Y (exclusive).
2759 Both X and Y must be numbers or markers. */)
2760 (register Lisp_Object x, Lisp_Object y)
2762 Lisp_Object val;
2763 EMACS_INT i1, i2;
2765 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2766 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2768 if (FLOATP (x) || FLOATP (y))
2769 return fmod_float (x, y);
2771 i1 = XINT (x);
2772 i2 = XINT (y);
2774 if (i2 == 0)
2775 xsignal0 (Qarith_error);
2777 i1 %= i2;
2779 /* If the "remainder" comes out with the wrong sign, fix it. */
2780 if (i2 < 0 ? i1 > 0 : i1 < 0)
2781 i1 += i2;
2783 XSETINT (val, i1);
2784 return val;
2787 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2788 doc: /* Return largest of all the arguments (which must be numbers or markers).
2789 The value is always a number; markers are converted to numbers.
2790 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2791 (ptrdiff_t nargs, Lisp_Object *args)
2793 return arith_driver (Amax, nargs, args);
2796 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2797 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2798 The value is always a number; markers are converted to numbers.
2799 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2800 (ptrdiff_t nargs, Lisp_Object *args)
2802 return arith_driver (Amin, nargs, args);
2805 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2806 doc: /* Return bitwise-and of all the arguments.
2807 Arguments may be integers, or markers converted to integers.
2808 usage: (logand &rest INTS-OR-MARKERS) */)
2809 (ptrdiff_t nargs, Lisp_Object *args)
2811 return arith_driver (Alogand, nargs, args);
2814 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2815 doc: /* Return bitwise-or of all the arguments.
2816 Arguments may be integers, or markers converted to integers.
2817 usage: (logior &rest INTS-OR-MARKERS) */)
2818 (ptrdiff_t nargs, Lisp_Object *args)
2820 return arith_driver (Alogior, nargs, args);
2823 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2824 doc: /* Return bitwise-exclusive-or of all the arguments.
2825 Arguments may be integers, or markers converted to integers.
2826 usage: (logxor &rest INTS-OR-MARKERS) */)
2827 (ptrdiff_t nargs, Lisp_Object *args)
2829 return arith_driver (Alogxor, nargs, args);
2832 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2833 doc: /* Return VALUE with its bits shifted left by COUNT.
2834 If COUNT is negative, shifting is actually to the right.
2835 In this case, the sign bit is duplicated. */)
2836 (register Lisp_Object value, Lisp_Object count)
2838 register Lisp_Object val;
2840 CHECK_NUMBER (value);
2841 CHECK_NUMBER (count);
2843 if (XINT (count) >= BITS_PER_EMACS_INT)
2844 XSETINT (val, 0);
2845 else if (XINT (count) > 0)
2846 XSETINT (val, XINT (value) << XFASTINT (count));
2847 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2848 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2849 else
2850 XSETINT (val, XINT (value) >> -XINT (count));
2851 return val;
2854 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2855 doc: /* Return VALUE with its bits shifted left by COUNT.
2856 If COUNT is negative, shifting is actually to the right.
2857 In this case, zeros are shifted in on the left. */)
2858 (register Lisp_Object value, Lisp_Object count)
2860 register Lisp_Object val;
2862 CHECK_NUMBER (value);
2863 CHECK_NUMBER (count);
2865 if (XINT (count) >= BITS_PER_EMACS_INT)
2866 XSETINT (val, 0);
2867 else if (XINT (count) > 0)
2868 XSETINT (val, XUINT (value) << XFASTINT (count));
2869 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2870 XSETINT (val, 0);
2871 else
2872 XSETINT (val, XUINT (value) >> -XINT (count));
2873 return val;
2876 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2877 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2878 Markers are converted to integers. */)
2879 (register Lisp_Object number)
2881 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2883 if (FLOATP (number))
2884 return (make_float (1.0 + XFLOAT_DATA (number)));
2886 XSETINT (number, XINT (number) + 1);
2887 return number;
2890 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2891 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2892 Markers are converted to integers. */)
2893 (register Lisp_Object number)
2895 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2897 if (FLOATP (number))
2898 return (make_float (-1.0 + XFLOAT_DATA (number)));
2900 XSETINT (number, XINT (number) - 1);
2901 return number;
2904 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2905 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2906 (register Lisp_Object number)
2908 CHECK_NUMBER (number);
2909 XSETINT (number, ~XINT (number));
2910 return number;
2913 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2914 doc: /* Return the byteorder for the machine.
2915 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2916 lowercase l) for small endian machines. */)
2917 (void)
2919 unsigned i = 0x04030201;
2920 int order = *(char *)&i == 1 ? 108 : 66;
2922 return make_number (order);
2927 void
2928 syms_of_data (void)
2930 Lisp_Object error_tail, arith_tail;
2932 DEFSYM (Qquote, "quote");
2933 DEFSYM (Qlambda, "lambda");
2934 DEFSYM (Qsubr, "subr");
2935 DEFSYM (Qerror_conditions, "error-conditions");
2936 DEFSYM (Qerror_message, "error-message");
2937 DEFSYM (Qtop_level, "top-level");
2939 DEFSYM (Qerror, "error");
2940 DEFSYM (Qquit, "quit");
2941 DEFSYM (Qwrong_type_argument, "wrong-type-argument");
2942 DEFSYM (Qargs_out_of_range, "args-out-of-range");
2943 DEFSYM (Qvoid_function, "void-function");
2944 DEFSYM (Qcyclic_function_indirection, "cyclic-function-indirection");
2945 DEFSYM (Qcyclic_variable_indirection, "cyclic-variable-indirection");
2946 DEFSYM (Qvoid_variable, "void-variable");
2947 DEFSYM (Qsetting_constant, "setting-constant");
2948 DEFSYM (Qinvalid_read_syntax, "invalid-read-syntax");
2950 DEFSYM (Qinvalid_function, "invalid-function");
2951 DEFSYM (Qwrong_number_of_arguments, "wrong-number-of-arguments");
2952 DEFSYM (Qno_catch, "no-catch");
2953 DEFSYM (Qend_of_file, "end-of-file");
2954 DEFSYM (Qarith_error, "arith-error");
2955 DEFSYM (Qbeginning_of_buffer, "beginning-of-buffer");
2956 DEFSYM (Qend_of_buffer, "end-of-buffer");
2957 DEFSYM (Qbuffer_read_only, "buffer-read-only");
2958 DEFSYM (Qtext_read_only, "text-read-only");
2959 DEFSYM (Qmark_inactive, "mark-inactive");
2961 DEFSYM (Qlistp, "listp");
2962 DEFSYM (Qconsp, "consp");
2963 DEFSYM (Qsymbolp, "symbolp");
2964 DEFSYM (Qkeywordp, "keywordp");
2965 DEFSYM (Qintegerp, "integerp");
2966 DEFSYM (Qnatnump, "natnump");
2967 DEFSYM (Qwholenump, "wholenump");
2968 DEFSYM (Qstringp, "stringp");
2969 DEFSYM (Qarrayp, "arrayp");
2970 DEFSYM (Qsequencep, "sequencep");
2971 DEFSYM (Qbufferp, "bufferp");
2972 DEFSYM (Qvectorp, "vectorp");
2973 DEFSYM (Qchar_or_string_p, "char-or-string-p");
2974 DEFSYM (Qmarkerp, "markerp");
2975 DEFSYM (Qbuffer_or_string_p, "buffer-or-string-p");
2976 DEFSYM (Qinteger_or_marker_p, "integer-or-marker-p");
2977 DEFSYM (Qboundp, "boundp");
2978 DEFSYM (Qfboundp, "fboundp");
2980 DEFSYM (Qfloatp, "floatp");
2981 DEFSYM (Qnumberp, "numberp");
2982 DEFSYM (Qnumber_or_marker_p, "number-or-marker-p");
2984 DEFSYM (Qchar_table_p, "char-table-p");
2985 DEFSYM (Qvector_or_char_table_p, "vector-or-char-table-p");
2987 DEFSYM (Qsubrp, "subrp");
2988 DEFSYM (Qunevalled, "unevalled");
2989 DEFSYM (Qmany, "many");
2991 DEFSYM (Qcdr, "cdr");
2993 /* Handle automatic advice activation. */
2994 DEFSYM (Qad_advice_info, "ad-advice-info");
2995 DEFSYM (Qad_activate_internal, "ad-activate-internal");
2997 error_tail = pure_cons (Qerror, Qnil);
2999 /* ERROR is used as a signaler for random errors for which nothing else is
3000 right. */
3002 Fput (Qerror, Qerror_conditions,
3003 error_tail);
3004 Fput (Qerror, Qerror_message,
3005 make_pure_c_string ("error"));
3007 Fput (Qquit, Qerror_conditions,
3008 pure_cons (Qquit, Qnil));
3009 Fput (Qquit, Qerror_message,
3010 make_pure_c_string ("Quit"));
3012 Fput (Qwrong_type_argument, Qerror_conditions,
3013 pure_cons (Qwrong_type_argument, error_tail));
3014 Fput (Qwrong_type_argument, Qerror_message,
3015 make_pure_c_string ("Wrong type argument"));
3017 Fput (Qargs_out_of_range, Qerror_conditions,
3018 pure_cons (Qargs_out_of_range, error_tail));
3019 Fput (Qargs_out_of_range, Qerror_message,
3020 make_pure_c_string ("Args out of range"));
3022 Fput (Qvoid_function, Qerror_conditions,
3023 pure_cons (Qvoid_function, error_tail));
3024 Fput (Qvoid_function, Qerror_message,
3025 make_pure_c_string ("Symbol's function definition is void"));
3027 Fput (Qcyclic_function_indirection, Qerror_conditions,
3028 pure_cons (Qcyclic_function_indirection, error_tail));
3029 Fput (Qcyclic_function_indirection, Qerror_message,
3030 make_pure_c_string ("Symbol's chain of function indirections contains a loop"));
3032 Fput (Qcyclic_variable_indirection, Qerror_conditions,
3033 pure_cons (Qcyclic_variable_indirection, error_tail));
3034 Fput (Qcyclic_variable_indirection, Qerror_message,
3035 make_pure_c_string ("Symbol's chain of variable indirections contains a loop"));
3037 DEFSYM (Qcircular_list, "circular-list");
3038 Fput (Qcircular_list, Qerror_conditions,
3039 pure_cons (Qcircular_list, error_tail));
3040 Fput (Qcircular_list, Qerror_message,
3041 make_pure_c_string ("List contains a loop"));
3043 Fput (Qvoid_variable, Qerror_conditions,
3044 pure_cons (Qvoid_variable, error_tail));
3045 Fput (Qvoid_variable, Qerror_message,
3046 make_pure_c_string ("Symbol's value as variable is void"));
3048 Fput (Qsetting_constant, Qerror_conditions,
3049 pure_cons (Qsetting_constant, error_tail));
3050 Fput (Qsetting_constant, Qerror_message,
3051 make_pure_c_string ("Attempt to set a constant symbol"));
3053 Fput (Qinvalid_read_syntax, Qerror_conditions,
3054 pure_cons (Qinvalid_read_syntax, error_tail));
3055 Fput (Qinvalid_read_syntax, Qerror_message,
3056 make_pure_c_string ("Invalid read syntax"));
3058 Fput (Qinvalid_function, Qerror_conditions,
3059 pure_cons (Qinvalid_function, error_tail));
3060 Fput (Qinvalid_function, Qerror_message,
3061 make_pure_c_string ("Invalid function"));
3063 Fput (Qwrong_number_of_arguments, Qerror_conditions,
3064 pure_cons (Qwrong_number_of_arguments, error_tail));
3065 Fput (Qwrong_number_of_arguments, Qerror_message,
3066 make_pure_c_string ("Wrong number of arguments"));
3068 Fput (Qno_catch, Qerror_conditions,
3069 pure_cons (Qno_catch, error_tail));
3070 Fput (Qno_catch, Qerror_message,
3071 make_pure_c_string ("No catch for tag"));
3073 Fput (Qend_of_file, Qerror_conditions,
3074 pure_cons (Qend_of_file, error_tail));
3075 Fput (Qend_of_file, Qerror_message,
3076 make_pure_c_string ("End of file during parsing"));
3078 arith_tail = pure_cons (Qarith_error, error_tail);
3079 Fput (Qarith_error, Qerror_conditions,
3080 arith_tail);
3081 Fput (Qarith_error, Qerror_message,
3082 make_pure_c_string ("Arithmetic error"));
3084 Fput (Qbeginning_of_buffer, Qerror_conditions,
3085 pure_cons (Qbeginning_of_buffer, error_tail));
3086 Fput (Qbeginning_of_buffer, Qerror_message,
3087 make_pure_c_string ("Beginning of buffer"));
3089 Fput (Qend_of_buffer, Qerror_conditions,
3090 pure_cons (Qend_of_buffer, error_tail));
3091 Fput (Qend_of_buffer, Qerror_message,
3092 make_pure_c_string ("End of buffer"));
3094 Fput (Qbuffer_read_only, Qerror_conditions,
3095 pure_cons (Qbuffer_read_only, error_tail));
3096 Fput (Qbuffer_read_only, Qerror_message,
3097 make_pure_c_string ("Buffer is read-only"));
3099 Fput (Qtext_read_only, Qerror_conditions,
3100 pure_cons (Qtext_read_only, error_tail));
3101 Fput (Qtext_read_only, Qerror_message,
3102 make_pure_c_string ("Text is read-only"));
3104 DEFSYM (Qrange_error, "range-error");
3105 DEFSYM (Qdomain_error, "domain-error");
3106 DEFSYM (Qsingularity_error, "singularity-error");
3107 DEFSYM (Qoverflow_error, "overflow-error");
3108 DEFSYM (Qunderflow_error, "underflow-error");
3110 Fput (Qdomain_error, Qerror_conditions,
3111 pure_cons (Qdomain_error, arith_tail));
3112 Fput (Qdomain_error, Qerror_message,
3113 make_pure_c_string ("Arithmetic domain error"));
3115 Fput (Qrange_error, Qerror_conditions,
3116 pure_cons (Qrange_error, arith_tail));
3117 Fput (Qrange_error, Qerror_message,
3118 make_pure_c_string ("Arithmetic range error"));
3120 Fput (Qsingularity_error, Qerror_conditions,
3121 pure_cons (Qsingularity_error, Fcons (Qdomain_error, arith_tail)));
3122 Fput (Qsingularity_error, Qerror_message,
3123 make_pure_c_string ("Arithmetic singularity error"));
3125 Fput (Qoverflow_error, Qerror_conditions,
3126 pure_cons (Qoverflow_error, Fcons (Qdomain_error, arith_tail)));
3127 Fput (Qoverflow_error, Qerror_message,
3128 make_pure_c_string ("Arithmetic overflow error"));
3130 Fput (Qunderflow_error, Qerror_conditions,
3131 pure_cons (Qunderflow_error, Fcons (Qdomain_error, arith_tail)));
3132 Fput (Qunderflow_error, Qerror_message,
3133 make_pure_c_string ("Arithmetic underflow error"));
3135 staticpro (&Qnil);
3136 staticpro (&Qt);
3137 staticpro (&Qunbound);
3139 /* Types that type-of returns. */
3140 DEFSYM (Qinteger, "integer");
3141 DEFSYM (Qsymbol, "symbol");
3142 DEFSYM (Qstring, "string");
3143 DEFSYM (Qcons, "cons");
3144 DEFSYM (Qmarker, "marker");
3145 DEFSYM (Qoverlay, "overlay");
3146 DEFSYM (Qfloat, "float");
3147 DEFSYM (Qwindow_configuration, "window-configuration");
3148 DEFSYM (Qprocess, "process");
3149 DEFSYM (Qwindow, "window");
3150 /* DEFSYM (Qsubr, "subr"); */
3151 DEFSYM (Qcompiled_function, "compiled-function");
3152 DEFSYM (Qbuffer, "buffer");
3153 DEFSYM (Qframe, "frame");
3154 DEFSYM (Qvector, "vector");
3155 DEFSYM (Qchar_table, "char-table");
3156 DEFSYM (Qbool_vector, "bool-vector");
3157 DEFSYM (Qhash_table, "hash-table");
3159 DEFSYM (Qfont_spec, "font-spec");
3160 DEFSYM (Qfont_entity, "font-entity");
3161 DEFSYM (Qfont_object, "font-object");
3163 DEFSYM (Qinteractive_form, "interactive-form");
3165 defsubr (&Sindirect_variable);
3166 defsubr (&Sinteractive_form);
3167 defsubr (&Seq);
3168 defsubr (&Snull);
3169 defsubr (&Stype_of);
3170 defsubr (&Slistp);
3171 defsubr (&Snlistp);
3172 defsubr (&Sconsp);
3173 defsubr (&Satom);
3174 defsubr (&Sintegerp);
3175 defsubr (&Sinteger_or_marker_p);
3176 defsubr (&Snumberp);
3177 defsubr (&Snumber_or_marker_p);
3178 defsubr (&Sfloatp);
3179 defsubr (&Snatnump);
3180 defsubr (&Ssymbolp);
3181 defsubr (&Skeywordp);
3182 defsubr (&Sstringp);
3183 defsubr (&Smultibyte_string_p);
3184 defsubr (&Svectorp);
3185 defsubr (&Schar_table_p);
3186 defsubr (&Svector_or_char_table_p);
3187 defsubr (&Sbool_vector_p);
3188 defsubr (&Sarrayp);
3189 defsubr (&Ssequencep);
3190 defsubr (&Sbufferp);
3191 defsubr (&Smarkerp);
3192 defsubr (&Ssubrp);
3193 defsubr (&Sbyte_code_function_p);
3194 defsubr (&Schar_or_string_p);
3195 defsubr (&Scar);
3196 defsubr (&Scdr);
3197 defsubr (&Scar_safe);
3198 defsubr (&Scdr_safe);
3199 defsubr (&Ssetcar);
3200 defsubr (&Ssetcdr);
3201 defsubr (&Ssymbol_function);
3202 defsubr (&Sindirect_function);
3203 defsubr (&Ssymbol_plist);
3204 defsubr (&Ssymbol_name);
3205 defsubr (&Smakunbound);
3206 defsubr (&Sfmakunbound);
3207 defsubr (&Sboundp);
3208 defsubr (&Sfboundp);
3209 defsubr (&Sfset);
3210 defsubr (&Sdefalias);
3211 defsubr (&Ssetplist);
3212 defsubr (&Ssymbol_value);
3213 defsubr (&Sset);
3214 defsubr (&Sdefault_boundp);
3215 defsubr (&Sdefault_value);
3216 defsubr (&Sset_default);
3217 defsubr (&Ssetq_default);
3218 defsubr (&Smake_variable_buffer_local);
3219 defsubr (&Smake_local_variable);
3220 defsubr (&Skill_local_variable);
3221 defsubr (&Smake_variable_frame_local);
3222 defsubr (&Slocal_variable_p);
3223 defsubr (&Slocal_variable_if_set_p);
3224 defsubr (&Svariable_binding_locus);
3225 #if 0 /* XXX Remove this. --lorentey */
3226 defsubr (&Sterminal_local_value);
3227 defsubr (&Sset_terminal_local_value);
3228 #endif
3229 defsubr (&Saref);
3230 defsubr (&Saset);
3231 defsubr (&Snumber_to_string);
3232 defsubr (&Sstring_to_number);
3233 defsubr (&Seqlsign);
3234 defsubr (&Slss);
3235 defsubr (&Sgtr);
3236 defsubr (&Sleq);
3237 defsubr (&Sgeq);
3238 defsubr (&Sneq);
3239 defsubr (&Szerop);
3240 defsubr (&Splus);
3241 defsubr (&Sminus);
3242 defsubr (&Stimes);
3243 defsubr (&Squo);
3244 defsubr (&Srem);
3245 defsubr (&Smod);
3246 defsubr (&Smax);
3247 defsubr (&Smin);
3248 defsubr (&Slogand);
3249 defsubr (&Slogior);
3250 defsubr (&Slogxor);
3251 defsubr (&Slsh);
3252 defsubr (&Sash);
3253 defsubr (&Sadd1);
3254 defsubr (&Ssub1);
3255 defsubr (&Slognot);
3256 defsubr (&Sbyteorder);
3257 defsubr (&Ssubr_arity);
3258 defsubr (&Ssubr_name);
3260 XSYMBOL (Qwholenump)->function = XSYMBOL (Qnatnump)->function;
3262 DEFVAR_LISP ("most-positive-fixnum", Vmost_positive_fixnum,
3263 doc: /* The largest value that is representable in a Lisp integer. */);
3264 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3265 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3267 DEFVAR_LISP ("most-negative-fixnum", Vmost_negative_fixnum,
3268 doc: /* The smallest value that is representable in a Lisp integer. */);
3269 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3270 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;
3273 #ifndef FORWARD_SIGNAL_TO_MAIN_THREAD
3274 static void arith_error (int) NO_RETURN;
3275 #endif
3277 static void
3278 arith_error (int signo)
3280 sigsetmask (SIGEMPTYMASK);
3282 SIGNAL_THREAD_CHECK (signo);
3283 xsignal0 (Qarith_error);
3286 void
3287 init_data (void)
3289 /* Don't do this if just dumping out.
3290 We don't want to call `signal' in this case
3291 so that we don't have trouble with dumping
3292 signal-delivering routines in an inconsistent state. */
3293 #ifndef CANNOT_DUMP
3294 if (!initialized)
3295 return;
3296 #endif /* CANNOT_DUMP */
3297 signal (SIGFPE, arith_error);