data.c 94.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 3
   Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
                 2001, 2002, 2003, 2004, 2005 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
Karl Heuer's avatar
Karl Heuer committed
9
the Free Software Foundation; either version 2, 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"
Jim Blandy's avatar
Jim Blandy committed
33

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

38 39 40 41 42 43 44 45 46 47
/* 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

48 49 50 51 52 53 54 55 56 57
/* 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
58 59
#include <math.h>

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

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

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

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

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

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

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

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

101
Lisp_Object Vmost_positive_fixnum, Vmost_negative_fixnum;
102

103 104 105 106 107 108 109 110 111

void
circular_list_error (list)
     Lisp_Object list;
{
  Fsignal (Qcircular_list, list);
}


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

Jim Blandy's avatar
Jim Blandy committed
124 125 126
      value = Fsignal (Qwrong_type_argument, Fcons (predicate, Fcons (value, Qnil)));
      tem = call1 (predicate, value);
    }
Jim Blandy's avatar
Jim Blandy committed
127
  while (NILP (tem));
Jim Blandy's avatar
Jim Blandy committed
128 129 130
  return value;
}

Andreas Schwab's avatar
Andreas Schwab committed
131
void
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
pure_write_error ()
{
  error ("Attempt to modify read-only object");
}

void
args_out_of_range (a1, a2)
     Lisp_Object a1, a2;
{
  while (1)
    Fsignal (Qargs_out_of_range, Fcons (a1, Fcons (a2, Qnil)));
}

void
args_out_of_range_3 (a1, a2, a3)
     Lisp_Object a1, a2, a3;
{
  while (1)
    Fsignal (Qargs_out_of_range, Fcons (a1, Fcons (a2, Fcons (a3, Qnil))));
}

/* 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)
162
     EMACS_INT num;
Jim Blandy's avatar
Jim Blandy committed
163
{
164 165
  if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
    return num | (((EMACS_INT) (-1)) << VALBITS);
Jim Blandy's avatar
Jim Blandy committed
166
  else
167
    return num & ((((EMACS_INT) 1) << VALBITS) - 1);
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172
}

/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
173 174
       doc: /* Return t if the two args are the same Lisp object.  */)
     (obj1, obj2)
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181
     Lisp_Object obj1, obj2;
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

182 183 184
DEFUN ("null", Fnull, Snull, 1, 1, 0,
       doc: /* Return t if OBJECT is nil.  */)
     (object)
185
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
186
{
187
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
188 189 190 191
    return Qt;
  return Qnil;
}

192
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
193 194 195 196
       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)
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
     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:
214
      switch (XMISCTYPE (object))
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
	{
	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;
238 239 240 241
      if (GC_CHAR_TABLE_P (object))
	return Qchar_table;
      if (GC_BOOL_VECTOR_P (object))
	return Qbool_vector;
242 243
      if (GC_FRAMEP (object))
	return Qframe;
Gerd Moellmann's avatar
Gerd Moellmann committed
244 245
      if (GC_HASH_TABLE_P (object))
	return Qhash_table;
246 247 248 249 250 251 252 253 254 255
      return Qvector;

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

256 257 258
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
     (object)
259
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
260
{
261
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
262 263 264 265
    return Qt;
  return Qnil;
}

266
DEFUN ("atom", Fatom, Satom, 1, 1, 0,
267 268
       doc: /* Return t if OBJECT is not a cons cell.  This includes nil.  */)
     (object)
269
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
270
{
271
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275
    return Qnil;
  return Qt;
}

276
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
277 278
       doc: /* Return t if OBJECT is a list.  This includes nil.  */)
     (object)
279
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
280
{
281
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
282 283 284 285
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

374 375 376
DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0,
       doc: /* Return t if OBJECT is a bool-vector.  */)
     (object)
377 378 379 380 381 382 383
     Lisp_Object object;
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

384 385 386
DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0,
       doc: /* Return t if OBJECT is an array (string or vector).  */)
     (object)
387
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
388
{
389 390
  if (VECTORP (object) || STRINGP (object)
      || CHAR_TABLE_P (object) || BOOL_VECTOR_P (object))
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395
    return Qt;
  return Qnil;
}

DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
396 397
       doc: /* Return t if OBJECT is a sequence (list or array).  */)
     (object)
398
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
399
{
400 401
  if (CONSP (object) || NILP (object) || VECTORP (object) || STRINGP (object)
      || CHAR_TABLE_P (object) || BOOL_VECTOR_P (object))
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405
    return Qt;
  return Qnil;
}

406 407 408
DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0,
       doc: /* Return t if OBJECT is an editor buffer.  */)
     (object)
409
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
410
{
411
  if (BUFFERP (object))
Jim Blandy's avatar
Jim Blandy committed
412 413 414 415
    return Qt;
  return Qnil;
}

416 417 418
DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0,
       doc: /* Return t if OBJECT is a marker (editor pointer).  */)
     (object)
419
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
420
{
421
  if (MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425
    return Qt;
  return Qnil;
}

426 427 428
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0,
       doc: /* Return t if OBJECT is a built-in function.  */)
     (object)
429
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
430
{
431
  if (SUBRP (object))
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435
    return Qt;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
436
DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
437 438 439
       1, 1, 0,
       doc: /* Return t if OBJECT is a byte-compiled function object.  */)
     (object)
440
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
441
{
442
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446
    return Qt;
  return Qnil;
}

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

467
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
468 469
       doc: /* Return t if OBJECT is an integer or a marker (editor pointer).  */)
     (object)
470
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
471
{
472
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
473 474 475 476
    return Qt;
  return Qnil;
}

477
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
478 479
       doc: /* Return t if OBJECT is a nonnegative integer.  */)
     (object)
480
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
481
{
482
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
483 484 485 486 487
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
488 489
       doc: /* Return t if OBJECT is a number (floating point or integer).  */)
     (object)
490
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
491
{
492
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
493
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
494 495
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
500 501
       doc: /* Return t if OBJECT is a number or a marker.  */)
     (object)
502
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
503
{
504
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
505 506 507
    return Qt;
  return Qnil;
}
508 509

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
510 511
       doc: /* Return t if OBJECT is a floating point number.  */)
     (object)
512
     Lisp_Object object;
513
{
514
  if (FLOATP (object))
515 516 517
    return Qt;
  return Qnil;
}
518

Jim Blandy's avatar
Jim Blandy committed
519 520 521 522

/* Extract and set components of lists */

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

Luc Teirlinck's avatar
Luc Teirlinck committed
526 527
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as car, cdr, cons cell and list.  */)
528
     (list)
Jim Blandy's avatar
Jim Blandy committed
529 530 531 532
     register Lisp_Object list;
{
  while (1)
    {
533
      if (CONSP (list))
534
	return XCAR (list);
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539 540 541 542
      else if (EQ (list, Qnil))
	return Qnil;
      else
	list = wrong_type_argument (Qlistp, list);
    }
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
543 544
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
545 546
     Lisp_Object object;
{
547
  if (CONSP (object))
548
    return XCAR (object);
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553
  else
    return Qnil;
}

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

Luc Teirlinck's avatar
Luc Teirlinck committed
557 558
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as cdr, car, cons cell and list.  */)
559
     (list)
