data.c 92.8 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
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 Lisp_Object swap_in_symval_forwarding P_ ((Lisp_Object, Lisp_Object));
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
  /* If VALUE is not even a valid Lisp object, abort here
     where we can get a backtrace showing where it came from.  */
113
  if ((unsigned int) XTYPE (value) >= Lisp_Type_Limit)
114
    abort ();
115

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

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

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

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

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

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

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

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

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

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

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

248 249 250
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
     (object)
251
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
252
{
253
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

335
DEFUN ("multibyte-string-p", Fmultibyte_string_p, Smultibyte_string_p,
336 337 338
       1, 1, 0,
       doc: /* Return t if OBJECT is a multibyte string.  */)
     (object)
339 340 341 342 343 344 345 346
     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,
347 348
       doc: /* Return t if OBJECT is a char-table.  */)
     (object)
349 350 351 352 353 354 355
     Lisp_Object object;
{
  if (CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

577 578 579
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
     (symbol)
580
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
581 582
{
  Lisp_Object valcontents;
583
  CHECK_SYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
584

585
  valcontents = SYMBOL_VALUE (symbol);
Jim Blandy's avatar
Jim Blandy committed
586

587
  if (BUFFER_LOCAL_VALUEP (valcontents))
588
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
589

590
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
591 592
}

593 594 595
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's function definition is not void.  */)
     (symbol)
596
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
597
{
598
  CHECK_SYMBOL (symbol);
599
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
600 601
}

602
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
603 604
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
605
     (symbol)
606
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
607
{
608
  CHECK_SYMBOL (symbol);
609
  if (SYMBOL_CONSTANT_P (symbol))
610
    xsignal1 (Qsetting_constant, symbol);
611 612
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
613 614
}

615
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
616 617
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
618
     (symbol)
619
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
620
{
621
  CHECK_SYMBOL (symbol);
622
  if (NILP (symbol) || EQ (symbol, Qt))
623
    xsignal1 (Qsetting_constant, symbol);
624 625
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
626 627 628
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
629 630
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
     (symbol)
Jim Blandy's avatar
Jim Blandy committed
631
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
632
{
633
  CHECK_SYMBOL (symbol);
634 635 636
  if (!EQ (XSYMBOL (symbol)->function, Qunbound))
    return XSYMBOL (symbol)->function;
  xsignal1 (Qvoid_function, symbol);
Jim Blandy's avatar
Jim Blandy committed
637 638
}

639 640 641
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
     (symbol)
642
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
643
{
644
  CHECK_SYMBOL (symbol);
645
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
646 647
}

648 649 650
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
     (symbol)
651
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
652 653 654
{
  register Lisp_Object name;

655
  CHECK_SYMBOL (symbol);
656
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
661 662
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
     (symbol, definition)
663
     register Lisp_Object symbol, definition;
664
{
665 666
  register Lisp_Object function;

667
  CHECK_SYMBOL (symbol);
668
  if (NILP (symbol) || EQ (symbol, Qt))
669
    xsignal1 (Qsetting_constant, symbol);
670 671 672 673 674 675 676 677 678

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

679
  XSYMBOL (symbol)->function = definition;
680
  /* Handle automatic advice activation */
681
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
682
    {
683
      call2 (Qad_activate_internal, symbol, Qnil);
684
      definition = XSYMBOL (symbol)->function;
685
    }
686
  return definition;
Jim Blandy's avatar
Jim Blandy committed
687 688
}

689 690 691
extern Lisp_Object Qfunction_documentation;

DEFUN ("defalias", Fdefalias, Sdefalias, 2, 3, 0,
692
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.
Richard M. Stallman's avatar
Richard M. Stallman committed
693 694 695 696
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.  */)
697 698
     (symbol, definition, docstring)
     register Lisp_Object symbol, definition, docstring;
699
{
700
  CHECK_SYMBOL (symbol);
701 702 703
  if (CONSP (XSYMBOL (symbol)->function)
      && EQ (XCAR (XSYMBOL (symbol)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, symbol));
704
  definition = Ffset (symbol, definition);
705
  LOADHIST_ATTACH (Fcons (Qdefun, symbol));
706 707
  if (!NILP (docstring))
    Fput (symbol, Qfunction_documentation, docstring);
708
  return definition;
709 710
}

Jim Blandy's avatar
Jim Blandy committed
711
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
712
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
713
     (symbol, newplist)
714
     register Lisp_Object symbol, newplist;
Jim Blandy's avatar
Jim Blandy committed
715
{
716
  CHECK_SYMBOL (symbol);
717
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
718 719
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
720

721
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
722 723 724 725 726 727
       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)
728 729 730
     Lisp_Object subr;
{
  short minargs, maxargs;
731
  CHECK_SUBR (subr);
732 733 734 735 736 737 738 739 740 741
  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
742 743 744 745 746 747 748
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;
749
  CHECK_SUBR (subr);
Stefan Monnier's avatar
Stefan Monnier committed
750 751 752 753
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

Kenichi Handa's avatar
Kenichi Handa committed
754 755
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
756 757
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
758 759
     (cmd)
     Lisp_Object cmd;
760
{
761
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
762

763 764 765 766 767 768 769 770
  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))
    {
771
      Lisp_Object tmp = Fget (fun, Qinteractive_form);
772 773 774 775 776
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
Kenichi Handa's avatar
Kenichi Handa committed
777 778 779

  if (SUBRP (fun))
    {
780 781 782 783 784
      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
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
    }
  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);
	}
    }
805 806 807
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
808

809 810 811 812 813 814 815 816
/***********************************************************************
		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
817
struct Lisp_Symbol *
818
indirect_variable (symbol)
Stefan Monnier's avatar
Stefan Monnier committed
819
     struct Lisp_Symbol *symbol;
820
{
Stefan Monnier's avatar
Stefan Monnier committed
821
  struct Lisp_Symbol *tortoise, *hare;
822 823 824

  hare = tortoise = symbol;

Stefan Monnier's avatar
Stefan Monnier committed
825
  while (hare->indirect_variable)
826
    {
Stefan Monnier's avatar
Stefan Monnier committed
827 828
      hare = XSYMBOL (hare->value);
      if (!hare->indirect_variable)
829
	break;
830

Stefan Monnier's avatar
Stefan Monnier committed
831 832
      hare = XSYMBOL (hare->value);
      tortoise = XSYMBOL (tortoise->value);
833

Stefan Monnier's avatar
Stefan Monnier committed
834 835 836 837 838 839
      if (hare == tortoise)
	{
	  Lisp_Object tem;
	  XSETSYMBOL (tem, symbol);
	  xsignal1 (Qcyclic_variable_indirection, tem);
	}
840 841 842 843 844 845 846
    }

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
847 848 849 850 851 852
       doc: /* Return the variable at the end of OBJECT's variable chain.
If OBJECT is a symbol, follow all variable indirections and return the final
variable.  If OBJECT is not a symbol, just return it.
Signal a cyclic-variable-indirection error if there is a loop in the
variable chain of symbols.  */)
     (object)
853 854 855
     Lisp_Object object;
{
  if (SYMBOLP (object))
Stefan Monnier's avatar
Stefan Monnier committed
856
    XSETSYMBOL (object,  indirect_variable (XSYMBOL (object)));
857 858 859
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865 866 867 868 869 870

/* Given the raw contents of a symbol value cell,
   return the Lisp value of the symbol.
   This does not handle buffer-local variables; use
   swap_in_symval_forwarding for that.  */

Lisp_Object
do_symval_forwarding (valcontents)
     register Lisp_Object valcontents;
{
  register Lisp_Object val;
871
  if (MISCP (valcontents))
872
    switch (XMISCTYPE (valcontents))
873 874 875 876
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
877

878 879
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
880

881 882
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
883

884
      case Lisp_Misc_Buffer_Objfwd:
885 886
	return PER_BUFFER_VALUE (current_buffer,
				 XBUFFER_OBJFWD (valcontents)->offset);
887

888
      case Lisp_Misc_Kboard_Objfwd:
889 890 891 892 893 894 895 896 897 898 899
        /* We used to simply use current_kboard here, but from Lisp
           code, it's value is often unexpected.  It seems nicer to
           allow constructions like this to work as intuitively expected:

           	(with-selected-frame frame
                   (define-key local-function-map "\eOP" [f1]))

           On the other hand, this affects the semantics of
           last-command and real-last-command, and people may rely on
           that.  I took a quick look at the Lisp codebase, and I
           don't think anything will break.  --lorentey  */
900 901
	return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
				+ (char *)FRAME_KBOARD (SELECTED_FRAME ()));
902
      }
Jim Blandy's avatar
Jim Blandy committed
903 904 905
  return valcontents;
}

906 907
/* Store NEWVAL into SYMBOL, where VALCONTENTS is found in the value cell
   of SYMBOL.  If SYMBOL is buffer-local, VALCONTENTS should be the
Jim Blandy's avatar
Jim Blandy committed
908
   buffer-independent contents of the value cell: forwarded just one
909 910 911 912
   step past the buffer-localness.

   BUF non-zero means set the value in buffer BUF instead of the
   current buffer.  This only plays a role for per-buffer variables.  */
Jim Blandy's avatar
Jim Blandy committed
913 914

void
915
store_symval_forwarding (symbol, valcontents, newval, buf)
916
     Lisp_Object symbol;