fns.c 53.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 86, 87, 93, 94, 95 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
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>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27 28 29 30

/* Note on some machines this defines `vector' as a typedef,
   so make sure we don't use that name in this file.  */
#undef vector
#define vector *****

#include "lisp.h"
#include "commands.h"
31
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
32 33

#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
34
#include "keyboard.h"
35
#include "intervals.h"
36 37
#include "frame.h"
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
38

Karl Heuer's avatar
Karl Heuer committed
39 40 41 42
#ifndef NULL
#define NULL (void *)0
#endif

43 44 45 46
/* Nonzero enables use of dialog boxes for questions
   asked by mouse commands.  */
int use_dialog_box;

47 48
extern Lisp_Object Flookup_key ();

49 50 51
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;

52
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
53
Lisp_Object Qyes_or_no_p_history;
54
Lisp_Object Qcursor_in_echo_area;
Jim Blandy's avatar
Jim Blandy committed
55

56
static int internal_equal ();
57

Jim Blandy's avatar
Jim Blandy committed
58 59 60 61 62 63 64 65
DEFUN ("identity", Fidentity, Sidentity, 1, 1, 0,
  "Return the argument unchanged.")
  (arg)
     Lisp_Object arg;
{
  return arg;
}

66 67 68 69
extern long get_random ();
extern void seed_random ();
extern long time ();

