fns.c 128 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 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

Jim Blandy's avatar
Jim Blandy committed
29 30 31 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 *****

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

#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
39
#include "keyboard.h"
40
#include "intervals.h"
41 42
#include "frame.h"
#include "window.h"
43
#if defined (HAVE_MENUS) && defined (HAVE_X_WINDOWS)
Andreas Schwab's avatar
Andreas Schwab committed
44 45
#include "xterm.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
46

Karl Heuer's avatar
Karl Heuer committed
47 48 49 50
#ifndef NULL
#define NULL (void *)0
#endif

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

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

60 61 62
extern int minibuffer_auto_raise;
extern Lisp_Object minibuf_window;

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

68 69
extern Lisp_Object Qinput_method_function;

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

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

#ifndef HAVE_UNISTD_H
extern long time ();
#endif
78

Jim Blandy's avatar
Jim Blandy committed
79 80 81 82 83 84 85 86 87 88
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\
89 90
All integers representable in Lisp are equally likely.\n\
  On most systems, this is 28 bits' worth.\n\
91
With positive integer argument N, return random number in interval [0,N).\n\
Jim Blandy's avatar
Jim Blandy committed
92
With argument t, set the random number seed from the current time and pid.")
93 94
  (n)
     Lisp_Object n;
Jim Blandy's avatar
Jim Blandy committed
95
{
96 97
  EMACS_INT val;
  Lisp_Object lispy_val;
98
  unsigned long denominator;
Jim Blandy's avatar
Jim Blandy committed
99

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

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

	  if (!CONSP (sequence))
	    break;

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

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

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

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

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

  XSETINT (length, len);
  return length;
}

207 208 209 210
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)
211
     Lisp_Object string;
212 213
{
  CHECK_STRING (string, 1);
214
  return make_number (STRING_BYTES (XSTRING (string)));
215 216
}

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

231
  if (XSTRING (s1)->size != XSTRING (s2)->size
232 233
      || 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
234 235 236 237
    return Qnil;
  return Qt;
}

238
DEFUN ("compare-strings", Fcompare_strings,
239
       Scompare_strings, 6, 7, 0,
240 241 242
  "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\
243 244
END1 and END2 default to the full lengths of the respective strings.\n\
\n\
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 291 292 293 294 295 296 297 298 299 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 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
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))
	FETCH_STRING_CHAR_ADVANCE (c1, str1, i1, i1_byte);
      else
	{
	  c1 = XSTRING (str1)->data[i1++];
	  c1 = unibyte_char_to_multibyte (c1);
	}

      if (STRING_MULTIBYTE (str2))
	FETCH_STRING_CHAR_ADVANCE (c2, str2, i2, i2_byte);
      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)
	return make_number (- i1);
      else
	return make_number (i1);
    }

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

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

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

364
  while (i1 < end)
Jim Blandy's avatar
Jim Blandy committed
365
    {
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
      /* When we find a mismatch, we must compare the
	 characters, not just the bytes.  */
      int c1, c2;

      if (STRING_MULTIBYTE (s1))
	FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
      else
	c1 = XSTRING (s1)->data[i1++];

      if (STRING_MULTIBYTE (s2))
	FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
      else
	c2 = XSTRING (s2)->data[i2++];

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

453 454 455 456
/* 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)
457
     Lisp_Object arg;
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
{
  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
475 476 477 478 479 480 481
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
482
  if (NILP (arg)) return arg;
483 484 485

  if (CHAR_TABLE_P (arg))
    {
486
      int i;
487 488
      Lisp_Object copy;

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

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

      return copy;
    }

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

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

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

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

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

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

  /* 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;

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

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

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

      result_len += len;
Jim Blandy's avatar
Jim Blandy committed
658 659
    }

660 661
  if (! some_multibyte)
    result_len_byte = result_len;
Jim Blandy's avatar
Jim Blandy committed
662

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

673 674 675
  /* 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
676

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

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

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

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

699 700 701
      /* 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
702
	{
703
	  int thislen_byte = STRING_BYTES (XSTRING (this));
704 705
	  int combined;

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

788 789
	    /* Store this element into the result.  */
	    if (toindex < 0)
Jim Blandy's avatar
Jim Blandy committed
790
	      {
791
		XCAR (tail) = elt;
792
		prev = tail;
793
		tail = XCDR (tail);
Jim Blandy's avatar
Jim Blandy committed
794
	      }
795 796 797 798 799 800 801
	    else if (VECTORP (val))
	      XVECTOR (val)->contents[toindex++] = elt;
	    else
	      {
		CHECK_NUMBER (elt, 0);
		if (SINGLE_BYTE_CHAR_P (XINT (elt)))
		  {
802
		    XSTRING (val)->data[toindex_byte++] = XINT (elt);
803 804
		    if (some_multibyte
			&& toindex_byte > 0
805 806 807 808 809
			&& count_combining (XSTRING (val)->data,
					    toindex_byte, toindex_byte - 1))
		      XSTRING (val)->size--;
		    else
		      toindex++;
810 811 812 813 814 815 816 817 818
		  }
		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];
819 820

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

Kenichi Handa's avatar
Kenichi Handa committed
829
  if (num_textprops > 0)
830
    {
Kenichi Handa's avatar
Kenichi Handa committed
831
      for (argnum = 0; argnum < num_textprops; argnum++)
832
	{
Kenichi Handa's avatar
Kenichi Handa committed
833 834
	  this = args[textprops[argnum].argnum];
	  copy_text_properties (make_number (textprops[argnum].from),
835
				make_number (XSTRING (this)->size), this,
Kenichi Handa's avatar
Kenichi Handa committed
836
				make_number (textprops[argnum].to), val, Qnil);
837 838
	}
    }
Karl Heuer's avatar
Karl Heuer committed
839
  return val;
Jim Blandy's avatar
Jim Blandy committed
840 841
}

