data.c 91.3 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-1995, 1997-2011
Glenn Morris's avatar
Glenn Morris committed
3
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19 20


21
#include <config.h>
22
#include <signal.h>
23
#include <stdio.h>
24
#include <setjmp.h>
25 26 27

#include <intprops.h>

Jim Blandy's avatar
Jim Blandy committed
28
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "puresize.h"
30
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include "keyboard.h"
33
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
34
#include "syssignal.h"
35
#include "termhooks.h"  /* For FRAME_KBOARD reference in y-or-n-p.  */
36
#include "font.h"
Jim Blandy's avatar
Jim Blandy committed
37

38
#ifdef STDC_HEADERS
39
#include <float.h>
40
#endif
41

42
/* If IEEE_FLOATING_POINT isn't defined, default it from FLT_*.  */
43 44 45 46 47 48 49 50 51
#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
52 53
#include <math.h>

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

70 71
Lisp_Object Qintegerp, Qwholenump, Qsymbolp, Qlistp, Qconsp;
static Lisp_Object Qnatnump;
Jim Blandy's avatar
Jim Blandy committed
72 73
Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
74 75 76
Lisp_Object Qbuffer_or_string_p;
static Lisp_Object Qkeywordp, Qboundp;
Lisp_Object Qfboundp;
77
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
78

Jim Blandy's avatar
Jim Blandy committed
79
Lisp_Object Qcdr;
80
static Lisp_Object Qad_advice_info, Qad_activate_internal;
Jim Blandy's avatar
Jim Blandy committed
81

82 83 84
Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
Lisp_Object Qoverflow_error, Qunderflow_error;

85
Lisp_Object Qfloatp;
Jim Blandy's avatar
Jim Blandy committed
86 87
Lisp_Object Qnumberp, Qnumber_or_marker_p;

Kenichi Handa's avatar
Kenichi Handa committed
88 89
Lisp_Object Qinteger;
static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
90 91
Lisp_Object Qwindow;
static Lisp_Object Qfloat, Qwindow_configuration;
92
static Lisp_Object Qprocess;
93
Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
Gerd Moellmann's avatar
Gerd Moellmann committed
94
static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
95
static Lisp_Object Qsubrp, Qmany, Qunevalled;
96
Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
97

98 99
Lisp_Object Qinteractive_form;

100
static void swap_in_symval_forwarding (struct Lisp_Symbol *, struct Lisp_Buffer_Local_Value *);
101

102

Jim Blandy's avatar
Jim Blandy committed
103
Lisp_Object
104
wrong_type_argument (register Lisp_Object predicate, register Lisp_Object value)
Jim Blandy's avatar
Jim Blandy committed
105
{
106 107 108 109 110 111
  /* 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 (); */
112

113
  xsignal2 (Qwrong_type_argument, predicate, value);
Jim Blandy's avatar
Jim Blandy committed
114 115
}

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

void
123
args_out_of_range (Lisp_Object a1, Lisp_Object a2)
Jim Blandy's avatar
Jim Blandy committed
124
{
125
  xsignal2 (Qargs_out_of_range, a1, a2);
Jim Blandy's avatar
Jim Blandy committed
126 127 128
}

void
129
args_out_of_range_3 (Lisp_Object a1, Lisp_Object a2, Lisp_Object a3)
Jim Blandy's avatar
Jim Blandy committed
130
{
131
  xsignal3 (Qargs_out_of_range, a1, a2, a3);
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137
}


