fns.c 136 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Random utility Lisp functions.
2 3
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Juanma Barranquero's avatar
Juanma Barranquero committed
4 5
                 2005, 2006, 2007, 2008, 2009, 2010
		 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
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>
28
#include <setjmp.h>
Andreas Schwab's avatar
Andreas Schwab committed
29

Jim Blandy's avatar
Jim Blandy committed
30 31 32 33
/* 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 *****
34

Jim Blandy's avatar
Jim Blandy committed
35 36
#include "lisp.h"
#include "commands.h"
37
#include "character.h"
38
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
39
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
41
#include "keymap.h"
42
#include "intervals.h"
43 44
#include "frame.h"
#include "window.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
45
#include "blockinput.h"
46 47
#ifdef HAVE_MENUS
#if defined (HAVE_X_WINDOWS)
Andreas Schwab's avatar
Andreas Schwab committed
48 49
#include "xterm.h"
#endif
50
#endif /* HAVE_MENUS */
Jim Blandy's avatar
Jim Blandy committed
51

Karl Heuer's avatar
Karl Heuer committed
52
#ifndef NULL
53
#define NULL ((POINTER_TYPE *)0)
Karl Heuer's avatar
Karl Heuer committed
54 55
#endif

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

Kenichi Handa's avatar
Kenichi Handa committed
60 61 62 63
/* Nonzero enables use of a file dialog for file name
   questions asked by mouse commands.  */
int use_file_dialog;

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;
68
Lisp_Object Qcodeset, Qdays, Qmonths, Qpaper;
Jim Blandy's avatar
Jim Blandy committed
69

70
static int internal_equal (Lisp_Object , Lisp_Object, int, int);
71

72
extern long get_random (void);
73
extern void seed_random (long);
74 75 76 77

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

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

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