842 843 844 845
static Lisp_Object string_char_byte_cache_string;
static int string_char_byte_cache_charpos;
static int string_char_byte_cache_bytepos;

846 847 848 849 850 851
void
clear_string_char_byte_cache ()
{
  string_char_byte_cache_string = Qnil;
}

852 853 854 855 856 857 858
/* Return the character index corresponding to CHAR_INDEX in STRING.  */

int
string_char_to_byte (string, char_index)
     Lisp_Object string;
     int char_index;
{
859 860 861
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
862 863 864 865

  if (! STRING_MULTIBYTE (string))
    return char_index;

866 867
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
868
  best_above_byte = STRING_BYTES (XSTRING (string));
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894

  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;
	  FETCH_STRING_CHAR_ADVANCE (c, string, best_below, best_below_byte);
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
895
    {
896 897
      while (best_above > char_index)
	{
898 899 900 901 902 903 904 905 906 907 908 909
	  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
910 911 912 913 914
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
915 916
    }

917 918 919 920
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

921 922
  return i_byte;
}
923

924 925 926 927 928 929 930
/* Return the character index corresponding to BYTE_INDEX in STRING.  */

int
string_byte_to_char (string, byte_index)
     Lisp_Object string;
     int byte_index;
{
931 932 933
  int i, i_byte;
  int best_below, best_below_byte;
  int best_above, best_above_byte;
934 935 936 937

  if (! STRING_MULTIBYTE (string))
    return byte_index;

938 939
  best_below = best_below_byte = 0;
  best_above = XSTRING (string)->size;
940
  best_above_byte = STRING_BYTES (XSTRING (string));
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966

  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;
	  FETCH_STRING_CHAR_ADVANCE (c, string, best_below, best_below_byte);
	}
      i = best_below;
      i_byte = best_below_byte;
    }
  else
967
    {
968 969
      while (best_above_byte > byte_index)
	{
970 971 972 973 974 975 976 977 978 979 980 981
	  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
982 983 984 985 986
	    best_above_byte--;
	  best_above--;
	}
      i = best_above;
      i_byte = best_above_byte;
987 988
    }

989 990 991 992
  string_char_byte_cache_bytepos = i_byte;
  string_char_byte_cache_charpos = i;
  string_char_byte_cache_string = string;

993 994
  return i;
}
995

996
/* Convert STRING to a multibyte string.
997
   Single-byte characters 0240 through 0377 are converted
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
   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);
1012 1013
  /* If all the chars are ASCII, they won't need any more bytes
     once converted.  In that case, we can return STRING itself.  */
1014
  if (nbytes == STRING_BYTES (XSTRING (string)))
1015 1016
    return string;

1017
  buf = (unsigned char *) alloca (nbytes);
1018
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	     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);

1037
  copy_text (XSTRING (string)->data, buf, STRING_BYTES (XSTRING (string)),
1038 1039 1040 1041
	     1, 0);

  return make_unibyte_string (buf, XSTRING (string)->size);
}
1042 1043 1044

