data.c 82.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985,86,88,93,94,95,97, 1998 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21 22 23


#include <signal.h>

24
#include <config.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 30 31

#ifndef standalone
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include "keyboard.h"
33
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
34 35
#endif

Jim Blandy's avatar
Jim Blandy committed
36
#include "syssignal.h"
Jim Blandy's avatar
Jim Blandy committed
37

Jim Blandy's avatar
Jim Blandy committed
38
#ifdef LISP_FLOAT_TYPE
39

40 41
#ifdef STDC_HEADERS
#include <stdlib.h>
42
#include <float.h>
43
#endif
44

45 46 47 48 49 50 51 52 53 54
/* 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

55 56 57 58 59 60 61 62 63 64
/* 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
65 66 67
#include <math.h>
#endif /* LISP_FLOAT_TYPE */

68 69 70 71
#if !defined (atof)
extern double atof ();
#endif /* !atof */

72 73 74 75
/* Nonzero means it is an error to set a symbol whose name starts with
   colon.  */
int keyword_symbols_constant_flag;

Jim Blandy's avatar
Jim Blandy committed
76 77 78
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
79
Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
Jim Blandy's avatar
Jim Blandy committed
80 81
Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
Roland McGrath's avatar
Roland McGrath committed
82
Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
83
Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
84
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
85 86
Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
87
Lisp_Object Qbuffer_or_string_p;
Jim Blandy's avatar
Jim Blandy committed
88
Lisp_Object Qboundp, Qfboundp;
89
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
90

Jim Blandy's avatar
Jim Blandy committed
91
Lisp_Object Qcdr;
92
Lisp_Object Qad_advice_info, Qad_activate;
Jim Blandy's avatar
Jim Blandy committed
93

94 95 96
Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
Lisp_Object Qoverflow_error, Qunderflow_error;

Jim Blandy's avatar
Jim Blandy committed
97
#ifdef LISP_FLOAT_TYPE
98
Lisp_Object Qfloatp;
Jim Blandy's avatar
Jim Blandy committed
99 100 101
Lisp_Object Qnumberp, Qnumber_or_marker_p;
#endif

102
static Lisp_Object Qinteger, Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
Karl Heuer's avatar
Karl Heuer committed
103 104
static Lisp_Object Qfloat, Qwindow_configuration, Qwindow;
Lisp_Object Qprocess;
105
static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
106
static Lisp_Object Qchar_table, Qbool_vector;
107

Jim Blandy's avatar
Jim Blandy committed
108 109
static Lisp_Object swap_in_symval_forwarding ();

110 111
Lisp_Object set_internal ();

Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120
Lisp_Object
wrong_type_argument (predicate, value)
     register Lisp_Object predicate, value;
{
  register Lisp_Object tem;
  do
    {
      if (!EQ (Vmocklisp_arguments, Qt))
	{
121
	 if (STRINGP (value) &&
Jim Blandy's avatar
Jim Blandy committed
122
	     (EQ (predicate, Qintegerp) || EQ (predicate, Qinteger_or_marker_p)))
123
	   return Fstring_to_number (value, Qnil);
124
	 if (INTEGERP (value) && EQ (predicate, Qstringp))
125
	   return Fnumber_to_string (value);
Jim Blandy's avatar
Jim Blandy committed
126
	}
127 128 129

      /* If VALUE is not even a valid Lisp object, abort here
	 where we can get a backtrace showing where it came from.  */
130
      if ((unsigned int) XGCTYPE (value) >= Lisp_Type_Limit)
131 132
	abort ();

Jim Blandy's avatar
Jim Blandy committed
133 134 135
      value = Fsignal (Qwrong_type_argument, Fcons (predicate, Fcons (value, Qnil)));
      tem = call1 (predicate, value);
    }
Jim Blandy's avatar
Jim Blandy committed
136
  while (NILP (tem));
Jim Blandy's avatar
Jim Blandy committed
137 138 139
  return value;
}

