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