Jim Blandy's avatar
Jim Blandy committed
70 71
DEFUN ("random", Frandom, Srandom, 0, 1, 0,
  "Return a pseudo-random number.\n\
72 73
All integers representable in Lisp are equally likely.\n\
  On most systems, this is 28 bits' worth.\n\
74
With positive integer argument N, return random number in interval [0,N).\n\
Jim Blandy's avatar
Jim Blandy committed
75
With argument t, set the random number seed from the current time and pid.")
76 77
  (n)
     Lisp_Object n;
Jim Blandy's avatar
Jim Blandy committed
78
{
79 80
  EMACS_INT val;
  Lisp_Object lispy_val;
81
  unsigned long denominator;
Jim Blandy's avatar
Jim Blandy committed
82

83
  if (EQ (n, Qt))
84
    seed_random (getpid () + time (NULL));
85
  if (NATNUMP (n) && XFASTINT (n) != 0)
Jim Blandy's avatar
Jim Blandy committed
86
    {
87 88 89 90
      /* Try to take our random number from the higher bits of VAL,
	 not the lower, since (says Gentzel) the low bits of `random'
	 are less random than the higher ones.  We do this by using the
	 quotient rather than the remainder.  At the high end of the RNG
91
	 it's possible to get a quotient larger than n; discarding
92
	 these values eliminates the bias that would otherwise appear
93 94
	 when using a large n.  */
      denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
95
      do
96
	val = get_random () / denominator;
97
      while (val >= XFASTINT (n));
Jim Blandy's avatar
Jim Blandy committed
98
    }
99
  else
100
    val = get_random ();
101 102
  XSETINT (lispy_val, val);
  return lispy_val;
Jim Blandy's avatar
Jim Blandy committed
103 104 105 106 107 108
}

/* Random data-structure functions */

DEFUN ("length", Flength, Slength, 1, 1, 0,
  "Return the length of vector, list or string SEQUENCE.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
109 110 111 112
A byte-code function object is also allowed.\n\
If the string contains multibyte characters, this is not the necessarily\n\
the number of characters in the string; it is the number of bytes.\n\
To get the number of characters, use `chars-in-string'")
113 114
  (sequence)
     register Lisp_Object sequence;
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119
{
  register Lisp_Object tail, val;
  register int i;

 retry:
120 121 122 123 124
  if (STRINGP (sequence))
    XSETFASTINT (val, XSTRING (sequence)->size);
  else if (VECTORP (sequence))
    XSETFASTINT (val, XVECTOR (sequence)->size);
  else if (CHAR_TABLE_P (sequence))
125
    XSETFASTINT (val, CHAR_TABLE_ORDINARY_SLOTS);
126 127 128 129 130
  else if (BOOL_VECTOR_P (sequence))
    XSETFASTINT (val, XBOOL_VECTOR (sequence)->size);
  else if (COMPILEDP (sequence))
    XSETFASTINT (val, XVECTOR (sequence)->size & PSEUDOVECTOR_SIZE_MASK);
  else if (CONSP (sequence))
Jim Blandy's avatar
Jim Blandy committed
131
    {
132
      for (i = 0, tail = sequence; !NILP (tail); i++)
Jim Blandy's avatar
Jim Blandy committed
133 134 135 136 137
	{
	  QUIT;
	  tail = Fcdr (tail);
	}

138
      XSETFASTINT (val, i);
Jim Blandy's avatar
Jim Blandy committed
139
    }
140
  else if (NILP (sequence))
141
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
142 143
  else
    {
144
      sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
145 146
      goto retry;
    }
147
  return val;
Jim Blandy's avatar
Jim Blandy committed
148 149
}

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/* This does not check for quits.  That is safe
   since it must terminate.  */

DEFUN ("safe-length", Fsafe_length, Ssafe_length, 1, 1, 0,
  "Return the length of a list, but avoid error or infinite loop.\n\
This function never gets an error.  If LIST is not really a list,\n\
it returns 0.  If LIST is circular, it returns a finite value\n\
which is at least the number of distinct elements.")
 (list)
     Lisp_Object list;
{
  Lisp_Object tail, halftail, length;
  int len = 0;

  /* halftail is used to detect circular lists.  */
  halftail = list;
  for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
    {
      if (EQ (tail, halftail) && len != 0)
169
	break;
170
      len++;
171
      if ((len & 1) == 0)
172 173 174 175 176 177 178
	halftail = XCONS (halftail)->cdr;
    }

  XSETINT (length, len);
  return length;
}

Jim Blandy's avatar
Jim Blandy committed
179 180
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
  "T if two strings have identical contents.\n\
181
Case is significant, but text properties are ignored.\n\
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
186
  if (SYMBOLP (s1))
187
    XSETSTRING (s1, XSYMBOL (s1)->name);
188
  if (SYMBOLP (s2))
189
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

  if (XSTRING (s1)->size != XSTRING (s2)->size ||
      bcmp (XSTRING (s1)->data, XSTRING (s2)->data, XSTRING (s1)->size))
    return Qnil;
  return Qt;
}

DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
  "T if first arg string is less than second in lexicographic order.\n\
Case is significant.\n\
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
  register int i;
  register unsigned char *p1, *p2;
  register int end;

210
  if (SYMBOLP (s1))
211
    XSETSTRING (s1, XSYMBOL (s1)->name);
212
  if (SYMBOLP (s2))
213
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

  p1 = XSTRING (s1)->data;
  p2 = XSTRING (s2)->data;
  end = XSTRING (s1)->size;
  if (end > XSTRING (s2)->size)
    end = XSTRING (s2)->size;

  for (i = 0; i < end; i++)
    {
      if (p1[i] != p2[i])
	return p1[i] < p2[i] ? Qt : Qnil;
    }
  return i < XSTRING (s2)->size ? Qt : Qnil;
}

static Lisp_Object concat ();

/* ARGSUSED */
Lisp_Object
concat2 (s1, s2)
     Lisp_Object s1, s2;
{
#ifdef NO_ARG_ARRAY
  Lisp_Object args[2];
  args[0] = s1;
  args[1] = s2;
  return concat (2, args, Lisp_String, 0);
#else
  return concat (2, &s1, Lisp_String, 0);
#endif /* NO_ARG_ARRAY */
}

Richard M. Stallman's avatar
Richard M. Stallman committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
/* ARGSUSED */
Lisp_Object
concat3 (s1, s2, s3)
     Lisp_Object s1, s2, s3;
{
#ifdef NO_ARG_ARRAY
  Lisp_Object args[3];
  args[0] = s1;
  args[1] = s2;
  args[2] = s3;
  return concat (3, args, Lisp_String, 0);
#else
  return concat (3, &s1, Lisp_String, 0);
#endif /* NO_ARG_ARRAY */
}

Jim Blandy's avatar
Jim Blandy committed
264 265 266 267
DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
  "Concatenate all the arguments and make the result a list.\n\
The result is a list whose elements are the elements of all the arguments.\n\
Each argument may be a list, vector or string.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
268
The last argument is not copied, just used as the tail of the new list.")
Jim Blandy's avatar
Jim Blandy committed
269 270 271 272 273 274 275 276 277 278
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_Cons, 1);
}

DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
  "Concatenate all the arguments and make the result a string.\n\
The result is a string whose elements are the elements of all the arguments.\n\
279 280 281 282 283 284
Each argument may be a string or a list or vector of characters (integers).\n\
\n\
Do not use individual integers as arguments!\n\
The behavior of `concat' in that case will be changed later!\n\
If your program passes an integer as an argument to `concat',\n\
you should change it right away not to do so.")
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_String, 0);
}

DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
  "Concatenate all the arguments and make the result a vector.\n\
The result is a vector whose elements are the elements of all the arguments.\n\
Each argument may be a list, vector or string.")
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
300
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
301 302
}

303 304 305 306
/* Retrun a copy of a sub char table ARG.  The elements except for a
   nested sub char table are not copied.  */
