data.c 94.5 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,
3
                 2001, 2002, 2003, 2004, 2005, 2006 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
Lisp_Object
wrong_type_argument (predicate, value)
     register Lisp_Object predicate, value;
{
116 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 ();

  Fsignal (Qwrong_type_argument, list2 (predicate, value));
122

123 124 125 126
  /* This function is marked as NO_RETURN, gcc would warn if it has a
     return statement or if falls off the function.  Other compilers
     warn if no return statement is present.  */
#ifndef __GNUC__
Jim Blandy's avatar
Jim Blandy committed
127
  return value;
128 129 130
#else
  abort ();
#endif
Jim Blandy's avatar
Jim Blandy committed
131 132
}

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

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

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

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

258 259 260
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0,
       doc: /* Return t if OBJECT is a cons cell.  */)
     (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 Qt;
  return Qnil;
}

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

278
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
Luc Teirlinck's avatar
Luc Teirlinck committed
279 280
       doc: /* Return t if OBJECT is a list, that is, a cons cell or nil.
Otherwise, return nil.  */)
281
     (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 Qt;
  return Qnil;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Luc Teirlinck's avatar
Luc Teirlinck committed
527 528
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as car, cdr, cons cell and list.  */)
529
     (list)
Jim Blandy's avatar
Jim Blandy committed
530 531
     register Lisp_Object list;
{
532
  return CAR (list);
Jim Blandy's avatar
Jim Blandy committed
533 534 535
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
536 537
       doc: /* Return the car of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
538 539
     Lisp_Object object;
{
540
  return CAR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
541 542 543
}

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

Luc Teirlinck's avatar
Luc Teirlinck committed
547 548
See Info node `(elisp)Cons Cells' for a discussion of related basic
Lisp concepts such as cdr, car, cons cell and list.  */)
549
     (list)
Jim Blandy's avatar
Jim Blandy committed
550 551
     register Lisp_Object list;
{
552
  return CDR (list);
Jim Blandy's avatar
Jim Blandy committed
553 554 555
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
556 557
       doc: /* Return the cdr of OBJECT if it is a cons cell, or else nil.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
558 559
     Lisp_Object object;
{
560
  return CDR_SAFE (object);
Jim Blandy's avatar
Jim Blandy committed
561 562 563
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
564 565
       doc: /* Set the car of CELL to be NEWCAR.  Returns NEWCAR.  */)
     (cell, newcar)
Jim Blandy's avatar
Jim Blandy committed
566 567
     register Lisp_Object cell, newcar;
{
568
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
569
  CHECK_IMPURE (cell);
570
  XSETCAR (cell, newcar);
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
575 576
       doc: /* Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.  */)
     (cell, newcdr)
Jim Blandy's avatar
Jim Blandy committed
577 578
     register Lisp_Object cell, newcdr;
{
579
  CHECK_CONS (cell);
Jim Blandy's avatar
Jim Blandy committed
580
  CHECK_IMPURE (cell);
581
  XSETCDR (cell, newcdr);
Jim Blandy's avatar
Jim Blandy committed
582 583 584 585 586
  return newcdr;
}

/* Extract and set components of symbols */

587 588 589
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's value is not void.  */)
     (symbol)
590
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
591 592
{
  Lisp_Object valcontents;
593
  CHECK_SYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
594

595
  valcontents = SYMBOL_VALUE (symbol);
Jim Blandy's avatar
Jim Blandy committed
596

Karl Heuer's avatar
Karl Heuer committed
597 598
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
599
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
600

601
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
602 603
}

604 605 606
DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
       doc: /* Return t if SYMBOL's function definition is not void.  */)
     (symbol)
607
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
608
{
609
  CHECK_SYMBOL (symbol);
610
  return (EQ (XSYMBOL (symbol)->function, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
611 612
}

613
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
614 615
       doc: /* Make SYMBOL's value be void.
Return SYMBOL.  */)
616
     (symbol)
617
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
618
{
619
  CHECK_SYMBOL (symbol);
620
  if (XSYMBOL (symbol)->constant)
621 622 623
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
624 625
}

626
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
627 628
       doc: /* Make SYMBOL's function definition be void.
Return SYMBOL.  */)
629
     (symbol)
630
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
631
{
632
  CHECK_SYMBOL (symbol);
633 634 635 636
  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
637 638 639
}

