fns.c 156 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,
4
                 2005, 2006 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
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

30 31
#ifndef MAC_OS
/* On Mac OS, defining this conflicts with precompiled headers.  */
32

Jim Blandy's avatar
Jim Blandy committed
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 *****
37 38 39

#endif  /* ! MAC_OSX */

Jim Blandy's avatar
Jim Blandy committed
40 41
#include "lisp.h"
#include "commands.h"
42
#include "charset.h"
43
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
44
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
45
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
46
#include "keymap.h"
47
#include "intervals.h"
48 49
#include "frame.h"
#include "window.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
50
#include "blockinput.h"
51 52
#ifdef HAVE_MENUS
#if defined (HAVE_X_WINDOWS)
Andreas Schwab's avatar
Andreas Schwab committed
53
#include "xterm.h"
54 55 56
#elif defined (MAC_OS)
#include "macterm.h"
#endif
Andreas Schwab's avatar
Andreas Schwab committed
57
#endif
Jim Blandy's avatar
Jim Blandy committed
58

Karl Heuer's avatar
Karl Heuer committed
59
#ifndef NULL
60
#define NULL ((POINTER_TYPE *)0)
Karl Heuer's avatar
Karl Heuer committed
61 62
#endif

63 64 65 66
/* Nonzero enables use of dialog boxes for questions
   asked by mouse commands.  */
int use_dialog_box;

67 68 69 70
/* Nonzero enables use of a file dialog for file name
   questions asked by mouse commands.  */
int use_file_dialog;

71 72
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;
73
extern Lisp_Object Vlocale_coding_system;
74
extern int load_in_progress;
75

76
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
77
Lisp_Object Qyes_or_no_p_history;
78
Lisp_Object Qcursor_in_echo_area;
Karl Heuer's avatar
Karl Heuer committed
79
Lisp_Object Qwidget_type;
80
Lisp_Object Qcodeset, Qdays, Qmonths, Qpaper;
Jim Blandy's avatar
Jim Blandy committed
81

82 83
extern Lisp_Object Qinput_method_function;

84
static int internal_equal P_ ((Lisp_Object , Lisp_Object, int, int));
85 86

extern long get_random ();
87
extern void seed_random P_ ((long));
88 89 90 91

#ifndef HAVE_UNISTD_H
extern long time ();
#endif
92

Jim Blandy's avatar
Jim Blandy committed
93
DEFUN ("identity", Fidentity, Sidentity, 1, 1, 0,
Pavel Janík's avatar
Pavel Janík committed
94
       doc: /* Return the argument unchanged.  */)
95
     (arg)
Jim Blandy's avatar
Jim Blandy committed
96 97 98 99 100 101
     Lisp_Object arg;
{
  return arg;
}

DEFUN ("random", Frandom, Srandom, 0, 1, 0,
102
       doc: /* Return a pseudo-random number.
Gerd Moellmann's avatar
Gerd Moellmann committed
103
All integers representable in Lisp are equally likely.
104
  On most systems, this is 29 bits' worth.
Gerd Moellmann's avatar
Gerd Moellmann committed
105
With positive integer argument N, return random number in interval [0,N).
106 107
With argument t, set the random number seed from the current time and pid. */)
     (n)
108
     Lisp_Object n;
Jim Blandy's avatar
Jim Blandy committed
109
{
110 111
  EMACS_INT val;
  Lisp_Object lispy_val;
112
  unsigned long denominator;
Jim Blandy's avatar
Jim Blandy committed
113

114
  if (EQ (n, Qt))
115
    seed_random (getpid () + time (NULL));
116
  if (NATNUMP (n) && XFASTINT (n) != 0)
Jim Blandy's avatar
Jim Blandy committed
117
    {
118 119 120 121
      /* 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
122
	 it's possible to get a quotient larger than n; discarding
123
	 these values eliminates the bias that would otherwise appear
124 125
	 when using a large n.  */
      denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
126
      do
127
	val = get_random () / denominator;
128
      while (val >= XFASTINT (n));
Jim Blandy's avatar
Jim Blandy committed
129
    }
130
  else
131
    val = get_random ();
132 133
  XSETINT (lispy_val, val);
  return lispy_val;
Jim Blandy's avatar
Jim Blandy committed
134 135 136 137 138
}

/* Random data-structure functions */

DEFUN ("length", Flength, Slength, 1, 1, 0,
139
       doc: /* Return the length of vector, list or string SEQUENCE.
Gerd Moellmann's avatar
Gerd Moellmann committed
140
A byte-code function object is also allowed.
John Paul Wallington's avatar
John Paul Wallington committed
141
If the string contains multibyte characters, this is not necessarily
Gerd Moellmann's avatar
Gerd Moellmann committed
142
the number of bytes in the string; it is the number of characters.
143 144
To get the number of bytes, use `string-bytes'. */)
     (sequence)
