1 /* Lisp functions pertaining to editing.
3 Copyright (C) 1985-1987, 1989, 1993-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <sys/types.h>
32 #ifdef HAVE_SYS_UTSNAME_H
33 #include <sys/utsname.h>
38 /* systime.h includes <sys/time.h> which, on some systems, is required
39 for <sys/resource.h>; thus systime.h must be included before
43 #if defined HAVE_SYS_RESOURCE_H
44 #include <sys/resource.h>
53 #include "intervals.h"
54 #include "character.h"
59 #include "blockinput.h"
61 #define TM_YEAR_BASE 1900
64 extern Lisp_Object
w32_get_internal_run_time (void);
67 static struct lisp_time
lisp_time_struct (Lisp_Object
, int *);
68 static void set_time_zone_rule (char const *);
69 static Lisp_Object
format_time_string (char const *, ptrdiff_t, struct timespec
,
71 static long int tm_gmtoff (struct tm
*);
72 static int tm_diff (struct tm
*, struct tm
*);
73 static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
75 #ifndef HAVE_TM_GMTOFF
76 # define HAVE_TM_GMTOFF false
79 /* The startup value of the TZ environment variable; null if unset. */
80 static char const *initial_tz
;
82 /* A valid but unlikely setting for the TZ environment variable.
83 It is OK (though a bit slower) if the user chooses this value. */
84 static char dump_tz_string
[] = "TZ=UtC0";
86 /* The cached value of Vsystem_name. This is used only to compare it
87 to Vsystem_name, so it need not be visible to the GC. */
88 static Lisp_Object cached_system_name
;
91 init_and_cache_system_name (void)
94 cached_system_name
= Vsystem_name
;
100 const char *user_name
;
102 struct passwd
*pw
; /* password entry for the current user */
105 /* Set up system_name even when dumping. */
106 init_and_cache_system_name ();
109 /* When just dumping out, set the time zone to a known unlikely value
110 and skip the rest of this function. */
114 xputenv (dump_tz_string
);
121 char *tz
= getenv ("TZ");
124 #if !defined CANNOT_DUMP && defined HAVE_TZSET
125 /* If the execution TZ happens to be the same as the dump TZ,
126 change it to some other value and then change it back,
127 to force the underlying implementation to reload the TZ info.
128 This is needed on implementations that load TZ info from files,
129 since the TZ file contents may differ between dump and execution. */
130 if (tz
&& strcmp (tz
, &dump_tz_string
[sizeof "TZ=" - 1]) == 0)
138 /* Call set_time_zone_rule now, so that its call to putenv is done
139 before multiple threads are active. */
140 set_time_zone_rule (tz
);
142 pw
= getpwuid (getuid ());
144 /* We let the real user name default to "root" because that's quite
145 accurate on MS-DOS and because it lets Emacs find the init file.
146 (The DVX libraries override the Djgpp libraries here.) */
147 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "root");
149 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "unknown");
152 /* Get the effective user name, by consulting environment variables,
153 or the effective uid if those are unset. */
154 user_name
= getenv ("LOGNAME");
157 user_name
= getenv ("USERNAME"); /* it's USERNAME on NT */
158 #else /* WINDOWSNT */
159 user_name
= getenv ("USER");
160 #endif /* WINDOWSNT */
163 pw
= getpwuid (geteuid ());
164 user_name
= pw
? pw
->pw_name
: "unknown";
166 Vuser_login_name
= build_string (user_name
);
168 /* If the user name claimed in the environment vars differs from
169 the real uid, use the claimed name to find the full name. */
170 tem
= Fstring_equal (Vuser_login_name
, Vuser_real_login_name
);
172 tem
= Vuser_login_name
;
175 uid_t euid
= geteuid ();
176 tem
= make_fixnum_or_float (euid
);
178 Vuser_full_name
= Fuser_full_name (tem
);
182 Vuser_full_name
= build_string (p
);
183 else if (NILP (Vuser_full_name
))
184 Vuser_full_name
= build_string ("unknown");
186 #ifdef HAVE_SYS_UTSNAME_H
190 Voperating_system_release
= build_string (uts
.release
);
193 Voperating_system_release
= Qnil
;
197 DEFUN ("char-to-string", Fchar_to_string
, Schar_to_string
, 1, 1, 0,
198 doc
: /* Convert arg CHAR to a string containing that character.
199 usage: (char-to-string CHAR) */)
200 (Lisp_Object character
)
203 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
205 CHECK_CHARACTER (character
);
206 c
= XFASTINT (character
);
208 len
= CHAR_STRING (c
, str
);
209 return make_string_from_bytes ((char *) str
, 1, len
);
212 DEFUN ("byte-to-string", Fbyte_to_string
, Sbyte_to_string
, 1, 1, 0,
213 doc
: /* Convert arg BYTE to a unibyte string containing that byte. */)
218 if (XINT (byte
) < 0 || XINT (byte
) > 255)
219 error ("Invalid byte");
221 return make_string_from_bytes ((char *) &b
, 1, 1);
224 DEFUN ("string-to-char", Fstring_to_char
, Sstring_to_char
, 1, 1, 0,
225 doc
: /* Return the first character in STRING. */)
226 (register Lisp_Object string
)
228 register Lisp_Object val
;
229 CHECK_STRING (string
);
232 if (STRING_MULTIBYTE (string
))
233 XSETFASTINT (val
, STRING_CHAR (SDATA (string
)));
235 XSETFASTINT (val
, SREF (string
, 0));
238 XSETFASTINT (val
, 0);
242 DEFUN ("point", Fpoint
, Spoint
, 0, 0, 0,
243 doc
: /* Return value of point, as an integer.
244 Beginning of buffer is position (point-min). */)
248 XSETFASTINT (temp
, PT
);
252 DEFUN ("point-marker", Fpoint_marker
, Spoint_marker
, 0, 0, 0,
253 doc
: /* Return value of point, as a marker object. */)
256 return build_marker (current_buffer
, PT
, PT_BYTE
);
259 DEFUN ("goto-char", Fgoto_char
, Sgoto_char
, 1, 1, "NGoto char: ",
260 doc
: /* Set point to POSITION, a number or marker.
261 Beginning of buffer is position (point-min), end is (point-max).
263 The return value is POSITION. */)
264 (register Lisp_Object position
)
266 if (MARKERP (position
))
267 set_point_from_marker (position
);
268 else if (INTEGERP (position
))
269 SET_PT (clip_to_bounds (BEGV
, XINT (position
), ZV
));
271 wrong_type_argument (Qinteger_or_marker_p
, position
);
276 /* Return the start or end position of the region.
277 BEGINNINGP means return the start.
278 If there is no region active, signal an error. */
281 region_limit (bool beginningp
)
285 if (!NILP (Vtransient_mark_mode
)
286 && NILP (Vmark_even_if_inactive
)
287 && NILP (BVAR (current_buffer
, mark_active
)))
288 xsignal0 (Qmark_inactive
);
290 m
= Fmarker_position (BVAR (current_buffer
, mark
));
292 error ("The mark is not set now, so there is no region");
294 /* Clip to the current narrowing (bug#11770). */
295 return make_number ((PT
< XFASTINT (m
)) == beginningp
297 : clip_to_bounds (BEGV
, XFASTINT (m
), ZV
));
300 DEFUN ("region-beginning", Fregion_beginning
, Sregion_beginning
, 0, 0, 0,
301 doc
: /* Return the integer value of point or mark, whichever is smaller. */)
304 return region_limit (1);
307 DEFUN ("region-end", Fregion_end
, Sregion_end
, 0, 0, 0,
308 doc
: /* Return the integer value of point or mark, whichever is larger. */)
311 return region_limit (0);
314 DEFUN ("mark-marker", Fmark_marker
, Smark_marker
, 0, 0, 0,
315 doc
: /* Return this buffer's mark, as a marker object.
316 Watch out! Moving this marker changes the mark position.
317 If you set the marker not to point anywhere, the buffer will have no mark. */)
320 return BVAR (current_buffer
, mark
);
324 /* Find all the overlays in the current buffer that touch position POS.
325 Return the number found, and store them in a vector in VEC
329 overlays_around (EMACS_INT pos
, Lisp_Object
*vec
, ptrdiff_t len
)
331 Lisp_Object overlay
, start
, end
;
332 struct Lisp_Overlay
*tail
;
333 ptrdiff_t startpos
, endpos
;
336 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
338 XSETMISC (overlay
, tail
);
340 end
= OVERLAY_END (overlay
);
341 endpos
= OVERLAY_POSITION (end
);
344 start
= OVERLAY_START (overlay
);
345 startpos
= OVERLAY_POSITION (start
);
350 /* Keep counting overlays even if we can't return them all. */
355 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
357 XSETMISC (overlay
, tail
);
359 start
= OVERLAY_START (overlay
);
360 startpos
= OVERLAY_POSITION (start
);
363 end
= OVERLAY_END (overlay
);
364 endpos
= OVERLAY_POSITION (end
);
376 DEFUN ("get-pos-property", Fget_pos_property
, Sget_pos_property
, 2, 3, 0,
377 doc
: /* Return the value of POSITION's property PROP, in OBJECT.
378 Almost identical to `get-char-property' except for the following difference:
379 Whereas `get-char-property' returns the property of the char at (i.e. right
380 after) POSITION, this pays attention to properties's stickiness and overlays's
381 advancement settings, in order to find the property of POSITION itself,
382 i.e. the property that a char would inherit if it were inserted
384 (Lisp_Object position
, register Lisp_Object prop
, Lisp_Object object
)
386 CHECK_NUMBER_COERCE_MARKER (position
);
389 XSETBUFFER (object
, current_buffer
);
390 else if (WINDOWP (object
))
391 object
= XWINDOW (object
)->contents
;
393 if (!BUFFERP (object
))
394 /* pos-property only makes sense in buffers right now, since strings
395 have no overlays and no notion of insertion for which stickiness
397 return Fget_text_property (position
, prop
, object
);
400 EMACS_INT posn
= XINT (position
);
402 Lisp_Object
*overlay_vec
, tem
;
403 struct buffer
*obuf
= current_buffer
;
406 set_buffer_temp (XBUFFER (object
));
408 /* First try with room for 40 overlays. */
409 Lisp_Object overlay_vecbuf
[40];
410 noverlays
= ARRAYELTS (overlay_vecbuf
);
411 overlay_vec
= overlay_vecbuf
;
412 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
414 /* If there are more than 40,
415 make enough space for all, and try again. */
416 if (ARRAYELTS (overlay_vecbuf
) < noverlays
)
418 SAFE_ALLOCA_LISP (overlay_vec
, noverlays
);
419 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
421 noverlays
= sort_overlays (overlay_vec
, noverlays
, NULL
);
423 set_buffer_temp (obuf
);
425 /* Now check the overlays in order of decreasing priority. */
426 while (--noverlays
>= 0)
428 Lisp_Object ol
= overlay_vec
[noverlays
];
429 tem
= Foverlay_get (ol
, prop
);
432 /* Check the overlay is indeed active at point. */
433 Lisp_Object start
= OVERLAY_START (ol
), finish
= OVERLAY_END (ol
);
434 if ((OVERLAY_POSITION (start
) == posn
435 && XMARKER (start
)->insertion_type
== 1)
436 || (OVERLAY_POSITION (finish
) == posn
437 && XMARKER (finish
)->insertion_type
== 0))
438 ; /* The overlay will not cover a char inserted at point. */
448 { /* Now check the text properties. */
449 int stickiness
= text_property_stickiness (prop
, position
, object
);
451 return Fget_text_property (position
, prop
, object
);
452 else if (stickiness
< 0
453 && XINT (position
) > BUF_BEGV (XBUFFER (object
)))
454 return Fget_text_property (make_number (XINT (position
) - 1),
462 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
463 the value of point is used instead. If BEG or END is null,
464 means don't store the beginning or end of the field.
466 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
467 results; they do not effect boundary behavior.
469 If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
470 position of a field, then the beginning of the previous field is
471 returned instead of the beginning of POS's field (since the end of a
472 field is actually also the beginning of the next input field, this
473 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
474 non-nil case, if two fields are separated by a field with the special
475 value `boundary', and POS lies within it, then the two separated
476 fields are considered to be adjacent, and POS between them, when
477 finding the beginning and ending of the "merged" field.
479 Either BEG or END may be 0, in which case the corresponding value
483 find_field (Lisp_Object pos
, Lisp_Object merge_at_boundary
,
484 Lisp_Object beg_limit
,
485 ptrdiff_t *beg
, Lisp_Object end_limit
, ptrdiff_t *end
)
487 /* Fields right before and after the point. */
488 Lisp_Object before_field
, after_field
;
489 /* True if POS counts as the start of a field. */
490 bool at_field_start
= 0;
491 /* True if POS counts as the end of a field. */
492 bool at_field_end
= 0;
495 XSETFASTINT (pos
, PT
);
497 CHECK_NUMBER_COERCE_MARKER (pos
);
500 = get_char_property_and_overlay (pos
, Qfield
, Qnil
, NULL
);
502 = (XFASTINT (pos
) > BEGV
503 ? get_char_property_and_overlay (make_number (XINT (pos
) - 1),
505 /* Using nil here would be a more obvious choice, but it would
506 fail when the buffer starts with a non-sticky field. */
509 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
510 and POS is at beginning of a field, which can also be interpreted
511 as the end of the previous field. Note that the case where if
512 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
513 more natural one; then we avoid treating the beginning of a field
515 if (NILP (merge_at_boundary
))
517 Lisp_Object field
= Fget_pos_property (pos
, Qfield
, Qnil
);
518 if (!EQ (field
, after_field
))
520 if (!EQ (field
, before_field
))
522 if (NILP (field
) && at_field_start
&& at_field_end
)
523 /* If an inserted char would have a nil field while the surrounding
524 text is non-nil, we're probably not looking at a
525 zero-length field, but instead at a non-nil field that's
526 not intended for editing (such as comint's prompts). */
527 at_field_end
= at_field_start
= 0;
530 /* Note about special `boundary' fields:
532 Consider the case where the point (`.') is between the fields `x' and `y':
536 In this situation, if merge_at_boundary is non-nil, consider the
537 `x' and `y' fields as forming one big merged field, and so the end
538 of the field is the end of `y'.
540 However, if `x' and `y' are separated by a special `boundary' field
541 (a field with a `field' char-property of 'boundary), then ignore
542 this special field when merging adjacent fields. Here's the same
543 situation, but with a `boundary' field between the `x' and `y' fields:
547 Here, if point is at the end of `x', the beginning of `y', or
548 anywhere in-between (within the `boundary' field), merge all
549 three fields and consider the beginning as being the beginning of
550 the `x' field, and the end as being the end of the `y' field. */
555 /* POS is at the edge of a field, and we should consider it as
556 the beginning of the following field. */
557 *beg
= XFASTINT (pos
);
559 /* Find the previous field boundary. */
562 if (!NILP (merge_at_boundary
) && EQ (before_field
, Qboundary
))
563 /* Skip a `boundary' field. */
564 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
567 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
569 *beg
= NILP (p
) ? BEGV
: XFASTINT (p
);
576 /* POS is at the edge of a field, and we should consider it as
577 the end of the previous field. */
578 *end
= XFASTINT (pos
);
580 /* Find the next field boundary. */
582 if (!NILP (merge_at_boundary
) && EQ (after_field
, Qboundary
))
583 /* Skip a `boundary' field. */
584 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
587 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
589 *end
= NILP (pos
) ? ZV
: XFASTINT (pos
);
595 DEFUN ("delete-field", Fdelete_field
, Sdelete_field
, 0, 1, 0,
596 doc
: /* Delete the field surrounding POS.
597 A field is a region of text with the same `field' property.
598 If POS is nil, the value of point is used for POS. */)
602 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
604 del_range (beg
, end
);
608 DEFUN ("field-string", Ffield_string
, Sfield_string
, 0, 1, 0,
609 doc
: /* Return the contents of the field surrounding POS as a string.
610 A field is a region of text with the same `field' property.
611 If POS is nil, the value of point is used for POS. */)
615 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
616 return make_buffer_string (beg
, end
, 1);
619 DEFUN ("field-string-no-properties", Ffield_string_no_properties
, Sfield_string_no_properties
, 0, 1, 0,
620 doc
: /* Return the contents of the field around POS, without text properties.
621 A field is a region of text with the same `field' property.
622 If POS is nil, the value of point is used for POS. */)
626 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
627 return make_buffer_string (beg
, end
, 0);
630 DEFUN ("field-beginning", Ffield_beginning
, Sfield_beginning
, 0, 3, 0,
631 doc
: /* Return the beginning of the field surrounding POS.
632 A field is a region of text with the same `field' property.
633 If POS is nil, the value of point is used for POS.
634 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
635 field, then the beginning of the *previous* field is returned.
636 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
637 is before LIMIT, then LIMIT will be returned instead. */)
638 (Lisp_Object pos
, Lisp_Object escape_from_edge
, Lisp_Object limit
)
641 find_field (pos
, escape_from_edge
, limit
, &beg
, Qnil
, 0);
642 return make_number (beg
);
645 DEFUN ("field-end", Ffield_end
, Sfield_end
, 0, 3, 0,
646 doc
: /* Return the end of the field surrounding POS.
647 A field is a region of text with the same `field' property.
648 If POS is nil, the value of point is used for POS.
649 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
650 then the end of the *following* field is returned.
651 If LIMIT is non-nil, it is a buffer position; if the end of the field
652 is after LIMIT, then LIMIT will be returned instead. */)
653 (Lisp_Object pos
, Lisp_Object escape_from_edge
, Lisp_Object limit
)
656 find_field (pos
, escape_from_edge
, Qnil
, 0, limit
, &end
);
657 return make_number (end
);
660 DEFUN ("constrain-to-field", Fconstrain_to_field
, Sconstrain_to_field
, 2, 5, 0,
661 doc
: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
662 A field is a region of text with the same `field' property.
664 If NEW-POS is nil, then use the current point instead, and move point
665 to the resulting constrained position, in addition to returning that
668 If OLD-POS is at the boundary of two fields, then the allowable
669 positions for NEW-POS depends on the value of the optional argument
670 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
671 constrained to the field that has the same `field' char-property
672 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
673 is non-nil, NEW-POS is constrained to the union of the two adjacent
674 fields. Additionally, if two fields are separated by another field with
675 the special value `boundary', then any point within this special field is
676 also considered to be `on the boundary'.
678 If the optional argument ONLY-IN-LINE is non-nil and constraining
679 NEW-POS would move it to a different line, NEW-POS is returned
680 unconstrained. This is useful for commands that move by line, like
681 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
682 only in the case where they can still move to the right line.
684 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
685 a non-nil property of that name, then any field boundaries are ignored.
687 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
688 (Lisp_Object new_pos
, Lisp_Object old_pos
, Lisp_Object escape_from_edge
,
689 Lisp_Object only_in_line
, Lisp_Object inhibit_capture_property
)
691 /* If non-zero, then the original point, before re-positioning. */
692 ptrdiff_t orig_point
= 0;
694 Lisp_Object prev_old
, prev_new
;
697 /* Use the current point, and afterwards, set it. */
700 XSETFASTINT (new_pos
, PT
);
703 CHECK_NUMBER_COERCE_MARKER (new_pos
);
704 CHECK_NUMBER_COERCE_MARKER (old_pos
);
706 fwd
= (XINT (new_pos
) > XINT (old_pos
));
708 prev_old
= make_number (XINT (old_pos
) - 1);
709 prev_new
= make_number (XINT (new_pos
) - 1);
711 if (NILP (Vinhibit_field_text_motion
)
712 && !EQ (new_pos
, old_pos
)
713 && (!NILP (Fget_char_property (new_pos
, Qfield
, Qnil
))
714 || !NILP (Fget_char_property (old_pos
, Qfield
, Qnil
))
715 /* To recognize field boundaries, we must also look at the
716 previous positions; we could use `Fget_pos_property'
717 instead, but in itself that would fail inside non-sticky
718 fields (like comint prompts). */
719 || (XFASTINT (new_pos
) > BEGV
720 && !NILP (Fget_char_property (prev_new
, Qfield
, Qnil
)))
721 || (XFASTINT (old_pos
) > BEGV
722 && !NILP (Fget_char_property (prev_old
, Qfield
, Qnil
))))
723 && (NILP (inhibit_capture_property
)
724 /* Field boundaries are again a problem; but now we must
725 decide the case exactly, so we need to call
726 `get_pos_property' as well. */
727 || (NILP (Fget_pos_property (old_pos
, inhibit_capture_property
, Qnil
))
728 && (XFASTINT (old_pos
) <= BEGV
729 || NILP (Fget_char_property
730 (old_pos
, inhibit_capture_property
, Qnil
))
731 || NILP (Fget_char_property
732 (prev_old
, inhibit_capture_property
, Qnil
))))))
733 /* It is possible that NEW_POS is not within the same field as
734 OLD_POS; try to move NEW_POS so that it is. */
737 Lisp_Object field_bound
;
740 field_bound
= Ffield_end (old_pos
, escape_from_edge
, new_pos
);
742 field_bound
= Ffield_beginning (old_pos
, escape_from_edge
, new_pos
);
744 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
745 other side of NEW_POS, which would mean that NEW_POS is
746 already acceptable, and it's not necessary to constrain it
748 ((XFASTINT (field_bound
) < XFASTINT (new_pos
)) ? fwd
: !fwd
)
749 /* NEW_POS should be constrained, but only if either
750 ONLY_IN_LINE is nil (in which case any constraint is OK),
751 or NEW_POS and FIELD_BOUND are on the same line (in which
752 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
753 && (NILP (only_in_line
)
754 /* This is the ONLY_IN_LINE case, check that NEW_POS and
755 FIELD_BOUND are on the same line by seeing whether
756 there's an intervening newline or not. */
757 || (find_newline (XFASTINT (new_pos
), -1,
758 XFASTINT (field_bound
), -1,
759 fwd
? -1 : 1, &shortage
, NULL
, 1),
761 /* Constrain NEW_POS to FIELD_BOUND. */
762 new_pos
= field_bound
;
764 if (orig_point
&& XFASTINT (new_pos
) != orig_point
)
765 /* The NEW_POS argument was originally nil, so automatically set PT. */
766 SET_PT (XFASTINT (new_pos
));
773 DEFUN ("line-beginning-position",
774 Fline_beginning_position
, Sline_beginning_position
, 0, 1, 0,
775 doc
: /* Return the character position of the first character on the current line.
776 With optional argument N, scan forward N - 1 lines first.
777 If the scan reaches the end of the buffer, return that position.
779 This function ignores text display directionality; it returns the
780 position of the first character in logical order, i.e. the smallest
781 character position on the line.
783 This function constrains the returned position to the current field
784 unless that position would be on a different line than the original,
785 unconstrained result. If N is nil or 1, and a front-sticky field
786 starts at point, the scan stops as soon as it starts. To ignore field
787 boundaries, bind `inhibit-field-text-motion' to t.
789 This function does not move point. */)
792 ptrdiff_t charpos
, bytepos
;
799 scan_newline_from_point (XINT (n
) - 1, &charpos
, &bytepos
);
801 /* Return END constrained to the current input field. */
802 return Fconstrain_to_field (make_number (charpos
), make_number (PT
),
803 XINT (n
) != 1 ? Qt
: Qnil
,
807 DEFUN ("line-end-position", Fline_end_position
, Sline_end_position
, 0, 1, 0,
808 doc
: /* Return the character position of the last character on the current line.
809 With argument N not nil or 1, move forward N - 1 lines first.
810 If scan reaches end of buffer, return that position.
812 This function ignores text display directionality; it returns the
813 position of the last character in logical order, i.e. the largest
814 character position on the line.
816 This function constrains the returned position to the current field
817 unless that would be on a different line than the original,
818 unconstrained result. If N is nil or 1, and a rear-sticky field ends
819 at point, the scan stops as soon as it starts. To ignore field
820 boundaries bind `inhibit-field-text-motion' to t.
822 This function does not move point. */)
834 clipped_n
= clip_to_bounds (PTRDIFF_MIN
+ 1, XINT (n
), PTRDIFF_MAX
);
835 end_pos
= find_before_next_newline (orig
, 0, clipped_n
- (clipped_n
<= 0),
838 /* Return END_POS constrained to the current input field. */
839 return Fconstrain_to_field (make_number (end_pos
), make_number (orig
),
843 /* Save current buffer state for `save-excursion' special form.
844 We (ab)use Lisp_Misc_Save_Value to allow explicit free and so
845 offload some work from GC. */
848 save_excursion_save (void)
850 return make_save_obj_obj_obj_obj
852 /* Do not copy the mark if it points to nowhere. */
853 (XMARKER (BVAR (current_buffer
, mark
))->buffer
854 ? Fcopy_marker (BVAR (current_buffer
, mark
), Qnil
)
856 /* Selected window if current buffer is shown in it, nil otherwise. */
857 (EQ (XWINDOW (selected_window
)->contents
, Fcurrent_buffer ())
858 ? selected_window
: Qnil
),
859 BVAR (current_buffer
, mark_active
));
862 /* Restore saved buffer before leaving `save-excursion' special form. */
865 save_excursion_restore (Lisp_Object info
)
867 Lisp_Object tem
, tem1
, omark
, nmark
;
868 struct gcpro gcpro1
, gcpro2
, gcpro3
;
870 tem
= Fmarker_buffer (XSAVE_OBJECT (info
, 0));
871 /* If we're unwinding to top level, saved buffer may be deleted. This
872 means that all of its markers are unchained and so tem is nil. */
876 omark
= nmark
= Qnil
;
877 GCPRO3 (info
, omark
, nmark
);
882 tem
= XSAVE_OBJECT (info
, 0);
884 unchain_marker (XMARKER (tem
));
887 tem
= XSAVE_OBJECT (info
, 1);
888 omark
= Fmarker_position (BVAR (current_buffer
, mark
));
890 unchain_marker (XMARKER (BVAR (current_buffer
, mark
)));
893 Fset_marker (BVAR (current_buffer
, mark
), tem
, Fcurrent_buffer ());
894 nmark
= Fmarker_position (tem
);
895 unchain_marker (XMARKER (tem
));
899 tem
= XSAVE_OBJECT (info
, 3);
900 tem1
= BVAR (current_buffer
, mark_active
);
901 bset_mark_active (current_buffer
, tem
);
903 /* If mark is active now, and either was not active
904 or was at a different place, run the activate hook. */
907 if (! EQ (omark
, nmark
))
908 run_hook (intern ("activate-mark-hook"));
910 /* If mark has ceased to be active, run deactivate hook. */
911 else if (! NILP (tem1
))
912 run_hook (intern ("deactivate-mark-hook"));
914 /* If buffer was visible in a window, and a different window was
915 selected, and the old selected window is still showing this
916 buffer, restore point in that window. */
917 tem
= XSAVE_OBJECT (info
, 2);
919 && !EQ (tem
, selected_window
)
920 && (tem1
= XWINDOW (tem
)->contents
,
921 (/* Window is live... */
923 /* ...and it shows the current buffer. */
924 && XBUFFER (tem1
) == current_buffer
)))
925 Fset_window_point (tem
, make_number (PT
));
934 DEFUN ("save-excursion", Fsave_excursion
, Ssave_excursion
, 0, UNEVALLED
, 0,
935 doc
: /* Save point, mark, and current buffer; execute BODY; restore those things.
936 Executes BODY just like `progn'.
937 The values of point, mark and the current buffer are restored
938 even in case of abnormal exit (throw or error).
939 The state of activation of the mark is also restored.
941 This construct does not save `deactivate-mark', and therefore
942 functions that change the buffer will still cause deactivation
943 of the mark at the end of the command. To prevent that, bind
944 `deactivate-mark' with `let'.
946 If you only want to save the current buffer but not point nor mark,
947 then just use `save-current-buffer', or even `with-current-buffer'.
949 usage: (save-excursion &rest BODY) */)
952 register Lisp_Object val
;
953 ptrdiff_t count
= SPECPDL_INDEX ();
955 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
958 return unbind_to (count
, val
);
961 DEFUN ("save-current-buffer", Fsave_current_buffer
, Ssave_current_buffer
, 0, UNEVALLED
, 0,
962 doc
: /* Record which buffer is current; execute BODY; make that buffer current.
963 BODY is executed just like `progn'.
964 usage: (save-current-buffer &rest BODY) */)
967 ptrdiff_t count
= SPECPDL_INDEX ();
969 record_unwind_current_buffer ();
970 return unbind_to (count
, Fprogn (args
));
973 DEFUN ("buffer-size", Fbuffer_size
, Sbuffer_size
, 0, 1, 0,
974 doc
: /* Return the number of characters in the current buffer.
975 If BUFFER, return the number of characters in that buffer instead. */)
979 return make_number (Z
- BEG
);
982 CHECK_BUFFER (buffer
);
983 return make_number (BUF_Z (XBUFFER (buffer
))
984 - BUF_BEG (XBUFFER (buffer
)));
988 DEFUN ("point-min", Fpoint_min
, Spoint_min
, 0, 0, 0,
989 doc
: /* Return the minimum permissible value of point in the current buffer.
990 This is 1, unless narrowing (a buffer restriction) is in effect. */)
994 XSETFASTINT (temp
, BEGV
);
998 DEFUN ("point-min-marker", Fpoint_min_marker
, Spoint_min_marker
, 0, 0, 0,
999 doc
: /* Return a marker to the minimum permissible value of point in this buffer.
1000 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1003 return build_marker (current_buffer
, BEGV
, BEGV_BYTE
);
1006 DEFUN ("point-max", Fpoint_max
, Spoint_max
, 0, 0, 0,
1007 doc
: /* Return the maximum permissible value of point in the current buffer.
1008 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1009 is in effect, in which case it is less. */)
1013 XSETFASTINT (temp
, ZV
);
1017 DEFUN ("point-max-marker", Fpoint_max_marker
, Spoint_max_marker
, 0, 0, 0,
1018 doc
: /* Return a marker to the maximum permissible value of point in this buffer.
1019 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1020 is in effect, in which case it is less. */)
1023 return build_marker (current_buffer
, ZV
, ZV_BYTE
);
1026 DEFUN ("gap-position", Fgap_position
, Sgap_position
, 0, 0, 0,
1027 doc
: /* Return the position of the gap, in the current buffer.
1028 See also `gap-size'. */)
1032 XSETFASTINT (temp
, GPT
);
1036 DEFUN ("gap-size", Fgap_size
, Sgap_size
, 0, 0, 0,
1037 doc
: /* Return the size of the current buffer's gap.
1038 See also `gap-position'. */)
1042 XSETFASTINT (temp
, GAP_SIZE
);
1046 DEFUN ("position-bytes", Fposition_bytes
, Sposition_bytes
, 1, 1, 0,
1047 doc
: /* Return the byte position for character position POSITION.
1048 If POSITION is out of range, the value is nil. */)
1049 (Lisp_Object position
)
1051 CHECK_NUMBER_COERCE_MARKER (position
);
1052 if (XINT (position
) < BEG
|| XINT (position
) > Z
)
1054 return make_number (CHAR_TO_BYTE (XINT (position
)));
1057 DEFUN ("byte-to-position", Fbyte_to_position
, Sbyte_to_position
, 1, 1, 0,
1058 doc
: /* Return the character position for byte position BYTEPOS.
1059 If BYTEPOS is out of range, the value is nil. */)
1060 (Lisp_Object bytepos
)
1062 CHECK_NUMBER (bytepos
);
1063 if (XINT (bytepos
) < BEG_BYTE
|| XINT (bytepos
) > Z_BYTE
)
1065 return make_number (BYTE_TO_CHAR (XINT (bytepos
)));
1068 DEFUN ("following-char", Ffollowing_char
, Sfollowing_char
, 0, 0, 0,
1069 doc
: /* Return the character following point, as a number.
1070 At the end of the buffer or accessible region, return 0. */)
1075 XSETFASTINT (temp
, 0);
1077 XSETFASTINT (temp
, FETCH_CHAR (PT_BYTE
));
1081 DEFUN ("preceding-char", Fprevious_char
, Sprevious_char
, 0, 0, 0,
1082 doc
: /* Return the character preceding point, as a number.
1083 At the beginning of the buffer or accessible region, return 0. */)
1088 XSETFASTINT (temp
, 0);
1089 else if (!NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1091 ptrdiff_t pos
= PT_BYTE
;
1093 XSETFASTINT (temp
, FETCH_CHAR (pos
));
1096 XSETFASTINT (temp
, FETCH_BYTE (PT_BYTE
- 1));
1100 DEFUN ("bobp", Fbobp
, Sbobp
, 0, 0, 0,
1101 doc
: /* Return t if point is at the beginning of the buffer.
1102 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1110 DEFUN ("eobp", Feobp
, Seobp
, 0, 0, 0,
1111 doc
: /* Return t if point is at the end of the buffer.
1112 If the buffer is narrowed, this means the end of the narrowed part. */)
1120 DEFUN ("bolp", Fbolp
, Sbolp
, 0, 0, 0,
1121 doc
: /* Return t if point is at the beginning of a line. */)
1124 if (PT
== BEGV
|| FETCH_BYTE (PT_BYTE
- 1) == '\n')
1129 DEFUN ("eolp", Feolp
, Seolp
, 0, 0, 0,
1130 doc
: /* Return t if point is at the end of a line.
1131 `End of a line' includes point being at the end of the buffer. */)
1134 if (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n')
1139 DEFUN ("char-after", Fchar_after
, Schar_after
, 0, 1, 0,
1140 doc
: /* Return character in current buffer at position POS.
1141 POS is an integer or a marker and defaults to point.
1142 If POS is out of range, the value is nil. */)
1145 register ptrdiff_t pos_byte
;
1150 XSETFASTINT (pos
, PT
);
1155 pos_byte
= marker_byte_position (pos
);
1156 if (pos_byte
< BEGV_BYTE
|| pos_byte
>= ZV_BYTE
)
1161 CHECK_NUMBER_COERCE_MARKER (pos
);
1162 if (XINT (pos
) < BEGV
|| XINT (pos
) >= ZV
)
1165 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1168 return make_number (FETCH_CHAR (pos_byte
));
1171 DEFUN ("char-before", Fchar_before
, Schar_before
, 0, 1, 0,
1172 doc
: /* Return character in current buffer preceding position POS.
1173 POS is an integer or a marker and defaults to point.
1174 If POS is out of range, the value is nil. */)
1177 register Lisp_Object val
;
1178 register ptrdiff_t pos_byte
;
1183 XSETFASTINT (pos
, PT
);
1188 pos_byte
= marker_byte_position (pos
);
1190 if (pos_byte
<= BEGV_BYTE
|| pos_byte
> ZV_BYTE
)
1195 CHECK_NUMBER_COERCE_MARKER (pos
);
1197 if (XINT (pos
) <= BEGV
|| XINT (pos
) > ZV
)
1200 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1203 if (!NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1206 XSETFASTINT (val
, FETCH_CHAR (pos_byte
));
1211 XSETFASTINT (val
, FETCH_BYTE (pos_byte
));
1216 DEFUN ("user-login-name", Fuser_login_name
, Suser_login_name
, 0, 1, 0,
1217 doc
: /* Return the name under which the user logged in, as a string.
1218 This is based on the effective uid, not the real uid.
1219 Also, if the environment variables LOGNAME or USER are set,
1220 that determines the value of this function.
1222 If optional argument UID is an integer or a float, return the login name
1223 of the user with that uid, or nil if there is no such user. */)
1229 /* Set up the user name info if we didn't do it before.
1230 (That can happen if Emacs is dumpable
1231 but you decide to run `temacs -l loadup' and not dump. */
1232 if (INTEGERP (Vuser_login_name
))
1236 return Vuser_login_name
;
1238 CONS_TO_INTEGER (uid
, uid_t
, id
);
1242 return (pw
? build_string (pw
->pw_name
) : Qnil
);
1245 DEFUN ("user-real-login-name", Fuser_real_login_name
, Suser_real_login_name
,
1247 doc
: /* Return the name of the user's real uid, as a string.
1248 This ignores the environment variables LOGNAME and USER, so it differs from
1249 `user-login-name' when running under `su'. */)
1252 /* Set up the user name info if we didn't do it before.
1253 (That can happen if Emacs is dumpable
1254 but you decide to run `temacs -l loadup' and not dump. */
1255 if (INTEGERP (Vuser_login_name
))
1257 return Vuser_real_login_name
;
1260 DEFUN ("user-uid", Fuser_uid
, Suser_uid
, 0, 0, 0,
1261 doc
: /* Return the effective uid of Emacs.
1262 Value is an integer or a float, depending on the value. */)
1265 uid_t euid
= geteuid ();
1266 return make_fixnum_or_float (euid
);
1269 DEFUN ("user-real-uid", Fuser_real_uid
, Suser_real_uid
, 0, 0, 0,
1270 doc
: /* Return the real uid of Emacs.
1271 Value is an integer or a float, depending on the value. */)
1274 uid_t uid
= getuid ();
1275 return make_fixnum_or_float (uid
);
1278 DEFUN ("group-gid", Fgroup_gid
, Sgroup_gid
, 0, 0, 0,
1279 doc
: /* Return the effective gid of Emacs.
1280 Value is an integer or a float, depending on the value. */)
1283 gid_t egid
= getegid ();
1284 return make_fixnum_or_float (egid
);
1287 DEFUN ("group-real-gid", Fgroup_real_gid
, Sgroup_real_gid
, 0, 0, 0,
1288 doc
: /* Return the real gid of Emacs.
1289 Value is an integer or a float, depending on the value. */)
1292 gid_t gid
= getgid ();
1293 return make_fixnum_or_float (gid
);
1296 DEFUN ("user-full-name", Fuser_full_name
, Suser_full_name
, 0, 1, 0,
1297 doc
: /* Return the full name of the user logged in, as a string.
1298 If the full name corresponding to Emacs's userid is not known,
1301 If optional argument UID is an integer or float, return the full name
1302 of the user with that uid, or nil if there is no such user.
1303 If UID is a string, return the full name of the user with that login
1304 name, or nil if there is no such user. */)
1308 register char *p
, *q
;
1312 return Vuser_full_name
;
1313 else if (NUMBERP (uid
))
1316 CONS_TO_INTEGER (uid
, uid_t
, u
);
1321 else if (STRINGP (uid
))
1324 pw
= getpwnam (SSDATA (uid
));
1328 error ("Invalid UID specification");
1334 /* Chop off everything after the first comma. */
1335 q
= strchr (p
, ',');
1336 full
= make_string (p
, q
? q
- p
: strlen (p
));
1338 #ifdef AMPERSAND_FULL_NAME
1340 q
= strchr (p
, '&');
1341 /* Substitute the login name for the &, upcasing the first character. */
1344 Lisp_Object login
= Fuser_login_name (make_number (pw
->pw_uid
));
1346 char *r
= SAFE_ALLOCA (strlen (p
) + SBYTES (login
) + 1);
1347 memcpy (r
, p
, q
- p
);
1348 char *s
= lispstpcpy (&r
[q
- p
], login
);
1349 r
[q
- p
] = upcase ((unsigned char) r
[q
- p
]);
1351 full
= build_string (r
);
1354 #endif /* AMPERSAND_FULL_NAME */
1359 DEFUN ("system-name", Fsystem_name
, Ssystem_name
, 0, 0, 0,
1360 doc
: /* Return the host name of the machine you are running on, as a string. */)
1363 if (EQ (Vsystem_name
, cached_system_name
))
1364 init_and_cache_system_name ();
1365 return Vsystem_name
;
1368 DEFUN ("emacs-pid", Femacs_pid
, Semacs_pid
, 0, 0, 0,
1369 doc
: /* Return the process ID of Emacs, as a number. */)
1372 pid_t pid
= getpid ();
1373 return make_fixnum_or_float (pid
);
1379 # define TIME_T_MIN TYPE_MINIMUM (time_t)
1382 # define TIME_T_MAX TYPE_MAXIMUM (time_t)
1385 /* Report that a time value is out of range for Emacs. */
1387 time_overflow (void)
1389 error ("Specified time is not representable");
1395 error ("Invalid time specification");
1398 /* A substitute for mktime_z on platforms that lack it. It's not
1399 thread-safe, but should be good enough for Emacs in typical use. */
1400 #ifndef HAVE_TZALLOC
1402 mktime_z (timezone_t tz
, struct tm
*tm
)
1404 char *oldtz
= getenv ("TZ");
1408 size_t oldtzsize
= strlen (oldtz
) + 1;
1409 char *oldtzcopy
= SAFE_ALLOCA (oldtzsize
);
1410 oldtz
= strcpy (oldtzcopy
, oldtz
);
1413 set_time_zone_rule (tz
);
1414 time_t t
= mktime (tm
);
1415 set_time_zone_rule (oldtz
);
1422 /* Return the upper part of the time T (everything but the bottom 16 bits). */
1426 time_t hi
= t
>> LO_TIME_BITS
;
1428 /* Check for overflow, helping the compiler for common cases where
1429 no runtime check is needed, and taking care not to convert
1430 negative numbers to unsigned before comparing them. */
1431 if (! ((! TYPE_SIGNED (time_t)
1432 || MOST_NEGATIVE_FIXNUM
<= TIME_T_MIN
>> LO_TIME_BITS
1433 || MOST_NEGATIVE_FIXNUM
<= hi
)
1434 && (TIME_T_MAX
>> LO_TIME_BITS
<= MOST_POSITIVE_FIXNUM
1435 || hi
<= MOST_POSITIVE_FIXNUM
)))
1441 /* Return the bottom bits of the time T. */
1445 return t
& ((1 << LO_TIME_BITS
) - 1);
1448 DEFUN ("current-time", Fcurrent_time
, Scurrent_time
, 0, 0, 0,
1449 doc
: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1450 The time is returned as a list of integers (HIGH LOW USEC PSEC).
1451 HIGH has the most significant bits of the seconds, while LOW has the
1452 least significant 16 bits. USEC and PSEC are the microsecond and
1453 picosecond counts. */)
1456 return make_lisp_time (current_timespec ());
1459 static struct lisp_time
1460 time_add (struct lisp_time ta
, struct lisp_time tb
)
1462 EMACS_INT hi
= ta
.hi
+ tb
.hi
;
1463 int lo
= ta
.lo
+ tb
.lo
;
1464 int us
= ta
.us
+ tb
.us
;
1465 int ps
= ta
.ps
+ tb
.ps
;
1466 us
+= (1000000 <= ps
);
1467 ps
-= (1000000 <= ps
) * 1000000;
1468 lo
+= (1000000 <= us
);
1469 us
-= (1000000 <= us
) * 1000000;
1470 hi
+= (1 << LO_TIME_BITS
<= lo
);
1471 lo
-= (1 << LO_TIME_BITS
<= lo
) << LO_TIME_BITS
;
1472 return (struct lisp_time
) { hi
, lo
, us
, ps
};
1475 static struct lisp_time
1476 time_subtract (struct lisp_time ta
, struct lisp_time tb
)
1478 EMACS_INT hi
= ta
.hi
- tb
.hi
;
1479 int lo
= ta
.lo
- tb
.lo
;
1480 int us
= ta
.us
- tb
.us
;
1481 int ps
= ta
.ps
- tb
.ps
;
1483 ps
+= (ps
< 0) * 1000000;
1485 us
+= (us
< 0) * 1000000;
1487 lo
+= (lo
< 0) << LO_TIME_BITS
;
1488 return (struct lisp_time
) { hi
, lo
, us
, ps
};
1492 time_arith (Lisp_Object a
, Lisp_Object b
,
1493 struct lisp_time (*op
) (struct lisp_time
, struct lisp_time
))
1496 struct lisp_time ta
= lisp_time_struct (a
, &alen
);
1497 struct lisp_time tb
= lisp_time_struct (b
, &blen
);
1498 struct lisp_time t
= op (ta
, tb
);
1499 if (! (MOST_NEGATIVE_FIXNUM
<= t
.hi
&& t
.hi
<= MOST_POSITIVE_FIXNUM
))
1501 Lisp_Object val
= Qnil
;
1503 switch (max (alen
, blen
))
1506 val
= Fcons (make_number (t
.ps
), val
);
1509 val
= Fcons (make_number (t
.us
), val
);
1512 val
= Fcons (make_number (t
.lo
), val
);
1513 val
= Fcons (make_number (t
.hi
), val
);
1520 DEFUN ("time-add", Ftime_add
, Stime_add
, 2, 2, 0,
1521 doc
: /* Return the sum of two time values A and B, as a time value. */)
1522 (Lisp_Object a
, Lisp_Object b
)
1524 return time_arith (a
, b
, time_add
);
1527 DEFUN ("time-subtract", Ftime_subtract
, Stime_subtract
, 2, 2, 0,
1528 doc
: /* Return the difference between two time values A and B, as a time value. */)
1529 (Lisp_Object a
, Lisp_Object b
)
1531 return time_arith (a
, b
, time_subtract
);
1534 DEFUN ("time-less-p", Ftime_less_p
, Stime_less_p
, 2, 2, 0,
1535 doc
: /* Return non-nil if time value T1 is earlier than time value T2. */)
1536 (Lisp_Object t1
, Lisp_Object t2
)
1539 struct lisp_time a
= lisp_time_struct (t1
, &t1len
);
1540 struct lisp_time b
= lisp_time_struct (t2
, &t2len
);
1541 return ((a
.hi
!= b
.hi
? a
.hi
< b
.hi
1542 : a
.lo
!= b
.lo
? a
.lo
< b
.lo
1543 : a
.us
!= b
.us
? a
.us
< b
.us
1549 DEFUN ("get-internal-run-time", Fget_internal_run_time
, Sget_internal_run_time
,
1551 doc
: /* Return the current run time used by Emacs.
1552 The time is returned as a list (HIGH LOW USEC PSEC), using the same
1553 style as (current-time).
1555 On systems that can't determine the run time, `get-internal-run-time'
1556 does the same thing as `current-time'. */)
1559 #ifdef HAVE_GETRUSAGE
1560 struct rusage usage
;
1564 if (getrusage (RUSAGE_SELF
, &usage
) < 0)
1565 /* This shouldn't happen. What action is appropriate? */
1568 /* Sum up user time and system time. */
1569 secs
= usage
.ru_utime
.tv_sec
+ usage
.ru_stime
.tv_sec
;
1570 usecs
= usage
.ru_utime
.tv_usec
+ usage
.ru_stime
.tv_usec
;
1571 if (usecs
>= 1000000)
1576 return make_lisp_time (make_timespec (secs
, usecs
* 1000));
1577 #else /* ! HAVE_GETRUSAGE */
1579 return w32_get_internal_run_time ();
1580 #else /* ! WINDOWSNT */
1581 return Fcurrent_time ();
1582 #endif /* WINDOWSNT */
1583 #endif /* HAVE_GETRUSAGE */
1587 /* Make a Lisp list that represents the Emacs time T. T may be an
1588 invalid time, with a slightly negative tv_nsec value such as
1589 UNKNOWN_MODTIME_NSECS; in that case, the Lisp list contains a
1590 correspondingly negative picosecond count. */
1592 make_lisp_time (struct timespec t
)
1594 time_t s
= t
.tv_sec
;
1596 return list4i (hi_time (s
), lo_time (s
), ns
/ 1000, ns
% 1000 * 1000);
1599 /* Decode a Lisp list SPECIFIED_TIME that represents a time.
1600 Set *PHIGH, *PLOW, *PUSEC, *PPSEC to its parts; do not check their values.
1601 Return 2, 3, or 4 to indicate the effective length of SPECIFIED_TIME
1602 if successful, 0 if unsuccessful. */
1604 disassemble_lisp_time (Lisp_Object specified_time
, Lisp_Object
*phigh
,
1605 Lisp_Object
*plow
, Lisp_Object
*pusec
,
1608 Lisp_Object high
= make_number (0);
1609 Lisp_Object low
= specified_time
;
1610 Lisp_Object usec
= make_number (0);
1611 Lisp_Object psec
= make_number (0);
1614 if (CONSP (specified_time
))
1616 high
= XCAR (specified_time
);
1617 low
= XCDR (specified_time
);
1620 Lisp_Object low_tail
= XCDR (low
);
1622 if (CONSP (low_tail
))
1624 usec
= XCAR (low_tail
);
1625 low_tail
= XCDR (low_tail
);
1626 if (CONSP (low_tail
))
1627 psec
= XCAR (low_tail
);
1631 else if (!NILP (low_tail
))
1642 /* When combining components, require LOW to be an integer,
1643 as otherwise it would be a pain to add up times. */
1644 if (! INTEGERP (low
))
1647 else if (INTEGERP (specified_time
))
1657 /* Convert T into an Emacs time *RESULT, truncating toward minus infinity.
1658 Return true if T is in range, false otherwise. */
1660 decode_float_time (double t
, struct lisp_time
*result
)
1662 double lo_multiplier
= 1 << LO_TIME_BITS
;
1663 double emacs_time_min
= MOST_NEGATIVE_FIXNUM
* lo_multiplier
;
1664 if (! (emacs_time_min
<= t
&& t
< -emacs_time_min
))
1667 double small_t
= t
/ lo_multiplier
;
1668 EMACS_INT hi
= small_t
;
1669 double t_sans_hi
= t
- hi
* lo_multiplier
;
1671 long double fracps
= (t_sans_hi
- lo
) * 1e12L
;
1672 #ifdef INT_FAST64_MAX
1673 int_fast64_t ifracps
= fracps
;
1674 int us
= ifracps
/ 1000000;
1675 int ps
= ifracps
% 1000000;
1677 int us
= fracps
/ 1e6L
;
1678 int ps
= fracps
- us
* 1e6L
;
1681 ps
+= (ps
< 0) * 1000000;
1683 us
+= (us
< 0) * 1000000;
1685 lo
+= (lo
< 0) << LO_TIME_BITS
;
1693 /* From the time components HIGH, LOW, USEC and PSEC taken from a Lisp
1694 list, generate the corresponding time value.
1695 If LOW is floating point, the other components should be zero.
1697 If RESULT is not null, store into *RESULT the converted time.
1698 If *DRESULT is not null, store into *DRESULT the number of
1699 seconds since the start of the POSIX Epoch.
1701 Return true if successful, false if the components are of the
1702 wrong type or represent a time out of range. */
1704 decode_time_components (Lisp_Object high
, Lisp_Object low
, Lisp_Object usec
,
1706 struct lisp_time
*result
, double *dresult
)
1708 EMACS_INT hi
, lo
, us
, ps
;
1709 if (! (INTEGERP (high
)
1710 && INTEGERP (usec
) && INTEGERP (psec
)))
1712 if (! INTEGERP (low
))
1716 double t
= XFLOAT_DATA (low
);
1717 if (result
&& ! decode_float_time (t
, result
))
1723 else if (NILP (low
))
1725 struct timespec now
= current_timespec ();
1728 result
->hi
= hi_time (now
.tv_sec
);
1729 result
->lo
= lo_time (now
.tv_sec
);
1730 result
->us
= now
.tv_nsec
/ 1000;
1731 result
->ps
= now
.tv_nsec
% 1000 * 1000;
1734 *dresult
= now
.tv_sec
+ now
.tv_nsec
/ 1e9
;
1746 /* Normalize out-of-range lower-order components by carrying
1747 each overflow into the next higher-order component. */
1748 us
+= ps
/ 1000000 - (ps
% 1000000 < 0);
1749 lo
+= us
/ 1000000 - (us
% 1000000 < 0);
1750 hi
+= lo
>> LO_TIME_BITS
;
1751 ps
= ps
% 1000000 + 1000000 * (ps
% 1000000 < 0);
1752 us
= us
% 1000000 + 1000000 * (us
% 1000000 < 0);
1753 lo
&= (1 << LO_TIME_BITS
) - 1;
1757 if (! (MOST_NEGATIVE_FIXNUM
<= hi
&& hi
<= MOST_POSITIVE_FIXNUM
))
1768 *dresult
= (us
* 1e6
+ ps
) / 1e12
+ lo
+ dhi
* (1 << LO_TIME_BITS
);
1775 lisp_to_timespec (struct lisp_time t
)
1777 if (! ((TYPE_SIGNED (time_t) ? TIME_T_MIN
>> LO_TIME_BITS
<= t
.hi
: 0 <= t
.hi
)
1778 && t
.hi
<= TIME_T_MAX
>> LO_TIME_BITS
))
1779 return invalid_timespec ();
1780 time_t s
= (t
.hi
<< LO_TIME_BITS
) + t
.lo
;
1781 int ns
= t
.us
* 1000 + t
.ps
/ 1000;
1782 return make_timespec (s
, ns
);
1785 /* Decode a Lisp list SPECIFIED_TIME that represents a time.
1786 Store its effective length into *PLEN.
1787 If SPECIFIED_TIME is nil, use the current time.
1788 Signal an error if SPECIFIED_TIME does not represent a time. */
1789 static struct lisp_time
1790 lisp_time_struct (Lisp_Object specified_time
, int *plen
)
1792 Lisp_Object high
, low
, usec
, psec
;
1794 int len
= disassemble_lisp_time (specified_time
, &high
, &low
, &usec
, &psec
);
1795 if (! (len
&& decode_time_components (high
, low
, usec
, psec
, &t
, 0)))
1801 /* Like lisp_time_struct, except return a struct timespec.
1802 Discard any low-order digits. */
1804 lisp_time_argument (Lisp_Object specified_time
)
1807 struct lisp_time lt
= lisp_time_struct (specified_time
, &len
);
1808 struct timespec t
= lisp_to_timespec (lt
);
1809 if (! timespec_valid_p (t
))
1814 /* Like lisp_time_argument, except decode only the seconds part,
1815 and do not check the subseconds part. */
1817 lisp_seconds_argument (Lisp_Object specified_time
)
1819 Lisp_Object high
, low
, usec
, psec
;
1821 if (! (disassemble_lisp_time (specified_time
, &high
, &low
, &usec
, &psec
)
1822 && decode_time_components (high
, low
, make_number (0),
1823 make_number (0), &t
, 0)))
1825 if (! ((TYPE_SIGNED (time_t) ? TIME_T_MIN
>> LO_TIME_BITS
<= t
.hi
: 0 <= t
.hi
)
1826 && t
.hi
<= TIME_T_MAX
>> LO_TIME_BITS
))
1828 return (t
.hi
<< LO_TIME_BITS
) + t
.lo
;
1831 DEFUN ("float-time", Ffloat_time
, Sfloat_time
, 0, 1, 0,
1832 doc
: /* Return the current time, as a float number of seconds since the epoch.
1833 If SPECIFIED-TIME is given, it is the time to convert to float
1834 instead of the current time. The argument should have the form
1835 (HIGH LOW) or (HIGH LOW USEC) or (HIGH LOW USEC PSEC). Thus,
1836 you can use times from `current-time' and from `file-attributes'.
1837 SPECIFIED-TIME can also have the form (HIGH . LOW), but this is
1838 considered obsolete.
1840 WARNING: Since the result is floating point, it may not be exact.
1841 If precise time stamps are required, use either `current-time',
1842 or (if you need time as a string) `format-time-string'. */)
1843 (Lisp_Object specified_time
)
1846 Lisp_Object high
, low
, usec
, psec
;
1847 if (! (disassemble_lisp_time (specified_time
, &high
, &low
, &usec
, &psec
)
1848 && decode_time_components (high
, low
, usec
, psec
, 0, &t
)))
1850 return make_float (t
);
1853 /* Write information into buffer S of size MAXSIZE, according to the
1854 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1855 Default to Universal Time if UT, local time otherwise.
1856 Use NS as the number of nanoseconds in the %N directive.
1857 Return the number of bytes written, not including the terminating
1858 '\0'. If S is NULL, nothing will be written anywhere; so to
1859 determine how many bytes would be written, use NULL for S and
1860 ((size_t) -1) for MAXSIZE.
1862 This function behaves like nstrftime, except it allows null
1863 bytes in FORMAT and it does not support nanoseconds. */
1865 emacs_nmemftime (char *s
, size_t maxsize
, const char *format
,
1866 size_t format_len
, const struct tm
*tp
, bool ut
, int ns
)
1870 /* Loop through all the null-terminated strings in the format
1871 argument. Normally there's just one null-terminated string, but
1872 there can be arbitrarily many, concatenated together, if the
1873 format contains '\0' bytes. nstrftime stops at the first
1874 '\0' byte so we must invoke it separately for each such string. */
1883 result
= nstrftime (s
, maxsize
, format
, tp
, ut
, ns
);
1887 if (result
== 0 && s
[0] != '\0')
1892 maxsize
-= result
+ 1;
1894 len
= strlen (format
);
1895 if (len
== format_len
)
1899 format_len
-= len
+ 1;
1903 DEFUN ("format-time-string", Fformat_time_string
, Sformat_time_string
, 1, 3, 0,
1904 doc
: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1905 TIME is specified as (HIGH LOW USEC PSEC), as returned by
1906 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1907 is also still accepted.
1908 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1909 as Universal Time; nil means describe TIME in the local time zone.
1910 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1911 by text that describes the specified date and time in TIME:
1913 %Y is the year, %y within the century, %C the century.
1914 %G is the year corresponding to the ISO week, %g within the century.
1915 %m is the numeric month.
1916 %b and %h are the locale's abbreviated month name, %B the full name.
1917 (%h is not supported on MS-Windows.)
1918 %d is the day of the month, zero-padded, %e is blank-padded.
1919 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1920 %a is the locale's abbreviated name of the day of week, %A the full name.
1921 %U is the week number starting on Sunday, %W starting on Monday,
1922 %V according to ISO 8601.
1923 %j is the day of the year.
1925 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1926 only blank-padded, %l is like %I blank-padded.
1927 %p is the locale's equivalent of either AM or PM.
1930 %N is the nanosecond, %6N the microsecond, %3N the millisecond, etc.
1931 %Z is the time zone name, %z is the numeric form.
1932 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1934 %c is the locale's date and time format.
1935 %x is the locale's "preferred" date format.
1936 %D is like "%m/%d/%y".
1937 %F is the ISO 8601 date format (like "%Y-%m-%d").
1939 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1940 %X is the locale's "preferred" time format.
1942 Finally, %n is a newline, %t is a tab, %% is a literal %.
1944 Certain flags and modifiers are available with some format controls.
1945 The flags are `_', `-', `^' and `#'. For certain characters X,
1946 %_X is like %X, but padded with blanks; %-X is like %X,
1947 but without padding. %^X is like %X, but with all textual
1948 characters up-cased; %#X is like %X, but with letter-case of
1949 all textual characters reversed.
1950 %NX (where N stands for an integer) is like %X,
1951 but takes up at least N (a number) positions.
1952 The modifiers are `E' and `O'. For certain characters X,
1953 %EX is a locale's alternative version of %X;
1954 %OX is like %X, but uses the locale's number symbols.
1956 For example, to produce full ISO 8601 format, use "%FT%T%z".
1958 usage: (format-time-string FORMAT-STRING &optional TIME UNIVERSAL) */)
1959 (Lisp_Object format_string
, Lisp_Object timeval
, Lisp_Object universal
)
1961 struct timespec t
= lisp_time_argument (timeval
);
1964 CHECK_STRING (format_string
);
1965 format_string
= code_convert_string_norecord (format_string
,
1966 Vlocale_coding_system
, 1);
1967 return format_time_string (SSDATA (format_string
), SBYTES (format_string
),
1968 t
, ! NILP (universal
), &tm
);
1972 format_time_string (char const *format
, ptrdiff_t formatlen
,
1973 struct timespec t
, bool ut
, struct tm
*tmp
)
1977 ptrdiff_t size
= sizeof buffer
;
1979 Lisp_Object bufstring
;
1983 tmp
= ut
? gmtime_r (&t
.tv_sec
, tmp
) : localtime_r (&t
.tv_sec
, tmp
);
1986 synchronize_system_time_locale ();
1991 len
= emacs_nmemftime (buf
, size
, format
, formatlen
, tmp
, ut
, ns
);
1992 if ((0 < len
&& len
< size
) || (len
== 0 && buf
[0] == '\0'))
1995 /* Buffer was too small, so make it bigger and try again. */
1996 len
= emacs_nmemftime (NULL
, SIZE_MAX
, format
, formatlen
, tmp
, ut
, ns
);
1997 if (STRING_BYTES_BOUND
<= len
)
2000 buf
= SAFE_ALLOCA (size
);
2003 bufstring
= make_unibyte_string (buf
, len
);
2005 return code_convert_string_norecord (bufstring
, Vlocale_coding_system
, 0);
2008 DEFUN ("decode-time", Fdecode_time
, Sdecode_time
, 0, 1, 0,
2009 doc
: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
2010 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
2011 as from `current-time' and `file-attributes', or nil to use the
2012 current time. The obsolete form (HIGH . LOW) is also still accepted.
2013 The list has the following nine members: SEC is an integer between 0
2014 and 60; SEC is 60 for a leap second, which only some operating systems
2015 support. MINUTE is an integer between 0 and 59. HOUR is an integer
2016 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
2017 integer between 1 and 12. YEAR is an integer indicating the
2018 four-digit year. DOW is the day of week, an integer between 0 and 6,
2019 where 0 is Sunday. DST is t if daylight saving time is in effect,
2020 otherwise nil. ZONE is an integer indicating the number of seconds
2021 east of Greenwich. (Note that Common Lisp has different meanings for
2023 (Lisp_Object specified_time
)
2025 time_t time_spec
= lisp_seconds_argument (specified_time
);
2026 struct tm local_tm
, gmt_tm
;
2028 if (! (localtime_r (&time_spec
, &local_tm
)
2029 && MOST_NEGATIVE_FIXNUM
- TM_YEAR_BASE
<= local_tm
.tm_year
2030 && local_tm
.tm_year
<= MOST_POSITIVE_FIXNUM
- TM_YEAR_BASE
))
2033 /* Avoid overflow when INT_MAX < EMACS_INT_MAX. */
2034 EMACS_INT tm_year_base
= TM_YEAR_BASE
;
2036 return CALLN (Flist
,
2037 make_number (local_tm
.tm_sec
),
2038 make_number (local_tm
.tm_min
),
2039 make_number (local_tm
.tm_hour
),
2040 make_number (local_tm
.tm_mday
),
2041 make_number (local_tm
.tm_mon
+ 1),
2042 make_number (local_tm
.tm_year
+ tm_year_base
),
2043 make_number (local_tm
.tm_wday
),
2044 local_tm
.tm_isdst
? Qt
: Qnil
,
2046 ? make_number (tm_gmtoff (&local_tm
))
2047 : gmtime_r (&time_spec
, &gmt_tm
)
2048 ? make_number (tm_diff (&local_tm
, &gmt_tm
))
2052 /* Return OBJ - OFFSET, checking that OBJ is a valid fixnum and that
2053 the result is representable as an int. Assume OFFSET is small and
2056 check_tm_member (Lisp_Object obj
, int offset
)
2061 if (! (INT_MIN
+ offset
<= n
&& n
- offset
<= INT_MAX
))
2066 /* Decode ZONE as a time zone specification. */
2069 decode_time_zone (Lisp_Object zone
)
2072 return build_string ("UTC0");
2073 else if (STRINGP (zone
))
2075 else if (INTEGERP (zone
))
2077 static char const tzbuf_format
[] = "XXX%s%"pI
"d:%02d:%02d";
2078 char tzbuf
[sizeof tzbuf_format
+ INT_STRLEN_BOUND (EMACS_INT
)];
2079 EMACS_INT abszone
= eabs (XINT (zone
)), zone_hr
= abszone
/ (60 * 60);
2080 int zone_min
= (abszone
/ 60) % 60, zone_sec
= abszone
% 60;
2082 return make_formatted_string (tzbuf
, tzbuf_format
, &"-"[XINT (zone
) < 0],
2083 zone_hr
, zone_min
, zone_sec
);
2086 xsignal2 (Qerror
, build_string ("Invalid time zone specification"), zone
);
2089 DEFUN ("encode-time", Fencode_time
, Sencode_time
, 6, MANY
, 0,
2090 doc
: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
2091 This is the reverse operation of `decode-time', which see.
2092 ZONE defaults to the current time zone rule. This can
2093 be a string or t (as from `set-time-zone-rule'), or it can be a list
2094 \(as from `current-time-zone') or an integer (as from `decode-time')
2095 applied without consideration for daylight saving time.
2097 You can pass more than 7 arguments; then the first six arguments
2098 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
2099 The intervening arguments are ignored.
2100 This feature lets (apply 'encode-time (decode-time ...)) work.
2102 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
2103 for example, a DAY of 0 means the day preceding the given month.
2104 Year numbers less than 100 are treated just like other year numbers.
2105 If you want them to stand for years in this century, you must do that yourself.
2107 Years before 1970 are not guaranteed to work. On some systems,
2108 year values as low as 1901 do work.
2110 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
2111 (ptrdiff_t nargs
, Lisp_Object
*args
)
2115 Lisp_Object zone
= (nargs
> 6 ? args
[nargs
- 1] : Qnil
);
2117 tm
.tm_sec
= check_tm_member (args
[0], 0);
2118 tm
.tm_min
= check_tm_member (args
[1], 0);
2119 tm
.tm_hour
= check_tm_member (args
[2], 0);
2120 tm
.tm_mday
= check_tm_member (args
[3], 0);
2121 tm
.tm_mon
= check_tm_member (args
[4], 1);
2122 tm
.tm_year
= check_tm_member (args
[5], TM_YEAR_BASE
);
2128 value
= mktime (&tm
);
2131 timezone_t tz
= tzalloc (SSDATA (decode_time_zone (zone
)));
2132 value
= mktime_z (tz
, &tm
);
2136 if (value
== (time_t) -1)
2139 return list2i (hi_time (value
), lo_time (value
));
2142 DEFUN ("current-time-string", Fcurrent_time_string
, Scurrent_time_string
, 0, 1, 0,
2143 doc
: /* Return the current local time, as a human-readable string.
2144 Programs can use this function to decode a time,
2145 since the number of columns in each field is fixed
2146 if the year is in the range 1000-9999.
2147 The format is `Sun Sep 16 01:03:52 1973'.
2148 However, see also the functions `decode-time' and `format-time-string'
2149 which provide a much more powerful and general facility.
2151 If SPECIFIED-TIME is given, it is a time to format instead of the
2152 current time. The argument should have the form (HIGH LOW . IGNORED).
2153 Thus, you can use times obtained from `current-time' and from
2154 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
2155 but this is considered obsolete. */)
2156 (Lisp_Object specified_time
)
2158 time_t value
= lisp_seconds_argument (specified_time
);
2160 /* Convert to a string in ctime format, except without the trailing
2161 newline, and without the 4-digit year limit. Don't use asctime
2162 or ctime, as they might dump core if the year is outside the
2163 range -999 .. 9999. */
2165 if (! localtime_r (&value
, &tm
))
2168 static char const wday_name
[][4] =
2169 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
2170 static char const mon_name
[][4] =
2171 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
2172 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
2173 printmax_t year_base
= TM_YEAR_BASE
;
2174 char buf
[sizeof "Mon Apr 30 12:49:17 " + INT_STRLEN_BOUND (int) + 1];
2175 int len
= sprintf (buf
, "%s %s%3d %02d:%02d:%02d %"pMd
,
2176 wday_name
[tm
.tm_wday
], mon_name
[tm
.tm_mon
], tm
.tm_mday
,
2177 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
,
2178 tm
.tm_year
+ year_base
);
2180 return make_unibyte_string (buf
, len
);
2183 /* Yield A - B, measured in seconds.
2184 This function is copied from the GNU C Library. */
2186 tm_diff (struct tm
*a
, struct tm
*b
)
2188 /* Compute intervening leap days correctly even if year is negative.
2189 Take care to avoid int overflow in leap day calculations,
2190 but it's OK to assume that A and B are close to each other. */
2191 int a4
= (a
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (a
->tm_year
& 3);
2192 int b4
= (b
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (b
->tm_year
& 3);
2193 int a100
= a4
/ 25 - (a4
% 25 < 0);
2194 int b100
= b4
/ 25 - (b4
% 25 < 0);
2195 int a400
= a100
>> 2;
2196 int b400
= b100
>> 2;
2197 int intervening_leap_days
= (a4
- b4
) - (a100
- b100
) + (a400
- b400
);
2198 int years
= a
->tm_year
- b
->tm_year
;
2199 int days
= (365 * years
+ intervening_leap_days
2200 + (a
->tm_yday
- b
->tm_yday
));
2201 return (60 * (60 * (24 * days
+ (a
->tm_hour
- b
->tm_hour
))
2202 + (a
->tm_min
- b
->tm_min
))
2203 + (a
->tm_sec
- b
->tm_sec
));
2206 /* Yield A's UTC offset, or an unspecified value if unknown. */
2208 tm_gmtoff (struct tm
*a
)
2211 return a
->tm_gmtoff
;
2217 DEFUN ("current-time-zone", Fcurrent_time_zone
, Scurrent_time_zone
, 0, 1, 0,
2218 doc
: /* Return the offset and name for the local time zone.
2219 This returns a list of the form (OFFSET NAME).
2220 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
2221 A negative value means west of Greenwich.
2222 NAME is a string giving the name of the time zone.
2223 If SPECIFIED-TIME is given, the time zone offset is determined from it
2224 instead of using the current time. The argument should have the form
2225 (HIGH LOW . IGNORED). Thus, you can use times obtained from
2226 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
2227 have the form (HIGH . LOW), but this is considered obsolete.
2229 Some operating systems cannot provide all this information to Emacs;
2230 in this case, `current-time-zone' returns a list containing nil for
2231 the data it can't find. */)
2232 (Lisp_Object specified_time
)
2234 struct timespec value
;
2235 struct tm local_tm
, gmt_tm
;
2236 Lisp_Object zone_offset
, zone_name
;
2239 value
= make_timespec (lisp_seconds_argument (specified_time
), 0);
2240 zone_name
= format_time_string ("%Z", sizeof "%Z" - 1, value
, 0, &local_tm
);
2242 if (HAVE_TM_GMTOFF
|| gmtime_r (&value
.tv_sec
, &gmt_tm
))
2244 long int offset
= (HAVE_TM_GMTOFF
2245 ? tm_gmtoff (&local_tm
)
2246 : tm_diff (&local_tm
, &gmt_tm
));
2247 zone_offset
= make_number (offset
);
2248 if (SCHARS (zone_name
) == 0)
2250 /* No local time zone name is available; use "+-NNNN" instead. */
2251 long int m
= offset
/ 60;
2252 long int am
= offset
< 0 ? - m
: m
;
2253 long int hour
= am
/ 60;
2255 char buf
[sizeof "+00" + INT_STRLEN_BOUND (long int)];
2256 zone_name
= make_formatted_string (buf
, "%c%02ld%02d",
2257 (offset
< 0 ? '-' : '+'),
2262 return list2 (zone_offset
, zone_name
);
2265 DEFUN ("set-time-zone-rule", Fset_time_zone_rule
, Sset_time_zone_rule
, 1, 1, 0,
2266 doc
: /* Set the local time zone using TZ, a string specifying a time zone rule.
2267 If TZ is nil, use implementation-defined default time zone information.
2268 If TZ is t, use Universal Time. If TZ is an integer, it is treated as in
2271 Instead of calling this function, you typically want (setenv "TZ" TZ).
2272 That changes both the environment of the Emacs process and the
2273 variable `process-environment', whereas `set-time-zone-rule' affects
2274 only the former. */)
2277 const char *tzstring
= NILP (tz
) ? initial_tz
: SSDATA (decode_time_zone (tz
));
2280 set_time_zone_rule (tzstring
);
2286 /* Set the local time zone rule to TZSTRING.
2288 This function is not thread-safe, in theory because putenv is not,
2289 but mostly because of the static storage it updates. Other threads
2290 that invoke localtime etc. may be adversely affected while this
2291 function is executing. */
2294 set_time_zone_rule (const char *tzstring
)
2296 /* A buffer holding a string of the form "TZ=value", intended
2297 to be part of the environment. */
2298 static char *tzvalbuf
;
2299 static ptrdiff_t tzvalbufsize
;
2301 int tzeqlen
= sizeof "TZ=" - 1;
2302 ptrdiff_t tzstringlen
= tzstring
? strlen (tzstring
) : 0;
2303 char *tzval
= tzvalbuf
;
2304 bool new_tzvalbuf
= tzvalbufsize
<= tzeqlen
+ tzstringlen
;
2308 /* Do not attempt to free the old tzvalbuf, since another thread
2309 may be using it. In practice, the first allocation is large
2310 enough and memory does not leak. */
2311 tzval
= xpalloc (NULL
, &tzvalbufsize
,
2312 tzeqlen
+ tzstringlen
- tzvalbufsize
+ 1, -1, 1);
2320 /* Modify TZVAL in place. Although this is dicey in a
2321 multithreaded environment, we know of no portable alternative.
2322 Calling putenv or setenv could crash some other thread. */
2324 strcpy (tzval
+ tzeqlen
, tzstring
);
2328 /* Turn 'TZ=whatever' into an empty environment variable 'tZ='.
2329 Although this is also dicey, calling unsetenv here can crash Emacs.
2337 /* Although this is not thread-safe, in practice this runs only
2338 on startup when there is only one thread. */
2347 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2348 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2349 type of object is Lisp_String). INHERIT is passed to
2350 INSERT_FROM_STRING_FUNC as the last argument. */
2353 general_insert_function (void (*insert_func
)
2354 (const char *, ptrdiff_t),
2355 void (*insert_from_string_func
)
2356 (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2357 ptrdiff_t, ptrdiff_t, bool),
2358 bool inherit
, ptrdiff_t nargs
, Lisp_Object
*args
)
2363 for (argnum
= 0; argnum
< nargs
; argnum
++)
2366 if (CHARACTERP (val
))
2368 int c
= XFASTINT (val
);
2369 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2372 if (!NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2373 len
= CHAR_STRING (c
, str
);
2376 str
[0] = CHAR_TO_BYTE8 (c
);
2379 (*insert_func
) ((char *) str
, len
);
2381 else if (STRINGP (val
))
2383 (*insert_from_string_func
) (val
, 0, 0,
2389 wrong_type_argument (Qchar_or_string_p
, val
);
2394 insert1 (Lisp_Object arg
)
2400 /* Callers passing one argument to Finsert need not gcpro the
2401 argument "array", since the only element of the array will
2402 not be used after calling insert or insert_from_string, so
2403 we don't care if it gets trashed. */
2405 DEFUN ("insert", Finsert
, Sinsert
, 0, MANY
, 0,
2406 doc
: /* Insert the arguments, either strings or characters, at point.
2407 Point and before-insertion markers move forward to end up
2408 after the inserted text.
2409 Any other markers at the point of insertion remain before the text.
2411 If the current buffer is multibyte, unibyte strings are converted
2412 to multibyte for insertion (see `string-make-multibyte').
2413 If the current buffer is unibyte, multibyte strings are converted
2414 to unibyte for insertion (see `string-make-unibyte').
2416 When operating on binary data, it may be necessary to preserve the
2417 original bytes of a unibyte string when inserting it into a multibyte
2418 buffer; to accomplish this, apply `string-as-multibyte' to the string
2419 and insert the result.
2421 usage: (insert &rest ARGS) */)
2422 (ptrdiff_t nargs
, Lisp_Object
*args
)
2424 general_insert_function (insert
, insert_from_string
, 0, nargs
, args
);
2428 DEFUN ("insert-and-inherit", Finsert_and_inherit
, Sinsert_and_inherit
,
2430 doc
: /* Insert the arguments at point, inheriting properties from adjoining text.
2431 Point and before-insertion markers move forward to end up
2432 after the inserted text.
2433 Any other markers at the point of insertion remain before the text.
2435 If the current buffer is multibyte, unibyte strings are converted
2436 to multibyte for insertion (see `unibyte-char-to-multibyte').
2437 If the current buffer is unibyte, multibyte strings are converted
2438 to unibyte for insertion.
2440 usage: (insert-and-inherit &rest ARGS) */)
2441 (ptrdiff_t nargs
, Lisp_Object
*args
)
2443 general_insert_function (insert_and_inherit
, insert_from_string
, 1,
2448 DEFUN ("insert-before-markers", Finsert_before_markers
, Sinsert_before_markers
, 0, MANY
, 0,
2449 doc
: /* Insert strings or characters at point, relocating markers after the text.
2450 Point and markers move forward to end up after the inserted text.
2452 If the current buffer is multibyte, unibyte strings are converted
2453 to multibyte for insertion (see `unibyte-char-to-multibyte').
2454 If the current buffer is unibyte, multibyte strings are converted
2455 to unibyte for insertion.
2457 If an overlay begins at the insertion point, the inserted text falls
2458 outside the overlay; if a nonempty overlay ends at the insertion
2459 point, the inserted text falls inside that overlay.
2461 usage: (insert-before-markers &rest ARGS) */)
2462 (ptrdiff_t nargs
, Lisp_Object
*args
)
2464 general_insert_function (insert_before_markers
,
2465 insert_from_string_before_markers
, 0,
2470 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers
,
2471 Sinsert_and_inherit_before_markers
, 0, MANY
, 0,
2472 doc
: /* Insert text at point, relocating markers and inheriting properties.
2473 Point and markers move forward to end up after the inserted text.
2475 If the current buffer is multibyte, unibyte strings are converted
2476 to multibyte for insertion (see `unibyte-char-to-multibyte').
2477 If the current buffer is unibyte, multibyte strings are converted
2478 to unibyte for insertion.
2480 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2481 (ptrdiff_t nargs
, Lisp_Object
*args
)
2483 general_insert_function (insert_before_markers_and_inherit
,
2484 insert_from_string_before_markers
, 1,
2489 DEFUN ("insert-char", Finsert_char
, Sinsert_char
, 1, 3,
2490 "(list (read-char-by-name \"Insert character (Unicode name or hex): \")\
2491 (prefix-numeric-value current-prefix-arg)\
2493 doc
: /* Insert COUNT copies of CHARACTER.
2494 Interactively, prompt for CHARACTER. You can specify CHARACTER in one
2497 - As its Unicode character name, e.g. \"LATIN SMALL LETTER A\".
2498 Completion is available; if you type a substring of the name
2499 preceded by an asterisk `*', Emacs shows all names which include
2500 that substring, not necessarily at the beginning of the name.
2502 - As a hexadecimal code point, e.g. 263A. Note that code points in
2503 Emacs are equivalent to Unicode up to 10FFFF (which is the limit of
2504 the Unicode code space).
2506 - As a code point with a radix specified with #, e.g. #o21430
2507 (octal), #x2318 (hex), or #10r8984 (decimal).
2509 If called interactively, COUNT is given by the prefix argument. If
2510 omitted or nil, it defaults to 1.
2512 Inserting the character(s) relocates point and before-insertion
2513 markers in the same ways as the function `insert'.
2515 The optional third argument INHERIT, if non-nil, says to inherit text
2516 properties from adjoining text, if those properties are sticky. If
2517 called interactively, INHERIT is t. */)
2518 (Lisp_Object character
, Lisp_Object count
, Lisp_Object inherit
)
2521 register ptrdiff_t n
;
2523 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2526 CHECK_CHARACTER (character
);
2528 XSETFASTINT (count
, 1);
2529 CHECK_NUMBER (count
);
2530 c
= XFASTINT (character
);
2532 if (!NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2533 len
= CHAR_STRING (c
, str
);
2535 str
[0] = c
, len
= 1;
2536 if (XINT (count
) <= 0)
2538 if (BUF_BYTES_MAX
/ len
< XINT (count
))
2540 n
= XINT (count
) * len
;
2541 stringlen
= min (n
, sizeof string
- sizeof string
% len
);
2542 for (i
= 0; i
< stringlen
; i
++)
2543 string
[i
] = str
[i
% len
];
2544 while (n
> stringlen
)
2547 if (!NILP (inherit
))
2548 insert_and_inherit (string
, stringlen
);
2550 insert (string
, stringlen
);
2553 if (!NILP (inherit
))
2554 insert_and_inherit (string
, n
);
2560 DEFUN ("insert-byte", Finsert_byte
, Sinsert_byte
, 2, 3, 0,
2561 doc
: /* Insert COUNT (second arg) copies of BYTE (first arg).
2562 Both arguments are required.
2563 BYTE is a number of the range 0..255.
2565 If BYTE is 128..255 and the current buffer is multibyte, the
2566 corresponding eight-bit character is inserted.
2568 Point, and before-insertion markers, are relocated as in the function `insert'.
2569 The optional third arg INHERIT, if non-nil, says to inherit text properties
2570 from adjoining text, if those properties are sticky. */)
2571 (Lisp_Object byte
, Lisp_Object count
, Lisp_Object inherit
)
2573 CHECK_NUMBER (byte
);
2574 if (XINT (byte
) < 0 || XINT (byte
) > 255)
2575 args_out_of_range_3 (byte
, make_number (0), make_number (255));
2576 if (XINT (byte
) >= 128
2577 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2578 XSETFASTINT (byte
, BYTE8_TO_CHAR (XINT (byte
)));
2579 return Finsert_char (byte
, count
, inherit
);
2583 /* Making strings from buffer contents. */
2585 /* Return a Lisp_String containing the text of the current buffer from
2586 START to END. If text properties are in use and the current buffer
2587 has properties in the range specified, the resulting string will also
2588 have them, if PROPS is true.
2590 We don't want to use plain old make_string here, because it calls
2591 make_uninit_string, which can cause the buffer arena to be
2592 compacted. make_string has no way of knowing that the data has
2593 been moved, and thus copies the wrong data into the string. This
2594 doesn't effect most of the other users of make_string, so it should
2595 be left as is. But we should use this function when conjuring
2596 buffer substrings. */
2599 make_buffer_string (ptrdiff_t start
, ptrdiff_t end
, bool props
)
2601 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
2602 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
2604 return make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
);
2607 /* Return a Lisp_String containing the text of the current buffer from
2608 START / START_BYTE to END / END_BYTE.
2610 If text properties are in use and the current buffer
2611 has properties in the range specified, the resulting string will also
2612 have them, if PROPS is true.
2614 We don't want to use plain old make_string here, because it calls
2615 make_uninit_string, which can cause the buffer arena to be
2616 compacted. make_string has no way of knowing that the data has
2617 been moved, and thus copies the wrong data into the string. This
2618 doesn't effect most of the other users of make_string, so it should
2619 be left as is. But we should use this function when conjuring
2620 buffer substrings. */
2623 make_buffer_string_both (ptrdiff_t start
, ptrdiff_t start_byte
,
2624 ptrdiff_t end
, ptrdiff_t end_byte
, bool props
)
2626 Lisp_Object result
, tem
, tem1
;
2627 ptrdiff_t beg0
, end0
, beg1
, end1
, size
;
2629 if (start_byte
< GPT_BYTE
&& GPT_BYTE
< end_byte
)
2631 /* Two regions, before and after the gap. */
2634 beg1
= GPT_BYTE
+ GAP_SIZE
- BEG_BYTE
;
2635 end1
= end_byte
+ GAP_SIZE
- BEG_BYTE
;
2639 /* The only region. */
2646 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
2647 result
= make_uninit_multibyte_string (end
- start
, end_byte
- start_byte
);
2649 result
= make_uninit_string (end
- start
);
2652 memcpy (SDATA (result
), BYTE_POS_ADDR (beg0
), size
);
2654 memcpy (SDATA (result
) + size
, BEG_ADDR
+ beg1
, end1
- beg1
);
2656 /* If desired, update and copy the text properties. */
2659 update_buffer_properties (start
, end
);
2661 tem
= Fnext_property_change (make_number (start
), Qnil
, make_number (end
));
2662 tem1
= Ftext_properties_at (make_number (start
), Qnil
);
2664 if (XINT (tem
) != end
|| !NILP (tem1
))
2665 copy_intervals_to_string (result
, current_buffer
, start
,
2672 /* Call Vbuffer_access_fontify_functions for the range START ... END
2673 in the current buffer, if necessary. */
2676 update_buffer_properties (ptrdiff_t start
, ptrdiff_t end
)
2678 /* If this buffer has some access functions,
2679 call them, specifying the range of the buffer being accessed. */
2680 if (!NILP (Vbuffer_access_fontify_functions
))
2682 /* But don't call them if we can tell that the work
2683 has already been done. */
2684 if (!NILP (Vbuffer_access_fontified_property
))
2687 = Ftext_property_any (make_number (start
), make_number (end
),
2688 Vbuffer_access_fontified_property
,
2694 CALLN (Frun_hook_with_args
, Qbuffer_access_fontify_functions
,
2695 make_number (start
), make_number (end
));
2699 DEFUN ("buffer-substring", Fbuffer_substring
, Sbuffer_substring
, 2, 2, 0,
2700 doc
: /* Return the contents of part of the current buffer as a string.
2701 The two arguments START and END are character positions;
2702 they can be in either order.
2703 The string returned is multibyte if the buffer is multibyte.
2705 This function copies the text properties of that part of the buffer
2706 into the result string; if you don't want the text properties,
2707 use `buffer-substring-no-properties' instead. */)
2708 (Lisp_Object start
, Lisp_Object end
)
2710 register ptrdiff_t b
, e
;
2712 validate_region (&start
, &end
);
2716 return make_buffer_string (b
, e
, 1);
2719 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties
,
2720 Sbuffer_substring_no_properties
, 2, 2, 0,
2721 doc
: /* Return the characters of part of the buffer, without the text properties.
2722 The two arguments START and END are character positions;
2723 they can be in either order. */)
2724 (Lisp_Object start
, Lisp_Object end
)
2726 register ptrdiff_t b
, e
;
2728 validate_region (&start
, &end
);
2732 return make_buffer_string (b
, e
, 0);
2735 DEFUN ("buffer-string", Fbuffer_string
, Sbuffer_string
, 0, 0, 0,
2736 doc
: /* Return the contents of the current buffer as a string.
2737 If narrowing is in effect, this function returns only the visible part
2741 return make_buffer_string_both (BEGV
, BEGV_BYTE
, ZV
, ZV_BYTE
, 1);
2744 DEFUN ("insert-buffer-substring", Finsert_buffer_substring
, Sinsert_buffer_substring
,
2746 doc
: /* Insert before point a substring of the contents of BUFFER.
2747 BUFFER may be a buffer or a buffer name.
2748 Arguments START and END are character positions specifying the substring.
2749 They default to the values of (point-min) and (point-max) in BUFFER. */)
2750 (Lisp_Object buffer
, Lisp_Object start
, Lisp_Object end
)
2752 register EMACS_INT b
, e
, temp
;
2753 register struct buffer
*bp
, *obuf
;
2756 buf
= Fget_buffer (buffer
);
2760 if (!BUFFER_LIVE_P (bp
))
2761 error ("Selecting deleted buffer");
2767 CHECK_NUMBER_COERCE_MARKER (start
);
2774 CHECK_NUMBER_COERCE_MARKER (end
);
2779 temp
= b
, b
= e
, e
= temp
;
2781 if (!(BUF_BEGV (bp
) <= b
&& e
<= BUF_ZV (bp
)))
2782 args_out_of_range (start
, end
);
2784 obuf
= current_buffer
;
2785 set_buffer_internal_1 (bp
);
2786 update_buffer_properties (b
, e
);
2787 set_buffer_internal_1 (obuf
);
2789 insert_from_buffer (bp
, b
, e
- b
, 0);
2793 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings
, Scompare_buffer_substrings
,
2795 doc
: /* Compare two substrings of two buffers; return result as number.
2796 Return -N if first string is less after N-1 chars, +N if first string is
2797 greater after N-1 chars, or 0 if strings match. Each substring is
2798 represented as three arguments: BUFFER, START and END. That makes six
2799 args in all, three for each substring.
2801 The value of `case-fold-search' in the current buffer
2802 determines whether case is significant or ignored. */)
2803 (Lisp_Object buffer1
, Lisp_Object start1
, Lisp_Object end1
, Lisp_Object buffer2
, Lisp_Object start2
, Lisp_Object end2
)
2805 register EMACS_INT begp1
, endp1
, begp2
, endp2
, temp
;
2806 register struct buffer
*bp1
, *bp2
;
2807 register Lisp_Object trt
2808 = (!NILP (BVAR (current_buffer
, case_fold_search
))
2809 ? BVAR (current_buffer
, case_canon_table
) : Qnil
);
2810 ptrdiff_t chars
= 0;
2811 ptrdiff_t i1
, i2
, i1_byte
, i2_byte
;
2813 /* Find the first buffer and its substring. */
2816 bp1
= current_buffer
;
2820 buf1
= Fget_buffer (buffer1
);
2823 bp1
= XBUFFER (buf1
);
2824 if (!BUFFER_LIVE_P (bp1
))
2825 error ("Selecting deleted buffer");
2829 begp1
= BUF_BEGV (bp1
);
2832 CHECK_NUMBER_COERCE_MARKER (start1
);
2833 begp1
= XINT (start1
);
2836 endp1
= BUF_ZV (bp1
);
2839 CHECK_NUMBER_COERCE_MARKER (end1
);
2840 endp1
= XINT (end1
);
2844 temp
= begp1
, begp1
= endp1
, endp1
= temp
;
2846 if (!(BUF_BEGV (bp1
) <= begp1
2848 && endp1
<= BUF_ZV (bp1
)))
2849 args_out_of_range (start1
, end1
);
2851 /* Likewise for second substring. */
2854 bp2
= current_buffer
;
2858 buf2
= Fget_buffer (buffer2
);
2861 bp2
= XBUFFER (buf2
);
2862 if (!BUFFER_LIVE_P (bp2
))
2863 error ("Selecting deleted buffer");
2867 begp2
= BUF_BEGV (bp2
);
2870 CHECK_NUMBER_COERCE_MARKER (start2
);
2871 begp2
= XINT (start2
);
2874 endp2
= BUF_ZV (bp2
);
2877 CHECK_NUMBER_COERCE_MARKER (end2
);
2878 endp2
= XINT (end2
);
2882 temp
= begp2
, begp2
= endp2
, endp2
= temp
;
2884 if (!(BUF_BEGV (bp2
) <= begp2
2886 && endp2
<= BUF_ZV (bp2
)))
2887 args_out_of_range (start2
, end2
);
2891 i1_byte
= buf_charpos_to_bytepos (bp1
, i1
);
2892 i2_byte
= buf_charpos_to_bytepos (bp2
, i2
);
2894 while (i1
< endp1
&& i2
< endp2
)
2896 /* When we find a mismatch, we must compare the
2897 characters, not just the bytes. */
2902 if (! NILP (BVAR (bp1
, enable_multibyte_characters
)))
2904 c1
= BUF_FETCH_MULTIBYTE_CHAR (bp1
, i1_byte
);
2905 BUF_INC_POS (bp1
, i1_byte
);
2910 c1
= BUF_FETCH_BYTE (bp1
, i1
);
2911 MAKE_CHAR_MULTIBYTE (c1
);
2915 if (! NILP (BVAR (bp2
, enable_multibyte_characters
)))
2917 c2
= BUF_FETCH_MULTIBYTE_CHAR (bp2
, i2_byte
);
2918 BUF_INC_POS (bp2
, i2_byte
);
2923 c2
= BUF_FETCH_BYTE (bp2
, i2
);
2924 MAKE_CHAR_MULTIBYTE (c2
);
2930 c1
= char_table_translate (trt
, c1
);
2931 c2
= char_table_translate (trt
, c2
);
2934 return make_number (- 1 - chars
);
2936 return make_number (chars
+ 1);
2941 /* The strings match as far as they go.
2942 If one is shorter, that one is less. */
2943 if (chars
< endp1
- begp1
)
2944 return make_number (chars
+ 1);
2945 else if (chars
< endp2
- begp2
)
2946 return make_number (- chars
- 1);
2948 /* Same length too => they are equal. */
2949 return make_number (0);
2953 subst_char_in_region_unwind (Lisp_Object arg
)
2955 bset_undo_list (current_buffer
, arg
);
2959 subst_char_in_region_unwind_1 (Lisp_Object arg
)
2961 bset_filename (current_buffer
, arg
);
2964 DEFUN ("subst-char-in-region", Fsubst_char_in_region
,
2965 Ssubst_char_in_region
, 4, 5, 0,
2966 doc
: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2967 If optional arg NOUNDO is non-nil, don't record this change for undo
2968 and don't mark the buffer as really changed.
2969 Both characters must have the same length of multi-byte form. */)
2970 (Lisp_Object start
, Lisp_Object end
, Lisp_Object fromchar
, Lisp_Object tochar
, Lisp_Object noundo
)
2972 register ptrdiff_t pos
, pos_byte
, stop
, i
, len
, end_byte
;
2973 /* Keep track of the first change in the buffer:
2974 if 0 we haven't found it yet.
2975 if < 0 we've found it and we've run the before-change-function.
2976 if > 0 we've actually performed it and the value is its position. */
2977 ptrdiff_t changed
= 0;
2978 unsigned char fromstr
[MAX_MULTIBYTE_LENGTH
], tostr
[MAX_MULTIBYTE_LENGTH
];
2980 ptrdiff_t count
= SPECPDL_INDEX ();
2981 #define COMBINING_NO 0
2982 #define COMBINING_BEFORE 1
2983 #define COMBINING_AFTER 2
2984 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2985 int maybe_byte_combining
= COMBINING_NO
;
2986 ptrdiff_t last_changed
= 0;
2988 = !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2993 validate_region (&start
, &end
);
2994 CHECK_CHARACTER (fromchar
);
2995 CHECK_CHARACTER (tochar
);
2996 fromc
= XFASTINT (fromchar
);
2997 toc
= XFASTINT (tochar
);
3001 len
= CHAR_STRING (fromc
, fromstr
);
3002 if (CHAR_STRING (toc
, tostr
) != len
)
3003 error ("Characters in `subst-char-in-region' have different byte-lengths");
3004 if (!ASCII_CHAR_P (*tostr
))
3006 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
3007 complete multibyte character, it may be combined with the
3008 after bytes. If it is in the range 0xA0..0xFF, it may be
3009 combined with the before and after bytes. */
3010 if (!CHAR_HEAD_P (*tostr
))
3011 maybe_byte_combining
= COMBINING_BOTH
;
3012 else if (BYTES_BY_CHAR_HEAD (*tostr
) > len
)
3013 maybe_byte_combining
= COMBINING_AFTER
;
3024 pos_byte
= CHAR_TO_BYTE (pos
);
3025 stop
= CHAR_TO_BYTE (XINT (end
));
3028 /* If we don't want undo, turn off putting stuff on the list.
3029 That's faster than getting rid of things,
3030 and it prevents even the entry for a first change.
3031 Also inhibit locking the file. */
3032 if (!changed
&& !NILP (noundo
))
3034 record_unwind_protect (subst_char_in_region_unwind
,
3035 BVAR (current_buffer
, undo_list
));
3036 bset_undo_list (current_buffer
, Qt
);
3037 /* Don't do file-locking. */
3038 record_unwind_protect (subst_char_in_region_unwind_1
,
3039 BVAR (current_buffer
, filename
));
3040 bset_filename (current_buffer
, Qnil
);
3043 if (pos_byte
< GPT_BYTE
)
3044 stop
= min (stop
, GPT_BYTE
);
3047 ptrdiff_t pos_byte_next
= pos_byte
;
3049 if (pos_byte
>= stop
)
3051 if (pos_byte
>= end_byte
) break;
3054 p
= BYTE_POS_ADDR (pos_byte
);
3056 INC_POS (pos_byte_next
);
3059 if (pos_byte_next
- pos_byte
== len
3060 && p
[0] == fromstr
[0]
3062 || (p
[1] == fromstr
[1]
3063 && (len
== 2 || (p
[2] == fromstr
[2]
3064 && (len
== 3 || p
[3] == fromstr
[3]))))))
3067 /* We've already seen this and run the before-change-function;
3068 this time we only need to record the actual position. */
3073 modify_text (pos
, XINT (end
));
3075 if (! NILP (noundo
))
3077 if (MODIFF
- 1 == SAVE_MODIFF
)
3079 if (MODIFF
- 1 == BUF_AUTOSAVE_MODIFF (current_buffer
))
3080 BUF_AUTOSAVE_MODIFF (current_buffer
)++;
3083 /* The before-change-function may have moved the gap
3084 or even modified the buffer so we should start over. */
3088 /* Take care of the case where the new character
3089 combines with neighboring bytes. */
3090 if (maybe_byte_combining
3091 && (maybe_byte_combining
== COMBINING_AFTER
3092 ? (pos_byte_next
< Z_BYTE
3093 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
3094 : ((pos_byte_next
< Z_BYTE
3095 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
3096 || (pos_byte
> BEG_BYTE
3097 && ! ASCII_CHAR_P (FETCH_BYTE (pos_byte
- 1))))))
3099 Lisp_Object tem
, string
;
3101 struct gcpro gcpro1
;
3103 tem
= BVAR (current_buffer
, undo_list
);
3106 /* Make a multibyte string containing this single character. */
3107 string
= make_multibyte_string ((char *) tostr
, 1, len
);
3108 /* replace_range is less efficient, because it moves the gap,
3109 but it handles combining correctly. */
3110 replace_range (pos
, pos
+ 1, string
,
3112 pos_byte_next
= CHAR_TO_BYTE (pos
);
3113 if (pos_byte_next
> pos_byte
)
3114 /* Before combining happened. We should not increment
3115 POS. So, to cancel the later increment of POS,
3119 INC_POS (pos_byte_next
);
3121 if (! NILP (noundo
))
3122 bset_undo_list (current_buffer
, tem
);
3129 record_change (pos
, 1);
3130 for (i
= 0; i
< len
; i
++) *p
++ = tostr
[i
];
3132 last_changed
= pos
+ 1;
3134 pos_byte
= pos_byte_next
;
3140 signal_after_change (changed
,
3141 last_changed
- changed
, last_changed
- changed
);
3142 update_compositions (changed
, last_changed
, CHECK_ALL
);
3145 unbind_to (count
, Qnil
);
3150 static Lisp_Object
check_translation (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3153 /* Helper function for Ftranslate_region_internal.
3155 Check if a character sequence at POS (POS_BYTE) matches an element
3156 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
3157 element is found, return it. Otherwise return Qnil. */
3160 check_translation (ptrdiff_t pos
, ptrdiff_t pos_byte
, ptrdiff_t end
,
3163 int initial_buf
[16];
3164 int *buf
= initial_buf
;
3165 ptrdiff_t buf_size
= ARRAYELTS (initial_buf
);
3167 ptrdiff_t buf_used
= 0;
3168 Lisp_Object result
= Qnil
;
3170 for (; CONSP (val
); val
= XCDR (val
))
3179 if (! VECTORP (elt
))
3182 if (len
<= end
- pos
)
3184 for (i
= 0; i
< len
; i
++)
3188 unsigned char *p
= BYTE_POS_ADDR (pos_byte
);
3191 if (buf_used
== buf_size
)
3193 bufalloc
= xpalloc (bufalloc
, &buf_size
, 1, -1,
3195 if (buf
== initial_buf
)
3196 memcpy (bufalloc
, buf
, sizeof initial_buf
);
3199 buf
[buf_used
++] = STRING_CHAR_AND_LENGTH (p
, len1
);
3202 if (XINT (AREF (elt
, i
)) != buf
[i
])
3207 result
= XCAR (val
);
3218 DEFUN ("translate-region-internal", Ftranslate_region_internal
,
3219 Stranslate_region_internal
, 3, 3, 0,
3220 doc
: /* Internal use only.
3221 From START to END, translate characters according to TABLE.
3222 TABLE is a string or a char-table; the Nth character in it is the
3223 mapping for the character with code N.
3224 It returns the number of characters changed. */)
3225 (Lisp_Object start
, Lisp_Object end
, register Lisp_Object table
)
3227 register unsigned char *tt
; /* Trans table. */
3228 register int nc
; /* New character. */
3229 int cnt
; /* Number of changes made. */
3230 ptrdiff_t size
; /* Size of translate table. */
3231 ptrdiff_t pos
, pos_byte
, end_pos
;
3232 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3233 bool string_multibyte
IF_LINT (= 0);
3235 validate_region (&start
, &end
);
3236 if (CHAR_TABLE_P (table
))
3238 if (! EQ (XCHAR_TABLE (table
)->purpose
, Qtranslation_table
))
3239 error ("Not a translation table");
3245 CHECK_STRING (table
);
3247 if (! multibyte
&& (SCHARS (table
) < SBYTES (table
)))
3248 table
= string_make_unibyte (table
);
3249 string_multibyte
= SCHARS (table
) < SBYTES (table
);
3250 size
= SBYTES (table
);
3255 pos_byte
= CHAR_TO_BYTE (pos
);
3256 end_pos
= XINT (end
);
3257 modify_text (pos
, end_pos
);
3260 for (; pos
< end_pos
; )
3262 register unsigned char *p
= BYTE_POS_ADDR (pos_byte
);
3263 unsigned char *str
, buf
[MAX_MULTIBYTE_LENGTH
];
3269 oc
= STRING_CHAR_AND_LENGTH (p
, len
);
3276 /* Reload as signal_after_change in last iteration may GC. */
3278 if (string_multibyte
)
3280 str
= tt
+ string_char_to_byte (table
, oc
);
3281 nc
= STRING_CHAR_AND_LENGTH (str
, str_len
);
3286 if (! ASCII_CHAR_P (nc
) && multibyte
)
3288 str_len
= BYTE8_STRING (nc
, buf
);
3301 val
= CHAR_TABLE_REF (table
, oc
);
3302 if (CHARACTERP (val
))
3304 nc
= XFASTINT (val
);
3305 str_len
= CHAR_STRING (nc
, buf
);
3308 else if (VECTORP (val
) || (CONSP (val
)))
3310 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3311 where TO is TO-CHAR or [TO-CHAR ...]. */
3316 if (nc
!= oc
&& nc
>= 0)
3318 /* Simple one char to one char translation. */
3323 /* This is less efficient, because it moves the gap,
3324 but it should handle multibyte characters correctly. */
3325 string
= make_multibyte_string ((char *) str
, 1, str_len
);
3326 replace_range (pos
, pos
+ 1, string
, 1, 0, 1);
3331 record_change (pos
, 1);
3332 while (str_len
-- > 0)
3334 signal_after_change (pos
, 1, 1);
3335 update_compositions (pos
, pos
+ 1, CHECK_BORDER
);
3345 val
= check_translation (pos
, pos_byte
, end_pos
, val
);
3352 /* VAL is ([FROM-CHAR ...] . TO). */
3353 len
= ASIZE (XCAR (val
));
3361 string
= Fconcat (1, &val
);
3365 string
= Fmake_string (make_number (1), val
);
3367 replace_range (pos
, pos
+ len
, string
, 1, 0, 1);
3368 pos_byte
+= SBYTES (string
);
3369 pos
+= SCHARS (string
);
3370 cnt
+= SCHARS (string
);
3371 end_pos
+= SCHARS (string
) - len
;
3379 return make_number (cnt
);
3382 DEFUN ("delete-region", Fdelete_region
, Sdelete_region
, 2, 2, "r",
3383 doc
: /* Delete the text between START and END.
3384 If called interactively, delete the region between point and mark.
3385 This command deletes buffer text without modifying the kill ring. */)
3386 (Lisp_Object start
, Lisp_Object end
)
3388 validate_region (&start
, &end
);
3389 del_range (XINT (start
), XINT (end
));
3393 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region
,
3394 Sdelete_and_extract_region
, 2, 2, 0,
3395 doc
: /* Delete the text between START and END and return it. */)
3396 (Lisp_Object start
, Lisp_Object end
)
3398 validate_region (&start
, &end
);
3399 if (XINT (start
) == XINT (end
))
3400 return empty_unibyte_string
;
3401 return del_range_1 (XINT (start
), XINT (end
), 1, 1);
3404 DEFUN ("widen", Fwiden
, Swiden
, 0, 0, "",
3405 doc
: /* Remove restrictions (narrowing) from current buffer.
3406 This allows the buffer's full text to be seen and edited. */)
3409 if (BEG
!= BEGV
|| Z
!= ZV
)
3410 current_buffer
->clip_changed
= 1;
3412 BEGV_BYTE
= BEG_BYTE
;
3413 SET_BUF_ZV_BOTH (current_buffer
, Z
, Z_BYTE
);
3414 /* Changing the buffer bounds invalidates any recorded current column. */
3415 invalidate_current_column ();
3419 DEFUN ("narrow-to-region", Fnarrow_to_region
, Snarrow_to_region
, 2, 2, "r",
3420 doc
: /* Restrict editing in this buffer to the current region.
3421 The rest of the text becomes temporarily invisible and untouchable
3422 but is not deleted; if you save the buffer in a file, the invisible
3423 text is included in the file. \\[widen] makes all visible again.
3424 See also `save-restriction'.
3426 When calling from a program, pass two arguments; positions (integers
3427 or markers) bounding the text that should remain visible. */)
3428 (register Lisp_Object start
, Lisp_Object end
)
3430 CHECK_NUMBER_COERCE_MARKER (start
);
3431 CHECK_NUMBER_COERCE_MARKER (end
);
3433 if (XINT (start
) > XINT (end
))
3436 tem
= start
; start
= end
; end
= tem
;
3439 if (!(BEG
<= XINT (start
) && XINT (start
) <= XINT (end
) && XINT (end
) <= Z
))
3440 args_out_of_range (start
, end
);
3442 if (BEGV
!= XFASTINT (start
) || ZV
!= XFASTINT (end
))
3443 current_buffer
->clip_changed
= 1;
3445 SET_BUF_BEGV (current_buffer
, XFASTINT (start
));
3446 SET_BUF_ZV (current_buffer
, XFASTINT (end
));
3447 if (PT
< XFASTINT (start
))
3448 SET_PT (XFASTINT (start
));
3449 if (PT
> XFASTINT (end
))
3450 SET_PT (XFASTINT (end
));
3451 /* Changing the buffer bounds invalidates any recorded current column. */
3452 invalidate_current_column ();
3457 save_restriction_save (void)
3459 if (BEGV
== BEG
&& ZV
== Z
)
3460 /* The common case that the buffer isn't narrowed.
3461 We return just the buffer object, which save_restriction_restore
3462 recognizes as meaning `no restriction'. */
3463 return Fcurrent_buffer ();
3465 /* We have to save a restriction, so return a pair of markers, one
3466 for the beginning and one for the end. */
3468 Lisp_Object beg
, end
;
3470 beg
= build_marker (current_buffer
, BEGV
, BEGV_BYTE
);
3471 end
= build_marker (current_buffer
, ZV
, ZV_BYTE
);
3473 /* END must move forward if text is inserted at its exact location. */
3474 XMARKER (end
)->insertion_type
= 1;
3476 return Fcons (beg
, end
);
3481 save_restriction_restore (Lisp_Object data
)
3483 struct buffer
*cur
= NULL
;
3484 struct buffer
*buf
= (CONSP (data
)
3485 ? XMARKER (XCAR (data
))->buffer
3488 if (buf
&& buf
!= current_buffer
&& !NILP (BVAR (buf
, pt_marker
)))
3489 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3490 is the case if it is or has an indirect buffer), then make
3491 sure it is current before we update BEGV, so
3492 set_buffer_internal takes care of managing those markers. */
3493 cur
= current_buffer
;
3494 set_buffer_internal (buf
);
3498 /* A pair of marks bounding a saved restriction. */
3500 struct Lisp_Marker
*beg
= XMARKER (XCAR (data
));
3501 struct Lisp_Marker
*end
= XMARKER (XCDR (data
));
3502 eassert (buf
== end
->buffer
);
3504 if (buf
/* Verify marker still points to a buffer. */
3505 && (beg
->charpos
!= BUF_BEGV (buf
) || end
->charpos
!= BUF_ZV (buf
)))
3506 /* The restriction has changed from the saved one, so restore
3507 the saved restriction. */
3509 ptrdiff_t pt
= BUF_PT (buf
);
3511 SET_BUF_BEGV_BOTH (buf
, beg
->charpos
, beg
->bytepos
);
3512 SET_BUF_ZV_BOTH (buf
, end
->charpos
, end
->bytepos
);
3514 if (pt
< beg
->charpos
|| pt
> end
->charpos
)
3515 /* The point is outside the new visible range, move it inside. */
3516 SET_BUF_PT_BOTH (buf
,
3517 clip_to_bounds (beg
->charpos
, pt
, end
->charpos
),
3518 clip_to_bounds (beg
->bytepos
, BUF_PT_BYTE (buf
),
3521 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3523 /* These aren't needed anymore, so don't wait for GC. */
3524 free_marker (XCAR (data
));
3525 free_marker (XCDR (data
));
3526 free_cons (XCONS (data
));
3529 /* A buffer, which means that there was no old restriction. */
3531 if (buf
/* Verify marker still points to a buffer. */
3532 && (BUF_BEGV (buf
) != BUF_BEG (buf
) || BUF_ZV (buf
) != BUF_Z (buf
)))
3533 /* The buffer has been narrowed, get rid of the narrowing. */
3535 SET_BUF_BEGV_BOTH (buf
, BUF_BEG (buf
), BUF_BEG_BYTE (buf
));
3536 SET_BUF_ZV_BOTH (buf
, BUF_Z (buf
), BUF_Z_BYTE (buf
));
3538 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3542 /* Changing the buffer bounds invalidates any recorded current column. */
3543 invalidate_current_column ();
3546 set_buffer_internal (cur
);
3549 DEFUN ("save-restriction", Fsave_restriction
, Ssave_restriction
, 0, UNEVALLED
, 0,
3550 doc
: /* Execute BODY, saving and restoring current buffer's restrictions.
3551 The buffer's restrictions make parts of the beginning and end invisible.
3552 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3553 This special form, `save-restriction', saves the current buffer's restrictions
3554 when it is entered, and restores them when it is exited.
3555 So any `narrow-to-region' within BODY lasts only until the end of the form.
3556 The old restrictions settings are restored
3557 even in case of abnormal exit (throw or error).
3559 The value returned is the value of the last form in BODY.
3561 Note: if you are using both `save-excursion' and `save-restriction',
3562 use `save-excursion' outermost:
3563 (save-excursion (save-restriction ...))
3565 usage: (save-restriction &rest BODY) */)
3568 register Lisp_Object val
;
3569 ptrdiff_t count
= SPECPDL_INDEX ();
3571 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
3572 val
= Fprogn (body
);
3573 return unbind_to (count
, val
);
3576 DEFUN ("message", Fmessage
, Smessage
, 1, MANY
, 0,
3577 doc
: /* Display a message at the bottom of the screen.
3578 The message also goes into the `*Messages*' buffer, if `message-log-max'
3579 is non-nil. (In keyboard macros, that's all it does.)
3582 In batch mode, the message is printed to the standard error stream,
3583 followed by a newline.
3585 The first argument is a format control string, and the rest are data
3586 to be formatted under control of the string. See `format' for details.
3588 Note: Use (message "%s" VALUE) to print the value of expressions and
3589 variables to avoid accidentally interpreting `%' as format specifiers.
3591 If the first argument is nil or the empty string, the function clears
3592 any existing message; this lets the minibuffer contents show. See
3593 also `current-message'.
3595 usage: (message FORMAT-STRING &rest ARGS) */)
3596 (ptrdiff_t nargs
, Lisp_Object
*args
)
3599 || (STRINGP (args
[0])
3600 && SBYTES (args
[0]) == 0))
3607 register Lisp_Object val
;
3608 val
= Fformat (nargs
, args
);
3614 DEFUN ("message-box", Fmessage_box
, Smessage_box
, 1, MANY
, 0,
3615 doc
: /* Display a message, in a dialog box if possible.
3616 If a dialog box is not available, use the echo area.
3617 The first argument is a format control string, and the rest are data
3618 to be formatted under control of the string. See `format' for details.
3620 If the first argument is nil or the empty string, clear any existing
3621 message; let the minibuffer contents show.
3623 usage: (message-box FORMAT-STRING &rest ARGS) */)
3624 (ptrdiff_t nargs
, Lisp_Object
*args
)
3633 Lisp_Object val
= Fformat (nargs
, args
);
3634 Lisp_Object pane
, menu
;
3635 struct gcpro gcpro1
;
3637 pane
= list1 (Fcons (build_string ("OK"), Qt
));
3639 menu
= Fcons (val
, pane
);
3640 Fx_popup_dialog (Qt
, menu
, Qt
);
3646 DEFUN ("message-or-box", Fmessage_or_box
, Smessage_or_box
, 1, MANY
, 0,
3647 doc
: /* Display a message in a dialog box or in the echo area.
3648 If this command was invoked with the mouse, use a dialog box if
3649 `use-dialog-box' is non-nil.
3650 Otherwise, use the echo area.
3651 The first argument is a format control string, and the rest are data
3652 to be formatted under control of the string. See `format' for details.
3654 If the first argument is nil or the empty string, clear any existing
3655 message; let the minibuffer contents show.
3657 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3658 (ptrdiff_t nargs
, Lisp_Object
*args
)
3660 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
3662 return Fmessage_box (nargs
, args
);
3663 return Fmessage (nargs
, args
);
3666 DEFUN ("current-message", Fcurrent_message
, Scurrent_message
, 0, 0, 0,
3667 doc
: /* Return the string currently displayed in the echo area, or nil if none. */)
3670 return current_message ();
3674 DEFUN ("propertize", Fpropertize
, Spropertize
, 1, MANY
, 0,
3675 doc
: /* Return a copy of STRING with text properties added.
3676 First argument is the string to copy.
3677 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3678 properties to add to the result.
3679 usage: (propertize STRING &rest PROPERTIES) */)
3680 (ptrdiff_t nargs
, Lisp_Object
*args
)
3682 Lisp_Object properties
, string
;
3683 struct gcpro gcpro1
, gcpro2
;
3686 /* Number of args must be odd. */
3687 if ((nargs
& 1) == 0)
3688 error ("Wrong number of arguments");
3690 properties
= string
= Qnil
;
3691 GCPRO2 (properties
, string
);
3693 /* First argument must be a string. */
3694 CHECK_STRING (args
[0]);
3695 string
= Fcopy_sequence (args
[0]);
3697 for (i
= 1; i
< nargs
; i
+= 2)
3698 properties
= Fcons (args
[i
], Fcons (args
[i
+ 1], properties
));
3700 Fadd_text_properties (make_number (0),
3701 make_number (SCHARS (string
)),
3702 properties
, string
);
3703 RETURN_UNGCPRO (string
);
3706 DEFUN ("format", Fformat
, Sformat
, 1, MANY
, 0,
3707 doc
: /* Format a string out of a format-string and arguments.
3708 The first argument is a format control string.
3709 The other arguments are substituted into it to make the result, a string.
3711 The format control string may contain %-sequences meaning to substitute
3712 the next available argument:
3714 %s means print a string argument. Actually, prints any object, with `princ'.
3715 %d means print as number in decimal (%o octal, %x hex).
3716 %X is like %x, but uses upper case.
3717 %e means print a number in exponential notation.
3718 %f means print a number in decimal-point notation.
3719 %g means print a number in exponential notation
3720 or decimal-point notation, whichever uses fewer characters.
3721 %c means print a number as a single character.
3722 %S means print any object as an s-expression (using `prin1').
3724 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3725 Use %% to put a single % into the output.
3727 A %-sequence may contain optional flag, width, and precision
3728 specifiers, as follows:
3730 %<flags><width><precision>character
3732 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3734 The + flag character inserts a + before any positive number, while a
3735 space inserts a space before any positive number; these flags only
3736 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3737 The - and 0 flags affect the width specifier, as described below.
3739 The # flag means to use an alternate display form for %o, %x, %X, %e,
3740 %f, and %g sequences: for %o, it ensures that the result begins with
3741 \"0\"; for %x and %X, it prefixes the result with \"0x\" or \"0X\";
3742 for %e, %f, and %g, it causes a decimal point to be included even if
3743 the precision is zero.
3745 The width specifier supplies a lower limit for the length of the
3746 printed representation. The padding, if any, normally goes on the
3747 left, but it goes on the right if the - flag is present. The padding
3748 character is normally a space, but it is 0 if the 0 flag is present.
3749 The 0 flag is ignored if the - flag is present, or the format sequence
3750 is something other than %d, %e, %f, and %g.
3752 For %e, %f, and %g sequences, the number after the "." in the
3753 precision specifier says how many decimal places to show; if zero, the
3754 decimal point itself is omitted. For %s and %S, the precision
3755 specifier truncates the string to the given width.
3757 usage: (format STRING &rest OBJECTS) */)
3758 (ptrdiff_t nargs
, Lisp_Object
*args
)
3760 ptrdiff_t n
; /* The number of the next arg to substitute. */
3761 char initial_buffer
[4000];
3762 char *buf
= initial_buffer
;
3763 ptrdiff_t bufsize
= sizeof initial_buffer
;
3764 ptrdiff_t max_bufsize
= STRING_BYTES_BOUND
+ 1;
3766 ptrdiff_t buf_save_value_index
IF_LINT (= 0);
3767 char *format
, *end
, *format_start
;
3768 ptrdiff_t formatlen
, nchars
;
3769 /* True if the format is multibyte. */
3770 bool multibyte_format
= 0;
3771 /* True if the output should be a multibyte string,
3772 which is true if any of the inputs is one. */
3774 /* When we make a multibyte string, we must pay attention to the
3775 byte combining problem, i.e., a byte may be combined with a
3776 multibyte character of the previous string. This flag tells if we
3777 must consider such a situation or not. */
3778 bool maybe_combine_byte
;
3780 bool arg_intervals
= 0;
3783 /* discarded[I] is 1 if byte I of the format
3784 string was not copied into the output.
3785 It is 2 if byte I was not the first byte of its character. */
3788 /* Each element records, for one argument,
3789 the start and end bytepos in the output string,
3790 whether the argument has been converted to string (e.g., due to "%S"),
3791 and whether the argument is a string with intervals.
3792 info[0] is unused. Unused elements have -1 for start. */
3795 ptrdiff_t start
, end
;
3796 bool_bf converted_to_string
: 1;
3797 bool_bf intervals
: 1;
3800 /* It should not be necessary to GCPRO ARGS, because
3801 the caller in the interpreter should take care of that. */
3803 CHECK_STRING (args
[0]);
3804 format_start
= SSDATA (args
[0]);
3805 formatlen
= SBYTES (args
[0]);
3807 /* Allocate the info and discarded tables. */
3810 if ((SIZE_MAX
- formatlen
) / sizeof (struct info
) <= nargs
)
3811 memory_full (SIZE_MAX
);
3812 info
= SAFE_ALLOCA ((nargs
+ 1) * sizeof *info
+ formatlen
);
3813 discarded
= (char *) &info
[nargs
+ 1];
3814 for (i
= 0; i
< nargs
+ 1; i
++)
3817 info
[i
].intervals
= info
[i
].converted_to_string
= 0;
3819 memset (discarded
, 0, formatlen
);
3822 /* Try to determine whether the result should be multibyte.
3823 This is not always right; sometimes the result needs to be multibyte
3824 because of an object that we will pass through prin1,
3825 and in that case, we won't know it here. */
3826 multibyte_format
= STRING_MULTIBYTE (args
[0]);
3827 multibyte
= multibyte_format
;
3828 for (n
= 1; !multibyte
&& n
< nargs
; n
++)
3829 if (STRINGP (args
[n
]) && STRING_MULTIBYTE (args
[n
]))
3832 /* If we start out planning a unibyte result,
3833 then discover it has to be multibyte, we jump back to retry. */
3840 /* Scan the format and store result in BUF. */
3841 format
= format_start
;
3842 end
= format
+ formatlen
;
3843 maybe_combine_byte
= 0;
3845 while (format
!= end
)
3847 /* The values of N and FORMAT when the loop body is entered. */
3849 char *format0
= format
;
3851 /* Bytes needed to represent the output of this conversion. */
3852 ptrdiff_t convbytes
;
3856 /* General format specifications look like
3858 '%' [flags] [field-width] [precision] format
3863 field-width ::= [0-9]+
3864 precision ::= '.' [0-9]*
3866 If a field-width is specified, it specifies to which width
3867 the output should be padded with blanks, if the output
3868 string is shorter than field-width.
3870 If precision is specified, it specifies the number of
3871 digits to print after the '.' for floats, or the max.
3872 number of chars to print from a string. */
3874 bool minus_flag
= 0;
3876 bool space_flag
= 0;
3877 bool sharp_flag
= 0;
3879 ptrdiff_t field_width
;
3880 bool precision_given
;
3881 uintmax_t precision
= UINTMAX_MAX
;
3889 case '-': minus_flag
= 1; continue;
3890 case '+': plus_flag
= 1; continue;
3891 case ' ': space_flag
= 1; continue;
3892 case '#': sharp_flag
= 1; continue;
3893 case '0': zero_flag
= 1; continue;
3898 /* Ignore flags when sprintf ignores them. */
3899 space_flag
&= ~ plus_flag
;
3900 zero_flag
&= ~ minus_flag
;
3903 uintmax_t w
= strtoumax (format
, &num_end
, 10);
3904 if (max_bufsize
<= w
)
3908 precision_given
= *num_end
== '.';
3909 if (precision_given
)
3910 precision
= strtoumax (num_end
+ 1, &num_end
, 10);
3914 error ("Format string ends in middle of format specifier");
3916 memset (&discarded
[format0
- format_start
], 1, format
- format0
);
3917 conversion
= *format
;
3918 if (conversion
== '%')
3920 discarded
[format
- format_start
] = 1;
3925 error ("Not enough arguments for format string");
3927 /* For 'S', prin1 the argument, and then treat like 's'.
3928 For 's', princ any argument that is not a string or
3929 symbol. But don't do this conversion twice, which might
3930 happen after retrying. */
3931 if ((conversion
== 'S'
3932 || (conversion
== 's'
3933 && ! STRINGP (args
[n
]) && ! SYMBOLP (args
[n
]))))
3935 if (! info
[n
].converted_to_string
)
3937 Lisp_Object noescape
= conversion
== 'S' ? Qnil
: Qt
;
3938 args
[n
] = Fprin1_to_string (args
[n
], noescape
);
3939 info
[n
].converted_to_string
= 1;
3940 if (STRING_MULTIBYTE (args
[n
]) && ! multibyte
)
3948 else if (conversion
== 'c')
3950 if (FLOATP (args
[n
]))
3952 double d
= XFLOAT_DATA (args
[n
]);
3953 args
[n
] = make_number (FIXNUM_OVERFLOW_P (d
) ? -1 : d
);
3956 if (INTEGERP (args
[n
]) && ! ASCII_CHAR_P (XINT (args
[n
])))
3963 args
[n
] = Fchar_to_string (args
[n
]);
3964 info
[n
].converted_to_string
= 1;
3967 if (info
[n
].converted_to_string
)
3972 if (SYMBOLP (args
[n
]))
3974 args
[n
] = SYMBOL_NAME (args
[n
]);
3975 if (STRING_MULTIBYTE (args
[n
]) && ! multibyte
)
3982 if (conversion
== 's')
3984 /* handle case (precision[n] >= 0) */
3986 ptrdiff_t width
, padding
, nbytes
;
3987 ptrdiff_t nchars_string
;
3989 ptrdiff_t prec
= -1;
3990 if (precision_given
&& precision
<= TYPE_MAXIMUM (ptrdiff_t))
3993 /* lisp_string_width ignores a precision of 0, but GNU
3994 libc functions print 0 characters when the precision
3995 is 0. Imitate libc behavior here. Changing
3996 lisp_string_width is the right thing, and will be
3997 done, but meanwhile we work with it. */
4000 width
= nchars_string
= nbytes
= 0;
4004 width
= lisp_string_width (args
[n
], prec
, &nch
, &nby
);
4007 nchars_string
= SCHARS (args
[n
]);
4008 nbytes
= SBYTES (args
[n
]);
4012 nchars_string
= nch
;
4018 if (convbytes
&& multibyte
&& ! STRING_MULTIBYTE (args
[n
]))
4019 convbytes
= count_size_as_multibyte (SDATA (args
[n
]), nbytes
);
4021 padding
= width
< field_width
? field_width
- width
: 0;
4023 if (max_bufsize
- padding
<= convbytes
)
4025 convbytes
+= padding
;
4026 if (convbytes
<= buf
+ bufsize
- p
)
4030 memset (p
, ' ', padding
);
4037 && !ASCII_CHAR_P (*((unsigned char *) p
- 1))
4038 && STRING_MULTIBYTE (args
[n
])
4039 && !CHAR_HEAD_P (SREF (args
[n
], 0)))
4040 maybe_combine_byte
= 1;
4042 p
+= copy_text (SDATA (args
[n
]), (unsigned char *) p
,
4044 STRING_MULTIBYTE (args
[n
]), multibyte
);
4046 info
[n
].start
= nchars
;
4047 nchars
+= nchars_string
;
4048 info
[n
].end
= nchars
;
4052 memset (p
, ' ', padding
);
4057 /* If this argument has text properties, record where
4058 in the result string it appears. */
4059 if (string_intervals (args
[n
]))
4060 info
[n
].intervals
= arg_intervals
= 1;
4065 else if (! (conversion
== 'c' || conversion
== 'd'
4066 || conversion
== 'e' || conversion
== 'f'
4067 || conversion
== 'g' || conversion
== 'i'
4068 || conversion
== 'o' || conversion
== 'x'
4069 || conversion
== 'X'))
4070 error ("Invalid format operation %%%c",
4071 STRING_CHAR ((unsigned char *) format
- 1));
4072 else if (! (INTEGERP (args
[n
]) || FLOATP (args
[n
])))
4073 error ("Format specifier doesn't match argument type");
4078 /* Maximum precision for a %f conversion such that the
4079 trailing output digit might be nonzero. Any precision
4080 larger than this will not yield useful information. */
4081 USEFUL_PRECISION_MAX
=
4083 * (FLT_RADIX
== 2 || FLT_RADIX
== 10 ? 1
4084 : FLT_RADIX
== 16 ? 4
4087 /* Maximum number of bytes generated by any format, if
4088 precision is no more than USEFUL_PRECISION_MAX.
4089 On all practical hosts, %f is the worst case. */
4091 sizeof "-." + (DBL_MAX_10_EXP
+ 1) + USEFUL_PRECISION_MAX
,
4093 /* Length of pM (that is, of pMd without the
4095 pMlen
= sizeof pMd
- 2
4097 verify (USEFUL_PRECISION_MAX
> 0);
4100 ptrdiff_t padding
, sprintf_bytes
;
4101 uintmax_t excess_precision
, numwidth
;
4102 uintmax_t leading_zeros
= 0, trailing_zeros
= 0;
4104 char sprintf_buf
[SPRINTF_BUFSIZE
];
4106 /* Copy of conversion specification, modified somewhat.
4107 At most three flags F can be specified at once. */
4108 char convspec
[sizeof "%FFF.*d" + pMlen
];
4110 /* Avoid undefined behavior in underlying sprintf. */
4111 if (conversion
== 'd' || conversion
== 'i')
4114 /* Create the copy of the conversion specification, with
4115 any width and precision removed, with ".*" inserted,
4116 and with pM inserted for integer formats. */
4120 *f
= '-'; f
+= minus_flag
;
4121 *f
= '+'; f
+= plus_flag
;
4122 *f
= ' '; f
+= space_flag
;
4123 *f
= '#'; f
+= sharp_flag
;
4124 *f
= '0'; f
+= zero_flag
;
4127 if (conversion
== 'd' || conversion
== 'i'
4128 || conversion
== 'o' || conversion
== 'x'
4129 || conversion
== 'X')
4131 memcpy (f
, pMd
, pMlen
);
4133 zero_flag
&= ~ precision_given
;
4140 if (precision_given
)
4141 prec
= min (precision
, USEFUL_PRECISION_MAX
);
4143 /* Use sprintf to format this number into sprintf_buf. Omit
4144 padding and excess precision, though, because sprintf limits
4145 output length to INT_MAX.
4147 There are four types of conversion: double, unsigned
4148 char (passed as int), wide signed int, and wide
4149 unsigned int. Treat them separately because the
4150 sprintf ABI is sensitive to which type is passed. Be
4151 careful about integer overflow, NaNs, infinities, and
4152 conversions; for example, the min and max macros are
4153 not suitable here. */
4154 if (conversion
== 'e' || conversion
== 'f' || conversion
== 'g')
4156 double x
= (INTEGERP (args
[n
])
4158 : XFLOAT_DATA (args
[n
]));
4159 sprintf_bytes
= sprintf (sprintf_buf
, convspec
, prec
, x
);
4161 else if (conversion
== 'c')
4163 /* Don't use sprintf here, as it might mishandle prec. */
4164 sprintf_buf
[0] = XINT (args
[n
]);
4165 sprintf_bytes
= prec
!= 0;
4167 else if (conversion
== 'd')
4169 /* For float, maybe we should use "%1.0f"
4170 instead so it also works for values outside
4171 the integer range. */
4173 if (INTEGERP (args
[n
]))
4177 double d
= XFLOAT_DATA (args
[n
]);
4180 x
= TYPE_MINIMUM (printmax_t
);
4186 x
= TYPE_MAXIMUM (printmax_t
);
4191 sprintf_bytes
= sprintf (sprintf_buf
, convspec
, prec
, x
);
4195 /* Don't sign-extend for octal or hex printing. */
4197 if (INTEGERP (args
[n
]))
4198 x
= XUINT (args
[n
]);
4201 double d
= XFLOAT_DATA (args
[n
]);
4206 x
= TYPE_MAXIMUM (uprintmax_t
);
4211 sprintf_bytes
= sprintf (sprintf_buf
, convspec
, prec
, x
);
4214 /* Now the length of the formatted item is known, except it omits
4215 padding and excess precision. Deal with excess precision
4216 first. This happens only when the format specifies
4217 ridiculously large precision. */
4218 excess_precision
= precision
- prec
;
4219 if (excess_precision
)
4221 if (conversion
== 'e' || conversion
== 'f'
4222 || conversion
== 'g')
4224 if ((conversion
== 'g' && ! sharp_flag
)
4225 || ! ('0' <= sprintf_buf
[sprintf_bytes
- 1]
4226 && sprintf_buf
[sprintf_bytes
- 1] <= '9'))
4227 excess_precision
= 0;
4230 if (conversion
== 'g')
4232 char *dot
= strchr (sprintf_buf
, '.');
4234 excess_precision
= 0;
4237 trailing_zeros
= excess_precision
;
4240 leading_zeros
= excess_precision
;
4243 /* Compute the total bytes needed for this item, including
4244 excess precision and padding. */
4245 numwidth
= sprintf_bytes
+ excess_precision
;
4246 padding
= numwidth
< field_width
? field_width
- numwidth
: 0;
4247 if (max_bufsize
- sprintf_bytes
<= excess_precision
4248 || max_bufsize
- padding
<= numwidth
)
4250 convbytes
= numwidth
+ padding
;
4252 if (convbytes
<= buf
+ bufsize
- p
)
4254 /* Copy the formatted item from sprintf_buf into buf,
4255 inserting padding and excess-precision zeros. */
4257 char *src
= sprintf_buf
;
4259 int exponent_bytes
= 0;
4260 bool signedp
= src0
== '-' || src0
== '+' || src0
== ' ';
4261 int significand_bytes
;
4263 && ((src
[signedp
] >= '0' && src
[signedp
] <= '9')
4264 || (src
[signedp
] >= 'a' && src
[signedp
] <= 'f')
4265 || (src
[signedp
] >= 'A' && src
[signedp
] <= 'F')))
4267 leading_zeros
+= padding
;
4271 if (excess_precision
4272 && (conversion
== 'e' || conversion
== 'g'))
4274 char *e
= strchr (src
, 'e');
4276 exponent_bytes
= src
+ sprintf_bytes
- e
;
4281 memset (p
, ' ', padding
);
4289 memset (p
, '0', leading_zeros
);
4291 significand_bytes
= sprintf_bytes
- signedp
- exponent_bytes
;
4292 memcpy (p
, src
, significand_bytes
);
4293 p
+= significand_bytes
;
4294 src
+= significand_bytes
;
4295 memset (p
, '0', trailing_zeros
);
4296 p
+= trailing_zeros
;
4297 memcpy (p
, src
, exponent_bytes
);
4298 p
+= exponent_bytes
;
4300 info
[n
].start
= nchars
;
4301 nchars
+= leading_zeros
+ sprintf_bytes
+ trailing_zeros
;
4302 info
[n
].end
= nchars
;
4306 memset (p
, ' ', padding
);
4318 /* Copy a single character from format to buf. */
4321 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4323 if (multibyte_format
)
4325 /* Copy a whole multibyte character. */
4327 && !ASCII_CHAR_P (*((unsigned char *) p
- 1))
4328 && !CHAR_HEAD_P (*format
))
4329 maybe_combine_byte
= 1;
4333 while (! CHAR_HEAD_P (*format
));
4335 convbytes
= format
- src
;
4336 memset (&discarded
[src
+ 1 - format_start
], 2, convbytes
- 1);
4340 unsigned char uc
= *format
++;
4341 if (! multibyte
|| ASCII_CHAR_P (uc
))
4345 int c
= BYTE8_TO_CHAR (uc
);
4346 convbytes
= CHAR_STRING (c
, str
);
4351 if (convbytes
<= buf
+ bufsize
- p
)
4353 memcpy (p
, src
, convbytes
);
4360 /* There wasn't enough room to store this conversion or single
4361 character. CONVBYTES says how much room is needed. Allocate
4362 enough room (and then some) and do it again. */
4364 ptrdiff_t used
= p
- buf
;
4366 if (max_bufsize
- used
< convbytes
)
4368 bufsize
= used
+ convbytes
;
4369 bufsize
= bufsize
< max_bufsize
/ 2 ? bufsize
* 2 : max_bufsize
;
4371 if (buf
== initial_buffer
)
4373 buf
= xmalloc (bufsize
);
4374 sa_must_free
= true;
4375 buf_save_value_index
= SPECPDL_INDEX ();
4376 record_unwind_protect_ptr (xfree
, buf
);
4377 memcpy (buf
, initial_buffer
, used
);
4381 buf
= xrealloc (buf
, bufsize
);
4382 set_unwind_protect_ptr (buf_save_value_index
, xfree
, buf
);
4392 if (bufsize
< p
- buf
)
4395 if (maybe_combine_byte
)
4396 nchars
= multibyte_chars_in_text ((unsigned char *) buf
, p
- buf
);
4397 val
= make_specified_string (buf
, nchars
, p
- buf
, multibyte
);
4399 /* If we allocated BUF with malloc, free it too. */
4402 /* If the format string has text properties, or any of the string
4403 arguments has text properties, set up text properties of the
4406 if (string_intervals (args
[0]) || arg_intervals
)
4408 Lisp_Object len
, new_len
, props
;
4409 struct gcpro gcpro1
;
4411 /* Add text properties from the format string. */
4412 len
= make_number (SCHARS (args
[0]));
4413 props
= text_property_list (args
[0], make_number (0), len
, Qnil
);
4418 ptrdiff_t bytepos
= 0, position
= 0, translated
= 0;
4422 /* Adjust the bounds of each text property
4423 to the proper start and end in the output string. */
4425 /* Put the positions in PROPS in increasing order, so that
4426 we can do (effectively) one scan through the position
4427 space of the format string. */
4428 props
= Fnreverse (props
);
4430 /* BYTEPOS is the byte position in the format string,
4431 POSITION is the untranslated char position in it,
4432 TRANSLATED is the translated char position in BUF,
4433 and ARGN is the number of the next arg we will come to. */
4434 for (list
= props
; CONSP (list
); list
= XCDR (list
))
4441 /* First adjust the property start position. */
4442 pos
= XINT (XCAR (item
));
4444 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4445 up to this position. */
4446 for (; position
< pos
; bytepos
++)
4448 if (! discarded
[bytepos
])
4449 position
++, translated
++;
4450 else if (discarded
[bytepos
] == 1)
4453 if (translated
== info
[argn
].start
)
4455 translated
+= info
[argn
].end
- info
[argn
].start
;
4461 XSETCAR (item
, make_number (translated
));
4463 /* Likewise adjust the property end position. */
4464 pos
= XINT (XCAR (XCDR (item
)));
4466 for (; position
< pos
; bytepos
++)
4468 if (! discarded
[bytepos
])
4469 position
++, translated
++;
4470 else if (discarded
[bytepos
] == 1)
4473 if (translated
== info
[argn
].start
)
4475 translated
+= info
[argn
].end
- info
[argn
].start
;
4481 XSETCAR (XCDR (item
), make_number (translated
));
4484 add_text_properties_from_list (val
, props
, make_number (0));
4487 /* Add text properties from arguments. */
4489 for (n
= 1; n
< nargs
; ++n
)
4490 if (info
[n
].intervals
)
4492 len
= make_number (SCHARS (args
[n
]));
4493 new_len
= make_number (info
[n
].end
- info
[n
].start
);
4494 props
= text_property_list (args
[n
], make_number (0), len
, Qnil
);
4495 props
= extend_property_ranges (props
, new_len
);
4496 /* If successive arguments have properties, be sure that
4497 the value of `composition' property be the copy. */
4498 if (n
> 1 && info
[n
- 1].end
)
4499 make_composition_value_copy (props
);
4500 add_text_properties_from_list (val
, props
,
4501 make_number (info
[n
].start
));
4511 format2 (const char *string1
, Lisp_Object arg0
, Lisp_Object arg1
)
4513 AUTO_STRING (format
, string1
);
4514 return CALLN (Fformat
, format
, arg0
, arg1
);
4517 DEFUN ("char-equal", Fchar_equal
, Schar_equal
, 2, 2, 0,
4518 doc
: /* Return t if two characters match, optionally ignoring case.
4519 Both arguments must be characters (i.e. integers).
4520 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4521 (register Lisp_Object c1
, Lisp_Object c2
)
4524 /* Check they're chars, not just integers, otherwise we could get array
4525 bounds violations in downcase. */
4526 CHECK_CHARACTER (c1
);
4527 CHECK_CHARACTER (c2
);
4529 if (XINT (c1
) == XINT (c2
))
4531 if (NILP (BVAR (current_buffer
, case_fold_search
)))
4537 /* FIXME: It is possible to compare multibyte characters even when
4538 the current buffer is unibyte. Unfortunately this is ambiguous
4539 for characters between 128 and 255, as they could be either
4540 eight-bit raw bytes or Latin-1 characters. Assume the former for
4541 now. See Bug#17011, and also see casefiddle.c's casify_object,
4542 which has a similar problem. */
4543 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4545 if (SINGLE_BYTE_CHAR_P (i1
))
4546 i1
= UNIBYTE_TO_CHAR (i1
);
4547 if (SINGLE_BYTE_CHAR_P (i2
))
4548 i2
= UNIBYTE_TO_CHAR (i2
);
4551 return (downcase (i1
) == downcase (i2
) ? Qt
: Qnil
);
4554 /* Transpose the markers in two regions of the current buffer, and
4555 adjust the ones between them if necessary (i.e.: if the regions
4558 START1, END1 are the character positions of the first region.
4559 START1_BYTE, END1_BYTE are the byte positions.
4560 START2, END2 are the character positions of the second region.
4561 START2_BYTE, END2_BYTE are the byte positions.
4563 Traverses the entire marker list of the buffer to do so, adding an
4564 appropriate amount to some, subtracting from some, and leaving the
4565 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4567 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4570 transpose_markers (ptrdiff_t start1
, ptrdiff_t end1
,
4571 ptrdiff_t start2
, ptrdiff_t end2
,
4572 ptrdiff_t start1_byte
, ptrdiff_t end1_byte
,
4573 ptrdiff_t start2_byte
, ptrdiff_t end2_byte
)
4575 register ptrdiff_t amt1
, amt1_byte
, amt2
, amt2_byte
, diff
, diff_byte
, mpos
;
4576 register struct Lisp_Marker
*marker
;
4578 /* Update point as if it were a marker. */
4582 TEMP_SET_PT_BOTH (PT
+ (end2
- end1
),
4583 PT_BYTE
+ (end2_byte
- end1_byte
));
4584 else if (PT
< start2
)
4585 TEMP_SET_PT_BOTH (PT
+ (end2
- start2
) - (end1
- start1
),
4586 (PT_BYTE
+ (end2_byte
- start2_byte
)
4587 - (end1_byte
- start1_byte
)));
4589 TEMP_SET_PT_BOTH (PT
- (start2
- start1
),
4590 PT_BYTE
- (start2_byte
- start1_byte
));
4592 /* We used to adjust the endpoints here to account for the gap, but that
4593 isn't good enough. Even if we assume the caller has tried to move the
4594 gap out of our way, it might still be at start1 exactly, for example;
4595 and that places it `inside' the interval, for our purposes. The amount
4596 of adjustment is nontrivial if there's a `denormalized' marker whose
4597 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4598 the dirty work to Fmarker_position, below. */
4600 /* The difference between the region's lengths */
4601 diff
= (end2
- start2
) - (end1
- start1
);
4602 diff_byte
= (end2_byte
- start2_byte
) - (end1_byte
- start1_byte
);
4604 /* For shifting each marker in a region by the length of the other
4605 region plus the distance between the regions. */
4606 amt1
= (end2
- start2
) + (start2
- end1
);
4607 amt2
= (end1
- start1
) + (start2
- end1
);
4608 amt1_byte
= (end2_byte
- start2_byte
) + (start2_byte
- end1_byte
);
4609 amt2_byte
= (end1_byte
- start1_byte
) + (start2_byte
- end1_byte
);
4611 for (marker
= BUF_MARKERS (current_buffer
); marker
; marker
= marker
->next
)
4613 mpos
= marker
->bytepos
;
4614 if (mpos
>= start1_byte
&& mpos
< end2_byte
)
4616 if (mpos
< end1_byte
)
4618 else if (mpos
< start2_byte
)
4622 marker
->bytepos
= mpos
;
4624 mpos
= marker
->charpos
;
4625 if (mpos
>= start1
&& mpos
< end2
)
4629 else if (mpos
< start2
)
4634 marker
->charpos
= mpos
;
4638 DEFUN ("transpose-regions", Ftranspose_regions
, Stranspose_regions
, 4, 5, 0,
4639 doc
: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4640 The regions should not be overlapping, because the size of the buffer is
4641 never changed in a transposition.
4643 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4644 any markers that happen to be located in the regions.
4646 Transposing beyond buffer boundaries is an error. */)
4647 (Lisp_Object startr1
, Lisp_Object endr1
, Lisp_Object startr2
, Lisp_Object endr2
, Lisp_Object leave_markers
)
4649 register ptrdiff_t start1
, end1
, start2
, end2
;
4650 ptrdiff_t start1_byte
, start2_byte
, len1_byte
, len2_byte
, end2_byte
;
4651 ptrdiff_t gap
, len1
, len_mid
, len2
;
4652 unsigned char *start1_addr
, *start2_addr
, *temp
;
4654 INTERVAL cur_intv
, tmp_interval1
, tmp_interval_mid
, tmp_interval2
, tmp_interval3
;
4657 XSETBUFFER (buf
, current_buffer
);
4658 cur_intv
= buffer_intervals (current_buffer
);
4660 validate_region (&startr1
, &endr1
);
4661 validate_region (&startr2
, &endr2
);
4663 start1
= XFASTINT (startr1
);
4664 end1
= XFASTINT (endr1
);
4665 start2
= XFASTINT (startr2
);
4666 end2
= XFASTINT (endr2
);
4669 /* Swap the regions if they're reversed. */
4672 register ptrdiff_t glumph
= start1
;
4680 len1
= end1
- start1
;
4681 len2
= end2
- start2
;
4684 error ("Transposed regions overlap");
4685 /* Nothing to change for adjacent regions with one being empty */
4686 else if ((start1
== end1
|| start2
== end2
) && end1
== start2
)
4689 /* The possibilities are:
4690 1. Adjacent (contiguous) regions, or separate but equal regions
4691 (no, really equal, in this case!), or
4692 2. Separate regions of unequal size.
4694 The worst case is usually No. 2. It means that (aside from
4695 potential need for getting the gap out of the way), there also
4696 needs to be a shifting of the text between the two regions. So
4697 if they are spread far apart, we are that much slower... sigh. */
4699 /* It must be pointed out that the really studly thing to do would
4700 be not to move the gap at all, but to leave it in place and work
4701 around it if necessary. This would be extremely efficient,
4702 especially considering that people are likely to do
4703 transpositions near where they are working interactively, which
4704 is exactly where the gap would be found. However, such code
4705 would be much harder to write and to read. So, if you are
4706 reading this comment and are feeling squirrely, by all means have
4707 a go! I just didn't feel like doing it, so I will simply move
4708 the gap the minimum distance to get it out of the way, and then
4709 deal with an unbroken array. */
4711 start1_byte
= CHAR_TO_BYTE (start1
);
4712 end2_byte
= CHAR_TO_BYTE (end2
);
4714 /* Make sure the gap won't interfere, by moving it out of the text
4715 we will operate on. */
4716 if (start1
< gap
&& gap
< end2
)
4718 if (gap
- start1
< end2
- gap
)
4719 move_gap_both (start1
, start1_byte
);
4721 move_gap_both (end2
, end2_byte
);
4724 start2_byte
= CHAR_TO_BYTE (start2
);
4725 len1_byte
= CHAR_TO_BYTE (end1
) - start1_byte
;
4726 len2_byte
= end2_byte
- start2_byte
;
4728 #ifdef BYTE_COMBINING_DEBUG
4731 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4732 len2_byte
, start1
, start1_byte
)
4733 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4734 len1_byte
, end2
, start2_byte
+ len2_byte
)
4735 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4736 len1_byte
, end2
, start2_byte
+ len2_byte
))
4741 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4742 len2_byte
, start1
, start1_byte
)
4743 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4744 len1_byte
, start2
, start2_byte
)
4745 || count_combining_after (BYTE_POS_ADDR (start2_byte
),
4746 len2_byte
, end1
, start1_byte
+ len1_byte
)
4747 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4748 len1_byte
, end2
, start2_byte
+ len2_byte
))
4753 /* Hmmm... how about checking to see if the gap is large
4754 enough to use as the temporary storage? That would avoid an
4755 allocation... interesting. Later, don't fool with it now. */
4757 /* Working without memmove, for portability (sigh), so must be
4758 careful of overlapping subsections of the array... */
4760 if (end1
== start2
) /* adjacent regions */
4762 modify_text (start1
, end2
);
4763 record_change (start1
, len1
+ len2
);
4765 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4766 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4767 /* Don't use Fset_text_properties: that can cause GC, which can
4768 clobber objects stored in the tmp_intervals. */
4769 tmp_interval3
= validate_interval_range (buf
, &startr1
, &endr2
, 0);
4771 set_text_properties_1 (startr1
, endr2
, Qnil
, buf
, tmp_interval3
);
4775 /* First region smaller than second. */
4776 if (len1_byte
< len2_byte
)
4778 temp
= SAFE_ALLOCA (len2_byte
);
4780 /* Don't precompute these addresses. We have to compute them
4781 at the last minute, because the relocating allocator might
4782 have moved the buffer around during the xmalloc. */
4783 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4784 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4786 memcpy (temp
, start2_addr
, len2_byte
);
4787 memcpy (start1_addr
+ len2_byte
, start1_addr
, len1_byte
);
4788 memcpy (start1_addr
, temp
, len2_byte
);
4791 /* First region not smaller than second. */
4793 temp
= SAFE_ALLOCA (len1_byte
);
4794 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4795 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4796 memcpy (temp
, start1_addr
, len1_byte
);
4797 memcpy (start1_addr
, start2_addr
, len2_byte
);
4798 memcpy (start1_addr
+ len2_byte
, temp
, len1_byte
);
4802 graft_intervals_into_buffer (tmp_interval1
, start1
+ len2
,
4803 len1
, current_buffer
, 0);
4804 graft_intervals_into_buffer (tmp_interval2
, start1
,
4805 len2
, current_buffer
, 0);
4806 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4807 update_compositions (start1
+ len2
, end2
, CHECK_TAIL
);
4809 /* Non-adjacent regions, because end1 != start2, bleagh... */
4812 len_mid
= start2_byte
- (start1_byte
+ len1_byte
);
4814 if (len1_byte
== len2_byte
)
4815 /* Regions are same size, though, how nice. */
4819 modify_text (start1
, end1
);
4820 modify_text (start2
, end2
);
4821 record_change (start1
, len1
);
4822 record_change (start2
, len2
);
4823 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4824 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4826 tmp_interval3
= validate_interval_range (buf
, &startr1
, &endr1
, 0);
4828 set_text_properties_1 (startr1
, endr1
, Qnil
, buf
, tmp_interval3
);
4830 tmp_interval3
= validate_interval_range (buf
, &startr2
, &endr2
, 0);
4832 set_text_properties_1 (startr2
, endr2
, Qnil
, buf
, tmp_interval3
);
4834 temp
= SAFE_ALLOCA (len1_byte
);
4835 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4836 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4837 memcpy (temp
, start1_addr
, len1_byte
);
4838 memcpy (start1_addr
, start2_addr
, len2_byte
);
4839 memcpy (start2_addr
, temp
, len1_byte
);
4842 graft_intervals_into_buffer (tmp_interval1
, start2
,
4843 len1
, current_buffer
, 0);
4844 graft_intervals_into_buffer (tmp_interval2
, start1
,
4845 len2
, current_buffer
, 0);
4848 else if (len1_byte
< len2_byte
) /* Second region larger than first */
4849 /* Non-adjacent & unequal size, area between must also be shifted. */
4853 modify_text (start1
, end2
);
4854 record_change (start1
, (end2
- start1
));
4855 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4856 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4857 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4859 tmp_interval3
= validate_interval_range (buf
, &startr1
, &endr2
, 0);
4861 set_text_properties_1 (startr1
, endr2
, Qnil
, buf
, tmp_interval3
);
4863 /* holds region 2 */
4864 temp
= SAFE_ALLOCA (len2_byte
);
4865 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4866 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4867 memcpy (temp
, start2_addr
, len2_byte
);
4868 memcpy (start1_addr
+ len_mid
+ len2_byte
, start1_addr
, len1_byte
);
4869 memmove (start1_addr
+ len2_byte
, start1_addr
+ len1_byte
, len_mid
);
4870 memcpy (start1_addr
, temp
, len2_byte
);
4873 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4874 len1
, current_buffer
, 0);
4875 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4876 len_mid
, current_buffer
, 0);
4877 graft_intervals_into_buffer (tmp_interval2
, start1
,
4878 len2
, current_buffer
, 0);
4881 /* Second region smaller than first. */
4885 record_change (start1
, (end2
- start1
));
4886 modify_text (start1
, end2
);
4888 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4889 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4890 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4892 tmp_interval3
= validate_interval_range (buf
, &startr1
, &endr2
, 0);
4894 set_text_properties_1 (startr1
, endr2
, Qnil
, buf
, tmp_interval3
);
4896 /* holds region 1 */
4897 temp
= SAFE_ALLOCA (len1_byte
);
4898 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4899 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4900 memcpy (temp
, start1_addr
, len1_byte
);
4901 memcpy (start1_addr
, start2_addr
, len2_byte
);
4902 memcpy (start1_addr
+ len2_byte
, start1_addr
+ len1_byte
, len_mid
);
4903 memcpy (start1_addr
+ len2_byte
+ len_mid
, temp
, len1_byte
);
4906 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4907 len1
, current_buffer
, 0);
4908 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4909 len_mid
, current_buffer
, 0);
4910 graft_intervals_into_buffer (tmp_interval2
, start1
,
4911 len2
, current_buffer
, 0);
4914 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4915 update_compositions (end2
- len1
, end2
, CHECK_BORDER
);
4918 /* When doing multiple transpositions, it might be nice
4919 to optimize this. Perhaps the markers in any one buffer
4920 should be organized in some sorted data tree. */
4921 if (NILP (leave_markers
))
4923 transpose_markers (start1
, end1
, start2
, end2
,
4924 start1_byte
, start1_byte
+ len1_byte
,
4925 start2_byte
, start2_byte
+ len2_byte
);
4926 fix_start_end_in_overlays (start1
, end2
);
4929 signal_after_change (start1
, end2
- start1
, end2
- start1
);
4935 syms_of_editfns (void)
4937 DEFSYM (Qbuffer_access_fontify_functions
, "buffer-access-fontify-functions");
4939 DEFVAR_LISP ("inhibit-field-text-motion", Vinhibit_field_text_motion
,
4940 doc
: /* Non-nil means text motion commands don't notice fields. */);
4941 Vinhibit_field_text_motion
= Qnil
;
4943 DEFVAR_LISP ("buffer-access-fontify-functions",
4944 Vbuffer_access_fontify_functions
,
4945 doc
: /* List of functions called by `buffer-substring' to fontify if necessary.
4946 Each function is called with two arguments which specify the range
4947 of the buffer being accessed. */);
4948 Vbuffer_access_fontify_functions
= Qnil
;
4952 obuf
= Fcurrent_buffer ();
4953 /* Do this here, because init_buffer_once is too early--it won't work. */
4954 Fset_buffer (Vprin1_to_string_buffer
);
4955 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4956 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
4961 DEFVAR_LISP ("buffer-access-fontified-property",
4962 Vbuffer_access_fontified_property
,
4963 doc
: /* Property which (if non-nil) indicates text has been fontified.
4964 `buffer-substring' need not call the `buffer-access-fontify-functions'
4965 functions if all the text being accessed has this property. */);
4966 Vbuffer_access_fontified_property
= Qnil
;
4968 DEFVAR_LISP ("system-name", Vsystem_name
,
4969 doc
: /* The host name of the machine Emacs is running on. */);
4970 Vsystem_name
= cached_system_name
= Qnil
;
4972 DEFVAR_LISP ("user-full-name", Vuser_full_name
,
4973 doc
: /* The full name of the user logged in. */);
4975 DEFVAR_LISP ("user-login-name", Vuser_login_name
,
4976 doc
: /* The user's name, taken from environment variables if possible. */);
4978 DEFVAR_LISP ("user-real-login-name", Vuser_real_login_name
,
4979 doc
: /* The user's name, based upon the real uid only. */);
4981 DEFVAR_LISP ("operating-system-release", Voperating_system_release
,
4982 doc
: /* The release of the operating system Emacs is running on. */);
4984 defsubr (&Spropertize
);
4985 defsubr (&Schar_equal
);
4986 defsubr (&Sgoto_char
);
4987 defsubr (&Sstring_to_char
);
4988 defsubr (&Schar_to_string
);
4989 defsubr (&Sbyte_to_string
);
4990 defsubr (&Sbuffer_substring
);
4991 defsubr (&Sbuffer_substring_no_properties
);
4992 defsubr (&Sbuffer_string
);
4993 defsubr (&Sget_pos_property
);
4995 defsubr (&Spoint_marker
);
4996 defsubr (&Smark_marker
);
4998 defsubr (&Sregion_beginning
);
4999 defsubr (&Sregion_end
);
5001 /* Symbol for the text property used to mark fields. */
5002 DEFSYM (Qfield
, "field");
5004 /* A special value for Qfield properties. */
5005 DEFSYM (Qboundary
, "boundary");
5007 defsubr (&Sfield_beginning
);
5008 defsubr (&Sfield_end
);
5009 defsubr (&Sfield_string
);
5010 defsubr (&Sfield_string_no_properties
);
5011 defsubr (&Sdelete_field
);
5012 defsubr (&Sconstrain_to_field
);
5014 defsubr (&Sline_beginning_position
);
5015 defsubr (&Sline_end_position
);
5017 defsubr (&Ssave_excursion
);
5018 defsubr (&Ssave_current_buffer
);
5020 defsubr (&Sbuffer_size
);
5021 defsubr (&Spoint_max
);
5022 defsubr (&Spoint_min
);
5023 defsubr (&Spoint_min_marker
);
5024 defsubr (&Spoint_max_marker
);
5025 defsubr (&Sgap_position
);
5026 defsubr (&Sgap_size
);
5027 defsubr (&Sposition_bytes
);
5028 defsubr (&Sbyte_to_position
);
5034 defsubr (&Sfollowing_char
);
5035 defsubr (&Sprevious_char
);
5036 defsubr (&Schar_after
);
5037 defsubr (&Schar_before
);
5039 defsubr (&Sinsert_before_markers
);
5040 defsubr (&Sinsert_and_inherit
);
5041 defsubr (&Sinsert_and_inherit_before_markers
);
5042 defsubr (&Sinsert_char
);
5043 defsubr (&Sinsert_byte
);
5045 defsubr (&Suser_login_name
);
5046 defsubr (&Suser_real_login_name
);
5047 defsubr (&Suser_uid
);
5048 defsubr (&Suser_real_uid
);
5049 defsubr (&Sgroup_gid
);
5050 defsubr (&Sgroup_real_gid
);
5051 defsubr (&Suser_full_name
);
5052 defsubr (&Semacs_pid
);
5053 defsubr (&Scurrent_time
);
5054 defsubr (&Stime_add
);
5055 defsubr (&Stime_subtract
);
5056 defsubr (&Stime_less_p
);
5057 defsubr (&Sget_internal_run_time
);
5058 defsubr (&Sformat_time_string
);
5059 defsubr (&Sfloat_time
);
5060 defsubr (&Sdecode_time
);
5061 defsubr (&Sencode_time
);
5062 defsubr (&Scurrent_time_string
);
5063 defsubr (&Scurrent_time_zone
);
5064 defsubr (&Sset_time_zone_rule
);
5065 defsubr (&Ssystem_name
);
5066 defsubr (&Smessage
);
5067 defsubr (&Smessage_box
);
5068 defsubr (&Smessage_or_box
);
5069 defsubr (&Scurrent_message
);
5072 defsubr (&Sinsert_buffer_substring
);
5073 defsubr (&Scompare_buffer_substrings
);
5074 defsubr (&Ssubst_char_in_region
);
5075 defsubr (&Stranslate_region_internal
);
5076 defsubr (&Sdelete_region
);
5077 defsubr (&Sdelete_and_extract_region
);
5079 defsubr (&Snarrow_to_region
);
5080 defsubr (&Ssave_restriction
);
5081 defsubr (&Stranspose_regions
);