data.c 93.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
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,
Glenn Morris's avatar
Glenn Morris committed
3
                 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
23
#include <signal.h>
24
#include <stdio.h>
25
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
26
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "puresize.h"
28
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include "keyboard.h"
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "syssignal.h"
33
#include "termhooks.h"  /* For FRAME_KBOARD reference in y-or-n-p. */
34
#include "font.h"
Jim Blandy's avatar
Jim Blandy committed
35

36
#ifdef STDC_HEADERS
37
#include <float.h>
38
#endif
39

40 41 42 43 44 45 46 47 48 49
/* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*. */
#ifndef IEEE_FLOATING_POINT
#if (FLT_RADIX == 2 && FLT_MANT_DIG == 24 \
     && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
#define IEEE_FLOATING_POINT 1
#else
#define IEEE_FLOATING_POINT 0
#endif
#endif

Jim Blandy's avatar
Jim Blandy committed
50 51
#include <math.h>

52
#if !defined (atof)
53
extern double atof (const char *);
54 55
#endif /* !atof */

Jim Blandy's avatar
Jim Blandy committed
56 57 58
Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
Jim Blandy's avatar
Jim Blandy committed
59
Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
60
Lisp_Object Qcyclic_variable_indirection, Qcircular_list;
Jim Blandy's avatar
Jim Blandy committed
61 62
Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
Roland McGrath's avatar
Roland McGrath committed
63
Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
64
Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
65
Lisp_Object Qtext_read_only;
Kenichi Handa's avatar
Kenichi Handa committed
66

67
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
68 69
Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
Dave Love's avatar
Dave Love committed
70
Lisp_Object Qbuffer_or_string_p, Qkeywordp;
Jim Blandy's avatar
Jim Blandy committed
71
Lisp_Object Qboundp, Qfboundp;
72
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
73

Jim Blandy's avatar
Jim Blandy committed
74
Lisp_Object Qcdr;
75
Lisp_Object Qad_advice_info, Qad_activate_internal;
Jim Blandy's avatar
Jim Blandy committed
76

77 78 79
Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
Lisp_Object Qoverflow_error, Qunderflow_error;

80
Lisp_Object Qfloatp;
Jim Blandy's avatar
Jim Blandy committed
81 82
Lisp_Object Qnumberp, Qnumber_or_marker_p;

Kenichi Handa's avatar
Kenichi Handa committed
83 84
Lisp_Object Qinteger;
static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
Karl Heuer's avatar
Karl Heuer committed
85 86
static Lisp_Object Qfloat, Qwindow_configuration, Qwindow;
Lisp_Object Qprocess;
87
static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
Gerd Moellmann's avatar
Gerd Moellmann committed
88
static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
89
static Lisp_Object Qsubrp, Qmany, Qunevalled;
90
Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
91

92 93
Lisp_Object Qinteractive_form;

94
static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
95

96
Lisp_Object Vmost_positive_fixnum, Vmost_negative_fixnum;
97

98 99

void
100
circular_list_error (Lisp_Object list)
101
{
102
  xsignal (Qcircular_list, list);
103 104 105
}


Jim Blandy's avatar
Jim Blandy committed
106
Lisp_Object
107
wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
Jim Blandy's avatar
Jim Blandy committed
108
{
109 110 111 112 113 114
  /* If VALUE is not even a valid Lisp object, we'd want to abort here
     where we can get a backtrace showing where it came from.  We used
     to try and do that by checking the tagbits, but nowadays all
     tagbits are potentially valid.  */
  /* if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
   *   abort (); */
115

116
  xsignal2 (Qwrong_type_argument, predicate, value);
Jim Blandy's avatar
Jim Blandy committed
117 118
}

Andreas Schwab's avatar
Andreas Schwab committed
119
void
120
pure_write_error (void)
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125
{
  error ("Attempt to modify read-only object");
}