DEFUN ("string-make-multibyte", Fstring_make_multibyte, Sstring_make_multibyte,
       1, 1, 0,
1045 1046 1047
  "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.")
1048 1049 1050
  (string)
     Lisp_Object string;
{
1051 1052
  CHECK_STRING (string, 0);

1053 1054 1055 1056 1057
  return string_make_multibyte (string);
}

DEFUN ("string-make-unibyte", Fstring_make_unibyte, Sstring_make_unibyte,
       1, 1, 0,
1058 1059 1060
  "Return the unibyte equivalent of STRING.\n\
Multibyte character codes are converted to unibyte\n\
by using just the low 8 bits.")
1061 1062 1063
  (string)
     Lisp_Object string;
{
1064 1065
  CHECK_STRING (string, 0);

1066 1067
  return string_make_unibyte (string);
}
1068 1069 1070 1071

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\
1072 1073
If STRING is unibyte, the result is STRING itself.\n\
Otherwise it is a newly created string, with no text properties.")
1074 1075 1076
  (string)
     Lisp_Object string;
{
1077 1078
  CHECK_STRING (string, 0);

1079 1080 1081
  if (STRING_MULTIBYTE (string))
    {
      string = Fcopy_sequence (string);
1082
      XSTRING (string)->size = STRING_BYTES (XSTRING (string));
1083
      XSTRING (string)->intervals = NULL_INTERVAL;
1084
      SET_STRING_BYTES (XSTRING (string), -1);
1085 1086 1087 1088 1089 1090 1091
    }
  return string;
}

DEFUN ("string-as-multibyte", Fstring_as_multibyte, Sstring_as_multibyte,
       1, 1, 0,
  "Return a multibyte string with the same individual bytes as STRING.\n\
1092 1093
If STRING is multibyte, the result is STRING itself.\n\
Otherwise it is a newly created string, with no text properties.")
1094 1095 1096
  (string)
     Lisp_Object string;
{
1097 1098
  CHECK_STRING (string, 0);

1099 1100
  if (! STRING_MULTIBYTE (string))
    {
1101 1102 1103 1104 1105 1106
      int nbytes = STRING_BYTES (XSTRING (string));
      int newlen = multibyte_chars_in_text (XSTRING (string)->data, nbytes);

      string = Fcopy_sequence (string);
      XSTRING (string)->size = newlen;
      XSTRING (string)->size_byte = nbytes;
1107
      XSTRING (string)->intervals = NULL_INTERVAL;
1108 1109 1110
    }
  return string;
}
1111

Jim Blandy's avatar
Jim Blandy committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
DEFUN ("copy-alist", Fcopy_alist, Scopy_alist, 1, 1, 0,
  "Return a copy of ALIST.\n\
This is an alist which represents the same mapping from objects to objects,\n\
but does not share the alist structure with ALIST.\n\
The objects mapped (cars and cdrs of elements of the alist)\n\
are shared, however.\n\
Elements of ALIST that are not conses are also shared.")
  (alist)
     Lisp_Object alist;
{
  register Lisp_Object tem;

  CHECK_LIST (alist, 0);
Jim Blandy's avatar
Jim Blandy committed
1125
  if (NILP (alist))
Jim Blandy's avatar
Jim Blandy committed
1126 1127
    return alist;
  alist = concat (1, &alist, Lisp_Cons, 0);
1128
  for (tem = alist; CONSP (tem); tem = XCDR (tem))
Jim Blandy's avatar
Jim Blandy committed
1129 1130
    {
      register Lisp_Object car;
1131
      car = XCAR (tem);
Jim Blandy's avatar
Jim Blandy committed
1132 1133

      if (CONSP (car))
1134
	XCAR (tem) = Fcons (XCAR (car), XCDR (car));
Jim Blandy's avatar
Jim Blandy committed
1135 1136 1137 1138 1139 1140 1141
    }
  return alist;
}

DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0,
  "Return a substring of STRING, starting at index FROM and ending before TO.\n\
TO may be nil or omitted; then the substring runs to the end of STRING.\n\
1142 1143 1144
If FROM or TO is negative, it counts from the end.\n\
\n\
This function allows vectors as well as strings.")
Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147 1148
  (string, from, to)
     Lisp_Object string;
     register Lisp_Object from, to;
{
1149
  Lisp_Object res;
1150
  int size;