data.c 87.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Primitive operations on Lisp data types for GNU Emacs Lisp interpreter.
2 3
   Copyright (C) 1985,86,88,93,94,95,97,98,99, 2000, 2001
   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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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;
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;
74
Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
75 76
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
77
Lisp_Object Qbuffer_or_string_p, Qkeywordp;
Jim Blandy's avatar
Jim Blandy committed
78
Lisp_Object Qboundp, Qfboundp;
79
Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
80

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

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

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

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

97
static Lisp_Object swap_in_symval_forwarding P_ ((Lisp_Object, Lisp_Object));
98

99 100
int most_positive_fixnum, most_negative_fixnum;

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

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

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

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

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

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

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

    case Lisp_Float:
      return Qfloat;

    default:
      abort ();
    }
}

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

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

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

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

Dave Love's avatar
Dave Love committed
302 303 304 305 306 307 308 309 310 311 312
/* 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] == ':'
313
      && SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (object))
Dave Love's avatar
Dave Love committed
314 315 316 317
    return Qt;
  return Qnil;
}

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

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

338 339 340 341 342 343 344 345 346 347 348 349
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.")
350 351 352 353 354 355 356 357
  (object)
     Lisp_Object object;
{
  if (CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

358 359
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
360
       "Return t if OBJECT is a char-table or vector.")
361 362 363 364 365 366 367 368
  (object)
     Lisp_Object object;
{
  if (VECTORP (object) || CHAR_TABLE_P (object))
    return Qt;
  return Qnil;
}

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

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
417
DEFUN ("subrp", Fsubrp, Ssubrp, 1, 1, 0, "Return t if OBJECT is a built-in function.")
418 419
  (object)
     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,
Richard M. Stallman's avatar
Richard M. Stallman committed
427
       1, 1, 0, "Return t if OBJECT is a byte-compiled function object.")
428 429
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
430
{
431
  if (COMPILEDP (object))
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435
    return Qt;
  return Qnil;
}

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

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

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

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

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

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

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

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

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

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

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

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

  CHECK_IMPURE (cell);
576
  XCAR (cell) = newcar;
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580
  return newcar;
}

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

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

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

602
  valcontents = SYMBOL_VALUE (symbol);
Jim Blandy's avatar
Jim Blandy committed
603

Karl Heuer's avatar
Karl Heuer committed
604 605
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
606
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
607

608
  return (EQ (valcontents, Qunbound) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
609 610
}

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

DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0, "Make SYMBOL's value be void.")
620 621
  (symbol)
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
622
{
623
  CHECK_SYMBOL (symbol, 0);
624
  if (XSYMBOL (symbol)->constant)
625 626 627
    return Fsignal (Qsetting_constant, Fcons (symbol, Qnil));
  Fset (symbol, Qunbound);
  return symbol;
Jim Blandy's avatar
Jim Blandy committed
628 629 630
}

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

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
643 644
  (symbol)
     register Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
645
{
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649
  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
650 651 652
}

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

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

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

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

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

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

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
DEFUN ("subr-arity", Fsubr_arity, Ssubr_arity, 1, 1, 0,
  "Return minimum and maximum number of args allowed for SUBR.\n\
SUBR must be a built-in function.\n\
The returned value is a pair (MIN . MAX).  MIN is the minimum number\n\
of args.  MAX is the maximum number or the symbol `many', for a\n\
function with `&rest' args, or `unevalled' for a special form.")
  (subr)
     Lisp_Object subr;
{
  short minargs, maxargs;
  if (!SUBRP (subr))
    wrong_type_argument (Qsubrp, subr);
  minargs = XSUBR (subr)->min_args;
  maxargs = XSUBR (subr)->max_args;
  if (maxargs == MANY)
    return Fcons (make_number (minargs), Qmany);
  else if (maxargs == UNEVALLED)
    return Fcons (make_number (minargs), Qunevalled);
  else
    return Fcons (make_number (minargs), make_number (maxargs));
}

735 736 737 738 739 740 741 742 743 744 745 746 747 748
DEFUN ("subr-interactive-form", Fsubr_interactive_form, Ssubr_interactive_form, 1, 1, 0,
  "Return the interactive form of SUBR or nil if none.\n\
SUBR must be a built-in function.  Value, if non-nil, is a list\n\
\(interactive SPEC).")
  (subr)
     Lisp_Object subr;
{
  if (!SUBRP (subr))
    wrong_type_argument (Qsubrp, subr);
  if (XSUBR (subr)->prompt)
    return list2 (Qinteractive, build_string (XSUBR (subr)->prompt));
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
749

750 751 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 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
/***********************************************************************
		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;
      
      hare = XSYMBOL (hare)->value;
      tortoise = XSYMBOL (tortoise)->value;

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

  return hare;
}


DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
  "Return the variable at the end of OBJECT's variable chain.\n\
If OBJECT is a symbol, follow all variable indirections and return the final\n\
variable.  If OBJECT is not a symbol, just return it.\n\
Signal a cyclic-variable-indirection error if there is a loop in the\n\
variable chain of symbols.")
  (object)
     Lisp_Object object;
{
  if (SYMBOLP (object))
    object = indirect_variable (object);
  return object;
}

Jim Blandy's avatar
Jim Blandy committed
797 798 799 800 801 802 803 804 805 806 807

/* 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;
808 809
  int offset;
  if (MISCP (valcontents))
810
    switch (XMISCTYPE (valcontents))
811 812 813 814
      {
      case Lisp_Misc_Intfwd:
	XSETINT (val, *XINTFWD (valcontents)->intvar);
	return val;
Jim Blandy's avatar
Jim Blandy committed
815

816 817
      case Lisp_Misc_Boolfwd:
	return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
818

819 820
      case Lisp_Misc_Objfwd:
	return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
821

822 823
      case Lisp_Misc_Buffer_Objfwd:
	offset = XBUFFER_OBJFWD (valcontents)->offset;
Gerd Moellmann's avatar
Gerd Moellmann committed
824
	return PER_BUFFER_VALUE (current_buffer, offset);
825

826 827 828
      case Lisp_Misc_Kboard_Objfwd:
	offset = XKBOARD_OBJFWD (valcontents)->offset;
	return *(Lisp_Object *)(offset + (char *)current_kboard);
829
      }
Jim Blandy's avatar
Jim Blandy committed
830 831 832
  return valcontents;
}

833 834
/* 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
835
   buffer-independent contents of the value cell: forwarded just one
836 837 838 839
   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
840 841

void
842
store_symval_forwarding (symbol, valcontents, newval, buf)
843
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
844
     register Lisp_Object valcontents, newval;
845
     struct buffer *buf;
Jim Blandy's avatar
Jim Blandy committed
846
{
847
  switch (SWITCH_ENUM_CAST (XTYPE (valcontents)))
Jim Blandy's avatar
Jim Blandy committed
848
    {
849
    case Lisp_Misc:
850
      switch (XMISCTYPE (valcontents))
851 852 853 854
	{
	case Lisp_Misc_Intfwd:
	  CHECK_NUMBER (newval, 1);
	  *XINTFWD (valcontents)->intvar = XINT (newval);
855 856
	  if (*XINTFWD (valcontents)->intvar != XINT (newval))
	    error ("Value out of range for variable `%s'",
857
		   XSYMBOL (symbol)->name->data);
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
	  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;

Gerd Moellmann's avatar
Gerd Moellmann committed
873
	    type = PER_BUFFER_TYPE (offset);
874 875 876
	    if (XINT (type) == -1)
	      error ("Variable %s is read-only", XSYMBOL (symbol)->name->data);

877 878 879 880
	    if (! NILP (type) && ! NILP (newval)
		&& XTYPE (newval) != XINT (type))
	      buffer_slot_type_mismatch (offset);

881 882 883
	    if (buf == NULL)
	      buf = current_buffer;
	    PER_BUFFER_VALUE (buf, offset) = newval;
884
	  }
885 886
	  break;

887
	case Lisp_Misc_Kboard_Objfwd:
888 889 890 891 892
	  {
	    char *base = (char *) current_kboard;
	    char *p = base + XKBOARD_OBJFWD (valcontents)->offset;
	    *(Lisp_Object *) p = newval;
	  }
893 894
	  break;

895 896 897
	default:
	  goto def;
	}
Jim Blandy's avatar
Jim Blandy committed
898 899 900
      break;

    default:
901
    def:
902
      valcontents = SYMBOL_VALUE (symbol);
903 904
      if (BUFFER_LOCAL_VALUEP (valcontents)
	  || SOME_BUFFER_LOCAL_VALUEP (valcontents))
905
	XBUFFER_LOCAL_VALUE (valcontents)->realvalue = newval;
Jim Blandy's avatar
Jim Blandy committed
906
      else
907
	SET_SYMBOL_VALUE (symbol, newval);
Jim Blandy's avatar
Jim Blandy committed
908 909 910
    }
}

911 912 913 914 915 916 917 918 919
/* 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;
  
920
  valcontents = SYMBOL_VALUE (symbol);
921 922 923 924 925 926 927 928 929 930 931
  if (!BUFFER_LOCAL_VALUEP (valcontents)
      && !SOME_BUFFER_LOCAL_VALUEP (valcontents))
    abort ();
  cdr = XBUFFER_LOCAL_VALUE (valcontents)->cdr;

  /* Unload the previously loaded binding.  */
  Fsetcdr (XCAR (cdr),
	   do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
  
  /* Select the global binding in the symbol.  */
  XCAR (cdr) = cdr;
932
  store_symval_forwarding (symbol, valcontents, XCDR (cdr), NULL);
933 934 935 936 937 938 939 940

  /* Indicate that the global binding is set up now.  */
  XBUFFER_LOCAL_VALUE (valcontents)->frame = Qnil;
  XBUFFER_LOCAL_VALUE (valcontents)->buffer = Qnil;
  XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame = 0;
  XBUFFER_LOCAL_VALUE (valcontents)->found_for_buffer = 0;
}

