fns.c 146 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
Dave Love's avatar
Dave Love committed
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 98, 99, 2000, 2001, 2002
Gerd Moellmann's avatar
Gerd Moellmann committed
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23

Andreas Schwab's avatar
Andreas Schwab committed
24 25 26
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Andreas Schwab's avatar
Andreas Schwab committed
27
#include <time.h>
Andreas Schwab's avatar
Andreas Schwab committed
28

Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33 34
/* 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"
35
#include "charset.h"
36
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
37
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
38
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
39
#include "keymap.h"
40
#include "intervals.h"
41 42
#include "frame.h"
#include "window.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
43
#include "blockinput.h"
44
#if defined (HAVE_MENUS) && defined (HAVE_X_WINDOWS)
Andreas Schwab's avatar
Andreas Schwab committed
45 46
#include "xterm.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
47

Karl Heuer's avatar
Karl Heuer committed
48
#ifndef NULL
49
#define NULL ((POINTER_TYPE *)0)
Karl Heuer's avatar
Karl Heuer committed
50 51
#endif

52 53 54 55
/* Nonzero enables use of dialog boxes for questions
   asked by mouse commands.  */
int use_dialog_box;

56 57
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;
58
extern Lisp_Object Vlocale_coding_system;
59

60
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
61
Lisp_Object Qyes_or_no_p_history;
62
Lisp_Object Qcursor_in_echo_area;
Karl Heuer's avatar
Karl Heuer committed
63
Lisp_Object Qwidget_type;
64
Lisp_Object Qcodeset, Qdays, Qmonths, Qpaper;
Jim Blandy's avatar
Jim Blandy committed
65

66 67
extern Lisp_Object Qinput_method_function;

68
static int internal_equal ();
69 70 71 72 73 74 75

extern long get_random ();
extern void seed_random ();

#ifndef HAVE_UNISTD_H
extern long time ();
#endif
76

Jim Blandy's avatar
Jim Blandy committed
77
DEFUN ("identity", Fidentity, Sidentity, 1, 1, 0,
Pavel Janík's avatar
Pavel Janík committed
78
       doc: /* Return the argument unchanged.  */)
79
     (arg)
Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84 85
     Lisp_Object arg;
{
  return arg;
}

DEFUN ("random", Frandom, Srandom, 0, 1, 0,
86
       doc: /* Return a pseudo-random number.
Gerd Moellmann's avatar
Gerd Moellmann committed
87 88 89
All integers representable in Lisp are equally likely.
  On most systems, this is 28 bits' worth.
With positive integer argument N, return random number in interval [0,N).
90 91
With argument t, set the random number seed from the current time and pid. */)
     (n)
92
     Lisp_Object n;