void
126
args_out_of_range (Lisp_Object a1, Lisp_Object a2)
Jim Blandy's avatar
Jim Blandy committed
127
{
128
  xsignal2 (Qargs_out_of_range, a1, a2);
Jim Blandy's avatar
Jim Blandy committed
129 130 131
}

void
132
args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
Jim Blandy's avatar
Jim Blandy committed
133
{
134
  xsignal3 (Qargs_out_of_range, a1, a2, a3);
Jim Blandy's avatar
Jim Blandy committed
135 136 137 138 139 140 141 142 143 144
}

/* On some machines, XINT needs a temporary location.
   Here it is, in case it is needed.  */

int sign_extend_temp;

/* On a few machines, XINT can only be done by calling this.  */

int
145
sign_extend_lisp_int (EMACS_INT num)
Jim Blandy's avatar
Jim Blandy committed
146
{
147 148
  if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
    return num | (((EMACS_INT) (-1)) << VALBITS);
Jim Blandy's avatar
Jim Blandy committed
149
  else
150
    return num & ((((EMACS_INT) 1) << VALBITS) - 1);
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155
}

/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
156
       doc: /* Return t if the two args are the same Lisp object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
157
  (Lisp_Object obj1, Lisp_Object obj2)
Jim Blandy's avatar
Jim Blandy committed
158 159 160 161 162 163
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

164 165
DEFUN ("null", Fnull, Snull, 1, 1, 0,
       doc: /* Return t if OBJECT is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
166
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
167
{
168
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172
    return Qt;
  return Qnil;
}

173
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
174 175 176
       doc: /* Return a symbol representing the type of OBJECT.
The symbol returned names the object's basic type;
for example, (type-of 1) returns `integer'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
177
  (Lisp_Object object)
178
{
179
  switch (XTYPE (object))
180
    {
181
    case_Lisp_Int:
182 183 184 185 186 187 188 189 190 191 192 193
      return Qinteger;

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

    case Lisp_Misc:
194
      switch (XMISCTYPE (object))
195 196 197 198 199 200 201 202 203 204 205
	{
	case Lisp_Misc_Marker:
	  return Qmarker;
	case Lisp_Misc_Overlay:
	  return Qoverlay;
	case Lisp_Misc_Float:
	  return Qfloat;
	}
      abort ();

    case Lisp_Vectorlike:
206
      if (WINDOW_CONFIGURATIONP (object))
207
	return Qwindow_configuration;
208
      if (PROCESSP (object))
209
	return Qprocess;
210
      if (WINDOWP (object))
211
	return Qwindow;
212
      if (SUBRP (object))
213
	return Qsubr;
214
      if (COMPILEDP (object))
215
	return Qcompiled_function;
216
      if (BUFFERP (object))
217
	return Qbuffer;
218
      if (CHAR_TABLE_P (object))
219
	return Qchar_table;
220
      if (BOOL_VECTOR_P (object))
221
	return Qbool_vector;
222
      if (FRAMEP (object))
223
	return Qframe;
224
      if (HASH_TABLE_P (object))
Gerd Moellmann's avatar
Gerd Moellmann committed
225
	return Qhash_table;
226 227 228 229 230 231
      if (FONT_SPEC_P (object))
	return Qfont_spec;
      if (FONT_ENTITY_P (object))
	return Qfont_entity;
      if (FONT_OBJECT_P (object))
	return Qfont_object;
232 233 234 235 236 237 238 239 240 241
      return Qvector;

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

242 243
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
244
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
245
{
246
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
247 248 249 250
    return Qt;
  return Qnil;
}

251
DEFUN ("atom", Fatom, Satom, 1, 1, 0,
252
       doc: /* Return t if OBJECT is not a cons cell.  This includes nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
253
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
254
{
255
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
256 257 258 259
    return Qnil;
  return Qt;
}

260
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
Luc Teirlinck's avatar
Luc Teirlinck committed
261 262
       doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
Otherwise, return nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
264
{
265
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
266 267 268 269
    return Qt;
  return Qnil;
}

270
DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
271
       doc: /* Return t if OBJECT is not a list.  Lists include nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
272
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
273
{
274
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
275 276 277 278
    return Qnil;
  return Qt;
}

279
DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
280
       doc: /* Return t if OBJECT is a symbol.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
281
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
282
{
283
  if (SYMBOLP (object))
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287
    return Qt;
  return Qnil;
}

Dave Love's avatar
Dave Love committed
288 289 290
/* Define this in C to avoid unnecessarily consing up the symbol
   name.  */
DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
291 292 293
       doc: /* Return t if OBJECT is a keyword.
This means that it is a symbol with a print name beginning with `:'
interned in the initial obarray.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
294
  (Lisp_Object object)
Dave Love's avatar
Dave Love committed
295 296
{
  if (SYMBOLP (object)
297
      && SREF (SYMBOL_NAME (object), 0) == ':'
298
      && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
Dave Love's avatar
Dave Love committed
299 300 301 302
    return Qt;
  return Qnil;
}

303
DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
304
       doc: /* Return t if OBJECT is a vector.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
305
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
306
{
307
  if (VECTORP (object))
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311
    return Qt;
  return Qnil;
}

312
DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
313
       doc: /* Return t if OBJECT is a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
314
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
315
{
316
  if (STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
317 318 319 320
    return Qt;
  return Qnil;
}

321
DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
322 323
       1, 1, 0,
       doc: /* Return t if OBJECT is a multibyte string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
324
  (Lisp_Object object)
325 326 327 328 329 330 331
{
  if (STRINGP (object) && STRING_MULTIBYTE (object))
    return Qt;
  return Qnil;
}

DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
332
       doc: /* Return t if OBJECT is a char-table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
333
  (Lisp_Object object)
334 335 336 337 338 339
{
  if (CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

340 341
DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
       Svector_or_char_table_p, 1, 1, 0,
342
       doc: /* Return t if OBJECT is a char-table or vector.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
343
  (Lisp_Object object)
344 345 346 347 348 349
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

350 351
DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
       doc: /* Return t if OBJECT is a bool-vector.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
352
  (Lisp_Object object)
353 354 355 356 357 358
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

359 360
DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
       doc: /* Return t if OBJECT is an array (string or vector).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
361
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
362
{
363
  if (ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367 368
    return Qt;
  return Qnil;
}

DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
369
       doc: /* Return t if OBJECT is a sequence (list or array).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
370
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
371
{
372
  if (CONSP (object) || NILP (object) || ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376
    return Qt;
  return Qnil;
}

377 378
DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
       doc: /* Return t if OBJECT is an editor buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
379
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
380
{
381
  if (BUFFERP (object))
Jim Blandy's avatar
Jim Blandy committed
382 383 384 385
    return Qt;
  return Qnil;
}

386 387
DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
       doc: /* Return t if OBJECT is a marker (editor pointer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
388
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
389
{
390
  if (MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394
    return Qt;
  return Qnil;
}

395 396
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
       doc: /* Return t if OBJECT is a built-in function.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
398
{
399
  if (SUBRP (object))
Jim Blandy's avatar
Jim Blandy committed
400 401 402 403
    return Qt;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
404
DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
405 406
       1, 1, 0,
       doc: /* Return t if OBJECT is a byte-compiled function object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
407
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
408
{
409
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413
    return Qt;
  return Qnil;
}

414
DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
415
       doc: /* Return t if OBJECT is a character or a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
416
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
417
{
418
  if (CHARACTERP (object) || STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
419 420 421 422
    return Qt;
  return Qnil;
}

423 424
DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
       doc: /* Return t if OBJECT is an integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
425
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
426
{
427
  if (INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431
    return Qt;
  return Qnil;
}

432
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
433
       doc: /* Return t if OBJECT is an integer or a marker (editor pointer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
434
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
435
{
436
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440
    return Qt;
  return Qnil;
}

441
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
442
       doc: /* Return t if OBJECT is a nonnegative integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
443
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
444
{
445
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449 450
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
451
       doc: /* Return t if OBJECT is a number (floating point or integer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
452
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
453
{
454
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
455
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
456 457
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
462
       doc: /* Return t if OBJECT is a number or a marker.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
463
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
464
{
465
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
466 467 468
    return Qt;
  return Qnil;
}
469 470

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
471
       doc: /* Return t if OBJECT is a floating point number.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
472
  (Lisp_Object object)
473
{
474
  if (FLOATP (object))
475 476 477
    return Qt;
  return Qnil;
}
478

Jim Blandy's avatar
Jim Blandy committed
479 480 481 482

/* Extract and set components of lists */