145
     register Lisp_Object sequence;
Jim Blandy's avatar
Jim Blandy committed
146
{
147
  register Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
148 149
  register int i;

150
  if (STRINGP (sequence))
151
    XSETFASTINT (val, SCHARS (sequence));
152 153
  else if (VECTORP (sequence))
    XSETFASTINT (val, XVECTOR (sequence)->size);
154 155
  else if (SUB_CHAR_TABLE_P (sequence))
    XSETFASTINT (val, SUB_CHAR_TABLE_ORDINARY_SLOTS);
156
  else if (CHAR_TABLE_P (sequence))
157
    XSETFASTINT (val, MAX_CHAR);
158 159 160 161 162
  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
163
    {
164 165
      i = 0;
      while (CONSP (sequence))
Jim Blandy's avatar
Jim Blandy committed
166
	{
167
	  sequence = XCDR (sequence);
168 169 170 171 172 173 174 175
	  ++i;

	  if (!CONSP (sequence))
	    break;

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

178
      CHECK_LIST_END (sequence, sequence);
179 180

      val = make_number (i);
Jim Blandy's avatar
Jim Blandy committed
181
    }
182
  else if (NILP (sequence))
183
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
184
  else
185
    wrong_type_argument (Qsequencep, sequence);
186

187
  return val;
Jim Blandy's avatar
Jim Blandy committed
188 189
}

190
/* This does not check for quits.  That is safe since it must terminate.  */
191 192

DEFUN ("safe-length", Fsafe_length, Ssafe_length, 1, 1, 0,
193
       doc: /* Return the length of a list, but avoid error or infinite loop.
Gerd Moellmann's avatar
Gerd Moellmann committed
194 195
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
196 197
which is at least the number of distinct elements. */)
     (list)
198 199 200 201 202 203 204
     Lisp_Object list;
{
  Lisp_Object tail, halftail, length;
  int len = 0;

  /* halftail is used to detect circular lists.  */
  halftail = list;
205
  for (tail = list; CONSP (tail); tail = XCDR (tail))
206 207
    {
      if (EQ (tail, halftail) && len != 0)
208
	break;
209
      len++;
210
      if ((len & 1) == 0)
211
	halftail = XCDR (halftail);
212 213 214 215 216 217
    }

  XSETINT (length, len);
  return length;
}

218
DEFUN ("string-bytes", Fstring_bytes, Sstring_bytes, 1, 1, 0,
219 220 221
       doc: /* Return the number of bytes in STRING.
If STRING is a multibyte string, this is greater than the length of STRING. */)
     (string)
222
     Lisp_Object string;
223
{
224
  CHECK_STRING (string);
225
  return make_number (SBYTES (string));
226 227
}

Jim Blandy's avatar
Jim Blandy committed
228
DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
229
       doc: /* Return t if two strings have identical contents.
Gerd Moellmann's avatar
Gerd Moellmann committed
230
Case is significant, but text properties are ignored.
231 232
Symbols are also allowed; their print names are used instead. */)
     (s1, s2)
Jim Blandy's avatar
Jim Blandy committed
233 234
     register Lisp_Object s1, s2;
{
235
  if (SYMBOLP (s1))
236
    s1 = SYMBOL_NAME (s1);
237
  if (SYMBOLP (s2))
238
    s2 = SYMBOL_NAME (s2);
239 240
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
241

242 243 244
  if (SCHARS (s1) != SCHARS (s2)
      || SBYTES (s1) != SBYTES (s2)
      || bcmp (SDATA (s1), SDATA (s2), SBYTES (s1)))
Jim Blandy's avatar
Jim Blandy committed
245 246 247 248
    return Qnil;
  return Qt;
}

249
DEFUN ("compare-strings", Fcompare_strings,
250
       Scompare_strings, 6, 7, 0,
251
doc: /* Compare the contents of two strings, converting to multibyte if needed.
Gerd Moellmann's avatar
Gerd Moellmann committed
252 253 254 255 256 257 258 259 260 261 262
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;
263 264
  N - 1 is the number of characters that match at the beginning. */)
     (str1, start1, end1, str2, start2, end2, ignore_case)
265 266 267 268 269
     Lisp_Object str1, start1, end1, start2, str2, end2, ignore_case;
{
  register int end1_char, end2_char;
  register int i1, i1_byte, i2, i2_byte;

270 271
  CHECK_STRING (str1);
  CHECK_STRING (str2);
272 273 274 275
  if (NILP (start1))
    start1 = make_number (0);
  if (NILP (start2))
    start2 = make_number (0);
276 277
  CHECK_NATNUM (start1);
  CHECK_NATNUM (start2);
278
  if (! NILP (end1))
279
    CHECK_NATNUM (end1);
280
  if (! NILP (end2))
281
    CHECK_NATNUM (end2);
282 283 284 285 286 287 288

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

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

289
  end1_char = SCHARS (str1);
290 291 292
  if (! NILP (end1) && end1_char > XINT (end1))
    end1_char = XINT (end1);

293
  end2_char = SCHARS (str2);
294 295 296 297 298 299 300 301 302 303
  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))
