1 /* Random utility Lisp functions.
2 Copyright (C) 1985, 86, 87, 93, 94, 95 Free Software Foundation, Inc.
3 Copyright (C) 1995, 1996 Ben Wing.
5 This file is part of SXEmacs
7 SXEmacs 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 3 of the License, or
10 (at your option) any later version.
12 SXEmacs 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 this program. If not, see <http://www.gnu.org/licenses/>. */
21 /* Synched up with: Mule 2.0, FSF 19.30. */
23 /* This file has been Mule-ized. */
25 /* Note: FSF 19.30 has bool vectors. We have bit vectors. */
27 /* Hacked on for Mule by Ben Wing, December 1994, January 1995. */
31 /* Note on some machines this defines `vector' as a typedef,
32 so make sure we don't use that name in this file. */
42 #include "ui/device.h"
43 #include "events/events.h"
47 #include "ui/insdel.h"
49 /* for the categorial views */
52 /* for all the map* funs */
56 /* NOTE: This symbol is also used in lread.c */
57 #define FEATUREP_SYNTAX
59 Lisp_Object Qstring_lessp, Qstring_greaterp;
60 Lisp_Object Qidentity;
62 static int internal_old_equal(Lisp_Object, Lisp_Object, int);
63 Lisp_Object safe_copy_tree(Lisp_Object arg, Lisp_Object vecp, int depth);
64 int internal_equalp(Lisp_Object, Lisp_Object, int);
66 static Lisp_Object mark_bit_vector(Lisp_Object obj)
72 print_bit_vector(Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
75 Lisp_Bit_Vector *v = XBIT_VECTOR(obj);
76 size_t len = bit_vector_length(v);
79 if (INTP(Vprint_length))
80 last = min((EMACS_INT) len, XINT(Vprint_length));
81 write_c_string("#*", printcharfun);
82 for (i = 0; i < last; i++) {
83 if (bit_vector_bit(v, i))
84 write_c_string("1", printcharfun);
86 write_c_string("0", printcharfun);
90 write_c_string("...", printcharfun);
93 static int bit_vector_equal(Lisp_Object obj1, Lisp_Object obj2, int depth)
95 Lisp_Bit_Vector *v1 = XBIT_VECTOR(obj1);
96 Lisp_Bit_Vector *v2 = XBIT_VECTOR(obj2);
98 return ((bit_vector_length(v1) == bit_vector_length(v2)) &&
99 !memcmp(v1->bits, v2->bits,
100 BIT_VECTOR_LONG_STORAGE(bit_vector_length(v1)) *
104 static unsigned long bit_vector_hash(Lisp_Object obj, int depth)
106 Lisp_Bit_Vector *v = XBIT_VECTOR(obj);
107 return HASH2(bit_vector_length(v),
109 BIT_VECTOR_LONG_STORAGE(bit_vector_length(v)) *
113 static size_t size_bit_vector(const void *lheader)
115 const Lisp_Bit_Vector *v = (const Lisp_Bit_Vector *) lheader;
116 return FLEXIBLE_ARRAY_STRUCT_SIZEOF(Lisp_Bit_Vector, unsigned long,
118 BIT_VECTOR_LONG_STORAGE
119 (bit_vector_length(v)));
122 static const struct lrecord_description bit_vector_description[] = {
123 {XD_LISP_OBJECT, offsetof(Lisp_Bit_Vector, next)},
127 DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION("bit-vector", bit_vector,
128 mark_bit_vector, print_bit_vector,
131 bit_vector_description,
132 size_bit_vector, Lisp_Bit_Vector);
134 DEFUN("identity", Fidentity, 1, 1, 0, /*
135 Return the argument unchanged.
142 extern long get_random(void);
143 extern void seed_random(long arg);
145 DEFUN("random", Frandom, 0, 1, 0, /*
146 Return a pseudo-random number.
147 All integers representable in Lisp are equally likely.
148 On most systems, this is 31 bits' worth.
150 With positive integer argument LIMIT, return random number
151 in interval [0,LIMIT). LIMIT can be a big integer, in which
152 case the range of possible values is extended.
154 With argument t, set the random number seed from the
155 current time and pid.
160 unsigned long denominator;
163 seed_random(getpid() + time(NULL));
164 if (NATNUMP(limit) && !ZEROP(limit)) {
165 /* Try to take our random number from the higher bits of VAL,
166 not the lower, since (says Gentzel) the low bits of `random'
167 are less random than the higher ones. We do this by using the
168 quotient rather than the remainder. At the high end of the RNG
169 it's possible to get a quotient larger than limit; discarding
170 these values eliminates the bias that would otherwise appear
171 when using a large limit. */
172 denominator = ((unsigned long)1 << INT_VALBITS) / XINT(limit);
174 val = get_random() / denominator;
175 while (val >= XINT(limit));
176 } else if (ZEROP(limit)) {
177 return wrong_type_argument(Qpositivep, limit);
178 #if defined HAVE_MPZ && defined WITH_GMP
179 } else if (BIGZP(limit)) {
183 if (bigz_sign(XBIGZ_DATA(limit)) <= 0)
184 return wrong_type_argument(Qpositivep, limit);
188 bigz_random(bz, XBIGZ_DATA(limit));
189 result = ent_mpz_downgrade_maybe(bz);
193 #endif /* HAVE_MPZ */
197 return make_int(val);
200 #if defined(WITH_GMP) && defined(HAVE_MPZ)
201 DEFUN("randomb", Frandomb, 1, 1, 0, /*
202 Return a uniform pseudo-random number in the range [0, 2^LIMIT).
210 CHECK_INTEGER(limit);
212 if (NILP(Fnonnegativep(limit)))
213 return wrong_type_argument(Qnonnegativep, limit);
214 else if (INTP(limit))
216 else if (BIGZP(limit) && bigz_fits_ulong_p(XBIGZ_DATA(limit)))
217 limui = bigz_to_ulong(XBIGZ_DATA(limit));
219 return wrong_type_argument(Qintegerp, limit);
223 mpz_urandomb(bz, random_state, limui);
224 result = make_bigz_bz(bz);
229 #endif /* HAVE_MPZ */
232 /* Random data-structure functions */
234 #ifdef LOSING_BYTECODE
236 /* #### Delete this shit */
238 /* Charcount is a misnomer here as we might be dealing with the
239 length of a vector or list, but emphasizes that we're not dealing
240 with Bytecounts in strings */
241 static Charcount length_with_bytecode_hack(Lisp_Object seq)
243 if (!COMPILED_FUNCTIONP(seq))
244 return XINT(Flength(seq));
246 Lisp_Compiled_Function *f = XCOMPILED_FUNCTION(seq);
248 return (f->flags.interactivep ? COMPILED_INTERACTIVE :
249 f->flags.domainp ? COMPILED_DOMAIN :
255 #endif /* LOSING_BYTECODE */
257 void check_losing_bytecode(const char *function, Lisp_Object seq)
259 if (COMPILED_FUNCTIONP(seq))
262 "As of 20.3, `%s' no longer works with compiled-function objects",
266 DEFUN("length", Flength, 1, 1, 0, /*
267 Return the length of vector, bit vector, list or string SEQUENCE.
272 /* that's whither we have to get */
273 if (LIKELY(!NILP(sequence))) {
274 return make_int(seq_length((seq_t)sequence));
280 if (LIKELY(STRINGP(sequence) ||
284 BIT_VECTORP(sequence))) {
285 return make_int(seq_length(sequence));
286 } else if (NILP(sequence)) {
289 check_losing_bytecode("length", sequence);
290 sequence = wrong_type_argument(Qsequencep, sequence);
295 if (STRINGP(sequence))
296 return make_int(XSTRING_CHAR_LENGTH(sequence));
297 else if (CONSP(sequence)) {
298 return make_int(seq_length(sequence));
299 } else if (VECTORP(sequence))
300 return make_int(seq_length(sequence));
301 else if (DLLISTP(sequence))
302 return make_int(XDLLIST_SIZE(sequence));
303 else if (NILP(sequence))
305 else if (BIT_VECTORP(sequence))
306 return make_int(bit_vector_length(XBIT_VECTOR(sequence)));
308 check_losing_bytecode("length", sequence);
309 sequence = wrong_type_argument(Qsequencep, sequence);
315 DEFUN("safe-length", Fsafe_length, 1, 1, 0, /*
316 Return the length of a list, but avoid error or infinite loop.
317 This function never gets an error. If LIST is not really a list,
318 it returns 0. If LIST is circular, it returns a finite value
319 which is at least the number of distinct elements.
323 Lisp_Object hare, tortoise;
326 for (hare = tortoise = list, len = 0;
327 CONSP(hare) && (!EQ(hare, tortoise) || len == 0);
328 hare = XCDR(hare), len++) {
330 tortoise = XCDR(tortoise);
333 return make_int(len);
336 /*** string functions. ***/
338 DEFUN("string-equal", Fstring_equal, 2, 2, 0, /*
339 Return t if two strings have identical contents.
340 Case is significant. Text properties are ignored.
341 \(Under SXEmacs, `equal' also ignores text properties and extents in
342 strings, but this is not the case under FSF Emacs 19. In FSF Emacs 20
343 `equal' is the same as in SXEmacs, in that respect.)
344 Symbols are also allowed; their print names are used instead.
349 Lisp_String *p1, *p2;
351 if (SYMBOLP(string1))
352 p1 = XSYMBOL(string1)->name;
354 CHECK_STRING(string1);
355 p1 = XSTRING(string1);
358 if (SYMBOLP(string2))
359 p2 = XSYMBOL(string2)->name;
361 CHECK_STRING(string2);
362 p2 = XSTRING(string2);
365 return (((len = string_length(p1)) == string_length(p2)) &&
366 !memcmp(string_data(p1), string_data(p2), len)) ? Qt : Qnil;
369 DEFUN("string-lessp", Fstring_lessp, 2, 2, 0, /*
370 Return t if first arg string is less than second in lexicographic order.
371 If I18N2 support (but not Mule support) was compiled in, ordering is
372 determined by the locale. (Case is significant for the default C locale.)
373 In all other cases, comparison is simply done on a character-by-
374 character basis using the numeric value of a character. (Note that
375 this may not produce particularly meaningful results under Mule if
376 characters from different charsets are being compared.)
378 Symbols are also allowed; their print names are used instead.
380 The reason that the I18N2 locale-specific collation is not used under
381 Mule is that the locale model of internationalization does not handle
382 multiple charsets and thus has no hope of working properly under Mule.
383 What we really should do is create a collation table over all built-in
384 charsets. This is extremely difficult to do from scratch, however.
386 Unicode is a good first step towards solving this problem. In fact,
387 it is quite likely that a collation table exists (or will exist) for
388 Unicode. When Unicode support is added to SXEmacs/Mule, this problem
393 Lisp_String *p1, *p2;
397 if (SYMBOLP(string1))
398 p1 = XSYMBOL(string1)->name;
400 CHECK_STRING(string1);
401 p1 = XSTRING(string1);
404 if (SYMBOLP(string2))
405 p2 = XSYMBOL(string2)->name;
407 CHECK_STRING(string2);
408 p2 = XSTRING(string2);
411 end = string_char_length(p1);
412 len2 = string_char_length(p2);
416 #if defined (I18N2) && !defined (MULE)
417 /* There is no hope of this working under Mule. Even if we converted
418 the data into an external format so that strcoll() processed it
419 properly, it would still not work because strcoll() does not
420 handle multiple locales. This is the fundamental flaw in the
423 Bytecount bcend = charcount_to_bytecount(string_data(p1), end);
424 /* Compare strings using collation order of locale. */
425 /* Need to be tricky to handle embedded nulls. */
427 for (i = 0; i < bcend;
428 i += strlen((char *)string_data(p1) + i) + 1) {
429 int val = strcoll((char *)string_data(p1) + i,
430 (char *)string_data(p2) + i);
437 #else /* not I18N2, or MULE */
439 Bufbyte *ptr1 = string_data(p1);
440 Bufbyte *ptr2 = string_data(p2);
442 /* #### It is not really necessary to do this: We could compare
443 byte-by-byte and still get a reasonable comparison, since this
444 would compare characters with a charset in the same way. With
445 a little rearrangement of the leading bytes, we could make most
446 inter-charset comparisons work out the same, too; even if some
447 don't, this is not a big deal because inter-charset comparisons
448 aren't really well-defined anyway. */
449 for (i = 0; i < end; i++) {
450 if (charptr_emchar(ptr1) != charptr_emchar(ptr2))
451 return charptr_emchar(ptr1) <
452 charptr_emchar(ptr2) ? Qt : Qnil;
457 #endif /* not I18N2, or MULE */
458 /* Can't do i < len2 because then comparison between "foo" and "foo^@"
459 won't work right in I18N2 case */
460 return end < len2 ? Qt : Qnil;
463 DEFUN("string-greaterp", Fstring_greaterp, 2, 2, 0, /*
464 Return t if first arg string is greater than second in lexicographic order.
465 If I18N2 support (but not Mule support) was compiled in, ordering is
466 determined by the locale. (Case is significant for the default C locale.)
467 In all other cases, comparison is simply done on a character-by-
468 character basis using the numeric value of a character. (Note that
469 this may not produce particularly meaningful results under Mule if
470 characters from different charsets are being compared.)
472 Symbols are also allowed; their print names are used instead.
474 The reason that the I18N2 locale-specific collation is not used under
475 Mule is that the locale model of internationalization does not handle
476 multiple charsets and thus has no hope of working properly under Mule.
477 What we really should do is create a collation table over all built-in
478 charsets. This is extremely difficult to do from scratch, however.
480 Unicode is a good first step towards solving this problem. In fact,
481 it is quite likely that a collation table exists (or will exist) for
482 Unicode. When Unicode support is added to SXEmacs/Mule, this problem
487 return Fstring_lessp(string2, string1);
490 DEFUN("string-modified-tick", Fstring_modified_tick, 1, 1, 0, /*
491 Return STRING's tick counter, incremented for each change to the string.
492 Each string has a tick counter which is incremented each time the contents
493 of the string are changed (e.g. with `aset'). It wraps around occasionally.
499 CHECK_STRING(string);
501 if (CONSP(s->plist) && INTP(XCAR(s->plist)))
502 return XCAR(s->plist);
507 void bump_string_modiff(Lisp_Object str)
509 Lisp_String *s = XSTRING(str);
510 Lisp_Object *ptr = &s->plist;
513 /* #### remove the `string-translatable' property from the string,
516 /* skip over extent info if it's there */
517 if (CONSP(*ptr) && EXTENT_INFOP(XCAR(*ptr)))
519 if (CONSP(*ptr) && INTP(XCAR(*ptr)))
520 XSETINT(XCAR(*ptr), 1 + XINT(XCAR(*ptr)));
522 *ptr = Fcons(make_int(1), *ptr);
525 enum concat_target_type { c_cons, c_string, c_vector, c_bit_vector, c_dllist };
526 static Lisp_Object concat(int nargs, Lisp_Object * args,
527 enum concat_target_type target_type,
530 Lisp_Object concat2(Lisp_Object string1, Lisp_Object string2)
535 return concat(2, args, c_string, 0);
539 concat3(Lisp_Object string1, Lisp_Object string2, Lisp_Object string3)
545 return concat(3, args, c_string, 0);
548 Lisp_Object vconcat2(Lisp_Object vec1, Lisp_Object vec2)
553 return concat(2, args, c_vector, 0);
556 Lisp_Object vconcat3(Lisp_Object vec1, Lisp_Object vec2, Lisp_Object vec3)
562 return concat(3, args, c_vector, 0);
565 DEFUN("append", Fappend, 0, MANY, 0, /*
566 Concatenate all the arguments and make the result a list.
567 The result is a list whose elements are the elements of all the arguments.
568 Each argument may be a list, vector, bit vector, or string.
569 The last argument is not copied, just used as the tail of the new list.
572 (int nargs, Lisp_Object * args))
574 return concat(nargs, args, c_cons, 1);
577 DEFUN("concat", Fconcat, 0, MANY, 0, /*
578 Concatenate all the arguments and make the result a string.
579 The result is a string whose elements are the elements of all the arguments.
580 Each argument may be a string or a list or vector of characters.
582 As of XEmacs 21.0, this function does NOT accept individual integers
583 as arguments. Old code that relies on, for example, (concat "foo" 50)
584 returning "foo50" will fail. To fix such code, either apply
585 `int-to-string' to the integer argument, or use `format'.
587 (int nargs, Lisp_Object * args))
589 return concat(nargs, args, c_string, 0);
592 DEFUN("vconcat", Fvconcat, 0, MANY, 0, /*
593 Concatenate all the arguments and make the result a vector.
594 The result is a vector whose elements are the elements of all the arguments.
595 Each argument may be a list, vector, bit vector, or string.
597 (int nargs, Lisp_Object * args))
599 return concat(nargs, args, c_vector, 0);
602 DEFUN("bvconcat", Fbvconcat, 0, MANY, 0, /*
603 Concatenate all the arguments and make the result a bit vector.
604 The result is a bit vector whose elements are the elements of all the
605 arguments. Each argument may be a list, vector, bit vector, or string.
607 (int nargs, Lisp_Object * args))
609 return concat(nargs, args, c_bit_vector, 0);
612 /* Copy a (possibly dotted) list. LIST must be a cons.
613 Can't use concat (1, &alist, c_cons, 0) - doesn't handle dotted lists. */
614 static Lisp_Object copy_list(Lisp_Object list)
616 Lisp_Object list_copy = Fcons(XCAR(list), XCDR(list));
617 Lisp_Object last = list_copy;
618 Lisp_Object hare, tortoise;
621 for (tortoise = hare = XCDR(list), len = 1;
622 CONSP(hare); hare = XCDR(hare), len++) {
623 XCDR(last) = Fcons(XCAR(hare), XCDR(hare));
626 if (len < CIRCULAR_LIST_SUSPICION_LENGTH)
629 tortoise = XCDR(tortoise);
630 if (EQ(tortoise, hare))
631 signal_circular_list_error(list);
637 DEFUN("copy-list", Fcopy_list, 1, 1, 0, /*
638 Return a copy of list LIST, which may be a dotted list.
639 The elements of LIST are not copied; they are shared
648 return copy_list(list);
650 list = wrong_type_argument(Qlistp, list);
654 DEFUN("copy-sequence", Fcopy_sequence, 1, 1, 0, /*
655 Return a copy of list, dllist, vector, bit vector or string SEQUENCE.
656 The elements of a list or vector are not copied; they are shared
657 with the original. SEQUENCE may be a dotted list.
665 return copy_list(sequence);
666 if (DLLISTP(sequence))
667 return Fcopy_dllist(sequence);
668 if (STRINGP(sequence))
669 return concat(1, &sequence, c_string, 0);
670 if (VECTORP(sequence))
671 return concat(1, &sequence, c_vector, 0);
672 if (BIT_VECTORP(sequence))
673 return concat(1, &sequence, c_bit_vector, 0);
675 check_losing_bytecode("copy-sequence", sequence);
676 sequence = wrong_type_argument(Qsequencep, sequence);
680 struct merge_string_extents_struct {
682 Bytecount entry_offset;
683 Bytecount entry_length;
687 concat(int nargs, Lisp_Object * args,
688 enum concat_target_type target_type, int last_special)
691 Lisp_Object tail = Qnil;
694 Lisp_Object last_tail;
696 struct merge_string_extents_struct *args_mse = 0;
697 Bufbyte *string_result = 0;
698 Bufbyte *string_result_ptr = 0;
700 int speccount = specpdl_depth();
701 Charcount total_length;
704 /* The modus operandi in Emacs is "caller gc-protects args".
705 However, concat is called many times in Emacs on freshly
706 created stuff. So we help those callers out by protecting
707 the args ourselves to save them a lot of temporary-variable
713 /* #### if the result is a string and any of the strings have a string
714 for the `string-translatable' property, then concat should also
715 concat the args but use the `string-translatable' strings, and store
716 the result in the returned string's `string-translatable' property. */
718 if (target_type == c_string)
719 XMALLOC_OR_ALLOCA(args_mse, nargs, struct merge_string_extents_struct);
721 /* In append, the last arg isn't treated like the others */
722 if (last_special && nargs > 0) {
724 last_tail = args[nargs];
728 /* Check and coerce the arguments. */
729 for (argnum = 0; argnum < nargs; argnum++) {
730 Lisp_Object seq = args[argnum];
731 if (LISTP(seq) || DLLISTP(seq)) ;
732 else if (VECTORP(seq) || STRINGP(seq) || BIT_VECTORP(seq)) ;
733 #ifdef LOSING_BYTECODE
734 else if (COMPILED_FUNCTIONP(seq))
735 /* Urk! We allow this, for "compatibility"... */
738 #if 0 /* removed for XEmacs 21 */
740 /* This is too revolting to think about but maintains
741 compatibility with FSF (and lots and lots of old code). */
742 args[argnum] = Fnumber_to_string(seq);
745 check_losing_bytecode("concat", seq);
746 args[argnum] = wrong_type_argument(Qsequencep, seq);
751 args_mse[argnum].string = seq;
753 args_mse[argnum].string = Qnil;
758 /* Charcount is a misnomer here as we might be dealing with the
759 length of a vector or list, but emphasizes that we're not dealing
760 with Bytecounts in strings */
761 /* Charcount total_length; */
763 for (argnum = 0, total_length = 0; argnum < nargs; argnum++) {
764 #ifdef LOSING_BYTECODE
766 length_with_bytecode_hack(args[argnum]);
768 Charcount thislen = XINT(Flength(args[argnum]));
770 total_length += thislen;
773 switch (target_type) {
775 if (total_length == 0) {
776 /* In append, if all but last arg are nil,
778 XMALLOC_UNBIND(args_mse, nargs, speccount);
779 RETURN_UNGCPRO(last_tail);
781 val = Fmake_list(make_int(total_length), Qnil);
784 if (total_length == 0) {
785 /* In append, if all but last arg are nil,
787 XMALLOC_UNBIND(args_mse, nargs, speccount);
788 RETURN_UNGCPRO(last_tail);
790 val = Fmake_list(make_int(total_length), Qnil);
793 val = make_vector(total_length, Qnil);
796 val = make_bit_vector(total_length, Qzero);
799 /* We don't make the string yet because we don't know
800 the actual number of bytes. This loop was formerly
801 written to call Fmake_string() here and then call
802 set_string_char() for each char. This seems logical
803 enough but is waaaaaaaay slow -- set_string_char()
804 has to scan the whole string up to the place where
805 the substitution is called for in order to find the
806 place to change, and may have to do some realloc()ing
807 in order to make the char fit properly. O(N^2)
810 XMALLOC_ATOMIC_OR_ALLOCA( string_result,
811 total_length * MAX_EMCHAR_LEN,
813 string_result_ptr = string_result;
822 tail = val, toindex = -1; /* -1 in toindex is flag we are
829 for (argnum = 0; argnum < nargs; argnum++) {
830 Charcount thisleni = 0;
831 Charcount thisindex = 0;
832 Lisp_Object seq = args[argnum];
833 Bufbyte *string_source_ptr = 0;
834 Bufbyte *string_prev_result_ptr = string_result_ptr;
837 #ifdef LOSING_BYTECODE
838 thisleni = length_with_bytecode_hack(seq);
840 thisleni = XINT(Flength(seq));
844 string_source_ptr = XSTRING_DATA(seq);
849 /* We've come to the end of this arg, so exit. */
853 /* Fetch next element of `seq' arg into `elt' */
858 if (thisindex >= thisleni)
863 make_char(charptr_emchar
864 (string_source_ptr));
865 INC_CHARPTR(string_source_ptr);
866 } else if (VECTORP(seq))
867 elt = XVECTOR_DATA(seq)[thisindex];
868 else if (BIT_VECTORP(seq))
870 make_int(bit_vector_bit
874 elt = Felt(seq, make_int(thisindex));
878 /* Store into result */
880 /* toindex negative means we are making a list */
884 } else if (VECTORP(val))
885 XVECTOR_DATA(val)[toindex++] = elt;
886 else if (BIT_VECTORP(val)) {
888 set_bit_vector_bit(XBIT_VECTOR(val), toindex++,
891 CHECK_CHAR_COERCE_INT(elt);
893 set_charptr_emchar(string_result_ptr,
898 args_mse[argnum].entry_offset =
899 string_prev_result_ptr - string_result;
900 args_mse[argnum].entry_length =
901 string_result_ptr - string_prev_result_ptr;
905 /* Now we finally make the string. */
906 if (target_type == c_string) {
908 make_string(string_result,
909 string_result_ptr - string_result);
910 for (argnum = 0; argnum < nargs; argnum++) {
911 if (STRINGP(args_mse[argnum].string))
912 copy_string_extents(val,
913 args_mse[argnum].string,
919 XMALLOC_UNBIND(string_result,
920 total_length * MAX_EMCHAR_LEN, speccount);
921 XMALLOC_UNBIND(args_mse, nargs, speccount);
925 XCDR(prev) = last_tail;
930 DEFUN("copy-alist", Fcopy_alist, 1, 1, 0, /*
931 Return a copy of ALIST.
932 This is an alist which represents the same mapping from objects to objects,
933 but does not share the alist structure with ALIST.
934 The objects mapped (cars and cdrs of elements of the alist)
936 Elements of ALIST that are not conses are also shared.
946 alist = concat(1, &alist, c_cons, 0);
947 for (tail = alist; CONSP(tail); tail = XCDR(tail)) {
948 Lisp_Object car = XCAR(tail);
951 XCAR(tail) = Fcons(XCAR(car), XCDR(car));
956 DEFUN("copy-tree", Fcopy_tree, 1, 2, 0, /*
957 Return a copy of a list and substructures.
958 The argument is copied, and any lists contained within it are copied
959 recursively. Circularities and shared substructures are not preserved.
960 Second arg VECP causes vectors to be copied, too. Strings and bit vectors
965 return safe_copy_tree(arg, vecp, 0);
968 Lisp_Object safe_copy_tree(Lisp_Object arg, Lisp_Object vecp, int depth)
971 signal_simple_error("Stack overflow in copy-tree", arg);
975 rest = arg = Fcopy_sequence(arg);
976 while (CONSP(rest)) {
977 Lisp_Object elt = XCAR(rest);
979 if (CONSP(elt) || VECTORP(elt))
981 safe_copy_tree(elt, vecp, depth + 1);
982 if (VECTORP(XCDR(rest))) /* hack for (a b . [c d]) */
984 safe_copy_tree(XCDR(rest), vecp, depth + 1);
987 } else if (VECTORP(arg) && !NILP(vecp)) {
988 int i = XVECTOR_LENGTH(arg);
990 arg = Fcopy_sequence(arg);
991 for (j = 0; j < i; j++) {
992 Lisp_Object elt = XVECTOR_DATA(arg)[j];
994 if (CONSP(elt) || VECTORP(elt))
995 XVECTOR_DATA(arg)[j] =
996 safe_copy_tree(elt, vecp, depth + 1);
1002 DEFUN("substring", Fsubstring, 2, 3, 0, /*
1003 Return the substring of STRING starting at START and ending before END.
1004 END may be nil or omitted; then the substring runs to the end of STRING.
1005 If START or END is negative, it counts from the end.
1006 Relevant parts of the string-extent-data are copied to the new string.
1008 (string, start, end))
1010 Charcount ccstart, ccend;
1011 Bytecount bstart, blen;
1014 CHECK_STRING(string);
1016 get_string_range_char(string, start, end, &ccstart, &ccend,
1017 GB_HISTORICAL_STRING_BEHAVIOR);
1018 bstart = charcount_to_bytecount(XSTRING_DATA(string), ccstart);
1020 charcount_to_bytecount(XSTRING_DATA(string) + bstart,
1022 val = make_string(XSTRING_DATA(string) + bstart, blen);
1023 /* Copy any applicable extent information into the new string. */
1024 copy_string_extents(val, string, 0, bstart, blen);
1028 DEFUN("subseq", Fsubseq, 2, 3, 0, /*
1029 Return the subsequence of SEQUENCE starting at START and ending before END.
1030 END may be omitted; then the subsequence runs to the end of SEQUENCE.
1031 If START or END is negative, it counts from the end.
1032 The returned subsequence is always of the same type as SEQUENCE.
1033 If SEQUENCE is a string, relevant parts of the string-extent-data
1034 are copied to the new string.
1036 (sequence, start, end))
1038 EMACS_INT len, s, e;
1040 if (STRINGP(sequence))
1041 return Fsubstring(sequence, start, end);
1043 len = XINT(Flength(sequence));
1059 if (!(0 <= s && s <= e && e <= len))
1060 args_out_of_range_3(sequence, make_int(s), make_int(e));
1062 if (VECTORP(sequence)) {
1063 Lisp_Object result = make_vector(e - s, Qnil);
1065 Lisp_Object *in_elts = XVECTOR_DATA(sequence);
1066 Lisp_Object *out_elts = XVECTOR_DATA(result);
1068 for (i = s; i < e; i++)
1069 out_elts[i - s] = in_elts[i];
1071 } else if (LISTP(sequence)) {
1072 Lisp_Object result = Qnil;
1075 sequence = Fnthcdr(make_int(s), sequence);
1077 for (i = s; i < e; i++) {
1078 result = Fcons(Fcar(sequence), result);
1079 sequence = Fcdr(sequence);
1082 return Fnreverse(result);
1083 } else if (BIT_VECTORP(sequence)) {
1084 Lisp_Object result = make_bit_vector(e - s, Qzero);
1087 for (i = s; i < e; i++)
1088 set_bit_vector_bit(XBIT_VECTOR(result), i - s,
1089 bit_vector_bit(XBIT_VECTOR(sequence),
1093 abort(); /* unreachable, since Flength (sequence) did not get
1099 DEFUN("nthcdr", Fnthcdr, 2, 2, 0, /*
1100 Take cdr N times on LIST, and return the result.
1105 REGISTER Lisp_Object tail = list;
1107 for (i = XINT(n); i; i--) {
1110 else if (NILP(tail))
1113 tail = wrong_type_argument(Qlistp, tail);
1120 DEFUN("nth", Fnth, 2, 2, 0, /*
1121 Return the Nth element of LIST.
1122 N counts from zero. If LIST is not that long, nil is returned.
1126 return Fcar(Fnthcdr(n, list));
1129 DEFUN("elt", Felt, 2, 2, 0, /*
1130 Return element of SEQUENCE at index N.
1135 if (!(INTP(n) || CHARP(n))) {
1136 n = wrong_type_argument(Qinteger_or_char_p, n);
1140 if (LISTP(sequence)) {
1141 Lisp_Object tem = Fnthcdr(n, sequence);
1142 /* #### Utterly, completely, fucking disgusting.
1143 * #### The whole point of "elt" is that it operates on
1144 * #### sequences, and does error- (bounds-) checking.
1150 /* This is The Way It Has Always Been. */
1153 /* This is The Way Mly and Cltl2 say It Should Be. */
1154 args_out_of_range(sequence, n);
1156 } else if (DLLISTP(sequence)) {
1157 dllist_item_t elm = NULL;
1160 EMACS_INT rn = ent_int(n);
1163 args_out_of_range(sequence, n);
1167 if (rn * 2 < (EMACS_INT)XDLLIST_SIZE(sequence)) {
1168 /* start at the front */
1169 elm = XDLLIST_FIRST(sequence);
1172 /* start at the end */
1173 elm = XDLLIST_LAST(sequence);
1175 i = XDLLIST_SIZE(sequence) - rn - 1;
1178 for (; i > 0 && elm != NULL; i--)
1185 return (Lisp_Object)elm->item;
1189 } else if (STRINGP(sequence) ||
1190 VECTORP(sequence) || BIT_VECTORP(sequence))
1191 return Faref(sequence, n);
1192 #ifdef LOSING_BYTECODE
1193 else if (COMPILED_FUNCTIONP(sequence)) {
1194 EMACS_INT idx = ent_int(n);
1197 args_out_of_range(sequence, n);
1199 /* Utter perversity */
1201 Lisp_Compiled_Function *f =
1202 XCOMPILED_FUNCTION(sequence);
1204 case COMPILED_ARGLIST:
1205 return compiled_function_arglist(f);
1206 case COMPILED_INSTRUCTIONS:
1207 return compiled_function_instructions(f);
1208 case COMPILED_CONSTANTS:
1209 return compiled_function_constants(f);
1210 case COMPILED_STACK_DEPTH:
1211 return compiled_function_stack_depth(f);
1212 case COMPILED_DOC_STRING:
1213 return compiled_function_documentation(f);
1214 case COMPILED_DOMAIN:
1215 return compiled_function_domain(f);
1216 case COMPILED_INTERACTIVE:
1217 if (f->flags.interactivep)
1218 return compiled_function_interactive(f);
1219 /* if we return nil, can't tell interactive with no args
1220 from noninteractive. */
1227 #endif /* LOSING_BYTECODE */
1229 check_losing_bytecode("elt", sequence);
1230 sequence = wrong_type_argument(Qsequencep, sequence);
1235 DEFUN("last", Flast, 1, 2, 0, /*
1236 Return the tail of list LIST, of length N (default 1).
1237 LIST may be a dotted list, but not a circular list.
1238 Optional argument N must be a non-negative integer.
1239 If N is zero, then the atom that terminates the list is returned.
1240 If N is greater than the length of LIST, then LIST itself is returned.
1244 EMACS_INT int_n, count;
1245 Lisp_Object retval, tortoise, hare;
1248 return Fdllist_rac(list);
1259 for (retval = tortoise = hare = list, count = 0;
1262 (int_n-- <= 0 ? ((void)(retval = XCDR(retval))) : (void)0),
1264 if (count < CIRCULAR_LIST_SUSPICION_LENGTH)
1268 tortoise = XCDR(tortoise);
1269 if (EQ(hare, tortoise))
1270 signal_circular_list_error(list);
1276 DEFUN("nbutlast", Fnbutlast, 1, 2, 0, /*
1277 Modify LIST to remove the last N (default 1) elements.
1278 If LIST has N or fewer elements, nil is returned and LIST is unmodified.
1294 Lisp_Object last_cons = list;
1296 EXTERNAL_LIST_LOOP_1(list) {
1298 last_cons = XCDR(last_cons);
1304 XCDR(last_cons) = Qnil;
1309 DEFUN("butlast", Fbutlast, 1, 2, 0, /*
1310 Return a copy of LIST with the last N (default 1) elements removed.
1311 If LIST has N or fewer elements, nil is returned.
1327 Lisp_Object retval = Qnil;
1328 Lisp_Object tail = list;
1330 EXTERNAL_LIST_LOOP_1(list) {
1332 retval = Fcons(XCAR(tail), retval);
1337 return Fnreverse(retval);
1341 DEFUN("member", Fmember, 2, 2, 0, /*
1342 Return non-nil if ELT is an element of LIST. Comparison done with `equal'.
1343 The value is actually the tail of LIST whose car is ELT.
1347 EXTERNAL_LIST_LOOP_3(list_elt, list, tail) {
1348 if (internal_equal(elt, list_elt, 0))
1354 DEFUN("old-member", Fold_member, 2, 2, 0, /*
1355 Return non-nil if ELT is an element of LIST. Comparison done with `old-equal'.
1356 The value is actually the tail of LIST whose car is ELT.
1357 This function is provided only for byte-code compatibility with v19.
1362 EXTERNAL_LIST_LOOP_3(list_elt, list, tail) {
1363 if (internal_old_equal(elt, list_elt, 0))
1369 DEFUN("memq", Fmemq, 2, 2, 0, /*
1370 Return non-nil if ELT is an element of LIST. Comparison done with `eq'.
1371 The value is actually the tail of LIST whose car is ELT.
1375 EXTERNAL_LIST_LOOP_3(list_elt, list, tail) {
1376 if (EQ_WITH_EBOLA_NOTICE(elt, list_elt))
1382 DEFUN("old-memq", Fold_memq, 2, 2, 0, /*
1383 Return non-nil if ELT is an element of LIST. Comparison done with `old-eq'.
1384 The value is actually the tail of LIST whose car is ELT.
1385 This function is provided only for byte-code compatibility with v19.
1390 EXTERNAL_LIST_LOOP_3(list_elt, list, tail) {
1391 if (HACKEQ_UNSAFE(elt, list_elt))
1397 Lisp_Object memq_no_quit(Lisp_Object elt, Lisp_Object list)
1399 LIST_LOOP_3(list_elt, list, tail) {
1400 if (EQ_WITH_EBOLA_NOTICE(elt, list_elt))
1406 DEFUN("assoc", Fassoc, 2, 2, 0, /*
1407 Return non-nil if KEY is `equal' to the car of an element of ALIST.
1408 The value is actually the element of ALIST whose car equals KEY.
1412 /* This function can GC. */
1413 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1414 if (internal_equal(key, elt_car, 0))
1420 DEFUN("old-assoc", Fold_assoc, 2, 2, 0, /*
1421 Return non-nil if KEY is `old-equal' to the car of an element of ALIST.
1422 The value is actually the element of ALIST whose car equals KEY.
1426 /* This function can GC. */
1427 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1428 if (internal_old_equal(key, elt_car, 0))
1434 Lisp_Object assoc_no_quit(Lisp_Object key, Lisp_Object alist)
1436 int speccount = specpdl_depth();
1437 specbind(Qinhibit_quit, Qt);
1438 return unbind_to(speccount, Fassoc(key, alist));
1441 DEFUN("assq", Fassq, 2, 2, 0, /*
1442 Return non-nil if KEY is `eq' to the car of an element of ALIST.
1443 The value is actually the element of ALIST whose car is KEY.
1444 Elements of ALIST that are not conses are ignored.
1448 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1449 if (EQ_WITH_EBOLA_NOTICE(key, elt_car))
1455 DEFUN("old-assq", Fold_assq, 2, 2, 0, /*
1456 Return non-nil if KEY is `old-eq' to the car of an element of ALIST.
1457 The value is actually the element of ALIST whose car is KEY.
1458 Elements of ALIST that are not conses are ignored.
1459 This function is provided only for byte-code compatibility with v19.
1464 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1465 if (HACKEQ_UNSAFE(key, elt_car))
1471 /* Like Fassq but never report an error and do not allow quits.
1472 Use only on lists known never to be circular. */
1474 Lisp_Object assq_no_quit(Lisp_Object key, Lisp_Object alist)
1476 /* This cannot GC. */
1477 LIST_LOOP_2(elt, alist) {
1478 Lisp_Object elt_car = XCAR(elt);
1479 if (EQ_WITH_EBOLA_NOTICE(key, elt_car))
1485 DEFUN("rassoc", Frassoc, 2, 2, 0, /*
1486 Return non-nil if VALUE is `equal' to the cdr of an element of ALIST.
1487 The value is actually the element of ALIST whose cdr equals VALUE.
1491 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1492 if (internal_equal(value, elt_cdr, 0))
1498 DEFUN("old-rassoc", Fold_rassoc, 2, 2, 0, /*
1499 Return non-nil if VALUE is `old-equal' to the cdr of an element of ALIST.
1500 The value is actually the element of ALIST whose cdr equals VALUE.
1504 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1505 if (internal_old_equal(value, elt_cdr, 0))
1511 DEFUN("rassq", Frassq, 2, 2, 0, /*
1512 Return non-nil if VALUE is `eq' to the cdr of an element of ALIST.
1513 The value is actually the element of ALIST whose cdr is VALUE.
1517 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1518 if (EQ_WITH_EBOLA_NOTICE(value, elt_cdr))
1524 DEFUN("old-rassq", Fold_rassq, 2, 2, 0, /*
1525 Return non-nil if VALUE is `old-eq' to the cdr of an element of ALIST.
1526 The value is actually the element of ALIST whose cdr is VALUE.
1530 EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, alist) {
1531 if (HACKEQ_UNSAFE(value, elt_cdr))
1537 /* Like Frassq, but caller must ensure that ALIST is properly
1538 nil-terminated and ebola-free. */
1539 Lisp_Object rassq_no_quit(Lisp_Object value, Lisp_Object alist)
1541 LIST_LOOP_2(elt, alist) {
1542 Lisp_Object elt_cdr = XCDR(elt);
1543 if (EQ_WITH_EBOLA_NOTICE(value, elt_cdr))
1549 DEFUN("delete", Fdelete, 2, 2, 0, /*
1550 Delete by side effect any occurrences of ELT as a member of LIST.
1551 The modified LIST is returned. Comparison is done with `equal'.
1552 If the first member of LIST is ELT, there is no way to remove it by side
1553 effect; therefore, write `(setq foo (delete element foo))' to be sure
1554 of changing the value of `foo'.
1559 EXTERNAL_LIST_LOOP_DELETE_IF(list_elt, list,
1560 (internal_equal(elt, list_elt, 0)));
1564 DEFUN("old-delete", Fold_delete, 2, 2, 0, /*
1565 Delete by side effect any occurrences of ELT as a member of LIST.
1566 The modified LIST is returned. Comparison is done with `old-equal'.
1567 If the first member of LIST is ELT, there is no way to remove it by side
1568 effect; therefore, write `(setq foo (old-delete element foo))' to be sure
1569 of changing the value of `foo'.
1573 EXTERNAL_LIST_LOOP_DELETE_IF(list_elt, list,
1574 (internal_old_equal(elt, list_elt, 0)));
1578 DEFUN("delq", Fdelq, 2, 2, 0, /*
1579 Delete by side effect any occurrences of ELT as a member of LIST.
1580 The modified LIST is returned. Comparison is done with `eq'.
1581 If the first member of LIST is ELT, there is no way to remove it by side
1582 effect; therefore, write `(setq foo (delq element foo))' to be sure of
1583 changing the value of `foo'.
1587 EXTERNAL_LIST_LOOP_DELETE_IF(list_elt, list,
1588 (EQ_WITH_EBOLA_NOTICE(elt, list_elt)));
1592 DEFUN("old-delq", Fold_delq, 2, 2, 0, /*
1593 Delete by side effect any occurrences of ELT as a member of LIST.
1594 The modified LIST is returned. Comparison is done with `old-eq'.
1595 If the first member of LIST is ELT, there is no way to remove it by side
1596 effect; therefore, write `(setq foo (old-delq element foo))' to be sure of
1597 changing the value of `foo'.
1601 EXTERNAL_LIST_LOOP_DELETE_IF(list_elt, list,
1602 (HACKEQ_UNSAFE(elt, list_elt)));
1606 /* Like Fdelq, but caller must ensure that LIST is properly
1607 nil-terminated and ebola-free. */
1609 Lisp_Object delq_no_quit(Lisp_Object elt, Lisp_Object list)
1611 LIST_LOOP_DELETE_IF(list_elt, list,
1612 (EQ_WITH_EBOLA_NOTICE(elt, list_elt)));
1616 /* Be VERY careful with this. This is like delq_no_quit() but
1617 also calls free_cons() on the removed conses. You must be SURE
1618 that no pointers to the freed conses remain around (e.g.
1619 someone else is pointing to part of the list). This function
1620 is useful on internal lists that are used frequently and where
1621 the actual list doesn't escape beyond known code bounds. */
1623 Lisp_Object delq_no_quit_and_free_cons(Lisp_Object elt, Lisp_Object list)
1625 REGISTER Lisp_Object tail = list;
1626 REGISTER Lisp_Object prev = Qnil;
1628 while (!NILP(tail)) {
1629 REGISTER Lisp_Object tem = XCAR(tail);
1631 Lisp_Object cons_to_free = tail;
1635 XCDR(prev) = XCDR(tail);
1637 free_cons(XCONS(cons_to_free));
1646 DEFUN("remassoc", Fremassoc, 2, 2, 0, /*
1647 Delete by side effect any elements of ALIST whose car is `equal' to KEY.
1648 The modified ALIST is returned. If the first member of ALIST has a car
1649 that is `equal' to KEY, there is no way to remove it by side effect;
1650 therefore, write `(setq foo (remassoc key foo))' to be sure of changing
1655 EXTERNAL_LIST_LOOP_DELETE_IF(elt, alist,
1657 internal_equal(key, XCAR(elt), 0)));
1661 Lisp_Object remassoc_no_quit(Lisp_Object key, Lisp_Object alist)
1663 int speccount = specpdl_depth();
1664 specbind(Qinhibit_quit, Qt);
1665 return unbind_to(speccount, Fremassoc(key, alist));
1668 DEFUN("remassq", Fremassq, 2, 2, 0, /*
1669 Delete by side effect any elements of ALIST whose car is `eq' to KEY.
1670 The modified ALIST is returned. If the first member of ALIST has a car
1671 that is `eq' to KEY, there is no way to remove it by side effect;
1672 therefore, write `(setq foo (remassq key foo))' to be sure of changing
1677 EXTERNAL_LIST_LOOP_DELETE_IF(elt, alist,
1679 EQ_WITH_EBOLA_NOTICE(key, XCAR(elt))));
1683 /* no quit, no errors; be careful */
1685 Lisp_Object remassq_no_quit(Lisp_Object key, Lisp_Object alist)
1687 LIST_LOOP_DELETE_IF(elt, alist,
1689 EQ_WITH_EBOLA_NOTICE(key, XCAR(elt))));
1693 DEFUN("remrassoc", Fremrassoc, 2, 2, 0, /*
1694 Delete by side effect any elements of ALIST whose cdr is `equal' to VALUE.
1695 The modified ALIST is returned. If the first member of ALIST has a car
1696 that is `equal' to VALUE, there is no way to remove it by side effect;
1697 therefore, write `(setq foo (remrassoc value foo))' to be sure of changing
1702 EXTERNAL_LIST_LOOP_DELETE_IF(elt, alist,
1704 internal_equal(value, XCDR(elt), 0)));
1708 DEFUN("remrassq", Fremrassq, 2, 2, 0, /*
1709 Delete by side effect any elements of ALIST whose cdr is `eq' to VALUE.
1710 The modified ALIST is returned. If the first member of ALIST has a car
1711 that is `eq' to VALUE, there is no way to remove it by side effect;
1712 therefore, write `(setq foo (remrassq value foo))' to be sure of changing
1717 EXTERNAL_LIST_LOOP_DELETE_IF(elt, alist,
1719 EQ_WITH_EBOLA_NOTICE(value, XCDR(elt))));
1723 /* Like Fremrassq, fast and unsafe; be careful */
1724 Lisp_Object remrassq_no_quit(Lisp_Object value, Lisp_Object alist)
1726 LIST_LOOP_DELETE_IF(elt, alist,
1728 EQ_WITH_EBOLA_NOTICE(value, XCDR(elt))));
1732 DEFUN("nreverse", Fnreverse, 1, 1, 0, /*
1733 Reverse LIST by destructively modifying cdr pointers.
1734 Return the beginning of the reversed list.
1735 Also see: `reverse'.
1739 struct gcpro gcpro1, gcpro2;
1740 REGISTER Lisp_Object prev = Qnil;
1741 REGISTER Lisp_Object tail = list;
1743 /* We gcpro our args; see `nconc' */
1745 while (!NILP(tail)) {
1746 REGISTER Lisp_Object next;
1747 CONCHECK_CONS(tail);
1757 DEFUN("reverse", Freverse, 1, 1, 0, /*
1758 Reverse LIST, copying. Return the beginning of the reversed list.
1759 See also the function `nreverse', which is used more often.
1763 Lisp_Object reversed_list = Qnil;
1764 EXTERNAL_LIST_LOOP_2(elt, list) {
1765 reversed_list = Fcons(elt, reversed_list);
1767 return reversed_list;
1770 static Lisp_Object list_merge(Lisp_Object org_l1, Lisp_Object org_l2,
1771 Lisp_Object lisp_arg,
1772 int (*pred_fn) (Lisp_Object, Lisp_Object,
1773 Lisp_Object lisp_arg));
1776 list_sort(Lisp_Object list,
1777 Lisp_Object lisp_arg,
1778 int (*pred_fn) (Lisp_Object, Lisp_Object, Lisp_Object lisp_arg))
1780 struct gcpro gcpro1, gcpro2, gcpro3;
1781 Lisp_Object back, tem;
1782 Lisp_Object front = list;
1783 Lisp_Object len = Flength(list);
1788 len = make_int(XINT(len) / 2 - 1);
1789 tem = Fnthcdr(len, list);
1793 GCPRO3(front, back, lisp_arg);
1794 front = list_sort(front, lisp_arg, pred_fn);
1795 back = list_sort(back, lisp_arg, pred_fn);
1797 return list_merge(front, back, lisp_arg, pred_fn);
1801 merge_pred_function(Lisp_Object obj1, Lisp_Object obj2, Lisp_Object pred)
1805 /* prevents the GC from happening in call2 */
1806 int speccount = specpdl_depth();
1807 /* Emacs' GC doesn't actually relocate pointers, so this probably
1808 isn't strictly necessary */
1809 record_unwind_protect(restore_gc_inhibit,
1810 make_int(gc_currently_forbidden));
1811 gc_currently_forbidden = 1;
1812 tmp = call2(pred, obj1, obj2);
1813 unbind_to(speccount, Qnil);
1821 DEFUN("sort", Fsort, 2, 2, 0, /*
1822 Sort LIST, stably, comparing elements using PREDICATE.
1823 Returns the sorted list. LIST is modified by side effects.
1824 PREDICATE is called with two elements of LIST, and should return T
1825 if the first element is "less" than the second.
1829 return list_sort(list, predicate, merge_pred_function);
1832 Lisp_Object merge(Lisp_Object org_l1, Lisp_Object org_l2, Lisp_Object pred)
1834 return list_merge(org_l1, org_l2, pred, merge_pred_function);
1838 list_merge(Lisp_Object org_l1, Lisp_Object org_l2,
1839 Lisp_Object lisp_arg,
1840 int (*pred_fn) (Lisp_Object, Lisp_Object, Lisp_Object lisp_arg))
1846 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1853 /* It is sufficient to protect org_l1 and org_l2.
1854 When l1 and l2 are updated, we copy the new values
1855 back into the org_ vars. */
1857 GCPRO4(org_l1, org_l2, lisp_arg, value);
1875 if (((*pred_fn) (Fcar(l2), Fcar(l1), lisp_arg)) < 0) {
1892 /************************************************************************/
1893 /* property-list functions */
1894 /************************************************************************/
1896 /* For properties of text, we need to do order-insensitive comparison of
1897 plists. That is, we need to compare two plists such that they are the
1898 same if they have the same set of keys, and equivalent values.
1899 So (a 1 b 2) would be equal to (b 2 a 1).
1901 NIL_MEANS_NOT_PRESENT is as in `plists-eq' etc.
1902 LAXP means use `equal' for comparisons.
1905 plists_differ(Lisp_Object a, Lisp_Object b, int nil_means_not_present,
1906 int laxp, int depth)
1908 int eqp = (depth == -1); /* -1 as depth means use eq, not equal. */
1909 int la, lb, m, i, fill;
1910 Lisp_Object *keys, *vals;
1913 int speccount = specpdl_depth();
1915 if (NILP(a) && NILP(b))
1918 Fcheck_valid_plist(a);
1919 Fcheck_valid_plist(b);
1921 la = XINT(Flength(a));
1922 lb = XINT(Flength(b));
1923 m = (la > lb ? la : lb);
1925 XMALLOC_OR_ALLOCA(keys, m, Lisp_Object);
1926 XMALLOC_OR_ALLOCA(vals, m, Lisp_Object);
1927 XMALLOC_ATOMIC_OR_ALLOCA(flags, m, char);
1929 /* First extract the pairs from A. */
1930 for (rest = a; !NILP(rest); rest = XCDR(XCDR(rest))) {
1931 Lisp_Object k = XCAR(rest);
1932 Lisp_Object v = XCAR(XCDR(rest));
1933 /* Maybe be Ebolified. */
1934 if (nil_means_not_present && NILP(v))
1941 /* Now iterate over B, and stop if we find something that's not in A,
1942 or that doesn't match. As we match, mark them. */
1943 for (rest = b; !NILP(rest); rest = XCDR(XCDR(rest))) {
1944 Lisp_Object k = XCAR(rest);
1945 Lisp_Object v = XCAR(XCDR(rest));
1946 /* Maybe be Ebolified. */
1947 if (nil_means_not_present && NILP(v))
1949 for (i = 0; i < fill; i++) {
1950 if (!laxp ? EQ(k, keys[i]) :
1951 internal_equal(k, keys[i], depth)) {
1953 /* We narrowly escaped being Ebolified
1955 ? !EQ_WITH_EBOLA_NOTICE(v, vals[i])
1956 : !internal_equal(v, vals[i], depth))
1957 /* a property in B has a different value
1965 /* there are some properties in B that are not in A */
1968 /* Now check to see that all the properties in A were also in B */
1969 for (i = 0; i < fill; i++)
1973 XMALLOC_UNBIND(flags, m, speccount);
1974 XMALLOC_UNBIND(vals, m, speccount);
1975 XMALLOC_UNBIND(keys, m, speccount);
1980 XMALLOC_UNBIND(flags, m, speccount);
1981 XMALLOC_UNBIND(vals, m, speccount);
1982 XMALLOC_UNBIND(keys, m, speccount);
1986 DEFUN("plists-eq", Fplists_eq, 2, 3, 0, /*
1987 Return non-nil if property lists A and B are `eq'.
1988 A property list is an alternating list of keywords and values.
1989 This function does order-insensitive comparisons of the property lists:
1990 For example, the property lists '(a 1 b 2) and '(b 2 a 1) are equal.
1991 Comparison between values is done using `eq'. See also `plists-equal'.
1992 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
1993 a nil value is ignored. This feature is a virus that has infected
1994 old Lisp implementations, but should not be used except for backward
1997 (a, b, nil_means_not_present))
1999 return (plists_differ(a, b, !NILP(nil_means_not_present), 0, -1)
2003 DEFUN("plists-equal", Fplists_equal, 2, 3, 0, /*
2004 Return non-nil if property lists A and B are `equal'.
2005 A property list is an alternating list of keywords and values. This
2006 function does order-insensitive comparisons of the property lists: For
2007 example, the property lists '(a 1 b 2) and '(b 2 a 1) are equal.
2008 Comparison between values is done using `equal'. See also `plists-eq'.
2009 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
2010 a nil value is ignored. This feature is a virus that has infected
2011 old Lisp implementations, but should not be used except for backward
2014 (a, b, nil_means_not_present))
2016 return (plists_differ(a, b, !NILP(nil_means_not_present), 0, 1)
2020 DEFUN("lax-plists-eq", Flax_plists_eq, 2, 3, 0, /*
2021 Return non-nil if lax property lists A and B are `eq'.
2022 A property list is an alternating list of keywords and values.
2023 This function does order-insensitive comparisons of the property lists:
2024 For example, the property lists '(a 1 b 2) and '(b 2 a 1) are equal.
2025 Comparison between values is done using `eq'. See also `plists-equal'.
2026 A lax property list is like a regular one except that comparisons between
2027 keywords is done using `equal' instead of `eq'.
2028 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
2029 a nil value is ignored. This feature is a virus that has infected
2030 old Lisp implementations, but should not be used except for backward
2033 (a, b, nil_means_not_present))
2035 return (plists_differ(a, b, !NILP(nil_means_not_present), 1, -1)
2039 DEFUN("lax-plists-equal", Flax_plists_equal, 2, 3, 0, /*
2040 Return non-nil if lax property lists A and B are `equal'.
2041 A property list is an alternating list of keywords and values. This
2042 function does order-insensitive comparisons of the property lists: For
2043 example, the property lists '(a 1 b 2) and '(b 2 a 1) are equal.
2044 Comparison between values is done using `equal'. See also `plists-eq'.
2045 A lax property list is like a regular one except that comparisons between
2046 keywords is done using `equal' instead of `eq'.
2047 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
2048 a nil value is ignored. This feature is a virus that has infected
2049 old Lisp implementations, but should not be used except for backward
2052 (a, b, nil_means_not_present))
2054 return (plists_differ(a, b, !NILP(nil_means_not_present), 1, 1)
2058 /* Return the value associated with key PROPERTY in property list PLIST.
2059 Return nil if key not found. This function is used for internal
2060 property lists that cannot be directly manipulated by the user.
2063 Lisp_Object internal_plist_get(Lisp_Object plist, Lisp_Object property)
2067 for (tail = plist; !NILP(tail); tail = XCDR(XCDR(tail))) {
2068 if (EQ(XCAR(tail), property))
2069 return XCAR(XCDR(tail));
2075 /* Set PLIST's value for PROPERTY to VALUE. Analogous to
2076 internal_plist_get(). */
2079 internal_plist_put(Lisp_Object * plist, Lisp_Object property, Lisp_Object value)
2083 for (tail = *plist; !NILP(tail); tail = XCDR(XCDR(tail))) {
2084 if (EQ(XCAR(tail), property)) {
2085 XCAR(XCDR(tail)) = value;
2090 *plist = Fcons(property, Fcons(value, *plist));
2093 int internal_remprop(Lisp_Object * plist, Lisp_Object property)
2095 Lisp_Object tail, prev;
2097 for (tail = *plist, prev = Qnil; !NILP(tail); tail = XCDR(XCDR(tail))) {
2098 if (EQ(XCAR(tail), property)) {
2100 *plist = XCDR(XCDR(tail));
2102 XCDR(XCDR(prev)) = XCDR(XCDR(tail));
2111 /* Called on a malformed property list. BADPLACE should be some
2112 place where truncating will form a good list -- i.e. we shouldn't
2113 result in a list with an odd length. */
2116 bad_bad_bunny(Lisp_Object * plist, Lisp_Object * badplace, Error_behavior errb)
2118 if (ERRB_EQ(errb, ERROR_ME))
2119 return Fsignal(Qmalformed_property_list,
2120 list2(*plist, *badplace));
2122 if (ERRB_EQ(errb, ERROR_ME_WARN)) {
2123 warn_when_safe_lispobj
2126 ("Malformed property list -- list has been truncated"),
2134 /* Called on a circular property list. BADPLACE should be some place
2135 where truncating will result in an even-length list, as above.
2136 If doesn't particularly matter where we truncate -- anywhere we
2137 truncate along the entire list will break the circularity, because
2138 it will create a terminus and the list currently doesn't have one.
2142 bad_bad_turtle(Lisp_Object * plist, Lisp_Object * badplace, Error_behavior errb)
2144 if (ERRB_EQ(errb, ERROR_ME))
2145 return Fsignal(Qcircular_property_list, list1(*plist));
2147 if (ERRB_EQ(errb, ERROR_ME_WARN)) {
2148 warn_when_safe_lispobj
2151 ("Circular property list -- list has been truncated"),
2159 /* Advance the tortoise pointer by two (one iteration of a property-list
2160 loop) and the hare pointer by four and verify that no malformations
2161 or circularities exist. If so, return zero and store a value into
2162 RETVAL that should be returned by the calling function. Otherwise,
2163 return 1. See external_plist_get().
2167 advance_plist_pointers(Lisp_Object * plist,
2168 Lisp_Object ** tortoise, Lisp_Object ** hare,
2169 Error_behavior errb, Lisp_Object * retval)
2172 Lisp_Object *tortsave = *tortoise;
2174 /* Note that our "fixing" may be more brutal than necessary,
2175 but it's the user's own problem, not ours, if they went in and
2176 manually fucked up a plist. */
2178 for (i = 0; i < 2; i++) {
2179 /* This is a standard iteration of a defensive-loop-checking
2180 loop. We just do it twice because we want to advance past
2181 both the property and its value.
2183 If the pointer indirection is confusing you, remember that
2184 one level of indirection on the hare and tortoise pointers
2185 is only due to pass-by-reference for this function. The other
2186 level is so that the plist can be fixed in place. */
2188 /* When we reach the end of a well-formed plist, **HARE is
2189 nil. In that case, we don't do anything at all except
2190 advance TORTOISE by one. Otherwise, we advance HARE
2191 by two (making sure it's OK to do so), then advance
2192 TORTOISE by one (it will always be OK to do so because
2193 the HARE is always ahead of the TORTOISE and will have
2194 already verified the path), then make sure TORTOISE and
2195 HARE don't contain the same non-nil object -- if the
2196 TORTOISE and the HARE ever meet, then obviously we're
2197 in a circularity, and if we're in a circularity, then
2198 the TORTOISE and the HARE can't cross paths without
2199 meeting, since the HARE only gains one step over the
2200 TORTOISE per iteration. */
2202 if (!NILP(**hare)) {
2203 Lisp_Object *haresave = *hare;
2204 if (!CONSP(**hare)) {
2205 *retval = bad_bad_bunny(plist, haresave, errb);
2208 *hare = &XCDR(**hare);
2209 /* In a non-plist, we'd check here for a nil value for
2210 **HARE, which is OK (it just means the list has an
2211 odd number of elements). In a plist, it's not OK
2212 for the list to have an odd number of elements. */
2213 if (!CONSP(**hare)) {
2214 *retval = bad_bad_bunny(plist, haresave, errb);
2217 *hare = &XCDR(**hare);
2220 *tortoise = &XCDR(**tortoise);
2221 if (!NILP(**hare) && EQ(**tortoise, **hare)) {
2222 *retval = bad_bad_turtle(plist, tortsave, errb);
2230 /* Return the value of PROPERTY from PLIST, or Qunbound if
2231 property is not on the list.
2233 PLIST is a Lisp-accessible property list, meaning that it
2234 has to be checked for malformations and circularities.
2236 If ERRB is ERROR_ME, an error will be signalled. Otherwise, the
2237 function will never signal an error; and if ERRB is ERROR_ME_WARN,
2238 on finding a malformation or a circularity, it issues a warning and
2239 attempts to silently fix the problem.
2241 A pointer to PLIST is passed in so that PLIST can be successfully
2242 "fixed" even if the error is at the beginning of the plist. */
2245 external_plist_get(Lisp_Object * plist, Lisp_Object property,
2246 int laxp, Error_behavior errb)
2248 Lisp_Object *tortoise = plist;
2249 Lisp_Object *hare = plist;
2251 while (!NILP(*tortoise)) {
2252 Lisp_Object *tortsave = tortoise;
2255 /* We do the standard tortoise/hare march. We isolate the
2256 grungy stuff to do this in advance_plist_pointers(), though.
2257 To us, all this function does is advance the tortoise
2258 pointer by two and the hare pointer by four and make sure
2259 everything's OK. We first advance the pointers and then
2260 check if a property matched; this ensures that our
2261 check for a matching property is safe. */
2263 if (!advance_plist_pointers
2264 (plist, &tortoise, &hare, errb, &retval))
2267 if (!laxp ? EQ(XCAR(*tortsave), property)
2268 : internal_equal(XCAR(*tortsave), property, 0))
2269 return XCAR(XCDR(*tortsave));
2275 /* Set PLIST's value for PROPERTY to VALUE, given a possibly
2276 malformed or circular plist. Analogous to external_plist_get(). */
2279 external_plist_put(Lisp_Object * plist, Lisp_Object property,
2280 Lisp_Object value, int laxp, Error_behavior errb)
2282 Lisp_Object *tortoise = plist;
2283 Lisp_Object *hare = plist;
2285 while (!NILP(*tortoise)) {
2286 Lisp_Object *tortsave = tortoise;
2290 if (!advance_plist_pointers
2291 (plist, &tortoise, &hare, errb, &retval))
2294 if (!laxp ? EQ(XCAR(*tortsave), property)
2295 : internal_equal(XCAR(*tortsave), property, 0)) {
2296 XCAR(XCDR(*tortsave)) = value;
2301 *plist = Fcons(property, Fcons(value, *plist));
2305 external_remprop(Lisp_Object * plist, Lisp_Object property,
2306 int laxp, Error_behavior errb)
2308 Lisp_Object *tortoise = plist;
2309 Lisp_Object *hare = plist;
2311 while (!NILP(*tortoise)) {
2312 Lisp_Object *tortsave = tortoise;
2316 if (!advance_plist_pointers
2317 (plist, &tortoise, &hare, errb, &retval))
2320 if (!laxp ? EQ(XCAR(*tortsave), property)
2321 : internal_equal(XCAR(*tortsave), property, 0)) {
2322 /* Now you see why it's so convenient to have that level
2324 *tortsave = XCDR(XCDR(*tortsave));
2332 DEFUN("plist-get", Fplist_get, 2, 3, 0, /*
2333 Extract a value from a property list.
2334 PLIST is a property list, which is a list of the form
2335 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2...).
2336 PROPERTY is usually a symbol.
2337 This function returns the value corresponding to the PROPERTY,
2338 or DEFAULT if PROPERTY is not one of the properties on the list.
2340 (plist, property, default_))
2342 Lisp_Object value = external_plist_get(&plist, property, 0, ERROR_ME);
2343 return UNBOUNDP(value) ? default_ : value;
2346 DEFUN("plist-put", Fplist_put, 3, 3, 0, /*
2347 Change value in PLIST of PROPERTY to VALUE.
2348 PLIST is a property list, which is a list of the form
2349 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2 ...).
2350 PROPERTY is usually a symbol and VALUE is any object.
2351 If PROPERTY is already a property on the list, its value is set to VALUE,
2352 otherwise the new PROPERTY VALUE pair is added.
2353 The new plist is returned; use `(setq x (plist-put x property value))'
2354 to be sure to use the new value. PLIST is modified by side effect.
2356 (plist, property, value))
2358 external_plist_put(&plist, property, value, 0, ERROR_ME);
2362 DEFUN("plist-remprop", Fplist_remprop, 2, 2, 0, /*
2363 Remove from PLIST the property PROPERTY and its value.
2364 PLIST is a property list, which is a list of the form
2365 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2 ...).
2366 PROPERTY is usually a symbol.
2367 The new plist is returned; use `(setq x (plist-remprop x property))'
2368 to be sure to use the new value. PLIST is modified by side effect.
2372 external_remprop(&plist, property, 0, ERROR_ME);
2376 DEFUN("plist-member", Fplist_member, 2, 2, 0, /*
2377 Return t if PROPERTY has a value specified in PLIST.
2381 Lisp_Object value = Fplist_get(plist, property, Qunbound);
2382 return UNBOUNDP(value) ? Qnil : Qt;
2385 DEFUN("check-valid-plist", Fcheck_valid_plist, 1, 1, 0, /*
2386 Given a plist, signal an error if there is anything wrong with it.
2387 This means that it's a malformed or circular plist.
2391 Lisp_Object *tortoise;
2397 while (!NILP(*tortoise)) {
2401 if (!advance_plist_pointers(&plist, &tortoise, &hare, ERROR_ME,
2409 DEFUN("valid-plist-p", Fvalid_plist_p, 1, 1, 0, /*
2410 Given a plist, return non-nil if its format is correct.
2411 If it returns nil, `check-valid-plist' will signal an error when given
2412 the plist; that means it's a malformed or circular plist.
2416 Lisp_Object *tortoise;
2421 while (!NILP(*tortoise)) {
2425 if (!advance_plist_pointers
2426 (&plist, &tortoise, &hare, ERROR_ME_NOT, &retval))
2433 DEFUN("canonicalize-plist", Fcanonicalize_plist, 1, 2, 0, /*
2434 Destructively remove any duplicate entries from a plist.
2435 In such cases, the first entry applies.
2437 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
2438 a nil value is removed. This feature is a virus that has infected
2439 old Lisp implementations, but should not be used except for backward
2442 The new plist is returned. If NIL-MEANS-NOT-PRESENT is given, the
2443 return value may not be EQ to the passed-in value, so make sure to
2444 `setq' the value back into where it came from.
2446 (plist, nil_means_not_present))
2448 Lisp_Object head = plist;
2450 Fcheck_valid_plist(plist);
2452 while (!NILP(plist)) {
2453 Lisp_Object prop = Fcar(plist);
2454 Lisp_Object next = Fcdr(plist);
2456 CHECK_CONS(next); /* just make doubly sure we catch any errors */
2457 if (!NILP(nil_means_not_present) && NILP(Fcar(next))) {
2458 if (EQ(head, plist))
2463 /* external_remprop returns 1 if it removed any property.
2464 We have to loop till it didn't remove anything, in case
2465 the property occurs many times. */
2466 while (external_remprop(&XCDR(next), prop, 0, ERROR_ME))
2474 DEFUN("lax-plist-get", Flax_plist_get, 2, 3, 0, /*
2475 Extract a value from a lax property list.
2476 LAX-PLIST is a lax property list, which is a list of the form
2477 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2...), where comparisons between
2478 properties is done using `equal' instead of `eq'.
2479 PROPERTY is usually a symbol.
2480 This function returns the value corresponding to PROPERTY,
2481 or DEFAULT if PROPERTY is not one of the properties on the list.
2483 (lax_plist, property, default_))
2486 external_plist_get(&lax_plist, property, 1, ERROR_ME);
2487 return UNBOUNDP(value) ? default_ : value;
2490 DEFUN("lax-plist-put", Flax_plist_put, 3, 3, 0, /*
2491 Change value in LAX-PLIST of PROPERTY to VALUE.
2492 LAX-PLIST is a lax property list, which is a list of the form
2493 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2...), where comparisons between
2494 properties is done using `equal' instead of `eq'.
2495 PROPERTY is usually a symbol and VALUE is any object.
2496 If PROPERTY is already a property on the list, its value is set to
2497 VALUE, otherwise the new PROPERTY VALUE pair is added.
2498 The new plist is returned; use `(setq x (lax-plist-put x property value))'
2499 to be sure to use the new value. LAX-PLIST is modified by side effect.
2501 (lax_plist, property, value))
2503 external_plist_put(&lax_plist, property, value, 1, ERROR_ME);
2507 DEFUN("lax-plist-remprop", Flax_plist_remprop, 2, 2, 0, /*
2508 Remove from LAX-PLIST the property PROPERTY and its value.
2509 LAX-PLIST is a lax property list, which is a list of the form
2510 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2...), where comparisons between
2511 properties is done using `equal' instead of `eq'.
2512 PROPERTY is usually a symbol.
2513 The new plist is returned; use `(setq x (lax-plist-remprop x property))'
2514 to be sure to use the new value. LAX-PLIST is modified by side effect.
2516 (lax_plist, property))
2518 external_remprop(&lax_plist, property, 1, ERROR_ME);
2522 DEFUN("lax-plist-member", Flax_plist_member, 2, 2, 0, /*
2523 Return t if PROPERTY has a value specified in LAX-PLIST.
2524 LAX-PLIST is a lax property list, which is a list of the form
2525 \(PROPERTY1 VALUE1 PROPERTY2 VALUE2...), where comparisons between
2526 properties is done using `equal' instead of `eq'.
2528 (lax_plist, property))
2530 return UNBOUNDP(Flax_plist_get(lax_plist, property, Qunbound)) ? Qnil :
2534 DEFUN("canonicalize-lax-plist", Fcanonicalize_lax_plist, 1, 2, 0, /*
2535 Destructively remove any duplicate entries from a lax plist.
2536 In such cases, the first entry applies.
2538 If optional arg NIL-MEANS-NOT-PRESENT is non-nil, then a property with
2539 a nil value is removed. This feature is a virus that has infected
2540 old Lisp implementations, but should not be used except for backward
2543 The new plist is returned. If NIL-MEANS-NOT-PRESENT is given, the
2544 return value may not be EQ to the passed-in value, so make sure to
2545 `setq' the value back into where it came from.
2547 (lax_plist, nil_means_not_present))
2549 Lisp_Object head = lax_plist;
2551 Fcheck_valid_plist(lax_plist);
2553 while (!NILP(lax_plist)) {
2554 Lisp_Object prop = Fcar(lax_plist);
2555 Lisp_Object next = Fcdr(lax_plist);
2557 CHECK_CONS(next); /* just make doubly sure we catch any errors */
2558 if (!NILP(nil_means_not_present) && NILP(Fcar(next))) {
2559 if (EQ(head, lax_plist))
2561 lax_plist = Fcdr(next);
2564 /* external_remprop returns 1 if it removed any property.
2565 We have to loop till it didn't remove anything, in case
2566 the property occurs many times. */
2567 while (external_remprop(&XCDR(next), prop, 1, ERROR_ME))
2569 lax_plist = Fcdr(next);
2575 /* In C because the frame props stuff uses it */
2577 DEFUN("destructive-alist-to-plist", Fdestructive_alist_to_plist, 1, 1, 0, /*
2578 Convert association list ALIST into the equivalent property-list form.
2579 The plist is returned. This converts from
2581 \((a . 1) (b . 2) (c . 3))
2587 The original alist is destroyed in the process of constructing the plist.
2588 See also `alist-to-plist'.
2592 Lisp_Object head = alist;
2593 while (!NILP(alist)) {
2594 /* remember the alist element. */
2595 Lisp_Object el = Fcar(alist);
2597 Fsetcar(alist, Fcar(el));
2598 Fsetcar(el, Fcdr(el));
2599 Fsetcdr(el, Fcdr(alist));
2601 alist = Fcdr(Fcdr(alist));
2607 DEFUN("get", Fget, 2, 3, 0, /*
2608 Return the value of OBJECT's PROPERTY property.
2609 This is the last VALUE stored with `(put OBJECT PROPERTY VALUE)'.
2610 If there is no such property, return optional third arg DEFAULT
2611 \(which defaults to `nil'). OBJECT can be a symbol, string, extent,
2612 face, or glyph. See also `put', `remprop', and `object-plist'.
2614 (object, property, default_))
2616 /* Various places in emacs call Fget() and expect it not to quit,
2620 if (LRECORDP(object) && XRECORD_LHEADER_IMPLEMENTATION(object)->getprop)
2622 XRECORD_LHEADER_IMPLEMENTATION(object)->getprop(object,
2625 signal_simple_error("Object type has no properties", object);
2627 return UNBOUNDP(val) ? default_ : val;
2630 DEFUN("put", Fput, 3, 3, 0, /*
2631 Set OBJECT's PROPERTY to VALUE.
2632 It can be subsequently retrieved with `(get OBJECT PROPERTY)'.
2633 OBJECT can be a symbol, face, extent, or string.
2634 For a string, no properties currently have predefined meanings.
2635 For the predefined properties for extents, see `set-extent-property'.
2636 For the predefined properties for faces, see `set-face-property'.
2637 See also `get', `remprop', and `object-plist'.
2639 (object, property, value))
2641 CHECK_LISP_WRITEABLE(object);
2643 if (LRECORDP(object) && XRECORD_LHEADER_IMPLEMENTATION(object)->putprop) {
2644 if (!XRECORD_LHEADER_IMPLEMENTATION(object)->putprop
2645 (object, property, value))
2646 signal_simple_error("Can't set property on object",
2649 signal_simple_error("Object type has no settable properties",
2655 DEFUN("remprop", Fremprop, 2, 2, 0, /*
2656 Remove, from OBJECT's property list, PROPERTY and its corresponding value.
2657 OBJECT can be a symbol, string, extent, face, or glyph. Return non-nil
2658 if the property list was actually modified (i.e. if PROPERTY was present
2659 in the property list). See also `get', `put', and `object-plist'.
2665 CHECK_LISP_WRITEABLE(object);
2667 if (LRECORDP(object) && XRECORD_LHEADER_IMPLEMENTATION(object)->remprop) {
2669 XRECORD_LHEADER_IMPLEMENTATION(object)->remprop(object,
2672 signal_simple_error("Can't remove property from object",
2675 signal_simple_error("Object type has no removable properties",
2678 return ret ? Qt : Qnil;
2681 DEFUN("object-plist", Fobject_plist, 1, 1, 0, /*
2682 Return a property list of OBJECT's properties.
2683 For a symbol, this is equivalent to `symbol-plist'.
2684 OBJECT can be a symbol, string, extent, face, or glyph.
2685 Do not modify the returned property list directly;
2686 this may or may not have the desired effects. Use `put' instead.
2690 if (LRECORDP(object) && XRECORD_LHEADER_IMPLEMENTATION(object)->plist)
2691 return XRECORD_LHEADER_IMPLEMENTATION(object)->plist(object);
2693 signal_simple_error("Object type has no properties", object);
2698 int internal_equal(Lisp_Object obj1, Lisp_Object obj2, int depth)
2701 error("Stack overflow in equal");
2703 if (EQ_WITH_EBOLA_NOTICE(obj1, obj2))
2705 /* Note that (equal 20 20.0) should be nil */
2706 if (XTYPE(obj1) != XTYPE(obj2))
2708 if (LRECORDP(obj1)) {
2709 const struct lrecord_implementation
2710 *imp1 = XRECORD_LHEADER_IMPLEMENTATION(obj1),
2711 *imp2 = XRECORD_LHEADER_IMPLEMENTATION(obj2);
2713 return (imp1 == imp2) &&
2714 /* EQ-ness of the objects was noticed above */
2715 (imp1->equal && (imp1->equal) (obj1, obj2, depth));
2722 internal_equalp (Lisp_Object obj1, Lisp_Object obj2, int depth)
2725 error ("Stack overflow in equalp");
2727 if (EQ_WITH_EBOLA_NOTICE (obj1, obj2))
2730 if (NUMBERP(obj1) && NUMBERP(obj2)) {
2731 return ent_binrel(ASE_BINARY_REL_EQUALP, obj1, obj2);
2734 if (CHARP(obj1) && CHARP(obj2))
2735 return XCHAR(obj1) == XCHAR(obj2);
2736 if (XTYPE(obj1) != XTYPE(obj2))
2738 if (LRECORDP(obj1)) {
2739 const struct lrecord_implementation
2740 *imp1 = XRECORD_LHEADER_IMPLEMENTATION (obj1),
2741 *imp2 = XRECORD_LHEADER_IMPLEMENTATION (obj2);
2743 /* #### not yet implemented properly, needs another flag to specify
2745 return (imp1 == imp2) &&
2746 /* EQ-ness of the objects was noticed above */
2747 (imp1->equal && (imp1->equal) (obj1, obj2, depth));
2754 /* Note that we may be calling sub-objects that will use
2755 internal_equal() (instead of internal_old_equal()). Oh well.
2756 We will get an Ebola note if there's any possibility of confusion,
2757 but that seems unlikely. */
2759 static int internal_old_equal(Lisp_Object obj1, Lisp_Object obj2, int depth)
2762 error("Stack overflow in equal");
2764 if (HACKEQ_UNSAFE(obj1, obj2))
2766 /* Note that (equal 20 20.0) should be nil */
2767 if (XTYPE(obj1) != XTYPE(obj2))
2770 return internal_equal(obj1, obj2, depth);
2773 DEFUN("equal", Fequal, 2, 2, 0, /*
2774 Return t if two Lisp objects have similar structure and contents.
2775 They must have the same data type.
2776 Conses are compared by comparing the cars and the cdrs.
2777 Vectors and strings are compared element by element.
2778 Numbers are compared by value. Symbols must match exactly.
2782 return internal_equal(object1, object2, 0) ? Qt : Qnil;
2785 DEFUN("old-equal", Fold_equal, 2, 2, 0, /*
2786 Return t if two Lisp objects have similar structure and contents.
2787 They must have the same data type.
2788 \(Note, however, that an exception is made for characters and integers;
2789 this is known as the "char-int confoundance disease." See `eq' and
2791 This function is provided only for byte-code compatibility with v19.
2796 return internal_old_equal(object1, object2, 0) ? Qt : Qnil;
2799 DEFUN("fillarray", Ffillarray, 2, 2, 0, /*
2800 Destructively modify ARRAY by replacing each element with ITEM.
2801 ARRAY is a vector, bit vector, or string.
2806 if (STRINGP(array)) {
2807 Lisp_String *s = XSTRING(array);
2808 Bytecount old_bytecount = string_length(s);
2809 Bytecount new_bytecount;
2810 Bytecount item_bytecount;
2811 Bufbyte item_buf[MAX_EMCHAR_LEN];
2815 CHECK_CHAR_COERCE_INT(item);
2816 CHECK_LISP_WRITEABLE(array);
2818 item_bytecount = set_charptr_emchar(item_buf, XCHAR(item));
2819 new_bytecount = item_bytecount * string_char_length(s);
2821 resize_string(s, -1, new_bytecount - old_bytecount);
2823 for (p = string_data(s), end = p + new_bytecount;
2824 p < end; p += item_bytecount)
2825 memcpy(p, item_buf, item_bytecount);
2828 bump_string_modiff(array);
2829 } else if (VECTORP(array)) {
2830 Lisp_Object *p = XVECTOR_DATA(array);
2831 size_t len = XVECTOR_LENGTH(array);
2832 CHECK_LISP_WRITEABLE(array);
2835 } else if (BIT_VECTORP(array)) {
2836 Lisp_Bit_Vector *v = XBIT_VECTOR(array);
2837 size_t len = bit_vector_length(v);
2841 CHECK_LISP_WRITEABLE(array);
2843 set_bit_vector_bit(v, len, bit);
2845 array = wrong_type_argument(Qarrayp, array);
2851 Lisp_Object nconc2(Lisp_Object arg1, Lisp_Object arg2)
2853 Lisp_Object args[2] = {arg1, arg2};
2854 struct gcpro gcpro1;
2856 GCPROn(args, countof(args));
2857 RETURN_UNGCPRO(bytecode_nconc2(args));
2860 Lisp_Object bytecode_nconc2(Lisp_Object * args)
2864 if (CONSP(args[0])) {
2865 /* (setcdr (last args[0]) args[1]) */
2866 Lisp_Object tortoise, hare;
2869 for (hare = tortoise = args[0], count = 0;
2870 CONSP(XCDR(hare)); hare = XCDR(hare), count++) {
2871 if (count < CIRCULAR_LIST_SUSPICION_LENGTH)
2875 tortoise = XCDR(tortoise);
2876 if (EQ(hare, tortoise))
2877 signal_circular_list_error(args[0]);
2879 XCDR(hare) = args[1];
2881 } else if (NILP(args[0])) {
2884 args[0] = wrong_type_argument(args[0], Qlistp);
2889 DEFUN("nconc", Fnconc, 0, MANY, 0, /*
2890 Concatenate any number of lists by altering them.
2891 Only the last argument is not altered, and need not be a list.
2893 If the first argument is nil, there is no way to modify it by side
2894 effect; therefore, write `(setq foo (nconc foo list))' to be sure of
2895 changing the value of `foo'.
2897 (int nargs, Lisp_Object * args))
2900 struct gcpro gcpro1;
2902 /* The modus operandi in Emacs is "caller gc-protects args".
2903 However, nconc (particularly nconc2 ()) is called many times
2904 in Emacs on freshly created stuff (e.g. you see the idiom
2905 nconc2 (Fcopy_sequence (foo), bar) a lot). So we help those
2906 callers out by protecting the args ourselves to save them
2907 a lot of temporary-variable grief. */
2909 GCPROn(args, nargs);
2911 while (argnum < nargs) {
2916 /* `val' is the first cons, which will be our return
2918 * `last_cons' will be the cons cell to mutate. */
2919 Lisp_Object last_cons = val;
2920 Lisp_Object tortoise = val;
2922 for (argnum++; argnum < nargs; argnum++) {
2923 Lisp_Object next = args[argnum];
2925 if (CONSP(next) || argnum == nargs - 1) {
2926 /* (setcdr (last val) next) */
2930 CONSP(XCDR(last_cons));
2932 XCDR(last_cons), count++) {
2934 CIRCULAR_LIST_SUSPICION_LENGTH)
2940 if (EQ(last_cons, tortoise))
2941 signal_circular_list_error
2944 XCDR(last_cons) = next;
2945 } else if (NILP(next)) {
2949 wrong_type_argument(Qlistp, next);
2953 RETURN_UNGCPRO(val);
2954 } else if (NILP(val))
2956 else if (argnum == nargs - 1) /* last arg? */
2957 RETURN_UNGCPRO(val);
2959 args[argnum] = wrong_type_argument(Qlistp, val);
2963 RETURN_UNGCPRO(Qnil); /* No non-nil args provided. */
2967 DEFUN("replace-list", Freplace_list, 2, 2, 0, /*
2968 Destructively replace the list OLD with NEW.
2969 This is like (copy-sequence NEW) except that it reuses the
2970 conses in OLD as much as possible. If OLD and NEW are the same
2971 length, no consing will take place.
2975 Lisp_Object tail, oldtail = old, prevoldtail = Qnil;
2977 EXTERNAL_LIST_LOOP(tail, new) {
2978 if (!NILP(oldtail)) {
2979 CHECK_CONS(oldtail);
2980 XCAR(oldtail) = XCAR(tail);
2981 } else if (!NILP(prevoldtail)) {
2982 XCDR(prevoldtail) = Fcons(XCAR(tail), Qnil);
2983 prevoldtail = XCDR(prevoldtail);
2985 old = oldtail = Fcons(XCAR(tail), Qnil);
2987 if (!NILP(oldtail)) {
2988 prevoldtail = oldtail;
2989 oldtail = XCDR(oldtail);
2993 if (!NILP(prevoldtail))
2994 XCDR(prevoldtail) = Qnil;
3001 /* #### this function doesn't belong in this file! */
3003 #ifdef HAVE_GETLOADAVG
3004 #ifdef HAVE_SYS_LOADAVG_H
3005 #include <sys/loadavg.h>
3008 int getloadavg(double loadavg[], int nelem); /* Defined in getloadavg.c */
3011 DEFUN("load-average", Fload_average, 0, 1, 0, /*
3012 Return list of 1 minute, 5 minute and 15 minute load averages.
3013 Each of the three load averages is multiplied by 100,
3014 then converted to integer.
3016 When USE-FLOATS is non-nil, floats will be used instead of integers.
3017 These floats are not multiplied by 100.
3019 If the 5-minute or 15-minute load averages are not available, return a
3020 shortened list, containing only those averages which are available.
3022 On some systems, this won't work due to permissions on /dev/kmem,
3023 in which case you can't use this.
3028 int loads = getloadavg(load_ave, countof(load_ave));
3029 Lisp_Object ret = Qnil;
3032 error("load-average not implemented for this operating system");
3034 signal_simple_error("Could not get load-average",
3035 lisp_strerror(errno));
3037 while (loads-- > 0) {
3038 Lisp_Object load = (NILP(use_floats) ?
3039 make_int((int)(100.0 * load_ave[loads]))
3040 : make_float(load_ave[loads]));
3041 ret = Fcons(load, ret);
3046 Lisp_Object Vfeatures;
3048 DEFUN("featurep", Ffeaturep, 1, 1, 0, /*
3049 Return non-nil if feature FEXP is present in this Emacs.
3050 Use this to conditionalize execution of lisp code based on the
3051 presence or absence of emacs or environment extensions.
3052 FEXP can be a symbol, a number, or a list.
3053 If it is a symbol, that symbol is looked up in the `features' variable,
3054 and non-nil will be returned if found.
3055 If it is a number, the function will return non-nil if this Emacs
3056 has an equal or greater version number than FEXP.
3057 If it is a list whose car is the symbol `and', it will return
3058 non-nil if all the features in its cdr are non-nil.
3059 If it is a list whose car is the symbol `or', it will return non-nil
3060 if any of the features in its cdr are non-nil.
3061 If it is a list whose car is the symbol `not', it will return
3062 non-nil if the feature is not present.
3067 => ; Non-nil on SXEmacs.
3069 (featurep '(and sxemacs gnus))
3070 => ; Non-nil on SXEmacs with Gnus loaded.
3072 (featurep '(or tty-frames (and emacs 19.30)))
3073 => ; Non-nil if this Emacs supports TTY frames.
3075 (featurep '(or (and xemacs 19.15) (and emacs 19.34)))
3076 => ; Non-nil on XEmacs 19.15 and later, or FSF Emacs 19.34 and later.
3078 (featurep '(and xemacs 21.02))
3079 => ; Non-nil on XEmacs 21.2 and later.
3081 NOTE: The advanced arguments of this function (anything other than a
3082 symbol) are not yet supported by FSF Emacs. If you feel they are useful
3083 for supporting multiple Emacs variants, lobby Richard Stallman at
3084 <bug-gnu-emacs@gnu.org>.
3088 #ifndef FEATUREP_SYNTAX
3090 return NILP(Fmemq(fexp, Vfeatures)) ? Qnil : Qt;
3091 #else /* FEATUREP_SYNTAX */
3092 static double featurep_emacs_version;
3094 /* Brute force translation from Erik Naggum's lisp function. */
3095 if (SYMBOLP(fexp)) {
3096 /* Original definition */
3097 return NILP(Fmemq(fexp, Vfeatures)) ? Qnil : Qt;
3098 } else if (INTP(fexp) || FLOATP(fexp)) {
3099 double d = extract_float(fexp);
3101 if (featurep_emacs_version == 0.0) {
3102 featurep_emacs_version = XINT(Vemacs_major_version) +
3103 (XINT(Vemacs_minor_version) / 100.0);
3105 return featurep_emacs_version >= d ? Qt : Qnil;
3106 } else if (CONSP(fexp)) {
3107 Lisp_Object tem = XCAR(fexp);
3108 if (EQ(tem, Qnot)) {
3114 return NILP(call1(Qfeaturep, negate)) ? Qt :
3117 return Fsignal(Qinvalid_read_syntax,
3119 } else if (EQ(tem, Qand)) {
3121 /* Use Fcar/Fcdr for error-checking. */
3122 while (!NILP(tem) && !NILP(call1(Qfeaturep, Fcar(tem)))) {
3125 return NILP(tem) ? Qt : Qnil;
3126 } else if (EQ(tem, Qor)) {
3128 /* Use Fcar/Fcdr for error-checking. */
3129 while (!NILP(tem) && NILP(call1(Qfeaturep, Fcar(tem)))) {
3132 return NILP(tem) ? Qnil : Qt;
3134 return Fsignal(Qinvalid_read_syntax, list1(XCDR(fexp)));
3137 return Fsignal(Qinvalid_read_syntax, list1(fexp));
3140 #endif /* FEATUREP_SYNTAX */
3142 DEFUN("provide", Fprovide, 1, 1, 0, /*
3143 Announce that FEATURE is a feature of the current Emacs.
3144 This function updates the value of the variable `features'.
3149 CHECK_SYMBOL(feature);
3150 if (!NILP(Vautoload_queue))
3152 Fcons(Fcons(Vfeatures, Qnil), Vautoload_queue);
3153 tem = Fmemq(feature, Vfeatures);
3155 Vfeatures = Fcons(feature, Vfeatures);
3156 LOADHIST_ATTACH(Fcons(Qprovide, feature));
3160 DEFUN("require", Frequire, 1, 2, 0, /*
3161 If feature FEATURE is not loaded, load it from FILENAME.
3162 If FEATURE is not a member of the list `features', then the feature
3163 is not loaded; so load the file FILENAME.
3164 If FILENAME is omitted, the printname of FEATURE is used as the file name.
3166 (feature, filename))
3170 CHECK_SYMBOL(feature);
3171 tem = Fmemq(feature, Vfeatures);
3172 LOADHIST_ATTACH(Fcons(Qrequire, feature));
3177 int speccount = specpdl_depth();
3179 /* Value saved here is to be restored into Vautoload_queue */
3180 record_unwind_protect(un_autoload, Vautoload_queue);
3181 Vautoload_queue = Qt;
3183 /* defined in code-files.el */
3184 call4(Qload, NILP(filename) ? Fsymbol_name(feature) : filename,
3187 tem = Fmemq(feature, Vfeatures);
3189 error("Required feature %s was not provided",
3190 string_data(XSYMBOL(feature)->name));
3192 /* Once loading finishes, don't undo it. */
3193 Vautoload_queue = Qt;
3194 return unbind_to(speccount, feature);
3198 DEFUN("revoke", Frevoke, 1, 1, 0, /*
3199 Announce that FEATURE is no longer a feature of the current Emacs.
3203 CHECK_SYMBOL(feature);
3204 if (!NILP(Vautoload_queue))
3206 Fcons(Fcons(Vfeatures, Qnil), Vautoload_queue);
3208 if (LIKELY(CONSP(Vfeatures) && EQ(XCAR(Vfeatures), feature))) {
3209 /* special case where feature is the head of 'features */
3210 Vfeatures = XCDR(Vfeatures);
3213 for (Lisp_Object tmp = Vfeatures;
3214 CONSP(tmp) && CONSP(XCDR(tmp));
3216 if (EQ(XCAR(XCDR(tmp)), feature)) {
3217 XCDR(tmp) = XCDR(XCDR(tmp));
3224 /* base64 encode/decode functions.
3226 Originally based on code from GNU recode. Ported to FSF Emacs by
3227 Lars Magne Ingebrigtsen and Karl Heuer. Ported to XEmacs and
3228 subsequently heavily hacked by Hrvoje Niksic. */
3230 #define MIME_LINE_LENGTH 72
3232 #define IS_ASCII(Character) \
3234 #define IS_BASE64(Character) \
3235 (IS_ASCII (Character) && base64_char_to_value[Character] >= 0)
3237 /* Table of characters coding the 64 values. */
3238 static char base64_value_to_char[64] = {
3239 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', /* 0- 9 */
3240 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', /* 10-19 */
3241 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', /* 20-29 */
3242 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', /* 30-39 */
3243 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', /* 40-49 */
3244 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', /* 50-59 */
3245 '8', '9', '+', '/' /* 60-63 */
3248 /* Table of base64 values for first 128 characters. */
3249 static short base64_char_to_value[128] = {
3250 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 0- 9 */
3251 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 10- 19 */
3252 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 20- 29 */
3253 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* 30- 39 */
3254 -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, /* 40- 49 */
3255 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, /* 50- 59 */
3256 -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, /* 60- 69 */
3257 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, /* 70- 79 */
3258 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, /* 80- 89 */
3259 25, -1, -1, -1, -1, -1, -1, 26, 27, 28, /* 90- 99 */
3260 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, /* 100-109 */
3261 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, /* 110-119 */
3262 49, 50, 51, -1, -1, -1, -1, -1 /* 120-127 */
3265 /* The following diagram shows the logical steps by which three octets
3266 get transformed into four base64 characters.
3268 .--------. .--------. .--------.
3269 |aaaaaabb| |bbbbcccc| |ccdddddd|
3270 `--------' `--------' `--------'
3272 .--------+--------+--------+--------.
3273 |00aaaaaa|00bbbbbb|00cccccc|00dddddd|
3274 `--------+--------+--------+--------'
3276 .--------+--------+--------+--------.
3277 |AAAAAAAA|BBBBBBBB|CCCCCCCC|DDDDDDDD|
3278 `--------+--------+--------+--------'
3280 The octets are divided into 6 bit chunks, which are then encoded into
3281 base64 characters. */
3283 #define ADVANCE_INPUT(c, stream) \
3284 ((ec = Lstream_get_emchar (stream)) == -1 ? 0 : \
3286 (signal_simple_error ("Non-ascii character in base64 input", \
3287 make_char (ec)), 0) \
3288 : (c = (Bufbyte)ec), 1))
3290 static Bytind base64_encode_1(Lstream * istream, Bufbyte * to, int line_break)
3292 EMACS_INT counter = 0;
3299 if (!ADVANCE_INPUT(c, istream))
3302 /* Wrap line every 76 characters. */
3304 if (counter < MIME_LINE_LENGTH / 4)
3312 /* Process first byte of a triplet. */
3313 *e++ = base64_value_to_char[0x3f & c >> 2];
3314 value = (0x03 & c) << 4;
3316 /* Process second byte of a triplet. */
3317 if (!ADVANCE_INPUT(c, istream)) {
3318 *e++ = base64_value_to_char[value];
3324 *e++ = base64_value_to_char[value | (0x0f & c >> 4)];
3325 value = (0x0f & c) << 2;
3327 /* Process third byte of a triplet. */
3328 if (!ADVANCE_INPUT(c, istream)) {
3329 *e++ = base64_value_to_char[value];
3334 *e++ = base64_value_to_char[value | (0x03 & c >> 6)];
3335 *e++ = base64_value_to_char[0x3f & c];
3341 #undef ADVANCE_INPUT
3343 /* Get next character from the stream, except that non-base64
3344 characters are ignored. This is in accordance with rfc2045. EC
3345 should be an Emchar, so that it can hold -1 as the value for EOF. */
3346 #define ADVANCE_INPUT_IGNORE_NONBASE64(ec, stream, streampos) do { \
3347 ec = Lstream_get_emchar (stream); \
3349 /* IS_BASE64 may not be called with negative arguments so check for \
3351 if (ec < 0 || IS_BASE64 (ec) || ec == '=') \
3355 #define STORE_BYTE(pos, val, ccnt) do { \
3356 pos += set_charptr_emchar (pos, (Emchar)((unsigned char)(val))); \
3361 base64_decode_1(Lstream * istream, Bufbyte * to, Charcount * ccptr)
3365 EMACS_INT streampos = 0;
3369 unsigned long value;
3371 /* Process first byte of a quadruplet. */
3372 ADVANCE_INPUT_IGNORE_NONBASE64(ec, istream, streampos);
3377 ("Illegal `=' character while decoding base64",
3378 make_int(streampos));
3379 value = base64_char_to_value[ec] << 18;
3381 /* Process second byte of a quadruplet. */
3382 ADVANCE_INPUT_IGNORE_NONBASE64(ec, istream, streampos);
3384 error("Premature EOF while decoding base64");
3387 ("Illegal `=' character while decoding base64",
3388 make_int(streampos));
3389 value |= base64_char_to_value[ec] << 12;
3390 STORE_BYTE(e, value >> 16, ccnt);
3392 /* Process third byte of a quadruplet. */
3393 ADVANCE_INPUT_IGNORE_NONBASE64(ec, istream, streampos);
3395 error("Premature EOF while decoding base64");
3398 ADVANCE_INPUT_IGNORE_NONBASE64(ec, istream, streampos);
3400 error("Premature EOF while decoding base64");
3403 ("Padding `=' expected but not found while decoding base64",
3404 make_int(streampos));
3408 value |= base64_char_to_value[ec] << 6;
3409 STORE_BYTE(e, 0xff & value >> 8, ccnt);
3411 /* Process fourth byte of a quadruplet. */
3412 ADVANCE_INPUT_IGNORE_NONBASE64(ec, istream, streampos);
3414 error("Premature EOF while decoding base64");
3418 value |= base64_char_to_value[ec];
3419 STORE_BYTE(e, 0xff & value, ccnt);
3426 #undef ADVANCE_INPUT
3427 #undef ADVANCE_INPUT_IGNORE_NONBASE64
3430 DEFUN("base64-encode-region", Fbase64_encode_region, 2, 3, "r", /*
3431 Base64-encode the region between START and END.
3432 Return the length of the encoded text.
3433 Optional third argument NO-LINE-BREAK means do not break long lines
3436 (start, end, no_line_break))
3439 Bytind encoded_length;
3440 Charcount allength, length;
3441 struct buffer *buf = current_buffer;
3442 Bufpos begv, zv, old_pt = BUF_PT(buf);
3444 int speccount = specpdl_depth();
3446 get_buffer_range_char(buf, start, end, &begv, &zv, 0);
3447 barf_if_buffer_read_only(buf, begv, zv);
3449 /* We need to allocate enough room for encoding the text.
3450 We need 33 1/3% more space, plus a newline every 76
3451 characters, and then we round up. */
3453 allength = length + length / 3 + 1;
3454 allength += allength / MIME_LINE_LENGTH + 1 + 6;
3456 input = make_lisp_buffer_input_stream(buf, begv, zv, 0);
3457 /* We needn't multiply allength with MAX_EMCHAR_LEN because all the
3458 base64 characters will be single-byte. */
3459 XMALLOC_ATOMIC_OR_ALLOCA(encoded, allength, Bufbyte);
3460 encoded_length = base64_encode_1(XLSTREAM(input), encoded,
3461 NILP(no_line_break));
3462 if (encoded_length > allength) {
3465 Lstream_delete(XLSTREAM(input));
3467 /* Now we have encoded the region, so we insert the new contents
3468 and delete the old. (Insert first in order to preserve markers.) */
3469 buffer_insert_raw_string_1(buf, begv, encoded, encoded_length, 0);
3470 XMALLOC_UNBIND(encoded, allength, speccount);
3471 buffer_delete_range(buf, begv + encoded_length, zv + encoded_length, 0);
3473 /* Simulate FSF Emacs implementation of this function: if point was
3474 in the region, place it at the beginning. */
3475 if (old_pt >= begv && old_pt < zv) {
3476 BUF_SET_PT(buf, begv);
3479 /* We return the length of the encoded text. */
3480 return make_int(encoded_length);
3483 DEFUN("base64-encode-string", Fbase64_encode_string, 1, 2, 0, /*
3484 Base64 encode STRING and return the result.
3485 Optional argument NO-LINE-BREAK means do not break long lines
3488 (string, no_line_break))
3490 Charcount allength, length;
3491 Bytind encoded_length;
3493 Lisp_Object input, result;
3494 int speccount = specpdl_depth();
3496 CHECK_STRING(string);
3498 length = XSTRING_CHAR_LENGTH(string);
3499 allength = length + length / 3 + 1;
3500 allength += allength / MIME_LINE_LENGTH + 1 + 6;
3502 input = make_lisp_string_input_stream(string, 0, -1);
3503 XMALLOC_ATOMIC_OR_ALLOCA(encoded, allength, Bufbyte);
3504 encoded_length = base64_encode_1(XLSTREAM(input), encoded,
3505 NILP(no_line_break));
3506 if (encoded_length > allength) {
3509 Lstream_delete(XLSTREAM(input));
3510 result = make_string(encoded, encoded_length);
3511 XMALLOC_UNBIND(encoded, allength, speccount);
3515 DEFUN("base64-decode-region", Fbase64_decode_region, 2, 2, "r", /*
3516 Base64-decode the region between START and END.
3517 Return the length of the decoded text.
3518 If the region can't be decoded, return nil and don't modify the buffer.
3519 Characters out of the base64 alphabet are ignored.
3523 struct buffer *buf = current_buffer;
3524 Bufpos begv, zv, old_pt = BUF_PT(buf);
3526 Bytind decoded_length;
3527 Charcount length, cc_decoded_length;
3529 int speccount = specpdl_depth();
3531 get_buffer_range_char(buf, start, end, &begv, &zv, 0);
3532 barf_if_buffer_read_only(buf, begv, zv);
3536 input = make_lisp_buffer_input_stream(buf, begv, zv, 0);
3537 /* We need to allocate enough room for decoding the text. */
3538 XMALLOC_ATOMIC_OR_ALLOCA(decoded, length * MAX_EMCHAR_LEN, Bufbyte);
3540 base64_decode_1(XLSTREAM(input), decoded, &cc_decoded_length);
3541 if (decoded_length > length * MAX_EMCHAR_LEN) {
3544 Lstream_delete(XLSTREAM(input));
3546 /* Now we have decoded the region, so we insert the new contents
3547 and delete the old. (Insert first in order to preserve markers.) */
3548 BUF_SET_PT(buf, begv);
3549 buffer_insert_raw_string_1(buf, begv, decoded, decoded_length, 0);
3550 XMALLOC_UNBIND(decoded, length * MAX_EMCHAR_LEN, speccount);
3551 buffer_delete_range(buf, begv + cc_decoded_length,
3552 zv + cc_decoded_length, 0);
3554 /* Simulate FSF Emacs implementation of this function: if point was
3555 in the region, place it at the beginning. */
3556 if (old_pt >= begv && old_pt < zv) {
3557 BUF_SET_PT(buf, begv);
3560 return make_int(cc_decoded_length);
3563 DEFUN("base64-decode-string", Fbase64_decode_string, 1, 1, 0, /*
3564 Base64-decode STRING and return the result.
3565 Characters out of the base64 alphabet are ignored.
3570 Bytind decoded_length;
3571 Charcount length, cc_decoded_length;
3572 Lisp_Object input, result;
3573 int speccount = specpdl_depth();
3575 CHECK_STRING(string);
3577 length = XSTRING_CHAR_LENGTH(string);
3578 /* We need to allocate enough room for decoding the text. */
3579 XMALLOC_ATOMIC_OR_ALLOCA(decoded, length * MAX_EMCHAR_LEN, Bufbyte);
3581 input = make_lisp_string_input_stream(string, 0, -1);
3582 decoded_length = base64_decode_1(XLSTREAM(input), decoded,
3583 &cc_decoded_length);
3584 if (decoded_length > length * MAX_EMCHAR_LEN) {
3587 Lstream_delete(XLSTREAM(input));
3589 result = make_string(decoded, decoded_length);
3590 XMALLOC_UNBIND(decoded, length * MAX_EMCHAR_LEN, speccount);
3594 /* base16 encode/decode functions. */
3596 base16_encode_1(Lstream * istream, int length, Bufbyte * to)
3601 for (i=0; i < length; i++) {
3602 ec = Lstream_get_emchar (istream);
3603 sprintf((char *)to+2*i,"%02x", ec);
3609 base16_decode_1(Lstream * istream, int length, Bufbyte * to)
3612 Emchar high = 0, low = 0;
3613 int high_set_p = 0, ignore_p = 0;
3616 /* high and low perform flip flop operation */
3618 ec = Lstream_get_emchar (istream);
3623 else if (isupper(ec))
3624 low = ec - 'A' + 10;
3625 else if (islower(ec))
3626 low = ec - 'a' + 10;
3630 if (low < 0 || low >= 16)
3638 to[i] = high*16+low;
3648 DEFUN("base16-encode-string", Fbase16_encode_string, 1, 1, 0, /*
3649 Base16 encode (i.e. hex dump) STRING and return the result.
3650 Optional argument NO-LINE-BREAK means do not break long lines
3657 Lisp_Object input, result;
3658 int speccount = specpdl_depth();
3660 CHECK_STRING(string);
3662 length = XSTRING_CHAR_LENGTH(string);
3664 input = make_lisp_string_input_stream(string, 0, -1);
3665 XMALLOC_ATOMIC_OR_ALLOCA(encoded, 2*length, Bufbyte);
3666 base16_encode_1(XLSTREAM(input), length, encoded);
3667 Lstream_delete(XLSTREAM(input));
3668 result = make_string(encoded, 2*length);
3669 XMALLOC_UNBIND(encoded, 2*length, speccount);
3671 XSTRING(result)->plist = XSTRING(string)->plist;
3676 DEFUN("base16-decode-string", Fbase16_decode_string, 1, 1, 0, /*
3677 Base16-decode (i.e. read hex data from) STRING and return the result.
3678 Characters out of the base16 alphabet are ignored.
3683 Bytind decoded_length;
3685 Lisp_Object input, result;
3686 int speccount = specpdl_depth();
3688 CHECK_STRING(string);
3690 length = XSTRING_CHAR_LENGTH(string);
3691 /* We need to allocate enough room for decoding the text. */
3692 XMALLOC_ATOMIC_OR_ALLOCA(decoded, length, Bufbyte);
3694 input = make_lisp_string_input_stream(string, 0, -1);
3695 decoded_length = base16_decode_1(XLSTREAM(input), length, decoded);
3696 Lstream_delete(XLSTREAM(input));
3698 /* this result might be raw, we declare it binary */
3699 result = make_ext_string((char *)decoded, decoded_length, Qbinary);
3700 XMALLOC_UNBIND(decoded, length, speccount);
3702 XSTRING(result)->plist = XSTRING(string)->plist;
3707 Lisp_Object Qyes_or_no_p;
3709 DEFUN("foobar", Ffoobar, 2, 2, 0, /*
3713 return make_int(__nbits_right_of(XINT(n), XINT(b)));
3716 void syms_of_fns(void)
3718 INIT_LRECORD_IMPLEMENTATION(bit_vector);
3720 defsymbol(&Qstring_lessp, "string-lessp");
3721 defsymbol(&Qstring_greaterp, "string-greaterp");
3722 defsymbol(&Qidentity, "identity");
3723 defsymbol(&Qyes_or_no_p, "yes-or-no-p");
3729 #if defined(WITH_GMP) && defined(HAVE_MPZ)
3733 DEFSUBR(Fsafe_length);
3734 DEFSUBR(Fstring_equal);
3735 DEFSUBR(Fstring_lessp);
3736 DEFSUBR(Fstring_greaterp);
3737 DEFSUBR(Fstring_modified_tick);
3742 DEFSUBR(Fcopy_list);
3743 DEFSUBR(Fcopy_sequence);
3744 DEFSUBR(Fcopy_alist);
3745 DEFSUBR(Fcopy_tree);
3746 DEFSUBR(Fsubstring);
3755 DEFSUBR(Fold_member);
3759 DEFSUBR(Fold_assoc);
3763 DEFSUBR(Fold_rassoc);
3765 DEFSUBR(Fold_rassq);
3767 DEFSUBR(Fold_delete);
3772 DEFSUBR(Fremrassoc);
3777 DEFSUBR(Fplists_eq);
3778 DEFSUBR(Fplists_equal);
3779 DEFSUBR(Flax_plists_eq);
3780 DEFSUBR(Flax_plists_equal);
3781 DEFSUBR(Fplist_get);
3782 DEFSUBR(Fplist_put);
3783 DEFSUBR(Fplist_remprop);
3784 DEFSUBR(Fplist_member);
3785 DEFSUBR(Fcheck_valid_plist);
3786 DEFSUBR(Fvalid_plist_p);
3787 DEFSUBR(Fcanonicalize_plist);
3788 DEFSUBR(Flax_plist_get);
3789 DEFSUBR(Flax_plist_put);
3790 DEFSUBR(Flax_plist_remprop);
3791 DEFSUBR(Flax_plist_member);
3792 DEFSUBR(Fcanonicalize_lax_plist);
3793 DEFSUBR(Fdestructive_alist_to_plist);
3797 DEFSUBR(Fobject_plist);
3799 DEFSUBR(Fold_equal);
3800 DEFSUBR(Ffillarray);
3802 DEFSUBR(Freplace_list);
3803 DEFSUBR(Fload_average);
3808 DEFSUBR(Fbase64_encode_region);
3809 DEFSUBR(Fbase64_encode_string);
3810 DEFSUBR(Fbase64_decode_region);
3811 DEFSUBR(Fbase64_decode_string);
3812 DEFSUBR(Fbase16_encode_string);
3813 DEFSUBR(Fbase16_decode_string);
3820 void init_provide_once(void)
3822 DEFVAR_LISP("features", &Vfeatures /*
3823 A list of symbols which are the features of the executing emacs.
3824 Used by `featurep' and `require', and altered by `provide'.
3828 Fprovide(intern("base64"));
3829 Fprovide(intern("base16"));
3831 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
3832 /* it's fuck ugly to define that here :( */
3833 Fprovide(intern("bdwgc"));