fns.c 139 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 98, 99, 2000, 2001
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


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

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

Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34 35 36
/* 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"
37
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
38 39

#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "keyboard.h"
41
#include "intervals.h"
42 43
#include "frame.h"
#include "window.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 49 50 51
#ifndef NULL
#define NULL (void *)0
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
52 53 54 55 56
#ifndef min
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))
#endif

57 58 59 60
/* Nonzero enables use of dialog boxes for questions
   asked by mouse commands.  */
int use_dialog_box;

61 62 63
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;

64
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
65
Lisp_Object Qyes_or_no_p_history;
66
Lisp_Object Qcursor_in_echo_area;
Karl Heuer's avatar
Karl Heuer committed
67
Lisp_Object Qwidget_type;
Jim Blandy's avatar
Jim Blandy committed
68

69 70
extern Lisp_Object Qinput_method_function;

71
static int internal_equal ();
72 73 74 75 76 77 78

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

#ifndef HAVE_UNISTD_H
extern long time ();
#endif
79

Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84 85 86 87 88 89
DEFUN ("identity", Fidentity, Sidentity, 1, 1, 0,
  "Return the argument unchanged.")
  (arg)
     Lisp_Object arg;
{
  return arg;
}

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

101
  if (EQ (n, Qt))
102
    seed_random (getpid () + time (NULL));
103
  if (NATNUMP (n) && XFASTINT (n) != 0)
Jim Blandy's avatar
Jim Blandy committed
104
    {
105 106 107 108
      /* 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
109
	 it's possible to get a quotient larger than n; discarding
110
	 these values eliminates the bias that would otherwise appear
111 112
	 when using a large n.  */
      denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
113
      do
114
	val = get_random () / denominator;
115
      while (val >= XFASTINT (n));
Jim Blandy's avatar
Jim Blandy committed
116
    }
117
  else
118
    val = get_random ();
119 120
  XSETINT (lispy_val, val);
  return lispy_val;
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125 126
}

