data.c 80.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,86,88,93,94,95,97,98, 1999 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
#include <config.h>
23
#include <signal.h>
24
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "puresize.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include "keyboard.h"
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "syssignal.h"
Jim Blandy's avatar
Jim Blandy committed
32

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
63 64 65
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
66
Lisp_Object Qvoid_variable, Qvoid_function, Qcyclic_function_indirection;
Jim Blandy's avatar
Jim Blandy committed
67 68
Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
Roland McGrath's avatar
Roland McGrath committed
69
Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
70
Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
71
Lisp_Object Qtext_read_only;
72
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
73 74
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
75
Lisp_Object Qbuffer_or_string_p, Qkeywordp;
Jim Blandy's avatar
Jim Blandy committed
76
Lisp_Object Qboundp, Qfboundp;
77
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
78

Jim Blandy's avatar
Jim Blandy committed
79
Lisp_Object Qcdr;
80
Lisp_Object Qad_advice_info, Qad_activate_internal;
Jim Blandy's avatar
Jim Blandy committed
81

82 83 84
Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
Lisp_Object Qoverflow_error, Qunderflow_error;

85
Lisp_Object Qfloatp;
Jim Blandy's avatar
Jim Blandy committed
86 87
Lisp_Object Qnumberp, Qnumber_or_marker_p;

88
static Lisp_Object Qinteger, Qsymbol, Qstring, Qcons, Qmarker, Qoverlay;
Karl Heuer's avatar
Karl Heuer committed
89 90
static Lisp_Object Qfloat, Qwindow_configuration, Qwindow;
Lisp_Object Qprocess;
91
static Lisp_Object Qcompiled_function, Qbuffer, Qframe, Qvector;
Gerd Moellmann's avatar
Gerd Moellmann committed
92
static Lisp_Object Qchar_table, Qbool_vector, Qhash_table;
93

Jim Blandy's avatar
Jim Blandy committed
94 95
static Lisp_Object swap_in_symval_forwarding ();

96 97
Lisp_Object set_internal ();

Jim Blandy's avatar
Jim Blandy committed
98 99 100 101 102 103 104 105 106
Lisp_Object
wrong_type_argument (predicate, value)
     register Lisp_Object predicate, value;
{
  register Lisp_Object tem;
  do
    {
      if (!EQ (Vmocklisp_arguments, Qt))
	{
107
	 if (STRINGP (value) &&
Jim Blandy's avatar
Jim Blandy committed
108
	     (EQ (predicate, Qintegerp) || EQ (predicate, Qinteger_or_marker_p)))
109
	   return Fstring_to_number (value, Qnil);
110
	 if (INTEGERP (value) && EQ (predicate, Qstringp))
111
	   return Fnumber_to_string (value);
Jim Blandy's avatar
Jim Blandy committed
112
	}
113 114 115

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

Jim Blandy's avatar
Jim Blandy committed
119 120 121
      value = Fsignal (Qwrong_type_argument, Fcons (predicate, Fcons (value, Qnil)));
      tem = call1 (predicate, value);
    }
Jim Blandy's avatar
Jim Blandy committed
122
  while (NILP (tem));
Jim Blandy's avatar
Jim Blandy committed
123 124 125
  return value;
}

Andreas Schwab's avatar
Andreas Schwab committed
126
void
Jim Blandy's avatar
Jim Blandy committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
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)
157
     EMACS_INT num;
Jim Blandy's avatar
Jim Blandy committed
158
{
159 160
  if (num & (((EMACS_INT) 1) << (VALBITS - 1)))
    return num | (((EMACS_INT) (-1)) << VALBITS);
Jim Blandy's avatar
Jim Blandy committed
161
  else
162
    return num & ((((EMACS_INT) 1) << VALBITS) - 1);
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167
}

/* Data type predicates */

