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"
59 #include "blockinput.h"
63 #define MAX_10_EXP DBL_MAX_10_EXP
65 #define MAX_10_EXP 310
73 extern char **environ
;
76 #define TM_YEAR_BASE 1900
78 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
79 asctime to have well-defined behavior. */
80 #ifndef TM_YEAR_IN_ASCTIME_RANGE
81 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
82 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
85 extern size_t emacs_strftimeu
P_ ((char *, size_t, const char *,
86 const struct tm
*, int));
87 static int tm_diff
P_ ((struct tm
*, struct tm
*));
88 static void find_field
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, int *, Lisp_Object
, int *));
89 static void update_buffer_properties
P_ ((int, int));
90 static Lisp_Object region_limit
P_ ((int));
91 int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
92 static size_t emacs_memftimeu
P_ ((char *, size_t, const char *,
93 size_t, const struct tm
*, int));
94 static void general_insert_function
P_ ((void (*) (const unsigned char *, int),
95 void (*) (Lisp_Object
, int, int, int,
97 int, int, Lisp_Object
*));
98 static Lisp_Object subst_char_in_region_unwind
P_ ((Lisp_Object
));
99 static Lisp_Object subst_char_in_region_unwind_1
P_ ((Lisp_Object
));
100 static void transpose_markers
P_ ((int, int, int, int, int, int, int, int));
103 extern char *index
P_ ((const char *, int));
106 Lisp_Object Vbuffer_access_fontify_functions
;
107 Lisp_Object Qbuffer_access_fontify_functions
;
108 Lisp_Object Vbuffer_access_fontified_property
;
110 Lisp_Object Fuser_full_name
P_ ((Lisp_Object
));
112 /* Non-nil means don't stop at field boundary in text motion commands. */
114 Lisp_Object Vinhibit_field_text_motion
;
116 /* Some static data, and a function to initialize it for each run */
118 Lisp_Object Vsystem_name
;
119 Lisp_Object Vuser_real_login_name
; /* login name of current user ID */
120 Lisp_Object Vuser_full_name
; /* full name of current user */
121 Lisp_Object Vuser_login_name
; /* user name from LOGNAME or USER */
122 Lisp_Object Voperating_system_release
; /* Operating System Release */
124 /* Symbol for the text property used to mark fields. */
128 /* A special value for Qfield properties. */
130 Lisp_Object Qboundary
;
137 register unsigned char *p
;
138 struct passwd
*pw
; /* password entry for the current user */
141 /* Set up system_name even when dumping. */
145 /* Don't bother with this on initial start when just dumping out */
148 #endif /* not CANNOT_DUMP */
150 pw
= (struct passwd
*) getpwuid (getuid ());
152 /* We let the real user name default to "root" because that's quite
153 accurate on MSDOG and because it lets Emacs find the init file.
154 (The DVX libraries override the Djgpp libraries here.) */
155 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "root");
157 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "unknown");
160 /* Get the effective user name, by consulting environment variables,
161 or the effective uid if those are unset. */
162 user_name
= (char *) getenv ("LOGNAME");
165 user_name
= (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
166 #else /* WINDOWSNT */
167 user_name
= (char *) getenv ("USER");
168 #endif /* WINDOWSNT */
171 pw
= (struct passwd
*) getpwuid (geteuid ());
172 user_name
= (char *) (pw
? pw
->pw_name
: "unknown");
174 Vuser_login_name
= build_string (user_name
);
176 /* If the user name claimed in the environment vars differs from
177 the real uid, use the claimed name to find the full name. */
178 tem
= Fstring_equal (Vuser_login_name
, Vuser_real_login_name
);
179 Vuser_full_name
= Fuser_full_name (NILP (tem
)? make_number (geteuid())
182 p
= (unsigned char *) getenv ("NAME");
184 Vuser_full_name
= build_string (p
);
185 else if (NILP (Vuser_full_name
))
186 Vuser_full_name
= build_string ("unknown");
188 #ifdef HAVE_SYS_UTSNAME_H
192 Voperating_system_release
= build_string (uts
.release
);
195 Voperating_system_release
= Qnil
;
199 DEFUN ("char-to-string", Fchar_to_string
, Schar_to_string
, 1, 1, 0,
200 doc
: /* Convert arg CHAR to a string containing that character.
201 usage: (char-to-string CHAR) */)
203 Lisp_Object character
;
206 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
208 CHECK_NUMBER (character
);
210 len
= (SINGLE_BYTE_CHAR_P (XFASTINT (character
))
211 ? (*str
= (unsigned char)(XFASTINT (character
)), 1)
212 : char_to_string (XFASTINT (character
), str
));
213 return make_string_from_bytes (str
, 1, len
);
216 DEFUN ("string-to-char", Fstring_to_char
, Sstring_to_char
, 1, 1, 0,
217 doc
: /* Convert arg STRING to a character, the first character of that string.
218 A multibyte character is handled correctly. */)
220 register Lisp_Object string
;
222 register Lisp_Object val
;
223 CHECK_STRING (string
);
226 if (STRING_MULTIBYTE (string
))
227 XSETFASTINT (val
, STRING_CHAR (SDATA (string
), SBYTES (string
)));
229 XSETFASTINT (val
, SREF (string
, 0));
232 XSETFASTINT (val
, 0);
237 buildmark (charpos
, bytepos
)
238 int charpos
, bytepos
;
240 register Lisp_Object mark
;
241 mark
= Fmake_marker ();
242 set_marker_both (mark
, Qnil
, charpos
, bytepos
);
246 DEFUN ("point", Fpoint
, Spoint
, 0, 0, 0,
247 doc
: /* Return value of point, as an integer.
248 Beginning of buffer is position (point-min). */)
252 XSETFASTINT (temp
, PT
);
256 DEFUN ("point-marker", Fpoint_marker
, Spoint_marker
, 0, 0, 0,
257 doc
: /* Return value of point, as a marker object. */)
260 return buildmark (PT
, PT_BYTE
);
264 clip_to_bounds (lower
, num
, upper
)
265 int lower
, num
, upper
;
269 else if (num
> upper
)
275 DEFUN ("goto-char", Fgoto_char
, Sgoto_char
, 1, 1, "NGoto char: ",
276 doc
: /* Set point to POSITION, a number or marker.
277 Beginning of buffer is position (point-min), end is (point-max). */)
279 register Lisp_Object position
;
283 if (MARKERP (position
)
284 && current_buffer
== XMARKER (position
)->buffer
)
286 pos
= marker_position (position
);
288 SET_PT_BOTH (BEGV
, BEGV_BYTE
);
290 SET_PT_BOTH (ZV
, ZV_BYTE
);
292 SET_PT_BOTH (pos
, marker_byte_position (position
));
297 CHECK_NUMBER_COERCE_MARKER (position
);
299 pos
= clip_to_bounds (BEGV
, XINT (position
), ZV
);
305 /* Return the start or end position of the region.
306 BEGINNINGP non-zero means return the start.
307 If there is no region active, signal an error. */
310 region_limit (beginningp
)
313 extern Lisp_Object Vmark_even_if_inactive
; /* Defined in callint.c. */
316 if (!NILP (Vtransient_mark_mode
)
317 && NILP (Vmark_even_if_inactive
)
318 && NILP (current_buffer
->mark_active
))
319 xsignal0 (Qmark_inactive
);
321 m
= Fmarker_position (current_buffer
->mark
);
323 error ("The mark is not set now, so there is no region");
325 if ((PT
< XFASTINT (m
)) == (beginningp
!= 0))
326 m
= make_number (PT
);
330 DEFUN ("region-beginning", Fregion_beginning
, Sregion_beginning
, 0, 0, 0,
331 doc
: /* Return position of beginning of region, as an integer. */)
334 return region_limit (1);
337 DEFUN ("region-end", Fregion_end
, Sregion_end
, 0, 0, 0,
338 doc
: /* Return position of end of region, as an integer. */)
341 return region_limit (0);
344 DEFUN ("mark-marker", Fmark_marker
, Smark_marker
, 0, 0, 0,
345 doc
: /* Return this buffer's mark, as a marker object.
346 Watch out! Moving this marker changes the mark position.
347 If you set the marker not to point anywhere, the buffer will have no mark. */)
350 return current_buffer
->mark
;
354 /* Find all the overlays in the current buffer that touch position POS.
355 Return the number found, and store them in a vector in VEC
359 overlays_around (pos
, vec
, len
)
364 Lisp_Object overlay
, start
, end
;
365 struct Lisp_Overlay
*tail
;
366 int startpos
, endpos
;
369 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
371 XSETMISC (overlay
, tail
);
373 end
= OVERLAY_END (overlay
);
374 endpos
= OVERLAY_POSITION (end
);
377 start
= OVERLAY_START (overlay
);
378 startpos
= OVERLAY_POSITION (start
);
383 /* Keep counting overlays even if we can't return them all. */
388 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
390 XSETMISC (overlay
, tail
);
392 start
= OVERLAY_START (overlay
);
393 startpos
= OVERLAY_POSITION (start
);
396 end
= OVERLAY_END (overlay
);
397 endpos
= OVERLAY_POSITION (end
);
409 /* Return the value of property PROP, in OBJECT at POSITION.
410 It's the value of PROP that a char inserted at POSITION would get.
411 OBJECT is optional and defaults to the current buffer.
412 If OBJECT is a buffer, then overlay properties are considered as well as
414 If OBJECT is a window, then that window's buffer is used, but
415 window-specific overlays are considered only if they are associated
418 get_pos_property (position
, prop
, object
)
419 Lisp_Object position
, object
;
420 register Lisp_Object prop
;
422 CHECK_NUMBER_COERCE_MARKER (position
);
425 XSETBUFFER (object
, current_buffer
);
426 else if (WINDOWP (object
))
427 object
= XWINDOW (object
)->buffer
;
429 if (!BUFFERP (object
))
430 /* pos-property only makes sense in buffers right now, since strings
431 have no overlays and no notion of insertion for which stickiness
433 return Fget_text_property (position
, prop
, object
);
436 int posn
= XINT (position
);
438 Lisp_Object
*overlay_vec
, tem
;
439 struct buffer
*obuf
= current_buffer
;
441 set_buffer_temp (XBUFFER (object
));
443 /* First try with room for 40 overlays. */
445 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
446 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
448 /* If there are more than 40,
449 make enough space for all, and try again. */
452 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
453 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
455 noverlays
= sort_overlays (overlay_vec
, noverlays
, NULL
);
457 set_buffer_temp (obuf
);
459 /* Now check the overlays in order of decreasing priority. */
460 while (--noverlays
>= 0)
462 Lisp_Object ol
= overlay_vec
[noverlays
];
463 tem
= Foverlay_get (ol
, prop
);
466 /* Check the overlay is indeed active at point. */
467 Lisp_Object start
= OVERLAY_START (ol
), finish
= OVERLAY_END (ol
);
468 if ((OVERLAY_POSITION (start
) == posn
469 && XMARKER (start
)->insertion_type
== 1)
470 || (OVERLAY_POSITION (finish
) == posn
471 && XMARKER (finish
)->insertion_type
== 0))
472 ; /* The overlay will not cover a char inserted at point. */
480 { /* Now check the text-properties. */
481 int stickiness
= text_property_stickiness (prop
, position
, object
);
483 return Fget_text_property (position
, prop
, object
);
484 else if (stickiness
< 0
485 && XINT (position
) > BUF_BEGV (XBUFFER (object
)))
486 return Fget_text_property (make_number (XINT (position
) - 1),
494 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
495 the value of point is used instead. If BEG or END is null,
496 means don't store the beginning or end of the field.
498 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
499 results; they do not effect boundary behavior.
501 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
502 position of a field, then the beginning of the previous field is
503 returned instead of the beginning of POS's field (since the end of a
504 field is actually also the beginning of the next input field, this
505 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
506 true case, if two fields are separated by a field with the special
507 value `boundary', and POS lies within it, then the two separated
508 fields are considered to be adjacent, and POS between them, when
509 finding the beginning and ending of the "merged" field.
511 Either BEG or END may be 0, in which case the corresponding value
515 find_field (pos
, merge_at_boundary
, beg_limit
, beg
, end_limit
, end
)
517 Lisp_Object merge_at_boundary
;
518 Lisp_Object beg_limit
, end_limit
;
521 /* Fields right before and after the point. */
522 Lisp_Object before_field
, after_field
;
523 /* 1 if POS counts as the start of a field. */
524 int at_field_start
= 0;
525 /* 1 if POS counts as the end of a field. */
526 int at_field_end
= 0;
529 XSETFASTINT (pos
, PT
);
531 CHECK_NUMBER_COERCE_MARKER (pos
);
534 = get_char_property_and_overlay (pos
, Qfield
, Qnil
, NULL
);
536 = (XFASTINT (pos
) > BEGV
537 ? get_char_property_and_overlay (make_number (XINT (pos
) - 1),
539 /* Using nil here would be a more obvious choice, but it would
540 fail when the buffer starts with a non-sticky field. */
543 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
544 and POS is at beginning of a field, which can also be interpreted
545 as the end of the previous field. Note that the case where if
546 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
547 more natural one; then we avoid treating the beginning of a field
549 if (NILP (merge_at_boundary
))
551 Lisp_Object field
= get_pos_property (pos
, Qfield
, Qnil
);
552 if (!EQ (field
, after_field
))
554 if (!EQ (field
, before_field
))
556 if (NILP (field
) && at_field_start
&& at_field_end
)
557 /* If an inserted char would have a nil field while the surrounding
558 text is non-nil, we're probably not looking at a
559 zero-length field, but instead at a non-nil field that's
560 not intended for editing (such as comint's prompts). */
561 at_field_end
= at_field_start
= 0;
564 /* Note about special `boundary' fields:
566 Consider the case where the point (`.') is between the fields `x' and `y':
570 In this situation, if merge_at_boundary is true, we consider the
571 `x' and `y' fields as forming one big merged field, and so the end
572 of the field is the end of `y'.
574 However, if `x' and `y' are separated by a special `boundary' field
575 (a field with a `field' char-property of 'boundary), then we ignore
576 this special field when merging adjacent fields. Here's the same
577 situation, but with a `boundary' field between the `x' and `y' fields:
581 Here, if point is at the end of `x', the beginning of `y', or
582 anywhere in-between (within the `boundary' field), we merge all
583 three fields and consider the beginning as being the beginning of
584 the `x' field, and the end as being the end of the `y' field. */
589 /* POS is at the edge of a field, and we should consider it as
590 the beginning of the following field. */
591 *beg
= XFASTINT (pos
);
593 /* Find the previous field boundary. */
596 if (!NILP (merge_at_boundary
) && EQ (before_field
, Qboundary
))
597 /* Skip a `boundary' field. */
598 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
601 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
603 *beg
= NILP (p
) ? BEGV
: XFASTINT (p
);
610 /* POS is at the edge of a field, and we should consider it as
611 the end of the previous field. */
612 *end
= XFASTINT (pos
);
614 /* Find the next field boundary. */
616 if (!NILP (merge_at_boundary
) && EQ (after_field
, Qboundary
))
617 /* Skip a `boundary' field. */
618 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
621 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
623 *end
= NILP (pos
) ? ZV
: XFASTINT (pos
);
629 DEFUN ("delete-field", Fdelete_field
, Sdelete_field
, 0, 1, 0,
630 doc
: /* Delete the field surrounding POS.
631 A field is a region of text with the same `field' property.
632 If POS is nil, the value of point is used for POS. */)
637 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
639 del_range (beg
, end
);
643 DEFUN ("field-string", Ffield_string
, Sfield_string
, 0, 1, 0,
644 doc
: /* Return the contents of the field surrounding POS as a string.
645 A field is a region of text with the same `field' property.
646 If POS is nil, the value of point is used for POS. */)
651 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
652 return make_buffer_string (beg
, end
, 1);
655 DEFUN ("field-string-no-properties", Ffield_string_no_properties
, Sfield_string_no_properties
, 0, 1, 0,
656 doc
: /* Return the contents of the field around POS, without text-properties.
657 A field is a region of text with the same `field' property.
658 If POS is nil, the value of point is used for POS. */)
663 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
664 return make_buffer_string (beg
, end
, 0);
667 DEFUN ("field-beginning", Ffield_beginning
, Sfield_beginning
, 0, 3, 0,
668 doc
: /* Return the beginning of the field surrounding POS.
669 A field is a region of text with the same `field' property.
670 If POS is nil, the value of point is used for POS.
671 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
672 field, then the beginning of the *previous* field is returned.
673 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
674 is before LIMIT, then LIMIT will be returned instead. */)
675 (pos
, escape_from_edge
, limit
)
676 Lisp_Object pos
, escape_from_edge
, limit
;
679 find_field (pos
, escape_from_edge
, limit
, &beg
, Qnil
, 0);
680 return make_number (beg
);
683 DEFUN ("field-end", Ffield_end
, Sfield_end
, 0, 3, 0,
684 doc
: /* Return the end of the field surrounding POS.
685 A field is a region of text with the same `field' property.
686 If POS is nil, the value of point is used for POS.
687 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
688 then the end of the *following* field is returned.
689 If LIMIT is non-nil, it is a buffer position; if the end of the field
690 is after LIMIT, then LIMIT will be returned instead. */)
691 (pos
, escape_from_edge
, limit
)
692 Lisp_Object pos
, escape_from_edge
, limit
;
695 find_field (pos
, escape_from_edge
, Qnil
, 0, limit
, &end
);
696 return make_number (end
);
699 DEFUN ("constrain-to-field", Fconstrain_to_field
, Sconstrain_to_field
, 2, 5, 0,
700 doc
: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
702 A field is a region of text with the same `field' property.
703 If NEW-POS is nil, then the current point is used instead, and set to the
704 constrained position if that is different.
706 If OLD-POS is at the boundary of two fields, then the allowable
707 positions for NEW-POS depends on the value of the optional argument
708 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
709 constrained to the field that has the same `field' char-property
710 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
711 is non-nil, NEW-POS is constrained to the union of the two adjacent
712 fields. Additionally, if two fields are separated by another field with
713 the special value `boundary', then any point within this special field is
714 also considered to be `on the boundary'.
716 If the optional argument ONLY-IN-LINE is non-nil and constraining
717 NEW-POS would move it to a different line, NEW-POS is returned
718 unconstrained. This useful for commands that move by line, like
719 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
720 only in the case where they can still move to the right line.
722 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
723 a non-nil property of that name, then any field boundaries are ignored.
725 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
726 (new_pos
, old_pos
, escape_from_edge
, only_in_line
, inhibit_capture_property
)
727 Lisp_Object new_pos
, old_pos
;
728 Lisp_Object escape_from_edge
, only_in_line
, inhibit_capture_property
;
730 /* If non-zero, then the original point, before re-positioning. */
733 Lisp_Object prev_old
, prev_new
;
736 /* Use the current point, and afterwards, set it. */
739 XSETFASTINT (new_pos
, PT
);
742 CHECK_NUMBER_COERCE_MARKER (new_pos
);
743 CHECK_NUMBER_COERCE_MARKER (old_pos
);
745 fwd
= (XFASTINT (new_pos
) > XFASTINT (old_pos
));
747 prev_old
= make_number (XFASTINT (old_pos
) - 1);
748 prev_new
= make_number (XFASTINT (new_pos
) - 1);
750 if (NILP (Vinhibit_field_text_motion
)
751 && !EQ (new_pos
, old_pos
)
752 && (!NILP (Fget_char_property (new_pos
, Qfield
, Qnil
))
753 || !NILP (Fget_char_property (old_pos
, Qfield
, Qnil
))
754 /* To recognize field boundaries, we must also look at the
755 previous positions; we could use `get_pos_property'
756 instead, but in itself that would fail inside non-sticky
757 fields (like comint prompts). */
758 || (XFASTINT (new_pos
) > BEGV
759 && !NILP (Fget_char_property (prev_new
, Qfield
, Qnil
)))
760 || (XFASTINT (old_pos
) > BEGV
761 && !NILP (Fget_char_property (prev_old
, Qfield
, Qnil
))))
762 && (NILP (inhibit_capture_property
)
763 /* Field boundaries are again a problem; but now we must
764 decide the case exactly, so we need to call
765 `get_pos_property' as well. */
766 || (NILP (get_pos_property (old_pos
, inhibit_capture_property
, Qnil
))
767 && (XFASTINT (old_pos
) <= BEGV
768 || NILP (Fget_char_property (old_pos
, inhibit_capture_property
, Qnil
))
769 || NILP (Fget_char_property (prev_old
, inhibit_capture_property
, Qnil
))))))
770 /* It is possible that NEW_POS is not within the same field as
771 OLD_POS; try to move NEW_POS so that it is. */
774 Lisp_Object field_bound
;
777 field_bound
= Ffield_end (old_pos
, escape_from_edge
, new_pos
);
779 field_bound
= Ffield_beginning (old_pos
, escape_from_edge
, new_pos
);
781 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
782 other side of NEW_POS, which would mean that NEW_POS is
783 already acceptable, and it's not necessary to constrain it
785 ((XFASTINT (field_bound
) < XFASTINT (new_pos
)) ? fwd
: !fwd
)
786 /* NEW_POS should be constrained, but only if either
787 ONLY_IN_LINE is nil (in which case any constraint is OK),
788 or NEW_POS and FIELD_BOUND are on the same line (in which
789 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
790 && (NILP (only_in_line
)
791 /* This is the ONLY_IN_LINE case, check that NEW_POS and
792 FIELD_BOUND are on the same line by seeing whether
793 there's an intervening newline or not. */
794 || (scan_buffer ('\n',
795 XFASTINT (new_pos
), XFASTINT (field_bound
),
796 fwd
? -1 : 1, &shortage
, 1),
798 /* Constrain NEW_POS to FIELD_BOUND. */
799 new_pos
= field_bound
;
801 if (orig_point
&& XFASTINT (new_pos
) != orig_point
)
802 /* The NEW_POS argument was originally nil, so automatically set PT. */
803 SET_PT (XFASTINT (new_pos
));
810 DEFUN ("line-beginning-position",
811 Fline_beginning_position
, Sline_beginning_position
, 0, 1, 0,
812 doc
: /* Return the character position of the first character on the current line.
813 With argument N not nil or 1, move forward N - 1 lines first.
814 If scan reaches end of buffer, return that position.
816 This function constrains the returned position to the current field
817 unless that would be on a different line than the original,
818 unconstrained result. If N is nil or 1, and a front-sticky field
819 starts at point, the scan stops as soon as it starts. To ignore field
820 boundaries bind `inhibit-field-text-motion' to t.
822 This function does not move point. */)
826 int orig
, orig_byte
, end
;
827 int count
= SPECPDL_INDEX ();
828 specbind (Qinhibit_point_motion_hooks
, Qt
);
837 Fforward_line (make_number (XINT (n
) - 1));
840 SET_PT_BOTH (orig
, orig_byte
);
842 unbind_to (count
, Qnil
);
844 /* Return END constrained to the current input field. */
845 return Fconstrain_to_field (make_number (end
), make_number (orig
),
846 XINT (n
) != 1 ? Qt
: Qnil
,
850 DEFUN ("line-end-position", Fline_end_position
, Sline_end_position
, 0, 1, 0,
851 doc
: /* Return the character position of the last character on the current line.
852 With argument N not nil or 1, move forward N - 1 lines first.
853 If scan reaches end of buffer, return that position.
855 This function constrains the returned position to the current field
856 unless that would be on a different line than the original,
857 unconstrained result. If N is nil or 1, and a rear-sticky field ends
858 at point, the scan stops as soon as it starts. To ignore field
859 boundaries bind `inhibit-field-text-motion' to t.
861 This function does not move point. */)
873 end_pos
= find_before_next_newline (orig
, 0, XINT (n
) - (XINT (n
) <= 0));
875 /* Return END_POS constrained to the current input field. */
876 return Fconstrain_to_field (make_number (end_pos
), make_number (orig
),
882 save_excursion_save ()
884 int visible
= (XBUFFER (XWINDOW (selected_window
)->buffer
)
887 return Fcons (Fpoint_marker (),
888 Fcons (Fcopy_marker (current_buffer
->mark
, Qnil
),
889 Fcons (visible
? Qt
: Qnil
,
890 Fcons (current_buffer
->mark_active
,
895 save_excursion_restore (info
)
898 Lisp_Object tem
, tem1
, omark
, nmark
;
899 struct gcpro gcpro1
, gcpro2
, gcpro3
;
902 tem
= Fmarker_buffer (XCAR (info
));
903 /* If buffer being returned to is now deleted, avoid error */
904 /* Otherwise could get error here while unwinding to top level
906 /* In that case, Fmarker_buffer returns nil now. */
910 omark
= nmark
= Qnil
;
911 GCPRO3 (info
, omark
, nmark
);
918 unchain_marker (XMARKER (tem
));
923 omark
= Fmarker_position (current_buffer
->mark
);
924 Fset_marker (current_buffer
->mark
, tem
, Fcurrent_buffer ());
925 nmark
= Fmarker_position (tem
);
926 unchain_marker (XMARKER (tem
));
930 visible_p
= !NILP (XCAR (info
));
932 #if 0 /* We used to make the current buffer visible in the selected window
933 if that was true previously. That avoids some anomalies.
934 But it creates others, and it wasn't documented, and it is simpler
935 and cleaner never to alter the window/buffer connections. */
938 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
939 Fswitch_to_buffer (Fcurrent_buffer (), Qnil
);
945 tem1
= current_buffer
->mark_active
;
946 current_buffer
->mark_active
= tem
;
948 if (!NILP (Vrun_hooks
))
950 /* If mark is active now, and either was not active
951 or was at a different place, run the activate hook. */
952 if (! NILP (current_buffer
->mark_active
))
954 if (! EQ (omark
, nmark
))
955 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
957 /* If mark has ceased to be active, run deactivate hook. */
958 else if (! NILP (tem1
))
959 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
962 /* If buffer was visible in a window, and a different window was
963 selected, and the old selected window is still showing this
964 buffer, restore point in that window. */
967 && !EQ (tem
, selected_window
)
968 && (tem1
= XWINDOW (tem
)->buffer
,
969 (/* Window is live... */
971 /* ...and it shows the current buffer. */
972 && XBUFFER (tem1
) == current_buffer
)))
973 Fset_window_point (tem
, make_number (PT
));
979 DEFUN ("save-excursion", Fsave_excursion
, Ssave_excursion
, 0, UNEVALLED
, 0,
980 doc
: /* Save point, mark, and current buffer; execute BODY; restore those things.
981 Executes BODY just like `progn'.
982 The values of point, mark and the current buffer are restored
983 even in case of abnormal exit (throw or error).
984 The state of activation of the mark is also restored.
986 This construct does not save `deactivate-mark', and therefore
987 functions that change the buffer will still cause deactivation
988 of the mark at the end of the command. To prevent that, bind
989 `deactivate-mark' with `let'.
991 usage: (save-excursion &rest BODY) */)
995 register Lisp_Object val
;
996 int count
= SPECPDL_INDEX ();
998 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
1000 val
= Fprogn (args
);
1001 return unbind_to (count
, val
);
1004 DEFUN ("save-current-buffer", Fsave_current_buffer
, Ssave_current_buffer
, 0, UNEVALLED
, 0,
1005 doc
: /* Save the current buffer; execute BODY; restore the current buffer.
1006 Executes BODY just like `progn'.
1007 usage: (save-current-buffer &rest BODY) */)
1012 int count
= SPECPDL_INDEX ();
1014 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
1016 val
= Fprogn (args
);
1017 return unbind_to (count
, val
);
1020 DEFUN ("buffer-size", Fbufsize
, Sbufsize
, 0, 1, 0,
1021 doc
: /* Return the number of characters in the current buffer.
1022 If BUFFER, return the number of characters in that buffer instead. */)
1027 return make_number (Z
- BEG
);
1030 CHECK_BUFFER (buffer
);
1031 return make_number (BUF_Z (XBUFFER (buffer
))
1032 - BUF_BEG (XBUFFER (buffer
)));
1036 DEFUN ("point-min", Fpoint_min
, Spoint_min
, 0, 0, 0,
1037 doc
: /* Return the minimum permissible value of point in the current buffer.
1038 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1042 XSETFASTINT (temp
, BEGV
);
1046 DEFUN ("point-min-marker", Fpoint_min_marker
, Spoint_min_marker
, 0, 0, 0,
1047 doc
: /* Return a marker to the minimum permissible value of point in this buffer.
1048 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1051 return buildmark (BEGV
, BEGV_BYTE
);
1054 DEFUN ("point-max", Fpoint_max
, Spoint_max
, 0, 0, 0,
1055 doc
: /* Return the maximum permissible value of point in the current buffer.
1056 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1057 is in effect, in which case it is less. */)
1061 XSETFASTINT (temp
, ZV
);
1065 DEFUN ("point-max-marker", Fpoint_max_marker
, Spoint_max_marker
, 0, 0, 0,
1066 doc
: /* Return a marker to the maximum permissible value of point in this buffer.
1067 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1068 is in effect, in which case it is less. */)
1071 return buildmark (ZV
, ZV_BYTE
);
1074 DEFUN ("gap-position", Fgap_position
, Sgap_position
, 0, 0, 0,
1075 doc
: /* Return the position of the gap, in the current buffer.
1076 See also `gap-size'. */)
1080 XSETFASTINT (temp
, GPT
);
1084 DEFUN ("gap-size", Fgap_size
, Sgap_size
, 0, 0, 0,
1085 doc
: /* Return the size of the current buffer's gap.
1086 See also `gap-position'. */)
1090 XSETFASTINT (temp
, GAP_SIZE
);
1094 DEFUN ("position-bytes", Fposition_bytes
, Sposition_bytes
, 1, 1, 0,
1095 doc
: /* Return the byte position for character position POSITION.
1096 If POSITION is out of range, the value is nil. */)
1098 Lisp_Object position
;
1100 CHECK_NUMBER_COERCE_MARKER (position
);
1101 if (XINT (position
) < BEG
|| XINT (position
) > Z
)
1103 return make_number (CHAR_TO_BYTE (XINT (position
)));
1106 DEFUN ("byte-to-position", Fbyte_to_position
, Sbyte_to_position
, 1, 1, 0,
1107 doc
: /* Return the character position for byte position BYTEPOS.
1108 If BYTEPOS is out of range, the value is nil. */)
1110 Lisp_Object bytepos
;
1112 CHECK_NUMBER (bytepos
);
1113 if (XINT (bytepos
) < BEG_BYTE
|| XINT (bytepos
) > Z_BYTE
)
1115 return make_number (BYTE_TO_CHAR (XINT (bytepos
)));
1118 DEFUN ("following-char", Ffollowing_char
, Sfollowing_char
, 0, 0, 0,
1119 doc
: /* Return the character following point, as a number.
1120 At the end of the buffer or accessible region, return 0. */)
1125 XSETFASTINT (temp
, 0);
1127 XSETFASTINT (temp
, FETCH_CHAR (PT_BYTE
));
1131 DEFUN ("preceding-char", Fprevious_char
, Sprevious_char
, 0, 0, 0,
1132 doc
: /* Return the character preceding point, as a number.
1133 At the beginning of the buffer or accessible region, return 0. */)
1138 XSETFASTINT (temp
, 0);
1139 else if (!NILP (current_buffer
->enable_multibyte_characters
))
1143 XSETFASTINT (temp
, FETCH_CHAR (pos
));
1146 XSETFASTINT (temp
, FETCH_BYTE (PT_BYTE
- 1));
1150 DEFUN ("bobp", Fbobp
, Sbobp
, 0, 0, 0,
1151 doc
: /* Return t if point is at the beginning of the buffer.
1152 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1160 DEFUN ("eobp", Feobp
, Seobp
, 0, 0, 0,
1161 doc
: /* Return t if point is at the end of the buffer.
1162 If the buffer is narrowed, this means the end of the narrowed part. */)
1170 DEFUN ("bolp", Fbolp
, Sbolp
, 0, 0, 0,
1171 doc
: /* Return t if point is at the beginning of a line. */)
1174 if (PT
== BEGV
|| FETCH_BYTE (PT_BYTE
- 1) == '\n')
1179 DEFUN ("eolp", Feolp
, Seolp
, 0, 0, 0,
1180 doc
: /* Return t if point is at the end of a line.
1181 `End of a line' includes point being at the end of the buffer. */)
1184 if (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n')
1189 DEFUN ("char-after", Fchar_after
, Schar_after
, 0, 1, 0,
1190 doc
: /* Return character in current buffer at position POS.
1191 POS is an integer or a marker and defaults to point.
1192 If POS is out of range, the value is nil. */)
1196 register int pos_byte
;
1201 XSETFASTINT (pos
, PT
);
1206 pos_byte
= marker_byte_position (pos
);
1207 if (pos_byte
< BEGV_BYTE
|| pos_byte
>= ZV_BYTE
)
1212 CHECK_NUMBER_COERCE_MARKER (pos
);
1213 if (XINT (pos
) < BEGV
|| XINT (pos
) >= ZV
)
1216 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1219 return make_number (FETCH_CHAR (pos_byte
));
1222 DEFUN ("char-before", Fchar_before
, Schar_before
, 0, 1, 0,
1223 doc
: /* Return character in current buffer preceding position POS.
1224 POS is an integer or a marker and defaults to point.
1225 If POS is out of range, the value is nil. */)
1229 register Lisp_Object val
;
1230 register int pos_byte
;
1235 XSETFASTINT (pos
, PT
);
1240 pos_byte
= marker_byte_position (pos
);
1242 if (pos_byte
<= BEGV_BYTE
|| pos_byte
> ZV_BYTE
)
1247 CHECK_NUMBER_COERCE_MARKER (pos
);
1249 if (XINT (pos
) <= BEGV
|| XINT (pos
) > ZV
)
1252 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1255 if (!NILP (current_buffer
->enable_multibyte_characters
))
1258 XSETFASTINT (val
, FETCH_CHAR (pos_byte
));
1263 XSETFASTINT (val
, FETCH_BYTE (pos_byte
));
1268 DEFUN ("user-login-name", Fuser_login_name
, Suser_login_name
, 0, 1, 0,
1269 doc
: /* Return the name under which the user logged in, as a string.
1270 This is based on the effective uid, not the real uid.
1271 Also, if the environment variables LOGNAME or USER are set,
1272 that determines the value of this function.
1274 If optional argument UID is an integer, return the login name of the user
1275 with that uid, or nil if there is no such user. */)
1281 /* Set up the user name info if we didn't do it before.
1282 (That can happen if Emacs is dumpable
1283 but you decide to run `temacs -l loadup' and not dump. */
1284 if (INTEGERP (Vuser_login_name
))
1288 return Vuser_login_name
;
1292 pw
= (struct passwd
*) getpwuid (XINT (uid
));
1294 return (pw
? build_string (pw
->pw_name
) : Qnil
);
1297 DEFUN ("user-real-login-name", Fuser_real_login_name
, Suser_real_login_name
,
1299 doc
: /* Return the name of the user's real uid, as a string.
1300 This ignores the environment variables LOGNAME and USER, so it differs from
1301 `user-login-name' when running under `su'. */)
1304 /* Set up the user name info if we didn't do it before.
1305 (That can happen if Emacs is dumpable
1306 but you decide to run `temacs -l loadup' and not dump. */
1307 if (INTEGERP (Vuser_login_name
))
1309 return Vuser_real_login_name
;
1312 DEFUN ("user-uid", Fuser_uid
, Suser_uid
, 0, 0, 0,
1313 doc
: /* Return the effective uid of Emacs.
1314 Value is an integer or float, depending on the value. */)
1317 return make_fixnum_or_float (geteuid ());
1320 DEFUN ("user-real-uid", Fuser_real_uid
, Suser_real_uid
, 0, 0, 0,
1321 doc
: /* Return the real uid of Emacs.
1322 Value is an integer or float, depending on the value. */)
1325 return make_fixnum_or_float (getuid ());
1328 DEFUN ("user-full-name", Fuser_full_name
, Suser_full_name
, 0, 1, 0,
1329 doc
: /* Return the full name of the user logged in, as a string.
1330 If the full name corresponding to Emacs's userid is not known,
1333 If optional argument UID is an integer or float, return the full name
1334 of the user with that uid, or nil if there is no such user.
1335 If UID is a string, return the full name of the user with that login
1336 name, or nil if there is no such user. */)
1341 register unsigned char *p
, *q
;
1345 return Vuser_full_name
;
1346 else if (NUMBERP (uid
))
1349 pw
= (struct passwd
*) getpwuid ((uid_t
) XFLOATINT (uid
));
1352 else if (STRINGP (uid
))
1355 pw
= (struct passwd
*) getpwnam (SDATA (uid
));
1359 error ("Invalid UID specification");
1364 p
= (unsigned char *) USER_FULL_NAME
;
1365 /* Chop off everything after the first comma. */
1366 q
= (unsigned char *) index (p
, ',');
1367 full
= make_string (p
, q
? q
- p
: strlen (p
));
1369 #ifdef AMPERSAND_FULL_NAME
1371 q
= (unsigned char *) index (p
, '&');
1372 /* Substitute the login name for the &, upcasing the first character. */
1375 register unsigned char *r
;
1378 login
= Fuser_login_name (make_number (pw
->pw_uid
));
1379 r
= (unsigned char *) alloca (strlen (p
) + SCHARS (login
) + 1);
1380 bcopy (p
, r
, q
- p
);
1382 strcat (r
, SDATA (login
));
1383 r
[q
- p
] = UPCASE (r
[q
- p
]);
1385 full
= build_string (r
);
1387 #endif /* AMPERSAND_FULL_NAME */
1392 DEFUN ("system-name", Fsystem_name
, Ssystem_name
, 0, 0, 0,
1393 doc
: /* Return the name of the machine you are running on, as a string. */)
1396 return Vsystem_name
;
1399 /* For the benefit of callers who don't want to include lisp.h */
1404 if (STRINGP (Vsystem_name
))
1405 return (char *) SDATA (Vsystem_name
);
1411 get_operating_system_release()
1413 if (STRINGP (Voperating_system_release
))
1414 return (char *) SDATA (Voperating_system_release
);
1419 DEFUN ("emacs-pid", Femacs_pid
, Semacs_pid
, 0, 0, 0,
1420 doc
: /* Return the process ID of Emacs, as an integer. */)
1423 return make_number (getpid ());
1426 DEFUN ("current-time", Fcurrent_time
, Scurrent_time
, 0, 0, 0,
1427 doc
: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1428 The time is returned as a list of three integers. The first has the
1429 most significant 16 bits of the seconds, while the second has the
1430 least significant 16 bits. The third integer gives the microsecond
1433 The microsecond count is zero on systems that do not provide
1434 resolution finer than a second. */)
1440 return list3 (make_number ((EMACS_SECS (t
) >> 16) & 0xffff),
1441 make_number ((EMACS_SECS (t
) >> 0) & 0xffff),
1442 make_number (EMACS_USECS (t
)));
1445 DEFUN ("get-internal-run-time", Fget_internal_run_time
, Sget_internal_run_time
,
1447 doc
: /* Return the current run time used by Emacs.
1448 The time is returned as a list of three integers. The first has the
1449 most significant 16 bits of the seconds, while the second has the
1450 least significant 16 bits. The third integer gives the microsecond
1453 On systems that can't determine the run time, get-internal-run-time
1454 does the same thing as current-time. The microsecond count is zero on
1455 systems that do not provide resolution finer than a second. */)
1458 #ifdef HAVE_GETRUSAGE
1459 struct rusage usage
;
1462 if (getrusage (RUSAGE_SELF
, &usage
) < 0)
1463 /* This shouldn't happen. What action is appropriate? */
1466 /* Sum up user time and system time. */
1467 secs
= usage
.ru_utime
.tv_sec
+ usage
.ru_stime
.tv_sec
;
1468 usecs
= usage
.ru_utime
.tv_usec
+ usage
.ru_stime
.tv_usec
;
1469 if (usecs
>= 1000000)
1475 return list3 (make_number ((secs
>> 16) & 0xffff),
1476 make_number ((secs
>> 0) & 0xffff),
1477 make_number (usecs
));
1479 return Fcurrent_time ();
1485 lisp_time_argument (specified_time
, result
, usec
)
1486 Lisp_Object specified_time
;
1490 if (NILP (specified_time
))
1497 *usec
= EMACS_USECS (t
);
1498 *result
= EMACS_SECS (t
);
1502 return time (result
) != -1;
1506 Lisp_Object high
, low
;
1507 high
= Fcar (specified_time
);
1508 CHECK_NUMBER (high
);
1509 low
= Fcdr (specified_time
);
1514 Lisp_Object usec_l
= Fcdr (low
);
1516 usec_l
= Fcar (usec_l
);
1521 CHECK_NUMBER (usec_l
);
1522 *usec
= XINT (usec_l
);
1530 *result
= (XINT (high
) << 16) + (XINT (low
) & 0xffff);
1531 return *result
>> 16 == XINT (high
);
1535 DEFUN ("float-time", Ffloat_time
, Sfloat_time
, 0, 1, 0,
1536 doc
: /* Return the current time, as a float number of seconds since the epoch.
1537 If SPECIFIED-TIME is given, it is the time to convert to float
1538 instead of the current time. The argument should have the form
1539 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1540 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1541 have the form (HIGH . LOW), but this is considered obsolete.
1543 WARNING: Since the result is floating point, it may not be exact.
1544 Do not use this function if precise time stamps are required. */)
1546 Lisp_Object specified_time
;
1551 if (! lisp_time_argument (specified_time
, &sec
, &usec
))
1552 error ("Invalid time specification");
1554 return make_float ((sec
* 1e6
+ usec
) / 1e6
);
1557 /* Write information into buffer S of size MAXSIZE, according to the
1558 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1559 Default to Universal Time if UT is nonzero, local time otherwise.
1560 Return the number of bytes written, not including the terminating
1561 '\0'. If S is NULL, nothing will be written anywhere; so to
1562 determine how many bytes would be written, use NULL for S and
1563 ((size_t) -1) for MAXSIZE.
1565 This function behaves like emacs_strftimeu, except it allows null
1568 emacs_memftimeu (s
, maxsize
, format
, format_len
, tp
, ut
)
1573 const struct tm
*tp
;
1578 /* Loop through all the null-terminated strings in the format
1579 argument. Normally there's just one null-terminated string, but
1580 there can be arbitrarily many, concatenated together, if the
1581 format contains '\0' bytes. emacs_strftimeu stops at the first
1582 '\0' byte so we must invoke it separately for each such string. */
1591 result
= emacs_strftimeu (s
, maxsize
, format
, tp
, ut
);
1595 if (result
== 0 && s
[0] != '\0')
1600 maxsize
-= result
+ 1;
1602 len
= strlen (format
);
1603 if (len
== format_len
)
1607 format_len
-= len
+ 1;
1611 DEFUN ("format-time-string", Fformat_time_string
, Sformat_time_string
, 1, 3, 0,
1612 doc
: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1613 TIME is specified as (HIGH LOW . IGNORED), as returned by
1614 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1615 is also still accepted.
1616 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1617 as Universal Time; nil means describe TIME in the local time zone.
1618 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1619 by text that describes the specified date and time in TIME:
1621 %Y is the year, %y within the century, %C the century.
1622 %G is the year corresponding to the ISO week, %g within the century.
1623 %m is the numeric month.
1624 %b and %h are the locale's abbreviated month name, %B the full name.
1625 %d is the day of the month, zero-padded, %e is blank-padded.
1626 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1627 %a is the locale's abbreviated name of the day of week, %A the full name.
1628 %U is the week number starting on Sunday, %W starting on Monday,
1629 %V according to ISO 8601.
1630 %j is the day of the year.
1632 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1633 only blank-padded, %l is like %I blank-padded.
1634 %p is the locale's equivalent of either AM or PM.
1637 %Z is the time zone name, %z is the numeric form.
1638 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1640 %c is the locale's date and time format.
1641 %x is the locale's "preferred" date format.
1642 %D is like "%m/%d/%y".
1644 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1645 %X is the locale's "preferred" time format.
1647 Finally, %n is a newline, %t is a tab, %% is a literal %.
1649 Certain flags and modifiers are available with some format controls.
1650 The flags are `_', `-', `^' and `#'. For certain characters X,
1651 %_X is like %X, but padded with blanks; %-X is like %X,
1652 but without padding. %^X is like %X, but with all textual
1653 characters up-cased; %#X is like %X, but with letter-case of
1654 all textual characters reversed.
1655 %NX (where N stands for an integer) is like %X,
1656 but takes up at least N (a number) positions.
1657 The modifiers are `E' and `O'. For certain characters X,
1658 %EX is a locale's alternative version of %X;
1659 %OX is like %X, but uses the locale's number symbols.
1661 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1662 (format_string
, time
, universal
)
1663 Lisp_Object format_string
, time
, universal
;
1668 int ut
= ! NILP (universal
);
1670 CHECK_STRING (format_string
);
1672 if (! lisp_time_argument (time
, &value
, NULL
))
1673 error ("Invalid time specification");
1675 format_string
= code_convert_string_norecord (format_string
,
1676 Vlocale_coding_system
, 1);
1678 /* This is probably enough. */
1679 size
= SBYTES (format_string
) * 6 + 50;
1681 tm
= ut
? gmtime (&value
) : localtime (&value
);
1683 error ("Specified time is not representable");
1685 synchronize_system_time_locale ();
1689 char *buf
= (char *) alloca (size
+ 1);
1693 result
= emacs_memftimeu (buf
, size
, SDATA (format_string
),
1694 SBYTES (format_string
),
1696 if ((result
> 0 && result
< size
) || (result
== 0 && buf
[0] == '\0'))
1697 return code_convert_string_norecord (make_string (buf
, result
),
1698 Vlocale_coding_system
, 0);
1700 /* If buffer was too small, make it bigger and try again. */
1701 result
= emacs_memftimeu (NULL
, (size_t) -1,
1702 SDATA (format_string
),
1703 SBYTES (format_string
),
1709 DEFUN ("decode-time", Fdecode_time
, Sdecode_time
, 0, 1, 0,
1710 doc
: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1711 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1712 as from `current-time' and `file-attributes', or `nil' to use the
1713 current time. The obsolete form (HIGH . LOW) is also still accepted.
1714 The list has the following nine members: SEC is an integer between 0
1715 and 60; SEC is 60 for a leap second, which only some operating systems
1716 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1717 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1718 integer between 1 and 12. YEAR is an integer indicating the
1719 four-digit year. DOW is the day of week, an integer between 0 and 6,
1720 where 0 is Sunday. DST is t if daylight savings time is effect,
1721 otherwise nil. ZONE is an integer indicating the number of seconds
1722 east of Greenwich. (Note that Common Lisp has different meanings for
1725 Lisp_Object specified_time
;
1729 struct tm
*decoded_time
;
1730 Lisp_Object list_args
[9];
1732 if (! lisp_time_argument (specified_time
, &time_spec
, NULL
))
1733 error ("Invalid time specification");
1735 decoded_time
= localtime (&time_spec
);
1737 error ("Specified time is not representable");
1738 XSETFASTINT (list_args
[0], decoded_time
->tm_sec
);
1739 XSETFASTINT (list_args
[1], decoded_time
->tm_min
);
1740 XSETFASTINT (list_args
[2], decoded_time
->tm_hour
);
1741 XSETFASTINT (list_args
[3], decoded_time
->tm_mday
);
1742 XSETFASTINT (list_args
[4], decoded_time
->tm_mon
+ 1);
1743 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1744 cast below avoids overflow in int arithmetics. */
1745 XSETINT (list_args
[5], TM_YEAR_BASE
+ (EMACS_INT
) decoded_time
->tm_year
);
1746 XSETFASTINT (list_args
[6], decoded_time
->tm_wday
);
1747 list_args
[7] = (decoded_time
->tm_isdst
)? Qt
: Qnil
;
1749 /* Make a copy, in case gmtime modifies the struct. */
1750 save_tm
= *decoded_time
;
1751 decoded_time
= gmtime (&time_spec
);
1752 if (decoded_time
== 0)
1753 list_args
[8] = Qnil
;
1755 XSETINT (list_args
[8], tm_diff (&save_tm
, decoded_time
));
1756 return Flist (9, list_args
);
1759 DEFUN ("encode-time", Fencode_time
, Sencode_time
, 6, MANY
, 0,
1760 doc
: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1761 This is the reverse operation of `decode-time', which see.
1762 ZONE defaults to the current time zone rule. This can
1763 be a string or t (as from `set-time-zone-rule'), or it can be a list
1764 \(as from `current-time-zone') or an integer (as from `decode-time')
1765 applied without consideration for daylight savings time.
1767 You can pass more than 7 arguments; then the first six arguments
1768 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1769 The intervening arguments are ignored.
1770 This feature lets (apply 'encode-time (decode-time ...)) work.
1772 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1773 for example, a DAY of 0 means the day preceding the given month.
1774 Year numbers less than 100 are treated just like other year numbers.
1775 If you want them to stand for years in this century, you must do that yourself.
1777 Years before 1970 are not guaranteed to work. On some systems,
1778 year values as low as 1901 do work.
1780 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1783 register Lisp_Object
*args
;
1787 Lisp_Object zone
= (nargs
> 6 ? args
[nargs
- 1] : Qnil
);
1789 CHECK_NUMBER (args
[0]); /* second */
1790 CHECK_NUMBER (args
[1]); /* minute */
1791 CHECK_NUMBER (args
[2]); /* hour */
1792 CHECK_NUMBER (args
[3]); /* day */
1793 CHECK_NUMBER (args
[4]); /* month */
1794 CHECK_NUMBER (args
[5]); /* year */
1796 tm
.tm_sec
= XINT (args
[0]);
1797 tm
.tm_min
= XINT (args
[1]);
1798 tm
.tm_hour
= XINT (args
[2]);
1799 tm
.tm_mday
= XINT (args
[3]);
1800 tm
.tm_mon
= XINT (args
[4]) - 1;
1801 tm
.tm_year
= XINT (args
[5]) - TM_YEAR_BASE
;
1807 time
= mktime (&tm
);
1812 char **oldenv
= environ
, **newenv
;
1816 else if (STRINGP (zone
))
1817 tzstring
= (char *) SDATA (zone
);
1818 else if (INTEGERP (zone
))
1820 int abszone
= abs (XINT (zone
));
1821 sprintf (tzbuf
, "XXX%s%d:%02d:%02d", "-" + (XINT (zone
) < 0),
1822 abszone
/ (60*60), (abszone
/60) % 60, abszone
% 60);
1826 error ("Invalid time zone specification");
1828 /* Set TZ before calling mktime; merely adjusting mktime's returned
1829 value doesn't suffice, since that would mishandle leap seconds. */
1830 set_time_zone_rule (tzstring
);
1832 time
= mktime (&tm
);
1834 /* Restore TZ to previous value. */
1838 #ifdef LOCALTIME_CACHE
1843 if (time
== (time_t) -1)
1844 error ("Specified time is not representable");
1846 return make_time (time
);
1849 DEFUN ("current-time-string", Fcurrent_time_string
, Scurrent_time_string
, 0, 1, 0,
1850 doc
: /* Return the current time, as a human-readable string.
1851 Programs can use this function to decode a time,
1852 since the number of columns in each field is fixed
1853 if the year is in the range 1000-9999.
1854 The format is `Sun Sep 16 01:03:52 1973'.
1855 However, see also the functions `decode-time' and `format-time-string'
1856 which provide a much more powerful and general facility.
1858 If SPECIFIED-TIME is given, it is a time to format instead of the
1859 current time. The argument should have the form (HIGH LOW . IGNORED).
1860 Thus, you can use times obtained from `current-time' and from
1861 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1862 but this is considered obsolete. */)
1864 Lisp_Object specified_time
;
1870 if (! lisp_time_argument (specified_time
, &value
, NULL
))
1871 error ("Invalid time specification");
1873 /* Convert to a string, checking for out-of-range time stamps.
1874 Don't use 'ctime', as that might dump core if VALUE is out of
1876 tm
= localtime (&value
);
1877 if (! (tm
&& TM_YEAR_IN_ASCTIME_RANGE (tm
->tm_year
) && (tem
= asctime (tm
))))
1878 error ("Specified time is not representable");
1880 /* Remove the trailing newline. */
1881 tem
[strlen (tem
) - 1] = '\0';
1883 return build_string (tem
);
1886 /* Yield A - B, measured in seconds.
1887 This function is copied from the GNU C Library. */
1892 /* Compute intervening leap days correctly even if year is negative.
1893 Take care to avoid int overflow in leap day calculations,
1894 but it's OK to assume that A and B are close to each other. */
1895 int a4
= (a
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (a
->tm_year
& 3);
1896 int b4
= (b
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (b
->tm_year
& 3);
1897 int a100
= a4
/ 25 - (a4
% 25 < 0);
1898 int b100
= b4
/ 25 - (b4
% 25 < 0);
1899 int a400
= a100
>> 2;
1900 int b400
= b100
>> 2;
1901 int intervening_leap_days
= (a4
- b4
) - (a100
- b100
) + (a400
- b400
);
1902 int years
= a
->tm_year
- b
->tm_year
;
1903 int days
= (365 * years
+ intervening_leap_days
1904 + (a
->tm_yday
- b
->tm_yday
));
1905 return (60 * (60 * (24 * days
+ (a
->tm_hour
- b
->tm_hour
))
1906 + (a
->tm_min
- b
->tm_min
))
1907 + (a
->tm_sec
- b
->tm_sec
));
1910 DEFUN ("current-time-zone", Fcurrent_time_zone
, Scurrent_time_zone
, 0, 1, 0,
1911 doc
: /* Return the offset and name for the local time zone.
1912 This returns a list of the form (OFFSET NAME).
1913 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1914 A negative value means west of Greenwich.
1915 NAME is a string giving the name of the time zone.
1916 If SPECIFIED-TIME is given, the time zone offset is determined from it
1917 instead of using the current time. The argument should have the form
1918 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1919 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1920 have the form (HIGH . LOW), but this is considered obsolete.
1922 Some operating systems cannot provide all this information to Emacs;
1923 in this case, `current-time-zone' returns a list containing nil for
1924 the data it can't find. */)
1926 Lisp_Object specified_time
;
1932 if (lisp_time_argument (specified_time
, &value
, NULL
)
1933 && (t
= gmtime (&value
)) != 0
1934 && (gmt
= *t
, t
= localtime (&value
)) != 0)
1936 int offset
= tm_diff (t
, &gmt
);
1941 s
= (char *)t
->tm_zone
;
1942 #else /* not HAVE_TM_ZONE */
1944 if (t
->tm_isdst
== 0 || t
->tm_isdst
== 1)
1945 s
= tzname
[t
->tm_isdst
];
1947 #endif /* not HAVE_TM_ZONE */
1949 #if defined HAVE_TM_ZONE || defined HAVE_TZNAME
1952 /* On Japanese w32, we can get a Japanese string as time
1953 zone name. Don't accept that. */
1955 for (p
= s
; *p
&& (isalnum ((unsigned char)*p
) || *p
== ' '); ++p
)
1964 /* No local time zone name is available; use "+-NNNN" instead. */
1965 int am
= (offset
< 0 ? -offset
: offset
) / 60;
1966 sprintf (buf
, "%c%02d%02d", (offset
< 0 ? '-' : '+'), am
/60, am
%60);
1969 return Fcons (make_number (offset
), Fcons (build_string (s
), Qnil
));
1972 return Fmake_list (make_number (2), Qnil
);
1975 /* This holds the value of `environ' produced by the previous
1976 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1977 has never been called. */
1978 static char **environbuf
;
1980 DEFUN ("set-time-zone-rule", Fset_time_zone_rule
, Sset_time_zone_rule
, 1, 1, 0,
1981 doc
: /* Set the local time zone using TZ, a string specifying a time zone rule.
1982 If TZ is nil, use implementation-defined default time zone information.
1983 If TZ is t, use Universal Time. */)
1991 else if (EQ (tz
, Qt
))
1996 tzstring
= (char *) SDATA (tz
);
1999 set_time_zone_rule (tzstring
);
2002 environbuf
= environ
;
2007 #ifdef LOCALTIME_CACHE
2009 /* These two values are known to load tz files in buggy implementations,
2010 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2011 Their values shouldn't matter in non-buggy implementations.
2012 We don't use string literals for these strings,
2013 since if a string in the environment is in readonly
2014 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2015 See Sun bugs 1113095 and 1114114, ``Timezone routines
2016 improperly modify environment''. */
2018 static char set_time_zone_rule_tz1
[] = "TZ=GMT+0";
2019 static char set_time_zone_rule_tz2
[] = "TZ=GMT+1";
2023 /* Set the local time zone rule to TZSTRING.
2024 This allocates memory into `environ', which it is the caller's
2025 responsibility to free. */
2028 set_time_zone_rule (tzstring
)
2032 char **from
, **to
, **newenv
;
2034 /* Make the ENVIRON vector longer with room for TZSTRING. */
2035 for (from
= environ
; *from
; from
++)
2037 envptrs
= from
- environ
+ 2;
2038 newenv
= to
= (char **) xmalloc (envptrs
* sizeof (char *)
2039 + (tzstring
? strlen (tzstring
) + 4 : 0));
2041 /* Add TZSTRING to the end of environ, as a value for TZ. */
2044 char *t
= (char *) (to
+ envptrs
);
2046 strcat (t
, tzstring
);
2050 /* Copy the old environ vector elements into NEWENV,
2051 but don't copy the TZ variable.
2052 So we have only one definition of TZ, which came from TZSTRING. */
2053 for (from
= environ
; *from
; from
++)
2054 if (strncmp (*from
, "TZ=", 3) != 0)
2060 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2061 the TZ variable is stored. If we do not have a TZSTRING,
2062 TO points to the vector slot which has the terminating null. */
2064 #ifdef LOCALTIME_CACHE
2066 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2067 "US/Pacific" that loads a tz file, then changes to a value like
2068 "XXX0" that does not load a tz file, and then changes back to
2069 its original value, the last change is (incorrectly) ignored.
2070 Also, if TZ changes twice in succession to values that do
2071 not load a tz file, tzset can dump core (see Sun bug#1225179).
2072 The following code works around these bugs. */
2076 /* Temporarily set TZ to a value that loads a tz file
2077 and that differs from tzstring. */
2079 *newenv
= (strcmp (tzstring
, set_time_zone_rule_tz1
+ 3) == 0
2080 ? set_time_zone_rule_tz2
: set_time_zone_rule_tz1
);
2086 /* The implied tzstring is unknown, so temporarily set TZ to
2087 two different values that each load a tz file. */
2088 *to
= set_time_zone_rule_tz1
;
2091 *to
= set_time_zone_rule_tz2
;
2096 /* Now TZ has the desired value, and tzset can be invoked safely. */
2103 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2104 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2105 type of object is Lisp_String). INHERIT is passed to
2106 INSERT_FROM_STRING_FUNC as the last argument. */
2109 general_insert_function (insert_func
, insert_from_string_func
,
2110 inherit
, nargs
, args
)
2111 void (*insert_func
) P_ ((const unsigned char *, int));
2112 void (*insert_from_string_func
) P_ ((Lisp_Object
, int, int, int, int, int));
2114 register Lisp_Object
*args
;
2116 register int argnum
;
2117 register Lisp_Object val
;
2119 for (argnum
= 0; argnum
< nargs
; argnum
++)
2124 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2127 if (!NILP (current_buffer
->enable_multibyte_characters
))
2128 len
= CHAR_STRING (XFASTINT (val
), str
);
2131 str
[0] = (SINGLE_BYTE_CHAR_P (XINT (val
))
2133 : multibyte_char_to_unibyte (XINT (val
), Qnil
));
2136 (*insert_func
) (str
, len
);
2138 else if (STRINGP (val
))
2140 (*insert_from_string_func
) (val
, 0, 0,
2146 wrong_type_argument (Qchar_or_string_p
, val
);
2158 /* Callers passing one argument to Finsert need not gcpro the
2159 argument "array", since the only element of the array will
2160 not be used after calling insert or insert_from_string, so
2161 we don't care if it gets trashed. */
2163 DEFUN ("insert", Finsert
, Sinsert
, 0, MANY
, 0,
2164 doc
: /* Insert the arguments, either strings or characters, at point.
2165 Point and before-insertion markers move forward to end up
2166 after the inserted text.
2167 Any other markers at the point of insertion remain before the text.
2169 If the current buffer is multibyte, unibyte strings are converted
2170 to multibyte for insertion (see `string-make-multibyte').
2171 If the current buffer is unibyte, multibyte strings are converted
2172 to unibyte for insertion (see `string-make-unibyte').
2174 When operating on binary data, it may be necessary to preserve the
2175 original bytes of a unibyte string when inserting it into a multibyte
2176 buffer; to accomplish this, apply `string-as-multibyte' to the string
2177 and insert the result.
2179 usage: (insert &rest ARGS) */)
2182 register Lisp_Object
*args
;
2184 general_insert_function (insert
, insert_from_string
, 0, nargs
, args
);
2188 DEFUN ("insert-and-inherit", Finsert_and_inherit
, Sinsert_and_inherit
,
2190 doc
: /* Insert the arguments at point, inheriting properties from adjoining text.
2191 Point and before-insertion markers move forward to end up
2192 after the inserted text.
2193 Any other markers at the point of insertion remain before the text.
2195 If the current buffer is multibyte, unibyte strings are converted
2196 to multibyte for insertion (see `unibyte-char-to-multibyte').
2197 If the current buffer is unibyte, multibyte strings are converted
2198 to unibyte for insertion.
2200 usage: (insert-and-inherit &rest ARGS) */)
2203 register Lisp_Object
*args
;
2205 general_insert_function (insert_and_inherit
, insert_from_string
, 1,
2210 DEFUN ("insert-before-markers", Finsert_before_markers
, Sinsert_before_markers
, 0, MANY
, 0,
2211 doc
: /* Insert strings or characters at point, relocating markers after the text.
2212 Point and markers move forward to end up after the inserted text.
2214 If the current buffer is multibyte, unibyte strings are converted
2215 to multibyte for insertion (see `unibyte-char-to-multibyte').
2216 If the current buffer is unibyte, multibyte strings are converted
2217 to unibyte for insertion.
2219 usage: (insert-before-markers &rest ARGS) */)
2222 register Lisp_Object
*args
;
2224 general_insert_function (insert_before_markers
,
2225 insert_from_string_before_markers
, 0,
2230 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers
,
2231 Sinsert_and_inherit_before_markers
, 0, MANY
, 0,
2232 doc
: /* Insert text at point, relocating markers and inheriting properties.
2233 Point and markers move forward to end up after the inserted text.
2235 If the current buffer is multibyte, unibyte strings are converted
2236 to multibyte for insertion (see `unibyte-char-to-multibyte').
2237 If the current buffer is unibyte, multibyte strings are converted
2238 to unibyte for insertion.
2240 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2243 register Lisp_Object
*args
;
2245 general_insert_function (insert_before_markers_and_inherit
,
2246 insert_from_string_before_markers
, 1,
2251 DEFUN ("insert-char", Finsert_char
, Sinsert_char
, 2, 3, 0,
2252 doc
: /* Insert COUNT (second arg) copies of CHARACTER (first arg).
2253 Both arguments are required.
2254 Point, and before-insertion markers, are relocated as in the function `insert'.
2255 The optional third arg INHERIT, if non-nil, says to inherit text properties
2256 from adjoining text, if those properties are sticky. */)
2257 (character
, count
, inherit
)
2258 Lisp_Object character
, count
, inherit
;
2260 register unsigned char *string
;
2261 register int strlen
;
2264 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2266 CHECK_NUMBER (character
);
2267 CHECK_NUMBER (count
);
2269 if (!NILP (current_buffer
->enable_multibyte_characters
))
2270 len
= CHAR_STRING (XFASTINT (character
), str
);
2272 str
[0] = XFASTINT (character
), len
= 1;
2273 n
= XINT (count
) * len
;
2276 strlen
= min (n
, 256 * len
);
2277 string
= (unsigned char *) alloca (strlen
);
2278 for (i
= 0; i
< strlen
; i
++)
2279 string
[i
] = str
[i
% len
];
2283 if (!NILP (inherit
))
2284 insert_and_inherit (string
, strlen
);
2286 insert (string
, strlen
);
2291 if (!NILP (inherit
))
2292 insert_and_inherit (string
, n
);
2300 /* Making strings from buffer contents. */
2302 /* Return a Lisp_String containing the text of the current buffer from
2303 START to END. If text properties are in use and the current buffer
2304 has properties in the range specified, the resulting string will also
2305 have them, if PROPS is nonzero.
2307 We don't want to use plain old make_string here, because it calls
2308 make_uninit_string, which can cause the buffer arena to be
2309 compacted. make_string has no way of knowing that the data has
2310 been moved, and thus copies the wrong data into the string. This
2311 doesn't effect most of the other users of make_string, so it should
2312 be left as is. But we should use this function when conjuring
2313 buffer substrings. */
2316 make_buffer_string (start
, end
, props
)
2320 int start_byte
= CHAR_TO_BYTE (start
);
2321 int end_byte
= CHAR_TO_BYTE (end
);
2323 return make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
);
2326 /* Return a Lisp_String containing the text of the current buffer from
2327 START / START_BYTE to END / END_BYTE.
2329 If text properties are in use and the current buffer
2330 has properties in the range specified, the resulting string will also
2331 have them, if PROPS is nonzero.
2333 We don't want to use plain old make_string here, because it calls
2334 make_uninit_string, which can cause the buffer arena to be
2335 compacted. make_string has no way of knowing that the data has
2336 been moved, and thus copies the wrong data into the string. This
2337 doesn't effect most of the other users of make_string, so it should
2338 be left as is. But we should use this function when conjuring
2339 buffer substrings. */
2342 make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
)
2343 int start
, start_byte
, end
, end_byte
;
2346 Lisp_Object result
, tem
, tem1
;
2348 if (start
< GPT
&& GPT
< end
)
2351 if (! NILP (current_buffer
->enable_multibyte_characters
))
2352 result
= make_uninit_multibyte_string (end
- start
, end_byte
- start_byte
);
2354 result
= make_uninit_string (end
- start
);
2355 bcopy (BYTE_POS_ADDR (start_byte
), SDATA (result
),
2356 end_byte
- start_byte
);
2358 /* If desired, update and copy the text properties. */
2361 update_buffer_properties (start
, end
);
2363 tem
= Fnext_property_change (make_number (start
), Qnil
, make_number (end
));
2364 tem1
= Ftext_properties_at (make_number (start
), Qnil
);
2366 if (XINT (tem
) != end
|| !NILP (tem1
))
2367 copy_intervals_to_string (result
, current_buffer
, start
,
2374 /* Call Vbuffer_access_fontify_functions for the range START ... END
2375 in the current buffer, if necessary. */
2378 update_buffer_properties (start
, end
)
2381 /* If this buffer has some access functions,
2382 call them, specifying the range of the buffer being accessed. */
2383 if (!NILP (Vbuffer_access_fontify_functions
))
2385 Lisp_Object args
[3];
2388 args
[0] = Qbuffer_access_fontify_functions
;
2389 XSETINT (args
[1], start
);
2390 XSETINT (args
[2], end
);
2392 /* But don't call them if we can tell that the work
2393 has already been done. */
2394 if (!NILP (Vbuffer_access_fontified_property
))
2396 tem
= Ftext_property_any (args
[1], args
[2],
2397 Vbuffer_access_fontified_property
,
2400 Frun_hook_with_args (3, args
);
2403 Frun_hook_with_args (3, args
);
2407 DEFUN ("buffer-substring", Fbuffer_substring
, Sbuffer_substring
, 2, 2, 0,
2408 doc
: /* Return the contents of part of the current buffer as a string.
2409 The two arguments START and END are character positions;
2410 they can be in either order.
2411 The string returned is multibyte if the buffer is multibyte.
2413 This function copies the text properties of that part of the buffer
2414 into the result string; if you don't want the text properties,
2415 use `buffer-substring-no-properties' instead. */)
2417 Lisp_Object start
, end
;
2421 validate_region (&start
, &end
);
2425 return make_buffer_string (b
, e
, 1);
2428 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties
,
2429 Sbuffer_substring_no_properties
, 2, 2, 0,
2430 doc
: /* Return the characters of part of the buffer, without the text properties.
2431 The two arguments START and END are character positions;
2432 they can be in either order. */)
2434 Lisp_Object start
, end
;
2438 validate_region (&start
, &end
);
2442 return make_buffer_string (b
, e
, 0);
2445 DEFUN ("buffer-string", Fbuffer_string
, Sbuffer_string
, 0, 0, 0,
2446 doc
: /* Return the contents of the current buffer as a string.
2447 If narrowing is in effect, this function returns only the visible part
2451 return make_buffer_string (BEGV
, ZV
, 1);
2454 DEFUN ("insert-buffer-substring", Finsert_buffer_substring
, Sinsert_buffer_substring
,
2456 doc
: /* Insert before point a substring of the contents of BUFFER.
2457 BUFFER may be a buffer or a buffer name.
2458 Arguments START and END are character positions specifying the substring.
2459 They default to the values of (point-min) and (point-max) in BUFFER. */)
2460 (buffer
, start
, end
)
2461 Lisp_Object buffer
, start
, end
;
2463 register int b
, e
, temp
;
2464 register struct buffer
*bp
, *obuf
;
2467 buf
= Fget_buffer (buffer
);
2471 if (NILP (bp
->name
))
2472 error ("Selecting deleted buffer");
2478 CHECK_NUMBER_COERCE_MARKER (start
);
2485 CHECK_NUMBER_COERCE_MARKER (end
);
2490 temp
= b
, b
= e
, e
= temp
;
2492 if (!(BUF_BEGV (bp
) <= b
&& e
<= BUF_ZV (bp
)))
2493 args_out_of_range (start
, end
);
2495 obuf
= current_buffer
;
2496 set_buffer_internal_1 (bp
);
2497 update_buffer_properties (b
, e
);
2498 set_buffer_internal_1 (obuf
);
2500 insert_from_buffer (bp
, b
, e
- b
, 0);
2504 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings
, Scompare_buffer_substrings
,
2506 doc
: /* Compare two substrings of two buffers; return result as number.
2507 the value is -N if first string is less after N-1 chars,
2508 +N if first string is greater after N-1 chars, or 0 if strings match.
2509 Each substring is represented as three arguments: BUFFER, START and END.
2510 That makes six args in all, three for each substring.
2512 The value of `case-fold-search' in the current buffer
2513 determines whether case is significant or ignored. */)
2514 (buffer1
, start1
, end1
, buffer2
, start2
, end2
)
2515 Lisp_Object buffer1
, start1
, end1
, buffer2
, start2
, end2
;
2517 register int begp1
, endp1
, begp2
, endp2
, temp
;
2518 register struct buffer
*bp1
, *bp2
;
2519 register Lisp_Object trt
2520 = (!NILP (current_buffer
->case_fold_search
)
2521 ? current_buffer
->case_canon_table
: Qnil
);
2523 int i1
, i2
, i1_byte
, i2_byte
;
2525 /* Find the first buffer and its substring. */
2528 bp1
= current_buffer
;
2532 buf1
= Fget_buffer (buffer1
);
2535 bp1
= XBUFFER (buf1
);
2536 if (NILP (bp1
->name
))
2537 error ("Selecting deleted buffer");
2541 begp1
= BUF_BEGV (bp1
);
2544 CHECK_NUMBER_COERCE_MARKER (start1
);
2545 begp1
= XINT (start1
);
2548 endp1
= BUF_ZV (bp1
);
2551 CHECK_NUMBER_COERCE_MARKER (end1
);
2552 endp1
= XINT (end1
);
2556 temp
= begp1
, begp1
= endp1
, endp1
= temp
;
2558 if (!(BUF_BEGV (bp1
) <= begp1
2560 && endp1
<= BUF_ZV (bp1
)))
2561 args_out_of_range (start1
, end1
);
2563 /* Likewise for second substring. */
2566 bp2
= current_buffer
;
2570 buf2
= Fget_buffer (buffer2
);
2573 bp2
= XBUFFER (buf2
);
2574 if (NILP (bp2
->name
))
2575 error ("Selecting deleted buffer");
2579 begp2
= BUF_BEGV (bp2
);
2582 CHECK_NUMBER_COERCE_MARKER (start2
);
2583 begp2
= XINT (start2
);
2586 endp2
= BUF_ZV (bp2
);
2589 CHECK_NUMBER_COERCE_MARKER (end2
);
2590 endp2
= XINT (end2
);
2594 temp
= begp2
, begp2
= endp2
, endp2
= temp
;
2596 if (!(BUF_BEGV (bp2
) <= begp2
2598 && endp2
<= BUF_ZV (bp2
)))
2599 args_out_of_range (start2
, end2
);
2603 i1_byte
= buf_charpos_to_bytepos (bp1
, i1
);
2604 i2_byte
= buf_charpos_to_bytepos (bp2
, i2
);
2606 while (i1
< endp1
&& i2
< endp2
)
2608 /* When we find a mismatch, we must compare the
2609 characters, not just the bytes. */
2614 if (! NILP (bp1
->enable_multibyte_characters
))
2616 c1
= BUF_FETCH_MULTIBYTE_CHAR (bp1
, i1_byte
);
2617 BUF_INC_POS (bp1
, i1_byte
);
2622 c1
= BUF_FETCH_BYTE (bp1
, i1
);
2623 c1
= unibyte_char_to_multibyte (c1
);
2627 if (! NILP (bp2
->enable_multibyte_characters
))
2629 c2
= BUF_FETCH_MULTIBYTE_CHAR (bp2
, i2_byte
);
2630 BUF_INC_POS (bp2
, i2_byte
);
2635 c2
= BUF_FETCH_BYTE (bp2
, i2
);
2636 c2
= unibyte_char_to_multibyte (c2
);
2642 c1
= CHAR_TABLE_TRANSLATE (trt
, c1
);
2643 c2
= CHAR_TABLE_TRANSLATE (trt
, c2
);
2646 return make_number (- 1 - chars
);
2648 return make_number (chars
+ 1);
2653 /* The strings match as far as they go.
2654 If one is shorter, that one is less. */
2655 if (chars
< endp1
- begp1
)
2656 return make_number (chars
+ 1);
2657 else if (chars
< endp2
- begp2
)
2658 return make_number (- chars
- 1);
2660 /* Same length too => they are equal. */
2661 return make_number (0);
2665 subst_char_in_region_unwind (arg
)
2668 return current_buffer
->undo_list
= arg
;
2672 subst_char_in_region_unwind_1 (arg
)
2675 return current_buffer
->filename
= arg
;
2678 DEFUN ("subst-char-in-region", Fsubst_char_in_region
,
2679 Ssubst_char_in_region
, 4, 5, 0,
2680 doc
: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2681 If optional arg NOUNDO is non-nil, don't record this change for undo
2682 and don't mark the buffer as really changed.
2683 Both characters must have the same length of multi-byte form. */)
2684 (start
, end
, fromchar
, tochar
, noundo
)
2685 Lisp_Object start
, end
, fromchar
, tochar
, noundo
;
2687 register int pos
, pos_byte
, stop
, i
, len
, end_byte
;
2688 /* Keep track of the first change in the buffer:
2689 if 0 we haven't found it yet.
2690 if < 0 we've found it and we've run the before-change-function.
2691 if > 0 we've actually performed it and the value is its position. */
2693 unsigned char fromstr
[MAX_MULTIBYTE_LENGTH
], tostr
[MAX_MULTIBYTE_LENGTH
];
2695 int count
= SPECPDL_INDEX ();
2696 #define COMBINING_NO 0
2697 #define COMBINING_BEFORE 1
2698 #define COMBINING_AFTER 2
2699 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2700 int maybe_byte_combining
= COMBINING_NO
;
2701 int last_changed
= 0;
2702 int multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2706 validate_region (&start
, &end
);
2707 CHECK_NUMBER (fromchar
);
2708 CHECK_NUMBER (tochar
);
2712 len
= CHAR_STRING (XFASTINT (fromchar
), fromstr
);
2713 if (CHAR_STRING (XFASTINT (tochar
), tostr
) != len
)
2714 error ("Characters in `subst-char-in-region' have different byte-lengths");
2715 if (!ASCII_BYTE_P (*tostr
))
2717 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2718 complete multibyte character, it may be combined with the
2719 after bytes. If it is in the range 0xA0..0xFF, it may be
2720 combined with the before and after bytes. */
2721 if (!CHAR_HEAD_P (*tostr
))
2722 maybe_byte_combining
= COMBINING_BOTH
;
2723 else if (BYTES_BY_CHAR_HEAD (*tostr
) > len
)
2724 maybe_byte_combining
= COMBINING_AFTER
;
2730 fromstr
[0] = XFASTINT (fromchar
);
2731 tostr
[0] = XFASTINT (tochar
);
2735 pos_byte
= CHAR_TO_BYTE (pos
);
2736 stop
= CHAR_TO_BYTE (XINT (end
));
2739 /* If we don't want undo, turn off putting stuff on the list.
2740 That's faster than getting rid of things,
2741 and it prevents even the entry for a first change.
2742 Also inhibit locking the file. */
2743 if (!changed
&& !NILP (noundo
))
2745 record_unwind_protect (subst_char_in_region_unwind
,
2746 current_buffer
->undo_list
);
2747 current_buffer
->undo_list
= Qt
;
2748 /* Don't do file-locking. */
2749 record_unwind_protect (subst_char_in_region_unwind_1
,
2750 current_buffer
->filename
);
2751 current_buffer
->filename
= Qnil
;
2754 if (pos_byte
< GPT_BYTE
)
2755 stop
= min (stop
, GPT_BYTE
);
2758 int pos_byte_next
= pos_byte
;
2760 if (pos_byte
>= stop
)
2762 if (pos_byte
>= end_byte
) break;
2765 p
= BYTE_POS_ADDR (pos_byte
);
2767 INC_POS (pos_byte_next
);
2770 if (pos_byte_next
- pos_byte
== len
2771 && p
[0] == fromstr
[0]
2773 || (p
[1] == fromstr
[1]
2774 && (len
== 2 || (p
[2] == fromstr
[2]
2775 && (len
== 3 || p
[3] == fromstr
[3]))))))
2778 /* We've already seen this and run the before-change-function;
2779 this time we only need to record the actual position. */
2784 modify_region (current_buffer
, pos
, XINT (end
), 0);
2786 if (! NILP (noundo
))
2788 if (MODIFF
- 1 == SAVE_MODIFF
)
2790 if (MODIFF
- 1 == current_buffer
->auto_save_modified
)
2791 current_buffer
->auto_save_modified
++;
2794 /* The before-change-function may have moved the gap
2795 or even modified the buffer so we should start over. */
2799 /* Take care of the case where the new character
2800 combines with neighboring bytes. */
2801 if (maybe_byte_combining
2802 && (maybe_byte_combining
== COMBINING_AFTER
2803 ? (pos_byte_next
< Z_BYTE
2804 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2805 : ((pos_byte_next
< Z_BYTE
2806 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2807 || (pos_byte
> BEG_BYTE
2808 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte
- 1))))))
2810 Lisp_Object tem
, string
;
2812 struct gcpro gcpro1
;
2814 tem
= current_buffer
->undo_list
;
2817 /* Make a multibyte string containing this single character. */
2818 string
= make_multibyte_string (tostr
, 1, len
);
2819 /* replace_range is less efficient, because it moves the gap,
2820 but it handles combining correctly. */
2821 replace_range (pos
, pos
+ 1, string
,
2823 pos_byte_next
= CHAR_TO_BYTE (pos
);
2824 if (pos_byte_next
> pos_byte
)
2825 /* Before combining happened. We should not increment
2826 POS. So, to cancel the later increment of POS,
2830 INC_POS (pos_byte_next
);
2832 if (! NILP (noundo
))
2833 current_buffer
->undo_list
= tem
;
2840 record_change (pos
, 1);
2841 for (i
= 0; i
< len
; i
++) *p
++ = tostr
[i
];
2843 last_changed
= pos
+ 1;
2845 pos_byte
= pos_byte_next
;
2851 signal_after_change (changed
,
2852 last_changed
- changed
, last_changed
- changed
);
2853 update_compositions (changed
, last_changed
, CHECK_ALL
);
2856 unbind_to (count
, Qnil
);
2860 DEFUN ("translate-region-internal", Ftranslate_region_internal
,
2861 Stranslate_region_internal
, 3, 3, 0,
2862 doc
: /* Internal use only.
2863 From START to END, translate characters according to TABLE.
2864 TABLE is a string; the Nth character in it is the mapping
2865 for the character with code N.
2866 It returns the number of characters changed. */)
2870 register Lisp_Object table
;
2872 register unsigned char *tt
; /* Trans table. */
2873 register int nc
; /* New character. */
2874 int cnt
; /* Number of changes made. */
2875 int size
; /* Size of translate table. */
2876 int pos
, pos_byte
, end_pos
;
2877 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2878 int string_multibyte
;
2880 validate_region (&start
, &end
);
2881 if (CHAR_TABLE_P (table
))
2888 CHECK_STRING (table
);
2890 if (! multibyte
&& (SCHARS (table
) < SBYTES (table
)))
2891 table
= string_make_unibyte (table
);
2892 string_multibyte
= SCHARS (table
) < SBYTES (table
);
2893 size
= SCHARS (table
);
2898 pos_byte
= CHAR_TO_BYTE (pos
);
2899 end_pos
= XINT (end
);
2900 modify_region (current_buffer
, pos
, XINT (end
), 0);
2903 for (; pos
< end_pos
; )
2905 register unsigned char *p
= BYTE_POS_ADDR (pos_byte
);
2906 unsigned char *str
, buf
[MAX_MULTIBYTE_LENGTH
];
2911 oc
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, len
);
2918 /* Reload as signal_after_change in last iteration may GC. */
2920 if (string_multibyte
)
2922 str
= tt
+ string_char_to_byte (table
, oc
);
2923 nc
= STRING_CHAR_AND_LENGTH (str
, MAX_MULTIBYTE_LENGTH
,
2929 if (! ASCII_BYTE_P (nc
) && multibyte
)
2931 str_len
= CHAR_STRING (nc
, buf
);
2947 val
= CHAR_TABLE_REF (table
, oc
);
2949 && (c
= XINT (val
), CHAR_VALID_P (c
, 0)))
2952 str_len
= CHAR_STRING (nc
, buf
);
2963 /* This is less efficient, because it moves the gap,
2964 but it should multibyte characters correctly. */
2965 string
= make_multibyte_string (str
, 1, str_len
);
2966 replace_range (pos
, pos
+ 1, string
, 1, 0, 1);
2971 record_change (pos
, 1);
2972 while (str_len
-- > 0)
2974 signal_after_change (pos
, 1, 1);
2975 update_compositions (pos
, pos
+ 1, CHECK_BORDER
);
2984 return make_number (cnt
);
2987 DEFUN ("delete-region", Fdelete_region
, Sdelete_region
, 2, 2, "r",
2988 doc
: /* Delete the text between point and mark.
2990 When called from a program, expects two arguments,
2991 positions (integers or markers) specifying the stretch to be deleted. */)
2993 Lisp_Object start
, end
;
2995 validate_region (&start
, &end
);
2996 del_range (XINT (start
), XINT (end
));
3000 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region
,
3001 Sdelete_and_extract_region
, 2, 2, 0,
3002 doc
: /* Delete the text between START and END and return it. */)
3004 Lisp_Object start
, end
;
3006 validate_region (&start
, &end
);
3007 if (XINT (start
) == XINT (end
))
3008 return build_string ("");
3009 return del_range_1 (XINT (start
), XINT (end
), 1, 1);
3012 DEFUN ("widen", Fwiden
, Swiden
, 0, 0, "",
3013 doc
: /* Remove restrictions (narrowing) from current buffer.
3014 This allows the buffer's full text to be seen and edited. */)
3017 if (BEG
!= BEGV
|| Z
!= ZV
)
3018 current_buffer
->clip_changed
= 1;
3020 BEGV_BYTE
= BEG_BYTE
;
3021 SET_BUF_ZV_BOTH (current_buffer
, Z
, Z_BYTE
);
3022 /* Changing the buffer bounds invalidates any recorded current column. */
3023 invalidate_current_column ();
3027 DEFUN ("narrow-to-region", Fnarrow_to_region
, Snarrow_to_region
, 2, 2, "r",
3028 doc
: /* Restrict editing in this buffer to the current region.
3029 The rest of the text becomes temporarily invisible and untouchable
3030 but is not deleted; if you save the buffer in a file, the invisible
3031 text is included in the file. \\[widen] makes all visible again.
3032 See also `save-restriction'.
3034 When calling from a program, pass two arguments; positions (integers
3035 or markers) bounding the text that should remain visible. */)
3037 register Lisp_Object start
, end
;
3039 CHECK_NUMBER_COERCE_MARKER (start
);
3040 CHECK_NUMBER_COERCE_MARKER (end
);
3042 if (XINT (start
) > XINT (end
))
3045 tem
= start
; start
= end
; end
= tem
;
3048 if (!(BEG
<= XINT (start
) && XINT (start
) <= XINT (end
) && XINT (end
) <= Z
))
3049 args_out_of_range (start
, end
);
3051 if (BEGV
!= XFASTINT (start
) || ZV
!= XFASTINT (end
))
3052 current_buffer
->clip_changed
= 1;
3054 SET_BUF_BEGV (current_buffer
, XFASTINT (start
));
3055 SET_BUF_ZV (current_buffer
, XFASTINT (end
));
3056 if (PT
< XFASTINT (start
))
3057 SET_PT (XFASTINT (start
));
3058 if (PT
> XFASTINT (end
))
3059 SET_PT (XFASTINT (end
));
3060 /* Changing the buffer bounds invalidates any recorded current column. */
3061 invalidate_current_column ();
3066 save_restriction_save ()
3068 if (BEGV
== BEG
&& ZV
== Z
)
3069 /* The common case that the buffer isn't narrowed.
3070 We return just the buffer object, which save_restriction_restore
3071 recognizes as meaning `no restriction'. */
3072 return Fcurrent_buffer ();
3074 /* We have to save a restriction, so return a pair of markers, one
3075 for the beginning and one for the end. */
3077 Lisp_Object beg
, end
;
3079 beg
= buildmark (BEGV
, BEGV_BYTE
);
3080 end
= buildmark (ZV
, ZV_BYTE
);
3082 /* END must move forward if text is inserted at its exact location. */
3083 XMARKER(end
)->insertion_type
= 1;
3085 return Fcons (beg
, end
);
3090 save_restriction_restore (data
)
3094 /* A pair of marks bounding a saved restriction. */
3096 struct Lisp_Marker
*beg
= XMARKER (XCAR (data
));
3097 struct Lisp_Marker
*end
= XMARKER (XCDR (data
));
3098 struct buffer
*buf
= beg
->buffer
; /* END should have the same buffer. */
3100 if (buf
/* Verify marker still points to a buffer. */
3101 && (beg
->charpos
!= BUF_BEGV (buf
) || end
->charpos
!= BUF_ZV (buf
)))
3102 /* The restriction has changed from the saved one, so restore
3103 the saved restriction. */
3105 int pt
= BUF_PT (buf
);
3107 SET_BUF_BEGV_BOTH (buf
, beg
->charpos
, beg
->bytepos
);
3108 SET_BUF_ZV_BOTH (buf
, end
->charpos
, end
->bytepos
);
3110 if (pt
< beg
->charpos
|| pt
> end
->charpos
)
3111 /* The point is outside the new visible range, move it inside. */
3112 SET_BUF_PT_BOTH (buf
,
3113 clip_to_bounds (beg
->charpos
, pt
, end
->charpos
),
3114 clip_to_bounds (beg
->bytepos
, BUF_PT_BYTE (buf
),
3117 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3121 /* A buffer, which means that there was no old restriction. */
3123 struct buffer
*buf
= XBUFFER (data
);
3125 if (buf
/* Verify marker still points to a buffer. */
3126 && (BUF_BEGV (buf
) != BUF_BEG (buf
) || BUF_ZV (buf
) != BUF_Z (buf
)))
3127 /* The buffer has been narrowed, get rid of the narrowing. */
3129 SET_BUF_BEGV_BOTH (buf
, BUF_BEG (buf
), BUF_BEG_BYTE (buf
));
3130 SET_BUF_ZV_BOTH (buf
, BUF_Z (buf
), BUF_Z_BYTE (buf
));
3132 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3139 DEFUN ("save-restriction", Fsave_restriction
, Ssave_restriction
, 0, UNEVALLED
, 0,
3140 doc
: /* Execute BODY, saving and restoring current buffer's restrictions.
3141 The buffer's restrictions make parts of the beginning and end invisible.
3142 (They are set up with `narrow-to-region' and eliminated with `widen'.)
3143 This special form, `save-restriction', saves the current buffer's restrictions
3144 when it is entered, and restores them when it is exited.
3145 So any `narrow-to-region' within BODY lasts only until the end of the form.
3146 The old restrictions settings are restored
3147 even in case of abnormal exit (throw or error).
3149 The value returned is the value of the last form in BODY.
3151 Note: if you are using both `save-excursion' and `save-restriction',
3152 use `save-excursion' outermost:
3153 (save-excursion (save-restriction ...))
3155 usage: (save-restriction &rest BODY) */)
3159 register Lisp_Object val
;
3160 int count
= SPECPDL_INDEX ();
3162 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
3163 val
= Fprogn (body
);
3164 return unbind_to (count
, val
);
3167 /* Buffer for the most recent text displayed by Fmessage_box. */
3168 static char *message_text
;
3170 /* Allocated length of that buffer. */
3171 static int message_length
;
3173 DEFUN ("message", Fmessage
, Smessage
, 1, MANY
, 0,
3174 doc
: /* Print a one-line message at the bottom of the screen.
3175 The message also goes into the `*Messages*' buffer.
3176 \(In keyboard macros, that's all it does.)
3178 The first argument is a format control string, and the rest are data
3179 to be formatted under control of the string. See `format' for details.
3181 If the first argument is nil or the empty string, the function clears
3182 any existing message; this lets the minibuffer contents show. See
3183 also `current-message'.
3185 usage: (message FORMAT-STRING &rest ARGS) */)
3191 || (STRINGP (args
[0])
3192 && SBYTES (args
[0]) == 0))
3199 register Lisp_Object val
;
3200 val
= Fformat (nargs
, args
);
3201 message3 (val
, SBYTES (val
), STRING_MULTIBYTE (val
));
3206 DEFUN ("message-box", Fmessage_box
, Smessage_box
, 1, MANY
, 0,
3207 doc
: /* Display a message, in a dialog box if possible.
3208 If a dialog box is not available, use the echo area.
3209 The first argument is a format control string, and the rest are data
3210 to be formatted under control of the string. See `format' for details.
3212 If the first argument is nil or the empty string, clear any existing
3213 message; let the minibuffer contents show.
3215 usage: (message-box FORMAT-STRING &rest ARGS) */)
3227 register Lisp_Object val
;
3228 val
= Fformat (nargs
, args
);
3230 /* The MS-DOS frames support popup menus even though they are
3231 not FRAME_WINDOW_P. */
3232 if (FRAME_WINDOW_P (XFRAME (selected_frame
))
3233 || FRAME_MSDOS_P (XFRAME (selected_frame
)))
3235 Lisp_Object pane
, menu
, obj
;
3236 struct gcpro gcpro1
;
3237 pane
= Fcons (Fcons (build_string ("OK"), Qt
), Qnil
);
3239 menu
= Fcons (val
, pane
);
3240 obj
= Fx_popup_dialog (Qt
, menu
, Qt
);
3244 #endif /* HAVE_MENUS */
3245 /* Copy the data so that it won't move when we GC. */
3248 message_text
= (char *)xmalloc (80);
3249 message_length
= 80;
3251 if (SBYTES (val
) > message_length
)
3253 message_length
= SBYTES (val
);
3254 message_text
= (char *)xrealloc (message_text
, message_length
);
3256 bcopy (SDATA (val
), message_text
, SBYTES (val
));
3257 message2 (message_text
, SBYTES (val
),
3258 STRING_MULTIBYTE (val
));
3263 extern Lisp_Object last_nonmenu_event
;
3266 DEFUN ("message-or-box", Fmessage_or_box
, Smessage_or_box
, 1, MANY
, 0,
3267 doc
: /* Display a message in a dialog box or in the echo area.
3268 If this command was invoked with the mouse, use a dialog box if
3269 `use-dialog-box' is non-nil.
3270 Otherwise, use the echo area.
3271 The first argument is a format control string, and the rest are data
3272 to be formatted under control of the string. See `format' for details.
3274 If the first argument is nil or the empty string, clear any existing
3275 message; let the minibuffer contents show.
3277 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3283 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
3285 return Fmessage_box (nargs
, args
);
3287 return Fmessage (nargs
, args
);
3290 DEFUN ("current-message", Fcurrent_message
, Scurrent_message
, 0, 0, 0,
3291 doc
: /* Return the string currently displayed in the echo area, or nil if none. */)
3294 return current_message ();
3298 DEFUN ("propertize", Fpropertize
, Spropertize
, 1, MANY
, 0,
3299 doc
: /* Return a copy of STRING with text properties added.
3300 First argument is the string to copy.
3301 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3302 properties to add to the result.
3303 usage: (propertize STRING &rest PROPERTIES) */)
3308 Lisp_Object properties
, string
;
3309 struct gcpro gcpro1
, gcpro2
;
3312 /* Number of args must be odd. */
3313 if ((nargs
& 1) == 0 || nargs
< 1)
3314 error ("Wrong number of arguments");
3316 properties
= string
= Qnil
;
3317 GCPRO2 (properties
, string
);
3319 /* First argument must be a string. */
3320 CHECK_STRING (args
[0]);
3321 string
= Fcopy_sequence (args
[0]);
3323 for (i
= 1; i
< nargs
; i
+= 2)
3324 properties
= Fcons (args
[i
], Fcons (args
[i
+ 1], properties
));
3326 Fadd_text_properties (make_number (0),
3327 make_number (SCHARS (string
)),
3328 properties
, string
);
3329 RETURN_UNGCPRO (string
);
3333 /* Number of bytes that STRING will occupy when put into the result.
3334 MULTIBYTE is nonzero if the result should be multibyte. */
3336 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3337 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3338 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3341 DEFUN ("format", Fformat
, Sformat
, 1, MANY
, 0,
3342 doc
: /* Format a string out of a format-string and arguments.
3343 The first argument is a format control string.
3344 The other arguments are substituted into it to make the result, a string.
3345 It may contain %-sequences meaning to substitute the next argument.
3346 %s means print a string argument. Actually, prints any object, with `princ'.
3347 %d means print as number in decimal (%o octal, %x hex).
3348 %X is like %x, but uses upper case.
3349 %e means print a number in exponential notation.
3350 %f means print a number in decimal-point notation.
3351 %g means print a number in exponential notation
3352 or decimal-point notation, whichever uses fewer characters.
3353 %c means print a number as a single character.
3354 %S means print any object as an s-expression (using `prin1').
3355 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3356 Use %% to put a single % into the output.
3358 The basic structure of a %-sequence is
3359 % <flags> <width> <precision> character
3360 where flags is [- #0]+, width is [0-9]+, and precision is .[0-9]+
3362 usage: (format STRING &rest OBJECTS) */)
3365 register Lisp_Object
*args
;
3367 register int n
; /* The number of the next arg to substitute */
3368 register int total
; /* An estimate of the final length */
3370 register unsigned char *format
, *end
, *format_start
;
3372 /* Nonzero if the output should be a multibyte string,
3373 which is true if any of the inputs is one. */
3375 /* When we make a multibyte string, we must pay attention to the
3376 byte combining problem, i.e., a byte may be combined with a
3377 multibyte charcter of the previous string. This flag tells if we
3378 must consider such a situation or not. */
3379 int maybe_combine_byte
;
3380 unsigned char *this_format
;
3381 /* Precision for each spec, or -1, a flag value meaning no precision
3382 was given in that spec. Element 0, corresonding to the format
3383 string itself, will not be used. Element NARGS, corresponding to
3384 no argument, *will* be assigned to in the case that a `%' and `.'
3385 occur after the final format specifier. */
3386 int *precision
= (int *) (alloca((nargs
+ 1) * sizeof (int)));
3389 int arg_intervals
= 0;
3392 /* discarded[I] is 1 if byte I of the format
3393 string was not copied into the output.
3394 It is 2 if byte I was not the first byte of its character. */
3395 char *discarded
= 0;
3397 /* Each element records, for one argument,
3398 the start and end bytepos in the output string,
3399 and whether the argument is a string with intervals.
3400 info[0] is unused. Unused elements have -1 for start. */
3403 int start
, end
, intervals
;
3406 /* It should not be necessary to GCPRO ARGS, because
3407 the caller in the interpreter should take care of that. */
3409 /* Try to determine whether the result should be multibyte.
3410 This is not always right; sometimes the result needs to be multibyte
3411 because of an object that we will pass through prin1,
3412 and in that case, we won't know it here. */
3413 for (n
= 0; n
< nargs
; n
++)
3415 if (STRINGP (args
[n
]) && STRING_MULTIBYTE (args
[n
]))
3417 /* Piggyback on this loop to initialize precision[N]. */
3420 precision
[nargs
] = -1;
3422 CHECK_STRING (args
[0]);
3423 /* We may have to change "%S" to "%s". */
3424 args
[0] = Fcopy_sequence (args
[0]);
3426 /* GC should never happen here, so abort if it does. */
3429 /* If we start out planning a unibyte result,
3430 then discover it has to be multibyte, we jump back to retry.
3431 That can only happen from the first large while loop below. */
3434 format
= SDATA (args
[0]);
3435 format_start
= format
;
3436 end
= format
+ SBYTES (args
[0]);
3439 /* Make room in result for all the non-%-codes in the control string. */
3440 total
= 5 + CONVERTED_BYTE_SIZE (multibyte
, args
[0]) + 1;
3442 /* Allocate the info and discarded tables. */
3444 int nbytes
= (nargs
+1) * sizeof *info
;
3447 info
= (struct info
*) alloca (nbytes
);
3448 bzero (info
, nbytes
);
3449 for (i
= 0; i
<= nargs
; i
++)
3452 SAFE_ALLOCA (discarded
, char *, SBYTES (args
[0]));
3453 bzero (discarded
, SBYTES (args
[0]));
3456 /* Add to TOTAL enough space to hold the converted arguments. */
3459 while (format
!= end
)
3460 if (*format
++ == '%')
3463 int actual_width
= 0;
3464 unsigned char *this_format_start
= format
- 1;
3465 int field_width
= 0;
3467 /* General format specifications look like
3469 '%' [flags] [field-width] [precision] format
3474 field-width ::= [0-9]+
3475 precision ::= '.' [0-9]*
3477 If a field-width is specified, it specifies to which width
3478 the output should be padded with blanks, iff the output
3479 string is shorter than field-width.
3481 If precision is specified, it specifies the number of
3482 digits to print after the '.' for floats, or the max.
3483 number of chars to print from a string. */
3485 while (format
!= end
3486 && (*format
== '-' || *format
== '0' || *format
== '#'
3487 || * format
== ' '))
3490 if (*format
>= '0' && *format
<= '9')
3492 for (field_width
= 0; *format
>= '0' && *format
<= '9'; ++format
)
3493 field_width
= 10 * field_width
+ *format
- '0';
3496 /* N is not incremented for another few lines below, so refer to
3497 element N+1 (which might be precision[NARGS]). */
3501 for (precision
[n
+1] = 0; *format
>= '0' && *format
<= '9'; ++format
)
3502 precision
[n
+1] = 10 * precision
[n
+1] + *format
- '0';
3505 if (format
- this_format_start
+ 1 > longest_format
)
3506 longest_format
= format
- this_format_start
+ 1;
3509 error ("Format string ends in middle of format specifier");
3512 else if (++n
>= nargs
)
3513 error ("Not enough arguments for format string");
3514 else if (*format
== 'S')
3516 /* For `S', prin1 the argument and then treat like a string. */
3517 register Lisp_Object tem
;
3518 tem
= Fprin1_to_string (args
[n
], Qnil
);
3519 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3525 /* If we restart the loop, we should not come here again
3526 because args[n] is now a string and calling
3527 Fprin1_to_string on it produces superflous double
3528 quotes. So, change "%S" to "%s" now. */
3532 else if (SYMBOLP (args
[n
]))
3534 args
[n
] = SYMBOL_NAME (args
[n
]);
3535 if (STRING_MULTIBYTE (args
[n
]) && ! multibyte
)
3542 else if (STRINGP (args
[n
]))
3545 if (*format
!= 's' && *format
!= 'S')
3546 error ("Format specifier doesn't match argument type");
3547 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3548 to be as large as is calculated here. Easy check for
3549 the case PRECISION = 0. */
3550 thissize
= precision
[n
] ? CONVERTED_BYTE_SIZE (multibyte
, args
[n
]) : 0;
3551 actual_width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3553 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3554 else if (INTEGERP (args
[n
]) && *format
!= 's')
3556 /* The following loop assumes the Lisp type indicates
3557 the proper way to pass the argument.
3558 So make sure we have a flonum if the argument should
3560 if (*format
== 'e' || *format
== 'f' || *format
== 'g')
3561 args
[n
] = Ffloat (args
[n
]);
3563 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3564 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3565 error ("Invalid format operation %%%c", *format
);
3570 if (! SINGLE_BYTE_CHAR_P (XINT (args
[n
]))
3571 /* Note: No one can remember why we have to treat
3572 the character 0 as a multibyte character here.
3573 But, until it causes a real problem, let's
3575 || XINT (args
[n
]) == 0)
3582 args
[n
] = Fchar_to_string (args
[n
]);
3583 thissize
= SBYTES (args
[n
]);
3585 else if (! ASCII_BYTE_P (XINT (args
[n
])) && multibyte
)
3588 = Fchar_to_string (Funibyte_char_to_multibyte (args
[n
]));
3589 thissize
= SBYTES (args
[n
]);
3593 else if (FLOATP (args
[n
]) && *format
!= 's')
3595 if (! (*format
== 'e' || *format
== 'f' || *format
== 'g'))
3597 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3598 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3599 error ("Invalid format operation %%%c", *format
);
3600 args
[n
] = Ftruncate (args
[n
], Qnil
);
3603 /* Note that we're using sprintf to print floats,
3604 so we have to take into account what that function
3606 /* Filter out flag value of -1. */
3607 thissize
= (MAX_10_EXP
+ 100
3608 + (precision
[n
] > 0 ? precision
[n
] : 0));
3612 /* Anything but a string, convert to a string using princ. */
3613 register Lisp_Object tem
;
3614 tem
= Fprin1_to_string (args
[n
], Qt
);
3615 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3624 thissize
+= max (0, field_width
- actual_width
);
3625 total
+= thissize
+ 4;
3630 /* Now we can no longer jump to retry.
3631 TOTAL and LONGEST_FORMAT are known for certain. */
3633 this_format
= (unsigned char *) alloca (longest_format
+ 1);
3635 /* Allocate the space for the result.
3636 Note that TOTAL is an overestimate. */
3637 SAFE_ALLOCA (buf
, char *, total
);
3643 /* Scan the format and store result in BUF. */
3644 format
= SDATA (args
[0]);
3645 format_start
= format
;
3646 end
= format
+ SBYTES (args
[0]);
3647 maybe_combine_byte
= 0;
3648 while (format
!= end
)
3654 unsigned char *this_format_start
= format
;
3656 discarded
[format
- format_start
] = 1;
3659 while (index("-0# ", *format
))
3665 discarded
[format
- format_start
] = 1;
3669 minlen
= atoi (format
);
3671 while ((*format
>= '0' && *format
<= '9') || *format
== '.')
3673 discarded
[format
- format_start
] = 1;
3677 if (*format
++ == '%')
3686 discarded
[format
- format_start
- 1] = 1;
3687 info
[n
].start
= nchars
;
3689 if (STRINGP (args
[n
]))
3691 /* handle case (precision[n] >= 0) */
3694 int nbytes
, start
, end
;
3697 /* lisp_string_width ignores a precision of 0, but GNU
3698 libc functions print 0 characters when the precision
3699 is 0. Imitate libc behavior here. Changing
3700 lisp_string_width is the right thing, and will be
3701 done, but meanwhile we work with it. */
3703 if (precision
[n
] == 0)
3704 width
= nchars_string
= nbytes
= 0;
3705 else if (precision
[n
] > 0)
3706 width
= lisp_string_width (args
[n
], precision
[n
], &nchars_string
, &nbytes
);
3708 { /* no precision spec given for this argument */
3709 width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3710 nbytes
= SBYTES (args
[n
]);
3711 nchars_string
= SCHARS (args
[n
]);
3714 /* If spec requires it, pad on right with spaces. */
3715 padding
= minlen
- width
;
3717 while (padding
-- > 0)
3723 info
[n
].start
= start
= nchars
;
3724 nchars
+= nchars_string
;
3729 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3730 && STRING_MULTIBYTE (args
[n
])
3731 && !CHAR_HEAD_P (SREF (args
[n
], 0)))
3732 maybe_combine_byte
= 1;
3734 p
+= copy_text (SDATA (args
[n
]), p
,
3736 STRING_MULTIBYTE (args
[n
]), multibyte
);
3738 info
[n
].end
= nchars
;
3741 while (padding
-- > 0)
3747 /* If this argument has text properties, record where
3748 in the result string it appears. */
3749 if (STRING_INTERVALS (args
[n
]))
3750 info
[n
].intervals
= arg_intervals
= 1;
3752 else if (INTEGERP (args
[n
]) || FLOATP (args
[n
]))
3756 bcopy (this_format_start
, this_format
,
3757 format
- this_format_start
);
3758 this_format
[format
- this_format_start
] = 0;
3760 if (INTEGERP (args
[n
]))
3762 if (format
[-1] == 'd')
3763 sprintf (p
, this_format
, XINT (args
[n
]));
3764 /* Don't sign-extend for octal or hex printing. */
3766 sprintf (p
, this_format
, XUINT (args
[n
]));
3769 sprintf (p
, this_format
, XFLOAT_DATA (args
[n
]));
3773 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3774 && !CHAR_HEAD_P (*((unsigned char *) p
)))
3775 maybe_combine_byte
= 1;
3776 this_nchars
= strlen (p
);
3778 p
+= str_to_multibyte (p
, buf
+ total
- 1 - p
, this_nchars
);
3781 nchars
+= this_nchars
;
3782 info
[n
].end
= nchars
;
3786 else if (STRING_MULTIBYTE (args
[0]))
3788 /* Copy a whole multibyte character. */
3791 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3792 && !CHAR_HEAD_P (*format
))
3793 maybe_combine_byte
= 1;
3795 while (! CHAR_HEAD_P (*format
))
3797 discarded
[format
- format_start
] = 2;
3804 /* Convert a single-byte character to multibyte. */
3805 int len
= copy_text (format
, p
, 1, 0, 1);
3812 *p
++ = *format
++, nchars
++;
3815 if (p
> buf
+ total
)
3818 if (maybe_combine_byte
)
3819 nchars
= multibyte_chars_in_text (buf
, p
- buf
);
3820 val
= make_specified_string (buf
, nchars
, p
- buf
, multibyte
);
3822 /* If we allocated BUF with malloc, free it too. */
3825 /* If the format string has text properties, or any of the string
3826 arguments has text properties, set up text properties of the
3829 if (STRING_INTERVALS (args
[0]) || arg_intervals
)
3831 Lisp_Object len
, new_len
, props
;
3832 struct gcpro gcpro1
;
3834 /* Add text properties from the format string. */
3835 len
= make_number (SCHARS (args
[0]));
3836 props
= text_property_list (args
[0], make_number (0), len
, Qnil
);
3841 int bytepos
= 0, position
= 0, translated
= 0, argn
= 1;
3844 /* Adjust the bounds of each text property
3845 to the proper start and end in the output string. */
3847 /* Put the positions in PROPS in increasing order, so that
3848 we can do (effectively) one scan through the position
3849 space of the format string. */
3850 props
= Fnreverse (props
);
3852 /* BYTEPOS is the byte position in the format string,
3853 POSITION is the untranslated char position in it,
3854 TRANSLATED is the translated char position in BUF,
3855 and ARGN is the number of the next arg we will come to. */
3856 for (list
= props
; CONSP (list
); list
= XCDR (list
))
3863 /* First adjust the property start position. */
3864 pos
= XINT (XCAR (item
));
3866 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
3867 up to this position. */
3868 for (; position
< pos
; bytepos
++)
3870 if (! discarded
[bytepos
])
3871 position
++, translated
++;
3872 else if (discarded
[bytepos
] == 1)
3875 if (translated
== info
[argn
].start
)
3877 translated
+= info
[argn
].end
- info
[argn
].start
;
3883 XSETCAR (item
, make_number (translated
));
3885 /* Likewise adjust the property end position. */
3886 pos
= XINT (XCAR (XCDR (item
)));
3888 for (; position
< pos
; bytepos
++)
3890 if (! discarded
[bytepos
])
3891 position
++, translated
++;
3892 else if (discarded
[bytepos
] == 1)
3895 if (translated
== info
[argn
].start
)
3897 translated
+= info
[argn
].end
- info
[argn
].start
;
3903 XSETCAR (XCDR (item
), make_number (translated
));
3906 add_text_properties_from_list (val
, props
, make_number (0));
3909 /* Add text properties from arguments. */
3911 for (n
= 1; n
< nargs
; ++n
)
3912 if (info
[n
].intervals
)
3914 len
= make_number (SCHARS (args
[n
]));
3915 new_len
= make_number (info
[n
].end
- info
[n
].start
);
3916 props
= text_property_list (args
[n
], make_number (0), len
, Qnil
);
3917 extend_property_ranges (props
, len
, new_len
);
3918 /* If successive arguments have properites, be sure that
3919 the value of `composition' property be the copy. */
3920 if (n
> 1 && info
[n
- 1].end
)
3921 make_composition_value_copy (props
);
3922 add_text_properties_from_list (val
, props
,
3923 make_number (info
[n
].start
));
3933 format2 (string1
, arg0
, arg1
)
3935 Lisp_Object arg0
, arg1
;
3937 Lisp_Object args
[3];
3938 args
[0] = build_string (string1
);
3941 return Fformat (3, args
);
3944 DEFUN ("char-equal", Fchar_equal
, Schar_equal
, 2, 2, 0,
3945 doc
: /* Return t if two characters match, optionally ignoring case.
3946 Both arguments must be characters (i.e. integers).
3947 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
3949 register Lisp_Object c1
, c2
;
3955 if (XINT (c1
) == XINT (c2
))
3957 if (NILP (current_buffer
->case_fold_search
))
3960 /* Do these in separate statements,
3961 then compare the variables.
3962 because of the way DOWNCASE uses temp variables. */
3963 i1
= DOWNCASE (XFASTINT (c1
));
3964 i2
= DOWNCASE (XFASTINT (c2
));
3965 return (i1
== i2
? Qt
: Qnil
);
3968 /* Transpose the markers in two regions of the current buffer, and
3969 adjust the ones between them if necessary (i.e.: if the regions
3972 START1, END1 are the character positions of the first region.
3973 START1_BYTE, END1_BYTE are the byte positions.
3974 START2, END2 are the character positions of the second region.
3975 START2_BYTE, END2_BYTE are the byte positions.
3977 Traverses the entire marker list of the buffer to do so, adding an
3978 appropriate amount to some, subtracting from some, and leaving the
3979 rest untouched. Most of this is copied from adjust_markers in insdel.c.
3981 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
3984 transpose_markers (start1
, end1
, start2
, end2
,
3985 start1_byte
, end1_byte
, start2_byte
, end2_byte
)
3986 register int start1
, end1
, start2
, end2
;
3987 register int start1_byte
, end1_byte
, start2_byte
, end2_byte
;
3989 register int amt1
, amt1_byte
, amt2
, amt2_byte
, diff
, diff_byte
, mpos
;
3990 register struct Lisp_Marker
*marker
;
3992 /* Update point as if it were a marker. */
3996 TEMP_SET_PT_BOTH (PT
+ (end2
- end1
),
3997 PT_BYTE
+ (end2_byte
- end1_byte
));
3998 else if (PT
< start2
)
3999 TEMP_SET_PT_BOTH (PT
+ (end2
- start2
) - (end1
- start1
),
4000 (PT_BYTE
+ (end2_byte
- start2_byte
)
4001 - (end1_byte
- start1_byte
)));
4003 TEMP_SET_PT_BOTH (PT
- (start2
- start1
),
4004 PT_BYTE
- (start2_byte
- start1_byte
));
4006 /* We used to adjust the endpoints here to account for the gap, but that
4007 isn't good enough. Even if we assume the caller has tried to move the
4008 gap out of our way, it might still be at start1 exactly, for example;
4009 and that places it `inside' the interval, for our purposes. The amount
4010 of adjustment is nontrivial if there's a `denormalized' marker whose
4011 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4012 the dirty work to Fmarker_position, below. */
4014 /* The difference between the region's lengths */
4015 diff
= (end2
- start2
) - (end1
- start1
);
4016 diff_byte
= (end2_byte
- start2_byte
) - (end1_byte
- start1_byte
);
4018 /* For shifting each marker in a region by the length of the other
4019 region plus the distance between the regions. */
4020 amt1
= (end2
- start2
) + (start2
- end1
);
4021 amt2
= (end1
- start1
) + (start2
- end1
);
4022 amt1_byte
= (end2_byte
- start2_byte
) + (start2_byte
- end1_byte
);
4023 amt2_byte
= (end1_byte
- start1_byte
) + (start2_byte
- end1_byte
);
4025 for (marker
= BUF_MARKERS (current_buffer
); marker
; marker
= marker
->next
)
4027 mpos
= marker
->bytepos
;
4028 if (mpos
>= start1_byte
&& mpos
< end2_byte
)
4030 if (mpos
< end1_byte
)
4032 else if (mpos
< start2_byte
)
4036 marker
->bytepos
= mpos
;
4038 mpos
= marker
->charpos
;
4039 if (mpos
>= start1
&& mpos
< end2
)
4043 else if (mpos
< start2
)
4048 marker
->charpos
= mpos
;
4052 DEFUN ("transpose-regions", Ftranspose_regions
, Stranspose_regions
, 4, 5, 0,
4053 doc
: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4054 The regions may not be overlapping, because the size of the buffer is
4055 never changed in a transposition.
4057 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4058 any markers that happen to be located in the regions.
4060 Transposing beyond buffer boundaries is an error. */)
4061 (startr1
, endr1
, startr2
, endr2
, leave_markers
)
4062 Lisp_Object startr1
, endr1
, startr2
, endr2
, leave_markers
;
4064 register int start1
, end1
, start2
, end2
;
4065 int start1_byte
, start2_byte
, len1_byte
, len2_byte
;
4066 int gap
, len1
, len_mid
, len2
;
4067 unsigned char *start1_addr
, *start2_addr
, *temp
;
4069 INTERVAL cur_intv
, tmp_interval1
, tmp_interval_mid
, tmp_interval2
;
4070 cur_intv
= BUF_INTERVALS (current_buffer
);
4072 validate_region (&startr1
, &endr1
);
4073 validate_region (&startr2
, &endr2
);
4075 start1
= XFASTINT (startr1
);
4076 end1
= XFASTINT (endr1
);
4077 start2
= XFASTINT (startr2
);
4078 end2
= XFASTINT (endr2
);
4081 /* Swap the regions if they're reversed. */
4084 register int glumph
= start1
;
4092 len1
= end1
- start1
;
4093 len2
= end2
- start2
;
4096 error ("Transposed regions overlap");
4097 else if (start1
== end1
|| start2
== end2
)
4098 error ("Transposed region has length 0");
4100 /* The possibilities are:
4101 1. Adjacent (contiguous) regions, or separate but equal regions
4102 (no, really equal, in this case!), or
4103 2. Separate regions of unequal size.
4105 The worst case is usually No. 2. It means that (aside from
4106 potential need for getting the gap out of the way), there also
4107 needs to be a shifting of the text between the two regions. So
4108 if they are spread far apart, we are that much slower... sigh. */
4110 /* It must be pointed out that the really studly thing to do would
4111 be not to move the gap at all, but to leave it in place and work
4112 around it if necessary. This would be extremely efficient,
4113 especially considering that people are likely to do
4114 transpositions near where they are working interactively, which
4115 is exactly where the gap would be found. However, such code
4116 would be much harder to write and to read. So, if you are
4117 reading this comment and are feeling squirrely, by all means have
4118 a go! I just didn't feel like doing it, so I will simply move
4119 the gap the minimum distance to get it out of the way, and then
4120 deal with an unbroken array. */
4122 /* Make sure the gap won't interfere, by moving it out of the text
4123 we will operate on. */
4124 if (start1
< gap
&& gap
< end2
)
4126 if (gap
- start1
< end2
- gap
)
4132 start1_byte
= CHAR_TO_BYTE (start1
);
4133 start2_byte
= CHAR_TO_BYTE (start2
);
4134 len1_byte
= CHAR_TO_BYTE (end1
) - start1_byte
;
4135 len2_byte
= CHAR_TO_BYTE (end2
) - start2_byte
;
4137 #ifdef BYTE_COMBINING_DEBUG
4140 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4141 len2_byte
, start1
, start1_byte
)
4142 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4143 len1_byte
, end2
, start2_byte
+ len2_byte
)
4144 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4145 len1_byte
, end2
, start2_byte
+ len2_byte
))
4150 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4151 len2_byte
, start1
, start1_byte
)
4152 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4153 len1_byte
, start2
, start2_byte
)
4154 || count_combining_after (BYTE_POS_ADDR (start2_byte
),
4155 len2_byte
, end1
, start1_byte
+ len1_byte
)
4156 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4157 len1_byte
, end2
, start2_byte
+ len2_byte
))
4162 /* Hmmm... how about checking to see if the gap is large
4163 enough to use as the temporary storage? That would avoid an
4164 allocation... interesting. Later, don't fool with it now. */
4166 /* Working without memmove, for portability (sigh), so must be
4167 careful of overlapping subsections of the array... */
4169 if (end1
== start2
) /* adjacent regions */
4171 modify_region (current_buffer
, start1
, end2
, 0);
4172 record_change (start1
, len1
+ len2
);
4174 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4175 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4176 Fset_text_properties (make_number (start1
), make_number (end2
),
4179 /* First region smaller than second. */
4180 if (len1_byte
< len2_byte
)
4184 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4186 /* Don't precompute these addresses. We have to compute them
4187 at the last minute, because the relocating allocator might
4188 have moved the buffer around during the xmalloc. */
4189 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4190 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4192 bcopy (start2_addr
, temp
, len2_byte
);
4193 bcopy (start1_addr
, start1_addr
+ len2_byte
, len1_byte
);
4194 bcopy (temp
, start1_addr
, len2_byte
);
4198 /* First region not smaller than second. */
4202 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4203 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4204 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4205 bcopy (start1_addr
, temp
, len1_byte
);
4206 bcopy (start2_addr
, start1_addr
, len2_byte
);
4207 bcopy (temp
, start1_addr
+ len2_byte
, len1_byte
);
4210 graft_intervals_into_buffer (tmp_interval1
, start1
+ len2
,
4211 len1
, current_buffer
, 0);
4212 graft_intervals_into_buffer (tmp_interval2
, start1
,
4213 len2
, current_buffer
, 0);
4214 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4215 update_compositions (start1
+ len2
, end2
, CHECK_TAIL
);
4217 /* Non-adjacent regions, because end1 != start2, bleagh... */
4220 len_mid
= start2_byte
- (start1_byte
+ len1_byte
);
4222 if (len1_byte
== len2_byte
)
4223 /* Regions are same size, though, how nice. */
4227 modify_region (current_buffer
, start1
, end1
, 0);
4228 modify_region (current_buffer
, start2
, end2
, 0);
4229 record_change (start1
, len1
);
4230 record_change (start2
, len2
);
4231 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4232 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4233 Fset_text_properties (make_number (start1
), make_number (end1
),
4235 Fset_text_properties (make_number (start2
), make_number (end2
),
4238 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4239 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4240 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4241 bcopy (start1_addr
, temp
, len1_byte
);
4242 bcopy (start2_addr
, start1_addr
, len2_byte
);
4243 bcopy (temp
, start2_addr
, len1_byte
);
4246 graft_intervals_into_buffer (tmp_interval1
, start2
,
4247 len1
, current_buffer
, 0);
4248 graft_intervals_into_buffer (tmp_interval2
, start1
,
4249 len2
, current_buffer
, 0);
4252 else if (len1_byte
< len2_byte
) /* Second region larger than first */
4253 /* Non-adjacent & unequal size, area between must also be shifted. */
4257 modify_region (current_buffer
, start1
, end2
, 0);
4258 record_change (start1
, (end2
- start1
));
4259 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4260 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4261 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4262 Fset_text_properties (make_number (start1
), make_number (end2
),
4265 /* holds region 2 */
4266 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4267 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4268 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4269 bcopy (start2_addr
, temp
, len2_byte
);
4270 bcopy (start1_addr
, start1_addr
+ len_mid
+ len2_byte
, len1_byte
);
4271 safe_bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4272 bcopy (temp
, start1_addr
, len2_byte
);
4275 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4276 len1
, current_buffer
, 0);
4277 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4278 len_mid
, current_buffer
, 0);
4279 graft_intervals_into_buffer (tmp_interval2
, start1
,
4280 len2
, current_buffer
, 0);
4283 /* Second region smaller than first. */
4287 record_change (start1
, (end2
- start1
));
4288 modify_region (current_buffer
, start1
, end2
, 0);
4290 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4291 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4292 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4293 Fset_text_properties (make_number (start1
), make_number (end2
),
4296 /* holds region 1 */
4297 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4298 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4299 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4300 bcopy (start1_addr
, temp
, len1_byte
);
4301 bcopy (start2_addr
, start1_addr
, len2_byte
);
4302 bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4303 bcopy (temp
, start1_addr
+ len2_byte
+ len_mid
, len1_byte
);
4306 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4307 len1
, current_buffer
, 0);
4308 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4309 len_mid
, current_buffer
, 0);
4310 graft_intervals_into_buffer (tmp_interval2
, start1
,
4311 len2
, current_buffer
, 0);
4314 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4315 update_compositions (end2
- len1
, end2
, CHECK_BORDER
);
4318 /* When doing multiple transpositions, it might be nice
4319 to optimize this. Perhaps the markers in any one buffer
4320 should be organized in some sorted data tree. */
4321 if (NILP (leave_markers
))
4323 transpose_markers (start1
, end1
, start2
, end2
,
4324 start1_byte
, start1_byte
+ len1_byte
,
4325 start2_byte
, start2_byte
+ len2_byte
);
4326 fix_start_end_in_overlays (start1
, end2
);
4338 Qbuffer_access_fontify_functions
4339 = intern ("buffer-access-fontify-functions");
4340 staticpro (&Qbuffer_access_fontify_functions
);
4342 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion
,
4343 doc
: /* Non-nil means text motion commands don't notice fields. */);
4344 Vinhibit_field_text_motion
= Qnil
;
4346 DEFVAR_LISP ("buffer-access-fontify-functions",
4347 &Vbuffer_access_fontify_functions
,
4348 doc
: /* List of functions called by `buffer-substring' to fontify if necessary.
4349 Each function is called with two arguments which specify the range
4350 of the buffer being accessed. */);
4351 Vbuffer_access_fontify_functions
= Qnil
;
4355 extern Lisp_Object Vprin1_to_string_buffer
;
4356 obuf
= Fcurrent_buffer ();
4357 /* Do this here, because init_buffer_once is too early--it won't work. */
4358 Fset_buffer (Vprin1_to_string_buffer
);
4359 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4360 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
4365 DEFVAR_LISP ("buffer-access-fontified-property",
4366 &Vbuffer_access_fontified_property
,
4367 doc
: /* Property which (if non-nil) indicates text has been fontified.
4368 `buffer-substring' need not call the `buffer-access-fontify-functions'
4369 functions if all the text being accessed has this property. */);
4370 Vbuffer_access_fontified_property
= Qnil
;
4372 DEFVAR_LISP ("system-name", &Vsystem_name
,
4373 doc
: /* The name of the machine Emacs is running on. */);
4375 DEFVAR_LISP ("user-full-name", &Vuser_full_name
,
4376 doc
: /* The full name of the user logged in. */);
4378 DEFVAR_LISP ("user-login-name", &Vuser_login_name
,
4379 doc
: /* The user's name, taken from environment variables if possible. */);
4381 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name
,
4382 doc
: /* The user's name, based upon the real uid only. */);
4384 DEFVAR_LISP ("operating-system-release", &Voperating_system_release
,
4385 doc
: /* The release of the operating system Emacs is running on. */);
4387 defsubr (&Spropertize
);
4388 defsubr (&Schar_equal
);
4389 defsubr (&Sgoto_char
);
4390 defsubr (&Sstring_to_char
);
4391 defsubr (&Schar_to_string
);
4392 defsubr (&Sbuffer_substring
);
4393 defsubr (&Sbuffer_substring_no_properties
);
4394 defsubr (&Sbuffer_string
);
4396 defsubr (&Spoint_marker
);
4397 defsubr (&Smark_marker
);
4399 defsubr (&Sregion_beginning
);
4400 defsubr (&Sregion_end
);
4402 staticpro (&Qfield
);
4403 Qfield
= intern ("field");
4404 staticpro (&Qboundary
);
4405 Qboundary
= intern ("boundary");
4406 defsubr (&Sfield_beginning
);
4407 defsubr (&Sfield_end
);
4408 defsubr (&Sfield_string
);
4409 defsubr (&Sfield_string_no_properties
);
4410 defsubr (&Sdelete_field
);
4411 defsubr (&Sconstrain_to_field
);
4413 defsubr (&Sline_beginning_position
);
4414 defsubr (&Sline_end_position
);
4416 /* defsubr (&Smark); */
4417 /* defsubr (&Sset_mark); */
4418 defsubr (&Ssave_excursion
);
4419 defsubr (&Ssave_current_buffer
);
4421 defsubr (&Sbufsize
);
4422 defsubr (&Spoint_max
);
4423 defsubr (&Spoint_min
);
4424 defsubr (&Spoint_min_marker
);
4425 defsubr (&Spoint_max_marker
);
4426 defsubr (&Sgap_position
);
4427 defsubr (&Sgap_size
);
4428 defsubr (&Sposition_bytes
);
4429 defsubr (&Sbyte_to_position
);
4435 defsubr (&Sfollowing_char
);
4436 defsubr (&Sprevious_char
);
4437 defsubr (&Schar_after
);
4438 defsubr (&Schar_before
);
4440 defsubr (&Sinsert_before_markers
);
4441 defsubr (&Sinsert_and_inherit
);
4442 defsubr (&Sinsert_and_inherit_before_markers
);
4443 defsubr (&Sinsert_char
);
4445 defsubr (&Suser_login_name
);
4446 defsubr (&Suser_real_login_name
);
4447 defsubr (&Suser_uid
);
4448 defsubr (&Suser_real_uid
);
4449 defsubr (&Suser_full_name
);
4450 defsubr (&Semacs_pid
);
4451 defsubr (&Scurrent_time
);
4452 defsubr (&Sget_internal_run_time
);
4453 defsubr (&Sformat_time_string
);
4454 defsubr (&Sfloat_time
);
4455 defsubr (&Sdecode_time
);
4456 defsubr (&Sencode_time
);
4457 defsubr (&Scurrent_time_string
);
4458 defsubr (&Scurrent_time_zone
);
4459 defsubr (&Sset_time_zone_rule
);
4460 defsubr (&Ssystem_name
);
4461 defsubr (&Smessage
);
4462 defsubr (&Smessage_box
);
4463 defsubr (&Smessage_or_box
);
4464 defsubr (&Scurrent_message
);
4467 defsubr (&Sinsert_buffer_substring
);
4468 defsubr (&Scompare_buffer_substrings
);
4469 defsubr (&Ssubst_char_in_region
);
4470 defsubr (&Stranslate_region_internal
);
4471 defsubr (&Sdelete_region
);
4472 defsubr (&Sdelete_and_extract_region
);
4474 defsubr (&Snarrow_to_region
);
4475 defsubr (&Ssave_restriction
);
4476 defsubr (&Stranspose_regions
);
4479 /* arch-tag: fc3827d8-6f60-4067-b11e-c3218031b018
4480 (do not change this comment) */