Jim Blandy's avatar
Jim Blandy committed
93
{
94 95
  EMACS_INT val;
  Lisp_Object lispy_val;
96
  unsigned long denominator;
Jim Blandy's avatar
Jim Blandy committed
97

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

DEFUN ("length", Flength, Slength, 1, 1, 0,
123
       doc: /* Return the length of vector, list or string SEQUENCE.
Gerd Moellmann's avatar
Gerd Moellmann committed
124
A byte-code function object is also allowed.
John Paul Wallington's avatar
John Paul Wallington committed
125
If the string contains multibyte characters, this is not necessarily
Gerd Moellmann's avatar
Gerd Moellmann committed
126
the number of bytes in the string; it is the number of characters.
127 128
To get the number of bytes, use `string-bytes'. */)
     (sequence)
129
     register Lisp_Object sequence;
Jim Blandy's avatar
Jim Blandy committed
130
{
131
  register Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
132 133 134
  register int i;

 retry:
135
  if (STRINGP (sequence))
136
    XSETFASTINT (val, SCHARS (sequence));
137 138 139
  else if (VECTORP (sequence))
    XSETFASTINT (val, XVECTOR (sequence)->size);
  else if (CHAR_TABLE_P (sequence))
140
    XSETFASTINT (val, MAX_CHAR);
141 142 143 144 145
  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
146
    {
147 148
      i = 0;
      while (CONSP (sequence))
Jim Blandy's avatar
Jim Blandy committed
149
	{
150
	  sequence = XCDR (sequence);
151 152 153 154 155 156 157 158
	  ++i;

	  if (!CONSP (sequence))
	    break;

	  sequence = XCDR (sequence);
	  ++i;
	  QUIT;
Jim Blandy's avatar
Jim Blandy committed
159 160
	}

161 162 163 164
      if (!NILP (sequence))
	wrong_type_argument (Qlistp, sequence);

      val = make_number (i);
Jim Blandy's avatar
Jim Blandy committed
165
    }
166
  else if (NILP (sequence))
167
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
168 169
  else
    {
170
      sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
171 172
      goto retry;
    }
173
  return val;
Jim Blandy's avatar
Jim Blandy committed
174 175
}

176 177 178 179
/* This does not check for quits.  That is safe
   since it must terminate.  */

DEFUN ("safe-length", Fsafe_length, Ssafe_length, 1, 1, 0,
180
       doc: /* Return the length of a list, but avoid error or infinite loop.
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182
This function never gets an error.  If LIST is not really a list,
it returns 0.  If LIST is circular, it returns a finite value
183 184
which is at least the number of distinct elements. */)
     (list)
185 186 187 188 189 190 191
     Lisp_Object list;
{
  Lisp_Object tail, halftail, length;
  int len = 0;

  /* halftail is used to detect circular lists.  */
  halftail = list;
192
  for (tail = list; CONSP (tail); tail = XCDR (tail))
193 194
    {
      if (EQ (tail, halftail) && len != 0)
195
	break;
196
      len++;
197
      if ((len & 1) == 0)
198
	halftail = XCDR (halftail);
199 200 201 202 203 204
    }

  XSETINT (length, len);
  return length;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
205
DEFUN ("string-bytes", Fstring_bytes, Sstring_bytes, 1, 1, 0, 
206 207 208
       doc: /* Return the number of bytes in STRING.
If STRING is a multibyte string, this is greater than the length of STRING. */)
     (string)
209
     Lisp_Object string;
210
{
211
  CHECK_STRING (string);
212
  return make_number (SBYTES (string));
213 214
}

Jim Blandy's avatar
Jim Blandy committed
215
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
216
       doc: /* Return t if two strings have identical contents.
Gerd Moellmann's avatar
Gerd Moellmann committed
217
Case is significant, but text properties are ignored.
218 219
Symbols are also allowed; their print names are used instead. */)
     (s1, s2)
Jim Blandy's avatar
Jim Blandy committed
220 221
     register Lisp_Object s1, s2;
{
222
  if (SYMBOLP (s1))
223
    s1 = SYMBOL_NAME (s1);
224
  if (SYMBOLP (s2))
225
    s2 = SYMBOL_NAME (s2);
226 227
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
228

229 230 231
  if (SCHARS (s1) != SCHARS (s2)
      || SBYTES (s1) != SBYTES (s2)
      || bcmp (SDATA (s1), SDATA (s2), SBYTES (s1)))
Jim Blandy's avatar
Jim Blandy committed
232 233 234 235
    return Qnil;
  return Qt;
}

236
DEFUN ("compare-strings", Fcompare_strings,
237
       Scompare_strings, 6, 7, 0,
238
doc: /* Compare the contents of two strings, converting to multibyte if needed.
Gerd Moellmann's avatar
Gerd Moellmann committed
239 240 241 242 243 244 245 246 247 248 249
In string STR1, skip the first START1 characters and stop at END1.
In string STR2, skip the first START2 characters and stop at END2.
END1 and END2 default to the full lengths of the respective strings.

Case is significant in this comparison if IGNORE-CASE is nil.
Unibyte strings are converted to multibyte for comparison.

The value is t if the strings (or specified portions) match.
If string STR1 is less, the value is a negative number N;
  - 1 - N is the number of characters that match at the beginning.
If string STR1 is greater, the value is a positive number N;
250 251
  N - 1 is the number of characters that match at the beginning. */)
     (str1, start1, end1, str2, start2, end2, ignore_case)
252 253 254 255 256
     Lisp_Object str1, start1, end1, start2, str2, end2, ignore_case;
{
  register int end1_char, end2_char;
  register int i1, i1_byte, i2, i2_byte;

257 258
  CHECK_STRING (str1);
  CHECK_STRING (str2);
259 260 261 262
  if (NILP (start1))
    start1 = make_number (0);
  if (NILP (start2))
    start2 = make_number (0);
263 264
  CHECK_NATNUM (start1);
  CHECK_NATNUM (start2);
265
  if (! NILP (end1))
266
    CHECK_NATNUM (end1);
267
  if (! NILP (end2))
268
    CHECK_NATNUM (end2);
269 270 271 272 273 274 275

  i1 = XINT (start1);
  i2 = XINT (start2);

  i1_byte = string_char_to_byte (str1, i1);
  i2_byte = string_char_to_byte (str2, i2);

276
  end1_char = SCHARS (str1);
277 278 279
  if (! NILP (end1) && end1_char > XINT (end1))
    end1_char = XINT (end1);

280
  end2_char = SCHARS (str2);
281 282 283 284 285 286 287 288 289 290
  if (! NILP (end2) && end2_char > XINT (end2))
    end2_char = XINT (end2);

  while (i1 < end1_char && i2 < end2_char)
    {
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

      if (STRING_MULTIBYTE (str1))
291
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
292 293
      else
	{
294
	  c1 = SREF (str1, i1++);
295 296 297 298
	  c1 = unibyte_char_to_multibyte (c1);
	}

      if (STRING_MULTIBYTE (str2))
299
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c2, str2, i2, i2_byte);
300 301
      else
	{
302
	  c2 = SREF (str2, i2++);
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
	  c2 = unibyte_char_to_multibyte (c2);
	}

      if (c1 == c2)
	continue;

      if (! NILP (ignore_case))
	{
	  Lisp_Object tem;

	  tem = Fupcase (make_number (c1));
	  c1 = XINT (tem);
	  tem = Fupcase (make_number (c2));
	  c2 = XINT (tem);
	}

      if (c1 == c2)
	continue;

      /* Note that I1 has already been incremented
	 past the character that we are comparing;
	 hence we don't add or subtract 1 here.  */
      if (c1 < c2)
326
	return make_number (- i1 + XINT (start1));
327
      else
328
	return make_number (i1 - XINT (start1));
329 330 331 332 333 334 335 336 337 338
    }

  if (i1 < end1_char)
    return make_number (i1 - XINT (start1) + 1);
  if (i2 < end2_char)
    return make_number (- i1 + XINT (start1) - 1);

  return Qt;
}