static Lisp_Object
copy_sub_char_table (arg)
307
     Lisp_Object arg;
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
{
  Lisp_Object copy = make_sub_char_table (XCHAR_TABLE (arg)->defalt);
  int i;

  /* Copy all the contents.  */
  bcopy (XCHAR_TABLE (arg)->contents, XCHAR_TABLE (copy)->contents,
	 SUB_CHAR_TABLE_ORDINARY_SLOTS * sizeof (Lisp_Object));
  /* Recursively copy any sub char-tables in the ordinary slots.  */
  for (i = 32; i < SUB_CHAR_TABLE_ORDINARY_SLOTS; i++)
    if (SUB_CHAR_TABLE_P (XCHAR_TABLE (arg)->contents[i]))
      XCHAR_TABLE (copy)->contents[i]
	= copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);

  return copy;
}


Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331
DEFUN ("copy-sequence", Fcopy_sequence, Scopy_sequence, 1, 1, 0,
  "Return a copy of a list, vector or string.\n\
The elements of a list or vector are not copied; they are shared\n\
with the original.")
  (arg)
     Lisp_Object arg;
{
Jim Blandy's avatar
Jim Blandy committed
332
  if (NILP (arg)) return arg;
333 334 335

  if (CHAR_TABLE_P (arg))
    {
336
      int i;
337 338
      Lisp_Object copy;

339
      copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
340
      /* Copy all the slots, including the extra ones.  */
341
      bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
342 343
	     ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
	      * sizeof (Lisp_Object)));
344

345 346 347 348 349
      /* Recursively copy any sub char tables in the ordinary slots
         for multibyte characters.  */
      for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS;
	   i < CHAR_TABLE_ORDINARY_SLOTS; i++)
	if (SUB_CHAR_TABLE_P (XCHAR_TABLE (arg)->contents[i]))
350
	  XCHAR_TABLE (copy)->contents[i]
351
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
352 353 354 355 356 357 358 359

      return copy;
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
360
	= (XBOOL_VECTOR (arg)->size + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
361 362 363 364 365 366 367

      val = Fmake_bool_vector (Flength (arg), Qnil);
      bcopy (XBOOL_VECTOR (arg)->data, XBOOL_VECTOR (val)->data,
	     size_in_chars);
      return val;
    }

368
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
Jim Blandy's avatar
Jim Blandy committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
    arg = wrong_type_argument (Qsequencep, arg);
  return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
}

static Lisp_Object
concat (nargs, args, target_type, last_special)
     int nargs;
     Lisp_Object *args;
     enum Lisp_Type target_type;
     int last_special;
{
  Lisp_Object val;
  Lisp_Object len;
  register Lisp_Object tail;
  register Lisp_Object this;
  int toindex;
  register int leni;
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;

  /* In append, the last arg isn't treated like the others */
  if (last_special && nargs > 0)
    {
      nargs--;
      last_tail = args[nargs];
    }
  else
    last_tail = Qnil;

  for (argnum = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
402
      if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
403
	    || COMPILEDP (this) || BOOL_VECTOR_P (this)))
Jim Blandy's avatar
Jim Blandy committed
404
	{
405
	  if (INTEGERP (this))
406
            args[argnum] = Fnumber_to_string (this);
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412 413 414 415
	  else
	    args[argnum] = wrong_type_argument (Qsequencep, this);
	}
    }

  for (argnum = 0, leni = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
      len = Flength (this);
416 417
      if ((VECTORP (this) || CONSP (this)) && target_type == Lisp_String)

418 419 420 421 422 423
	{
	  /* We must pay attention to a multibyte character which
             takes more than one byte in string.  */
	  int i;
	  Lisp_Object ch;

424 425 426 427 428 429
	  if (VECTORP (this))
	    for (i = 0; i < XFASTINT (len); i++)
	      {
		ch = XVECTOR (this)->contents[i];
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
430
		leni += XFASTINT (Fchar_bytes (ch));
431 432 433 434 435 436 437
	      }
	  else
	    for (; CONSP (this); this = XCONS (this)->cdr)
	      {
		ch = XCONS (this)->car;
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
438
		leni += XFASTINT (Fchar_bytes (ch));
439
	      }
440 441 442
	}
      else
	leni += XFASTINT (len);
Jim Blandy's avatar
Jim Blandy committed
443 444
    }

445
  XSETFASTINT (len, leni);
Jim Blandy's avatar
Jim Blandy committed
446 447 448

  if (target_type == Lisp_Cons)
    val = Fmake_list (len, Qnil);