DEFUN ("length", Flength, Slength, 1, 1, 0,
124
       doc: /* Return the length of vector, list or string SEQUENCE.
Gerd Moellmann's avatar
Gerd Moellmann committed
125
A byte-code function object is also allowed.
John Paul Wallington's avatar
John Paul Wallington committed
126
If the string contains multibyte characters, this is not necessarily
Gerd Moellmann's avatar
Gerd Moellmann committed
127
the number of bytes in the string; it is the number of characters.
128
To get the number of bytes, use `string-bytes'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
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
  register int i;

134
  if (STRINGP (sequence))
135
    XSETFASTINT (val, SCHARS (sequence));
136
  else if (VECTORP (sequence))
Stefan Monnier's avatar
Stefan Monnier committed
137
    XSETFASTINT (val, ASIZE (sequence));
138
  else if (CHAR_TABLE_P (sequence))
139
    XSETFASTINT (val, MAX_CHAR);
140 141 142
  else if (BOOL_VECTOR_P (sequence))
    XSETFASTINT (val, XBOOL_VECTOR (sequence)->size);
  else if (COMPILEDP (sequence))
Stefan Monnier's avatar
Stefan Monnier committed
143
    XSETFASTINT (val, ASIZE (sequence) & PSEUDOVECTOR_SIZE_MASK);
144
  else if (CONSP (sequence))
Jim Blandy's avatar
Jim Blandy committed
145
    {
146 147
      i = 0;
      while (CONSP (sequence))
Jim Blandy's avatar
Jim Blandy committed
148
	{
149
	  sequence = XCDR (sequence);
150 151 152 153 154 155 156 157
	  ++i;

	  if (!CONSP (sequence))
	    break;

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

160
      CHECK_LIST_END (sequence, sequence);
161 162

      val = make_number (i);
Jim Blandy's avatar
Jim Blandy committed
163
    }
164
  else if (NILP (sequence))
165
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
166
  else
167
    wrong_type_argument (Qsequencep, sequence);
168

169
  return val;
Jim Blandy's avatar
Jim Blandy committed
170 171
}

172
/* This does not check for quits.  That is safe since it must terminate.  */
173 174

DEFUN ("safe-length", Fsafe_length, Ssafe_length, 1, 1, 0,
175
       doc: /* Return the length of a list, but avoid error or infinite loop.
Gerd Moellmann's avatar
Gerd Moellmann committed
176 177
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
178
which is at least the number of distinct elements.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
179
  (Lisp_Object list)
180 181 182 183 184 185
{
  Lisp_Object tail, halftail, length;
  int len = 0;

  /* halftail is used to detect circular lists.  */
  halftail = list;
186
  for (tail = list; CONSP (tail); tail = XCDR (tail))
187 188
    {
      if (EQ (tail, halftail) && len != 0)
189
	break;
190
      len++;
191
      if ((len & 1) == 0)
192
	halftail = XCDR (halftail);
193 194 195 196 197 198
    }

  XSETINT (length, len);
  return length;
}

199
DEFUN ("string-bytes", Fstring_bytes, Sstring_bytes, 1, 1, 0,
200
       doc: /* Return the number of bytes in STRING.
Miles Bader's avatar
Miles Bader committed
201
If STRING is multibyte, this may be greater than the length of STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
202
  (Lisp_Object string)
203
{
204
  CHECK_STRING (string);
205
  return make_number (SBYTES (string));
206 207
}

Jim Blandy's avatar
Jim Blandy committed
208
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
209
       doc: /* Return t if two strings have identical contents.
Gerd Moellmann's avatar
Gerd Moellmann committed
210
Case is significant, but text properties are ignored.
211
Symbols are also allowed; their print names are used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
212
  (register Lisp_Object s1, Lisp_Object s2)
Jim Blandy's avatar
Jim Blandy committed
213
{
214
  if (SYMBOLP (s1))
215
    s1 = SYMBOL_NAME (s1);
216
  if (SYMBOLP (s2))
217
    s2 = SYMBOL_NAME (s2);
218 219
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
220

221 222
  if (SCHARS (s1) != SCHARS (s2)
      || SBYTES (s1) != SBYTES (s2)
223
      || memcmp (SDATA (s1), SDATA (s2), SBYTES (s1)))
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227
    return Qnil;
  return Qt;
}

228
DEFUN ("compare-strings", Fcompare_strings,
229
       Scompare_strings, 6, 7, 0,
230
doc: /* Compare the contents of two strings, converting to multibyte if needed.
Gerd Moellmann's avatar
Gerd Moellmann committed
231 232 233 234 235 236 237 238 239 240 241
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;
242
  N - 1 is the number of characters that match at the beginning.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
243
  (Lisp_Object str1, Lisp_Object start1, Lisp_Object end1, Lisp_Object str2, Lisp_Object start2, Lisp_Object end2, Lisp_Object ignore_case)
244 245 246 247
{
  register int end1_char, end2_char;
  register int i1, i1_byte, i2, i2_byte;

248 249
  CHECK_STRING (str1);
  CHECK_STRING (str2);
250 251 252 253
  if (NILP (start1))
    start1 = make_number (0);
  if (NILP (start2))
    start2 = make_number (0);
254 255
  CHECK_NATNUM (start1);
  CHECK_NATNUM (start2);
256
  if (! NILP (end1))
257
    CHECK_NATNUM (end1);
258
  if (! NILP (end2))
259
    CHECK_NATNUM (end2);
260 261 262 263 264 265 266

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

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

267
  end1_char = SCHARS (str1);
268 269 270
  if (! NILP (end1) && end1_char > XINT (end1))
    end1_char = XINT (end1);

271
  end2_char = SCHARS (str2);
272 273 274 275 276 277 278 279 280 281
  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))
282
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
283 284
      else
	{
285
	  c1 = SREF (str1, i1++);
286
	  MAKE_CHAR_MULTIBYTE (c1);
287 288 289
	}

      if (STRING_MULTIBYTE (str2))
290
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c2, str2, i2, i2_byte);
291 292
      else
	{
293
	  c2 = SREF (str2, i2++);
294
	  MAKE_CHAR_MULTIBYTE (c2);
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	}

      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)
317
	return make_number (- i1 + XINT (start1));
318
      else
319
	return make_number (i1 - XINT (start1));
320 321 322 323 324 325 326 327 328 329
    }

  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
330
DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
331
       doc: /* Return t if first arg string is less than second in lexicographic order.
Gerd Moellmann's avatar
Gerd Moellmann committed
332
Case is significant.
333
Symbols are also allowed; their print names are used instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
334
  (register Lisp_Object s1, Lisp_Object s2)
Jim Blandy's avatar
Jim Blandy committed
335 336
{
  register int end;
337
  register int i1, i1_byte, i2, i2_byte;
Jim Blandy's avatar
Jim Blandy committed
338

339
  if (SYMBOLP (s1))
340
    s1 = SYMBOL_NAME (s1);
341
  if (SYMBOLP (s2))
342
    s2 = SYMBOL_NAME (s2);
343 344
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
345

346 347
  i1 = i1_byte = i2 = i2_byte = 0;

348 349 350
  end = SCHARS (s1);
  if (end > SCHARS (s2))
    end = SCHARS (s2);
Jim Blandy's avatar
Jim Blandy committed
351

352
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
353
    {
354 355 356 357
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

358 359
      FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
360 361 362

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
363
    }
364
  return i1 < SCHARS (s2) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
365 366
}

367 368
static Lisp_Object concat (int nargs, Lisp_Object *args,
			   enum Lisp_Type target_type, int last_special);
Jim Blandy's avatar
Jim Blandy committed
369 370 371

/* ARGSUSED */
Lisp_Object
372
concat2 (Lisp_Object s1, Lisp_Object s2)
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376 377 378 379
{
  Lisp_Object args[2];
  args[0] = s1;
  args[1] = s2;
  return concat (2, args, Lisp_String, 0);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
380 381
/* ARGSUSED */
Lisp_Object
382
concat3 (Lisp_Object s1, Lisp_Object s2, Lisp_Object s3)
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385 386 387 388 389 390
{
  Lisp_Object args[3];
  args[0] = s1;
  args[1] = s2;
  args[2] = s3;
  return concat (3, args, Lisp_String, 0);
}

Jim Blandy's avatar
Jim Blandy committed
391
DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
392
       doc: /* Concatenate all the arguments and make the result a list.
Gerd Moellmann's avatar
Gerd Moellmann committed
393 394
The result is a list whose elements are the elements of all the arguments.
Each argument may be a list, vector or string.
395 396
The last argument is not copied, just used as the tail of the new list.
usage: (append &rest SEQUENCES)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (int nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402
{
  return concat (nargs, args, Lisp_Cons, 1);
}

DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
403
       doc: /* Concatenate all the arguments and make the result a string.
Gerd Moellmann's avatar
Gerd Moellmann committed
404
The result is a string whose elements are the elements of all the arguments.
405 406
Each argument may be a string or a list or vector of characters (integers).
usage: (concat &rest SEQUENCES)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
407
  (int nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412
{
  return concat (nargs, args, Lisp_String, 0);
}

DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
413
       doc: /* Concatenate all the arguments and make the result a vector.
Gerd Moellmann's avatar
Gerd Moellmann committed
414
The result is a vector whose elements are the elements of all the arguments.
415 416
Each argument may be a list, vector or string.
usage: (vconcat &rest SEQUENCES)   */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
417
  (int nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
418
{
419
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
420 421
}

422

Jim Blandy's avatar
Jim Blandy committed
423
DEFUN ("copy-sequence", Fcopy_sequence, Scopy_sequence, 1, 1, 0,
Dave Love's avatar
Dave Love committed
424
       doc: /* Return a copy of a list, vector, string or char-table.
Gerd Moellmann's avatar
Gerd Moellmann committed
425
The elements of a list or vector are not copied; they are shared
426
with the original.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
427
  (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
428
{
Jim Blandy's avatar
Jim Blandy committed
429
  if (NILP (arg)) return arg;
430 431 432

  if (CHAR_TABLE_P (arg))
    {
433
      return copy_char_table (arg);
434 435 436 437 438 439
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
440 441
	= ((XBOOL_VECTOR (arg)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
	   / BOOL_VECTOR_BITS_PER_CHAR);
442 443

      val = Fmake_bool_vector (Flength (arg), Qnil);
444 445
      memcpy (XBOOL_VECTOR (val)->data, XBOOL_VECTOR (arg)->data,
	      size_in_chars);
446 447 448
      return val;
    }

449
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
450 451
    wrong_type_argument (Qsequencep, arg);

Jim Blandy's avatar
Jim Blandy committed
452 453 454
  return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
}

455 456
/* 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
457
struct textprop_rec
458 459 460 461 462 463
{
  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
464
static Lisp_Object
465
concat (int nargs, Lisp_Object *args, enum Lisp_Type target_type, int last_special)
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469 470
{
  Lisp_Object val;
  register Lisp_Object tail;
  register Lisp_Object this;
  int toindex;
471
  int toindex_byte = 0;
472 473
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
474 475 476
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
477
  int some_multibyte;
478 479 480 481 482
  /* 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.  */
483
  struct textprop_rec  *textprops = NULL;
Juanma Barranquero's avatar
Juanma Barranquero committed
484
  /* Number of elements in textprops.  */
Kenichi Handa's avatar
Kenichi Handa committed
485
  int num_textprops = 0;
Kim F. Storm's avatar
Kim F. Storm committed
486
  USE_SAFE_ALLOCA;
Jim Blandy's avatar
Jim Blandy committed
487

488 489
  tail = Qnil;

Jim Blandy's avatar
Jim Blandy committed
490 491 492 493 494 495 496 497 498
  /* 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;

499
  /* Check each argument.  */
Jim Blandy's avatar
Jim Blandy committed
500 501 502
  for (argnum = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
503
      if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
504
	    || COMPILEDP (this) || BOOL_VECTOR_P (this)))
505
	wrong_type_argument (Qsequencep, this);
Jim Blandy's avatar
Jim Blandy committed
506 507
    }

508 509 510 511 512 513 514 515
  /* 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
516
    {
517
      int len;
Jim Blandy's avatar
Jim Blandy committed
518
      this = args[argnum];
519 520
      len = XFASTINT (Flength (this));
      if (target_type == Lisp_String)
521
	{
522 523
	  /* We must count the number of bytes needed in the string
	     as well as the number of characters.  */
524 525
	  int i;
	  Lisp_Object ch;
526
	  int this_len_byte;
527

528
	  if (VECTORP (this))
529
	    for (i = 0; i < len; i++)
530
	      {
Stefan Monnier's avatar
Stefan Monnier committed
531
		ch = AREF (this, i);
Miles Bader's avatar
Miles Bader committed
532
		CHECK_CHARACTER (ch);
533
		this_len_byte = CHAR_BYTES (XINT (ch));
534
		result_len_byte += this_len_byte;
535
		if (! ASCII_CHAR_P (XINT (ch)) && ! CHAR_BYTE8_P (XINT (ch)))
536
		  some_multibyte = 1;
537
	      }
538 539
	  else if (BOOL_VECTOR_P (this) && XBOOL_VECTOR (this)->size > 0)
	    wrong_type_argument (Qintegerp, Faref (this, make_number (0)));
540
	  else if (CONSP (this))
541
	    for (; CONSP (this); this = XCDR (this))
542
	      {
543
		ch = XCAR (this);
Miles Bader's avatar
Miles Bader committed
544
		CHECK_CHARACTER (ch);
545
		this_len_byte = CHAR_BYTES (XINT (ch));
546
		result_len_byte += this_len_byte;
547
		if (! ASCII_CHAR_P (XINT (ch)) && ! CHAR_BYTE8_P (XINT (ch)))
548
		  some_multibyte = 1;
549
	      }
550
	  else if (STRINGP (this))
551
	    {
552
	      if (STRING_MULTIBYTE (this))
553 554
		{
		  some_multibyte = 1;
555
		  result_len_byte += SBYTES (this);
556 557
		}
	      else
558 559
		result_len_byte += count_size_as_multibyte (SDATA (this),
							    SCHARS (this));
560
	    }
561
	}
562 563

      result_len += len;
564 565
      if (result_len < 0)
	error ("String overflow");
Jim Blandy's avatar
Jim Blandy committed
566 567
    }

568 569
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
570

571
  /* Create the output object.  */
Jim Blandy's avatar
Jim Blandy committed
572
  if (target_type == Lisp_Cons)
573
    val = Fmake_list (make_number (result_len), Qnil);
574
  else if (target_type == Lisp_Vectorlike)
575
    val = Fmake_vector (make_number (result_len), Qnil);
576
  else if (some_multibyte)
577
    val = make_uninit_multibyte_string (result_len, result_len_byte);
578 579
  else
    val = make_uninit_string (result_len);
Jim Blandy's avatar
Jim Blandy committed
580

581 582 583
  /* 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
584

585
  /* Copy the contents of the args into the result.  */
Jim Blandy's avatar
Jim Blandy committed
586
  if (CONSP (val))
587
    tail = val, toindex = -1; /* -1 in toindex is flag we are making a list */
Jim Blandy's avatar
Jim Blandy committed
588
  else
589
    toindex = 0, toindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
590 591

  prev = Qnil;
592
  if (STRINGP (val))
Kim F. Storm's avatar
Kim F. Storm committed
593
    SAFE_ALLOCA (textprops, struct textprop_rec *, sizeof (struct textprop_rec) * nargs);
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
598
      int thisleni = 0;
599
      register unsigned int thisindex = 0;
600
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604 605

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

606 607 608
      /* 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
609
	{
610
	  int thislen_byte = SBYTES (this);
611

612
	  memcpy (SDATA (val) + toindex_byte, SDATA (this), SBYTES (this));
613
	  if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
614
	    {
Kenichi Handa's avatar
Kenichi Handa committed
615
	      textprops[num_textprops].argnum = argnum;
616
	      textprops[num_textprops].from = 0;
Kenichi Handa's avatar
Kenichi Handa committed
617
	      textprops[num_textprops++].to = toindex;
618
	    }
619
	  toindex_byte += thislen_byte;
620
	  toindex += thisleni;
621
	}
622 623 624
      /* Copy a single-byte string to a multibyte string.  */
      else if (STRINGP (this) && STRINGP (val))
	{
625
	  if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
626
	    {
Kenichi Handa's avatar
Kenichi Handa committed
627 628 629
	      textprops[num_textprops].argnum = argnum;
	      textprops[num_textprops].from = 0;
	      textprops[num_textprops++].to = toindex;
630
	    }
631 632 633
	  toindex_byte += copy_text (SDATA (this),
				     SDATA (val) + toindex_byte,
				     SCHARS (this), 0, 1);
634 635
	  toindex += thisleni;
	}
636 637 638 639 640 641 642 643 644 645
      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))
