fns.c 61.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 1997 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;
Karl Heuer's avatar
Karl Heuer committed
55
Lisp_Object Qwidget_type;
Jim Blandy's avatar
Jim Blandy committed
56

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

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

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

84
  if (EQ (n, Qt))
85
    seed_random (getpid () + time (NULL));
86
  if (NATNUMP (n) && XFASTINT (n) != 0)
Jim Blandy's avatar
Jim Blandy committed
87
    {
88 89 90 91
      /* 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
92
	 it's possible to get a quotient larger than n; discarding
93
	 these values eliminates the bias that would otherwise appear
94 95
	 when using a large n.  */
      denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
96
      do
97
	val = get_random () / denominator;
98
      while (val >= XFASTINT (n));
Jim Blandy's avatar
Jim Blandy committed
99
    }
100
  else
101
    val = get_random ();
102 103
  XSETINT (lispy_val, val);
  return lispy_val;
Jim Blandy's avatar
Jim Blandy committed
104 105 106 107 108 109
}

/* 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
110 111 112 113
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'")
114 115
  (sequence)
     register Lisp_Object sequence;
Jim Blandy's avatar
Jim Blandy committed
116 117 118 119 120
{
  register Lisp_Object tail, val;
  register int i;

 retry:
121 122 123 124 125
  if (STRINGP (sequence))
    XSETFASTINT (val, XSTRING (sequence)->size);
  else if (VECTORP (sequence))
    XSETFASTINT (val, XVECTOR (sequence)->size);
  else if (CHAR_TABLE_P (sequence))
126
    XSETFASTINT (val, CHAR_TABLE_ORDINARY_SLOTS);
127 128 129 130 131
  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
132
    {
133
      for (i = 0, tail = sequence; !NILP (tail); i++)
Jim Blandy's avatar
Jim Blandy committed
134 135 136 137 138
	{
	  QUIT;
	  tail = Fcdr (tail);
	}

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

151 152 153 154 155 156 157 158
/* 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.")
Karl Heuer's avatar
Karl Heuer committed
159
  (list)
160 161 162 163 164 165 166 167 168 169
     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)
170
	break;
171
      len++;
172
      if ((len & 1) == 0)
173 174 175 176 177 178 179
	halftail = XCONS (halftail)->cdr;
    }

  XSETINT (length, len);
  return length;
}

Jim Blandy's avatar
Jim Blandy committed
180
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
181
  "Return t if two strings have identical contents.\n\
182
Case is significant, but text properties are ignored.\n\
Jim Blandy's avatar
Jim Blandy committed
183 184 185 186
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
187
  if (SYMBOLP (s1))
188
    XSETSTRING (s1, XSYMBOL (s1)->name);
189
  if (SYMBOLP (s2))
190
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
191 192 193
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

194 195 196
  if (XSTRING (s1)->size != XSTRING (s2)->size
      || XSTRING (s1)->size_byte != XSTRING (s2)->size_byte
      || bcmp (XSTRING (s1)->data, XSTRING (s2)->data, XSTRING (s1)->size_byte))
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201
    return Qnil;
  return Qt;
}

DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
202
  "Return t if first arg string is less than second in lexicographic order.\n\
Jim Blandy's avatar
Jim Blandy committed
203 204 205 206 207 208 209 210 211
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;

212
  if (SYMBOLP (s1))
213
    XSETSTRING (s1, XSYMBOL (s1)->name);
214
  if (SYMBOLP (s2))
215
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

  p1 = XSTRING (s1)->data;
  p2 = XSTRING (s2)->data;
221 222 223
  end = XSTRING (s1)->size_byte;
  if (end > XSTRING (s2)->size_byte)
    end = XSTRING (s2)->size_byte;
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229

  for (i = 0; i < end; i++)
    {
      if (p1[i] != p2[i])
	return p1[i] < p2[i] ? Qt : Qnil;
    }
230
  return i < XSTRING (s2)->size_byte ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
}

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
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
/* 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
266 267 268 269
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
270
The last argument is not copied, just used as the tail of the new list.")
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274 275 276 277 278 279 280
  (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\
281 282 283 284 285 286
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
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
  (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;
{
302
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
303 304
}

305 306 307 308
/* 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)
309
     Lisp_Object arg;
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
{
  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
327 328 329 330 331 332 333
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
334
  if (NILP (arg)) return arg;
335 336 337

  if (CHAR_TABLE_P (arg))
    {
338
      int i;
339 340
      Lisp_Object copy;

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

347 348 349 350 351
      /* 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]))
352
	  XCHAR_TABLE (copy)->contents[i]
353
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
354 355 356 357 358 359 360 361

      return copy;
    }

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

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

370
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
    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;
  register Lisp_Object tail;
  register Lisp_Object this;
  int toindex;
386 387 388
  int toindex_byte;
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
389 390 391
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
392
  int some_multibyte;
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399 400 401 402

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

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

417 418 419 420 421 422 423 424
  /* Compute total length in chars of arguments in RESULT_LEN.
     If desired output is a string, also compute length in bytes
     in RESULT_LEN_BYTE, and determine in SOME_MULTIBYTE
     whether the result should be a multibyte string.  */
  result_len_byte = 0;
  result_len = 0;
  some_multibyte = 0;
  for (argnum = 0; argnum < nargs; argnum++)