Jim Blandy's avatar
Jim Blandy committed
560 561 562 563
     register Lisp_Object list;
{
  while (1)
    {
564
      if (CONSP (list))
565
	return XCDR (list);
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570 571 572 573
      else if (EQ (list, Qnil))
	return Qnil;
      else
	list = wrong_type_argument (Qlistp, list);
    }
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
574 575
       doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
576 577
     Lisp_Object object;
{
578
  if (CONSP (object))
579
    return XCDR (object);
Jim Blandy's avatar
Jim Blandy committed
580 581 582 583 584
  else
    return Qnil;
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
585 586
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
     (cell, newcar)
Jim Blandy's avatar
Jim Blandy committed
587 588
     register Lisp_Object cell, newcar;
{
589
  if (!CONSP (cell))
Jim Blandy's avatar
Jim Blandy committed
590 591 592
    cell = wrong_type_argument (Qconsp, cell);

  CHECK_IMPURE (cell);
593
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
598 599
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
     (cell, newcdr)
Jim Blandy's avatar
Jim Blandy committed
600 601
     register Lisp_Object cell, newcdr;
{
602
  if (!CONSP (cell))
Jim Blandy's avatar
Jim Blandy committed
603 604 605
    cell = wrong_type_argument (Qconsp, cell);

  CHECK_IMPURE (cell);
606
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611
  return newcdr;
}

/* Extract and set components of symbols */

612 613 614
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
     (symbol)
615
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
616 617
{
  Lisp_Object valcontents;
618
  CHECK_SYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
619

620
  valcontents = SYMBOL_VALUE (symbol);
Jim Blandy's avatar
Jim Blandy committed
621

Karl Heuer's avatar
Karl Heuer committed
622 623
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
624
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
625

626
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
627 628
}

629 630 631
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's function definition is not void.  */)
     (symbol)
632
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
633
{
634
  CHECK_SYMBOL (symbol);
635
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
636 637
}

638
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
639 640
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
641
     (symbol)
642
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
643
{
644
  CHECK_SYMBOL (symbol);
645
  if (XSYMBOL (symbol)->constant)
646 647 648
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
649 650
}

651
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
652 653
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
654
     (symbol)
655
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
656
{
657
  CHECK_SYMBOL (symbol);
658 659 660 661
  if (NILP (symbol) || EQ (symbol, Qt))
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  XSYMBOL (symbol)->function = Qunbound;
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
662 663 664
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
665 666
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
     (symbol)
Jim Blandy's avatar
Jim Blandy committed
667
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
668
{
669
  CHECK_SYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
670 671 672
  if (EQ (XSYMBOL (symbol)->function, Qunbound))
    return Fsignal (Qvoid_function, Fcons (symbol, Qnil));
  return XSYMBOL (symbol)->function;
Jim Blandy's avatar
Jim Blandy committed
673 674
}

675 676 677
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
     (symbol)
678
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
679
{
680
  CHECK_SYMBOL (symbol);
681
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
682 683
}

684 685 686
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
     (symbol)
687
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
688 689 690
{
  register Lisp_Object name;

691
  CHECK_SYMBOL (symbol);
692
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
697 698
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
     (symbol, definition)
699
     register Lisp_Object symbol, definition;
700
{
701
  CHECK_SYMBOL (symbol);
702 703 704 705
  if (NILP (symbol) || EQ (symbol, Qt))
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  if (!NILP (Vautoload_queue) && !EQ (XSYMBOL (symbol)->function, Qunbound))
    Vautoload_queue = Fcons (Fcons (symbol, XSYMBOL (symbol)->function),
Jim Blandy's avatar
Jim Blandy committed
706
			     Vautoload_queue);
707
  XSYMBOL (symbol)->function = definition;
708
  /* Handle automatic advice activation */
709
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
710
    {
711
      call2 (Qad_activate_internal, symbol, Qnil);
712
      definition = XSYMBOL (symbol)->function;
713
    }
714
  return definition;
Jim Blandy's avatar
Jim Blandy committed
715 716
}

717 718 719
extern Lisp_Object Qfunction_documentation;

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

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

749
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
750 751 752 753 754 755
       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)
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
     Lisp_Object subr;
{
  short minargs, maxargs;
  if (!SUBRP (subr))
    wrong_type_argument (Qsubrp, subr);
  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
771 772 773 774 775 776 777 778 779 780 781 782 783
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;
  if (!SUBRP (subr))
    wrong_type_argument (Qsubrp, subr);
  name = XSUBR (subr)->symbol_name;
  return make_string (name, strlen (name));
}

784 785
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
786 787
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
788 789
     (cmd)
     Lisp_Object cmd;
790
{
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
  Lisp_Object fun = indirect_function (cmd);

  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);
	}
    }
817 818 819
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
820

821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
/***********************************************************************
		Getting and Setting Values of Symbols
 ***********************************************************************/

/* Return the symbol holding SYMBOL's value.  Signal
   `cyclic-variable-indirection' if SYMBOL's chain of variable
   indirections contains a loop.  */

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

843 844 845 846 847 848 849 850 851 852 853 854
      hare = XSYMBOL (hare)->value;
      tortoise = XSYMBOL (tortoise)->value;

      if (EQ (hare, tortoise))
	Fsignal (Qcyclic_variable_indirection, Fcons (symbol, Qnil));
    }

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
855 856 857 858 859 860
       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)
