data.c 96.7 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
24
#include <signal.h>
25
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
26
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "puresize.h"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.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. */
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

49 50 51 52 53 54 55 56 57 58
/* Work around a problem that happens because math.h on hpux 7
   defines two static variables--which, in Emacs, are not really static,
   because `static' is defined as nothing.  The problem is that they are
   here, in floatfns.c, and in lread.c.
   These macros prevent the name conflict.  */
#if defined (HPUX) && !defined (HPUX8)
#define _MAXLDBL data_c_maxldbl
#define _NMAXLDBL data_c_nmaxldbl
#endif

Jim Blandy's avatar
Jim Blandy committed
59 60
#include <math.h>

61 62 63 64
#if !defined (atof)
extern double atof ();
#endif /* !atof */

Jim Blandy's avatar
Jim Blandy committed
65 66 67
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
68
Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
69
Lisp_Object Qcyclic_variable_indirection, Qcircular_list;
Jim Blandy's avatar
Jim Blandy committed
70 71
Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
Roland McGrath's avatar
Roland McGrath committed
72
Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
73
Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
74
Lisp_Object Qtext_read_only;
Lars Hansen's avatar
Lars Hansen committed
75

76
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
77 78
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
79
Lisp_Object Qbuffer_or_string_p, Qkeywordp;
Jim Blandy's avatar
Jim Blandy committed
80
Lisp_Object Qboundp, Qfboundp;
81
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
82

Jim Blandy's avatar
Jim Blandy committed
83
Lisp_Object Qcdr;
84
Lisp_Object Qad_advice_info, Qad_activate_internal;
Jim Blandy's avatar
Jim Blandy committed
85

86 87 88
Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
Lisp_Object Qoverflow_error, Qunderflow_error;

89
Lisp_Object Qfloatp;
Jim Blandy's avatar
Jim Blandy committed
90 91
Lisp_Object Qnumberp, Qnumber_or_marker_p;

Lars Hansen's avatar
Lars Hansen committed
92 93
Lisp_Object Qinteger;
static Lisp_Object Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
Karl Heuer's avatar
Karl Heuer committed
94 95
static Lisp_Object Qfloat, Qwindow_configuration, Qwindow;
Lisp_Object Qprocess;
96
static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
Gerd Moellmann's avatar
Gerd Moellmann committed
97
static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
98
static Lisp_Object Qsubrp, Qmany, Qunevalled;
99

100
static Lisp_Object swap_in_symval_forwarding P_ ((Lisp_Object, Lisp_Object));
101

102
Lisp_Object Vmost_positive_fixnum, Vmost_negative_fixnum;
103

104 105 106 107 108

void
circular_list_error (list)
     Lisp_Object list;
{
109
  xsignal (Qcircular_list, list);
110 111 112
}


Jim Blandy's avatar
Jim Blandy committed
113 114 115 116
Lisp_Object
wrong_type_argument (predicate, value)
     register Lisp_Object predicate, value;
{
117 118 119 120 121
  /* If VALUE is not even a valid Lisp object, abort here
     where we can get a backtrace showing where it came from.  */
  if ((unsigned int) XGCTYPE (value) >= Lisp_Type_Limit)
    abort ();

122
  xsignal2 (Qwrong_type_argument, predicate, value);
Jim Blandy's avatar
Jim Blandy committed
123 124
}

Andreas Schwab's avatar
Andreas Schwab committed
125
void
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132 133 134
pure_write_error ()
{
  error ("Attempt to modify read-only object");
}

void
args_out_of_range (a1, a2)
     Lisp_Object a1, a2;
{
135
  xsignal2 (Qargs_out_of_range, a1, a2);
Jim Blandy's avatar
Jim Blandy committed
136 137 138 139 140 141
}

void
args_out_of_range_3 (a1, a2, a3)
     Lisp_Object a1, a2, a3;
{
142
  xsignal3 (Qargs_out_of_range, a1, a2, a3);
Jim Blandy's avatar
Jim Blandy committed
143 144 145 146 147 148 149 150 151 152 153
}

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

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

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