/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
138
       doc: /* Return t if the two args are the same Lisp object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
139
  (Lisp_Object obj1, Lisp_Object obj2)
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143 144 145
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

146 147
DEFUN ("null", Fnull, Snull, 1, 1, 0,
       doc: /* Return t if OBJECT is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
148
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
149
{
150
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154
    return Qt;
  return Qnil;
}

155
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
156 157 158
       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
159
  (Lisp_Object object)
160
{
161
  switch (XTYPE (object))
162
    {
163
    case_Lisp_Int:
164 165 166 167 168 169 170 171 172 173 174 175
      return Qinteger;

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

    case Lisp_Misc:
176
      switch (XMISCTYPE (object))
177 178 179 180 181 182 183 184 185 186 187
	{
	case Lisp_Misc_Marker:
	  return Qmarker;
	case Lisp_Misc_Overlay:
	  return Qoverlay;
	case Lisp_Misc_Float:
	  return Qfloat;
	}
      abort ();

    case Lisp_Vectorlike:
188
      if (WINDOW_CONFIGURATIONP (object))
189
	return Qwindow_configuration;
190
      if (PROCESSP (object))
191
	return Qprocess;
192
      if (WINDOWP (object))
193
	return Qwindow;
194
      if (SUBRP (object))
195
	return Qsubr;
Stefan Monnier's avatar
Stefan Monnier committed
196 197
      if (COMPILEDP (object))
	return Qcompiled_function;
198
      if (BUFFERP (object))
199
	return Qbuffer;
200
      if (CHAR_TABLE_P (object))
201
	return Qchar_table;
202
      if (BOOL_VECTOR_P (object))
203
	return Qbool_vector;
204
      if (FRAMEP (object))
205
	return Qframe;
206
      if (HASH_TABLE_P (object))
Gerd Moellmann's avatar
Gerd Moellmann committed
207
	return Qhash_table;
208 209 210 211 212 213
      if (FONT_SPEC_P (object))
	return Qfont_spec;
      if (FONT_ENTITY_P (object))
	return Qfont_entity;
      if (FONT_OBJECT_P (object))
	return Qfont_object;
214 215 216 217 218 219 220 221 222 223
      return Qvector;

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

224 225
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
226
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
227
{
228
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232
    return Qt;
  return Qnil;
}

233
DEFUN ("atom", Fatom, Satom, 1, 1, 0,
234
       doc: /* Return t if OBJECT is not a cons cell.  This includes nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
235
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
236
{
237
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
238 239 240 241
    return Qnil;
  return Qt;
}

242
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
Luc Teirlinck's avatar
Luc Teirlinck committed
243 244
       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
245
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
246
{
247
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251
    return Qt;
  return Qnil;
}

252
DEFUN ("nlistp", Fnlistp, Snlistp, 1, 1, 0,
253
       doc: /* Return t if OBJECT is not a list.  Lists include nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
255
{
256
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
257 258 259 260
    return Qnil;
  return Qt;
}

261
DEFUN ("symbolp", Fsymbolp, Ssymbolp, 1, 1, 0,
262
       doc: /* Return t if OBJECT is a symbol.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
264
{
265
  if (SYMBOLP (object))
Jim Blandy's avatar
Jim Blandy committed
266 267 268 269
    return Qt;
  return Qnil;
}

Dave Love's avatar
Dave Love committed
270 271 272
/* Define this in C to avoid unnecessarily consing up the symbol
   name.  */
DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
273 274 275
       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
276
  (Lisp_Object object)
