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

This file is part of GNU Emacs.

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

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

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

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

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

29 30 31
#ifndef MAC_OSX
/* On Mac OS X, defining this conflicts with precompiled headers.  */

Jim Blandy's avatar
Jim Blandy committed
32 33 34 35
/* 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 *****
36 37 38

#endif  /* ! MAC_OSX */

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

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

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

62 63
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;
64
extern Lisp_Object Vlocale_coding_system;
65

66
Lisp_Object Qstring_lessp, Qprovide, Qrequire;
67
Lisp_Object Qyes_or_no_p_history;
68
Lisp_Object Qcursor_in_echo_area;
Karl Heuer's avatar
Karl Heuer committed
69
Lisp_Object Qwidget_type;
70
Lisp_Object Qcodeset, Qdays, Qmonths, Qpaper;
Jim Blandy's avatar
Jim Blandy committed
71

72 73
extern Lisp_Object Qinput_method_function;

74
static int internal_equal ();
75 76 77 78 79 80 81

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

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

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

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

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

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

	  if (!CONSP (sequence))
	    break;

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

169 170 171 172
      if (!NILP (sequence))
	wrong_type_argument (Qlistp, sequence);

      val = make_number (i);
Jim Blandy's avatar
Jim Blandy committed
173
    }
174
  else if (NILP (sequence))
175
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
176 177
  else
    {
178
      sequence = wrong_type_argument (Qsequencep, sequence);
Jim Blandy's avatar
Jim Blandy committed
179 180
      goto retry;
    }
181
  return val;
Jim Blandy's avatar
Jim Blandy committed
182 183
}

184 185 186 187
/* This does not check for quits.  That is safe
   since it must terminate.  */

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

  /* halftail is used to detect circular lists.  */
  halftail = list;
200
  for (tail = list; CONSP (tail); tail = XCDR (tail))
201 202
    {
      if (EQ (tail, halftail) && len != 0)
203
	break;
204
      len++;
205
      if ((len & 1) == 0)
206
	halftail = XCDR (halftail);
207 208 209 210 211 212
    }

  XSETINT (length, len);
  return length;
}

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

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

237 238 239
  if (SCHARS (s1) != SCHARS (s2)
      || SBYTES (s1) != SBYTES (s2)
      || bcmp (SDATA (s1), SDATA (s2), SBYTES (s1)))
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243
    return Qnil;
  return Qt;
}

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

265 266
  CHECK_STRING (str1);
  CHECK_STRING (str2);
267 268 269 270
  if (NILP (start1))
    start1 = make_number (0);
  if (NILP (start2))
    start2 = make_number (0);
271 272
  CHECK_NATNUM (start1);
  CHECK_NATNUM (start2);
273
  if (! NILP (end1))
274
    CHECK_NATNUM (end1);
275
  if (! NILP (end2))
276
    CHECK_NATNUM (end2);
277 278 279 280 281 282 283

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

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

284
  end1_char = SCHARS (str1);
285 286 287
  if (! NILP (end1) && end1_char > XINT (end1))
    end1_char = XINT (end1);

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

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

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

357
  if (SYMBOLP (s1))
358
    s1 = SYMBOL_NAME (s1);
359
  if (SYMBOLP (s2))
360
    s2 = SYMBOL_NAME (s2);
361 362
  CHECK_STRING (s1);
  CHECK_STRING (s2);
Jim Blandy's avatar
Jim Blandy committed
363

364 365
  i1 = i1_byte = i2 = i2_byte = 0;

366 367 368
  end = SCHARS (s1);
  if (end > SCHARS (s2))
    end = SCHARS (s2);
Jim Blandy's avatar
Jim Blandy committed
369

370
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
371
    {
372 373 374 375
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

376 377
      FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
378 379 380

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

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

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

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

  if (CHAR_TABLE_P (arg))
    {
488
      int i;
489 490
      Lisp_Object copy;

491
      copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
492
      /* Copy all the slots, including the extra ones.  */
493
      bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
494 495
	     ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
	      * sizeof (Lisp_Object)));
496

497 498 499 500 501
      /* 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]))
502
	  XCHAR_TABLE (copy)->contents[i]
503
	    = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
504 505 506 507 508 509 510 511

      return copy;
    }

  if (BOOL_VECTOR_P (arg))
    {
      Lisp_Object val;
      int size_in_chars
512
	= (XBOOL_VECTOR (arg)->size + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
513 514 515 516 517 518 519

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

520
  if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524
    arg = wrong_type_argument (Qsequencep, arg);
  return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
}

525 526 527 528 529 530 531 532 533 534
/* 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;
{
535
  int j = i - 1, bytes;
536 537 538 539 540 541

  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;
542 543
  PARSE_MULTIBYTE_SEQ (str + j, len - j, bytes);
  return (bytes <= i - j ? 0 : bytes - (i - j));
544 545 546 547
}

/* 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
548
struct textprop_rec
549 550 551 552 553 554
{
  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
555 556 557 558 559 560 561 562 563 564 565
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;
566
  int toindex_byte = 0;
567 568
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
569 570 571
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
572
  int some_multibyte;
573 574 575 576 577
  /* 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.  */