184
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
185 186 187 188
       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)
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
     Lisp_Object object;
{
  switch (XGCTYPE (object))
    {
    case Lisp_Int:
      return Qinteger;

    case Lisp_Symbol:
      return Qsymbol;

    case Lisp_String:
      return Qstring;

    case Lisp_Cons:
      return Qcons;

    case Lisp_Misc:
206
      switch (XMISCTYPE (object))
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
	{
	case Lisp_Misc_Marker:
	  return Qmarker;
	case Lisp_Misc_Overlay:
	  return Qoverlay;
	case Lisp_Misc_Float:
	  return Qfloat;
	}
      abort ();

    case Lisp_Vectorlike:
      if (GC_WINDOW_CONFIGURATIONP (object))
	return Qwindow_configuration;
      if (GC_PROCESSP (object))
	return Qprocess;
      if (GC_WINDOWP (object))
	return Qwindow;
      if (GC_SUBRP (object))
	return Qsubr;
      if (GC_COMPILEDP (object))
	return Qcompiled_function;
      if (GC_BUFFERP (object))
	return Qbuffer;
230 231 232 233
      if (GC_CHAR_TABLE_P (object))
	return Qchar_table;
      if (GC_BOOL_VECTOR_P (object))
	return Qbool_vector;
234 235
      if (GC_FRAMEP (object))
	return Qframe;
Gerd Moellmann's avatar
Gerd Moellmann committed
236 237
      if (GC_HASH_TABLE_P (object))
	return Qhash_table;
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 440
       doc: /* Return t if OBJECT is a character (an integer) or a string.  */)
     (object)
441
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
442
{
443
  if (INTEGERP (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

Karl Heuer's avatar
Karl Heuer committed
587 588
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
589
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
590

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

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

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

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

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

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

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

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

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
662 663
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
     (symbol, definition)
664
     register Lisp_Object symbol, definition;
665
{
666
  CHECK_SYMBOL (symbol);
667
  if (NILP (symbol) || EQ (symbol, Qt))
668
    xsignal1 (Qsetting_constant, symbol);
669 670
  if (!NILP (Vautoload_queue) && !EQ (XSYMBOL (symbol)->function, Qunbound))
    Vautoload_queue = Fcons (Fcons (symbol, XSYMBOL (symbol)->function),
Jim Blandy's avatar
Jim Blandy committed
671
			     Vautoload_queue);
672
  XSYMBOL (symbol)->function = definition;
673
  /* Handle automatic advice activation */
674
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
675
    {
676
      call2 (Qad_activate_internal, symbol, Qnil);
677
      definition = XSYMBOL (symbol)->function;
678
    }
679
  return definition;
Jim Blandy's avatar
Jim Blandy committed
680 681
}

682 683 684
extern Lisp_Object Qfunction_documentation;

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

Jim Blandy's avatar
Jim Blandy committed
704
DEFUN ("setplist", Fsetplist, Ssetplist, 2, 2, 0,
Luc Teirlinck's avatar
Luc Teirlinck committed
705
       doc: /* Set SYMBOL's property list to NEWPLIST, and return NEWPLIST.  */)
706
     (symbol, newplist)
707
     register Lisp_Object symbol, newplist;
Jim Blandy's avatar
Jim Blandy committed
708
{
709
  CHECK_SYMBOL (symbol);
710
  XSYMBOL (symbol)->plist = newplist;
Jim Blandy's avatar
Jim Blandy committed
711 712
  return newplist;
}
Jim Blandy's avatar
Jim Blandy committed
713

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

747 748
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
749 750
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
751 752
     (cmd)
     Lisp_Object cmd;
753
{
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
  Lisp_Object fun = indirect_function (cmd); /* Check cycles.  */
  
  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))
    {
      Lisp_Object tmp = Fget (fun, intern ("interactive-form"));
      if (!NILP (tmp))
	return tmp;
      else
	fun = Fsymbol_function (fun);
    }
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794

  if (SUBRP (fun))
    {
      if (XSUBR (fun)->prompt)
	return list2 (Qinteractive, build_string (XSUBR (fun)->prompt));
    }
  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);
	}
    }
795 796 797
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
798

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
/***********************************************************************
		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.  */

Lisp_Object
indirect_variable (symbol)
     Lisp_Object symbol;
{
  Lisp_Object tortoise, hare;

  hare = tortoise = symbol;

  while (XSYMBOL (hare)->indirect_variable)
    {
      hare = XSYMBOL (hare)->value;
      if (!XSYMBOL (hare)->indirect_variable)
	break;
820

821 822 823 824
      hare = XSYMBOL (hare)->value;
      tortoise = XSYMBOL (tortoise)->value;

      if (EQ (hare, tortoise))
825
	xsignal1 (Qcyclic_variable_indirection, symbol);
826 827 828 829 830 831 832
    }

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
833 834 835 836 837 838
       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)