304
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
305 306
      else
	{
307
	  c1 = SREF (str1, i1++);
308 309 310 311
	  c1 = unibyte_char_to_multibyte (c1);
	}

      if (STRING_MULTIBYTE (str2))
312
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c2, str2, i2, i2_byte);
313 314
      else
	{
315
	  c2 = SREF (str2, i2++);
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
	  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)
339
	return make_number (- i1 + XINT (start1));
340
      else
341
	return make_number (i1 - XINT (start1));
342 343 344 345 346 347 348 349 350 351
    }

  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
352
DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
353
       doc: /* Return t if first arg string is less than second in lexicographic order.
Gerd Moellmann's avatar
Gerd Moellmann committed
354
Case is significant.
355 356
Symbols are also allowed; their print names are used instead. */)
     (s1, s2)
Jim Blandy's avatar
Jim Blandy committed
357 358 359
     register Lisp_Object s1, s2;
{
  register int end;
360
  register int i1, i1_byte, i2, i2_byte;
Jim Blandy's avatar
Jim Blandy committed
361

362
  if (SYMBOLP (s1))
363
    s1 = SYMBOL_NAME (s1);
364
  if (SYMBOLP (s2))
365
    s2 = SYMBOL_NAME (s2);
366 367
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
368

369 370
  i1 = i1_byte = i2 = i2_byte = 0;

371 372 373
  end = SCHARS (s1);
  if (end > SCHARS (s2))
    end = SCHARS (s2);
Jim Blandy's avatar
Jim Blandy committed
374

375
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
376
    {
377 378 379 380
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

381 382
      FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
383 384 385

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
386
    }
387
  return i1 < SCHARS (s2) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
388 389
}

390 391 392 393 394 395
#if __GNUC__
/* "gcc -O3" enables automatic function inlining, which optimizes out
   the arguments for the invocations of this function, whereas it
   expects these values on the stack.  */
static Lisp_Object concat () __attribute__((noinline));
#endif
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

/* 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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/* 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
428
DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
429
       doc: /* Concatenate all the arguments and make the result a list.
Gerd Moellmann's avatar
Gerd Moellmann committed
430 431
The result is a list whose elements are the elements of all the arguments.
Each argument may be a list, vector or string.
432 433
The last argument is not copied, just used as the tail of the new list.
usage: (append &rest SEQUENCES)  */)
434
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
435 436 437 438 439 440 441
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_Cons, 1);
}

DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
442
       doc: /* Concatenate all the arguments and make the result a string.
Gerd Moellmann's avatar
Gerd Moellmann committed
443
The result is a string whose elements are the elements of all the arguments.
444 445
Each argument may be a string or a list or vector of characters (integers).
usage: (concat &rest SEQUENCES)  */)
446
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452 453
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_String, 0);
}

DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
454
       doc: /* Concatenate all the arguments and make the result a vector.
Gerd Moellmann's avatar
Gerd Moellmann committed
455
The result is a vector whose elements are the elements of all the arguments.
456 457
Each argument may be a list, vector or string.
usage: (vconcat &rest SEQUENCES)   */)
458
     (nargs, args)
Jim Blandy's avatar
Jim Blandy committed
459 460 461
     int nargs;
     Lisp_Object *args;
{
462
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
463 464
}

John Paul Wallington's avatar
John Paul Wallington committed
465
/* Return a copy of a sub char table ARG.  The elements except for a
466 467 468
   nested sub char table are not copied.  */
static Lisp_Object
copy_sub_char_table (arg)
469
     Lisp_Object arg;
470
{
471
  Lisp_Object copy = make_sub_char_table (Qnil);
472 473
  int i;

474
  XCHAR_TABLE (copy)->defalt = XCHAR_TABLE (arg)->defalt;
475 476 477 478 479 480 481 482 483 484 485 486 487
  /* 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
488
DEFUN ("copy-sequence", Fcopy_sequence, Scopy_sequence, 1, 1, 0,
Dave Love's avatar
Dave Love committed
489
       doc: /* Return a copy of a list, vector, string or char-table.
Gerd Moellmann's avatar
Gerd Moellmann committed
490
The elements of a list or vector are not copied; they are shared
491 492
with the original. */)
     (arg)
