data.c 93.1 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>
Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "puresize.h"
27
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include "keyboard.h"
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "syssignal.h"
32
#include "termhooks.h"  /* For FRAME_KBOARD reference in y-or-n-p. */
33
#include "font.h"
Jim Blandy's avatar
Jim Blandy committed
34

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

39 40 41 42 43 44 45 46 47 48
/* 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
49 50
#include <math.h>

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

Jim Blandy's avatar
Jim Blandy committed
55 56 57
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
58
Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
59
Lisp_Object Qcyclic_variable_indirection, Qcircular_list;
Jim Blandy's avatar
Jim Blandy committed
60 61
Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
Roland McGrath's avatar
Roland McGrath committed
62
Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
63
Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
64
Lisp_Object Qtext_read_only;
Kenichi Handa's avatar
Kenichi Handa committed
65

66
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
67 68
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
69
Lisp_Object Qbuffer_or_string_p, Qkeywordp;
Jim Blandy's avatar
Jim Blandy committed
70
Lisp_Object Qboundp, Qfboundp;
71
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
72

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
82 83
Lisp_Object Qinteger;
static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
84 85
Lisp_Object Qwindow;
static Lisp_Object Qfloat, Qwindow_configuration;
Karl Heuer's avatar
Karl Heuer committed
86
Lisp_Object Qprocess;
87
static Lisp_Object Qcompiled_function, Qfunction_vector, 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 97

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


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

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

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

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

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


/* Data type predicates */

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

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

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

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

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

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

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

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

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

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

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

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

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

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

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

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

336 337
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
338
  (Lisp_Object object)
339 340 341 342 343 344
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

400 401
DEFUN ("funvecp", Ffunvecp, Sfunvecp, 1, 1, 0,
       doc: /* Return t if OBJECT is a `function vector' object.  */)
Stefan Monnier's avatar
Stefan Monnier committed
402
     (Lisp_Object object)
403 404 405 406
{
  return FUNVECP (object) ? Qt : Qnil;
}

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

425
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
426
       doc: /* Return t if OBJECT is an integer or a marker (editor pointer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
427
  (register Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
428
{
429
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
430 431 432 433
    return Qt;
  return Qnil;
}

434
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
435
       doc: /* Return t if OBJECT is a nonnegative integer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
436
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
437
{
438
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442 443
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
444
       doc: /* Return t if OBJECT is a number (floating point or integer).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
445
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
446
{
447
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
448
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
449 450
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
455
       doc: /* Return t if OBJECT is a number or a marker.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
456
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
457
{
458
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
459 460 461
    return Qt;
  return Qnil;
}
462 463

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
464
       doc: /* Return t if OBJECT is a floating point number.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
465
  (Lisp_Object object)
466
{
467
  if (FLOATP (object))
468 469 470
    return Qt;
  return Qnil;
}
471

Jim Blandy's avatar
Jim Blandy committed
472 473 474 475

/* Extract and set components of lists */

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