Jim Blandy's avatar
Jim Blandy committed
425
    {
426
      int len;
Jim Blandy's avatar
Jim Blandy committed
427
      this = args[argnum];
428 429
      len = XFASTINT (Flength (this));
      if (target_type == Lisp_String)
430 431
	{
	  /* We must pay attention to a multibyte character which
432
	     takes more than one byte in string.  */
433 434
	  int i;
	  Lisp_Object ch;
435
	  int this_len_byte;
436

437
	  if (VECTORP (this))
438
	    for (i = 0; i < len; i++)
439 440 441 442
	      {
		ch = XVECTOR (this)->contents[i];
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
443 444 445 446
		this_len_byte = XFASTINT (Fchar_bytes (ch));
		result_len_byte += this_len_byte;
		if (this_len_byte > 1)
		  some_multibyte = 1;
447
	      }
448
	  else if (CONSP (this))
449 450 451 452 453
	    for (; CONSP (this); this = XCONS (this)->cdr)
	      {
		ch = XCONS (this)->car;
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
454 455 456 457
		this_len_byte = XFASTINT (Fchar_bytes (ch));
		result_len_byte += this_len_byte;
		if (this_len_byte > 1)
		  some_multibyte = 1;
458
	      }
459 460 461 462 463 464
	  else
	    {
	      result_len_byte += XSTRING (this)->size_byte;
	      if (STRING_MULTIBYTE (this))
		some_multibyte = 1;
	    }
465
	}
466 467

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
468 469
    }

470 471 472
  /* In `append', if all but last arg are nil, return last arg.  */
  if (target_type == Lisp_Cons && EQ (val, Qnil))
    return last_tail;
Jim Blandy's avatar
Jim Blandy committed
473

474
  /* Create the output object.  */
Jim Blandy's avatar
Jim Blandy committed
475
  if (target_type == Lisp_Cons)
476
    val = Fmake_list (make_number (result_len), Qnil);
477
  else if (target_type == Lisp_Vectorlike)
478
    val = Fmake_vector (make_number (result_len), Qnil);
Jim Blandy's avatar
Jim Blandy committed
479
  else
480
    val = make_uninit_multibyte_string (result_len, result_len_byte);
Jim Blandy's avatar
Jim Blandy committed
481 482


483
  /* Copy the contents of the args into the result.  */
Jim Blandy's avatar
Jim Blandy committed
484 485 486
  if (CONSP (val))
    tail = val, toindex = -1;		/* -1 in toindex is flag we are making a list */
  else
487
    toindex = 0, toindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493 494

  prev = Qnil;

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
      int thisleni;
495
      register unsigned int thisindex = 0;
496
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
497 498 499 500 501

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

502
      if (STRINGP (this) && STRINGP (val)
503
	  && ! NULL_INTERVAL_P (XSTRING (this)->intervals))
504 505
	copy_text_properties (make_number (0), thislen, this,
			      make_number (toindex), val, Qnil);
506

507 508 509
      /* Between strings of the same kind, copy fast.  */
      if (STRINGP (this) && STRINGP (val)
	  && STRING_MULTIBYTE (this) == some_multibyte)