DEFUN ("symbol-function", Fsymbol_function, Ssymbol_function, 1, 1, 0,
640 641
       doc: /* Return SYMBOL's function definition.  Error if that is void.  */)
     (symbol)
Jim Blandy's avatar
Jim Blandy committed
642
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
643
{
644
  CHECK_SYMBOL (symbol);
Jim Blandy's avatar
Jim Blandy committed
645 646 647
  if (EQ (XSYMBOL (symbol)->function, Qunbound))
    return Fsignal (Qvoid_function, Fcons (symbol, Qnil));
  return XSYMBOL (symbol)->function;
Jim Blandy's avatar
Jim Blandy committed
648 649
}

650 651 652
DEFUN ("symbol-plist", Fsymbol_plist, Ssymbol_plist, 1, 1, 0,
       doc: /* Return SYMBOL's property list.  */)
     (symbol)
653
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
654
{
655
  CHECK_SYMBOL (symbol);
656
  return XSYMBOL (symbol)->plist;
Jim Blandy's avatar
Jim Blandy committed
657 658
}

659 660 661
DEFUN ("symbol-name", Fsymbol_name, Ssymbol_name, 1, 1, 0,
       doc: /* Return SYMBOL's name, a string.  */)
     (symbol)
662
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
663 664 665
{
  register Lisp_Object name;

666
  CHECK_SYMBOL (symbol);
667
  name = SYMBOL_NAME (symbol);
Jim Blandy's avatar
Jim Blandy committed
668 669 670 671
  return name;
}

DEFUN ("fset", Ffset, Sfset, 2, 2, 0,
672 673
       doc: /* Set SYMBOL's function definition to DEFINITION, and return DEFINITION.  */)
     (symbol, definition)
674
     register Lisp_Object symbol, definition;
675
{
676
  CHECK_SYMBOL (symbol);
677 678 679 680
  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
681
			     Vautoload_queue);
682
  XSYMBOL (symbol)->function = definition;
683
  /* Handle automatic advice activation */
684
  if (CONSP (XSYMBOL (symbol)->plist) && !NILP (Fget (symbol, Qad_advice_info)))
685
    {
686
      call2 (Qad_activate_internal, symbol, Qnil);
687
      definition = XSYMBOL (symbol)->function;
688
    }
689
  return definition;
Jim Blandy's avatar
Jim Blandy committed
690 691
}

692 693 694
extern Lisp_Object Qfunction_documentation;

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

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

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

757 758
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
759 760
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
761 762
     (cmd)
     Lisp_Object cmd;
763
{
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
  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);
	}
    }
790 791 792
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
793

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
/***********************************************************************
		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;
815

816 817 818 819 820 821 822 823 824 825 826 827
      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,
828 829 830 831 832 833
       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)
834 835 836 837 838 839 840
     Lisp_Object object;
{
  if (SYMBOLP (object))
    object = indirect_variable (object);
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
841 842 843 844 845 846 847 848 849 850 851

/* 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;
852 853
  int offset;
  if (MISCP (valcontents))
854
    switch (XMISCTYPE (valcontents))
855 856 857 858
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
859

860 861
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
862

863 864
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
865

866 867
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
Gerd Moellmann's avatar
Gerd Moellmann committed
868
	return PER_BUFFER_VALUE (current_buffer, offset);
869

870 871 872
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_kboard);
873
      }
Jim Blandy's avatar
Jim Blandy committed
874 875 876
  return valcontents;
}

877 878
/* 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
879
   buffer-independent contents of the value cell: forwarded just one
880 881 882 883
   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
884 885

void
886
store_symval_forwarding (symbol, valcontents, newval, buf)
887
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
888
     register Lisp_Object valcontents, newval;
889
     struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
890
{
891
  switch (SWITCH_ENUM_CAST (XTYPE (valcontents)))
Jim Blandy's avatar
Jim Blandy committed
892
    {
893
    case Lisp_Misc:
894
      switch (XMISCTYPE (valcontents))
895 896
	{
	case Lisp_Misc_Intfwd:
897
	  CHECK_NUMBER (newval);
898
	  *XINTFWD (valcontents)->intvar = XINT (newval);
899 900
	  if (*XINTFWD (valcontents)->intvar != XINT (newval))
	    error ("Value out of range for variable `%s'",
901
		   SDATA (SYMBOL_NAME (symbol)));