Jim Blandy's avatar
Jim Blandy committed
339
DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
340
       doc: /* Return t if first arg string is less than second in lexicographic order.
Gerd Moellmann's avatar
Gerd Moellmann committed
341
Case is significant.
342 343
Symbols are also allowed; their print names are used instead. */)
     (s1, s2)
Jim Blandy's avatar
Jim Blandy committed
344 345 346
     register Lisp_Object s1, s2;
{
  register int end;
347
  register int i1, i1_byte, i2, i2_byte;
Jim Blandy's avatar
Jim Blandy committed
348

349
  if (SYMBOLP (s1))
350
    s1 = SYMBOL_NAME (s1);
351
  if (SYMBOLP (s2))
352
    s2 = SYMBOL_NAME (s2);
353 354
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
355

356 357
  i1 = i1_byte = i2 = i2_byte = 0;

358 359 360
  end = SCHARS (s1);
  if (end > SCHARS (s2))
    end = SCHARS (s2);
Jim Blandy's avatar
Jim Blandy committed
361

362
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
363
    {
364 365 366 367
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

368 369
      FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
370 371 372

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
373
    }
374
  return i1 < SCHARS (s2) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
}

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
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/* 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
410
DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
411
       doc: /* Concatenate all the arguments and make the result a list.
Gerd Moellmann's avatar
Gerd Moellmann committed
412 413
The result is a list whose elements are the elements of all the arguments.
Each argument may be a list, vector or string.
414 415
The last argument is not copied, just used as the tail of the new list.
usage: (append &rest SEQUENCES)  */)
416
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421 422 423
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_Cons, 1);
}

DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
424
       doc: /* Concatenate all the arguments and make the result a string.
Gerd Moellmann's avatar
Gerd Moellmann committed
425
The result is a string whose elements are the elements of all the arguments.
426 427
Each argument may be a string or a list or vector of characters (integers).
usage: (concat &rest SEQUENCES)  */)
428
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433 434 435
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_String, 0);
}

DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
436
       doc: /* Concatenate all the arguments and make the result a vector.
Gerd Moellmann's avatar
Gerd Moellmann committed
437
The result is a vector whose elements are the elements of all the arguments.
438 439
Each argument may be a list, vector or string.
usage: (vconcat &rest SEQUENCES)   */)
440
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
441 442 443
     int nargs;
     Lisp_Object *args;
{
444
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
445 446
}

John Paul Wallington's avatar
John Paul Wallington committed
447
/* Return a copy of a sub char table ARG.  The elements except for a
448 449 450
   nested sub char table are not copied.  */
static Lisp_Object
copy_sub_char_table (arg)
451
     Lisp_Object arg;
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
{
  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
469
DEFUN ("copy-sequence", Fcopy_sequence, Scopy_sequence, 1, 1, 0,
Dave Love's avatar
Dave Love committed
470
       doc: /* Return a copy of a list, vector, string or char-table.
Gerd Moellmann's avatar
Gerd Moellmann committed
471
The elements of a list or vector are not copied; they are shared
472 473
with the original. */)
     (arg)
Jim Blandy's avatar
Jim Blandy committed
474 475
     Lisp_Object arg;
{
Jim Blandy's avatar
Jim Blandy committed
476
  if (NILP (arg)) return arg;
477 478 479

  if (CHAR_TABLE_P (arg))
    {
480
      int i;
481 482
      Lisp_Object copy;

483
      copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
484
      /* Copy all the slots, including the extra ones.  */
485
      bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
486 487
	     ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
	      * sizeof (Lisp_Object)));
488

489 490 491 492 493
      /* 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]))
494
	  XCHAR_TABLE (copy)->contents[i]
495
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
496 497 498 499 500 501 502 503

      return copy;
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
504
	= (XBOOL_VECTOR (arg)->size + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
505 506 507 508 509 510 511

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

512
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
Jim Blandy's avatar
Jim Blandy committed
513 514 515 516
    arg = wrong_type_argument (Qsequencep, arg);
  return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
}

517 518 519 520 521 522 523 524 525 526
/* In string STR of length LEN, see if bytes before STR[I] combine
   with bytes after STR[I] to form a single character.  If so, return
   the number of bytes after STR[I] which combine in this way.
   Otherwize, return 0.  */

static int
count_combining (str, len, i)
     unsigned char *str;
     int len, i;
{
527
  int j = i - 1, bytes;
528 529 530 531 532 533

  if (i == 0 || i == len || CHAR_HEAD_P (str[i]))
    return 0;
  while (j >= 0 && !CHAR_HEAD_P (str[j])) j--;
  if (j < 0 || ! BASE_LEADING_CODE_P (str[j]))
    return 0;
534 535
  PARSE_MULTIBYTE_SEQ (str + j, len - j, bytes);
  return (bytes <= i - j ? 0 : bytes - (i - j));
536 537 538 539
}

/* This structure holds information of an argument of `concat' that is
   a string and has text properties to be copied.  */
Kenichi Handa's avatar
Kenichi Handa committed
540
struct textprop_rec
541 542 543 544 545 546
{
  int argnum;			/* refer to ARGS (arguments of `concat') */
  int from;			/* refer to ARGS[argnum] (argument string) */
  int to;			/* refer to VAL (the target string) */
};

Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552 553 554 555 556 557
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;
558
  int toindex_byte = 0;
559 560
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
561 562 563
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
564
  int some_multibyte;
565 566 567 568 569
  /* When we make a multibyte string, we can't copy text properties
     while concatinating each string because the length of resulting
     string can't be decided until we finish the whole concatination.
     So, we record strings that have text properties to be copied
     here, and copy the text properties after the concatination.  */
570
  struct textprop_rec  *textprops = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
571 572
  /* Number of elments in textprops.  */
  int num_textprops = 0;
Jim Blandy's avatar
Jim Blandy committed
573

574 575
  tail = Qnil;

Jim Blandy's avatar
Jim Blandy committed
576 577 578 579 580 581 582 583 584
  /* 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;

585
  /* Canonicalize each argument.  */
Jim Blandy's avatar
Jim Blandy committed
586 587 588
  for (argnum = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
589
      if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
590
	    || COMPILEDP (this) || BOOL_VECTOR_P (this)))