839 840 841 842 843 844 845
     Lisp_Object object;
{
  if (SYMBOLP (object))
    object = indirect_variable (object);
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
846 847 848 849 850 851 852 853 854 855 856

/* 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;
857 858
  int offset;
  if (MISCP (valcontents))
859
    switch (XMISCTYPE (valcontents))
860 861 862 863
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
864

865 866
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
867

868 869
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
870

871 872
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
Gerd Moellmann's avatar
Gerd Moellmann committed
873
	return PER_BUFFER_VALUE (current_buffer, offset);
874

875 876
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
877 878 879 880 881 882 883 884 885 886 887 888
        /* 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  */
	return *(Lisp_Object *)(offset + (char *)FRAME_KBOARD (SELECTED_FRAME ()));
889
      }
Jim Blandy's avatar
Jim Blandy committed
890 891 892
  return valcontents;
}

893 894
/* 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
895
   buffer-independent contents of the value cell: forwarded just one
896 897 898 899
   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
900 901

void
902
store_symval_forwarding (symbol, valcontents, newval, buf)
903
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
904
     register Lisp_Object valcontents, newval;
905
     struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  switch (SWITCH_ENUM_CAST (XTYPE (valcontents)))
Jim Blandy's avatar
Jim Blandy committed
908
    {
909
    case Lisp_Misc:
910
      switch (XMISCTYPE (valcontents))
911 912
	{
	case Lisp_Misc_Intfwd:
913
	  CHECK_NUMBER (newval);
914
	  *XINTFWD (valcontents)->intvar = XINT (newval);
915 916
	  if (*XINTFWD (valcontents)->intvar != XINT (newval))
	    error ("Value out of range for variable `%s'",
917
		   SDATA (SYMBOL_NAME (symbol)));
918 919 920 921 922 923 924 925
	  break;

	case Lisp_Misc_Boolfwd:
	  *XBOOLFWD (valcontents)->boolvar = NILP (newval) ? 0 : 1;
	  break;

	case Lisp_Misc_Objfwd:
	  *XOBJFWD (valcontents)->objvar = newval;
926 927 928 929 930 931 932 933 934 935 936 937

	  /* If this variable is a default for something stored
	     in the buffer itself, such as default-fill-column,
	     find the buffers that don't have local values for it
	     and update them.  */
	  if (XOBJFWD (valcontents)->objvar > (Lisp_Object *) &buffer_defaults
	      && XOBJFWD (valcontents)->objvar < (Lisp_Object *) (&buffer_defaults + 1))
	    {
	      int offset = ((char *) XOBJFWD (valcontents)->objvar
			    - (char *) &buffer_defaults);
	      int idx = PER_BUFFER_IDX (offset);

938
	      Lisp_Object tail;
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955

	      if (idx <= 0)
		break;

	      for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
		{
		  Lisp_Object buf;
		  struct buffer *b;

		  buf = Fcdr (XCAR (tail));
		  if (!BUFFERP (buf)) continue;
		  b = XBUFFER (buf);

		  if (! PER_BUFFER_VALUE_P (b, idx))
		    PER_BUFFER_VALUE (b, offset) = newval;
		}
	    }
956 957 958 959 960 961 962
	  break;

	case Lisp_Misc_Buffer_Objfwd:
	  {
	    int offset = XBUFFER_OBJFWD (valcontents)->offset;
	    Lisp_Object type;

963
	    type = PER_BUFFER_TYPE (offset);
964 965 966 967
	    if (! NILP (type) && ! NILP (newval)
		&& XTYPE (newval) != XINT (type))
	      buffer_slot_type_mismatch (offset);

968 969 970
	    if (buf == NULL)
	      buf = current_buffer;
	    PER_BUFFER_VALUE (buf, offset) = newval;
971
	  }
972 973
	  break;

974
	case Lisp_Misc_Kboard_Objfwd:
975
	  {
976
	    char *base = (char *) FRAME_KBOARD (SELECTED_FRAME ());
977 978 979
	    char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
	    *(Lisp_Object *) p = newval;
	  }
980 981
	  break;

982 983 984
	default:
	  goto def;
	}
Jim Blandy's avatar
Jim Blandy committed
985 986 987
      break;

    default:
988
    def:
989
      valcontents = SYMBOL_VALUE (symbol);
990