fns.c 67.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 1998 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
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
#define DEFAULT_NONASCII_INSERT_OFFSET 0x800

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

49 50
extern Lisp_Object Flookup_key ();

51 52 53
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;

54
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
55
Lisp_Object Qyes_or_no_p_history;
56
Lisp_Object Qcursor_in_echo_area;
Karl Heuer's avatar
Karl Heuer committed
57
Lisp_Object Qwidget_type;
Jim Blandy's avatar
Jim Blandy committed
58

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

69 70 71 72
extern long get_random ();
extern void seed_random ();
extern long time ();

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

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

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

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

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

  XSETINT (length, len);
  return length;
}

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

196 197 198
  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
199 200 201 202 203
    return Qnil;
  return Qt;
}

DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
204
  "Return t if first arg string is less than second in lexicographic order.\n\
Jim Blandy's avatar
Jim Blandy committed
205 206 207 208 209 210
Case is significant.\n\
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
  register int end;
211
  register int i1, i1_byte, i2, i2_byte;
Jim Blandy's avatar
Jim Blandy committed
212

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

220 221 222 223 224
  i1 = i1_byte = i2 = i2_byte = 0;

  end = XSTRING (s1)->size;
  if (end > XSTRING (s2)->size)
    end = XSTRING (s2)->size;
Jim Blandy's avatar
Jim Blandy committed
225

226
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
227
    {
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

      if (STRING_MULTIBYTE (s1))
	FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      else
	c1 = XSTRING (s1)->data[i1++];

      if (STRING_MULTIBYTE (s2))
	FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
      else
	c2 = XSTRING (s2)->data[i2++];

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
244
    }
245
  return i1 < XSTRING (s2)->size ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
}

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
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
/* 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
281 282 283 284
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
285
The last argument is not copied, just used as the tail of the new list.")
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292 293 294 295
  (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\
296 297 298 299 300 301
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
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
  (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;
{
317
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
318 319
}

320 321 322 323
/* 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)
324
     Lisp_Object arg;
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
{
  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
342 343 344 345 346 347 348
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
349
  if (NILP (arg)) return arg;
350 351 352

  if (CHAR_TABLE_P (arg))
    {
353
      int i;
354 355
      Lisp_Object copy;

356
      copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
357
      /* Copy all the slots, including the extra ones.  */
358
      bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
359 360
	     ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
	      * sizeof (Lisp_Object)));
361

362 363 364 365 366
      /* 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]))
367
	  XCHAR_TABLE (copy)->contents[i]
368
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
369 370 371 372 373 374 375 376

      return copy;
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
377
	= (XBOOL_VECTOR (arg)->size + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
378 379 380 381 382 383 384

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

385
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
Jim Blandy's avatar
Jim Blandy committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
    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;
401 402 403
  int toindex_byte;
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
404 405 406
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
407
  int some_multibyte;
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413 414 415 416 417

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

418
  /* Canonicalize each argument.  */
Jim Blandy's avatar
Jim Blandy committed
419 420 421
  for (argnum = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
422
      if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
423
	    || COMPILEDP (this) || BOOL_VECTOR_P (this)))
Jim Blandy's avatar
Jim Blandy committed
424
	{
425
	  if (INTEGERP (this))
426
            args[argnum] = Fnumber_to_string (this);
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431
	  else
	    args[argnum] = wrong_type_argument (Qsequencep, this);
	}
    }

432 433 434 435 436 437 438 439
  /* 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
440
    {
441
      int len;
Jim Blandy's avatar
Jim Blandy committed
442
      this = args[argnum];
443 444
      len = XFASTINT (Flength (this));
      if (target_type == Lisp_String)
445
	{
446 447
	  /* We must count the number of bytes needed in the string
	     as well as the number of characters.  */
448 449
	  int i;
	  Lisp_Object ch;
450
	  int this_len_byte;
451

452
	  if (VECTORP (this))
453
	    for (i = 0; i < len; i++)
454 455 456 457
	      {
		ch = XVECTOR (this)->contents[i];
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
458 459 460 461
		this_len_byte = XFASTINT (Fchar_bytes (ch));
		result_len_byte += this_len_byte;
		if (this_len_byte > 1)
		  some_multibyte = 1;
462
	      }