941
/* Set up the buffer-local symbol SYMBOL for validity in the current buffer.
942 943 944 945 946
   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
947 948

static Lisp_Object
949 950
swap_in_symval_forwarding (symbol, valcontents)
     Lisp_Object symbol, valcontents;
Jim Blandy's avatar
Jim Blandy committed
951 952
{
  register Lisp_Object tem1;
953
  
954
  tem1 = XBUFFER_LOCAL_VALUE (valcontents)->buffer;
Jim Blandy's avatar
Jim Blandy committed
955

956 957 958 959
  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
960
    {
961 962 963
      if (XSYMBOL (symbol)->indirect_variable)
	symbol = indirect_variable (symbol);
      
964
      /* Unload the previously loaded binding.  */
965
      tem1 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
966
      Fsetcdr (tem1,
967
	       do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
968
      /* Choose the new binding.  */
969
      tem1 = assq_no_quit (symbol, current_buffer->local_var_alist);
970 971
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame = 0;
      XBUFFER_LOCAL_VALUE (valcontents)->found_for_buffer = 0;
Jim Blandy's avatar
Jim Blandy committed
972
      if (NILP (tem1))
973 974
	{
	  if (XBUFFER_LOCAL_VALUE (valcontents)->check_frame)
975
	    tem1 = assq_no_quit (symbol, XFRAME (selected_frame)->param_alist);
976 977 978 979 980 981 982 983
	  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;

984
      /* Load the new binding.  */
985
      XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr) = tem1;
986
      XSETBUFFER (XBUFFER_LOCAL_VALUE (valcontents)->buffer, current_buffer);
987
      XBUFFER_LOCAL_VALUE (valcontents)->frame = selected_frame;
988 989
      store_symval_forwarding (symbol,
			       XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
990
			       Fcdr (tem1), NULL);
Jim Blandy's avatar
Jim Blandy committed
991
    }