Luc Teirlinck's avatar
Luc Teirlinck committed
479 480
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
481
  (register Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
482
{
483
  return CAR (list);
Jim Blandy's avatar
Jim Blandy committed
484 485 486
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
487
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
488
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
489
{
490
  return CAR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
491 492 493
}

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

Luc Teirlinck's avatar
Luc Teirlinck committed
497 498
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
499
  (register Lisp_Object list)
Jim Blandy's avatar
Jim Blandy committed
500
{
501
  return CDR (list);
Jim Blandy's avatar
Jim Blandy committed
502 503 504
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
505
       doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
506
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
507
{
508
  return CDR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
509 510 511
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
512
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
513
  (register Lisp_Object cell, Lisp_Object newcar)
Jim Blandy's avatar
Jim Blandy committed
514
{
515
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
516
  CHECK_IMPURE (cell);
517
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
522
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
523
  (register Lisp_Object cell, Lisp_Object newcdr)
Jim Blandy's avatar
Jim Blandy committed
524
{
525
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
526
  CHECK_IMPURE (cell);
527
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531 532
  return newcdr;
}

/* Extract and set components of symbols */

533 534
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
535
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
536 537
{
  Lisp_Object valcontents;
538
  struct Lisp_Symbol *sym;
539
  CHECK_SYMBOL (symbol);
540
  sym = XSYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
 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
567

568
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
569 570
}

571 572
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
573
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
574
{
575
  CHECK_SYMBOL (symbol);
576
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
577 578
}

579
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
580 581
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
582
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
583
{
584
  CHECK_SYMBOL (symbol);
585
  if (SYMBOL_CONSTANT_P (symbol))
586
    xsignal1 (Qsetting_constant, symbol);
587 588
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
589 590
}

591
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
592 593
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
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
  if (NILP (symbol) || EQ (symbol, Qt))
598
    xsignal1 (Qsetting_constant, symbol);
599 600
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
601 602 603
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
604
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
605
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
606
{
607
  CHECK_SYMBOL (symbol);
608 609 610
  if (!EQ (XSYMBOL (symbol)->function, Qunbound))
    return XSYMBOL (symbol)->function;
  xsignal1 (Qvoid_function, symbol);
Jim Blandy's avatar
Jim Blandy committed
611 612
}

613 614
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
615
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
616
{
617
  CHECK_SYMBOL (symbol);
618
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
619 620
}

621 622
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
623
  (register Lisp_Object symbol)
Jim Blandy's avatar
Jim Blandy committed
624 625 626
{
  register Lisp_Object name;

627
  CHECK_SYMBOL (symbol);
628
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
629 630 631 632
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
633
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
634
  (register Lisp_Object symbol, Lisp_Object definition)
635
{
636 637
  register Lisp_Object function;

638
  CHECK_SYMBOL (symbol);
639
  if (NILP (symbol) || EQ (symbol, Qt))
640
    xsignal1 (Qsetting_constant, symbol);
641 642 643 644 645 646 647 648 649

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

650
  XSYMBOL (symbol)->function = definition;
651
  /* Handle automatic advice activation */
652
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
653
    {
654
      call2 (Qad_activate_internal, symbol, Qnil);
655
      definition = XSYMBOL (symbol)->function;
656
    }
657
  return definition;
Jim Blandy's avatar
Jim Blandy committed
658 659
}

660
DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
661
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
Richard M. Stallman's avatar
Richard M. Stallman committed
662 663 664 665
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
666
  (register Lisp_Object symbol, Lisp_Object definition, Lisp_Object docstring)
667
{
668
  CHECK_SYMBOL (symbol);
669 670 671
  if (CONSP (XSYMBOL (symbol)->function)
      && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, symbol));
672
  definition = Ffset (symbol, definition);
673
  LOADHIST_ATTACH (Fcons (Qdefun, symbol));
674 675
  if (!NILP (docstring))
    Fput (symbol, Qfunction_documentation, docstring);
676
  return definition;
677 678
}

Jim Blandy's avatar
Jim Blandy committed
679
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
680
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
681
  (register Lisp_Object symbol, Lisp_Object newplist)
Jim Blandy's avatar
Jim Blandy committed
682
{
683
  CHECK_SYMBOL (symbol);
684
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
685 686
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
687

688
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
689 690 691 692 693
       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
694
  (Lisp_Object subr)
695 696
{
  short minargs, maxargs;
697
  CHECK_SUBR (subr);
698 699 700 701 702 703 704 705 706 707
  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
708 709 710
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
711
  (Lisp_Object subr)
Stefan Monnier's avatar
Stefan Monnier committed
712 713
{
  const char *name;
714
  CHECK_SUBR (subr);
Stefan Monnier's avatar
Stefan Monnier committed
715 716 717 718
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

Kenichi Handa's avatar
Kenichi Handa committed
719 720
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
721 722
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
723
  (Lisp_Object cmd)
724
{
725
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
726

727 728 729 730 731 732 733 734
  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))
    {
735
      Lisp_Object tmp = Fget (fun, Qinteractive_form);
736 737 738 739 740
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
Kenichi Handa's avatar
Kenichi Handa committed
741 742 743

  if (SUBRP (fun))
    {
744
      const char *spec = XSUBR (fun)->intspec;
745 746 747 748
      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
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
    }
  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);
	}
    }
769 770 771
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
772

773 774 775 776 777 778 779 780
/***********************************************************************
		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
781
struct Lisp_Symbol *
782
indirect_variable (struct Lisp_Symbol *symbol)
783
{
Stefan Monnier's avatar
Stefan Monnier committed
784
  struct Lisp_Symbol *tortoise, *hare;
785 786 787

  hare = tortoise = symbol;

788
  while (hare->redirect == SYMBOL_VARALIAS)
789
    {
790 791
      hare = SYMBOL_ALIAS (hare);
      if (hare->redirect != SYMBOL_VARALIAS)
792
	break;