DEFUN ("eq", Feq, Seq, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
168
  "Return t if the two args are the same Lisp object.")
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175 176
  (obj1, obj2)
     Lisp_Object obj1, obj2;
{
  if (EQ (obj1, obj2))
    return Qt;
  return Qnil;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
177
DEFUN ("null", Fnull, Snull, 1, 1, 0, "Return t if OBJECT is nil.")
178 179
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
180
{
181
  if (NILP (object))
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185
    return Qt;
  return Qnil;
}

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

Richard M. Stallman's avatar
Richard M. Stallman committed
250
DEFUN ("consp", Fconsp, Sconsp, 1, 1, 0, "Return t if OBJECT is a cons cell.")
251 252
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
253
{
254
  if (CONSP (object))
Jim Blandy's avatar
Jim Blandy committed
255 256 257 258
    return Qt;
  return Qnil;
}

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

269 270
DEFUN ("listp", Flistp, Slistp, 1, 1, 0,
       "Return t if OBJECT is a list.  This includes nil.")
271 272
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
273
{
274
  if (CONSP (object) || NILP (object))
Jim Blandy's avatar
Jim Blandy committed
275 276 277 278
    return Qt;
  return Qnil;
}

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

Dave Love's avatar
Dave Love committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/* Define this in C to avoid unnecessarily consing up the symbol
   name.  */
DEFUN ("keywordp", Fkeywordp, Skeywordp, 1, 1, 0,
       "Return t if OBJECT is a keyword.\n\
This means that it is a symbol with a print name beginning with `:'\n\
interned in the initial obarray.")
  (object)
     Lisp_Object object;
{
  if (SYMBOLP (object)
      && XSYMBOL (object)->name->data[0] == ':'
      && EQ (XSYMBOL (object)->obarray, initial_obarray))
    return Qt;
  return Qnil;
}

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

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

335 336 337 338 339 340 341 342 343 344 345 346
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.")
347 348 349 350 351 352 353 354
  (object)
     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,
Richard M. Stallman's avatar
Richard M. Stallman committed
357
       "Return t if OBJECT is a char-table or vector.")
358 359 360 361 362 363 364 365
  (object)
     Lisp_Object object;
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

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

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

452
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
453
  "Return t if OBJECT is an integer or a marker (editor pointer).")
454 455
  (object)
     register Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
456
{
457
  if (MARKERP (object) || INTEGERP (object))
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461
    return Qt;
  return Qnil;
}

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

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

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
485
       "Return t if OBJECT is a number or a marker.")
486 487
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
488
{
489
  if (NUMBERP (object) || MARKERP (object))
Jim Blandy's avatar
Jim Blandy committed
490 491 492
    return Qt;
  return Qnil;
}
493 494

DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
495
       "Return t if OBJECT is a floating point number.")
496 497
  (object)
     Lisp_Object object;
498
{
499
  if (FLOATP (object))
500 501 502
    return Qt;
  return Qnil;
}
503

Jim Blandy's avatar
Jim Blandy committed
504 505 506 507

/* Extract and set components of lists */