992
  return XBUFFER_LOCAL_VALUE (valcontents)->realvalue;
Jim Blandy's avatar
Jim Blandy committed
993 994
}

Jim Blandy's avatar
Jim Blandy committed
995 996
/* 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
997
   if it has one, without signaling an error.
Jim Blandy's avatar
Jim Blandy committed
998 999
   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
1000

Jim Blandy's avatar
Jim Blandy committed
1001
Lisp_Object
1002 1003
find_symbol_value (symbol)
     Lisp_Object symbol;
Jim Blandy's avatar
Jim Blandy committed
1004
{
1005
  register Lisp_Object valcontents;
Jim Blandy's avatar
Jim Blandy committed
1006
  register Lisp_Object val;
1007
  
1008
  CHECK_SYMBOL (symbol, 0);
1009
  valcontents = SYMBOL_VALUE (symbol);
Jim Blandy's avatar
Jim Blandy committed
1010

Karl Heuer's avatar
Karl Heuer committed
1011 1012
  if (BUFFER_LOCAL_VALUEP (valcontents)
      || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1013
    valcontents = swap_in_symval_forwarding (symbol, valcontents);
Jim Blandy's avatar
Jim Blandy committed
1014

1015 1016
  if (MISCP (valcontents))
    {
1017
      switch (XMISCTYPE (valcontents))
1018 1019 1020 1021
	{
	case Lisp_Misc_Intfwd:
	  XSETINT (val, *XINTFWD (valcontents)->intvar);
	  return val;
Jim Blandy's avatar
Jim Blandy committed
1022

1023 1024
	case Lisp_Misc_Boolfwd:
	  return (*XBOOLFWD (valcontents)->boolvar ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
1025

1026 1027
	case Lisp_Misc_Objfwd:
	  return *XOBJFWD (valcontents)->objvar;
Jim Blandy's avatar
Jim Blandy committed
1028

1029
	case Lisp_Misc_Buffer_Objfwd:
Gerd Moellmann's avatar
Gerd Moellmann committed
1030
	  return PER_BUFFER_VALUE (current_buffer,
1031
				     XBUFFER_OBJFWD (valcontents)->offset);
1032