Jim Blandy's avatar
Jim Blandy committed
591 592 593 594 595
	{
	    args[argnum] = wrong_type_argument (Qsequencep, this);
	}
    }

596 597 598 599 600 601 602 603
  /* 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
604
    {
605
      int len;
Jim Blandy's avatar
Jim Blandy committed
606
      this = args[argnum];
607 608
      len = XFASTINT (Flength (this));
      if (target_type == Lisp_String)
609
	{
610 611
	  /* We must count the number of bytes needed in the string
	     as well as the number of characters.  */
612 613
	  int i;
	  Lisp_Object ch;
614
	  int this_len_byte;
615

616
	  if (VECTORP (this))
617
	    for (i = 0; i < len; i++)
618 619 620 621
	      {
		ch = XVECTOR (this)->contents[i];
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
622
		this_len_byte = CHAR_BYTES (XINT (ch));
623
		result_len_byte += this_len_byte;
624
		if (!SINGLE_BYTE_CHAR_P (XINT (ch)))
625
		  some_multibyte = 1;
626
	      }
627 628
	  else if (BOOL_VECTOR_P (this) && XBOOL_VECTOR (this)->size > 0)
	    wrong_type_argument (Qintegerp, Faref (this, make_number (0)));
629
	  else if (CONSP (this))
630
	    for (; CONSP (this); this = XCDR (this))
631
	      {
632
		ch = XCAR (this);
633 634
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
635
		this_len_byte = CHAR_BYTES (XINT (ch));
636
		result_len_byte += this_len_byte;
637
		if (!SINGLE_BYTE_CHAR_P (XINT (ch)))
638
		  some_multibyte = 1;
639
	      }
640
	  else if (STRINGP (this))
641
	    {
642
	      if (STRING_MULTIBYTE (this))
643 644
		{
		  some_multibyte = 1;
645
		  result_len_byte += SBYTES (this);
646 647
		}
	      else
648 649
		result_len_byte += count_size_as_multibyte (SDATA (this),
							    SCHARS (this));
650
	    }
651
	}
652 653

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
654 655
    }

656 657
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
658

659
  /* Create the output object.  */
Jim Blandy's avatar
Jim Blandy committed
660
  if (target_type == Lisp_Cons)
661
    val = Fmake_list (make_number (result_len), Qnil);
662
  else if (target_type == Lisp_Vectorlike)
663
    val = Fmake_vector (make_number (result_len), Qnil);
664
  else if (some_multibyte)
665
    val = make_uninit_multibyte_string (result_len, result_len_byte);
666 667
  else
    val = make_uninit_string (result_len);
Jim Blandy's avatar
Jim Blandy committed
668

669 670 671
  /* 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
672

673
  /* Copy the contents of the args into the result.  */
Jim Blandy's avatar
Jim Blandy committed
674
  if (CONSP (val))
675
    tail = val, toindex = -1; /* -1 in toindex is flag we are making a list */