Andreas Schwab's avatar
Andreas Schwab committed
140
void
Jim Blandy's avatar
Jim Blandy committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
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)
171
     EMACS_INT num;
Jim Blandy's avatar
Jim Blandy committed
172
{
173 174
  if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
    return num | (((EMACS_INT) (-1)) << VALBITS);
Jim Blandy's avatar
Jim Blandy committed
175
  else
176
    return num & ((((EMACS_INT) 1) << VALBITS) - 1);
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180 181
}

/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
182
  "Return t if the two args are the same Lisp object.")
Jim Blandy's avatar
Jim Blandy committed
183 184 185 186 187 188 189 190
  (obj1, obj2)
     Lisp_Object obj1, obj2;
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
191
DEFUN ("null", Fnull, Snull, 1, 1, 0, "Return t if OBJECT is nil.")
192 193
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
194
{
195
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
196 197 198 199
    return Qt;
  return Qnil;
}

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
DEFUN ("type-of", Ftype_of, Stype_of, 1, 1, 0,
  "Return a symbol representing the type of OBJECT.\n\
The symbol returned names the object's basic type;\n\
for example, (type-of 1) returns `integer'.")
  (object)
     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:
222
      switch (XMISCTYPE (object))
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
	{
	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;
246 247 248 249
      if (GC_CHAR_TABLE_P (object))
	return Qchar_table;
      if (GC_BOOL_VECTOR_P (object))
	return Qbool_vector;
250 251 252 253 254 255 256 257 258 259 260 261 262 263
      if (GC_FRAMEP (object))
	return Qframe;
      return Qvector;

#ifdef LISP_FLOAT_TYPE
    case Lisp_Float:
      return Qfloat;
#endif

    default:
      abort ();
    }
}

Richard M. Stallman's avatar
Richard M. Stallman committed
264
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0, "Return t if OBJECT is a cons cell.")
265 266
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
267
{
268
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
269 270 271 272
    return Qt;
  return Qnil;
}

273 274
DEFUN ("atom", Fatom, Satom, 1, 1, 0,
       "Return t if OBJECT is not a cons cell.  This includes nil.")
275 276
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
277
{
278
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
279 280 281 282
    return Qnil;
  return Qt;
}

283 284
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
       "Return t if OBJECT is a list.  This includes nil.")
285 286
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
287
{
288
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
289 290 291 292
    return Qt;
  return Qnil;
}

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

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

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

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

353 354
DEFUN ("vector-or-char-table-p", Fvector_or_char_table_p,
       Svector_or_char_table_p, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
355
       "Return t if OBJECT is a char-table or vector.")
