data.c 95.2 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 53 54 55
#if !defined (atof)
extern double atof ();
#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 100 101 102

void
circular_list_error (list)
     Lisp_Object list;
{
103
  xsignal (Qcircular_list, list);
104 105 106
}


Jim Blandy's avatar
Jim Blandy committed
107 108 109 110
Lisp_Object
wrong_type_argument (predicate, value)
     register Lisp_Object predicate, value;
{
111 112 113 114 115 116
  /* 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 (); */
117

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

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

void
args_out_of_range (a1, a2)
     Lisp_Object a1, a2;
{
131
  xsignal2 (Qargs_out_of_range, a1, a2);
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137
}

void
args_out_of_range_3 (a1, a2, a3)
     Lisp_Object a1, a2, a3;
{
138
  xsignal3 (Qargs_out_of_range, a1, a2, a3);
Jim Blandy's avatar
Jim Blandy committed
139 140 141 142 143 144 145 146 147 148 149
}

/* 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
sign_extend_lisp_int (num)
150
     EMACS_INT num;
Jim Blandy's avatar
Jim Blandy committed
151
{
152 153
  if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
    return num | (((EMACS_INT) (-1)) << VALBITS);
Jim Blandy's avatar
Jim Blandy committed
154
  else
155
    return num & ((((EMACS_INT) 1) << VALBITS) - 1);
Jim Blandy's avatar
Jim Blandy committed
156 157 158 159 160
}

/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
161 162
       doc: /* Return t if the two args are the same Lisp object.  */)
     (obj1, obj2)
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169
     Lisp_Object obj1, obj2;
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

170 171 172
DEFUN ("null", Fnull, Snull, 1, 1, 0,
       doc: /* Return t if OBJECT is nil.  */)
     (object)
173
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
174
{
175
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
176 177 178 179
    return Qt;
  return Qnil;
}

180
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
181 182 183 184
       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'.  */)
     (object)
185 186
     Lisp_Object object;
{
187
  switch (XTYPE (object))
188
    {
189
    case_Lisp_Int:
190 191 192 193 194 195 196 197 198 199 200 201
      return Qinteger;

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

    case Lisp_Misc:
202
      switch (XMISCTYPE (object))
203 204 205 206 207 208 209 210 211 212 213
	{
	case Lisp_Misc_Marker:
	  return Qmarker;
	case Lisp_Misc_Overlay:
	  return Qoverlay;
	case Lisp_Misc_Float:
	  return Qfloat;
	}
      abort ();

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

250 251 252
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
     (object)
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 Qt;
  return Qnil;
}

260
DEFUN ("atom", Fatom, Satom, 1, 1, 0,
261 262
       doc: /* Return t if OBJECT is not a cons cell.  This includes nil.  */)
     (object)
263
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
264
{
265
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
266 267 268 269
    return Qnil;
  return Qt;
}

270
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
Luc Teirlinck's avatar
Luc Teirlinck committed
271 272
       doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
Otherwise, return nil.  */)
273
     (object)
274
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
275
{
276
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280
    return Qt;
  return Qnil;
}

281
DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
282 283
       doc: /* Return t if OBJECT is not a list.  Lists include nil.  */)
     (object)
284
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
285
{
286
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290
    return Qnil;
  return Qt;
}

291
DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
292 293
       doc: /* Return t if OBJECT is a symbol.  */)
     (object)
294
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
295
{
296
  if (SYMBOLP (object))
Jim Blandy's avatar
Jim Blandy committed
297 298 299 300
    return Qt;
  return Qnil;
}

Dave Love's avatar
Dave Love committed
301 302 303
/* Define this in C to avoid unnecessarily consing up the symbol
   name.  */
DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
304 305 306 307
       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.  */)
     (object)
Dave Love's avatar
Dave Love committed
308 309 310
     Lisp_Object object;
{
  if (SYMBOLP (object)
311
      && SREF (SYMBOL_NAME (object), 0) == ':'
312
      && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
Dave Love's avatar
Dave Love committed
313 314 315 316
    return Qt;
  return Qnil;
}

317
DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
318 319
       doc: /* Return t if OBJECT is a vector.  */)
     (object)
320
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
321
{
322
  if (VECTORP (object))
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326
    return Qt;
  return Qnil;
}

327
DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
328 329
       doc: /* Return t if OBJECT is a string.  */)
     (object)
330
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
331
{
332
  if (STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336
    return Qt;
  return Qnil;
}

337
DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
338 339 340
       1, 1, 0,
       doc: /* Return t if OBJECT is a multibyte string.  */)
     (object)
341 342 343 344 345 346 347 348
     Lisp_Object object;
{
  if (STRINGP (object) && STRING_MULTIBYTE (object))
    return Qt;
  return Qnil;
}

DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
349 350
       doc: /* Return t if OBJECT is a char-table.  */)
     (object)