861 862 863 864 865 866 867
     Lisp_Object object;
{
  if (SYMBOLP (object))
    object = indirect_variable (object);
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
868 869 870 871 872 873 874 875 876 877 878

/* 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;
879 880
  int offset;
  if (MISCP (valcontents))
881
    switch (XMISCTYPE (valcontents))
882 883 884 885
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
886

887 888
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
889

890 891
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
892

893 894
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
Gerd Moellmann's avatar
Gerd Moellmann committed
895
	return PER_BUFFER_VALUE (current_buffer, offset);
896

897 898 899
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_kboard);
900
      }
Jim Blandy's avatar
Jim Blandy committed
901 902 903
  return valcontents;
}

904 905
/* 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
906
   buffer-independent contents of the value cell: forwarded just one
907 908 909 910
   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
911 912

void
913
store_symval_forwarding (symbol, valcontents, newval, buf)
914
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
915
     register Lisp_Object valcontents, newval;
916
     struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
917
{
918
  switch (SWITCH_ENUM_CAST (XTYPE (valcontents)))
Jim Blandy's avatar
Jim Blandy committed
919
    {
920
    case Lisp_Misc:
921
      switch (XMISCTYPE (valcontents))
922 923
	{
	case Lisp_Misc_Intfwd:
924
	  CHECK_NUMBER (newval);
925
	  *XINTFWD (valcontents)->intvar = XINT (newval);
926 927
	  if (*XINTFWD (valcontents)->intvar != XINT (newval))
	    error ("Value out of range for variable `%s'",
928
		   SDATA (SYMBOL_NAME (symbol)));
929 930 931 932 933 934 935 936
	  break;

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

	case Lisp_Misc_Objfwd:
	  *XOBJFWD (valcontents)->objvar = newval;
937 938 939 940 941 942 943 944 945 946 947 948

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

949
	      Lisp_Object tail;
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966

	      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;
		}
	    }
967 968 969 970 971 972 973
	  break;

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

974
	    type = PER_BUFFER_TYPE (offset);
975 976 977 978
	    if (! NILP (type) && ! NILP (newval)
		&& XTYPE (newval) != XINT (type))
	      buffer_slot_type_mismatch (offset);

979 980 981
	    if (buf == NULL)
	      buf = current_buffer;
	    PER_BUFFER_VALUE (buf, offset) = newval;
982
	  }
983 984
	  break;

985
	case Lisp_Misc_Kboard_Objfwd:
986 987 988 989 990
	  {
	    char *base = (char *) current_kboard;
	    char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
	    *(Lisp_Object *) p = newval;
	  }
991 992
	  break;

993 994 995
	default:
	  goto def;
	}
Jim Blandy's avatar
Jim Blandy committed
996 997 998
      break;

    default:
999
    def:
1000
      valcontents = SYMBOL_VALUE (symbol);
1001 1002
      if (BUFFER_LOCAL_VALUEP (valcontents)
	  || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1003
	XBUFFER_LOCAL_VALUE (valcontents)->realvalue = newval;
Jim Blandy's avatar
Jim Blandy committed
1004
      else
1005
	SET_SYMBOL_VALUE (symbol, newval);
Jim Blandy's avatar
Jim Blandy committed
1006 1007 1008
    }
}

1009 1010 1011 1012 1013 1014 1015 1016
/* Set up SYMBOL to refer to its global binding.
   This makes it safe to alter the status of other bindings.  */

void
swap_in_global_binding (symbol)
     Lisp_Object symbol;
{
  Lisp_Object valcontents, cdr;
1017

1018
  valcontents = SYMBOL_VALUE (symbol);
1019 1020 1021 1022 1023 1024 1025 1026
  if (!BUFFER_LOCAL_VALUEP (valcontents)
      && !SOME_BUFFER_LOCAL_VALUEP (valcontents))
    abort ();
  cdr = XBUFFER_LOCAL_VALUE (valcontents)->cdr;

  /* Unload the previously loaded binding.  */
  Fsetcdr (XCAR (cdr),
	   do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));