449
  else if (target_type == Lisp_Vectorlike)
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
    val = Fmake_vector (len, Qnil);
  else
    val = Fmake_string (len, len);

  /* In append, if all but last arg are nil, return last arg */
  if (target_type == Lisp_Cons && EQ (val, Qnil))
    return last_tail;

  if (CONSP (val))
    tail = val, toindex = -1;		/* -1 in toindex is flag we are making a list */
  else
    toindex = 0;

  prev = Qnil;

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
      int thisleni;
469
      register unsigned int thisindex = 0;
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474

      this = args[argnum];
      if (!CONSP (this))
	thislen = Flength (this), thisleni = XINT (thislen);

475
      if (STRINGP (this) && STRINGP (val)
476 477 478 479 480 481
	  && ! NULL_INTERVAL_P (XSTRING (this)->intervals))
	{
	  copy_text_properties (make_number (0), thislen, this,
				make_number (toindex), val, Qnil);
	}

Jim Blandy's avatar
Jim Blandy committed
482 483 484 485
      while (1)
	{
	  register Lisp_Object elt;

486 487
	  /* Fetch next element of `this' arg into `elt', or break if
             `this' is exhausted. */
Jim Blandy's avatar
Jim Blandy committed
488
	  if (NILP (this)) break;
Jim Blandy's avatar
Jim Blandy committed
489
	  if (CONSP (this))
490
	    elt = XCONS (this)->car, this = XCONS (this)->cdr;
Jim Blandy's avatar
Jim Blandy committed
491 492 493
	  else
	    {
	      if (thisindex >= thisleni) break;
494
	      if (STRINGP (this))
495
		XSETFASTINT (elt, XSTRING (this)->data[thisindex++]);
496 497 498
	      else if (BOOL_VECTOR_P (this))
		{
		  int size_in_chars
499
		    = ((XBOOL_VECTOR (this)->size + BITS_PER_CHAR - 1)
500
		       / BITS_PER_CHAR);
501
		  int byte;
502
		  byte = XBOOL_VECTOR (val)->data[thisindex / BITS_PER_CHAR];
503
		  if (byte & (1 << (thisindex % BITS_PER_CHAR)))
504 505 506 507
		    elt = Qt;
		  else
		    elt = Qnil;
		}
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514 515 516 517 518
	      else
		elt = XVECTOR (this)->contents[thisindex++];
	    }

	  /* Store into result */
	  if (toindex < 0)
	    {
	      XCONS (tail)->car = elt;
	      prev = tail;
	      tail = XCONS (tail)->cdr;
	    }
519
	  else if (VECTORP (val))
Jim Blandy's avatar
Jim Blandy committed
520 521 522
	    XVECTOR (val)->contents[toindex++] = elt;
	  else
	    {
523
	      while (!INTEGERP (elt))
Jim Blandy's avatar
Jim Blandy committed
524 525
		elt = wrong_type_argument (Qintegerp, elt);
	      {
526 527 528 529
		int c = XINT (elt);
		unsigned char work[4], *str;
		int i = CHAR_STRING (c, work, str);

Jim Blandy's avatar
Jim Blandy committed
530 531 532
#ifdef MASSC_REGISTER_BUG
		/* Even removing all "register"s doesn't disable this bug!
		   Nothing simpler than this seems to work. */
533 534
		unsigned char *p = & XSTRING (val)->data[toindex];
		bcopy (str, p, i);
Jim Blandy's avatar
Jim Blandy committed
535
#else
536
		bcopy (str, & XSTRING (val)->data[toindex], i);
Jim Blandy's avatar
Jim Blandy committed
537
#endif
538
		toindex += i;
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542
	      }
	    }
	}
    }
Jim Blandy's avatar
Jim Blandy committed
543
  if (!NILP (prev))
Jim Blandy's avatar
Jim Blandy committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
    XCONS (prev)->cdr = last_tail;

  return val;  
}

DEFUN ("copy-alist", Fcopy_alist, Scopy_alist, 1, 1, 0,
  "Return a copy of ALIST.\n\
This is an alist which represents the same mapping from objects to objects,\n\
but does not share the alist structure with ALIST.\n\
The objects mapped (cars and cdrs of elements of the alist)\n\
are shared, however.\n\
Elements of ALIST that are not conses are also shared.")
  (alist)
     Lisp_Object alist;
{
  register Lisp_Object tem;

  CHECK_LIST (alist, 0);
Jim Blandy's avatar
Jim Blandy committed
562
  if (NILP (alist))
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
    return alist;
  alist = concat (1, &alist, Lisp_Cons, 0);
  for (tem = alist; CONSP (tem); tem = XCONS (tem)->cdr)
    {
      register Lisp_Object car;
      car = XCONS (tem)->car;

      if (CONSP (car))
	XCONS (tem)->car = Fcons (XCONS (car)->car, XCONS (car)->cdr);
    }
  return alist;
}

DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0,
  "Return a substring of STRING, starting at index FROM and ending before TO.\n\
TO may be nil or omitted; then the substring runs to the end of STRING.\n\
579 580 581
If FROM or TO is negative, it counts from the end.\n\
\n\
This function allows vectors as well as strings.")
Jim Blandy's avatar
Jim Blandy committed
582 583 584 585
  (string, from, to)
     Lisp_Object string;
     register Lisp_Object from, to;
{
586
  Lisp_Object res;
587 588 589 590
  int size;

  if (! (STRINGP (string) || VECTORP (string)))
    wrong_type_argument (Qarrayp, string);
591

Jim Blandy's avatar
Jim Blandy committed
592
  CHECK_NUMBER (from, 1);
593 594 595 596 597 598

  if (STRINGP (string))
    size = XSTRING (string)->size;
  else
    size = XVECTOR (string)->size;

Jim Blandy's avatar
Jim Blandy committed
599
  if (NILP (to))
600
    XSETINT (to, size);
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604
  else
    CHECK_NUMBER (to, 2);

  if (XINT (from) < 0)
605
    XSETINT (from, XINT (from) + size);
Jim Blandy's avatar
Jim Blandy committed
606
  if (XINT (to) < 0)
607
    XSETINT (to, XINT (to) + size);
Jim Blandy's avatar
Jim Blandy committed
608
  if (!(0 <= XINT (from) && XINT (from) <= XINT (to)
609
        && XINT (to) <= size))
Jim Blandy's avatar
Jim Blandy committed
610 611
    args_out_of_range_3 (string, from, to);

612 613 614 615 616 617 618 619 620 621
  if (STRINGP (string))
    {
      res = make_string (XSTRING (string)->data + XINT (from),
			 XINT (to) - XINT (from));
      copy_text_properties (from, to, string, make_number (0), res, Qnil);
    }
  else
    res = Fvector (XINT (to) - XINT (from),
		   XVECTOR (string)->contents + XINT (from));
		   
622
  return res;
Jim Blandy's avatar
Jim Blandy committed
623 624 625 626 627 628 629 630 631 632 633
}

DEFUN ("nthcdr", Fnthcdr, Snthcdr, 2, 2, 0,
  "Take cdr N times on LIST, returns the result.")
  (n, list)
     Lisp_Object n;
     register Lisp_Object list;
{
  register int i, num;
  CHECK_NUMBER (n, 0);
  num = XINT (n);
Jim Blandy's avatar
Jim Blandy committed
634
  for (i = 0; i < num && !NILP (list); i++)
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
    {
      QUIT;
      list = Fcdr (list);
    }
  return list;
}

DEFUN ("nth", Fnth, Snth, 2, 2, 0,
  "Return the Nth element of LIST.\n\
N counts from zero.  If LIST is not that long, nil is returned.")
  (n, list)
     Lisp_Object n, list;
{
  return Fcar (Fnthcdr (n, list));
}

DEFUN ("elt", Felt, Selt, 2, 2, 0,
  "Return element of SEQUENCE at index N.")
653 654
  (sequence, n)
     register Lisp_Object sequence, n;
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658
{
  CHECK_NUMBER (n, 0);
  while (1)
    {
659 660 661 662 663
      if (CONSP (sequence) || NILP (sequence))
	return Fcar (Fnthcdr (n, sequence));
      else if (STRINGP (sequence) || VECTORP (sequence)
	       || BOOL_VECTOR_P (sequence) || CHAR_TABLE_P (sequence))
	return Faref (sequence, n);
Jim Blandy's avatar
Jim Blandy committed
664
      else
665
	sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669
    }
}

DEFUN ("member", Fmember, Smember, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
670
  "Return non-nil if ELT is an element of LIST.  Comparison done with `equal'.\n\
Jim Blandy's avatar
Jim Blandy committed
671 672 673 674 675 676
The value is actually the tail of LIST whose car is ELT.")
  (elt, list)
     register Lisp_Object elt;
     Lisp_Object list;
{
  register Lisp_Object tail;
677
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
678 679 680
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
681
      if (! NILP (Fequal (elt, tem)))
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695
	return tail;
      QUIT;
    }
  return Qnil;
}

DEFUN ("memq", Fmemq, Smemq, 2, 2, 0,
  "Return non-nil if ELT is an element of LIST.  Comparison done with EQ.\n\
The value is actually the tail of LIST whose car is ELT.")
  (elt, list)
     register Lisp_Object elt;
     Lisp_Object list;
{
  register Lisp_Object tail;
696
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703 704 705 706
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
      if (EQ (elt, tem)) return tail;
      QUIT;
    }
  return Qnil;
}