Jim Blandy's avatar
Jim Blandy committed
493 494
     Lisp_Object arg;
{
Jim Blandy's avatar
Jim Blandy committed
495
  if (NILP (arg)) return arg;
496 497 498

  if (CHAR_TABLE_P (arg))
    {
499
      int i;
500 501
      Lisp_Object copy;

502
      copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
503
      /* Copy all the slots, including the extra ones.  */
504
      bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
505 506
	     ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
	      * sizeof (Lisp_Object)));
507

508 509 510 511 512
      /* 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]))
513
	  XCHAR_TABLE (copy)->contents[i]
514
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
515 516 517 518 519 520 521 522

      return copy;
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
523 524
	= ((XBOOL_VECTOR (arg)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
	   / BOOL_VECTOR_BITS_PER_CHAR);
525 526 527 528 529 530 531

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

532
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
533 534
    wrong_type_argument (Qsequencep, arg);

Jim Blandy's avatar
Jim Blandy committed
535 536 537
  return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
}

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;
Kim F. Storm's avatar
Kim F. Storm committed
573
  USE_SAFE_ALLOCA;
Jim Blandy's avatar
Jim Blandy committed
574

575 576
  tail = Qnil;

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

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

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

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

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
651 652
    }

653 654
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
655

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

666 667 668
  /* 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
669

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

  prev = Qnil;
677
  if (STRINGP (val))
Kim F. Storm's avatar
Kim F. Storm committed
678
    SAFE_ALLOCA (textprops, struct textprop_rec *, sizeof (struct textprop_rec) * nargs);
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
683
      int thisleni = 0;
684
      register unsigned int thisindex = 0;
685
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689 690

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

691 692 693
      /* 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
694
	{
695
	  int thislen_byte = SBYTES (this);
696

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

773 774
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
775
	      {
776
		XSETCAR (tail, elt);
777
		prev = tail;
778
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
779
	      }
780 781 782 783
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
784
		CHECK_NUMBER (elt);
785 786
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
787 788 789
		    if (some_multibyte)
		      toindex_byte
			+= CHAR_STRING (XINT (elt),
790
					SDATA (val) + toindex_byte);
791
		    else
Ken Raeburn's avatar
Ken Raeburn committed
792
		      SSET (val, toindex_byte++, XINT (elt));
Kenichi Handa's avatar
Kenichi Handa committed
793
		    toindex++;
794 795 796 797 798 799 800 801
		  }
		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
802
		    unsigned char *p = SDATA (val) + toindex_byte;
803 804

		    toindex_byte += CHAR_STRING (c, p);
805 806 807 808
		    toindex++;
		  }
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
809
    }
Jim Blandy's avatar
Jim Blandy committed
810
  if (!NILP (prev))
811
    XSETCDR (prev, last_tail);
Jim Blandy's avatar
Jim Blandy committed
812

Kenichi Handa's avatar
Kenichi Handa committed
813
  if (num_textprops > 0)
814
    {
815
      Lisp_Object props;
816
      int last_to_end = -1;
817

Kenichi Handa's avatar
Kenichi Handa committed
818
      for (argnum = 0; argnum < num_textprops; argnum++)
819
	{
Kenichi Handa's avatar
Kenichi Handa committed
820
	  this = args[textprops[argnum].argnum];
821 822
	  props = text_property_list (this,
				      make_number (0),
823
				      make_number (SCHARS (this)),
824 825 826
				      Qnil);
	  /* If successive arguments have properites, be sure that the
	     value of `composition' property be the copy.  */
827
	  if (last_to_end == textprops[argnum].to)
828 829 830
	    make_composition_value_copy (props);
	  add_text_properties_from_list (val, props,
					 make_number (textprops[argnum].to));
831
	  last_to_end = textprops[argnum].to + SCHARS (this);
832 833
	}
    }
Kim F. Storm's avatar
Kim F. Storm committed
834 835

  SAFE_FREE ();
Karl Heuer's avatar
Karl Heuer committed
836
  return val;
Jim Blandy's avatar
Jim Blandy committed
837 838
}

839 840 841 842
static Lisp_Object string_char_byte_cache_string;
static int string_char_byte_cache_charpos;
static int string_char_byte_cache_bytepos;

843 844 845 846 847 848
void
clear_string_char_byte_cache ()
{
  string_char_byte_cache_string = Qnil;
}

849 850 851 852 853 854 855
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
856 857 858
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
859

860
  best_below = best_below_byte = 0;
861 862
  best_above = SCHARS (string);
  best_above_byte = SBYTES (string);
863 864
  if (best_above == best_above_byte)
    return char_index;
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

  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;
885 886
	  FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
					      best_below, best_below_byte);
887 888 889 890 891
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
892
    {
893 894
      while (best_above > char_index)
	{
895
	  unsigned char *pend = SDATA (string) + best_above_byte;
896 897 898 899 900 901 902 903 904 905 906
	  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
907 908 909 910 911
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
912 913
    }

914 915 916 917
  string_char_byte_cache_bytepos = i_byte;