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

This file is part of GNU Emacs.

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

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

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


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

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

Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34 35 36
/* Note on some machines this defines `vector' as a typedef,
   so make sure we don't use that name in this file.  */
#undef vector
#define vector *****

#include "lisp.h"
#include "commands.h"
37
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
38 39

#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "keyboard.h"
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
#if defined (HAVE_MENUS) && defined (HAVE_X_WINDOWS)
Andreas Schwab's avatar
Andreas Schwab committed
47 48
#include "xterm.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
49

Karl Heuer's avatar
Karl Heuer committed
50 51 52 53
#ifndef NULL
#define NULL (void *)0
#endif

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

58 59 60
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;

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

66 67
extern Lisp_Object Qinput_method_function;

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

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

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

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

98
  if (EQ (n, Qt))
99
    seed_random (getpid () + time (NULL));
100
  if (NATNUMP (n) && XFASTINT (n) != 0)
Jim Blandy's avatar
Jim Blandy committed
101
    {
102 103 104 105
      /* Try to take our random number from the higher bits of VAL,
	 not the lower, since (says Gentzel) the low bits of `random'
	 are less random than the higher ones.  We do this by using the
	 quotient rather than the remainder.  At the high end of the RNG
106
	 it's possible to get a quotient larger than n; discarding
107
	 these values eliminates the bias that would otherwise appear
108 109
	 when using a large n.  */
      denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
110
      do
111
	val = get_random () / denominator;
112
      while (val >= XFASTINT (n));
Jim Blandy's avatar
Jim Blandy committed
113
    }
114
  else
115
    val = get_random ();
116 117
  XSETINT (lispy_val, val);
  return lispy_val;
Jim Blandy's avatar
Jim Blandy committed
118 119 120 121 122 123
}

/* Random data-structure functions */

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

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

	  if (!CONSP (sequence))
	    break;

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

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

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

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

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

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

  XSETINT (length, len);
  return length;
}

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

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

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

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

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

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

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

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

  end2_char = XSTRING (str2)->size;
  if (! NILP (end2) && end2_char > XINT (end2))
    end2_char = XINT (end2);

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

      if (STRING_MULTIBYTE (str1))
291
	FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
292 293 294 295 296 297 298
      else
	{
	  c1 = XSTRING (str1)->data[i1++];
	  c1 = unibyte_char_to_multibyte (c1);
	}

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

      if (c1 == c2)
	continue;

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

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

      if (c1 == c2)
	continue;

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

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

  return Qt;
}

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

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

356 357 358 359 360
  i1 = i1_byte = i2 = i2_byte = 0;

  end = XSTRING (s1)->size;
  if (end > XSTRING (s2)->size)
    end = XSTRING (s2)->size;
Jim Blandy's avatar
Jim Blandy committed
361

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

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

      if (c1 != c2)
	return c1 < c2 ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
373
    }
374
  return i1 < XSTRING (s2)->size ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
}

static Lisp_Object concat ();

/* ARGSUSED */
Lisp_Object
concat2 (s1, s2)
     Lisp_Object s1, s2;
{
#ifdef NO_ARG_ARRAY
  Lisp_Object args[2];
  args[0] = s1;
  args[1] = s2;
  return concat (2, args, Lisp_String, 0);
#else
  return concat (2, &s1, Lisp_String, 0);
#endif /* NO_ARG_ARRAY */
}

Richard M. Stallman's avatar
Richard M. Stallman committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/* ARGSUSED */
Lisp_Object
concat3 (s1, s2, s3)
     Lisp_Object s1, s2, s3;
{
#ifdef NO_ARG_ARRAY
  Lisp_Object args[3];
  args[0] = s1;
  args[1] = s2;
  args[2] = s3;
  return concat (3, args, Lisp_String, 0);
#else
  return concat (3, &s1, Lisp_String, 0);
#endif /* NO_ARG_ARRAY */
}

Jim Blandy's avatar
Jim Blandy committed
410 411 412 413
DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
  "Concatenate all the arguments and make the result a list.\n\
The result is a list whose elements are the elements of all the arguments.\n\
Each argument may be a list, vector or string.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
414
The last argument is not copied, just used as the tail of the new list.")
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418 419 420 421 422 423 424
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_Cons, 1);
}

DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
  "Concatenate all the arguments and make the result a string.\n\
The result is a string whose elements are the elements of all the arguments.\n\
Dave Love's avatar
Dave Love committed
425
Each argument may be a string or a list or vector of characters (integers).")
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  return concat (nargs, args, Lisp_String, 0);
}

DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
  "Concatenate all the arguments and make the result a vector.\n\
The result is a vector whose elements are the elements of all the arguments.\n\
Each argument may be a list, vector or string.")
  (nargs, args)
     int nargs;
     Lisp_Object *args;
{
441
  return concat (nargs, args, Lisp_Vectorlike, 0);
Jim Blandy's avatar
Jim Blandy committed
442 443
}

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

  if (CHAR_TABLE_P (arg))
    {
477
      int i;
478 479
      Lisp_Object copy;

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

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

      return copy;
    }

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

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

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

514 515 516 517 518 519 520 521 522 523
/* 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;
{
524
  int j = i - 1, bytes;
525 526 527 528 529 530

  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;
531 532
  PARSE_MULTIBYTE_SEQ (str + j, len - j, bytes);
  return (bytes <= i - j ? 0 : bytes - (i - j));
533 534 535 536
}

/* 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
537
struct textprop_rec
538 539 540 541 542 543
{
  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
544 545 546 547 548 549 550 551 552 553 554
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;
555
  int toindex_byte = 0;
556 557
  register int result_len;
  register int result_len_byte;
Jim Blandy's avatar
Jim Blandy committed
558 559 560
  register int argnum;
  Lisp_Object last_tail;
  Lisp_Object prev;
561
  int some_multibyte;
562 563 564 565 566
  /* 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.  */
567
  struct textprop_rec  *textprops = NULL;
Kenichi Handa's avatar
Kenichi Handa committed
568 569
  /* Number of elments in textprops.  */
  int num_textprops = 0;
Jim Blandy's avatar
Jim Blandy committed
570

571 572
  tail = Qnil;

Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577 578 579 580 581
  /* 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;

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

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

613
	  if (VECTORP (this))
614
	    for (i = 0; i < len; i++)
615 616 617 618
	      {
		ch = XVECTOR (this)->contents[i];
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, ch);
619
		this_len_byte = CHAR_BYTES (XINT (ch));
620
		result_len_byte += this_len_byte;
621
		if (!SINGLE_BYTE_CHAR_P (XINT (ch)))
622
		  some_multibyte = 1;
623
	      }
624 625
	  else if (BOOL_VECTOR_P (this) && XBOOL_VECTOR (this)->size > 0)
	    wrong_type_argument (Qintegerp, Faref (this, make_number (0)));
626
	  else if (CONSP (this))
627
	    for (; CONSP (this); this = XCDR (this))
628
	      {
629
		ch = XCAR (this);
630 631
		if (! INTEGERP (ch))
		  wrong_type_argument (Qintegerp, 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 += STRING_BYTES (XSTRING (this));
643 644 645 646
		}
	      else
		result_len_byte += count_size_as_multibyte (XSTRING (this)->data,
							    XSTRING (this)->size);
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))
Kenichi Handa's avatar
Kenichi Handa committed
678 679
    textprops
      = (struct textprop_rec *) alloca (sizeof (struct textprop_rec) * nargs);
Jim Blandy's avatar
Jim Blandy committed
680 681 682 683

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

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

692 693 694
      /* 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
695
	{
696
	  int thislen_byte = STRING_BYTES (XSTRING (this));
697 698
	  int combined;

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

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

		    toindex_byte += CHAR_STRING (c, p);
819 820 821 822
		    toindex++;
		  }
	      }
	  }
Jim Blandy's avatar
Jim Blandy committed
823
    }
Jim Blandy's avatar
Jim Blandy committed
824
  if (!NILP (prev))
825
    XCDR (prev) = last_tail;
Jim Blandy's avatar
Jim Blandy committed
826

Kenichi Handa's avatar
Kenichi Handa committed
827
  if (num_textprops > 0)
828
    {
829
      Lisp_Object props;
830
      int last_to_end = -1;
831

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

855 856 857 858 859 860
void
clear_string_char_byte_cache ()
{
  string_char_byte_cache_string = Qnil;
}

861 862 863 864 865 866 867
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
868 869 870
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
871 872 873 874

  if (! STRING_MULTIBYTE (string))
    return char_index;

875 876
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
877
  best_above_byte = STRING_BYTES (XSTRING (string));
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897

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

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

927 928 929 930
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

931 932
  return i_byte;
}
933

934 935 936 937 938 939 940
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{
941 942 943
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
944 945 946 947

  if (! STRING_MULTIBYTE (string))
    return byte_index;

948 949
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
950
  best_above_byte = STRING_BYTES (XSTRING (string));
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970

  if (EQ (string, string_char_byte_cache_string))
    {
      if (string_char_byte_cache_bytepos < byte_index)
	{
	  best_below = string_char_byte_cache_charpos;
	  best_below_byte = string_char_byte_cache_bytepos;
	}
      else
	{
	  best_above = string_char_byte_cache_charpos;
	  best_above_byte = string_char_byte_cache_bytepos;
	}
    }

  if (byte_index - best_below_byte < best_above_byte - byte_index)
    {
      while (best_below_byte < byte_index)
	{
	  int c;
971 972
	  FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
					      best_below, best_below_byte);
973 974 975 976 977
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
978
    {
979 980
      while (best_above_byte > byte_index)
	{
981 982 983 984 985 986 987 988 989 990 991 992
	  unsigned char *pend = XSTRING (string)->data + best_above_byte;
	  unsigned char *pbeg = pend - best_above_byte;
	  unsigned char *p = pend - 1;
	  int bytes;

	  while (p > pbeg  && !CHAR_HEAD_P (*p)) p--;
	  PARSE_MULTIBYTE_SEQ (p, pend - p, bytes);
	  if (bytes == pend - p)
	    best_above_byte -= bytes;
	  else if (bytes > pend - p)
	    best_above_byte -= (pend - p);
	  else
993 994 995 996 997
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
998 999
    }

1000 1001 1002 1003
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

1004 1005
  return i;
}
1006

1007
/* Convert STRING to a multibyte string.
1008
   Single-byte characters 0240 through 0377 are converted
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
   by adding nonascii_insert_offset to each.  */

