data.c 94 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

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


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

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

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

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

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

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

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

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

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

681 682 683
extern Lisp_Object Qfunction_documentation;

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

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

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

746 747
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
748 749
If CMD is not a command, the return value is nil.
Value, if non-nil, is a list \(interactive SPEC).  */)
750 751
     (cmd)
     Lisp_Object cmd;
752
{
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
  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);
	}
    }
779 780 781
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
782

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
/***********************************************************************
		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;
804

805 806 807 808
      hare = XSYMBOL (hare)->value;
      tortoise = XSYMBOL (tortoise)->value;

      if (EQ (hare, tortoise))
809
	xsignal1 (Qcyclic_variable_indirection, symbol);
810 811 812 813 814 815 816
    }

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
817 818 819 820 821 822
       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)
823 824 825 826 827 828 829
     Lisp_Object object;
{
  if (SYMBOLP (object))
    object = indirect_variable (object);
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
830 831 832 833 834 835 836 837 838 839 840

/* 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;
841 842
  int offset;
  if (MISCP (valcontents))
843
    switch (XMISCTYPE (valcontents))
844 845 846 847
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
848

849 850
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
851

852 853
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
854

855 856
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
Gerd Moellmann's avatar
Gerd Moellmann committed
857
	return PER_BUFFER_VALUE (current_buffer, offset);
858

859 860 861
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_kboard);
862
      }
Jim Blandy's avatar
Jim Blandy committed
863 864 865
  return valcontents;
}

866 867
/* 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
868
   buffer-independent contents of the value cell: forwarded just one
869 870 871 872
   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
873 874

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

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

	case Lisp_Misc_Objfwd:
	  *XOBJFWD (valcontents)->objvar = newval;
899 900 901 902 903 904 905 906 907 908 909 910

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

911
	      Lisp_Object tail;
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928

	      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;
		}
	    }
929 930 931 932 933 934 935
	  break;

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

936
	    type = PER_BUFFER_TYPE (offset);
937 938 939 940
	    if (! NILP (type) && ! NILP (newval)
		&& XTYPE (newval) != XINT (type))
	      buffer_slot_type_mismatch (offset);

941 942 943
	    if (buf == NULL)
	      buf = current_buffer;
	    PER_BUFFER_VALUE (buf, offset) = newval;
944
	  }
945 946
	  break;

947
	case Lisp_Misc_Kboard_Objfwd:
948 949 950 951 952
	  {
	    char *base = (char *) current_kboard;
	    char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
	    *(Lisp_Object *) p = newval;
	  }
953 954
	  break;

955 956 957
	default:
	  goto def;
	}
Jim Blandy's avatar
Jim Blandy committed
958 959 960
      break;

    default:
961
    def:
962
      valcontents = SYMBOL_VALUE (symbol);
963 964
      if (BUFFER_LOCAL_VALUEP (valcontents)
	  || SOME_BUFFER_LOCAL_VALUEP (valcontents))
965
	XBUFFER_LOCAL_VALUE (valcontents)->realvalue = newval;
Jim Blandy's avatar
Jim Blandy committed
966
      else
967
	SET_SYMBOL_VALUE (symbol, newval);
Jim Blandy's avatar
Jim Blandy committed
968 969 970
    }
}

971 972 973 974 975 976 977 978
/* 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;
979

980
  valcontents = SYMBOL_VALUE (symbol);