463 464
	  else if (BOOL_VECTOR_P (this) && XBOOL_VECTOR (this)->size > 0)
	    wrong_type_argument (Qintegerp, Faref (this, make_number (0)));
465
	  else if (CONSP (this))
466 467 468 469 470
	    for (; CONSP (this); this = XCONS (this)->cdr)
	      {
		ch = XCONS (this)->car;
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
471 472 473 474
		this_len_byte = XFASTINT (Fchar_bytes (ch));
		result_len_byte += this_len_byte;
		if (this_len_byte > 1)
		  some_multibyte = 1;
475
	      }
476
	  else if (STRINGP (this))
477
	    {
478
	      if (STRING_MULTIBYTE (this))
479 480 481 482 483 484 485
		{
		  some_multibyte = 1;
		  result_len_byte += XSTRING (this)->size_byte;
		}
	      else
		result_len_byte += count_size_as_multibyte (XSTRING (this)->data,
							    XSTRING (this)->size);
486
	    }
487
	}
488 489

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
490 491
    }

492 493
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
494

495
  /* Create the output object.  */
Jim Blandy's avatar
Jim Blandy committed
496
  if (target_type == Lisp_Cons)
497
    val = Fmake_list (make_number (result_len), Qnil);
498
  else if (target_type == Lisp_Vectorlike)
499
    val = Fmake_vector (make_number (result_len), Qnil);
Jim Blandy's avatar
Jim Blandy committed
500
  else
501
    val = make_uninit_multibyte_string (result_len, result_len_byte);
Jim Blandy's avatar
Jim Blandy committed
502

503 504 505
  /* 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
506

507
  /* Copy the contents of the args into the result.  */
Jim Blandy's avatar
Jim Blandy committed
508 509 510
  if (CONSP (val))
    tail = val, toindex = -1;		/* -1 in toindex is flag we are making a list */
  else
511
    toindex = 0, toindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517 518

  prev = Qnil;

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
      int thisleni;
519
      register unsigned int thisindex = 0;
520
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524 525

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

526
      if (STRINGP (this) && STRINGP (val)
527
	  && ! NULL_INTERVAL_P (XSTRING (this)->intervals))
528 529
	copy_text_properties (make_number (0), thislen, this,
			      make_number (toindex), val, Qnil);
530

531 532 533
      /* 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
534
	{
535 536 537 538 539 540
	  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;
	}
541 542 543 544 545 546 547 548
      /* Copy a single-byte string to a multibyte string.  */
      else if (STRINGP (this) && STRINGP (val))
	{
	  toindex_byte += copy_text (XSTRING (this)->data,
				     XSTRING (val)->data + toindex_byte,
				     XSTRING (this)->size, 0, 1);
	  toindex += thisleni;
	}
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
      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++]);
577 578 579
			if (some_multibyte)
			  XSETINT (elt,
				   unibyte_char_to_multibyte (XINT (elt)));
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
		      }
		  }
		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
597

598 599
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
600
	      {
601 602 603
		XCONS (tail)->car = elt;
		prev = tail;
		tail = XCONS (tail)->cdr;
Jim Blandy's avatar
Jim Blandy committed
604
	      }
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
	    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
632
    }
Jim Blandy's avatar
Jim Blandy committed
633
  if (!NILP (prev))
Jim Blandy's avatar
Jim Blandy committed
634 635
    XCONS (prev)->cdr = last_tail;

Karl Heuer's avatar
Karl Heuer committed
636
  return val;
Jim Blandy's avatar
Jim Blandy committed
637 638
}

639 640 641 642
static Lisp_Object string_char_byte_cache_string;
static int string_char_byte_cache_charpos;
static int string_char_byte_cache_bytepos;

