(Regexp Replace): Some typo corrections and
[emacs.git] / src / fns.c
blob693f3eaaa934130a4abade1aaf8d01c240faddcf
1 /* Random utility Lisp functions.
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 98, 99, 2000, 2001, 02, 03, 2004
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 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)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #ifdef HAVE_UNISTD_H
25 #include <unistd.h>
26 #endif
27 #include <time.h>
29 #ifndef MAC_OSX
30 /* On Mac OS X, defining this conflicts with precompiled headers. */
32 /* Note on some machines this defines `vector' as a typedef,
33 so make sure we don't use that name in this file. */
34 #undef vector
35 #define vector *****
37 #endif /* ! MAC_OSX */
39 #include "lisp.h"
40 #include "commands.h"
41 #include "charset.h"
42 #include "coding.h"
43 #include "buffer.h"
44 #include "keyboard.h"
45 #include "keymap.h"
46 #include "intervals.h"
47 #include "frame.h"
48 #include "window.h"
49 #include "blockinput.h"
50 #if defined (HAVE_MENUS) && defined (HAVE_X_WINDOWS)
51 #include "xterm.h"
52 #endif
54 #ifndef NULL
55 #define NULL ((POINTER_TYPE *)0)
56 #endif
58 /* Nonzero enables use of dialog boxes for questions
59 asked by mouse commands. */
60 int use_dialog_box;
62 /* Nonzero enables use of a file dialog for file name
63 questions asked by mouse commands. */
64 int use_file_dialog;
66 extern int minibuffer_auto_raise;
67 extern Lisp_Object minibuf_window;
68 extern Lisp_Object Vlocale_coding_system;
70 Lisp_Object Qstring_lessp, Qprovide, Qrequire;
71 Lisp_Object Qyes_or_no_p_history;
72 Lisp_Object Qcursor_in_echo_area;
73 Lisp_Object Qwidget_type;
74 Lisp_Object Qcodeset, Qdays, Qmonths, Qpaper;
76 extern Lisp_Object Qinput_method_function;
78 static int internal_equal ();
80 extern long get_random ();
81 extern void seed_random ();
83 #ifndef HAVE_UNISTD_H
84 extern long time ();
85 #endif
87 DEFUN ("identity", Fidentity, Sidentity, 1, 1, 0,
88 doc: /* Return the argument unchanged. */)
89 (arg)
90 Lisp_Object arg;
92 return arg;
95 DEFUN ("random", Frandom, Srandom, 0, 1, 0,
96 doc: /* Return a pseudo-random number.
97 All integers representable in Lisp are equally likely.
98 On most systems, this is 29 bits' worth.
99 With positive integer argument N, return random number in interval [0,N).
100 With argument t, set the random number seed from the current time and pid. */)
102 Lisp_Object n;
104 EMACS_INT val;
105 Lisp_Object lispy_val;
106 unsigned long denominator;
108 if (EQ (n, Qt))
109 seed_random (getpid () + time (NULL));
110 if (NATNUMP (n) && XFASTINT (n) != 0)
112 /* Try to take our random number from the higher bits of VAL,
113 not the lower, since (says Gentzel) the low bits of `random'
114 are less random than the higher ones. We do this by using the
115 quotient rather than the remainder. At the high end of the RNG
116 it's possible to get a quotient larger than n; discarding
117 these values eliminates the bias that would otherwise appear
118 when using a large n. */
119 denominator = ((unsigned long)1 << VALBITS) / XFASTINT (n);
121 val = get_random () / denominator;
122 while (val >= XFASTINT (n));
124 else
125 val = get_random ();
126 XSETINT (lispy_val, val);
127 return lispy_val;
130 /* Random data-structure functions */
132 DEFUN ("length", Flength, Slength, 1, 1, 0,
133 doc: /* Return the length of vector, list or string SEQUENCE.
134 A byte-code function object is also allowed.
135 If the string contains multibyte characters, this is not necessarily
136 the number of bytes in the string; it is the number of characters.
137 To get the number of bytes, use `string-bytes'. */)
138 (sequence)
139 register Lisp_Object sequence;
141 register Lisp_Object val;
142 register int i;
144 retry:
145 if (STRINGP (sequence))
146 XSETFASTINT (val, SCHARS (sequence));
147 else if (VECTORP (sequence))
148 XSETFASTINT (val, XVECTOR (sequence)->size);
149 else if (SUB_CHAR_TABLE_P (sequence))
150 XSETFASTINT (val, SUB_CHAR_TABLE_ORDINARY_SLOTS);
151 else if (CHAR_TABLE_P (sequence))
152 XSETFASTINT (val, MAX_CHAR);
153 else if (BOOL_VECTOR_P (sequence))
154 XSETFASTINT (val, XBOOL_VECTOR (sequence)->size);
155 else if (COMPILEDP (sequence))
156 XSETFASTINT (val, XVECTOR (sequence)->size & PSEUDOVECTOR_SIZE_MASK);
157 else if (CONSP (sequence))
159 i = 0;
160 while (CONSP (sequence))
162 sequence = XCDR (sequence);
163 ++i;
165 if (!CONSP (sequence))
166 break;
168 sequence = XCDR (sequence);
169 ++i;
170 QUIT;
173 if (!NILP (sequence))
174 wrong_type_argument (Qlistp, sequence);
176 val = make_number (i);
178 else if (NILP (sequence))
179 XSETFASTINT (val, 0);
180 else
182 sequence = wrong_type_argument (Qsequencep, sequence);
183 goto retry;
185 return val;
188 /* This does not check for quits. That is safe
189 since it must terminate. */
191 DEFUN ("safe-length", Fsafe_length, Ssafe_length, 1, 1, 0,
192 doc: /* Return the length of a list, but avoid error or infinite loop.
193 This function never gets an error. If LIST is not really a list,
194 it returns 0. If LIST is circular, it returns a finite value
195 which is at least the number of distinct elements. */)
196 (list)
197 Lisp_Object list;
199 Lisp_Object tail, halftail, length;
200 int len = 0;
202 /* halftail is used to detect circular lists. */
203 halftail = list;
204 for (tail = list; CONSP (tail); tail = XCDR (tail))
206 if (EQ (tail, halftail) && len != 0)
207 break;
208 len++;
209 if ((len & 1) == 0)
210 halftail = XCDR (halftail);
213 XSETINT (length, len);
214 return length;
217 DEFUN ("string-bytes", Fstring_bytes, Sstring_bytes, 1, 1, 0,
218 doc: /* Return the number of bytes in STRING.
219 If STRING is a multibyte string, this is greater than the length of STRING. */)
220 (string)
221 Lisp_Object string;
223 CHECK_STRING (string);
224 return make_number (SBYTES (string));
227 DEFUN ("string-equal", Fstring_equal, Sstring_equal, 2, 2, 0,
228 doc: /* Return t if two strings have identical contents.
229 Case is significant, but text properties are ignored.
230 Symbols are also allowed; their print names are used instead. */)
231 (s1, s2)
232 register Lisp_Object s1, s2;
234 if (SYMBOLP (s1))
235 s1 = SYMBOL_NAME (s1);
236 if (SYMBOLP (s2))
237 s2 = SYMBOL_NAME (s2);
238 CHECK_STRING (s1);
239 CHECK_STRING (s2);
241 if (SCHARS (s1) != SCHARS (s2)
242 || SBYTES (s1) != SBYTES (s2)
243 || bcmp (SDATA (s1), SDATA (s2), SBYTES (s1)))
244 return Qnil;
245 return Qt;
248 DEFUN ("compare-strings", Fcompare_strings,
249 Scompare_strings, 6, 7, 0,
250 doc: /* Compare the contents of two strings, converting to multibyte if needed.
251 In string STR1, skip the first START1 characters and stop at END1.
252 In string STR2, skip the first START2 characters and stop at END2.
253 END1 and END2 default to the full lengths of the respective strings.
255 Case is significant in this comparison if IGNORE-CASE is nil.
256 Unibyte strings are converted to multibyte for comparison.
258 The value is t if the strings (or specified portions) match.
259 If string STR1 is less, the value is a negative number N;
260 - 1 - N is the number of characters that match at the beginning.
261 If string STR1 is greater, the value is a positive number N;
262 N - 1 is the number of characters that match at the beginning. */)
263 (str1, start1, end1, str2, start2, end2, ignore_case)
264 Lisp_Object str1, start1, end1, start2, str2, end2, ignore_case;
266 register int end1_char, end2_char;
267 register int i1, i1_byte, i2, i2_byte;
269 CHECK_STRING (str1);
270 CHECK_STRING (str2);
271 if (NILP (start1))
272 start1 = make_number (0);
273 if (NILP (start2))
274 start2 = make_number (0);
275 CHECK_NATNUM (start1);
276 CHECK_NATNUM (start2);
277 if (! NILP (end1))
278 CHECK_NATNUM (end1);
279 if (! NILP (end2))
280 CHECK_NATNUM (end2);
282 i1 = XINT (start1);
283 i2 = XINT (start2);
285 i1_byte = string_char_to_byte (str1, i1);
286 i2_byte = string_char_to_byte (str2, i2);
288 end1_char = SCHARS (str1);
289 if (! NILP (end1) && end1_char > XINT (end1))
290 end1_char = XINT (end1);
292 end2_char = SCHARS (str2);
293 if (! NILP (end2) && end2_char > XINT (end2))
294 end2_char = XINT (end2);
296 while (i1 < end1_char && i2 < end2_char)
298 /* When we find a mismatch, we must compare the
299 characters, not just the bytes. */
300 int c1, c2;
302 if (STRING_MULTIBYTE (str1))
303 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c1, str1, i1, i1_byte);
304 else
306 c1 = SREF (str1, i1++);
307 c1 = unibyte_char_to_multibyte (c1);
310 if (STRING_MULTIBYTE (str2))
311 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c2, str2, i2, i2_byte);
312 else
314 c2 = SREF (str2, i2++);
315 c2 = unibyte_char_to_multibyte (c2);
318 if (c1 == c2)
319 continue;
321 if (! NILP (ignore_case))
323 Lisp_Object tem;
325 tem = Fupcase (make_number (c1));
326 c1 = XINT (tem);
327 tem = Fupcase (make_number (c2));
328 c2 = XINT (tem);
331 if (c1 == c2)
332 continue;
334 /* Note that I1 has already been incremented
335 past the character that we are comparing;
336 hence we don't add or subtract 1 here. */
337 if (c1 < c2)
338 return make_number (- i1 + XINT (start1));
339 else
340 return make_number (i1 - XINT (start1));
343 if (i1 < end1_char)
344 return make_number (i1 - XINT (start1) + 1);
345 if (i2 < end2_char)
346 return make_number (- i1 + XINT (start1) - 1);
348 return Qt;
351 DEFUN ("string-lessp", Fstring_lessp, Sstring_lessp, 2, 2, 0,
352 doc: /* Return t if first arg string is less than second in lexicographic order.
353 Case is significant.
354 Symbols are also allowed; their print names are used instead. */)
355 (s1, s2)
356 register Lisp_Object s1, s2;
358 register int end;
359 register int i1, i1_byte, i2, i2_byte;
361 if (SYMBOLP (s1))
362 s1 = SYMBOL_NAME (s1);
363 if (SYMBOLP (s2))
364 s2 = SYMBOL_NAME (s2);
365 CHECK_STRING (s1);
366 CHECK_STRING (s2);
368 i1 = i1_byte = i2 = i2_byte = 0;
370 end = SCHARS (s1);
371 if (end > SCHARS (s2))
372 end = SCHARS (s2);
374 while (i1 < end)
376 /* When we find a mismatch, we must compare the
377 characters, not just the bytes. */
378 int c1, c2;
380 FETCH_STRING_CHAR_ADVANCE (c1, s1, i1, i1_byte);
381 FETCH_STRING_CHAR_ADVANCE (c2, s2, i2, i2_byte);
383 if (c1 != c2)
384 return c1 < c2 ? Qt : Qnil;
386 return i1 < SCHARS (s2) ? Qt : Qnil;
389 static Lisp_Object concat ();
391 /* ARGSUSED */
392 Lisp_Object
393 concat2 (s1, s2)
394 Lisp_Object s1, s2;
396 #ifdef NO_ARG_ARRAY
397 Lisp_Object args[2];
398 args[0] = s1;
399 args[1] = s2;
400 return concat (2, args, Lisp_String, 0);
401 #else
402 return concat (2, &s1, Lisp_String, 0);
403 #endif /* NO_ARG_ARRAY */
406 /* ARGSUSED */
407 Lisp_Object
408 concat3 (s1, s2, s3)
409 Lisp_Object s1, s2, s3;
411 #ifdef NO_ARG_ARRAY
412 Lisp_Object args[3];
413 args[0] = s1;
414 args[1] = s2;
415 args[2] = s3;
416 return concat (3, args, Lisp_String, 0);
417 #else
418 return concat (3, &s1, Lisp_String, 0);
419 #endif /* NO_ARG_ARRAY */
422 DEFUN ("append", Fappend, Sappend, 0, MANY, 0,
423 doc: /* Concatenate all the arguments and make the result a list.
424 The result is a list whose elements are the elements of all the arguments.
425 Each argument may be a list, vector or string.
426 The last argument is not copied, just used as the tail of the new list.
427 usage: (append &rest SEQUENCES) */)
428 (nargs, args)
429 int nargs;
430 Lisp_Object *args;
432 return concat (nargs, args, Lisp_Cons, 1);
435 DEFUN ("concat", Fconcat, Sconcat, 0, MANY, 0,
436 doc: /* Concatenate all the arguments and make the result a string.
437 The result is a string whose elements are the elements of all the arguments.
438 Each argument may be a string or a list or vector of characters (integers).
439 usage: (concat &rest SEQUENCES) */)
440 (nargs, args)
441 int nargs;
442 Lisp_Object *args;
444 return concat (nargs, args, Lisp_String, 0);
447 DEFUN ("vconcat", Fvconcat, Svconcat, 0, MANY, 0,
448 doc: /* Concatenate all the arguments and make the result a vector.
449 The result is a vector whose elements are the elements of all the arguments.
450 Each argument may be a list, vector or string.
451 usage: (vconcat &rest SEQUENCES) */)
452 (nargs, args)
453 int nargs;
454 Lisp_Object *args;
456 return concat (nargs, args, Lisp_Vectorlike, 0);
459 /* Return a copy of a sub char table ARG. The elements except for a
460 nested sub char table are not copied. */
461 static Lisp_Object
462 copy_sub_char_table (arg)
463 Lisp_Object arg;
465 Lisp_Object copy = make_sub_char_table (XCHAR_TABLE (arg)->defalt);
466 int i;
468 /* Copy all the contents. */
469 bcopy (XCHAR_TABLE (arg)->contents, XCHAR_TABLE (copy)->contents,
470 SUB_CHAR_TABLE_ORDINARY_SLOTS * sizeof (Lisp_Object));
471 /* Recursively copy any sub char-tables in the ordinary slots. */
472 for (i = 32; i < SUB_CHAR_TABLE_ORDINARY_SLOTS; i++)
473 if (SUB_CHAR_TABLE_P (XCHAR_TABLE (arg)->contents[i]))
474 XCHAR_TABLE (copy)->contents[i]
475 = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
477 return copy;
481 DEFUN ("copy-sequence", Fcopy_sequence, Scopy_sequence, 1, 1, 0,
482 doc: /* Return a copy of a list, vector, string or char-table.
483 The elements of a list or vector are not copied; they are shared
484 with the original. */)
485 (arg)
486 Lisp_Object arg;
488 if (NILP (arg)) return arg;
490 if (CHAR_TABLE_P (arg))
492 int i;
493 Lisp_Object copy;
495 copy = Fmake_char_table (XCHAR_TABLE (arg)->purpose, Qnil);
496 /* Copy all the slots, including the extra ones. */
497 bcopy (XVECTOR (arg)->contents, XVECTOR (copy)->contents,
498 ((XCHAR_TABLE (arg)->size & PSEUDOVECTOR_SIZE_MASK)
499 * sizeof (Lisp_Object)));
501 /* Recursively copy any sub char tables in the ordinary slots
502 for multibyte characters. */
503 for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS;
504 i < CHAR_TABLE_ORDINARY_SLOTS; i++)
505 if (SUB_CHAR_TABLE_P (XCHAR_TABLE (arg)->contents[i]))
506 XCHAR_TABLE (copy)->contents[i]
507 = copy_sub_char_table (XCHAR_TABLE (copy)->contents[i]);
509 return copy;
512 if (BOOL_VECTOR_P (arg))
514 Lisp_Object val;
515 int size_in_chars
516 = ((XBOOL_VECTOR (arg)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
517 / BOOL_VECTOR_BITS_PER_CHAR);
519 val = Fmake_bool_vector (Flength (arg), Qnil);
520 bcopy (XBOOL_VECTOR (arg)->data, XBOOL_VECTOR (val)->data,
521 size_in_chars);
522 return val;
525 if (!CONSP (arg) && !VECTORP (arg) && !STRINGP (arg))
526 arg = wrong_type_argument (Qsequencep, arg);
527 return concat (1, &arg, CONSP (arg) ? Lisp_Cons : XTYPE (arg), 0);
530 /* This structure holds information of an argument of `concat' that is
531 a string and has text properties to be copied. */
532 struct textprop_rec
534 int argnum; /* refer to ARGS (arguments of `concat') */
535 int from; /* refer to ARGS[argnum] (argument string) */
536 int to; /* refer to VAL (the target string) */
539 static Lisp_Object
540 concat (nargs, args, target_type, last_special)
541 int nargs;
542 Lisp_Object *args;
543 enum Lisp_Type target_type;
544 int last_special;
546 Lisp_Object val;
547 register Lisp_Object tail;
548 register Lisp_Object this;
549 int toindex;
550 int toindex_byte = 0;
551 register int result_len;
552 register int result_len_byte;
553 register int argnum;
554 Lisp_Object last_tail;
555 Lisp_Object prev;
556 int some_multibyte;
557 /* When we make a multibyte string, we can't copy text properties
558 while concatinating each string because the length of resulting
559 string can't be decided until we finish the whole concatination.
560 So, we record strings that have text properties to be copied
561 here, and copy the text properties after the concatination. */
562 struct textprop_rec *textprops = NULL;
563 /* Number of elments in textprops. */
564 int num_textprops = 0;
566 tail = Qnil;
568 /* In append, the last arg isn't treated like the others */
569 if (last_special && nargs > 0)
571 nargs--;
572 last_tail = args[nargs];
574 else
575 last_tail = Qnil;
577 /* Canonicalize each argument. */
578 for (argnum = 0; argnum < nargs; argnum++)
580 this = args[argnum];
581 if (!(CONSP (this) || NILP (this) || VECTORP (this) || STRINGP (this)
582 || COMPILEDP (this) || BOOL_VECTOR_P (this)))
584 args[argnum] = wrong_type_argument (Qsequencep, this);
588 /* Compute total length in chars of arguments in RESULT_LEN.
589 If desired output is a string, also compute length in bytes
590 in RESULT_LEN_BYTE, and determine in SOME_MULTIBYTE
591 whether the result should be a multibyte string. */
592 result_len_byte = 0;
593 result_len = 0;
594 some_multibyte = 0;
595 for (argnum = 0; argnum < nargs; argnum++)
597 int len;
598 this = args[argnum];
599 len = XFASTINT (Flength (this));
600 if (target_type == Lisp_String)
602 /* We must count the number of bytes needed in the string
603 as well as the number of characters. */
604 int i;
605 Lisp_Object ch;
606 int this_len_byte;
608 if (VECTORP (this))
609 for (i = 0; i < len; i++)
611 ch = XVECTOR (this)->contents[i];
612 if (! INTEGERP (ch))
613 wrong_type_argument (Qintegerp, ch);
614 this_len_byte = CHAR_BYTES (XINT (ch));
615 result_len_byte += this_len_byte;
616 if (!SINGLE_BYTE_CHAR_P (XINT (ch)))
617 some_multibyte = 1;
619 else if (BOOL_VECTOR_P (this) && XBOOL_VECTOR (this)->size > 0)
620 wrong_type_argument (Qintegerp, Faref (this, make_number (0)));
621 else if (CONSP (this))
622 for (; CONSP (this); this = XCDR (this))
624 ch = XCAR (this);
625 if (! INTEGERP (ch))
626 wrong_type_argument (Qintegerp, ch);
627 this_len_byte = CHAR_BYTES (XINT (ch));
628 result_len_byte += this_len_byte;
629 if (!SINGLE_BYTE_CHAR_P (XINT (ch)))
630 some_multibyte = 1;
632 else if (STRINGP (this))
634 if (STRING_MULTIBYTE (this))
636 some_multibyte = 1;
637 result_len_byte += SBYTES (this);
639 else
640 result_len_byte += count_size_as_multibyte (SDATA (this),
641 SCHARS (this));
645 result_len += len;
648 if (! some_multibyte)
649 result_len_byte = result_len;
651 /* Create the output object. */
652 if (target_type == Lisp_Cons)
653 val = Fmake_list (make_number (result_len), Qnil);
654 else if (target_type == Lisp_Vectorlike)
655 val = Fmake_vector (make_number (result_len), Qnil);
656 else if (some_multibyte)
657 val = make_uninit_multibyte_string (result_len, result_len_byte);
658 else
659 val = make_uninit_string (result_len);
661 /* In `append', if all but last arg are nil, return last arg. */
662 if (target_type == Lisp_Cons && EQ (val, Qnil))
663 return last_tail;
665 /* Copy the contents of the args into the result. */
666 if (CONSP (val))
667 tail = val, toindex = -1; /* -1 in toindex is flag we are making a list */
668 else
669 toindex = 0, toindex_byte = 0;
671 prev = Qnil;
672 if (STRINGP (val))
673 textprops
674 = (struct textprop_rec *) alloca (sizeof (struct textprop_rec) * nargs);
676 for (argnum = 0; argnum < nargs; argnum++)
678 Lisp_Object thislen;
679 int thisleni = 0;
680 register unsigned int thisindex = 0;
681 register unsigned int thisindex_byte = 0;
683 this = args[argnum];
684 if (!CONSP (this))
685 thislen = Flength (this), thisleni = XINT (thislen);
687 /* Between strings of the same kind, copy fast. */
688 if (STRINGP (this) && STRINGP (val)
689 && STRING_MULTIBYTE (this) == some_multibyte)
691 int thislen_byte = SBYTES (this);
693 bcopy (SDATA (this), SDATA (val) + toindex_byte,
694 SBYTES (this));
695 if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
697 textprops[num_textprops].argnum = argnum;
698 textprops[num_textprops].from = 0;
699 textprops[num_textprops++].to = toindex;
701 toindex_byte += thislen_byte;
702 toindex += thisleni;
703 STRING_SET_CHARS (val, SCHARS (val));
705 /* Copy a single-byte string to a multibyte string. */
706 else if (STRINGP (this) && STRINGP (val))
708 if (! NULL_INTERVAL_P (STRING_INTERVALS (this)))
710 textprops[num_textprops].argnum = argnum;
711 textprops[num_textprops].from = 0;
712 textprops[num_textprops++].to = toindex;
714 toindex_byte += copy_text (SDATA (this),
715 SDATA (val) + toindex_byte,
716 SCHARS (this), 0, 1);
717 toindex += thisleni;
719 else
720 /* Copy element by element. */
721 while (1)
723 register Lisp_Object elt;
725 /* Fetch next element of `this' arg into `elt', or break if
726 `this' is exhausted. */
727 if (NILP (this)) break;
728 if (CONSP (this))
729 elt = XCAR (this), this = XCDR (this);
730 else if (thisindex >= thisleni)
731 break;
732 else if (STRINGP (this))
734 int c;
735 if (STRING_MULTIBYTE (this))
737 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, this,
738 thisindex,
739 thisindex_byte);
740 XSETFASTINT (elt, c);
742 else
744 XSETFASTINT (elt, SREF (this, thisindex++));
745 if (some_multibyte
746 && (XINT (elt) >= 0240
747 || (XINT (elt) >= 0200
748 && ! NILP (Vnonascii_translation_table)))
749 && XINT (elt) < 0400)
751 c = unibyte_char_to_multibyte (XINT (elt));
752 XSETINT (elt, c);
756 else if (BOOL_VECTOR_P (this))
758 int byte;
759 byte = XBOOL_VECTOR (this)->data[thisindex / BOOL_VECTOR_BITS_PER_CHAR];
760 if (byte & (1 << (thisindex % BOOL_VECTOR_BITS_PER_CHAR)))
761 elt = Qt;
762 else
763 elt = Qnil;
764 thisindex++;
766 else
767 elt = XVECTOR (this)->contents[thisindex++];
769 /* Store this element into the result. */
770 if (toindex < 0)
772 XSETCAR (tail, elt);
773 prev = tail;
774 tail = XCDR (tail);
776 else if (VECTORP (val))
777 XVECTOR (val)->contents[toindex++] = elt;
778 else
780 CHECK_NUMBER (elt);
781 if (SINGLE_BYTE_CHAR_P (XINT (elt)))
783 if (some_multibyte)
784 toindex_byte
785 += CHAR_STRING (XINT (elt),
786 SDATA (val) + toindex_byte);
787 else
788 SSET (val, toindex_byte++, XINT (elt));
789 toindex++;
791 else
792 /* If we have any multibyte characters,
793 we already decided to make a multibyte string. */
795 int c = XINT (elt);
796 /* P exists as a variable
797 to avoid a bug on the Masscomp C compiler. */
798 unsigned char *p = SDATA (val) + toindex_byte;
800 toindex_byte += CHAR_STRING (c, p);
801 toindex++;
806 if (!NILP (prev))
807 XSETCDR (prev, last_tail);
809 if (num_textprops > 0)
811 Lisp_Object props;
812 int last_to_end = -1;
814 for (argnum = 0; argnum < num_textprops; argnum++)
816 this = args[textprops[argnum].argnum];
817 props = text_property_list (this,
818 make_number (0),
819 make_number (SCHARS (this)),
820 Qnil);
821 /* If successive arguments have properites, be sure that the
822 value of `composition' property be the copy. */
823 if (last_to_end == textprops[argnum].to)
824 make_composition_value_copy (props);
825 add_text_properties_from_list (val, props,
826 make_number (textprops[argnum].to));
827 last_to_end = textprops[argnum].to + SCHARS (this);
830 return val;
833 static Lisp_Object string_char_byte_cache_string;
834 static int string_char_byte_cache_charpos;
835 static int string_char_byte_cache_bytepos;
837 void
838 clear_string_char_byte_cache ()
840 string_char_byte_cache_string = Qnil;
843 /* Return the character index corresponding to CHAR_INDEX in STRING. */
846 string_char_to_byte (string, char_index)
847 Lisp_Object string;
848 int char_index;
850 int i, i_byte;
851 int best_below, best_below_byte;
852 int best_above, best_above_byte;
854 best_below = best_below_byte = 0;
855 best_above = SCHARS (string);
856 best_above_byte = SBYTES (string);
857 if (best_above == best_above_byte)
858 return char_index;
860 if (EQ (string, string_char_byte_cache_string))
862 if (string_char_byte_cache_charpos < char_index)
864 best_below = string_char_byte_cache_charpos;
865 best_below_byte = string_char_byte_cache_bytepos;
867 else
869 best_above = string_char_byte_cache_charpos;
870 best_above_byte = string_char_byte_cache_bytepos;
874 if (char_index - best_below < best_above - char_index)
876 while (best_below < char_index)
878 int c;
879 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
880 best_below, best_below_byte);
882 i = best_below;
883 i_byte = best_below_byte;
885 else
887 while (best_above > char_index)
889 unsigned char *pend = SDATA (string) + best_above_byte;
890 unsigned char *pbeg = pend - best_above_byte;
891 unsigned char *p = pend - 1;
892 int bytes;
894 while (p > pbeg && !CHAR_HEAD_P (*p)) p--;
895 PARSE_MULTIBYTE_SEQ (p, pend - p, bytes);
896 if (bytes == pend - p)
897 best_above_byte -= bytes;
898 else if (bytes > pend - p)
899 best_above_byte -= (pend - p);
900 else
901 best_above_byte--;
902 best_above--;
904 i = best_above;
905 i_byte = best_above_byte;
908 string_char_byte_cache_bytepos = i_byte;
909 string_char_byte_cache_charpos = i;
910 string_char_byte_cache_string = string;
912 return i_byte;
915 /* Return the character index corresponding to BYTE_INDEX in STRING. */
918 string_byte_to_char (string, byte_index)
919 Lisp_Object string;
920 int byte_index;
922 int i, i_byte;
923 int best_below, best_below_byte;
924 int best_above, best_above_byte;
926 best_below = best_below_byte = 0;
927 best_above = SCHARS (string);
928 best_above_byte = SBYTES (string);
929 if (best_above == best_above_byte)
930 return byte_index;
932 if (EQ (string, string_char_byte_cache_string))
934 if (string_char_byte_cache_bytepos < byte_index)
936 best_below = string_char_byte_cache_charpos;
937 best_below_byte = string_char_byte_cache_bytepos;
939 else
941 best_above = string_char_byte_cache_charpos;
942 best_above_byte = string_char_byte_cache_bytepos;
946 if (byte_index - best_below_byte < best_above_byte - byte_index)
948 while (best_below_byte < byte_index)
950 int c;
951 FETCH_STRING_CHAR_ADVANCE_NO_CHECK (c, string,
952 best_below, best_below_byte);
954 i = best_below;
955 i_byte = best_below_byte;
957 else
959 while (best_above_byte > byte_index)
961 unsigned char *pend = SDATA (string) + best_above_byte;
962 unsigned char *pbeg = pend - best_above_byte;
963 unsigned char *p = pend - 1;
964 int bytes;
966 while (p > pbeg && !CHAR_HEAD_P (*p)) p--;
967 PARSE_MULTIBYTE_SEQ (p, pend - p, bytes);
968 if (bytes == pend - p)
969 best_above_byte -= bytes;
970 else if (bytes > pend - p)
971 best_above_byte -= (pend - p);
972 else
973 best_above_byte--;
974 best_above--;
976 i = best_above;
977 i_byte = best_above_byte;
980 string_char_byte_cache_bytepos = i_byte;
981 string_char_byte_cache_charpos = i;
982 string_char_byte_cache_string = string;
984 return i;
987 /* Convert STRING to a multibyte string.
988 Single-byte characters 0240 through 0377 are converted
989 by adding nonascii_insert_offset to each. */
991 Lisp_Object
992 string_make_multibyte (string)
993 Lisp_Object string;
995 unsigned char *buf;
996 int nbytes;
997 Lisp_Object ret;
998 USE_SAFE_ALLOCA;
1000 if (STRING_MULTIBYTE (string))
1001 return string;
1003 nbytes = count_size_as_multibyte (SDATA (string),
1004 SCHARS (string));
1005 /* If all the chars are ASCII, they won't need any more bytes
1006 once converted. In that case, we can return STRING itself. */
1007 if (nbytes == SBYTES (string))
1008 return string;
1010 SAFE_ALLOCA (buf, unsigned char *, nbytes);
1011 copy_text (SDATA (string), buf, SBYTES (string),
1012 0, 1);
1014 ret = make_multibyte_string (buf, SCHARS (string), nbytes);
1015 SAFE_FREE (nbytes);
1017 return ret;
1021 /* Convert STRING to a multibyte string without changing each
1022 character codes. Thus, characters 0200 trough 0237 are converted
1023 to eight-bit-control characters, and characters 0240 through 0377
1024 are converted eight-bit-graphic characters. */
1026 Lisp_Object
1027 string_to_multibyte (string)
1028 Lisp_Object string;
1030 unsigned char *buf;
1031 int nbytes;
1032 Lisp_Object ret;
1033 USE_SAFE_ALLOCA;
1035 if (STRING_MULTIBYTE (string))
1036 return string;
1038 nbytes = parse_str_to_multibyte (SDATA (string), SBYTES (string));
1039 /* If all the chars are ASCII or eight-bit-graphic, they won't need
1040 any more bytes once converted. */
1041 if (nbytes == SBYTES (string))
1042 return make_multibyte_string (SDATA (string), nbytes, nbytes);
1044 SAFE_ALLOCA (buf, unsigned char *, nbytes);
1045 bcopy (SDATA (string), buf, SBYTES (string));
1046 str_to_multibyte (buf, nbytes, SBYTES (string));
1048 ret = make_multibyte_string (buf, SCHARS (string), nbytes);
1049 SAFE_FREE (nbytes);
1051 return ret;
1055 /* Convert STRING to a single-byte string. */
1057 Lisp_Object
1058 string_make_unibyte (string)
1059 Lisp_Object string;
1061 int nchars;
1062 unsigned char *buf;
1063 Lisp_Object ret;
1064 USE_SAFE_ALLOCA;
1066 if (! STRING_MULTIBYTE (string))
1067 return string;
1069 nchars = SCHARS (string);
1071 SAFE_ALLOCA (buf, unsigned char *, nchars);
1072 copy_text (SDATA (string), buf, SBYTES (string),
1073 1, 0);
1075 ret = make_unibyte_string (buf, nchars);
1076 SAFE_FREE (nchars);
1078 return ret;
1081 DEFUN ("string-make-multibyte", Fstring_make_multibyte, Sstring_make_multibyte,
1082 1, 1, 0,
1083 doc: /* Return the multibyte equivalent of STRING.
1084 If STRING is unibyte and contains non-ASCII characters, the function
1085 `unibyte-char-to-multibyte' is used to convert each unibyte character
1086 to a multibyte character. In this case, the returned string is a
1087 newly created string with no text properties. If STRING is multibyte
1088 or entirely ASCII, it is returned unchanged. In particular, when
1089 STRING is unibyte and entirely ASCII, the returned string is unibyte.
1090 \(When the characters are all ASCII, Emacs primitives will treat the
1091 string the same way whether it is unibyte or multibyte.) */)
1092 (string)
1093 Lisp_Object string;
1095 CHECK_STRING (string);
1097 return string_make_multibyte (string);
1100 DEFUN ("string-make-unibyte", Fstring_make_unibyte, Sstring_make_unibyte,
1101 1, 1, 0,
1102 doc: /* Return the unibyte equivalent of STRING.
1103 Multibyte character codes are converted to unibyte according to
1104 `nonascii-translation-table' or, if that is nil, `nonascii-insert-offset'.
1105 If the lookup in the translation table fails, this function takes just
1106 the low 8 bits of each character. */)
1107 (string)
1108 Lisp_Object string;
1110 CHECK_STRING (string);
1112 return string_make_unibyte (string);
1115 DEFUN ("string-as-unibyte", Fstring_as_unibyte, Sstring_as_unibyte,
1116 1, 1, 0,
1117 doc: /* Return a unibyte string with the same individual bytes as STRING.
1118 If STRING is unibyte, the result is STRING itself.
1119 Otherwise it is a newly created string, with no text properties.
1120 If STRING is multibyte and contains a character of charset
1121 `eight-bit-control' or `eight-bit-graphic', it is converted to the
1122 corresponding single byte. */)
1123 (string)
1124 Lisp_Object string;
1126 CHECK_STRING (string);
1128 if (STRING_MULTIBYTE (string))
1130 int bytes = SBYTES (string);
1131 unsigned char *str = (unsigned char *) xmalloc (bytes);
1133 bcopy (SDATA (string), str, bytes);
1134 bytes = str_as_unibyte (str, bytes);
1135 string = make_unibyte_string (str, bytes);
1136 xfree (str);
1138 return string;
1141 DEFUN ("string-as-multibyte", Fstring_as_multibyte, Sstring_as_multibyte,
1142 1, 1, 0,
1143 doc: /* Return a multibyte string with the same individual bytes as STRING.
1144 If STRING is multibyte, the result is STRING itself.
1145 Otherwise it is a newly created string, with no text properties.
1146 If STRING is unibyte and contains an individual 8-bit byte (i.e. not
1147 part of a multibyte form), it is converted to the corresponding
1148 multibyte character of charset `eight-bit-control' or `eight-bit-graphic'. */)
1149 (string)
1150 Lisp_Object string;
1152 CHECK_STRING (string);
1154 if (! STRING_MULTIBYTE (string))
1156 Lisp_Object new_string;
1157 int nchars, nbytes;
1159 parse_str_as_multibyte (SDATA (string),
1160 SBYTES (string),
1161 &nchars, &nbytes);
1162 new_string = make_uninit_multibyte_string (nchars, nbytes);
1163 bcopy (SDATA (string), SDATA (new_string),
1164 SBYTES (string));
1165 if (nbytes != SBYTES (string))
1166 str_as_multibyte (SDATA (new_string), nbytes,
1167 SBYTES (string), NULL);
1168 string = new_string;
1169 STRING_SET_INTERVALS (string, NULL_INTERVAL);
1171 return string;
1174 DEFUN ("string-to-multibyte", Fstring_to_multibyte, Sstring_to_multibyte,
1175 1, 1, 0,
1176 doc: /* Return a multibyte string with the same individual chars as STRING.
1177 If STRING is multibyte, the result is STRING itself.
1178 Otherwise it is a newly created string, with no text properties.
1179 Characters 0200 through 0237 are converted to eight-bit-control
1180 characters of the same character code. Characters 0240 through 0377
1181 are converted to eight-bit-graphic characters of the same character
1182 codes. */)
1183 (string)
1184 Lisp_Object string;
1186 CHECK_STRING (string);
1188 return string_to_multibyte (string);
1192 DEFUN ("copy-alist", Fcopy_alist, Scopy_alist, 1, 1, 0,
1193 doc: /* Return a copy of ALIST.
1194 This is an alist which represents the same mapping from objects to objects,
1195 but does not share the alist structure with ALIST.
1196 The objects mapped (cars and cdrs of elements of the alist)
1197 are shared, however.
1198 Elements of ALIST that are not conses are also shared. */)
1199 (alist)
1200 Lisp_Object alist;
1202 register Lisp_Object tem;
1204 CHECK_LIST (alist);
1205 if (NILP (alist))
1206 return alist;
1207 alist = concat (1, &alist, Lisp_Cons, 0);
1208 for (tem = alist; CONSP (tem); tem = XCDR (tem))
1210 register Lisp_Object car;
1211 car = XCAR (tem);
1213 if (CONSP (car))
1214 XSETCAR (tem, Fcons (XCAR (car), XCDR (car)));
1216 return alist;
1219 DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0,
1220 doc: /* Return a substring of STRING, starting at index FROM and ending before TO.
1221 TO may be nil or omitted; then the substring runs to the end of STRING.
1222 FROM and TO start at 0. If either is negative, it counts from the end.
1224 This function allows vectors as well as strings. */)
1225 (string, from, to)
1226 Lisp_Object string;
1227 register Lisp_Object from, to;
1229 Lisp_Object res;
1230 int size;
1231 int size_byte = 0;
1232 int from_char, to_char;
1233 int from_byte = 0, to_byte = 0;
1235 if (! (STRINGP (string) || VECTORP (string)))
1236 wrong_type_argument (Qarrayp, string);
1238 CHECK_NUMBER (from);
1240 if (STRINGP (string))
1242 size = SCHARS (string);
1243 size_byte = SBYTES (string);
1245 else
1246 size = XVECTOR (string)->size;
1248 if (NILP (to))
1250 to_char = size;
1251 to_byte = size_byte;
1253 else
1255 CHECK_NUMBER (to);
1257 to_char = XINT (to);
1258 if (to_char < 0)
1259 to_char += size;
1261 if (STRINGP (string))
1262 to_byte = string_char_to_byte (string, to_char);
1265 from_char = XINT (from);
1266 if (from_char < 0)
1267 from_char += size;
1268 if (STRINGP (string))
1269 from_byte = string_char_to_byte (string, from_char);
1271 if (!(0 <= from_char && from_char <= to_char && to_char <= size))
1272 args_out_of_range_3 (string, make_number (from_char),
1273 make_number (to_char));
1275 if (STRINGP (string))
1277 res = make_specified_string (SDATA (string) + from_byte,
1278 to_char - from_char, to_byte - from_byte,
1279 STRING_MULTIBYTE (string));
1280 copy_text_properties (make_number (from_char), make_number (to_char),
1281 string, make_number (0), res, Qnil);
1283 else
1284 res = Fvector (to_char - from_char,
1285 XVECTOR (string)->contents + from_char);
1287 return res;
1291 DEFUN ("substring-no-properties", Fsubstring_no_properties, Ssubstring_no_properties, 1, 3, 0,
1292 doc: /* Return a substring of STRING, without text properties.
1293 It starts at index FROM and ending before TO.
1294 TO may be nil or omitted; then the substring runs to the end of STRING.
1295 If FROM is nil or omitted, the substring starts at the beginning of STRING.
1296 If FROM or TO is negative, it counts from the end.
1298 With one argument, just copy STRING without its properties. */)
1299 (string, from, to)
1300 Lisp_Object string;
1301 register Lisp_Object from, to;
1303 int size, size_byte;
1304 int from_char, to_char;
1305 int from_byte, to_byte;
1307 CHECK_STRING (string);
1309 size = SCHARS (string);
1310 size_byte = SBYTES (string);
1312 if (NILP (from))
1313 from_char = from_byte = 0;
1314 else
1316 CHECK_NUMBER (from);
1317 from_char = XINT (from);
1318 if (from_char < 0)
1319 from_char += size;
1321 from_byte = string_char_to_byte (string, from_char);
1324 if (NILP (to))
1326 to_char = size;
1327 to_byte = size_byte;
1329 else
1331 CHECK_NUMBER (to);
1333 to_char = XINT (to);
1334 if (to_char < 0)
1335 to_char += size;
1337 to_byte = string_char_to_byte (string, to_char);
1340 if (!(0 <= from_char && from_char <= to_char && to_char <= size))
1341 args_out_of_range_3 (string, make_number (from_char),
1342 make_number (to_char));
1344 return make_specified_string (SDATA (string) + from_byte,
1345 to_char - from_char, to_byte - from_byte,
1346 STRING_MULTIBYTE (string));
1349 /* Extract a substring of STRING, giving start and end positions
1350 both in characters and in bytes. */
1352 Lisp_Object
1353 substring_both (string, from, from_byte, to, to_byte)
1354 Lisp_Object string;
1355 int from, from_byte, to, to_byte;
1357 Lisp_Object res;
1358 int size;
1359 int size_byte;
1361 if (! (STRINGP (string) || VECTORP (string)))
1362 wrong_type_argument (Qarrayp, string);
1364 if (STRINGP (string))
1366 size = SCHARS (string);
1367 size_byte = SBYTES (string);
1369 else
1370 size = XVECTOR (string)->size;
1372 if (!(0 <= from && from <= to && to <= size))
1373 args_out_of_range_3 (string, make_number (from), make_number (to));
1375 if (STRINGP (string))
1377 res = make_specified_string (SDATA (string) + from_byte,
1378 to - from, to_byte - from_byte,
1379 STRING_MULTIBYTE (string));
1380 copy_text_properties (make_number (from), make_number (to),
1381 string, make_number (0), res, Qnil);
1383 else
1384 res = Fvector (to - from,
1385 XVECTOR (string)->contents + from);
1387 return res;
1390 DEFUN ("nthcdr", Fnthcdr, Snthcdr, 2, 2, 0,
1391 doc: /* Take cdr N times on LIST, returns the result. */)
1392 (n, list)
1393 Lisp_Object n;
1394 register Lisp_Object list;
1396 register int i, num;
1397 CHECK_NUMBER (n);
1398 num = XINT (n);
1399 for (i = 0; i < num && !NILP (list); i++)
1401 QUIT;
1402 if (! CONSP (list))
1403 wrong_type_argument (Qlistp, list);
1404 list = XCDR (list);
1406 return list;
1409 DEFUN ("nth", Fnth, Snth, 2, 2, 0,
1410 doc: /* Return the Nth element of LIST.
1411 N counts from zero. If LIST is not that long, nil is returned. */)
1412 (n, list)
1413 Lisp_Object n, list;
1415 return Fcar (Fnthcdr (n, list));
1418 DEFUN ("elt", Felt, Selt, 2, 2, 0,
1419 doc: /* Return element of SEQUENCE at index N. */)
1420 (sequence, n)
1421 register Lisp_Object sequence, n;
1423 CHECK_NUMBER (n);
1424 while (1)
1426 if (CONSP (sequence) || NILP (sequence))
1427 return Fcar (Fnthcdr (n, sequence));
1428 else if (STRINGP (sequence) || VECTORP (sequence)
1429 || BOOL_VECTOR_P (sequence) || CHAR_TABLE_P (sequence))
1430 return Faref (sequence, n);
1431 else
1432 sequence = wrong_type_argument (Qsequencep, sequence);
1436 DEFUN ("member", Fmember, Smember, 2, 2, 0,
1437 doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `equal'.
1438 The value is actually the tail of LIST whose car is ELT. */)
1439 (elt, list)
1440 register Lisp_Object elt;
1441 Lisp_Object list;
1443 register Lisp_Object tail;
1444 for (tail = list; !NILP (tail); tail = XCDR (tail))
1446 register Lisp_Object tem;
1447 if (! CONSP (tail))
1448 wrong_type_argument (Qlistp, list);
1449 tem = XCAR (tail);
1450 if (! NILP (Fequal (elt, tem)))
1451 return tail;
1452 QUIT;
1454 return Qnil;
1457 DEFUN ("memq", Fmemq, Smemq, 2, 2, 0,
1458 doc: /* Return non-nil if ELT is an element of LIST.
1459 Comparison done with EQ. The value is actually the tail of LIST
1460 whose car is ELT. */)
1461 (elt, list)
1462 Lisp_Object elt, list;
1464 while (1)
1466 if (!CONSP (list) || EQ (XCAR (list), elt))
1467 break;
1469 list = XCDR (list);
1470 if (!CONSP (list) || EQ (XCAR (list), elt))
1471 break;
1473 list = XCDR (list);
1474 if (!CONSP (list) || EQ (XCAR (list), elt))
1475 break;
1477 list = XCDR (list);
1478 QUIT;
1481 if (!CONSP (list) && !NILP (list))
1482 list = wrong_type_argument (Qlistp, list);
1484 return list;
1487 DEFUN ("assq", Fassq, Sassq, 2, 2, 0,
1488 doc: /* Return non-nil if KEY is `eq' to the car of an element of LIST.
1489 The value is actually the first element of LIST whose car is KEY.
1490 Elements of LIST that are not conses are ignored. */)
1491 (key, list)
1492 Lisp_Object key, list;
1494 Lisp_Object result;
1496 while (1)
1498 if (!CONSP (list)
1499 || (CONSP (XCAR (list))
1500 && EQ (XCAR (XCAR (list)), key)))
1501 break;
1503 list = XCDR (list);
1504 if (!CONSP (list)
1505 || (CONSP (XCAR (list))
1506 && EQ (XCAR (XCAR (list)), key)))
1507 break;
1509 list = XCDR (list);
1510 if (!CONSP (list)
1511 || (CONSP (XCAR (list))
1512 && EQ (XCAR (XCAR (list)), key)))
1513 break;
1515 list = XCDR (list);
1516 QUIT;
1519 if (CONSP (list))
1520 result = XCAR (list);
1521 else if (NILP (list))
1522 result = Qnil;
1523 else
1524 result = wrong_type_argument (Qlistp, list);
1526 return result;
1529 /* Like Fassq but never report an error and do not allow quits.
1530 Use only on lists known never to be circular. */
1532 Lisp_Object
1533 assq_no_quit (key, list)
1534 Lisp_Object key, list;
1536 while (CONSP (list)
1537 && (!CONSP (XCAR (list))
1538 || !EQ (XCAR (XCAR (list)), key)))
1539 list = XCDR (list);
1541 return CONSP (list) ? XCAR (list) : Qnil;
1544 DEFUN ("assoc", Fassoc, Sassoc, 2, 2, 0,
1545 doc: /* Return non-nil if KEY is `equal' to the car of an element of LIST.
1546 The value is actually the first element of LIST whose car equals KEY. */)
1547 (key, list)
1548 Lisp_Object key, list;
1550 Lisp_Object result, car;
1552 while (1)
1554 if (!CONSP (list)
1555 || (CONSP (XCAR (list))
1556 && (car = XCAR (XCAR (list)),
1557 EQ (car, key) || !NILP (Fequal (car, key)))))
1558 break;
1560 list = XCDR (list);
1561 if (!CONSP (list)
1562 || (CONSP (XCAR (list))
1563 && (car = XCAR (XCAR (list)),
1564 EQ (car, key) || !NILP (Fequal (car, key)))))
1565 break;
1567 list = XCDR (list);
1568 if (!CONSP (list)
1569 || (CONSP (XCAR (list))
1570 && (car = XCAR (XCAR (list)),
1571 EQ (car, key) || !NILP (Fequal (car, key)))))
1572 break;
1574 list = XCDR (list);
1575 QUIT;
1578 if (CONSP (list))
1579 result = XCAR (list);
1580 else if (NILP (list))
1581 result = Qnil;
1582 else
1583 result = wrong_type_argument (Qlistp, list);
1585 return result;
1588 DEFUN ("rassq", Frassq, Srassq, 2, 2, 0,
1589 doc: /* Return non-nil if KEY is `eq' to the cdr of an element of LIST.
1590 The value is actually the first element of LIST whose cdr is KEY. */)
1591 (key, list)
1592 register Lisp_Object key;
1593 Lisp_Object list;
1595 Lisp_Object result;
1597 while (1)
1599 if (!CONSP (list)
1600 || (CONSP (XCAR (list))
1601 && EQ (XCDR (XCAR (list)), key)))
1602 break;
1604 list = XCDR (list);
1605 if (!CONSP (list)
1606 || (CONSP (XCAR (list))
1607 && EQ (XCDR (XCAR (list)), key)))
1608 break;
1610 list = XCDR (list);
1611 if (!CONSP (list)
1612 || (CONSP (XCAR (list))
1613 && EQ (XCDR (XCAR (list)), key)))
1614 break;
1616 list = XCDR (list);
1617 QUIT;
1620 if (NILP (list))
1621 result = Qnil;
1622 else if (CONSP (list))
1623 result = XCAR (list);
1624 else
1625 result = wrong_type_argument (Qlistp, list);
1627 return result;
1630 DEFUN ("rassoc", Frassoc, Srassoc, 2, 2, 0,
1631 doc: /* Return non-nil if KEY is `equal' to the cdr of an element of LIST.
1632 The value is actually the first element of LIST whose cdr equals KEY. */)
1633 (key, list)
1634 Lisp_Object key, list;
1636 Lisp_Object result, cdr;
1638 while (1)
1640 if (!CONSP (list)
1641 || (CONSP (XCAR (list))
1642 && (cdr = XCDR (XCAR (list)),
1643 EQ (cdr, key) || !NILP (Fequal (cdr, key)))))
1644 break;
1646 list = XCDR (list);
1647 if (!CONSP (list)
1648 || (CONSP (XCAR (list))
1649 && (cdr = XCDR (XCAR (list)),
1650 EQ (cdr, key) || !NILP (Fequal (cdr, key)))))
1651 break;
1653 list = XCDR (list);
1654 if (!CONSP (list)
1655 || (CONSP (XCAR (list))
1656 && (cdr = XCDR (XCAR (list)),
1657 EQ (cdr, key) || !NILP (Fequal (cdr, key)))))
1658 break;
1660 list = XCDR (list);
1661 QUIT;
1664 if (CONSP (list))
1665 result = XCAR (list);
1666 else if (NILP (list))
1667 result = Qnil;
1668 else
1669 result = wrong_type_argument (Qlistp, list);
1671 return result;
1674 DEFUN ("delq", Fdelq, Sdelq, 2, 2, 0,
1675 doc: /* Delete by side effect any occurrences of ELT as a member of LIST.
1676 The modified LIST is returned. Comparison is done with `eq'.
1677 If the first member of LIST is ELT, there is no way to remove it by side effect;
1678 therefore, write `(setq foo (delq element foo))'
1679 to be sure of changing the value of `foo'. */)
1680 (elt, list)
1681 register Lisp_Object elt;
1682 Lisp_Object list;
1684 register Lisp_Object tail, prev;
1685 register Lisp_Object tem;
1687 tail = list;
1688 prev = Qnil;
1689 while (!NILP (tail))
1691 if (! CONSP (tail))
1692 wrong_type_argument (Qlistp, list);
1693 tem = XCAR (tail);
1694 if (EQ (elt, tem))
1696 if (NILP (prev))
1697 list = XCDR (tail);
1698 else
1699 Fsetcdr (prev, XCDR (tail));
1701 else
1702 prev = tail;
1703 tail = XCDR (tail);
1704 QUIT;
1706 return list;
1709 DEFUN ("delete", Fdelete, Sdelete, 2, 2, 0,
1710 doc: /* Delete by side effect any occurrences of ELT as a member of SEQ.
1711 SEQ must be a list, a vector, or a string.
1712 The modified SEQ is returned. Comparison is done with `equal'.
1713 If SEQ is not a list, or the first member of SEQ is ELT, deleting it
1714 is not a side effect; it is simply using a different sequence.
1715 Therefore, write `(setq foo (delete element foo))'
1716 to be sure of changing the value of `foo'. */)
1717 (elt, seq)
1718 Lisp_Object elt, seq;
1720 if (VECTORP (seq))
1722 EMACS_INT i, n;
1724 for (i = n = 0; i < ASIZE (seq); ++i)
1725 if (NILP (Fequal (AREF (seq, i), elt)))
1726 ++n;
1728 if (n != ASIZE (seq))
1730 struct Lisp_Vector *p = allocate_vector (n);
1732 for (i = n = 0; i < ASIZE (seq); ++i)
1733 if (NILP (Fequal (AREF (seq, i), elt)))
1734 p->contents[n++] = AREF (seq, i);
1736 XSETVECTOR (seq, p);
1739 else if (STRINGP (seq))
1741 EMACS_INT i, ibyte, nchars, nbytes, cbytes;
1742 int c;
1744 for (i = nchars = nbytes = ibyte = 0;
1745 i < SCHARS (seq);
1746 ++i, ibyte += cbytes)
1748 if (STRING_MULTIBYTE (seq))
1750 c = STRING_CHAR (SDATA (seq) + ibyte,
1751 SBYTES (seq) - ibyte);
1752 cbytes = CHAR_BYTES (c);
1754 else
1756 c = SREF (seq, i);
1757 cbytes = 1;
1760 if (!INTEGERP (elt) || c != XINT (elt))
1762 ++nchars;
1763 nbytes += cbytes;
1767 if (nchars != SCHARS (seq))
1769 Lisp_Object tem;
1771 tem = make_uninit_multibyte_string (nchars, nbytes);
1772 if (!STRING_MULTIBYTE (seq))
1773 STRING_SET_UNIBYTE (tem);
1775 for (i = nchars = nbytes = ibyte = 0;
1776 i < SCHARS (seq);
1777 ++i, ibyte += cbytes)
1779 if (STRING_MULTIBYTE (seq))
1781 c = STRING_CHAR (SDATA (seq) + ibyte,
1782 SBYTES (seq) - ibyte);
1783 cbytes = CHAR_BYTES (c);
1785 else
1787 c = SREF (seq, i);
1788 cbytes = 1;
1791 if (!INTEGERP (elt) || c != XINT (elt))
1793 unsigned char *from = SDATA (seq) + ibyte;
1794 unsigned char *to = SDATA (tem) + nbytes;
1795 EMACS_INT n;
1797 ++nchars;
1798 nbytes += cbytes;
1800 for (n = cbytes; n--; )
1801 *to++ = *from++;
1805 seq = tem;
1808 else
1810 Lisp_Object tail, prev;
1812 for (tail = seq, prev = Qnil; !NILP (tail); tail = XCDR (tail))
1814 if (!CONSP (tail))
1815 wrong_type_argument (Qlistp, seq);
1817 if (!NILP (Fequal (elt, XCAR (tail))))
1819 if (NILP (prev))
1820 seq = XCDR (tail);
1821 else
1822 Fsetcdr (prev, XCDR (tail));
1824 else
1825 prev = tail;
1826 QUIT;
1830 return seq;
1833 DEFUN ("nreverse", Fnreverse, Snreverse, 1, 1, 0,
1834 doc: /* Reverse LIST by modifying cdr pointers.
1835 Return the reversed list. */)
1836 (list)
1837 Lisp_Object list;
1839 register Lisp_Object prev, tail, next;
1841 if (NILP (list)) return list;
1842 prev = Qnil;
1843 tail = list;
1844 while (!NILP (tail))
1846 QUIT;
1847 if (! CONSP (tail))
1848 wrong_type_argument (Qlistp, list);
1849 next = XCDR (tail);
1850 Fsetcdr (tail, prev);
1851 prev = tail;
1852 tail = next;
1854 return prev;
1857 DEFUN ("reverse", Freverse, Sreverse, 1, 1, 0,
1858 doc: /* Reverse LIST, copying. Return the reversed list.
1859 See also the function `nreverse', which is used more often. */)
1860 (list)
1861 Lisp_Object list;
1863 Lisp_Object new;
1865 for (new = Qnil; CONSP (list); list = XCDR (list))
1867 QUIT;
1868 new = Fcons (XCAR (list), new);
1870 if (!NILP (list))
1871 wrong_type_argument (Qconsp, list);
1872 return new;
1875 Lisp_Object merge ();
1877 DEFUN ("sort", Fsort, Ssort, 2, 2, 0,
1878 doc: /* Sort LIST, stably, comparing elements using PREDICATE.
1879 Returns the sorted list. LIST is modified by side effects.
1880 PREDICATE is called with two elements of LIST, and should return t
1881 if the first element is "less" than the second. */)
1882 (list, predicate)
1883 Lisp_Object list, predicate;
1885 Lisp_Object front, back;
1886 register Lisp_Object len, tem;
1887 struct gcpro gcpro1, gcpro2;
1888 register int length;
1890 front = list;
1891 len = Flength (list);
1892 length = XINT (len);
1893 if (length < 2)
1894 return list;
1896 XSETINT (len, (length / 2) - 1);
1897 tem = Fnthcdr (len, list);
1898 back = Fcdr (tem);
1899 Fsetcdr (tem, Qnil);
1901 GCPRO2 (front, back);
1902 front = Fsort (front, predicate);
1903 back = Fsort (back, predicate);
1904 UNGCPRO;
1905 return merge (front, back, predicate);
1908 Lisp_Object
1909 merge (org_l1, org_l2, pred)
1910 Lisp_Object org_l1, org_l2;
1911 Lisp_Object pred;
1913 Lisp_Object value;
1914 register Lisp_Object tail;
1915 Lisp_Object tem;
1916 register Lisp_Object l1, l2;
1917 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1919 l1 = org_l1;
1920 l2 = org_l2;
1921 tail = Qnil;
1922 value = Qnil;
1924 /* It is sufficient to protect org_l1 and org_l2.
1925 When l1 and l2 are updated, we copy the new values
1926 back into the org_ vars. */
1927 GCPRO4 (org_l1, org_l2, pred, value);
1929 while (1)
1931 if (NILP (l1))
1933 UNGCPRO;
1934 if (NILP (tail))
1935 return l2;
1936 Fsetcdr (tail, l2);
1937 return value;
1939 if (NILP (l2))
1941 UNGCPRO;
1942 if (NILP (tail))
1943 return l1;
1944 Fsetcdr (tail, l1);
1945 return value;
1947 tem = call2 (pred, Fcar (l2), Fcar (l1));
1948 if (NILP (tem))
1950 tem = l1;
1951 l1 = Fcdr (l1);
1952 org_l1 = l1;
1954 else
1956 tem = l2;
1957 l2 = Fcdr (l2);
1958 org_l2 = l2;
1960 if (NILP (tail))
1961 value = tem;
1962 else
1963 Fsetcdr (tail, tem);
1964 tail = tem;
1969 DEFUN ("plist-get", Fplist_get, Splist_get, 2, 2, 0,
1970 doc: /* Extract a value from a property list.
1971 PLIST is a property list, which is a list of the form
1972 \(PROP1 VALUE1 PROP2 VALUE2...). This function returns the value
1973 corresponding to the given PROP, or nil if PROP is not
1974 one of the properties on the list. */)
1975 (plist, prop)
1976 Lisp_Object plist;
1977 Lisp_Object prop;
1979 Lisp_Object tail;
1981 for (tail = plist;
1982 CONSP (tail) && CONSP (XCDR (tail));
1983 tail = XCDR (XCDR (tail)))
1985 if (EQ (prop, XCAR (tail)))
1986 return XCAR (XCDR (tail));
1988 /* This function can be called asynchronously
1989 (setup_coding_system). Don't QUIT in that case. */
1990 if (!interrupt_input_blocked)
1991 QUIT;
1994 if (!NILP (tail))
1995 wrong_type_argument (Qlistp, prop);
1997 return Qnil;
2000 DEFUN ("get", Fget, Sget, 2, 2, 0,
2001 doc: /* Return the value of SYMBOL's PROPNAME property.
2002 This is the last value stored with `(put SYMBOL PROPNAME VALUE)'. */)
2003 (symbol, propname)
2004 Lisp_Object symbol, propname;
2006 CHECK_SYMBOL (symbol);
2007 return Fplist_get (XSYMBOL (symbol)->plist, propname);
2010 DEFUN ("plist-put", Fplist_put, Splist_put, 3, 3, 0,
2011 doc: /* Change value in PLIST of PROP to VAL.
2012 PLIST is a property list, which is a list of the form
2013 \(PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol and VAL is any object.
2014 If PROP is already a property on the list, its value is set to VAL,
2015 otherwise the new PROP VAL pair is added. The new plist is returned;
2016 use `(setq x (plist-put x prop val))' to be sure to use the new value.
2017 The PLIST is modified by side effects. */)
2018 (plist, prop, val)
2019 Lisp_Object plist;
2020 register Lisp_Object prop;
2021 Lisp_Object val;
2023 register Lisp_Object tail, prev;
2024 Lisp_Object newcell;
2025 prev = Qnil;
2026 for (tail = plist; CONSP (tail) && CONSP (XCDR (tail));
2027 tail = XCDR (XCDR (tail)))
2029 if (EQ (prop, XCAR (tail)))
2031 Fsetcar (XCDR (tail), val);
2032 return plist;
2035 prev = tail;
2036 QUIT;
2038 newcell = Fcons (prop, Fcons (val, Qnil));
2039 if (NILP (prev))
2040 return newcell;
2041 else
2042 Fsetcdr (XCDR (prev), newcell);
2043 return plist;
2046 DEFUN ("put", Fput, Sput, 3, 3, 0,
2047 doc: /* Store SYMBOL's PROPNAME property with value VALUE.
2048 It can be retrieved with `(get SYMBOL PROPNAME)'. */)
2049 (symbol, propname, value)
2050 Lisp_Object symbol, propname, value;
2052 CHECK_SYMBOL (symbol);
2053 XSYMBOL (symbol)->plist
2054 = Fplist_put (XSYMBOL (symbol)->plist, propname, value);
2055 return value;
2058 DEFUN ("lax-plist-get", Flax_plist_get, Slax_plist_get, 2, 2, 0,
2059 doc: /* Extract a value from a property list, comparing with `equal'.
2060 PLIST is a property list, which is a list of the form
2061 \(PROP1 VALUE1 PROP2 VALUE2...). This function returns the value
2062 corresponding to the given PROP, or nil if PROP is not
2063 one of the properties on the list. */)
2064 (plist, prop)
2065 Lisp_Object plist;
2066 Lisp_Object prop;
2068 Lisp_Object tail;
2070 for (tail = plist;
2071 CONSP (tail) && CONSP (XCDR (tail));
2072 tail = XCDR (XCDR (tail)))
2074 if (! NILP (Fequal (prop, XCAR (tail))))
2075 return XCAR (XCDR (tail));
2077 QUIT;
2080 if (!NILP (tail))
2081 wrong_type_argument (Qlistp, prop);
2083 return Qnil;
2086 DEFUN ("lax-plist-put", Flax_plist_put, Slax_plist_put, 3, 3, 0,
2087 doc: /* Change value in PLIST of PROP to VAL, comparing with `equal'.
2088 PLIST is a property list, which is a list of the form
2089 \(PROP1 VALUE1 PROP2 VALUE2 ...). PROP and VAL are any objects.
2090 If PROP is already a property on the list, its value is set to VAL,
2091 otherwise the new PROP VAL pair is added. The new plist is returned;
2092 use `(setq x (lax-plist-put x prop val))' to be sure to use the new value.
2093 The PLIST is modified by side effects. */)
2094 (plist, prop, val)
2095 Lisp_Object plist;
2096 register Lisp_Object prop;
2097 Lisp_Object val;
2099 register Lisp_Object tail, prev;
2100 Lisp_Object newcell;
2101 prev = Qnil;
2102 for (tail = plist; CONSP (tail) && CONSP (XCDR (tail));
2103 tail = XCDR (XCDR (tail)))
2105 if (! NILP (Fequal (prop, XCAR (tail))))
2107 Fsetcar (XCDR (tail), val);
2108 return plist;
2111 prev = tail;
2112 QUIT;
2114 newcell = Fcons (prop, Fcons (val, Qnil));
2115 if (NILP (prev))
2116 return newcell;
2117 else
2118 Fsetcdr (XCDR (prev), newcell);
2119 return plist;
2122 DEFUN ("eql", Feql, Seql, 2, 2, 0,
2123 doc: /* Return t if the two args are the same Lisp object.
2124 Floating-point numbers of equal value are `eql', but they may not be `eq'. */)
2125 (obj1, obj2)
2126 Lisp_Object obj1, obj2;
2128 if (FLOATP (obj1))
2129 return internal_equal (obj1, obj2, 0, 0) ? Qt : Qnil;
2130 else
2131 return EQ (obj1, obj2) ? Qt : Qnil;
2134 DEFUN ("equal", Fequal, Sequal, 2, 2, 0,
2135 doc: /* Return t if two Lisp objects have similar structure and contents.
2136 They must have the same data type.
2137 Conses are compared by comparing the cars and the cdrs.
2138 Vectors and strings are compared element by element.
2139 Numbers are compared by value, but integers cannot equal floats.
2140 (Use `=' if you want integers and floats to be able to be equal.)
2141 Symbols must match exactly. */)
2142 (o1, o2)
2143 register Lisp_Object o1, o2;
2145 return internal_equal (o1, o2, 0, 0) ? Qt : Qnil;
2148 DEFUN ("equal-including-properties", Fequal_including_properties, Sequal_including_properties, 2, 2, 0,
2149 doc: /* Return t if two Lisp objects have similar structure and contents.
2150 This is like `equal' except that it compares the text properties
2151 of strings. (`equal' ignores text properties.) */)
2152 (o1, o2)
2153 register Lisp_Object o1, o2;
2155 return internal_equal (o1, o2, 0, 1) ? Qt : Qnil;
2158 /* DEPTH is current depth of recursion. Signal an error if it
2159 gets too deep.
2160 PROPS, if non-nil, means compare string text properties too. */
2162 static int
2163 internal_equal (o1, o2, depth, props)
2164 register Lisp_Object o1, o2;
2165 int depth, props;
2167 if (depth > 200)
2168 error ("Stack overflow in equal");
2170 tail_recurse:
2171 QUIT;
2172 if (EQ (o1, o2))
2173 return 1;
2174 if (XTYPE (o1) != XTYPE (o2))
2175 return 0;
2177 switch (XTYPE (o1))
2179 case Lisp_Float:
2181 double d1, d2;
2183 d1 = extract_float (o1);
2184 d2 = extract_float (o2);
2185 /* If d is a NaN, then d != d. Two NaNs should be `equal' even
2186 though they are not =. */
2187 return d1 == d2 || (d1 != d1 && d2 != d2);
2190 case Lisp_Cons:
2191 if (!internal_equal (XCAR (o1), XCAR (o2), depth + 1, props))
2192 return 0;
2193 o1 = XCDR (o1);
2194 o2 = XCDR (o2);
2195 goto tail_recurse;
2197 case Lisp_Misc:
2198 if (XMISCTYPE (o1) != XMISCTYPE (o2))
2199 return 0;
2200 if (OVERLAYP (o1))
2202 if (!internal_equal (OVERLAY_START (o1), OVERLAY_START (o2),
2203 depth + 1, props)
2204 || !internal_equal (OVERLAY_END (o1), OVERLAY_END (o2),
2205 depth + 1))
2206 return 0;
2207 o1 = XOVERLAY (o1)->plist;
2208 o2 = XOVERLAY (o2)->plist;
2209 goto tail_recurse;
2211 if (MARKERP (o1))
2213 return (XMARKER (o1)->buffer == XMARKER (o2)->buffer
2214 && (XMARKER (o1)->buffer == 0
2215 || XMARKER (o1)->bytepos == XMARKER (o2)->bytepos));
2217 break;
2219 case Lisp_Vectorlike:
2221 register int i;
2222 EMACS_INT size = XVECTOR (o1)->size;
2223 /* Pseudovectors have the type encoded in the size field, so this test
2224 actually checks that the objects have the same type as well as the
2225 same size. */
2226 if (XVECTOR (o2)->size != size)
2227 return 0;
2228 /* Boolvectors are compared much like strings. */
2229 if (BOOL_VECTOR_P (o1))
2231 int size_in_chars
2232 = ((XBOOL_VECTOR (o1)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
2233 / BOOL_VECTOR_BITS_PER_CHAR);
2235 if (XBOOL_VECTOR (o1)->size != XBOOL_VECTOR (o2)->size)
2236 return 0;
2237 if (bcmp (XBOOL_VECTOR (o1)->data, XBOOL_VECTOR (o2)->data,
2238 size_in_chars))
2239 return 0;
2240 return 1;
2242 if (WINDOW_CONFIGURATIONP (o1))
2243 return compare_window_configurations (o1, o2, 0);
2245 /* Aside from them, only true vectors, char-tables, and compiled
2246 functions are sensible to compare, so eliminate the others now. */
2247 if (size & PSEUDOVECTOR_FLAG)
2249 if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE)))
2250 return 0;
2251 size &= PSEUDOVECTOR_SIZE_MASK;
2253 for (i = 0; i < size; i++)
2255 Lisp_Object v1, v2;
2256 v1 = XVECTOR (o1)->contents [i];
2257 v2 = XVECTOR (o2)->contents [i];
2258 if (!internal_equal (v1, v2, depth + 1, props))
2259 return 0;
2261 return 1;
2263 break;
2265 case Lisp_String:
2266 if (SCHARS (o1) != SCHARS (o2))
2267 return 0;
2268 if (SBYTES (o1) != SBYTES (o2))
2269 return 0;
2270 if (bcmp (SDATA (o1), SDATA (o2),
2271 SBYTES (o1)))
2272 return 0;
2273 if (props && !compare_string_intervals (o1, o2))
2274 return 0;
2275 return 1;
2277 case Lisp_Int:
2278 case Lisp_Symbol:
2279 case Lisp_Type_Limit:
2280 break;
2283 return 0;
2286 extern Lisp_Object Fmake_char_internal ();
2288 DEFUN ("fillarray", Ffillarray, Sfillarray, 2, 2, 0,
2289 doc: /* Store each element of ARRAY with ITEM.
2290 ARRAY is a vector, string, char-table, or bool-vector. */)
2291 (array, item)
2292 Lisp_Object array, item;
2294 register int size, index, charval;
2295 retry:
2296 if (VECTORP (array))
2298 register Lisp_Object *p = XVECTOR (array)->contents;
2299 size = XVECTOR (array)->size;
2300 for (index = 0; index < size; index++)
2301 p[index] = item;
2303 else if (CHAR_TABLE_P (array))
2305 register Lisp_Object *p = XCHAR_TABLE (array)->contents;
2306 size = CHAR_TABLE_ORDINARY_SLOTS;
2307 for (index = 0; index < size; index++)
2308 p[index] = item;
2309 XCHAR_TABLE (array)->defalt = Qnil;
2311 else if (STRINGP (array))
2313 register unsigned char *p = SDATA (array);
2314 CHECK_NUMBER (item);
2315 charval = XINT (item);
2316 size = SCHARS (array);
2317 if (STRING_MULTIBYTE (array))
2319 unsigned char str[MAX_MULTIBYTE_LENGTH];
2320 int len = CHAR_STRING (charval, str);
2321 int size_byte = SBYTES (array);
2322 unsigned char *p1 = p, *endp = p + size_byte;
2323 int i;
2325 if (size != size_byte)
2326 while (p1 < endp)
2328 int this_len = MULTIBYTE_FORM_LENGTH (p1, endp - p1);
2329 if (len != this_len)
2330 error ("Attempt to change byte length of a string");
2331 p1 += this_len;
2333 for (i = 0; i < size_byte; i++)
2334 *p++ = str[i % len];
2336 else
2337 for (index = 0; index < size; index++)
2338 p[index] = charval;
2340 else if (BOOL_VECTOR_P (array))
2342 register unsigned char *p = XBOOL_VECTOR (array)->data;
2343 int size_in_chars
2344 = ((XBOOL_VECTOR (array)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
2345 / BOOL_VECTOR_BITS_PER_CHAR);
2347 charval = (! NILP (item) ? -1 : 0);
2348 for (index = 0; index < size_in_chars - 1; index++)
2349 p[index] = charval;
2350 if (index < size_in_chars)
2352 /* Mask out bits beyond the vector size. */
2353 if (XBOOL_VECTOR (array)->size % BOOL_VECTOR_BITS_PER_CHAR)
2354 charval &= (1 << (XBOOL_VECTOR (array)->size % BOOL_VECTOR_BITS_PER_CHAR)) - 1;
2355 p[index] = charval;
2358 else
2360 array = wrong_type_argument (Qarrayp, array);
2361 goto retry;
2363 return array;
2366 DEFUN ("clear-string", Fclear_string, Sclear_string,
2367 1, 1, 0,
2368 doc: /* Clear the contents of STRING.
2369 This makes STRING unibyte and may change its length. */)
2370 (string)
2371 Lisp_Object string;
2373 int len = SBYTES (string);
2374 bzero (SDATA (string), len);
2375 STRING_SET_CHARS (string, len);
2376 STRING_SET_UNIBYTE (string);
2377 return Qnil;
2380 DEFUN ("char-table-subtype", Fchar_table_subtype, Schar_table_subtype,
2381 1, 1, 0,
2382 doc: /* Return the subtype of char-table CHAR-TABLE. The value is a symbol. */)
2383 (char_table)
2384 Lisp_Object char_table;
2386 CHECK_CHAR_TABLE (char_table);
2388 return XCHAR_TABLE (char_table)->purpose;
2391 DEFUN ("char-table-parent", Fchar_table_parent, Schar_table_parent,
2392 1, 1, 0,
2393 doc: /* Return the parent char-table of CHAR-TABLE.
2394 The value is either nil or another char-table.
2395 If CHAR-TABLE holds nil for a given character,
2396 then the actual applicable value is inherited from the parent char-table
2397 \(or from its parents, if necessary). */)
2398 (char_table)
2399 Lisp_Object char_table;
2401 CHECK_CHAR_TABLE (char_table);
2403 return XCHAR_TABLE (char_table)->parent;
2406 DEFUN ("set-char-table-parent", Fset_char_table_parent, Sset_char_table_parent,
2407 2, 2, 0,
2408 doc: /* Set the parent char-table of CHAR-TABLE to PARENT.
2409 Return PARENT. PARENT must be either nil or another char-table. */)
2410 (char_table, parent)
2411 Lisp_Object char_table, parent;
2413 Lisp_Object temp;
2415 CHECK_CHAR_TABLE (char_table);
2417 if (!NILP (parent))
2419 CHECK_CHAR_TABLE (parent);
2421 for (temp = parent; !NILP (temp); temp = XCHAR_TABLE (temp)->parent)
2422 if (EQ (temp, char_table))
2423 error ("Attempt to make a chartable be its own parent");
2426 XCHAR_TABLE (char_table)->parent = parent;
2428 return parent;
2431 DEFUN ("char-table-extra-slot", Fchar_table_extra_slot, Schar_table_extra_slot,
2432 2, 2, 0,
2433 doc: /* Return the value of CHAR-TABLE's extra-slot number N. */)
2434 (char_table, n)
2435 Lisp_Object char_table, n;
2437 CHECK_CHAR_TABLE (char_table);
2438 CHECK_NUMBER (n);
2439 if (XINT (n) < 0
2440 || XINT (n) >= CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (char_table)))
2441 args_out_of_range (char_table, n);
2443 return XCHAR_TABLE (char_table)->extras[XINT (n)];
2446 DEFUN ("set-char-table-extra-slot", Fset_char_table_extra_slot,
2447 Sset_char_table_extra_slot,
2448 3, 3, 0,
2449 doc: /* Set CHAR-TABLE's extra-slot number N to VALUE. */)
2450 (char_table, n, value)
2451 Lisp_Object char_table, n, value;
2453 CHECK_CHAR_TABLE (char_table);
2454 CHECK_NUMBER (n);
2455 if (XINT (n) < 0
2456 || XINT (n) >= CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (char_table)))
2457 args_out_of_range (char_table, n);
2459 return XCHAR_TABLE (char_table)->extras[XINT (n)] = value;
2462 DEFUN ("char-table-range", Fchar_table_range, Schar_table_range,
2463 2, 2, 0,
2464 doc: /* Return the value in CHAR-TABLE for a range of characters RANGE.
2465 RANGE should be nil (for the default value)
2466 a vector which identifies a character set or a row of a character set,
2467 a character set name, or a character code. */)
2468 (char_table, range)
2469 Lisp_Object char_table, range;
2471 CHECK_CHAR_TABLE (char_table);
2473 if (EQ (range, Qnil))
2474 return XCHAR_TABLE (char_table)->defalt;
2475 else if (INTEGERP (range))
2476 return Faref (char_table, range);
2477 else if (SYMBOLP (range))
2479 Lisp_Object charset_info;
2481 charset_info = Fget (range, Qcharset);
2482 CHECK_VECTOR (charset_info);
2484 return Faref (char_table,
2485 make_number (XINT (XVECTOR (charset_info)->contents[0])
2486 + 128));
2488 else if (VECTORP (range))
2490 if (XVECTOR (range)->size == 1)
2491 return Faref (char_table,
2492 make_number (XINT (XVECTOR (range)->contents[0]) + 128));
2493 else
2495 int size = XVECTOR (range)->size;
2496 Lisp_Object *val = XVECTOR (range)->contents;
2497 Lisp_Object ch = Fmake_char_internal (size <= 0 ? Qnil : val[0],
2498 size <= 1 ? Qnil : val[1],
2499 size <= 2 ? Qnil : val[2]);
2500 return Faref (char_table, ch);
2503 else
2504 error ("Invalid RANGE argument to `char-table-range'");
2505 return Qt;
2508 DEFUN ("set-char-table-range", Fset_char_table_range, Sset_char_table_range,
2509 3, 3, 0,
2510 doc: /* Set the value in CHAR-TABLE for a range of characters RANGE to VALUE.
2511 RANGE should be t (for all characters), nil (for the default value),
2512 a character set, a vector which identifies a character set, a row of a
2513 character set, or a character code. Return VALUE. */)
2514 (char_table, range, value)
2515 Lisp_Object char_table, range, value;
2517 int i;
2519 CHECK_CHAR_TABLE (char_table);
2521 if (EQ (range, Qt))
2522 for (i = 0; i < CHAR_TABLE_ORDINARY_SLOTS; i++)
2523 XCHAR_TABLE (char_table)->contents[i] = value;
2524 else if (EQ (range, Qnil))
2525 XCHAR_TABLE (char_table)->defalt = value;
2526 else if (SYMBOLP (range))
2528 Lisp_Object charset_info;
2529 int charset_id;
2531 charset_info = Fget (range, Qcharset);
2532 if (! VECTORP (charset_info)
2533 || ! NATNUMP (AREF (charset_info, 0))
2534 || (charset_id = XINT (AREF (charset_info, 0)),
2535 ! CHARSET_DEFINED_P (charset_id)))
2536 error ("Invalid charset: %s", SDATA (SYMBOL_NAME (range)));
2538 if (charset_id == CHARSET_ASCII)
2539 for (i = 0; i < 128; i++)
2540 XCHAR_TABLE (char_table)->contents[i] = value;
2541 else if (charset_id == CHARSET_8_BIT_CONTROL)
2542 for (i = 128; i < 160; i++)
2543 XCHAR_TABLE (char_table)->contents[i] = value;
2544 else if (charset_id == CHARSET_8_BIT_GRAPHIC)
2545 for (i = 160; i < 256; i++)
2546 XCHAR_TABLE (char_table)->contents[i] = value;
2547 else
2548 XCHAR_TABLE (char_table)->contents[charset_id + 128] = value;
2550 else if (INTEGERP (range))
2551 Faset (char_table, range, value);
2552 else if (VECTORP (range))
2554 if (XVECTOR (range)->size == 1)
2555 return Faset (char_table,
2556 make_number (XINT (XVECTOR (range)->contents[0]) + 128),
2557 value);
2558 else
2560 int size = XVECTOR (range)->size;
2561 Lisp_Object *val = XVECTOR (range)->contents;
2562 Lisp_Object ch = Fmake_char_internal (size <= 0 ? Qnil : val[0],
2563 size <= 1 ? Qnil : val[1],
2564 size <= 2 ? Qnil : val[2]);
2565 return Faset (char_table, ch, value);
2568 else
2569 error ("Invalid RANGE argument to `set-char-table-range'");
2571 return value;
2574 DEFUN ("set-char-table-default", Fset_char_table_default,
2575 Sset_char_table_default, 3, 3, 0,
2576 doc: /* Set the default value in CHAR-TABLE for generic character CH to VALUE.
2577 The generic character specifies the group of characters.
2578 See also the documentation of `make-char'. */)
2579 (char_table, ch, value)
2580 Lisp_Object char_table, ch, value;
2582 int c, charset, code1, code2;
2583 Lisp_Object temp;
2585 CHECK_CHAR_TABLE (char_table);
2586 CHECK_NUMBER (ch);
2588 c = XINT (ch);
2589 SPLIT_CHAR (c, charset, code1, code2);
2591 /* Since we may want to set the default value for a character set
2592 not yet defined, we check only if the character set is in the
2593 valid range or not, instead of it is already defined or not. */
2594 if (! CHARSET_VALID_P (charset))
2595 invalid_character (c);
2597 if (charset == CHARSET_ASCII)
2598 return (XCHAR_TABLE (char_table)->defalt = value);
2600 /* Even if C is not a generic char, we had better behave as if a
2601 generic char is specified. */
2602 if (!CHARSET_DEFINED_P (charset) || CHARSET_DIMENSION (charset) == 1)
2603 code1 = 0;
2604 temp = XCHAR_TABLE (char_table)->contents[charset + 128];
2605 if (!code1)
2607 if (SUB_CHAR_TABLE_P (temp))
2608 XCHAR_TABLE (temp)->defalt = value;
2609 else
2610 XCHAR_TABLE (char_table)->contents[charset + 128] = value;
2611 return value;
2613 if (SUB_CHAR_TABLE_P (temp))
2614 char_table = temp;
2615 else
2616 char_table = (XCHAR_TABLE (char_table)->contents[charset + 128]
2617 = make_sub_char_table (temp));
2618 temp = XCHAR_TABLE (char_table)->contents[code1];
2619 if (SUB_CHAR_TABLE_P (temp))
2620 XCHAR_TABLE (temp)->defalt = value;
2621 else
2622 XCHAR_TABLE (char_table)->contents[code1] = value;
2623 return value;
2626 /* Look up the element in TABLE at index CH,
2627 and return it as an integer.
2628 If the element is nil, return CH itself.
2629 (Actually we do that for any non-integer.) */
2632 char_table_translate (table, ch)
2633 Lisp_Object table;
2634 int ch;
2636 Lisp_Object value;
2637 value = Faref (table, make_number (ch));
2638 if (! INTEGERP (value))
2639 return ch;
2640 return XINT (value);
2643 static void
2644 optimize_sub_char_table (table, chars)
2645 Lisp_Object *table;
2646 int chars;
2648 Lisp_Object elt;
2649 int from, to;
2651 if (chars == 94)
2652 from = 33, to = 127;
2653 else
2654 from = 32, to = 128;
2656 if (!SUB_CHAR_TABLE_P (*table))
2657 return;
2658 elt = XCHAR_TABLE (*table)->contents[from++];
2659 for (; from < to; from++)
2660 if (NILP (Fequal (elt, XCHAR_TABLE (*table)->contents[from])))
2661 return;
2662 *table = elt;
2665 DEFUN ("optimize-char-table", Foptimize_char_table, Soptimize_char_table,
2666 1, 1, 0, doc: /* Optimize char table TABLE. */)
2667 (table)
2668 Lisp_Object table;
2670 Lisp_Object elt;
2671 int dim;
2672 int i, j;
2674 CHECK_CHAR_TABLE (table);
2676 for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS; i < CHAR_TABLE_ORDINARY_SLOTS; i++)
2678 elt = XCHAR_TABLE (table)->contents[i];
2679 if (!SUB_CHAR_TABLE_P (elt))
2680 continue;
2681 dim = CHARSET_DIMENSION (i - 128);
2682 if (dim == 2)
2683 for (j = 32; j < SUB_CHAR_TABLE_ORDINARY_SLOTS; j++)
2684 optimize_sub_char_table (XCHAR_TABLE (elt)->contents + j, dim);
2685 optimize_sub_char_table (XCHAR_TABLE (table)->contents + i, dim);
2687 return Qnil;
2691 /* Map C_FUNCTION or FUNCTION over SUBTABLE, calling it for each
2692 character or group of characters that share a value.
2693 DEPTH is the current depth in the originally specified
2694 chartable, and INDICES contains the vector indices
2695 for the levels our callers have descended.
2697 ARG is passed to C_FUNCTION when that is called. */
2699 void
2700 map_char_table (c_function, function, table, subtable, arg, depth, indices)
2701 void (*c_function) P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2702 Lisp_Object function, table, subtable, arg, *indices;
2703 int depth;
2705 int i, to;
2707 if (depth == 0)
2709 /* At first, handle ASCII and 8-bit European characters. */
2710 for (i = 0; i < CHAR_TABLE_SINGLE_BYTE_SLOTS; i++)
2712 Lisp_Object elt= XCHAR_TABLE (subtable)->contents[i];
2713 if (NILP (elt))
2714 elt = XCHAR_TABLE (subtable)->defalt;
2715 if (NILP (elt))
2716 elt = Faref (subtable, make_number (i));
2717 if (c_function)
2718 (*c_function) (arg, make_number (i), elt);
2719 else
2720 call2 (function, make_number (i), elt);
2722 #if 0 /* If the char table has entries for higher characters,
2723 we should report them. */
2724 if (NILP (current_buffer->enable_multibyte_characters))
2725 return;
2726 #endif
2727 to = CHAR_TABLE_ORDINARY_SLOTS;
2729 else
2731 int charset = XFASTINT (indices[0]) - 128;
2733 i = 32;
2734 to = SUB_CHAR_TABLE_ORDINARY_SLOTS;
2735 if (CHARSET_CHARS (charset) == 94)
2736 i++, to--;
2739 for (; i < to; i++)
2741 Lisp_Object elt;
2742 int charset;
2744 elt = XCHAR_TABLE (subtable)->contents[i];
2745 XSETFASTINT (indices[depth], i);
2746 charset = XFASTINT (indices[0]) - 128;
2747 if (depth == 0
2748 && (!CHARSET_DEFINED_P (charset)
2749 || charset == CHARSET_8_BIT_CONTROL
2750 || charset == CHARSET_8_BIT_GRAPHIC))
2751 continue;
2753 if (SUB_CHAR_TABLE_P (elt))
2755 if (depth >= 3)
2756 error ("Too deep char table");
2757 map_char_table (c_function, function, table, elt, arg, depth + 1, indices);
2759 else
2761 int c1, c2, c;
2763 c1 = depth >= 1 ? XFASTINT (indices[1]) : 0;
2764 c2 = depth >= 2 ? XFASTINT (indices[2]) : 0;
2765 c = MAKE_CHAR (charset, c1, c2);
2767 if (NILP (elt))
2768 elt = XCHAR_TABLE (subtable)->defalt;
2769 if (NILP (elt))
2770 elt = Faref (table, make_number (c));
2772 if (c_function)
2773 (*c_function) (arg, make_number (c), elt);
2774 else
2775 call2 (function, make_number (c), elt);
2780 static void void_call2 P_ ((Lisp_Object a, Lisp_Object b, Lisp_Object c));
2781 static void
2782 void_call2 (a, b, c)
2783 Lisp_Object a, b, c;
2785 call2 (a, b, c);
2788 DEFUN ("map-char-table", Fmap_char_table, Smap_char_table,
2789 2, 2, 0,
2790 doc: /* Call FUNCTION for each (normal and generic) characters in CHAR-TABLE.
2791 FUNCTION is called with two arguments--a key and a value.
2792 The key is always a possible IDX argument to `aref'. */)
2793 (function, char_table)
2794 Lisp_Object function, char_table;
2796 /* The depth of char table is at most 3. */
2797 Lisp_Object indices[3];
2799 CHECK_CHAR_TABLE (char_table);
2801 /* When Lisp_Object is represented as a union, `call2' cannot directly
2802 be passed to map_char_table because it returns a Lisp_Object rather
2803 than returning nothing.
2804 Casting leads to crashes on some architectures. -stef */
2805 map_char_table (void_call2, Qnil, char_table, char_table, function, 0, indices);
2806 return Qnil;
2809 /* Return a value for character C in char-table TABLE. Store the
2810 actual index for that value in *IDX. Ignore the default value of
2811 TABLE. */
2813 Lisp_Object
2814 char_table_ref_and_index (table, c, idx)
2815 Lisp_Object table;
2816 int c, *idx;
2818 int charset, c1, c2;
2819 Lisp_Object elt;
2821 if (SINGLE_BYTE_CHAR_P (c))
2823 *idx = c;
2824 return XCHAR_TABLE (table)->contents[c];
2826 SPLIT_CHAR (c, charset, c1, c2);
2827 elt = XCHAR_TABLE (table)->contents[charset + 128];
2828 *idx = MAKE_CHAR (charset, 0, 0);
2829 if (!SUB_CHAR_TABLE_P (elt))
2830 return elt;
2831 if (c1 < 32 || NILP (XCHAR_TABLE (elt)->contents[c1]))
2832 return XCHAR_TABLE (elt)->defalt;
2833 elt = XCHAR_TABLE (elt)->contents[c1];
2834 *idx = MAKE_CHAR (charset, c1, 0);
2835 if (!SUB_CHAR_TABLE_P (elt))
2836 return elt;
2837 if (c2 < 32 || NILP (XCHAR_TABLE (elt)->contents[c2]))
2838 return XCHAR_TABLE (elt)->defalt;
2839 *idx = c;
2840 return XCHAR_TABLE (elt)->contents[c2];
2844 /* ARGSUSED */
2845 Lisp_Object
2846 nconc2 (s1, s2)
2847 Lisp_Object s1, s2;
2849 #ifdef NO_ARG_ARRAY
2850 Lisp_Object args[2];
2851 args[0] = s1;
2852 args[1] = s2;
2853 return Fnconc (2, args);
2854 #else
2855 return Fnconc (2, &s1);
2856 #endif /* NO_ARG_ARRAY */
2859 DEFUN ("nconc", Fnconc, Snconc, 0, MANY, 0,
2860 doc: /* Concatenate any number of lists by altering them.
2861 Only the last argument is not altered, and need not be a list.
2862 usage: (nconc &rest LISTS) */)
2863 (nargs, args)
2864 int nargs;
2865 Lisp_Object *args;
2867 register int argnum;
2868 register Lisp_Object tail, tem, val;
2870 val = tail = Qnil;
2872 for (argnum = 0; argnum < nargs; argnum++)
2874 tem = args[argnum];
2875 if (NILP (tem)) continue;
2877 if (NILP (val))
2878 val = tem;
2880 if (argnum + 1 == nargs) break;
2882 if (!CONSP (tem))
2883 tem = wrong_type_argument (Qlistp, tem);
2885 while (CONSP (tem))
2887 tail = tem;
2888 tem = XCDR (tail);
2889 QUIT;
2892 tem = args[argnum + 1];
2893 Fsetcdr (tail, tem);
2894 if (NILP (tem))
2895 args[argnum + 1] = tail;
2898 return val;
2901 /* This is the guts of all mapping functions.
2902 Apply FN to each element of SEQ, one by one,
2903 storing the results into elements of VALS, a C vector of Lisp_Objects.
2904 LENI is the length of VALS, which should also be the length of SEQ. */
2906 static void
2907 mapcar1 (leni, vals, fn, seq)
2908 int leni;
2909 Lisp_Object *vals;
2910 Lisp_Object fn, seq;
2912 register Lisp_Object tail;
2913 Lisp_Object dummy;
2914 register int i;
2915 struct gcpro gcpro1, gcpro2, gcpro3;
2917 if (vals)
2919 /* Don't let vals contain any garbage when GC happens. */
2920 for (i = 0; i < leni; i++)
2921 vals[i] = Qnil;
2923 GCPRO3 (dummy, fn, seq);
2924 gcpro1.var = vals;
2925 gcpro1.nvars = leni;
2927 else
2928 GCPRO2 (fn, seq);
2929 /* We need not explicitly protect `tail' because it is used only on lists, and
2930 1) lists are not relocated and 2) the list is marked via `seq' so will not be freed */
2932 if (VECTORP (seq))
2934 for (i = 0; i < leni; i++)
2936 dummy = XVECTOR (seq)->contents[i];
2937 dummy = call1 (fn, dummy);
2938 if (vals)
2939 vals[i] = dummy;
2942 else if (BOOL_VECTOR_P (seq))
2944 for (i = 0; i < leni; i++)
2946 int byte;
2947 byte = XBOOL_VECTOR (seq)->data[i / BOOL_VECTOR_BITS_PER_CHAR];
2948 if (byte & (1 << (i % BOOL_VECTOR_BITS_PER_CHAR)))
2949 dummy = Qt;
2950 else
2951 dummy = Qnil;
2953 dummy = call1 (fn, dummy);
2954 if (vals)
2955 vals[i] = dummy;
2958 else if (STRINGP (seq))
2960 int i_byte;
2962 for (i = 0, i_byte = 0; i < leni;)
2964 int c;
2965 int i_before = i;
2967 FETCH_STRING_CHAR_ADVANCE (c, seq, i, i_byte);
2968 XSETFASTINT (dummy, c);
2969 dummy = call1 (fn, dummy);
2970 if (vals)
2971 vals[i_before] = dummy;
2974 else /* Must be a list, since Flength did not get an error */
2976 tail = seq;
2977 for (i = 0; i < leni; i++)
2979 dummy = call1 (fn, Fcar (tail));
2980 if (vals)
2981 vals[i] = dummy;
2982 tail = XCDR (tail);
2986 UNGCPRO;
2989 DEFUN ("mapconcat", Fmapconcat, Smapconcat, 3, 3, 0,
2990 doc: /* Apply FUNCTION to each element of SEQUENCE, and concat the results as strings.
2991 In between each pair of results, stick in SEPARATOR. Thus, " " as
2992 SEPARATOR results in spaces between the values returned by FUNCTION.
2993 SEQUENCE may be a list, a vector, a bool-vector, or a string. */)
2994 (function, sequence, separator)
2995 Lisp_Object function, sequence, separator;
2997 Lisp_Object len;
2998 register int leni;
2999 int nargs;
3000 register Lisp_Object *args;
3001 register int i;
3002 struct gcpro gcpro1;
3003 Lisp_Object ret;
3004 USE_SAFE_ALLOCA;
3006 len = Flength (sequence);
3007 leni = XINT (len);
3008 nargs = leni + leni - 1;
3009 if (nargs < 0) return build_string ("");
3011 SAFE_ALLOCA_LISP (args, nargs);
3013 GCPRO1 (separator);
3014 mapcar1 (leni, args, function, sequence);
3015 UNGCPRO;
3017 for (i = leni - 1; i >= 0; i--)
3018 args[i + i] = args[i];
3020 for (i = 1; i < nargs; i += 2)
3021 args[i] = separator;
3023 ret = Fconcat (nargs, args);
3024 SAFE_FREE_LISP (nargs);
3026 return ret;
3029 DEFUN ("mapcar", Fmapcar, Smapcar, 2, 2, 0,
3030 doc: /* Apply FUNCTION to each element of SEQUENCE, and make a list of the results.
3031 The result is a list just as long as SEQUENCE.
3032 SEQUENCE may be a list, a vector, a bool-vector, or a string. */)
3033 (function, sequence)
3034 Lisp_Object function, sequence;
3036 register Lisp_Object len;
3037 register int leni;
3038 register Lisp_Object *args;
3039 Lisp_Object ret;
3040 USE_SAFE_ALLOCA;
3042 len = Flength (sequence);
3043 leni = XFASTINT (len);
3045 SAFE_ALLOCA_LISP (args, leni);
3047 mapcar1 (leni, args, function, sequence);
3049 ret = Flist (leni, args);
3050 SAFE_FREE_LISP (leni);
3052 return ret;
3055 DEFUN ("mapc", Fmapc, Smapc, 2, 2, 0,
3056 doc: /* Apply FUNCTION to each element of SEQUENCE for side effects only.
3057 Unlike `mapcar', don't accumulate the results. Return SEQUENCE.
3058 SEQUENCE may be a list, a vector, a bool-vector, or a string. */)
3059 (function, sequence)
3060 Lisp_Object function, sequence;
3062 register int leni;
3064 leni = XFASTINT (Flength (sequence));
3065 mapcar1 (leni, 0, function, sequence);
3067 return sequence;
3070 /* Anything that calls this function must protect from GC! */
3072 DEFUN ("y-or-n-p", Fy_or_n_p, Sy_or_n_p, 1, 1, 0,
3073 doc: /* Ask user a "y or n" question. Return t if answer is "y".
3074 Takes one argument, which is the string to display to ask the question.
3075 It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
3076 No confirmation of the answer is requested; a single character is enough.
3077 Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses
3078 the bindings in `query-replace-map'; see the documentation of that variable
3079 for more information. In this case, the useful bindings are `act', `skip',
3080 `recenter', and `quit'.\)
3082 Under a windowing system a dialog box will be used if `last-nonmenu-event'
3083 is nil and `use-dialog-box' is non-nil. */)
3084 (prompt)
3085 Lisp_Object prompt;
3087 register Lisp_Object obj, key, def, map;
3088 register int answer;
3089 Lisp_Object xprompt;
3090 Lisp_Object args[2];
3091 struct gcpro gcpro1, gcpro2;
3092 int count = SPECPDL_INDEX ();
3094 specbind (Qcursor_in_echo_area, Qt);
3096 map = Fsymbol_value (intern ("query-replace-map"));
3098 CHECK_STRING (prompt);
3099 xprompt = prompt;
3100 GCPRO2 (prompt, xprompt);
3102 #ifdef HAVE_X_WINDOWS
3103 if (display_hourglass_p)
3104 cancel_hourglass ();
3105 #endif
3107 while (1)
3110 #ifdef HAVE_MENUS
3111 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3112 && use_dialog_box
3113 && have_menus_p ())
3115 Lisp_Object pane, menu;
3116 redisplay_preserve_echo_area (3);
3117 pane = Fcons (Fcons (build_string ("Yes"), Qt),
3118 Fcons (Fcons (build_string ("No"), Qnil),
3119 Qnil));
3120 menu = Fcons (prompt, pane);
3121 obj = Fx_popup_dialog (Qt, menu);
3122 answer = !NILP (obj);
3123 break;
3125 #endif /* HAVE_MENUS */
3126 cursor_in_echo_area = 1;
3127 choose_minibuf_frame ();
3130 Lisp_Object pargs[3];
3132 /* Colorize prompt according to `minibuffer-prompt' face. */
3133 pargs[0] = build_string ("%s(y or n) ");
3134 pargs[1] = intern ("face");
3135 pargs[2] = intern ("minibuffer-prompt");
3136 args[0] = Fpropertize (3, pargs);
3137 args[1] = xprompt;
3138 Fmessage (2, args);
3141 if (minibuffer_auto_raise)
3143 Lisp_Object mini_frame;
3145 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
3147 Fraise_frame (mini_frame);
3150 obj = read_filtered_event (1, 0, 0, 0);
3151 cursor_in_echo_area = 0;
3152 /* If we need to quit, quit with cursor_in_echo_area = 0. */
3153 QUIT;
3155 key = Fmake_vector (make_number (1), obj);
3156 def = Flookup_key (map, key, Qt);
3158 if (EQ (def, intern ("skip")))
3160 answer = 0;
3161 break;
3163 else if (EQ (def, intern ("act")))
3165 answer = 1;
3166 break;
3168 else if (EQ (def, intern ("recenter")))
3170 Frecenter (Qnil);
3171 xprompt = prompt;
3172 continue;
3174 else if (EQ (def, intern ("quit")))
3175 Vquit_flag = Qt;
3176 /* We want to exit this command for exit-prefix,
3177 and this is the only way to do it. */
3178 else if (EQ (def, intern ("exit-prefix")))
3179 Vquit_flag = Qt;
3181 QUIT;
3183 /* If we don't clear this, then the next call to read_char will
3184 return quit_char again, and we'll enter an infinite loop. */
3185 Vquit_flag = Qnil;
3187 Fding (Qnil);
3188 Fdiscard_input ();
3189 if (EQ (xprompt, prompt))
3191 args[0] = build_string ("Please answer y or n. ");
3192 args[1] = prompt;
3193 xprompt = Fconcat (2, args);
3196 UNGCPRO;
3198 if (! noninteractive)
3200 cursor_in_echo_area = -1;
3201 message_with_string (answer ? "%s(y or n) y" : "%s(y or n) n",
3202 xprompt, 0);
3205 unbind_to (count, Qnil);
3206 return answer ? Qt : Qnil;
3209 /* This is how C code calls `yes-or-no-p' and allows the user
3210 to redefined it.
3212 Anything that calls this function must protect from GC! */
3214 Lisp_Object
3215 do_yes_or_no_p (prompt)
3216 Lisp_Object prompt;
3218 return call1 (intern ("yes-or-no-p"), prompt);
3221 /* Anything that calls this function must protect from GC! */
3223 DEFUN ("yes-or-no-p", Fyes_or_no_p, Syes_or_no_p, 1, 1, 0,
3224 doc: /* Ask user a yes-or-no question. Return t if answer is yes.
3225 Takes one argument, which is the string to display to ask the question.
3226 It should end in a space; `yes-or-no-p' adds `(yes or no) ' to it.
3227 The user must confirm the answer with RET,
3228 and can edit it until it has been confirmed.
3230 Under a windowing system a dialog box will be used if `last-nonmenu-event'
3231 is nil, and `use-dialog-box' is non-nil. */)
3232 (prompt)
3233 Lisp_Object prompt;
3235 register Lisp_Object ans;
3236 Lisp_Object args[2];
3237 struct gcpro gcpro1;
3239 CHECK_STRING (prompt);
3241 #ifdef HAVE_MENUS
3242 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3243 && use_dialog_box
3244 && have_menus_p ())
3246 Lisp_Object pane, menu, obj;
3247 redisplay_preserve_echo_area (4);
3248 pane = Fcons (Fcons (build_string ("Yes"), Qt),
3249 Fcons (Fcons (build_string ("No"), Qnil),
3250 Qnil));
3251 GCPRO1 (pane);
3252 menu = Fcons (prompt, pane);
3253 obj = Fx_popup_dialog (Qt, menu);
3254 UNGCPRO;
3255 return obj;
3257 #endif /* HAVE_MENUS */
3259 args[0] = prompt;
3260 args[1] = build_string ("(yes or no) ");
3261 prompt = Fconcat (2, args);
3263 GCPRO1 (prompt);
3265 while (1)
3267 ans = Fdowncase (Fread_from_minibuffer (prompt, Qnil, Qnil, Qnil,
3268 Qyes_or_no_p_history, Qnil,
3269 Qnil));
3270 if (SCHARS (ans) == 3 && !strcmp (SDATA (ans), "yes"))
3272 UNGCPRO;
3273 return Qt;
3275 if (SCHARS (ans) == 2 && !strcmp (SDATA (ans), "no"))
3277 UNGCPRO;
3278 return Qnil;
3281 Fding (Qnil);
3282 Fdiscard_input ();
3283 message ("Please answer yes or no.");
3284 Fsleep_for (make_number (2), Qnil);
3288 DEFUN ("load-average", Fload_average, Sload_average, 0, 1, 0,
3289 doc: /* Return list of 1 minute, 5 minute and 15 minute load averages.
3291 Each of the three load averages is multiplied by 100, then converted
3292 to integer.
3294 When USE-FLOATS is non-nil, floats will be used instead of integers.
3295 These floats are not multiplied by 100.
3297 If the 5-minute or 15-minute load averages are not available, return a
3298 shortened list, containing only those averages which are available.
3300 An error is thrown if the load average can't be obtained. In some
3301 cases making it work would require Emacs being installed setuid or
3302 setgid so that it can read kernel information, and that usually isn't
3303 advisable. */)
3304 (use_floats)
3305 Lisp_Object use_floats;
3307 double load_ave[3];
3308 int loads = getloadavg (load_ave, 3);
3309 Lisp_Object ret = Qnil;
3311 if (loads < 0)
3312 error ("load-average not implemented for this operating system");
3314 while (loads-- > 0)
3316 Lisp_Object load = (NILP (use_floats) ?
3317 make_number ((int) (100.0 * load_ave[loads]))
3318 : make_float (load_ave[loads]));
3319 ret = Fcons (load, ret);
3322 return ret;
3325 Lisp_Object Vfeatures, Qsubfeatures;
3326 extern Lisp_Object Vafter_load_alist;
3328 DEFUN ("featurep", Ffeaturep, Sfeaturep, 1, 2, 0,
3329 doc: /* Returns t if FEATURE is present in this Emacs.
3331 Use this to conditionalize execution of lisp code based on the
3332 presence or absence of emacs or environment extensions.
3333 Use `provide' to declare that a feature is available. This function
3334 looks at the value of the variable `features'. The optional argument
3335 SUBFEATURE can be used to check a specific subfeature of FEATURE. */)
3336 (feature, subfeature)
3337 Lisp_Object feature, subfeature;
3339 register Lisp_Object tem;
3340 CHECK_SYMBOL (feature);
3341 tem = Fmemq (feature, Vfeatures);
3342 if (!NILP (tem) && !NILP (subfeature))
3343 tem = Fmember (subfeature, Fget (feature, Qsubfeatures));
3344 return (NILP (tem)) ? Qnil : Qt;
3347 DEFUN ("provide", Fprovide, Sprovide, 1, 2, 0,
3348 doc: /* Announce that FEATURE is a feature of the current Emacs.
3349 The optional argument SUBFEATURES should be a list of symbols listing
3350 particular subfeatures supported in this version of FEATURE. */)
3351 (feature, subfeatures)
3352 Lisp_Object feature, subfeatures;
3354 register Lisp_Object tem;
3355 CHECK_SYMBOL (feature);
3356 CHECK_LIST (subfeatures);
3357 if (!NILP (Vautoload_queue))
3358 Vautoload_queue = Fcons (Fcons (Vfeatures, Qnil), Vautoload_queue);
3359 tem = Fmemq (feature, Vfeatures);
3360 if (NILP (tem))
3361 Vfeatures = Fcons (feature, Vfeatures);
3362 if (!NILP (subfeatures))
3363 Fput (feature, Qsubfeatures, subfeatures);
3364 LOADHIST_ATTACH (Fcons (Qprovide, feature));
3366 /* Run any load-hooks for this file. */
3367 tem = Fassq (feature, Vafter_load_alist);
3368 if (CONSP (tem))
3369 Fprogn (XCDR (tem));
3371 return feature;
3374 /* `require' and its subroutines. */
3376 /* List of features currently being require'd, innermost first. */
3378 Lisp_Object require_nesting_list;
3380 Lisp_Object
3381 require_unwind (old_value)
3382 Lisp_Object old_value;
3384 return require_nesting_list = old_value;
3387 DEFUN ("require", Frequire, Srequire, 1, 3, 0,
3388 doc: /* If feature FEATURE is not loaded, load it from FILENAME.
3389 If FEATURE is not a member of the list `features', then the feature
3390 is not loaded; so load the file FILENAME.
3391 If FILENAME is omitted, the printname of FEATURE is used as the file name,
3392 and `load' will try to load this name appended with the suffix `.elc' or
3393 `.el', in that order. The name without appended suffix will not be used.
3394 If the optional third argument NOERROR is non-nil,
3395 then return nil if the file is not found instead of signaling an error.
3396 Normally the return value is FEATURE.
3397 The normal messages at start and end of loading FILENAME are suppressed. */)
3398 (feature, filename, noerror)
3399 Lisp_Object feature, filename, noerror;
3401 register Lisp_Object tem;
3402 struct gcpro gcpro1, gcpro2;
3404 CHECK_SYMBOL (feature);
3406 tem = Fmemq (feature, Vfeatures);
3408 if (NILP (tem))
3410 int count = SPECPDL_INDEX ();
3411 int nesting = 0;
3413 LOADHIST_ATTACH (Fcons (Qrequire, feature));
3415 /* This is to make sure that loadup.el gives a clear picture
3416 of what files are preloaded and when. */
3417 if (! NILP (Vpurify_flag))
3418 error ("(require %s) while preparing to dump",
3419 SDATA (SYMBOL_NAME (feature)));
3421 /* A certain amount of recursive `require' is legitimate,
3422 but if we require the same feature recursively 3 times,
3423 signal an error. */
3424 tem = require_nesting_list;
3425 while (! NILP (tem))
3427 if (! NILP (Fequal (feature, XCAR (tem))))
3428 nesting++;
3429 tem = XCDR (tem);
3431 if (nesting > 3)
3432 error ("Recursive `require' for feature `%s'",
3433 SDATA (SYMBOL_NAME (feature)));
3435 /* Update the list for any nested `require's that occur. */
3436 record_unwind_protect (require_unwind, require_nesting_list);
3437 require_nesting_list = Fcons (feature, require_nesting_list);
3439 /* Value saved here is to be restored into Vautoload_queue */
3440 record_unwind_protect (un_autoload, Vautoload_queue);
3441 Vautoload_queue = Qt;
3443 /* Load the file. */
3444 GCPRO2 (feature, filename);
3445 tem = Fload (NILP (filename) ? Fsymbol_name (feature) : filename,
3446 noerror, Qt, Qnil, (NILP (filename) ? Qt : Qnil));
3447 UNGCPRO;
3449 /* If load failed entirely, return nil. */
3450 if (NILP (tem))
3451 return unbind_to (count, Qnil);
3453 tem = Fmemq (feature, Vfeatures);
3454 if (NILP (tem))
3455 error ("Required feature `%s' was not provided",
3456 SDATA (SYMBOL_NAME (feature)));
3458 /* Once loading finishes, don't undo it. */
3459 Vautoload_queue = Qt;
3460 feature = unbind_to (count, feature);
3463 return feature;
3466 /* Primitives for work of the "widget" library.
3467 In an ideal world, this section would not have been necessary.
3468 However, lisp function calls being as slow as they are, it turns
3469 out that some functions in the widget library (wid-edit.el) are the
3470 bottleneck of Widget operation. Here is their translation to C,
3471 for the sole reason of efficiency. */
3473 DEFUN ("plist-member", Fplist_member, Splist_member, 2, 2, 0,
3474 doc: /* Return non-nil if PLIST has the property PROP.
3475 PLIST is a property list, which is a list of the form
3476 \(PROP1 VALUE1 PROP2 VALUE2 ...\). PROP is a symbol.
3477 Unlike `plist-get', this allows you to distinguish between a missing
3478 property and a property with the value nil.
3479 The value is actually the tail of PLIST whose car is PROP. */)
3480 (plist, prop)
3481 Lisp_Object plist, prop;
3483 while (CONSP (plist) && !EQ (XCAR (plist), prop))
3485 QUIT;
3486 plist = XCDR (plist);
3487 plist = CDR (plist);
3489 return plist;
3492 DEFUN ("widget-put", Fwidget_put, Swidget_put, 3, 3, 0,
3493 doc: /* In WIDGET, set PROPERTY to VALUE.
3494 The value can later be retrieved with `widget-get'. */)
3495 (widget, property, value)
3496 Lisp_Object widget, property, value;
3498 CHECK_CONS (widget);
3499 XSETCDR (widget, Fplist_put (XCDR (widget), property, value));
3500 return value;
3503 DEFUN ("widget-get", Fwidget_get, Swidget_get, 2, 2, 0,
3504 doc: /* In WIDGET, get the value of PROPERTY.
3505 The value could either be specified when the widget was created, or
3506 later with `widget-put'. */)
3507 (widget, property)
3508 Lisp_Object widget, property;
3510 Lisp_Object tmp;
3512 while (1)
3514 if (NILP (widget))
3515 return Qnil;
3516 CHECK_CONS (widget);
3517 tmp = Fplist_member (XCDR (widget), property);
3518 if (CONSP (tmp))
3520 tmp = XCDR (tmp);
3521 return CAR (tmp);
3523 tmp = XCAR (widget);
3524 if (NILP (tmp))
3525 return Qnil;
3526 widget = Fget (tmp, Qwidget_type);
3530 DEFUN ("widget-apply", Fwidget_apply, Swidget_apply, 2, MANY, 0,
3531 doc: /* Apply the value of WIDGET's PROPERTY to the widget itself.
3532 ARGS are passed as extra arguments to the function.
3533 usage: (widget-apply WIDGET PROPERTY &rest ARGS) */)
3534 (nargs, args)
3535 int nargs;
3536 Lisp_Object *args;
3538 /* This function can GC. */
3539 Lisp_Object newargs[3];
3540 struct gcpro gcpro1, gcpro2;
3541 Lisp_Object result;
3543 newargs[0] = Fwidget_get (args[0], args[1]);
3544 newargs[1] = args[0];
3545 newargs[2] = Flist (nargs - 2, args + 2);
3546 GCPRO2 (newargs[0], newargs[2]);
3547 result = Fapply (3, newargs);
3548 UNGCPRO;
3549 return result;
3552 #ifdef HAVE_LANGINFO_CODESET
3553 #include <langinfo.h>
3554 #endif
3556 DEFUN ("locale-info", Flocale_info, Slocale_info, 1, 1, 0,
3557 doc: /* Access locale data ITEM for the current C locale, if available.
3558 ITEM should be one of the following:
3560 `codeset', returning the character set as a string (locale item CODESET);
3562 `days', returning a 7-element vector of day names (locale items DAY_n);
3564 `months', returning a 12-element vector of month names (locale items MON_n);
3566 `paper', returning a list (WIDTH HEIGHT) for the default paper size,
3567 both measured in milimeters (locale items PAPER_WIDTH, PAPER_HEIGHT).
3569 If the system can't provide such information through a call to
3570 `nl_langinfo', or if ITEM isn't from the list above, return nil.
3572 See also Info node `(libc)Locales'.
3574 The data read from the system are decoded using `locale-coding-system'. */)
3575 (item)
3576 Lisp_Object item;
3578 char *str = NULL;
3579 #ifdef HAVE_LANGINFO_CODESET
3580 Lisp_Object val;
3581 if (EQ (item, Qcodeset))
3583 str = nl_langinfo (CODESET);
3584 return build_string (str);
3586 #ifdef DAY_1
3587 else if (EQ (item, Qdays)) /* e.g. for calendar-day-name-array */
3589 Lisp_Object v = Fmake_vector (make_number (7), Qnil);
3590 int days[7] = {DAY_1, DAY_2, DAY_3, DAY_4, DAY_5, DAY_6, DAY_7};
3591 int i;
3592 synchronize_system_time_locale ();
3593 for (i = 0; i < 7; i++)
3595 str = nl_langinfo (days[i]);
3596 val = make_unibyte_string (str, strlen (str));
3597 /* Fixme: Is this coding system necessarily right, even if
3598 it is consistent with CODESET? If not, what to do? */
3599 Faset (v, make_number (i),
3600 code_convert_string_norecord (val, Vlocale_coding_system,
3601 0));
3603 return v;
3605 #endif /* DAY_1 */
3606 #ifdef MON_1
3607 else if (EQ (item, Qmonths)) /* e.g. for calendar-month-name-array */
3609 struct Lisp_Vector *p = allocate_vector (12);
3610 int months[12] = {MON_1, MON_2, MON_3, MON_4, MON_5, MON_6, MON_7,
3611 MON_8, MON_9, MON_10, MON_11, MON_12};
3612 int i;
3613 synchronize_system_time_locale ();
3614 for (i = 0; i < 12; i++)
3616 str = nl_langinfo (months[i]);
3617 val = make_unibyte_string (str, strlen (str));
3618 p->contents[i] =
3619 code_convert_string_norecord (val, Vlocale_coding_system, 0);
3621 XSETVECTOR (val, p);
3622 return val;
3624 #endif /* MON_1 */
3625 /* LC_PAPER stuff isn't defined as accessible in glibc as of 2.3.1,
3626 but is in the locale files. This could be used by ps-print. */
3627 #ifdef PAPER_WIDTH
3628 else if (EQ (item, Qpaper))
3630 return list2 (make_number (nl_langinfo (PAPER_WIDTH)),
3631 make_number (nl_langinfo (PAPER_HEIGHT)));
3633 #endif /* PAPER_WIDTH */
3634 #endif /* HAVE_LANGINFO_CODESET*/
3635 return Qnil;
3638 /* base64 encode/decode functions (RFC 2045).
3639 Based on code from GNU recode. */
3641 #define MIME_LINE_LENGTH 76
3643 #define IS_ASCII(Character) \
3644 ((Character) < 128)
3645 #define IS_BASE64(Character) \
3646 (IS_ASCII (Character) && base64_char_to_value[Character] >= 0)
3647 #define IS_BASE64_IGNORABLE(Character) \
3648 ((Character) == ' ' || (Character) == '\t' || (Character) == '\n' \
3649 || (Character) == '\f' || (Character) == '\r')
3651 /* Used by base64_decode_1 to retrieve a non-base64-ignorable
3652 character or return retval if there are no characters left to
3653 process. */
3654 #define READ_QUADRUPLET_BYTE(retval) \
3655 do \
3657 if (i == length) \
3659 if (nchars_return) \
3660 *nchars_return = nchars; \
3661 return (retval); \
3663 c = from[i++]; \
3665 while (IS_BASE64_IGNORABLE (c))
3667 /* Table of characters coding the 64 values. */
3668 static char base64_value_to_char[64] =
3670 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', /* 0- 9 */
3671 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', /* 10-19 */
3672 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', /* 20-29 */
3673 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', /* 30-39 */
3674 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', /* 40-49 */
3675 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', /* 50-59 */
3676 '8', '9', '+', '/' /* 60-63 */
3679 /* Table of base64 values for first 128 characters. */
3680 static short base64_char_to_value[128] =
3682 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 0- 9 */
3683 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 10- 19 */
3684 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 20- 29 */
3685 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 30- 39 */
3686 -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, /* 40- 49 */
3687 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, /* 50- 59 */
3688 -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, /* 60- 69 */
3689 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, /* 70- 79 */
3690 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, /* 80- 89 */
3691 25, -1, -1, -1, -1, -1, -1, 26, 27, 28, /* 90- 99 */
3692 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, /* 100-109 */
3693 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, /* 110-119 */
3694 49, 50, 51, -1, -1, -1, -1, -1 /* 120-127 */
3697 /* The following diagram shows the logical steps by which three octets
3698 get transformed into four base64 characters.
3700 .--------. .--------. .--------.
3701 |aaaaaabb| |bbbbcccc| |ccdddddd|
3702 `--------' `--------' `--------'
3703 6 2 4 4 2 6
3704 .--------+--------+--------+--------.
3705 |00aaaaaa|00bbbbbb|00cccccc|00dddddd|
3706 `--------+--------+--------+--------'
3708 .--------+--------+--------+--------.
3709 |AAAAAAAA|BBBBBBBB|CCCCCCCC|DDDDDDDD|
3710 `--------+--------+--------+--------'
3712 The octets are divided into 6 bit chunks, which are then encoded into
3713 base64 characters. */
3716 static int base64_encode_1 P_ ((const char *, char *, int, int, int));
3717 static int base64_decode_1 P_ ((const char *, char *, int, int, int *));
3719 DEFUN ("base64-encode-region", Fbase64_encode_region, Sbase64_encode_region,
3720 2, 3, "r",
3721 doc: /* Base64-encode the region between BEG and END.
3722 Return the length of the encoded text.
3723 Optional third argument NO-LINE-BREAK means do not break long lines
3724 into shorter lines. */)
3725 (beg, end, no_line_break)
3726 Lisp_Object beg, end, no_line_break;
3728 char *encoded;
3729 int allength, length;
3730 int ibeg, iend, encoded_length;
3731 int old_pos = PT;
3732 USE_SAFE_ALLOCA;
3734 validate_region (&beg, &end);
3736 ibeg = CHAR_TO_BYTE (XFASTINT (beg));
3737 iend = CHAR_TO_BYTE (XFASTINT (end));
3738 move_gap_both (XFASTINT (beg), ibeg);
3740 /* We need to allocate enough room for encoding the text.
3741 We need 33 1/3% more space, plus a newline every 76
3742 characters, and then we round up. */
3743 length = iend - ibeg;
3744 allength = length + length/3 + 1;
3745 allength += allength / MIME_LINE_LENGTH + 1 + 6;
3747 SAFE_ALLOCA (encoded, char *, allength);
3748 encoded_length = base64_encode_1 (BYTE_POS_ADDR (ibeg), encoded, length,
3749 NILP (no_line_break),
3750 !NILP (current_buffer->enable_multibyte_characters));
3751 if (encoded_length > allength)
3752 abort ();
3754 if (encoded_length < 0)
3756 /* The encoding wasn't possible. */
3757 SAFE_FREE (allength);
3758 error ("Multibyte character in data for base64 encoding");
3761 /* Now we have encoded the region, so we insert the new contents
3762 and delete the old. (Insert first in order to preserve markers.) */
3763 SET_PT_BOTH (XFASTINT (beg), ibeg);
3764 insert (encoded, encoded_length);
3765 SAFE_FREE (allength);
3766 del_range_byte (ibeg + encoded_length, iend + encoded_length, 1);
3768 /* If point was outside of the region, restore it exactly; else just
3769 move to the beginning of the region. */
3770 if (old_pos >= XFASTINT (end))
3771 old_pos += encoded_length - (XFASTINT (end) - XFASTINT (beg));
3772 else if (old_pos > XFASTINT (beg))
3773 old_pos = XFASTINT (beg);
3774 SET_PT (old_pos);
3776 /* We return the length of the encoded text. */
3777 return make_number (encoded_length);
3780 DEFUN ("base64-encode-string", Fbase64_encode_string, Sbase64_encode_string,
3781 1, 2, 0,
3782 doc: /* Base64-encode STRING and return the result.
3783 Optional second argument NO-LINE-BREAK means do not break long lines
3784 into shorter lines. */)
3785 (string, no_line_break)
3786 Lisp_Object string, no_line_break;
3788 int allength, length, encoded_length;
3789 char *encoded;
3790 Lisp_Object encoded_string;
3791 USE_SAFE_ALLOCA;
3793 CHECK_STRING (string);
3795 /* We need to allocate enough room for encoding the text.
3796 We need 33 1/3% more space, plus a newline every 76
3797 characters, and then we round up. */
3798 length = SBYTES (string);
3799 allength = length + length/3 + 1;
3800 allength += allength / MIME_LINE_LENGTH + 1 + 6;
3802 /* We need to allocate enough room for decoding the text. */
3803 SAFE_ALLOCA (encoded, char *, allength);
3805 encoded_length = base64_encode_1 (SDATA (string),
3806 encoded, length, NILP (no_line_break),
3807 STRING_MULTIBYTE (string));
3808 if (encoded_length > allength)
3809 abort ();
3811 if (encoded_length < 0)
3813 /* The encoding wasn't possible. */
3814 SAFE_FREE (allength);
3815 error ("Multibyte character in data for base64 encoding");
3818 encoded_string = make_unibyte_string (encoded, encoded_length);
3819 SAFE_FREE (allength);
3821 return encoded_string;
3824 static int
3825 base64_encode_1 (from, to, length, line_break, multibyte)
3826 const char *from;
3827 char *to;
3828 int length;
3829 int line_break;
3830 int multibyte;
3832 int counter = 0, i = 0;
3833 char *e = to;
3834 int c;
3835 unsigned int value;
3836 int bytes;
3838 while (i < length)
3840 if (multibyte)
3842 c = STRING_CHAR_AND_LENGTH (from + i, length - i, bytes);
3843 if (c >= 256)
3844 return -1;
3845 i += bytes;
3847 else
3848 c = from[i++];
3850 /* Wrap line every 76 characters. */
3852 if (line_break)
3854 if (counter < MIME_LINE_LENGTH / 4)
3855 counter++;
3856 else
3858 *e++ = '\n';
3859 counter = 1;
3863 /* Process first byte of a triplet. */
3865 *e++ = base64_value_to_char[0x3f & c >> 2];
3866 value = (0x03 & c) << 4;
3868 /* Process second byte of a triplet. */
3870 if (i == length)
3872 *e++ = base64_value_to_char[value];
3873 *e++ = '=';
3874 *e++ = '=';
3875 break;
3878 if (multibyte)
3880 c = STRING_CHAR_AND_LENGTH (from + i, length - i, bytes);
3881 if (c >= 256)
3882 return -1;
3883 i += bytes;
3885 else
3886 c = from[i++];
3888 *e++ = base64_value_to_char[value | (0x0f & c >> 4)];
3889 value = (0x0f & c) << 2;
3891 /* Process third byte of a triplet. */
3893 if (i == length)
3895 *e++ = base64_value_to_char[value];
3896 *e++ = '=';
3897 break;
3900 if (multibyte)
3902 c = STRING_CHAR_AND_LENGTH (from + i, length - i, bytes);
3903 if (c >= 256)
3904 return -1;
3905 i += bytes;
3907 else
3908 c = from[i++];
3910 *e++ = base64_value_to_char[value | (0x03 & c >> 6)];
3911 *e++ = base64_value_to_char[0x3f & c];
3914 return e - to;
3918 DEFUN ("base64-decode-region", Fbase64_decode_region, Sbase64_decode_region,
3919 2, 2, "r",
3920 doc: /* Base64-decode the region between BEG and END.
3921 Return the length of the decoded text.
3922 If the region can't be decoded, signal an error and don't modify the buffer. */)
3923 (beg, end)
3924 Lisp_Object beg, end;
3926 int ibeg, iend, length, allength;
3927 char *decoded;
3928 int old_pos = PT;
3929 int decoded_length;
3930 int inserted_chars;
3931 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
3932 USE_SAFE_ALLOCA;
3934 validate_region (&beg, &end);
3936 ibeg = CHAR_TO_BYTE (XFASTINT (beg));
3937 iend = CHAR_TO_BYTE (XFASTINT (end));
3939 length = iend - ibeg;
3941 /* We need to allocate enough room for decoding the text. If we are
3942 working on a multibyte buffer, each decoded code may occupy at
3943 most two bytes. */
3944 allength = multibyte ? length * 2 : length;
3945 SAFE_ALLOCA (decoded, char *, allength);
3947 move_gap_both (XFASTINT (beg), ibeg);
3948 decoded_length = base64_decode_1 (BYTE_POS_ADDR (ibeg), decoded, length,
3949 multibyte, &inserted_chars);
3950 if (decoded_length > allength)
3951 abort ();
3953 if (decoded_length < 0)
3955 /* The decoding wasn't possible. */
3956 SAFE_FREE (allength);
3957 error ("Invalid base64 data");
3960 /* Now we have decoded the region, so we insert the new contents
3961 and delete the old. (Insert first in order to preserve markers.) */
3962 TEMP_SET_PT_BOTH (XFASTINT (beg), ibeg);
3963 insert_1_both (decoded, inserted_chars, decoded_length, 0, 1, 0);
3964 SAFE_FREE (allength);
3966 /* Delete the original text. */
3967 del_range_both (PT, PT_BYTE, XFASTINT (end) + inserted_chars,
3968 iend + decoded_length, 1);
3970 /* If point was outside of the region, restore it exactly; else just
3971 move to the beginning of the region. */
3972 if (old_pos >= XFASTINT (end))
3973 old_pos += inserted_chars - (XFASTINT (end) - XFASTINT (beg));
3974 else if (old_pos > XFASTINT (beg))
3975 old_pos = XFASTINT (beg);
3976 SET_PT (old_pos > ZV ? ZV : old_pos);
3978 return make_number (inserted_chars);
3981 DEFUN ("base64-decode-string", Fbase64_decode_string, Sbase64_decode_string,
3982 1, 1, 0,
3983 doc: /* Base64-decode STRING and return the result. */)
3984 (string)
3985 Lisp_Object string;
3987 char *decoded;
3988 int length, decoded_length;
3989 Lisp_Object decoded_string;
3990 USE_SAFE_ALLOCA;
3992 CHECK_STRING (string);
3994 length = SBYTES (string);
3995 /* We need to allocate enough room for decoding the text. */
3996 SAFE_ALLOCA (decoded, char *, length);
3998 /* The decoded result should be unibyte. */
3999 decoded_length = base64_decode_1 (SDATA (string), decoded, length,
4000 0, NULL);
4001 if (decoded_length > length)
4002 abort ();
4003 else if (decoded_length >= 0)
4004 decoded_string = make_unibyte_string (decoded, decoded_length);
4005 else
4006 decoded_string = Qnil;
4008 SAFE_FREE (length);
4009 if (!STRINGP (decoded_string))
4010 error ("Invalid base64 data");
4012 return decoded_string;
4015 /* Base64-decode the data at FROM of LENGHT bytes into TO. If
4016 MULTIBYTE is nonzero, the decoded result should be in multibyte
4017 form. If NCHARS_RETRUN is not NULL, store the number of produced
4018 characters in *NCHARS_RETURN. */
4020 static int
4021 base64_decode_1 (from, to, length, multibyte, nchars_return)
4022 const char *from;
4023 char *to;
4024 int length;
4025 int multibyte;
4026 int *nchars_return;
4028 int i = 0;
4029 char *e = to;
4030 unsigned char c;
4031 unsigned long value;
4032 int nchars = 0;
4034 while (1)
4036 /* Process first byte of a quadruplet. */
4038 READ_QUADRUPLET_BYTE (e-to);
4040 if (!IS_BASE64 (c))
4041 return -1;
4042 value = base64_char_to_value[c] << 18;
4044 /* Process second byte of a quadruplet. */
4046 READ_QUADRUPLET_BYTE (-1);
4048 if (!IS_BASE64 (c))
4049 return -1;
4050 value |= base64_char_to_value[c] << 12;
4052 c = (unsigned char) (value >> 16);
4053 if (multibyte)
4054 e += CHAR_STRING (c, e);
4055 else
4056 *e++ = c;
4057 nchars++;
4059 /* Process third byte of a quadruplet. */
4061 READ_QUADRUPLET_BYTE (-1);
4063 if (c == '=')
4065 READ_QUADRUPLET_BYTE (-1);
4067 if (c != '=')
4068 return -1;
4069 continue;
4072 if (!IS_BASE64 (c))
4073 return -1;
4074 value |= base64_char_to_value[c] << 6;
4076 c = (unsigned char) (0xff & value >> 8);
4077 if (multibyte)
4078 e += CHAR_STRING (c, e);
4079 else
4080 *e++ = c;
4081 nchars++;
4083 /* Process fourth byte of a quadruplet. */
4085 READ_QUADRUPLET_BYTE (-1);
4087 if (c == '=')
4088 continue;
4090 if (!IS_BASE64 (c))
4091 return -1;
4092 value |= base64_char_to_value[c];
4094 c = (unsigned char) (0xff & value);
4095 if (multibyte)
4096 e += CHAR_STRING (c, e);
4097 else
4098 *e++ = c;
4099 nchars++;
4105 /***********************************************************************
4106 ***** *****
4107 ***** Hash Tables *****
4108 ***** *****
4109 ***********************************************************************/
4111 /* Implemented by gerd@gnu.org. This hash table implementation was
4112 inspired by CMUCL hash tables. */
4114 /* Ideas:
4116 1. For small tables, association lists are probably faster than
4117 hash tables because they have lower overhead.
4119 For uses of hash tables where the O(1) behavior of table
4120 operations is not a requirement, it might therefore be a good idea
4121 not to hash. Instead, we could just do a linear search in the
4122 key_and_value vector of the hash table. This could be done
4123 if a `:linear-search t' argument is given to make-hash-table. */
4126 /* The list of all weak hash tables. Don't staticpro this one. */
4128 Lisp_Object Vweak_hash_tables;
4130 /* Various symbols. */
4132 Lisp_Object Qhash_table_p, Qeq, Qeql, Qequal, Qkey, Qvalue;
4133 Lisp_Object QCtest, QCsize, QCrehash_size, QCrehash_threshold, QCweakness;
4134 Lisp_Object Qhash_table_test, Qkey_or_value, Qkey_and_value;
4136 /* Function prototypes. */
4138 static struct Lisp_Hash_Table *check_hash_table P_ ((Lisp_Object));
4139 static int get_key_arg P_ ((Lisp_Object, int, Lisp_Object *, char *));
4140 static void maybe_resize_hash_table P_ ((struct Lisp_Hash_Table *));
4141 static int cmpfn_eql P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned,
4142 Lisp_Object, unsigned));
4143 static int cmpfn_equal P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned,
4144 Lisp_Object, unsigned));
4145 static int cmpfn_user_defined P_ ((struct Lisp_Hash_Table *, Lisp_Object,
4146 unsigned, Lisp_Object, unsigned));
4147 static unsigned hashfn_eq P_ ((struct Lisp_Hash_Table *, Lisp_Object));
4148 static unsigned hashfn_eql P_ ((struct Lisp_Hash_Table *, Lisp_Object));
4149 static unsigned hashfn_equal P_ ((struct Lisp_Hash_Table *, Lisp_Object));
4150 static unsigned hashfn_user_defined P_ ((struct Lisp_Hash_Table *,
4151 Lisp_Object));
4152 static unsigned sxhash_string P_ ((unsigned char *, int));
4153 static unsigned sxhash_list P_ ((Lisp_Object, int));
4154 static unsigned sxhash_vector P_ ((Lisp_Object, int));
4155 static unsigned sxhash_bool_vector P_ ((Lisp_Object));
4156 static int sweep_weak_table P_ ((struct Lisp_Hash_Table *, int));
4160 /***********************************************************************
4161 Utilities
4162 ***********************************************************************/
4164 /* If OBJ is a Lisp hash table, return a pointer to its struct
4165 Lisp_Hash_Table. Otherwise, signal an error. */
4167 static struct Lisp_Hash_Table *
4168 check_hash_table (obj)
4169 Lisp_Object obj;
4171 CHECK_HASH_TABLE (obj);
4172 return XHASH_TABLE (obj);
4176 /* Value is the next integer I >= N, N >= 0 which is "almost" a prime
4177 number. */
4180 next_almost_prime (n)
4181 int n;
4183 if (n % 2 == 0)
4184 n += 1;
4185 if (n % 3 == 0)
4186 n += 2;
4187 if (n % 7 == 0)
4188 n += 4;
4189 return n;
4193 /* Find KEY in ARGS which has size NARGS. Don't consider indices for
4194 which USED[I] is non-zero. If found at index I in ARGS, set
4195 USED[I] and USED[I + 1] to 1, and return I + 1. Otherwise return
4196 -1. This function is used to extract a keyword/argument pair from
4197 a DEFUN parameter list. */
4199 static int
4200 get_key_arg (key, nargs, args, used)
4201 Lisp_Object key;
4202 int nargs;
4203 Lisp_Object *args;
4204 char *used;
4206 int i;
4208 for (i = 0; i < nargs - 1; ++i)
4209 if (!used[i] && EQ (args[i], key))
4210 break;
4212 if (i >= nargs - 1)
4213 i = -1;
4214 else
4216 used[i++] = 1;
4217 used[i] = 1;
4220 return i;
4224 /* Return a Lisp vector which has the same contents as VEC but has
4225 size NEW_SIZE, NEW_SIZE >= VEC->size. Entries in the resulting
4226 vector that are not copied from VEC are set to INIT. */
4228 Lisp_Object
4229 larger_vector (vec, new_size, init)
4230 Lisp_Object vec;
4231 int new_size;
4232 Lisp_Object init;
4234 struct Lisp_Vector *v;
4235 int i, old_size;
4237 xassert (VECTORP (vec));
4238 old_size = XVECTOR (vec)->size;
4239 xassert (new_size >= old_size);
4241 v = allocate_vector (new_size);
4242 bcopy (XVECTOR (vec)->contents, v->contents,
4243 old_size * sizeof *v->contents);
4244 for (i = old_size; i < new_size; ++i)
4245 v->contents[i] = init;
4246 XSETVECTOR (vec, v);
4247 return vec;
4251 /***********************************************************************
4252 Low-level Functions
4253 ***********************************************************************/
4255 /* Compare KEY1 which has hash code HASH1 and KEY2 with hash code
4256 HASH2 in hash table H using `eql'. Value is non-zero if KEY1 and
4257 KEY2 are the same. */
4259 static int
4260 cmpfn_eql (h, key1, hash1, key2, hash2)
4261 struct Lisp_Hash_Table *h;
4262 Lisp_Object key1, key2;
4263 unsigned hash1, hash2;
4265 return (FLOATP (key1)
4266 && FLOATP (key2)
4267 && XFLOAT_DATA (key1) == XFLOAT_DATA (key2));
4271 /* Compare KEY1 which has hash code HASH1 and KEY2 with hash code
4272 HASH2 in hash table H using `equal'. Value is non-zero if KEY1 and
4273 KEY2 are the same. */
4275 static int
4276 cmpfn_equal (h, key1, hash1, key2, hash2)
4277 struct Lisp_Hash_Table *h;
4278 Lisp_Object key1, key2;
4279 unsigned hash1, hash2;
4281 return hash1 == hash2 && !NILP (Fequal (key1, key2));
4285 /* Compare KEY1 which has hash code HASH1, and KEY2 with hash code
4286 HASH2 in hash table H using H->user_cmp_function. Value is non-zero
4287 if KEY1 and KEY2 are the same. */
4289 static int
4290 cmpfn_user_defined (h, key1, hash1, key2, hash2)
4291 struct Lisp_Hash_Table *h;
4292 Lisp_Object key1, key2;
4293 unsigned hash1, hash2;
4295 if (hash1 == hash2)
4297 Lisp_Object args[3];
4299 args[0] = h->user_cmp_function;
4300 args[1] = key1;
4301 args[2] = key2;
4302 return !NILP (Ffuncall (3, args));
4304 else
4305 return 0;
4309 /* Value is a hash code for KEY for use in hash table H which uses
4310 `eq' to compare keys. The hash code returned is guaranteed to fit
4311 in a Lisp integer. */
4313 static unsigned
4314 hashfn_eq (h, key)
4315 struct Lisp_Hash_Table *h;
4316 Lisp_Object key;
4318 unsigned hash = XUINT (key) ^ XGCTYPE (key);
4319 xassert ((hash & ~INTMASK) == 0);
4320 return hash;
4324 /* Value is a hash code for KEY for use in hash table H which uses
4325 `eql' to compare keys. The hash code returned is guaranteed to fit
4326 in a Lisp integer. */
4328 static unsigned
4329 hashfn_eql (h, key)
4330 struct Lisp_Hash_Table *h;
4331 Lisp_Object key;
4333 unsigned hash;
4334 if (FLOATP (key))
4335 hash = sxhash (key, 0);
4336 else
4337 hash = XUINT (key) ^ XGCTYPE (key);
4338 xassert ((hash & ~INTMASK) == 0);
4339 return hash;
4343 /* Value is a hash code for KEY for use in hash table H which uses
4344 `equal' to compare keys. The hash code returned is guaranteed to fit
4345 in a Lisp integer. */
4347 static unsigned
4348 hashfn_equal (h, key)
4349 struct Lisp_Hash_Table *h;
4350 Lisp_Object key;
4352 unsigned hash = sxhash (key, 0);
4353 xassert ((hash & ~INTMASK) == 0);
4354 return hash;
4358 /* Value is a hash code for KEY for use in hash table H which uses as
4359 user-defined function to compare keys. The hash code returned is
4360 guaranteed to fit in a Lisp integer. */
4362 static unsigned
4363 hashfn_user_defined (h, key)
4364 struct Lisp_Hash_Table *h;
4365 Lisp_Object key;
4367 Lisp_Object args[2], hash;
4369 args[0] = h->user_hash_function;
4370 args[1] = key;
4371 hash = Ffuncall (2, args);
4372 if (!INTEGERP (hash))
4373 Fsignal (Qerror,
4374 list2 (build_string ("Invalid hash code returned from \
4375 user-supplied hash function"),
4376 hash));
4377 return XUINT (hash);
4381 /* Create and initialize a new hash table.
4383 TEST specifies the test the hash table will use to compare keys.
4384 It must be either one of the predefined tests `eq', `eql' or
4385 `equal' or a symbol denoting a user-defined test named TEST with
4386 test and hash functions USER_TEST and USER_HASH.
4388 Give the table initial capacity SIZE, SIZE >= 0, an integer.
4390 If REHASH_SIZE is an integer, it must be > 0, and this hash table's
4391 new size when it becomes full is computed by adding REHASH_SIZE to
4392 its old size. If REHASH_SIZE is a float, it must be > 1.0, and the
4393 table's new size is computed by multiplying its old size with
4394 REHASH_SIZE.
4396 REHASH_THRESHOLD must be a float <= 1.0, and > 0. The table will
4397 be resized when the ratio of (number of entries in the table) /
4398 (table size) is >= REHASH_THRESHOLD.
4400 WEAK specifies the weakness of the table. If non-nil, it must be
4401 one of the symbols `key', `value', `key-or-value', or `key-and-value'. */
4403 Lisp_Object
4404 make_hash_table (test, size, rehash_size, rehash_threshold, weak,
4405 user_test, user_hash)
4406 Lisp_Object test, size, rehash_size, rehash_threshold, weak;
4407 Lisp_Object user_test, user_hash;
4409 struct Lisp_Hash_Table *h;
4410 Lisp_Object table;
4411 int index_size, i, sz;
4413 /* Preconditions. */
4414 xassert (SYMBOLP (test));
4415 xassert (INTEGERP (size) && XINT (size) >= 0);
4416 xassert ((INTEGERP (rehash_size) && XINT (rehash_size) > 0)
4417 || (FLOATP (rehash_size) && XFLOATINT (rehash_size) > 1.0));
4418 xassert (FLOATP (rehash_threshold)
4419 && XFLOATINT (rehash_threshold) > 0
4420 && XFLOATINT (rehash_threshold) <= 1.0);
4422 if (XFASTINT (size) == 0)
4423 size = make_number (1);
4425 /* Allocate a table and initialize it. */
4426 h = allocate_hash_table ();
4428 /* Initialize hash table slots. */
4429 sz = XFASTINT (size);
4431 h->test = test;
4432 if (EQ (test, Qeql))
4434 h->cmpfn = cmpfn_eql;
4435 h->hashfn = hashfn_eql;
4437 else if (EQ (test, Qeq))
4439 h->cmpfn = NULL;
4440 h->hashfn = hashfn_eq;
4442 else if (EQ (test, Qequal))
4444 h->cmpfn = cmpfn_equal;
4445 h->hashfn = hashfn_equal;
4447 else
4449 h->user_cmp_function = user_test;
4450 h->user_hash_function = user_hash;
4451 h->cmpfn = cmpfn_user_defined;
4452 h->hashfn = hashfn_user_defined;
4455 h->weak = weak;
4456 h->rehash_threshold = rehash_threshold;
4457 h->rehash_size = rehash_size;
4458 h->count = make_number (0);
4459 h->key_and_value = Fmake_vector (make_number (2 * sz), Qnil);
4460 h->hash = Fmake_vector (size, Qnil);
4461 h->next = Fmake_vector (size, Qnil);
4462 /* Cast to int here avoids losing with gcc 2.95 on Tru64/Alpha... */
4463 index_size = next_almost_prime ((int) (sz / XFLOATINT (rehash_threshold)));
4464 h->index = Fmake_vector (make_number (index_size), Qnil);
4466 /* Set up the free list. */
4467 for (i = 0; i < sz - 1; ++i)
4468 HASH_NEXT (h, i) = make_number (i + 1);
4469 h->next_free = make_number (0);
4471 XSET_HASH_TABLE (table, h);
4472 xassert (HASH_TABLE_P (table));
4473 xassert (XHASH_TABLE (table) == h);
4475 /* Maybe add this hash table to the list of all weak hash tables. */
4476 if (NILP (h->weak))
4477 h->next_weak = Qnil;
4478 else
4480 h->next_weak = Vweak_hash_tables;
4481 Vweak_hash_tables = table;
4484 return table;
4488 /* Return a copy of hash table H1. Keys and values are not copied,
4489 only the table itself is. */
4491 Lisp_Object
4492 copy_hash_table (h1)
4493 struct Lisp_Hash_Table *h1;
4495 Lisp_Object table;
4496 struct Lisp_Hash_Table *h2;
4497 struct Lisp_Vector *next;
4499 h2 = allocate_hash_table ();
4500 next = h2->vec_next;
4501 bcopy (h1, h2, sizeof *h2);
4502 h2->vec_next = next;
4503 h2->key_and_value = Fcopy_sequence (h1->key_and_value);
4504 h2->hash = Fcopy_sequence (h1->hash);
4505 h2->next = Fcopy_sequence (h1->next);
4506 h2->index = Fcopy_sequence (h1->index);
4507 XSET_HASH_TABLE (table, h2);
4509 /* Maybe add this hash table to the list of all weak hash tables. */
4510 if (!NILP (h2->weak))
4512 h2->next_weak = Vweak_hash_tables;
4513 Vweak_hash_tables = table;
4516 return table;
4520 /* Resize hash table H if it's too full. If H cannot be resized
4521 because it's already too large, throw an error. */
4523 static INLINE void
4524 maybe_resize_hash_table (h)
4525 struct Lisp_Hash_Table *h;
4527 if (NILP (h->next_free))
4529 int old_size = HASH_TABLE_SIZE (h);
4530 int i, new_size, index_size;
4532 if (INTEGERP (h->rehash_size))
4533 new_size = old_size + XFASTINT (h->rehash_size);
4534 else
4535 new_size = old_size * XFLOATINT (h->rehash_size);
4536 new_size = max (old_size + 1, new_size);
4537 index_size = next_almost_prime ((int)
4538 (new_size
4539 / XFLOATINT (h->rehash_threshold)));
4540 if (max (index_size, 2 * new_size) > MOST_POSITIVE_FIXNUM)
4541 error ("Hash table too large to resize");
4543 h->key_and_value = larger_vector (h->key_and_value, 2 * new_size, Qnil);
4544 h->next = larger_vector (h->next, new_size, Qnil);
4545 h->hash = larger_vector (h->hash, new_size, Qnil);
4546 h->index = Fmake_vector (make_number (index_size), Qnil);
4548 /* Update the free list. Do it so that new entries are added at
4549 the end of the free list. This makes some operations like
4550 maphash faster. */
4551 for (i = old_size; i < new_size - 1; ++i)
4552 HASH_NEXT (h, i) = make_number (i + 1);
4554 if (!NILP (h->next_free))
4556 Lisp_Object last, next;
4558 last = h->next_free;
4559 while (next = HASH_NEXT (h, XFASTINT (last)),
4560 !NILP (next))
4561 last = next;
4563 HASH_NEXT (h, XFASTINT (last)) = make_number (old_size);
4565 else
4566 XSETFASTINT (h->next_free, old_size);
4568 /* Rehash. */
4569 for (i = 0; i < old_size; ++i)
4570 if (!NILP (HASH_HASH (h, i)))
4572 unsigned hash_code = XUINT (HASH_HASH (h, i));
4573 int start_of_bucket = hash_code % XVECTOR (h->index)->size;
4574 HASH_NEXT (h, i) = HASH_INDEX (h, start_of_bucket);
4575 HASH_INDEX (h, start_of_bucket) = make_number (i);
4581 /* Lookup KEY in hash table H. If HASH is non-null, return in *HASH
4582 the hash code of KEY. Value is the index of the entry in H
4583 matching KEY, or -1 if not found. */
4586 hash_lookup (h, key, hash)
4587 struct Lisp_Hash_Table *h;
4588 Lisp_Object key;
4589 unsigned *hash;
4591 unsigned hash_code;
4592 int start_of_bucket;
4593 Lisp_Object idx;
4595 hash_code = h->hashfn (h, key);
4596 if (hash)
4597 *hash = hash_code;
4599 start_of_bucket = hash_code % XVECTOR (h->index)->size;
4600 idx = HASH_INDEX (h, start_of_bucket);
4602 /* We need not gcpro idx since it's either an integer or nil. */
4603 while (!NILP (idx))
4605 int i = XFASTINT (idx);
4606 if (EQ (key, HASH_KEY (h, i))
4607 || (h->cmpfn
4608 && h->cmpfn (h, key, hash_code,
4609 HASH_KEY (h, i), XUINT (HASH_HASH (h, i)))))
4610 break;
4611 idx = HASH_NEXT (h, i);
4614 return NILP (idx) ? -1 : XFASTINT (idx);
4618 /* Put an entry into hash table H that associates KEY with VALUE.
4619 HASH is a previously computed hash code of KEY.
4620 Value is the index of the entry in H matching KEY. */
4623 hash_put (h, key, value, hash)
4624 struct Lisp_Hash_Table *h;
4625 Lisp_Object key, value;
4626 unsigned hash;
4628 int start_of_bucket, i;
4630 xassert ((hash & ~INTMASK) == 0);
4632 /* Increment count after resizing because resizing may fail. */
4633 maybe_resize_hash_table (h);
4634 h->count = make_number (XFASTINT (h->count) + 1);
4636 /* Store key/value in the key_and_value vector. */
4637 i = XFASTINT (h->next_free);
4638 h->next_free = HASH_NEXT (h, i);
4639 HASH_KEY (h, i) = key;
4640 HASH_VALUE (h, i) = value;
4642 /* Remember its hash code. */
4643 HASH_HASH (h, i) = make_number (hash);
4645 /* Add new entry to its collision chain. */
4646 start_of_bucket = hash % XVECTOR (h->index)->size;
4647 HASH_NEXT (h, i) = HASH_INDEX (h, start_of_bucket);
4648 HASH_INDEX (h, start_of_bucket) = make_number (i);
4649 return i;
4653 /* Remove the entry matching KEY from hash table H, if there is one. */
4655 void
4656 hash_remove (h, key)
4657 struct Lisp_Hash_Table *h;
4658 Lisp_Object key;
4660 unsigned hash_code;
4661 int start_of_bucket;
4662 Lisp_Object idx, prev;
4664 hash_code = h->hashfn (h, key);
4665 start_of_bucket = hash_code % XVECTOR (h->index)->size;
4666 idx = HASH_INDEX (h, start_of_bucket);
4667 prev = Qnil;
4669 /* We need not gcpro idx, prev since they're either integers or nil. */
4670 while (!NILP (idx))
4672 int i = XFASTINT (idx);
4674 if (EQ (key, HASH_KEY (h, i))
4675 || (h->cmpfn
4676 && h->cmpfn (h, key, hash_code,
4677 HASH_KEY (h, i), XUINT (HASH_HASH (h, i)))))
4679 /* Take entry out of collision chain. */
4680 if (NILP (prev))
4681 HASH_INDEX (h, start_of_bucket) = HASH_NEXT (h, i);
4682 else
4683 HASH_NEXT (h, XFASTINT (prev)) = HASH_NEXT (h, i);
4685 /* Clear slots in key_and_value and add the slots to
4686 the free list. */
4687 HASH_KEY (h, i) = HASH_VALUE (h, i) = HASH_HASH (h, i) = Qnil;
4688 HASH_NEXT (h, i) = h->next_free;
4689 h->next_free = make_number (i);
4690 h->count = make_number (XFASTINT (h->count) - 1);
4691 xassert (XINT (h->count) >= 0);
4692 break;
4694 else
4696 prev = idx;
4697 idx = HASH_NEXT (h, i);
4703 /* Clear hash table H. */
4705 void
4706 hash_clear (h)
4707 struct Lisp_Hash_Table *h;
4709 if (XFASTINT (h->count) > 0)
4711 int i, size = HASH_TABLE_SIZE (h);
4713 for (i = 0; i < size; ++i)
4715 HASH_NEXT (h, i) = i < size - 1 ? make_number (i + 1) : Qnil;
4716 HASH_KEY (h, i) = Qnil;
4717 HASH_VALUE (h, i) = Qnil;
4718 HASH_HASH (h, i) = Qnil;
4721 for (i = 0; i < XVECTOR (h->index)->size; ++i)
4722 XVECTOR (h->index)->contents[i] = Qnil;
4724 h->next_free = make_number (0);
4725 h->count = make_number (0);
4731 /************************************************************************
4732 Weak Hash Tables
4733 ************************************************************************/
4735 /* Sweep weak hash table H. REMOVE_ENTRIES_P non-zero means remove
4736 entries from the table that don't survive the current GC.
4737 REMOVE_ENTRIES_P zero means mark entries that are in use. Value is
4738 non-zero if anything was marked. */
4740 static int
4741 sweep_weak_table (h, remove_entries_p)
4742 struct Lisp_Hash_Table *h;
4743 int remove_entries_p;
4745 int bucket, n, marked;
4747 n = XVECTOR (h->index)->size & ~ARRAY_MARK_FLAG;
4748 marked = 0;
4750 for (bucket = 0; bucket < n; ++bucket)
4752 Lisp_Object idx, next, prev;
4754 /* Follow collision chain, removing entries that
4755 don't survive this garbage collection. */
4756 prev = Qnil;
4757 for (idx = HASH_INDEX (h, bucket); !GC_NILP (idx); idx = next)
4759 int i = XFASTINT (idx);
4760 int key_known_to_survive_p = survives_gc_p (HASH_KEY (h, i));
4761 int value_known_to_survive_p = survives_gc_p (HASH_VALUE (h, i));
4762 int remove_p;
4764 if (EQ (h->weak, Qkey))
4765 remove_p = !key_known_to_survive_p;
4766 else if (EQ (h->weak, Qvalue))
4767 remove_p = !value_known_to_survive_p;
4768 else if (EQ (h->weak, Qkey_or_value))
4769 remove_p = !(key_known_to_survive_p || value_known_to_survive_p);
4770 else if (EQ (h->weak, Qkey_and_value))
4771 remove_p = !(key_known_to_survive_p && value_known_to_survive_p);
4772 else
4773 abort ();
4775 next = HASH_NEXT (h, i);
4777 if (remove_entries_p)
4779 if (remove_p)
4781 /* Take out of collision chain. */
4782 if (GC_NILP (prev))
4783 HASH_INDEX (h, bucket) = next;
4784 else
4785 HASH_NEXT (h, XFASTINT (prev)) = next;
4787 /* Add to free list. */
4788 HASH_NEXT (h, i) = h->next_free;
4789 h->next_free = idx;
4791 /* Clear key, value, and hash. */
4792 HASH_KEY (h, i) = HASH_VALUE (h, i) = Qnil;
4793 HASH_HASH (h, i) = Qnil;
4795 h->count = make_number (XFASTINT (h->count) - 1);
4798 else
4800 if (!remove_p)
4802 /* Make sure key and value survive. */
4803 if (!key_known_to_survive_p)
4805 mark_object (HASH_KEY (h, i));
4806 marked = 1;
4809 if (!value_known_to_survive_p)
4811 mark_object (HASH_VALUE (h, i));
4812 marked = 1;
4819 return marked;
4822 /* Remove elements from weak hash tables that don't survive the
4823 current garbage collection. Remove weak tables that don't survive
4824 from Vweak_hash_tables. Called from gc_sweep. */
4826 void
4827 sweep_weak_hash_tables ()
4829 Lisp_Object table, used, next;
4830 struct Lisp_Hash_Table *h;
4831 int marked;
4833 /* Mark all keys and values that are in use. Keep on marking until
4834 there is no more change. This is necessary for cases like
4835 value-weak table A containing an entry X -> Y, where Y is used in a
4836 key-weak table B, Z -> Y. If B comes after A in the list of weak
4837 tables, X -> Y might be removed from A, although when looking at B
4838 one finds that it shouldn't. */
4841 marked = 0;
4842 for (table = Vweak_hash_tables; !GC_NILP (table); table = h->next_weak)
4844 h = XHASH_TABLE (table);
4845 if (h->size & ARRAY_MARK_FLAG)
4846 marked |= sweep_weak_table (h, 0);
4849 while (marked);
4851 /* Remove tables and entries that aren't used. */
4852 for (table = Vweak_hash_tables, used = Qnil; !GC_NILP (table); table = next)
4854 h = XHASH_TABLE (table);
4855 next = h->next_weak;
4857 if (h->size & ARRAY_MARK_FLAG)
4859 /* TABLE is marked as used. Sweep its contents. */
4860 if (XFASTINT (h->count) > 0)
4861 sweep_weak_table (h, 1);
4863 /* Add table to the list of used weak hash tables. */
4864 h->next_weak = used;
4865 used = table;
4869 Vweak_hash_tables = used;
4874 /***********************************************************************
4875 Hash Code Computation
4876 ***********************************************************************/
4878 /* Maximum depth up to which to dive into Lisp structures. */
4880 #define SXHASH_MAX_DEPTH 3
4882 /* Maximum length up to which to take list and vector elements into
4883 account. */
4885 #define SXHASH_MAX_LEN 7
4887 /* Combine two integers X and Y for hashing. */
4889 #define SXHASH_COMBINE(X, Y) \
4890 ((((unsigned)(X) << 4) + (((unsigned)(X) >> 24) & 0x0fffffff)) \
4891 + (unsigned)(Y))
4894 /* Return a hash for string PTR which has length LEN. The hash
4895 code returned is guaranteed to fit in a Lisp integer. */
4897 static unsigned
4898 sxhash_string (ptr, len)
4899 unsigned char *ptr;
4900 int len;
4902 unsigned char *p = ptr;
4903 unsigned char *end = p + len;
4904 unsigned char c;
4905 unsigned hash = 0;
4907 while (p != end)
4909 c = *p++;
4910 if (c >= 0140)
4911 c -= 40;
4912 hash = ((hash << 3) + (hash >> 28) + c);
4915 return hash & INTMASK;
4919 /* Return a hash for list LIST. DEPTH is the current depth in the
4920 list. We don't recurse deeper than SXHASH_MAX_DEPTH in it. */
4922 static unsigned
4923 sxhash_list (list, depth)
4924 Lisp_Object list;
4925 int depth;
4927 unsigned hash = 0;
4928 int i;
4930 if (depth < SXHASH_MAX_DEPTH)
4931 for (i = 0;
4932 CONSP (list) && i < SXHASH_MAX_LEN;
4933 list = XCDR (list), ++i)
4935 unsigned hash2 = sxhash (XCAR (list), depth + 1);
4936 hash = SXHASH_COMBINE (hash, hash2);
4939 return hash;
4943 /* Return a hash for vector VECTOR. DEPTH is the current depth in
4944 the Lisp structure. */
4946 static unsigned
4947 sxhash_vector (vec, depth)
4948 Lisp_Object vec;
4949 int depth;
4951 unsigned hash = XVECTOR (vec)->size;
4952 int i, n;
4954 n = min (SXHASH_MAX_LEN, XVECTOR (vec)->size);
4955 for (i = 0; i < n; ++i)
4957 unsigned hash2 = sxhash (XVECTOR (vec)->contents[i], depth + 1);
4958 hash = SXHASH_COMBINE (hash, hash2);
4961 return hash;
4965 /* Return a hash for bool-vector VECTOR. */
4967 static unsigned
4968 sxhash_bool_vector (vec)
4969 Lisp_Object vec;
4971 unsigned hash = XBOOL_VECTOR (vec)->size;
4972 int i, n;
4974 n = min (SXHASH_MAX_LEN, XBOOL_VECTOR (vec)->vector_size);
4975 for (i = 0; i < n; ++i)
4976 hash = SXHASH_COMBINE (hash, XBOOL_VECTOR (vec)->data[i]);
4978 return hash;
4982 /* Return a hash code for OBJ. DEPTH is the current depth in the Lisp
4983 structure. Value is an unsigned integer clipped to INTMASK. */
4985 unsigned
4986 sxhash (obj, depth)
4987 Lisp_Object obj;
4988 int depth;
4990 unsigned hash;
4992 if (depth > SXHASH_MAX_DEPTH)
4993 return 0;
4995 switch (XTYPE (obj))
4997 case Lisp_Int:
4998 hash = XUINT (obj);
4999 break;
5001 case Lisp_Symbol:
5002 hash = sxhash_string (SDATA (SYMBOL_NAME (obj)),
5003 SCHARS (SYMBOL_NAME (obj)));
5004 break;
5006 case Lisp_Misc:
5007 hash = XUINT (obj);
5008 break;
5010 case Lisp_String:
5011 hash = sxhash_string (SDATA (obj), SCHARS (obj));
5012 break;
5014 /* This can be everything from a vector to an overlay. */
5015 case Lisp_Vectorlike:
5016 if (VECTORP (obj))
5017 /* According to the CL HyperSpec, two arrays are equal only if
5018 they are `eq', except for strings and bit-vectors. In
5019 Emacs, this works differently. We have to compare element
5020 by element. */
5021 hash = sxhash_vector (obj, depth);
5022 else if (BOOL_VECTOR_P (obj))
5023 hash = sxhash_bool_vector (obj);
5024 else
5025 /* Others are `equal' if they are `eq', so let's take their
5026 address as hash. */
5027 hash = XUINT (obj);
5028 break;
5030 case Lisp_Cons:
5031 hash = sxhash_list (obj, depth);
5032 break;
5034 case Lisp_Float:
5036 unsigned char *p = (unsigned char *) &XFLOAT_DATA (obj);
5037 unsigned char *e = p + sizeof XFLOAT_DATA (obj);
5038 for (hash = 0; p < e; ++p)
5039 hash = SXHASH_COMBINE (hash, *p);
5040 break;
5043 default:
5044 abort ();
5047 return hash & INTMASK;
5052 /***********************************************************************
5053 Lisp Interface
5054 ***********************************************************************/
5057 DEFUN ("sxhash", Fsxhash, Ssxhash, 1, 1, 0,
5058 doc: /* Compute a hash code for OBJ and return it as integer. */)
5059 (obj)
5060 Lisp_Object obj;
5062 unsigned hash = sxhash (obj, 0);;
5063 return make_number (hash);
5067 DEFUN ("make-hash-table", Fmake_hash_table, Smake_hash_table, 0, MANY, 0,
5068 doc: /* Create and return a new hash table.
5070 Arguments are specified as keyword/argument pairs. The following
5071 arguments are defined:
5073 :test TEST -- TEST must be a symbol that specifies how to compare
5074 keys. Default is `eql'. Predefined are the tests `eq', `eql', and
5075 `equal'. User-supplied test and hash functions can be specified via
5076 `define-hash-table-test'.
5078 :size SIZE -- A hint as to how many elements will be put in the table.
5079 Default is 65.
5081 :rehash-size REHASH-SIZE - Indicates how to expand the table when it
5082 fills up. If REHASH-SIZE is an integer, add that many space. If it
5083 is a float, it must be > 1.0, and the new size is computed by
5084 multiplying the old size with that factor. Default is 1.5.
5086 :rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0.
5087 Resize the hash table when ratio of the number of entries in the
5088 table. Default is 0.8.
5090 :weakness WEAK -- WEAK must be one of nil, t, `key', `value',
5091 `key-or-value', or `key-and-value'. If WEAK is not nil, the table
5092 returned is a weak table. Key/value pairs are removed from a weak
5093 hash table when there are no non-weak references pointing to their
5094 key, value, one of key or value, or both key and value, depending on
5095 WEAK. WEAK t is equivalent to `key-and-value'. Default value of WEAK
5096 is nil.
5098 usage: (make-hash-table &rest KEYWORD-ARGS) */)
5099 (nargs, args)
5100 int nargs;
5101 Lisp_Object *args;
5103 Lisp_Object test, size, rehash_size, rehash_threshold, weak;
5104 Lisp_Object user_test, user_hash;
5105 char *used;
5106 int i;
5108 /* The vector `used' is used to keep track of arguments that
5109 have been consumed. */
5110 used = (char *) alloca (nargs * sizeof *used);
5111 bzero (used, nargs * sizeof *used);
5113 /* See if there's a `:test TEST' among the arguments. */
5114 i = get_key_arg (QCtest, nargs, args, used);
5115 test = i < 0 ? Qeql : args[i];
5116 if (!EQ (test, Qeq) && !EQ (test, Qeql) && !EQ (test, Qequal))
5118 /* See if it is a user-defined test. */
5119 Lisp_Object prop;
5121 prop = Fget (test, Qhash_table_test);
5122 if (!CONSP (prop) || !CONSP (XCDR (prop)))
5123 Fsignal (Qerror, list2 (build_string ("Invalid hash table test"),
5124 test));
5125 user_test = XCAR (prop);
5126 user_hash = XCAR (XCDR (prop));
5128 else
5129 user_test = user_hash = Qnil;
5131 /* See if there's a `:size SIZE' argument. */
5132 i = get_key_arg (QCsize, nargs, args, used);
5133 size = i < 0 ? Qnil : args[i];
5134 if (NILP (size))
5135 size = make_number (DEFAULT_HASH_SIZE);
5136 else if (!INTEGERP (size) || XINT (size) < 0)
5137 Fsignal (Qerror,
5138 list2 (build_string ("Invalid hash table size"),
5139 size));
5141 /* Look for `:rehash-size SIZE'. */
5142 i = get_key_arg (QCrehash_size, nargs, args, used);
5143 rehash_size = i < 0 ? make_float (DEFAULT_REHASH_SIZE) : args[i];
5144 if (!NUMBERP (rehash_size)
5145 || (INTEGERP (rehash_size) && XINT (rehash_size) <= 0)
5146 || XFLOATINT (rehash_size) <= 1.0)
5147 Fsignal (Qerror,
5148 list2 (build_string ("Invalid hash table rehash size"),
5149 rehash_size));
5151 /* Look for `:rehash-threshold THRESHOLD'. */
5152 i = get_key_arg (QCrehash_threshold, nargs, args, used);
5153 rehash_threshold = i < 0 ? make_float (DEFAULT_REHASH_THRESHOLD) : args[i];
5154 if (!FLOATP (rehash_threshold)
5155 || XFLOATINT (rehash_threshold) <= 0.0
5156 || XFLOATINT (rehash_threshold) > 1.0)
5157 Fsignal (Qerror,
5158 list2 (build_string ("Invalid hash table rehash threshold"),
5159 rehash_threshold));
5161 /* Look for `:weakness WEAK'. */
5162 i = get_key_arg (QCweakness, nargs, args, used);
5163 weak = i < 0 ? Qnil : args[i];
5164 if (EQ (weak, Qt))
5165 weak = Qkey_and_value;
5166 if (!NILP (weak)
5167 && !EQ (weak, Qkey)
5168 && !EQ (weak, Qvalue)
5169 && !EQ (weak, Qkey_or_value)
5170 && !EQ (weak, Qkey_and_value))
5171 Fsignal (Qerror, list2 (build_string ("Invalid hash table weakness"),
5172 weak));
5174 /* Now, all args should have been used up, or there's a problem. */
5175 for (i = 0; i < nargs; ++i)
5176 if (!used[i])
5177 Fsignal (Qerror,
5178 list2 (build_string ("Invalid argument list"), args[i]));
5180 return make_hash_table (test, size, rehash_size, rehash_threshold, weak,
5181 user_test, user_hash);
5185 DEFUN ("copy-hash-table", Fcopy_hash_table, Scopy_hash_table, 1, 1, 0,
5186 doc: /* Return a copy of hash table TABLE. */)
5187 (table)
5188 Lisp_Object table;
5190 return copy_hash_table (check_hash_table (table));
5194 DEFUN ("hash-table-count", Fhash_table_count, Shash_table_count, 1, 1, 0,
5195 doc: /* Return the number of elements in TABLE. */)
5196 (table)
5197 Lisp_Object table;
5199 return check_hash_table (table)->count;
5203 DEFUN ("hash-table-rehash-size", Fhash_table_rehash_size,
5204 Shash_table_rehash_size, 1, 1, 0,
5205 doc: /* Return the current rehash size of TABLE. */)
5206 (table)
5207 Lisp_Object table;
5209 return check_hash_table (table)->rehash_size;
5213 DEFUN ("hash-table-rehash-threshold", Fhash_table_rehash_threshold,
5214 Shash_table_rehash_threshold, 1, 1, 0,
5215 doc: /* Return the current rehash threshold of TABLE. */)
5216 (table)
5217 Lisp_Object table;
5219 return check_hash_table (table)->rehash_threshold;
5223 DEFUN ("hash-table-size", Fhash_table_size, Shash_table_size, 1, 1, 0,
5224 doc: /* Return the size of TABLE.
5225 The size can be used as an argument to `make-hash-table' to create
5226 a hash table than can hold as many elements of TABLE holds
5227 without need for resizing. */)
5228 (table)
5229 Lisp_Object table;
5231 struct Lisp_Hash_Table *h = check_hash_table (table);
5232 return make_number (HASH_TABLE_SIZE (h));
5236 DEFUN ("hash-table-test", Fhash_table_test, Shash_table_test, 1, 1, 0,
5237 doc: /* Return the test TABLE uses. */)
5238 (table)
5239 Lisp_Object table;
5241 return check_hash_table (table)->test;
5245 DEFUN ("hash-table-weakness", Fhash_table_weakness, Shash_table_weakness,
5246 1, 1, 0,
5247 doc: /* Return the weakness of TABLE. */)
5248 (table)
5249 Lisp_Object table;
5251 return check_hash_table (table)->weak;
5255 DEFUN ("hash-table-p", Fhash_table_p, Shash_table_p, 1, 1, 0,
5256 doc: /* Return t if OBJ is a Lisp hash table object. */)
5257 (obj)
5258 Lisp_Object obj;
5260 return HASH_TABLE_P (obj) ? Qt : Qnil;
5264 DEFUN ("clrhash", Fclrhash, Sclrhash, 1, 1, 0,
5265 doc: /* Clear hash table TABLE. */)
5266 (table)
5267 Lisp_Object table;
5269 hash_clear (check_hash_table (table));
5270 return Qnil;
5274 DEFUN ("gethash", Fgethash, Sgethash, 2, 3, 0,
5275 doc: /* Look up KEY in TABLE and return its associated value.
5276 If KEY is not found, return DFLT which defaults to nil. */)
5277 (key, table, dflt)
5278 Lisp_Object key, table, dflt;
5280 struct Lisp_Hash_Table *h = check_hash_table (table);
5281 int i = hash_lookup (h, key, NULL);
5282 return i >= 0 ? HASH_VALUE (h, i) : dflt;
5286 DEFUN ("puthash", Fputhash, Sputhash, 3, 3, 0,
5287 doc: /* Associate KEY with VALUE in hash table TABLE.
5288 If KEY is already present in table, replace its current value with
5289 VALUE. */)
5290 (key, value, table)
5291 Lisp_Object key, value, table;
5293 struct Lisp_Hash_Table *h = check_hash_table (table);
5294 int i;
5295 unsigned hash;
5297 i = hash_lookup (h, key, &hash);
5298 if (i >= 0)
5299 HASH_VALUE (h, i) = value;
5300 else
5301 hash_put (h, key, value, hash);
5303 return value;
5307 DEFUN ("remhash", Fremhash, Sremhash, 2, 2, 0,
5308 doc: /* Remove KEY from TABLE. */)
5309 (key, table)
5310 Lisp_Object key, table;
5312 struct Lisp_Hash_Table *h = check_hash_table (table);
5313 hash_remove (h, key);
5314 return Qnil;
5318 DEFUN ("maphash", Fmaphash, Smaphash, 2, 2, 0,
5319 doc: /* Call FUNCTION for all entries in hash table TABLE.
5320 FUNCTION is called with 2 arguments KEY and VALUE. */)
5321 (function, table)
5322 Lisp_Object function, table;
5324 struct Lisp_Hash_Table *h = check_hash_table (table);
5325 Lisp_Object args[3];
5326 int i;
5328 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
5329 if (!NILP (HASH_HASH (h, i)))
5331 args[0] = function;
5332 args[1] = HASH_KEY (h, i);
5333 args[2] = HASH_VALUE (h, i);
5334 Ffuncall (3, args);
5337 return Qnil;
5341 DEFUN ("define-hash-table-test", Fdefine_hash_table_test,
5342 Sdefine_hash_table_test, 3, 3, 0,
5343 doc: /* Define a new hash table test with name NAME, a symbol.
5345 In hash tables created with NAME specified as test, use TEST to
5346 compare keys, and HASH for computing hash codes of keys.
5348 TEST must be a function taking two arguments and returning non-nil if
5349 both arguments are the same. HASH must be a function taking one
5350 argument and return an integer that is the hash code of the argument.
5351 Hash code computation should use the whole value range of integers,
5352 including negative integers. */)
5353 (name, test, hash)
5354 Lisp_Object name, test, hash;
5356 return Fput (name, Qhash_table_test, list2 (test, hash));
5361 /************************************************************************
5363 ************************************************************************/
5365 #include "md5.h"
5366 #include "coding.h"
5368 DEFUN ("md5", Fmd5, Smd5, 1, 5, 0,
5369 doc: /* Return MD5 message digest of OBJECT, a buffer or string.
5371 A message digest is a cryptographic checksum of a document, and the
5372 algorithm to calculate it is defined in RFC 1321.
5374 The two optional arguments START and END are character positions
5375 specifying for which part of OBJECT the message digest should be
5376 computed. If nil or omitted, the digest is computed for the whole
5377 OBJECT.
5379 The MD5 message digest is computed from the result of encoding the
5380 text in a coding system, not directly from the internal Emacs form of
5381 the text. The optional fourth argument CODING-SYSTEM specifies which
5382 coding system to encode the text with. It should be the same coding
5383 system that you used or will use when actually writing the text into a
5384 file.
5386 If CODING-SYSTEM is nil or omitted, the default depends on OBJECT. If
5387 OBJECT is a buffer, the default for CODING-SYSTEM is whatever coding
5388 system would be chosen by default for writing this text into a file.
5390 If OBJECT is a string, the most preferred coding system (see the
5391 command `prefer-coding-system') is used.
5393 If NOERROR is non-nil, silently assume the `raw-text' coding if the
5394 guesswork fails. Normally, an error is signaled in such case. */)
5395 (object, start, end, coding_system, noerror)
5396 Lisp_Object object, start, end, coding_system, noerror;
5398 unsigned char digest[16];
5399 unsigned char value[33];
5400 int i;
5401 int size;
5402 int size_byte = 0;
5403 int start_char = 0, end_char = 0;
5404 int start_byte = 0, end_byte = 0;
5405 register int b, e;
5406 register struct buffer *bp;
5407 int temp;
5409 if (STRINGP (object))
5411 if (NILP (coding_system))
5413 /* Decide the coding-system to encode the data with. */
5415 if (STRING_MULTIBYTE (object))
5416 /* use default, we can't guess correct value */
5417 coding_system = SYMBOL_VALUE (XCAR (Vcoding_category_list));
5418 else
5419 coding_system = Qraw_text;
5422 if (NILP (Fcoding_system_p (coding_system)))
5424 /* Invalid coding system. */
5426 if (!NILP (noerror))
5427 coding_system = Qraw_text;
5428 else
5429 while (1)
5430 Fsignal (Qcoding_system_error, Fcons (coding_system, Qnil));
5433 if (STRING_MULTIBYTE (object))
5434 object = code_convert_string1 (object, coding_system, Qnil, 1);
5436 size = SCHARS (object);
5437 size_byte = SBYTES (object);
5439 if (!NILP (start))
5441 CHECK_NUMBER (start);
5443 start_char = XINT (start);
5445 if (start_char < 0)
5446 start_char += size;
5448 start_byte = string_char_to_byte (object, start_char);
5451 if (NILP (end))
5453 end_char = size;
5454 end_byte = size_byte;
5456 else
5458 CHECK_NUMBER (end);
5460 end_char = XINT (end);
5462 if (end_char < 0)
5463 end_char += size;
5465 end_byte = string_char_to_byte (object, end_char);
5468 if (!(0 <= start_char && start_char <= end_char && end_char <= size))
5469 args_out_of_range_3 (object, make_number (start_char),
5470 make_number (end_char));
5472 else
5474 struct buffer *prev = current_buffer;
5476 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
5478 CHECK_BUFFER (object);
5480 bp = XBUFFER (object);
5481 if (bp != current_buffer)
5482 set_buffer_internal (bp);
5484 if (NILP (start))
5485 b = BEGV;
5486 else
5488 CHECK_NUMBER_COERCE_MARKER (start);
5489 b = XINT (start);
5492 if (NILP (end))
5493 e = ZV;
5494 else
5496 CHECK_NUMBER_COERCE_MARKER (end);
5497 e = XINT (end);
5500 if (b > e)
5501 temp = b, b = e, e = temp;
5503 if (!(BEGV <= b && e <= ZV))
5504 args_out_of_range (start, end);
5506 if (NILP (coding_system))
5508 /* Decide the coding-system to encode the data with.
5509 See fileio.c:Fwrite-region */
5511 if (!NILP (Vcoding_system_for_write))
5512 coding_system = Vcoding_system_for_write;
5513 else
5515 int force_raw_text = 0;
5517 coding_system = XBUFFER (object)->buffer_file_coding_system;
5518 if (NILP (coding_system)
5519 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
5521 coding_system = Qnil;
5522 if (NILP (current_buffer->enable_multibyte_characters))
5523 force_raw_text = 1;
5526 if (NILP (coding_system) && !NILP (Fbuffer_file_name(object)))
5528 /* Check file-coding-system-alist. */
5529 Lisp_Object args[4], val;
5531 args[0] = Qwrite_region; args[1] = start; args[2] = end;
5532 args[3] = Fbuffer_file_name(object);
5533 val = Ffind_operation_coding_system (4, args);
5534 if (CONSP (val) && !NILP (XCDR (val)))
5535 coding_system = XCDR (val);
5538 if (NILP (coding_system)
5539 && !NILP (XBUFFER (object)->buffer_file_coding_system))
5541 /* If we still have not decided a coding system, use the
5542 default value of buffer-file-coding-system. */
5543 coding_system = XBUFFER (object)->buffer_file_coding_system;
5546 if (!force_raw_text
5547 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
5548 /* Confirm that VAL can surely encode the current region. */
5549 coding_system = call4 (Vselect_safe_coding_system_function,
5550 make_number (b), make_number (e),
5551 coding_system, Qnil);
5553 if (force_raw_text)
5554 coding_system = Qraw_text;
5557 if (NILP (Fcoding_system_p (coding_system)))
5559 /* Invalid coding system. */
5561 if (!NILP (noerror))
5562 coding_system = Qraw_text;
5563 else
5564 while (1)
5565 Fsignal (Qcoding_system_error, Fcons (coding_system, Qnil));
5569 object = make_buffer_string (b, e, 0);
5570 if (prev != current_buffer)
5571 set_buffer_internal (prev);
5572 /* Discard the unwind protect for recovering the current
5573 buffer. */
5574 specpdl_ptr--;
5576 if (STRING_MULTIBYTE (object))
5577 object = code_convert_string1 (object, coding_system, Qnil, 1);
5580 md5_buffer (SDATA (object) + start_byte,
5581 SBYTES (object) - (size_byte - end_byte),
5582 digest);
5584 for (i = 0; i < 16; i++)
5585 sprintf (&value[2 * i], "%02x", digest[i]);
5586 value[32] = '\0';
5588 return make_string (value, 32);
5592 void
5593 syms_of_fns ()
5595 /* Hash table stuff. */
5596 Qhash_table_p = intern ("hash-table-p");
5597 staticpro (&Qhash_table_p);
5598 Qeq = intern ("eq");
5599 staticpro (&Qeq);
5600 Qeql = intern ("eql");
5601 staticpro (&Qeql);
5602 Qequal = intern ("equal");
5603 staticpro (&Qequal);
5604 QCtest = intern (":test");
5605 staticpro (&QCtest);
5606 QCsize = intern (":size");
5607 staticpro (&QCsize);
5608 QCrehash_size = intern (":rehash-size");
5609 staticpro (&QCrehash_size);
5610 QCrehash_threshold = intern (":rehash-threshold");
5611 staticpro (&QCrehash_threshold);
5612 QCweakness = intern (":weakness");
5613 staticpro (&QCweakness);
5614 Qkey = intern ("key");
5615 staticpro (&Qkey);
5616 Qvalue = intern ("value");
5617 staticpro (&Qvalue);
5618 Qhash_table_test = intern ("hash-table-test");
5619 staticpro (&Qhash_table_test);
5620 Qkey_or_value = intern ("key-or-value");
5621 staticpro (&Qkey_or_value);
5622 Qkey_and_value = intern ("key-and-value");
5623 staticpro (&Qkey_and_value);
5625 defsubr (&Ssxhash);
5626 defsubr (&Smake_hash_table);
5627 defsubr (&Scopy_hash_table);
5628 defsubr (&Shash_table_count);
5629 defsubr (&Shash_table_rehash_size);
5630 defsubr (&Shash_table_rehash_threshold);
5631 defsubr (&Shash_table_size);
5632 defsubr (&Shash_table_test);
5633 defsubr (&Shash_table_weakness);
5634 defsubr (&Shash_table_p);
5635 defsubr (&Sclrhash);
5636 defsubr (&Sgethash);
5637 defsubr (&Sputhash);
5638 defsubr (&Sremhash);
5639 defsubr (&Smaphash);
5640 defsubr (&Sdefine_hash_table_test);
5642 Qstring_lessp = intern ("string-lessp");
5643 staticpro (&Qstring_lessp);
5644 Qprovide = intern ("provide");
5645 staticpro (&Qprovide);
5646 Qrequire = intern ("require");
5647 staticpro (&Qrequire);
5648 Qyes_or_no_p_history = intern ("yes-or-no-p-history");
5649 staticpro (&Qyes_or_no_p_history);
5650 Qcursor_in_echo_area = intern ("cursor-in-echo-area");
5651 staticpro (&Qcursor_in_echo_area);
5652 Qwidget_type = intern ("widget-type");
5653 staticpro (&Qwidget_type);
5655 staticpro (&string_char_byte_cache_string);
5656 string_char_byte_cache_string = Qnil;
5658 require_nesting_list = Qnil;
5659 staticpro (&require_nesting_list);
5661 Fset (Qyes_or_no_p_history, Qnil);
5663 DEFVAR_LISP ("features", &Vfeatures,
5664 doc: /* A list of symbols which are the features of the executing emacs.
5665 Used by `featurep' and `require', and altered by `provide'. */);
5666 Vfeatures = Qnil;
5667 Qsubfeatures = intern ("subfeatures");
5668 staticpro (&Qsubfeatures);
5670 #ifdef HAVE_LANGINFO_CODESET
5671 Qcodeset = intern ("codeset");
5672 staticpro (&Qcodeset);
5673 Qdays = intern ("days");
5674 staticpro (&Qdays);
5675 Qmonths = intern ("months");
5676 staticpro (&Qmonths);
5677 Qpaper = intern ("paper");
5678 staticpro (&Qpaper);
5679 #endif /* HAVE_LANGINFO_CODESET */
5681 DEFVAR_BOOL ("use-dialog-box", &use_dialog_box,
5682 doc: /* *Non-nil means mouse commands use dialog boxes to ask questions.
5683 This applies to `y-or-n-p' and `yes-or-no-p' questions asked by commands
5684 invoked by mouse clicks and mouse menu items. */);
5685 use_dialog_box = 1;
5687 DEFVAR_BOOL ("use-file-dialog", &use_file_dialog,
5688 doc: /* *Non-nil means mouse commands use a file dialog to ask for files.
5689 This applies to commands from menus and tool bar buttons. The value of
5690 `use-dialog-box' takes precedence over this variable, so a file dialog is only
5691 used if both `use-dialog-box' and this variable are non-nil. */);
5692 use_file_dialog = 1;
5694 defsubr (&Sidentity);
5695 defsubr (&Srandom);
5696 defsubr (&Slength);
5697 defsubr (&Ssafe_length);
5698 defsubr (&Sstring_bytes);
5699 defsubr (&Sstring_equal);
5700 defsubr (&Scompare_strings);
5701 defsubr (&Sstring_lessp);
5702 defsubr (&Sappend);
5703 defsubr (&Sconcat);
5704 defsubr (&Svconcat);
5705 defsubr (&Scopy_sequence);
5706 defsubr (&Sstring_make_multibyte);
5707 defsubr (&Sstring_make_unibyte);
5708 defsubr (&Sstring_as_multibyte);
5709 defsubr (&Sstring_as_unibyte);
5710 defsubr (&Sstring_to_multibyte);
5711 defsubr (&Scopy_alist);
5712 defsubr (&Ssubstring);
5713 defsubr (&Ssubstring_no_properties);
5714 defsubr (&Snthcdr);
5715 defsubr (&Snth);
5716 defsubr (&Selt);
5717 defsubr (&Smember);
5718 defsubr (&Smemq);
5719 defsubr (&Sassq);
5720 defsubr (&Sassoc);
5721 defsubr (&Srassq);
5722 defsubr (&Srassoc);
5723 defsubr (&Sdelq);
5724 defsubr (&Sdelete);
5725 defsubr (&Snreverse);
5726 defsubr (&Sreverse);
5727 defsubr (&Ssort);
5728 defsubr (&Splist_get);
5729 defsubr (&Sget);
5730 defsubr (&Splist_put);
5731 defsubr (&Sput);
5732 defsubr (&Slax_plist_get);
5733 defsubr (&Slax_plist_put);
5734 defsubr (&Seql);
5735 defsubr (&Sequal);
5736 defsubr (&Sequal_including_properties);
5737 defsubr (&Sfillarray);
5738 defsubr (&Sclear_string);
5739 defsubr (&Schar_table_subtype);
5740 defsubr (&Schar_table_parent);
5741 defsubr (&Sset_char_table_parent);
5742 defsubr (&Schar_table_extra_slot);
5743 defsubr (&Sset_char_table_extra_slot);
5744 defsubr (&Schar_table_range);
5745 defsubr (&Sset_char_table_range);
5746 defsubr (&Sset_char_table_default);
5747 defsubr (&Soptimize_char_table);
5748 defsubr (&Smap_char_table);
5749 defsubr (&Snconc);
5750 defsubr (&Smapcar);
5751 defsubr (&Smapc);
5752 defsubr (&Smapconcat);
5753 defsubr (&Sy_or_n_p);
5754 defsubr (&Syes_or_no_p);
5755 defsubr (&Sload_average);
5756 defsubr (&Sfeaturep);
5757 defsubr (&Srequire);
5758 defsubr (&Sprovide);
5759 defsubr (&Splist_member);
5760 defsubr (&Swidget_put);
5761 defsubr (&Swidget_get);
5762 defsubr (&Swidget_apply);
5763 defsubr (&Sbase64_encode_region);
5764 defsubr (&Sbase64_decode_region);
5765 defsubr (&Sbase64_encode_string);
5766 defsubr (&Sbase64_decode_string);
5767 defsubr (&Smd5);
5768 defsubr (&Slocale_info);
5772 void
5773 init_fns ()
5775 Vweak_hash_tables = Qnil;
5778 /* arch-tag: 787f8219-5b74-46bd-8469-7e1cc475fa31
5779 (do not change this comment) */