Dave Love's avatar
Dave Love committed
277 278
{
  if (SYMBOLP (object)
279
      && SREF (SYMBOL_NAME (object), 0) == ':'
280
      && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
Dave Love's avatar
Dave Love committed
281 282 283 284
    return Qt;
  return Qnil;
}

285
DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
286
       doc: /* Return t if OBJECT is a vector.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
287
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
288
{
289
  if (VECTORP (object))
Jim Blandy's avatar
Jim Blandy committed
290 291 292 293
    return Qt;
  return Qnil;
}

294
DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
295
       doc: /* Return t if OBJECT is a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
296
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
297
{
298
  if (STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302
    return Qt;
  return Qnil;
}

303
DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
304 305
       1, 1, 0,
       doc: /* Return t if OBJECT is a multibyte string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
306
  (Lisp_Object object)
307 308 309 310 311 312 313
{
  if (STRINGP (object) && STRING_MULTIBYTE (object))
    return Qt;
  return Qnil;
}

DEFUN ("char-table-p", Fchar_table_p, Schar_table_p, 1, 1, 0,
314
       doc: /* Return t if OBJECT is a char-table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
315
  (Lisp_Object object)
316 317 318 319 320 321
{
  if (CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

322 323
DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
       Svector_or_char_table_p, 1, 1, 0,
324
       doc: /* Return t if OBJECT is a char-table or vector.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
325
  (Lisp_Object object)
326 327 328 329 330 331
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

332 333
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
334
  (Lisp_Object object)
335 336 337 338 339 340
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

341 342
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
343
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
344
{
345
  if (ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350
    return Qt;
  return Qnil;
}

DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
351
       doc: /* Return t if OBJECT is a sequence (list or array).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
352
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
353
{
354
  if (CONSP (object) || NILP (object) || ARRAYP (object))
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358
    return Qt;
  return Qnil;
}

359 360
DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
       doc: /* Return t if OBJECT is an editor buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
361
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
362
{
363
  if (BUFFERP (object))
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367
    return Qt;
  return Qnil;
}

368 369
DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
       doc: /* Return t if OBJECT is a marker (editor pointer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
370
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
371
{
372
  if (MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376
    return Qt;
  return Qnil;
}

377 378
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
       doc: /* Return t if OBJECT is a built-in function.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
379
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
380
{
381
  if (SUBRP (object))
Jim Blandy's avatar
Jim Blandy committed
382 383 384 385
    return Qt;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
386
DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
387 388
       1, 1, 0,
       doc: /* Return t if OBJECT is a byte-compiled function object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
389
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
390
{
391
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395
    return Qt;
  return Qnil;
}

396
DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
397
       doc: /* Return t if OBJECT is a character or a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
398
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
399
{
400
  if (CHARACTERP (object) || STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
401 402 403 404
    return Qt;
  return Qnil;
}

405 406
DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0,
       doc: /* Return t if OBJECT is an integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
407
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
408
{
409
  if (INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413
    return Qt;
  return Qnil;
}

414
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
415
       doc: /* Return t if OBJECT is an integer or a marker (editor pointer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
416
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
417
{
418
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
419 420 421 422
    return Qt;
  return Qnil;
}

423
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
424
       doc: /* Return t if OBJECT is a nonnegative integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
425
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
426
{
427
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431 432
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
433
       doc: /* Return t if OBJECT is a number (floating point or integer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
434
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
435
{
436
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
437
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
438 439
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
440 441 442 443
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
444
       doc: /* Return t if OBJECT is a number or a marker.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
445
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
446
{
447
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
448 449 450
    return Qt;
  return Qnil;
}
451 452

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
453
       doc: /* Return t if OBJECT is a floating point number.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
454
  (Lisp_Object object)
455
{
456
  if (FLOATP (object))
457 458 459
    return Qt;
  return Qnil;
}
460

Jim Blandy's avatar
Jim Blandy committed
461 462 463

/* Extract and set components of lists */

Paul Eggert's avatar
Paul Eggert committed
464
DEFUN ("car", Fcar, Scar, 1, 1, 0,
465
       doc: /* Return the car of LIST.  If arg is nil, return nil.
466 467
Error if arg is not nil and not a cons cell.  See also `car-safe'.

Luc Teirlinck's avatar
Luc Teirlinck committed
468 469
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
470
  (register Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
471
{
472
  return CAR (list);
Jim Blandy's avatar
Jim Blandy committed
473 474
}

Paul Eggert's avatar
Paul Eggert committed
475
DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
476
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
477
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
478
{
479
  return CAR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
480 481
}

Paul Eggert's avatar
Paul Eggert committed
482
DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
483
       doc: /* Return the cdr of LIST.  If arg is nil, return nil.
484 485
Error if arg is not nil and not a cons cell.  See also `cdr-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 cdr, car, 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 CDR (list);
Jim Blandy's avatar
Jim Blandy committed
491 492
}

Paul Eggert's avatar
Paul Eggert committed
493
DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
494
       doc: /* Return the cdr 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 CDR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
498 499
}

Paul Eggert's avatar
Paul Eggert committed
500
DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
501
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
502
  (register Lisp_Object cell, Lisp_Object newcar)
Jim Blandy's avatar
Jim Blandy committed
503
{
504
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
505
  CHECK_IMPURE (cell);
506
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
507 508 509
  return newcar;
}

Paul Eggert's avatar
Paul Eggert committed
510
DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
511
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
512
  (register Lisp_Object cell, Lisp_Object newcdr)
Jim Blandy's avatar
Jim Blandy committed
513
{
514
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
515
  CHECK_IMPURE (cell);
516
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521
  return newcdr;
}

/* Extract and set components of symbols */

Paul Eggert's avatar
Paul Eggert committed
522
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
523
       doc: /* Return t if SYMBOL's value is not void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
524
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
525 526
{
  Lisp_Object valcontents;
527
  struct Lisp_Symbol *sym;
528
  CHECK_SYMBOL (symbol);
529
  sym = XSYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
530

531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
 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
556

557
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
558 559
}

Paul Eggert's avatar
Paul Eggert committed
560
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
561
       doc: /* Return t if SYMBOL's function definition is not void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
562
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
563
{
564
  CHECK_SYMBOL (symbol);
565
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
566 567
}

568
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
569 570
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
571
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
572
{
573
  CHECK_SYMBOL (symbol);
574
  if (SYMBOL_CONSTANT_P (symbol))
575
    xsignal1 (Qsetting_constant, symbol);
576 577
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
578 579
}

580
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
581 582
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
583
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
584
{
585
  CHECK_SYMBOL (symbol);
586
  if (NILP (symbol) || EQ (symbol, Qt))
587
    xsignal1 (Qsetting_constant, symbol);
588 589
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
590 591
}

Paul Eggert's avatar
Paul Eggert committed
592
DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
593
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
594
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
595
{
596
  CHECK_SYMBOL (symbol);
597 598 599
  if (!EQ (XSYMBOL (symbol)->function, Qunbound))
    return XSYMBOL (symbol)->function;
  xsignal1 (Qvoid_function, symbol);
Jim Blandy's avatar
Jim Blandy committed
600 601
}

602 603
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
604
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
605
{
606
  CHECK_SYMBOL (symbol);
607
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
608 609
}

Paul Eggert's avatar
Paul Eggert committed
610
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
611
       doc: /* Return SYMBOL's name, a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
612
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
613 614 615
{
  register Lisp_Object name;

616
  CHECK_SYMBOL (symbol);
617
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
618 619 620
  return name;
}

Paul Eggert's avatar
Paul Eggert committed
621
DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
622
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
623
  (register Lisp_Object symbol, Lisp_Object definition)
624
{
625 626
  register Lisp_Object function;

627
  CHECK_SYMBOL (symbol);
628
  if (NILP (symbol) || EQ (symbol, Qt))
629
    xsignal1 (Qsetting_constant, symbol);
630 631 632 633 634 635 636 637 638

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

639
  XSYMBOL (symbol)->function = definition;
640
  /* Handle automatic advice activation */
641
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
642
    {
643
      call2 (Qad_activate_internal, symbol, Qnil);
644
      definition = XSYMBOL (symbol)->function;
645
    }
646
  return definition;
Jim Blandy's avatar
Jim Blandy committed
647 648
}

649
DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
650
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
Richard M. Stallman's avatar
Richard M. Stallman committed
651 652 653 654
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
655
  (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
656
{
657
  CHECK_SYMBOL (symbol);
658 659 660
  if (CONSP (XSYMBOL (symbol)->function)
      && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, symbol));
661
  definition = Ffset (symbol, definition);
662
  LOADHIST_ATTACH (Fcons (Qdefun, symbol));
663 664
  if (!NILP (docstring))
    Fput (symbol, Qfunction_documentation, docstring);
665
  return definition;
666 667
}

Jim Blandy's avatar
Jim Blandy committed
668
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
669
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
670
  (register Lisp_Object symbol, Lisp_Object newplist)
Jim Blandy's avatar
Jim Blandy committed
671
{
672
  CHECK_SYMBOL (symbol);
673
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
674 675
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
676

677
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
678 679 680 681 682
       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
683
  (Lisp_Object subr)
684 685
{
  short minargs, maxargs;
686
  CHECK_SUBR (subr);
687 688 689 690 691 692 693 694 695 696
  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
697 698 699
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
700
  (Lisp_Object subr)
Stefan Monnier's avatar
Stefan Monnier committed
701 702
{
  const char *name;
703
  CHECK_SUBR (subr);
Stefan Monnier's avatar
Stefan Monnier committed
704 705 706 707
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

Paul Eggert's avatar
Paul Eggert committed
708
DEFUN ("interactive-form", Finteractive_form, Sinteractive_form, 1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
709
       doc: /* Return the interactive form of CMD or nil if none.
Luc Teirlinck's avatar
Luc Teirlinck committed
710 711
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
712
  (Lisp_Object cmd)
713
{
714
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
715

716 717 718 719 720 721 722 723
  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))
    {
724
      Lisp_Object tmp = Fget (fun, Qinteractive_form);
725 726 727 728 729
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
Kenichi Handa's avatar
Kenichi Handa committed
730 731 732

  if (SUBRP (fun))
    {
733
      const char *spec = XSUBR (fun)->intspec;
734 735 736 737
      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
738 739 740 741 742 743 744 745 746
    }
  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);
747
      if (EQ (funcar, Qclosure))
748 749
	return Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun))));
      else if (EQ (funcar, Qlambda))
Kenichi Handa's avatar
Kenichi Handa committed
750 751 752 753 754 755 756 757 758 759
	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);
	}
    }
760 761 762
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
763

764 765 766 767 768 769 770 771
/***********************************************************************
		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
772
struct Lisp_Symbol *
773
indirect_variable (struct Lisp_Symbol *symbol)
774
{
Stefan Monnier's avatar
Stefan Monnier committed
775
  struct Lisp_Symbol *tortoise, *hare;
776 777 778

  hare = tortoise = symbol;

779
  while (hare->redirect == SYMBOL_VARALIAS)
780
    {