DEFUN ("assq", Fassq, Sassq, 2, 2, 0,
707 708
  "Return non-nil if KEY is `eq' to the car of an element of LIST.\n\
The value is actually the element of LIST whose car is KEY.\n\
Jim Blandy's avatar
Jim Blandy committed
709 710 711 712 713 714
Elements of LIST that are not conses are ignored.")
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
715
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
720
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
      if (EQ (key, tem)) return elt;
      QUIT;
    }
  return Qnil;
}

/* Like Fassq but never report an error and do not allow quits.
   Use only on lists known never to be circular.  */

Lisp_Object
assq_no_quit (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
736
  for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
737 738 739 740
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
741
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
742 743 744 745 746 747
      if (EQ (key, tem)) return elt;
    }
  return Qnil;
}

DEFUN ("assoc", Fassoc, Sassoc, 2, 2, 0,
748
  "Return non-nil if KEY is `equal' to the car of an element of LIST.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
749
The value is actually the element of LIST whose car equals KEY.")
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
755
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
756 757 758 759
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
760
      tem = Fequal (XCONS (elt)->car, key);
Jim Blandy's avatar
Jim Blandy committed
761
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
762 763 764 765 766 767 768 769 770 771 772 773 774
      QUIT;
    }
  return Qnil;
}

DEFUN ("rassq", Frassq, Srassq, 2, 2, 0,
  "Return non-nil if ELT is `eq' to the cdr of an element of LIST.\n\
The value is actually the element of LIST whose cdr is ELT.")
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
775
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
780
      tem = XCONS (elt)->cdr;
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784 785
      if (EQ (key, tem)) return elt;
      QUIT;
    }
  return Qnil;
}
Richard M. Stallman's avatar
Richard M. Stallman committed
786 787 788 789 790 791 792 793 794

DEFUN ("rassoc", Frassoc, Srassoc, 2, 2, 0,
  "Return non-nil if KEY is `equal' to the cdr of an element of LIST.\n\
The value is actually the element of LIST whose cdr equals KEY.")
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
795
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
800
      tem = Fequal (XCONS (elt)->cdr, key);
Richard M. Stallman's avatar
Richard M. Stallman committed
801 802 803 804 805
      if (!NILP (tem)) return elt;
      QUIT;
    }
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821