351 352 353 354 355 356 357
     Lisp_Object object;
{
  if (CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

358 359
DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
       Svector_or_char_table_p, 1, 1, 0,
360 361
       doc: /* Return t if OBJECT is a char-table or vector.  */)
     (object)
362 363 364 365 366 367 368
     Lisp_Object object;
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

369 370 371
DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
       doc: /* Return t if OBJECT is a bool-vector.  */)
     (object)
372 373 374 375 376 377 378
     Lisp_Object object;
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

379 380 381
DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
       doc: /* Return t if OBJECT is an array (string or vector).  */)
     (object)
382
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
383
{
384
  if (ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389
    return Qt;
  return Qnil;
}

DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
390 391
       doc: /* Return t if OBJECT is a sequence (list or array).  */)
     (object)
392
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
393
{
394
  if (CONSP (object) || NILP (object) || ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398
    return Qt;
  return Qnil;
}

399 400 401
DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
       doc: /* Return t if OBJECT is an editor buffer.  */)
     (object)
402
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
403
{
404
  if (BUFFERP (object))
Jim Blandy's avatar
Jim Blandy committed
405 406 407 408
    return Qt;
  return Qnil;
}

409 410 411
DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
       doc: /* Return t if OBJECT is a marker (editor pointer).  */)
     (object)
412
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
413
{
414
  if (MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418
    return Qt;
  return Qnil;
}

419 420 421
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
       doc: /* Return t if OBJECT is a built-in function.  */)
     (object)
422
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
423
{
424
  if (SUBRP (object))
Jim Blandy's avatar
Jim Blandy committed
425 426 427 428
    return Qt;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
429
DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
430 431 432
       1, 1, 0,
       doc: /* Return t if OBJECT is a byte-compiled function object.  */)
     (object)
433
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
434
{
435
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439
    return Qt;
  return Qnil;
}

440
DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
441
       doc: /* Return t if OBJECT is a character or a string.  */)
442
     (object)
443
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
444
{
445
  if (CHARACTERP (object) || STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449
    return Qt;
  return Qnil;
}

450 451 452
DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
       doc: /* Return t if OBJECT is an integer.  */)
     (object)
453
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
454
{
455
  if (INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459
    return Qt;
  return Qnil;
}

460
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
461 462
       doc: /* Return t if OBJECT is an integer or a marker (editor pointer).  */)
     (object)
463
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
464
{
465
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
    return Qt;
  return Qnil;
}

470
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
471 472
       doc: /* Return t if OBJECT is a nonnegative integer.  */)
     (object)
473
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
474
{
475
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
476 477 478 479 480
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
481 482
       doc: /* Return t if OBJECT is a number (floating point or integer).  */)
     (object)
483
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
484
{
485
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
486
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
487 488
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
493 494
       doc: /* Return t if OBJECT is a number or a marker.  */)
     (object)
495
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
496
{
497
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
498 499 500
    return Qt;
  return Qnil;
}
501 502

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
503 504
       doc: /* Return t if OBJECT is a floating point number.  */)
     (object)
505
     Lisp_Object object;
506
{
507
  if (FLOATP (object))
508 509 510
    return Qt;
  return Qnil;
}
511

Jim Blandy's avatar
Jim Blandy committed
512 513 514 515

/* Extract and set components of lists */

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

Luc Teirlinck's avatar
Luc Teirlinck committed
519 520
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as car, cdr, cons cell and list.  */)
521
     (list)
Jim Blandy's avatar
Jim Blandy committed
522 523
     register Lisp_Object list;
{
524
  return CAR (list);
Jim Blandy's avatar
Jim Blandy committed
525 526 527
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
528 529
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
530 531
     Lisp_Object object;
{
532
  return CAR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
533 534 535
}

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

Luc Teirlinck's avatar
Luc Teirlinck committed
539 540
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as cdr, car, cons cell and list.  */)
541
     (list)