Jim Blandy's avatar
Jim Blandy committed
510
	{
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
	  int thislen_byte = XSTRING (this)->size_byte;
	  bcopy (XSTRING (this)->data, XSTRING (val)->data + toindex_byte,
		 XSTRING (this)->size_byte);
	  toindex_byte += thislen_byte;
	  toindex += thisleni;
	}
      else
	/* Copy element by element.  */
	while (1)
	  {
	    register Lisp_Object elt;

	    /* Fetch next element of `this' arg into `elt', or break if
	       `this' is exhausted. */
	    if (NILP (this)) break;
	    if (CONSP (this))
	      elt = XCONS (this)->car, this = XCONS (this)->cdr;
	    else
	      {
		if (thisindex >= thisleni) break;
		if (STRINGP (this))
		  {
		    if (STRING_MULTIBYTE (this))
		      {
			int c;
			FETCH_STRING_CHAR_ADVANCE (c, this,
						   thisindex,
						   thisindex_byte);
			XSETFASTINT (elt, c);
		      }
		    else
		      {
			unsigned char c;
			XSETFASTINT (elt, XSTRING (this)->data[thisindex++]);
			if (some_multibyte && XINT (elt) >= 0200
			    && XINT (elt) < 0400)
			  {
			    c = XINT (elt);
			    copy_text (&c, &c, 1, 0, 1);
			    XSETINT (elt, c);
			  }
		      }
		  }
		else if (BOOL_VECTOR_P (this))
		  {
		    int size_in_chars
		      = ((XBOOL_VECTOR (this)->size + BITS_PER_CHAR - 1)
			 / BITS_PER_CHAR);
		    int byte;
		    byte = XBOOL_VECTOR (val)->data[thisindex / BITS_PER_CHAR];
		    if (byte & (1 << (thisindex % BITS_PER_CHAR)))
		      elt = Qt;
		    else
		      elt = Qnil;
		  }
		else
		  elt = XVECTOR (this)->contents[thisindex++];
	      }
Jim Blandy's avatar
Jim Blandy committed
569

570 571
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
572
	      {
573 574 575
		XCONS (tail)->car = elt;
		prev = tail;
		tail = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
576
	      }
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
		CHECK_NUMBER (elt, 0);
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
		    XSTRING (val)->data[toindex++] = XINT (elt);
		    toindex_byte++;
		  }
		else
		  /* If we have any multibyte characters,
		     we already decided to make a multibyte string.  */
		  {
		    int c = XINT (elt);
		    unsigned char work[4], *str;
		    int i = CHAR_STRING (c, work, str);

		    /* P exists as a variable
		       to avoid a bug on the Masscomp C compiler.  */
		    unsigned char *p = & XSTRING (val)->data[toindex_byte];
		    bcopy (str, p, i);
		    toindex_byte += i;
		    toindex++;
		  }
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
604
    }
Jim Blandy's avatar
Jim Blandy committed
605
  if (!NILP (prev))
Jim Blandy's avatar
Jim Blandy committed
606 607
    XCONS (prev)->cdr = last_tail;

Karl Heuer's avatar
Karl Heuer committed
608
  return val;
Jim Blandy's avatar
Jim Blandy committed
609 610
}

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
  int i = 0, i_byte = 0;

  if (! STRING_MULTIBYTE (string))
    return char_index;

  while (i < char_index)
    {
      int c;
      FETCH_STRING_CHAR_ADVANCE (c, string, i, i_byte);
    }

  return i_byte;
}

/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{
  int i = 0, i_byte = 0;

  if (! STRING_MULTIBYTE (string))
    return byte_index;

  while (i_byte < byte_index)
    {
      int c;
      FETCH_STRING_CHAR_ADVANCE (c, string, i, i_byte);
    }

  return i;
}

/* Convert STRING to a multibyte string.
   Single-byte characters 0200 through 0377 are converted
   by adding nonascii_insert_offset to each.  */

Lisp_Object
string_make_multibyte (string)
     Lisp_Object string;
{
  unsigned char *buf;
  int nbytes;

  if (STRING_MULTIBYTE (string))
    return string;

  nbytes = count_size_as_multibyte (XSTRING (string)->data,
				    XSTRING (string)->size);
  buf = (unsigned char *) alloca (nbytes);
  copy_text (XSTRING (string)->data, buf, XSTRING (string)->size_byte,
	     0, 1);

  return make_multibyte_string (buf, XSTRING (string)->size, nbytes);
}