Lisp_Object
string_make_multibyte (string)
     Lisp_Object string;
{
  unsigned char *buf;
  int nbytes;

  if (STRING_MULTIBYTE (string))
    return string;

  nbytes = count_size_as_multibyte (XSTRING (string)->data,
				    XSTRING (string)->size);
1023 1024
  /* If all the chars are ASCII, they won't need any more bytes
     once converted.  In that case, we can return STRING itself.  */
1025
  if (nbytes == STRING_BYTES (XSTRING (string)))
1026 1027
    return string;

1028
  buf = (unsigned char *) alloca (nbytes);
1029
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
	     0, 1);

  return make_multibyte_string (buf, XSTRING (string)->size, nbytes);
}

/* Convert STRING to a single-byte string.  */

Lisp_Object
string_make_unibyte (string)
     Lisp_Object string;
{
  unsigned char *buf;

  if (! STRING_MULTIBYTE (string))
    return string;

  buf = (unsigned char *) alloca (XSTRING (string)->size);

1048
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1049 1050 1051 1052
	     1, 0);

  return make_unibyte_string (buf, XSTRING (string)->size);
}
1053 1054 1055

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

1064 1065 1066 1067 1068
  return string_make_multibyte (string);
}

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

1077 1078
  return string_make_unibyte (string);
}
1079 1080 1081 1082

DEFUN ("string-as-unibyte", Fstring_as_unibyte, Sstring_as_unibyte,
       1, 1, 0,
  "Return a unibyte string with the same individual bytes as STRING.\n\
1083
If STRING is unibyte, the result is STRING itself.\n\
1084
Otherwise it is a newly created string, with no text properties.\n\
1085 1086 1087
If STRING is multibyte and contains a character of charset\n\
`eight-bit-control' or `eight-bit-graphic', it is converted to the\n\
corresponding single byte.")
1088 1089 1090
  (string)
     Lisp_Object string;
{
1091 1092
  CHECK_STRING (string, 0);

1093 1094
  if (STRING_MULTIBYTE (string))
    {
1095 1096 1097 1098 1099 1100 1101
      int bytes = STRING_BYTES (XSTRING (string));
      unsigned char *str = (unsigned char *) xmalloc (bytes);

      bcopy (XSTRING (string)->data, str, bytes);
      bytes = str_as_unibyte (str, bytes);
      string = make_unibyte_string (str, bytes);
      xfree (str);
1102 1103 1104 1105