578
  struct textprop_rec  *textprops = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
579 580
  /* Number of elments in textprops.  */
  int num_textprops = 0;
Jim Blandy's avatar
Jim Blandy committed
581

582 583
  tail = Qnil;

Jim Blandy's avatar
Jim Blandy committed
584 585 586 587 588 589 590 591 592
  /* 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;

593
  /* Canonicalize each argument.  */
Jim Blandy's avatar
Jim Blandy committed
594 595 596
  for (argnum = 0; argnum < nargs; argnum++)
    {
      this = args[argnum];
597
      if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
598
	    || COMPILEDP (this) || BOOL_VECTOR_P (this)))
Jim Blandy's avatar
Jim Blandy committed
599 600 601 602 603
	{
	    args[argnum] = wrong_type_argument (Qsequencep, this);
	}
    }

604 605 606 607 608 609 610 611
  /* 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
612
    {
613
      int len;
Jim Blandy's avatar
Jim Blandy committed
614
      this = args[argnum];
615 616
      len = XFASTINT (Flength (this));
      if (target_type == Lisp_String)
617
	{
618 619
	  /* We must count the number of bytes needed in the string
	     as well as the number of characters.  */
620 621
	  int i;
	  Lisp_Object ch;
622
	  int this_len_byte;
623

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

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
662 663
    }

664 665
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
666

667
  /* Create the output object.  */
Jim Blandy's avatar
Jim Blandy committed
668
  if (target_type == Lisp_Cons)
669
    val = Fmake_list (make_number (result_len), Qnil);
670
  else if (target_type == Lisp_Vectorlike)
671
    val = Fmake_vector (make_number (result_len), Qnil);
672
  else if (some_multibyte)
673
    val = make_uninit_multibyte_string (result_len, result_len_byte);
674 675
  else
    val = make_uninit_string (result_len);
Jim Blandy's avatar
Jim Blandy committed
676

677 678 679
  /* 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
680

681
  /* Copy the contents of the args into the result.  */
Jim Blandy's avatar
Jim Blandy committed
682
  if (CONSP (val))
683
    tail = val, toindex = -1; /* -1 in toindex is flag we are making a list */
Jim Blandy's avatar
Jim Blandy committed
684
  else
685
    toindex = 0, toindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
686 687

  prev = Qnil;
688
  if (STRINGP (val))
Kenichi Handa's avatar
Kenichi Handa committed
689 690
    textprops
      = (struct textprop_rec *) alloca (sizeof (struct textprop_rec) * nargs);
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694

  for (argnum = 0; argnum < nargs; argnum++)
    {
      Lisp_Object thislen;
695
      int thisleni = 0;
696
      register unsigned int thisindex = 0;
697
      register unsigned int thisindex_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702

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

703 704 705
      /* 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
706
	{
707
	  int thislen_byte = SBYTES (this);
708 709
	  int combined;

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

792 793
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
794
	      {
795
		XSETCAR (tail, elt);
796
		prev = tail;
797
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
798
	      }
799 800 801 802
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
803
		CHECK_NUMBER (elt);
804 805
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
806 807 808
		    if (some_multibyte)
		      toindex_byte
			+= CHAR_STRING (XINT (elt),
809
					SDATA (val) + toindex_byte);
810
		    else
Ken Raeburn's avatar
Ken Raeburn committed
811
		      SSET (val, toindex_byte++, XINT (elt));
812 813
		    if (some_multibyte
			&& toindex_byte > 0
814
			&& count_combining (SDATA (val),
815
					    toindex_byte, toindex_byte - 1))
816
		      STRING_SET_CHARS (val, SCHARS (val) - 1);
817 818
		    else
		      toindex++;
819 820 821 822 823 824 825 826
		  }
		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
827
		    unsigned char *p = SDATA (val) + toindex_byte;
828 829

		    toindex_byte += CHAR_STRING (c, p);
830 831 832 833
		    toindex++;
		  }
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
834
    }
Jim Blandy's avatar
Jim Blandy committed
835
  if (!NILP (prev))
836
    XSETCDR (prev, last_tail);
Jim Blandy's avatar
Jim Blandy committed
837

Kenichi Handa's avatar
Kenichi Handa committed
838
  if (num_textprops > 0)
839
    {
840
      Lisp_Object props;
841
      int last_to_end = -1;
842

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

866 867 868 869 870 871
void
clear_string_char_byte_cache ()
{
  string_char_byte_cache_string = Qnil;
}

872 873 874 875 876 877 878
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
879 880 881
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
882 883 884 885

  if (! STRING_MULTIBYTE (string))
    return char_index;

886
  best_below = best_below_byte = 0;
887 888
  best_above = SCHARS (string);
  best_above_byte = SBYTES (string);
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908

  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;
909 910
	  FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
					      best_below, best_below_byte);
911 912 913 914 915
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
916
    {
917 918
      while (best_above > char_index)
	{
919
	  unsigned char *pend = SDATA (string) + best_above_byte;
920 921 922 923 924 925 926 927 928 929 930
	  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
931 932 933 934 935
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
936 937
    }

938 939 940 941
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

942 943
  return i_byte;
}
944

945 946 947 948 949 950 951
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{