646
	      elt = XCAR (this), this = XCDR (this);
647 648 649
	    else if (thisindex >= thisleni)
	      break;
	    else if (STRINGP (this))
650
	      {
651
		int c;
652
		if (STRING_MULTIBYTE (this))
653
		  {
654 655 656
		    FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, this,
							thisindex,
							thisindex_byte);
657
		    XSETFASTINT (elt, c);
658
		  }
659
		else
660
		  {
661
		    XSETFASTINT (elt, SREF (this, thisindex)); thisindex++;
662
		    if (some_multibyte
663
			&& !ASCII_CHAR_P (XINT (elt))
664 665
			&& XINT (elt) < 0400)
		      {
666
			c = BYTE8_TO_CHAR (XINT (elt));
667 668
			XSETINT (elt, c);
		      }
669
		  }
670 671 672 673
	      }
	    else if (BOOL_VECTOR_P (this))
	      {
		int byte;
674 675
		byte = XBOOL_VECTOR (this)->data[thisindex / BOOL_VECTOR_BITS_PER_CHAR];
		if (byte & (1 << (thisindex % BOOL_VECTOR_BITS_PER_CHAR)))
676
		  elt = Qt;
677
		else
678 679
		  elt = Qnil;
		thisindex++;
680
	      }
681
	    else