DEFUN ("delq", Fdelq, Sdelq, 2, 2, 0,
  "Delete by side effect any occurrences of ELT as a member of LIST.\n\
The modified LIST is returned.  Comparison is done with `eq'.\n\
If the first member of LIST is ELT, there is no way to remove it by side effect;\n\
therefore, write `(setq foo (delq element foo))'\n\
to be sure of changing the value of `foo'.")
  (elt, list)
     register Lisp_Object elt;
     Lisp_Object list;
{
  register Lisp_Object tail, prev;
  register Lisp_Object tem;

  tail = list;
  prev = Qnil;
Jim Blandy's avatar
Jim Blandy committed
822
  while (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
823 824 825 826
    {
      tem = Fcar (tail);
      if (EQ (elt, tem))
	{
Jim Blandy's avatar
Jim Blandy committed
827
	  if (NILP (prev))
828
	    list = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
829
	  else
830
	    Fsetcdr (prev, XCONS (tail)->cdr);
Jim Blandy's avatar
Jim Blandy committed
831 832 833
	}
      else
	prev = tail;
834
      tail = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
835 836 837 838 839
      QUIT;
    }
  return list;
}

Jim Blandy's avatar
Jim Blandy committed
840
DEFUN ("delete", Fdelete, Sdelete, 2, 2, 0,
Roland McGrath's avatar
Roland McGrath committed
841 842
  "Delete by side effect any occurrences of ELT as a member of LIST.\n\
The modified LIST is returned.  Comparison is done with `equal'.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
843 844 845
If the first member of LIST is ELT, deleting it is not a side effect;\n\
it is simply using a different list.\n\
Therefore, write `(setq foo (delete element foo))'\n\
Roland McGrath's avatar
Roland McGrath committed
846 847 848 849 850 851 852 853 854 855
to be sure of changing the value of `foo'.")
  (elt, list)
     register Lisp_Object elt;
     Lisp_Object list;
{
  register Lisp_Object tail, prev;
  register Lisp_Object tem;

  tail = list;
  prev = Qnil;
Jim Blandy's avatar
Jim Blandy committed
856
  while (!NILP (tail))
Roland McGrath's avatar
Roland McGrath committed
857 858
    {
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
859
      if (! NILP (Fequal (elt, tem)))
Roland McGrath's avatar
Roland McGrath committed
860
	{
Jim Blandy's avatar
Jim Blandy committed
861
	  if (NILP (prev))
862
	    list = XCONS (tail)->cdr;
Roland McGrath's avatar
Roland McGrath committed
863
	  else
864
	    Fsetcdr (prev, XCONS (tail)->cdr);
Roland McGrath's avatar
Roland McGrath committed
865 866 867
	}
      else
	prev = tail;
868
      tail = XCONS (tail)->cdr;
Roland McGrath's avatar
Roland McGrath committed
869 870 871 872 873
      QUIT;
    }
  return list;
}

Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879 880 881
DEFUN ("nreverse", Fnreverse, Snreverse, 1, 1, 0,
  "Reverse LIST by modifying cdr pointers.\n\
Returns the beginning of the reversed list.")
  (list)
     Lisp_Object list;
{
  register Lisp_Object prev, tail, next;

Jim Blandy's avatar
Jim Blandy committed
882
  if (NILP (list)) return list;
Jim Blandy's avatar
Jim Blandy committed
883 884
  prev = Qnil;
  tail = list;
Jim Blandy's avatar
Jim Blandy committed
885
  while (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
    {
      QUIT;
      next = Fcdr (tail);
      Fsetcdr (tail, prev);
      prev = tail;
      tail = next;
    }
  return prev;
}

DEFUN ("reverse", Freverse, Sreverse, 1, 1, 0,
  "Reverse LIST, copying.  Returns the beginning of the reversed list.\n\
See also the function `nreverse', which is used more often.")
  (list)
     Lisp_Object list;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
902
  Lisp_Object new;
Jim Blandy's avatar
Jim Blandy committed
903

Richard M. Stallman's avatar
Richard M. Stallman committed
904 905 906 907 908
  for (new = Qnil; CONSP (list); list = XCONS (list)->cdr)
    new = Fcons (XCONS (list)->car, new);
  if (!NILP (list))
    wrong_type_argument (Qconsp, list);
  return new;
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913 914 915 916 917
}

Lisp_Object merge ();

DEFUN ("sort", Fsort, Ssort, 2, 2, 0,
  "Sort LIST, stably, comparing elements using PREDICATE.\n\
Returns the sorted list.  LIST is modified by side effects.\n\
PREDICATE is called with two elements of LIST, and should return T\n\
if the first element is \"less\" than the second.")
918 919
  (list, predicate)
     Lisp_Object list, predicate;
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
{
  Lisp_Object front, back;
  register Lisp_Object len, tem;
  struct gcpro gcpro1, gcpro2;
  register int length;

  front = list;
  len = Flength (list);
  length = XINT (len);
  if (length < 2)
    return list;

  XSETINT (len, (length / 2) - 1);
  tem = Fnthcdr (len, list);
  back = Fcdr (tem);
  Fsetcdr (tem, Qnil);

  GCPRO2 (front, back);
938 939
  front = Fsort (front, predicate);
  back = Fsort (back, predicate);
Jim Blandy's avatar
Jim Blandy committed
940
  UNGCPRO;
941
  return merge (front, back, predicate);
Jim Blandy's avatar
Jim Blandy committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
}

Lisp_Object
merge (org_l1, org_l2, pred)
     Lisp_Object org_l1, org_l2;
     Lisp_Object pred;
{
  Lisp_Object value;
  register Lisp_Object tail;
  Lisp_Object tem;
  register Lisp_Object l1, l2;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  l1 = org_l1;
  l2 = org_l2;
  tail = Qnil;
  value = Qnil;

  /* It is sufficient to protect org_l1 and org_l2.
     When l1 and l2 are updated, we copy the new values
     back into the org_ vars.  */
  GCPRO4 (org_l1, org_l2, pred, value);

  while (1)
    {
Jim Blandy's avatar
Jim Blandy committed
967
      if (NILP (l1))
Jim Blandy's avatar
Jim Blandy committed
968 969
	{
	  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
970
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
971 972 973 974
	    return l2;
	  Fsetcdr (tail, l2);
	  return value;
	}
Jim Blandy's avatar
Jim Blandy committed
975
      if (NILP (l2))
Jim Blandy's avatar
Jim Blandy committed
976 977
	{
	  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
978
	  if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
979 980 981 982 983
	    return l1;
	  Fsetcdr (tail, l1);
	  return value;
	}
      tem = call2 (pred, Fcar (l2), Fcar (l1));
Jim Blandy's avatar
Jim Blandy committed
984
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
985 986 987 988 989 990 991 992 993 994 995
	{
	  tem = l1;
	  l1 = Fcdr (l1);
	  org_l1 = l1;
	}
      else
	{
	  tem = l2;
	  l2 = Fcdr (l2);
	  org_l2 = l2;
	}
Jim Blandy's avatar
Jim Blandy committed
996
      if (NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
997 998 999 1000 1001 1002 1003
	value = tem;
      else
	Fsetcdr (tail, tem);
      tail = tem;
    }
}

1004 1005

DEFUN ("plist-get", Fplist_get, Splist_get, 2, 2, 0,
1006
  "Extract a value from a property list.\n\
1007
PLIST is a property list, which is a list of the form\n\
1008
\(PROP1 VALUE1 PROP2 VALUE2...).  This function returns the value\n\
1009 1010
corresponding to the given PROP, or nil if PROP is not\n\
one of the properties on the list.")
1011 1012
  (plist, prop)
     Lisp_Object plist;
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015
     register Lisp_Object prop;
{
  register Lisp_Object tail;
1016
  for (tail = plist; !NILP (tail); tail = Fcdr (XCONS (tail)->cdr))
Jim Blandy's avatar
Jim Blandy committed
1017 1018 1019 1020
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
      if (EQ (prop, tem))
1021
	return Fcar (XCONS (tail)->cdr);
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025
    }
  return Qnil;
}

1026 1027
DEFUN ("get", Fget, Sget, 2, 2, 0,
  "Return the value of SYMBOL's PROPNAME property.\n\
1028 1029 1030
This is the last value stored with `(put SYMBOL PROPNAME VALUE)'.")
  (symbol, propname)
     Lisp_Object symbol, propname;
1031
{
1032 1033
  CHECK_SYMBOL (symbol, 0);
  return Fplist_get (XSYMBOL (symbol)->plist, propname);
1034 1035 1036 1037 1038
}

DEFUN ("plist-put", Fplist_put, Splist_put, 3, 3, 0,
  "Change value in PLIST of PROP to VAL.\n\
PLIST is a property list, which is a list of the form\n\
1039
\(PROP1 VALUE1 PROP2 VALUE2 ...).  PROP is a symbol and VAL is any object.\n\
1040
If PROP is already a property on the list, its value is set to VAL,\n\
Karl Heuer's avatar
Karl Heuer committed
1041
otherwise the new PROP VAL pair is added.  The new plist is returned;\n\
1042 1043 1044 1045 1046 1047
use `(setq x (plist-put x prop val))' to be sure to use the new value.\n\
The PLIST is modified by side effects.")
  (plist, prop, val)
    Lisp_Object plist;
    register Lisp_Object prop;
    Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
1048 1049 1050 1051
{
  register Lisp_Object tail, prev;
  Lisp_Object newcell;
  prev = Qnil;
1052 1053
  for (tail = plist; CONSP (tail) && CONSP (XCONS (tail)->cdr);
       tail = XCONS (XCONS (tail)->cdr)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1054
    {
1055
      if (EQ (prop, XCONS (tail)->car))
1056
	{
1057
	  Fsetcar (XCONS (tail)->cdr, val);
1058 1059
	  return plist;
	}
Jim Blandy's avatar
Jim Blandy committed
1060 1061 1062
      prev = tail;
    }
  newcell = Fcons (prop, Fcons (val, Qnil));
Jim Blandy's avatar
Jim Blandy committed
1063
  if (NILP (prev))
1064
    return newcell;
Jim Blandy's avatar
Jim Blandy committed
1065
  else
1066
    Fsetcdr (XCONS (prev)->cdr, newcell);
1067 1068 1069 1070 1071 1072
  return plist;
}

DEFUN ("put", Fput, Sput, 3, 3, 0,
  "Store SYMBOL's PROPNAME property with value VALUE.\n\
It can be retrieved with `(get SYMBOL PROPNAME)'.")
1073 1074
  (symbol, propname, value)
     Lisp_Object symbol, propname, value;
1075
{
1076 1077 1078 1079
  CHECK_SYMBOL (symbol, 0);
  XSYMBOL (symbol)->plist
    = Fplist_put (XSYMBOL (symbol)->plist, propname, value);
  return value;
Jim Blandy's avatar
Jim Blandy committed
1080 1081 1082 1083 1084 1085 1086
}

DEFUN ("equal", Fequal, Sequal, 2, 2, 0,
  "T if two Lisp objects have similar structure and contents.\n\
They must have the same data type.\n\
Conses are compared by comparing the cars and the cdrs.\n\
Vectors and strings are compared element by element.\n\
1087 1088 1089
Numbers are compared by value, but integers cannot equal floats.\n\
 (Use `=' if you want integers and floats to be able to be equal.)\n\
Symbols must match exactly.")
Jim Blandy's avatar
Jim Blandy committed
1090 1091 1092
  (o1, o2)
     register Lisp_Object o1, o2;
{
1093
  return internal_equal (o1, o2, 0) ? Qt : Qnil;
1094 1095
}

1096
static int