DEFUN ("car", Fcar, Scar, 1, 1, 0,
483
       doc: /* Return the car of LIST.  If arg is nil, return nil.
484 485
Error if arg is not nil and not a cons cell.  See also `car-safe'.

Luc Teirlinck's avatar
Luc Teirlinck committed
486 487
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as car, cdr, cons cell and list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
488
  (register Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
489
{
490
  return CAR (list);
Jim Blandy's avatar
Jim Blandy committed
491 492 493
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
494
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
495
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
496
{
497
  return CAR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
498 499 500
}

DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
501
       doc: /* Return the cdr of LIST.  If arg is nil, return nil.
502 503
Error if arg is not nil and not a cons cell.  See also `cdr-safe'.

Luc Teirlinck's avatar
Luc Teirlinck committed
504 505
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as cdr, car, cons cell and list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
506
  (register Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
507
{
508
  return CDR (list);
Jim Blandy's avatar
Jim Blandy committed
509 510 511
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
512
       doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
513
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
514
{
515
  return CDR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
516 517 518
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
519
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
520
  (register Lisp_Object cell, Lisp_Object newcar)
Jim Blandy's avatar
Jim Blandy committed
521
{
522
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
523
  CHECK_IMPURE (cell);
524
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
529
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
530
  (register Lisp_Object cell, Lisp_Object newcdr)
Jim Blandy's avatar
Jim Blandy committed
531
{
532
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
533
  CHECK_IMPURE (cell);
534
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539
  return newcdr;
}

/* Extract and set components of symbols */

540 541
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
542
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
543 544
{
  Lisp_Object valcontents;
545
  struct Lisp_Symbol *sym;
546
  CHECK_SYMBOL (symbol);
547
  sym = XSYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
548

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
 start:
  switch (sym->redirect)
    {
    case SYMBOL_PLAINVAL: valcontents = SYMBOL_VAL (sym); break;
    case SYMBOL_VARALIAS: sym = indirect_variable (sym); goto start;
    case SYMBOL_LOCALIZED:
      {
	struct Lisp_Buffer_Local_Value *blv = SYMBOL_BLV (sym);
	if (blv->fwd)
	  /* In set_internal, we un-forward vars when their value is
    	     set to Qunbound. */
    	  return Qt;
	else
	  {
	    swap_in_symval_forwarding (sym, blv);
	    valcontents = BLV_VALUE (blv);
	  }
	break;
      }
    case SYMBOL_FORWARDED:
      /* In set_internal, we un-forward vars when their value is
	 set to Qunbound. */
      return Qt;
    default: abort ();
    }
Jim Blandy's avatar
Jim Blandy committed
574

575
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
576 577
}

578 579
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's function definition is not void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
580
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
581
{
582
  CHECK_SYMBOL (symbol);
583
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
584 585
}

586
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
587 588
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
589
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
590
{
591
  CHECK_SYMBOL (symbol);
592
  if (SYMBOL_CONSTANT_P (symbol))
593
    xsignal1 (Qsetting_constant, symbol);
594 595
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
596 597
}

598
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
599 600
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
601
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
602
{
603
  CHECK_SYMBOL (symbol);
604
  if (NILP (symbol) || EQ (symbol, Qt))
605
    xsignal1 (Qsetting_constant, symbol);
606 607
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
608 609 610
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
611
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
612
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
613
{
614
  CHECK_SYMBOL (symbol);
615 616 617
  if (!EQ (XSYMBOL (symbol)->function, Qunbound))
    return XSYMBOL (symbol)->function;
  xsignal1 (Qvoid_function, symbol);
Jim Blandy's avatar
Jim Blandy committed
618 619
}

620 621
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
622
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
623
{
624
  CHECK_SYMBOL (symbol);
625
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
626 627
}

628 629
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
630
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
631 632 633
{
  register Lisp_Object name;

634
  CHECK_SYMBOL (symbol);
635
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
640
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
641
  (register Lisp_Object symbol, Lisp_Object definition)
642
{
643 644
  register Lisp_Object function;

645
  CHECK_SYMBOL (symbol);
646
  if (NILP (symbol) || EQ (symbol, Qt))
647
    xsignal1 (Qsetting_constant, symbol);
648 649 650 651 652 653 654 655 656

  function = XSYMBOL (symbol)->function;

  if (!NILP (Vautoload_queue) && !EQ (function, Qunbound))
    Vautoload_queue = Fcons (Fcons (symbol, function), Vautoload_queue);

  if (CONSP (function) && EQ (XCAR (function), Qautoload))
    Fput (symbol, Qautoload, XCDR (function));

657
  XSYMBOL (symbol)->function = definition;
658
  /* Handle automatic advice activation */
659
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
660
    {
661
      call2 (Qad_activate_internal, symbol, Qnil);
662
      definition = XSYMBOL (symbol)->function;
663
    }
664
  return definition;
Jim Blandy's avatar
Jim Blandy committed
665 666
}

667 668 669
extern Lisp_Object Qfunction_documentation;

DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
670
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
Richard M. Stallman's avatar
Richard M. Stallman committed
671 672 673 674
Associates the function with the current load file, if any.
The optional third argument DOCSTRING specifies the documentation string
for SYMBOL; if it is omitted or nil, SYMBOL uses the documentation string
determined by DEFINITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
675
  (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
676
{
677
  CHECK_SYMBOL (symbol);
678 679 680
  if (CONSP (XSYMBOL (symbol)->function)
      && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, symbol));
681
  definition = Ffset (symbol, definition);
682
  LOADHIST_ATTACH (Fcons (Qdefun, symbol));
683 684
  if (!NILP (docstring))
    Fput (symbol, Qfunction_documentation, docstring);
685
  return definition;
686 687
}

Jim Blandy's avatar
Jim Blandy committed
688
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
689
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
690
  (register Lisp_Object symbol, Lisp_Object newplist)
Jim Blandy's avatar
Jim Blandy committed
691
{
692
  CHECK_SYMBOL (symbol);
693
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
694 695
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
696

697
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
698 699 700 701 702
       doc: /* Return minimum and maximum number of args allowed for SUBR.
SUBR must be a built-in function.
The returned value is a pair (MIN . MAX).  MIN is the minimum number
of args.  MAX is the maximum number or the symbol `many', for a
function with `&rest' args, or `unevalled' for a special form.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
703
  (Lisp_Object subr)
704 705
{
  short minargs, maxargs;
706
  CHECK_SUBR (subr);
707 708 709 710 711 712 713 714 715 716
  minargs = XSUBR (subr)->min_args;
  maxargs = XSUBR (subr)->max_args;
  if (maxargs == MANY)
    return Fcons (make_number (minargs), Qmany);
  else if (maxargs == UNEVALLED)
    return Fcons (make_number (minargs), Qunevalled);
  else
    return Fcons (make_number (minargs), make_number (maxargs));
}

Stefan Monnier's avatar
Stefan Monnier committed
717 718 719
DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
       doc: /* Return name of subroutine SUBR.
SUBR must be a built-in function.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
720
  (Lisp_Object subr)
Stefan Monnier's avatar
Stefan Monnier committed
721 722
{
  const char *name;
723
  CHECK_SUBR (subr);
Stefan Monnier's avatar
Stefan Monnier committed
724 725 726 727
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

Kenichi Handa's avatar
Kenichi Handa committed
728 729
DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
       doc: /* Return the interactive form of CMD or nil if none.
Luc Teirlinck's avatar
Luc Teirlinck committed
730 731
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
732
  (Lisp_Object cmd)
733
{
734
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
735

736 737 738 739 740 741 742 743
  if (NILP (fun) || EQ (fun, Qunbound))
    return Qnil;

  /* Use an `interactive-form' property if present, analogous to the
     function-documentation property. */
  fun = cmd;
  while (SYMBOLP (fun))
    {
744
      Lisp_Object tmp = Fget (fun, Qinteractive_form);
745 746 747 748 749
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
Kenichi Handa's avatar
Kenichi Handa committed
750 751 752

  if (SUBRP (fun))
    {
753
      const char *spec = XSUBR (fun)->intspec;
754 755 756 757
      if (spec)
	return list2 (Qinteractive,
		      (*spec != '(') ? build_string (spec) :
		      Fcar (Fread_from_string (build_string (spec), Qnil, Qnil)));
Kenichi Handa's avatar
Kenichi Handa committed
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    }
  else if (COMPILEDP (fun))
    {
      if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE)
	return list2 (Qinteractive, AREF (fun, COMPILED_INTERACTIVE));
    }
  else if (CONSP (fun))
    {
      Lisp_Object funcar = XCAR (fun);
      if (EQ (funcar, Qlambda))
	return Fassq (Qinteractive, Fcdr (XCDR (fun)));
      else if (EQ (funcar, Qautoload))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (cmd);
	  do_autoload (fun, cmd);
	  UNGCPRO;
	  return Finteractive_form (cmd);
	}
    }
778 779 780
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
781

782 783 784 785 786 787 788 789
/***********************************************************************
		Getting and Setting Values of Symbols
 ***********************************************************************/

/* Return the symbol holding SYMBOL's value.  Signal
   `cyclic-variable-indirection' if SYMBOL's chain of variable
   indirections contains a loop.  */

Stefan Monnier's avatar
Stefan Monnier committed
790
struct Lisp_Symbol *
791
indirect_variable (struct Lisp_Symbol *symbol)
792
{
Stefan Monnier's avatar
Stefan Monnier committed
793
  struct Lisp_Symbol *tortoise, *hare;
794 795 796

  hare = tortoise = symbol;

797
  while (hare->redirect == SYMBOL_VARALIAS)
798
    {
799 800
      hare = SYMBOL_ALIAS (hare);
      if (hare->redirect != SYMBOL_VARALIAS)
801
	break;
802

803 804
      hare = SYMBOL_ALIAS (hare);
      tortoise = SYMBOL_ALIAS (tortoise);
805

Stefan Monnier's avatar
Stefan Monnier committed
806 807 808 809 810 811
      if (hare == tortoise)
	{
	  Lisp_Object tem;
	  XSETSYMBOL (tem, symbol);
	  xsignal1 (Qcyclic_variable_indirection, tem);
	}
812 813 814 815 816 817 818
    }

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
819 820 821 822 823
       doc: /* Return the variable at the end of OBJECT's variable chain.
If OBJECT is a symbol, follow all variable indirections and return the final
variable.  If OBJECT is not a symbol, just return it.
Signal a cyclic-variable-indirection error if there is a loop in the
variable chain of symbols.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
824
  (Lisp_Object object)
825 826
{
  if (SYMBOLP (object))