/* Convert STRING to a single-byte string.  */

Lisp_Object
string_make_unibyte (string)
     Lisp_Object string;
{
  unsigned char *buf;

  if (! STRING_MULTIBYTE (string))
    return string;

  buf = (unsigned char *) alloca (XSTRING (string)->size);

  copy_text (XSTRING (string)->data, buf, XSTRING (string)->size_byte,
	     1, 0);

  return make_unibyte_string (buf, XSTRING (string)->size);
}

Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700 701 702 703 704 705 706 707
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
708
  if (NILP (alist))
Jim Blandy's avatar
Jim Blandy committed
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
    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\
725 726 727
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
728 729 730 731
  (string, from, to)
     Lisp_Object string;
     register Lisp_Object from, to;
{
732
  Lisp_Object res;
733
  int size;
734 735 736
  int size_byte;
  int from_char, to_char;
  int from_byte, to_byte;
737 738 739

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

Jim Blandy's avatar
Jim Blandy committed
741
  CHECK_NUMBER (from, 1);
742 743

  if (STRINGP (string))
744 745 746 747
    {
      size = XSTRING (string)->size;
      size_byte = XSTRING (string)->size_byte;
    }
748 749 750
  else
    size = XVECTOR (string)->size;

Jim Blandy's avatar
Jim Blandy committed
751
  if (NILP (to))
752 753 754 755
    {
      to_char = size;
      to_byte = size_byte;
    }
Jim Blandy's avatar
Jim Blandy committed
756
  else
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    {
      CHECK_NUMBER (to, 2);

      to_char = XINT (to);
      if (to_char < 0)
	to_char += size;

      if (STRINGP (string))
	to_byte = string_char_to_byte (string, to_char);
    }

  from_char = XINT (from);
  if (from_char < 0)
    from_char += size;
  if (STRINGP (string))
    from_byte = string_char_to_byte (string, from_char);
Jim Blandy's avatar
Jim Blandy committed
773

774 775 776
  if (!(0 <= from_char && from_char <= to_char && to_char <= size))
    args_out_of_range_3 (string, make_number (from_char),
			 make_number (to_char));
Jim Blandy's avatar
Jim Blandy committed
777

778 779
  if (STRINGP (string))
    {
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
      res = make_multibyte_string (XSTRING (string)->data + from_byte,
				   to_char - from_char, to_byte - from_byte);
      copy_text_properties (from_char, to_char, string,
			    make_number (0), res, Qnil);
    }
  else
    res = Fvector (to_char - from_char,
		   XVECTOR (string)->contents + from_char);

  return res;
}

/* Extract a substring of STRING, giving start and end positions
   both in characters and in bytes.  */

Lisp_Object
substring_both (string, from, from_byte, to, to_byte)
     Lisp_Object string;
     int from, from_byte, to, to_byte;
{
  Lisp_Object res;
  int size;
  int size_byte;

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

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

  if (!(0 <= from && from <= to && to <= size))
    args_out_of_range_3 (string, make_number (from), make_number (to));

  if (STRINGP (string))
    {
      res = make_multibyte_string (XSTRING (string)->data + from_byte,
				   to - from, to_byte - from_byte);
822 823 824
      copy_text_properties (from, to, string, make_number (0), res, Qnil);
    }
  else
825 826
    res = Fvector (to - from,
		   XVECTOR (string)->contents + from);
Karl Heuer's avatar
Karl Heuer committed
827

828
  return res;
Jim Blandy's avatar
Jim Blandy committed
829 830 831 832 833 834 835 836 837 838 839
}

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
840
  for (i = 0; i < num && !NILP (list); i++)
Jim Blandy's avatar
Jim Blandy committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
    {
      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.")
859 860
  (sequence, n)
     register Lisp_Object sequence, n;
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
{
  CHECK_NUMBER (n, 0);
  while (1)
    {
865 866 867 868 869
      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
870
      else
871
	sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
872 873 874 875
    }
}

DEFUN ("member", Fmember, Smember, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
876
  "Return non-nil if ELT is an element of LIST.  Comparison done with `equal'.\n\
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881 882
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;
883
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
884 885 886
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
887
      if (! NILP (Fequal (elt, tem)))
Jim Blandy's avatar
Jim Blandy committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901
	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;
902
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
903 904 905 906 907 908 909 910 911 912
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
      if (EQ (elt, tem)) return tail;
      QUIT;
    }
  return Qnil;
}