682 683 684 685
	      {
		elt = AREF (this, thisindex);
		thisindex++;
	      }
Jim Blandy's avatar
Jim Blandy committed
686

687 688
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
689
	      {
690
		XSETCAR (tail, elt);
691
		prev = tail;
692
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
693
	      }
694
	    else if (VECTORP (val))
695 696 697 698
	      {
		ASET (val, toindex, elt);
		toindex++;
	      }
699 700
	    else
	      {
701
		CHECK_NUMBER (elt);
702
		if (some_multibyte)
Kenichi Handa's avatar
Kenichi Handa committed
703 704
		  toindex_byte += CHAR_STRING (XINT (elt),
					       SDATA (val) + toindex_byte);
705
		else
Kenichi Handa's avatar
Kenichi Handa committed
706
		  SSET (val, toindex_byte++, XINT (elt));
707
		toindex++;
708 709
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
710
    }
Jim Blandy's avatar
Jim Blandy committed
711
  if (!NILP (prev))
712
    XSETCDR (prev, last_tail);
Jim Blandy's avatar
Jim Blandy committed
713

Kenichi Handa's avatar
Kenichi Handa committed
714
  if (num_textprops > 0)
715
    {
716
      Lisp_Object props;
717
      int last_to_end = -1;
718

Kenichi Handa's avatar
Kenichi Handa committed
719
      for (argnum = 0; argnum < num_textprops; argnum++)
720
	{
Kenichi Handa's avatar
Kenichi Handa committed
721
	  this = args[textprops[argnum].argnum];
722 723
	  props = text_property_list (this,
				      make_number (0),
724
				      make_number (SCHARS (this)),
725 726 727
				      Qnil);
	  /* If successive arguments have properites, be sure that the
	     value of `composition' property be the copy.  */
728
	  if (last_to_end == textprops[argnum].to)
729 730 731
	    make_composition_value_copy (props);
	  add_text_properties_from_list (val, props,
					 make_number (textprops[argnum].to));
732
	  last_to_end = textprops[argnum].to + SCHARS (this);
733 734
	}
    }
