Merge from trunk.
[emacs.git] / src / data.c
blob69f6cc34c2989a7bad676e0ecec43aa3a438314f
1 /* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <setjmp.h>
26 #include "lisp.h"
27 #include "puresize.h"
28 #include "character.h"
29 #include "buffer.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "syssignal.h"
33 #include "termhooks.h" /* For FRAME_KBOARD reference in y-or-n-p. */
34 #include "font.h"
36 #ifdef STDC_HEADERS
37 #include <float.h>
38 #endif
40 /* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
41 #ifndef IEEE_FLOATING_POINT
42 #if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
43 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
44 #define IEEE_FLOATING_POINT 1
45 #else
46 #define IEEE_FLOATING_POINT 0
47 #endif
48 #endif
50 #include <math.h>
52 #if !defined (atof)
53 extern double atof (const char *);
54 #endif /* !atof */
56 Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
57 Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
58 Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
59 Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
60 Lisp_Object Qcyclic_variable_indirection, Qcircular_list;
61 Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
62 Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
63 Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
64 Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
65 Lisp_Object Qtext_read_only;
67 Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
68 Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
69 Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
70 Lisp_Object Qbuffer_or_string_p, Qkeywordp;
71 Lisp_Object Qboundp, Qfboundp;
72 Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
74 Lisp_Object Qcdr;
75 Lisp_Object Qad_advice_info, Qad_activate_internal;
77 Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
78 Lisp_Object Qoverflow_error, Qunderflow_error;
80 Lisp_Object Qfloatp;
81 Lisp_Object Qnumberp, Qnumber_or_marker_p;
83 Lisp_Object Qinteger;
84 static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
85 Lisp_Object Qwindow;
86 static Lisp_Object Qfloat, Qwindow_configuration;
87 Lisp_Object Qprocess;
88 static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
89 static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
90 static Lisp_Object Qsubrp, Qmany, Qunevalled;
91 Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
93 Lisp_Object Qinteractive_form;
95 static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
97 Lisp_Object Vmost_positive_fixnum, Vmost_negative_fixnum;
100 void
101 circular_list_error (Lisp_Object list)
103 xsignal (Qcircular_list, list);
107 Lisp_Object
108 wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
110 /* If VALUE is not even a valid Lisp object, we'd want to abort here
111 where we can get a backtrace showing where it came from. We used
112 to try and do that by checking the tagbits, but nowadays all
113 tagbits are potentially valid. */
114 /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
115 * abort (); */
117 xsignal2 (Qwrong_type_argument, predicate, value);
120 void
121 pure_write_error (void)
123 error ("Attempt to modify read-only object");
126 void
127 args_out_of_range (Lisp_Object a1, Lisp_Object a2)
129 xsignal2 (Qargs_out_of_range, a1, a2);
132 void
133 args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
135 xsignal3 (Qargs_out_of_range, a1, a2, a3);
138 /* On some machines, XINT needs a temporary location.
139 Here it is, in case it is needed. */
141 int sign_extend_temp;
143 /* On a few machines, XINT can only be done by calling this. */
146 sign_extend_lisp_int (EMACS_INT num)
148 if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
149 return num | (((EMACS_INT) (-1)) << VALBITS);
150 else
151 return num & ((((EMACS_INT) 1) << VALBITS) - 1);
154 /* Data type predicates */
156 DEFUN ("eq", Feq, Seq, 2, 2, 0,
157 doc: /* Return t if the two args are the same Lisp object. */)
158 (Lisp_Object obj1, Lisp_Object obj2)
160 if (EQ (obj1, obj2))
161 return Qt;
162 return Qnil;
165 DEFUN ("null", Fnull, Snull, 1, 1, 0,
166 doc: /* Return t if OBJECT is nil. */)
167 (Lisp_Object object)
169 if (NILP (object))
170 return Qt;
171 return Qnil;
174 DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
175 doc: /* Return a symbol representing the type of OBJECT.
176 The symbol returned names the object's basic type;
177 for example, (type-of 1) returns `integer'. */)
178 (Lisp_Object object)
180 switch (XTYPE (object))
182 case_Lisp_Int:
183 return Qinteger;
185 case Lisp_Symbol:
186 return Qsymbol;
188 case Lisp_String:
189 return Qstring;
191 case Lisp_Cons:
192 return Qcons;
194 case Lisp_Misc:
195 switch (XMISCTYPE (object))
197 case Lisp_Misc_Marker:
198 return Qmarker;
199 case Lisp_Misc_Overlay:
200 return Qoverlay;
201 case Lisp_Misc_Float:
202 return Qfloat;
204 abort ();
206 case Lisp_Vectorlike:
207 if (WINDOW_CONFIGURATIONP (object))
208 return Qwindow_configuration;
209 if (PROCESSP (object))
210 return Qprocess;
211 if (WINDOWP (object))
212 return Qwindow;
213 if (SUBRP (object))
214 return Qsubr;
215 if (COMPILEDP (object))
216 return Qcompiled_function;
217 if (BUFFERP (object))
218 return Qbuffer;
219 if (CHAR_TABLE_P (object))
220 return Qchar_table;
221 if (BOOL_VECTOR_P (object))
222 return Qbool_vector;
223 if (FRAMEP (object))
224 return Qframe;
225 if (HASH_TABLE_P (object))
226 return Qhash_table;
227 if (FONT_SPEC_P (object))
228 return Qfont_spec;
229 if (FONT_ENTITY_P (object))
230 return Qfont_entity;
231 if (FONT_OBJECT_P (object))
232 return Qfont_object;
233 return Qvector;
235 case Lisp_Float:
236 return Qfloat;
238 default:
239 abort ();
243 DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
244 doc: /* Return t if OBJECT is a cons cell. */)
245 (Lisp_Object object)
247 if (CONSP (object))
248 return Qt;
249 return Qnil;
252 DEFUN ("atom", Fatom, Satom, 1, 1, 0,
253 doc: /* Return t if OBJECT is not a cons cell. This includes nil. */)
254 (Lisp_Object object)
256 if (CONSP (object))
257 return Qnil;
258 return Qt;
261 DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
262 doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
263 Otherwise, return nil. */)
264 (Lisp_Object object)
266 if (CONSP (object) || NILP (object))
267 return Qt;
268 return Qnil;
271 DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
272 doc: /* Return t if OBJECT is not a list. Lists include nil. */)
273 (Lisp_Object object)
275 if (CONSP (object) || NILP (object))
276 return Qnil;
277 return Qt;
280 DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
281 doc: /* Return t if OBJECT is a symbol. */)
282 (Lisp_Object object)
284 if (SYMBOLP (object))
285 return Qt;
286 return Qnil;
289 /* Define this in C to avoid unnecessarily consing up the symbol
290 name. */
291 DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
292 doc: /* Return t if OBJECT is a keyword.
293 This means that it is a symbol with a print name beginning with `:'
294 interned in the initial obarray. */)
295 (Lisp_Object object)
297 if (SYMBOLP (object)
298 && SREF (SYMBOL_NAME (object), 0) == ':'
299 && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
300 return Qt;
301 return Qnil;
304 DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
305 doc: /* Return t if OBJECT is a vector. */)
306 (Lisp_Object object)
308 if (VECTORP (object))
309 return Qt;
310 return Qnil;
313 DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
314 doc: /* Return t if OBJECT is a string. */)
315 (Lisp_Object object)
317 if (STRINGP (object))
318 return Qt;
319 return Qnil;
322 DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
323 1, 1, 0,
324 doc: /* Return t if OBJECT is a multibyte string. */)
325 (Lisp_Object object)
327 if (STRINGP (object) && STRING_MULTIBYTE (object))
328 return Qt;
329 return Qnil;
332 DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
333 doc: /* Return t if OBJECT is a char-table. */)
334 (Lisp_Object object)
336 if (CHAR_TABLE_P (object))
337 return Qt;
338 return Qnil;
341 DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
342 Svector_or_char_table_p, 1, 1, 0,
343 doc: /* Return t if OBJECT is a char-table or vector. */)
344 (Lisp_Object object)
346 if (VECTORP (object) || CHAR_TABLE_P (object))
347 return Qt;
348 return Qnil;
351 DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
352 doc: /* Return t if OBJECT is a bool-vector. */)
353 (Lisp_Object object)
355 if (BOOL_VECTOR_P (object))
356 return Qt;
357 return Qnil;
360 DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
361 doc: /* Return t if OBJECT is an array (string or vector). */)
362 (Lisp_Object object)
364 if (ARRAYP (object))
365 return Qt;
366 return Qnil;
369 DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
370 doc: /* Return t if OBJECT is a sequence (list or array). */)
371 (register Lisp_Object object)
373 if (CONSP (object) || NILP (object) || ARRAYP (object))
374 return Qt;
375 return Qnil;
378 DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
379 doc: /* Return t if OBJECT is an editor buffer. */)
380 (Lisp_Object object)
382 if (BUFFERP (object))
383 return Qt;
384 return Qnil;
387 DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
388 doc: /* Return t if OBJECT is a marker (editor pointer). */)
389 (Lisp_Object object)
391 if (MARKERP (object))
392 return Qt;
393 return Qnil;
396 DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
397 doc: /* Return t if OBJECT is a built-in function. */)
398 (Lisp_Object object)
400 if (SUBRP (object))
401 return Qt;
402 return Qnil;
405 DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
406 1, 1, 0,
407 doc: /* Return t if OBJECT is a byte-compiled function object. */)
408 (Lisp_Object object)
410 if (COMPILEDP (object))
411 return Qt;
412 return Qnil;
415 DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
416 doc: /* Return t if OBJECT is a character or a string. */)
417 (register Lisp_Object object)
419 if (CHARACTERP (object) || STRINGP (object))
420 return Qt;
421 return Qnil;
424 DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
425 doc: /* Return t if OBJECT is an integer. */)
426 (Lisp_Object object)
428 if (INTEGERP (object))
429 return Qt;
430 return Qnil;
433 DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
434 doc: /* Return t if OBJECT is an integer or a marker (editor pointer). */)
435 (register Lisp_Object object)
437 if (MARKERP (object) || INTEGERP (object))
438 return Qt;
439 return Qnil;
442 DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
443 doc: /* Return t if OBJECT is a nonnegative integer. */)
444 (Lisp_Object object)
446 if (NATNUMP (object))
447 return Qt;
448 return Qnil;
451 DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
452 doc: /* Return t if OBJECT is a number (floating point or integer). */)
453 (Lisp_Object object)
455 if (NUMBERP (object))
456 return Qt;
457 else
458 return Qnil;
461 DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
462 Snumber_or_marker_p, 1, 1, 0,
463 doc: /* Return t if OBJECT is a number or a marker. */)
464 (Lisp_Object object)
466 if (NUMBERP (object) || MARKERP (object))
467 return Qt;
468 return Qnil;
471 DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
472 doc: /* Return t if OBJECT is a floating point number. */)
473 (Lisp_Object object)
475 if (FLOATP (object))
476 return Qt;
477 return Qnil;
481 /* Extract and set components of lists */
483 DEFUN ("car", Fcar, Scar, 1, 1, 0,
484 doc: /* Return the car of LIST. If arg is nil, return nil.
485 Error if arg is not nil and not a cons cell. See also `car-safe'.
487 See Info node `(elisp)Cons Cells' for a discussion of related basic
488 Lisp concepts such as car, cdr, cons cell and list. */)
489 (register Lisp_Object list)
491 return CAR (list);
494 DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
495 doc: /* Return the car of OBJECT if it is a cons cell, or else nil. */)
496 (Lisp_Object object)
498 return CAR_SAFE (object);
501 DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
502 doc: /* Return the cdr of LIST. If arg is nil, return nil.
503 Error if arg is not nil and not a cons cell. See also `cdr-safe'.
505 See Info node `(elisp)Cons Cells' for a discussion of related basic
506 Lisp concepts such as cdr, car, cons cell and list. */)
507 (register Lisp_Object list)
509 return CDR (list);
512 DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
513 doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil. */)
514 (Lisp_Object object)
516 return CDR_SAFE (object);
519 DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
520 doc: /* Set the car of CELL to be NEWCAR. Returns NEWCAR. */)
521 (register Lisp_Object cell, Lisp_Object newcar)
523 CHECK_CONS (cell);
524 CHECK_IMPURE (cell);
525 XSETCAR (cell, newcar);
526 return newcar;
529 DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
530 doc: /* Set the cdr of CELL to be NEWCDR. Returns NEWCDR. */)
531 (register Lisp_Object cell, Lisp_Object newcdr)
533 CHECK_CONS (cell);
534 CHECK_IMPURE (cell);
535 XSETCDR (cell, newcdr);
536 return newcdr;
539 /* Extract and set components of symbols */
541 DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
542 doc: /* Return t if SYMBOL's value is not void. */)
543 (register Lisp_Object symbol)
545 Lisp_Object valcontents;
546 struct Lisp_Symbol *sym;
547 CHECK_SYMBOL (symbol);
548 sym = XSYMBOL (symbol);
550 start:
551 switch (sym->redirect)
553 case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
554 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
555 case SYMBOL_LOCALIZED:
557 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
558 if (blv->fwd)
559 /* In set_internal, we un-forward vars when their value is
560 set to Qunbound. */
561 return Qt;
562 else
564 swap_in_symval_forwarding (sym, blv);
565 valcontents = BLV_VALUE (blv);
567 break;
569 case SYMBOL_FORWARDED:
570 /* In set_internal, we un-forward vars when their value is
571 set to Qunbound. */
572 return Qt;
573 default: abort ();
576 return (EQ (valcontents, Qunbound) ? Qnil : Qt);
579 DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
580 doc: /* Return t if SYMBOL's function definition is not void. */)
581 (register Lisp_Object symbol)
583 CHECK_SYMBOL (symbol);
584 return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
587 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
588 doc: /* Make SYMBOL's value be void.
589 Return SYMBOL. */)
590 (register Lisp_Object symbol)
592 CHECK_SYMBOL (symbol);
593 if (SYMBOL_CONSTANT_P (symbol))
594 xsignal1 (Qsetting_constant, symbol);
595 Fset (symbol, Qunbound);
596 return symbol;
599 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
600 doc: /* Make SYMBOL's function definition be void.
601 Return SYMBOL. */)
602 (register Lisp_Object symbol)
604 CHECK_SYMBOL (symbol);
605 if (NILP (symbol) || EQ (symbol, Qt))
606 xsignal1 (Qsetting_constant, symbol);
607 XSYMBOL (symbol)->function = Qunbound;
608 return symbol;
611 DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
612 doc: /* Return SYMBOL's function definition. Error if that is void. */)
613 (register Lisp_Object symbol)
615 CHECK_SYMBOL (symbol);
616 if (!EQ (XSYMBOL (symbol)->function, Qunbound))
617 return XSYMBOL (symbol)->function;
618 xsignal1 (Qvoid_function, symbol);
621 DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
622 doc: /* Return SYMBOL's property list. */)
623 (register Lisp_Object symbol)
625 CHECK_SYMBOL (symbol);
626 return XSYMBOL (symbol)->plist;
629 DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
630 doc: /* Return SYMBOL's name, a string. */)
631 (register Lisp_Object symbol)
633 register Lisp_Object name;
635 CHECK_SYMBOL (symbol);
636 name = SYMBOL_NAME (symbol);
637 return name;
640 DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
641 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION. */)
642 (register Lisp_Object symbol, Lisp_Object definition)
644 register Lisp_Object function;
646 CHECK_SYMBOL (symbol);
647 if (NILP (symbol) || EQ (symbol, Qt))
648 xsignal1 (Qsetting_constant, symbol);
650 function = XSYMBOL (symbol)->function;
652 if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
653 Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);
655 if (CONSP (function) && EQ (XCAR (function), Qautoload))
656 Fput (symbol, Qautoload, XCDR (function));
658 XSYMBOL (symbol)->function = definition;
659 /* Handle automatic advice activation */
660 if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
662 call2 (Qad_activate_internal, symbol, Qnil);
663 definition = XSYMBOL (symbol)->function;
665 return definition;
668 extern Lisp_Object Qfunction_documentation;
670 DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
671 doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
672 Associates the function with the current load file, if any.
673 The optional third argument DOCSTRING specifies the documentation string
674 for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
675 determined by DEFINITION. */)
676 (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
678 CHECK_SYMBOL (symbol);
679 if (CONSP (XSYMBOL (symbol)->function)
680 && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
681 LOADHIST_ATTACH (Fcons (Qt, symbol));
682 definition = Ffset (symbol, definition);
683 LOADHIST_ATTACH (Fcons (Qdefun, symbol));
684 if (!NILP (docstring))
685 Fput (symbol, Qfunction_documentation, docstring);
686 return definition;
689 DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
690 doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST. */)
691 (register Lisp_Object symbol, Lisp_Object newplist)
693 CHECK_SYMBOL (symbol);
694 XSYMBOL (symbol)->plist = newplist;
695 return newplist;
698 DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
699 doc: /* Return minimum and maximum number of args allowed for SUBR.
700 SUBR must be a built-in function.
701 The returned value is a pair (MIN . MAX). MIN is the minimum number
702 of args. MAX is the maximum number or the symbol `many', for a
703 function with `&rest' args, or `unevalled' for a special form. */)
704 (Lisp_Object subr)
706 short minargs, maxargs;
707 CHECK_SUBR (subr);
708 minargs = XSUBR (subr)->min_args;
709 maxargs = XSUBR (subr)->max_args;
710 if (maxargs == MANY)
711 return Fcons (make_number (minargs), Qmany);
712 else if (maxargs == UNEVALLED)
713 return Fcons (make_number (minargs), Qunevalled);
714 else
715 return Fcons (make_number (minargs), make_number (maxargs));
718 DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
719 doc: /* Return name of subroutine SUBR.
720 SUBR must be a built-in function. */)
721 (Lisp_Object subr)
723 const char *name;
724 CHECK_SUBR (subr);
725 name = XSUBR (subr)->symbol_name;
726 return make_string (name, strlen (name));
729 DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
730 doc: /* Return the interactive form of CMD or nil if none.
731 If CMD is not a command, the return value is nil.
732 Value, if non-nil, is a list \(interactive SPEC). */)
733 (Lisp_Object cmd)
735 Lisp_Object fun = indirect_function (cmd); /* Check cycles. */
737 if (NILP (fun) || EQ (fun, Qunbound))
738 return Qnil;
740 /* Use an `interactive-form' property if present, analogous to the
741 function-documentation property. */
742 fun = cmd;
743 while (SYMBOLP (fun))
745 Lisp_Object tmp = Fget (fun, Qinteractive_form);
746 if (!NILP (tmp))
747 return tmp;
748 else
749 fun = Fsymbol_function (fun);
752 if (SUBRP (fun))
754 const char *spec = XSUBR (fun)->intspec;
755 if (spec)
756 return list2 (Qinteractive,
757 (*spec != '(') ? build_string (spec) :
758 Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
760 else if (COMPILEDP (fun))
762 if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
763 return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
765 else if (CONSP (fun))
767 Lisp_Object funcar = XCAR (fun);
768 if (EQ (funcar, Qlambda))
769 return Fassq (Qinteractive, Fcdr (XCDR (fun)));
770 else if (EQ (funcar, Qautoload))
772 struct gcpro gcpro1;
773 GCPRO1 (cmd);
774 do_autoload (fun, cmd);
775 UNGCPRO;
776 return Finteractive_form (cmd);
779 return Qnil;
783 /***********************************************************************
784 Getting and Setting Values of Symbols
785 ***********************************************************************/
787 /* Return the symbol holding SYMBOL's value. Signal
788 `cyclic-variable-indirection' if SYMBOL's chain of variable
789 indirections contains a loop. */
791 struct Lisp_Symbol *
792 indirect_variable (struct Lisp_Symbol *symbol)
794 struct Lisp_Symbol *tortoise, *hare;
796 hare = tortoise = symbol;
798 while (hare->redirect == SYMBOL_VARALIAS)
800 hare = SYMBOL_ALIAS (hare);
801 if (hare->redirect != SYMBOL_VARALIAS)
802 break;
804 hare = SYMBOL_ALIAS (hare);
805 tortoise = SYMBOL_ALIAS (tortoise);
807 if (hare == tortoise)
809 Lisp_Object tem;
810 XSETSYMBOL (tem, symbol);
811 xsignal1 (Qcyclic_variable_indirection, tem);
815 return hare;
819 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
820 doc: /* Return the variable at the end of OBJECT's variable chain.
821 If OBJECT is a symbol, follow all variable indirections and return the final
822 variable. If OBJECT is not a symbol, just return it.
823 Signal a cyclic-variable-indirection error if there is a loop in the
824 variable chain of symbols. */)
825 (Lisp_Object object)
827 if (SYMBOLP (object))
828 XSETSYMBOL (object, indirect_variable (XSYMBOL (object)));
829 return object;
833 /* Given the raw contents of a symbol value cell,
834 return the Lisp value of the symbol.
835 This does not handle buffer-local variables; use
836 swap_in_symval_forwarding for that. */
838 #define do_blv_forwarding(blv) \
839 ((blv)->forwarded ? do_symval_forwarding (BLV_FWD (blv)) : BLV_VALUE (blv))
841 Lisp_Object
842 do_symval_forwarding (register union Lisp_Fwd *valcontents)
844 register Lisp_Object val;
845 switch (XFWDTYPE (valcontents))
847 case Lisp_Fwd_Int:
848 XSETINT (val, *XINTFWD (valcontents)->intvar);
849 return val;
851 case Lisp_Fwd_Bool:
852 return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
854 case Lisp_Fwd_Obj:
855 return *XOBJFWD (valcontents)->objvar;
857 case Lisp_Fwd_Buffer_Obj:
858 return PER_BUFFER_VALUE (current_buffer,
859 XBUFFER_OBJFWD (valcontents)->offset);
861 case Lisp_Fwd_Kboard_Obj:
862 /* We used to simply use current_kboard here, but from Lisp
863 code, it's value is often unexpected. It seems nicer to
864 allow constructions like this to work as intuitively expected:
866 (with-selected-frame frame
867 (define-key local-function-map "\eOP" [f1]))
869 On the other hand, this affects the semantics of
870 last-command and real-last-command, and people may rely on
871 that. I took a quick look at the Lisp codebase, and I
872 don't think anything will break. --lorentey */
873 return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
874 + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
875 default: abort ();
879 /* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
880 of SYMBOL. If SYMBOL is buffer-local, VALCONTENTS should be the
881 buffer-independent contents of the value cell: forwarded just one
882 step past the buffer-localness.
884 BUF non-zero means set the value in buffer BUF instead of the
885 current buffer. This only plays a role for per-buffer variables. */
887 #define store_blv_forwarding(blv, newval, buf) \
888 do { \
889 if ((blv)->forwarded) \
890 store_symval_forwarding (BLV_FWD (blv), (newval), (buf)); \
891 else \
892 SET_BLV_VALUE (blv, newval); \
893 } while (0)
895 static void
896 store_symval_forwarding (union Lisp_Fwd *valcontents, register Lisp_Object newval, struct buffer *buf)
898 switch (XFWDTYPE (valcontents))
900 case Lisp_Fwd_Int:
901 CHECK_NUMBER (newval);
902 *XINTFWD (valcontents)->intvar = XINT (newval);
903 break;
905 case Lisp_Fwd_Bool:
906 *XBOOLFWD (valcontents)->boolvar = !NILP (newval);
907 break;
909 case Lisp_Fwd_Obj:
910 *XOBJFWD (valcontents)->objvar = newval;
912 /* If this variable is a default for something stored
913 in the buffer itself, such as default-fill-column,
914 find the buffers that don't have local values for it
915 and update them. */
916 if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
917 && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
919 int offset = ((char *) XOBJFWD (valcontents)->objvar
920 - (char *) &buffer_defaults);
921 int idx = PER_BUFFER_IDX (offset);
923 Lisp_Object tail;
925 if (idx <= 0)
926 break;
928 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
930 Lisp_Object buf;
931 struct buffer *b;
933 buf = Fcdr (XCAR (tail));
934 if (!BUFFERP (buf)) continue;
935 b = XBUFFER (buf);
937 if (! PER_BUFFER_VALUE_P (b, idx))
938 PER_BUFFER_VALUE (b, offset) = newval;
941 break;
943 case Lisp_Fwd_Buffer_Obj:
945 int offset = XBUFFER_OBJFWD (valcontents)->offset;
946 Lisp_Object type = XBUFFER_OBJFWD (valcontents)->slottype;
948 if (!(NILP (type) || NILP (newval)
949 || (XINT (type) == LISP_INT_TAG
950 ? INTEGERP (newval)
951 : XTYPE (newval) == XINT (type))))
952 buffer_slot_type_mismatch (newval, XINT (type));
954 if (buf == NULL)
955 buf = current_buffer;
956 PER_BUFFER_VALUE (buf, offset) = newval;
958 break;
960 case Lisp_Fwd_Kboard_Obj:
962 char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
963 char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
964 *(Lisp_Object *) p = newval;
966 break;
968 default:
969 abort (); /* goto def; */
973 /* Set up SYMBOL to refer to its global binding.
974 This makes it safe to alter the status of other bindings. */
976 void
977 swap_in_global_binding (struct Lisp_Symbol *symbol)
979 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (symbol);
981 /* Unload the previously loaded binding. */
982 if (blv->fwd)
983 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
985 /* Select the global binding in the symbol. */
986 blv->valcell = blv->defcell;
987 if (blv->fwd)
988 store_symval_forwarding (blv->fwd, XCDR (blv->defcell), NULL);
990 /* Indicate that the global binding is set up now. */
991 blv->where = Qnil;
992 SET_BLV_FOUND (blv, 0);
995 /* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
996 VALCONTENTS is the contents of its value cell,
997 which points to a struct Lisp_Buffer_Local_Value.
999 Return the value forwarded one step past the buffer-local stage.
1000 This could be another forwarding pointer. */
1002 static void
1003 swap_in_symval_forwarding (struct Lisp_Symbol *symbol, struct Lisp_Buffer_Local_Value *blv)
1005 register Lisp_Object tem1;
1007 eassert (blv == SYMBOL_BLV (symbol));
1009 tem1 = blv->where;
1011 if (NILP (tem1)
1012 || (blv->frame_local
1013 ? !EQ (selected_frame, tem1)
1014 : current_buffer != XBUFFER (tem1)))
1017 /* Unload the previously loaded binding. */
1018 tem1 = blv->valcell;
1019 if (blv->fwd)
1020 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1021 /* Choose the new binding. */
1023 Lisp_Object var;
1024 XSETSYMBOL (var, symbol);
1025 if (blv->frame_local)
1027 tem1 = assq_no_quit (var, XFRAME (selected_frame)->param_alist);
1028 blv->where = selected_frame;
1030 else
1032 tem1 = assq_no_quit (var, current_buffer->local_var_alist);
1033 XSETBUFFER (blv->where, current_buffer);
1036 if (!(blv->found = !NILP (tem1)))
1037 tem1 = blv->defcell;
1039 /* Load the new binding. */
1040 blv->valcell = tem1;
1041 if (blv->fwd)
1042 store_symval_forwarding (blv->fwd, BLV_VALUE (blv), NULL);
1046 /* Find the value of a symbol, returning Qunbound if it's not bound.
1047 This is helpful for code which just wants to get a variable's value
1048 if it has one, without signaling an error.
1049 Note that it must not be possible to quit
1050 within this function. Great care is required for this. */
1052 Lisp_Object
1053 find_symbol_value (Lisp_Object symbol)
1055 struct Lisp_Symbol *sym;
1057 CHECK_SYMBOL (symbol);
1058 sym = XSYMBOL (symbol);
1060 start:
1061 switch (sym->redirect)
1063 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1064 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1065 case SYMBOL_LOCALIZED:
1067 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1068 swap_in_symval_forwarding (sym, blv);
1069 return blv->fwd ? do_symval_forwarding (blv->fwd) : BLV_VALUE (blv);
1071 /* FALLTHROUGH */
1072 case SYMBOL_FORWARDED:
1073 return do_symval_forwarding (SYMBOL_FWD (sym));
1074 default: abort ();
1078 DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
1079 doc: /* Return SYMBOL's value. Error if that is void. */)
1080 (Lisp_Object symbol)
1082 Lisp_Object val;
1084 val = find_symbol_value (symbol);
1085 if (!EQ (val, Qunbound))
1086 return val;
1088 xsignal1 (Qvoid_variable, symbol);
1091 DEFUN ("set", Fset, Sset, 2, 2, 0,
1092 doc: /* Set SYMBOL's value to NEWVAL, and return NEWVAL. */)
1093 (register Lisp_Object symbol, Lisp_Object newval)
1095 set_internal (symbol, newval, Qnil, 0);
1096 return newval;
1099 /* Return 1 if SYMBOL currently has a let-binding
1100 which was made in the buffer that is now current. */
1102 static int
1103 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
1105 struct specbinding *p;
1107 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1108 if (p->func == NULL
1109 && CONSP (p->symbol))
1111 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (XCAR (p->symbol));
1112 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
1113 if (symbol == let_bound_symbol
1114 && XBUFFER (XCDR (XCDR (p->symbol))) == current_buffer)
1115 break;
1118 return p >= specpdl;
1121 static int
1122 let_shadows_global_binding_p (Lisp_Object symbol)
1124 struct specbinding *p;
1126 for (p = specpdl_ptr - 1; p >= specpdl; p--)
1127 if (p->func == NULL && EQ (p->symbol, symbol))
1128 break;
1130 return p >= specpdl;
1133 /* Store the value NEWVAL into SYMBOL.
1134 If buffer/frame-locality is an issue, WHERE specifies which context to use.
1135 (nil stands for the current buffer/frame).
1137 If BINDFLAG is zero, then if this symbol is supposed to become
1138 local in every buffer where it is set, then we make it local.
1139 If BINDFLAG is nonzero, we don't do that. */
1141 void
1142 set_internal (register Lisp_Object symbol, register Lisp_Object newval, register Lisp_Object where, int bindflag)
1144 int voide = EQ (newval, Qunbound);
1145 struct Lisp_Symbol *sym;
1146 Lisp_Object tem1;
1148 /* If restoring in a dead buffer, do nothing. */
1149 /* if (BUFFERP (where) && NILP (XBUFFER (where)->name))
1150 return; */
1152 CHECK_SYMBOL (symbol);
1153 if (SYMBOL_CONSTANT_P (symbol))
1155 if (NILP (Fkeywordp (symbol))
1156 || !EQ (newval, Fsymbol_value (symbol)))
1157 xsignal1 (Qsetting_constant, symbol);
1158 else
1159 /* Allow setting keywords to their own value. */
1160 return;
1163 sym = XSYMBOL (symbol);
1165 start:
1166 switch (sym->redirect)
1168 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1169 case SYMBOL_PLAINVAL: SET_SYMBOL_VAL (sym , newval); return;
1170 case SYMBOL_LOCALIZED:
1172 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1173 if (NILP (where))
1175 if (blv->frame_local)
1176 where = selected_frame;
1177 else
1178 XSETBUFFER (where, current_buffer);
1180 /* If the current buffer is not the buffer whose binding is
1181 loaded, or if there may be frame-local bindings and the frame
1182 isn't the right one, or if it's a Lisp_Buffer_Local_Value and
1183 the default binding is loaded, the loaded binding may be the
1184 wrong one. */
1185 if (!EQ (blv->where, where)
1186 /* Also unload a global binding (if the var is local_if_set). */
1187 || (EQ (blv->valcell, blv->defcell)))
1189 /* The currently loaded binding is not necessarily valid.
1190 We need to unload it, and choose a new binding. */
1192 /* Write out `realvalue' to the old loaded binding. */
1193 if (blv->fwd)
1194 SET_BLV_VALUE (blv, do_symval_forwarding (blv->fwd));
1196 /* Find the new binding. */
1197 XSETSYMBOL (symbol, sym); /* May have changed via aliasing. */
1198 tem1 = Fassq (symbol,
1199 (blv->frame_local
1200 ? XFRAME (where)->param_alist
1201 : XBUFFER (where)->local_var_alist));
1202 blv->where = where;
1203 blv->found = 1;
1205 if (NILP (tem1))
1207 /* This buffer still sees the default value. */
1209 /* If the variable is a Lisp_Some_Buffer_Local_Value,
1210 or if this is `let' rather than `set',
1211 make CURRENT-ALIST-ELEMENT point to itself,
1212 indicating that we're seeing the default value.
1213 Likewise if the variable has been let-bound
1214 in the current buffer. */
1215 if (bindflag || !blv->local_if_set
1216 || let_shadows_buffer_binding_p (sym))
1218 blv->found = 0;
1219 tem1 = blv->defcell;
1221 /* If it's a local_if_set, being set not bound,
1222 and we're not within a let that was made for this buffer,
1223 create a new buffer-local binding for the variable.
1224 That means, give this buffer a new assoc for a local value
1225 and load that binding. */
1226 else
1228 /* local_if_set is only supported for buffer-local
1229 bindings, not for frame-local bindings. */
1230 eassert (!blv->frame_local);
1231 tem1 = Fcons (symbol, XCDR (blv->defcell));
1232 XBUFFER (where)->local_var_alist
1233 = Fcons (tem1, XBUFFER (where)->local_var_alist);
1237 /* Record which binding is now loaded. */
1238 blv->valcell = tem1;
1241 /* Store the new value in the cons cell. */
1242 SET_BLV_VALUE (blv, newval);
1244 if (blv->fwd)
1246 if (voide)
1247 /* If storing void (making the symbol void), forward only through
1248 buffer-local indicator, not through Lisp_Objfwd, etc. */
1249 blv->fwd = NULL;
1250 else
1251 store_symval_forwarding (blv->fwd, newval,
1252 BUFFERP (where)
1253 ? XBUFFER (where) : current_buffer);
1255 break;
1257 case SYMBOL_FORWARDED:
1259 struct buffer *buf
1260 = BUFFERP (where) ? XBUFFER (where) : current_buffer;
1261 union Lisp_Fwd *innercontents = SYMBOL_FWD (sym);
1262 if (BUFFER_OBJFWDP (innercontents))
1264 int offset = XBUFFER_OBJFWD (innercontents)->offset;
1265 int idx = PER_BUFFER_IDX (offset);
1266 if (idx > 0
1267 && !bindflag
1268 && !let_shadows_buffer_binding_p (sym))
1269 SET_PER_BUFFER_VALUE_P (buf, idx, 1);
1272 if (voide)
1273 { /* If storing void (making the symbol void), forward only through
1274 buffer-local indicator, not through Lisp_Objfwd, etc. */
1275 sym->redirect = SYMBOL_PLAINVAL;
1276 SET_SYMBOL_VAL (sym, newval);
1278 else
1279 store_symval_forwarding (/* sym, */ innercontents, newval, buf);
1280 break;
1282 default: abort ();
1284 return;
1287 /* Access or set a buffer-local symbol's default value. */
1289 /* Return the default value of SYMBOL, but don't check for voidness.
1290 Return Qunbound if it is void. */
1292 Lisp_Object
1293 default_value (Lisp_Object symbol)
1295 struct Lisp_Symbol *sym;
1297 CHECK_SYMBOL (symbol);
1298 sym = XSYMBOL (symbol);
1300 start:
1301 switch (sym->redirect)
1303 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1304 case SYMBOL_PLAINVAL: return SYMBOL_VAL (sym);
1305 case SYMBOL_LOCALIZED:
1307 /* If var is set up for a buffer that lacks a local value for it,
1308 the current value is nominally the default value.
1309 But the `realvalue' slot may be more up to date, since
1310 ordinary setq stores just that slot. So use that. */
1311 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1312 if (blv->fwd && EQ (blv->valcell, blv->defcell))
1313 return do_symval_forwarding (blv->fwd);
1314 else
1315 return XCDR (blv->defcell);
1317 case SYMBOL_FORWARDED:
1319 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1321 /* For a built-in buffer-local variable, get the default value
1322 rather than letting do_symval_forwarding get the current value. */
1323 if (BUFFER_OBJFWDP (valcontents))
1325 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1326 if (PER_BUFFER_IDX (offset) != 0)
1327 return PER_BUFFER_DEFAULT (offset);
1330 /* For other variables, get the current value. */
1331 return do_symval_forwarding (valcontents);
1333 default: abort ();
1337 DEFUN ("default-boundp", Fdefault_boundp, Sdefault_boundp, 1, 1, 0,
1338 doc: /* Return t if SYMBOL has a non-void default value.
1339 This is the value that is seen in buffers that do not have their own values
1340 for this variable. */)
1341 (Lisp_Object symbol)
1343 register Lisp_Object value;
1345 value = default_value (symbol);
1346 return (EQ (value, Qunbound) ? Qnil : Qt);
1349 DEFUN ("default-value", Fdefault_value, Sdefault_value, 1, 1, 0,
1350 doc: /* Return SYMBOL's default value.
1351 This is the value that is seen in buffers that do not have their own values
1352 for this variable. The default value is meaningful for variables with
1353 local bindings in certain buffers. */)
1354 (Lisp_Object symbol)
1356 register Lisp_Object value;
1358 value = default_value (symbol);
1359 if (!EQ (value, Qunbound))
1360 return value;
1362 xsignal1 (Qvoid_variable, symbol);
1365 DEFUN ("set-default", Fset_default, Sset_default, 2, 2, 0,
1366 doc: /* Set SYMBOL's default value to VALUE. SYMBOL and VALUE are evaluated.
1367 The default value is seen in buffers that do not have their own values
1368 for this variable. */)
1369 (Lisp_Object symbol, Lisp_Object value)
1371 struct Lisp_Symbol *sym;
1373 CHECK_SYMBOL (symbol);
1374 if (SYMBOL_CONSTANT_P (symbol))
1376 if (NILP (Fkeywordp (symbol))
1377 || !EQ (value, Fdefault_value (symbol)))
1378 xsignal1 (Qsetting_constant, symbol);
1379 else
1380 /* Allow setting keywords to their own value. */
1381 return value;
1383 sym = XSYMBOL (symbol);
1385 start:
1386 switch (sym->redirect)
1388 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1389 case SYMBOL_PLAINVAL: return Fset (symbol, value);
1390 case SYMBOL_LOCALIZED:
1392 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1394 /* Store new value into the DEFAULT-VALUE slot. */
1395 XSETCDR (blv->defcell, value);
1397 /* If the default binding is now loaded, set the REALVALUE slot too. */
1398 if (blv->fwd && EQ (blv->defcell, blv->valcell))
1399 store_symval_forwarding (blv->fwd, value, NULL);
1400 return value;
1402 case SYMBOL_FORWARDED:
1404 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1406 /* Handle variables like case-fold-search that have special slots
1407 in the buffer.
1408 Make them work apparently like Lisp_Buffer_Local_Value variables. */
1409 if (BUFFER_OBJFWDP (valcontents))
1411 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1412 int idx = PER_BUFFER_IDX (offset);
1414 PER_BUFFER_DEFAULT (offset) = value;
1416 /* If this variable is not always local in all buffers,
1417 set it in the buffers that don't nominally have a local value. */
1418 if (idx > 0)
1420 struct buffer *b;
1422 for (b = all_buffers; b; b = b->next)
1423 if (!PER_BUFFER_VALUE_P (b, idx))
1424 PER_BUFFER_VALUE (b, offset) = value;
1426 return value;
1428 else
1429 return Fset (symbol, value);
1431 default: abort ();
1435 DEFUN ("setq-default", Fsetq_default, Ssetq_default, 0, UNEVALLED, 0,
1436 doc: /* Set the default value of variable VAR to VALUE.
1437 VAR, the variable name, is literal (not evaluated);
1438 VALUE is an expression: it is evaluated and its value returned.
1439 The default value of a variable is seen in buffers
1440 that do not have their own values for the variable.
1442 More generally, you can use multiple variables and values, as in
1443 (setq-default VAR VALUE VAR VALUE...)
1444 This sets each VAR's default value to the corresponding VALUE.
1445 The VALUE for the Nth VAR can refer to the new default values
1446 of previous VARs.
1447 usage: (setq-default [VAR VALUE]...) */)
1448 (Lisp_Object args)
1450 register Lisp_Object args_left;
1451 register Lisp_Object val, symbol;
1452 struct gcpro gcpro1;
1454 if (NILP (args))
1455 return Qnil;
1457 args_left = args;
1458 GCPRO1 (args);
1462 val = Feval (Fcar (Fcdr (args_left)));
1463 symbol = XCAR (args_left);
1464 Fset_default (symbol, val);
1465 args_left = Fcdr (XCDR (args_left));
1467 while (!NILP (args_left));
1469 UNGCPRO;
1470 return val;
1473 /* Lisp functions for creating and removing buffer-local variables. */
1475 union Lisp_Val_Fwd
1477 Lisp_Object value;
1478 union Lisp_Fwd *fwd;
1481 static struct Lisp_Buffer_Local_Value *
1482 make_blv (struct Lisp_Symbol *sym, int forwarded, union Lisp_Val_Fwd valcontents)
1484 struct Lisp_Buffer_Local_Value *blv
1485 = xmalloc (sizeof (struct Lisp_Buffer_Local_Value));
1486 Lisp_Object symbol;
1487 Lisp_Object tem;
1489 XSETSYMBOL (symbol, sym);
1490 tem = Fcons (symbol, (forwarded
1491 ? do_symval_forwarding (valcontents.fwd)
1492 : valcontents.value));
1494 /* Buffer_Local_Values cannot have as realval a buffer-local
1495 or keyboard-local forwarding. */
1496 eassert (!(forwarded && BUFFER_OBJFWDP (valcontents.fwd)));
1497 eassert (!(forwarded && KBOARD_OBJFWDP (valcontents.fwd)));
1498 blv->fwd = forwarded ? valcontents.fwd : NULL;
1499 blv->where = Qnil;
1500 blv->frame_local = 0;
1501 blv->local_if_set = 0;
1502 blv->defcell = tem;
1503 blv->valcell = tem;
1504 SET_BLV_FOUND (blv, 0);
1505 return blv;
1508 DEFUN ("make-variable-buffer-local", Fmake_variable_buffer_local, Smake_variable_buffer_local,
1509 1, 1, "vMake Variable Buffer Local: ",
1510 doc: /* Make VARIABLE become buffer-local whenever it is set.
1511 At any time, the value for the current buffer is in effect,
1512 unless the variable has never been set in this buffer,
1513 in which case the default value is in effect.
1514 Note that binding the variable with `let', or setting it while
1515 a `let'-style binding made in this buffer is in effect,
1516 does not make the variable buffer-local. Return VARIABLE.
1518 In most cases it is better to use `make-local-variable',
1519 which makes a variable local in just one buffer.
1521 The function `default-value' gets the default value and `set-default' sets it. */)
1522 (register Lisp_Object variable)
1524 struct Lisp_Symbol *sym;
1525 struct Lisp_Buffer_Local_Value *blv = NULL;
1526 union Lisp_Val_Fwd valcontents;
1527 int forwarded;
1529 CHECK_SYMBOL (variable);
1530 sym = XSYMBOL (variable);
1532 start:
1533 switch (sym->redirect)
1535 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1536 case SYMBOL_PLAINVAL:
1537 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1538 if (EQ (valcontents.value, Qunbound))
1539 valcontents.value = Qnil;
1540 break;
1541 case SYMBOL_LOCALIZED:
1542 blv = SYMBOL_BLV (sym);
1543 if (blv->frame_local)
1544 error ("Symbol %s may not be buffer-local",
1545 SDATA (SYMBOL_NAME (variable)));
1546 break;
1547 case SYMBOL_FORWARDED:
1548 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1549 if (KBOARD_OBJFWDP (valcontents.fwd))
1550 error ("Symbol %s may not be buffer-local",
1551 SDATA (SYMBOL_NAME (variable)));
1552 else if (BUFFER_OBJFWDP (valcontents.fwd))
1553 return variable;
1554 break;
1555 default: abort ();
1558 if (sym->constant)
1559 error ("Symbol %s may not be buffer-local", SDATA (SYMBOL_NAME (variable)));
1561 if (!blv)
1563 blv = make_blv (sym, forwarded, valcontents);
1564 sym->redirect = SYMBOL_LOCALIZED;
1565 SET_SYMBOL_BLV (sym, blv);
1567 Lisp_Object symbol;
1568 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1569 if (let_shadows_global_binding_p (symbol))
1570 message ("Making %s buffer-local while let-bound!",
1571 SDATA (SYMBOL_NAME (variable)));
1575 blv->local_if_set = 1;
1576 return variable;
1579 DEFUN ("make-local-variable", Fmake_local_variable, Smake_local_variable,
1580 1, 1, "vMake Local Variable: ",
1581 doc: /* Make VARIABLE have a separate value in the current buffer.
1582 Other buffers will continue to share a common default value.
1583 \(The buffer-local value of VARIABLE starts out as the same value
1584 VARIABLE previously had. If VARIABLE was void, it remains void.\)
1585 Return VARIABLE.
1587 If the variable is already arranged to become local when set,
1588 this function causes a local value to exist for this buffer,
1589 just as setting the variable would do.
1591 This function returns VARIABLE, and therefore
1592 (set (make-local-variable 'VARIABLE) VALUE-EXP)
1593 works.
1595 See also `make-variable-buffer-local'.
1597 Do not use `make-local-variable' to make a hook variable buffer-local.
1598 Instead, use `add-hook' and specify t for the LOCAL argument. */)
1599 (register Lisp_Object variable)
1601 register Lisp_Object tem;
1602 int forwarded;
1603 union Lisp_Val_Fwd valcontents;
1604 struct Lisp_Symbol *sym;
1605 struct Lisp_Buffer_Local_Value *blv = NULL;
1607 CHECK_SYMBOL (variable);
1608 sym = XSYMBOL (variable);
1610 start:
1611 switch (sym->redirect)
1613 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1614 case SYMBOL_PLAINVAL:
1615 forwarded = 0; valcontents.value = SYMBOL_VAL (sym); break;
1616 case SYMBOL_LOCALIZED:
1617 blv = SYMBOL_BLV (sym);
1618 if (blv->frame_local)
1619 error ("Symbol %s may not be buffer-local",
1620 SDATA (SYMBOL_NAME (variable)));
1621 break;
1622 case SYMBOL_FORWARDED:
1623 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1624 if (KBOARD_OBJFWDP (valcontents.fwd))
1625 error ("Symbol %s may not be buffer-local",
1626 SDATA (SYMBOL_NAME (variable)));
1627 break;
1628 default: abort ();
1631 if (sym->constant)
1632 error ("Symbol %s may not be buffer-local",
1633 SDATA (SYMBOL_NAME (variable)));
1635 if (blv ? blv->local_if_set
1636 : (forwarded && BUFFER_OBJFWDP (valcontents.fwd)))
1638 tem = Fboundp (variable);
1639 /* Make sure the symbol has a local value in this particular buffer,
1640 by setting it to the same value it already has. */
1641 Fset (variable, (EQ (tem, Qt) ? Fsymbol_value (variable) : Qunbound));
1642 return variable;
1644 if (!blv)
1646 blv = make_blv (sym, forwarded, valcontents);
1647 sym->redirect = SYMBOL_LOCALIZED;
1648 SET_SYMBOL_BLV (sym, blv);
1650 Lisp_Object symbol;
1651 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1652 if (let_shadows_global_binding_p (symbol))
1653 message ("Making %s local to %s while let-bound!",
1654 SDATA (SYMBOL_NAME (variable)),
1655 SDATA (current_buffer->name));
1659 /* Make sure this buffer has its own value of symbol. */
1660 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1661 tem = Fassq (variable, current_buffer->local_var_alist);
1662 if (NILP (tem))
1664 if (let_shadows_buffer_binding_p (sym))
1665 message ("Making %s buffer-local while locally let-bound!",
1666 SDATA (SYMBOL_NAME (variable)));
1668 /* Swap out any local binding for some other buffer, and make
1669 sure the current value is permanently recorded, if it's the
1670 default value. */
1671 find_symbol_value (variable);
1673 current_buffer->local_var_alist
1674 = Fcons (Fcons (variable, XCDR (blv->defcell)),
1675 current_buffer->local_var_alist);
1677 /* Make sure symbol does not think it is set up for this buffer;
1678 force it to look once again for this buffer's value. */
1679 if (current_buffer == XBUFFER (blv->where))
1680 blv->where = Qnil;
1681 /* blv->valcell = blv->defcell;
1682 * SET_BLV_FOUND (blv, 0); */
1683 blv->found = 0;
1686 /* If the symbol forwards into a C variable, then load the binding
1687 for this buffer now. If C code modifies the variable before we
1688 load the binding in, then that new value will clobber the default
1689 binding the next time we unload it. */
1690 if (blv->fwd)
1691 swap_in_symval_forwarding (sym, blv);
1693 return variable;
1696 DEFUN ("kill-local-variable", Fkill_local_variable, Skill_local_variable,
1697 1, 1, "vKill Local Variable: ",
1698 doc: /* Make VARIABLE no longer have a separate value in the current buffer.
1699 From now on the default value will apply in this buffer. Return VARIABLE. */)
1700 (register Lisp_Object variable)
1702 register Lisp_Object tem;
1703 struct Lisp_Buffer_Local_Value *blv;
1704 struct Lisp_Symbol *sym;
1706 CHECK_SYMBOL (variable);
1707 sym = XSYMBOL (variable);
1709 start:
1710 switch (sym->redirect)
1712 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1713 case SYMBOL_PLAINVAL: return variable;
1714 case SYMBOL_FORWARDED:
1716 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1717 if (BUFFER_OBJFWDP (valcontents))
1719 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1720 int idx = PER_BUFFER_IDX (offset);
1722 if (idx > 0)
1724 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 0);
1725 PER_BUFFER_VALUE (current_buffer, offset)
1726 = PER_BUFFER_DEFAULT (offset);
1729 return variable;
1731 case SYMBOL_LOCALIZED:
1732 blv = SYMBOL_BLV (sym);
1733 if (blv->frame_local)
1734 return variable;
1735 break;
1736 default: abort ();
1739 /* Get rid of this buffer's alist element, if any. */
1740 XSETSYMBOL (variable, sym); /* Propagate variable indirection. */
1741 tem = Fassq (variable, current_buffer->local_var_alist);
1742 if (!NILP (tem))
1743 current_buffer->local_var_alist
1744 = Fdelq (tem, current_buffer->local_var_alist);
1746 /* If the symbol is set up with the current buffer's binding
1747 loaded, recompute its value. We have to do it now, or else
1748 forwarded objects won't work right. */
1750 Lisp_Object buf; XSETBUFFER (buf, current_buffer);
1751 if (EQ (buf, blv->where))
1753 blv->where = Qnil;
1754 /* blv->valcell = blv->defcell;
1755 * SET_BLV_FOUND (blv, 0); */
1756 blv->found = 0;
1757 find_symbol_value (variable);
1761 return variable;
1764 /* Lisp functions for creating and removing buffer-local variables. */
1766 /* Obsolete since 22.2. NB adjust doc of modify-frame-parameters
1767 when/if this is removed. */
1769 DEFUN ("make-variable-frame-local", Fmake_variable_frame_local, Smake_variable_frame_local,
1770 1, 1, "vMake Variable Frame Local: ",
1771 doc: /* Enable VARIABLE to have frame-local bindings.
1772 This does not create any frame-local bindings for VARIABLE,
1773 it just makes them possible.
1775 A frame-local binding is actually a frame parameter value.
1776 If a frame F has a value for the frame parameter named VARIABLE,
1777 that also acts as a frame-local binding for VARIABLE in F--
1778 provided this function has been called to enable VARIABLE
1779 to have frame-local bindings at all.
1781 The only way to create a frame-local binding for VARIABLE in a frame
1782 is to set the VARIABLE frame parameter of that frame. See
1783 `modify-frame-parameters' for how to set frame parameters.
1785 Note that since Emacs 23.1, variables cannot be both buffer-local and
1786 frame-local any more (buffer-local bindings used to take precedence over
1787 frame-local bindings). */)
1788 (register Lisp_Object variable)
1790 int forwarded;
1791 union Lisp_Val_Fwd valcontents;
1792 struct Lisp_Symbol *sym;
1793 struct Lisp_Buffer_Local_Value *blv = NULL;
1795 CHECK_SYMBOL (variable);
1796 sym = XSYMBOL (variable);
1798 start:
1799 switch (sym->redirect)
1801 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1802 case SYMBOL_PLAINVAL:
1803 forwarded = 0; valcontents.value = SYMBOL_VAL (sym);
1804 if (EQ (valcontents.value, Qunbound))
1805 valcontents.value = Qnil;
1806 break;
1807 case SYMBOL_LOCALIZED:
1808 if (SYMBOL_BLV (sym)->frame_local)
1809 return variable;
1810 else
1811 error ("Symbol %s may not be frame-local",
1812 SDATA (SYMBOL_NAME (variable)));
1813 case SYMBOL_FORWARDED:
1814 forwarded = 1; valcontents.fwd = SYMBOL_FWD (sym);
1815 if (KBOARD_OBJFWDP (valcontents.fwd) || BUFFER_OBJFWDP (valcontents.fwd))
1816 error ("Symbol %s may not be frame-local",
1817 SDATA (SYMBOL_NAME (variable)));
1818 break;
1819 default: abort ();
1822 if (sym->constant)
1823 error ("Symbol %s may not be frame-local", SDATA (SYMBOL_NAME (variable)));
1825 blv = make_blv (sym, forwarded, valcontents);
1826 blv->frame_local = 1;
1827 sym->redirect = SYMBOL_LOCALIZED;
1828 SET_SYMBOL_BLV (sym, blv);
1830 Lisp_Object symbol;
1831 XSETSYMBOL (symbol, sym); /* In case `variable' is aliased. */
1832 if (let_shadows_global_binding_p (symbol))
1833 message ("Making %s frame-local while let-bound!",
1834 SDATA (SYMBOL_NAME (variable)));
1836 return variable;
1839 DEFUN ("local-variable-p", Flocal_variable_p, Slocal_variable_p,
1840 1, 2, 0,
1841 doc: /* Non-nil if VARIABLE has a local binding in buffer BUFFER.
1842 BUFFER defaults to the current buffer. */)
1843 (register Lisp_Object variable, Lisp_Object buffer)
1845 register struct buffer *buf;
1846 struct Lisp_Symbol *sym;
1848 if (NILP (buffer))
1849 buf = current_buffer;
1850 else
1852 CHECK_BUFFER (buffer);
1853 buf = XBUFFER (buffer);
1856 CHECK_SYMBOL (variable);
1857 sym = XSYMBOL (variable);
1859 start:
1860 switch (sym->redirect)
1862 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1863 case SYMBOL_PLAINVAL: return Qnil;
1864 case SYMBOL_LOCALIZED:
1866 Lisp_Object tail, elt, tmp;
1867 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1868 XSETBUFFER (tmp, buf);
1870 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1872 elt = XCAR (tail);
1873 if (EQ (variable, XCAR (elt)))
1875 eassert (!blv->frame_local);
1876 eassert (BLV_FOUND (blv) || !EQ (blv->where, tmp));
1877 return Qt;
1880 eassert (!BLV_FOUND (blv) || !EQ (blv->where, tmp));
1881 return Qnil;
1883 case SYMBOL_FORWARDED:
1885 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1886 if (BUFFER_OBJFWDP (valcontents))
1888 int offset = XBUFFER_OBJFWD (valcontents)->offset;
1889 int idx = PER_BUFFER_IDX (offset);
1890 if (idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1891 return Qt;
1893 return Qnil;
1895 default: abort ();
1899 DEFUN ("local-variable-if-set-p", Flocal_variable_if_set_p, Slocal_variable_if_set_p,
1900 1, 2, 0,
1901 doc: /* Non-nil if VARIABLE will be local in buffer BUFFER when set there.
1902 More precisely, this means that setting the variable \(with `set' or`setq'),
1903 while it does not have a `let'-style binding that was made in BUFFER,
1904 will produce a buffer local binding. See Info node
1905 `(elisp)Creating Buffer-Local'.
1906 BUFFER defaults to the current buffer. */)
1907 (register Lisp_Object variable, Lisp_Object buffer)
1909 struct Lisp_Symbol *sym;
1911 CHECK_SYMBOL (variable);
1912 sym = XSYMBOL (variable);
1914 start:
1915 switch (sym->redirect)
1917 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1918 case SYMBOL_PLAINVAL: return Qnil;
1919 case SYMBOL_LOCALIZED:
1921 struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
1922 if (blv->local_if_set)
1923 return Qt;
1924 XSETSYMBOL (variable, sym); /* Update in case of aliasing. */
1925 return Flocal_variable_p (variable, buffer);
1927 case SYMBOL_FORWARDED:
1928 /* All BUFFER_OBJFWD slots become local if they are set. */
1929 return (BUFFER_OBJFWDP (SYMBOL_FWD (sym)) ? Qt : Qnil);
1930 default: abort ();
1934 DEFUN ("variable-binding-locus", Fvariable_binding_locus, Svariable_binding_locus,
1935 1, 1, 0,
1936 doc: /* Return a value indicating where VARIABLE's current binding comes from.
1937 If the current binding is buffer-local, the value is the current buffer.
1938 If the current binding is frame-local, the value is the selected frame.
1939 If the current binding is global (the default), the value is nil. */)
1940 (register Lisp_Object variable)
1942 struct Lisp_Symbol *sym;
1944 CHECK_SYMBOL (variable);
1945 sym = XSYMBOL (variable);
1947 /* Make sure the current binding is actually swapped in. */
1948 find_symbol_value (variable);
1950 start:
1951 switch (sym->redirect)
1953 case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
1954 case SYMBOL_PLAINVAL: return Qnil;
1955 case SYMBOL_FORWARDED:
1957 union Lisp_Fwd *valcontents = SYMBOL_FWD (sym);
1958 if (KBOARD_OBJFWDP (valcontents))
1959 return Fframe_terminal (Fselected_frame ());
1960 else if (!BUFFER_OBJFWDP (valcontents))
1961 return Qnil;
1963 /* FALLTHROUGH */
1964 case SYMBOL_LOCALIZED:
1965 /* For a local variable, record both the symbol and which
1966 buffer's or frame's value we are saving. */
1967 if (!NILP (Flocal_variable_p (variable, Qnil)))
1968 return Fcurrent_buffer ();
1969 else if (sym->redirect == SYMBOL_LOCALIZED
1970 && BLV_FOUND (SYMBOL_BLV (sym)))
1971 return SYMBOL_BLV (sym)->where;
1972 else
1973 return Qnil;
1974 default: abort ();
1978 /* This code is disabled now that we use the selected frame to return
1979 keyboard-local-values. */
1980 #if 0
1981 extern struct terminal *get_terminal (Lisp_Object display, int);
1983 DEFUN ("terminal-local-value", Fterminal_local_value, Sterminal_local_value, 2, 2, 0,
1984 doc: /* Return the terminal-local value of SYMBOL on TERMINAL.
1985 If SYMBOL is not a terminal-local variable, then return its normal
1986 value, like `symbol-value'.
1988 TERMINAL may be a terminal object, a frame, or nil (meaning the
1989 selected frame's terminal device). */)
1990 (Lisp_Object symbol, Lisp_Object terminal)
1992 Lisp_Object result;
1993 struct terminal *t = get_terminal (terminal, 1);
1994 push_kboard (t->kboard);
1995 result = Fsymbol_value (symbol);
1996 pop_kboard ();
1997 return result;
2000 DEFUN ("set-terminal-local-value", Fset_terminal_local_value, Sset_terminal_local_value, 3, 3, 0,
2001 doc: /* Set the terminal-local binding of SYMBOL on TERMINAL to VALUE.
2002 If VARIABLE is not a terminal-local variable, then set its normal
2003 binding, like `set'.
2005 TERMINAL may be a terminal object, a frame, or nil (meaning the
2006 selected frame's terminal device). */)
2007 (Lisp_Object symbol, Lisp_Object terminal, Lisp_Object value)
2009 Lisp_Object result;
2010 struct terminal *t = get_terminal (terminal, 1);
2011 push_kboard (d->kboard);
2012 result = Fset (symbol, value);
2013 pop_kboard ();
2014 return result;
2016 #endif
2018 /* Find the function at the end of a chain of symbol function indirections. */
2020 /* If OBJECT is a symbol, find the end of its function chain and
2021 return the value found there. If OBJECT is not a symbol, just
2022 return it. If there is a cycle in the function chain, signal a
2023 cyclic-function-indirection error.
2025 This is like Findirect_function, except that it doesn't signal an
2026 error if the chain ends up unbound. */
2027 Lisp_Object
2028 indirect_function (register Lisp_Object object)
2030 Lisp_Object tortoise, hare;
2032 hare = tortoise = object;
2034 for (;;)
2036 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2037 break;
2038 hare = XSYMBOL (hare)->function;
2039 if (!SYMBOLP (hare) || EQ (hare, Qunbound))
2040 break;
2041 hare = XSYMBOL (hare)->function;
2043 tortoise = XSYMBOL (tortoise)->function;
2045 if (EQ (hare, tortoise))
2046 xsignal1 (Qcyclic_function_indirection, object);
2049 return hare;
2052 DEFUN ("indirect-function", Findirect_function, Sindirect_function, 1, 2, 0,
2053 doc: /* Return the function at the end of OBJECT's function chain.
2054 If OBJECT is not a symbol, just return it. Otherwise, follow all
2055 function indirections to find the final function binding and return it.
2056 If the final symbol in the chain is unbound, signal a void-function error.
2057 Optional arg NOERROR non-nil means to return nil instead of signalling.
2058 Signal a cyclic-function-indirection error if there is a loop in the
2059 function chain of symbols. */)
2060 (register Lisp_Object object, Lisp_Object noerror)
2062 Lisp_Object result;
2064 /* Optimize for no indirection. */
2065 result = object;
2066 if (SYMBOLP (result) && !EQ (result, Qunbound)
2067 && (result = XSYMBOL (result)->function, SYMBOLP (result)))
2068 result = indirect_function (result);
2069 if (!EQ (result, Qunbound))
2070 return result;
2072 if (NILP (noerror))
2073 xsignal1 (Qvoid_function, object);
2075 return Qnil;
2078 /* Extract and set vector and string elements */
2080 DEFUN ("aref", Faref, Saref, 2, 2, 0,
2081 doc: /* Return the element of ARRAY at index IDX.
2082 ARRAY may be a vector, a string, a char-table, a bool-vector,
2083 or a byte-code object. IDX starts at 0. */)
2084 (register Lisp_Object array, Lisp_Object idx)
2086 register int idxval;
2088 CHECK_NUMBER (idx);
2089 idxval = XINT (idx);
2090 if (STRINGP (array))
2092 int c, idxval_byte;
2094 if (idxval < 0 || idxval >= SCHARS (array))
2095 args_out_of_range (array, idx);
2096 if (! STRING_MULTIBYTE (array))
2097 return make_number ((unsigned char) SREF (array, idxval));
2098 idxval_byte = string_char_to_byte (array, idxval);
2100 c = STRING_CHAR (SDATA (array) + idxval_byte);
2101 return make_number (c);
2103 else if (BOOL_VECTOR_P (array))
2105 int val;
2107 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2108 args_out_of_range (array, idx);
2110 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2111 return (val & (1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR)) ? Qt : Qnil);
2113 else if (CHAR_TABLE_P (array))
2115 CHECK_CHARACTER (idx);
2116 return CHAR_TABLE_REF (array, idxval);
2118 else
2120 int size = 0;
2121 if (VECTORP (array))
2122 size = XVECTOR (array)->size;
2123 else if (COMPILEDP (array))
2124 size = XVECTOR (array)->size & PSEUDOVECTOR_SIZE_MASK;
2125 else
2126 wrong_type_argument (Qarrayp, array);
2128 if (idxval < 0 || idxval >= size)
2129 args_out_of_range (array, idx);
2130 return XVECTOR (array)->contents[idxval];
2134 DEFUN ("aset", Faset, Saset, 3, 3, 0,
2135 doc: /* Store into the element of ARRAY at index IDX the value NEWELT.
2136 Return NEWELT. ARRAY may be a vector, a string, a char-table or a
2137 bool-vector. IDX starts at 0. */)
2138 (register Lisp_Object array, Lisp_Object idx, Lisp_Object newelt)
2140 register int idxval;
2142 CHECK_NUMBER (idx);
2143 idxval = XINT (idx);
2144 CHECK_ARRAY (array, Qarrayp);
2145 CHECK_IMPURE (array);
2147 if (VECTORP (array))
2149 if (idxval < 0 || idxval >= XVECTOR (array)->size)
2150 args_out_of_range (array, idx);
2151 XVECTOR (array)->contents[idxval] = newelt;
2153 else if (BOOL_VECTOR_P (array))
2155 int val;
2157 if (idxval < 0 || idxval >= XBOOL_VECTOR (array)->size)
2158 args_out_of_range (array, idx);
2160 val = (unsigned char) XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR];
2162 if (! NILP (newelt))
2163 val |= 1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR);
2164 else
2165 val &= ~(1 << (idxval % BOOL_VECTOR_BITS_PER_CHAR));
2166 XBOOL_VECTOR (array)->data[idxval / BOOL_VECTOR_BITS_PER_CHAR] = val;
2168 else if (CHAR_TABLE_P (array))
2170 CHECK_CHARACTER (idx);
2171 CHAR_TABLE_SET (array, idxval, newelt);
2173 else if (STRING_MULTIBYTE (array))
2175 int idxval_byte, prev_bytes, new_bytes, nbytes;
2176 unsigned char workbuf[MAX_MULTIBYTE_LENGTH], *p0 = workbuf, *p1;
2178 if (idxval < 0 || idxval >= SCHARS (array))
2179 args_out_of_range (array, idx);
2180 CHECK_CHARACTER (newelt);
2182 nbytes = SBYTES (array);
2184 idxval_byte = string_char_to_byte (array, idxval);
2185 p1 = SDATA (array) + idxval_byte;
2186 prev_bytes = BYTES_BY_CHAR_HEAD (*p1);
2187 new_bytes = CHAR_STRING (XINT (newelt), p0);
2188 if (prev_bytes != new_bytes)
2190 /* We must relocate the string data. */
2191 int nchars = SCHARS (array);
2192 unsigned char *str;
2193 USE_SAFE_ALLOCA;
2195 SAFE_ALLOCA (str, unsigned char *, nbytes);
2196 memcpy (str, SDATA (array), nbytes);
2197 allocate_string_data (XSTRING (array), nchars,
2198 nbytes + new_bytes - prev_bytes);
2199 memcpy (SDATA (array), str, idxval_byte);
2200 p1 = SDATA (array) + idxval_byte;
2201 memcpy (p1 + new_bytes, str + idxval_byte + prev_bytes,
2202 nbytes - (idxval_byte + prev_bytes));
2203 SAFE_FREE ();
2204 clear_string_char_byte_cache ();
2206 while (new_bytes--)
2207 *p1++ = *p0++;
2209 else
2211 if (idxval < 0 || idxval >= SCHARS (array))
2212 args_out_of_range (array, idx);
2213 CHECK_NUMBER (newelt);
2215 if (XINT (newelt) >= 0 && ! SINGLE_BYTE_CHAR_P (XINT (newelt)))
2217 int i;
2219 for (i = SBYTES (array) - 1; i >= 0; i--)
2220 if (SREF (array, i) >= 0x80)
2221 args_out_of_range (array, newelt);
2222 /* ARRAY is an ASCII string. Convert it to a multibyte
2223 string, and try `aset' again. */
2224 STRING_SET_MULTIBYTE (array);
2225 return Faset (array, idx, newelt);
2227 SSET (array, idxval, XINT (newelt));
2230 return newelt;
2233 /* Arithmetic functions */
2235 enum comparison { equal, notequal, less, grtr, less_or_equal, grtr_or_equal };
2237 Lisp_Object
2238 arithcompare (Lisp_Object num1, Lisp_Object num2, enum comparison comparison)
2240 double f1 = 0, f2 = 0;
2241 int floatp = 0;
2243 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num1);
2244 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (num2);
2246 if (FLOATP (num1) || FLOATP (num2))
2248 floatp = 1;
2249 f1 = (FLOATP (num1)) ? XFLOAT_DATA (num1) : XINT (num1);
2250 f2 = (FLOATP (num2)) ? XFLOAT_DATA (num2) : XINT (num2);
2253 switch (comparison)
2255 case equal:
2256 if (floatp ? f1 == f2 : XINT (num1) == XINT (num2))
2257 return Qt;
2258 return Qnil;
2260 case notequal:
2261 if (floatp ? f1 != f2 : XINT (num1) != XINT (num2))
2262 return Qt;
2263 return Qnil;
2265 case less:
2266 if (floatp ? f1 < f2 : XINT (num1) < XINT (num2))
2267 return Qt;
2268 return Qnil;
2270 case less_or_equal:
2271 if (floatp ? f1 <= f2 : XINT (num1) <= XINT (num2))
2272 return Qt;
2273 return Qnil;
2275 case grtr:
2276 if (floatp ? f1 > f2 : XINT (num1) > XINT (num2))
2277 return Qt;
2278 return Qnil;
2280 case grtr_or_equal:
2281 if (floatp ? f1 >= f2 : XINT (num1) >= XINT (num2))
2282 return Qt;
2283 return Qnil;
2285 default:
2286 abort ();
2290 DEFUN ("=", Feqlsign, Seqlsign, 2, 2, 0,
2291 doc: /* Return t if two args, both numbers or markers, are equal. */)
2292 (register Lisp_Object num1, Lisp_Object num2)
2294 return arithcompare (num1, num2, equal);
2297 DEFUN ("<", Flss, Slss, 2, 2, 0,
2298 doc: /* Return t if first arg is less than second arg. Both must be numbers or markers. */)
2299 (register Lisp_Object num1, Lisp_Object num2)
2301 return arithcompare (num1, num2, less);
2304 DEFUN (">", Fgtr, Sgtr, 2, 2, 0,
2305 doc: /* Return t if first arg is greater than second arg. Both must be numbers or markers. */)
2306 (register Lisp_Object num1, Lisp_Object num2)
2308 return arithcompare (num1, num2, grtr);
2311 DEFUN ("<=", Fleq, Sleq, 2, 2, 0,
2312 doc: /* Return t if first arg is less than or equal to second arg.
2313 Both must be numbers or markers. */)
2314 (register Lisp_Object num1, Lisp_Object num2)
2316 return arithcompare (num1, num2, less_or_equal);
2319 DEFUN (">=", Fgeq, Sgeq, 2, 2, 0,
2320 doc: /* Return t if first arg is greater than or equal to second arg.
2321 Both must be numbers or markers. */)
2322 (register Lisp_Object num1, Lisp_Object num2)
2324 return arithcompare (num1, num2, grtr_or_equal);
2327 DEFUN ("/=", Fneq, Sneq, 2, 2, 0,
2328 doc: /* Return t if first arg is not equal to second arg. Both must be numbers or markers. */)
2329 (register Lisp_Object num1, Lisp_Object num2)
2331 return arithcompare (num1, num2, notequal);
2334 DEFUN ("zerop", Fzerop, Szerop, 1, 1, 0,
2335 doc: /* Return t if NUMBER is zero. */)
2336 (register Lisp_Object number)
2338 CHECK_NUMBER_OR_FLOAT (number);
2340 if (FLOATP (number))
2342 if (XFLOAT_DATA (number) == 0.0)
2343 return Qt;
2344 return Qnil;
2347 if (!XINT (number))
2348 return Qt;
2349 return Qnil;
2352 /* Convert between long values and pairs of Lisp integers.
2353 Note that long_to_cons returns a single Lisp integer
2354 when the value fits in one. */
2356 Lisp_Object
2357 long_to_cons (long unsigned int i)
2359 unsigned long top = i >> 16;
2360 unsigned int bot = i & 0xFFFF;
2361 if (top == 0)
2362 return make_number (bot);
2363 if (top == (unsigned long)-1 >> 16)
2364 return Fcons (make_number (-1), make_number (bot));
2365 return Fcons (make_number (top), make_number (bot));
2368 unsigned long
2369 cons_to_long (Lisp_Object c)
2371 Lisp_Object top, bot;
2372 if (INTEGERP (c))
2373 return XINT (c);
2374 top = XCAR (c);
2375 bot = XCDR (c);
2376 if (CONSP (bot))
2377 bot = XCAR (bot);
2378 return ((XINT (top) << 16) | XINT (bot));
2381 DEFUN ("number-to-string", Fnumber_to_string, Snumber_to_string, 1, 1, 0,
2382 doc: /* Return the decimal representation of NUMBER as a string.
2383 Uses a minus sign if negative.
2384 NUMBER may be an integer or a floating point number. */)
2385 (Lisp_Object number)
2387 char buffer[VALBITS];
2389 CHECK_NUMBER_OR_FLOAT (number);
2391 if (FLOATP (number))
2393 char pigbuf[350]; /* see comments in float_to_string */
2395 float_to_string (pigbuf, XFLOAT_DATA (number));
2396 return build_string (pigbuf);
2399 if (sizeof (int) == sizeof (EMACS_INT))
2400 sprintf (buffer, "%d", (int) XINT (number));
2401 else if (sizeof (long) == sizeof (EMACS_INT))
2402 sprintf (buffer, "%ld", (long) XINT (number));
2403 else
2404 abort ();
2405 return build_string (buffer);
2408 INLINE static int
2409 digit_to_number (int character, int base)
2411 int digit;
2413 if (character >= '0' && character <= '9')
2414 digit = character - '0';
2415 else if (character >= 'a' && character <= 'z')
2416 digit = character - 'a' + 10;
2417 else if (character >= 'A' && character <= 'Z')
2418 digit = character - 'A' + 10;
2419 else
2420 return -1;
2422 if (digit >= base)
2423 return -1;
2424 else
2425 return digit;
2428 DEFUN ("string-to-number", Fstring_to_number, Sstring_to_number, 1, 2, 0,
2429 doc: /* Parse STRING as a decimal number and return the number.
2430 This parses both integers and floating point numbers.
2431 It ignores leading spaces and tabs, and all trailing chars.
2433 If BASE, interpret STRING as a number in that base. If BASE isn't
2434 present, base 10 is used. BASE must be between 2 and 16 (inclusive).
2435 If the base used is not 10, STRING is always parsed as integer. */)
2436 (register Lisp_Object string, Lisp_Object base)
2438 register unsigned char *p;
2439 register int b;
2440 int sign = 1;
2441 Lisp_Object val;
2443 CHECK_STRING (string);
2445 if (NILP (base))
2446 b = 10;
2447 else
2449 CHECK_NUMBER (base);
2450 b = XINT (base);
2451 if (b < 2 || b > 16)
2452 xsignal1 (Qargs_out_of_range, base);
2455 /* Skip any whitespace at the front of the number. Some versions of
2456 atoi do this anyway, so we might as well make Emacs lisp consistent. */
2457 p = SDATA (string);
2458 while (*p == ' ' || *p == '\t')
2459 p++;
2461 if (*p == '-')
2463 sign = -1;
2464 p++;
2466 else if (*p == '+')
2467 p++;
2469 if (isfloat_string (p, 1) && b == 10)
2470 val = make_float (sign * atof (p));
2471 else
2473 double v = 0;
2475 while (1)
2477 int digit = digit_to_number (*p++, b);
2478 if (digit < 0)
2479 break;
2480 v = v * b + digit;
2483 val = make_fixnum_or_float (sign * v);
2486 return 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, int, enum arithop,
2504 int, Lisp_Object *);
2505 extern Lisp_Object fmod_float (Lisp_Object, Lisp_Object);
2507 Lisp_Object
2508 arith_driver (enum arithop code, int nargs, register Lisp_Object *args)
2510 register Lisp_Object val;
2511 register int argnum;
2512 register EMACS_INT accum = 0;
2513 register EMACS_INT next;
2515 switch (SWITCH_ENUM_CAST (code))
2517 case Alogior:
2518 case Alogxor:
2519 case Aadd:
2520 case Asub:
2521 accum = 0;
2522 break;
2523 case Amult:
2524 accum = 1;
2525 break;
2526 case Alogand:
2527 accum = -1;
2528 break;
2529 default:
2530 break;
2533 for (argnum = 0; argnum < nargs; argnum++)
2535 /* Using args[argnum] as argument to CHECK_NUMBER_... */
2536 val = args[argnum];
2537 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2539 if (FLOATP (val))
2540 return float_arith_driver ((double) accum, argnum, code,
2541 nargs, args);
2542 args[argnum] = val;
2543 next = XINT (args[argnum]);
2544 switch (SWITCH_ENUM_CAST (code))
2546 case Aadd:
2547 accum += next;
2548 break;
2549 case Asub:
2550 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2551 break;
2552 case Amult:
2553 accum *= next;
2554 break;
2555 case Adiv:
2556 if (!argnum)
2557 accum = next;
2558 else
2560 if (next == 0)
2561 xsignal0 (Qarith_error);
2562 accum /= next;
2564 break;
2565 case Alogand:
2566 accum &= next;
2567 break;
2568 case Alogior:
2569 accum |= next;
2570 break;
2571 case Alogxor:
2572 accum ^= next;
2573 break;
2574 case Amax:
2575 if (!argnum || next > accum)
2576 accum = next;
2577 break;
2578 case Amin:
2579 if (!argnum || next < accum)
2580 accum = next;
2581 break;
2585 XSETINT (val, accum);
2586 return val;
2589 #undef isnan
2590 #define isnan(x) ((x) != (x))
2592 static Lisp_Object
2593 float_arith_driver (double accum, register int argnum, enum arithop code, int nargs, register Lisp_Object *args)
2595 register Lisp_Object val;
2596 double next;
2598 for (; argnum < nargs; argnum++)
2600 val = args[argnum]; /* using args[argnum] as argument to CHECK_NUMBER_... */
2601 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (val);
2603 if (FLOATP (val))
2605 next = XFLOAT_DATA (val);
2607 else
2609 args[argnum] = val; /* runs into a compiler bug. */
2610 next = XINT (args[argnum]);
2612 switch (SWITCH_ENUM_CAST (code))
2614 case Aadd:
2615 accum += next;
2616 break;
2617 case Asub:
2618 accum = argnum ? accum - next : nargs == 1 ? - next : next;
2619 break;
2620 case Amult:
2621 accum *= next;
2622 break;
2623 case Adiv:
2624 if (!argnum)
2625 accum = next;
2626 else
2628 if (! IEEE_FLOATING_POINT && next == 0)
2629 xsignal0 (Qarith_error);
2630 accum /= next;
2632 break;
2633 case Alogand:
2634 case Alogior:
2635 case Alogxor:
2636 return wrong_type_argument (Qinteger_or_marker_p, val);
2637 case Amax:
2638 if (!argnum || isnan (next) || next > accum)
2639 accum = next;
2640 break;
2641 case Amin:
2642 if (!argnum || isnan (next) || next < accum)
2643 accum = next;
2644 break;
2648 return make_float (accum);
2652 DEFUN ("+", Fplus, Splus, 0, MANY, 0,
2653 doc: /* Return sum of any number of arguments, which are numbers or markers.
2654 usage: (+ &rest NUMBERS-OR-MARKERS) */)
2655 (int nargs, Lisp_Object *args)
2657 return arith_driver (Aadd, nargs, args);
2660 DEFUN ("-", Fminus, Sminus, 0, MANY, 0,
2661 doc: /* Negate number or subtract numbers or markers and return the result.
2662 With one arg, negates it. With more than one arg,
2663 subtracts all but the first from the first.
2664 usage: (- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS) */)
2665 (int nargs, Lisp_Object *args)
2667 return arith_driver (Asub, nargs, args);
2670 DEFUN ("*", Ftimes, Stimes, 0, MANY, 0,
2671 doc: /* Return product of any number of arguments, which are numbers or markers.
2672 usage: (* &rest NUMBERS-OR-MARKERS) */)
2673 (int nargs, Lisp_Object *args)
2675 return arith_driver (Amult, nargs, args);
2678 DEFUN ("/", Fquo, Squo, 2, MANY, 0,
2679 doc: /* Return first argument divided by all the remaining arguments.
2680 The arguments must be numbers or markers.
2681 usage: (/ DIVIDEND DIVISOR &rest DIVISORS) */)
2682 (int nargs, Lisp_Object *args)
2684 int argnum;
2685 for (argnum = 2; argnum < nargs; argnum++)
2686 if (FLOATP (args[argnum]))
2687 return float_arith_driver (0, 0, Adiv, nargs, args);
2688 return arith_driver (Adiv, nargs, args);
2691 DEFUN ("%", Frem, Srem, 2, 2, 0,
2692 doc: /* Return remainder of X divided by Y.
2693 Both must be integers or markers. */)
2694 (register Lisp_Object x, Lisp_Object y)
2696 Lisp_Object val;
2698 CHECK_NUMBER_COERCE_MARKER (x);
2699 CHECK_NUMBER_COERCE_MARKER (y);
2701 if (XFASTINT (y) == 0)
2702 xsignal0 (Qarith_error);
2704 XSETINT (val, XINT (x) % XINT (y));
2705 return val;
2708 #ifndef HAVE_FMOD
2709 double
2710 fmod (f1, f2)
2711 double f1, f2;
2713 double r = f1;
2715 if (f2 < 0.0)
2716 f2 = -f2;
2718 /* If the magnitude of the result exceeds that of the divisor, or
2719 the sign of the result does not agree with that of the dividend,
2720 iterate with the reduced value. This does not yield a
2721 particularly accurate result, but at least it will be in the
2722 range promised by fmod. */
2724 r -= f2 * floor (r / f2);
2725 while (f2 <= (r < 0 ? -r : r) || ((r < 0) != (f1 < 0) && ! isnan (r)));
2727 return r;
2729 #endif /* ! HAVE_FMOD */
2731 DEFUN ("mod", Fmod, Smod, 2, 2, 0,
2732 doc: /* Return X modulo Y.
2733 The result falls between zero (inclusive) and Y (exclusive).
2734 Both X and Y must be numbers or markers. */)
2735 (register Lisp_Object x, Lisp_Object y)
2737 Lisp_Object val;
2738 EMACS_INT i1, i2;
2740 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (x);
2741 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (y);
2743 if (FLOATP (x) || FLOATP (y))
2744 return fmod_float (x, y);
2746 i1 = XINT (x);
2747 i2 = XINT (y);
2749 if (i2 == 0)
2750 xsignal0 (Qarith_error);
2752 i1 %= i2;
2754 /* If the "remainder" comes out with the wrong sign, fix it. */
2755 if (i2 < 0 ? i1 > 0 : i1 < 0)
2756 i1 += i2;
2758 XSETINT (val, i1);
2759 return val;
2762 DEFUN ("max", Fmax, Smax, 1, MANY, 0,
2763 doc: /* Return largest of all the arguments (which must be numbers or markers).
2764 The value is always a number; markers are converted to numbers.
2765 usage: (max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2766 (int nargs, Lisp_Object *args)
2768 return arith_driver (Amax, nargs, args);
2771 DEFUN ("min", Fmin, Smin, 1, MANY, 0,
2772 doc: /* Return smallest of all the arguments (which must be numbers or markers).
2773 The value is always a number; markers are converted to numbers.
2774 usage: (min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS) */)
2775 (int nargs, Lisp_Object *args)
2777 return arith_driver (Amin, nargs, args);
2780 DEFUN ("logand", Flogand, Slogand, 0, MANY, 0,
2781 doc: /* Return bitwise-and of all the arguments.
2782 Arguments may be integers, or markers converted to integers.
2783 usage: (logand &rest INTS-OR-MARKERS) */)
2784 (int nargs, Lisp_Object *args)
2786 return arith_driver (Alogand, nargs, args);
2789 DEFUN ("logior", Flogior, Slogior, 0, MANY, 0,
2790 doc: /* Return bitwise-or of all the arguments.
2791 Arguments may be integers, or markers converted to integers.
2792 usage: (logior &rest INTS-OR-MARKERS) */)
2793 (int nargs, Lisp_Object *args)
2795 return arith_driver (Alogior, nargs, args);
2798 DEFUN ("logxor", Flogxor, Slogxor, 0, MANY, 0,
2799 doc: /* Return bitwise-exclusive-or of all the arguments.
2800 Arguments may be integers, or markers converted to integers.
2801 usage: (logxor &rest INTS-OR-MARKERS) */)
2802 (int nargs, Lisp_Object *args)
2804 return arith_driver (Alogxor, nargs, args);
2807 DEFUN ("ash", Fash, Sash, 2, 2, 0,
2808 doc: /* Return VALUE with its bits shifted left by COUNT.
2809 If COUNT is negative, shifting is actually to the right.
2810 In this case, the sign bit is duplicated. */)
2811 (register Lisp_Object value, Lisp_Object count)
2813 register Lisp_Object val;
2815 CHECK_NUMBER (value);
2816 CHECK_NUMBER (count);
2818 if (XINT (count) >= BITS_PER_EMACS_INT)
2819 XSETINT (val, 0);
2820 else if (XINT (count) > 0)
2821 XSETINT (val, XINT (value) << XFASTINT (count));
2822 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2823 XSETINT (val, XINT (value) < 0 ? -1 : 0);
2824 else
2825 XSETINT (val, XINT (value) >> -XINT (count));
2826 return val;
2829 DEFUN ("lsh", Flsh, Slsh, 2, 2, 0,
2830 doc: /* Return VALUE with its bits shifted left by COUNT.
2831 If COUNT is negative, shifting is actually to the right.
2832 In this case, zeros are shifted in on the left. */)
2833 (register Lisp_Object value, Lisp_Object count)
2835 register Lisp_Object val;
2837 CHECK_NUMBER (value);
2838 CHECK_NUMBER (count);
2840 if (XINT (count) >= BITS_PER_EMACS_INT)
2841 XSETINT (val, 0);
2842 else if (XINT (count) > 0)
2843 XSETINT (val, (EMACS_UINT) XUINT (value) << XFASTINT (count));
2844 else if (XINT (count) <= -BITS_PER_EMACS_INT)
2845 XSETINT (val, 0);
2846 else
2847 XSETINT (val, (EMACS_UINT) XUINT (value) >> -XINT (count));
2848 return val;
2851 DEFUN ("1+", Fadd1, Sadd1, 1, 1, 0,
2852 doc: /* Return NUMBER plus one. NUMBER may be a number or a marker.
2853 Markers are converted to integers. */)
2854 (register Lisp_Object number)
2856 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2858 if (FLOATP (number))
2859 return (make_float (1.0 + XFLOAT_DATA (number)));
2861 XSETINT (number, XINT (number) + 1);
2862 return number;
2865 DEFUN ("1-", Fsub1, Ssub1, 1, 1, 0,
2866 doc: /* Return NUMBER minus one. NUMBER may be a number or a marker.
2867 Markers are converted to integers. */)
2868 (register Lisp_Object number)
2870 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (number);
2872 if (FLOATP (number))
2873 return (make_float (-1.0 + XFLOAT_DATA (number)));
2875 XSETINT (number, XINT (number) - 1);
2876 return number;
2879 DEFUN ("lognot", Flognot, Slognot, 1, 1, 0,
2880 doc: /* Return the bitwise complement of NUMBER. NUMBER must be an integer. */)
2881 (register Lisp_Object number)
2883 CHECK_NUMBER (number);
2884 XSETINT (number, ~XINT (number));
2885 return number;
2888 DEFUN ("byteorder", Fbyteorder, Sbyteorder, 0, 0, 0,
2889 doc: /* Return the byteorder for the machine.
2890 Returns 66 (ASCII uppercase B) for big endian machines or 108 (ASCII
2891 lowercase l) for small endian machines. */)
2892 (void)
2894 unsigned i = 0x04030201;
2895 int order = *(char *)&i == 1 ? 108 : 66;
2897 return make_number (order);
2902 void
2903 syms_of_data (void)
2905 Lisp_Object error_tail, arith_tail;
2907 Qquote = intern_c_string ("quote");
2908 Qlambda = intern_c_string ("lambda");
2909 Qsubr = intern_c_string ("subr");
2910 Qerror_conditions = intern_c_string ("error-conditions");
2911 Qerror_message = intern_c_string ("error-message");
2912 Qtop_level = intern_c_string ("top-level");
2914 Qerror = intern_c_string ("error");
2915 Qquit = intern_c_string ("quit");
2916 Qwrong_type_argument = intern_c_string ("wrong-type-argument");
2917 Qargs_out_of_range = intern_c_string ("args-out-of-range");
2918 Qvoid_function = intern_c_string ("void-function");
2919 Qcyclic_function_indirection = intern_c_string ("cyclic-function-indirection");
2920 Qcyclic_variable_indirection = intern_c_string ("cyclic-variable-indirection");
2921 Qvoid_variable = intern_c_string ("void-variable");
2922 Qsetting_constant = intern_c_string ("setting-constant");
2923 Qinvalid_read_syntax = intern_c_string ("invalid-read-syntax");
2925 Qinvalid_function = intern_c_string ("invalid-function");
2926 Qwrong_number_of_arguments = intern_c_string ("wrong-number-of-arguments");
2927 Qno_catch = intern_c_string ("no-catch");
2928 Qend_of_file = intern_c_string ("end-of-file");
2929 Qarith_error = intern_c_string ("arith-error");
2930 Qbeginning_of_buffer = intern_c_string ("beginning-of-buffer");
2931 Qend_of_buffer = intern_c_string ("end-of-buffer");
2932 Qbuffer_read_only = intern_c_string ("buffer-read-only");
2933 Qtext_read_only = intern_c_string ("text-read-only");
2934 Qmark_inactive = intern_c_string ("mark-inactive");
2936 Qlistp = intern_c_string ("listp");
2937 Qconsp = intern_c_string ("consp");
2938 Qsymbolp = intern_c_string ("symbolp");
2939 Qkeywordp = intern_c_string ("keywordp");
2940 Qintegerp = intern_c_string ("integerp");
2941 Qnatnump = intern_c_string ("natnump");
2942 Qwholenump = intern_c_string ("wholenump");
2943 Qstringp = intern_c_string ("stringp");
2944 Qarrayp = intern_c_string ("arrayp");
2945 Qsequencep = intern_c_string ("sequencep");
2946 Qbufferp = intern_c_string ("bufferp");
2947 Qvectorp = intern_c_string ("vectorp");
2948 Qchar_or_string_p = intern_c_string ("char-or-string-p");
2949 Qmarkerp = intern_c_string ("markerp");
2950 Qbuffer_or_string_p = intern_c_string ("buffer-or-string-p");
2951 Qinteger_or_marker_p = intern_c_string ("integer-or-marker-p");
2952 Qboundp = intern_c_string ("boundp");
2953 Qfboundp = intern_c_string ("fboundp");
2955 Qfloatp = intern_c_string ("floatp");
2956 Qnumberp = intern_c_string ("numberp");
2957 Qnumber_or_marker_p = intern_c_string ("number-or-marker-p");
2959 Qchar_table_p = intern_c_string ("char-table-p");
2960 Qvector_or_char_table_p = intern_c_string ("vector-or-char-table-p");
2962 Qsubrp = intern_c_string ("subrp");
2963 Qunevalled = intern_c_string ("unevalled");
2964 Qmany = intern_c_string ("many");
2966 Qcdr = intern_c_string ("cdr");
2968 /* Handle automatic advice activation */
2969 Qad_advice_info = intern_c_string ("ad-advice-info");
2970 Qad_activate_internal = intern_c_string ("ad-activate-internal");
2972 error_tail = pure_cons (Qerror, Qnil);
2974 /* ERROR is used as a signaler for random errors for which nothing else is right */
2976 Fput (Qerror, Qerror_conditions,
2977 error_tail);
2978 Fput (Qerror, Qerror_message,
2979 make_pure_c_string ("error"));
2981 Fput (Qquit, Qerror_conditions,
2982 pure_cons (Qquit, Qnil));
2983 Fput (Qquit, Qerror_message,
2984 make_pure_c_string ("Quit"));
2986 Fput (Qwrong_type_argument, Qerror_conditions,
2987 pure_cons (Qwrong_type_argument, error_tail));
2988 Fput (Qwrong_type_argument, Qerror_message,
2989 make_pure_c_string ("Wrong type argument"));
2991 Fput (Qargs_out_of_range, Qerror_conditions,
2992 pure_cons (Qargs_out_of_range, error_tail));
2993 Fput (Qargs_out_of_range, Qerror_message,
2994 make_pure_c_string ("Args out of range"));
2996 Fput (Qvoid_function, Qerror_conditions,
2997 pure_cons (Qvoid_function, error_tail));
2998 Fput (Qvoid_function, Qerror_message,
2999 make_pure_c_string ("Symbol's function definition is void"));
3001 Fput (Qcyclic_function_indirection, Qerror_conditions,
3002 pure_cons (Qcyclic_function_indirection, error_tail));
3003 Fput (Qcyclic_function_indirection, Qerror_message,
3004 make_pure_c_string ("Symbol's chain of function indirections contains a loop"));
3006 Fput (Qcyclic_variable_indirection, Qerror_conditions,
3007 pure_cons (Qcyclic_variable_indirection, error_tail));
3008 Fput (Qcyclic_variable_indirection, Qerror_message,
3009 make_pure_c_string ("Symbol's chain of variable indirections contains a loop"));
3011 Qcircular_list = intern_c_string ("circular-list");
3012 staticpro (&Qcircular_list);
3013 Fput (Qcircular_list, Qerror_conditions,
3014 pure_cons (Qcircular_list, error_tail));
3015 Fput (Qcircular_list, Qerror_message,
3016 make_pure_c_string ("List contains a loop"));
3018 Fput (Qvoid_variable, Qerror_conditions,
3019 pure_cons (Qvoid_variable, error_tail));
3020 Fput (Qvoid_variable, Qerror_message,
3021 make_pure_c_string ("Symbol's value as variable is void"));
3023 Fput (Qsetting_constant, Qerror_conditions,
3024 pure_cons (Qsetting_constant, error_tail));
3025 Fput (Qsetting_constant, Qerror_message,
3026 make_pure_c_string ("Attempt to set a constant symbol"));
3028 Fput (Qinvalid_read_syntax, Qerror_conditions,
3029 pure_cons (Qinvalid_read_syntax, error_tail));
3030 Fput (Qinvalid_read_syntax, Qerror_message,
3031 make_pure_c_string ("Invalid read syntax"));
3033 Fput (Qinvalid_function, Qerror_conditions,
3034 pure_cons (Qinvalid_function, error_tail));
3035 Fput (Qinvalid_function, Qerror_message,
3036 make_pure_c_string ("Invalid function"));
3038 Fput (Qwrong_number_of_arguments, Qerror_conditions,
3039 pure_cons (Qwrong_number_of_arguments, error_tail));
3040 Fput (Qwrong_number_of_arguments, Qerror_message,
3041 make_pure_c_string ("Wrong number of arguments"));
3043 Fput (Qno_catch, Qerror_conditions,
3044 pure_cons (Qno_catch, error_tail));
3045 Fput (Qno_catch, Qerror_message,
3046 make_pure_c_string ("No catch for tag"));
3048 Fput (Qend_of_file, Qerror_conditions,
3049 pure_cons (Qend_of_file, error_tail));
3050 Fput (Qend_of_file, Qerror_message,
3051 make_pure_c_string ("End of file during parsing"));
3053 arith_tail = pure_cons (Qarith_error, error_tail);
3054 Fput (Qarith_error, Qerror_conditions,
3055 arith_tail);
3056 Fput (Qarith_error, Qerror_message,
3057 make_pure_c_string ("Arithmetic error"));
3059 Fput (Qbeginning_of_buffer, Qerror_conditions,
3060 pure_cons (Qbeginning_of_buffer, error_tail));
3061 Fput (Qbeginning_of_buffer, Qerror_message,
3062 make_pure_c_string ("Beginning of buffer"));
3064 Fput (Qend_of_buffer, Qerror_conditions,
3065 pure_cons (Qend_of_buffer, error_tail));
3066 Fput (Qend_of_buffer, Qerror_message,
3067 make_pure_c_string ("End of buffer"));
3069 Fput (Qbuffer_read_only, Qerror_conditions,
3070 pure_cons (Qbuffer_read_only, error_tail));
3071 Fput (Qbuffer_read_only, Qerror_message,
3072 make_pure_c_string ("Buffer is read-only"));
3074 Fput (Qtext_read_only, Qerror_conditions,
3075 pure_cons (Qtext_read_only, error_tail));
3076 Fput (Qtext_read_only, Qerror_message,
3077 make_pure_c_string ("Text is read-only"));
3079 Qrange_error = intern_c_string ("range-error");
3080 Qdomain_error = intern_c_string ("domain-error");
3081 Qsingularity_error = intern_c_string ("singularity-error");
3082 Qoverflow_error = intern_c_string ("overflow-error");
3083 Qunderflow_error = intern_c_string ("underflow-error");
3085 Fput (Qdomain_error, Qerror_conditions,
3086 pure_cons (Qdomain_error, arith_tail));
3087 Fput (Qdomain_error, Qerror_message,
3088 make_pure_c_string ("Arithmetic domain error"));
3090 Fput (Qrange_error, Qerror_conditions,
3091 pure_cons (Qrange_error, arith_tail));
3092 Fput (Qrange_error, Qerror_message,
3093 make_pure_c_string ("Arithmetic range error"));
3095 Fput (Qsingularity_error, Qerror_conditions,
3096 pure_cons (Qsingularity_error, Fcons (Qdomain_error, arith_tail)));
3097 Fput (Qsingularity_error, Qerror_message,
3098 make_pure_c_string ("Arithmetic singularity error"));
3100 Fput (Qoverflow_error, Qerror_conditions,
3101 pure_cons (Qoverflow_error, Fcons (Qdomain_error, arith_tail)));
3102 Fput (Qoverflow_error, Qerror_message,
3103 make_pure_c_string ("Arithmetic overflow error"));
3105 Fput (Qunderflow_error, Qerror_conditions,
3106 pure_cons (Qunderflow_error, Fcons (Qdomain_error, arith_tail)));
3107 Fput (Qunderflow_error, Qerror_message,
3108 make_pure_c_string ("Arithmetic underflow error"));
3110 staticpro (&Qrange_error);
3111 staticpro (&Qdomain_error);
3112 staticpro (&Qsingularity_error);
3113 staticpro (&Qoverflow_error);
3114 staticpro (&Qunderflow_error);
3116 staticpro (&Qnil);
3117 staticpro (&Qt);
3118 staticpro (&Qquote);
3119 staticpro (&Qlambda);
3120 staticpro (&Qsubr);
3121 staticpro (&Qunbound);
3122 staticpro (&Qerror_conditions);
3123 staticpro (&Qerror_message);
3124 staticpro (&Qtop_level);
3126 staticpro (&Qerror);
3127 staticpro (&Qquit);
3128 staticpro (&Qwrong_type_argument);
3129 staticpro (&Qargs_out_of_range);
3130 staticpro (&Qvoid_function);
3131 staticpro (&Qcyclic_function_indirection);
3132 staticpro (&Qcyclic_variable_indirection);
3133 staticpro (&Qvoid_variable);
3134 staticpro (&Qsetting_constant);
3135 staticpro (&Qinvalid_read_syntax);
3136 staticpro (&Qwrong_number_of_arguments);
3137 staticpro (&Qinvalid_function);
3138 staticpro (&Qno_catch);
3139 staticpro (&Qend_of_file);
3140 staticpro (&Qarith_error);
3141 staticpro (&Qbeginning_of_buffer);
3142 staticpro (&Qend_of_buffer);
3143 staticpro (&Qbuffer_read_only);
3144 staticpro (&Qtext_read_only);
3145 staticpro (&Qmark_inactive);
3147 staticpro (&Qlistp);
3148 staticpro (&Qconsp);
3149 staticpro (&Qsymbolp);
3150 staticpro (&Qkeywordp);
3151 staticpro (&Qintegerp);
3152 staticpro (&Qnatnump);
3153 staticpro (&Qwholenump);
3154 staticpro (&Qstringp);
3155 staticpro (&Qarrayp);
3156 staticpro (&Qsequencep);
3157 staticpro (&Qbufferp);
3158 staticpro (&Qvectorp);
3159 staticpro (&Qchar_or_string_p);
3160 staticpro (&Qmarkerp);
3161 staticpro (&Qbuffer_or_string_p);
3162 staticpro (&Qinteger_or_marker_p);
3163 staticpro (&Qfloatp);
3164 staticpro (&Qnumberp);
3165 staticpro (&Qnumber_or_marker_p);
3166 staticpro (&Qchar_table_p);
3167 staticpro (&Qvector_or_char_table_p);
3168 staticpro (&Qsubrp);
3169 staticpro (&Qmany);
3170 staticpro (&Qunevalled);
3172 staticpro (&Qboundp);
3173 staticpro (&Qfboundp);
3174 staticpro (&Qcdr);
3175 staticpro (&Qad_advice_info);
3176 staticpro (&Qad_activate_internal);
3178 /* Types that type-of returns. */
3179 Qinteger = intern_c_string ("integer");
3180 Qsymbol = intern_c_string ("symbol");
3181 Qstring = intern_c_string ("string");
3182 Qcons = intern_c_string ("cons");
3183 Qmarker = intern_c_string ("marker");
3184 Qoverlay = intern_c_string ("overlay");
3185 Qfloat = intern_c_string ("float");
3186 Qwindow_configuration = intern_c_string ("window-configuration");
3187 Qprocess = intern_c_string ("process");
3188 Qwindow = intern_c_string ("window");
3189 /* Qsubr = intern_c_string ("subr"); */
3190 Qcompiled_function = intern_c_string ("compiled-function");
3191 Qbuffer = intern_c_string ("buffer");
3192 Qframe = intern_c_string ("frame");
3193 Qvector = intern_c_string ("vector");
3194 Qchar_table = intern_c_string ("char-table");
3195 Qbool_vector = intern_c_string ("bool-vector");
3196 Qhash_table = intern_c_string ("hash-table");
3198 DEFSYM (Qfont_spec, "font-spec");
3199 DEFSYM (Qfont_entity, "font-entity");
3200 DEFSYM (Qfont_object, "font-object");
3202 DEFSYM (Qinteractive_form, "interactive-form");
3204 staticpro (&Qinteger);
3205 staticpro (&Qsymbol);
3206 staticpro (&Qstring);
3207 staticpro (&Qcons);
3208 staticpro (&Qmarker);
3209 staticpro (&Qoverlay);
3210 staticpro (&Qfloat);
3211 staticpro (&Qwindow_configuration);
3212 staticpro (&Qprocess);
3213 staticpro (&Qwindow);
3214 /* staticpro (&Qsubr); */
3215 staticpro (&Qcompiled_function);
3216 staticpro (&Qbuffer);
3217 staticpro (&Qframe);
3218 staticpro (&Qvector);
3219 staticpro (&Qchar_table);
3220 staticpro (&Qbool_vector);
3221 staticpro (&Qhash_table);
3223 defsubr (&Sindirect_variable);
3224 defsubr (&Sinteractive_form);
3225 defsubr (&Seq);
3226 defsubr (&Snull);
3227 defsubr (&Stype_of);
3228 defsubr (&Slistp);
3229 defsubr (&Snlistp);
3230 defsubr (&Sconsp);
3231 defsubr (&Satom);
3232 defsubr (&Sintegerp);
3233 defsubr (&Sinteger_or_marker_p);
3234 defsubr (&Snumberp);
3235 defsubr (&Snumber_or_marker_p);
3236 defsubr (&Sfloatp);
3237 defsubr (&Snatnump);
3238 defsubr (&Ssymbolp);
3239 defsubr (&Skeywordp);
3240 defsubr (&Sstringp);
3241 defsubr (&Smultibyte_string_p);
3242 defsubr (&Svectorp);
3243 defsubr (&Schar_table_p);
3244 defsubr (&Svector_or_char_table_p);
3245 defsubr (&Sbool_vector_p);
3246 defsubr (&Sarrayp);
3247 defsubr (&Ssequencep);
3248 defsubr (&Sbufferp);
3249 defsubr (&Smarkerp);
3250 defsubr (&Ssubrp);
3251 defsubr (&Sbyte_code_function_p);
3252 defsubr (&Schar_or_string_p);
3253 defsubr (&Scar);
3254 defsubr (&Scdr);
3255 defsubr (&Scar_safe);
3256 defsubr (&Scdr_safe);
3257 defsubr (&Ssetcar);
3258 defsubr (&Ssetcdr);
3259 defsubr (&Ssymbol_function);
3260 defsubr (&Sindirect_function);
3261 defsubr (&Ssymbol_plist);
3262 defsubr (&Ssymbol_name);
3263 defsubr (&Smakunbound);
3264 defsubr (&Sfmakunbound);
3265 defsubr (&Sboundp);
3266 defsubr (&Sfboundp);
3267 defsubr (&Sfset);
3268 defsubr (&Sdefalias);
3269 defsubr (&Ssetplist);
3270 defsubr (&Ssymbol_value);
3271 defsubr (&Sset);
3272 defsubr (&Sdefault_boundp);
3273 defsubr (&Sdefault_value);
3274 defsubr (&Sset_default);
3275 defsubr (&Ssetq_default);
3276 defsubr (&Smake_variable_buffer_local);
3277 defsubr (&Smake_local_variable);
3278 defsubr (&Skill_local_variable);
3279 defsubr (&Smake_variable_frame_local);
3280 defsubr (&Slocal_variable_p);
3281 defsubr (&Slocal_variable_if_set_p);
3282 defsubr (&Svariable_binding_locus);
3283 #if 0 /* XXX Remove this. --lorentey */
3284 defsubr (&Sterminal_local_value);
3285 defsubr (&Sset_terminal_local_value);
3286 #endif
3287 defsubr (&Saref);
3288 defsubr (&Saset);
3289 defsubr (&Snumber_to_string);
3290 defsubr (&Sstring_to_number);
3291 defsubr (&Seqlsign);
3292 defsubr (&Slss);
3293 defsubr (&Sgtr);
3294 defsubr (&Sleq);
3295 defsubr (&Sgeq);
3296 defsubr (&Sneq);
3297 defsubr (&Szerop);
3298 defsubr (&Splus);
3299 defsubr (&Sminus);
3300 defsubr (&Stimes);
3301 defsubr (&Squo);
3302 defsubr (&Srem);
3303 defsubr (&Smod);
3304 defsubr (&Smax);
3305 defsubr (&Smin);
3306 defsubr (&Slogand);
3307 defsubr (&Slogior);
3308 defsubr (&Slogxor);
3309 defsubr (&Slsh);
3310 defsubr (&Sash);
3311 defsubr (&Sadd1);
3312 defsubr (&Ssub1);
3313 defsubr (&Slognot);
3314 defsubr (&Sbyteorder);
3315 defsubr (&Ssubr_arity);
3316 defsubr (&Ssubr_name);
3318 XSYMBOL (Qwholenump)->function = XSYMBOL (Qnatnump)->function;
3320 DEFVAR_LISP ("most-positive-fixnum", &Vmost_positive_fixnum,
3321 doc: /* The largest value that is representable in a Lisp integer. */);
3322 Vmost_positive_fixnum = make_number (MOST_POSITIVE_FIXNUM);
3323 XSYMBOL (intern_c_string ("most-positive-fixnum"))->constant = 1;
3325 DEFVAR_LISP ("most-negative-fixnum", &Vmost_negative_fixnum,
3326 doc: /* The smallest value that is representable in a Lisp integer. */);
3327 Vmost_negative_fixnum = make_number (MOST_NEGATIVE_FIXNUM);
3328 XSYMBOL (intern_c_string ("most-negative-fixnum"))->constant = 1;
3331 SIGTYPE
3332 arith_error (int signo)
3334 sigsetmask (SIGEMPTYMASK);
3336 SIGNAL_THREAD_CHECK (signo);
3337 xsignal0 (Qarith_error);
3340 void
3341 init_data (void)
3343 /* Don't do this if just dumping out.
3344 We don't want to call `signal' in this case
3345 so that we don't have trouble with dumping
3346 signal-delivering routines in an inconsistent state. */
3347 #ifndef CANNOT_DUMP
3348 if (!initialized)
3349 return;
3350 #endif /* CANNOT_DUMP */
3351 signal (SIGFPE, arith_error);
3353 #ifdef uts
3354 signal (SIGEMT, arith_error);
3355 #endif /* uts */
3358 /* arch-tag: 25879798-b84d-479a-9c89-7d148e2109f7
3359 (do not change this comment) */