Jim Blandy's avatar
Jim Blandy committed
676
  else
677
    toindex = 0, toindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
678 679

  prev = Qnil;
680
  if (STRINGP (val))
Kenichi Handa's avatar
Kenichi Handa committed
681 682
    textprops
      = (struct textprop_rec *) alloca (sizeof (struct textprop_rec) * nargs);
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
687
      int thisleni = 0;
688
      register unsigned int thisindex = 0;
689
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
690 691 692 693 694

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

695 696 697
      /* 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
698
	{
699
	  int thislen_byte = SBYTES (this);
700 701
	  int combined;

702 703
	  bcopy (SDATA (this), SDATA (val) + toindex_byte,
		 SBYTES (this));
704
	  combined =  (some_multibyte && toindex_byte > 0
705
		       ? count_combining (SDATA (val),
706 707 708
					  toindex_byte + thislen_byte,
					  toindex_byte)
		       : 0);
709
	  if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
710
	    {
Kenichi Handa's avatar
Kenichi Handa committed
711
	      textprops[num_textprops].argnum = argnum;
712
	      /* We ignore text properties on characters being combined.  */
Kenichi Handa's avatar
Kenichi Handa committed
713 714
	      textprops[num_textprops].from = combined;
	      textprops[num_textprops++].to = toindex;
715
	    }
716
	  toindex_byte += thislen_byte;
717
	  toindex += thisleni - combined;
718
	  STRING_SET_CHARS (val, SCHARS (val) - combined);
719
	}
720 721 722
      /* Copy a single-byte string to a multibyte string.  */
      else if (STRINGP (this) && STRINGP (val))
	{
723
	  if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
724
	    {
Kenichi Handa's avatar
Kenichi Handa committed
725 726 727
	      textprops[num_textprops].argnum = argnum;
	      textprops[num_textprops].from = 0;
	      textprops[num_textprops++].to = toindex;
728
	    }
729 730 731
	  toindex_byte += copy_text (SDATA (this),
				     SDATA (val) + toindex_byte,
				     SCHARS (this), 0, 1);
732 733
	  toindex += thisleni;
	}
734 735 736 737 738 739 740 741 742 743
      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))
744
	      elt = XCAR (this), this = XCDR (this);
745 746 747
	    else if (thisindex >= thisleni)
	      break;
	    else if (STRINGP (this))
748
	      {
749
		int c;
750
		if (STRING_MULTIBYTE (this))
751
		  {
752 753 754
		    FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, this,
							thisindex,
							thisindex_byte);
755
		    XSETFASTINT (elt, c);
756
		  }
757
		else
758
		  {
759
		    XSETFASTINT (elt, SREF (this, thisindex++));
760 761
		    if (some_multibyte
			&& (XINT (elt) >= 0240
762 763
			    || (XINT (elt) >= 0200
				&& ! NILP (Vnonascii_translation_table)))
764 765
			&& XINT (elt) < 0400)
		      {
766
			c = unibyte_char_to_multibyte (XINT (elt));
767 768
			XSETINT (elt, c);
		      }
769
		  }
770 771 772 773 774 775 776
	      }
	    else if (BOOL_VECTOR_P (this))
	      {
		int byte;
		byte = XBOOL_VECTOR (this)->data[thisindex / BITS_PER_CHAR];
		if (byte & (1 << (thisindex % BITS_PER_CHAR)))
		  elt = Qt;
777
		else
778 779
		  elt = Qnil;
		thisindex++;
780
	      }
781 782
	    else
	      elt = XVECTOR (this)->contents[thisindex++];
Jim Blandy's avatar
Jim Blandy committed
783

784 785
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
786
	      {
787
		XSETCAR (tail, elt);
788
		prev = tail;
789
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
790
	      }
791 792 793 794
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
795
		CHECK_NUMBER (elt);
796 797
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
798 799 800
		    if (some_multibyte)
		      toindex_byte
			+= CHAR_STRING (XINT (elt),
801
					SDATA (val) + toindex_byte);
802
		    else