Kim F. Storm's avatar
Kim F. Storm committed
735 736

  SAFE_FREE ();
Karl Heuer's avatar
Karl Heuer committed
737
  return val;
Jim Blandy's avatar
Jim Blandy committed
738 739
}

740
static Lisp_Object string_char_byte_cache_string;
741 742
static EMACS_INT string_char_byte_cache_charpos;
static EMACS_INT string_char_byte_cache_bytepos;
743

744
void
745
clear_string_char_byte_cache (void)
746 747 748 749
{
  string_char_byte_cache_string = Qnil;
}

750
/* Return the byte index corresponding to CHAR_INDEX in STRING.  */
751

752
EMACS_INT
753
string_char_to_byte (Lisp_Object string, EMACS_INT char_index)
754
{
755 756 757
  EMACS_INT i_byte;
  EMACS_INT best_below, best_below_byte;
  EMACS_INT best_above, best_above_byte;
758

759
  best_below = best_below_byte = 0;
760 761
  best_above = SCHARS (string);
  best_above_byte = SBYTES (string);
762 763
  if (best_above == best_above_byte)
    return char_index;
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780

  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)
    {
Kenichi Handa's avatar
Kenichi Handa committed
781
      unsigned char *p = SDATA (string) + best_below_byte;
782

783 784
      while (best_below < char_index)
	{
785 786
	  p += BYTES_BY_CHAR_HEAD (*p);
	  best_below++;
787
	}
Kenichi Handa's avatar
Kenichi Handa committed
788
      i_byte = p - SDATA (string);
789 790
    }
  else
791
    {
Kenichi Handa's avatar
Kenichi Handa committed
792
      unsigned char *p = SDATA (string) + best_above_byte;
793

794 795
      while (best_above > char_index)
	{
796 797
	  p--;
	  while (!CHAR_HEAD_P (*p)) p--;
798 799
	  best_above--;
	}
Kenichi Handa's avatar
Kenichi Handa committed
800
      i_byte = p - SDATA (string);
801 802
    }

803
  string_char_byte_cache_bytepos = i_byte;
804
  string_char_byte_cache_charpos = char_index;
805 806
  string_char_byte_cache_string = string;

807 808
  return i_byte;
}
809

810 811
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

812
EMACS_INT
813
string_byte_to_char (Lisp_Object string, EMACS_INT byte_index)