DEFUN ("assq", Fassq, Sassq, 2, 2, 0,
913 914
  "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
915 916 917 918 919 920
Elements of LIST that are not conses are ignored.")
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
921
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
926
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
      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;
942
  for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
947
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951 952 953
      if (EQ (key, tem)) return elt;
    }
  return Qnil;
}

DEFUN ("assoc", Fassoc, Sassoc, 2, 2, 0,
954
  "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
955
The value is actually the element of LIST whose car equals KEY.")
Jim Blandy's avatar
Jim Blandy committed
956 957 958 959 960
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
961
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
962 963 964 965
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
966
      tem = Fequal (XCONS (elt)->car, key);
Jim Blandy's avatar
Jim Blandy committed
967
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
968 969 970 971 972 973 974 975 976 977 978 979 980
      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;
981
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
982 983 984 985
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
986
      tem = XCONS (elt)->cdr;
Jim Blandy's avatar
Jim Blandy committed
987 988 989 990 991
      if (EQ (key, tem)) return elt;
      QUIT;
    }
  return Qnil;
}
Richard M. Stallman's avatar
Richard M. Stallman committed
992 993 994 995 996 997 998 999 1000

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;
1001
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Richard M. Stallman's avatar
Richard M. Stallman committed
1002 1003 1004 1005
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
1006
      tem = Fequal (XCONS (elt)->cdr, key);
Richard M. Stallman's avatar
Richard M. Stallman committed
1007 1008 1009 1010 1011
      if (!NILP (tem)) return elt;
      QUIT;
    }
  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

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
1028
  while (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
1029 1030 1031 1032
    {
      tem = Fcar (tail);
      if (EQ (elt, tem))
	{
Jim Blandy's avatar
Jim Blandy committed
1033
	  if (NILP (prev))
1034
	    list = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
1035
	  else
1036
	    Fsetcdr (prev, XCONS (tail)->cdr);
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039
	}
      else
	prev = tail;
1040
      tail = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043 1044 1045
      QUIT;
    }
  return list;
}

Jim Blandy's avatar
Jim Blandy committed
1046
DEFUN ("delete", Fdelete, Sdelete, 2, 2, 0,
Roland McGrath's avatar
Roland McGrath committed
1047 1048
  "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
1049 1050 1051
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
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
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
1062
  while (!NILP (tail))
Roland McGrath's avatar
Roland McGrath committed
1063 1064
    {
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
1065
      if (! NILP (Fequal (elt, tem)))
Roland McGrath's avatar
Roland McGrath committed
1066
	{
Jim Blandy's avatar
Jim Blandy committed
1067
	  if (NILP (prev))
1068
	    list = XCONS (tail)->cdr;
Roland McGrath's avatar
Roland McGrath committed
1069
	  else
1070
	    Fsetcdr (prev, XCONS (tail)->cdr);
Roland McGrath's avatar
Roland McGrath committed
1071 1072 1073
	}
      else
	prev = tail;
1074
      tail = XCONS (tail)->cdr;
Roland McGrath's avatar
Roland McGrath committed
1075 1076 1077 1078 1079
      QUIT;
    }
  return list;
}

Jim Blandy's avatar
Jim Blandy committed
1080 1081 1082 1083 1084 1085 1086 1087
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
1088
  if (NILP (list)) return list;
Jim Blandy's avatar
Jim Blandy committed
1089 1090
  prev = Qnil;
  tail = list;
Jim Blandy's avatar
Jim Blandy committed
1091
  while (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    {
      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
1108
  Lisp_Object new;
Jim Blandy's avatar
Jim Blandy committed
1109

Richard M. Stallman's avatar
Richard M. Stallman committed
1110 1111 1112 1113 1114
  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
1115 1116 1117 1118 1119 1120 1121 1122 1123
}

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.")
1124 1125
  (list, predicate)
     Lisp_Object list, predicate;
Jim Blandy's avatar
Jim Blandy committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
{
  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);
1144 1145
  front = Fsort (front, predicate);
  back = Fsort (back, predicate);
Jim Blandy's avatar
Jim Blandy committed
1146
  UNGCPRO;
1147
  return merge (front, back, predicate);
Jim Blandy's avatar
Jim Blandy committed
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159