DEFUN ("car", Fcar, Scar, 1, 1, 0,
508
  "Return the car of LIST.  If arg is nil, return nil.\n\
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514
Error if arg is not nil and not a cons cell.  See also `car-safe'.")
  (list)
     register Lisp_Object list;
{
  while (1)
    {
515
      if (CONSP (list))
516
	return XCAR (list);
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521 522 523 524 525 526 527 528
      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;
{
529
  if (CONSP (object))
530
    return XCAR (object);
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534 535
  else
    return Qnil;
}

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

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

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

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

  CHECK_IMPURE (cell);
573
  XCAR (cell) = newcar;
Jim Blandy's avatar
Jim Blandy committed
574 575 576 577
  return newcar;
}

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

  CHECK_IMPURE (cell);
586
  XCDR (cell) = newcdr;
Jim Blandy's avatar
Jim Blandy committed
587 588 589 590 591
  return newcdr;
}

/* Extract and set components of symbols */

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

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

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

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

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

DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0, "Make SYMBOL's value be void.")
617 618
  (symbol)
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
619
{
620
  CHECK_SYMBOL (symbol, 0);
621 622
  if (NILP (symbol) || EQ (symbol, Qt)
      || (XSYMBOL (symbol)->name->data[0] == ':'
623
	  && EQ (XSYMBOL (symbol)->obarray, initial_obarray)))
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_internal, 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
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
741
	return BUFFER_LOCAL_VALUE (current_buffer, offset);
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
	  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;

786
	    type = BUFFER_LOCAL_TYPE (offset);
787 788 789
	    if (XINT (type) == -1)
	      error ("Variable %s is read-only", XSYMBOL (symbol)->name->data);

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

794
	    BUFFER_LOCAL_VALUE (current_buffer, offset) = newval;
795
	  }
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 buffer.
821 822 823 824 825
   VALCONTENTS is the contents of its value cell,
   which points to a struct Lisp_Buffer_Local_Value.

   Return the value forwarded one step past the buffer-local stage.
   This could be another forwarding pointer.  */
Jim Blandy's avatar
Jim Blandy committed
826 827

static Lisp_Object
828 829
swap_in_symval_forwarding (symbol, valcontents)
     Lisp_Object symbol, valcontents;
Jim Blandy's avatar
Jim Blandy committed
830 831
{
  register Lisp_Object tem1;
832
  tem1 = XBUFFER_LOCAL_VALUE (valcontents)->buffer;
Jim Blandy's avatar
Jim Blandy committed
833

834 835 836 837
  if (NILP (tem1)
      || current_buffer != XBUFFER (tem1)
      || (XBUFFER_LOCAL_VALUE (valcontents)->check_frame
	  && ! EQ (selected_frame, XBUFFER_LOCAL_VALUE (valcontents)->frame)))
Jim Blandy's avatar
Jim Blandy committed
838
    {
839
      /* Unload the previously loaded binding.  */
840
      tem1 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
841
      Fsetcdr (tem1,
842
	       do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
843
      /* Choose the new binding.  */
844
      tem1 = assq_no_quit (symbol, current_buffer->local_var_alist);
845 846
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame = 0;
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_buffer = 0;
Jim Blandy's avatar
Jim Blandy committed
847
      if (NILP (tem1))
848 849
	{
	  if (XBUFFER_LOCAL_VALUE (valcontents)->check_frame)
850
	    tem1 = assq_no_quit (symbol, XFRAME (selected_frame)->param_alist);
851 852 853 854 855 856 857 858
	  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;

859
      /* Load the new binding.  */
860
      XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr) = tem1;
861
      XSETBUFFER (XBUFFER_LOCAL_VALUE (valcontents)->buffer, current_buffer);
862
      XBUFFER_LOCAL_VALUE (valcontents)->frame = selected_frame;
863 864
      store_symval_forwarding (symbol,
			       XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
865
			       Fcdr (tem1));
Jim Blandy's avatar
Jim Blandy committed
866
    }
867
  return XBUFFER_LOCAL_VALUE (valcontents)->realvalue;
Jim Blandy's avatar
Jim Blandy committed
868 869
}

Jim Blandy's avatar
Jim Blandy committed
870 871
/* 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
872
   if it has one, without signaling an error.
Jim Blandy's avatar
Jim Blandy committed
873 874
   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
875

Jim Blandy's avatar
Jim Blandy committed
876
Lisp_Object
877 878
find_symbol_value (symbol)
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
879
{
880
  register Lisp_Object valcontents;
Jim Blandy's avatar
Jim Blandy committed
881
  register Lisp_Object val;
882 883
  CHECK_SYMBOL (symbol, 0);
  valcontents = XSYMBOL (symbol)->value;
Jim Blandy's avatar
Jim Blandy committed
884

Karl Heuer's avatar
Karl Heuer committed
885 886
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
887 888
    valcontents = swap_in_symval_forwarding (symbol, valcontents,
					     current_buffer);
Jim Blandy's avatar
Jim Blandy committed
889

890 891
  if (MISCP (valcontents))
    {
892
      switch (XMISCTYPE (valcontents))
893 894 895 896
	{
	case Lisp_Misc_Intfwd:
	  XSETINT (val, *XINTFWD (valcontents)->intvar);
	  return val;
Jim Blandy's avatar
Jim Blandy committed
897

898 899
	case Lisp_Misc_Boolfwd:
	  return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
900

901 902
	case Lisp_Misc_Objfwd:
	  return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
903

904
	case Lisp_Misc_Buffer_Objfwd<