/* 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
127 128
A byte-code function object is also allowed.\n\
If the string contains multibyte characters, this is not the necessarily\n\
Andreas Schwab's avatar
Andreas Schwab committed
129 130
the number of bytes in the string; it is the number of characters.\n\
To get the number of bytes, use `string-bytes'")
131 132
  (sequence)
     register Lisp_Object sequence;
Jim Blandy's avatar
Jim Blandy committed
133
{
134
  register Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
135 136 137
  register int i;

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

	  if (!CONSP (sequence))
	    break;

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

164 165 166 167
      if (!NILP (sequence))
	wrong_type_argument (Qlistp, sequence);

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

179 180 181 182 183 184 185 186
/* 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
187
  (list)
188 189 190 191 192 193 194
     Lisp_Object list;
{
  Lisp_Object tail, halftail, length;
  int len = 0;

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

  XSETINT (length, len);
  return length;
}

208 209 210 211
DEFUN ("string-bytes", Fstring_bytes, Sstring_bytes, 1, 1, 0,
  "Return the number of bytes in STRING.\n\
If STRING is a multibyte string, this is greater than the length of STRING.")
  (string)
212
     Lisp_Object string;
213 214
{
  CHECK_STRING (string, 1);
215
  return make_number (STRING_BYTES (XSTRING (string)));
216 217
}

Jim Blandy's avatar
Jim Blandy committed
218
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
219
  "Return t if two strings have identical contents.\n\
220
Case is significant, but text properties are ignored.\n\
Jim Blandy's avatar
Jim Blandy committed
221 222 223 224
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
225
  if (SYMBOLP (s1))
226
    XSETSTRING (s1, XSYMBOL (s1)->name);
227
  if (SYMBOLP (s2))
228
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
229 230 231
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

232
  if (XSTRING (s1)->size != XSTRING (s2)->size
233 234
      || STRING_BYTES (XSTRING (s1)) != STRING_BYTES (XSTRING (s2))
      || bcmp (XSTRING (s1)->data, XSTRING (s2)->data, STRING_BYTES (XSTRING (s1))))
Jim Blandy's avatar
Jim Blandy committed
235 236 237 238
    return Qnil;
  return Qt;
}

239
DEFUN ("compare-strings", Fcompare_strings,
240
       Scompare_strings, 6, 7, 0,
241 242 243
  "Compare the contents of two strings, converting to multibyte if needed.\n\
In string STR1, skip the first START1 characters and stop at END1.\n\
In string STR2, skip the first START2 characters and stop at END2.\n\
244 245
END1 and END2 default to the full lengths of the respective strings.\n\
\n\
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
Case is significant in this comparison if IGNORE-CASE is nil.\n\
Unibyte strings are converted to multibyte for comparison.\n\
\n\
The value is t if the strings (or specified portions) match.\n\
If string STR1 is less, the value is a negative number N;\n\
  - 1 - N is the number of characters that match at the beginning.\n\
If string STR1 is greater, the value is a positive number N;\n\
  N - 1 is the number of characters that match at the beginning.")
  (str1, start1, end1, str2, start2, end2, ignore_case)
     Lisp_Object str1, start1, end1, start2, str2, end2, ignore_case;
{
  register int end1_char, end2_char;
  register int i1, i1_byte, i2, i2_byte;

  CHECK_STRING (str1, 0);
  CHECK_STRING (str2, 1);
  if (NILP (start1))
    start1 = make_number (0);
  if (NILP (start2))
    start2 = make_number (0);
  CHECK_NATNUM (start1, 2);
  CHECK_NATNUM (start2, 3);
  if (! NILP (end1))
    CHECK_NATNUM (end1, 4);
  if (! NILP (end2))
    CHECK_NATNUM (end2, 4);

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

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

  end1_char = XSTRING (str1)->size;
  if (! NILP (end1) && end1_char > XINT (end1))
    end1_char = XINT (end1);

  end2_char = XSTRING (str2)->size;
  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))
294
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
295 296 297 298 299 300 301
      else
	{
	  c1 = XSTRING (str1)->data[i1++];
	  c1 = unibyte_char_to_multibyte (c1);
	}

      if (STRING_MULTIBYTE (str2))
302
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c2, str2, i2, i2_byte);
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
      else
	{
	  c2 = XSTRING (str2)->data[i2++];
	  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)
329
	return make_number (- i1 + XINT (start1));
330
      else
331
	return make_number (i1 - XINT (start1));
332 333 334 335 336 337 338 339 340 341
    }

  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
342
DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
343
  "Return t if first arg string is less than second in lexicographic order.\n\
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347 348 349
Case is significant.\n\
Symbols are also allowed; their print names are used instead.")
  (s1, s2)
     register Lisp_Object s1, s2;
{
  register int end;
350
  register int i1, i1_byte, i2, i2_byte;
Jim Blandy's avatar
Jim Blandy committed
351

352
  if (SYMBOLP (s1))
353
    XSETSTRING (s1, XSYMBOL (s1)->name);
354
  if (SYMBOLP (s2))
355
    XSETSTRING (s2, XSYMBOL (s2)->name);
Jim Blandy's avatar
Jim Blandy committed
356 357 358
  CHECK_STRING (s1, 0);
  CHECK_STRING (s2, 1);

359 360 361 362 363
  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
364

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

371 372
      FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
373 374 375

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
376
    }
377
  return i1 < XSTRING (s2)->size ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
}

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
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
/* 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
413 414 415 416
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
417
The last argument is not copied, just used as the tail of the new list.")
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425 426 427
  (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\
Dave Love's avatar
Dave Love committed
428
Each argument may be a string or a list or vector of characters (integers).")
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  (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;
{
444
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
445 446
}

447 448 449 450
/* 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)
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 470 471 472 473 474 475
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
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 += STRING_BYTES (XSTRING (this));
646 647 648 649
		}
	      else
		result_len_byte += count_size_as_multibyte (XSTRING (this)->data,
							    XSTRING (this)->size);
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 = STRING_BYTES (XSTRING (this));
700 701
	  int combined;

702
	  bcopy (XSTRING (this)->data, XSTRING (val)->data + toindex_byte,
703
		 STRING_BYTES (XSTRING (this)));
704 705 706 707 708 709 710
	  combined =  (some_multibyte && toindex_byte > 0
		       ? count_combining (XSTRING (val)->data,
					  toindex_byte + thislen_byte,
					  toindex_byte)
		       : 0);
	  if (! NULL_INTERVAL_P (XSTRING (this)->intervals))
	    {
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 718
	  toindex += thisleni - combined;
	  XSTRING (val)->size -= combined;
719
	}
720 721 722
      /* Copy a single-byte string to a multibyte string.  */
      else if (STRINGP (this) && STRINGP (val))
	{
723 724
	  if (! NULL_INTERVAL_P (XSTRING (this)->intervals))
	    {
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 732 733
	  toindex_byte += copy_text (XSTRING (this)->data,
				     XSTRING (val)->data + toindex_byte,
				     XSTRING (this)->size, 0, 1);
	  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, XSTRING (this)->data[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
		XCAR (tail) = elt;
788
		prev = tail;
789
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
790
	      }
791 792 793 794 795 796 797
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
		CHECK_NUMBER (elt, 0);
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
798 799 800 801 802 803
		    if (some_multibyte)
		      toindex_byte
			+= CHAR_STRING (XINT (elt),
					XSTRING (val)->data + toindex_byte);
		    else
		      XSTRING (val)->data[toindex_byte++] = XINT (elt);
804 805
		    if (some_multibyte
			&& toindex_byte > 0
806 807 808 809 810
			&& count_combining (XSTRING (val)->data,
					    toindex_byte, toindex_byte - 1))
		      XSTRING (val)->size--;
		    else
		      toindex++;
811 812 813 814 815 816 817 818 819
		  }
		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.  */
		    unsigned char *p = & XSTRING (val)->data[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
    XCDR (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 840 841 842 843
	  props = text_property_list (this,
				      make_number (0),
				      make_number (XSTRING (this)->size),
				      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 + XSTRING (this)->size;
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 879
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
880
  best_above_byte = STRING_BYTES (XSTRING (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 912 913 914 915 916 917 918 919 920 921 922
	  unsigned char *pend = XSTRING (string)->data + best_above_byte;
	  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 952
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
953
  best_above_byte = STRING_BYTES (XSTRING (string));
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973

  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;
974 975
	  FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
					      best_below, best_below_byte);
976 977 978 979 980
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
981
    {
982 983
      while (best_above_byte > byte_index)
	{
984 985 986 987 988 989 990 991 992 993 994 995
	  unsigned char *pend = XSTRING (string)->data + best_above_byte;
	  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
996 997 998 999 1000
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
1001 1002
    }

1003 1004 1005 1006
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

1007 1008
  return i;
}
1009

1010
/* Convert STRING to a multibyte string.
1011
   Single-byte characters 0240 through 0377 are converted
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
   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);
1026 1027
  /* If all the chars are ASCII, they won't need any more bytes
     once converted.  In that case, we can return STRING itself.  */
1028
  if (nbytes == STRING_BYTES (XSTRING (string)))
1029 1030
    return string;

1031
  buf = (unsigned char *) alloca (nbytes);
1032
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
	     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);

1051
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1052 1053 1054 1055
	     1, 0);

  return make_unibyte_string (buf, XSTRING (string)->size);
}
1056 1057 1058

DEFUN ("string-make-multibyte", Fstring_make_multibyte, Sstring_make_multibyte,
       1, 1, 0,
1059 1060 1061
  "Return the multibyte equivalent of STRING.\n\
The function `unibyte-char-to-multibyte' is used to convert\n\
each unibyte character to a multibyte character.")
1062 1063 1064
  (string)
     Lisp_Object string;
{
1065 1066
  CHECK_STRING (string, 0);

1067 1068 1069 1070 1071
  return string_make_multibyte (string);
}

DEFUN ("string-make-unibyte", Fstring_make_unibyte, Sstring_make_unibyte,
       1, 1, 0,
1072 1073 1074
  "Return the unibyte equivalent of STRING.\n\
Multibyte character codes are converted to unibyte\n\
by using just the low 8 bits.")
1075 1076 1077
  (string)
     Lisp_Object string;
{
1078 1079
  CHECK_STRING (string, 0);

1080 1081
  return string_make_unibyte (string);
}
1082 1083 1084 1085

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\
1086
If STRING is unibyte, the result is STRING itself.\n\
1087
Otherwise it is a newly created string, with no text properties.\n\
1088 1089 1090
If STRING is multibyte and contains a character of charset\n\
`eight-bit-control' or `eight-bit-graphic', it is converted to the\n\
corresponding single byte.")
1091 1092 1093
  (string)
     Lisp_Object string;
{
1094 1095
  CHECK_STRING (string, 0);

1096 1097
  if (STRING_MULTIBYTE (string))
    {
1098 1099 1100 1101 1102 1103 1104
      int bytes = STRING_BYTES (XSTRING (string));
      unsigned char *str = (unsigned char *) xmalloc (bytes);

      bcopy (XSTRING (string)->data, str, bytes);
      bytes = str_as_unibyte (str, bytes);
      string = make_unibyte_string (str, bytes);
      xfree (str);
1105 1106 1107 1108 1109