copy-file now uses GNU/Linux file cloning
[emacs.git] / src / editfns.c
blob20cb3a80c7b15cbe0de34edea86827fe9f7cc63c
1 /* Lisp functions pertaining to editing. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1989, 1993-2016 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or (at
10 your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <sys/types.h>
23 #include <stdio.h>
25 #ifdef HAVE_PWD_H
26 #include <pwd.h>
27 #include <grp.h>
28 #endif
30 #include <unistd.h>
32 #ifdef HAVE_SYS_UTSNAME_H
33 #include <sys/utsname.h>
34 #endif
36 #include "lisp.h"
38 /* systime.h includes <sys/time.h> which, on some systems, is required
39 for <sys/resource.h>; thus systime.h must be included before
40 <sys/resource.h> */
41 #include "systime.h"
43 #if defined HAVE_SYS_RESOURCE_H
44 #include <sys/resource.h>
45 #endif
47 #include <errno.h>
48 #include <float.h>
49 #include <limits.h>
51 #include <intprops.h>
52 #include <strftime.h>
53 #include <verify.h>
55 #include "composite.h"
56 #include "intervals.h"
57 #include "character.h"
58 #include "buffer.h"
59 #include "coding.h"
60 #include "window.h"
61 #include "blockinput.h"
63 #define TM_YEAR_BASE 1900
65 #ifdef WINDOWSNT
66 extern Lisp_Object w32_get_internal_run_time (void);
67 #endif
69 static struct lisp_time lisp_time_struct (Lisp_Object, int *);
70 static Lisp_Object format_time_string (char const *, ptrdiff_t, struct timespec,
71 Lisp_Object, struct tm *);
72 static long int tm_gmtoff (struct tm *);
73 static int tm_diff (struct tm *, struct tm *);
74 static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
75 static Lisp_Object styled_format (ptrdiff_t, Lisp_Object *, bool);
77 #ifndef HAVE_TM_GMTOFF
78 # define HAVE_TM_GMTOFF false
79 #endif
81 enum { tzeqlen = sizeof "TZ=" - 1 };
83 /* Time zones equivalent to current local time, to wall clock time,
84 and to UTC, respectively. */
85 static timezone_t local_tz;
86 static timezone_t wall_clock_tz;
87 static timezone_t const utc_tz = 0;
89 /* A valid but unlikely setting for the TZ environment variable.
90 It is OK (though a bit slower) if the user chooses this value. */
91 static char dump_tz_string[] = "TZ=UtC0";
93 /* The cached value of Vsystem_name. This is used only to compare it
94 to Vsystem_name, so it need not be visible to the GC. */
95 static Lisp_Object cached_system_name;
97 static void
98 init_and_cache_system_name (void)
100 init_system_name ();
101 cached_system_name = Vsystem_name;
104 static struct tm *
105 emacs_localtime_rz (timezone_t tz, time_t const *t, struct tm *tm)
107 tm = localtime_rz (tz, t, tm);
108 if (!tm && errno == ENOMEM)
109 memory_full (SIZE_MAX);
110 return tm;
113 static time_t
114 emacs_mktime_z (timezone_t tz, struct tm *tm)
116 errno = 0;
117 time_t t = mktime_z (tz, tm);
118 if (t == (time_t) -1 && errno == ENOMEM)
119 memory_full (SIZE_MAX);
120 return t;
123 /* Allocate a timezone, signaling on failure. */
124 static timezone_t
125 xtzalloc (char const *name)
127 timezone_t tz = tzalloc (name);
128 if (!tz)
129 memory_full (SIZE_MAX);
130 return tz;
133 /* Free a timezone, except do not free the time zone for local time.
134 Freeing utc_tz is also a no-op. */
135 static void
136 xtzfree (timezone_t tz)
138 if (tz != local_tz)
139 tzfree (tz);
142 /* Convert the Lisp time zone rule ZONE to a timezone_t object.
143 The returned value either is 0, or is LOCAL_TZ, or is newly allocated.
144 If SETTZ, set Emacs local time to the time zone rule; otherwise,
145 the caller should eventually pass the returned value to xtzfree. */
146 static timezone_t
147 tzlookup (Lisp_Object zone, bool settz)
149 static char const tzbuf_format[] = "<%+.*"pI"d>%s%"pI"d:%02d:%02d";
150 char const *trailing_tzbuf_format = tzbuf_format + sizeof "<%+.*"pI"d" - 1;
151 char tzbuf[sizeof tzbuf_format + 2 * INT_STRLEN_BOUND (EMACS_INT)];
152 char const *zone_string;
153 timezone_t new_tz;
155 if (NILP (zone))
156 return local_tz;
157 else if (EQ (zone, Qt))
159 zone_string = "UTC0";
160 new_tz = utc_tz;
162 else
164 bool plain_integer = INTEGERP (zone);
166 if (EQ (zone, Qwall))
167 zone_string = 0;
168 else if (STRINGP (zone))
169 zone_string = SSDATA (ENCODE_SYSTEM (zone));
170 else if (plain_integer || (CONSP (zone) && INTEGERP (XCAR (zone))
171 && CONSP (XCDR (zone))))
173 Lisp_Object abbr;
174 if (!plain_integer)
176 abbr = XCAR (XCDR (zone));
177 zone = XCAR (zone);
180 EMACS_INT abszone = eabs (XINT (zone)), hour = abszone / (60 * 60);
181 int hour_remainder = abszone % (60 * 60);
182 int min = hour_remainder / 60, sec = hour_remainder % 60;
184 if (plain_integer)
186 int prec = 2;
187 EMACS_INT numzone = hour;
188 if (hour_remainder != 0)
190 prec += 2, numzone = 100 * numzone + min;
191 if (sec != 0)
192 prec += 2, numzone = 100 * numzone + sec;
194 sprintf (tzbuf, tzbuf_format, prec, numzone,
195 &"-"[XINT (zone) < 0], hour, min, sec);
196 zone_string = tzbuf;
198 else
200 AUTO_STRING (leading, "<");
201 AUTO_STRING_WITH_LEN (trailing, tzbuf,
202 sprintf (tzbuf, trailing_tzbuf_format,
203 &"-"[XINT (zone) < 0],
204 hour, min, sec));
205 zone_string = SSDATA (concat3 (leading, ENCODE_SYSTEM (abbr),
206 trailing));
209 else
210 xsignal2 (Qerror, build_string ("Invalid time zone specification"),
211 zone);
212 new_tz = xtzalloc (zone_string);
215 if (settz)
217 block_input ();
218 emacs_setenv_TZ (zone_string);
219 tzset ();
220 timezone_t old_tz = local_tz;
221 local_tz = new_tz;
222 tzfree (old_tz);
223 unblock_input ();
226 return new_tz;
229 void
230 init_editfns (bool dumping)
232 const char *user_name;
233 register char *p;
234 struct passwd *pw; /* password entry for the current user */
235 Lisp_Object tem;
237 /* Set up system_name even when dumping. */
238 init_and_cache_system_name ();
240 #ifndef CANNOT_DUMP
241 /* When just dumping out, set the time zone to a known unlikely value
242 and skip the rest of this function. */
243 if (dumping)
245 # ifdef HAVE_TZSET
246 xputenv (dump_tz_string);
247 tzset ();
248 # endif
249 return;
251 #endif
253 char *tz = getenv ("TZ");
255 #if !defined CANNOT_DUMP && defined HAVE_TZSET
256 /* If the execution TZ happens to be the same as the dump TZ,
257 change it to some other value and then change it back,
258 to force the underlying implementation to reload the TZ info.
259 This is needed on implementations that load TZ info from files,
260 since the TZ file contents may differ between dump and execution. */
261 if (tz && strcmp (tz, &dump_tz_string[tzeqlen]) == 0)
263 ++*tz;
264 tzset ();
265 --*tz;
267 #endif
269 /* Set the time zone rule now, so that the call to putenv is done
270 before multiple threads are active. */
271 wall_clock_tz = xtzalloc (0);
272 tzlookup (tz ? build_string (tz) : Qwall, true);
274 pw = getpwuid (getuid ());
275 #ifdef MSDOS
276 /* We let the real user name default to "root" because that's quite
277 accurate on MS-DOS and because it lets Emacs find the init file.
278 (The DVX libraries override the Djgpp libraries here.) */
279 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
280 #else
281 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
282 #endif
284 /* Get the effective user name, by consulting environment variables,
285 or the effective uid if those are unset. */
286 user_name = getenv ("LOGNAME");
287 if (!user_name)
288 #ifdef WINDOWSNT
289 user_name = getenv ("USERNAME"); /* it's USERNAME on NT */
290 #else /* WINDOWSNT */
291 user_name = getenv ("USER");
292 #endif /* WINDOWSNT */
293 if (!user_name)
295 pw = getpwuid (geteuid ());
296 user_name = pw ? pw->pw_name : "unknown";
298 Vuser_login_name = build_string (user_name);
300 /* If the user name claimed in the environment vars differs from
301 the real uid, use the claimed name to find the full name. */
302 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
303 if (! NILP (tem))
304 tem = Vuser_login_name;
305 else
307 uid_t euid = geteuid ();
308 tem = make_fixnum_or_float (euid);
310 Vuser_full_name = Fuser_full_name (tem);
312 p = getenv ("NAME");
313 if (p)
314 Vuser_full_name = build_string (p);
315 else if (NILP (Vuser_full_name))
316 Vuser_full_name = build_string ("unknown");
318 #ifdef HAVE_SYS_UTSNAME_H
320 struct utsname uts;
321 uname (&uts);
322 Voperating_system_release = build_string (uts.release);
324 #else
325 Voperating_system_release = Qnil;
326 #endif
329 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
330 doc: /* Convert arg CHAR to a string containing that character.
331 usage: (char-to-string CHAR) */)
332 (Lisp_Object character)
334 int c, len;
335 unsigned char str[MAX_MULTIBYTE_LENGTH];
337 CHECK_CHARACTER (character);
338 c = XFASTINT (character);
340 len = CHAR_STRING (c, str);
341 return make_string_from_bytes ((char *) str, 1, len);
344 DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
345 doc: /* Convert arg BYTE to a unibyte string containing that byte. */)
346 (Lisp_Object byte)
348 unsigned char b;
349 CHECK_NUMBER (byte);
350 if (XINT (byte) < 0 || XINT (byte) > 255)
351 error ("Invalid byte");
352 b = XINT (byte);
353 return make_string_from_bytes ((char *) &b, 1, 1);
356 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
357 doc: /* Return the first character in STRING. */)
358 (register Lisp_Object string)
360 register Lisp_Object val;
361 CHECK_STRING (string);
362 if (SCHARS (string))
364 if (STRING_MULTIBYTE (string))
365 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
366 else
367 XSETFASTINT (val, SREF (string, 0));
369 else
370 XSETFASTINT (val, 0);
371 return val;
374 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
375 doc: /* Return value of point, as an integer.
376 Beginning of buffer is position (point-min). */)
377 (void)
379 Lisp_Object temp;
380 XSETFASTINT (temp, PT);
381 return temp;
384 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
385 doc: /* Return value of point, as a marker object. */)
386 (void)
388 return build_marker (current_buffer, PT, PT_BYTE);
391 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
392 doc: /* Set point to POSITION, a number or marker.
393 Beginning of buffer is position (point-min), end is (point-max).
395 The return value is POSITION. */)
396 (register Lisp_Object position)
398 if (MARKERP (position))
399 set_point_from_marker (position);
400 else if (INTEGERP (position))
401 SET_PT (clip_to_bounds (BEGV, XINT (position), ZV));
402 else
403 wrong_type_argument (Qinteger_or_marker_p, position);
404 return position;
408 /* Return the start or end position of the region.
409 BEGINNINGP means return the start.
410 If there is no region active, signal an error. */
412 static Lisp_Object
413 region_limit (bool beginningp)
415 Lisp_Object m;
417 if (!NILP (Vtransient_mark_mode)
418 && NILP (Vmark_even_if_inactive)
419 && NILP (BVAR (current_buffer, mark_active)))
420 xsignal0 (Qmark_inactive);
422 m = Fmarker_position (BVAR (current_buffer, mark));
423 if (NILP (m))
424 error ("The mark is not set now, so there is no region");
426 /* Clip to the current narrowing (bug#11770). */
427 return make_number ((PT < XFASTINT (m)) == beginningp
428 ? PT
429 : clip_to_bounds (BEGV, XFASTINT (m), ZV));
432 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
433 doc: /* Return the integer value of point or mark, whichever is smaller. */)
434 (void)
436 return region_limit (1);
439 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
440 doc: /* Return the integer value of point or mark, whichever is larger. */)
441 (void)
443 return region_limit (0);
446 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
447 doc: /* Return this buffer's mark, as a marker object.
448 Watch out! Moving this marker changes the mark position.
449 If you set the marker not to point anywhere, the buffer will have no mark. */)
450 (void)
452 return BVAR (current_buffer, mark);
456 /* Find all the overlays in the current buffer that touch position POS.
457 Return the number found, and store them in a vector in VEC
458 of length LEN. */
460 static ptrdiff_t
461 overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
463 Lisp_Object overlay, start, end;
464 struct Lisp_Overlay *tail;
465 ptrdiff_t startpos, endpos;
466 ptrdiff_t idx = 0;
468 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
470 XSETMISC (overlay, tail);
472 end = OVERLAY_END (overlay);
473 endpos = OVERLAY_POSITION (end);
474 if (endpos < pos)
475 break;
476 start = OVERLAY_START (overlay);
477 startpos = OVERLAY_POSITION (start);
478 if (startpos <= pos)
480 if (idx < len)
481 vec[idx] = overlay;
482 /* Keep counting overlays even if we can't return them all. */
483 idx++;
487 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
489 XSETMISC (overlay, tail);
491 start = OVERLAY_START (overlay);
492 startpos = OVERLAY_POSITION (start);
493 if (pos < startpos)
494 break;
495 end = OVERLAY_END (overlay);
496 endpos = OVERLAY_POSITION (end);
497 if (pos <= endpos)
499 if (idx < len)
500 vec[idx] = overlay;
501 idx++;
505 return idx;
508 DEFUN ("get-pos-property", Fget_pos_property, Sget_pos_property, 2, 3, 0,
509 doc: /* Return the value of POSITION's property PROP, in OBJECT.
510 Almost identical to `get-char-property' except for the following difference:
511 Whereas `get-char-property' returns the property of the char at (i.e. right
512 after) POSITION, this pays attention to properties's stickiness and overlays's
513 advancement settings, in order to find the property of POSITION itself,
514 i.e. the property that a char would inherit if it were inserted
515 at POSITION. */)
516 (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
518 CHECK_NUMBER_COERCE_MARKER (position);
520 if (NILP (object))
521 XSETBUFFER (object, current_buffer);
522 else if (WINDOWP (object))
523 object = XWINDOW (object)->contents;
525 if (!BUFFERP (object))
526 /* pos-property only makes sense in buffers right now, since strings
527 have no overlays and no notion of insertion for which stickiness
528 could be obeyed. */
529 return Fget_text_property (position, prop, object);
530 else
532 EMACS_INT posn = XINT (position);
533 ptrdiff_t noverlays;
534 Lisp_Object *overlay_vec, tem;
535 struct buffer *obuf = current_buffer;
536 USE_SAFE_ALLOCA;
538 set_buffer_temp (XBUFFER (object));
540 /* First try with room for 40 overlays. */
541 Lisp_Object overlay_vecbuf[40];
542 noverlays = ARRAYELTS (overlay_vecbuf);
543 overlay_vec = overlay_vecbuf;
544 noverlays = overlays_around (posn, overlay_vec, noverlays);
546 /* If there are more than 40,
547 make enough space for all, and try again. */
548 if (ARRAYELTS (overlay_vecbuf) < noverlays)
550 SAFE_ALLOCA_LISP (overlay_vec, noverlays);
551 noverlays = overlays_around (posn, overlay_vec, noverlays);
553 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
555 set_buffer_temp (obuf);
557 /* Now check the overlays in order of decreasing priority. */
558 while (--noverlays >= 0)
560 Lisp_Object ol = overlay_vec[noverlays];
561 tem = Foverlay_get (ol, prop);
562 if (!NILP (tem))
564 /* Check the overlay is indeed active at point. */
565 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
566 if ((OVERLAY_POSITION (start) == posn
567 && XMARKER (start)->insertion_type == 1)
568 || (OVERLAY_POSITION (finish) == posn
569 && XMARKER (finish)->insertion_type == 0))
570 ; /* The overlay will not cover a char inserted at point. */
571 else
573 SAFE_FREE ();
574 return tem;
578 SAFE_FREE ();
580 { /* Now check the text properties. */
581 int stickiness = text_property_stickiness (prop, position, object);
582 if (stickiness > 0)
583 return Fget_text_property (position, prop, object);
584 else if (stickiness < 0
585 && XINT (position) > BUF_BEGV (XBUFFER (object)))
586 return Fget_text_property (make_number (XINT (position) - 1),
587 prop, object);
588 else
589 return Qnil;
594 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
595 the value of point is used instead. If BEG or END is null,
596 means don't store the beginning or end of the field.
598 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
599 results; they do not effect boundary behavior.
601 If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
602 position of a field, then the beginning of the previous field is
603 returned instead of the beginning of POS's field (since the end of a
604 field is actually also the beginning of the next input field, this
605 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
606 non-nil case, if two fields are separated by a field with the special
607 value `boundary', and POS lies within it, then the two separated
608 fields are considered to be adjacent, and POS between them, when
609 finding the beginning and ending of the "merged" field.
611 Either BEG or END may be 0, in which case the corresponding value
612 is not stored. */
614 static void
615 find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
616 Lisp_Object beg_limit,
617 ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
619 /* Fields right before and after the point. */
620 Lisp_Object before_field, after_field;
621 /* True if POS counts as the start of a field. */
622 bool at_field_start = 0;
623 /* True if POS counts as the end of a field. */
624 bool at_field_end = 0;
626 if (NILP (pos))
627 XSETFASTINT (pos, PT);
628 else
629 CHECK_NUMBER_COERCE_MARKER (pos);
631 after_field
632 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
633 before_field
634 = (XFASTINT (pos) > BEGV
635 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
636 Qfield, Qnil, NULL)
637 /* Using nil here would be a more obvious choice, but it would
638 fail when the buffer starts with a non-sticky field. */
639 : after_field);
641 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
642 and POS is at beginning of a field, which can also be interpreted
643 as the end of the previous field. Note that the case where if
644 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
645 more natural one; then we avoid treating the beginning of a field
646 specially. */
647 if (NILP (merge_at_boundary))
649 Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
650 if (!EQ (field, after_field))
651 at_field_end = 1;
652 if (!EQ (field, before_field))
653 at_field_start = 1;
654 if (NILP (field) && at_field_start && at_field_end)
655 /* If an inserted char would have a nil field while the surrounding
656 text is non-nil, we're probably not looking at a
657 zero-length field, but instead at a non-nil field that's
658 not intended for editing (such as comint's prompts). */
659 at_field_end = at_field_start = 0;
662 /* Note about special `boundary' fields:
664 Consider the case where the point (`.') is between the fields `x' and `y':
666 xxxx.yyyy
668 In this situation, if merge_at_boundary is non-nil, consider the
669 `x' and `y' fields as forming one big merged field, and so the end
670 of the field is the end of `y'.
672 However, if `x' and `y' are separated by a special `boundary' field
673 (a field with a `field' char-property of 'boundary), then ignore
674 this special field when merging adjacent fields. Here's the same
675 situation, but with a `boundary' field between the `x' and `y' fields:
677 xxx.BBBByyyy
679 Here, if point is at the end of `x', the beginning of `y', or
680 anywhere in-between (within the `boundary' field), merge all
681 three fields and consider the beginning as being the beginning of
682 the `x' field, and the end as being the end of the `y' field. */
684 if (beg)
686 if (at_field_start)
687 /* POS is at the edge of a field, and we should consider it as
688 the beginning of the following field. */
689 *beg = XFASTINT (pos);
690 else
691 /* Find the previous field boundary. */
693 Lisp_Object p = pos;
694 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
695 /* Skip a `boundary' field. */
696 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
697 beg_limit);
699 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
700 beg_limit);
701 *beg = NILP (p) ? BEGV : XFASTINT (p);
705 if (end)
707 if (at_field_end)
708 /* POS is at the edge of a field, and we should consider it as
709 the end of the previous field. */
710 *end = XFASTINT (pos);
711 else
712 /* Find the next field boundary. */
714 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
715 /* Skip a `boundary' field. */
716 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
717 end_limit);
719 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
720 end_limit);
721 *end = NILP (pos) ? ZV : XFASTINT (pos);
727 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
728 doc: /* Delete the field surrounding POS.
729 A field is a region of text with the same `field' property.
730 If POS is nil, the value of point is used for POS. */)
731 (Lisp_Object pos)
733 ptrdiff_t beg, end;
734 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
735 if (beg != end)
736 del_range (beg, end);
737 return Qnil;
740 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
741 doc: /* Return the contents of the field surrounding POS as a string.
742 A field is a region of text with the same `field' property.
743 If POS is nil, the value of point is used for POS. */)
744 (Lisp_Object pos)
746 ptrdiff_t beg, end;
747 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
748 return make_buffer_string (beg, end, 1);
751 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
752 doc: /* Return the contents of the field around POS, without text properties.
753 A field is a region of text with the same `field' property.
754 If POS is nil, the value of point is used for POS. */)
755 (Lisp_Object pos)
757 ptrdiff_t beg, end;
758 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
759 return make_buffer_string (beg, end, 0);
762 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
763 doc: /* Return the beginning of the field surrounding POS.
764 A field is a region of text with the same `field' property.
765 If POS is nil, the value of point is used for POS.
766 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
767 field, then the beginning of the *previous* field is returned.
768 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
769 is before LIMIT, then LIMIT will be returned instead. */)
770 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
772 ptrdiff_t beg;
773 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
774 return make_number (beg);
777 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
778 doc: /* Return the end of the field surrounding POS.
779 A field is a region of text with the same `field' property.
780 If POS is nil, the value of point is used for POS.
781 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
782 then the end of the *following* field is returned.
783 If LIMIT is non-nil, it is a buffer position; if the end of the field
784 is after LIMIT, then LIMIT will be returned instead. */)
785 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
787 ptrdiff_t end;
788 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
789 return make_number (end);
792 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
793 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
794 A field is a region of text with the same `field' property.
796 If NEW-POS is nil, then use the current point instead, and move point
797 to the resulting constrained position, in addition to returning that
798 position.
800 If OLD-POS is at the boundary of two fields, then the allowable
801 positions for NEW-POS depends on the value of the optional argument
802 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
803 constrained to the field that has the same `field' char-property
804 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
805 is non-nil, NEW-POS is constrained to the union of the two adjacent
806 fields. Additionally, if two fields are separated by another field with
807 the special value `boundary', then any point within this special field is
808 also considered to be `on the boundary'.
810 If the optional argument ONLY-IN-LINE is non-nil and constraining
811 NEW-POS would move it to a different line, NEW-POS is returned
812 unconstrained. This is useful for commands that move by line, like
813 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
814 only in the case where they can still move to the right line.
816 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
817 a non-nil property of that name, then any field boundaries are ignored.
819 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
820 (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
821 Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
823 /* If non-zero, then the original point, before re-positioning. */
824 ptrdiff_t orig_point = 0;
825 bool fwd;
826 Lisp_Object prev_old, prev_new;
828 if (NILP (new_pos))
829 /* Use the current point, and afterwards, set it. */
831 orig_point = PT;
832 XSETFASTINT (new_pos, PT);
835 CHECK_NUMBER_COERCE_MARKER (new_pos);
836 CHECK_NUMBER_COERCE_MARKER (old_pos);
838 fwd = (XINT (new_pos) > XINT (old_pos));
840 prev_old = make_number (XINT (old_pos) - 1);
841 prev_new = make_number (XINT (new_pos) - 1);
843 if (NILP (Vinhibit_field_text_motion)
844 && !EQ (new_pos, old_pos)
845 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
846 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
847 /* To recognize field boundaries, we must also look at the
848 previous positions; we could use `Fget_pos_property'
849 instead, but in itself that would fail inside non-sticky
850 fields (like comint prompts). */
851 || (XFASTINT (new_pos) > BEGV
852 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
853 || (XFASTINT (old_pos) > BEGV
854 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
855 && (NILP (inhibit_capture_property)
856 /* Field boundaries are again a problem; but now we must
857 decide the case exactly, so we need to call
858 `get_pos_property' as well. */
859 || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
860 && (XFASTINT (old_pos) <= BEGV
861 || NILP (Fget_char_property
862 (old_pos, inhibit_capture_property, Qnil))
863 || NILP (Fget_char_property
864 (prev_old, inhibit_capture_property, Qnil))))))
865 /* It is possible that NEW_POS is not within the same field as
866 OLD_POS; try to move NEW_POS so that it is. */
868 ptrdiff_t shortage;
869 Lisp_Object field_bound;
871 if (fwd)
872 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
873 else
874 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
876 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
877 other side of NEW_POS, which would mean that NEW_POS is
878 already acceptable, and it's not necessary to constrain it
879 to FIELD_BOUND. */
880 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
881 /* NEW_POS should be constrained, but only if either
882 ONLY_IN_LINE is nil (in which case any constraint is OK),
883 or NEW_POS and FIELD_BOUND are on the same line (in which
884 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
885 && (NILP (only_in_line)
886 /* This is the ONLY_IN_LINE case, check that NEW_POS and
887 FIELD_BOUND are on the same line by seeing whether
888 there's an intervening newline or not. */
889 || (find_newline (XFASTINT (new_pos), -1,
890 XFASTINT (field_bound), -1,
891 fwd ? -1 : 1, &shortage, NULL, 1),
892 shortage != 0)))
893 /* Constrain NEW_POS to FIELD_BOUND. */
894 new_pos = field_bound;
896 if (orig_point && XFASTINT (new_pos) != orig_point)
897 /* The NEW_POS argument was originally nil, so automatically set PT. */
898 SET_PT (XFASTINT (new_pos));
901 return new_pos;
905 DEFUN ("line-beginning-position",
906 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
907 doc: /* Return the character position of the first character on the current line.
908 With optional argument N, scan forward N - 1 lines first.
909 If the scan reaches the end of the buffer, return that position.
911 This function ignores text display directionality; it returns the
912 position of the first character in logical order, i.e. the smallest
913 character position on the line.
915 This function constrains the returned position to the current field
916 unless that position would be on a different line than the original,
917 unconstrained result. If N is nil or 1, and a front-sticky field
918 starts at point, the scan stops as soon as it starts. To ignore field
919 boundaries, bind `inhibit-field-text-motion' to t.
921 This function does not move point. */)
922 (Lisp_Object n)
924 ptrdiff_t charpos, bytepos;
926 if (NILP (n))
927 XSETFASTINT (n, 1);
928 else
929 CHECK_NUMBER (n);
931 scan_newline_from_point (XINT (n) - 1, &charpos, &bytepos);
933 /* Return END constrained to the current input field. */
934 return Fconstrain_to_field (make_number (charpos), make_number (PT),
935 XINT (n) != 1 ? Qt : Qnil,
936 Qt, Qnil);
939 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
940 doc: /* Return the character position of the last character on the current line.
941 With argument N not nil or 1, move forward N - 1 lines first.
942 If scan reaches end of buffer, return that position.
944 This function ignores text display directionality; it returns the
945 position of the last character in logical order, i.e. the largest
946 character position on the line.
948 This function constrains the returned position to the current field
949 unless that would be on a different line than the original,
950 unconstrained result. If N is nil or 1, and a rear-sticky field ends
951 at point, the scan stops as soon as it starts. To ignore field
952 boundaries bind `inhibit-field-text-motion' to t.
954 This function does not move point. */)
955 (Lisp_Object n)
957 ptrdiff_t clipped_n;
958 ptrdiff_t end_pos;
959 ptrdiff_t orig = PT;
961 if (NILP (n))
962 XSETFASTINT (n, 1);
963 else
964 CHECK_NUMBER (n);
966 clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
967 end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
968 NULL);
970 /* Return END_POS constrained to the current input field. */
971 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
972 Qnil, Qt, Qnil);
975 /* Save current buffer state for `save-excursion' special form.
976 We (ab)use Lisp_Misc_Save_Value to allow explicit free and so
977 offload some work from GC. */
979 Lisp_Object
980 save_excursion_save (void)
982 return make_save_obj_obj_obj_obj
983 (Fpoint_marker (),
984 Qnil,
985 /* Selected window if current buffer is shown in it, nil otherwise. */
986 (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
987 ? selected_window : Qnil),
988 Qnil);
991 /* Restore saved buffer before leaving `save-excursion' special form. */
993 void
994 save_excursion_restore (Lisp_Object info)
996 Lisp_Object tem, tem1;
998 tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
999 /* If we're unwinding to top level, saved buffer may be deleted. This
1000 means that all of its markers are unchained and so tem is nil. */
1001 if (NILP (tem))
1002 goto out;
1004 Fset_buffer (tem);
1006 /* Point marker. */
1007 tem = XSAVE_OBJECT (info, 0);
1008 Fgoto_char (tem);
1009 unchain_marker (XMARKER (tem));
1011 /* If buffer was visible in a window, and a different window was
1012 selected, and the old selected window is still showing this
1013 buffer, restore point in that window. */
1014 tem = XSAVE_OBJECT (info, 2);
1015 if (WINDOWP (tem)
1016 && !EQ (tem, selected_window)
1017 && (tem1 = XWINDOW (tem)->contents,
1018 (/* Window is live... */
1019 BUFFERP (tem1)
1020 /* ...and it shows the current buffer. */
1021 && XBUFFER (tem1) == current_buffer)))
1022 Fset_window_point (tem, make_number (PT));
1024 out:
1026 free_misc (info);
1029 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
1030 doc: /* Save point, and current buffer; execute BODY; restore those things.
1031 Executes BODY just like `progn'.
1032 The values of point and the current buffer are restored
1033 even in case of abnormal exit (throw or error).
1035 If you only want to save the current buffer but not point,
1036 then just use `save-current-buffer', or even `with-current-buffer'.
1038 Before Emacs 25.1, `save-excursion' used to save the mark state.
1039 To save the marker state as well as the point and buffer, use
1040 `save-mark-and-excursion'.
1042 usage: (save-excursion &rest BODY) */)
1043 (Lisp_Object args)
1045 register Lisp_Object val;
1046 ptrdiff_t count = SPECPDL_INDEX ();
1048 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1050 val = Fprogn (args);
1051 return unbind_to (count, val);
1054 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1055 doc: /* Record which buffer is current; execute BODY; make that buffer current.
1056 BODY is executed just like `progn'.
1057 usage: (save-current-buffer &rest BODY) */)
1058 (Lisp_Object args)
1060 ptrdiff_t count = SPECPDL_INDEX ();
1062 record_unwind_current_buffer ();
1063 return unbind_to (count, Fprogn (args));
1066 DEFUN ("buffer-size", Fbuffer_size, Sbuffer_size, 0, 1, 0,
1067 doc: /* Return the number of characters in the current buffer.
1068 If BUFFER is not nil, return the number of characters in that buffer
1069 instead.
1071 This does not take narrowing into account; to count the number of
1072 characters in the accessible portion of the current buffer, use
1073 `(- (point-max) (point-min))', and to count the number of characters
1074 in some other BUFFER, use
1075 `(with-current-buffer BUFFER (- (point-max) (point-min)))'. */)
1076 (Lisp_Object buffer)
1078 if (NILP (buffer))
1079 return make_number (Z - BEG);
1080 else
1082 CHECK_BUFFER (buffer);
1083 return make_number (BUF_Z (XBUFFER (buffer))
1084 - BUF_BEG (XBUFFER (buffer)));
1088 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1089 doc: /* Return the minimum permissible value of point in the current buffer.
1090 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1091 (void)
1093 Lisp_Object temp;
1094 XSETFASTINT (temp, BEGV);
1095 return temp;
1098 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1099 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1100 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1101 (void)
1103 return build_marker (current_buffer, BEGV, BEGV_BYTE);
1106 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1107 doc: /* Return the maximum permissible value of point in the current buffer.
1108 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1109 is in effect, in which case it is less. */)
1110 (void)
1112 Lisp_Object temp;
1113 XSETFASTINT (temp, ZV);
1114 return temp;
1117 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1118 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1119 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1120 is in effect, in which case it is less. */)
1121 (void)
1123 return build_marker (current_buffer, ZV, ZV_BYTE);
1126 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1127 doc: /* Return the position of the gap, in the current buffer.
1128 See also `gap-size'. */)
1129 (void)
1131 Lisp_Object temp;
1132 XSETFASTINT (temp, GPT);
1133 return temp;
1136 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1137 doc: /* Return the size of the current buffer's gap.
1138 See also `gap-position'. */)
1139 (void)
1141 Lisp_Object temp;
1142 XSETFASTINT (temp, GAP_SIZE);
1143 return temp;
1146 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1147 doc: /* Return the byte position for character position POSITION.
1148 If POSITION is out of range, the value is nil. */)
1149 (Lisp_Object position)
1151 CHECK_NUMBER_COERCE_MARKER (position);
1152 if (XINT (position) < BEG || XINT (position) > Z)
1153 return Qnil;
1154 return make_number (CHAR_TO_BYTE (XINT (position)));
1157 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1158 doc: /* Return the character position for byte position BYTEPOS.
1159 If BYTEPOS is out of range, the value is nil. */)
1160 (Lisp_Object bytepos)
1162 ptrdiff_t pos_byte;
1164 CHECK_NUMBER (bytepos);
1165 pos_byte = XINT (bytepos);
1166 if (pos_byte < BEG_BYTE || pos_byte > Z_BYTE)
1167 return Qnil;
1168 if (Z != Z_BYTE)
1169 /* There are multibyte characters in the buffer.
1170 The argument of BYTE_TO_CHAR must be a byte position at
1171 a character boundary, so search for the start of the current
1172 character. */
1173 while (!CHAR_HEAD_P (FETCH_BYTE (pos_byte)))
1174 pos_byte--;
1175 return make_number (BYTE_TO_CHAR (pos_byte));
1178 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1179 doc: /* Return the character following point, as a number.
1180 At the end of the buffer or accessible region, return 0. */)
1181 (void)
1183 Lisp_Object temp;
1184 if (PT >= ZV)
1185 XSETFASTINT (temp, 0);
1186 else
1187 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1188 return temp;
1191 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1192 doc: /* Return the character preceding point, as a number.
1193 At the beginning of the buffer or accessible region, return 0. */)
1194 (void)
1196 Lisp_Object temp;
1197 if (PT <= BEGV)
1198 XSETFASTINT (temp, 0);
1199 else if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
1201 ptrdiff_t pos = PT_BYTE;
1202 DEC_POS (pos);
1203 XSETFASTINT (temp, FETCH_CHAR (pos));
1205 else
1206 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1207 return temp;
1210 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1211 doc: /* Return t if point is at the beginning of the buffer.
1212 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1213 (void)
1215 if (PT == BEGV)
1216 return Qt;
1217 return Qnil;
1220 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1221 doc: /* Return t if point is at the end of the buffer.
1222 If the buffer is narrowed, this means the end of the narrowed part. */)
1223 (void)
1225 if (PT == ZV)
1226 return Qt;
1227 return Qnil;
1230 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1231 doc: /* Return t if point is at the beginning of a line. */)
1232 (void)
1234 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1235 return Qt;
1236 return Qnil;
1239 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1240 doc: /* Return t if point is at the end of a line.
1241 `End of a line' includes point being at the end of the buffer. */)
1242 (void)
1244 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1245 return Qt;
1246 return Qnil;
1249 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1250 doc: /* Return character in current buffer at position POS.
1251 POS is an integer or a marker and defaults to point.
1252 If POS is out of range, the value is nil. */)
1253 (Lisp_Object pos)
1255 register ptrdiff_t pos_byte;
1257 if (NILP (pos))
1259 pos_byte = PT_BYTE;
1260 XSETFASTINT (pos, PT);
1263 if (MARKERP (pos))
1265 pos_byte = marker_byte_position (pos);
1266 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1267 return Qnil;
1269 else
1271 CHECK_NUMBER_COERCE_MARKER (pos);
1272 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1273 return Qnil;
1275 pos_byte = CHAR_TO_BYTE (XINT (pos));
1278 return make_number (FETCH_CHAR (pos_byte));
1281 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1282 doc: /* Return character in current buffer preceding position POS.
1283 POS is an integer or a marker and defaults to point.
1284 If POS is out of range, the value is nil. */)
1285 (Lisp_Object pos)
1287 register Lisp_Object val;
1288 register ptrdiff_t pos_byte;
1290 if (NILP (pos))
1292 pos_byte = PT_BYTE;
1293 XSETFASTINT (pos, PT);
1296 if (MARKERP (pos))
1298 pos_byte = marker_byte_position (pos);
1300 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1301 return Qnil;
1303 else
1305 CHECK_NUMBER_COERCE_MARKER (pos);
1307 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1308 return Qnil;
1310 pos_byte = CHAR_TO_BYTE (XINT (pos));
1313 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
1315 DEC_POS (pos_byte);
1316 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1318 else
1320 pos_byte--;
1321 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1323 return val;
1326 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1327 doc: /* Return the name under which the user logged in, as a string.
1328 This is based on the effective uid, not the real uid.
1329 Also, if the environment variables LOGNAME or USER are set,
1330 that determines the value of this function.
1332 If optional argument UID is an integer or a float, return the login name
1333 of the user with that uid, or nil if there is no such user. */)
1334 (Lisp_Object uid)
1336 struct passwd *pw;
1337 uid_t id;
1339 /* Set up the user name info if we didn't do it before.
1340 (That can happen if Emacs is dumpable
1341 but you decide to run `temacs -l loadup' and not dump. */
1342 if (NILP (Vuser_login_name))
1343 init_editfns (false);
1345 if (NILP (uid))
1346 return Vuser_login_name;
1348 CONS_TO_INTEGER (uid, uid_t, id);
1349 block_input ();
1350 pw = getpwuid (id);
1351 unblock_input ();
1352 return (pw ? build_string (pw->pw_name) : Qnil);
1355 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1356 0, 0, 0,
1357 doc: /* Return the name of the user's real uid, as a string.
1358 This ignores the environment variables LOGNAME and USER, so it differs from
1359 `user-login-name' when running under `su'. */)
1360 (void)
1362 /* Set up the user name info if we didn't do it before.
1363 (That can happen if Emacs is dumpable
1364 but you decide to run `temacs -l loadup' and not dump. */
1365 if (NILP (Vuser_login_name))
1366 init_editfns (false);
1367 return Vuser_real_login_name;
1370 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1371 doc: /* Return the effective uid of Emacs.
1372 Value is an integer or a float, depending on the value. */)
1373 (void)
1375 uid_t euid = geteuid ();
1376 return make_fixnum_or_float (euid);
1379 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1380 doc: /* Return the real uid of Emacs.
1381 Value is an integer or a float, depending on the value. */)
1382 (void)
1384 uid_t uid = getuid ();
1385 return make_fixnum_or_float (uid);
1388 DEFUN ("group-gid", Fgroup_gid, Sgroup_gid, 0, 0, 0,
1389 doc: /* Return the effective gid of Emacs.
1390 Value is an integer or a float, depending on the value. */)
1391 (void)
1393 gid_t egid = getegid ();
1394 return make_fixnum_or_float (egid);
1397 DEFUN ("group-real-gid", Fgroup_real_gid, Sgroup_real_gid, 0, 0, 0,
1398 doc: /* Return the real gid of Emacs.
1399 Value is an integer or a float, depending on the value. */)
1400 (void)
1402 gid_t gid = getgid ();
1403 return make_fixnum_or_float (gid);
1406 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1407 doc: /* Return the full name of the user logged in, as a string.
1408 If the full name corresponding to Emacs's userid is not known,
1409 return "unknown".
1411 If optional argument UID is an integer or float, return the full name
1412 of the user with that uid, or nil if there is no such user.
1413 If UID is a string, return the full name of the user with that login
1414 name, or nil if there is no such user. */)
1415 (Lisp_Object uid)
1417 struct passwd *pw;
1418 register char *p, *q;
1419 Lisp_Object full;
1421 if (NILP (uid))
1422 return Vuser_full_name;
1423 else if (NUMBERP (uid))
1425 uid_t u;
1426 CONS_TO_INTEGER (uid, uid_t, u);
1427 block_input ();
1428 pw = getpwuid (u);
1429 unblock_input ();
1431 else if (STRINGP (uid))
1433 block_input ();
1434 pw = getpwnam (SSDATA (uid));
1435 unblock_input ();
1437 else
1438 error ("Invalid UID specification");
1440 if (!pw)
1441 return Qnil;
1443 p = USER_FULL_NAME;
1444 /* Chop off everything after the first comma. */
1445 q = strchr (p, ',');
1446 full = make_string (p, q ? q - p : strlen (p));
1448 #ifdef AMPERSAND_FULL_NAME
1449 p = SSDATA (full);
1450 q = strchr (p, '&');
1451 /* Substitute the login name for the &, upcasing the first character. */
1452 if (q)
1454 Lisp_Object login = Fuser_login_name (make_number (pw->pw_uid));
1455 USE_SAFE_ALLOCA;
1456 char *r = SAFE_ALLOCA (strlen (p) + SBYTES (login) + 1);
1457 memcpy (r, p, q - p);
1458 char *s = lispstpcpy (&r[q - p], login);
1459 r[q - p] = upcase ((unsigned char) r[q - p]);
1460 strcpy (s, q + 1);
1461 full = build_string (r);
1462 SAFE_FREE ();
1464 #endif /* AMPERSAND_FULL_NAME */
1466 return full;
1469 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1470 doc: /* Return the host name of the machine you are running on, as a string. */)
1471 (void)
1473 if (EQ (Vsystem_name, cached_system_name))
1474 init_and_cache_system_name ();
1475 return Vsystem_name;
1478 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1479 doc: /* Return the process ID of Emacs, as a number. */)
1480 (void)
1482 pid_t pid = getpid ();
1483 return make_fixnum_or_float (pid);
1488 #ifndef TIME_T_MIN
1489 # define TIME_T_MIN TYPE_MINIMUM (time_t)
1490 #endif
1491 #ifndef TIME_T_MAX
1492 # define TIME_T_MAX TYPE_MAXIMUM (time_t)
1493 #endif
1495 /* Report that a time value is out of range for Emacs. */
1496 void
1497 time_overflow (void)
1499 error ("Specified time is not representable");
1502 static _Noreturn void
1503 invalid_time (void)
1505 error ("Invalid time specification");
1508 /* Check a return value compatible with that of decode_time_components. */
1509 static void
1510 check_time_validity (int validity)
1512 if (validity <= 0)
1514 if (validity < 0)
1515 time_overflow ();
1516 else
1517 invalid_time ();
1521 /* Return the upper part of the time T (everything but the bottom 16 bits). */
1522 static EMACS_INT
1523 hi_time (time_t t)
1525 time_t hi = t >> LO_TIME_BITS;
1527 /* Check for overflow, helping the compiler for common cases where
1528 no runtime check is needed, and taking care not to convert
1529 negative numbers to unsigned before comparing them. */
1530 if (! ((! TYPE_SIGNED (time_t)
1531 || MOST_NEGATIVE_FIXNUM <= TIME_T_MIN >> LO_TIME_BITS
1532 || MOST_NEGATIVE_FIXNUM <= hi)
1533 && (TIME_T_MAX >> LO_TIME_BITS <= MOST_POSITIVE_FIXNUM
1534 || hi <= MOST_POSITIVE_FIXNUM)))
1535 time_overflow ();
1537 return hi;
1540 /* Return the bottom bits of the time T. */
1541 static int
1542 lo_time (time_t t)
1544 return t & ((1 << LO_TIME_BITS) - 1);
1547 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1548 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1549 The time is returned as a list of integers (HIGH LOW USEC PSEC).
1550 HIGH has the most significant bits of the seconds, while LOW has the
1551 least significant 16 bits. USEC and PSEC are the microsecond and
1552 picosecond counts. */)
1553 (void)
1555 return make_lisp_time (current_timespec ());
1558 static struct lisp_time
1559 time_add (struct lisp_time ta, struct lisp_time tb)
1561 EMACS_INT hi = ta.hi + tb.hi;
1562 int lo = ta.lo + tb.lo;
1563 int us = ta.us + tb.us;
1564 int ps = ta.ps + tb.ps;
1565 us += (1000000 <= ps);
1566 ps -= (1000000 <= ps) * 1000000;
1567 lo += (1000000 <= us);
1568 us -= (1000000 <= us) * 1000000;
1569 hi += (1 << LO_TIME_BITS <= lo);
1570 lo -= (1 << LO_TIME_BITS <= lo) << LO_TIME_BITS;
1571 return (struct lisp_time) { hi, lo, us, ps };
1574 static struct lisp_time
1575 time_subtract (struct lisp_time ta, struct lisp_time tb)
1577 EMACS_INT hi = ta.hi - tb.hi;
1578 int lo = ta.lo - tb.lo;
1579 int us = ta.us - tb.us;
1580 int ps = ta.ps - tb.ps;
1581 us -= (ps < 0);
1582 ps += (ps < 0) * 1000000;
1583 lo -= (us < 0);
1584 us += (us < 0) * 1000000;
1585 hi -= (lo < 0);
1586 lo += (lo < 0) << LO_TIME_BITS;
1587 return (struct lisp_time) { hi, lo, us, ps };
1590 static Lisp_Object
1591 time_arith (Lisp_Object a, Lisp_Object b,
1592 struct lisp_time (*op) (struct lisp_time, struct lisp_time))
1594 int alen, blen;
1595 struct lisp_time ta = lisp_time_struct (a, &alen);
1596 struct lisp_time tb = lisp_time_struct (b, &blen);
1597 struct lisp_time t = op (ta, tb);
1598 if (! (MOST_NEGATIVE_FIXNUM <= t.hi && t.hi <= MOST_POSITIVE_FIXNUM))
1599 time_overflow ();
1600 Lisp_Object val = Qnil;
1602 switch (max (alen, blen))
1604 default:
1605 val = Fcons (make_number (t.ps), val);
1606 /* Fall through. */
1607 case 3:
1608 val = Fcons (make_number (t.us), val);
1609 /* Fall through. */
1610 case 2:
1611 val = Fcons (make_number (t.lo), val);
1612 val = Fcons (make_number (t.hi), val);
1613 break;
1616 return val;
1619 DEFUN ("time-add", Ftime_add, Stime_add, 2, 2, 0,
1620 doc: /* Return the sum of two time values A and B, as a time value. */)
1621 (Lisp_Object a, Lisp_Object b)
1623 return time_arith (a, b, time_add);
1626 DEFUN ("time-subtract", Ftime_subtract, Stime_subtract, 2, 2, 0,
1627 doc: /* Return the difference between two time values A and B, as a time value. */)
1628 (Lisp_Object a, Lisp_Object b)
1630 return time_arith (a, b, time_subtract);
1633 DEFUN ("time-less-p", Ftime_less_p, Stime_less_p, 2, 2, 0,
1634 doc: /* Return non-nil if time value T1 is earlier than time value T2. */)
1635 (Lisp_Object t1, Lisp_Object t2)
1637 int t1len, t2len;
1638 struct lisp_time a = lisp_time_struct (t1, &t1len);
1639 struct lisp_time b = lisp_time_struct (t2, &t2len);
1640 return ((a.hi != b.hi ? a.hi < b.hi
1641 : a.lo != b.lo ? a.lo < b.lo
1642 : a.us != b.us ? a.us < b.us
1643 : a.ps < b.ps)
1644 ? Qt : Qnil);
1648 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1649 0, 0, 0,
1650 doc: /* Return the current run time used by Emacs.
1651 The time is returned as a list (HIGH LOW USEC PSEC), using the same
1652 style as (current-time).
1654 On systems that can't determine the run time, `get-internal-run-time'
1655 does the same thing as `current-time'. */)
1656 (void)
1658 #ifdef HAVE_GETRUSAGE
1659 struct rusage usage;
1660 time_t secs;
1661 int usecs;
1663 if (getrusage (RUSAGE_SELF, &usage) < 0)
1664 /* This shouldn't happen. What action is appropriate? */
1665 xsignal0 (Qerror);
1667 /* Sum up user time and system time. */
1668 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1669 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1670 if (usecs >= 1000000)
1672 usecs -= 1000000;
1673 secs++;
1675 return make_lisp_time (make_timespec (secs, usecs * 1000));
1676 #else /* ! HAVE_GETRUSAGE */
1677 #ifdef WINDOWSNT
1678 return w32_get_internal_run_time ();
1679 #else /* ! WINDOWSNT */
1680 return Fcurrent_time ();
1681 #endif /* WINDOWSNT */
1682 #endif /* HAVE_GETRUSAGE */
1686 /* Make a Lisp list that represents the Emacs time T. T may be an
1687 invalid time, with a slightly negative tv_nsec value such as
1688 UNKNOWN_MODTIME_NSECS; in that case, the Lisp list contains a
1689 correspondingly negative picosecond count. */
1690 Lisp_Object
1691 make_lisp_time (struct timespec t)
1693 time_t s = t.tv_sec;
1694 int ns = t.tv_nsec;
1695 return list4i (hi_time (s), lo_time (s), ns / 1000, ns % 1000 * 1000);
1698 /* Decode a Lisp list SPECIFIED_TIME that represents a time.
1699 Set *PHIGH, *PLOW, *PUSEC, *PPSEC to its parts; do not check their values.
1700 Return 2, 3, or 4 to indicate the effective length of SPECIFIED_TIME
1701 if successful, 0 if unsuccessful. */
1702 static int
1703 disassemble_lisp_time (Lisp_Object specified_time, Lisp_Object *phigh,
1704 Lisp_Object *plow, Lisp_Object *pusec,
1705 Lisp_Object *ppsec)
1707 Lisp_Object high = make_number (0);
1708 Lisp_Object low = specified_time;
1709 Lisp_Object usec = make_number (0);
1710 Lisp_Object psec = make_number (0);
1711 int len = 4;
1713 if (CONSP (specified_time))
1715 high = XCAR (specified_time);
1716 low = XCDR (specified_time);
1717 if (CONSP (low))
1719 Lisp_Object low_tail = XCDR (low);
1720 low = XCAR (low);
1721 if (CONSP (low_tail))
1723 usec = XCAR (low_tail);
1724 low_tail = XCDR (low_tail);
1725 if (CONSP (low_tail))
1726 psec = XCAR (low_tail);
1727 else
1728 len = 3;
1730 else if (!NILP (low_tail))
1732 usec = low_tail;
1733 len = 3;
1735 else
1736 len = 2;
1738 else
1739 len = 2;
1741 /* When combining components, require LOW to be an integer,
1742 as otherwise it would be a pain to add up times. */
1743 if (! INTEGERP (low))
1744 return 0;
1746 else if (INTEGERP (specified_time))
1747 len = 2;
1749 *phigh = high;
1750 *plow = low;
1751 *pusec = usec;
1752 *ppsec = psec;
1753 return len;
1756 /* Convert T into an Emacs time *RESULT, truncating toward minus infinity.
1757 Return true if T is in range, false otherwise. */
1758 static bool
1759 decode_float_time (double t, struct lisp_time *result)
1761 double lo_multiplier = 1 << LO_TIME_BITS;
1762 double emacs_time_min = MOST_NEGATIVE_FIXNUM * lo_multiplier;
1763 if (! (emacs_time_min <= t && t < -emacs_time_min))
1764 return false;
1766 double small_t = t / lo_multiplier;
1767 EMACS_INT hi = small_t;
1768 double t_sans_hi = t - hi * lo_multiplier;
1769 int lo = t_sans_hi;
1770 long double fracps = (t_sans_hi - lo) * 1e12L;
1771 #ifdef INT_FAST64_MAX
1772 int_fast64_t ifracps = fracps;
1773 int us = ifracps / 1000000;
1774 int ps = ifracps % 1000000;
1775 #else
1776 int us = fracps / 1e6L;
1777 int ps = fracps - us * 1e6L;
1778 #endif
1779 us -= (ps < 0);
1780 ps += (ps < 0) * 1000000;
1781 lo -= (us < 0);
1782 us += (us < 0) * 1000000;
1783 hi -= (lo < 0);
1784 lo += (lo < 0) << LO_TIME_BITS;
1785 result->hi = hi;
1786 result->lo = lo;
1787 result->us = us;
1788 result->ps = ps;
1789 return true;
1792 /* From the time components HIGH, LOW, USEC and PSEC taken from a Lisp
1793 list, generate the corresponding time value.
1794 If LOW is floating point, the other components should be zero.
1796 If RESULT is not null, store into *RESULT the converted time.
1797 If *DRESULT is not null, store into *DRESULT the number of
1798 seconds since the start of the POSIX Epoch.
1800 Return 1 if successful, 0 if the components are of the
1801 wrong type, and -1 if the time is out of range. */
1803 decode_time_components (Lisp_Object high, Lisp_Object low, Lisp_Object usec,
1804 Lisp_Object psec,
1805 struct lisp_time *result, double *dresult)
1807 EMACS_INT hi, lo, us, ps;
1808 if (! (INTEGERP (high)
1809 && INTEGERP (usec) && INTEGERP (psec)))
1810 return 0;
1811 if (! INTEGERP (low))
1813 if (FLOATP (low))
1815 double t = XFLOAT_DATA (low);
1816 if (result && ! decode_float_time (t, result))
1817 return -1;
1818 if (dresult)
1819 *dresult = t;
1820 return 1;
1822 else if (NILP (low))
1824 struct timespec now = current_timespec ();
1825 if (result)
1827 result->hi = hi_time (now.tv_sec);
1828 result->lo = lo_time (now.tv_sec);
1829 result->us = now.tv_nsec / 1000;
1830 result->ps = now.tv_nsec % 1000 * 1000;
1832 if (dresult)
1833 *dresult = now.tv_sec + now.tv_nsec / 1e9;
1834 return 1;
1836 else
1837 return 0;
1840 hi = XINT (high);
1841 lo = XINT (low);
1842 us = XINT (usec);
1843 ps = XINT (psec);
1845 /* Normalize out-of-range lower-order components by carrying
1846 each overflow into the next higher-order component. */
1847 us += ps / 1000000 - (ps % 1000000 < 0);
1848 lo += us / 1000000 - (us % 1000000 < 0);
1849 hi += lo >> LO_TIME_BITS;
1850 ps = ps % 1000000 + 1000000 * (ps % 1000000 < 0);
1851 us = us % 1000000 + 1000000 * (us % 1000000 < 0);
1852 lo &= (1 << LO_TIME_BITS) - 1;
1854 if (result)
1856 if (! (MOST_NEGATIVE_FIXNUM <= hi && hi <= MOST_POSITIVE_FIXNUM))
1857 return -1;
1858 result->hi = hi;
1859 result->lo = lo;
1860 result->us = us;
1861 result->ps = ps;
1864 if (dresult)
1866 double dhi = hi;
1867 *dresult = (us * 1e6 + ps) / 1e12 + lo + dhi * (1 << LO_TIME_BITS);
1870 return 1;
1873 struct timespec
1874 lisp_to_timespec (struct lisp_time t)
1876 if (! ((TYPE_SIGNED (time_t) ? TIME_T_MIN >> LO_TIME_BITS <= t.hi : 0 <= t.hi)
1877 && t.hi <= TIME_T_MAX >> LO_TIME_BITS))
1878 return invalid_timespec ();
1879 time_t s = (t.hi << LO_TIME_BITS) + t.lo;
1880 int ns = t.us * 1000 + t.ps / 1000;
1881 return make_timespec (s, ns);
1884 /* Decode a Lisp list SPECIFIED_TIME that represents a time.
1885 Store its effective length into *PLEN.
1886 If SPECIFIED_TIME is nil, use the current time.
1887 Signal an error if SPECIFIED_TIME does not represent a time. */
1888 static struct lisp_time
1889 lisp_time_struct (Lisp_Object specified_time, int *plen)
1891 Lisp_Object high, low, usec, psec;
1892 struct lisp_time t;
1893 int len = disassemble_lisp_time (specified_time, &high, &low, &usec, &psec);
1894 if (!len)
1895 invalid_time ();
1896 int val = decode_time_components (high, low, usec, psec, &t, 0);
1897 check_time_validity (val);
1898 *plen = len;
1899 return t;
1902 /* Like lisp_time_struct, except return a struct timespec.
1903 Discard any low-order digits. */
1904 struct timespec
1905 lisp_time_argument (Lisp_Object specified_time)
1907 int len;
1908 struct lisp_time lt = lisp_time_struct (specified_time, &len);
1909 struct timespec t = lisp_to_timespec (lt);
1910 if (! timespec_valid_p (t))
1911 time_overflow ();
1912 return t;
1915 /* Like lisp_time_argument, except decode only the seconds part,
1916 and do not check the subseconds part. */
1917 static time_t
1918 lisp_seconds_argument (Lisp_Object specified_time)
1920 Lisp_Object high, low, usec, psec;
1921 struct lisp_time t;
1923 int val = disassemble_lisp_time (specified_time, &high, &low, &usec, &psec);
1924 if (val != 0)
1926 val = decode_time_components (high, low, make_number (0),
1927 make_number (0), &t, 0);
1928 if (0 < val
1929 && ! ((TYPE_SIGNED (time_t)
1930 ? TIME_T_MIN >> LO_TIME_BITS <= t.hi
1931 : 0 <= t.hi)
1932 && t.hi <= TIME_T_MAX >> LO_TIME_BITS))
1933 val = -1;
1935 check_time_validity (val);
1936 return (t.hi << LO_TIME_BITS) + t.lo;
1939 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1940 doc: /* Return the current time, as a float number of seconds since the epoch.
1941 If SPECIFIED-TIME is given, it is the time to convert to float
1942 instead of the current time. The argument should have the form
1943 \(HIGH LOW) or (HIGH LOW USEC) or (HIGH LOW USEC PSEC). Thus,
1944 you can use times from `current-time' and from `file-attributes'.
1945 SPECIFIED-TIME can also have the form (HIGH . LOW), but this is
1946 considered obsolete.
1948 WARNING: Since the result is floating point, it may not be exact.
1949 If precise time stamps are required, use either `current-time',
1950 or (if you need time as a string) `format-time-string'. */)
1951 (Lisp_Object specified_time)
1953 double t;
1954 Lisp_Object high, low, usec, psec;
1955 if (! (disassemble_lisp_time (specified_time, &high, &low, &usec, &psec)
1956 && decode_time_components (high, low, usec, psec, 0, &t)))
1957 invalid_time ();
1958 return make_float (t);
1961 /* Write information into buffer S of size MAXSIZE, according to the
1962 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1963 Use the time zone specified by TZ.
1964 Use NS as the number of nanoseconds in the %N directive.
1965 Return the number of bytes written, not including the terminating
1966 '\0'. If S is NULL, nothing will be written anywhere; so to
1967 determine how many bytes would be written, use NULL for S and
1968 ((size_t) -1) for MAXSIZE.
1970 This function behaves like nstrftime, except it allows null
1971 bytes in FORMAT and it does not support nanoseconds. */
1972 static size_t
1973 emacs_nmemftime (char *s, size_t maxsize, const char *format,
1974 size_t format_len, const struct tm *tp, timezone_t tz, int ns)
1976 size_t total = 0;
1978 /* Loop through all the null-terminated strings in the format
1979 argument. Normally there's just one null-terminated string, but
1980 there can be arbitrarily many, concatenated together, if the
1981 format contains '\0' bytes. nstrftime stops at the first
1982 '\0' byte so we must invoke it separately for each such string. */
1983 for (;;)
1985 size_t len;
1986 size_t result;
1988 if (s)
1989 s[0] = '\1';
1991 result = nstrftime (s, maxsize, format, tp, tz, ns);
1993 if (s)
1995 if (result == 0 && s[0] != '\0')
1996 return 0;
1997 s += result + 1;
2000 maxsize -= result + 1;
2001 total += result;
2002 len = strlen (format);
2003 if (len == format_len)
2004 return total;
2005 total++;
2006 format += len + 1;
2007 format_len -= len + 1;
2011 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
2012 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
2013 TIME is specified as (HIGH LOW USEC PSEC), as returned by
2014 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
2015 is also still accepted.
2017 The optional ZONE is omitted or nil for Emacs local time, t for
2018 Universal Time, `wall' for system wall clock time, or a string as in
2019 the TZ environment variable. It can also be a list (as from
2020 `current-time-zone') or an integer (as from `decode-time') applied
2021 without consideration for daylight saving time.
2023 The value is a copy of FORMAT-STRING, but with certain constructs replaced
2024 by text that describes the specified date and time in TIME:
2026 %Y is the year, %y within the century, %C the century.
2027 %G is the year corresponding to the ISO week, %g within the century.
2028 %m is the numeric month.
2029 %b and %h are the locale's abbreviated month name, %B the full name.
2030 (%h is not supported on MS-Windows.)
2031 %d is the day of the month, zero-padded, %e is blank-padded.
2032 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
2033 %a is the locale's abbreviated name of the day of week, %A the full name.
2034 %U is the week number starting on Sunday, %W starting on Monday,
2035 %V according to ISO 8601.
2036 %j is the day of the year.
2038 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
2039 only blank-padded, %l is like %I blank-padded.
2040 %p is the locale's equivalent of either AM or PM.
2041 %M is the minute.
2042 %S is the second.
2043 %N is the nanosecond, %6N the microsecond, %3N the millisecond, etc.
2044 %Z is the time zone name, %z is the numeric form.
2045 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
2047 %c is the locale's date and time format.
2048 %x is the locale's "preferred" date format.
2049 %D is like "%m/%d/%y".
2050 %F is the ISO 8601 date format (like "%Y-%m-%d").
2052 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
2053 %X is the locale's "preferred" time format.
2055 Finally, %n is a newline, %t is a tab, %% is a literal %.
2057 Certain flags and modifiers are available with some format controls.
2058 The flags are `_', `-', `^' and `#'. For certain characters X,
2059 %_X is like %X, but padded with blanks; %-X is like %X,
2060 but without padding. %^X is like %X, but with all textual
2061 characters up-cased; %#X is like %X, but with letter-case of
2062 all textual characters reversed.
2063 %NX (where N stands for an integer) is like %X,
2064 but takes up at least N (a number) positions.
2065 The modifiers are `E' and `O'. For certain characters X,
2066 %EX is a locale's alternative version of %X;
2067 %OX is like %X, but uses the locale's number symbols.
2069 For example, to produce full ISO 8601 format, use "%FT%T%z".
2071 usage: (format-time-string FORMAT-STRING &optional TIME ZONE) */)
2072 (Lisp_Object format_string, Lisp_Object timeval, Lisp_Object zone)
2074 struct timespec t = lisp_time_argument (timeval);
2075 struct tm tm;
2077 CHECK_STRING (format_string);
2078 format_string = code_convert_string_norecord (format_string,
2079 Vlocale_coding_system, 1);
2080 return format_time_string (SSDATA (format_string), SBYTES (format_string),
2081 t, zone, &tm);
2084 static Lisp_Object
2085 format_time_string (char const *format, ptrdiff_t formatlen,
2086 struct timespec t, Lisp_Object zone, struct tm *tmp)
2088 char buffer[4000];
2089 char *buf = buffer;
2090 ptrdiff_t size = sizeof buffer;
2091 size_t len;
2092 int ns = t.tv_nsec;
2093 USE_SAFE_ALLOCA;
2095 timezone_t tz = tzlookup (zone, false);
2096 tmp = emacs_localtime_rz (tz, &t.tv_sec, tmp);
2097 if (! tmp)
2099 xtzfree (tz);
2100 time_overflow ();
2102 synchronize_system_time_locale ();
2104 while (true)
2106 buf[0] = '\1';
2107 len = emacs_nmemftime (buf, size, format, formatlen, tmp, tz, ns);
2108 if ((0 < len && len < size) || (len == 0 && buf[0] == '\0'))
2109 break;
2111 /* Buffer was too small, so make it bigger and try again. */
2112 len = emacs_nmemftime (NULL, SIZE_MAX, format, formatlen, tmp, tz, ns);
2113 if (STRING_BYTES_BOUND <= len)
2115 xtzfree (tz);
2116 string_overflow ();
2118 size = len + 1;
2119 buf = SAFE_ALLOCA (size);
2122 xtzfree (tz);
2123 AUTO_STRING_WITH_LEN (bufstring, buf, len);
2124 Lisp_Object result = code_convert_string_norecord (bufstring,
2125 Vlocale_coding_system, 0);
2126 SAFE_FREE ();
2127 return result;
2130 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 2, 0,
2131 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST UTCOFF).
2132 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
2133 as from `current-time' and `file-attributes', or nil to use the
2134 current time. The obsolete form (HIGH . LOW) is also still accepted.
2136 The optional ZONE is omitted or nil for Emacs local time, t for
2137 Universal Time, `wall' for system wall clock time, or a string as in
2138 the TZ environment variable. It can also be a list (as from
2139 `current-time-zone') or an integer (as from `decode-time') applied
2140 without consideration for daylight saving time.
2142 The list has the following nine members: SEC is an integer between 0
2143 and 60; SEC is 60 for a leap second, which only some operating systems
2144 support. MINUTE is an integer between 0 and 59. HOUR is an integer
2145 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
2146 integer between 1 and 12. YEAR is an integer indicating the
2147 four-digit year. DOW is the day of week, an integer between 0 and 6,
2148 where 0 is Sunday. DST is t if daylight saving time is in effect,
2149 otherwise nil. UTCOFF is an integer indicating the UTC offset in
2150 seconds, i.e., the number of seconds east of Greenwich. (Note that
2151 Common Lisp has different meanings for DOW and UTCOFF.)
2153 usage: (decode-time &optional TIME ZONE) */)
2154 (Lisp_Object specified_time, Lisp_Object zone)
2156 time_t time_spec = lisp_seconds_argument (specified_time);
2157 struct tm local_tm, gmt_tm;
2158 timezone_t tz = tzlookup (zone, false);
2159 struct tm *tm = emacs_localtime_rz (tz, &time_spec, &local_tm);
2160 xtzfree (tz);
2162 if (! (tm
2163 && MOST_NEGATIVE_FIXNUM - TM_YEAR_BASE <= local_tm.tm_year
2164 && local_tm.tm_year <= MOST_POSITIVE_FIXNUM - TM_YEAR_BASE))
2165 time_overflow ();
2167 /* Avoid overflow when INT_MAX < EMACS_INT_MAX. */
2168 EMACS_INT tm_year_base = TM_YEAR_BASE;
2170 return CALLN (Flist,
2171 make_number (local_tm.tm_sec),
2172 make_number (local_tm.tm_min),
2173 make_number (local_tm.tm_hour),
2174 make_number (local_tm.tm_mday),
2175 make_number (local_tm.tm_mon + 1),
2176 make_number (local_tm.tm_year + tm_year_base),
2177 make_number (local_tm.tm_wday),
2178 local_tm.tm_isdst ? Qt : Qnil,
2179 (HAVE_TM_GMTOFF
2180 ? make_number (tm_gmtoff (&local_tm))
2181 : gmtime_r (&time_spec, &gmt_tm)
2182 ? make_number (tm_diff (&local_tm, &gmt_tm))
2183 : Qnil));
2186 /* Return OBJ - OFFSET, checking that OBJ is a valid fixnum and that
2187 the result is representable as an int. */
2188 static int
2189 check_tm_member (Lisp_Object obj, int offset)
2191 CHECK_NUMBER (obj);
2192 EMACS_INT n = XINT (obj);
2193 int result;
2194 if (INT_SUBTRACT_WRAPV (n, offset, &result))
2195 time_overflow ();
2196 return result;
2199 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
2200 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
2201 This is the reverse operation of `decode-time', which see.
2203 The optional ZONE is omitted or nil for Emacs local time, t for
2204 Universal Time, `wall' for system wall clock time, or a string as in
2205 the TZ environment variable. It can also be a list (as from
2206 `current-time-zone') or an integer (as from `decode-time') applied
2207 without consideration for daylight saving time.
2209 You can pass more than 7 arguments; then the first six arguments
2210 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
2211 The intervening arguments are ignored.
2212 This feature lets (apply \\='encode-time (decode-time ...)) work.
2214 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
2215 for example, a DAY of 0 means the day preceding the given month.
2216 Year numbers less than 100 are treated just like other year numbers.
2217 If you want them to stand for years in this century, you must do that yourself.
2219 Years before 1970 are not guaranteed to work. On some systems,
2220 year values as low as 1901 do work.
2222 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
2223 (ptrdiff_t nargs, Lisp_Object *args)
2225 time_t value;
2226 struct tm tm;
2227 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
2229 tm.tm_sec = check_tm_member (args[0], 0);
2230 tm.tm_min = check_tm_member (args[1], 0);
2231 tm.tm_hour = check_tm_member (args[2], 0);
2232 tm.tm_mday = check_tm_member (args[3], 0);
2233 tm.tm_mon = check_tm_member (args[4], 1);
2234 tm.tm_year = check_tm_member (args[5], TM_YEAR_BASE);
2235 tm.tm_isdst = -1;
2237 timezone_t tz = tzlookup (zone, false);
2238 value = emacs_mktime_z (tz, &tm);
2239 xtzfree (tz);
2241 if (value == (time_t) -1)
2242 time_overflow ();
2244 return list2i (hi_time (value), lo_time (value));
2247 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string,
2248 0, 2, 0,
2249 doc: /* Return the current local time, as a human-readable string.
2250 Programs can use this function to decode a time,
2251 since the number of columns in each field is fixed
2252 if the year is in the range 1000-9999.
2253 The format is `Sun Sep 16 01:03:52 1973'.
2254 However, see also the functions `decode-time' and `format-time-string'
2255 which provide a much more powerful and general facility.
2257 If SPECIFIED-TIME is given, it is a time to format instead of the
2258 current time. The argument should have the form (HIGH LOW . IGNORED).
2259 Thus, you can use times obtained from `current-time' and from
2260 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
2261 but this is considered obsolete.
2263 The optional ZONE is omitted or nil for Emacs local time, t for
2264 Universal Time, `wall' for system wall clock time, or a string as in
2265 the TZ environment variable. It can also be a list (as from
2266 `current-time-zone') or an integer (as from `decode-time') applied
2267 without consideration for daylight saving time. */)
2268 (Lisp_Object specified_time, Lisp_Object zone)
2270 time_t value = lisp_seconds_argument (specified_time);
2271 timezone_t tz = tzlookup (zone, false);
2273 /* Convert to a string in ctime format, except without the trailing
2274 newline, and without the 4-digit year limit. Don't use asctime
2275 or ctime, as they might dump core if the year is outside the
2276 range -999 .. 9999. */
2277 struct tm tm;
2278 struct tm *tmp = emacs_localtime_rz (tz, &value, &tm);
2279 xtzfree (tz);
2280 if (! tmp)
2281 time_overflow ();
2283 static char const wday_name[][4] =
2284 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
2285 static char const mon_name[][4] =
2286 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
2287 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
2288 printmax_t year_base = TM_YEAR_BASE;
2289 char buf[sizeof "Mon Apr 30 12:49:17 " + INT_STRLEN_BOUND (int) + 1];
2290 int len = sprintf (buf, "%s %s%3d %02d:%02d:%02d %"pMd,
2291 wday_name[tm.tm_wday], mon_name[tm.tm_mon], tm.tm_mday,
2292 tm.tm_hour, tm.tm_min, tm.tm_sec,
2293 tm.tm_year + year_base);
2295 return make_unibyte_string (buf, len);
2298 /* Yield A - B, measured in seconds.
2299 This function is copied from the GNU C Library. */
2300 static int
2301 tm_diff (struct tm *a, struct tm *b)
2303 /* Compute intervening leap days correctly even if year is negative.
2304 Take care to avoid int overflow in leap day calculations,
2305 but it's OK to assume that A and B are close to each other. */
2306 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
2307 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
2308 int a100 = a4 / 25 - (a4 % 25 < 0);
2309 int b100 = b4 / 25 - (b4 % 25 < 0);
2310 int a400 = a100 >> 2;
2311 int b400 = b100 >> 2;
2312 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
2313 int years = a->tm_year - b->tm_year;
2314 int days = (365 * years + intervening_leap_days
2315 + (a->tm_yday - b->tm_yday));
2316 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
2317 + (a->tm_min - b->tm_min))
2318 + (a->tm_sec - b->tm_sec));
2321 /* Yield A's UTC offset, or an unspecified value if unknown. */
2322 static long int
2323 tm_gmtoff (struct tm *a)
2325 #if HAVE_TM_GMTOFF
2326 return a->tm_gmtoff;
2327 #else
2328 return 0;
2329 #endif
2332 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 2, 0,
2333 doc: /* Return the offset and name for the local time zone.
2334 This returns a list of the form (OFFSET NAME).
2335 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
2336 A negative value means west of Greenwich.
2337 NAME is a string giving the name of the time zone.
2338 If SPECIFIED-TIME is given, the time zone offset is determined from it
2339 instead of using the current time. The argument should have the form
2340 \(HIGH LOW . IGNORED). Thus, you can use times obtained from
2341 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
2342 have the form (HIGH . LOW), but this is considered obsolete.
2344 The optional ZONE is omitted or nil for Emacs local time, t for
2345 Universal Time, `wall' for system wall clock time, or a string as in
2346 the TZ environment variable. It can also be a list (as from
2347 `current-time-zone') or an integer (as from `decode-time') applied
2348 without consideration for daylight saving time.
2350 Some operating systems cannot provide all this information to Emacs;
2351 in this case, `current-time-zone' returns a list containing nil for
2352 the data it can't find. */)
2353 (Lisp_Object specified_time, Lisp_Object zone)
2355 struct timespec value;
2356 struct tm local_tm, gmt_tm;
2357 Lisp_Object zone_offset, zone_name;
2359 zone_offset = Qnil;
2360 value = make_timespec (lisp_seconds_argument (specified_time), 0);
2361 zone_name = format_time_string ("%Z", sizeof "%Z" - 1, value,
2362 zone, &local_tm);
2364 if (HAVE_TM_GMTOFF || gmtime_r (&value.tv_sec, &gmt_tm))
2366 long int offset = (HAVE_TM_GMTOFF
2367 ? tm_gmtoff (&local_tm)
2368 : tm_diff (&local_tm, &gmt_tm));
2369 zone_offset = make_number (offset);
2370 if (SCHARS (zone_name) == 0)
2372 /* No local time zone name is available; use numeric zone instead. */
2373 long int hour = offset / 3600;
2374 int min_sec = offset % 3600;
2375 int amin_sec = min_sec < 0 ? - min_sec : min_sec;
2376 int min = amin_sec / 60;
2377 int sec = amin_sec % 60;
2378 int min_prec = min_sec ? 2 : 0;
2379 int sec_prec = sec ? 2 : 0;
2380 char buf[sizeof "+0000" + INT_STRLEN_BOUND (long int)];
2381 zone_name = make_formatted_string (buf, "%c%.2ld%.*d%.*d",
2382 (offset < 0 ? '-' : '+'),
2383 hour, min_prec, min, sec_prec, sec);
2387 return list2 (zone_offset, zone_name);
2390 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
2391 doc: /* Set the Emacs local time zone using TZ, a string specifying a time zone rule.
2392 If TZ is nil or `wall', use system wall clock time; this differs from
2393 the usual Emacs convention where nil means current local time. If TZ
2394 is t, use Universal Time. If TZ is a list (as from
2395 `current-time-zone') or an integer (as from `decode-time'), use the
2396 specified time zone without consideration for daylight saving time.
2398 Instead of calling this function, you typically want something else.
2399 To temporarily use a different time zone rule for just one invocation
2400 of `decode-time', `encode-time', or `format-time-string', pass the
2401 function a ZONE argument. To change local time consistently
2402 throughout Emacs, call (setenv "TZ" TZ): this changes both the
2403 environment of the Emacs process and the variable
2404 `process-environment', whereas `set-time-zone-rule' affects only the
2405 former. */)
2406 (Lisp_Object tz)
2408 tzlookup (NILP (tz) ? Qwall : tz, true);
2409 return Qnil;
2412 /* A buffer holding a string of the form "TZ=value", intended
2413 to be part of the environment. If TZ is supposed to be unset,
2414 the buffer string is "tZ=". */
2415 static char *tzvalbuf;
2417 /* Get the local time zone rule. */
2418 char *
2419 emacs_getenv_TZ (void)
2421 return tzvalbuf[0] == 'T' ? tzvalbuf + tzeqlen : 0;
2424 /* Set the local time zone rule to TZSTRING, which can be null to
2425 denote wall clock time. Do not record the setting in LOCAL_TZ.
2427 This function is not thread-safe, in theory because putenv is not,
2428 but mostly because of the static storage it updates. Other threads
2429 that invoke localtime etc. may be adversely affected while this
2430 function is executing. */
2433 emacs_setenv_TZ (const char *tzstring)
2435 static ptrdiff_t tzvalbufsize;
2436 ptrdiff_t tzstringlen = tzstring ? strlen (tzstring) : 0;
2437 char *tzval = tzvalbuf;
2438 bool new_tzvalbuf = tzvalbufsize <= tzeqlen + tzstringlen;
2440 if (new_tzvalbuf)
2442 /* Do not attempt to free the old tzvalbuf, since another thread
2443 may be using it. In practice, the first allocation is large
2444 enough and memory does not leak. */
2445 tzval = xpalloc (NULL, &tzvalbufsize,
2446 tzeqlen + tzstringlen - tzvalbufsize + 1, -1, 1);
2447 tzvalbuf = tzval;
2448 tzval[1] = 'Z';
2449 tzval[2] = '=';
2452 if (tzstring)
2454 /* Modify TZVAL in place. Although this is dicey in a
2455 multithreaded environment, we know of no portable alternative.
2456 Calling putenv or setenv could crash some other thread. */
2457 tzval[0] = 'T';
2458 strcpy (tzval + tzeqlen, tzstring);
2460 else
2462 /* Turn 'TZ=whatever' into an empty environment variable 'tZ='.
2463 Although this is also dicey, calling unsetenv here can crash Emacs.
2464 See Bug#8705. */
2465 tzval[0] = 't';
2466 tzval[tzeqlen] = 0;
2470 #ifndef WINDOWSNT
2471 /* Modifying *TZVAL merely requires calling tzset (which is the
2472 caller's responsibility). However, modifying TZVAL requires
2473 calling putenv; although this is not thread-safe, in practice this
2474 runs only on startup when there is only one thread. */
2475 bool need_putenv = new_tzvalbuf;
2476 #else
2477 /* MS-Windows 'putenv' copies the argument string into a block it
2478 allocates, so modifying *TZVAL will not change the environment.
2479 However, the other threads run by Emacs on MS-Windows never call
2480 'xputenv' or 'putenv' or 'unsetenv', so the original cause for the
2481 dicey in-place modification technique doesn't exist there in the
2482 first place. */
2483 bool need_putenv = true;
2484 #endif
2485 if (need_putenv)
2486 xputenv (tzval);
2488 return 0;
2491 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2492 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2493 type of object is Lisp_String). INHERIT is passed to
2494 INSERT_FROM_STRING_FUNC as the last argument. */
2496 static void
2497 general_insert_function (void (*insert_func)
2498 (const char *, ptrdiff_t),
2499 void (*insert_from_string_func)
2500 (Lisp_Object, ptrdiff_t, ptrdiff_t,
2501 ptrdiff_t, ptrdiff_t, bool),
2502 bool inherit, ptrdiff_t nargs, Lisp_Object *args)
2504 ptrdiff_t argnum;
2505 Lisp_Object val;
2507 for (argnum = 0; argnum < nargs; argnum++)
2509 val = args[argnum];
2510 if (CHARACTERP (val))
2512 int c = XFASTINT (val);
2513 unsigned char str[MAX_MULTIBYTE_LENGTH];
2514 int len;
2516 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
2517 len = CHAR_STRING (c, str);
2518 else
2520 str[0] = CHAR_TO_BYTE8 (c);
2521 len = 1;
2523 (*insert_func) ((char *) str, len);
2525 else if (STRINGP (val))
2527 (*insert_from_string_func) (val, 0, 0,
2528 SCHARS (val),
2529 SBYTES (val),
2530 inherit);
2532 else
2533 wrong_type_argument (Qchar_or_string_p, val);
2537 void
2538 insert1 (Lisp_Object arg)
2540 Finsert (1, &arg);
2544 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2545 doc: /* Insert the arguments, either strings or characters, at point.
2546 Point and after-insertion markers move forward to end up
2547 after the inserted text.
2548 Any other markers at the point of insertion remain before the text.
2550 If the current buffer is multibyte, unibyte strings are converted
2551 to multibyte for insertion (see `string-make-multibyte').
2552 If the current buffer is unibyte, multibyte strings are converted
2553 to unibyte for insertion (see `string-make-unibyte').
2555 When operating on binary data, it may be necessary to preserve the
2556 original bytes of a unibyte string when inserting it into a multibyte
2557 buffer; to accomplish this, apply `string-as-multibyte' to the string
2558 and insert the result.
2560 usage: (insert &rest ARGS) */)
2561 (ptrdiff_t nargs, Lisp_Object *args)
2563 general_insert_function (insert, insert_from_string, 0, nargs, args);
2564 return Qnil;
2567 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2568 0, MANY, 0,
2569 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2570 Point and after-insertion markers move forward to end up
2571 after the inserted text.
2572 Any other markers at the point of insertion remain before the text.
2574 If the current buffer is multibyte, unibyte strings are converted
2575 to multibyte for insertion (see `unibyte-char-to-multibyte').
2576 If the current buffer is unibyte, multibyte strings are converted
2577 to unibyte for insertion.
2579 usage: (insert-and-inherit &rest ARGS) */)
2580 (ptrdiff_t nargs, Lisp_Object *args)
2582 general_insert_function (insert_and_inherit, insert_from_string, 1,
2583 nargs, args);
2584 return Qnil;
2587 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2588 doc: /* Insert strings or characters at point, relocating markers after the text.
2589 Point and markers move forward to end up after the inserted text.
2591 If the current buffer is multibyte, unibyte strings are converted
2592 to multibyte for insertion (see `unibyte-char-to-multibyte').
2593 If the current buffer is unibyte, multibyte strings are converted
2594 to unibyte for insertion.
2596 If an overlay begins at the insertion point, the inserted text falls
2597 outside the overlay; if a nonempty overlay ends at the insertion
2598 point, the inserted text falls inside that overlay.
2600 usage: (insert-before-markers &rest ARGS) */)
2601 (ptrdiff_t nargs, Lisp_Object *args)
2603 general_insert_function (insert_before_markers,
2604 insert_from_string_before_markers, 0,
2605 nargs, args);
2606 return Qnil;
2609 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2610 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2611 doc: /* Insert text at point, relocating markers and inheriting properties.
2612 Point and markers move forward to end up after the inserted text.
2614 If the current buffer is multibyte, unibyte strings are converted
2615 to multibyte for insertion (see `unibyte-char-to-multibyte').
2616 If the current buffer is unibyte, multibyte strings are converted
2617 to unibyte for insertion.
2619 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2620 (ptrdiff_t nargs, Lisp_Object *args)
2622 general_insert_function (insert_before_markers_and_inherit,
2623 insert_from_string_before_markers, 1,
2624 nargs, args);
2625 return Qnil;
2628 DEFUN ("insert-char", Finsert_char, Sinsert_char, 1, 3,
2629 "(list (read-char-by-name \"Insert character (Unicode name or hex): \")\
2630 (prefix-numeric-value current-prefix-arg)\
2631 t))",
2632 doc: /* Insert COUNT copies of CHARACTER.
2633 Interactively, prompt for CHARACTER. You can specify CHARACTER in one
2634 of these ways:
2636 - As its Unicode character name, e.g. \"LATIN SMALL LETTER A\".
2637 Completion is available; if you type a substring of the name
2638 preceded by an asterisk `*', Emacs shows all names which include
2639 that substring, not necessarily at the beginning of the name.
2641 - As a hexadecimal code point, e.g. 263A. Note that code points in
2642 Emacs are equivalent to Unicode up to 10FFFF (which is the limit of
2643 the Unicode code space).
2645 - As a code point with a radix specified with #, e.g. #o21430
2646 (octal), #x2318 (hex), or #10r8984 (decimal).
2648 If called interactively, COUNT is given by the prefix argument. If
2649 omitted or nil, it defaults to 1.
2651 Inserting the character(s) relocates point and before-insertion
2652 markers in the same ways as the function `insert'.
2654 The optional third argument INHERIT, if non-nil, says to inherit text
2655 properties from adjoining text, if those properties are sticky. If
2656 called interactively, INHERIT is t. */)
2657 (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
2659 int i, stringlen;
2660 register ptrdiff_t n;
2661 int c, len;
2662 unsigned char str[MAX_MULTIBYTE_LENGTH];
2663 char string[4000];
2665 CHECK_CHARACTER (character);
2666 if (NILP (count))
2667 XSETFASTINT (count, 1);
2668 CHECK_NUMBER (count);
2669 c = XFASTINT (character);
2671 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
2672 len = CHAR_STRING (c, str);
2673 else
2674 str[0] = c, len = 1;
2675 if (XINT (count) <= 0)
2676 return Qnil;
2677 if (BUF_BYTES_MAX / len < XINT (count))
2678 buffer_overflow ();
2679 n = XINT (count) * len;
2680 stringlen = min (n, sizeof string - sizeof string % len);
2681 for (i = 0; i < stringlen; i++)
2682 string[i] = str[i % len];
2683 while (n > stringlen)
2685 QUIT;
2686 if (!NILP (inherit))
2687 insert_and_inherit (string, stringlen);
2688 else
2689 insert (string, stringlen);
2690 n -= stringlen;
2692 if (!NILP (inherit))
2693 insert_and_inherit (string, n);
2694 else
2695 insert (string, n);
2696 return Qnil;
2699 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2700 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2701 Both arguments are required.
2702 BYTE is a number of the range 0..255.
2704 If BYTE is 128..255 and the current buffer is multibyte, the
2705 corresponding eight-bit character is inserted.
2707 Point, and before-insertion markers, are relocated as in the function `insert'.
2708 The optional third arg INHERIT, if non-nil, says to inherit text properties
2709 from adjoining text, if those properties are sticky. */)
2710 (Lisp_Object byte, Lisp_Object count, Lisp_Object inherit)
2712 CHECK_NUMBER (byte);
2713 if (XINT (byte) < 0 || XINT (byte) > 255)
2714 args_out_of_range_3 (byte, make_number (0), make_number (255));
2715 if (XINT (byte) >= 128
2716 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2717 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2718 return Finsert_char (byte, count, inherit);
2722 /* Making strings from buffer contents. */
2724 /* Return a Lisp_String containing the text of the current buffer from
2725 START to END. If text properties are in use and the current buffer
2726 has properties in the range specified, the resulting string will also
2727 have them, if PROPS is true.
2729 We don't want to use plain old make_string here, because it calls
2730 make_uninit_string, which can cause the buffer arena to be
2731 compacted. make_string has no way of knowing that the data has
2732 been moved, and thus copies the wrong data into the string. This
2733 doesn't effect most of the other users of make_string, so it should
2734 be left as is. But we should use this function when conjuring
2735 buffer substrings. */
2737 Lisp_Object
2738 make_buffer_string (ptrdiff_t start, ptrdiff_t end, bool props)
2740 ptrdiff_t start_byte = CHAR_TO_BYTE (start);
2741 ptrdiff_t end_byte = CHAR_TO_BYTE (end);
2743 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2746 /* Return a Lisp_String containing the text of the current buffer from
2747 START / START_BYTE to END / END_BYTE.
2749 If text properties are in use and the current buffer
2750 has properties in the range specified, the resulting string will also
2751 have them, if PROPS is true.
2753 We don't want to use plain old make_string here, because it calls
2754 make_uninit_string, which can cause the buffer arena to be
2755 compacted. make_string has no way of knowing that the data has
2756 been moved, and thus copies the wrong data into the string. This
2757 doesn't effect most of the other users of make_string, so it should
2758 be left as is. But we should use this function when conjuring
2759 buffer substrings. */
2761 Lisp_Object
2762 make_buffer_string_both (ptrdiff_t start, ptrdiff_t start_byte,
2763 ptrdiff_t end, ptrdiff_t end_byte, bool props)
2765 Lisp_Object result, tem, tem1;
2766 ptrdiff_t beg0, end0, beg1, end1, size;
2768 if (start_byte < GPT_BYTE && GPT_BYTE < end_byte)
2770 /* Two regions, before and after the gap. */
2771 beg0 = start_byte;
2772 end0 = GPT_BYTE;
2773 beg1 = GPT_BYTE + GAP_SIZE - BEG_BYTE;
2774 end1 = end_byte + GAP_SIZE - BEG_BYTE;
2776 else
2778 /* The only region. */
2779 beg0 = start_byte;
2780 end0 = end_byte;
2781 beg1 = -1;
2782 end1 = -1;
2785 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2786 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2787 else
2788 result = make_uninit_string (end - start);
2790 size = end0 - beg0;
2791 memcpy (SDATA (result), BYTE_POS_ADDR (beg0), size);
2792 if (beg1 != -1)
2793 memcpy (SDATA (result) + size, BEG_ADDR + beg1, end1 - beg1);
2795 /* If desired, update and copy the text properties. */
2796 if (props)
2798 update_buffer_properties (start, end);
2800 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2801 tem1 = Ftext_properties_at (make_number (start), Qnil);
2803 if (XINT (tem) != end || !NILP (tem1))
2804 copy_intervals_to_string (result, current_buffer, start,
2805 end - start);
2808 return result;
2811 /* Call Vbuffer_access_fontify_functions for the range START ... END
2812 in the current buffer, if necessary. */
2814 static void
2815 update_buffer_properties (ptrdiff_t start, ptrdiff_t end)
2817 /* If this buffer has some access functions,
2818 call them, specifying the range of the buffer being accessed. */
2819 if (!NILP (Vbuffer_access_fontify_functions))
2821 /* But don't call them if we can tell that the work
2822 has already been done. */
2823 if (!NILP (Vbuffer_access_fontified_property))
2825 Lisp_Object tem
2826 = Ftext_property_any (make_number (start), make_number (end),
2827 Vbuffer_access_fontified_property,
2828 Qnil, Qnil);
2829 if (NILP (tem))
2830 return;
2833 CALLN (Frun_hook_with_args, Qbuffer_access_fontify_functions,
2834 make_number (start), make_number (end));
2838 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2839 doc: /* Return the contents of part of the current buffer as a string.
2840 The two arguments START and END are character positions;
2841 they can be in either order.
2842 The string returned is multibyte if the buffer is multibyte.
2844 This function copies the text properties of that part of the buffer
2845 into the result string; if you don't want the text properties,
2846 use `buffer-substring-no-properties' instead. */)
2847 (Lisp_Object start, Lisp_Object end)
2849 register ptrdiff_t b, e;
2851 validate_region (&start, &end);
2852 b = XINT (start);
2853 e = XINT (end);
2855 return make_buffer_string (b, e, 1);
2858 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2859 Sbuffer_substring_no_properties, 2, 2, 0,
2860 doc: /* Return the characters of part of the buffer, without the text properties.
2861 The two arguments START and END are character positions;
2862 they can be in either order. */)
2863 (Lisp_Object start, Lisp_Object end)
2865 register ptrdiff_t b, e;
2867 validate_region (&start, &end);
2868 b = XINT (start);
2869 e = XINT (end);
2871 return make_buffer_string (b, e, 0);
2874 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2875 doc: /* Return the contents of the current buffer as a string.
2876 If narrowing is in effect, this function returns only the visible part
2877 of the buffer. */)
2878 (void)
2880 return make_buffer_string_both (BEGV, BEGV_BYTE, ZV, ZV_BYTE, 1);
2883 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2884 1, 3, 0,
2885 doc: /* Insert before point a substring of the contents of BUFFER.
2886 BUFFER may be a buffer or a buffer name.
2887 Arguments START and END are character positions specifying the substring.
2888 They default to the values of (point-min) and (point-max) in BUFFER.
2890 Point and before-insertion markers move forward to end up after the
2891 inserted text.
2892 Any other markers at the point of insertion remain before the text.
2894 If the current buffer is multibyte and BUFFER is unibyte, or vice
2895 versa, strings are converted from unibyte to multibyte or vice versa
2896 using `string-make-multibyte' or `string-make-unibyte', which see. */)
2897 (Lisp_Object buffer, Lisp_Object start, Lisp_Object end)
2899 register EMACS_INT b, e, temp;
2900 register struct buffer *bp, *obuf;
2901 Lisp_Object buf;
2903 buf = Fget_buffer (buffer);
2904 if (NILP (buf))
2905 nsberror (buffer);
2906 bp = XBUFFER (buf);
2907 if (!BUFFER_LIVE_P (bp))
2908 error ("Selecting deleted buffer");
2910 if (NILP (start))
2911 b = BUF_BEGV (bp);
2912 else
2914 CHECK_NUMBER_COERCE_MARKER (start);
2915 b = XINT (start);
2917 if (NILP (end))
2918 e = BUF_ZV (bp);
2919 else
2921 CHECK_NUMBER_COERCE_MARKER (end);
2922 e = XINT (end);
2925 if (b > e)
2926 temp = b, b = e, e = temp;
2928 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2929 args_out_of_range (start, end);
2931 obuf = current_buffer;
2932 set_buffer_internal_1 (bp);
2933 update_buffer_properties (b, e);
2934 set_buffer_internal_1 (obuf);
2936 insert_from_buffer (bp, b, e - b, 0);
2937 return Qnil;
2940 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2941 6, 6, 0,
2942 doc: /* Compare two substrings of two buffers; return result as number.
2943 Return -N if first string is less after N-1 chars, +N if first string is
2944 greater after N-1 chars, or 0 if strings match.
2945 The first substring is in BUFFER1 from START1 to END1 and the second
2946 is in BUFFER2 from START2 to END2.
2947 The value of `case-fold-search' in the current buffer
2948 determines whether case is significant or ignored. */)
2949 (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)
2951 register EMACS_INT begp1, endp1, begp2, endp2, temp;
2952 register struct buffer *bp1, *bp2;
2953 register Lisp_Object trt
2954 = (!NILP (BVAR (current_buffer, case_fold_search))
2955 ? BVAR (current_buffer, case_canon_table) : Qnil);
2956 ptrdiff_t chars = 0;
2957 ptrdiff_t i1, i2, i1_byte, i2_byte;
2959 /* Find the first buffer and its substring. */
2961 if (NILP (buffer1))
2962 bp1 = current_buffer;
2963 else
2965 Lisp_Object buf1;
2966 buf1 = Fget_buffer (buffer1);
2967 if (NILP (buf1))
2968 nsberror (buffer1);
2969 bp1 = XBUFFER (buf1);
2970 if (!BUFFER_LIVE_P (bp1))
2971 error ("Selecting deleted buffer");
2974 if (NILP (start1))
2975 begp1 = BUF_BEGV (bp1);
2976 else
2978 CHECK_NUMBER_COERCE_MARKER (start1);
2979 begp1 = XINT (start1);
2981 if (NILP (end1))
2982 endp1 = BUF_ZV (bp1);
2983 else
2985 CHECK_NUMBER_COERCE_MARKER (end1);
2986 endp1 = XINT (end1);
2989 if (begp1 > endp1)
2990 temp = begp1, begp1 = endp1, endp1 = temp;
2992 if (!(BUF_BEGV (bp1) <= begp1
2993 && begp1 <= endp1
2994 && endp1 <= BUF_ZV (bp1)))
2995 args_out_of_range (start1, end1);
2997 /* Likewise for second substring. */
2999 if (NILP (buffer2))
3000 bp2 = current_buffer;
3001 else
3003 Lisp_Object buf2;
3004 buf2 = Fget_buffer (buffer2);
3005 if (NILP (buf2))
3006 nsberror (buffer2);
3007 bp2 = XBUFFER (buf2);
3008 if (!BUFFER_LIVE_P (bp2))
3009 error ("Selecting deleted buffer");
3012 if (NILP (start2))
3013 begp2 = BUF_BEGV (bp2);
3014 else
3016 CHECK_NUMBER_COERCE_MARKER (start2);
3017 begp2 = XINT (start2);
3019 if (NILP (end2))
3020 endp2 = BUF_ZV (bp2);
3021 else
3023 CHECK_NUMBER_COERCE_MARKER (end2);
3024 endp2 = XINT (end2);
3027 if (begp2 > endp2)
3028 temp = begp2, begp2 = endp2, endp2 = temp;
3030 if (!(BUF_BEGV (bp2) <= begp2
3031 && begp2 <= endp2
3032 && endp2 <= BUF_ZV (bp2)))
3033 args_out_of_range (start2, end2);
3035 i1 = begp1;
3036 i2 = begp2;
3037 i1_byte = buf_charpos_to_bytepos (bp1, i1);
3038 i2_byte = buf_charpos_to_bytepos (bp2, i2);
3040 while (i1 < endp1 && i2 < endp2)
3042 /* When we find a mismatch, we must compare the
3043 characters, not just the bytes. */
3044 int c1, c2;
3046 QUIT;
3048 if (! NILP (BVAR (bp1, enable_multibyte_characters)))
3050 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
3051 BUF_INC_POS (bp1, i1_byte);
3052 i1++;
3054 else
3056 c1 = BUF_FETCH_BYTE (bp1, i1);
3057 MAKE_CHAR_MULTIBYTE (c1);
3058 i1++;
3061 if (! NILP (BVAR (bp2, enable_multibyte_characters)))
3063 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
3064 BUF_INC_POS (bp2, i2_byte);
3065 i2++;
3067 else
3069 c2 = BUF_FETCH_BYTE (bp2, i2);
3070 MAKE_CHAR_MULTIBYTE (c2);
3071 i2++;
3074 if (!NILP (trt))
3076 c1 = char_table_translate (trt, c1);
3077 c2 = char_table_translate (trt, c2);
3079 if (c1 < c2)
3080 return make_number (- 1 - chars);
3081 if (c1 > c2)
3082 return make_number (chars + 1);
3084 chars++;
3087 /* The strings match as far as they go.
3088 If one is shorter, that one is less. */
3089 if (chars < endp1 - begp1)
3090 return make_number (chars + 1);
3091 else if (chars < endp2 - begp2)
3092 return make_number (- chars - 1);
3094 /* Same length too => they are equal. */
3095 return make_number (0);
3098 static void
3099 subst_char_in_region_unwind (Lisp_Object arg)
3101 bset_undo_list (current_buffer, arg);
3104 static void
3105 subst_char_in_region_unwind_1 (Lisp_Object arg)
3107 bset_filename (current_buffer, arg);
3110 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
3111 Ssubst_char_in_region, 4, 5, 0,
3112 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
3113 If optional arg NOUNDO is non-nil, don't record this change for undo
3114 and don't mark the buffer as really changed.
3115 Both characters must have the same length of multi-byte form. */)
3116 (Lisp_Object start, Lisp_Object end, Lisp_Object fromchar, Lisp_Object tochar, Lisp_Object noundo)
3118 register ptrdiff_t pos, pos_byte, stop, i, len, end_byte;
3119 /* Keep track of the first change in the buffer:
3120 if 0 we haven't found it yet.
3121 if < 0 we've found it and we've run the before-change-function.
3122 if > 0 we've actually performed it and the value is its position. */
3123 ptrdiff_t changed = 0;
3124 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
3125 unsigned char *p;
3126 ptrdiff_t count = SPECPDL_INDEX ();
3127 #define COMBINING_NO 0
3128 #define COMBINING_BEFORE 1
3129 #define COMBINING_AFTER 2
3130 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
3131 int maybe_byte_combining = COMBINING_NO;
3132 ptrdiff_t last_changed = 0;
3133 bool multibyte_p
3134 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
3135 int fromc, toc;
3137 restart:
3139 validate_region (&start, &end);
3140 CHECK_CHARACTER (fromchar);
3141 CHECK_CHARACTER (tochar);
3142 fromc = XFASTINT (fromchar);
3143 toc = XFASTINT (tochar);
3145 if (multibyte_p)
3147 len = CHAR_STRING (fromc, fromstr);
3148 if (CHAR_STRING (toc, tostr) != len)
3149 error ("Characters in `subst-char-in-region' have different byte-lengths");
3150 if (!ASCII_CHAR_P (*tostr))
3152 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
3153 complete multibyte character, it may be combined with the
3154 after bytes. If it is in the range 0xA0..0xFF, it may be
3155 combined with the before and after bytes. */
3156 if (!CHAR_HEAD_P (*tostr))
3157 maybe_byte_combining = COMBINING_BOTH;
3158 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
3159 maybe_byte_combining = COMBINING_AFTER;
3162 else
3164 len = 1;
3165 fromstr[0] = fromc;
3166 tostr[0] = toc;
3169 pos = XINT (start);
3170 pos_byte = CHAR_TO_BYTE (pos);
3171 stop = CHAR_TO_BYTE (XINT (end));
3172 end_byte = stop;
3174 /* If we don't want undo, turn off putting stuff on the list.
3175 That's faster than getting rid of things,
3176 and it prevents even the entry for a first change.
3177 Also inhibit locking the file. */
3178 if (!changed && !NILP (noundo))
3180 record_unwind_protect (subst_char_in_region_unwind,
3181 BVAR (current_buffer, undo_list));
3182 bset_undo_list (current_buffer, Qt);
3183 /* Don't do file-locking. */
3184 record_unwind_protect (subst_char_in_region_unwind_1,
3185 BVAR (current_buffer, filename));
3186 bset_filename (current_buffer, Qnil);
3189 if (pos_byte < GPT_BYTE)
3190 stop = min (stop, GPT_BYTE);
3191 while (1)
3193 ptrdiff_t pos_byte_next = pos_byte;
3195 if (pos_byte >= stop)
3197 if (pos_byte >= end_byte) break;
3198 stop = end_byte;
3200 p = BYTE_POS_ADDR (pos_byte);
3201 if (multibyte_p)
3202 INC_POS (pos_byte_next);
3203 else
3204 ++pos_byte_next;
3205 if (pos_byte_next - pos_byte == len
3206 && p[0] == fromstr[0]
3207 && (len == 1
3208 || (p[1] == fromstr[1]
3209 && (len == 2 || (p[2] == fromstr[2]
3210 && (len == 3 || p[3] == fromstr[3]))))))
3212 if (changed < 0)
3213 /* We've already seen this and run the before-change-function;
3214 this time we only need to record the actual position. */
3215 changed = pos;
3216 else if (!changed)
3218 changed = -1;
3219 modify_text (pos, XINT (end));
3221 if (! NILP (noundo))
3223 if (MODIFF - 1 == SAVE_MODIFF)
3224 SAVE_MODIFF++;
3225 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
3226 BUF_AUTOSAVE_MODIFF (current_buffer)++;
3229 /* The before-change-function may have moved the gap
3230 or even modified the buffer so we should start over. */
3231 goto restart;
3234 /* Take care of the case where the new character
3235 combines with neighboring bytes. */
3236 if (maybe_byte_combining
3237 && (maybe_byte_combining == COMBINING_AFTER
3238 ? (pos_byte_next < Z_BYTE
3239 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
3240 : ((pos_byte_next < Z_BYTE
3241 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
3242 || (pos_byte > BEG_BYTE
3243 && ! ASCII_CHAR_P (FETCH_BYTE (pos_byte - 1))))))
3245 Lisp_Object tem, string;
3247 tem = BVAR (current_buffer, undo_list);
3249 /* Make a multibyte string containing this single character. */
3250 string = make_multibyte_string ((char *) tostr, 1, len);
3251 /* replace_range is less efficient, because it moves the gap,
3252 but it handles combining correctly. */
3253 replace_range (pos, pos + 1, string,
3254 0, 0, 1, 0);
3255 pos_byte_next = CHAR_TO_BYTE (pos);
3256 if (pos_byte_next > pos_byte)
3257 /* Before combining happened. We should not increment
3258 POS. So, to cancel the later increment of POS,
3259 decrease it now. */
3260 pos--;
3261 else
3262 INC_POS (pos_byte_next);
3264 if (! NILP (noundo))
3265 bset_undo_list (current_buffer, tem);
3267 else
3269 if (NILP (noundo))
3270 record_change (pos, 1);
3271 for (i = 0; i < len; i++) *p++ = tostr[i];
3273 last_changed = pos + 1;
3275 pos_byte = pos_byte_next;
3276 pos++;
3279 if (changed > 0)
3281 signal_after_change (changed,
3282 last_changed - changed, last_changed - changed);
3283 update_compositions (changed, last_changed, CHECK_ALL);
3286 unbind_to (count, Qnil);
3287 return Qnil;
3291 static Lisp_Object check_translation (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3292 Lisp_Object);
3294 /* Helper function for Ftranslate_region_internal.
3296 Check if a character sequence at POS (POS_BYTE) matches an element
3297 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
3298 element is found, return it. Otherwise return Qnil. */
3300 static Lisp_Object
3301 check_translation (ptrdiff_t pos, ptrdiff_t pos_byte, ptrdiff_t end,
3302 Lisp_Object val)
3304 int initial_buf[16];
3305 int *buf = initial_buf;
3306 ptrdiff_t buf_size = ARRAYELTS (initial_buf);
3307 int *bufalloc = 0;
3308 ptrdiff_t buf_used = 0;
3309 Lisp_Object result = Qnil;
3311 for (; CONSP (val); val = XCDR (val))
3313 Lisp_Object elt;
3314 ptrdiff_t len, i;
3316 elt = XCAR (val);
3317 if (! CONSP (elt))
3318 continue;
3319 elt = XCAR (elt);
3320 if (! VECTORP (elt))
3321 continue;
3322 len = ASIZE (elt);
3323 if (len <= end - pos)
3325 for (i = 0; i < len; i++)
3327 if (buf_used <= i)
3329 unsigned char *p = BYTE_POS_ADDR (pos_byte);
3330 int len1;
3332 if (buf_used == buf_size)
3334 bufalloc = xpalloc (bufalloc, &buf_size, 1, -1,
3335 sizeof *bufalloc);
3336 if (buf == initial_buf)
3337 memcpy (bufalloc, buf, sizeof initial_buf);
3338 buf = bufalloc;
3340 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len1);
3341 pos_byte += len1;
3343 if (XINT (AREF (elt, i)) != buf[i])
3344 break;
3346 if (i == len)
3348 result = XCAR (val);
3349 break;
3354 xfree (bufalloc);
3355 return result;
3359 DEFUN ("translate-region-internal", Ftranslate_region_internal,
3360 Stranslate_region_internal, 3, 3, 0,
3361 doc: /* Internal use only.
3362 From START to END, translate characters according to TABLE.
3363 TABLE is a string or a char-table; the Nth character in it is the
3364 mapping for the character with code N.
3365 It returns the number of characters changed. */)
3366 (Lisp_Object start, Lisp_Object end, register Lisp_Object table)
3368 register unsigned char *tt; /* Trans table. */
3369 register int nc; /* New character. */
3370 int cnt; /* Number of changes made. */
3371 ptrdiff_t size; /* Size of translate table. */
3372 ptrdiff_t pos, pos_byte, end_pos;
3373 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
3374 bool string_multibyte UNINIT;
3376 validate_region (&start, &end);
3377 if (CHAR_TABLE_P (table))
3379 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
3380 error ("Not a translation table");
3381 size = MAX_CHAR;
3382 tt = NULL;
3384 else
3386 CHECK_STRING (table);
3388 if (! multibyte && (SCHARS (table) < SBYTES (table)))
3389 table = string_make_unibyte (table);
3390 string_multibyte = SCHARS (table) < SBYTES (table);
3391 size = SBYTES (table);
3392 tt = SDATA (table);
3395 pos = XINT (start);
3396 pos_byte = CHAR_TO_BYTE (pos);
3397 end_pos = XINT (end);
3398 modify_text (pos, end_pos);
3400 cnt = 0;
3401 for (; pos < end_pos; )
3403 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
3404 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
3405 int len, str_len;
3406 int oc;
3407 Lisp_Object val;
3409 if (multibyte)
3410 oc = STRING_CHAR_AND_LENGTH (p, len);
3411 else
3412 oc = *p, len = 1;
3413 if (oc < size)
3415 if (tt)
3417 /* Reload as signal_after_change in last iteration may GC. */
3418 tt = SDATA (table);
3419 if (string_multibyte)
3421 str = tt + string_char_to_byte (table, oc);
3422 nc = STRING_CHAR_AND_LENGTH (str, str_len);
3424 else
3426 nc = tt[oc];
3427 if (! ASCII_CHAR_P (nc) && multibyte)
3429 str_len = BYTE8_STRING (nc, buf);
3430 str = buf;
3432 else
3434 str_len = 1;
3435 str = tt + oc;
3439 else
3441 nc = oc;
3442 val = CHAR_TABLE_REF (table, oc);
3443 if (CHARACTERP (val))
3445 nc = XFASTINT (val);
3446 str_len = CHAR_STRING (nc, buf);
3447 str = buf;
3449 else if (VECTORP (val) || (CONSP (val)))
3451 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3452 where TO is TO-CHAR or [TO-CHAR ...]. */
3453 nc = -1;
3457 if (nc != oc && nc >= 0)
3459 /* Simple one char to one char translation. */
3460 if (len != str_len)
3462 Lisp_Object string;
3464 /* This is less efficient, because it moves the gap,
3465 but it should handle multibyte characters correctly. */
3466 string = make_multibyte_string ((char *) str, 1, str_len);
3467 replace_range (pos, pos + 1, string, 1, 0, 1, 0);
3468 len = str_len;
3470 else
3472 record_change (pos, 1);
3473 while (str_len-- > 0)
3474 *p++ = *str++;
3475 signal_after_change (pos, 1, 1);
3476 update_compositions (pos, pos + 1, CHECK_BORDER);
3478 ++cnt;
3480 else if (nc < 0)
3482 Lisp_Object string;
3484 if (CONSP (val))
3486 val = check_translation (pos, pos_byte, end_pos, val);
3487 if (NILP (val))
3489 pos_byte += len;
3490 pos++;
3491 continue;
3493 /* VAL is ([FROM-CHAR ...] . TO). */
3494 len = ASIZE (XCAR (val));
3495 val = XCDR (val);
3497 else
3498 len = 1;
3500 if (VECTORP (val))
3502 string = Fconcat (1, &val);
3504 else
3506 string = Fmake_string (make_number (1), val);
3508 replace_range (pos, pos + len, string, 1, 0, 1, 0);
3509 pos_byte += SBYTES (string);
3510 pos += SCHARS (string);
3511 cnt += SCHARS (string);
3512 end_pos += SCHARS (string) - len;
3513 continue;
3516 pos_byte += len;
3517 pos++;
3520 return make_number (cnt);
3523 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3524 doc: /* Delete the text between START and END.
3525 If called interactively, delete the region between point and mark.
3526 This command deletes buffer text without modifying the kill ring. */)
3527 (Lisp_Object start, Lisp_Object end)
3529 validate_region (&start, &end);
3530 del_range (XINT (start), XINT (end));
3531 return Qnil;
3534 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3535 Sdelete_and_extract_region, 2, 2, 0,
3536 doc: /* Delete the text between START and END and return it. */)
3537 (Lisp_Object start, Lisp_Object end)
3539 validate_region (&start, &end);
3540 if (XINT (start) == XINT (end))
3541 return empty_unibyte_string;
3542 return del_range_1 (XINT (start), XINT (end), 1, 1);
3545 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3546 doc: /* Remove restrictions (narrowing) from current buffer.
3547 This allows the buffer's full text to be seen and edited. */)
3548 (void)
3550 if (BEG != BEGV || Z != ZV)
3551 current_buffer->clip_changed = 1;
3552 BEGV = BEG;
3553 BEGV_BYTE = BEG_BYTE;
3554 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3555 /* Changing the buffer bounds invalidates any recorded current column. */
3556 invalidate_current_column ();
3557 return Qnil;
3560 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3561 doc: /* Restrict editing in this buffer to the current region.
3562 The rest of the text becomes temporarily invisible and untouchable
3563 but is not deleted; if you save the buffer in a file, the invisible
3564 text is included in the file. \\[widen] makes all visible again.
3565 See also `save-restriction'.
3567 When calling from a program, pass two arguments; positions (integers
3568 or markers) bounding the text that should remain visible. */)
3569 (register Lisp_Object start, Lisp_Object end)
3571 CHECK_NUMBER_COERCE_MARKER (start);
3572 CHECK_NUMBER_COERCE_MARKER (end);
3574 if (XINT (start) > XINT (end))
3576 Lisp_Object tem;
3577 tem = start; start = end; end = tem;
3580 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3581 args_out_of_range (start, end);
3583 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3584 current_buffer->clip_changed = 1;
3586 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3587 SET_BUF_ZV (current_buffer, XFASTINT (end));
3588 if (PT < XFASTINT (start))
3589 SET_PT (XFASTINT (start));
3590 if (PT > XFASTINT (end))
3591 SET_PT (XFASTINT (end));
3592 /* Changing the buffer bounds invalidates any recorded current column. */
3593 invalidate_current_column ();
3594 return Qnil;
3597 Lisp_Object
3598 save_restriction_save (void)
3600 if (BEGV == BEG && ZV == Z)
3601 /* The common case that the buffer isn't narrowed.
3602 We return just the buffer object, which save_restriction_restore
3603 recognizes as meaning `no restriction'. */
3604 return Fcurrent_buffer ();
3605 else
3606 /* We have to save a restriction, so return a pair of markers, one
3607 for the beginning and one for the end. */
3609 Lisp_Object beg, end;
3611 beg = build_marker (current_buffer, BEGV, BEGV_BYTE);
3612 end = build_marker (current_buffer, ZV, ZV_BYTE);
3614 /* END must move forward if text is inserted at its exact location. */
3615 XMARKER (end)->insertion_type = 1;
3617 return Fcons (beg, end);
3621 void
3622 save_restriction_restore (Lisp_Object data)
3624 struct buffer *cur = NULL;
3625 struct buffer *buf = (CONSP (data)
3626 ? XMARKER (XCAR (data))->buffer
3627 : XBUFFER (data));
3629 if (buf && buf != current_buffer && !NILP (BVAR (buf, pt_marker)))
3630 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3631 is the case if it is or has an indirect buffer), then make
3632 sure it is current before we update BEGV, so
3633 set_buffer_internal takes care of managing those markers. */
3634 cur = current_buffer;
3635 set_buffer_internal (buf);
3638 if (CONSP (data))
3639 /* A pair of marks bounding a saved restriction. */
3641 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3642 struct Lisp_Marker *end = XMARKER (XCDR (data));
3643 eassert (buf == end->buffer);
3645 if (buf /* Verify marker still points to a buffer. */
3646 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3647 /* The restriction has changed from the saved one, so restore
3648 the saved restriction. */
3650 ptrdiff_t pt = BUF_PT (buf);
3652 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3653 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3655 if (pt < beg->charpos || pt > end->charpos)
3656 /* The point is outside the new visible range, move it inside. */
3657 SET_BUF_PT_BOTH (buf,
3658 clip_to_bounds (beg->charpos, pt, end->charpos),
3659 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3660 end->bytepos));
3662 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3664 /* These aren't needed anymore, so don't wait for GC. */
3665 free_marker (XCAR (data));
3666 free_marker (XCDR (data));
3667 free_cons (XCONS (data));
3669 else
3670 /* A buffer, which means that there was no old restriction. */
3672 if (buf /* Verify marker still points to a buffer. */
3673 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3674 /* The buffer has been narrowed, get rid of the narrowing. */
3676 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3677 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3679 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3683 /* Changing the buffer bounds invalidates any recorded current column. */
3684 invalidate_current_column ();
3686 if (cur)
3687 set_buffer_internal (cur);
3690 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3691 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3692 The buffer's restrictions make parts of the beginning and end invisible.
3693 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3694 This special form, `save-restriction', saves the current buffer's restrictions
3695 when it is entered, and restores them when it is exited.
3696 So any `narrow-to-region' within BODY lasts only until the end of the form.
3697 The old restrictions settings are restored
3698 even in case of abnormal exit (throw or error).
3700 The value returned is the value of the last form in BODY.
3702 Note: if you are using both `save-excursion' and `save-restriction',
3703 use `save-excursion' outermost:
3704 (save-excursion (save-restriction ...))
3706 usage: (save-restriction &rest BODY) */)
3707 (Lisp_Object body)
3709 register Lisp_Object val;
3710 ptrdiff_t count = SPECPDL_INDEX ();
3712 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3713 val = Fprogn (body);
3714 return unbind_to (count, val);
3717 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3718 doc: /* Display a message at the bottom of the screen.
3719 The message also goes into the `*Messages*' buffer, if `message-log-max'
3720 is non-nil. (In keyboard macros, that's all it does.)
3721 Return the message.
3723 In batch mode, the message is printed to the standard error stream,
3724 followed by a newline.
3726 The first argument is a format control string, and the rest are data
3727 to be formatted under control of the string. See `format-message' for
3728 details.
3730 Note: (message "%s" VALUE) displays the string VALUE without
3731 interpreting format characters like `%', `\\=`', and `\\=''.
3733 If the first argument is nil or the empty string, the function clears
3734 any existing message; this lets the minibuffer contents show. See
3735 also `current-message'.
3737 usage: (message FORMAT-STRING &rest ARGS) */)
3738 (ptrdiff_t nargs, Lisp_Object *args)
3740 if (NILP (args[0])
3741 || (STRINGP (args[0])
3742 && SBYTES (args[0]) == 0))
3744 message1 (0);
3745 return args[0];
3747 else
3749 Lisp_Object val = Fformat_message (nargs, args);
3750 message3 (val);
3751 return val;
3755 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3756 doc: /* Display a message, in a dialog box if possible.
3757 If a dialog box is not available, use the echo area.
3758 The first argument is a format control string, and the rest are data
3759 to be formatted under control of the string. See `format-message' for
3760 details.
3762 If the first argument is nil or the empty string, clear any existing
3763 message; let the minibuffer contents show.
3765 usage: (message-box FORMAT-STRING &rest ARGS) */)
3766 (ptrdiff_t nargs, Lisp_Object *args)
3768 if (NILP (args[0]))
3770 message1 (0);
3771 return Qnil;
3773 else
3775 Lisp_Object val = Fformat_message (nargs, args);
3776 Lisp_Object pane, menu;
3778 pane = list1 (Fcons (build_string ("OK"), Qt));
3779 menu = Fcons (val, pane);
3780 Fx_popup_dialog (Qt, menu, Qt);
3781 return val;
3785 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3786 doc: /* Display a message in a dialog box or in the echo area.
3787 If this command was invoked with the mouse, use a dialog box if
3788 `use-dialog-box' is non-nil.
3789 Otherwise, use the echo area.
3790 The first argument is a format control string, and the rest are data
3791 to be formatted under control of the string. See `format-message' for
3792 details.
3794 If the first argument is nil or the empty string, clear any existing
3795 message; let the minibuffer contents show.
3797 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3798 (ptrdiff_t nargs, Lisp_Object *args)
3800 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3801 && use_dialog_box)
3802 return Fmessage_box (nargs, args);
3803 return Fmessage (nargs, args);
3806 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3807 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3808 (void)
3810 return current_message ();
3814 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3815 doc: /* Return a copy of STRING with text properties added.
3816 First argument is the string to copy.
3817 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3818 properties to add to the result.
3819 usage: (propertize STRING &rest PROPERTIES) */)
3820 (ptrdiff_t nargs, Lisp_Object *args)
3822 Lisp_Object properties, string;
3823 ptrdiff_t i;
3825 /* Number of args must be odd. */
3826 if ((nargs & 1) == 0)
3827 error ("Wrong number of arguments");
3829 properties = string = Qnil;
3831 /* First argument must be a string. */
3832 CHECK_STRING (args[0]);
3833 string = Fcopy_sequence (args[0]);
3835 for (i = 1; i < nargs; i += 2)
3836 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3838 Fadd_text_properties (make_number (0),
3839 make_number (SCHARS (string)),
3840 properties, string);
3841 return string;
3844 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3845 doc: /* Format a string out of a format-string and arguments.
3846 The first argument is a format control string.
3847 The other arguments are substituted into it to make the result, a string.
3849 The format control string may contain %-sequences meaning to substitute
3850 the next available argument:
3852 %s means print a string argument. Actually, prints any object, with `princ'.
3853 %d means print as number in decimal (%o octal, %x hex).
3854 %X is like %x, but uses upper case.
3855 %e means print a number in exponential notation.
3856 %f means print a number in decimal-point notation.
3857 %g means print a number in exponential notation
3858 or decimal-point notation, whichever uses fewer characters.
3859 %c means print a number as a single character.
3860 %S means print any object as an s-expression (using `prin1').
3862 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3863 Use %% to put a single % into the output.
3865 A %-sequence may contain optional flag, width, and precision
3866 specifiers, as follows:
3868 %<flags><width><precision>character
3870 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3872 The + flag character inserts a + before any positive number, while a
3873 space inserts a space before any positive number; these flags only
3874 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3875 The - and 0 flags affect the width specifier, as described below.
3877 The # flag means to use an alternate display form for %o, %x, %X, %e,
3878 %f, and %g sequences: for %o, it ensures that the result begins with
3879 \"0\"; for %x and %X, it prefixes the result with \"0x\" or \"0X\";
3880 for %e, %f, and %g, it causes a decimal point to be included even if
3881 the precision is zero.
3883 The width specifier supplies a lower limit for the length of the
3884 printed representation. The padding, if any, normally goes on the
3885 left, but it goes on the right if the - flag is present. The padding
3886 character is normally a space, but it is 0 if the 0 flag is present.
3887 The 0 flag is ignored if the - flag is present, or the format sequence
3888 is something other than %d, %e, %f, and %g.
3890 For %e, %f, and %g sequences, the number after the "." in the
3891 precision specifier says how many decimal places to show; if zero, the
3892 decimal point itself is omitted. For %s and %S, the precision
3893 specifier truncates the string to the given width.
3895 Text properties, if any, are copied from the format-string to the
3896 produced text.
3898 usage: (format STRING &rest OBJECTS) */)
3899 (ptrdiff_t nargs, Lisp_Object *args)
3901 return styled_format (nargs, args, false);
3904 DEFUN ("format-message", Fformat_message, Sformat_message, 1, MANY, 0,
3905 doc: /* Format a string out of a format-string and arguments.
3906 The first argument is a format control string.
3907 The other arguments are substituted into it to make the result, a string.
3909 This acts like `format', except it also replaces each grave accent (\\=`)
3910 by a left quote, and each apostrophe (\\=') by a right quote. The left
3911 and right quote replacement characters are specified by
3912 `text-quoting-style'.
3914 usage: (format-message STRING &rest OBJECTS) */)
3915 (ptrdiff_t nargs, Lisp_Object *args)
3917 return styled_format (nargs, args, true);
3920 /* Implement ‘format-message’ if MESSAGE is true, ‘format’ otherwise. */
3922 static Lisp_Object
3923 styled_format (ptrdiff_t nargs, Lisp_Object *args, bool message)
3925 ptrdiff_t n; /* The number of the next arg to substitute. */
3926 char initial_buffer[4000];
3927 char *buf = initial_buffer;
3928 ptrdiff_t bufsize = sizeof initial_buffer;
3929 ptrdiff_t max_bufsize = STRING_BYTES_BOUND + 1;
3930 char *p;
3931 ptrdiff_t buf_save_value_index UNINIT;
3932 char *format, *end;
3933 ptrdiff_t nchars;
3934 /* When we make a multibyte string, we must pay attention to the
3935 byte combining problem, i.e., a byte may be combined with a
3936 multibyte character of the previous string. This flag tells if we
3937 must consider such a situation or not. */
3938 bool maybe_combine_byte;
3939 bool arg_intervals = false;
3940 USE_SAFE_ALLOCA;
3942 /* Each element records, for one argument,
3943 the start and end bytepos in the output string,
3944 whether the argument has been converted to string (e.g., due to "%S"),
3945 and whether the argument is a string with intervals. */
3946 struct info
3948 ptrdiff_t start, end;
3949 bool_bf converted_to_string : 1;
3950 bool_bf intervals : 1;
3951 } *info;
3953 CHECK_STRING (args[0]);
3954 char *format_start = SSDATA (args[0]);
3955 ptrdiff_t formatlen = SBYTES (args[0]);
3957 /* Allocate the info and discarded tables. */
3958 ptrdiff_t alloca_size;
3959 if (INT_MULTIPLY_WRAPV (nargs, sizeof *info, &alloca_size)
3960 || INT_ADD_WRAPV (sizeof *info, alloca_size, &alloca_size)
3961 || INT_ADD_WRAPV (formatlen, alloca_size, &alloca_size)
3962 || SIZE_MAX < alloca_size)
3963 memory_full (SIZE_MAX);
3964 /* info[0] is unused. Unused elements have -1 for start. */
3965 info = SAFE_ALLOCA (alloca_size);
3966 memset (info, 0, alloca_size);
3967 for (ptrdiff_t i = 0; i < nargs + 1; i++)
3968 info[i].start = -1;
3969 /* discarded[I] is 1 if byte I of the format
3970 string was not copied into the output.
3971 It is 2 if byte I was not the first byte of its character. */
3972 char *discarded = (char *) &info[nargs + 1];
3974 /* Try to determine whether the result should be multibyte.
3975 This is not always right; sometimes the result needs to be multibyte
3976 because of an object that we will pass through prin1.
3977 or because a grave accent or apostrophe is requoted,
3978 and in that case, we won't know it here. */
3980 /* True if the format is multibyte. */
3981 bool multibyte_format = STRING_MULTIBYTE (args[0]);
3982 /* True if the output should be a multibyte string,
3983 which is true if any of the inputs is one. */
3984 bool multibyte = multibyte_format;
3985 for (ptrdiff_t i = 1; !multibyte && i < nargs; i++)
3986 if (STRINGP (args[i]) && STRING_MULTIBYTE (args[i]))
3987 multibyte = true;
3989 int quoting_style = message ? text_quoting_style () : -1;
3991 /* If we start out planning a unibyte result,
3992 then discover it has to be multibyte, we jump back to retry. */
3993 retry:
3995 p = buf;
3996 nchars = 0;
3997 n = 0;
3999 /* Scan the format and store result in BUF. */
4000 format = format_start;
4001 end = format + formatlen;
4002 maybe_combine_byte = false;
4004 while (format != end)
4006 /* The values of N and FORMAT when the loop body is entered. */
4007 ptrdiff_t n0 = n;
4008 char *format0 = format;
4009 char const *convsrc = format;
4010 unsigned char format_char = *format++;
4012 /* Bytes needed to represent the output of this conversion. */
4013 ptrdiff_t convbytes = 1;
4015 if (format_char == '%')
4017 /* General format specifications look like
4019 '%' [flags] [field-width] [precision] format
4021 where
4023 flags ::= [-+0# ]+
4024 field-width ::= [0-9]+
4025 precision ::= '.' [0-9]*
4027 If a field-width is specified, it specifies to which width
4028 the output should be padded with blanks, if the output
4029 string is shorter than field-width.
4031 If precision is specified, it specifies the number of
4032 digits to print after the '.' for floats, or the max.
4033 number of chars to print from a string. */
4035 bool minus_flag = false;
4036 bool plus_flag = false;
4037 bool space_flag = false;
4038 bool sharp_flag = false;
4039 bool zero_flag = false;
4041 for (; ; format++)
4043 switch (*format)
4045 case '-': minus_flag = true; continue;
4046 case '+': plus_flag = true; continue;
4047 case ' ': space_flag = true; continue;
4048 case '#': sharp_flag = true; continue;
4049 case '0': zero_flag = true; continue;
4051 break;
4054 /* Ignore flags when sprintf ignores them. */
4055 space_flag &= ~ plus_flag;
4056 zero_flag &= ~ minus_flag;
4058 char *num_end;
4059 uintmax_t raw_field_width = strtoumax (format, &num_end, 10);
4060 if (max_bufsize <= raw_field_width)
4061 string_overflow ();
4062 ptrdiff_t field_width = raw_field_width;
4064 bool precision_given = *num_end == '.';
4065 uintmax_t precision = (precision_given
4066 ? strtoumax (num_end + 1, &num_end, 10)
4067 : UINTMAX_MAX);
4068 format = num_end;
4070 if (format == end)
4071 error ("Format string ends in middle of format specifier");
4073 char conversion = *format++;
4074 memset (&discarded[format0 - format_start], 1,
4075 format - format0 - (conversion == '%'));
4076 if (conversion == '%')
4077 goto copy_char;
4079 ++n;
4080 if (! (n < nargs))
4081 error ("Not enough arguments for format string");
4083 /* For 'S', prin1 the argument, and then treat like 's'.
4084 For 's', princ any argument that is not a string or
4085 symbol. But don't do this conversion twice, which might
4086 happen after retrying. */
4087 if ((conversion == 'S'
4088 || (conversion == 's'
4089 && ! STRINGP (args[n]) && ! SYMBOLP (args[n]))))
4091 if (! info[n].converted_to_string)
4093 Lisp_Object noescape = conversion == 'S' ? Qnil : Qt;
4094 args[n] = Fprin1_to_string (args[n], noescape);
4095 info[n].converted_to_string = true;
4096 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
4098 multibyte = true;
4099 goto retry;
4102 conversion = 's';
4104 else if (conversion == 'c')
4106 if (FLOATP (args[n]))
4108 double d = XFLOAT_DATA (args[n]);
4109 args[n] = make_number (FIXNUM_OVERFLOW_P (d) ? -1 : d);
4112 if (INTEGERP (args[n]) && ! ASCII_CHAR_P (XINT (args[n])))
4114 if (!multibyte)
4116 multibyte = true;
4117 goto retry;
4119 args[n] = Fchar_to_string (args[n]);
4120 info[n].converted_to_string = true;
4123 if (info[n].converted_to_string)
4124 conversion = 's';
4125 zero_flag = false;
4128 if (SYMBOLP (args[n]))
4130 args[n] = SYMBOL_NAME (args[n]);
4131 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
4133 multibyte = true;
4134 goto retry;
4138 if (conversion == 's')
4140 /* handle case (precision[n] >= 0) */
4142 ptrdiff_t prec = -1;
4143 if (precision_given && precision <= TYPE_MAXIMUM (ptrdiff_t))
4144 prec = precision;
4146 /* lisp_string_width ignores a precision of 0, but GNU
4147 libc functions print 0 characters when the precision
4148 is 0. Imitate libc behavior here. Changing
4149 lisp_string_width is the right thing, and will be
4150 done, but meanwhile we work with it. */
4152 ptrdiff_t width, nbytes;
4153 ptrdiff_t nchars_string;
4154 if (prec == 0)
4155 width = nchars_string = nbytes = 0;
4156 else
4158 ptrdiff_t nch, nby;
4159 width = lisp_string_width (args[n], prec, &nch, &nby);
4160 if (prec < 0)
4162 nchars_string = SCHARS (args[n]);
4163 nbytes = SBYTES (args[n]);
4165 else
4167 nchars_string = nch;
4168 nbytes = nby;
4172 convbytes = nbytes;
4173 if (convbytes && multibyte && ! STRING_MULTIBYTE (args[n]))
4174 convbytes = count_size_as_multibyte (SDATA (args[n]), nbytes);
4176 ptrdiff_t padding
4177 = width < field_width ? field_width - width : 0;
4179 if (max_bufsize - padding <= convbytes)
4180 string_overflow ();
4181 convbytes += padding;
4182 if (convbytes <= buf + bufsize - p)
4184 if (! minus_flag)
4186 memset (p, ' ', padding);
4187 p += padding;
4188 nchars += padding;
4190 info[n].start = nchars;
4192 if (p > buf
4193 && multibyte
4194 && !ASCII_CHAR_P (*((unsigned char *) p - 1))
4195 && STRING_MULTIBYTE (args[n])
4196 && !CHAR_HEAD_P (SREF (args[n], 0)))
4197 maybe_combine_byte = true;
4199 p += copy_text (SDATA (args[n]), (unsigned char *) p,
4200 nbytes,
4201 STRING_MULTIBYTE (args[n]), multibyte);
4203 nchars += nchars_string;
4205 if (minus_flag)
4207 memset (p, ' ', padding);
4208 p += padding;
4209 nchars += padding;
4211 info[n].end = nchars;
4213 /* If this argument has text properties, record where
4214 in the result string it appears. */
4215 if (string_intervals (args[n]))
4216 info[n].intervals = arg_intervals = true;
4218 continue;
4221 else if (! (conversion == 'c' || conversion == 'd'
4222 || conversion == 'e' || conversion == 'f'
4223 || conversion == 'g' || conversion == 'i'
4224 || conversion == 'o' || conversion == 'x'
4225 || conversion == 'X'))
4226 error ("Invalid format operation %%%c",
4227 STRING_CHAR ((unsigned char *) format - 1));
4228 else if (! NUMBERP (args[n]))
4229 error ("Format specifier doesn't match argument type");
4230 else
4232 enum
4234 /* Maximum precision for a %f conversion such that the
4235 trailing output digit might be nonzero. Any precision
4236 larger than this will not yield useful information. */
4237 USEFUL_PRECISION_MAX =
4238 ((1 - DBL_MIN_EXP)
4239 * (FLT_RADIX == 2 || FLT_RADIX == 10 ? 1
4240 : FLT_RADIX == 16 ? 4
4241 : -1)),
4243 /* Maximum number of bytes generated by any format, if
4244 precision is no more than USEFUL_PRECISION_MAX.
4245 On all practical hosts, %f is the worst case. */
4246 SPRINTF_BUFSIZE =
4247 sizeof "-." + (DBL_MAX_10_EXP + 1) + USEFUL_PRECISION_MAX,
4249 /* Length of pM (that is, of pMd without the
4250 trailing "d"). */
4251 pMlen = sizeof pMd - 2
4253 verify (USEFUL_PRECISION_MAX > 0);
4255 /* Avoid undefined behavior in underlying sprintf. */
4256 if (conversion == 'd' || conversion == 'i')
4257 sharp_flag = false;
4259 /* Create the copy of the conversion specification, with
4260 any width and precision removed, with ".*" inserted,
4261 and with pM inserted for integer formats.
4262 At most three flags F can be specified at once. */
4263 char convspec[sizeof "%FFF.*d" + pMlen];
4265 char *f = convspec;
4266 *f++ = '%';
4267 *f = '-'; f += minus_flag;
4268 *f = '+'; f += plus_flag;
4269 *f = ' '; f += space_flag;
4270 *f = '#'; f += sharp_flag;
4271 *f = '0'; f += zero_flag;
4272 *f++ = '.';
4273 *f++ = '*';
4274 if (conversion == 'd' || conversion == 'i'
4275 || conversion == 'o' || conversion == 'x'
4276 || conversion == 'X')
4278 memcpy (f, pMd, pMlen);
4279 f += pMlen;
4280 zero_flag &= ~ precision_given;
4282 *f++ = conversion;
4283 *f = '\0';
4286 int prec = -1;
4287 if (precision_given)
4288 prec = min (precision, USEFUL_PRECISION_MAX);
4290 /* Use sprintf to format this number into sprintf_buf. Omit
4291 padding and excess precision, though, because sprintf limits
4292 output length to INT_MAX.
4294 There are four types of conversion: double, unsigned
4295 char (passed as int), wide signed int, and wide
4296 unsigned int. Treat them separately because the
4297 sprintf ABI is sensitive to which type is passed. Be
4298 careful about integer overflow, NaNs, infinities, and
4299 conversions; for example, the min and max macros are
4300 not suitable here. */
4301 char sprintf_buf[SPRINTF_BUFSIZE];
4302 ptrdiff_t sprintf_bytes;
4303 if (conversion == 'e' || conversion == 'f' || conversion == 'g')
4305 double x = (INTEGERP (args[n])
4306 ? XINT (args[n])
4307 : XFLOAT_DATA (args[n]));
4308 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4310 else if (conversion == 'c')
4312 /* Don't use sprintf here, as it might mishandle prec. */
4313 sprintf_buf[0] = XINT (args[n]);
4314 sprintf_bytes = prec != 0;
4316 else if (conversion == 'd')
4318 /* For float, maybe we should use "%1.0f"
4319 instead so it also works for values outside
4320 the integer range. */
4321 printmax_t x;
4322 if (INTEGERP (args[n]))
4323 x = XINT (args[n]);
4324 else
4326 double d = XFLOAT_DATA (args[n]);
4327 if (d < 0)
4329 x = TYPE_MINIMUM (printmax_t);
4330 if (x < d)
4331 x = d;
4333 else
4335 x = TYPE_MAXIMUM (printmax_t);
4336 if (d < x)
4337 x = d;
4340 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4342 else
4344 /* Don't sign-extend for octal or hex printing. */
4345 uprintmax_t x;
4346 if (INTEGERP (args[n]))
4347 x = XUINT (args[n]);
4348 else
4350 double d = XFLOAT_DATA (args[n]);
4351 if (d < 0)
4352 x = 0;
4353 else
4355 x = TYPE_MAXIMUM (uprintmax_t);
4356 if (d < x)
4357 x = d;
4360 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4363 /* Now the length of the formatted item is known, except it omits
4364 padding and excess precision. Deal with excess precision
4365 first. This happens only when the format specifies
4366 ridiculously large precision. */
4367 uintmax_t excess_precision = precision - prec;
4368 uintmax_t leading_zeros = 0, trailing_zeros = 0;
4369 if (excess_precision)
4371 if (conversion == 'e' || conversion == 'f'
4372 || conversion == 'g')
4374 if ((conversion == 'g' && ! sharp_flag)
4375 || ! ('0' <= sprintf_buf[sprintf_bytes - 1]
4376 && sprintf_buf[sprintf_bytes - 1] <= '9'))
4377 excess_precision = 0;
4378 else
4380 if (conversion == 'g')
4382 char *dot = strchr (sprintf_buf, '.');
4383 if (!dot)
4384 excess_precision = 0;
4387 trailing_zeros = excess_precision;
4389 else
4390 leading_zeros = excess_precision;
4393 /* Compute the total bytes needed for this item, including
4394 excess precision and padding. */
4395 uintmax_t numwidth = sprintf_bytes + excess_precision;
4396 ptrdiff_t padding
4397 = numwidth < field_width ? field_width - numwidth : 0;
4398 if (max_bufsize - sprintf_bytes <= excess_precision
4399 || max_bufsize - padding <= numwidth)
4400 string_overflow ();
4401 convbytes = numwidth + padding;
4403 if (convbytes <= buf + bufsize - p)
4405 /* Copy the formatted item from sprintf_buf into buf,
4406 inserting padding and excess-precision zeros. */
4408 char *src = sprintf_buf;
4409 char src0 = src[0];
4410 int exponent_bytes = 0;
4411 bool signedp = src0 == '-' || src0 == '+' || src0 == ' ';
4412 if (zero_flag
4413 && ((src[signedp] >= '0' && src[signedp] <= '9')
4414 || (src[signedp] >= 'a' && src[signedp] <= 'f')
4415 || (src[signedp] >= 'A' && src[signedp] <= 'F')))
4417 leading_zeros += padding;
4418 padding = 0;
4421 if (excess_precision
4422 && (conversion == 'e' || conversion == 'g'))
4424 char *e = strchr (src, 'e');
4425 if (e)
4426 exponent_bytes = src + sprintf_bytes - e;
4429 info[n].start = nchars;
4430 if (! minus_flag)
4432 memset (p, ' ', padding);
4433 p += padding;
4434 nchars += padding;
4437 *p = src0;
4438 src += signedp;
4439 p += signedp;
4440 memset (p, '0', leading_zeros);
4441 p += leading_zeros;
4442 int significand_bytes
4443 = sprintf_bytes - signedp - exponent_bytes;
4444 memcpy (p, src, significand_bytes);
4445 p += significand_bytes;
4446 src += significand_bytes;
4447 memset (p, '0', trailing_zeros);
4448 p += trailing_zeros;
4449 memcpy (p, src, exponent_bytes);
4450 p += exponent_bytes;
4452 nchars += leading_zeros + sprintf_bytes + trailing_zeros;
4454 if (minus_flag)
4456 memset (p, ' ', padding);
4457 p += padding;
4458 nchars += padding;
4460 info[n].end = nchars;
4462 continue;
4466 else
4468 unsigned char str[MAX_MULTIBYTE_LENGTH];
4470 if ((format_char == '`' || format_char == '\'')
4471 && quoting_style == CURVE_QUOTING_STYLE)
4473 if (! multibyte)
4475 multibyte = true;
4476 goto retry;
4478 convsrc = format_char == '`' ? uLSQM : uRSQM;
4479 convbytes = 3;
4481 else if (format_char == '`' && quoting_style == STRAIGHT_QUOTING_STYLE)
4482 convsrc = "'";
4483 else
4485 /* Copy a single character from format to buf. */
4486 if (multibyte_format)
4488 /* Copy a whole multibyte character. */
4489 if (p > buf
4490 && !ASCII_CHAR_P (*((unsigned char *) p - 1))
4491 && !CHAR_HEAD_P (format_char))
4492 maybe_combine_byte = true;
4494 while (! CHAR_HEAD_P (*format))
4495 format++;
4497 convbytes = format - format0;
4498 memset (&discarded[format0 + 1 - format_start], 2,
4499 convbytes - 1);
4501 else if (multibyte && !ASCII_CHAR_P (format_char))
4503 int c = BYTE8_TO_CHAR (format_char);
4504 convbytes = CHAR_STRING (c, str);
4505 convsrc = (char *) str;
4509 copy_char:
4510 if (convbytes <= buf + bufsize - p)
4512 memcpy (p, convsrc, convbytes);
4513 p += convbytes;
4514 nchars++;
4515 continue;
4519 /* There wasn't enough room to store this conversion or single
4520 character. CONVBYTES says how much room is needed. Allocate
4521 enough room (and then some) and do it again. */
4523 ptrdiff_t used = p - buf;
4524 if (max_bufsize - used < convbytes)
4525 string_overflow ();
4526 bufsize = used + convbytes;
4527 bufsize = bufsize < max_bufsize / 2 ? bufsize * 2 : max_bufsize;
4529 if (buf == initial_buffer)
4531 buf = xmalloc (bufsize);
4532 sa_must_free = true;
4533 buf_save_value_index = SPECPDL_INDEX ();
4534 record_unwind_protect_ptr (xfree, buf);
4535 memcpy (buf, initial_buffer, used);
4537 else
4539 buf = xrealloc (buf, bufsize);
4540 set_unwind_protect_ptr (buf_save_value_index, xfree, buf);
4543 p = buf + used;
4544 format = format0;
4545 n = n0;
4548 if (bufsize < p - buf)
4549 emacs_abort ();
4551 if (maybe_combine_byte)
4552 nchars = multibyte_chars_in_text ((unsigned char *) buf, p - buf);
4553 Lisp_Object val = make_specified_string (buf, nchars, p - buf, multibyte);
4555 /* If the format string has text properties, or any of the string
4556 arguments has text properties, set up text properties of the
4557 result string. */
4559 if (string_intervals (args[0]) || arg_intervals)
4561 /* Add text properties from the format string. */
4562 Lisp_Object len = make_number (SCHARS (args[0]));
4563 Lisp_Object props = text_property_list (args[0], make_number (0),
4564 len, Qnil);
4565 if (CONSP (props))
4567 ptrdiff_t bytepos = 0, position = 0, translated = 0;
4568 ptrdiff_t argn = 1;
4570 /* Adjust the bounds of each text property
4571 to the proper start and end in the output string. */
4573 /* Put the positions in PROPS in increasing order, so that
4574 we can do (effectively) one scan through the position
4575 space of the format string. */
4576 props = Fnreverse (props);
4578 /* BYTEPOS is the byte position in the format string,
4579 POSITION is the untranslated char position in it,
4580 TRANSLATED is the translated char position in BUF,
4581 and ARGN is the number of the next arg we will come to. */
4582 for (Lisp_Object list = props; CONSP (list); list = XCDR (list))
4584 Lisp_Object item = XCAR (list);
4586 /* First adjust the property start position. */
4587 ptrdiff_t pos = XINT (XCAR (item));
4589 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4590 up to this position. */
4591 for (; position < pos; bytepos++)
4593 if (! discarded[bytepos])
4594 position++, translated++;
4595 else if (discarded[bytepos] == 1)
4597 position++;
4598 if (translated == info[argn].start)
4600 translated += info[argn].end - info[argn].start;
4601 argn++;
4606 XSETCAR (item, make_number (translated));
4608 /* Likewise adjust the property end position. */
4609 pos = XINT (XCAR (XCDR (item)));
4611 for (; position < pos; bytepos++)
4613 if (! discarded[bytepos])
4614 position++, translated++;
4615 else if (discarded[bytepos] == 1)
4617 position++;
4618 if (translated == info[argn].start)
4620 translated += info[argn].end - info[argn].start;
4621 argn++;
4626 XSETCAR (XCDR (item), make_number (translated));
4629 add_text_properties_from_list (val, props, make_number (0));
4632 /* Add text properties from arguments. */
4633 if (arg_intervals)
4634 for (ptrdiff_t i = 1; i < nargs; i++)
4635 if (info[i].intervals)
4637 len = make_number (SCHARS (args[i]));
4638 Lisp_Object new_len = make_number (info[i].end - info[i].start);
4639 props = text_property_list (args[i], make_number (0), len, Qnil);
4640 props = extend_property_ranges (props, len, new_len);
4641 /* If successive arguments have properties, be sure that
4642 the value of `composition' property be the copy. */
4643 if (1 < i && info[i - 1].end)
4644 make_composition_value_copy (props);
4645 add_text_properties_from_list (val, props,
4646 make_number (info[i].start));
4650 /* If we allocated BUF or INFO with malloc, free it too. */
4651 SAFE_FREE ();
4653 return val;
4656 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4657 doc: /* Return t if two characters match, optionally ignoring case.
4658 Both arguments must be characters (i.e. integers).
4659 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4660 (register Lisp_Object c1, Lisp_Object c2)
4662 int i1, i2;
4663 /* Check they're chars, not just integers, otherwise we could get array
4664 bounds violations in downcase. */
4665 CHECK_CHARACTER (c1);
4666 CHECK_CHARACTER (c2);
4668 if (XINT (c1) == XINT (c2))
4669 return Qt;
4670 if (NILP (BVAR (current_buffer, case_fold_search)))
4671 return Qnil;
4673 i1 = XFASTINT (c1);
4674 i2 = XFASTINT (c2);
4676 /* FIXME: It is possible to compare multibyte characters even when
4677 the current buffer is unibyte. Unfortunately this is ambiguous
4678 for characters between 128 and 255, as they could be either
4679 eight-bit raw bytes or Latin-1 characters. Assume the former for
4680 now. See Bug#17011, and also see casefiddle.c's casify_object,
4681 which has a similar problem. */
4682 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
4684 if (SINGLE_BYTE_CHAR_P (i1))
4685 i1 = UNIBYTE_TO_CHAR (i1);
4686 if (SINGLE_BYTE_CHAR_P (i2))
4687 i2 = UNIBYTE_TO_CHAR (i2);
4690 return (downcase (i1) == downcase (i2) ? Qt : Qnil);
4693 /* Transpose the markers in two regions of the current buffer, and
4694 adjust the ones between them if necessary (i.e.: if the regions
4695 differ in size).
4697 START1, END1 are the character positions of the first region.
4698 START1_BYTE, END1_BYTE are the byte positions.
4699 START2, END2 are the character positions of the second region.
4700 START2_BYTE, END2_BYTE are the byte positions.
4702 Traverses the entire marker list of the buffer to do so, adding an
4703 appropriate amount to some, subtracting from some, and leaving the
4704 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4706 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4708 static void
4709 transpose_markers (ptrdiff_t start1, ptrdiff_t end1,
4710 ptrdiff_t start2, ptrdiff_t end2,
4711 ptrdiff_t start1_byte, ptrdiff_t end1_byte,
4712 ptrdiff_t start2_byte, ptrdiff_t end2_byte)
4714 register ptrdiff_t amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4715 register struct Lisp_Marker *marker;
4717 /* Update point as if it were a marker. */
4718 if (PT < start1)
4720 else if (PT < end1)
4721 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4722 PT_BYTE + (end2_byte - end1_byte));
4723 else if (PT < start2)
4724 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4725 (PT_BYTE + (end2_byte - start2_byte)
4726 - (end1_byte - start1_byte)));
4727 else if (PT < end2)
4728 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4729 PT_BYTE - (start2_byte - start1_byte));
4731 /* We used to adjust the endpoints here to account for the gap, but that
4732 isn't good enough. Even if we assume the caller has tried to move the
4733 gap out of our way, it might still be at start1 exactly, for example;
4734 and that places it `inside' the interval, for our purposes. The amount
4735 of adjustment is nontrivial if there's a `denormalized' marker whose
4736 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4737 the dirty work to Fmarker_position, below. */
4739 /* The difference between the region's lengths */
4740 diff = (end2 - start2) - (end1 - start1);
4741 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4743 /* For shifting each marker in a region by the length of the other
4744 region plus the distance between the regions. */
4745 amt1 = (end2 - start2) + (start2 - end1);
4746 amt2 = (end1 - start1) + (start2 - end1);
4747 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4748 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4750 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4752 mpos = marker->bytepos;
4753 if (mpos >= start1_byte && mpos < end2_byte)
4755 if (mpos < end1_byte)
4756 mpos += amt1_byte;
4757 else if (mpos < start2_byte)
4758 mpos += diff_byte;
4759 else
4760 mpos -= amt2_byte;
4761 marker->bytepos = mpos;
4763 mpos = marker->charpos;
4764 if (mpos >= start1 && mpos < end2)
4766 if (mpos < end1)
4767 mpos += amt1;
4768 else if (mpos < start2)
4769 mpos += diff;
4770 else
4771 mpos -= amt2;
4773 marker->charpos = mpos;
4777 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4778 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4779 The regions should not be overlapping, because the size of the buffer is
4780 never changed in a transposition.
4782 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4783 any markers that happen to be located in the regions.
4785 Transposing beyond buffer boundaries is an error. */)
4786 (Lisp_Object startr1, Lisp_Object endr1, Lisp_Object startr2, Lisp_Object endr2, Lisp_Object leave_markers)
4788 register ptrdiff_t start1, end1, start2, end2;
4789 ptrdiff_t start1_byte, start2_byte, len1_byte, len2_byte, end2_byte;
4790 ptrdiff_t gap, len1, len_mid, len2;
4791 unsigned char *start1_addr, *start2_addr, *temp;
4793 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4794 Lisp_Object buf;
4796 XSETBUFFER (buf, current_buffer);
4797 cur_intv = buffer_intervals (current_buffer);
4799 validate_region (&startr1, &endr1);
4800 validate_region (&startr2, &endr2);
4802 start1 = XFASTINT (startr1);
4803 end1 = XFASTINT (endr1);
4804 start2 = XFASTINT (startr2);
4805 end2 = XFASTINT (endr2);
4806 gap = GPT;
4808 /* Swap the regions if they're reversed. */
4809 if (start2 < end1)
4811 register ptrdiff_t glumph = start1;
4812 start1 = start2;
4813 start2 = glumph;
4814 glumph = end1;
4815 end1 = end2;
4816 end2 = glumph;
4819 len1 = end1 - start1;
4820 len2 = end2 - start2;
4822 if (start2 < end1)
4823 error ("Transposed regions overlap");
4824 /* Nothing to change for adjacent regions with one being empty */
4825 else if ((start1 == end1 || start2 == end2) && end1 == start2)
4826 return Qnil;
4828 /* The possibilities are:
4829 1. Adjacent (contiguous) regions, or separate but equal regions
4830 (no, really equal, in this case!), or
4831 2. Separate regions of unequal size.
4833 The worst case is usually No. 2. It means that (aside from
4834 potential need for getting the gap out of the way), there also
4835 needs to be a shifting of the text between the two regions. So
4836 if they are spread far apart, we are that much slower... sigh. */
4838 /* It must be pointed out that the really studly thing to do would
4839 be not to move the gap at all, but to leave it in place and work
4840 around it if necessary. This would be extremely efficient,
4841 especially considering that people are likely to do
4842 transpositions near where they are working interactively, which
4843 is exactly where the gap would be found. However, such code
4844 would be much harder to write and to read. So, if you are
4845 reading this comment and are feeling squirrely, by all means have
4846 a go! I just didn't feel like doing it, so I will simply move
4847 the gap the minimum distance to get it out of the way, and then
4848 deal with an unbroken array. */
4850 start1_byte = CHAR_TO_BYTE (start1);
4851 end2_byte = CHAR_TO_BYTE (end2);
4853 /* Make sure the gap won't interfere, by moving it out of the text
4854 we will operate on. */
4855 if (start1 < gap && gap < end2)
4857 if (gap - start1 < end2 - gap)
4858 move_gap_both (start1, start1_byte);
4859 else
4860 move_gap_both (end2, end2_byte);
4863 start2_byte = CHAR_TO_BYTE (start2);
4864 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4865 len2_byte = end2_byte - start2_byte;
4867 #ifdef BYTE_COMBINING_DEBUG
4868 if (end1 == start2)
4870 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4871 len2_byte, start1, start1_byte)
4872 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4873 len1_byte, end2, start2_byte + len2_byte)
4874 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4875 len1_byte, end2, start2_byte + len2_byte))
4876 emacs_abort ();
4878 else
4880 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4881 len2_byte, start1, start1_byte)
4882 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4883 len1_byte, start2, start2_byte)
4884 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4885 len2_byte, end1, start1_byte + len1_byte)
4886 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4887 len1_byte, end2, start2_byte + len2_byte))
4888 emacs_abort ();
4890 #endif
4892 /* Hmmm... how about checking to see if the gap is large
4893 enough to use as the temporary storage? That would avoid an
4894 allocation... interesting. Later, don't fool with it now. */
4896 /* Working without memmove, for portability (sigh), so must be
4897 careful of overlapping subsections of the array... */
4899 if (end1 == start2) /* adjacent regions */
4901 modify_text (start1, end2);
4902 record_change (start1, len1 + len2);
4904 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4905 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4906 /* Don't use Fset_text_properties: that can cause GC, which can
4907 clobber objects stored in the tmp_intervals. */
4908 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4909 if (tmp_interval3)
4910 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4912 USE_SAFE_ALLOCA;
4914 /* First region smaller than second. */
4915 if (len1_byte < len2_byte)
4917 temp = SAFE_ALLOCA (len2_byte);
4919 /* Don't precompute these addresses. We have to compute them
4920 at the last minute, because the relocating allocator might
4921 have moved the buffer around during the xmalloc. */
4922 start1_addr = BYTE_POS_ADDR (start1_byte);
4923 start2_addr = BYTE_POS_ADDR (start2_byte);
4925 memcpy (temp, start2_addr, len2_byte);
4926 memcpy (start1_addr + len2_byte, start1_addr, len1_byte);
4927 memcpy (start1_addr, temp, len2_byte);
4929 else
4930 /* First region not smaller than second. */
4932 temp = SAFE_ALLOCA (len1_byte);
4933 start1_addr = BYTE_POS_ADDR (start1_byte);
4934 start2_addr = BYTE_POS_ADDR (start2_byte);
4935 memcpy (temp, start1_addr, len1_byte);
4936 memcpy (start1_addr, start2_addr, len2_byte);
4937 memcpy (start1_addr + len2_byte, temp, len1_byte);
4940 SAFE_FREE ();
4941 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4942 len1, current_buffer, 0);
4943 graft_intervals_into_buffer (tmp_interval2, start1,
4944 len2, current_buffer, 0);
4945 update_compositions (start1, start1 + len2, CHECK_BORDER);
4946 update_compositions (start1 + len2, end2, CHECK_TAIL);
4948 /* Non-adjacent regions, because end1 != start2, bleagh... */
4949 else
4951 len_mid = start2_byte - (start1_byte + len1_byte);
4953 if (len1_byte == len2_byte)
4954 /* Regions are same size, though, how nice. */
4956 USE_SAFE_ALLOCA;
4958 modify_text (start1, end1);
4959 modify_text (start2, end2);
4960 record_change (start1, len1);
4961 record_change (start2, len2);
4962 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4963 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4965 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4966 if (tmp_interval3)
4967 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4969 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4970 if (tmp_interval3)
4971 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4973 temp = SAFE_ALLOCA (len1_byte);
4974 start1_addr = BYTE_POS_ADDR (start1_byte);
4975 start2_addr = BYTE_POS_ADDR (start2_byte);
4976 memcpy (temp, start1_addr, len1_byte);
4977 memcpy (start1_addr, start2_addr, len2_byte);
4978 memcpy (start2_addr, temp, len1_byte);
4979 SAFE_FREE ();
4981 graft_intervals_into_buffer (tmp_interval1, start2,
4982 len1, current_buffer, 0);
4983 graft_intervals_into_buffer (tmp_interval2, start1,
4984 len2, current_buffer, 0);
4987 else if (len1_byte < len2_byte) /* Second region larger than first */
4988 /* Non-adjacent & unequal size, area between must also be shifted. */
4990 USE_SAFE_ALLOCA;
4992 modify_text (start1, end2);
4993 record_change (start1, (end2 - start1));
4994 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4995 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4996 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4998 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4999 if (tmp_interval3)
5000 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
5002 /* holds region 2 */
5003 temp = SAFE_ALLOCA (len2_byte);
5004 start1_addr = BYTE_POS_ADDR (start1_byte);
5005 start2_addr = BYTE_POS_ADDR (start2_byte);
5006 memcpy (temp, start2_addr, len2_byte);
5007 memcpy (start1_addr + len_mid + len2_byte, start1_addr, len1_byte);
5008 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
5009 memcpy (start1_addr, temp, len2_byte);
5010 SAFE_FREE ();
5012 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
5013 len1, current_buffer, 0);
5014 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
5015 len_mid, current_buffer, 0);
5016 graft_intervals_into_buffer (tmp_interval2, start1,
5017 len2, current_buffer, 0);
5019 else
5020 /* Second region smaller than first. */
5022 USE_SAFE_ALLOCA;
5024 record_change (start1, (end2 - start1));
5025 modify_text (start1, end2);
5027 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
5028 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
5029 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
5031 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
5032 if (tmp_interval3)
5033 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
5035 /* holds region 1 */
5036 temp = SAFE_ALLOCA (len1_byte);
5037 start1_addr = BYTE_POS_ADDR (start1_byte);
5038 start2_addr = BYTE_POS_ADDR (start2_byte);
5039 memcpy (temp, start1_addr, len1_byte);
5040 memcpy (start1_addr, start2_addr, len2_byte);
5041 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
5042 memcpy (start1_addr + len2_byte + len_mid, temp, len1_byte);
5043 SAFE_FREE ();
5045 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
5046 len1, current_buffer, 0);
5047 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
5048 len_mid, current_buffer, 0);
5049 graft_intervals_into_buffer (tmp_interval2, start1,
5050 len2, current_buffer, 0);
5053 update_compositions (start1, start1 + len2, CHECK_BORDER);
5054 update_compositions (end2 - len1, end2, CHECK_BORDER);
5057 /* When doing multiple transpositions, it might be nice
5058 to optimize this. Perhaps the markers in any one buffer
5059 should be organized in some sorted data tree. */
5060 if (NILP (leave_markers))
5062 transpose_markers (start1, end1, start2, end2,
5063 start1_byte, start1_byte + len1_byte,
5064 start2_byte, start2_byte + len2_byte);
5065 fix_start_end_in_overlays (start1, end2);
5067 else
5069 /* The character positions of the markers remain intact, but we
5070 still need to update their byte positions, because the
5071 transposed regions might include multibyte sequences which
5072 make some original byte positions of the markers invalid. */
5073 adjust_markers_bytepos (start1, start1_byte, end2, end2_byte, 0);
5076 signal_after_change (start1, end2 - start1, end2 - start1);
5077 return Qnil;
5081 void
5082 syms_of_editfns (void)
5084 DEFSYM (Qbuffer_access_fontify_functions, "buffer-access-fontify-functions");
5085 DEFSYM (Qwall, "wall");
5087 DEFVAR_LISP ("inhibit-field-text-motion", Vinhibit_field_text_motion,
5088 doc: /* Non-nil means text motion commands don't notice fields. */);
5089 Vinhibit_field_text_motion = Qnil;
5091 DEFVAR_LISP ("buffer-access-fontify-functions",
5092 Vbuffer_access_fontify_functions,
5093 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
5094 Each function is called with two arguments which specify the range
5095 of the buffer being accessed. */);
5096 Vbuffer_access_fontify_functions = Qnil;
5099 Lisp_Object obuf;
5100 obuf = Fcurrent_buffer ();
5101 /* Do this here, because init_buffer_once is too early--it won't work. */
5102 Fset_buffer (Vprin1_to_string_buffer);
5103 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
5104 Fset (Fmake_local_variable (Qbuffer_access_fontify_functions), Qnil);
5105 Fset_buffer (obuf);
5108 DEFVAR_LISP ("buffer-access-fontified-property",
5109 Vbuffer_access_fontified_property,
5110 doc: /* Property which (if non-nil) indicates text has been fontified.
5111 `buffer-substring' need not call the `buffer-access-fontify-functions'
5112 functions if all the text being accessed has this property. */);
5113 Vbuffer_access_fontified_property = Qnil;
5115 DEFVAR_LISP ("system-name", Vsystem_name,
5116 doc: /* The host name of the machine Emacs is running on. */);
5117 Vsystem_name = cached_system_name = Qnil;
5119 DEFVAR_LISP ("user-full-name", Vuser_full_name,
5120 doc: /* The full name of the user logged in. */);
5122 DEFVAR_LISP ("user-login-name", Vuser_login_name,
5123 doc: /* The user's name, taken from environment variables if possible. */);
5124 Vuser_login_name = Qnil;
5126 DEFVAR_LISP ("user-real-login-name", Vuser_real_login_name,
5127 doc: /* The user's name, based upon the real uid only. */);
5129 DEFVAR_LISP ("operating-system-release", Voperating_system_release,
5130 doc: /* The release of the operating system Emacs is running on. */);
5132 defsubr (&Spropertize);
5133 defsubr (&Schar_equal);
5134 defsubr (&Sgoto_char);
5135 defsubr (&Sstring_to_char);
5136 defsubr (&Schar_to_string);
5137 defsubr (&Sbyte_to_string);
5138 defsubr (&Sbuffer_substring);
5139 defsubr (&Sbuffer_substring_no_properties);
5140 defsubr (&Sbuffer_string);
5141 defsubr (&Sget_pos_property);
5143 defsubr (&Spoint_marker);
5144 defsubr (&Smark_marker);
5145 defsubr (&Spoint);
5146 defsubr (&Sregion_beginning);
5147 defsubr (&Sregion_end);
5149 /* Symbol for the text property used to mark fields. */
5150 DEFSYM (Qfield, "field");
5152 /* A special value for Qfield properties. */
5153 DEFSYM (Qboundary, "boundary");
5155 defsubr (&Sfield_beginning);
5156 defsubr (&Sfield_end);
5157 defsubr (&Sfield_string);
5158 defsubr (&Sfield_string_no_properties);
5159 defsubr (&Sdelete_field);
5160 defsubr (&Sconstrain_to_field);
5162 defsubr (&Sline_beginning_position);
5163 defsubr (&Sline_end_position);
5165 defsubr (&Ssave_excursion);
5166 defsubr (&Ssave_current_buffer);
5168 defsubr (&Sbuffer_size);
5169 defsubr (&Spoint_max);
5170 defsubr (&Spoint_min);
5171 defsubr (&Spoint_min_marker);
5172 defsubr (&Spoint_max_marker);
5173 defsubr (&Sgap_position);
5174 defsubr (&Sgap_size);
5175 defsubr (&Sposition_bytes);
5176 defsubr (&Sbyte_to_position);
5178 defsubr (&Sbobp);
5179 defsubr (&Seobp);
5180 defsubr (&Sbolp);
5181 defsubr (&Seolp);
5182 defsubr (&Sfollowing_char);
5183 defsubr (&Sprevious_char);
5184 defsubr (&Schar_after);
5185 defsubr (&Schar_before);
5186 defsubr (&Sinsert);
5187 defsubr (&Sinsert_before_markers);
5188 defsubr (&Sinsert_and_inherit);
5189 defsubr (&Sinsert_and_inherit_before_markers);
5190 defsubr (&Sinsert_char);
5191 defsubr (&Sinsert_byte);
5193 defsubr (&Suser_login_name);
5194 defsubr (&Suser_real_login_name);
5195 defsubr (&Suser_uid);
5196 defsubr (&Suser_real_uid);
5197 defsubr (&Sgroup_gid);
5198 defsubr (&Sgroup_real_gid);
5199 defsubr (&Suser_full_name);
5200 defsubr (&Semacs_pid);
5201 defsubr (&Scurrent_time);
5202 defsubr (&Stime_add);
5203 defsubr (&Stime_subtract);
5204 defsubr (&Stime_less_p);
5205 defsubr (&Sget_internal_run_time);
5206 defsubr (&Sformat_time_string);
5207 defsubr (&Sfloat_time);
5208 defsubr (&Sdecode_time);
5209 defsubr (&Sencode_time);
5210 defsubr (&Scurrent_time_string);
5211 defsubr (&Scurrent_time_zone);
5212 defsubr (&Sset_time_zone_rule);
5213 defsubr (&Ssystem_name);
5214 defsubr (&Smessage);
5215 defsubr (&Smessage_box);
5216 defsubr (&Smessage_or_box);
5217 defsubr (&Scurrent_message);
5218 defsubr (&Sformat);
5219 defsubr (&Sformat_message);
5221 defsubr (&Sinsert_buffer_substring);
5222 defsubr (&Scompare_buffer_substrings);
5223 defsubr (&Ssubst_char_in_region);
5224 defsubr (&Stranslate_region_internal);
5225 defsubr (&Sdelete_region);
5226 defsubr (&Sdelete_and_extract_region);
5227 defsubr (&Swiden);
5228 defsubr (&Snarrow_to_region);
5229 defsubr (&Ssave_restriction);
5230 defsubr (&Stranspose_regions);