1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
25 #include <sys/types.h>
36 #ifdef HAVE_SYS_UTSNAME_H
37 #include <sys/utsname.h>
42 /* systime.h includes <sys/time.h> which, on some systems, is required
43 for <sys/resource.h>; thus systime.h must be included before
47 #if defined HAVE_SYS_RESOURCE_H
48 #include <sys/resource.h>
53 #include "intervals.h"
62 #define MAX_10_EXP DBL_MAX_10_EXP
64 #define MAX_10_EXP 310
72 extern char **environ
;
75 #define TM_YEAR_BASE 1900
77 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
78 asctime to have well-defined behavior. */
79 #ifndef TM_YEAR_IN_ASCTIME_RANGE
80 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
81 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
84 extern size_t emacs_strftimeu
P_ ((char *, size_t, const char *,
85 const struct tm
*, int));
86 static int tm_diff
P_ ((struct tm
*, struct tm
*));
87 static void find_field
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, int *, Lisp_Object
, int *));
88 static void update_buffer_properties
P_ ((int, int));
89 static Lisp_Object region_limit
P_ ((int));
90 int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
91 static size_t emacs_memftimeu
P_ ((char *, size_t, const char *,
92 size_t, const struct tm
*, int));
93 static void general_insert_function
P_ ((void (*) (const unsigned char *, int),
94 void (*) (Lisp_Object
, int, int, int,
96 int, int, Lisp_Object
*));
97 static Lisp_Object subst_char_in_region_unwind
P_ ((Lisp_Object
));
98 static Lisp_Object subst_char_in_region_unwind_1
P_ ((Lisp_Object
));
99 static void transpose_markers
P_ ((int, int, int, int, int, int, int, int));
102 extern char *index
P_ ((const char *, int));
105 Lisp_Object Vbuffer_access_fontify_functions
;
106 Lisp_Object Qbuffer_access_fontify_functions
;
107 Lisp_Object Vbuffer_access_fontified_property
;
109 Lisp_Object Fuser_full_name
P_ ((Lisp_Object
));
111 /* Non-nil means don't stop at field boundary in text motion commands. */
113 Lisp_Object Vinhibit_field_text_motion
;
115 /* Some static data, and a function to initialize it for each run */
117 Lisp_Object Vsystem_name
;
118 Lisp_Object Vuser_real_login_name
; /* login name of current user ID */
119 Lisp_Object Vuser_full_name
; /* full name of current user */
120 Lisp_Object Vuser_login_name
; /* user name from LOGNAME or USER */
121 Lisp_Object Voperating_system_release
; /* Operating System Release */
123 /* Symbol for the text property used to mark fields. */
127 /* A special value for Qfield properties. */
129 Lisp_Object Qboundary
;
136 register unsigned char *p
;
137 struct passwd
*pw
; /* password entry for the current user */
140 /* Set up system_name even when dumping. */
144 /* Don't bother with this on initial start when just dumping out */
147 #endif /* not CANNOT_DUMP */
149 pw
= (struct passwd
*) getpwuid (getuid ());
151 /* We let the real user name default to "root" because that's quite
152 accurate on MSDOG and because it lets Emacs find the init file.
153 (The DVX libraries override the Djgpp libraries here.) */
154 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "root");
156 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "unknown");
159 /* Get the effective user name, by consulting environment variables,
160 or the effective uid if those are unset. */
161 user_name
= (char *) getenv ("LOGNAME");
164 user_name
= (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
165 #else /* WINDOWSNT */
166 user_name
= (char *) getenv ("USER");
167 #endif /* WINDOWSNT */
170 pw
= (struct passwd
*) getpwuid (geteuid ());
171 user_name
= (char *) (pw
? pw
->pw_name
: "unknown");
173 Vuser_login_name
= build_string (user_name
);
175 /* If the user name claimed in the environment vars differs from
176 the real uid, use the claimed name to find the full name. */
177 tem
= Fstring_equal (Vuser_login_name
, Vuser_real_login_name
);
178 Vuser_full_name
= Fuser_full_name (NILP (tem
)? make_number (geteuid())
181 p
= (unsigned char *) getenv ("NAME");
183 Vuser_full_name
= build_string (p
);
184 else if (NILP (Vuser_full_name
))
185 Vuser_full_name
= build_string ("unknown");
187 #ifdef HAVE_SYS_UTSNAME_H
191 Voperating_system_release
= build_string (uts
.release
);
194 Voperating_system_release
= Qnil
;
198 DEFUN ("char-to-string", Fchar_to_string
, Schar_to_string
, 1, 1, 0,
199 doc
: /* Convert arg CHAR to a string containing that character.
200 usage: (char-to-string CHAR) */)
202 Lisp_Object character
;
205 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
207 CHECK_NUMBER (character
);
209 len
= (SINGLE_BYTE_CHAR_P (XFASTINT (character
))
210 ? (*str
= (unsigned char)(XFASTINT (character
)), 1)
211 : char_to_string (XFASTINT (character
), str
));
212 return make_string_from_bytes (str
, 1, len
);
215 DEFUN ("string-to-char", Fstring_to_char
, Sstring_to_char
, 1, 1, 0,
216 doc
: /* Convert arg STRING to a character, the first character of that string.
217 A multibyte character is handled correctly. */)
219 register Lisp_Object string
;
221 register Lisp_Object val
;
222 CHECK_STRING (string
);
225 if (STRING_MULTIBYTE (string
))
226 XSETFASTINT (val
, STRING_CHAR (SDATA (string
), SBYTES (string
)));
228 XSETFASTINT (val
, SREF (string
, 0));
231 XSETFASTINT (val
, 0);
236 buildmark (charpos
, bytepos
)
237 int charpos
, bytepos
;
239 register Lisp_Object mark
;
240 mark
= Fmake_marker ();
241 set_marker_both (mark
, Qnil
, charpos
, bytepos
);
245 DEFUN ("point", Fpoint
, Spoint
, 0, 0, 0,
246 doc
: /* Return value of point, as an integer.
247 Beginning of buffer is position (point-min). */)
251 XSETFASTINT (temp
, PT
);
255 DEFUN ("point-marker", Fpoint_marker
, Spoint_marker
, 0, 0, 0,
256 doc
: /* Return value of point, as a marker object. */)
259 return buildmark (PT
, PT_BYTE
);
263 clip_to_bounds (lower
, num
, upper
)
264 int lower
, num
, upper
;
268 else if (num
> upper
)
274 DEFUN ("goto-char", Fgoto_char
, Sgoto_char
, 1, 1, "NGoto char: ",
275 doc
: /* Set point to POSITION, a number or marker.
276 Beginning of buffer is position (point-min), end is (point-max). */)
278 register Lisp_Object position
;
282 if (MARKERP (position
)
283 && current_buffer
== XMARKER (position
)->buffer
)
285 pos
= marker_position (position
);
287 SET_PT_BOTH (BEGV
, BEGV_BYTE
);
289 SET_PT_BOTH (ZV
, ZV_BYTE
);
291 SET_PT_BOTH (pos
, marker_byte_position (position
));
296 CHECK_NUMBER_COERCE_MARKER (position
);
298 pos
= clip_to_bounds (BEGV
, XINT (position
), ZV
);
304 /* Return the start or end position of the region.
305 BEGINNINGP non-zero means return the start.
306 If there is no region active, signal an error. */
309 region_limit (beginningp
)
312 extern Lisp_Object Vmark_even_if_inactive
; /* Defined in callint.c. */
315 if (!NILP (Vtransient_mark_mode
)
316 && NILP (Vmark_even_if_inactive
)
317 && NILP (current_buffer
->mark_active
))
318 Fsignal (Qmark_inactive
, Qnil
);
320 m
= Fmarker_position (current_buffer
->mark
);
322 error ("The mark is not set now, so there is no region");
324 if ((PT
< XFASTINT (m
)) == (beginningp
!= 0))
325 m
= make_number (PT
);
329 DEFUN ("region-beginning", Fregion_beginning
, Sregion_beginning
, 0, 0, 0,
330 doc
: /* Return position of beginning of region, as an integer. */)
333 return region_limit (1);
336 DEFUN ("region-end", Fregion_end
, Sregion_end
, 0, 0, 0,
337 doc
: /* Return position of end of region, as an integer. */)
340 return region_limit (0);
343 DEFUN ("mark-marker", Fmark_marker
, Smark_marker
, 0, 0, 0,
344 doc
: /* Return this buffer's mark, as a marker object.
345 Watch out! Moving this marker changes the mark position.
346 If you set the marker not to point anywhere, the buffer will have no mark. */)
349 return current_buffer
->mark
;
353 /* Find all the overlays in the current buffer that touch position POS.
354 Return the number found, and store them in a vector in VEC
358 overlays_around (pos
, vec
, len
)
363 Lisp_Object overlay
, start
, end
;
364 struct Lisp_Overlay
*tail
;
365 int startpos
, endpos
;
368 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
370 XSETMISC (overlay
, tail
);
372 end
= OVERLAY_END (overlay
);
373 endpos
= OVERLAY_POSITION (end
);
376 start
= OVERLAY_START (overlay
);
377 startpos
= OVERLAY_POSITION (start
);
382 /* Keep counting overlays even if we can't return them all. */
387 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
389 XSETMISC (overlay
, tail
);
391 start
= OVERLAY_START (overlay
);
392 startpos
= OVERLAY_POSITION (start
);
395 end
= OVERLAY_END (overlay
);
396 endpos
= OVERLAY_POSITION (end
);
408 /* Return the value of property PROP, in OBJECT at POSITION.
409 It's the value of PROP that a char inserted at POSITION would get.
410 OBJECT is optional and defaults to the current buffer.
411 If OBJECT is a buffer, then overlay properties are considered as well as
413 If OBJECT is a window, then that window's buffer is used, but
414 window-specific overlays are considered only if they are associated
417 get_pos_property (position
, prop
, object
)
418 Lisp_Object position
, object
;
419 register Lisp_Object prop
;
421 CHECK_NUMBER_COERCE_MARKER (position
);
424 XSETBUFFER (object
, current_buffer
);
425 else if (WINDOWP (object
))
426 object
= XWINDOW (object
)->buffer
;
428 if (!BUFFERP (object
))
429 /* pos-property only makes sense in buffers right now, since strings
430 have no overlays and no notion of insertion for which stickiness
432 return Fget_text_property (position
, prop
, object
);
435 int posn
= XINT (position
);
437 Lisp_Object
*overlay_vec
, tem
;
438 struct buffer
*obuf
= current_buffer
;
440 set_buffer_temp (XBUFFER (object
));
442 /* First try with room for 40 overlays. */
444 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
445 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
447 /* If there are more than 40,
448 make enough space for all, and try again. */
451 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
452 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
454 noverlays
= sort_overlays (overlay_vec
, noverlays
, NULL
);
456 set_buffer_temp (obuf
);
458 /* Now check the overlays in order of decreasing priority. */
459 while (--noverlays
>= 0)
461 Lisp_Object ol
= overlay_vec
[noverlays
];
462 tem
= Foverlay_get (ol
, prop
);
465 /* Check the overlay is indeed active at point. */
466 Lisp_Object start
= OVERLAY_START (ol
), finish
= OVERLAY_END (ol
);
467 if ((OVERLAY_POSITION (start
) == posn
468 && XMARKER (start
)->insertion_type
== 1)
469 || (OVERLAY_POSITION (finish
) == posn
470 && XMARKER (finish
)->insertion_type
== 0))
471 ; /* The overlay will not cover a char inserted at point. */
479 { /* Now check the text-properties. */
480 int stickiness
= text_property_stickiness (prop
, position
, object
);
482 return Fget_text_property (position
, prop
, object
);
483 else if (stickiness
< 0
484 && XINT (position
) > BUF_BEGV (XBUFFER (object
)))
485 return Fget_text_property (make_number (XINT (position
) - 1),
493 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
494 the value of point is used instead. If BEG or END is null,
495 means don't store the beginning or end of the field.
497 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
498 results; they do not effect boundary behavior.
500 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very last
501 position of a field, then the end of the next field is returned
502 instead of the end of POS's field (since the end of a field is
503 actually also the beginning of the next input field, this behavior
504 is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
505 true case, if two fields are separated by a field with the special
506 value `boundary', and POS lies within it, then the two separated
507 fields are considered to be adjacent, and POS between them, when
508 finding the beginning and ending of the "merged" field. */
511 find_field (pos
, merge_at_boundary
, beg_limit
, beg
, end_limit
, end
)
513 Lisp_Object merge_at_boundary
;
514 Lisp_Object beg_limit
, end_limit
;
517 /* Fields right before and after the point. */
518 Lisp_Object before_field
, after_field
;
519 /* 1 if POS counts as the start of a field. */
520 int at_field_start
= 0;
521 /* 1 if POS counts as the end of a field. */
522 int at_field_end
= 0;
525 XSETFASTINT (pos
, PT
);
527 CHECK_NUMBER_COERCE_MARKER (pos
);
530 = get_char_property_and_overlay (pos
, Qfield
, Qnil
, NULL
);
532 = (XFASTINT (pos
) > BEGV
533 ? get_char_property_and_overlay (make_number (XINT (pos
) - 1),
535 /* Using nil here would be a more obvious choice, but it would
536 fail when the buffer starts with a non-sticky field. */
539 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
540 and POS is at beginning of a field, which can also be interpreted
541 as the end of the previous field. Note that the case where if
542 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
543 more natural one; then we avoid treating the beginning of a field
545 if (NILP (merge_at_boundary
))
547 Lisp_Object field
= get_pos_property (pos
, Qfield
, Qnil
);
548 if (!EQ (field
, after_field
))
550 if (!EQ (field
, before_field
))
552 if (NILP (field
) && at_field_start
&& at_field_end
)
553 /* If an inserted char would have a nil field while the surrounding
554 text is non-nil, we're probably not looking at a
555 zero-length field, but instead at a non-nil field that's
556 not intended for editing (such as comint's prompts). */
557 at_field_end
= at_field_start
= 0;
560 /* Note about special `boundary' fields:
562 Consider the case where the point (`.') is between the fields `x' and `y':
566 In this situation, if merge_at_boundary is true, we consider the
567 `x' and `y' fields as forming one big merged field, and so the end
568 of the field is the end of `y'.
570 However, if `x' and `y' are separated by a special `boundary' field
571 (a field with a `field' char-property of 'boundary), then we ignore
572 this special field when merging adjacent fields. Here's the same
573 situation, but with a `boundary' field between the `x' and `y' fields:
577 Here, if point is at the end of `x', the beginning of `y', or
578 anywhere in-between (within the `boundary' field), we merge all
579 three fields and consider the beginning as being the beginning of
580 the `x' field, and the end as being the end of the `y' field. */
585 /* POS is at the edge of a field, and we should consider it as
586 the beginning of the following field. */
587 *beg
= XFASTINT (pos
);
589 /* Find the previous field boundary. */
592 if (!NILP (merge_at_boundary
) && EQ (before_field
, Qboundary
))
593 /* Skip a `boundary' field. */
594 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
597 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
599 *beg
= NILP (p
) ? BEGV
: XFASTINT (p
);
606 /* POS is at the edge of a field, and we should consider it as
607 the end of the previous field. */
608 *end
= XFASTINT (pos
);
610 /* Find the next field boundary. */
612 if (!NILP (merge_at_boundary
) && EQ (after_field
, Qboundary
))
613 /* Skip a `boundary' field. */
614 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
617 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
619 *end
= NILP (pos
) ? ZV
: XFASTINT (pos
);
625 DEFUN ("delete-field", Fdelete_field
, Sdelete_field
, 0, 1, 0,
626 doc
: /* Delete the field surrounding POS.
627 A field is a region of text with the same `field' property.
628 If POS is nil, the value of point is used for POS. */)
633 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
635 del_range (beg
, end
);
639 DEFUN ("field-string", Ffield_string
, Sfield_string
, 0, 1, 0,
640 doc
: /* Return the contents of the field surrounding POS as a string.
641 A field is a region of text with the same `field' property.
642 If POS is nil, the value of point is used for POS. */)
647 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
648 return make_buffer_string (beg
, end
, 1);
651 DEFUN ("field-string-no-properties", Ffield_string_no_properties
, Sfield_string_no_properties
, 0, 1, 0,
652 doc
: /* Return the contents of the field around POS, without text-properties.
653 A field is a region of text with the same `field' property.
654 If POS is nil, the value of point is used for POS. */)
659 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
660 return make_buffer_string (beg
, end
, 0);
663 DEFUN ("field-beginning", Ffield_beginning
, Sfield_beginning
, 0, 3, 0,
664 doc
: /* Return the beginning of the field surrounding POS.
665 A field is a region of text with the same `field' property.
666 If POS is nil, the value of point is used for POS.
667 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
668 field, then the beginning of the *previous* field is returned.
669 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
670 is before LIMIT, then LIMIT will be returned instead. */)
671 (pos
, escape_from_edge
, limit
)
672 Lisp_Object pos
, escape_from_edge
, limit
;
675 find_field (pos
, escape_from_edge
, limit
, &beg
, Qnil
, &end
);
676 /* When pos is at a field boundary and escape_from_edge (merge_at_boundary)
677 is nil, find_field returns the *previous* field. In this case we return
678 end instead of beg. */
679 return make_number (NILP (escape_from_edge
)
680 && XFASTINT (pos
) == end
681 && end
!= ZV
? end
: beg
);
684 DEFUN ("field-end", Ffield_end
, Sfield_end
, 0, 3, 0,
685 doc
: /* Return the end of the field surrounding POS.
686 A field is a region of text with the same `field' property.
687 If POS is nil, the value of point is used for POS.
688 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
689 then the end of the *following* field is returned.
690 If LIMIT is non-nil, it is a buffer position; if the end of the field
691 is after LIMIT, then LIMIT will be returned instead. */)
692 (pos
, escape_from_edge
, limit
)
693 Lisp_Object pos
, escape_from_edge
, limit
;
696 find_field (pos
, escape_from_edge
, Qnil
, 0, limit
, &end
);
697 return make_number (end
);
700 DEFUN ("constrain-to-field", Fconstrain_to_field
, Sconstrain_to_field
, 2, 5, 0,
701 doc
: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
703 A field is a region of text with the same `field' property.
704 If NEW-POS is nil, then the current point is used instead, and set to the
705 constrained position if that is different.
707 If OLD-POS is at the boundary of two fields, then the allowable
708 positions for NEW-POS depends on the value of the optional argument
709 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
710 constrained to the field that has the same `field' char-property
711 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
712 is non-nil, NEW-POS is constrained to the union of the two adjacent
713 fields. Additionally, if two fields are separated by another field with
714 the special value `boundary', then any point within this special field is
715 also considered to be `on the boundary'.
717 If the optional argument ONLY-IN-LINE is non-nil and constraining
718 NEW-POS would move it to a different line, NEW-POS is returned
719 unconstrained. This useful for commands that move by line, like
720 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
721 only in the case where they can still move to the right line.
723 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
724 a non-nil property of that name, then any field boundaries are ignored.
726 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
727 (new_pos
, old_pos
, escape_from_edge
, only_in_line
, inhibit_capture_property
)
728 Lisp_Object new_pos
, old_pos
;
729 Lisp_Object escape_from_edge
, only_in_line
, inhibit_capture_property
;
731 /* If non-zero, then the original point, before re-positioning. */
734 Lisp_Object prev_old
, prev_new
;
737 /* Use the current point, and afterwards, set it. */
740 XSETFASTINT (new_pos
, PT
);
743 CHECK_NUMBER_COERCE_MARKER (new_pos
);
744 CHECK_NUMBER_COERCE_MARKER (old_pos
);
746 fwd
= (XFASTINT (new_pos
) > XFASTINT (old_pos
));
748 prev_old
= make_number (XFASTINT (old_pos
) - 1);
749 prev_new
= make_number (XFASTINT (new_pos
) - 1);
751 if (NILP (Vinhibit_field_text_motion
)
752 && !EQ (new_pos
, old_pos
)
753 && (!NILP (Fget_char_property (new_pos
, Qfield
, Qnil
))
754 || !NILP (Fget_char_property (old_pos
, Qfield
, Qnil
))
755 /* To recognize field boundaries, we must also look at the
756 previous positions; we could use `get_pos_property'
757 instead, but in itself that would fail inside non-sticky
758 fields (like comint prompts). */
759 || (XFASTINT (new_pos
) > BEGV
760 && !NILP (Fget_char_property (prev_new
, Qfield
, Qnil
)))
761 || (XFASTINT (old_pos
) > BEGV
762 && !NILP (Fget_char_property (prev_old
, Qfield
, Qnil
))))
763 && (NILP (inhibit_capture_property
)
764 /* Field boundaries are again a problem; but now we must
765 decide the case exactly, so we need to call
766 `get_pos_property' as well. */
767 || (NILP (get_pos_property (old_pos
, inhibit_capture_property
, Qnil
))
768 && (XFASTINT (old_pos
) <= BEGV
769 || NILP (Fget_char_property (old_pos
, inhibit_capture_property
, Qnil
))
770 || NILP (Fget_char_property (prev_old
, inhibit_capture_property
, Qnil
))))))
771 /* It is possible that NEW_POS is not within the same field as
772 OLD_POS; try to move NEW_POS so that it is. */
775 Lisp_Object field_bound
;
778 field_bound
= Ffield_end (old_pos
, escape_from_edge
, new_pos
);
780 field_bound
= Ffield_beginning (old_pos
, escape_from_edge
, new_pos
);
782 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
783 other side of NEW_POS, which would mean that NEW_POS is
784 already acceptable, and it's not necessary to constrain it
786 ((XFASTINT (field_bound
) < XFASTINT (new_pos
)) ? fwd
: !fwd
)
787 /* NEW_POS should be constrained, but only if either
788 ONLY_IN_LINE is nil (in which case any constraint is OK),
789 or NEW_POS and FIELD_BOUND are on the same line (in which
790 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
791 && (NILP (only_in_line
)
792 /* This is the ONLY_IN_LINE case, check that NEW_POS and
793 FIELD_BOUND are on the same line by seeing whether
794 there's an intervening newline or not. */
795 || (scan_buffer ('\n',
796 XFASTINT (new_pos
), XFASTINT (field_bound
),
797 fwd
? -1 : 1, &shortage
, 1),
799 /* Constrain NEW_POS to FIELD_BOUND. */
800 new_pos
= field_bound
;
802 if (orig_point
&& XFASTINT (new_pos
) != orig_point
)
803 /* The NEW_POS argument was originally nil, so automatically set PT. */
804 SET_PT (XFASTINT (new_pos
));
811 DEFUN ("line-beginning-position",
812 Fline_beginning_position
, Sline_beginning_position
, 0, 1, 0,
813 doc
: /* Return the character position of the first character on the current line.
814 With argument N not nil or 1, move forward N - 1 lines first.
815 If scan reaches end of buffer, return that position.
817 This function constrains the returned position to the current field
818 unless that would be on a different line than the original,
819 unconstrained result. If N is nil or 1, and a front-sticky field
820 starts at point, the scan stops as soon as it starts. To ignore field
821 boundaries bind `inhibit-field-text-motion' to t.
823 This function does not move point. */)
827 int orig
, orig_byte
, end
;
836 Fforward_line (make_number (XINT (n
) - 1));
839 SET_PT_BOTH (orig
, orig_byte
);
841 /* Return END constrained to the current input field. */
842 return Fconstrain_to_field (make_number (end
), make_number (orig
),
843 XINT (n
) != 1 ? Qt
: Qnil
,
847 DEFUN ("line-end-position", Fline_end_position
, Sline_end_position
, 0, 1, 0,
848 doc
: /* Return the character position of the last character on the current line.
849 With argument N not nil or 1, move forward N - 1 lines first.
850 If scan reaches end of buffer, return that position.
852 This function constrains the returned position to the current field
853 unless that would be on a different line than the original,
854 unconstrained result. If N is nil or 1, and a rear-sticky field ends
855 at point, the scan stops as soon as it starts. To ignore field
856 boundaries bind `inhibit-field-text-motion' to t.
858 This function does not move point. */)
870 end_pos
= find_before_next_newline (orig
, 0, XINT (n
) - (XINT (n
) <= 0));
872 /* Return END_POS constrained to the current input field. */
873 return Fconstrain_to_field (make_number (end_pos
), make_number (orig
),
879 save_excursion_save ()
881 int visible
= (XBUFFER (XWINDOW (selected_window
)->buffer
)
884 return Fcons (Fpoint_marker (),
885 Fcons (Fcopy_marker (current_buffer
->mark
, Qnil
),
886 Fcons (visible
? Qt
: Qnil
,
887 Fcons (current_buffer
->mark_active
,
892 save_excursion_restore (info
)
895 Lisp_Object tem
, tem1
, omark
, nmark
;
896 struct gcpro gcpro1
, gcpro2
, gcpro3
;
899 tem
= Fmarker_buffer (XCAR (info
));
900 /* If buffer being returned to is now deleted, avoid error */
901 /* Otherwise could get error here while unwinding to top level
903 /* In that case, Fmarker_buffer returns nil now. */
907 omark
= nmark
= Qnil
;
908 GCPRO3 (info
, omark
, nmark
);
915 unchain_marker (XMARKER (tem
));
920 omark
= Fmarker_position (current_buffer
->mark
);
921 Fset_marker (current_buffer
->mark
, tem
, Fcurrent_buffer ());
922 nmark
= Fmarker_position (tem
);
923 unchain_marker (XMARKER (tem
));
927 visible_p
= !NILP (XCAR (info
));
929 #if 0 /* We used to make the current buffer visible in the selected window
930 if that was true previously. That avoids some anomalies.
931 But it creates others, and it wasn't documented, and it is simpler
932 and cleaner never to alter the window/buffer connections. */
935 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
936 Fswitch_to_buffer (Fcurrent_buffer (), Qnil
);
942 tem1
= current_buffer
->mark_active
;
943 current_buffer
->mark_active
= tem
;
945 if (!NILP (Vrun_hooks
))
947 /* If mark is active now, and either was not active
948 or was at a different place, run the activate hook. */
949 if (! NILP (current_buffer
->mark_active
))
951 if (! EQ (omark
, nmark
))
952 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
954 /* If mark has ceased to be active, run deactivate hook. */
955 else if (! NILP (tem1
))
956 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
959 /* If buffer was visible in a window, and a different window was
960 selected, and the old selected window is still showing this
961 buffer, restore point in that window. */
964 && !EQ (tem
, selected_window
)
965 && (tem1
= XWINDOW (tem
)->buffer
,
966 (/* Window is live... */
968 /* ...and it shows the current buffer. */
969 && XBUFFER (tem1
) == current_buffer
)))
970 Fset_window_point (tem
, make_number (PT
));
976 DEFUN ("save-excursion", Fsave_excursion
, Ssave_excursion
, 0, UNEVALLED
, 0,
977 doc
: /* Save point, mark, and current buffer; execute BODY; restore those things.
978 Executes BODY just like `progn'.
979 The values of point, mark and the current buffer are restored
980 even in case of abnormal exit (throw or error).
981 The state of activation of the mark is also restored.
983 This construct does not save `deactivate-mark', and therefore
984 functions that change the buffer will still cause deactivation
985 of the mark at the end of the command. To prevent that, bind
986 `deactivate-mark' with `let'.
988 usage: (save-excursion &rest BODY) */)
992 register Lisp_Object val
;
993 int count
= SPECPDL_INDEX ();
995 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
998 return unbind_to (count
, val
);
1001 DEFUN ("save-current-buffer", Fsave_current_buffer
, Ssave_current_buffer
, 0, UNEVALLED
, 0,
1002 doc
: /* Save the current buffer; execute BODY; restore the current buffer.
1003 Executes BODY just like `progn'.
1004 usage: (save-current-buffer &rest BODY) */)
1009 int count
= SPECPDL_INDEX ();
1011 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
1013 val
= Fprogn (args
);
1014 return unbind_to (count
, val
);
1017 DEFUN ("buffer-size", Fbufsize
, Sbufsize
, 0, 1, 0,
1018 doc
: /* Return the number of characters in the current buffer.
1019 If BUFFER, return the number of characters in that buffer instead. */)
1024 return make_number (Z
- BEG
);
1027 CHECK_BUFFER (buffer
);
1028 return make_number (BUF_Z (XBUFFER (buffer
))
1029 - BUF_BEG (XBUFFER (buffer
)));
1033 DEFUN ("point-min", Fpoint_min
, Spoint_min
, 0, 0, 0,
1034 doc
: /* Return the minimum permissible value of point in the current buffer.
1035 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1039 XSETFASTINT (temp
, BEGV
);
1043 DEFUN ("point-min-marker", Fpoint_min_marker
, Spoint_min_marker
, 0, 0, 0,
1044 doc
: /* Return a marker to the minimum permissible value of point in this buffer.
1045 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1048 return buildmark (BEGV
, BEGV_BYTE
);
1051 DEFUN ("point-max", Fpoint_max
, Spoint_max
, 0, 0, 0,
1052 doc
: /* Return the maximum permissible value of point in the current buffer.
1053 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1054 is in effect, in which case it is less. */)
1058 XSETFASTINT (temp
, ZV
);
1062 DEFUN ("point-max-marker", Fpoint_max_marker
, Spoint_max_marker
, 0, 0, 0,
1063 doc
: /* Return a marker to the maximum permissible value of point in this buffer.
1064 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1065 is in effect, in which case it is less. */)
1068 return buildmark (ZV
, ZV_BYTE
);
1071 DEFUN ("gap-position", Fgap_position
, Sgap_position
, 0, 0, 0,
1072 doc
: /* Return the position of the gap, in the current buffer.
1073 See also `gap-size'. */)
1077 XSETFASTINT (temp
, GPT
);
1081 DEFUN ("gap-size", Fgap_size
, Sgap_size
, 0, 0, 0,
1082 doc
: /* Return the size of the current buffer's gap.
1083 See also `gap-position'. */)
1087 XSETFASTINT (temp
, GAP_SIZE
);
1091 DEFUN ("position-bytes", Fposition_bytes
, Sposition_bytes
, 1, 1, 0,
1092 doc
: /* Return the byte position for character position POSITION.
1093 If POSITION is out of range, the value is nil. */)
1095 Lisp_Object position
;
1097 CHECK_NUMBER_COERCE_MARKER (position
);
1098 if (XINT (position
) < BEG
|| XINT (position
) > Z
)
1100 return make_number (CHAR_TO_BYTE (XINT (position
)));
1103 DEFUN ("byte-to-position", Fbyte_to_position
, Sbyte_to_position
, 1, 1, 0,
1104 doc
: /* Return the character position for byte position BYTEPOS.
1105 If BYTEPOS is out of range, the value is nil. */)
1107 Lisp_Object bytepos
;
1109 CHECK_NUMBER (bytepos
);
1110 if (XINT (bytepos
) < BEG_BYTE
|| XINT (bytepos
) > Z_BYTE
)
1112 return make_number (BYTE_TO_CHAR (XINT (bytepos
)));
1115 DEFUN ("following-char", Ffollowing_char
, Sfollowing_char
, 0, 0, 0,
1116 doc
: /* Return the character following point, as a number.
1117 At the end of the buffer or accessible region, return 0. */)
1122 XSETFASTINT (temp
, 0);
1124 XSETFASTINT (temp
, FETCH_CHAR (PT_BYTE
));
1128 DEFUN ("preceding-char", Fprevious_char
, Sprevious_char
, 0, 0, 0,
1129 doc
: /* Return the character preceding point, as a number.
1130 At the beginning of the buffer or accessible region, return 0. */)
1135 XSETFASTINT (temp
, 0);
1136 else if (!NILP (current_buffer
->enable_multibyte_characters
))
1140 XSETFASTINT (temp
, FETCH_CHAR (pos
));
1143 XSETFASTINT (temp
, FETCH_BYTE (PT_BYTE
- 1));
1147 DEFUN ("bobp", Fbobp
, Sbobp
, 0, 0, 0,
1148 doc
: /* Return t if point is at the beginning of the buffer.
1149 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1157 DEFUN ("eobp", Feobp
, Seobp
, 0, 0, 0,
1158 doc
: /* Return t if point is at the end of the buffer.
1159 If the buffer is narrowed, this means the end of the narrowed part. */)
1167 DEFUN ("bolp", Fbolp
, Sbolp
, 0, 0, 0,
1168 doc
: /* Return t if point is at the beginning of a line. */)
1171 if (PT
== BEGV
|| FETCH_BYTE (PT_BYTE
- 1) == '\n')
1176 DEFUN ("eolp", Feolp
, Seolp
, 0, 0, 0,
1177 doc
: /* Return t if point is at the end of a line.
1178 `End of a line' includes point being at the end of the buffer. */)
1181 if (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n')
1186 DEFUN ("char-after", Fchar_after
, Schar_after
, 0, 1, 0,
1187 doc
: /* Return character in current buffer at position POS.
1188 POS is an integer or a marker and defaults to point.
1189 If POS is out of range, the value is nil. */)
1193 register int pos_byte
;
1198 XSETFASTINT (pos
, PT
);
1203 pos_byte
= marker_byte_position (pos
);
1204 if (pos_byte
< BEGV_BYTE
|| pos_byte
>= ZV_BYTE
)
1209 CHECK_NUMBER_COERCE_MARKER (pos
);
1210 if (XINT (pos
) < BEGV
|| XINT (pos
) >= ZV
)
1213 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1216 return make_number (FETCH_CHAR (pos_byte
));
1219 DEFUN ("char-before", Fchar_before
, Schar_before
, 0, 1, 0,
1220 doc
: /* Return character in current buffer preceding position POS.
1221 POS is an integer or a marker and defaults to point.
1222 If POS is out of range, the value is nil. */)
1226 register Lisp_Object val
;
1227 register int pos_byte
;
1232 XSETFASTINT (pos
, PT
);
1237 pos_byte
= marker_byte_position (pos
);
1239 if (pos_byte
<= BEGV_BYTE
|| pos_byte
> ZV_BYTE
)
1244 CHECK_NUMBER_COERCE_MARKER (pos
);
1246 if (XINT (pos
) <= BEGV
|| XINT (pos
) > ZV
)
1249 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1252 if (!NILP (current_buffer
->enable_multibyte_characters
))
1255 XSETFASTINT (val
, FETCH_CHAR (pos_byte
));
1260 XSETFASTINT (val
, FETCH_BYTE (pos_byte
));
1265 DEFUN ("user-login-name", Fuser_login_name
, Suser_login_name
, 0, 1, 0,
1266 doc
: /* Return the name under which the user logged in, as a string.
1267 This is based on the effective uid, not the real uid.
1268 Also, if the environment variables LOGNAME or USER are set,
1269 that determines the value of this function.
1271 If optional argument UID is an integer, return the login name of the user
1272 with that uid, or nil if there is no such user. */)
1278 /* Set up the user name info if we didn't do it before.
1279 (That can happen if Emacs is dumpable
1280 but you decide to run `temacs -l loadup' and not dump. */
1281 if (INTEGERP (Vuser_login_name
))
1285 return Vuser_login_name
;
1288 pw
= (struct passwd
*) getpwuid (XINT (uid
));
1289 return (pw
? build_string (pw
->pw_name
) : Qnil
);
1292 DEFUN ("user-real-login-name", Fuser_real_login_name
, Suser_real_login_name
,
1294 doc
: /* Return the name of the user's real uid, as a string.
1295 This ignores the environment variables LOGNAME and USER, so it differs from
1296 `user-login-name' when running under `su'. */)
1299 /* Set up the user name info if we didn't do it before.
1300 (That can happen if Emacs is dumpable
1301 but you decide to run `temacs -l loadup' and not dump. */
1302 if (INTEGERP (Vuser_login_name
))
1304 return Vuser_real_login_name
;
1307 DEFUN ("user-uid", Fuser_uid
, Suser_uid
, 0, 0, 0,
1308 doc
: /* Return the effective uid of Emacs.
1309 Value is an integer or float, depending on the value. */)
1312 return make_fixnum_or_float (geteuid ());
1315 DEFUN ("user-real-uid", Fuser_real_uid
, Suser_real_uid
, 0, 0, 0,
1316 doc
: /* Return the real uid of Emacs.
1317 Value is an integer or float, depending on the value. */)
1320 return make_fixnum_or_float (getuid ());
1323 DEFUN ("user-full-name", Fuser_full_name
, Suser_full_name
, 0, 1, 0,
1324 doc
: /* Return the full name of the user logged in, as a string.
1325 If the full name corresponding to Emacs's userid is not known,
1328 If optional argument UID is an integer or float, return the full name
1329 of the user with that uid, or nil if there is no such user.
1330 If UID is a string, return the full name of the user with that login
1331 name, or nil if there is no such user. */)
1336 register unsigned char *p
, *q
;
1340 return Vuser_full_name
;
1341 else if (NUMBERP (uid
))
1342 pw
= (struct passwd
*) getpwuid ((uid_t
) XFLOATINT (uid
));
1343 else if (STRINGP (uid
))
1344 pw
= (struct passwd
*) getpwnam (SDATA (uid
));
1346 error ("Invalid UID specification");
1351 p
= (unsigned char *) USER_FULL_NAME
;
1352 /* Chop off everything after the first comma. */
1353 q
= (unsigned char *) index (p
, ',');
1354 full
= make_string (p
, q
? q
- p
: strlen (p
));
1356 #ifdef AMPERSAND_FULL_NAME
1358 q
= (unsigned char *) index (p
, '&');
1359 /* Substitute the login name for the &, upcasing the first character. */
1362 register unsigned char *r
;
1365 login
= Fuser_login_name (make_number (pw
->pw_uid
));
1366 r
= (unsigned char *) alloca (strlen (p
) + SCHARS (login
) + 1);
1367 bcopy (p
, r
, q
- p
);
1369 strcat (r
, SDATA (login
));
1370 r
[q
- p
] = UPCASE (r
[q
- p
]);
1372 full
= build_string (r
);
1374 #endif /* AMPERSAND_FULL_NAME */
1379 DEFUN ("system-name", Fsystem_name
, Ssystem_name
, 0, 0, 0,
1380 doc
: /* Return the name of the machine you are running on, as a string. */)
1383 return Vsystem_name
;
1386 /* For the benefit of callers who don't want to include lisp.h */
1391 if (STRINGP (Vsystem_name
))
1392 return (char *) SDATA (Vsystem_name
);
1398 get_operating_system_release()
1400 if (STRINGP (Voperating_system_release
))
1401 return (char *) SDATA (Voperating_system_release
);
1406 DEFUN ("emacs-pid", Femacs_pid
, Semacs_pid
, 0, 0, 0,
1407 doc
: /* Return the process ID of Emacs, as an integer. */)
1410 return make_number (getpid ());
1413 DEFUN ("current-time", Fcurrent_time
, Scurrent_time
, 0, 0, 0,
1414 doc
: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1415 The time is returned as a list of three integers. The first has the
1416 most significant 16 bits of the seconds, while the second has the
1417 least significant 16 bits. The third integer gives the microsecond
1420 The microsecond count is zero on systems that do not provide
1421 resolution finer than a second. */)
1425 Lisp_Object result
[3];
1428 XSETINT (result
[0], (EMACS_SECS (t
) >> 16) & 0xffff);
1429 XSETINT (result
[1], (EMACS_SECS (t
) >> 0) & 0xffff);
1430 XSETINT (result
[2], EMACS_USECS (t
));
1432 return Flist (3, result
);
1435 DEFUN ("get-internal-run-time", Fget_internal_run_time
, Sget_internal_run_time
,
1437 doc
: /* Return the current run time used by Emacs.
1438 The time is returned as a list of three integers. The first has the
1439 most significant 16 bits of the seconds, while the second has the
1440 least significant 16 bits. The third integer gives the microsecond
1443 On systems that can't determine the run time, get-internal-run-time
1444 does the same thing as current-time. The microsecond count is zero on
1445 systems that do not provide resolution finer than a second. */)
1448 #ifdef HAVE_GETRUSAGE
1449 struct rusage usage
;
1450 Lisp_Object result
[3];
1453 if (getrusage (RUSAGE_SELF
, &usage
) < 0)
1454 /* This shouldn't happen. What action is appropriate? */
1455 Fsignal (Qerror
, Qnil
);
1457 /* Sum up user time and system time. */
1458 secs
= usage
.ru_utime
.tv_sec
+ usage
.ru_stime
.tv_sec
;
1459 usecs
= usage
.ru_utime
.tv_usec
+ usage
.ru_stime
.tv_usec
;
1460 if (usecs
>= 1000000)
1466 XSETINT (result
[0], (secs
>> 16) & 0xffff);
1467 XSETINT (result
[1], (secs
>> 0) & 0xffff);
1468 XSETINT (result
[2], usecs
);
1470 return Flist (3, result
);
1472 return Fcurrent_time ();
1478 lisp_time_argument (specified_time
, result
, usec
)
1479 Lisp_Object specified_time
;
1483 if (NILP (specified_time
))
1490 *usec
= EMACS_USECS (t
);
1491 *result
= EMACS_SECS (t
);
1495 return time (result
) != -1;
1499 Lisp_Object high
, low
;
1500 high
= Fcar (specified_time
);
1501 CHECK_NUMBER (high
);
1502 low
= Fcdr (specified_time
);
1507 Lisp_Object usec_l
= Fcdr (low
);
1509 usec_l
= Fcar (usec_l
);
1514 CHECK_NUMBER (usec_l
);
1515 *usec
= XINT (usec_l
);
1523 *result
= (XINT (high
) << 16) + (XINT (low
) & 0xffff);
1524 return *result
>> 16 == XINT (high
);
1528 DEFUN ("float-time", Ffloat_time
, Sfloat_time
, 0, 1, 0,
1529 doc
: /* Return the current time, as a float number of seconds since the epoch.
1530 If SPECIFIED-TIME is given, it is the time to convert to float
1531 instead of the current time. The argument should have the form
1532 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1533 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1534 have the form (HIGH . LOW), but this is considered obsolete.
1536 WARNING: Since the result is floating point, it may not be exact.
1537 Do not use this function if precise time stamps are required. */)
1539 Lisp_Object specified_time
;
1544 if (! lisp_time_argument (specified_time
, &sec
, &usec
))
1545 error ("Invalid time specification");
1547 return make_float ((sec
* 1e6
+ usec
) / 1e6
);
1550 /* Write information into buffer S of size MAXSIZE, according to the
1551 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1552 Default to Universal Time if UT is nonzero, local time otherwise.
1553 Return the number of bytes written, not including the terminating
1554 '\0'. If S is NULL, nothing will be written anywhere; so to
1555 determine how many bytes would be written, use NULL for S and
1556 ((size_t) -1) for MAXSIZE.
1558 This function behaves like emacs_strftimeu, except it allows null
1561 emacs_memftimeu (s
, maxsize
, format
, format_len
, tp
, ut
)
1566 const struct tm
*tp
;
1571 /* Loop through all the null-terminated strings in the format
1572 argument. Normally there's just one null-terminated string, but
1573 there can be arbitrarily many, concatenated together, if the
1574 format contains '\0' bytes. emacs_strftimeu stops at the first
1575 '\0' byte so we must invoke it separately for each such string. */
1584 result
= emacs_strftimeu (s
, maxsize
, format
, tp
, ut
);
1588 if (result
== 0 && s
[0] != '\0')
1593 maxsize
-= result
+ 1;
1595 len
= strlen (format
);
1596 if (len
== format_len
)
1600 format_len
-= len
+ 1;
1604 DEFUN ("format-time-string", Fformat_time_string
, Sformat_time_string
, 1, 3, 0,
1605 doc
: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1606 TIME is specified as (HIGH LOW . IGNORED), as returned by
1607 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1608 is also still accepted.
1609 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1610 as Universal Time; nil means describe TIME in the local time zone.
1611 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1612 by text that describes the specified date and time in TIME:
1614 %Y is the year, %y within the century, %C the century.
1615 %G is the year corresponding to the ISO week, %g within the century.
1616 %m is the numeric month.
1617 %b and %h are the locale's abbreviated month name, %B the full name.
1618 %d is the day of the month, zero-padded, %e is blank-padded.
1619 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1620 %a is the locale's abbreviated name of the day of week, %A the full name.
1621 %U is the week number starting on Sunday, %W starting on Monday,
1622 %V according to ISO 8601.
1623 %j is the day of the year.
1625 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1626 only blank-padded, %l is like %I blank-padded.
1627 %p is the locale's equivalent of either AM or PM.
1630 %Z is the time zone name, %z is the numeric form.
1631 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1633 %c is the locale's date and time format.
1634 %x is the locale's "preferred" date format.
1635 %D is like "%m/%d/%y".
1637 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1638 %X is the locale's "preferred" time format.
1640 Finally, %n is a newline, %t is a tab, %% is a literal %.
1642 Certain flags and modifiers are available with some format controls.
1643 The flags are `_', `-', `^' and `#'. For certain characters X,
1644 %_X is like %X, but padded with blanks; %-X is like %X,
1645 but without padding. %^X is like %X, but with all textual
1646 characters up-cased; %#X is like %X, but with letter-case of
1647 all textual characters reversed.
1648 %NX (where N stands for an integer) is like %X,
1649 but takes up at least N (a number) positions.
1650 The modifiers are `E' and `O'. For certain characters X,
1651 %EX is a locale's alternative version of %X;
1652 %OX is like %X, but uses the locale's number symbols.
1654 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1655 (format_string
, time
, universal
)
1656 Lisp_Object format_string
, time
, universal
;
1661 int ut
= ! NILP (universal
);
1663 CHECK_STRING (format_string
);
1665 if (! lisp_time_argument (time
, &value
, NULL
))
1666 error ("Invalid time specification");
1668 format_string
= code_convert_string_norecord (format_string
,
1669 Vlocale_coding_system
, 1);
1671 /* This is probably enough. */
1672 size
= SBYTES (format_string
) * 6 + 50;
1674 tm
= ut
? gmtime (&value
) : localtime (&value
);
1676 error ("Specified time is not representable");
1678 synchronize_system_time_locale ();
1682 char *buf
= (char *) alloca (size
+ 1);
1686 result
= emacs_memftimeu (buf
, size
, SDATA (format_string
),
1687 SBYTES (format_string
),
1689 if ((result
> 0 && result
< size
) || (result
== 0 && buf
[0] == '\0'))
1690 return code_convert_string_norecord (make_string (buf
, result
),
1691 Vlocale_coding_system
, 0);
1693 /* If buffer was too small, make it bigger and try again. */
1694 result
= emacs_memftimeu (NULL
, (size_t) -1,
1695 SDATA (format_string
),
1696 SBYTES (format_string
),
1702 DEFUN ("decode-time", Fdecode_time
, Sdecode_time
, 0, 1, 0,
1703 doc
: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1704 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1705 as from `current-time' and `file-attributes', or `nil' to use the
1706 current time. The obsolete form (HIGH . LOW) is also still accepted.
1707 The list has the following nine members: SEC is an integer between 0
1708 and 60; SEC is 60 for a leap second, which only some operating systems
1709 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1710 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1711 integer between 1 and 12. YEAR is an integer indicating the
1712 four-digit year. DOW is the day of week, an integer between 0 and 6,
1713 where 0 is Sunday. DST is t if daylight savings time is effect,
1714 otherwise nil. ZONE is an integer indicating the number of seconds
1715 east of Greenwich. (Note that Common Lisp has different meanings for
1718 Lisp_Object specified_time
;
1722 struct tm
*decoded_time
;
1723 Lisp_Object list_args
[9];
1725 if (! lisp_time_argument (specified_time
, &time_spec
, NULL
))
1726 error ("Invalid time specification");
1728 decoded_time
= localtime (&time_spec
);
1730 error ("Specified time is not representable");
1731 XSETFASTINT (list_args
[0], decoded_time
->tm_sec
);
1732 XSETFASTINT (list_args
[1], decoded_time
->tm_min
);
1733 XSETFASTINT (list_args
[2], decoded_time
->tm_hour
);
1734 XSETFASTINT (list_args
[3], decoded_time
->tm_mday
);
1735 XSETFASTINT (list_args
[4], decoded_time
->tm_mon
+ 1);
1736 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1737 cast below avoids overflow in int arithmetics. */
1738 XSETINT (list_args
[5], TM_YEAR_BASE
+ (EMACS_INT
) decoded_time
->tm_year
);
1739 XSETFASTINT (list_args
[6], decoded_time
->tm_wday
);
1740 list_args
[7] = (decoded_time
->tm_isdst
)? Qt
: Qnil
;
1742 /* Make a copy, in case gmtime modifies the struct. */
1743 save_tm
= *decoded_time
;
1744 decoded_time
= gmtime (&time_spec
);
1745 if (decoded_time
== 0)
1746 list_args
[8] = Qnil
;
1748 XSETINT (list_args
[8], tm_diff (&save_tm
, decoded_time
));
1749 return Flist (9, list_args
);
1752 DEFUN ("encode-time", Fencode_time
, Sencode_time
, 6, MANY
, 0,
1753 doc
: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1754 This is the reverse operation of `decode-time', which see.
1755 ZONE defaults to the current time zone rule. This can
1756 be a string or t (as from `set-time-zone-rule'), or it can be a list
1757 \(as from `current-time-zone') or an integer (as from `decode-time')
1758 applied without consideration for daylight savings time.
1760 You can pass more than 7 arguments; then the first six arguments
1761 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1762 The intervening arguments are ignored.
1763 This feature lets (apply 'encode-time (decode-time ...)) work.
1765 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1766 for example, a DAY of 0 means the day preceding the given month.
1767 Year numbers less than 100 are treated just like other year numbers.
1768 If you want them to stand for years in this century, you must do that yourself.
1770 Years before 1970 are not guaranteed to work. On some systems,
1771 year values as low as 1901 do work.
1773 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1776 register Lisp_Object
*args
;
1780 Lisp_Object zone
= (nargs
> 6 ? args
[nargs
- 1] : Qnil
);
1782 CHECK_NUMBER (args
[0]); /* second */
1783 CHECK_NUMBER (args
[1]); /* minute */
1784 CHECK_NUMBER (args
[2]); /* hour */
1785 CHECK_NUMBER (args
[3]); /* day */
1786 CHECK_NUMBER (args
[4]); /* month */
1787 CHECK_NUMBER (args
[5]); /* year */
1789 tm
.tm_sec
= XINT (args
[0]);
1790 tm
.tm_min
= XINT (args
[1]);
1791 tm
.tm_hour
= XINT (args
[2]);
1792 tm
.tm_mday
= XINT (args
[3]);
1793 tm
.tm_mon
= XINT (args
[4]) - 1;
1794 tm
.tm_year
= XINT (args
[5]) - TM_YEAR_BASE
;
1800 time
= mktime (&tm
);
1805 char **oldenv
= environ
, **newenv
;
1809 else if (STRINGP (zone
))
1810 tzstring
= (char *) SDATA (zone
);
1811 else if (INTEGERP (zone
))
1813 int abszone
= abs (XINT (zone
));
1814 sprintf (tzbuf
, "XXX%s%d:%02d:%02d", "-" + (XINT (zone
) < 0),
1815 abszone
/ (60*60), (abszone
/60) % 60, abszone
% 60);
1819 error ("Invalid time zone specification");
1821 /* Set TZ before calling mktime; merely adjusting mktime's returned
1822 value doesn't suffice, since that would mishandle leap seconds. */
1823 set_time_zone_rule (tzstring
);
1825 time
= mktime (&tm
);
1827 /* Restore TZ to previous value. */
1831 #ifdef LOCALTIME_CACHE
1836 if (time
== (time_t) -1)
1837 error ("Specified time is not representable");
1839 return make_time (time
);
1842 DEFUN ("current-time-string", Fcurrent_time_string
, Scurrent_time_string
, 0, 1, 0,
1843 doc
: /* Return the current time, as a human-readable string.
1844 Programs can use this function to decode a time,
1845 since the number of columns in each field is fixed
1846 if the year is in the range 1000-9999.
1847 The format is `Sun Sep 16 01:03:52 1973'.
1848 However, see also the functions `decode-time' and `format-time-string'
1849 which provide a much more powerful and general facility.
1851 If SPECIFIED-TIME is given, it is a time to format instead of the
1852 current time. The argument should have the form (HIGH LOW . IGNORED).
1853 Thus, you can use times obtained from `current-time' and from
1854 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1855 but this is considered obsolete. */)
1857 Lisp_Object specified_time
;
1863 if (! lisp_time_argument (specified_time
, &value
, NULL
))
1864 error ("Invalid time specification");
1866 /* Convert to a string, checking for out-of-range time stamps.
1867 Don't use 'ctime', as that might dump core if VALUE is out of
1869 tm
= localtime (&value
);
1870 if (! (tm
&& TM_YEAR_IN_ASCTIME_RANGE (tm
->tm_year
) && (tem
= asctime (tm
))))
1871 error ("Specified time is not representable");
1873 /* Remove the trailing newline. */
1874 tem
[strlen (tem
) - 1] = '\0';
1876 return build_string (tem
);
1879 /* Yield A - B, measured in seconds.
1880 This function is copied from the GNU C Library. */
1885 /* Compute intervening leap days correctly even if year is negative.
1886 Take care to avoid int overflow in leap day calculations,
1887 but it's OK to assume that A and B are close to each other. */
1888 int a4
= (a
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (a
->tm_year
& 3);
1889 int b4
= (b
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (b
->tm_year
& 3);
1890 int a100
= a4
/ 25 - (a4
% 25 < 0);
1891 int b100
= b4
/ 25 - (b4
% 25 < 0);
1892 int a400
= a100
>> 2;
1893 int b400
= b100
>> 2;
1894 int intervening_leap_days
= (a4
- b4
) - (a100
- b100
) + (a400
- b400
);
1895 int years
= a
->tm_year
- b
->tm_year
;
1896 int days
= (365 * years
+ intervening_leap_days
1897 + (a
->tm_yday
- b
->tm_yday
));
1898 return (60 * (60 * (24 * days
+ (a
->tm_hour
- b
->tm_hour
))
1899 + (a
->tm_min
- b
->tm_min
))
1900 + (a
->tm_sec
- b
->tm_sec
));
1903 DEFUN ("current-time-zone", Fcurrent_time_zone
, Scurrent_time_zone
, 0, 1, 0,
1904 doc
: /* Return the offset and name for the local time zone.
1905 This returns a list of the form (OFFSET NAME).
1906 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1907 A negative value means west of Greenwich.
1908 NAME is a string giving the name of the time zone.
1909 If SPECIFIED-TIME is given, the time zone offset is determined from it
1910 instead of using the current time. The argument should have the form
1911 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1912 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1913 have the form (HIGH . LOW), but this is considered obsolete.
1915 Some operating systems cannot provide all this information to Emacs;
1916 in this case, `current-time-zone' returns a list containing nil for
1917 the data it can't find. */)
1919 Lisp_Object specified_time
;
1925 if (lisp_time_argument (specified_time
, &value
, NULL
)
1926 && (t
= gmtime (&value
)) != 0
1927 && (gmt
= *t
, t
= localtime (&value
)) != 0)
1929 int offset
= tm_diff (t
, &gmt
);
1934 s
= (char *)t
->tm_zone
;
1935 #else /* not HAVE_TM_ZONE */
1937 if (t
->tm_isdst
== 0 || t
->tm_isdst
== 1)
1938 s
= tzname
[t
->tm_isdst
];
1940 #endif /* not HAVE_TM_ZONE */
1942 #if defined HAVE_TM_ZONE || defined HAVE_TZNAME
1945 /* On Japanese w32, we can get a Japanese string as time
1946 zone name. Don't accept that. */
1948 for (p
= s
; *p
&& (isalnum ((unsigned char)*p
) || *p
== ' '); ++p
)
1957 /* No local time zone name is available; use "+-NNNN" instead. */
1958 int am
= (offset
< 0 ? -offset
: offset
) / 60;
1959 sprintf (buf
, "%c%02d%02d", (offset
< 0 ? '-' : '+'), am
/60, am
%60);
1962 return Fcons (make_number (offset
), Fcons (build_string (s
), Qnil
));
1965 return Fmake_list (make_number (2), Qnil
);
1968 /* This holds the value of `environ' produced by the previous
1969 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1970 has never been called. */
1971 static char **environbuf
;
1973 DEFUN ("set-time-zone-rule", Fset_time_zone_rule
, Sset_time_zone_rule
, 1, 1, 0,
1974 doc
: /* Set the local time zone using TZ, a string specifying a time zone rule.
1975 If TZ is nil, use implementation-defined default time zone information.
1976 If TZ is t, use Universal Time. */)
1984 else if (EQ (tz
, Qt
))
1989 tzstring
= (char *) SDATA (tz
);
1992 set_time_zone_rule (tzstring
);
1995 environbuf
= environ
;
2000 #ifdef LOCALTIME_CACHE
2002 /* These two values are known to load tz files in buggy implementations,
2003 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2004 Their values shouldn't matter in non-buggy implementations.
2005 We don't use string literals for these strings,
2006 since if a string in the environment is in readonly
2007 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2008 See Sun bugs 1113095 and 1114114, ``Timezone routines
2009 improperly modify environment''. */
2011 static char set_time_zone_rule_tz1
[] = "TZ=GMT+0";
2012 static char set_time_zone_rule_tz2
[] = "TZ=GMT+1";
2016 /* Set the local time zone rule to TZSTRING.
2017 This allocates memory into `environ', which it is the caller's
2018 responsibility to free. */
2021 set_time_zone_rule (tzstring
)
2025 char **from
, **to
, **newenv
;
2027 /* Make the ENVIRON vector longer with room for TZSTRING. */
2028 for (from
= environ
; *from
; from
++)
2030 envptrs
= from
- environ
+ 2;
2031 newenv
= to
= (char **) xmalloc (envptrs
* sizeof (char *)
2032 + (tzstring
? strlen (tzstring
) + 4 : 0));
2034 /* Add TZSTRING to the end of environ, as a value for TZ. */
2037 char *t
= (char *) (to
+ envptrs
);
2039 strcat (t
, tzstring
);
2043 /* Copy the old environ vector elements into NEWENV,
2044 but don't copy the TZ variable.
2045 So we have only one definition of TZ, which came from TZSTRING. */
2046 for (from
= environ
; *from
; from
++)
2047 if (strncmp (*from
, "TZ=", 3) != 0)
2053 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2054 the TZ variable is stored. If we do not have a TZSTRING,
2055 TO points to the vector slot which has the terminating null. */
2057 #ifdef LOCALTIME_CACHE
2059 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2060 "US/Pacific" that loads a tz file, then changes to a value like
2061 "XXX0" that does not load a tz file, and then changes back to
2062 its original value, the last change is (incorrectly) ignored.
2063 Also, if TZ changes twice in succession to values that do
2064 not load a tz file, tzset can dump core (see Sun bug#1225179).
2065 The following code works around these bugs. */
2069 /* Temporarily set TZ to a value that loads a tz file
2070 and that differs from tzstring. */
2072 *newenv
= (strcmp (tzstring
, set_time_zone_rule_tz1
+ 3) == 0
2073 ? set_time_zone_rule_tz2
: set_time_zone_rule_tz1
);
2079 /* The implied tzstring is unknown, so temporarily set TZ to
2080 two different values that each load a tz file. */
2081 *to
= set_time_zone_rule_tz1
;
2084 *to
= set_time_zone_rule_tz2
;
2089 /* Now TZ has the desired value, and tzset can be invoked safely. */
2096 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2097 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2098 type of object is Lisp_String). INHERIT is passed to
2099 INSERT_FROM_STRING_FUNC as the last argument. */
2102 general_insert_function (insert_func
, insert_from_string_func
,
2103 inherit
, nargs
, args
)
2104 void (*insert_func
) P_ ((const unsigned char *, int));
2105 void (*insert_from_string_func
) P_ ((Lisp_Object
, int, int, int, int, int));
2107 register Lisp_Object
*args
;
2109 register int argnum
;
2110 register Lisp_Object val
;
2112 for (argnum
= 0; argnum
< nargs
; argnum
++)
2118 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2121 if (!NILP (current_buffer
->enable_multibyte_characters
))
2122 len
= CHAR_STRING (XFASTINT (val
), str
);
2125 str
[0] = (SINGLE_BYTE_CHAR_P (XINT (val
))
2127 : multibyte_char_to_unibyte (XINT (val
), Qnil
));
2130 (*insert_func
) (str
, len
);
2132 else if (STRINGP (val
))
2134 (*insert_from_string_func
) (val
, 0, 0,
2141 val
= wrong_type_argument (Qchar_or_string_p
, val
);
2155 /* Callers passing one argument to Finsert need not gcpro the
2156 argument "array", since the only element of the array will
2157 not be used after calling insert or insert_from_string, so
2158 we don't care if it gets trashed. */
2160 DEFUN ("insert", Finsert
, Sinsert
, 0, MANY
, 0,
2161 doc
: /* Insert the arguments, either strings or characters, at point.
2162 Point and before-insertion markers move forward to end up
2163 after the inserted text.
2164 Any other markers at the point of insertion remain before the text.
2166 If the current buffer is multibyte, unibyte strings are converted
2167 to multibyte for insertion (see `string-make-multibyte').
2168 If the current buffer is unibyte, multibyte strings are converted
2169 to unibyte for insertion (see `string-make-unibyte').
2171 When operating on binary data, it may be necessary to preserve the
2172 original bytes of a unibyte string when inserting it into a multibyte
2173 buffer; to accomplish this, apply `string-as-multibyte' to the string
2174 and insert the result.
2176 usage: (insert &rest ARGS) */)
2179 register Lisp_Object
*args
;
2181 general_insert_function (insert
, insert_from_string
, 0, nargs
, args
);
2185 DEFUN ("insert-and-inherit", Finsert_and_inherit
, Sinsert_and_inherit
,
2187 doc
: /* Insert the arguments at point, inheriting properties from adjoining text.
2188 Point and before-insertion markers move forward to end up
2189 after the inserted text.
2190 Any other markers at the point of insertion remain before the text.
2192 If the current buffer is multibyte, unibyte strings are converted
2193 to multibyte for insertion (see `unibyte-char-to-multibyte').
2194 If the current buffer is unibyte, multibyte strings are converted
2195 to unibyte for insertion.
2197 usage: (insert-and-inherit &rest ARGS) */)
2200 register Lisp_Object
*args
;
2202 general_insert_function (insert_and_inherit
, insert_from_string
, 1,
2207 DEFUN ("insert-before-markers", Finsert_before_markers
, Sinsert_before_markers
, 0, MANY
, 0,
2208 doc
: /* Insert strings or characters at point, relocating markers after the text.
2209 Point and markers move forward to end up after the inserted text.
2211 If the current buffer is multibyte, unibyte strings are converted
2212 to multibyte for insertion (see `unibyte-char-to-multibyte').
2213 If the current buffer is unibyte, multibyte strings are converted
2214 to unibyte for insertion.
2216 usage: (insert-before-markers &rest ARGS) */)
2219 register Lisp_Object
*args
;
2221 general_insert_function (insert_before_markers
,
2222 insert_from_string_before_markers
, 0,
2227 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers
,
2228 Sinsert_and_inherit_before_markers
, 0, MANY
, 0,
2229 doc
: /* Insert text at point, relocating markers and inheriting properties.
2230 Point and markers move forward to end up after the inserted text.
2232 If the current buffer is multibyte, unibyte strings are converted
2233 to multibyte for insertion (see `unibyte-char-to-multibyte').
2234 If the current buffer is unibyte, multibyte strings are converted
2235 to unibyte for insertion.
2237 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2240 register Lisp_Object
*args
;
2242 general_insert_function (insert_before_markers_and_inherit
,
2243 insert_from_string_before_markers
, 1,
2248 DEFUN ("insert-char", Finsert_char
, Sinsert_char
, 2, 3, 0,
2249 doc
: /* Insert COUNT (second arg) copies of CHARACTER (first arg).
2250 Both arguments are required.
2251 Point, and before-insertion markers, are relocated as in the function `insert'.
2252 The optional third arg INHERIT, if non-nil, says to inherit text properties
2253 from adjoining text, if those properties are sticky. */)
2254 (character
, count
, inherit
)
2255 Lisp_Object character
, count
, inherit
;
2257 register unsigned char *string
;
2258 register int strlen
;
2261 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2263 CHECK_NUMBER (character
);
2264 CHECK_NUMBER (count
);
2266 if (!NILP (current_buffer
->enable_multibyte_characters
))
2267 len
= CHAR_STRING (XFASTINT (character
), str
);
2269 str
[0] = XFASTINT (character
), len
= 1;
2270 n
= XINT (count
) * len
;
2273 strlen
= min (n
, 256 * len
);
2274 string
= (unsigned char *) alloca (strlen
);
2275 for (i
= 0; i
< strlen
; i
++)
2276 string
[i
] = str
[i
% len
];
2280 if (!NILP (inherit
))
2281 insert_and_inherit (string
, strlen
);
2283 insert (string
, strlen
);
2288 if (!NILP (inherit
))
2289 insert_and_inherit (string
, n
);
2297 /* Making strings from buffer contents. */
2299 /* Return a Lisp_String containing the text of the current buffer from
2300 START to END. If text properties are in use and the current buffer
2301 has properties in the range specified, the resulting string will also
2302 have them, if PROPS is nonzero.
2304 We don't want to use plain old make_string here, because it calls
2305 make_uninit_string, which can cause the buffer arena to be
2306 compacted. make_string has no way of knowing that the data has
2307 been moved, and thus copies the wrong data into the string. This
2308 doesn't effect most of the other users of make_string, so it should
2309 be left as is. But we should use this function when conjuring
2310 buffer substrings. */
2313 make_buffer_string (start
, end
, props
)
2317 int start_byte
= CHAR_TO_BYTE (start
);
2318 int end_byte
= CHAR_TO_BYTE (end
);
2320 return make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
);
2323 /* Return a Lisp_String containing the text of the current buffer from
2324 START / START_BYTE to END / END_BYTE.
2326 If text properties are in use and the current buffer
2327 has properties in the range specified, the resulting string will also
2328 have them, if PROPS is nonzero.
2330 We don't want to use plain old make_string here, because it calls
2331 make_uninit_string, which can cause the buffer arena to be
2332 compacted. make_string has no way of knowing that the data has
2333 been moved, and thus copies the wrong data into the string. This
2334 doesn't effect most of the other users of make_string, so it should
2335 be left as is. But we should use this function when conjuring
2336 buffer substrings. */
2339 make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
)
2340 int start
, start_byte
, end
, end_byte
;
2343 Lisp_Object result
, tem
, tem1
;
2345 if (start
< GPT
&& GPT
< end
)
2348 if (! NILP (current_buffer
->enable_multibyte_characters
))
2349 result
= make_uninit_multibyte_string (end
- start
, end_byte
- start_byte
);
2351 result
= make_uninit_string (end
- start
);
2352 bcopy (BYTE_POS_ADDR (start_byte
), SDATA (result
),
2353 end_byte
- start_byte
);
2355 /* If desired, update and copy the text properties. */
2358 update_buffer_properties (start
, end
);
2360 tem
= Fnext_property_change (make_number (start
), Qnil
, make_number (end
));
2361 tem1
= Ftext_properties_at (make_number (start
), Qnil
);
2363 if (XINT (tem
) != end
|| !NILP (tem1
))
2364 copy_intervals_to_string (result
, current_buffer
, start
,
2371 /* Call Vbuffer_access_fontify_functions for the range START ... END
2372 in the current buffer, if necessary. */
2375 update_buffer_properties (start
, end
)
2378 /* If this buffer has some access functions,
2379 call them, specifying the range of the buffer being accessed. */
2380 if (!NILP (Vbuffer_access_fontify_functions
))
2382 Lisp_Object args
[3];
2385 args
[0] = Qbuffer_access_fontify_functions
;
2386 XSETINT (args
[1], start
);
2387 XSETINT (args
[2], end
);
2389 /* But don't call them if we can tell that the work
2390 has already been done. */
2391 if (!NILP (Vbuffer_access_fontified_property
))
2393 tem
= Ftext_property_any (args
[1], args
[2],
2394 Vbuffer_access_fontified_property
,
2397 Frun_hook_with_args (3, args
);
2400 Frun_hook_with_args (3, args
);
2404 DEFUN ("buffer-substring", Fbuffer_substring
, Sbuffer_substring
, 2, 2, 0,
2405 doc
: /* Return the contents of part of the current buffer as a string.
2406 The two arguments START and END are character positions;
2407 they can be in either order.
2408 The string returned is multibyte if the buffer is multibyte.
2410 This function copies the text properties of that part of the buffer
2411 into the result string; if you don't want the text properties,
2412 use `buffer-substring-no-properties' instead. */)
2414 Lisp_Object start
, end
;
2418 validate_region (&start
, &end
);
2422 return make_buffer_string (b
, e
, 1);
2425 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties
,
2426 Sbuffer_substring_no_properties
, 2, 2, 0,
2427 doc
: /* Return the characters of part of the buffer, without the text properties.
2428 The two arguments START and END are character positions;
2429 they can be in either order. */)
2431 Lisp_Object start
, end
;
2435 validate_region (&start
, &end
);
2439 return make_buffer_string (b
, e
, 0);
2442 DEFUN ("buffer-string", Fbuffer_string
, Sbuffer_string
, 0, 0, 0,
2443 doc
: /* Return the contents of the current buffer as a string.
2444 If narrowing is in effect, this function returns only the visible part
2448 return make_buffer_string (BEGV
, ZV
, 1);
2451 DEFUN ("insert-buffer-substring", Finsert_buffer_substring
, Sinsert_buffer_substring
,
2453 doc
: /* Insert before point a substring of the contents of BUFFER.
2454 BUFFER may be a buffer or a buffer name.
2455 Arguments START and END are character positions specifying the substring.
2456 They default to the values of (point-min) and (point-max) in BUFFER. */)
2457 (buffer
, start
, end
)
2458 Lisp_Object buffer
, start
, end
;
2460 register int b
, e
, temp
;
2461 register struct buffer
*bp
, *obuf
;
2464 buf
= Fget_buffer (buffer
);
2468 if (NILP (bp
->name
))
2469 error ("Selecting deleted buffer");
2475 CHECK_NUMBER_COERCE_MARKER (start
);
2482 CHECK_NUMBER_COERCE_MARKER (end
);
2487 temp
= b
, b
= e
, e
= temp
;
2489 if (!(BUF_BEGV (bp
) <= b
&& e
<= BUF_ZV (bp
)))
2490 args_out_of_range (start
, end
);
2492 obuf
= current_buffer
;
2493 set_buffer_internal_1 (bp
);
2494 update_buffer_properties (b
, e
);
2495 set_buffer_internal_1 (obuf
);
2497 insert_from_buffer (bp
, b
, e
- b
, 0);
2501 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings
, Scompare_buffer_substrings
,
2503 doc
: /* Compare two substrings of two buffers; return result as number.
2504 the value is -N if first string is less after N-1 chars,
2505 +N if first string is greater after N-1 chars, or 0 if strings match.
2506 Each substring is represented as three arguments: BUFFER, START and END.
2507 That makes six args in all, three for each substring.
2509 The value of `case-fold-search' in the current buffer
2510 determines whether case is significant or ignored. */)
2511 (buffer1
, start1
, end1
, buffer2
, start2
, end2
)
2512 Lisp_Object buffer1
, start1
, end1
, buffer2
, start2
, end2
;
2514 register int begp1
, endp1
, begp2
, endp2
, temp
;
2515 register struct buffer
*bp1
, *bp2
;
2516 register Lisp_Object trt
2517 = (!NILP (current_buffer
->case_fold_search
)
2518 ? current_buffer
->case_canon_table
: Qnil
);
2520 int i1
, i2
, i1_byte
, i2_byte
;
2522 /* Find the first buffer and its substring. */
2525 bp1
= current_buffer
;
2529 buf1
= Fget_buffer (buffer1
);
2532 bp1
= XBUFFER (buf1
);
2533 if (NILP (bp1
->name
))
2534 error ("Selecting deleted buffer");
2538 begp1
= BUF_BEGV (bp1
);
2541 CHECK_NUMBER_COERCE_MARKER (start1
);
2542 begp1
= XINT (start1
);
2545 endp1
= BUF_ZV (bp1
);
2548 CHECK_NUMBER_COERCE_MARKER (end1
);
2549 endp1
= XINT (end1
);
2553 temp
= begp1
, begp1
= endp1
, endp1
= temp
;
2555 if (!(BUF_BEGV (bp1
) <= begp1
2557 && endp1
<= BUF_ZV (bp1
)))
2558 args_out_of_range (start1
, end1
);
2560 /* Likewise for second substring. */
2563 bp2
= current_buffer
;
2567 buf2
= Fget_buffer (buffer2
);
2570 bp2
= XBUFFER (buf2
);
2571 if (NILP (bp2
->name
))
2572 error ("Selecting deleted buffer");
2576 begp2
= BUF_BEGV (bp2
);
2579 CHECK_NUMBER_COERCE_MARKER (start2
);
2580 begp2
= XINT (start2
);
2583 endp2
= BUF_ZV (bp2
);
2586 CHECK_NUMBER_COERCE_MARKER (end2
);
2587 endp2
= XINT (end2
);
2591 temp
= begp2
, begp2
= endp2
, endp2
= temp
;
2593 if (!(BUF_BEGV (bp2
) <= begp2
2595 && endp2
<= BUF_ZV (bp2
)))
2596 args_out_of_range (start2
, end2
);
2600 i1_byte
= buf_charpos_to_bytepos (bp1
, i1
);
2601 i2_byte
= buf_charpos_to_bytepos (bp2
, i2
);
2603 while (i1
< endp1
&& i2
< endp2
)
2605 /* When we find a mismatch, we must compare the
2606 characters, not just the bytes. */
2611 if (! NILP (bp1
->enable_multibyte_characters
))
2613 c1
= BUF_FETCH_MULTIBYTE_CHAR (bp1
, i1_byte
);
2614 BUF_INC_POS (bp1
, i1_byte
);
2619 c1
= BUF_FETCH_BYTE (bp1
, i1
);
2620 c1
= unibyte_char_to_multibyte (c1
);
2624 if (! NILP (bp2
->enable_multibyte_characters
))
2626 c2
= BUF_FETCH_MULTIBYTE_CHAR (bp2
, i2_byte
);
2627 BUF_INC_POS (bp2
, i2_byte
);
2632 c2
= BUF_FETCH_BYTE (bp2
, i2
);
2633 c2
= unibyte_char_to_multibyte (c2
);
2639 c1
= CHAR_TABLE_TRANSLATE (trt
, c1
);
2640 c2
= CHAR_TABLE_TRANSLATE (trt
, c2
);
2643 return make_number (- 1 - chars
);
2645 return make_number (chars
+ 1);
2650 /* The strings match as far as they go.
2651 If one is shorter, that one is less. */
2652 if (chars
< endp1
- begp1
)
2653 return make_number (chars
+ 1);
2654 else if (chars
< endp2
- begp2
)
2655 return make_number (- chars
- 1);
2657 /* Same length too => they are equal. */
2658 return make_number (0);
2662 subst_char_in_region_unwind (arg
)
2665 return current_buffer
->undo_list
= arg
;
2669 subst_char_in_region_unwind_1 (arg
)
2672 return current_buffer
->filename
= arg
;
2675 DEFUN ("subst-char-in-region", Fsubst_char_in_region
,
2676 Ssubst_char_in_region
, 4, 5, 0,
2677 doc
: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2678 If optional arg NOUNDO is non-nil, don't record this change for undo
2679 and don't mark the buffer as really changed.
2680 Both characters must have the same length of multi-byte form. */)
2681 (start
, end
, fromchar
, tochar
, noundo
)
2682 Lisp_Object start
, end
, fromchar
, tochar
, noundo
;
2684 register int pos
, pos_byte
, stop
, i
, len
, end_byte
;
2686 unsigned char fromstr
[MAX_MULTIBYTE_LENGTH
], tostr
[MAX_MULTIBYTE_LENGTH
];
2688 int count
= SPECPDL_INDEX ();
2689 #define COMBINING_NO 0
2690 #define COMBINING_BEFORE 1
2691 #define COMBINING_AFTER 2
2692 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2693 int maybe_byte_combining
= COMBINING_NO
;
2694 int last_changed
= 0;
2695 int multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2697 validate_region (&start
, &end
);
2698 CHECK_NUMBER (fromchar
);
2699 CHECK_NUMBER (tochar
);
2703 len
= CHAR_STRING (XFASTINT (fromchar
), fromstr
);
2704 if (CHAR_STRING (XFASTINT (tochar
), tostr
) != len
)
2705 error ("Characters in `subst-char-in-region' have different byte-lengths");
2706 if (!ASCII_BYTE_P (*tostr
))
2708 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2709 complete multibyte character, it may be combined with the
2710 after bytes. If it is in the range 0xA0..0xFF, it may be
2711 combined with the before and after bytes. */
2712 if (!CHAR_HEAD_P (*tostr
))
2713 maybe_byte_combining
= COMBINING_BOTH
;
2714 else if (BYTES_BY_CHAR_HEAD (*tostr
) > len
)
2715 maybe_byte_combining
= COMBINING_AFTER
;
2721 fromstr
[0] = XFASTINT (fromchar
);
2722 tostr
[0] = XFASTINT (tochar
);
2726 pos_byte
= CHAR_TO_BYTE (pos
);
2727 stop
= CHAR_TO_BYTE (XINT (end
));
2730 /* If we don't want undo, turn off putting stuff on the list.
2731 That's faster than getting rid of things,
2732 and it prevents even the entry for a first change.
2733 Also inhibit locking the file. */
2736 record_unwind_protect (subst_char_in_region_unwind
,
2737 current_buffer
->undo_list
);
2738 current_buffer
->undo_list
= Qt
;
2739 /* Don't do file-locking. */
2740 record_unwind_protect (subst_char_in_region_unwind_1
,
2741 current_buffer
->filename
);
2742 current_buffer
->filename
= Qnil
;
2745 if (pos_byte
< GPT_BYTE
)
2746 stop
= min (stop
, GPT_BYTE
);
2749 int pos_byte_next
= pos_byte
;
2751 if (pos_byte
>= stop
)
2753 if (pos_byte
>= end_byte
) break;
2756 p
= BYTE_POS_ADDR (pos_byte
);
2758 INC_POS (pos_byte_next
);
2761 if (pos_byte_next
- pos_byte
== len
2762 && p
[0] == fromstr
[0]
2764 || (p
[1] == fromstr
[1]
2765 && (len
== 2 || (p
[2] == fromstr
[2]
2766 && (len
== 3 || p
[3] == fromstr
[3]))))))
2771 modify_region (current_buffer
, changed
, XINT (end
));
2773 if (! NILP (noundo
))
2775 if (MODIFF
- 1 == SAVE_MODIFF
)
2777 if (MODIFF
- 1 == current_buffer
->auto_save_modified
)
2778 current_buffer
->auto_save_modified
++;
2782 /* Take care of the case where the new character
2783 combines with neighboring bytes. */
2784 if (maybe_byte_combining
2785 && (maybe_byte_combining
== COMBINING_AFTER
2786 ? (pos_byte_next
< Z_BYTE
2787 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2788 : ((pos_byte_next
< Z_BYTE
2789 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2790 || (pos_byte
> BEG_BYTE
2791 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte
- 1))))))
2793 Lisp_Object tem
, string
;
2795 struct gcpro gcpro1
;
2797 tem
= current_buffer
->undo_list
;
2800 /* Make a multibyte string containing this single character. */
2801 string
= make_multibyte_string (tostr
, 1, len
);
2802 /* replace_range is less efficient, because it moves the gap,
2803 but it handles combining correctly. */
2804 replace_range (pos
, pos
+ 1, string
,
2806 pos_byte_next
= CHAR_TO_BYTE (pos
);
2807 if (pos_byte_next
> pos_byte
)
2808 /* Before combining happened. We should not increment
2809 POS. So, to cancel the later increment of POS,
2813 INC_POS (pos_byte_next
);
2815 if (! NILP (noundo
))
2816 current_buffer
->undo_list
= tem
;
2823 record_change (pos
, 1);
2824 for (i
= 0; i
< len
; i
++) *p
++ = tostr
[i
];
2826 last_changed
= pos
+ 1;
2828 pos_byte
= pos_byte_next
;
2834 signal_after_change (changed
,
2835 last_changed
- changed
, last_changed
- changed
);
2836 update_compositions (changed
, last_changed
, CHECK_ALL
);
2839 unbind_to (count
, Qnil
);
2843 DEFUN ("translate-region-internal", Ftranslate_region_internal
,
2844 Stranslate_region_internal
, 3, 3, 0,
2845 doc
: /* Internal use only.
2846 From START to END, translate characters according to TABLE.
2847 TABLE is a string; the Nth character in it is the mapping
2848 for the character with code N.
2849 It returns the number of characters changed. */)
2853 register Lisp_Object table
;
2855 register unsigned char *tt
; /* Trans table. */
2856 register int nc
; /* New character. */
2857 int cnt
; /* Number of changes made. */
2858 int size
; /* Size of translate table. */
2859 int pos
, pos_byte
, end_pos
;
2860 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2861 int string_multibyte
;
2863 validate_region (&start
, &end
);
2864 if (CHAR_TABLE_P (table
))
2871 CHECK_STRING (table
);
2873 if (! multibyte
&& (SCHARS (table
) < SBYTES (table
)))
2874 table
= string_make_unibyte (table
);
2875 string_multibyte
= SCHARS (table
) < SBYTES (table
);
2876 size
= SCHARS (table
);
2881 pos_byte
= CHAR_TO_BYTE (pos
);
2882 end_pos
= XINT (end
);
2883 modify_region (current_buffer
, pos
, XINT (end
));
2886 for (; pos
< end_pos
; )
2888 register unsigned char *p
= BYTE_POS_ADDR (pos_byte
);
2889 unsigned char *str
, buf
[MAX_MULTIBYTE_LENGTH
];
2894 oc
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, len
);
2901 /* Reload as signal_after_change in last iteration may GC. */
2903 if (string_multibyte
)
2905 str
= tt
+ string_char_to_byte (table
, oc
);
2906 nc
= STRING_CHAR_AND_LENGTH (str
, MAX_MULTIBYTE_LENGTH
,
2912 if (! ASCII_BYTE_P (nc
) && multibyte
)
2914 str_len
= CHAR_STRING (nc
, buf
);
2930 val
= CHAR_TABLE_REF (table
, oc
);
2932 && (c
= XINT (val
), CHAR_VALID_P (c
, 0)))
2935 str_len
= CHAR_STRING (nc
, buf
);
2946 /* This is less efficient, because it moves the gap,
2947 but it should multibyte characters correctly. */
2948 string
= make_multibyte_string (str
, 1, str_len
);
2949 replace_range (pos
, pos
+ 1, string
, 1, 0, 1);
2954 record_change (pos
, 1);
2955 while (str_len
-- > 0)
2957 signal_after_change (pos
, 1, 1);
2958 update_compositions (pos
, pos
+ 1, CHECK_BORDER
);
2967 return make_number (cnt
);
2970 DEFUN ("delete-region", Fdelete_region
, Sdelete_region
, 2, 2, "r",
2971 doc
: /* Delete the text between point and mark.
2973 When called from a program, expects two arguments,
2974 positions (integers or markers) specifying the stretch to be deleted. */)
2976 Lisp_Object start
, end
;
2978 validate_region (&start
, &end
);
2979 del_range (XINT (start
), XINT (end
));
2983 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region
,
2984 Sdelete_and_extract_region
, 2, 2, 0,
2985 doc
: /* Delete the text between START and END and return it. */)
2987 Lisp_Object start
, end
;
2989 validate_region (&start
, &end
);
2990 if (XINT (start
) == XINT (end
))
2991 return build_string ("");
2992 return del_range_1 (XINT (start
), XINT (end
), 1, 1);
2995 DEFUN ("widen", Fwiden
, Swiden
, 0, 0, "",
2996 doc
: /* Remove restrictions (narrowing) from current buffer.
2997 This allows the buffer's full text to be seen and edited. */)
3000 if (BEG
!= BEGV
|| Z
!= ZV
)
3001 current_buffer
->clip_changed
= 1;
3003 BEGV_BYTE
= BEG_BYTE
;
3004 SET_BUF_ZV_BOTH (current_buffer
, Z
, Z_BYTE
);
3005 /* Changing the buffer bounds invalidates any recorded current column. */
3006 invalidate_current_column ();
3010 DEFUN ("narrow-to-region", Fnarrow_to_region
, Snarrow_to_region
, 2, 2, "r",
3011 doc
: /* Restrict editing in this buffer to the current region.
3012 The rest of the text becomes temporarily invisible and untouchable
3013 but is not deleted; if you save the buffer in a file, the invisible
3014 text is included in the file. \\[widen] makes all visible again.
3015 See also `save-restriction'.
3017 When calling from a program, pass two arguments; positions (integers
3018 or markers) bounding the text that should remain visible. */)
3020 register Lisp_Object start
, end
;
3022 CHECK_NUMBER_COERCE_MARKER (start
);
3023 CHECK_NUMBER_COERCE_MARKER (end
);
3025 if (XINT (start
) > XINT (end
))
3028 tem
= start
; start
= end
; end
= tem
;
3031 if (!(BEG
<= XINT (start
) && XINT (start
) <= XINT (end
) && XINT (end
) <= Z
))
3032 args_out_of_range (start
, end
);
3034 if (BEGV
!= XFASTINT (start
) || ZV
!= XFASTINT (end
))
3035 current_buffer
->clip_changed
= 1;
3037 SET_BUF_BEGV (current_buffer
, XFASTINT (start
));
3038 SET_BUF_ZV (current_buffer
, XFASTINT (end
));
3039 if (PT
< XFASTINT (start
))
3040 SET_PT (XFASTINT (start
));
3041 if (PT
> XFASTINT (end
))
3042 SET_PT (XFASTINT (end
));
3043 /* Changing the buffer bounds invalidates any recorded current column. */
3044 invalidate_current_column ();
3049 save_restriction_save ()
3051 if (BEGV
== BEG
&& ZV
== Z
)
3052 /* The common case that the buffer isn't narrowed.
3053 We return just the buffer object, which save_restriction_restore
3054 recognizes as meaning `no restriction'. */
3055 return Fcurrent_buffer ();
3057 /* We have to save a restriction, so return a pair of markers, one
3058 for the beginning and one for the end. */
3060 Lisp_Object beg
, end
;
3062 beg
= buildmark (BEGV
, BEGV_BYTE
);
3063 end
= buildmark (ZV
, ZV_BYTE
);
3065 /* END must move forward if text is inserted at its exact location. */
3066 XMARKER(end
)->insertion_type
= 1;
3068 return Fcons (beg
, end
);
3073 save_restriction_restore (data
)
3077 /* A pair of marks bounding a saved restriction. */
3079 struct Lisp_Marker
*beg
= XMARKER (XCAR (data
));
3080 struct Lisp_Marker
*end
= XMARKER (XCDR (data
));
3081 struct buffer
*buf
= beg
->buffer
; /* END should have the same buffer. */
3083 if (buf
/* Verify marker still points to a buffer. */
3084 && (beg
->charpos
!= BUF_BEGV (buf
) || end
->charpos
!= BUF_ZV (buf
)))
3085 /* The restriction has changed from the saved one, so restore
3086 the saved restriction. */
3088 int pt
= BUF_PT (buf
);
3090 SET_BUF_BEGV_BOTH (buf
, beg
->charpos
, beg
->bytepos
);
3091 SET_BUF_ZV_BOTH (buf
, end
->charpos
, end
->bytepos
);
3093 if (pt
< beg
->charpos
|| pt
> end
->charpos
)
3094 /* The point is outside the new visible range, move it inside. */
3095 SET_BUF_PT_BOTH (buf
,
3096 clip_to_bounds (beg
->charpos
, pt
, end
->charpos
),
3097 clip_to_bounds (beg
->bytepos
, BUF_PT_BYTE (buf
),
3100 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3104 /* A buffer, which means that there was no old restriction. */
3106 struct buffer
*buf
= XBUFFER (data
);
3108 if (buf
/* Verify marker still points to a buffer. */
3109 && (BUF_BEGV (buf
) != BUF_BEG (buf
) || BUF_ZV (buf
) != BUF_Z (buf
)))
3110 /* The buffer has been narrowed, get rid of the narrowing. */
3112 SET_BUF_BEGV_BOTH (buf
, BUF_BEG (buf
), BUF_BEG_BYTE (buf
));
3113 SET_BUF_ZV_BOTH (buf
, BUF_Z (buf
), BUF_Z_BYTE (buf
));
3115 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3122 DEFUN ("save-restriction", Fsave_restriction
, Ssave_restriction
, 0, UNEVALLED
, 0,
3123 doc
: /* Execute BODY, saving and restoring current buffer's restrictions.
3124 The buffer's restrictions make parts of the beginning and end invisible.
3125 (They are set up with `narrow-to-region' and eliminated with `widen'.)
3126 This special form, `save-restriction', saves the current buffer's restrictions
3127 when it is entered, and restores them when it is exited.
3128 So any `narrow-to-region' within BODY lasts only until the end of the form.
3129 The old restrictions settings are restored
3130 even in case of abnormal exit (throw or error).
3132 The value returned is the value of the last form in BODY.
3134 Note: if you are using both `save-excursion' and `save-restriction',
3135 use `save-excursion' outermost:
3136 (save-excursion (save-restriction ...))
3138 usage: (save-restriction &rest BODY) */)
3142 register Lisp_Object val
;
3143 int count
= SPECPDL_INDEX ();
3145 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
3146 val
= Fprogn (body
);
3147 return unbind_to (count
, val
);
3150 /* Buffer for the most recent text displayed by Fmessage_box. */
3151 static char *message_text
;
3153 /* Allocated length of that buffer. */
3154 static int message_length
;
3156 DEFUN ("message", Fmessage
, Smessage
, 1, MANY
, 0,
3157 doc
: /* Print a one-line message at the bottom of the screen.
3158 The message also goes into the `*Messages*' buffer.
3159 \(In keyboard macros, that's all it does.)
3161 The first argument is a format control string, and the rest are data
3162 to be formatted under control of the string. See `format' for details.
3164 If the first argument is nil or the empty string, the function clears
3165 any existing message; this lets the minibuffer contents show. See
3166 also `current-message'.
3168 usage: (message FORMAT-STRING &rest ARGS) */)
3174 || (STRINGP (args
[0])
3175 && SBYTES (args
[0]) == 0))
3182 register Lisp_Object val
;
3183 val
= Fformat (nargs
, args
);
3184 message3 (val
, SBYTES (val
), STRING_MULTIBYTE (val
));
3189 DEFUN ("message-box", Fmessage_box
, Smessage_box
, 1, MANY
, 0,
3190 doc
: /* Display a message, in a dialog box if possible.
3191 If a dialog box is not available, use the echo area.
3192 The first argument is a format control string, and the rest are data
3193 to be formatted under control of the string. See `format' for details.
3195 If the first argument is nil or the empty string, clear any existing
3196 message; let the minibuffer contents show.
3198 usage: (message-box FORMAT-STRING &rest ARGS) */)
3210 register Lisp_Object val
;
3211 val
= Fformat (nargs
, args
);
3213 /* The MS-DOS frames support popup menus even though they are
3214 not FRAME_WINDOW_P. */
3215 if (FRAME_WINDOW_P (XFRAME (selected_frame
))
3216 || FRAME_MSDOS_P (XFRAME (selected_frame
)))
3218 Lisp_Object pane
, menu
, obj
;
3219 struct gcpro gcpro1
;
3220 pane
= Fcons (Fcons (build_string ("OK"), Qt
), Qnil
);
3222 menu
= Fcons (val
, pane
);
3223 obj
= Fx_popup_dialog (Qt
, menu
, Qt
);
3227 #endif /* HAVE_MENUS */
3228 /* Copy the data so that it won't move when we GC. */
3231 message_text
= (char *)xmalloc (80);
3232 message_length
= 80;
3234 if (SBYTES (val
) > message_length
)
3236 message_length
= SBYTES (val
);
3237 message_text
= (char *)xrealloc (message_text
, message_length
);
3239 bcopy (SDATA (val
), message_text
, SBYTES (val
));
3240 message2 (message_text
, SBYTES (val
),
3241 STRING_MULTIBYTE (val
));
3246 extern Lisp_Object last_nonmenu_event
;
3249 DEFUN ("message-or-box", Fmessage_or_box
, Smessage_or_box
, 1, MANY
, 0,
3250 doc
: /* Display a message in a dialog box or in the echo area.
3251 If this command was invoked with the mouse, use a dialog box if
3252 `use-dialog-box' is non-nil.
3253 Otherwise, use the echo area.
3254 The first argument is a format control string, and the rest are data
3255 to be formatted under control of the string. See `format' for details.
3257 If the first argument is nil or the empty string, clear any existing
3258 message; let the minibuffer contents show.
3260 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3266 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
3268 return Fmessage_box (nargs
, args
);
3270 return Fmessage (nargs
, args
);
3273 DEFUN ("current-message", Fcurrent_message
, Scurrent_message
, 0, 0, 0,
3274 doc
: /* Return the string currently displayed in the echo area, or nil if none. */)
3277 return current_message ();
3281 DEFUN ("propertize", Fpropertize
, Spropertize
, 1, MANY
, 0,
3282 doc
: /* Return a copy of STRING with text properties added.
3283 First argument is the string to copy.
3284 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3285 properties to add to the result.
3286 usage: (propertize STRING &rest PROPERTIES) */)
3291 Lisp_Object properties
, string
;
3292 struct gcpro gcpro1
, gcpro2
;
3295 /* Number of args must be odd. */
3296 if ((nargs
& 1) == 0 || nargs
< 1)
3297 error ("Wrong number of arguments");
3299 properties
= string
= Qnil
;
3300 GCPRO2 (properties
, string
);
3302 /* First argument must be a string. */
3303 CHECK_STRING (args
[0]);
3304 string
= Fcopy_sequence (args
[0]);
3306 for (i
= 1; i
< nargs
; i
+= 2)
3307 properties
= Fcons (args
[i
], Fcons (args
[i
+ 1], properties
));
3309 Fadd_text_properties (make_number (0),
3310 make_number (SCHARS (string
)),
3311 properties
, string
);
3312 RETURN_UNGCPRO (string
);
3316 /* Number of bytes that STRING will occupy when put into the result.
3317 MULTIBYTE is nonzero if the result should be multibyte. */
3319 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3320 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3321 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3324 DEFUN ("format", Fformat
, Sformat
, 1, MANY
, 0,
3325 doc
: /* Format a string out of a format-string and arguments.
3326 The first argument is a format control string.
3327 The other arguments are substituted into it to make the result, a string.
3328 It may contain %-sequences meaning to substitute the next argument.
3329 %s means print a string argument. Actually, prints any object, with `princ'.
3330 %d means print as number in decimal (%o octal, %x hex).
3331 %X is like %x, but uses upper case.
3332 %e means print a number in exponential notation.
3333 %f means print a number in decimal-point notation.
3334 %g means print a number in exponential notation
3335 or decimal-point notation, whichever uses fewer characters.
3336 %c means print a number as a single character.
3337 %S means print any object as an s-expression (using `prin1').
3338 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3339 Use %% to put a single % into the output.
3341 The basic structure of a %-sequence is
3342 % <flags> <width> <precision> character
3343 where flags is [- #0]+, width is [0-9]+, and precision is .[0-9]+
3345 usage: (format STRING &rest OBJECTS) */)
3348 register Lisp_Object
*args
;
3350 register int n
; /* The number of the next arg to substitute */
3351 register int total
; /* An estimate of the final length */
3353 register unsigned char *format
, *end
, *format_start
;
3355 /* Nonzero if the output should be a multibyte string,
3356 which is true if any of the inputs is one. */
3358 /* When we make a multibyte string, we must pay attention to the
3359 byte combining problem, i.e., a byte may be combined with a
3360 multibyte charcter of the previous string. This flag tells if we
3361 must consider such a situation or not. */
3362 int maybe_combine_byte
;
3363 unsigned char *this_format
;
3364 /* Precision for each spec, or -1, a flag value meaning no precision
3365 was given in that spec. Element 0, corresonding to the format
3366 string itself, will not be used. Element NARGS, corresponding to
3367 no argument, *will* be assigned to in the case that a `%' and `.'
3368 occur after the final format specifier. */
3369 int *precision
= (int *) (alloca((nargs
+ 1) * sizeof (int)));
3372 int arg_intervals
= 0;
3375 /* discarded[I] is 1 if byte I of the format
3376 string was not copied into the output.
3377 It is 2 if byte I was not the first byte of its character. */
3378 char *discarded
= 0;
3380 /* Each element records, for one argument,
3381 the start and end bytepos in the output string,
3382 and whether the argument is a string with intervals.
3383 info[0] is unused. Unused elements have -1 for start. */
3386 int start
, end
, intervals
;
3389 /* It should not be necessary to GCPRO ARGS, because
3390 the caller in the interpreter should take care of that. */
3392 /* Try to determine whether the result should be multibyte.
3393 This is not always right; sometimes the result needs to be multibyte
3394 because of an object that we will pass through prin1,
3395 and in that case, we won't know it here. */
3396 for (n
= 0; n
< nargs
; n
++)
3398 if (STRINGP (args
[n
]) && STRING_MULTIBYTE (args
[n
]))
3400 /* Piggyback on this loop to initialize precision[N]. */
3403 precision
[nargs
] = -1;
3405 CHECK_STRING (args
[0]);
3406 /* We may have to change "%S" to "%s". */
3407 args
[0] = Fcopy_sequence (args
[0]);
3409 /* GC should never happen here, so abort if it does. */
3412 /* If we start out planning a unibyte result,
3413 then discover it has to be multibyte, we jump back to retry.
3414 That can only happen from the first large while loop below. */
3417 format
= SDATA (args
[0]);
3418 format_start
= format
;
3419 end
= format
+ SBYTES (args
[0]);
3422 /* Make room in result for all the non-%-codes in the control string. */
3423 total
= 5 + CONVERTED_BYTE_SIZE (multibyte
, args
[0]) + 1;
3425 /* Allocate the info and discarded tables. */
3427 int nbytes
= (nargs
+1) * sizeof *info
;
3430 info
= (struct info
*) alloca (nbytes
);
3431 bzero (info
, nbytes
);
3432 for (i
= 0; i
<= nargs
; i
++)
3435 SAFE_ALLOCA (discarded
, char *, SBYTES (args
[0]));
3436 bzero (discarded
, SBYTES (args
[0]));
3439 /* Add to TOTAL enough space to hold the converted arguments. */
3442 while (format
!= end
)
3443 if (*format
++ == '%')
3446 int actual_width
= 0;
3447 unsigned char *this_format_start
= format
- 1;
3448 int field_width
= 0;
3450 /* General format specifications look like
3452 '%' [flags] [field-width] [precision] format
3457 field-width ::= [0-9]+
3458 precision ::= '.' [0-9]*
3460 If a field-width is specified, it specifies to which width
3461 the output should be padded with blanks, iff the output
3462 string is shorter than field-width.
3464 If precision is specified, it specifies the number of
3465 digits to print after the '.' for floats, or the max.
3466 number of chars to print from a string. */
3468 while (format
!= end
3469 && (*format
== '-' || *format
== '0' || *format
== '#'
3470 || * format
== ' '))
3473 if (*format
>= '0' && *format
<= '9')
3475 for (field_width
= 0; *format
>= '0' && *format
<= '9'; ++format
)
3476 field_width
= 10 * field_width
+ *format
- '0';
3479 /* N is not incremented for another few lines below, so refer to
3480 element N+1 (which might be precision[NARGS]). */
3484 for (precision
[n
+1] = 0; *format
>= '0' && *format
<= '9'; ++format
)
3485 precision
[n
+1] = 10 * precision
[n
+1] + *format
- '0';
3488 if (format
- this_format_start
+ 1 > longest_format
)
3489 longest_format
= format
- this_format_start
+ 1;
3492 error ("Format string ends in middle of format specifier");
3495 else if (++n
>= nargs
)
3496 error ("Not enough arguments for format string");
3497 else if (*format
== 'S')
3499 /* For `S', prin1 the argument and then treat like a string. */
3500 register Lisp_Object tem
;
3501 tem
= Fprin1_to_string (args
[n
], Qnil
);
3502 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3508 /* If we restart the loop, we should not come here again
3509 because args[n] is now a string and calling
3510 Fprin1_to_string on it produces superflous double
3511 quotes. So, change "%S" to "%s" now. */
3515 else if (SYMBOLP (args
[n
]))
3517 args
[n
] = SYMBOL_NAME (args
[n
]);
3518 if (STRING_MULTIBYTE (args
[n
]) && ! multibyte
)
3525 else if (STRINGP (args
[n
]))
3528 if (*format
!= 's' && *format
!= 'S')
3529 error ("Format specifier doesn't match argument type");
3530 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3531 to be as large as is calculated here. Easy check for
3532 the case PRECISION = 0. */
3533 thissize
= precision
[n
] ? CONVERTED_BYTE_SIZE (multibyte
, args
[n
]) : 0;
3534 actual_width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3536 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3537 else if (INTEGERP (args
[n
]) && *format
!= 's')
3539 /* The following loop assumes the Lisp type indicates
3540 the proper way to pass the argument.
3541 So make sure we have a flonum if the argument should
3543 if (*format
== 'e' || *format
== 'f' || *format
== 'g')
3544 args
[n
] = Ffloat (args
[n
]);
3546 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3547 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3548 error ("Invalid format operation %%%c", *format
);
3553 if (! SINGLE_BYTE_CHAR_P (XINT (args
[n
]))
3554 /* Note: No one can remember why we have to treat
3555 the character 0 as a multibyte character here.
3556 But, until it causes a real problem, let's
3558 || XINT (args
[n
]) == 0)
3565 args
[n
] = Fchar_to_string (args
[n
]);
3566 thissize
= SBYTES (args
[n
]);
3568 else if (! ASCII_BYTE_P (XINT (args
[n
])) && multibyte
)
3571 = Fchar_to_string (Funibyte_char_to_multibyte (args
[n
]));
3572 thissize
= SBYTES (args
[n
]);
3576 else if (FLOATP (args
[n
]) && *format
!= 's')
3578 if (! (*format
== 'e' || *format
== 'f' || *format
== 'g'))
3580 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3581 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3582 error ("Invalid format operation %%%c", *format
);
3583 args
[n
] = Ftruncate (args
[n
], Qnil
);
3586 /* Note that we're using sprintf to print floats,
3587 so we have to take into account what that function
3589 /* Filter out flag value of -1. */
3590 thissize
= (MAX_10_EXP
+ 100
3591 + (precision
[n
] > 0 ? precision
[n
] : 0));
3595 /* Anything but a string, convert to a string using princ. */
3596 register Lisp_Object tem
;
3597 tem
= Fprin1_to_string (args
[n
], Qt
);
3598 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3607 thissize
+= max (0, field_width
- actual_width
);
3608 total
+= thissize
+ 4;
3613 /* Now we can no longer jump to retry.
3614 TOTAL and LONGEST_FORMAT are known for certain. */
3616 this_format
= (unsigned char *) alloca (longest_format
+ 1);
3618 /* Allocate the space for the result.
3619 Note that TOTAL is an overestimate. */
3620 SAFE_ALLOCA (buf
, char *, total
);
3626 /* Scan the format and store result in BUF. */
3627 format
= SDATA (args
[0]);
3628 format_start
= format
;
3629 end
= format
+ SBYTES (args
[0]);
3630 maybe_combine_byte
= 0;
3631 while (format
!= end
)
3637 unsigned char *this_format_start
= format
;
3639 discarded
[format
- format_start
] = 1;
3642 while (index("-0# ", *format
))
3648 discarded
[format
- format_start
] = 1;
3652 minlen
= atoi (format
);
3654 while ((*format
>= '0' && *format
<= '9') || *format
== '.')
3656 discarded
[format
- format_start
] = 1;
3660 if (*format
++ == '%')
3669 discarded
[format
- format_start
- 1] = 1;
3670 info
[n
].start
= nchars
;
3672 if (STRINGP (args
[n
]))
3674 /* handle case (precision[n] >= 0) */
3677 int nbytes
, start
, end
;
3680 /* lisp_string_width ignores a precision of 0, but GNU
3681 libc functions print 0 characters when the precision
3682 is 0. Imitate libc behavior here. Changing
3683 lisp_string_width is the right thing, and will be
3684 done, but meanwhile we work with it. */
3686 if (precision
[n
] == 0)
3687 width
= nchars_string
= nbytes
= 0;
3688 else if (precision
[n
] > 0)
3689 width
= lisp_string_width (args
[n
], precision
[n
], &nchars_string
, &nbytes
);
3691 { /* no precision spec given for this argument */
3692 width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3693 nbytes
= SBYTES (args
[n
]);
3694 nchars_string
= SCHARS (args
[n
]);
3697 /* If spec requires it, pad on right with spaces. */
3698 padding
= minlen
- width
;
3700 while (padding
-- > 0)
3706 info
[n
].start
= start
= nchars
;
3707 nchars
+= nchars_string
;
3712 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3713 && STRING_MULTIBYTE (args
[n
])
3714 && !CHAR_HEAD_P (SREF (args
[n
], 0)))
3715 maybe_combine_byte
= 1;
3717 p
+= copy_text (SDATA (args
[n
]), p
,
3719 STRING_MULTIBYTE (args
[n
]), multibyte
);
3721 info
[n
].end
= nchars
;
3724 while (padding
-- > 0)
3730 /* If this argument has text properties, record where
3731 in the result string it appears. */
3732 if (STRING_INTERVALS (args
[n
]))
3733 info
[n
].intervals
= arg_intervals
= 1;
3735 else if (INTEGERP (args
[n
]) || FLOATP (args
[n
]))
3739 bcopy (this_format_start
, this_format
,
3740 format
- this_format_start
);
3741 this_format
[format
- this_format_start
] = 0;
3743 if (INTEGERP (args
[n
]))
3744 sprintf (p
, this_format
, XINT (args
[n
]));
3746 sprintf (p
, this_format
, XFLOAT_DATA (args
[n
]));
3750 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3751 && !CHAR_HEAD_P (*((unsigned char *) p
)))
3752 maybe_combine_byte
= 1;
3753 this_nchars
= strlen (p
);
3755 p
+= str_to_multibyte (p
, buf
+ total
- 1 - p
, this_nchars
);
3758 nchars
+= this_nchars
;
3759 info
[n
].end
= nchars
;
3763 else if (STRING_MULTIBYTE (args
[0]))
3765 /* Copy a whole multibyte character. */
3768 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3769 && !CHAR_HEAD_P (*format
))
3770 maybe_combine_byte
= 1;
3772 while (! CHAR_HEAD_P (*format
))
3774 discarded
[format
- format_start
] = 2;
3781 /* Convert a single-byte character to multibyte. */
3782 int len
= copy_text (format
, p
, 1, 0, 1);
3789 *p
++ = *format
++, nchars
++;
3792 if (p
> buf
+ total
)
3795 if (maybe_combine_byte
)
3796 nchars
= multibyte_chars_in_text (buf
, p
- buf
);
3797 val
= make_specified_string (buf
, nchars
, p
- buf
, multibyte
);
3799 /* If we allocated BUF with malloc, free it too. */
3802 /* If the format string has text properties, or any of the string
3803 arguments has text properties, set up text properties of the
3806 if (STRING_INTERVALS (args
[0]) || arg_intervals
)
3808 Lisp_Object len
, new_len
, props
;
3809 struct gcpro gcpro1
;
3811 /* Add text properties from the format string. */
3812 len
= make_number (SCHARS (args
[0]));
3813 props
= text_property_list (args
[0], make_number (0), len
, Qnil
);
3818 int bytepos
= 0, position
= 0, translated
= 0, argn
= 1;
3821 /* Adjust the bounds of each text property
3822 to the proper start and end in the output string. */
3824 /* Put the positions in PROPS in increasing order, so that
3825 we can do (effectively) one scan through the position
3826 space of the format string. */
3827 props
= Fnreverse (props
);
3829 /* BYTEPOS is the byte position in the format string,
3830 POSITION is the untranslated char position in it,
3831 TRANSLATED is the translated char position in BUF,
3832 and ARGN is the number of the next arg we will come to. */
3833 for (list
= props
; CONSP (list
); list
= XCDR (list
))
3840 /* First adjust the property start position. */
3841 pos
= XINT (XCAR (item
));
3843 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
3844 up to this position. */
3845 for (; position
< pos
; bytepos
++)
3847 if (! discarded
[bytepos
])
3848 position
++, translated
++;
3849 else if (discarded
[bytepos
] == 1)
3852 if (translated
== info
[argn
].start
)
3854 translated
+= info
[argn
].end
- info
[argn
].start
;
3860 XSETCAR (item
, make_number (translated
));
3862 /* Likewise adjust the property end position. */
3863 pos
= XINT (XCAR (XCDR (item
)));
3865 for (; bytepos
< pos
; bytepos
++)
3867 if (! discarded
[bytepos
])
3868 position
++, translated
++;
3869 else if (discarded
[bytepos
] == 1)
3872 if (translated
== info
[argn
].start
)
3874 translated
+= info
[argn
].end
- info
[argn
].start
;
3880 XSETCAR (XCDR (item
), make_number (translated
));
3883 add_text_properties_from_list (val
, props
, make_number (0));
3886 /* Add text properties from arguments. */
3888 for (n
= 1; n
< nargs
; ++n
)
3889 if (info
[n
].intervals
)
3891 len
= make_number (SCHARS (args
[n
]));
3892 new_len
= make_number (info
[n
].end
- info
[n
].start
);
3893 props
= text_property_list (args
[n
], make_number (0), len
, Qnil
);
3894 extend_property_ranges (props
, len
, new_len
);
3895 /* If successive arguments have properites, be sure that
3896 the value of `composition' property be the copy. */
3897 if (n
> 1 && info
[n
- 1].end
)
3898 make_composition_value_copy (props
);
3899 add_text_properties_from_list (val
, props
,
3900 make_number (info
[n
].start
));
3910 format2 (string1
, arg0
, arg1
)
3912 Lisp_Object arg0
, arg1
;
3914 Lisp_Object args
[3];
3915 args
[0] = build_string (string1
);
3918 return Fformat (3, args
);
3921 DEFUN ("char-equal", Fchar_equal
, Schar_equal
, 2, 2, 0,
3922 doc
: /* Return t if two characters match, optionally ignoring case.
3923 Both arguments must be characters (i.e. integers).
3924 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
3926 register Lisp_Object c1
, c2
;
3932 if (XINT (c1
) == XINT (c2
))
3934 if (NILP (current_buffer
->case_fold_search
))
3937 /* Do these in separate statements,
3938 then compare the variables.
3939 because of the way DOWNCASE uses temp variables. */
3940 i1
= DOWNCASE (XFASTINT (c1
));
3941 i2
= DOWNCASE (XFASTINT (c2
));
3942 return (i1
== i2
? Qt
: Qnil
);
3945 /* Transpose the markers in two regions of the current buffer, and
3946 adjust the ones between them if necessary (i.e.: if the regions
3949 START1, END1 are the character positions of the first region.
3950 START1_BYTE, END1_BYTE are the byte positions.
3951 START2, END2 are the character positions of the second region.
3952 START2_BYTE, END2_BYTE are the byte positions.
3954 Traverses the entire marker list of the buffer to do so, adding an
3955 appropriate amount to some, subtracting from some, and leaving the
3956 rest untouched. Most of this is copied from adjust_markers in insdel.c.
3958 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
3961 transpose_markers (start1
, end1
, start2
, end2
,
3962 start1_byte
, end1_byte
, start2_byte
, end2_byte
)
3963 register int start1
, end1
, start2
, end2
;
3964 register int start1_byte
, end1_byte
, start2_byte
, end2_byte
;
3966 register int amt1
, amt1_byte
, amt2
, amt2_byte
, diff
, diff_byte
, mpos
;
3967 register struct Lisp_Marker
*marker
;
3969 /* Update point as if it were a marker. */
3973 TEMP_SET_PT_BOTH (PT
+ (end2
- end1
),
3974 PT_BYTE
+ (end2_byte
- end1_byte
));
3975 else if (PT
< start2
)
3976 TEMP_SET_PT_BOTH (PT
+ (end2
- start2
) - (end1
- start1
),
3977 (PT_BYTE
+ (end2_byte
- start2_byte
)
3978 - (end1_byte
- start1_byte
)));
3980 TEMP_SET_PT_BOTH (PT
- (start2
- start1
),
3981 PT_BYTE
- (start2_byte
- start1_byte
));
3983 /* We used to adjust the endpoints here to account for the gap, but that
3984 isn't good enough. Even if we assume the caller has tried to move the
3985 gap out of our way, it might still be at start1 exactly, for example;
3986 and that places it `inside' the interval, for our purposes. The amount
3987 of adjustment is nontrivial if there's a `denormalized' marker whose
3988 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
3989 the dirty work to Fmarker_position, below. */
3991 /* The difference between the region's lengths */
3992 diff
= (end2
- start2
) - (end1
- start1
);
3993 diff_byte
= (end2_byte
- start2_byte
) - (end1_byte
- start1_byte
);
3995 /* For shifting each marker in a region by the length of the other
3996 region plus the distance between the regions. */
3997 amt1
= (end2
- start2
) + (start2
- end1
);
3998 amt2
= (end1
- start1
) + (start2
- end1
);
3999 amt1_byte
= (end2_byte
- start2_byte
) + (start2_byte
- end1_byte
);
4000 amt2_byte
= (end1_byte
- start1_byte
) + (start2_byte
- end1_byte
);
4002 for (marker
= BUF_MARKERS (current_buffer
); marker
; marker
= marker
->next
)
4004 mpos
= marker
->bytepos
;
4005 if (mpos
>= start1_byte
&& mpos
< end2_byte
)
4007 if (mpos
< end1_byte
)
4009 else if (mpos
< start2_byte
)
4013 marker
->bytepos
= mpos
;
4015 mpos
= marker
->charpos
;
4016 if (mpos
>= start1
&& mpos
< end2
)
4020 else if (mpos
< start2
)
4025 marker
->charpos
= mpos
;
4029 DEFUN ("transpose-regions", Ftranspose_regions
, Stranspose_regions
, 4, 5, 0,
4030 doc
: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4031 The regions may not be overlapping, because the size of the buffer is
4032 never changed in a transposition.
4034 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4035 any markers that happen to be located in the regions.
4037 Transposing beyond buffer boundaries is an error. */)
4038 (startr1
, endr1
, startr2
, endr2
, leave_markers
)
4039 Lisp_Object startr1
, endr1
, startr2
, endr2
, leave_markers
;
4041 register int start1
, end1
, start2
, end2
;
4042 int start1_byte
, start2_byte
, len1_byte
, len2_byte
;
4043 int gap
, len1
, len_mid
, len2
;
4044 unsigned char *start1_addr
, *start2_addr
, *temp
;
4046 INTERVAL cur_intv
, tmp_interval1
, tmp_interval_mid
, tmp_interval2
;
4047 cur_intv
= BUF_INTERVALS (current_buffer
);
4049 validate_region (&startr1
, &endr1
);
4050 validate_region (&startr2
, &endr2
);
4052 start1
= XFASTINT (startr1
);
4053 end1
= XFASTINT (endr1
);
4054 start2
= XFASTINT (startr2
);
4055 end2
= XFASTINT (endr2
);
4058 /* Swap the regions if they're reversed. */
4061 register int glumph
= start1
;
4069 len1
= end1
- start1
;
4070 len2
= end2
- start2
;
4073 error ("Transposed regions overlap");
4074 else if (start1
== end1
|| start2
== end2
)
4075 error ("Transposed region has length 0");
4077 /* The possibilities are:
4078 1. Adjacent (contiguous) regions, or separate but equal regions
4079 (no, really equal, in this case!), or
4080 2. Separate regions of unequal size.
4082 The worst case is usually No. 2. It means that (aside from
4083 potential need for getting the gap out of the way), there also
4084 needs to be a shifting of the text between the two regions. So
4085 if they are spread far apart, we are that much slower... sigh. */
4087 /* It must be pointed out that the really studly thing to do would
4088 be not to move the gap at all, but to leave it in place and work
4089 around it if necessary. This would be extremely efficient,
4090 especially considering that people are likely to do
4091 transpositions near where they are working interactively, which
4092 is exactly where the gap would be found. However, such code
4093 would be much harder to write and to read. So, if you are
4094 reading this comment and are feeling squirrely, by all means have
4095 a go! I just didn't feel like doing it, so I will simply move
4096 the gap the minimum distance to get it out of the way, and then
4097 deal with an unbroken array. */
4099 /* Make sure the gap won't interfere, by moving it out of the text
4100 we will operate on. */
4101 if (start1
< gap
&& gap
< end2
)
4103 if (gap
- start1
< end2
- gap
)
4109 start1_byte
= CHAR_TO_BYTE (start1
);
4110 start2_byte
= CHAR_TO_BYTE (start2
);
4111 len1_byte
= CHAR_TO_BYTE (end1
) - start1_byte
;
4112 len2_byte
= CHAR_TO_BYTE (end2
) - start2_byte
;
4114 #ifdef BYTE_COMBINING_DEBUG
4117 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4118 len2_byte
, start1
, start1_byte
)
4119 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4120 len1_byte
, end2
, start2_byte
+ len2_byte
)
4121 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4122 len1_byte
, end2
, start2_byte
+ len2_byte
))
4127 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4128 len2_byte
, start1
, start1_byte
)
4129 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4130 len1_byte
, start2
, start2_byte
)
4131 || count_combining_after (BYTE_POS_ADDR (start2_byte
),
4132 len2_byte
, end1
, start1_byte
+ len1_byte
)
4133 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4134 len1_byte
, end2
, start2_byte
+ len2_byte
))
4139 /* Hmmm... how about checking to see if the gap is large
4140 enough to use as the temporary storage? That would avoid an
4141 allocation... interesting. Later, don't fool with it now. */
4143 /* Working without memmove, for portability (sigh), so must be
4144 careful of overlapping subsections of the array... */
4146 if (end1
== start2
) /* adjacent regions */
4148 modify_region (current_buffer
, start1
, end2
);
4149 record_change (start1
, len1
+ len2
);
4151 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4152 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4153 Fset_text_properties (make_number (start1
), make_number (end2
),
4156 /* First region smaller than second. */
4157 if (len1_byte
< len2_byte
)
4161 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4163 /* Don't precompute these addresses. We have to compute them
4164 at the last minute, because the relocating allocator might
4165 have moved the buffer around during the xmalloc. */
4166 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4167 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4169 bcopy (start2_addr
, temp
, len2_byte
);
4170 bcopy (start1_addr
, start1_addr
+ len2_byte
, len1_byte
);
4171 bcopy (temp
, start1_addr
, len2_byte
);
4175 /* First region not smaller than second. */
4179 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4180 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4181 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4182 bcopy (start1_addr
, temp
, len1_byte
);
4183 bcopy (start2_addr
, start1_addr
, len2_byte
);
4184 bcopy (temp
, start1_addr
+ len2_byte
, len1_byte
);
4187 graft_intervals_into_buffer (tmp_interval1
, start1
+ len2
,
4188 len1
, current_buffer
, 0);
4189 graft_intervals_into_buffer (tmp_interval2
, start1
,
4190 len2
, current_buffer
, 0);
4191 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4192 update_compositions (start1
+ len2
, end2
, CHECK_TAIL
);
4194 /* Non-adjacent regions, because end1 != start2, bleagh... */
4197 len_mid
= start2_byte
- (start1_byte
+ len1_byte
);
4199 if (len1_byte
== len2_byte
)
4200 /* Regions are same size, though, how nice. */
4204 modify_region (current_buffer
, start1
, end1
);
4205 modify_region (current_buffer
, start2
, end2
);
4206 record_change (start1
, len1
);
4207 record_change (start2
, len2
);
4208 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4209 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4210 Fset_text_properties (make_number (start1
), make_number (end1
),
4212 Fset_text_properties (make_number (start2
), make_number (end2
),
4215 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4216 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4217 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4218 bcopy (start1_addr
, temp
, len1_byte
);
4219 bcopy (start2_addr
, start1_addr
, len2_byte
);
4220 bcopy (temp
, start2_addr
, len1_byte
);
4223 graft_intervals_into_buffer (tmp_interval1
, start2
,
4224 len1
, current_buffer
, 0);
4225 graft_intervals_into_buffer (tmp_interval2
, start1
,
4226 len2
, current_buffer
, 0);
4229 else if (len1_byte
< len2_byte
) /* Second region larger than first */
4230 /* Non-adjacent & unequal size, area between must also be shifted. */
4234 modify_region (current_buffer
, start1
, end2
);
4235 record_change (start1
, (end2
- start1
));
4236 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4237 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4238 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4239 Fset_text_properties (make_number (start1
), make_number (end2
),
4242 /* holds region 2 */
4243 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4244 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4245 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4246 bcopy (start2_addr
, temp
, len2_byte
);
4247 bcopy (start1_addr
, start1_addr
+ len_mid
+ len2_byte
, len1_byte
);
4248 safe_bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4249 bcopy (temp
, start1_addr
, len2_byte
);
4252 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4253 len1
, current_buffer
, 0);
4254 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4255 len_mid
, current_buffer
, 0);
4256 graft_intervals_into_buffer (tmp_interval2
, start1
,
4257 len2
, current_buffer
, 0);
4260 /* Second region smaller than first. */
4264 record_change (start1
, (end2
- start1
));
4265 modify_region (current_buffer
, start1
, end2
);
4267 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4268 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4269 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4270 Fset_text_properties (make_number (start1
), make_number (end2
),
4273 /* holds region 1 */
4274 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4275 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4276 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4277 bcopy (start1_addr
, temp
, len1_byte
);
4278 bcopy (start2_addr
, start1_addr
, len2_byte
);
4279 bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4280 bcopy (temp
, start1_addr
+ len2_byte
+ len_mid
, len1_byte
);
4283 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4284 len1
, current_buffer
, 0);
4285 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4286 len_mid
, current_buffer
, 0);
4287 graft_intervals_into_buffer (tmp_interval2
, start1
,
4288 len2
, current_buffer
, 0);
4291 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4292 update_compositions (end2
- len1
, end2
, CHECK_BORDER
);
4295 /* When doing multiple transpositions, it might be nice
4296 to optimize this. Perhaps the markers in any one buffer
4297 should be organized in some sorted data tree. */
4298 if (NILP (leave_markers
))
4300 transpose_markers (start1
, end1
, start2
, end2
,
4301 start1_byte
, start1_byte
+ len1_byte
,
4302 start2_byte
, start2_byte
+ len2_byte
);
4303 fix_start_end_in_overlays (start1
, end2
);
4315 Qbuffer_access_fontify_functions
4316 = intern ("buffer-access-fontify-functions");
4317 staticpro (&Qbuffer_access_fontify_functions
);
4319 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion
,
4320 doc
: /* Non-nil means text motion commands don't notice fields. */);
4321 Vinhibit_field_text_motion
= Qnil
;
4323 DEFVAR_LISP ("buffer-access-fontify-functions",
4324 &Vbuffer_access_fontify_functions
,
4325 doc
: /* List of functions called by `buffer-substring' to fontify if necessary.
4326 Each function is called with two arguments which specify the range
4327 of the buffer being accessed. */);
4328 Vbuffer_access_fontify_functions
= Qnil
;
4332 extern Lisp_Object Vprin1_to_string_buffer
;
4333 obuf
= Fcurrent_buffer ();
4334 /* Do this here, because init_buffer_once is too early--it won't work. */
4335 Fset_buffer (Vprin1_to_string_buffer
);
4336 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4337 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
4342 DEFVAR_LISP ("buffer-access-fontified-property",
4343 &Vbuffer_access_fontified_property
,
4344 doc
: /* Property which (if non-nil) indicates text has been fontified.
4345 `buffer-substring' need not call the `buffer-access-fontify-functions'
4346 functions if all the text being accessed has this property. */);
4347 Vbuffer_access_fontified_property
= Qnil
;
4349 DEFVAR_LISP ("system-name", &Vsystem_name
,
4350 doc
: /* The name of the machine Emacs is running on. */);
4352 DEFVAR_LISP ("user-full-name", &Vuser_full_name
,
4353 doc
: /* The full name of the user logged in. */);
4355 DEFVAR_LISP ("user-login-name", &Vuser_login_name
,
4356 doc
: /* The user's name, taken from environment variables if possible. */);
4358 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name
,
4359 doc
: /* The user's name, based upon the real uid only. */);
4361 DEFVAR_LISP ("operating-system-release", &Voperating_system_release
,
4362 doc
: /* The release of the operating system Emacs is running on. */);
4364 defsubr (&Spropertize
);
4365 defsubr (&Schar_equal
);
4366 defsubr (&Sgoto_char
);
4367 defsubr (&Sstring_to_char
);
4368 defsubr (&Schar_to_string
);
4369 defsubr (&Sbuffer_substring
);
4370 defsubr (&Sbuffer_substring_no_properties
);
4371 defsubr (&Sbuffer_string
);
4373 defsubr (&Spoint_marker
);
4374 defsubr (&Smark_marker
);
4376 defsubr (&Sregion_beginning
);
4377 defsubr (&Sregion_end
);
4379 staticpro (&Qfield
);
4380 Qfield
= intern ("field");
4381 staticpro (&Qboundary
);
4382 Qboundary
= intern ("boundary");
4383 defsubr (&Sfield_beginning
);
4384 defsubr (&Sfield_end
);
4385 defsubr (&Sfield_string
);
4386 defsubr (&Sfield_string_no_properties
);
4387 defsubr (&Sdelete_field
);
4388 defsubr (&Sconstrain_to_field
);
4390 defsubr (&Sline_beginning_position
);
4391 defsubr (&Sline_end_position
);
4393 /* defsubr (&Smark); */
4394 /* defsubr (&Sset_mark); */
4395 defsubr (&Ssave_excursion
);
4396 defsubr (&Ssave_current_buffer
);
4398 defsubr (&Sbufsize
);
4399 defsubr (&Spoint_max
);
4400 defsubr (&Spoint_min
);
4401 defsubr (&Spoint_min_marker
);
4402 defsubr (&Spoint_max_marker
);
4403 defsubr (&Sgap_position
);
4404 defsubr (&Sgap_size
);
4405 defsubr (&Sposition_bytes
);
4406 defsubr (&Sbyte_to_position
);
4412 defsubr (&Sfollowing_char
);
4413 defsubr (&Sprevious_char
);
4414 defsubr (&Schar_after
);
4415 defsubr (&Schar_before
);
4417 defsubr (&Sinsert_before_markers
);
4418 defsubr (&Sinsert_and_inherit
);
4419 defsubr (&Sinsert_and_inherit_before_markers
);
4420 defsubr (&Sinsert_char
);
4422 defsubr (&Suser_login_name
);
4423 defsubr (&Suser_real_login_name
);
4424 defsubr (&Suser_uid
);
4425 defsubr (&Suser_real_uid
);
4426 defsubr (&Suser_full_name
);
4427 defsubr (&Semacs_pid
);
4428 defsubr (&Scurrent_time
);
4429 defsubr (&Sget_internal_run_time
);
4430 defsubr (&Sformat_time_string
);
4431 defsubr (&Sfloat_time
);
4432 defsubr (&Sdecode_time
);
4433 defsubr (&Sencode_time
);
4434 defsubr (&Scurrent_time_string
);
4435 defsubr (&Scurrent_time_zone
);
4436 defsubr (&Sset_time_zone_rule
);
4437 defsubr (&Ssystem_name
);
4438 defsubr (&Smessage
);
4439 defsubr (&Smessage_box
);
4440 defsubr (&Smessage_or_box
);
4441 defsubr (&Scurrent_message
);
4444 defsubr (&Sinsert_buffer_substring
);
4445 defsubr (&Scompare_buffer_substrings
);
4446 defsubr (&Ssubst_char_in_region
);
4447 defsubr (&Stranslate_region_internal
);
4448 defsubr (&Sdelete_region
);
4449 defsubr (&Sdelete_and_extract_region
);
4451 defsubr (&Snarrow_to_region
);
4452 defsubr (&Ssave_restriction
);
4453 defsubr (&Stranspose_regions
);
4456 /* arch-tag: fc3827d8-6f60-4067-b11e-c3218031b018
4457 (do not change this comment) */