Ken Raeburn's avatar
Ken Raeburn committed
803
		      SSET (val, toindex_byte++, XINT (elt));
804 805
		    if (some_multibyte
			&& toindex_byte > 0
806
			&& count_combining (SDATA (val),
807
					    toindex_byte, toindex_byte - 1))
808
		      STRING_SET_CHARS (val, SCHARS (val) - 1);
809 810
		    else
		      toindex++;
811 812 813 814 815 816 817 818
		  }
		else
		  /* If we have any multibyte characters,
		     we already decided to make a multibyte string.  */
		  {
		    int c = XINT (elt);
		    /* P exists as a variable
		       to avoid a bug on the Masscomp C compiler.  */
Ken Raeburn's avatar
Ken Raeburn committed
819
		    unsigned char *p = SDATA (val) + toindex_byte;
820 821

		    toindex_byte += CHAR_STRING (c, p);
822 823 824 825
		    toindex++;
		  }
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
826
    }
Jim Blandy's avatar
Jim Blandy committed
827
  if (!NILP (prev))
828
    XSETCDR (prev, last_tail);
Jim Blandy's avatar
Jim Blandy committed
829

Kenichi Handa's avatar
Kenichi Handa committed
830
  if (num_textprops > 0)
831
    {
832
      Lisp_Object props;
833
      int last_to_end = -1;
834

Kenichi Handa's avatar
Kenichi Handa committed
835
      for (argnum = 0; argnum < num_textprops; argnum++)
836
	{
Kenichi Handa's avatar
Kenichi Handa committed
837
	  this = args[textprops[argnum].argnum];
838 839
	  props = text_property_list (this,
				      make_number (0),
840
				      make_number (SCHARS (this)),
841 842 843
				      Qnil);
	  /* If successive arguments have properites, be sure that the
	     value of `composition' property be the copy.  */
844
	  if (last_to_end == textprops[argnum].to)
845 846 847
	    make_composition_value_copy (props);
	  add_text_properties_from_list (val, props,
					 make_number (textprops[argnum].to));
848
	  last_to_end = textprops[argnum].to + SCHARS (this);
849 850
	}
    }
Karl Heuer's avatar
Karl Heuer committed
851
  return val;
Jim Blandy's avatar
Jim Blandy committed
852 853
}

854 855 856 857
static Lisp_Object string_char_byte_cache_string;
static int string_char_byte_cache_charpos;
static int string_char_byte_cache_bytepos;

858 859 860 861 862 863
void
clear_string_char_byte_cache ()
{
  string_char_byte_cache_string = Qnil;
}

864 865 866 867 868 869 870
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
871 872 873
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
874 875 876 877

  if (! STRING_MULTIBYTE (string))
    return char_index;

878
  best_below = best_below_byte = 0;
879 880
  best_above = SCHARS (string);
  best_above_byte = SBYTES (string);
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900

  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;
901 902
	  FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
					      best_below, best_below_byte);
903 904 905 906 907
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
908
    {
909 910
      while (best_above > char_index)
	{
911
	  unsigned char *pend = SDATA (string) + best_above_byte;
912 913 914 915 916 917 918 919 920 921 922
	  unsigned char *pbeg = pend - best_above_byte;
	  unsigned char *p = pend - 1;
	  int bytes;

	  while (p > pbeg  && !CHAR_HEAD_P (*p)) p--;
	  PARSE_MULTIBYTE_SEQ (p, pend - p, bytes);
	  if (bytes == pend - p)
	    best_above_byte -= bytes;
	  else if (bytes > pend - p)
	    best_above_byte -= (pend - p);
	  else
923 924 925 926 927
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
928 929
    }

930 931 932 933
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

934 935
  return i_byte;
}
936

937 938 939 940 941 942 943
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{
944 945 946
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
947 948 949 950

  if (! STRING_MULTIBYTE (string))
    return byte_index;

951
  best_below = best_below_byte = 0;
952 953
  best_above = SCHARS (string);
  best_above_byte = SBYTES (string);
954