643 644 645 646 647 648 649
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
650 651 652
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
653 654 655 656

  if (! STRING_MULTIBYTE (string))
    return char_index;

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
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
  best_above_byte = XSTRING (string)->size_byte;

  if (EQ (string, string_char_byte_cache_string))
    {
      if (string_char_byte_cache_charpos < char_index)
	{
	  best_below = string_char_byte_cache_charpos;
	  best_below_byte = string_char_byte_cache_bytepos;
	}
      else
	{
	  best_above = string_char_byte_cache_charpos;
	  best_above_byte = string_char_byte_cache_bytepos;
	}
    }

  if (char_index - best_below < best_above - char_index)
    {
      while (best_below < char_index)
	{
	  int c;
	  FETCH_STRING_CHAR_ADVANCE (c, string, best_below, best_below_byte);
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
686
    {
687 688 689 690 691 692 693 694 695 696 697 698 699
      while (best_above > char_index)
	{
	  int best_above_byte_saved = --best_above_byte;

	  while (best_above_byte > 0
		 && !CHAR_HEAD_P (XSTRING (string)->data[best_above_byte]))
	    best_above_byte--;
	  if (XSTRING (string)->data[best_above_byte] < 0x80)
	    best_above_byte = best_above_byte_saved;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
700 701
    }

702 703 704 705
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

706 707
  return i_byte;
}
708

709 710 711 712 713 714 715
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{
716 717 718
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
719 720 721 722

  if (! STRING_MULTIBYTE (string))
    return byte_index;

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
  best_above_byte = XSTRING (string)->size_byte;

  if (EQ (string, string_char_byte_cache_string))
    {
      if (string_char_byte_cache_bytepos < byte_index)
	{
	  best_below = string_char_byte_cache_charpos;
	  best_below_byte = string_char_byte_cache_bytepos;
	}
      else
	{
	  best_above = string_char_byte_cache_charpos;
	  best_above_byte = string_char_byte_cache_bytepos;
	}
    }

  if (byte_index - best_below_byte < best_above_byte - byte_index)
    {
      while (best_below_byte < byte_index)
	{
	  int c;
	  FETCH_STRING_CHAR_ADVANCE (c, string, best_below, best_below_byte);
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
752
    {
753 754 755 756 757 758 759 760 761 762 763 764 765
      while (best_above_byte > byte_index)
	{
	  int best_above_byte_saved = --best_above_byte;

	  while (best_above_byte > 0
		 && !CHAR_HEAD_P (XSTRING (string)->data[best_above_byte]))
	    best_above_byte--;
	  if (XSTRING (string)->data[best_above_byte] < 0x80)
	    best_above_byte = best_above_byte_saved;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
766 767
    }

768 769 770 771
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

772 773
  return i;
}
774

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
/* 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);
791 792 793 794 795
  /* If all the chars are ASCII, they won't need any more bytes
     once converted.  In that case, we can return STRING itself.  */
  if (nbytes == XSTRING (string)->size_byte)
    return string;

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
  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);
}
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

DEFUN ("string-make-multibyte", Fstring_make_multibyte, Sstring_make_multibyte,
       1, 1, 0,
  "Return the multibyte equivalent of STRING.")
  (string)
     Lisp_Object string;
{
  return string_make_multibyte (string);
}

DEFUN ("string-make-unibyte", Fstring_make_unibyte, Sstring_make_unibyte,
       1, 1, 0,
  "Return the unibyte equivalent of STRING.")
  (string)
     Lisp_Object string;
{
  return string_make_unibyte (string);
}
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874

DEFUN ("string-as-unibyte", Fstring_as_unibyte, Sstring_as_unibyte,
       1, 1, 0,
  "Return a unibyte string with the same individual bytes as STRING.\n\
If STRING is unibyte, the result is STRING itself.")
  (string)
     Lisp_Object string;
{
  if (STRING_MULTIBYTE (string))
    {
      string = Fcopy_sequence (string);
      XSTRING (string)->size = XSTRING (string)->size_byte;
    }
  return string;
}

DEFUN ("string-as-multibyte", Fstring_as_multibyte, Sstring_as_multibyte,
       1, 1, 0,
  "Return a multibyte string with the same individual bytes as STRING.\n\
If STRING is multibyte, the result is STRING itself.")
  (string)
     Lisp_Object string;
{
  if (! STRING_MULTIBYTE (string))
    {
      int newlen = chars_in_text (XSTRING (string)->data,
				  XSTRING (string)->size_byte);
      /* If all the chars are ASCII, STRING is already suitable.  */
      if (newlen != XSTRING (string)->size_byte)
	{
	  string = Fcopy_sequence (string);
	  XSTRING (string)->size = newlen;
	}
    }
  return string;
}
875

Jim Blandy's avatar
Jim Blandy committed
876 877 878 879 880 881 882 883 884 885 886 887 888
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
889
  if (NILP (alist))
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
    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\
906 907 908
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
909 910 911 912
  (string, from, to)
     Lisp_Object string;
     register Lisp_Object from, to;
{
913
  Lisp_Object res;
914
  int size;
915 916 917
  int size_byte;
  int from_char, to_char;
  int from_byte, to_byte;
918 919 920

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

Jim Blandy's avatar
Jim Blandy committed
922
  CHECK_NUMBER (from, 1);
923 924

  if (STRINGP (string))
925 926 927 928
    {
      size = XSTRING (string)->size;
      size_byte = XSTRING (string)->size_byte;
    }
929 930 931
  else
    size = XVECTOR (string)->size;

Jim Blandy's avatar
Jim Blandy committed
932
  if (NILP (to))
933 934 935 936
    {
      to_char = size;
      to_byte = size_byte;
    }
Jim Blandy's avatar
Jim Blandy committed
937
  else
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    {
      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
954

955 956 957
  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
958

959 960
  if (STRINGP (string))
    {
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
      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);
1003 1004 1005
      copy_text_properties (from, to, string, make_number (0), res, Qnil);
    }
  else
1006 1007
    res = Fvector (to - from,
		   XVECTOR (string)->contents + from);
Karl Heuer's avatar
Karl Heuer committed
1008

1009
  return res;
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
}

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
1021
  for (i = 0; i < num && !NILP (list); i++)
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    {
      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.")
1040 1041
  (sequence, n)
     register Lisp_Object sequence, n;
Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044 1045
{
  CHECK_NUMBER (n, 0);
  while (1)
    {
1046 1047 1048 1049 1050
      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
1051
      else
1052
	sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
1053 1054 1055 1056
    }
}

DEFUN ("member", Fmember, Smember, 2, 2, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
1057
  "Return non-nil if ELT is an element of LIST.  Comparison done with `equal'.\n\
Jim Blandy's avatar
Jim Blandy committed
1058 1059 1060 1061 1062 1063
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;
1064
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1065 1066 1067
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
1068
      if (! NILP (Fequal (elt, tem)))
Jim Blandy's avatar
Jim Blandy committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
	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;
1083
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
      if (EQ (elt, tem)) return tail;
      QUIT;
    }
  return Qnil;
}

DEFUN ("assq", Fassq, Sassq, 2, 2, 0,
1094 1095
  "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
1096 1097 1098 1099 1100 1101
Elements of LIST that are not conses are ignored.")
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
1102
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1103 1104 1105 1106
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
1107
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
      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;
1123
  for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1124 1125 1126 1127
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
1128
      tem = XCONS (elt)->car;
Jim Blandy's avatar
Jim Blandy committed
1129 1130 1131 1132 1133 1134
      if (EQ (key, tem)) return elt;
    }
  return Qnil;
}

DEFUN ("assoc", Fassoc, Sassoc, 2, 2, 0,
1135
  "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
1136
The value is actually the element of LIST whose car equals KEY.")
Jim Blandy's avatar
Jim Blandy committed
1137 1138 1139 1140 1141
  (key, list)
     register Lisp_Object key;
     Lisp_Object list;
{
  register Lisp_Object tail;
1142
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1143 1144 1145 1146
    {
      register Lisp_Object elt, tem;
      elt = Fcar (tail);
      if (!CONSP (elt)) continue;
1147
      tem = Fequal (XCONS (elt)->car, key);
Jim Blandy's avatar
Jim Blandy committed
1148
      if (!NILP (tem)) return elt;
Jim Blandy's avatar
Jim Blandy committed
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
      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;
1162
  for (tail = list; !NILP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
1163 1164 1165 1166
    {
      register Lisp_Objec