356 357 358 359 360 361 362 363
  (object)
     Lisp_Object object;
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
364
DEFUN ("bool-vector-p", Fbool_vector_p, Sbool_vector_p, 1, 1, 0, "Return t if OBJECT is a bool-vector.")
365 366 367 368 369 370 371 372
  (object)
     Lisp_Object object;
{
  if (BOOL_VECTOR_P (object))
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
373
DEFUN ("arrayp", Farrayp, Sarrayp, 1, 1, 0, "Return t if OBJECT is an array (string or vector).")
374 375
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
376
{
377 378
  if (VECTORP (object) || STRINGP (object)
      || CHAR_TABLE_P (object) || BOOL_VECTOR_P (object))
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383
    return Qt;
  return Qnil;
}

DEFUN ("sequencep", Fsequencep, Ssequencep, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
384
  "Return t if OBJECT is a sequence (list or array).")
385 386
  (object)
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
387
{
388 389
  if (CONSP (object) || NILP (object) || VECTORP (object) || STRINGP (object)
      || CHAR_TABLE_P (object) || BOOL_VECTOR_P (object))
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
394
DEFUN ("bufferp", Fbufferp, Sbufferp, 1, 1, 0, "Return t if OBJECT is an editor buffer.")
395 396
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
397
{
398
  if (BUFFERP (object))
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
403
DEFUN ("markerp", Fmarkerp, Smarkerp, 1, 1, 0, "Return t if OBJECT is a marker (editor pointer).")
404 405
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
406
{
407
  if (MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
412
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0, "Return t if OBJECT is a built-in function.")
413 414
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
415
{
416
  if (SUBRP (object))
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420
    return Qt;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
421
DEFUN ("byte-code-function-p", Fbyte_code_function_p, Sbyte_code_function_p,
Richard M. Stallman's avatar
Richard M. Stallman committed
422
       1, 1, 0, "Return t if OBJECT is a byte-compiled function object.")
423 424
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
425
{
426
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430
    return Qt;
  return Qnil;
}

431
DEFUN ("char-or-string-p", Fchar_or_string_p, Schar_or_string_p, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
432
  "Return t if OBJECT is a character (an integer) or a string.")
433 434
  (object)
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
435
{
436
  if (INTEGERP (object) || STRINGP (object))
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
441
DEFUN ("integerp", Fintegerp, Sintegerp, 1, 1, 0, "Return t if OBJECT is an integer.")
442 443
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
444
{
445
  if (INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449
    return Qt;
  return Qnil;
}

450
DEFUN ("integer-or-marker-p", Finteger_or_marker_p, Sinteger_or_marker_p, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
451
  "Return t if OBJECT is an integer or a marker (editor pointer).")
452 453
  (object)
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
454
{
455
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459
    return Qt;
  return Qnil;
}

460
DEFUN ("natnump", Fnatnump, Snatnump, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
461
  "Return t if OBJECT is a nonnegative integer.")
462 463
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
464
{
465
  if (NATNUMP (object))
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469 470
    return Qt;
  return Qnil;
}

DEFUN ("numberp", Fnumberp, Snumberp, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
471
       "Return t if OBJECT is a number (floating point or integer).")
472 473
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
474
{
475
  if (NUMBERP (object))
Jim Blandy's avatar
Jim Blandy committed
476
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
477 478
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
479 480 481 482
}

DEFUN ("number-or-marker-p", Fnumber_or_marker_p,
       Snumber_or_marker_p, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
483
       "Return t if OBJECT is a number or a marker.")
484 485
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
486
{
487
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
488 489 490
    return Qt;
  return Qnil;
}
491 492 493

#ifdef LISP_FLOAT_TYPE
DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
494
       "Return t if OBJECT is a floating point number.")
495 496
  (object)
     Lisp_Object object;
497
{
498
  if (FLOATP (object))
499 500 501
    return Qt;
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505 506
#endif /* LISP_FLOAT_TYPE */

/* Extract and set components of lists */

DEFUN ("car", Fcar, Scar, 1, 1, 0,
507
  "Return the car of LIST.  If arg is nil, return nil.\n\
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513
Error if arg is not nil and not a cons cell.  See also `car-safe'.")
  (list)
     register Lisp_Object list;
{
  while (1)
    {
514
      if (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
515 516 517 518 519 520 521 522 523 524 525 526 527
	return XCONS (list)->car;
      else if (EQ (list, Qnil))
	return Qnil;
      else
	list = wrong_type_argument (Qlistp, list);
    }
}

DEFUN ("car-safe", Fcar_safe, Scar_safe, 1, 1, 0,
  "Return the car of OBJECT if it is a cons cell, or else nil.")
  (object)
     Lisp_Object object;
{
528
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
529 530 531 532 533 534
    return XCONS (object)->car;
  else
    return Qnil;
}

DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
535
  "Return the cdr of LIST.  If arg is nil, return nil.\n\
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541 542
Error if arg is not nil and not a cons cell.  See also `cdr-safe'.")

  (list)
     register Lisp_Object list;
{
  while (1)
    {
543
      if (CONSP (list))
Jim Blandy's avatar
Jim Blandy committed
544 545 546 547 548 549 550 551 552
	return XCONS (list)->cdr;
      else if (EQ (list, Qnil))
	return Qnil;
      else
	list = wrong_type_argument (Qlistp, list);
    }
}

DEFUN ("cdr-safe", Fcdr_safe, Scdr_safe, 1, 1, 0,
553
  "Return the cdr of OBJECT if it is a cons cell, or else nil.")
Jim Blandy's avatar
Jim Blandy committed
554 555 556
  (object)
     Lisp_Object object;
{
557
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562 563
    return XCONS (object)->cdr;
  else
    return Qnil;
}

DEFUN ("setcar", Fsetcar, Ssetcar, 2, 2, 0,
564
  "Set the car of CELL to be NEWCAR.  Returns NEWCAR.")
Jim Blandy's avatar
Jim Blandy committed
565 566 567
  (cell, newcar)
     register Lisp_Object cell, newcar;
{
568
  if (!CONSP (cell))
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573 574 575 576
    cell = wrong_type_argument (Qconsp, cell);

  CHECK_IMPURE (cell);
  XCONS (cell)->car = newcar;
  return newcar;
}

DEFUN ("setcdr", Fsetcdr, Ssetcdr, 2, 2, 0,
577
  "Set the cdr of CELL to be NEWCDR.  Returns NEWCDR.")
Jim Blandy's avatar
Jim Blandy committed
578 579 580
  (cell, newcdr)
     register Lisp_Object cell, newcdr;
{
581
  if (!CONSP (cell))
Jim Blandy's avatar
Jim Blandy committed
582 583 584 585 586 587 588 589 590
    cell = wrong_type_argument (Qconsp, cell);

  CHECK_IMPURE (cell);
  XCONS (cell)->cdr = newcdr;
  return newcdr;
}

/* Extract and set components of symbols */

Richard M. Stallman's avatar
Richard M. Stallman committed
591
DEFUN ("boundp", Fboundp, Sboundp, 1, 1, 0, "Return t if SYMBOL's value is not void.")
592 593
  (symbol)
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
594 595
{
  Lisp_Object valcontents;
596
  CHECK_SYMBOL (symbol, 0);
Jim Blandy's avatar
Jim Blandy committed
597

598
  valcontents = XSYMBOL (symbol)->value;
Jim Blandy's avatar
Jim Blandy committed
599

Karl Heuer's avatar
Karl Heuer committed
600 601
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
602
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
603

604
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
605 606
}

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

DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0, "Make SYMBOL's value be void.")
616 617
  (symbol)
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
618
{
619
  CHECK_SYMBOL (symbol, 0);
620 621
  if (NILP (symbol) || EQ (symbol, Qt)
      || (XSYMBOL (symbol)->name->data[0] == ':'
622
	  && EQ (XSYMBOL (symbol)->obarray, initial_obarray)
623
	  && keyword_symbols_constant_flag))
624 625 626
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
627 628 629
}

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

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

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

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

665 666
  CHECK_SYMBOL (symbol, 0);
  XSETSTRING (name, XSYMBOL (symbol)->name);
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670
  return name;
}

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

691
DEFUN ("defalias", Fdefalias, Sdefalias, 2, 2, 0,
692
  "Set SYMBOL's function definition to DEFINITION, and return DEFINITION.\n\
693
Associates the function with the current load file, if any.")
694 695
  (symbol, definition)
     register Lisp_Object symbol, definition;
696
{
697
  definition = Ffset (symbol, definition);
698
  LOADHIST_ATTACH (symbol);
699
  return definition;
700 701
}

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

Jim Blandy's avatar
Jim Blandy committed
712 713 714 715 716 717 718 719 720 721 722 723 724

/* Getting and setting values of symbols */

/* 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;
725 726
  int offset;
  if (MISCP (valcontents))
727
    switch (XMISCTYPE (valcontents))
728 729 730 731
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
732

733 734
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
735

736 737
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
738

739 740 741
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_buffer);
742

743 744 745
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_kboard);
746
      }
Jim Blandy's avatar
Jim Blandy committed
747 748 749
  return valcontents;
}

750 751
/* 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
752 753 754 755
   buffer-independent contents of the value cell: forwarded just one
   step past the buffer-localness.  */

void
756 757
store_symval_forwarding (symbol, valcontents, newval)
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
758 759
     register Lisp_Object valcontents, newval;
{
760
  switch (SWITCH_ENUM_CAST (XTYPE (valcontents)))
Jim Blandy's avatar
Jim Blandy committed
761
    {
762
    case Lisp_Misc:
763
      switch (XMISCTYPE (valcontents))
764 765 766 767
	{
	case Lisp_Misc_Intfwd:
	  CHECK_NUMBER (newval, 1);
	  *XINTFWD (valcontents)->intvar = XINT (newval);
768 769
	  if (*XINTFWD (valcontents)->intvar != XINT (newval))
	    error ("Value out of range for variable `%s'",
770
		   XSYMBOL (symbol)->name->data);
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
	  break;

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

	case Lisp_Misc_Objfwd:
	  *XOBJFWD (valcontents)->objvar = newval;
	  break;

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

	    type = *(Lisp_Object *)(offset + (char *)&buffer_local_types);
787 788 789
	    if (XINT (type) == -1)
	      error ("Variable %s is read-only", XSYMBOL (symbol)->name->data);

790 791 792 793 794 795
	    if (! NILP (type) && ! NILP (newval)
		&& XTYPE (newval) != XINT (type))
	      buffer_slot_type_mismatch (offset);

	    *(Lisp_Object *)(offset + (char *)current_buffer) = newval;
	  }
796 797
	  break;

798 799 800
	case Lisp_Misc_Kboard_Objfwd:
	  (*(Lisp_Object *)((char *)current_kboard
			    + XKBOARD_OBJFWD (valcontents)->offset))
801 802 803
	    = newval;
	  break;

804 805 806
	default:
	  goto def;
	}
Jim Blandy's avatar
Jim Blandy committed
807 808 809
      break;

    default:
810
    def:
811
      valcontents = XSYMBOL (symbol)->value;
812 813
      if (BUFFER_LOCAL_VALUEP (valcontents)
	  || SOME_BUFFER_LOCAL_VALUEP (valcontents))
814
	XBUFFER_LOCAL_VALUE (valcontents)->realvalue = newval;
Jim Blandy's avatar
Jim Blandy committed
815
      else
816
	XSYMBOL (symbol)->value = newval;
Jim Blandy's avatar
Jim Blandy committed
817 818 819
    }
}

820
/* Set up the buffer-local symbol SYMBOL for validity in the current
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824
   buffer.  VALCONTENTS is the contents of its value cell.
   Return the value forwarded one step past the buffer-local indicator.  */

static Lisp_Object
825 826
swap_in_symval_forwarding (symbol, valcontents)
     Lisp_Object symbol, valcontents;
Jim Blandy's avatar
Jim Blandy committed
827
{
828
  /* valcontents is a pointer to a struct resembling the cons
Jim Blandy's avatar
Jim Blandy committed
829
     (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE)).
830

Jim Blandy's avatar
Jim Blandy committed
831
     CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
832 833 834 835 836 837 838 839 840 841 842
     local_var_alist, that being the element whose car is this
     variable.  Or it can be a pointer to the
     (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE), if BUFFER does not have
     an element in its alist for this variable.

     If the current buffer is not BUFFER, we store the current
     REALVALUE value into CURRENT-ALIST-ELEMENT, then find the
     appropriate alist element for the buffer now current and set up
     CURRENT-ALIST-ELEMENT.  Then we set REALVALUE out of that
     element, and store into BUFFER.

Jim Blandy's avatar
Jim Blandy committed
843 844 845
     Note that REALVALUE can be a forwarding pointer. */

  register Lisp_Object tem1;
846
  tem1 = XBUFFER_LOCAL_VALUE (valcontents)->buffer;
Jim Blandy's avatar
Jim Blandy committed
847

848
  if (NILP (tem1) || current_buffer != XBUFFER (tem1)
849
      || !EQ (selected_frame, XBUFFER_LOCAL_VALUE (valcontents)->frame))
Jim Blandy's avatar
Jim Blandy committed
850
    {
851
      tem1 = XCONS (XBUFFER_LOCAL_VALUE (valcontents)->cdr)->car;
852
      Fsetcdr (tem1,
853
	       do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
854
      tem1 = assq_no_quit (symbol, current_buffer->local_var_alist);
855 856
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame = 0;
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_buffer = 0;
Jim Blandy's avatar
Jim Blandy committed
857
      if (NILP (tem1))
858 859
	{
	  if (XBUFFER_LOCAL_VALUE (valcontents)->check_frame)
860
	    tem1 = assq_no_quit (symbol, XFRAME (selected_frame)->param_alist);
861 862 863 864 865 866 867 868 869 870
	  if (! NILP (tem1))
	    XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame = 1;
	  else
	    tem1 = XBUFFER_LOCAL_VALUE (valcontents)->cdr;
	}
      else
	XBUFFER_LOCAL_VALUE (valcontents)->found_for_buffer = 1;

      XCONS (XBUFFER_LOCAL_VALUE (valcontents)->cdr)->car = tem1;
      XSETBUFFER (XBUFFER_LOCAL_VALUE (valcontents)->buffer, current_buffer);
871
      XBUFFER_LOCAL_VALUE (valcontents)->frame = selected_frame;
872 873
      store_symval_forwarding (symbol,
			       XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
874
			       Fcdr (tem1));
Jim Blandy's avatar
Jim Blandy committed
875
    }
876
  return XBUFFER_LOCAL_VALUE (valcontents)->realvalue;
Jim Blandy's avatar
Jim Blandy committed
877 878
}

Jim Blandy's avatar
Jim Blandy committed
879 880
/* Find the value of a symbol, returning Qunbound if it's not bound.
   This is helpful for code which just wants to get a variable's value
Karl Heuer's avatar
Karl Heuer committed
881
   if it has one, without signaling an error.
Jim Blandy's avatar
Jim Blandy committed
882 883
   Note that it must not be possible to quit
   within this function.  Great care is required for this.  */
Jim Blandy's avatar
Jim Blandy committed
884

Jim Blandy's avatar
Jim Blandy committed
885
Lisp_Object
886 887
find_symbol_value (symbol)
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
888
{
889
  register Lisp_Object valcontents;
Jim Blandy's avatar
Jim Blandy committed
890
  register Lisp_Object val;
891 892
  CHECK_SYMBOL (symbol, 0);
  valcontents = XSYMBOL (symbol)->value;
Jim Blandy's avatar
Jim Blandy committed
893

Karl Heuer's avatar
Karl Heuer committed
894 895
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
896
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
897

898 899
  if (MISCP (valcontents))
    {
900
      switch (XMISCTYPE (valcontents))
901 902 903 904
	{
	case Lisp_Misc_Intfwd:
	  XSETINT (val, *XINTFWD (valcontents)->intvar);
	  return val;
Jim Blandy's avatar
Jim Blandy committed
905

906 907
	case Lisp_Misc_Boolfwd:
	  return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
908

909 910
	case Lisp_Misc_Objfwd:
	  return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
911

912 913 914
	case Lisp_Misc_Buffer_Objfwd:
	  return *(Lisp_Object *)(XBUFFER_OBJFWD (valcontents)->offset
				  + (char *)current_buffer);
915

916 917 918
	case Lisp_Misc_Kboard_Objfwd:
	  return *(Lisp_Object *)(XKBOARD_OBJFWD (valcontents)->offset
				  + (char *)current_kboard);
919
	}
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924
    }

  return valcontents;
}

Jim Blandy's avatar
Jim Blandy committed
925 926
DEFUN ("symbol-value", Fsymbol_value, Ssymbol_value, 1, 1, 0,
  "Return SYMBOL's value.  Error if that is void.")