Jim Blandy's avatar
Jim Blandy committed
542 543
     register Lisp_Object list;
{
544
  return CDR (list);
Jim Blandy's avatar
Jim Blandy committed
545 546 547
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
548 549
       doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
550 551
     Lisp_Object object;
{
552
  return CDR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
553 554 555
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
556 557
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
     (cell, newcar)
Jim Blandy's avatar
Jim Blandy committed
558 559
     register Lisp_Object cell, newcar;
{
560
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
561
  CHECK_IMPURE (cell);
562
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
567 568
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
     (cell, newcdr)
Jim Blandy's avatar
Jim Blandy committed
569 570
     register Lisp_Object cell, newcdr;
{
571
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
572
  CHECK_IMPURE (cell);
573
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577 578
  return newcdr;
}

/* Extract and set components of symbols */

579 580 581
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
     (symbol)
582
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
583 584
{
  Lisp_Object valcontents;
585
  struct Lisp_Symbol *sym;
586
  CHECK_SYMBOL (symbol);
587
  sym = XSYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
 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
614

615
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
616 617
}

618 619 620
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's function definition is not void.  */)
     (symbol)
621
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
622
{
623
  CHECK_SYMBOL (symbol);
624
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
625 626
}

627
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
628 629
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
630
     (symbol)
631
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
632
{
633
  CHECK_SYMBOL (symbol);
634
  if (SYMBOL_CONSTANT_P (symbol))
635
    xsignal1 (Qsetting_constant, symbol);
636 637
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
638 639
}

640
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
641 642
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
643
     (symbol)
644
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
645
{
646
  CHECK_SYMBOL (symbol);
647
  if (NILP (symbol) || EQ (symbol, Qt))
648
    xsignal1 (Qsetting_constant, symbol);
649 650
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
651 652 653
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
654 655
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
     (symbol)
Jim Blandy's avatar
Jim Blandy committed
656
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
657
{
658
  CHECK_SYMBOL (symbol);
659 660 661
  if (!EQ (XSYMBOL (symbol)->function, Qunbound))
    return XSYMBOL (symbol)->function;
  xsignal1 (Qvoid_function, symbol);
Jim Blandy's avatar
Jim Blandy committed
662 663
}

664 665 666
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
     (symbol)
667
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
668
{
669
  CHECK_SYMBOL (symbol);
670
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
671 672
}

673 674 675
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
     (symbol)
676
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
677 678 679
{
  register Lisp_Object name;

680
  CHECK_SYMBOL (symbol);
681
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
686 687
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
     (symbol, definition)
688
     register Lisp_Object symbol, definition;
689
{
690 691
  register Lisp_Object function;

692
  CHECK_SYMBOL (symbol);
693
  if (NILP (symbol) || EQ (symbol, Qt))
694
    xsignal1 (Qsetting_constant, symbol);
695 696 697 698 699 700 701 702 703

  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));

704
  XSYMBOL (symbol)->function = definition;
705
  /* Handle automatic advice activation */
706
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
707
    {
708
      call2 (Qad_activate_internal, symbol, Qnil);
709
      definition = XSYMBOL (symbol)->function;
710
    }
711
  return definition;
Jim Blandy's avatar
Jim Blandy committed
712 713
}

714 715 716
extern Lisp_Object Qfunction_documentation;

DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
717
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
Richard M. Stallman's avatar
Richard M. Stallman committed
718 719 720 721
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.  */)
722 723
     (symbol, definition, docstring)
     register Lisp_Object symbol, definition, docstring;
724
{
725
  CHECK_SYMBOL (symbol);
726 727 728
  if (CONSP (XSYMBOL (symbol)->function)
      && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, symbol));
729
  definition = Ffset (symbol, definition);
730
  LOADHIST_ATTACH (Fcons (Qdefun, symbol));
731 732
  if (!NILP (docstring))
    Fput (symbol, Qfunction_documentation, docstring);
733
  return definition;
734 735
}

Jim Blandy's avatar
Jim Blandy committed
736
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
737
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
738
     (symbol, newplist)
739
     register Lisp_Object symbol, newplist;
Jim Blandy's avatar
Jim Blandy committed
740
{
741
  CHECK_SYMBOL (symbol);
742
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
743 744
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
745

746
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
747 748 749 750 751 752
       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.  */)
     (subr)
753 754 755
     Lisp_Object subr;
{
  short minargs, maxargs;
756
  CHECK_SUBR (subr);
757 758 759 760 761 762 763 764 765 766
  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
767 768 769 770 771 772 773
DEFUN ("subr-name", Fsubr_name, Ssubr_name, 1, 1, 0,
       doc: /* Return name of subroutine SUBR.
SUBR must be a built-in function.  */)
     (subr)
     Lisp_Object subr;
{
  const char *name;
774
  CHECK_SUBR (subr);
Stefan Monnier's avatar
Stefan Monnier committed
775 776 777 778
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

Kenichi Handa's avatar
Kenichi Handa committed
779 780
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
781 782
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
Kenichi Handa's avatar
Kenichi Handa committed
783 784
     (cmd)
     Lisp_Object cmd;
785
{
786
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
787

788 789 790 791 792 793 794 795
  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))
    {
796
      Lisp_Object tmp = Fget (fun, Qinteractive_form);
797 798 799 800 801
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
Kenichi Handa's avatar
Kenichi Handa committed
802 803 804

  if (SUBRP (fun))
    {
805 806 807 808 809
      char *spec = XSUBR (fun)->intspec;
      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
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
    }
  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);
	}
    }
830 831 832
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
833

834 835 836 837 838 839 840 841
/***********************************************************************
		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
842
struct Lisp_Symbol *
843
indirect_variable (symbol)
Stefan Monnier's avatar
Stefan Monnier committed
844
     struct Lisp_Symbol *symbol;
845
{
Stefan Monnier's avatar
Stefan Monnier committed
846
  struct Lisp_Symbol *tortoise, *hare;
847 848 849

  hare = tortoise = symbol;

850
  while (hare->redirect == SYMBOL_VARALIAS)