1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985,86,87,89,93,94,95,96,97,98,1999,2000,01,02,03,2004
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
24 #include <sys/types.h>
36 /* Without this, sprintf on Mac OS Classic will produce wrong
42 #ifdef HAVE_SYS_TIME_H
46 #if defined HAVE_SYS_RESOURCE_H
47 #include <sys/resource.h>
53 #include "intervals.h"
64 #define MAX_10_EXP DBL_MAX_10_EXP
66 #define MAX_10_EXP 310
74 extern char **environ
;
77 extern Lisp_Object make_time
P_ ((time_t));
78 extern size_t emacs_strftimeu
P_ ((char *, size_t, const char *,
79 const struct tm
*, int));
80 static int tm_diff
P_ ((struct tm
*, struct tm
*));
81 static void find_field
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, int *, Lisp_Object
, int *));
82 static void update_buffer_properties
P_ ((int, int));
83 static Lisp_Object region_limit
P_ ((int));
84 int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
85 static size_t emacs_memftimeu
P_ ((char *, size_t, const char *,
86 size_t, const struct tm
*, int));
87 static void general_insert_function
P_ ((void (*) (const unsigned char *, int),
88 void (*) (Lisp_Object
, int, int, int,
90 int, int, Lisp_Object
*));
91 static Lisp_Object subst_char_in_region_unwind
P_ ((Lisp_Object
));
92 static Lisp_Object subst_char_in_region_unwind_1
P_ ((Lisp_Object
));
93 static void transpose_markers
P_ ((int, int, int, int, int, int, int, int));
96 extern char *index
P_ ((const char *, int));
99 Lisp_Object Vbuffer_access_fontify_functions
;
100 Lisp_Object Qbuffer_access_fontify_functions
;
101 Lisp_Object Vbuffer_access_fontified_property
;
103 Lisp_Object Fuser_full_name
P_ ((Lisp_Object
));
105 /* Non-nil means don't stop at field boundary in text motion commands. */
107 Lisp_Object Vinhibit_field_text_motion
;
109 /* Some static data, and a function to initialize it for each run */
111 Lisp_Object Vsystem_name
;
112 Lisp_Object Vuser_real_login_name
; /* login name of current user ID */
113 Lisp_Object Vuser_full_name
; /* full name of current user */
114 Lisp_Object Vuser_login_name
; /* user name from LOGNAME or USER */
116 /* Symbol for the text property used to mark fields. */
120 /* A special value for Qfield properties. */
122 Lisp_Object Qboundary
;
129 register unsigned char *p
;
130 struct passwd
*pw
; /* password entry for the current user */
133 /* Set up system_name even when dumping. */
137 /* Don't bother with this on initial start when just dumping out */
140 #endif /* not CANNOT_DUMP */
142 pw
= (struct passwd
*) getpwuid (getuid ());
144 /* We let the real user name default to "root" because that's quite
145 accurate on MSDOG and because it lets Emacs find the init file.
146 (The DVX libraries override the Djgpp libraries here.) */
147 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "root");
149 Vuser_real_login_name
= build_string (pw
? pw
->pw_name
: "unknown");
152 /* Get the effective user name, by consulting environment variables,
153 or the effective uid if those are unset. */
154 user_name
= (char *) getenv ("LOGNAME");
157 user_name
= (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
158 #else /* WINDOWSNT */
159 user_name
= (char *) getenv ("USER");
160 #endif /* WINDOWSNT */
163 pw
= (struct passwd
*) getpwuid (geteuid ());
164 user_name
= (char *) (pw
? pw
->pw_name
: "unknown");
166 Vuser_login_name
= build_string (user_name
);
168 /* If the user name claimed in the environment vars differs from
169 the real uid, use the claimed name to find the full name. */
170 tem
= Fstring_equal (Vuser_login_name
, Vuser_real_login_name
);
171 Vuser_full_name
= Fuser_full_name (NILP (tem
)? make_number (geteuid())
174 p
= (unsigned char *) getenv ("NAME");
176 Vuser_full_name
= build_string (p
);
177 else if (NILP (Vuser_full_name
))
178 Vuser_full_name
= build_string ("unknown");
181 DEFUN ("char-to-string", Fchar_to_string
, Schar_to_string
, 1, 1, 0,
182 doc
: /* Convert arg CHAR to a string containing that character.
183 usage: (char-to-string CHAR) */)
185 Lisp_Object character
;
188 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
190 CHECK_NUMBER (character
);
192 len
= (SINGLE_BYTE_CHAR_P (XFASTINT (character
))
193 ? (*str
= (unsigned char)(XFASTINT (character
)), 1)
194 : char_to_string (XFASTINT (character
), str
));
195 return make_string_from_bytes (str
, 1, len
);
198 DEFUN ("string-to-char", Fstring_to_char
, Sstring_to_char
, 1, 1, 0,
199 doc
: /* Convert arg STRING to a character, the first character of that string.
200 A multibyte character is handled correctly. */)
202 register Lisp_Object string
;
204 register Lisp_Object val
;
205 CHECK_STRING (string
);
208 if (STRING_MULTIBYTE (string
))
209 XSETFASTINT (val
, STRING_CHAR (SDATA (string
), SBYTES (string
)));
211 XSETFASTINT (val
, SREF (string
, 0));
214 XSETFASTINT (val
, 0);
219 buildmark (charpos
, bytepos
)
220 int charpos
, bytepos
;
222 register Lisp_Object mark
;
223 mark
= Fmake_marker ();
224 set_marker_both (mark
, Qnil
, charpos
, bytepos
);
228 DEFUN ("point", Fpoint
, Spoint
, 0, 0, 0,
229 doc
: /* Return value of point, as an integer.
230 Beginning of buffer is position (point-min). */)
234 XSETFASTINT (temp
, PT
);
238 DEFUN ("point-marker", Fpoint_marker
, Spoint_marker
, 0, 0, 0,
239 doc
: /* Return value of point, as a marker object. */)
242 return buildmark (PT
, PT_BYTE
);
246 clip_to_bounds (lower
, num
, upper
)
247 int lower
, num
, upper
;
251 else if (num
> upper
)
257 DEFUN ("goto-char", Fgoto_char
, Sgoto_char
, 1, 1, "NGoto char: ",
258 doc
: /* Set point to POSITION, a number or marker.
259 Beginning of buffer is position (point-min), end is (point-max).
260 If the position is in the middle of a multibyte form,
261 the actual point is set at the head of the multibyte form
262 except in the case that `enable-multibyte-characters' is nil. */)
264 register Lisp_Object position
;
268 if (MARKERP (position
)
269 && current_buffer
== XMARKER (position
)->buffer
)
271 pos
= marker_position (position
);
273 SET_PT_BOTH (BEGV
, BEGV_BYTE
);
275 SET_PT_BOTH (ZV
, ZV_BYTE
);
277 SET_PT_BOTH (pos
, marker_byte_position (position
));
282 CHECK_NUMBER_COERCE_MARKER (position
);
284 pos
= clip_to_bounds (BEGV
, XINT (position
), ZV
);
290 /* Return the start or end position of the region.
291 BEGINNINGP non-zero means return the start.
292 If there is no region active, signal an error. */
295 region_limit (beginningp
)
298 extern Lisp_Object Vmark_even_if_inactive
; /* Defined in callint.c. */
301 if (!NILP (Vtransient_mark_mode
)
302 && NILP (Vmark_even_if_inactive
)
303 && NILP (current_buffer
->mark_active
))
304 Fsignal (Qmark_inactive
, Qnil
);
306 m
= Fmarker_position (current_buffer
->mark
);
308 error ("The mark is not set now, so there is no region");
310 if ((PT
< XFASTINT (m
)) == (beginningp
!= 0))
311 m
= make_number (PT
);
315 DEFUN ("region-beginning", Fregion_beginning
, Sregion_beginning
, 0, 0, 0,
316 doc
: /* Return position of beginning of region, as an integer. */)
319 return region_limit (1);
322 DEFUN ("region-end", Fregion_end
, Sregion_end
, 0, 0, 0,
323 doc
: /* Return position of end of region, as an integer. */)
326 return region_limit (0);
329 DEFUN ("mark-marker", Fmark_marker
, Smark_marker
, 0, 0, 0,
330 doc
: /* Return this buffer's mark, as a marker object.
331 Watch out! Moving this marker changes the mark position.
332 If you set the marker not to point anywhere, the buffer will have no mark. */)
335 return current_buffer
->mark
;
339 /* Find all the overlays in the current buffer that touch position POS.
340 Return the number found, and store them in a vector in VEC
344 overlays_around (pos
, vec
, len
)
349 Lisp_Object overlay
, start
, end
;
350 struct Lisp_Overlay
*tail
;
351 int startpos
, endpos
;
354 for (tail
= current_buffer
->overlays_before
; tail
; tail
= tail
->next
)
356 XSETMISC (overlay
, tail
);
358 end
= OVERLAY_END (overlay
);
359 endpos
= OVERLAY_POSITION (end
);
362 start
= OVERLAY_START (overlay
);
363 startpos
= OVERLAY_POSITION (start
);
368 /* Keep counting overlays even if we can't return them all. */
373 for (tail
= current_buffer
->overlays_after
; tail
; tail
= tail
->next
)
375 XSETMISC (overlay
, tail
);
377 start
= OVERLAY_START (overlay
);
378 startpos
= OVERLAY_POSITION (start
);
381 end
= OVERLAY_END (overlay
);
382 endpos
= OVERLAY_POSITION (end
);
394 /* Return the value of property PROP, in OBJECT at POSITION.
395 It's the value of PROP that a char inserted at POSITION would get.
396 OBJECT is optional and defaults to the current buffer.
397 If OBJECT is a buffer, then overlay properties are considered as well as
399 If OBJECT is a window, then that window's buffer is used, but
400 window-specific overlays are considered only if they are associated
403 get_pos_property (position
, prop
, object
)
404 Lisp_Object position
, object
;
405 register Lisp_Object prop
;
407 CHECK_NUMBER_COERCE_MARKER (position
);
410 XSETBUFFER (object
, current_buffer
);
411 else if (WINDOWP (object
))
412 object
= XWINDOW (object
)->buffer
;
414 if (!BUFFERP (object
))
415 /* pos-property only makes sense in buffers right now, since strings
416 have no overlays and no notion of insertion for which stickiness
418 return Fget_text_property (position
, prop
, object
);
421 int posn
= XINT (position
);
423 Lisp_Object
*overlay_vec
, tem
;
424 struct buffer
*obuf
= current_buffer
;
426 set_buffer_temp (XBUFFER (object
));
428 /* First try with room for 40 overlays. */
430 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
431 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
433 /* If there are more than 40,
434 make enough space for all, and try again. */
437 overlay_vec
= (Lisp_Object
*) alloca (noverlays
* sizeof (Lisp_Object
));
438 noverlays
= overlays_around (posn
, overlay_vec
, noverlays
);
440 noverlays
= sort_overlays (overlay_vec
, noverlays
, NULL
);
442 set_buffer_temp (obuf
);
444 /* Now check the overlays in order of decreasing priority. */
445 while (--noverlays
>= 0)
447 Lisp_Object ol
= overlay_vec
[noverlays
];
448 tem
= Foverlay_get (ol
, prop
);
451 /* Check the overlay is indeed active at point. */
452 Lisp_Object start
= OVERLAY_START (ol
), finish
= OVERLAY_END (ol
);
453 if ((OVERLAY_POSITION (start
) == posn
454 && XMARKER (start
)->insertion_type
== 1)
455 || (OVERLAY_POSITION (finish
) == posn
456 && XMARKER (finish
)->insertion_type
== 0))
457 ; /* The overlay will not cover a char inserted at point. */
465 { /* Now check the text-properties. */
466 int stickiness
= text_property_stickiness (prop
, position
, object
);
468 return Fget_text_property (position
, prop
, object
);
469 else if (stickiness
< 0
470 && XINT (position
) > BUF_BEGV (XBUFFER (object
)))
471 return Fget_text_property (make_number (XINT (position
) - 1),
479 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
480 the value of point is used instead. If BEG or END null,
481 means don't store the beginning or end of the field.
483 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
484 results; they do not effect boundary behavior.
486 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
487 position of a field, then the beginning of the previous field is
488 returned instead of the beginning of POS's field (since the end of a
489 field is actually also the beginning of the next input field, this
490 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
491 true case, if two fields are separated by a field with the special
492 value `boundary', and POS lies within it, then the two separated
493 fields are considered to be adjacent, and POS between them, when
494 finding the beginning and ending of the "merged" field.
496 Either BEG or END may be 0, in which case the corresponding value
500 find_field (pos
, merge_at_boundary
, beg_limit
, beg
, end_limit
, end
)
502 Lisp_Object merge_at_boundary
;
503 Lisp_Object beg_limit
, end_limit
;
506 /* Fields right before and after the point. */
507 Lisp_Object before_field
, after_field
;
508 /* 1 if POS counts as the start of a field. */
509 int at_field_start
= 0;
510 /* 1 if POS counts as the end of a field. */
511 int at_field_end
= 0;
514 XSETFASTINT (pos
, PT
);
516 CHECK_NUMBER_COERCE_MARKER (pos
);
519 = get_char_property_and_overlay (pos
, Qfield
, Qnil
, NULL
);
521 = (XFASTINT (pos
) > BEGV
522 ? get_char_property_and_overlay (make_number (XINT (pos
) - 1),
526 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
527 and POS is at beginning of a field, which can also be interpreted
528 as the end of the previous field. Note that the case where if
529 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
530 more natural one; then we avoid treating the beginning of a field
532 if (NILP (merge_at_boundary
))
534 Lisp_Object field
= get_pos_property (pos
, Qfield
, Qnil
);
535 if (!EQ (field
, after_field
))
537 if (!EQ (field
, before_field
))
539 if (NILP (field
) && at_field_start
&& at_field_end
)
540 /* If an inserted char would have a nil field while the surrounding
541 text is non-nil, we're probably not looking at a
542 zero-length field, but instead at a non-nil field that's
543 not intended for editing (such as comint's prompts). */
544 at_field_end
= at_field_start
= 0;
547 /* Note about special `boundary' fields:
549 Consider the case where the point (`.') is between the fields `x' and `y':
553 In this situation, if merge_at_boundary is true, we consider the
554 `x' and `y' fields as forming one big merged field, and so the end
555 of the field is the end of `y'.
557 However, if `x' and `y' are separated by a special `boundary' field
558 (a field with a `field' char-property of 'boundary), then we ignore
559 this special field when merging adjacent fields. Here's the same
560 situation, but with a `boundary' field between the `x' and `y' fields:
564 Here, if point is at the end of `x', the beginning of `y', or
565 anywhere in-between (within the `boundary' field), we merge all
566 three fields and consider the beginning as being the beginning of
567 the `x' field, and the end as being the end of the `y' field. */
572 /* POS is at the edge of a field, and we should consider it as
573 the beginning of the following field. */
574 *beg
= XFASTINT (pos
);
576 /* Find the previous field boundary. */
579 if (!NILP (merge_at_boundary
) && EQ (before_field
, Qboundary
))
580 /* Skip a `boundary' field. */
581 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
584 p
= Fprevious_single_char_property_change (p
, Qfield
, Qnil
,
586 *beg
= NILP (p
) ? BEGV
: XFASTINT (p
);
593 /* POS is at the edge of a field, and we should consider it as
594 the end of the previous field. */
595 *end
= XFASTINT (pos
);
597 /* Find the next field boundary. */
599 if (!NILP (merge_at_boundary
) && EQ (after_field
, Qboundary
))
600 /* Skip a `boundary' field. */
601 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
604 pos
= Fnext_single_char_property_change (pos
, Qfield
, Qnil
,
606 *end
= NILP (pos
) ? ZV
: XFASTINT (pos
);
612 DEFUN ("delete-field", Fdelete_field
, Sdelete_field
, 0, 1, 0,
613 doc
: /* Delete the field surrounding POS.
614 A field is a region of text with the same `field' property.
615 If POS is nil, the value of point is used for POS. */)
620 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
622 del_range (beg
, end
);
626 DEFUN ("field-string", Ffield_string
, Sfield_string
, 0, 1, 0,
627 doc
: /* Return the contents of the field surrounding POS as a string.
628 A field is a region of text with the same `field' property.
629 If POS is nil, the value of point is used for POS. */)
634 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
635 return make_buffer_string (beg
, end
, 1);
638 DEFUN ("field-string-no-properties", Ffield_string_no_properties
, Sfield_string_no_properties
, 0, 1, 0,
639 doc
: /* Return the contents of the field around POS, without text-properties.
640 A field is a region of text with the same `field' property.
641 If POS is nil, the value of point is used for POS. */)
646 find_field (pos
, Qnil
, Qnil
, &beg
, Qnil
, &end
);
647 return make_buffer_string (beg
, end
, 0);
650 DEFUN ("field-beginning", Ffield_beginning
, Sfield_beginning
, 0, 3, 0,
651 doc
: /* Return the beginning of the field surrounding POS.
652 A field is a region of text with the same `field' property.
653 If POS is nil, the value of point is used for POS.
654 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
655 field, then the beginning of the *previous* field is returned.
656 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
657 is before LIMIT, then LIMIT will be returned instead. */)
658 (pos
, escape_from_edge
, limit
)
659 Lisp_Object pos
, escape_from_edge
, limit
;
662 find_field (pos
, escape_from_edge
, limit
, &beg
, Qnil
, 0);
663 return make_number (beg
);
666 DEFUN ("field-end", Ffield_end
, Sfield_end
, 0, 3, 0,
667 doc
: /* Return the end of the field surrounding POS.
668 A field is a region of text with the same `field' property.
669 If POS is nil, the value of point is used for POS.
670 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
671 then the end of the *following* field is returned.
672 If LIMIT is non-nil, it is a buffer position; if the end of the field
673 is after LIMIT, then LIMIT will be returned instead. */)
674 (pos
, escape_from_edge
, limit
)
675 Lisp_Object pos
, escape_from_edge
, limit
;
678 find_field (pos
, escape_from_edge
, Qnil
, 0, limit
, &end
);
679 return make_number (end
);
682 DEFUN ("constrain-to-field", Fconstrain_to_field
, Sconstrain_to_field
, 2, 5, 0,
683 doc
: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
685 A field is a region of text with the same `field' property.
686 If NEW-POS is nil, then the current point is used instead, and set to the
687 constrained position if that is different.
689 If OLD-POS is at the boundary of two fields, then the allowable
690 positions for NEW-POS depends on the value of the optional argument
691 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
692 constrained to the field that has the same `field' char-property
693 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
694 is non-nil, NEW-POS is constrained to the union of the two adjacent
695 fields. Additionally, if two fields are separated by another field with
696 the special value `boundary', then any point within this special field is
697 also considered to be `on the boundary'.
699 If the optional argument ONLY-IN-LINE is non-nil and constraining
700 NEW-POS would move it to a different line, NEW-POS is returned
701 unconstrained. This useful for commands that move by line, like
702 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
703 only in the case where they can still move to the right line.
705 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
706 a non-nil property of that name, then any field boundaries are ignored.
708 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
709 (new_pos
, old_pos
, escape_from_edge
, only_in_line
, inhibit_capture_property
)
710 Lisp_Object new_pos
, old_pos
;
711 Lisp_Object escape_from_edge
, only_in_line
, inhibit_capture_property
;
713 /* If non-zero, then the original point, before re-positioning. */
717 /* Use the current point, and afterwards, set it. */
720 XSETFASTINT (new_pos
, PT
);
723 if (NILP (Vinhibit_field_text_motion
)
724 && !EQ (new_pos
, old_pos
)
725 && (!NILP (Fget_char_property (new_pos
, Qfield
, Qnil
))
726 || !NILP (Fget_char_property (old_pos
, Qfield
, Qnil
)))
727 && (NILP (inhibit_capture_property
)
728 || NILP (Fget_char_property(old_pos
, inhibit_capture_property
, Qnil
))))
729 /* NEW_POS is not within the same field as OLD_POS; try to
730 move NEW_POS so that it is. */
733 Lisp_Object field_bound
;
735 CHECK_NUMBER_COERCE_MARKER (new_pos
);
736 CHECK_NUMBER_COERCE_MARKER (old_pos
);
738 fwd
= (XFASTINT (new_pos
) > XFASTINT (old_pos
));
741 field_bound
= Ffield_end (old_pos
, escape_from_edge
, new_pos
);
743 field_bound
= Ffield_beginning (old_pos
, escape_from_edge
, new_pos
);
745 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
746 other side of NEW_POS, which would mean that NEW_POS is
747 already acceptable, and it's not necessary to constrain it
749 ((XFASTINT (field_bound
) < XFASTINT (new_pos
)) ? fwd
: !fwd
)
750 /* NEW_POS should be constrained, but only if either
751 ONLY_IN_LINE is nil (in which case any constraint is OK),
752 or NEW_POS and FIELD_BOUND are on the same line (in which
753 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
754 && (NILP (only_in_line
)
755 /* This is the ONLY_IN_LINE case, check that NEW_POS and
756 FIELD_BOUND are on the same line by seeing whether
757 there's an intervening newline or not. */
758 || (scan_buffer ('\n',
759 XFASTINT (new_pos
), XFASTINT (field_bound
),
760 fwd
? -1 : 1, &shortage
, 1),
762 /* Constrain NEW_POS to FIELD_BOUND. */
763 new_pos
= field_bound
;
765 if (orig_point
&& XFASTINT (new_pos
) != orig_point
)
766 /* The NEW_POS argument was originally nil, so automatically set PT. */
767 SET_PT (XFASTINT (new_pos
));
774 DEFUN ("line-beginning-position",
775 Fline_beginning_position
, Sline_beginning_position
, 0, 1, 0,
776 doc
: /* Return the character position of the first character on the current line.
777 With argument N not nil or 1, move forward N - 1 lines first.
778 If scan reaches end of buffer, return that position.
780 The scan does not cross a field boundary unless doing so would move
781 beyond there to a different line; if N is nil or 1, and scan starts at a
782 field boundary, the scan stops as soon as it starts. To ignore field
783 boundaries bind `inhibit-field-text-motion' to t.
785 This function does not move point. */)
789 int orig
, orig_byte
, end
;
798 Fforward_line (make_number (XINT (n
) - 1));
801 SET_PT_BOTH (orig
, orig_byte
);
803 /* Return END constrained to the current input field. */
804 return Fconstrain_to_field (make_number (end
), make_number (orig
),
805 XINT (n
) != 1 ? Qt
: Qnil
,
809 DEFUN ("line-end-position", Fline_end_position
, Sline_end_position
, 0, 1, 0,
810 doc
: /* Return the character position of the last character on the current line.
811 With argument N not nil or 1, move forward N - 1 lines first.
812 If scan reaches end of buffer, return that position.
814 The scan does not cross a field boundary unless doing so would move
815 beyond there to a different line; if N is nil or 1, and scan starts at a
816 field boundary, the scan stops as soon as it starts. To ignore field
817 boundaries bind `inhibit-field-text-motion' to t.
819 This function does not move point. */)
831 end_pos
= find_before_next_newline (orig
, 0, XINT (n
) - (XINT (n
) <= 0));
833 /* Return END_POS constrained to the current input field. */
834 return Fconstrain_to_field (make_number (end_pos
), make_number (orig
),
840 save_excursion_save ()
842 int visible
= (XBUFFER (XWINDOW (selected_window
)->buffer
)
845 return Fcons (Fpoint_marker (),
846 Fcons (Fcopy_marker (current_buffer
->mark
, Qnil
),
847 Fcons (visible
? Qt
: Qnil
,
848 Fcons (current_buffer
->mark_active
,
853 save_excursion_restore (info
)
856 Lisp_Object tem
, tem1
, omark
, nmark
;
857 struct gcpro gcpro1
, gcpro2
, gcpro3
;
860 tem
= Fmarker_buffer (XCAR (info
));
861 /* If buffer being returned to is now deleted, avoid error */
862 /* Otherwise could get error here while unwinding to top level
864 /* In that case, Fmarker_buffer returns nil now. */
868 omark
= nmark
= Qnil
;
869 GCPRO3 (info
, omark
, nmark
);
876 unchain_marker (XMARKER (tem
));
881 omark
= Fmarker_position (current_buffer
->mark
);
882 Fset_marker (current_buffer
->mark
, tem
, Fcurrent_buffer ());
883 nmark
= Fmarker_position (tem
);
884 unchain_marker (XMARKER (tem
));
888 visible_p
= !NILP (XCAR (info
));
890 #if 0 /* We used to make the current buffer visible in the selected window
891 if that was true previously. That avoids some anomalies.
892 But it creates others, and it wasn't documented, and it is simpler
893 and cleaner never to alter the window/buffer connections. */
896 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
897 Fswitch_to_buffer (Fcurrent_buffer (), Qnil
);
903 tem1
= current_buffer
->mark_active
;
904 current_buffer
->mark_active
= tem
;
906 if (!NILP (Vrun_hooks
))
908 /* If mark is active now, and either was not active
909 or was at a different place, run the activate hook. */
910 if (! NILP (current_buffer
->mark_active
))
912 if (! EQ (omark
, nmark
))
913 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
915 /* If mark has ceased to be active, run deactivate hook. */
916 else if (! NILP (tem1
))
917 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
920 /* If buffer was visible in a window, and a different window was
921 selected, and the old selected window is still showing this
922 buffer, restore point in that window. */
925 && !EQ (tem
, selected_window
)
926 && (tem1
= XWINDOW (tem
)->buffer
,
927 (/* Window is live... */
929 /* ...and it shows the current buffer. */
930 && XBUFFER (tem1
) == current_buffer
)))
931 Fset_window_point (tem
, make_number (PT
));
937 DEFUN ("save-excursion", Fsave_excursion
, Ssave_excursion
, 0, UNEVALLED
, 0,
938 doc
: /* Save point, mark, and current buffer; execute BODY; restore those things.
939 Executes BODY just like `progn'.
940 The values of point, mark and the current buffer are restored
941 even in case of abnormal exit (throw or error).
942 The state of activation of the mark is also restored.
944 This construct does not save `deactivate-mark', and therefore
945 functions that change the buffer will still cause deactivation
946 of the mark at the end of the command. To prevent that, bind
947 `deactivate-mark' with `let'.
949 usage: (save-excursion &rest BODY) */)
953 register Lisp_Object val
;
954 int count
= SPECPDL_INDEX ();
956 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
959 return unbind_to (count
, val
);
962 DEFUN ("save-current-buffer", Fsave_current_buffer
, Ssave_current_buffer
, 0, UNEVALLED
, 0,
963 doc
: /* Save the current buffer; execute BODY; restore the current buffer.
964 Executes BODY just like `progn'.
965 usage: (save-current-buffer &rest BODY) */)
970 int count
= SPECPDL_INDEX ();
972 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
975 return unbind_to (count
, val
);
978 DEFUN ("buffer-size", Fbufsize
, Sbufsize
, 0, 1, 0,
979 doc
: /* Return the number of characters in the current buffer.
980 If BUFFER, return the number of characters in that buffer instead. */)
985 return make_number (Z
- BEG
);
988 CHECK_BUFFER (buffer
);
989 return make_number (BUF_Z (XBUFFER (buffer
))
990 - BUF_BEG (XBUFFER (buffer
)));
994 DEFUN ("point-min", Fpoint_min
, Spoint_min
, 0, 0, 0,
995 doc
: /* Return the minimum permissible value of point in the current buffer.
996 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1000 XSETFASTINT (temp
, BEGV
);
1004 DEFUN ("point-min-marker", Fpoint_min_marker
, Spoint_min_marker
, 0, 0, 0,
1005 doc
: /* Return a marker to the minimum permissible value of point in this buffer.
1006 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1009 return buildmark (BEGV
, BEGV_BYTE
);
1012 DEFUN ("point-max", Fpoint_max
, Spoint_max
, 0, 0, 0,
1013 doc
: /* Return the maximum permissible value of point in the current buffer.
1014 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1015 is in effect, in which case it is less. */)
1019 XSETFASTINT (temp
, ZV
);
1023 DEFUN ("point-max-marker", Fpoint_max_marker
, Spoint_max_marker
, 0, 0, 0,
1024 doc
: /* Return a marker to the maximum permissible value of point in this buffer.
1025 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1026 is in effect, in which case it is less. */)
1029 return buildmark (ZV
, ZV_BYTE
);
1032 DEFUN ("gap-position", Fgap_position
, Sgap_position
, 0, 0, 0,
1033 doc
: /* Return the position of the gap, in the current buffer.
1034 See also `gap-size'. */)
1038 XSETFASTINT (temp
, GPT
);
1042 DEFUN ("gap-size", Fgap_size
, Sgap_size
, 0, 0, 0,
1043 doc
: /* Return the size of the current buffer's gap.
1044 See also `gap-position'. */)
1048 XSETFASTINT (temp
, GAP_SIZE
);
1052 DEFUN ("position-bytes", Fposition_bytes
, Sposition_bytes
, 1, 1, 0,
1053 doc
: /* Return the byte position for character position POSITION.
1054 If POSITION is out of range, the value is nil. */)
1056 Lisp_Object position
;
1058 CHECK_NUMBER_COERCE_MARKER (position
);
1059 if (XINT (position
) < BEG
|| XINT (position
) > Z
)
1061 return make_number (CHAR_TO_BYTE (XINT (position
)));
1064 DEFUN ("byte-to-position", Fbyte_to_position
, Sbyte_to_position
, 1, 1, 0,
1065 doc
: /* Return the character position for byte position BYTEPOS.
1066 If BYTEPOS is out of range, the value is nil. */)
1068 Lisp_Object bytepos
;
1070 CHECK_NUMBER (bytepos
);
1071 if (XINT (bytepos
) < BEG_BYTE
|| XINT (bytepos
) > Z_BYTE
)
1073 return make_number (BYTE_TO_CHAR (XINT (bytepos
)));
1076 DEFUN ("following-char", Ffollowing_char
, Sfollowing_char
, 0, 0, 0,
1077 doc
: /* Return the character following point, as a number.
1078 At the end of the buffer or accessible region, return 0. */)
1083 XSETFASTINT (temp
, 0);
1085 XSETFASTINT (temp
, FETCH_CHAR (PT_BYTE
));
1089 DEFUN ("preceding-char", Fprevious_char
, Sprevious_char
, 0, 0, 0,
1090 doc
: /* Return the character preceding point, as a number.
1091 At the beginning of the buffer or accessible region, return 0. */)
1096 XSETFASTINT (temp
, 0);
1097 else if (!NILP (current_buffer
->enable_multibyte_characters
))
1101 XSETFASTINT (temp
, FETCH_CHAR (pos
));
1104 XSETFASTINT (temp
, FETCH_BYTE (PT_BYTE
- 1));
1108 DEFUN ("bobp", Fbobp
, Sbobp
, 0, 0, 0,
1109 doc
: /* Return t if point is at the beginning of the buffer.
1110 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1118 DEFUN ("eobp", Feobp
, Seobp
, 0, 0, 0,
1119 doc
: /* Return t if point is at the end of the buffer.
1120 If the buffer is narrowed, this means the end of the narrowed part. */)
1128 DEFUN ("bolp", Fbolp
, Sbolp
, 0, 0, 0,
1129 doc
: /* Return t if point is at the beginning of a line. */)
1132 if (PT
== BEGV
|| FETCH_BYTE (PT_BYTE
- 1) == '\n')
1137 DEFUN ("eolp", Feolp
, Seolp
, 0, 0, 0,
1138 doc
: /* Return t if point is at the end of a line.
1139 `End of a line' includes point being at the end of the buffer. */)
1142 if (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n')
1147 DEFUN ("char-after", Fchar_after
, Schar_after
, 0, 1, 0,
1148 doc
: /* Return character in current buffer at position POS.
1149 POS is an integer or a marker and defaults to point.
1150 If POS is out of range, the value is nil. */)
1154 register int pos_byte
;
1159 XSETFASTINT (pos
, PT
);
1164 pos_byte
= marker_byte_position (pos
);
1165 if (pos_byte
< BEGV_BYTE
|| pos_byte
>= ZV_BYTE
)
1170 CHECK_NUMBER_COERCE_MARKER (pos
);
1171 if (XINT (pos
) < BEGV
|| XINT (pos
) >= ZV
)
1174 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1177 return make_number (FETCH_CHAR (pos_byte
));
1180 DEFUN ("char-before", Fchar_before
, Schar_before
, 0, 1, 0,
1181 doc
: /* Return character in current buffer preceding position POS.
1182 POS is an integer or a marker and defaults to point.
1183 If POS is out of range, the value is nil. */)
1187 register Lisp_Object val
;
1188 register int pos_byte
;
1193 XSETFASTINT (pos
, PT
);
1198 pos_byte
= marker_byte_position (pos
);
1200 if (pos_byte
<= BEGV_BYTE
|| pos_byte
> ZV_BYTE
)
1205 CHECK_NUMBER_COERCE_MARKER (pos
);
1207 if (XINT (pos
) <= BEGV
|| XINT (pos
) > ZV
)
1210 pos_byte
= CHAR_TO_BYTE (XINT (pos
));
1213 if (!NILP (current_buffer
->enable_multibyte_characters
))
1216 XSETFASTINT (val
, FETCH_CHAR (pos_byte
));
1221 XSETFASTINT (val
, FETCH_BYTE (pos_byte
));
1226 DEFUN ("user-login-name", Fuser_login_name
, Suser_login_name
, 0, 1, 0,
1227 doc
: /* Return the name under which the user logged in, as a string.
1228 This is based on the effective uid, not the real uid.
1229 Also, if the environment variables LOGNAME or USER are set,
1230 that determines the value of this function.
1232 If optional argument UID is an integer, return the login name of the user
1233 with that uid, or nil if there is no such user. */)
1239 /* Set up the user name info if we didn't do it before.
1240 (That can happen if Emacs is dumpable
1241 but you decide to run `temacs -l loadup' and not dump. */
1242 if (INTEGERP (Vuser_login_name
))
1246 return Vuser_login_name
;
1249 pw
= (struct passwd
*) getpwuid (XINT (uid
));
1250 return (pw
? build_string (pw
->pw_name
) : Qnil
);
1253 DEFUN ("user-real-login-name", Fuser_real_login_name
, Suser_real_login_name
,
1255 doc
: /* Return the name of the user's real uid, as a string.
1256 This ignores the environment variables LOGNAME and USER, so it differs from
1257 `user-login-name' when running under `su'. */)
1260 /* Set up the user name info if we didn't do it before.
1261 (That can happen if Emacs is dumpable
1262 but you decide to run `temacs -l loadup' and not dump. */
1263 if (INTEGERP (Vuser_login_name
))
1265 return Vuser_real_login_name
;
1268 DEFUN ("user-uid", Fuser_uid
, Suser_uid
, 0, 0, 0,
1269 doc
: /* Return the effective uid of Emacs.
1270 Value is an integer or float, depending on the value. */)
1273 return make_fixnum_or_float (geteuid ());
1276 DEFUN ("user-real-uid", Fuser_real_uid
, Suser_real_uid
, 0, 0, 0,
1277 doc
: /* Return the real uid of Emacs.
1278 Value is an integer or float, depending on the value. */)
1281 return make_fixnum_or_float (getuid ());
1284 DEFUN ("user-full-name", Fuser_full_name
, Suser_full_name
, 0, 1, 0,
1285 doc
: /* Return the full name of the user logged in, as a string.
1286 If the full name corresponding to Emacs's userid is not known,
1289 If optional argument UID is an integer or float, return the full name
1290 of the user with that uid, or nil if there is no such user.
1291 If UID is a string, return the full name of the user with that login
1292 name, or nil if there is no such user. */)
1297 register unsigned char *p
, *q
;
1301 return Vuser_full_name
;
1302 else if (NUMBERP (uid
))
1303 pw
= (struct passwd
*) getpwuid ((uid_t
) XFLOATINT (uid
));
1304 else if (STRINGP (uid
))
1305 pw
= (struct passwd
*) getpwnam (SDATA (uid
));
1307 error ("Invalid UID specification");
1312 p
= (unsigned char *) USER_FULL_NAME
;
1313 /* Chop off everything after the first comma. */
1314 q
= (unsigned char *) index (p
, ',');
1315 full
= make_string (p
, q
? q
- p
: strlen (p
));
1317 #ifdef AMPERSAND_FULL_NAME
1319 q
= (unsigned char *) index (p
, '&');
1320 /* Substitute the login name for the &, upcasing the first character. */
1323 register unsigned char *r
;
1326 login
= Fuser_login_name (make_number (pw
->pw_uid
));
1327 r
= (unsigned char *) alloca (strlen (p
) + SCHARS (login
) + 1);
1328 bcopy (p
, r
, q
- p
);
1330 strcat (r
, SDATA (login
));
1331 r
[q
- p
] = UPCASE (r
[q
- p
]);
1333 full
= build_string (r
);
1335 #endif /* AMPERSAND_FULL_NAME */
1340 DEFUN ("system-name", Fsystem_name
, Ssystem_name
, 0, 0, 0,
1341 doc
: /* Return the name of the machine you are running on, as a string. */)
1344 return Vsystem_name
;
1347 /* For the benefit of callers who don't want to include lisp.h */
1352 if (STRINGP (Vsystem_name
))
1353 return (char *) SDATA (Vsystem_name
);
1358 DEFUN ("emacs-pid", Femacs_pid
, Semacs_pid
, 0, 0, 0,
1359 doc
: /* Return the process ID of Emacs, as an integer. */)
1362 return make_number (getpid ());
1365 DEFUN ("current-time", Fcurrent_time
, Scurrent_time
, 0, 0, 0,
1366 doc
: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1367 The time is returned as a list of three integers. The first has the
1368 most significant 16 bits of the seconds, while the second has the
1369 least significant 16 bits. The third integer gives the microsecond
1372 The microsecond count is zero on systems that do not provide
1373 resolution finer than a second. */)
1377 Lisp_Object result
[3];
1380 XSETINT (result
[0], (EMACS_SECS (t
) >> 16) & 0xffff);
1381 XSETINT (result
[1], (EMACS_SECS (t
) >> 0) & 0xffff);
1382 XSETINT (result
[2], EMACS_USECS (t
));
1384 return Flist (3, result
);
1387 DEFUN ("get-internal-run-time", Fget_internal_run_time
, Sget_internal_run_time
,
1389 doc
: /* Return the current run time used by Emacs.
1390 The time is returned as a list of three integers. The first has the
1391 most significant 16 bits of the seconds, while the second has the
1392 least significant 16 bits. The third integer gives the microsecond
1395 On systems that can't determine the run time, get-internal-run-time
1396 does the same thing as current-time. The microsecond count is zero on
1397 systems that do not provide resolution finer than a second. */)
1400 #ifdef HAVE_GETRUSAGE
1401 struct rusage usage
;
1402 Lisp_Object result
[3];
1405 if (getrusage (RUSAGE_SELF
, &usage
) < 0)
1406 /* This shouldn't happen. What action is appropriate? */
1407 Fsignal (Qerror
, Qnil
);
1409 /* Sum up user time and system time. */
1410 secs
= usage
.ru_utime
.tv_sec
+ usage
.ru_stime
.tv_sec
;
1411 usecs
= usage
.ru_utime
.tv_usec
+ usage
.ru_stime
.tv_usec
;
1412 if (usecs
>= 1000000)
1418 XSETINT (result
[0], (secs
>> 16) & 0xffff);
1419 XSETINT (result
[1], (secs
>> 0) & 0xffff);
1420 XSETINT (result
[2], usecs
);
1422 return Flist (3, result
);
1424 return Fcurrent_time ();
1430 lisp_time_argument (specified_time
, result
, usec
)
1431 Lisp_Object specified_time
;
1435 if (NILP (specified_time
))
1442 *usec
= EMACS_USECS (t
);
1443 *result
= EMACS_SECS (t
);
1447 return time (result
) != -1;
1451 Lisp_Object high
, low
;
1452 high
= Fcar (specified_time
);
1453 CHECK_NUMBER (high
);
1454 low
= Fcdr (specified_time
);
1459 Lisp_Object usec_l
= Fcdr (low
);
1461 usec_l
= Fcar (usec_l
);
1466 CHECK_NUMBER (usec_l
);
1467 *usec
= XINT (usec_l
);
1475 *result
= (XINT (high
) << 16) + (XINT (low
) & 0xffff);
1476 return *result
>> 16 == XINT (high
);
1480 DEFUN ("float-time", Ffloat_time
, Sfloat_time
, 0, 1, 0,
1481 doc
: /* Return the current time, as a float number of seconds since the epoch.
1482 If SPECIFIED-TIME is given, it is the time to convert to float
1483 instead of the current time. The argument should have the form
1484 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1485 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1486 have the form (HIGH . LOW), but this is considered obsolete.
1488 WARNING: Since the result is floating point, it may not be exact.
1489 Do not use this function if precise time stamps are required. */)
1491 Lisp_Object specified_time
;
1496 if (! lisp_time_argument (specified_time
, &sec
, &usec
))
1497 error ("Invalid time specification");
1499 return make_float ((sec
* 1e6
+ usec
) / 1e6
);
1502 /* Write information into buffer S of size MAXSIZE, according to the
1503 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1504 Default to Universal Time if UT is nonzero, local time otherwise.
1505 Return the number of bytes written, not including the terminating
1506 '\0'. If S is NULL, nothing will be written anywhere; so to
1507 determine how many bytes would be written, use NULL for S and
1508 ((size_t) -1) for MAXSIZE.
1510 This function behaves like emacs_strftimeu, except it allows null
1513 emacs_memftimeu (s
, maxsize
, format
, format_len
, tp
, ut
)
1518 const struct tm
*tp
;
1523 /* Loop through all the null-terminated strings in the format
1524 argument. Normally there's just one null-terminated string, but
1525 there can be arbitrarily many, concatenated together, if the
1526 format contains '\0' bytes. emacs_strftimeu stops at the first
1527 '\0' byte so we must invoke it separately for each such string. */
1536 result
= emacs_strftimeu (s
, maxsize
, format
, tp
, ut
);
1540 if (result
== 0 && s
[0] != '\0')
1545 maxsize
-= result
+ 1;
1547 len
= strlen (format
);
1548 if (len
== format_len
)
1552 format_len
-= len
+ 1;
1556 DEFUN ("format-time-string", Fformat_time_string
, Sformat_time_string
, 1, 3, 0,
1557 doc
: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1558 TIME is specified as (HIGH LOW . IGNORED), as returned by
1559 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1560 is also still accepted.
1561 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1562 as Universal Time; nil means describe TIME in the local time zone.
1563 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1564 by text that describes the specified date and time in TIME:
1566 %Y is the year, %y within the century, %C the century.
1567 %G is the year corresponding to the ISO week, %g within the century.
1568 %m is the numeric month.
1569 %b and %h are the locale's abbreviated month name, %B the full name.
1570 %d is the day of the month, zero-padded, %e is blank-padded.
1571 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1572 %a is the locale's abbreviated name of the day of week, %A the full name.
1573 %U is the week number starting on Sunday, %W starting on Monday,
1574 %V according to ISO 8601.
1575 %j is the day of the year.
1577 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1578 only blank-padded, %l is like %I blank-padded.
1579 %p is the locale's equivalent of either AM or PM.
1582 %Z is the time zone name, %z is the numeric form.
1583 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1585 %c is the locale's date and time format.
1586 %x is the locale's "preferred" date format.
1587 %D is like "%m/%d/%y".
1589 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1590 %X is the locale's "preferred" time format.
1592 Finally, %n is a newline, %t is a tab, %% is a literal %.
1594 Certain flags and modifiers are available with some format controls.
1595 The flags are `_', `-', `^' and `#'. For certain characters X,
1596 %_X is like %X, but padded with blanks; %-X is like %X,
1597 but without padding. %^X is like %X, but with all textual
1598 characters up-cased; %#X is like %X, but with letter-case of
1599 all textual characters reversed.
1600 %NX (where N stands for an integer) is like %X,
1601 but takes up at least N (a number) positions.
1602 The modifiers are `E' and `O'. For certain characters X,
1603 %EX is a locale's alternative version of %X;
1604 %OX is like %X, but uses the locale's number symbols.
1606 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1607 (format_string
, time
, universal
)
1608 Lisp_Object format_string
, time
, universal
;
1613 int ut
= ! NILP (universal
);
1615 CHECK_STRING (format_string
);
1617 if (! lisp_time_argument (time
, &value
, NULL
))
1618 error ("Invalid time specification");
1620 format_string
= code_convert_string_norecord (format_string
,
1621 Vlocale_coding_system
, 1);
1623 /* This is probably enough. */
1624 size
= SBYTES (format_string
) * 6 + 50;
1626 tm
= ut
? gmtime (&value
) : localtime (&value
);
1628 error ("Specified time is not representable");
1630 synchronize_system_time_locale ();
1634 char *buf
= (char *) alloca (size
+ 1);
1638 result
= emacs_memftimeu (buf
, size
, SDATA (format_string
),
1639 SBYTES (format_string
),
1641 if ((result
> 0 && result
< size
) || (result
== 0 && buf
[0] == '\0'))
1642 return code_convert_string_norecord (make_string (buf
, result
),
1643 Vlocale_coding_system
, 0);
1645 /* If buffer was too small, make it bigger and try again. */
1646 result
= emacs_memftimeu (NULL
, (size_t) -1,
1647 SDATA (format_string
),
1648 SBYTES (format_string
),
1654 DEFUN ("decode-time", Fdecode_time
, Sdecode_time
, 0, 1, 0,
1655 doc
: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1656 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1657 as from `current-time' and `file-attributes', or `nil' to use the
1658 current time. The obsolete form (HIGH . LOW) is also still accepted.
1659 The list has the following nine members: SEC is an integer between 0
1660 and 60; SEC is 60 for a leap second, which only some operating systems
1661 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1662 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1663 integer between 1 and 12. YEAR is an integer indicating the
1664 four-digit year. DOW is the day of week, an integer between 0 and 6,
1665 where 0 is Sunday. DST is t if daylight savings time is effect,
1666 otherwise nil. ZONE is an integer indicating the number of seconds
1667 east of Greenwich. (Note that Common Lisp has different meanings for
1670 Lisp_Object specified_time
;
1674 struct tm
*decoded_time
;
1675 Lisp_Object list_args
[9];
1677 if (! lisp_time_argument (specified_time
, &time_spec
, NULL
))
1678 error ("Invalid time specification");
1680 decoded_time
= localtime (&time_spec
);
1682 error ("Specified time is not representable");
1683 XSETFASTINT (list_args
[0], decoded_time
->tm_sec
);
1684 XSETFASTINT (list_args
[1], decoded_time
->tm_min
);
1685 XSETFASTINT (list_args
[2], decoded_time
->tm_hour
);
1686 XSETFASTINT (list_args
[3], decoded_time
->tm_mday
);
1687 XSETFASTINT (list_args
[4], decoded_time
->tm_mon
+ 1);
1688 XSETINT (list_args
[5], decoded_time
->tm_year
+ 1900);
1689 XSETFASTINT (list_args
[6], decoded_time
->tm_wday
);
1690 list_args
[7] = (decoded_time
->tm_isdst
)? Qt
: Qnil
;
1692 /* Make a copy, in case gmtime modifies the struct. */
1693 save_tm
= *decoded_time
;
1694 decoded_time
= gmtime (&time_spec
);
1695 if (decoded_time
== 0)
1696 list_args
[8] = Qnil
;
1698 XSETINT (list_args
[8], tm_diff (&save_tm
, decoded_time
));
1699 return Flist (9, list_args
);
1702 DEFUN ("encode-time", Fencode_time
, Sencode_time
, 6, MANY
, 0,
1703 doc
: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1704 This is the reverse operation of `decode-time', which see.
1705 ZONE defaults to the current time zone rule. This can
1706 be a string or t (as from `set-time-zone-rule'), or it can be a list
1707 \(as from `current-time-zone') or an integer (as from `decode-time')
1708 applied without consideration for daylight savings time.
1710 You can pass more than 7 arguments; then the first six arguments
1711 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1712 The intervening arguments are ignored.
1713 This feature lets (apply 'encode-time (decode-time ...)) work.
1715 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1716 for example, a DAY of 0 means the day preceding the given month.
1717 Year numbers less than 100 are treated just like other year numbers.
1718 If you want them to stand for years in this century, you must do that yourself.
1720 Years before 1970 are not guaranteed to work. On some systems,
1721 year values as low as 1901 do work.
1723 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1726 register Lisp_Object
*args
;
1730 Lisp_Object zone
= (nargs
> 6 ? args
[nargs
- 1] : Qnil
);
1732 CHECK_NUMBER (args
[0]); /* second */
1733 CHECK_NUMBER (args
[1]); /* minute */
1734 CHECK_NUMBER (args
[2]); /* hour */
1735 CHECK_NUMBER (args
[3]); /* day */
1736 CHECK_NUMBER (args
[4]); /* month */
1737 CHECK_NUMBER (args
[5]); /* year */
1739 tm
.tm_sec
= XINT (args
[0]);
1740 tm
.tm_min
= XINT (args
[1]);
1741 tm
.tm_hour
= XINT (args
[2]);
1742 tm
.tm_mday
= XINT (args
[3]);
1743 tm
.tm_mon
= XINT (args
[4]) - 1;
1744 tm
.tm_year
= XINT (args
[5]) - 1900;
1750 time
= mktime (&tm
);
1755 char **oldenv
= environ
, **newenv
;
1759 else if (STRINGP (zone
))
1760 tzstring
= (char *) SDATA (zone
);
1761 else if (INTEGERP (zone
))
1763 int abszone
= abs (XINT (zone
));
1764 sprintf (tzbuf
, "XXX%s%d:%02d:%02d", "-" + (XINT (zone
) < 0),
1765 abszone
/ (60*60), (abszone
/60) % 60, abszone
% 60);
1769 error ("Invalid time zone specification");
1771 /* Set TZ before calling mktime; merely adjusting mktime's returned
1772 value doesn't suffice, since that would mishandle leap seconds. */
1773 set_time_zone_rule (tzstring
);
1775 time
= mktime (&tm
);
1777 /* Restore TZ to previous value. */
1781 #ifdef LOCALTIME_CACHE
1786 if (time
== (time_t) -1)
1787 error ("Specified time is not representable");
1789 return make_time (time
);
1792 DEFUN ("current-time-string", Fcurrent_time_string
, Scurrent_time_string
, 0, 1, 0,
1793 doc
: /* Return the current time, as a human-readable string.
1794 Programs can use this function to decode a time,
1795 since the number of columns in each field is fixed.
1796 The format is `Sun Sep 16 01:03:52 1973'.
1797 However, see also the functions `decode-time' and `format-time-string'
1798 which provide a much more powerful and general facility.
1800 If SPECIFIED-TIME is given, it is a time to format instead of the
1801 current time. The argument should have the form (HIGH LOW . IGNORED).
1802 Thus, you can use times obtained from `current-time' and from
1803 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1804 but this is considered obsolete. */)
1806 Lisp_Object specified_time
;
1812 if (! lisp_time_argument (specified_time
, &value
, NULL
))
1814 tem
= (char *) ctime (&value
);
1816 strncpy (buf
, tem
, 24);
1819 return build_string (buf
);
1822 #define TM_YEAR_BASE 1900
1824 /* Yield A - B, measured in seconds.
1825 This function is copied from the GNU C Library. */
1830 /* Compute intervening leap days correctly even if year is negative.
1831 Take care to avoid int overflow in leap day calculations,
1832 but it's OK to assume that A and B are close to each other. */
1833 int a4
= (a
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (a
->tm_year
& 3);
1834 int b4
= (b
->tm_year
>> 2) + (TM_YEAR_BASE
>> 2) - ! (b
->tm_year
& 3);
1835 int a100
= a4
/ 25 - (a4
% 25 < 0);
1836 int b100
= b4
/ 25 - (b4
% 25 < 0);
1837 int a400
= a100
>> 2;
1838 int b400
= b100
>> 2;
1839 int intervening_leap_days
= (a4
- b4
) - (a100
- b100
) + (a400
- b400
);
1840 int years
= a
->tm_year
- b
->tm_year
;
1841 int days
= (365 * years
+ intervening_leap_days
1842 + (a
->tm_yday
- b
->tm_yday
));
1843 return (60 * (60 * (24 * days
+ (a
->tm_hour
- b
->tm_hour
))
1844 + (a
->tm_min
- b
->tm_min
))
1845 + (a
->tm_sec
- b
->tm_sec
));
1848 DEFUN ("current-time-zone", Fcurrent_time_zone
, Scurrent_time_zone
, 0, 1, 0,
1849 doc
: /* Return the offset and name for the local time zone.
1850 This returns a list of the form (OFFSET NAME).
1851 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1852 A negative value means west of Greenwich.
1853 NAME is a string giving the name of the time zone.
1854 If SPECIFIED-TIME is given, the time zone offset is determined from it
1855 instead of using the current time. The argument should have the form
1856 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1857 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1858 have the form (HIGH . LOW), but this is considered obsolete.
1860 Some operating systems cannot provide all this information to Emacs;
1861 in this case, `current-time-zone' returns a list containing nil for
1862 the data it can't find. */)
1864 Lisp_Object specified_time
;
1870 if (lisp_time_argument (specified_time
, &value
, NULL
)
1871 && (t
= gmtime (&value
)) != 0
1872 && (gmt
= *t
, t
= localtime (&value
)) != 0)
1874 int offset
= tm_diff (t
, &gmt
);
1879 s
= (char *)t
->tm_zone
;
1880 #else /* not HAVE_TM_ZONE */
1882 if (t
->tm_isdst
== 0 || t
->tm_isdst
== 1)
1883 s
= tzname
[t
->tm_isdst
];
1885 #endif /* not HAVE_TM_ZONE */
1887 #if defined HAVE_TM_ZONE || defined HAVE_TZNAME
1890 /* On Japanese w32, we can get a Japanese string as time
1891 zone name. Don't accept that. */
1893 for (p
= s
; *p
&& (isalnum ((unsigned char)*p
) || *p
== ' '); ++p
)
1902 /* No local time zone name is available; use "+-NNNN" instead. */
1903 int am
= (offset
< 0 ? -offset
: offset
) / 60;
1904 sprintf (buf
, "%c%02d%02d", (offset
< 0 ? '-' : '+'), am
/60, am
%60);
1907 return Fcons (make_number (offset
), Fcons (build_string (s
), Qnil
));
1910 return Fmake_list (make_number (2), Qnil
);
1913 /* This holds the value of `environ' produced by the previous
1914 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1915 has never been called. */
1916 static char **environbuf
;
1918 DEFUN ("set-time-zone-rule", Fset_time_zone_rule
, Sset_time_zone_rule
, 1, 1, 0,
1919 doc
: /* Set the local time zone using TZ, a string specifying a time zone rule.
1920 If TZ is nil, use implementation-defined default time zone information.
1921 If TZ is t, use Universal Time. */)
1929 else if (EQ (tz
, Qt
))
1934 tzstring
= (char *) SDATA (tz
);
1937 set_time_zone_rule (tzstring
);
1940 environbuf
= environ
;
1945 #ifdef LOCALTIME_CACHE
1947 /* These two values are known to load tz files in buggy implementations,
1948 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1949 Their values shouldn't matter in non-buggy implementations.
1950 We don't use string literals for these strings,
1951 since if a string in the environment is in readonly
1952 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1953 See Sun bugs 1113095 and 1114114, ``Timezone routines
1954 improperly modify environment''. */
1956 static char set_time_zone_rule_tz1
[] = "TZ=GMT+0";
1957 static char set_time_zone_rule_tz2
[] = "TZ=GMT+1";
1961 /* Set the local time zone rule to TZSTRING.
1962 This allocates memory into `environ', which it is the caller's
1963 responsibility to free. */
1966 set_time_zone_rule (tzstring
)
1970 char **from
, **to
, **newenv
;
1972 /* Make the ENVIRON vector longer with room for TZSTRING. */
1973 for (from
= environ
; *from
; from
++)
1975 envptrs
= from
- environ
+ 2;
1976 newenv
= to
= (char **) xmalloc (envptrs
* sizeof (char *)
1977 + (tzstring
? strlen (tzstring
) + 4 : 0));
1979 /* Add TZSTRING to the end of environ, as a value for TZ. */
1982 char *t
= (char *) (to
+ envptrs
);
1984 strcat (t
, tzstring
);
1988 /* Copy the old environ vector elements into NEWENV,
1989 but don't copy the TZ variable.
1990 So we have only one definition of TZ, which came from TZSTRING. */
1991 for (from
= environ
; *from
; from
++)
1992 if (strncmp (*from
, "TZ=", 3) != 0)
1998 /* If we do have a TZSTRING, NEWENV points to the vector slot where
1999 the TZ variable is stored. If we do not have a TZSTRING,
2000 TO points to the vector slot which has the terminating null. */
2002 #ifdef LOCALTIME_CACHE
2004 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2005 "US/Pacific" that loads a tz file, then changes to a value like
2006 "XXX0" that does not load a tz file, and then changes back to
2007 its original value, the last change is (incorrectly) ignored.
2008 Also, if TZ changes twice in succession to values that do
2009 not load a tz file, tzset can dump core (see Sun bug#1225179).
2010 The following code works around these bugs. */
2014 /* Temporarily set TZ to a value that loads a tz file
2015 and that differs from tzstring. */
2017 *newenv
= (strcmp (tzstring
, set_time_zone_rule_tz1
+ 3) == 0
2018 ? set_time_zone_rule_tz2
: set_time_zone_rule_tz1
);
2024 /* The implied tzstring is unknown, so temporarily set TZ to
2025 two different values that each load a tz file. */
2026 *to
= set_time_zone_rule_tz1
;
2029 *to
= set_time_zone_rule_tz2
;
2034 /* Now TZ has the desired value, and tzset can be invoked safely. */
2041 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2042 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2043 type of object is Lisp_String). INHERIT is passed to
2044 INSERT_FROM_STRING_FUNC as the last argument. */
2047 general_insert_function (insert_func
, insert_from_string_func
,
2048 inherit
, nargs
, args
)
2049 void (*insert_func
) P_ ((const unsigned char *, int));
2050 void (*insert_from_string_func
) P_ ((Lisp_Object
, int, int, int, int, int));
2052 register Lisp_Object
*args
;
2054 register int argnum
;
2055 register Lisp_Object val
;
2057 for (argnum
= 0; argnum
< nargs
; argnum
++)
2063 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2066 if (!NILP (current_buffer
->enable_multibyte_characters
))
2067 len
= CHAR_STRING (XFASTINT (val
), str
);
2070 str
[0] = (SINGLE_BYTE_CHAR_P (XINT (val
))
2072 : multibyte_char_to_unibyte (XINT (val
), Qnil
));
2075 (*insert_func
) (str
, len
);
2077 else if (STRINGP (val
))
2079 (*insert_from_string_func
) (val
, 0, 0,
2086 val
= wrong_type_argument (Qchar_or_string_p
, val
);
2100 /* Callers passing one argument to Finsert need not gcpro the
2101 argument "array", since the only element of the array will
2102 not be used after calling insert or insert_from_string, so
2103 we don't care if it gets trashed. */
2105 DEFUN ("insert", Finsert
, Sinsert
, 0, MANY
, 0,
2106 doc
: /* Insert the arguments, either strings or characters, at point.
2107 Point and before-insertion markers move forward to end up
2108 after the inserted text.
2109 Any other markers at the point of insertion remain before the text.
2111 If the current buffer is multibyte, unibyte strings are converted
2112 to multibyte for insertion (see `string-make-multibyte').
2113 If the current buffer is unibyte, multibyte strings are converted
2114 to unibyte for insertion (see `string-make-unibyte').
2116 When operating on binary data, it may be necessary to preserve the
2117 original bytes of a unibyte string when inserting it into a multibyte
2118 buffer; to accomplish this, apply `string-as-multibyte' to the string
2119 and insert the result.
2121 usage: (insert &rest ARGS) */)
2124 register Lisp_Object
*args
;
2126 general_insert_function (insert
, insert_from_string
, 0, nargs
, args
);
2130 DEFUN ("insert-and-inherit", Finsert_and_inherit
, Sinsert_and_inherit
,
2132 doc
: /* Insert the arguments at point, inheriting properties from adjoining text.
2133 Point and before-insertion markers move forward to end up
2134 after the inserted text.
2135 Any other markers at the point of insertion remain before the text.
2137 If the current buffer is multibyte, unibyte strings are converted
2138 to multibyte for insertion (see `unibyte-char-to-multibyte').
2139 If the current buffer is unibyte, multibyte strings are converted
2140 to unibyte for insertion.
2142 usage: (insert-and-inherit &rest ARGS) */)
2145 register Lisp_Object
*args
;
2147 general_insert_function (insert_and_inherit
, insert_from_string
, 1,
2152 DEFUN ("insert-before-markers", Finsert_before_markers
, Sinsert_before_markers
, 0, MANY
, 0,
2153 doc
: /* Insert strings or characters at point, relocating markers after the text.
2154 Point and markers move forward to end up after the inserted text.
2156 If the current buffer is multibyte, unibyte strings are converted
2157 to multibyte for insertion (see `unibyte-char-to-multibyte').
2158 If the current buffer is unibyte, multibyte strings are converted
2159 to unibyte for insertion.
2161 usage: (insert-before-markers &rest ARGS) */)
2164 register Lisp_Object
*args
;
2166 general_insert_function (insert_before_markers
,
2167 insert_from_string_before_markers
, 0,
2172 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers
,
2173 Sinsert_and_inherit_before_markers
, 0, MANY
, 0,
2174 doc
: /* Insert text at point, relocating markers and inheriting properties.
2175 Point and markers move forward to end up after the inserted text.
2177 If the current buffer is multibyte, unibyte strings are converted
2178 to multibyte for insertion (see `unibyte-char-to-multibyte').
2179 If the current buffer is unibyte, multibyte strings are converted
2180 to unibyte for insertion.
2182 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2185 register Lisp_Object
*args
;
2187 general_insert_function (insert_before_markers_and_inherit
,
2188 insert_from_string_before_markers
, 1,
2193 DEFUN ("insert-char", Finsert_char
, Sinsert_char
, 2, 3, 0,
2194 doc
: /* Insert COUNT (second arg) copies of CHARACTER (first arg).
2195 Both arguments are required.
2196 Point, and before-insertion markers, are relocated as in the function `insert'.
2197 The optional third arg INHERIT, if non-nil, says to inherit text properties
2198 from adjoining text, if those properties are sticky. */)
2199 (character
, count
, inherit
)
2200 Lisp_Object character
, count
, inherit
;
2202 register unsigned char *string
;
2203 register int strlen
;
2206 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
2208 CHECK_NUMBER (character
);
2209 CHECK_NUMBER (count
);
2211 if (!NILP (current_buffer
->enable_multibyte_characters
))
2212 len
= CHAR_STRING (XFASTINT (character
), str
);
2214 str
[0] = XFASTINT (character
), len
= 1;
2215 n
= XINT (count
) * len
;
2218 strlen
= min (n
, 256 * len
);
2219 string
= (unsigned char *) alloca (strlen
);
2220 for (i
= 0; i
< strlen
; i
++)
2221 string
[i
] = str
[i
% len
];
2225 if (!NILP (inherit
))
2226 insert_and_inherit (string
, strlen
);
2228 insert (string
, strlen
);
2233 if (!NILP (inherit
))
2234 insert_and_inherit (string
, n
);
2242 /* Making strings from buffer contents. */
2244 /* Return a Lisp_String containing the text of the current buffer from
2245 START to END. If text properties are in use and the current buffer
2246 has properties in the range specified, the resulting string will also
2247 have them, if PROPS is nonzero.
2249 We don't want to use plain old make_string here, because it calls
2250 make_uninit_string, which can cause the buffer arena to be
2251 compacted. make_string has no way of knowing that the data has
2252 been moved, and thus copies the wrong data into the string. This
2253 doesn't effect most of the other users of make_string, so it should
2254 be left as is. But we should use this function when conjuring
2255 buffer substrings. */
2258 make_buffer_string (start
, end
, props
)
2262 int start_byte
= CHAR_TO_BYTE (start
);
2263 int end_byte
= CHAR_TO_BYTE (end
);
2265 return make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
);
2268 /* Return a Lisp_String containing the text of the current buffer from
2269 START / START_BYTE to END / END_BYTE.
2271 If text properties are in use and the current buffer
2272 has properties in the range specified, the resulting string will also
2273 have them, if PROPS is nonzero.
2275 We don't want to use plain old make_string here, because it calls
2276 make_uninit_string, which can cause the buffer arena to be
2277 compacted. make_string has no way of knowing that the data has
2278 been moved, and thus copies the wrong data into the string. This
2279 doesn't effect most of the other users of make_string, so it should
2280 be left as is. But we should use this function when conjuring
2281 buffer substrings. */
2284 make_buffer_string_both (start
, start_byte
, end
, end_byte
, props
)
2285 int start
, start_byte
, end
, end_byte
;
2288 Lisp_Object result
, tem
, tem1
;
2290 if (start
< GPT
&& GPT
< end
)
2293 if (! NILP (current_buffer
->enable_multibyte_characters
))
2294 result
= make_uninit_multibyte_string (end
- start
, end_byte
- start_byte
);
2296 result
= make_uninit_string (end
- start
);
2297 bcopy (BYTE_POS_ADDR (start_byte
), SDATA (result
),
2298 end_byte
- start_byte
);
2300 /* If desired, update and copy the text properties. */
2303 update_buffer_properties (start
, end
);
2305 tem
= Fnext_property_change (make_number (start
), Qnil
, make_number (end
));
2306 tem1
= Ftext_properties_at (make_number (start
), Qnil
);
2308 if (XINT (tem
) != end
|| !NILP (tem1
))
2309 copy_intervals_to_string (result
, current_buffer
, start
,
2316 /* Call Vbuffer_access_fontify_functions for the range START ... END
2317 in the current buffer, if necessary. */
2320 update_buffer_properties (start
, end
)
2323 /* If this buffer has some access functions,
2324 call them, specifying the range of the buffer being accessed. */
2325 if (!NILP (Vbuffer_access_fontify_functions
))
2327 Lisp_Object args
[3];
2330 args
[0] = Qbuffer_access_fontify_functions
;
2331 XSETINT (args
[1], start
);
2332 XSETINT (args
[2], end
);
2334 /* But don't call them if we can tell that the work
2335 has already been done. */
2336 if (!NILP (Vbuffer_access_fontified_property
))
2338 tem
= Ftext_property_any (args
[1], args
[2],
2339 Vbuffer_access_fontified_property
,
2342 Frun_hook_with_args (3, args
);
2345 Frun_hook_with_args (3, args
);
2349 DEFUN ("buffer-substring", Fbuffer_substring
, Sbuffer_substring
, 2, 2, 0,
2350 doc
: /* Return the contents of part of the current buffer as a string.
2351 The two arguments START and END are character positions;
2352 they can be in either order.
2353 The string returned is multibyte if the buffer is multibyte.
2355 This function copies the text properties of that part of the buffer
2356 into the result string; if you don't want the text properties,
2357 use `buffer-substring-no-properties' instead. */)
2359 Lisp_Object start
, end
;
2363 validate_region (&start
, &end
);
2367 return make_buffer_string (b
, e
, 1);
2370 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties
,
2371 Sbuffer_substring_no_properties
, 2, 2, 0,
2372 doc
: /* Return the characters of part of the buffer, without the text properties.
2373 The two arguments START and END are character positions;
2374 they can be in either order. */)
2376 Lisp_Object start
, end
;
2380 validate_region (&start
, &end
);
2384 return make_buffer_string (b
, e
, 0);
2387 DEFUN ("buffer-string", Fbuffer_string
, Sbuffer_string
, 0, 0, 0,
2388 doc
: /* Return the contents of the current buffer as a string.
2389 If narrowing is in effect, this function returns only the visible part
2393 return make_buffer_string (BEGV
, ZV
, 1);
2396 DEFUN ("insert-buffer-substring", Finsert_buffer_substring
, Sinsert_buffer_substring
,
2398 doc
: /* Insert before point a substring of the contents of BUFFER.
2399 BUFFER may be a buffer or a buffer name.
2400 Arguments START and END are character positions specifying the substring.
2401 They default to the values of (point-min) and (point-max) in BUFFER. */)
2402 (buffer
, start
, end
)
2403 Lisp_Object buffer
, start
, end
;
2405 register int b
, e
, temp
;
2406 register struct buffer
*bp
, *obuf
;
2409 buf
= Fget_buffer (buffer
);
2413 if (NILP (bp
->name
))
2414 error ("Selecting deleted buffer");
2420 CHECK_NUMBER_COERCE_MARKER (start
);
2427 CHECK_NUMBER_COERCE_MARKER (end
);
2432 temp
= b
, b
= e
, e
= temp
;
2434 if (!(BUF_BEGV (bp
) <= b
&& e
<= BUF_ZV (bp
)))
2435 args_out_of_range (start
, end
);
2437 obuf
= current_buffer
;
2438 set_buffer_internal_1 (bp
);
2439 update_buffer_properties (b
, e
);
2440 set_buffer_internal_1 (obuf
);
2442 insert_from_buffer (bp
, b
, e
- b
, 0);
2446 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings
, Scompare_buffer_substrings
,
2448 doc
: /* Compare two substrings of two buffers; return result as number.
2449 the value is -N if first string is less after N-1 chars,
2450 +N if first string is greater after N-1 chars, or 0 if strings match.
2451 Each substring is represented as three arguments: BUFFER, START and END.
2452 That makes six args in all, three for each substring.
2454 The value of `case-fold-search' in the current buffer
2455 determines whether case is significant or ignored. */)
2456 (buffer1
, start1
, end1
, buffer2
, start2
, end2
)
2457 Lisp_Object buffer1
, start1
, end1
, buffer2
, start2
, end2
;
2459 register int begp1
, endp1
, begp2
, endp2
, temp
;
2460 register struct buffer
*bp1
, *bp2
;
2461 register Lisp_Object
*trt
2462 = (!NILP (current_buffer
->case_fold_search
)
2463 ? XCHAR_TABLE (current_buffer
->case_canon_table
)->contents
: 0);
2465 int i1
, i2
, i1_byte
, i2_byte
;
2467 /* Find the first buffer and its substring. */
2470 bp1
= current_buffer
;
2474 buf1
= Fget_buffer (buffer1
);
2477 bp1
= XBUFFER (buf1
);
2478 if (NILP (bp1
->name
))
2479 error ("Selecting deleted buffer");
2483 begp1
= BUF_BEGV (bp1
);
2486 CHECK_NUMBER_COERCE_MARKER (start1
);
2487 begp1
= XINT (start1
);
2490 endp1
= BUF_ZV (bp1
);
2493 CHECK_NUMBER_COERCE_MARKER (end1
);
2494 endp1
= XINT (end1
);
2498 temp
= begp1
, begp1
= endp1
, endp1
= temp
;
2500 if (!(BUF_BEGV (bp1
) <= begp1
2502 && endp1
<= BUF_ZV (bp1
)))
2503 args_out_of_range (start1
, end1
);
2505 /* Likewise for second substring. */
2508 bp2
= current_buffer
;
2512 buf2
= Fget_buffer (buffer2
);
2515 bp2
= XBUFFER (buf2
);
2516 if (NILP (bp2
->name
))
2517 error ("Selecting deleted buffer");
2521 begp2
= BUF_BEGV (bp2
);
2524 CHECK_NUMBER_COERCE_MARKER (start2
);
2525 begp2
= XINT (start2
);
2528 endp2
= BUF_ZV (bp2
);
2531 CHECK_NUMBER_COERCE_MARKER (end2
);
2532 endp2
= XINT (end2
);
2536 temp
= begp2
, begp2
= endp2
, endp2
= temp
;
2538 if (!(BUF_BEGV (bp2
) <= begp2
2540 && endp2
<= BUF_ZV (bp2
)))
2541 args_out_of_range (start2
, end2
);
2545 i1_byte
= buf_charpos_to_bytepos (bp1
, i1
);
2546 i2_byte
= buf_charpos_to_bytepos (bp2
, i2
);
2548 while (i1
< endp1
&& i2
< endp2
)
2550 /* When we find a mismatch, we must compare the
2551 characters, not just the bytes. */
2556 if (! NILP (bp1
->enable_multibyte_characters
))
2558 c1
= BUF_FETCH_MULTIBYTE_CHAR (bp1
, i1_byte
);
2559 BUF_INC_POS (bp1
, i1_byte
);
2564 c1
= BUF_FETCH_BYTE (bp1
, i1
);
2565 c1
= unibyte_char_to_multibyte (c1
);
2569 if (! NILP (bp2
->enable_multibyte_characters
))
2571 c2
= BUF_FETCH_MULTIBYTE_CHAR (bp2
, i2_byte
);
2572 BUF_INC_POS (bp2
, i2_byte
);
2577 c2
= BUF_FETCH_BYTE (bp2
, i2
);
2578 c2
= unibyte_char_to_multibyte (c2
);
2584 c1
= XINT (trt
[c1
]);
2585 c2
= XINT (trt
[c2
]);
2588 return make_number (- 1 - chars
);
2590 return make_number (chars
+ 1);
2595 /* The strings match as far as they go.
2596 If one is shorter, that one is less. */
2597 if (chars
< endp1
- begp1
)
2598 return make_number (chars
+ 1);
2599 else if (chars
< endp2
- begp2
)
2600 return make_number (- chars
- 1);
2602 /* Same length too => they are equal. */
2603 return make_number (0);
2607 subst_char_in_region_unwind (arg
)
2610 return current_buffer
->undo_list
= arg
;
2614 subst_char_in_region_unwind_1 (arg
)
2617 return current_buffer
->filename
= arg
;
2620 DEFUN ("subst-char-in-region", Fsubst_char_in_region
,
2621 Ssubst_char_in_region
, 4, 5, 0,
2622 doc
: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2623 If optional arg NOUNDO is non-nil, don't record this change for undo
2624 and don't mark the buffer as really changed.
2625 Both characters must have the same length of multi-byte form. */)
2626 (start
, end
, fromchar
, tochar
, noundo
)
2627 Lisp_Object start
, end
, fromchar
, tochar
, noundo
;
2629 register int pos
, pos_byte
, stop
, i
, len
, end_byte
;
2631 unsigned char fromstr
[MAX_MULTIBYTE_LENGTH
], tostr
[MAX_MULTIBYTE_LENGTH
];
2633 int count
= SPECPDL_INDEX ();
2634 #define COMBINING_NO 0
2635 #define COMBINING_BEFORE 1
2636 #define COMBINING_AFTER 2
2637 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2638 int maybe_byte_combining
= COMBINING_NO
;
2639 int last_changed
= 0;
2640 int multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2642 validate_region (&start
, &end
);
2643 CHECK_NUMBER (fromchar
);
2644 CHECK_NUMBER (tochar
);
2648 len
= CHAR_STRING (XFASTINT (fromchar
), fromstr
);
2649 if (CHAR_STRING (XFASTINT (tochar
), tostr
) != len
)
2650 error ("Characters in subst-char-in-region have different byte-lengths");
2651 if (!ASCII_BYTE_P (*tostr
))
2653 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2654 complete multibyte character, it may be combined with the
2655 after bytes. If it is in the range 0xA0..0xFF, it may be
2656 combined with the before and after bytes. */
2657 if (!CHAR_HEAD_P (*tostr
))
2658 maybe_byte_combining
= COMBINING_BOTH
;
2659 else if (BYTES_BY_CHAR_HEAD (*tostr
) > len
)
2660 maybe_byte_combining
= COMBINING_AFTER
;
2666 fromstr
[0] = XFASTINT (fromchar
);
2667 tostr
[0] = XFASTINT (tochar
);
2671 pos_byte
= CHAR_TO_BYTE (pos
);
2672 stop
= CHAR_TO_BYTE (XINT (end
));
2675 /* If we don't want undo, turn off putting stuff on the list.
2676 That's faster than getting rid of things,
2677 and it prevents even the entry for a first change.
2678 Also inhibit locking the file. */
2681 record_unwind_protect (subst_char_in_region_unwind
,
2682 current_buffer
->undo_list
);
2683 current_buffer
->undo_list
= Qt
;
2684 /* Don't do file-locking. */
2685 record_unwind_protect (subst_char_in_region_unwind_1
,
2686 current_buffer
->filename
);
2687 current_buffer
->filename
= Qnil
;
2690 if (pos_byte
< GPT_BYTE
)
2691 stop
= min (stop
, GPT_BYTE
);
2694 int pos_byte_next
= pos_byte
;
2696 if (pos_byte
>= stop
)
2698 if (pos_byte
>= end_byte
) break;
2701 p
= BYTE_POS_ADDR (pos_byte
);
2703 INC_POS (pos_byte_next
);
2706 if (pos_byte_next
- pos_byte
== len
2707 && p
[0] == fromstr
[0]
2709 || (p
[1] == fromstr
[1]
2710 && (len
== 2 || (p
[2] == fromstr
[2]
2711 && (len
== 3 || p
[3] == fromstr
[3]))))))
2716 modify_region (current_buffer
, changed
, XINT (end
));
2718 if (! NILP (noundo
))
2720 if (MODIFF
- 1 == SAVE_MODIFF
)
2722 if (MODIFF
- 1 == current_buffer
->auto_save_modified
)
2723 current_buffer
->auto_save_modified
++;
2727 /* Take care of the case where the new character
2728 combines with neighboring bytes. */
2729 if (maybe_byte_combining
2730 && (maybe_byte_combining
== COMBINING_AFTER
2731 ? (pos_byte_next
< Z_BYTE
2732 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2733 : ((pos_byte_next
< Z_BYTE
2734 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next
)))
2735 || (pos_byte
> BEG_BYTE
2736 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte
- 1))))))
2738 Lisp_Object tem
, string
;
2740 struct gcpro gcpro1
;
2742 tem
= current_buffer
->undo_list
;
2745 /* Make a multibyte string containing this single character. */
2746 string
= make_multibyte_string (tostr
, 1, len
);
2747 /* replace_range is less efficient, because it moves the gap,
2748 but it handles combining correctly. */
2749 replace_range (pos
, pos
+ 1, string
,
2751 pos_byte_next
= CHAR_TO_BYTE (pos
);
2752 if (pos_byte_next
> pos_byte
)
2753 /* Before combining happened. We should not increment
2754 POS. So, to cancel the later increment of POS,
2758 INC_POS (pos_byte_next
);
2760 if (! NILP (noundo
))
2761 current_buffer
->undo_list
= tem
;
2768 record_change (pos
, 1);
2769 for (i
= 0; i
< len
; i
++) *p
++ = tostr
[i
];
2771 last_changed
= pos
+ 1;
2773 pos_byte
= pos_byte_next
;
2779 signal_after_change (changed
,
2780 last_changed
- changed
, last_changed
- changed
);
2781 update_compositions (changed
, last_changed
, CHECK_ALL
);
2784 unbind_to (count
, Qnil
);
2788 DEFUN ("translate-region-internal", Ftranslate_region_internal
,
2789 Stranslate_region_internal
, 3, 3, 0,
2790 doc
: /* Internal use only.
2791 From START to END, translate characters according to TABLE.
2792 TABLE is a string; the Nth character in it is the mapping
2793 for the character with code N.
2794 It returns the number of characters changed. */)
2798 register Lisp_Object table
;
2800 register unsigned char *tt
; /* Trans table. */
2801 register int nc
; /* New character. */
2802 int cnt
; /* Number of changes made. */
2803 int size
; /* Size of translate table. */
2804 int pos
, pos_byte
, end_pos
;
2805 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2806 int string_multibyte
;
2808 validate_region (&start
, &end
);
2809 if (CHAR_TABLE_P (table
))
2816 CHECK_STRING (table
);
2818 if (! multibyte
&& (SCHARS (table
) < SBYTES (table
)))
2819 table
= string_make_unibyte (table
);
2820 string_multibyte
= SCHARS (table
) < SBYTES (table
);
2821 size
= SCHARS (table
);
2826 pos_byte
= CHAR_TO_BYTE (pos
);
2827 end_pos
= XINT (end
);
2828 modify_region (current_buffer
, pos
, XINT (end
));
2831 for (; pos
< end_pos
; )
2833 register unsigned char *p
= BYTE_POS_ADDR (pos_byte
);
2834 unsigned char *str
, buf
[MAX_MULTIBYTE_LENGTH
];
2839 oc
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, len
);
2846 if (string_multibyte
)
2848 str
= tt
+ string_char_to_byte (table
, oc
);
2849 nc
= STRING_CHAR_AND_LENGTH (str
, MAX_MULTIBYTE_LENGTH
,
2855 if (! ASCII_BYTE_P (nc
) && multibyte
)
2857 str_len
= CHAR_STRING (nc
, buf
);
2873 val
= CHAR_TABLE_REF (table
, oc
);
2875 && (c
= XINT (val
), CHAR_VALID_P (c
, 0)))
2878 str_len
= CHAR_STRING (nc
, buf
);
2889 /* This is less efficient, because it moves the gap,
2890 but it should multibyte characters correctly. */
2891 string
= make_multibyte_string (str
, 1, str_len
);
2892 replace_range (pos
, pos
+ 1, string
, 1, 0, 1);
2897 record_change (pos
, 1);
2898 while (str_len
-- > 0)
2900 signal_after_change (pos
, 1, 1);
2901 update_compositions (pos
, pos
+ 1, CHECK_BORDER
);
2910 return make_number (cnt
);
2913 DEFUN ("delete-region", Fdelete_region
, Sdelete_region
, 2, 2, "r",
2914 doc
: /* Delete the text between point and mark.
2916 When called from a program, expects two arguments,
2917 positions (integers or markers) specifying the stretch to be deleted. */)
2919 Lisp_Object start
, end
;
2921 validate_region (&start
, &end
);
2922 del_range (XINT (start
), XINT (end
));
2926 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region
,
2927 Sdelete_and_extract_region
, 2, 2, 0,
2928 doc
: /* Delete the text between START and END and return it. */)
2930 Lisp_Object start
, end
;
2932 validate_region (&start
, &end
);
2933 if (XINT (start
) == XINT (end
))
2934 return build_string ("");
2935 return del_range_1 (XINT (start
), XINT (end
), 1, 1);
2938 DEFUN ("widen", Fwiden
, Swiden
, 0, 0, "",
2939 doc
: /* Remove restrictions (narrowing) from current buffer.
2940 This allows the buffer's full text to be seen and edited. */)
2943 if (BEG
!= BEGV
|| Z
!= ZV
)
2944 current_buffer
->clip_changed
= 1;
2946 BEGV_BYTE
= BEG_BYTE
;
2947 SET_BUF_ZV_BOTH (current_buffer
, Z
, Z_BYTE
);
2948 /* Changing the buffer bounds invalidates any recorded current column. */
2949 invalidate_current_column ();
2953 DEFUN ("narrow-to-region", Fnarrow_to_region
, Snarrow_to_region
, 2, 2, "r",
2954 doc
: /* Restrict editing in this buffer to the current region.
2955 The rest of the text becomes temporarily invisible and untouchable
2956 but is not deleted; if you save the buffer in a file, the invisible
2957 text is included in the file. \\[widen] makes all visible again.
2958 See also `save-restriction'.
2960 When calling from a program, pass two arguments; positions (integers
2961 or markers) bounding the text that should remain visible. */)
2963 register Lisp_Object start
, end
;
2965 CHECK_NUMBER_COERCE_MARKER (start
);
2966 CHECK_NUMBER_COERCE_MARKER (end
);
2968 if (XINT (start
) > XINT (end
))
2971 tem
= start
; start
= end
; end
= tem
;
2974 if (!(BEG
<= XINT (start
) && XINT (start
) <= XINT (end
) && XINT (end
) <= Z
))
2975 args_out_of_range (start
, end
);
2977 if (BEGV
!= XFASTINT (start
) || ZV
!= XFASTINT (end
))
2978 current_buffer
->clip_changed
= 1;
2980 SET_BUF_BEGV (current_buffer
, XFASTINT (start
));
2981 SET_BUF_ZV (current_buffer
, XFASTINT (end
));
2982 if (PT
< XFASTINT (start
))
2983 SET_PT (XFASTINT (start
));
2984 if (PT
> XFASTINT (end
))
2985 SET_PT (XFASTINT (end
));
2986 /* Changing the buffer bounds invalidates any recorded current column. */
2987 invalidate_current_column ();
2992 save_restriction_save ()
2994 if (BEGV
== BEG
&& ZV
== Z
)
2995 /* The common case that the buffer isn't narrowed.
2996 We return just the buffer object, which save_restriction_restore
2997 recognizes as meaning `no restriction'. */
2998 return Fcurrent_buffer ();
3000 /* We have to save a restriction, so return a pair of markers, one
3001 for the beginning and one for the end. */
3003 Lisp_Object beg
, end
;
3005 beg
= buildmark (BEGV
, BEGV_BYTE
);
3006 end
= buildmark (ZV
, ZV_BYTE
);
3008 /* END must move forward if text is inserted at its exact location. */
3009 XMARKER(end
)->insertion_type
= 1;
3011 return Fcons (beg
, end
);
3016 save_restriction_restore (data
)
3020 /* A pair of marks bounding a saved restriction. */
3022 struct Lisp_Marker
*beg
= XMARKER (XCAR (data
));
3023 struct Lisp_Marker
*end
= XMARKER (XCDR (data
));
3024 struct buffer
*buf
= beg
->buffer
; /* END should have the same buffer. */
3026 if (buf
/* Verify marker still points to a buffer. */
3027 && (beg
->charpos
!= BUF_BEGV (buf
) || end
->charpos
!= BUF_ZV (buf
)))
3028 /* The restriction has changed from the saved one, so restore
3029 the saved restriction. */
3031 int pt
= BUF_PT (buf
);
3033 SET_BUF_BEGV_BOTH (buf
, beg
->charpos
, beg
->bytepos
);
3034 SET_BUF_ZV_BOTH (buf
, end
->charpos
, end
->bytepos
);
3036 if (pt
< beg
->charpos
|| pt
> end
->charpos
)
3037 /* The point is outside the new visible range, move it inside. */
3038 SET_BUF_PT_BOTH (buf
,
3039 clip_to_bounds (beg
->charpos
, pt
, end
->charpos
),
3040 clip_to_bounds (beg
->bytepos
, BUF_PT_BYTE (buf
),
3043 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3047 /* A buffer, which means that there was no old restriction. */
3049 struct buffer
*buf
= XBUFFER (data
);
3051 if (buf
/* Verify marker still points to a buffer. */
3052 && (BUF_BEGV (buf
) != BUF_BEG (buf
) || BUF_ZV (buf
) != BUF_Z (buf
)))
3053 /* The buffer has been narrowed, get rid of the narrowing. */
3055 SET_BUF_BEGV_BOTH (buf
, BUF_BEG (buf
), BUF_BEG_BYTE (buf
));
3056 SET_BUF_ZV_BOTH (buf
, BUF_Z (buf
), BUF_Z_BYTE (buf
));
3058 buf
->clip_changed
= 1; /* Remember that the narrowing changed. */
3065 DEFUN ("save-restriction", Fsave_restriction
, Ssave_restriction
, 0, UNEVALLED
, 0,
3066 doc
: /* Execute BODY, saving and restoring current buffer's restrictions.
3067 The buffer's restrictions make parts of the beginning and end invisible.
3068 (They are set up with `narrow-to-region' and eliminated with `widen'.)
3069 This special form, `save-restriction', saves the current buffer's restrictions
3070 when it is entered, and restores them when it is exited.
3071 So any `narrow-to-region' within BODY lasts only until the end of the form.
3072 The old restrictions settings are restored
3073 even in case of abnormal exit (throw or error).
3075 The value returned is the value of the last form in BODY.
3077 Note: if you are using both `save-excursion' and `save-restriction',
3078 use `save-excursion' outermost:
3079 (save-excursion (save-restriction ...))
3081 usage: (save-restriction &rest BODY) */)
3085 register Lisp_Object val
;
3086 int count
= SPECPDL_INDEX ();
3088 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
3089 val
= Fprogn (body
);
3090 return unbind_to (count
, val
);
3093 /* Buffer for the most recent text displayed by Fmessage_box. */
3094 static char *message_text
;
3096 /* Allocated length of that buffer. */
3097 static int message_length
;
3099 DEFUN ("message", Fmessage
, Smessage
, 1, MANY
, 0,
3100 doc
: /* Print a one-line message at the bottom of the screen.
3101 The message also goes into the `*Messages*' buffer.
3102 \(In keyboard macros, that's all it does.)
3104 The first argument is a format control string, and the rest are data
3105 to be formatted under control of the string. See `format' for details.
3107 If the first argument is nil, the function clears any existing message;
3108 this lets the minibuffer contents show. See also `current-message'.
3110 usage: (message STRING &rest ARGS) */)
3116 || (STRINGP (args
[0])
3117 && SBYTES (args
[0]) == 0))
3124 register Lisp_Object val
;
3125 val
= Fformat (nargs
, args
);
3126 message3 (val
, SBYTES (val
), STRING_MULTIBYTE (val
));
3131 DEFUN ("message-box", Fmessage_box
, Smessage_box
, 1, MANY
, 0,
3132 doc
: /* Display a message, in a dialog box if possible.
3133 If a dialog box is not available, use the echo area.
3134 The first argument is a format control string, and the rest are data
3135 to be formatted under control of the string. See `format' for details.
3137 If the first argument is nil, clear any existing message; let the
3138 minibuffer contents show.
3140 usage: (message-box STRING &rest ARGS) */)
3152 register Lisp_Object val
;
3153 val
= Fformat (nargs
, args
);
3155 /* The MS-DOS frames support popup menus even though they are
3156 not FRAME_WINDOW_P. */
3157 if (FRAME_WINDOW_P (XFRAME (selected_frame
))
3158 || FRAME_MSDOS_P (XFRAME (selected_frame
)))
3160 Lisp_Object pane
, menu
, obj
;
3161 struct gcpro gcpro1
;
3162 pane
= Fcons (Fcons (build_string ("OK"), Qt
), Qnil
);
3164 menu
= Fcons (val
, pane
);
3165 obj
= Fx_popup_dialog (Qt
, menu
);
3169 #endif /* HAVE_MENUS */
3170 /* Copy the data so that it won't move when we GC. */
3173 message_text
= (char *)xmalloc (80);
3174 message_length
= 80;
3176 if (SBYTES (val
) > message_length
)
3178 message_length
= SBYTES (val
);
3179 message_text
= (char *)xrealloc (message_text
, message_length
);
3181 bcopy (SDATA (val
), message_text
, SBYTES (val
));
3182 message2 (message_text
, SBYTES (val
),
3183 STRING_MULTIBYTE (val
));
3188 extern Lisp_Object last_nonmenu_event
;
3191 DEFUN ("message-or-box", Fmessage_or_box
, Smessage_or_box
, 1, MANY
, 0,
3192 doc
: /* Display a message in a dialog box or in the echo area.
3193 If this command was invoked with the mouse, use a dialog box if
3194 `use-dialog-box' is non-nil.
3195 Otherwise, use the echo area.
3196 The first argument is a format control string, and the rest are data
3197 to be formatted under control of the string. See `format' for details.
3199 If the first argument is nil, clear any existing message; let the
3200 minibuffer contents show.
3202 usage: (message-or-box STRING &rest ARGS) */)
3208 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
3210 return Fmessage_box (nargs
, args
);
3212 return Fmessage (nargs
, args
);
3215 DEFUN ("current-message", Fcurrent_message
, Scurrent_message
, 0, 0, 0,
3216 doc
: /* Return the string currently displayed in the echo area, or nil if none. */)
3219 return current_message ();
3223 DEFUN ("propertize", Fpropertize
, Spropertize
, 1, MANY
, 0,
3224 doc
: /* Return a copy of STRING with text properties added.
3225 First argument is the string to copy.
3226 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3227 properties to add to the result.
3228 usage: (propertize STRING &rest PROPERTIES) */)
3233 Lisp_Object properties
, string
;
3234 struct gcpro gcpro1
, gcpro2
;
3237 /* Number of args must be odd. */
3238 if ((nargs
& 1) == 0 || nargs
< 1)
3239 error ("Wrong number of arguments");
3241 properties
= string
= Qnil
;
3242 GCPRO2 (properties
, string
);
3244 /* First argument must be a string. */
3245 CHECK_STRING (args
[0]);
3246 string
= Fcopy_sequence (args
[0]);
3248 for (i
= 1; i
< nargs
; i
+= 2)
3250 CHECK_SYMBOL (args
[i
]);
3251 properties
= Fcons (args
[i
], Fcons (args
[i
+ 1], properties
));
3254 Fadd_text_properties (make_number (0),
3255 make_number (SCHARS (string
)),
3256 properties
, string
);
3257 RETURN_UNGCPRO (string
);
3261 /* Number of bytes that STRING will occupy when put into the result.
3262 MULTIBYTE is nonzero if the result should be multibyte. */
3264 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3265 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3266 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3269 DEFUN ("format", Fformat
, Sformat
, 1, MANY
, 0,
3270 doc
: /* Format a string out of a control-string and arguments.
3271 The first argument is a control string.
3272 The other arguments are substituted into it to make the result, a string.
3273 It may contain %-sequences meaning to substitute the next argument.
3274 %s means print a string argument. Actually, prints any object, with `princ'.
3275 %d means print as number in decimal (%o octal, %x hex).
3276 %X is like %x, but uses upper case.
3277 %e means print a number in exponential notation.
3278 %f means print a number in decimal-point notation.
3279 %g means print a number in exponential notation
3280 or decimal-point notation, whichever uses fewer characters.
3281 %c means print a number as a single character.
3282 %S means print any object as an s-expression (using `prin1').
3283 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3284 Use %% to put a single % into the output.
3286 The basic structure of a %-sequence is
3287 % <flags> <width> <precision> character
3288 where flags is [- #0]+, width is [0-9]+, and precision is .[0-9]+
3290 usage: (format STRING &rest OBJECTS) */)
3293 register Lisp_Object
*args
;
3295 register int n
; /* The number of the next arg to substitute */
3296 register int total
; /* An estimate of the final length */
3298 register unsigned char *format
, *end
, *format_start
;
3300 /* Nonzero if the output should be a multibyte string,
3301 which is true if any of the inputs is one. */
3303 /* When we make a multibyte string, we must pay attention to the
3304 byte combining problem, i.e., a byte may be combined with a
3305 multibyte charcter of the previous string. This flag tells if we
3306 must consider such a situation or not. */
3307 int maybe_combine_byte
;
3308 unsigned char *this_format
;
3309 /* Precision for each spec, or -1, a flag value meaning no precision
3310 was given in that spec. Element 0, corresonding to the format
3311 string itself, will not be used. Element NARGS, corresponding to
3312 no argument, *will* be assigned to in the case that a `%' and `.'
3313 occur after the final format specifier. */
3314 int *precision
= (int *) (alloca((nargs
+ 1) * sizeof (int)));
3317 int arg_intervals
= 0;
3320 /* discarded[I] is 1 if byte I of the format
3321 string was not copied into the output.
3322 It is 2 if byte I was not the first byte of its character. */
3323 char *discarded
= 0;
3325 /* Each element records, for one argument,
3326 the start and end bytepos in the output string,
3327 and whether the argument is a string with intervals.
3328 info[0] is unused. Unused elements have -1 for start. */
3331 int start
, end
, intervals
;
3334 /* It should not be necessary to GCPRO ARGS, because
3335 the caller in the interpreter should take care of that. */
3337 /* Try to determine whether the result should be multibyte.
3338 This is not always right; sometimes the result needs to be multibyte
3339 because of an object that we will pass through prin1,
3340 and in that case, we won't know it here. */
3341 for (n
= 0; n
< nargs
; n
++)
3343 if (STRINGP (args
[n
]) && STRING_MULTIBYTE (args
[n
]))
3345 /* Piggyback on this loop to initialize precision[N]. */
3348 precision
[nargs
] = -1;
3350 CHECK_STRING (args
[0]);
3351 /* We may have to change "%S" to "%s". */
3352 args
[0] = Fcopy_sequence (args
[0]);
3354 /* GC should never happen here, so abort if it does. */
3357 /* If we start out planning a unibyte result,
3358 then discover it has to be multibyte, we jump back to retry.
3359 That can only happen from the first large while loop below. */
3362 format
= SDATA (args
[0]);
3363 format_start
= format
;
3364 end
= format
+ SBYTES (args
[0]);
3367 /* Make room in result for all the non-%-codes in the control string. */
3368 total
= 5 + CONVERTED_BYTE_SIZE (multibyte
, args
[0]) + 1;
3370 /* Allocate the info and discarded tables. */
3372 int nbytes
= (nargs
+1) * sizeof *info
;
3375 info
= (struct info
*) alloca (nbytes
);
3376 bzero (info
, nbytes
);
3377 for (i
= 0; i
<= nargs
; i
++)
3380 SAFE_ALLOCA (discarded
, char *, SBYTES (args
[0]));
3381 bzero (discarded
, SBYTES (args
[0]));
3384 /* Add to TOTAL enough space to hold the converted arguments. */
3387 while (format
!= end
)
3388 if (*format
++ == '%')
3391 int actual_width
= 0;
3392 unsigned char *this_format_start
= format
- 1;
3393 int field_width
= 0;
3395 /* General format specifications look like
3397 '%' [flags] [field-width] [precision] format
3402 field-width ::= [0-9]+
3403 precision ::= '.' [0-9]*
3405 If a field-width is specified, it specifies to which width
3406 the output should be padded with blanks, iff the output
3407 string is shorter than field-width.
3409 If precision is specified, it specifies the number of
3410 digits to print after the '.' for floats, or the max.
3411 number of chars to print from a string. */
3413 while (index ("-0# ", *format
))
3416 if (*format
>= '0' && *format
<= '9')
3418 for (field_width
= 0; *format
>= '0' && *format
<= '9'; ++format
)
3419 field_width
= 10 * field_width
+ *format
- '0';
3422 /* N is not incremented for another few lines below, so refer to
3423 element N+1 (which might be precision[NARGS]). */
3427 for (precision
[n
+1] = 0; *format
>= '0' && *format
<= '9'; ++format
)
3428 precision
[n
+1] = 10 * precision
[n
+1] + *format
- '0';
3431 if (format
- this_format_start
+ 1 > longest_format
)
3432 longest_format
= format
- this_format_start
+ 1;
3435 error ("Format string ends in middle of format specifier");
3438 else if (++n
>= nargs
)
3439 error ("Not enough arguments for format string");
3440 else if (*format
== 'S')
3442 /* For `S', prin1 the argument and then treat like a string. */
3443 register Lisp_Object tem
;
3444 tem
= Fprin1_to_string (args
[n
], Qnil
);
3445 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3451 /* If we restart the loop, we should not come here again
3452 because args[n] is now a string and calling
3453 Fprin1_to_string on it produces superflous double
3454 quotes. So, change "%S" to "%s" now. */
3458 else if (SYMBOLP (args
[n
]))
3460 args
[n
] = SYMBOL_NAME (args
[n
]);
3461 if (STRING_MULTIBYTE (args
[n
]) && ! multibyte
)
3468 else if (STRINGP (args
[n
]))
3471 if (*format
!= 's' && *format
!= 'S')
3472 error ("Format specifier doesn't match argument type");
3473 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3474 to be as large as is calculated here. Easy check for
3475 the case PRECISION = 0. */
3476 thissize
= precision
[n
] ? CONVERTED_BYTE_SIZE (multibyte
, args
[n
]) : 0;
3477 actual_width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3479 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3480 else if (INTEGERP (args
[n
]) && *format
!= 's')
3482 /* The following loop assumes the Lisp type indicates
3483 the proper way to pass the argument.
3484 So make sure we have a flonum if the argument should
3486 if (*format
== 'e' || *format
== 'f' || *format
== 'g')
3487 args
[n
] = Ffloat (args
[n
]);
3489 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3490 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3491 error ("Invalid format operation %%%c", *format
);
3496 if (! SINGLE_BYTE_CHAR_P (XINT (args
[n
]))
3497 /* Note: No one can remember why we have to treat
3498 the character 0 as a multibyte character here.
3499 But, until it causes a real problem, let's
3501 || XINT (args
[n
]) == 0)
3508 args
[n
] = Fchar_to_string (args
[n
]);
3509 thissize
= SBYTES (args
[n
]);
3511 else if (! ASCII_BYTE_P (XINT (args
[n
])) && multibyte
)
3514 = Fchar_to_string (Funibyte_char_to_multibyte (args
[n
]));
3515 thissize
= SBYTES (args
[n
]);
3519 else if (FLOATP (args
[n
]) && *format
!= 's')
3521 if (! (*format
== 'e' || *format
== 'f' || *format
== 'g'))
3523 if (*format
!= 'd' && *format
!= 'o' && *format
!= 'x'
3524 && *format
!= 'i' && *format
!= 'X' && *format
!= 'c')
3525 error ("Invalid format operation %%%c", *format
);
3526 args
[n
] = Ftruncate (args
[n
], Qnil
);
3529 /* Note that we're using sprintf to print floats,
3530 so we have to take into account what that function
3532 /* Filter out flag value of -1. */
3533 thissize
= (MAX_10_EXP
+ 100
3534 + (precision
[n
] > 0 ? precision
[n
] : 0));
3538 /* Anything but a string, convert to a string using princ. */
3539 register Lisp_Object tem
;
3540 tem
= Fprin1_to_string (args
[n
], Qt
);
3541 if (STRING_MULTIBYTE (tem
) && ! multibyte
)
3550 thissize
+= max (0, field_width
- actual_width
);
3551 total
+= thissize
+ 4;
3556 /* Now we can no longer jump to retry.
3557 TOTAL and LONGEST_FORMAT are known for certain. */
3559 this_format
= (unsigned char *) alloca (longest_format
+ 1);
3561 /* Allocate the space for the result.
3562 Note that TOTAL is an overestimate. */
3563 SAFE_ALLOCA (buf
, char *, total
);
3569 /* Scan the format and store result in BUF. */
3570 format
= SDATA (args
[0]);
3571 format_start
= format
;
3572 end
= format
+ SBYTES (args
[0]);
3573 maybe_combine_byte
= 0;
3574 while (format
!= end
)
3580 unsigned char *this_format_start
= format
;
3582 discarded
[format
- format_start
] = 1;
3585 while (index("-0# ", *format
))
3591 discarded
[format
- format_start
] = 1;
3595 minlen
= atoi (format
);
3597 while ((*format
>= '0' && *format
<= '9') || *format
== '.')
3599 discarded
[format
- format_start
] = 1;
3603 if (*format
++ == '%')
3612 discarded
[format
- format_start
- 1] = 1;
3613 info
[n
].start
= nchars
;
3615 if (STRINGP (args
[n
]))
3617 /* handle case (precision[n] >= 0) */
3620 int nbytes
, start
, end
;
3623 /* lisp_string_width ignores a precision of 0, but GNU
3624 libc functions print 0 characters when the precision
3625 is 0. Imitate libc behavior here. Changing
3626 lisp_string_width is the right thing, and will be
3627 done, but meanwhile we work with it. */
3629 if (precision
[n
] == 0)
3630 width
= nchars_string
= nbytes
= 0;
3631 else if (precision
[n
] > 0)
3632 width
= lisp_string_width (args
[n
], precision
[n
], &nchars_string
, &nbytes
);
3634 { /* no precision spec given for this argument */
3635 width
= lisp_string_width (args
[n
], -1, NULL
, NULL
);
3636 nbytes
= SBYTES (args
[n
]);
3637 nchars_string
= SCHARS (args
[n
]);
3640 /* If spec requires it, pad on right with spaces. */
3641 padding
= minlen
- width
;
3643 while (padding
-- > 0)
3650 nchars
+= nchars_string
;
3655 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3656 && STRING_MULTIBYTE (args
[n
])
3657 && !CHAR_HEAD_P (SREF (args
[n
], 0)))
3658 maybe_combine_byte
= 1;
3660 p
+= copy_text (SDATA (args
[n
]), p
,
3662 STRING_MULTIBYTE (args
[n
]), multibyte
);
3665 while (padding
-- > 0)
3671 /* If this argument has text properties, record where
3672 in the result string it appears. */
3673 if (STRING_INTERVALS (args
[n
]))
3674 info
[n
].intervals
= arg_intervals
= 1;
3676 else if (INTEGERP (args
[n
]) || FLOATP (args
[n
]))
3680 bcopy (this_format_start
, this_format
,
3681 format
- this_format_start
);
3682 this_format
[format
- this_format_start
] = 0;
3684 if (INTEGERP (args
[n
]))
3685 sprintf (p
, this_format
, XINT (args
[n
]));
3687 sprintf (p
, this_format
, XFLOAT_DATA (args
[n
]));
3691 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3692 && !CHAR_HEAD_P (*((unsigned char *) p
)))
3693 maybe_combine_byte
= 1;
3694 this_nchars
= strlen (p
);
3696 p
+= str_to_multibyte (p
, buf
+ total
- 1 - p
, this_nchars
);
3699 nchars
+= this_nchars
;
3702 info
[n
].end
= nchars
;
3704 else if (STRING_MULTIBYTE (args
[0]))
3706 /* Copy a whole multibyte character. */
3709 && !ASCII_BYTE_P (*((unsigned char *) p
- 1))
3710 && !CHAR_HEAD_P (*format
))
3711 maybe_combine_byte
= 1;
3713 while (! CHAR_HEAD_P (*format
))
3715 discarded
[format
- format_start
] = 2;
3722 /* Convert a single-byte character to multibyte. */
3723 int len
= copy_text (format
, p
, 1, 0, 1);
3730 *p
++ = *format
++, nchars
++;
3733 if (p
> buf
+ total
)
3736 if (maybe_combine_byte
)
3737 nchars
= multibyte_chars_in_text (buf
, p
- buf
);
3738 val
= make_specified_string (buf
, nchars
, p
- buf
, multibyte
);
3740 /* If we allocated BUF with malloc, free it too. */
3743 /* If the format string has text properties, or any of the string
3744 arguments has text properties, set up text properties of the
3747 if (STRING_INTERVALS (args
[0]) || arg_intervals
)
3749 Lisp_Object len
, new_len
, props
;
3750 struct gcpro gcpro1
;
3752 /* Add text properties from the format string. */
3753 len
= make_number (SCHARS (args
[0]));
3754 props
= text_property_list (args
[0], make_number (0), len
, Qnil
);
3759 int bytepos
= 0, position
= 0, translated
= 0, argn
= 1;
3762 /* Adjust the bounds of each text property
3763 to the proper start and end in the output string. */
3765 /* Put the positions in PROPS in increasing order, so that
3766 we can do (effectively) one scan through the position
3767 space of the format string. */
3768 props
= Fnreverse (props
);
3770 /* BYTEPOS is the byte position in the format string,
3771 POSITION is the untranslated char position in it,
3772 TRANSLATED is the translated char position in BUF,
3773 and ARGN is the number of the next arg we will come to. */
3774 for (list
= props
; CONSP (list
); list
= XCDR (list
))
3781 /* First adjust the property start position. */
3782 pos
= XINT (XCAR (item
));
3784 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
3785 up to this position. */
3786 for (; position
< pos
; bytepos
++)
3788 if (! discarded
[bytepos
])
3789 position
++, translated
++;
3790 else if (discarded
[bytepos
] == 1)
3793 if (translated
== info
[argn
].start
)
3795 translated
+= info
[argn
].end
- info
[argn
].start
;
3801 XSETCAR (item
, make_number (translated
));
3803 /* Likewise adjust the property end position. */
3804 pos
= XINT (XCAR (XCDR (item
)));
3806 for (; bytepos
< pos
; bytepos
++)
3808 if (! discarded
[bytepos
])
3809 position
++, translated
++;
3810 else if (discarded
[bytepos
] == 1)
3813 if (translated
== info
[argn
].start
)
3815 translated
+= info
[argn
].end
- info
[argn
].start
;
3821 XSETCAR (XCDR (item
), make_number (translated
));
3824 add_text_properties_from_list (val
, props
, make_number (0));
3827 /* Add text properties from arguments. */
3829 for (n
= 1; n
< nargs
; ++n
)
3830 if (info
[n
].intervals
)
3832 len
= make_number (SCHARS (args
[n
]));
3833 new_len
= make_number (info
[n
].end
- info
[n
].start
);
3834 props
= text_property_list (args
[n
], make_number (0), len
, Qnil
);
3835 extend_property_ranges (props
, len
, new_len
);
3836 /* If successive arguments have properites, be sure that
3837 the value of `composition' property be the copy. */
3838 if (n
> 1 && info
[n
- 1].end
)
3839 make_composition_value_copy (props
);
3840 add_text_properties_from_list (val
, props
,
3841 make_number (info
[n
].start
));
3851 format2 (string1
, arg0
, arg1
)
3853 Lisp_Object arg0
, arg1
;
3855 Lisp_Object args
[3];
3856 args
[0] = build_string (string1
);
3859 return Fformat (3, args
);
3862 DEFUN ("char-equal", Fchar_equal
, Schar_equal
, 2, 2, 0,
3863 doc
: /* Return t if two characters match, optionally ignoring case.
3864 Both arguments must be characters (i.e. integers).
3865 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
3867 register Lisp_Object c1
, c2
;
3873 if (XINT (c1
) == XINT (c2
))
3875 if (NILP (current_buffer
->case_fold_search
))
3878 /* Do these in separate statements,
3879 then compare the variables.
3880 because of the way DOWNCASE uses temp variables. */
3881 i1
= DOWNCASE (XFASTINT (c1
));
3882 i2
= DOWNCASE (XFASTINT (c2
));
3883 return (i1
== i2
? Qt
: Qnil
);
3886 /* Transpose the markers in two regions of the current buffer, and
3887 adjust the ones between them if necessary (i.e.: if the regions
3890 START1, END1 are the character positions of the first region.
3891 START1_BYTE, END1_BYTE are the byte positions.
3892 START2, END2 are the character positions of the second region.
3893 START2_BYTE, END2_BYTE are the byte positions.
3895 Traverses the entire marker list of the buffer to do so, adding an
3896 appropriate amount to some, subtracting from some, and leaving the
3897 rest untouched. Most of this is copied from adjust_markers in insdel.c.
3899 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
3902 transpose_markers (start1
, end1
, start2
, end2
,
3903 start1_byte
, end1_byte
, start2_byte
, end2_byte
)
3904 register int start1
, end1
, start2
, end2
;
3905 register int start1_byte
, end1_byte
, start2_byte
, end2_byte
;
3907 register int amt1
, amt1_byte
, amt2
, amt2_byte
, diff
, diff_byte
, mpos
;
3908 register struct Lisp_Marker
*marker
;
3910 /* Update point as if it were a marker. */
3914 TEMP_SET_PT_BOTH (PT
+ (end2
- end1
),
3915 PT_BYTE
+ (end2_byte
- end1_byte
));
3916 else if (PT
< start2
)
3917 TEMP_SET_PT_BOTH (PT
+ (end2
- start2
) - (end1
- start1
),
3918 (PT_BYTE
+ (end2_byte
- start2_byte
)
3919 - (end1_byte
- start1_byte
)));
3921 TEMP_SET_PT_BOTH (PT
- (start2
- start1
),
3922 PT_BYTE
- (start2_byte
- start1_byte
));
3924 /* We used to adjust the endpoints here to account for the gap, but that
3925 isn't good enough. Even if we assume the caller has tried to move the
3926 gap out of our way, it might still be at start1 exactly, for example;
3927 and that places it `inside' the interval, for our purposes. The amount
3928 of adjustment is nontrivial if there's a `denormalized' marker whose
3929 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
3930 the dirty work to Fmarker_position, below. */
3932 /* The difference between the region's lengths */
3933 diff
= (end2
- start2
) - (end1
- start1
);
3934 diff_byte
= (end2_byte
- start2_byte
) - (end1_byte
- start1_byte
);
3936 /* For shifting each marker in a region by the length of the other
3937 region plus the distance between the regions. */
3938 amt1
= (end2
- start2
) + (start2
- end1
);
3939 amt2
= (end1
- start1
) + (start2
- end1
);
3940 amt1_byte
= (end2_byte
- start2_byte
) + (start2_byte
- end1_byte
);
3941 amt2_byte
= (end1_byte
- start1_byte
) + (start2_byte
- end1_byte
);
3943 for (marker
= BUF_MARKERS (current_buffer
); marker
; marker
= marker
->next
)
3945 mpos
= marker
->bytepos
;
3946 if (mpos
>= start1_byte
&& mpos
< end2_byte
)
3948 if (mpos
< end1_byte
)
3950 else if (mpos
< start2_byte
)
3954 marker
->bytepos
= mpos
;
3956 mpos
= marker
->charpos
;
3957 if (mpos
>= start1
&& mpos
< end2
)
3961 else if (mpos
< start2
)
3966 marker
->charpos
= mpos
;
3970 DEFUN ("transpose-regions", Ftranspose_regions
, Stranspose_regions
, 4, 5, 0,
3971 doc
: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
3972 The regions may not be overlapping, because the size of the buffer is
3973 never changed in a transposition.
3975 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
3976 any markers that happen to be located in the regions.
3978 Transposing beyond buffer boundaries is an error. */)
3979 (startr1
, endr1
, startr2
, endr2
, leave_markers
)
3980 Lisp_Object startr1
, endr1
, startr2
, endr2
, leave_markers
;
3982 register int start1
, end1
, start2
, end2
;
3983 int start1_byte
, start2_byte
, len1_byte
, len2_byte
;
3984 int gap
, len1
, len_mid
, len2
;
3985 unsigned char *start1_addr
, *start2_addr
, *temp
;
3987 INTERVAL cur_intv
, tmp_interval1
, tmp_interval_mid
, tmp_interval2
;
3988 cur_intv
= BUF_INTERVALS (current_buffer
);
3990 validate_region (&startr1
, &endr1
);
3991 validate_region (&startr2
, &endr2
);
3993 start1
= XFASTINT (startr1
);
3994 end1
= XFASTINT (endr1
);
3995 start2
= XFASTINT (startr2
);
3996 end2
= XFASTINT (endr2
);
3999 /* Swap the regions if they're reversed. */
4002 register int glumph
= start1
;
4010 len1
= end1
- start1
;
4011 len2
= end2
- start2
;
4014 error ("Transposed regions overlap");
4015 else if (start1
== end1
|| start2
== end2
)
4016 error ("Transposed region has length 0");
4018 /* The possibilities are:
4019 1. Adjacent (contiguous) regions, or separate but equal regions
4020 (no, really equal, in this case!), or
4021 2. Separate regions of unequal size.
4023 The worst case is usually No. 2. It means that (aside from
4024 potential need for getting the gap out of the way), there also
4025 needs to be a shifting of the text between the two regions. So
4026 if they are spread far apart, we are that much slower... sigh. */
4028 /* It must be pointed out that the really studly thing to do would
4029 be not to move the gap at all, but to leave it in place and work
4030 around it if necessary. This would be extremely efficient,
4031 especially considering that people are likely to do
4032 transpositions near where they are working interactively, which
4033 is exactly where the gap would be found. However, such code
4034 would be much harder to write and to read. So, if you are
4035 reading this comment and are feeling squirrely, by all means have
4036 a go! I just didn't feel like doing it, so I will simply move
4037 the gap the minimum distance to get it out of the way, and then
4038 deal with an unbroken array. */
4040 /* Make sure the gap won't interfere, by moving it out of the text
4041 we will operate on. */
4042 if (start1
< gap
&& gap
< end2
)
4044 if (gap
- start1
< end2
- gap
)
4050 start1_byte
= CHAR_TO_BYTE (start1
);
4051 start2_byte
= CHAR_TO_BYTE (start2
);
4052 len1_byte
= CHAR_TO_BYTE (end1
) - start1_byte
;
4053 len2_byte
= CHAR_TO_BYTE (end2
) - start2_byte
;
4055 #ifdef BYTE_COMBINING_DEBUG
4058 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4059 len2_byte
, start1
, start1_byte
)
4060 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4061 len1_byte
, end2
, start2_byte
+ len2_byte
)
4062 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4063 len1_byte
, end2
, start2_byte
+ len2_byte
))
4068 if (count_combining_before (BYTE_POS_ADDR (start2_byte
),
4069 len2_byte
, start1
, start1_byte
)
4070 || count_combining_before (BYTE_POS_ADDR (start1_byte
),
4071 len1_byte
, start2
, start2_byte
)
4072 || count_combining_after (BYTE_POS_ADDR (start2_byte
),
4073 len2_byte
, end1
, start1_byte
+ len1_byte
)
4074 || count_combining_after (BYTE_POS_ADDR (start1_byte
),
4075 len1_byte
, end2
, start2_byte
+ len2_byte
))
4080 /* Hmmm... how about checking to see if the gap is large
4081 enough to use as the temporary storage? That would avoid an
4082 allocation... interesting. Later, don't fool with it now. */
4084 /* Working without memmove, for portability (sigh), so must be
4085 careful of overlapping subsections of the array... */
4087 if (end1
== start2
) /* adjacent regions */
4089 modify_region (current_buffer
, start1
, end2
);
4090 record_change (start1
, len1
+ len2
);
4092 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4093 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4094 Fset_text_properties (make_number (start1
), make_number (end2
),
4097 /* First region smaller than second. */
4098 if (len1_byte
< len2_byte
)
4102 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4104 /* Don't precompute these addresses. We have to compute them
4105 at the last minute, because the relocating allocator might
4106 have moved the buffer around during the xmalloc. */
4107 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4108 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4110 bcopy (start2_addr
, temp
, len2_byte
);
4111 bcopy (start1_addr
, start1_addr
+ len2_byte
, len1_byte
);
4112 bcopy (temp
, start1_addr
, len2_byte
);
4116 /* First region not smaller than second. */
4120 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4121 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4122 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4123 bcopy (start1_addr
, temp
, len1_byte
);
4124 bcopy (start2_addr
, start1_addr
, len2_byte
);
4125 bcopy (temp
, start1_addr
+ len2_byte
, len1_byte
);
4128 graft_intervals_into_buffer (tmp_interval1
, start1
+ len2
,
4129 len1
, current_buffer
, 0);
4130 graft_intervals_into_buffer (tmp_interval2
, start1
,
4131 len2
, current_buffer
, 0);
4132 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4133 update_compositions (start1
+ len2
, end2
, CHECK_TAIL
);
4135 /* Non-adjacent regions, because end1 != start2, bleagh... */
4138 len_mid
= start2_byte
- (start1_byte
+ len1_byte
);
4140 if (len1_byte
== len2_byte
)
4141 /* Regions are same size, though, how nice. */
4145 modify_region (current_buffer
, start1
, end1
);
4146 modify_region (current_buffer
, start2
, end2
);
4147 record_change (start1
, len1
);
4148 record_change (start2
, len2
);
4149 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4150 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4151 Fset_text_properties (make_number (start1
), make_number (end1
),
4153 Fset_text_properties (make_number (start2
), make_number (end2
),
4156 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4157 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4158 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4159 bcopy (start1_addr
, temp
, len1_byte
);
4160 bcopy (start2_addr
, start1_addr
, len2_byte
);
4161 bcopy (temp
, start2_addr
, len1_byte
);
4164 graft_intervals_into_buffer (tmp_interval1
, start2
,
4165 len1
, current_buffer
, 0);
4166 graft_intervals_into_buffer (tmp_interval2
, start1
,
4167 len2
, current_buffer
, 0);
4170 else if (len1_byte
< len2_byte
) /* Second region larger than first */
4171 /* Non-adjacent & unequal size, area between must also be shifted. */
4175 modify_region (current_buffer
, start1
, end2
);
4176 record_change (start1
, (end2
- start1
));
4177 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4178 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4179 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4180 Fset_text_properties (make_number (start1
), make_number (end2
),
4183 /* holds region 2 */
4184 SAFE_ALLOCA (temp
, unsigned char *, len2_byte
);
4185 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4186 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4187 bcopy (start2_addr
, temp
, len2_byte
);
4188 bcopy (start1_addr
, start1_addr
+ len_mid
+ len2_byte
, len1_byte
);
4189 safe_bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4190 bcopy (temp
, start1_addr
, len2_byte
);
4193 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4194 len1
, current_buffer
, 0);
4195 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4196 len_mid
, current_buffer
, 0);
4197 graft_intervals_into_buffer (tmp_interval2
, start1
,
4198 len2
, current_buffer
, 0);
4201 /* Second region smaller than first. */
4205 record_change (start1
, (end2
- start1
));
4206 modify_region (current_buffer
, start1
, end2
);
4208 tmp_interval1
= copy_intervals (cur_intv
, start1
, len1
);
4209 tmp_interval_mid
= copy_intervals (cur_intv
, end1
, len_mid
);
4210 tmp_interval2
= copy_intervals (cur_intv
, start2
, len2
);
4211 Fset_text_properties (make_number (start1
), make_number (end2
),
4214 /* holds region 1 */
4215 SAFE_ALLOCA (temp
, unsigned char *, len1_byte
);
4216 start1_addr
= BYTE_POS_ADDR (start1_byte
);
4217 start2_addr
= BYTE_POS_ADDR (start2_byte
);
4218 bcopy (start1_addr
, temp
, len1_byte
);
4219 bcopy (start2_addr
, start1_addr
, len2_byte
);
4220 bcopy (start1_addr
+ len1_byte
, start1_addr
+ len2_byte
, len_mid
);
4221 bcopy (temp
, start1_addr
+ len2_byte
+ len_mid
, len1_byte
);
4224 graft_intervals_into_buffer (tmp_interval1
, end2
- len1
,
4225 len1
, current_buffer
, 0);
4226 graft_intervals_into_buffer (tmp_interval_mid
, start1
+ len2
,
4227 len_mid
, current_buffer
, 0);
4228 graft_intervals_into_buffer (tmp_interval2
, start1
,
4229 len2
, current_buffer
, 0);
4232 update_compositions (start1
, start1
+ len2
, CHECK_BORDER
);
4233 update_compositions (end2
- len1
, end2
, CHECK_BORDER
);
4236 /* When doing multiple transpositions, it might be nice
4237 to optimize this. Perhaps the markers in any one buffer
4238 should be organized in some sorted data tree. */
4239 if (NILP (leave_markers
))
4241 transpose_markers (start1
, end1
, start2
, end2
,
4242 start1_byte
, start1_byte
+ len1_byte
,
4243 start2_byte
, start2_byte
+ len2_byte
);
4244 fix_start_end_in_overlays (start1
, end2
);
4256 Qbuffer_access_fontify_functions
4257 = intern ("buffer-access-fontify-functions");
4258 staticpro (&Qbuffer_access_fontify_functions
);
4260 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion
,
4261 doc
: /* Non-nil means text motion commands don't notice fields. */);
4262 Vinhibit_field_text_motion
= Qnil
;
4264 DEFVAR_LISP ("buffer-access-fontify-functions",
4265 &Vbuffer_access_fontify_functions
,
4266 doc
: /* List of functions called by `buffer-substring' to fontify if necessary.
4267 Each function is called with two arguments which specify the range
4268 of the buffer being accessed. */);
4269 Vbuffer_access_fontify_functions
= Qnil
;
4273 extern Lisp_Object Vprin1_to_string_buffer
;
4274 obuf
= Fcurrent_buffer ();
4275 /* Do this here, because init_buffer_once is too early--it won't work. */
4276 Fset_buffer (Vprin1_to_string_buffer
);
4277 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4278 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
4283 DEFVAR_LISP ("buffer-access-fontified-property",
4284 &Vbuffer_access_fontified_property
,
4285 doc
: /* Property which (if non-nil) indicates text has been fontified.
4286 `buffer-substring' need not call the `buffer-access-fontify-functions'
4287 functions if all the text being accessed has this property. */);
4288 Vbuffer_access_fontified_property
= Qnil
;
4290 DEFVAR_LISP ("system-name", &Vsystem_name
,
4291 doc
: /* The name of the machine Emacs is running on. */);
4293 DEFVAR_LISP ("user-full-name", &Vuser_full_name
,
4294 doc
: /* The full name of the user logged in. */);
4296 DEFVAR_LISP ("user-login-name", &Vuser_login_name
,
4297 doc
: /* The user's name, taken from environment variables if possible. */);
4299 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name
,
4300 doc
: /* The user's name, based upon the real uid only. */);
4302 defsubr (&Spropertize
);
4303 defsubr (&Schar_equal
);
4304 defsubr (&Sgoto_char
);
4305 defsubr (&Sstring_to_char
);
4306 defsubr (&Schar_to_string
);
4307 defsubr (&Sbuffer_substring
);
4308 defsubr (&Sbuffer_substring_no_properties
);
4309 defsubr (&Sbuffer_string
);
4311 defsubr (&Spoint_marker
);
4312 defsubr (&Smark_marker
);
4314 defsubr (&Sregion_beginning
);
4315 defsubr (&Sregion_end
);
4317 staticpro (&Qfield
);
4318 Qfield
= intern ("field");
4319 staticpro (&Qboundary
);
4320 Qboundary
= intern ("boundary");
4321 defsubr (&Sfield_beginning
);
4322 defsubr (&Sfield_end
);
4323 defsubr (&Sfield_string
);
4324 defsubr (&Sfield_string_no_properties
);
4325 defsubr (&Sdelete_field
);
4326 defsubr (&Sconstrain_to_field
);
4328 defsubr (&Sline_beginning_position
);
4329 defsubr (&Sline_end_position
);
4331 /* defsubr (&Smark); */
4332 /* defsubr (&Sset_mark); */
4333 defsubr (&Ssave_excursion
);
4334 defsubr (&Ssave_current_buffer
);
4336 defsubr (&Sbufsize
);
4337 defsubr (&Spoint_max
);
4338 defsubr (&Spoint_min
);
4339 defsubr (&Spoint_min_marker
);
4340 defsubr (&Spoint_max_marker
);
4341 defsubr (&Sgap_position
);
4342 defsubr (&Sgap_size
);
4343 defsubr (&Sposition_bytes
);
4344 defsubr (&Sbyte_to_position
);
4350 defsubr (&Sfollowing_char
);
4351 defsubr (&Sprevious_char
);
4352 defsubr (&Schar_after
);
4353 defsubr (&Schar_before
);
4355 defsubr (&Sinsert_before_markers
);
4356 defsubr (&Sinsert_and_inherit
);
4357 defsubr (&Sinsert_and_inherit_before_markers
);
4358 defsubr (&Sinsert_char
);
4360 defsubr (&Suser_login_name
);
4361 defsubr (&Suser_real_login_name
);
4362 defsubr (&Suser_uid
);
4363 defsubr (&Suser_real_uid
);
4364 defsubr (&Suser_full_name
);
4365 defsubr (&Semacs_pid
);
4366 defsubr (&Scurrent_time
);
4367 defsubr (&Sget_internal_run_time
);
4368 defsubr (&Sformat_time_string
);
4369 defsubr (&Sfloat_time
);
4370 defsubr (&Sdecode_time
);
4371 defsubr (&Sencode_time
);
4372 defsubr (&Scurrent_time_string
);
4373 defsubr (&Scurrent_time_zone
);
4374 defsubr (&Sset_time_zone_rule
);
4375 defsubr (&Ssystem_name
);
4376 defsubr (&Smessage
);
4377 defsubr (&Smessage_box
);
4378 defsubr (&Smessage_or_box
);
4379 defsubr (&Scurrent_message
);
4382 defsubr (&Sinsert_buffer_substring
);
4383 defsubr (&Scompare_buffer_substrings
);
4384 defsubr (&Ssubst_char_in_region
);
4385 defsubr (&Stranslate_region_internal
);
4386 defsubr (&Sdelete_region
);
4387 defsubr (&Sdelete_and_extract_region
);
4389 defsubr (&Snarrow_to_region
);
4390 defsubr (&Ssave_restriction
);
4391 defsubr (&Stranspose_regions
);
4394 /* arch-tag: fc3827d8-6f60-4067-b11e-c3218031b018
4395 (do not change this comment) */