Changes for ins/del in repeat.
[emacs.git] / src / editfns.c
blob2f5e3f711ea4000db46089a6fe4448827372ac6d
1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985,86,87,89,93,94,95,96,97,98, 1999, 2000
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)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; 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. */
23 #include <config.h>
24 #include <sys/types.h>
26 #ifdef VMS
27 #include "vms-pwd.h"
28 #else
29 #include <pwd.h>
30 #endif
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
36 #include "lisp.h"
37 #include "intervals.h"
38 #include "buffer.h"
39 #include "charset.h"
40 #include "coding.h"
41 #include "window.h"
43 #include "systime.h"
45 #define min(a, b) ((a) < (b) ? (a) : (b))
46 #define max(a, b) ((a) > (b) ? (a) : (b))
48 #ifndef NULL
49 #define NULL 0
50 #endif
52 #ifndef USE_CRT_DLL
53 extern char **environ;
54 #endif
56 extern Lisp_Object make_time P_ ((time_t));
57 extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
58 const struct tm *, int));
59 static int tm_diff P_ ((struct tm *, struct tm *));
60 static void find_field P_ ((Lisp_Object, Lisp_Object, int *, int *));
61 static void update_buffer_properties P_ ((int, int));
62 static Lisp_Object region_limit P_ ((int));
63 static int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
64 static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
65 size_t, const struct tm *, int));
66 static void general_insert_function P_ ((void (*) (unsigned char *, int),
67 void (*) (Lisp_Object, int, int, int,
68 int, int),
69 int, int, Lisp_Object *));
70 static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
71 static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
72 static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
74 #ifdef HAVE_INDEX
75 extern char *index P_ ((const char *, int));
76 #endif
78 Lisp_Object Vbuffer_access_fontify_functions;
79 Lisp_Object Qbuffer_access_fontify_functions;
80 Lisp_Object Vbuffer_access_fontified_property;
82 Lisp_Object Fuser_full_name P_ ((Lisp_Object));
84 /* Non-nil means don't stop at field boundary in text motion commands. */
86 Lisp_Object Vinhibit_field_text_motion;
88 /* Some static data, and a function to initialize it for each run */
90 Lisp_Object Vsystem_name;
91 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
92 Lisp_Object Vuser_full_name; /* full name of current user */
93 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER */
95 /* Symbol for the text property used to mark fields. */
97 Lisp_Object Qfield;
99 /* A special value for Qfield properties. */
101 Lisp_Object Qboundary;
104 void
105 init_editfns ()
107 char *user_name;
108 register unsigned char *p;
109 struct passwd *pw; /* password entry for the current user */
110 Lisp_Object tem;
112 /* Set up system_name even when dumping. */
113 init_system_name ();
115 #ifndef CANNOT_DUMP
116 /* Don't bother with this on initial start when just dumping out */
117 if (!initialized)
118 return;
119 #endif /* not CANNOT_DUMP */
121 pw = (struct passwd *) getpwuid (getuid ());
122 #ifdef MSDOS
123 /* We let the real user name default to "root" because that's quite
124 accurate on MSDOG and because it lets Emacs find the init file.
125 (The DVX libraries override the Djgpp libraries here.) */
126 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
127 #else
128 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
129 #endif
131 /* Get the effective user name, by consulting environment variables,
132 or the effective uid if those are unset. */
133 user_name = (char *) getenv ("LOGNAME");
134 if (!user_name)
135 #ifdef WINDOWSNT
136 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
137 #else /* WINDOWSNT */
138 user_name = (char *) getenv ("USER");
139 #endif /* WINDOWSNT */
140 if (!user_name)
142 pw = (struct passwd *) getpwuid (geteuid ());
143 user_name = (char *) (pw ? pw->pw_name : "unknown");
145 Vuser_login_name = build_string (user_name);
147 /* If the user name claimed in the environment vars differs from
148 the real uid, use the claimed name to find the full name. */
149 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
150 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
151 : Vuser_login_name);
153 p = (unsigned char *) getenv ("NAME");
154 if (p)
155 Vuser_full_name = build_string (p);
156 else if (NILP (Vuser_full_name))
157 Vuser_full_name = build_string ("unknown");
160 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
161 "Convert arg CHAR to a string containing that character.")
162 (character)
163 Lisp_Object character;
165 int len;
166 unsigned char str[MAX_MULTIBYTE_LENGTH];
168 CHECK_NUMBER (character, 0);
170 len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
171 ? (*str = (unsigned char)(XFASTINT (character)), 1)
172 : char_to_string (XFASTINT (character), str));
173 return make_string_from_bytes (str, 1, len);
176 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
177 "Convert arg STRING to a character, the first character of that string.\n\
178 A multibyte character is handled correctly.")
179 (string)
180 register Lisp_Object string;
182 register Lisp_Object val;
183 register struct Lisp_String *p;
184 CHECK_STRING (string, 0);
185 p = XSTRING (string);
186 if (p->size)
188 if (STRING_MULTIBYTE (string))
189 XSETFASTINT (val, STRING_CHAR (p->data, STRING_BYTES (p)));
190 else
191 XSETFASTINT (val, p->data[0]);
193 else
194 XSETFASTINT (val, 0);
195 return val;
198 static Lisp_Object
199 buildmark (charpos, bytepos)
200 int charpos, bytepos;
202 register Lisp_Object mark;
203 mark = Fmake_marker ();
204 set_marker_both (mark, Qnil, charpos, bytepos);
205 return mark;
208 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
209 "Return value of point, as an integer.\n\
210 Beginning of buffer is position (point-min)")
213 Lisp_Object temp;
214 XSETFASTINT (temp, PT);
215 return temp;
218 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
219 "Return value of point, as a marker object.")
222 return buildmark (PT, PT_BYTE);
226 clip_to_bounds (lower, num, upper)
227 int lower, num, upper;
229 if (num < lower)
230 return lower;
231 else if (num > upper)
232 return upper;
233 else
234 return num;
237 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
238 "Set point to POSITION, a number or marker.\n\
239 Beginning of buffer is position (point-min), end is (point-max).\n\
240 If the position is in the middle of a multibyte form,\n\
241 the actual point is set at the head of the multibyte form\n\
242 except in the case that `enable-multibyte-characters' is nil.")
243 (position)
244 register Lisp_Object position;
246 int pos;
248 if (MARKERP (position)
249 && current_buffer == XMARKER (position)->buffer)
251 pos = marker_position (position);
252 if (pos < BEGV)
253 SET_PT_BOTH (BEGV, BEGV_BYTE);
254 else if (pos > ZV)
255 SET_PT_BOTH (ZV, ZV_BYTE);
256 else
257 SET_PT_BOTH (pos, marker_byte_position (position));
259 return position;
262 CHECK_NUMBER_COERCE_MARKER (position, 0);
264 pos = clip_to_bounds (BEGV, XINT (position), ZV);
265 SET_PT (pos);
266 return position;
270 /* Return the start or end position of the region.
271 BEGINNINGP non-zero means return the start.
272 If there is no region active, signal an error. */
274 static Lisp_Object
275 region_limit (beginningp)
276 int beginningp;
278 extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
279 Lisp_Object m;
281 if (!NILP (Vtransient_mark_mode)
282 && NILP (Vmark_even_if_inactive)
283 && NILP (current_buffer->mark_active))
284 Fsignal (Qmark_inactive, Qnil);
286 m = Fmarker_position (current_buffer->mark);
287 if (NILP (m))
288 error ("There is no region now");
290 if ((PT < XFASTINT (m)) == beginningp)
291 m = make_number (PT);
292 return m;
295 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
296 "Return position of beginning of region, as an integer.")
299 return region_limit (1);
302 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
303 "Return position of end of region, as an integer.")
306 return region_limit (0);
309 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
310 "Return this buffer's mark, as a marker object.\n\
311 Watch out! Moving this marker changes the mark position.\n\
312 If you set the marker not to point anywhere, the buffer will have no mark.")
315 return current_buffer->mark;
319 /* Return nonzero if POS1 and POS2 have the same value
320 for the text property PROP. */
322 static int
323 char_property_eq (prop, pos1, pos2)
324 Lisp_Object prop;
325 Lisp_Object pos1, pos2;
327 Lisp_Object pval1, pval2;
329 pval1 = Fget_char_property (pos1, prop, Qnil);
330 pval2 = Fget_char_property (pos2, prop, Qnil);
332 return EQ (pval1, pval2);
335 /* Return the direction from which the text-property PROP would be
336 inherited by any new text inserted at POS: 1 if it would be
337 inherited from the char after POS, -1 if it would be inherited from
338 the char before POS, and 0 if from neither. */
340 static int
341 text_property_stickiness (prop, pos)
342 Lisp_Object prop;
343 Lisp_Object pos;
345 Lisp_Object front_sticky;
347 if (XINT (pos) > BEGV)
348 /* Consider previous character. */
350 Lisp_Object prev_pos, rear_non_sticky;
352 prev_pos = make_number (XINT (pos) - 1);
353 rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);
355 if (EQ (rear_non_sticky, Qnil)
356 || (CONSP (rear_non_sticky)
357 && NILP (Fmemq (prop, rear_non_sticky))))
358 /* PROP is not rear-non-sticky, and since this takes precedence over
359 any front-stickiness, PROP is inherited from before. */
360 return -1;
363 /* Consider following character. */
364 front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
366 if (EQ (front_sticky, Qt)
367 || (CONSP (front_sticky)
368 && !NILP (Fmemq (prop, front_sticky))))
369 /* PROP is inherited from after. */
370 return 1;
372 /* PROP is not inherited from either side. */
373 return 0;
377 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
378 the value of point is used instead. If BEG or END null,
379 means don't store the beginning or end of the field.
381 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
382 position of a field, then the beginning of the previous field is
383 returned instead of the beginning of POS's field (since the end of a
384 field is actually also the beginning of the next input field, this
385 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
386 true case, if two fields are separated by a field with the special
387 value `boundary', and POS lies within it, then the two separated
388 fields are considered to be adjacent, and POS between them, when
389 finding the beginning and ending of the "merged" field.
391 Either BEG or END may be 0, in which case the corresponding value
392 is not stored. */
394 static void
395 find_field (pos, merge_at_boundary, beg, end)
396 Lisp_Object pos;
397 Lisp_Object merge_at_boundary;
398 int *beg, *end;
400 /* Fields right before and after the point. */
401 Lisp_Object before_field, after_field;
402 /* If the fields came from overlays, the associated overlays.
403 Qnil means they came from text-properties. */
404 Lisp_Object before_overlay = Qnil, after_overlay = Qnil;
405 /* 1 if POS counts as the start of a field. */
406 int at_field_start = 0;
407 /* 1 if POS counts as the end of a field. */
408 int at_field_end = 0;
410 if (NILP (pos))
411 XSETFASTINT (pos, PT);
412 else
413 CHECK_NUMBER_COERCE_MARKER (pos, 0);
415 after_field
416 = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
417 before_field
418 = (XFASTINT (pos) > BEGV
419 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
420 Qfield, Qnil,
421 &before_overlay)
422 : Qnil);
424 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
425 and POS is at beginning of a field, which can also be interpreted
426 as the end of the previous field. Note that the case where if
427 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
428 more natural one; then we avoid treating the beginning of a field
429 specially. */
430 if (NILP (merge_at_boundary) && !EQ (after_field, before_field))
431 /* We are at a boundary, see which direction is inclusive. We
432 decide by seeing which field the `field' property sticks to. */
434 /* -1 means insertions go into before_field, 1 means they go
435 into after_field, 0 means neither. */
436 int stickiness;
437 /* Whether the before/after_field come from overlays. */
438 int bop = !NILP (before_overlay);
439 int aop = !NILP (after_overlay);
441 if (bop && XMARKER (OVERLAY_END (before_overlay))->insertion_type == 1)
442 /* before_field is from an overlay, which expands upon
443 end-insertions. Note that it's possible for after_overlay to
444 also eat insertions here, but then they will overlap, and
445 there's not much we can do. */
446 stickiness = -1;
447 else if (aop
448 && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
449 /* after_field is from an overlay, which expand to contain
450 start-insertions. */
451 stickiness = 1;
452 else if (bop && aop)
453 /* Both fields come from overlays, but neither will contain any
454 insertion here. */
455 stickiness = 0;
456 else if (bop)
457 /* before_field is an overlay that won't eat any insertion, but
458 after_field is from a text-property. Assume that the
459 text-property continues underneath the overlay, and so will
460 be inherited by any insertion, regardless of any stickiness
461 settings. */
462 stickiness = 1;
463 else if (aop)
464 /* Similarly, when after_field is the overlay. */
465 stickiness = -1;
466 else
467 /* Both fields come from text-properties. Look for explicit
468 stickiness properties. */
469 stickiness = text_property_stickiness (Qfield, pos);
471 if (stickiness > 0)
472 at_field_start = 1;
473 else if (stickiness < 0)
474 at_field_end = 1;
475 else
476 /* STICKINESS == 0 means that any inserted text will get a
477 `field' char-property of nil, so check to see if that
478 matches either of the adjacent characters (this being a
479 kind of "stickiness by default"). */
481 if (NILP (before_field))
482 at_field_end = 1; /* Sticks to the left. */
483 else if (NILP (after_field))
484 at_field_start = 1; /* Sticks to the right. */
488 /* Note about special `boundary' fields:
490 Consider the case where the point (`.') is between the fields `x' and `y':
492 xxxx.yyyy
494 In this situation, if merge_at_boundary is true, we consider the
495 `x' and `y' fields as forming one big merged field, and so the end
496 of the field is the end of `y'.
498 However, if `x' and `y' are separated by a special `boundary' field
499 (a field with a `field' char-property of 'boundary), then we ignore
500 this special field when merging adjacent fields. Here's the same
501 situation, but with a `boundary' field between the `x' and `y' fields:
503 xxx.BBBByyyy
505 Here, if point is at the end of `x', the beginning of `y', or
506 anywhere in-between (within the `boundary' field), we merge all
507 three fields and consider the beginning as being the beginning of
508 the `x' field, and the end as being the end of the `y' field. */
510 if (beg)
512 if (at_field_start)
513 /* POS is at the edge of a field, and we should consider it as
514 the beginning of the following field. */
515 *beg = XFASTINT (pos);
516 else
517 /* Find the previous field boundary. */
519 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
520 /* Skip a `boundary' field. */
521 pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,Qnil);
523 pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
524 *beg = NILP (pos) ? BEGV : XFASTINT (pos);
528 if (end)
530 if (at_field_end)
531 /* POS is at the edge of a field, and we should consider it as
532 the end of the previous field. */
533 *end = XFASTINT (pos);
534 else
535 /* Find the next field boundary. */
537 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
538 /* Skip a `boundary' field. */
539 pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
541 pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
542 *end = NILP (pos) ? ZV : XFASTINT (pos);
548 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
549 "Delete the field surrounding POS.\n\
550 A field is a region of text with the same `field' property.\n\
551 If POS is nil, the value of point is used for POS.")
552 (pos)
553 Lisp_Object pos;
555 int beg, end;
556 find_field (pos, Qnil, &beg, &end);
557 if (beg != end)
558 del_range (beg, end);
559 return Qnil;
562 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
563 "Return the contents of the field surrounding POS as a string.\n\
564 A field is a region of text with the same `field' property.\n\
565 If POS is nil, the value of point is used for POS.")
566 (pos)
567 Lisp_Object pos;
569 int beg, end;
570 find_field (pos, Qnil, &beg, &end);
571 return make_buffer_string (beg, end, 1);
574 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
575 "Return the contents of the field around POS, without text-properties.\n\
576 A field is a region of text with the same `field' property.\n\
577 If POS is nil, the value of point is used for POS.")
578 (pos)
579 Lisp_Object pos;
581 int beg, end;
582 find_field (pos, Qnil, &beg, &end);
583 return make_buffer_string (beg, end, 0);
586 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 2, 0,
587 "Return the beginning of the field surrounding POS.\n\
588 A field is a region of text with the same `field' property.\n\
589 If POS is nil, the value of point is used for POS.\n\
590 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its\n\
591 field, then the beginning of the *previous* field is returned.")
592 (pos, escape_from_edge)
593 Lisp_Object pos, escape_from_edge;
595 int beg;
596 find_field (pos, escape_from_edge, &beg, 0);
597 return make_number (beg);
600 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 2, 0,
601 "Return the end of the field surrounding POS.\n\
602 A field is a region of text with the same `field' property.\n\
603 If POS is nil, the value of point is used for POS.\n\
604 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,\n\
605 then the end of the *following* field is returned.")
606 (pos, escape_from_edge)
607 Lisp_Object pos, escape_from_edge;
609 int end;
610 find_field (pos, escape_from_edge, 0, &end);
611 return make_number (end);
614 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
615 "Return the position closest to NEW-POS that is in the same field as OLD-POS.\n\
617 A field is a region of text with the same `field' property.\n\
618 If NEW-POS is nil, then the current point is used instead, and set to the\n\
619 constrained position if that is different.\n\
621 If OLD-POS is at the boundary of two fields, then the allowable\n\
622 positions for NEW-POS depends on the value of the optional argument\n\
623 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is\n\
624 constrained to the field that has the same `field' char-property\n\
625 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE\n\
626 is non-nil, NEW-POS is constrained to the union of the two adjacent\n\
627 fields. Additionally, if two fields are separated by another field with\n\
628 the special value `boundary', then any point within this special field is\n\
629 also considered to be `on the boundary'.\n\
631 If the optional argument ONLY-IN-LINE is non-nil and constraining\n\
632 NEW-POS would move it to a different line, NEW-POS is returned\n\
633 unconstrained. This useful for commands that move by line, like\n\
634 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries\n\
635 only in the case where they can still move to the right line.\n\
637 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has\n\
638 a non-nil property of that name, then any field boundaries are ignored.\n\
640 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.")
641 (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
642 Lisp_Object new_pos, old_pos;
643 Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
645 /* If non-zero, then the original point, before re-positioning. */
646 int orig_point = 0;
648 if (NILP (new_pos))
649 /* Use the current point, and afterwards, set it. */
651 orig_point = PT;
652 XSETFASTINT (new_pos, PT);
655 if (NILP (Vinhibit_field_text_motion)
656 && !EQ (new_pos, old_pos)
657 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
658 || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
659 && (NILP (inhibit_capture_property)
660 || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
661 /* NEW_POS is not within the same field as OLD_POS; try to
662 move NEW_POS so that it is. */
664 int fwd, shortage;
665 Lisp_Object field_bound;
667 CHECK_NUMBER_COERCE_MARKER (new_pos, 0);
668 CHECK_NUMBER_COERCE_MARKER (old_pos, 0);
670 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
672 if (fwd)
673 field_bound = Ffield_end (old_pos, escape_from_edge);
674 else
675 field_bound = Ffield_beginning (old_pos, escape_from_edge);
677 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
678 other side of NEW_POS, which would mean that NEW_POS is
679 already acceptable, and it's not necessary to constrain it
680 to FIELD_BOUND. */
681 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
682 /* NEW_POS should be constrained, but only if either
683 ONLY_IN_LINE is nil (in which case any constraint is OK),
684 or NEW_POS and FIELD_BOUND are on the same line (in which
685 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
686 && (NILP (only_in_line)
687 /* This is the ONLY_IN_LINE case, check that NEW_POS and
688 FIELD_BOUND are on the same line by seeing whether
689 there's an intervening newline or not. */
690 || (scan_buffer ('\n',
691 XFASTINT (new_pos), XFASTINT (field_bound),
692 fwd ? -1 : 1, &shortage, 1),
693 shortage != 0)))
694 /* Constrain NEW_POS to FIELD_BOUND. */
695 new_pos = field_bound;
697 if (orig_point && XFASTINT (new_pos) != orig_point)
698 /* The NEW_POS argument was originally nil, so automatically set PT. */
699 SET_PT (XFASTINT (new_pos));
702 return new_pos;
706 DEFUN ("line-beginning-position", Fline_beginning_position, Sline_beginning_position,
707 0, 1, 0,
708 "Return the character position of the first character on the current line.\n\
709 With argument N not nil or 1, move forward N - 1 lines first.\n\
710 If scan reaches end of buffer, return that position.\n\
711 The scan does not cross a field boundary unless it would move\n\
712 beyond there to a different line. Field boundaries are not noticed if\n\
713 `inhibit-field-text-motion' is non-nil. .And if N is nil or 1,\n\
714 and scan starts at a field boundary, the scan stops as soon as it starts.\n\
716 This function does not move point.")
718 Lisp_Object n;
720 int orig, orig_byte, end;
722 if (NILP (n))
723 XSETFASTINT (n, 1);
724 else
725 CHECK_NUMBER (n, 0);
727 orig = PT;
728 orig_byte = PT_BYTE;
729 Fforward_line (make_number (XINT (n) - 1));
730 end = PT;
732 SET_PT_BOTH (orig, orig_byte);
734 /* Return END constrained to the current input field. */
735 return Fconstrain_to_field (make_number (end), make_number (orig),
736 XINT (n) != 1 ? Qt : Qnil,
737 Qt, Qnil);
740 DEFUN ("line-end-position", Fline_end_position, Sline_end_position,
741 0, 1, 0,
742 "Return the character position of the last character on the current line.\n\
743 With argument N not nil or 1, move forward N - 1 lines first.\n\
744 If scan reaches end of buffer, return that position.\n\
745 This function does not move point.")
747 Lisp_Object n;
749 int end_pos;
750 int orig = PT;
752 if (NILP (n))
753 XSETFASTINT (n, 1);
754 else
755 CHECK_NUMBER (n, 0);
757 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
759 /* Return END_POS constrained to the current input field. */
760 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
761 Qnil, Qt, Qnil);
764 Lisp_Object
765 save_excursion_save ()
767 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
768 == current_buffer);
770 return Fcons (Fpoint_marker (),
771 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
772 Fcons (visible ? Qt : Qnil,
773 Fcons (current_buffer->mark_active,
774 selected_window))));
777 Lisp_Object
778 save_excursion_restore (info)
779 Lisp_Object info;
781 Lisp_Object tem, tem1, omark, nmark;
782 struct gcpro gcpro1, gcpro2, gcpro3;
783 int visible_p;
785 tem = Fmarker_buffer (XCAR (info));
786 /* If buffer being returned to is now deleted, avoid error */
787 /* Otherwise could get error here while unwinding to top level
788 and crash */
789 /* In that case, Fmarker_buffer returns nil now. */
790 if (NILP (tem))
791 return Qnil;
793 omark = nmark = Qnil;
794 GCPRO3 (info, omark, nmark);
796 Fset_buffer (tem);
798 /* Point marker. */
799 tem = XCAR (info);
800 Fgoto_char (tem);
801 unchain_marker (tem);
803 /* Mark marker. */
804 info = XCDR (info);
805 tem = XCAR (info);
806 omark = Fmarker_position (current_buffer->mark);
807 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
808 nmark = Fmarker_position (tem);
809 unchain_marker (tem);
811 /* visible */
812 info = XCDR (info);
813 visible_p = !NILP (XCAR (info));
815 #if 0 /* We used to make the current buffer visible in the selected window
816 if that was true previously. That avoids some anomalies.
817 But it creates others, and it wasn't documented, and it is simpler
818 and cleaner never to alter the window/buffer connections. */
819 tem1 = Fcar (tem);
820 if (!NILP (tem1)
821 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
822 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
823 #endif /* 0 */
825 /* Mark active */
826 info = XCDR (info);
827 tem = XCAR (info);
828 tem1 = current_buffer->mark_active;
829 current_buffer->mark_active = tem;
831 if (!NILP (Vrun_hooks))
833 /* If mark is active now, and either was not active
834 or was at a different place, run the activate hook. */
835 if (! NILP (current_buffer->mark_active))
837 if (! EQ (omark, nmark))
838 call1 (Vrun_hooks, intern ("activate-mark-hook"));
840 /* If mark has ceased to be active, run deactivate hook. */
841 else if (! NILP (tem1))
842 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
845 /* If buffer was visible in a window, and a different window was
846 selected, and the old selected window is still showing this
847 buffer, restore point in that window. */
848 tem = XCDR (info);
849 if (visible_p
850 && !EQ (tem, selected_window)
851 /* This also verifies that the window is still live. */
852 && XBUFFER (XWINDOW (tem)->buffer) == current_buffer)
853 Fset_window_point (tem, make_number (PT));
855 UNGCPRO;
856 return Qnil;
859 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
860 "Save point, mark, and current buffer; execute BODY; restore those things.\n\
861 Executes BODY just like `progn'.\n\
862 The values of point, mark and the current buffer are restored\n\
863 even in case of abnormal exit (throw or error).\n\
864 The state of activation of the mark is also restored.\n\
866 This construct does not save `deactivate-mark', and therefore\n\
867 functions that change the buffer will still cause deactivation\n\
868 of the mark at the end of the command. To prevent that, bind\n\
869 `deactivate-mark' with `let'.")
870 (args)
871 Lisp_Object args;
873 register Lisp_Object val;
874 int count = specpdl_ptr - specpdl;
876 record_unwind_protect (save_excursion_restore, save_excursion_save ());
878 val = Fprogn (args);
879 return unbind_to (count, val);
882 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
883 "Save the current buffer; execute BODY; restore the current buffer.\n\
884 Executes BODY just like `progn'.")
885 (args)
886 Lisp_Object args;
888 Lisp_Object val;
889 int count = specpdl_ptr - specpdl;
891 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
893 val = Fprogn (args);
894 return unbind_to (count, val);
897 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
898 "Return the number of characters in the current buffer.\n\
899 If BUFFER, return the number of characters in that buffer instead.")
900 (buffer)
901 Lisp_Object buffer;
903 if (NILP (buffer))
904 return make_number (Z - BEG);
905 else
907 CHECK_BUFFER (buffer, 1);
908 return make_number (BUF_Z (XBUFFER (buffer))
909 - BUF_BEG (XBUFFER (buffer)));
913 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
914 "Return the minimum permissible value of point in the current buffer.\n\
915 This is 1, unless narrowing (a buffer restriction) is in effect.")
918 Lisp_Object temp;
919 XSETFASTINT (temp, BEGV);
920 return temp;
923 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
924 "Return a marker to the minimum permissible value of point in this buffer.\n\
925 This is the beginning, unless narrowing (a buffer restriction) is in effect.")
928 return buildmark (BEGV, BEGV_BYTE);
931 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
932 "Return the maximum permissible value of point in the current buffer.\n\
933 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
934 is in effect, in which case it is less.")
937 Lisp_Object temp;
938 XSETFASTINT (temp, ZV);
939 return temp;
942 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
943 "Return a marker to the maximum permissible value of point in this buffer.\n\
944 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
945 is in effect, in which case it is less.")
948 return buildmark (ZV, ZV_BYTE);
951 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
952 "Return the position of the gap, in the current buffer.\n\
953 See also `gap-size'.")
956 Lisp_Object temp;
957 XSETFASTINT (temp, GPT);
958 return temp;
961 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
962 "Return the size of the current buffer's gap.\n\
963 See also `gap-position'.")
966 Lisp_Object temp;
967 XSETFASTINT (temp, GAP_SIZE);
968 return temp;
971 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
972 "Return the byte position for character position POSITION.\n\
973 If POSITION is out of range, the value is nil.")
974 (position)
975 Lisp_Object position;
977 CHECK_NUMBER_COERCE_MARKER (position, 1);
978 if (XINT (position) < BEG || XINT (position) > Z)
979 return Qnil;
980 return make_number (CHAR_TO_BYTE (XINT (position)));
983 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
984 "Return the character position for byte position BYTEPOS.\n\
985 If BYTEPOS is out of range, the value is nil.")
986 (bytepos)
987 Lisp_Object bytepos;
989 CHECK_NUMBER (bytepos, 1);
990 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
991 return Qnil;
992 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
995 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
996 "Return the character following point, as a number.\n\
997 At the end of the buffer or accessible region, return 0.")
1000 Lisp_Object temp;
1001 if (PT >= ZV)
1002 XSETFASTINT (temp, 0);
1003 else
1004 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1005 return temp;
1008 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1009 "Return the character preceding point, as a number.\n\
1010 At the beginning of the buffer or accessible region, return 0.")
1013 Lisp_Object temp;
1014 if (PT <= BEGV)
1015 XSETFASTINT (temp, 0);
1016 else if (!NILP (current_buffer->enable_multibyte_characters))
1018 int pos = PT_BYTE;
1019 DEC_POS (pos);
1020 XSETFASTINT (temp, FETCH_CHAR (pos));
1022 else
1023 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1024 return temp;
1027 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1028 "Return t if point is at the beginning of the buffer.\n\
1029 If the buffer is narrowed, this means the beginning of the narrowed part.")
1032 if (PT == BEGV)
1033 return Qt;
1034 return Qnil;
1037 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1038 "Return t if point is at the end of the buffer.\n\
1039 If the buffer is narrowed, this means the end of the narrowed part.")
1042 if (PT == ZV)
1043 return Qt;
1044 return Qnil;
1047 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1048 "Return t if point is at the beginning of a line.")
1051 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1052 return Qt;
1053 return Qnil;
1056 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1057 "Return t if point is at the end of a line.\n\
1058 `End of a line' includes point being at the end of the buffer.")
1061 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1062 return Qt;
1063 return Qnil;
1066 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1067 "Return character in current buffer at position POS.\n\
1068 POS is an integer or a marker.\n\
1069 If POS is out of range, the value is nil.")
1070 (pos)
1071 Lisp_Object pos;
1073 register int pos_byte;
1075 if (NILP (pos))
1077 pos_byte = PT_BYTE;
1078 XSETFASTINT (pos, PT);
1081 if (MARKERP (pos))
1083 pos_byte = marker_byte_position (pos);
1084 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1085 return Qnil;
1087 else
1089 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1090 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1091 return Qnil;
1093 pos_byte = CHAR_TO_BYTE (XINT (pos));
1096 return make_number (FETCH_CHAR (pos_byte));
1099 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1100 "Return character in current buffer preceding position POS.\n\
1101 POS is an integer or a marker.\n\
1102 If POS is out of range, the value is nil.")
1103 (pos)
1104 Lisp_Object pos;
1106 register Lisp_Object val;
1107 register int pos_byte;
1109 if (NILP (pos))
1111 pos_byte = PT_BYTE;
1112 XSETFASTINT (pos, PT);
1115 if (MARKERP (pos))
1117 pos_byte = marker_byte_position (pos);
1119 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1120 return Qnil;
1122 else
1124 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1126 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1127 return Qnil;
1129 pos_byte = CHAR_TO_BYTE (XINT (pos));
1132 if (!NILP (current_buffer->enable_multibyte_characters))
1134 DEC_POS (pos_byte);
1135 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1137 else
1139 pos_byte--;
1140 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1142 return val;
1145 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1146 "Return the name under which the user logged in, as a string.\n\
1147 This is based on the effective uid, not the real uid.\n\
1148 Also, if the environment variable LOGNAME or USER is set,\n\
1149 that determines the value of this function.\n\n\
1150 If optional argument UID is an integer, return the login name of the user\n\
1151 with that uid, or nil if there is no such user.")
1152 (uid)
1153 Lisp_Object uid;
1155 struct passwd *pw;
1157 /* Set up the user name info if we didn't do it before.
1158 (That can happen if Emacs is dumpable
1159 but you decide to run `temacs -l loadup' and not dump. */
1160 if (INTEGERP (Vuser_login_name))
1161 init_editfns ();
1163 if (NILP (uid))
1164 return Vuser_login_name;
1166 CHECK_NUMBER (uid, 0);
1167 pw = (struct passwd *) getpwuid (XINT (uid));
1168 return (pw ? build_string (pw->pw_name) : Qnil);
1171 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1172 0, 0, 0,
1173 "Return the name of the user's real uid, as a string.\n\
1174 This ignores the environment variables LOGNAME and USER, so it differs from\n\
1175 `user-login-name' when running under `su'.")
1178 /* Set up the user name info if we didn't do it before.
1179 (That can happen if Emacs is dumpable
1180 but you decide to run `temacs -l loadup' and not dump. */
1181 if (INTEGERP (Vuser_login_name))
1182 init_editfns ();
1183 return Vuser_real_login_name;
1186 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1187 "Return the effective uid of Emacs, as an integer.")
1190 return make_number (geteuid ());
1193 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1194 "Return the real uid of Emacs, as an integer.")
1197 return make_number (getuid ());
1200 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1201 "Return the full name of the user logged in, as a string.\n\
1202 If the full name corresponding to Emacs's userid is not known,\n\
1203 return \"unknown\".\n\
1205 If optional argument UID is an integer, return the full name of the user\n\
1206 with that uid, or nil if there is no such user.\n\
1207 If UID is a string, return the full name of the user with that login\n\
1208 name, or nil if there is no such user.")
1209 (uid)
1210 Lisp_Object uid;
1212 struct passwd *pw;
1213 register unsigned char *p, *q;
1214 Lisp_Object full;
1216 if (NILP (uid))
1217 return Vuser_full_name;
1218 else if (NUMBERP (uid))
1219 pw = (struct passwd *) getpwuid (XINT (uid));
1220 else if (STRINGP (uid))
1221 pw = (struct passwd *) getpwnam (XSTRING (uid)->data);
1222 else
1223 error ("Invalid UID specification");
1225 if (!pw)
1226 return Qnil;
1228 p = (unsigned char *) USER_FULL_NAME;
1229 /* Chop off everything after the first comma. */
1230 q = (unsigned char *) index (p, ',');
1231 full = make_string (p, q ? q - p : strlen (p));
1233 #ifdef AMPERSAND_FULL_NAME
1234 p = XSTRING (full)->data;
1235 q = (unsigned char *) index (p, '&');
1236 /* Substitute the login name for the &, upcasing the first character. */
1237 if (q)
1239 register unsigned char *r;
1240 Lisp_Object login;
1242 login = Fuser_login_name (make_number (pw->pw_uid));
1243 r = (unsigned char *) alloca (strlen (p) + XSTRING (login)->size + 1);
1244 bcopy (p, r, q - p);
1245 r[q - p] = 0;
1246 strcat (r, XSTRING (login)->data);
1247 r[q - p] = UPCASE (r[q - p]);
1248 strcat (r, q + 1);
1249 full = build_string (r);
1251 #endif /* AMPERSAND_FULL_NAME */
1253 return full;
1256 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1257 "Return the name of the machine you are running on, as a string.")
1260 return Vsystem_name;
1263 /* For the benefit of callers who don't want to include lisp.h */
1265 char *
1266 get_system_name ()
1268 if (STRINGP (Vsystem_name))
1269 return (char *) XSTRING (Vsystem_name)->data;
1270 else
1271 return "";
1274 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1275 "Return the process ID of Emacs, as an integer.")
1278 return make_number (getpid ());
1281 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1282 "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
1283 The time is returned as a list of three integers. The first has the\n\
1284 most significant 16 bits of the seconds, while the second has the\n\
1285 least significant 16 bits. The third integer gives the microsecond\n\
1286 count.\n\
1288 The microsecond count is zero on systems that do not provide\n\
1289 resolution finer than a second.")
1292 EMACS_TIME t;
1293 Lisp_Object result[3];
1295 EMACS_GET_TIME (t);
1296 XSETINT (result[0], (EMACS_SECS (t) >> 16) & 0xffff);
1297 XSETINT (result[1], (EMACS_SECS (t) >> 0) & 0xffff);
1298 XSETINT (result[2], EMACS_USECS (t));
1300 return Flist (3, result);
1304 static int
1305 lisp_time_argument (specified_time, result, usec)
1306 Lisp_Object specified_time;
1307 time_t *result;
1308 int *usec;
1310 if (NILP (specified_time))
1312 if (usec)
1314 EMACS_TIME t;
1316 EMACS_GET_TIME (t);
1317 *usec = EMACS_USECS (t);
1318 *result = EMACS_SECS (t);
1319 return 1;
1321 else
1322 return time (result) != -1;
1324 else
1326 Lisp_Object high, low;
1327 high = Fcar (specified_time);
1328 CHECK_NUMBER (high, 0);
1329 low = Fcdr (specified_time);
1330 if (CONSP (low))
1332 if (usec)
1334 Lisp_Object usec_l = Fcdr (low);
1335 if (CONSP (usec_l))
1336 usec_l = Fcar (usec_l);
1337 if (NILP (usec_l))
1338 *usec = 0;
1339 else
1341 CHECK_NUMBER (usec_l, 0);
1342 *usec = XINT (usec_l);
1345 low = Fcar (low);
1347 else if (usec)
1348 *usec = 0;
1349 CHECK_NUMBER (low, 0);
1350 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1351 return *result >> 16 == XINT (high);
1355 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1356 "Return the current time, as a float number of seconds since the epoch.\n\
1357 If an argument is given, it specifies a time to convert to float\n\
1358 instead of the current time. The argument should have the forms:\n\
1359 (HIGH . LOW) or (HIGH LOW USEC) or (HIGH LOW . USEC).\n\
1360 Thus, you can use times obtained from `current-time'\n\
1361 and from `file-attributes'.")
1362 (specified_time)
1363 Lisp_Object specified_time;
1365 time_t sec;
1366 int usec;
1368 if (! lisp_time_argument (specified_time, &sec, &usec))
1369 error ("Invalid time specification");
1371 return make_float (sec + usec * 0.0000001);
1374 /* Write information into buffer S of size MAXSIZE, according to the
1375 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1376 Default to Universal Time if UT is nonzero, local time otherwise.
1377 Return the number of bytes written, not including the terminating
1378 '\0'. If S is NULL, nothing will be written anywhere; so to
1379 determine how many bytes would be written, use NULL for S and
1380 ((size_t) -1) for MAXSIZE.
1382 This function behaves like emacs_strftimeu, except it allows null
1383 bytes in FORMAT. */
1384 static size_t
1385 emacs_memftimeu (s, maxsize, format, format_len, tp, ut)
1386 char *s;
1387 size_t maxsize;
1388 const char *format;
1389 size_t format_len;
1390 const struct tm *tp;
1391 int ut;
1393 size_t total = 0;
1395 /* Loop through all the null-terminated strings in the format
1396 argument. Normally there's just one null-terminated string, but
1397 there can be arbitrarily many, concatenated together, if the
1398 format contains '\0' bytes. emacs_strftimeu stops at the first
1399 '\0' byte so we must invoke it separately for each such string. */
1400 for (;;)
1402 size_t len;
1403 size_t result;
1405 if (s)
1406 s[0] = '\1';
1408 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1410 if (s)
1412 if (result == 0 && s[0] != '\0')
1413 return 0;
1414 s += result + 1;
1417 maxsize -= result + 1;
1418 total += result;
1419 len = strlen (format);
1420 if (len == format_len)
1421 return total;
1422 total++;
1423 format += len + 1;
1424 format_len -= len + 1;
1429 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1430 "Use FORMAT-STRING to format the time TIME, or now if omitted.\n\
1431 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as returned by\n\
1432 `current-time' or `file-attributes'.\n\
1433 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME\n\
1434 as Universal Time; nil means describe TIME in the local time zone.\n\
1435 The value is a copy of FORMAT-STRING, but with certain constructs replaced\n\
1436 by text that describes the specified date and time in TIME:\n\
1438 %Y is the year, %y within the century, %C the century.\n\
1439 %G is the year corresponding to the ISO week, %g within the century.\n\
1440 %m is the numeric month.\n\
1441 %b and %h are the locale's abbreviated month name, %B the full name.\n\
1442 %d is the day of the month, zero-padded, %e is blank-padded.\n\
1443 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.\n\
1444 %a is the locale's abbreviated name of the day of week, %A the full name.\n\
1445 %U is the week number starting on Sunday, %W starting on Monday,\n\
1446 %V according to ISO 8601.\n\
1447 %j is the day of the year.\n\
1449 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H\n\
1450 only blank-padded, %l is like %I blank-padded.\n\
1451 %p is the locale's equivalent of either AM or PM.\n\
1452 %M is the minute.\n\
1453 %S is the second.\n\
1454 %Z is the time zone name, %z is the numeric form.\n\
1455 %s is the number of seconds since 1970-01-01 00:00:00 +0000.\n\
1457 %c is the locale's date and time format.\n\
1458 %x is the locale's \"preferred\" date format.\n\
1459 %D is like \"%m/%d/%y\".\n\
1461 %R is like \"%H:%M\", %T is like \"%H:%M:%S\", %r is like \"%I:%M:%S %p\".\n\
1462 %X is the locale's \"preferred\" time format.\n\
1464 Finally, %n is a newline, %t is a tab, %% is a literal %.\n\
1466 Certain flags and modifiers are available with some format controls.\n\
1467 The flags are `_', `-', `^' and `#'. For certain characters X,\n\
1468 %_X is like %X, but padded with blanks; %-X is like %X,\n\
1469 ut without padding. %^X is like %X but with all textual\n\
1470 characters up-cased; %#X is like %X but with letter-case of\n\
1471 all textual characters reversed.\n\
1472 %NX (where N stands for an integer) is like %X,\n\
1473 but takes up at least N (a number) positions.\n\
1474 The modifiers are `E' and `O'. For certain characters X,\n\
1475 %EX is a locale's alternative version of %X;\n\
1476 %OX is like %X, but uses the locale's number symbols.\n\
1478 For example, to produce full ISO 8601 format, use \"%Y-%m-%dT%T%z\".")
1479 (format_string, time, universal)
1482 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1483 0 /* See immediately above */)
1484 (format_string, time, universal)
1485 Lisp_Object format_string, time, universal;
1487 time_t value;
1488 int size;
1489 struct tm *tm;
1490 int ut = ! NILP (universal);
1492 CHECK_STRING (format_string, 1);
1494 if (! lisp_time_argument (time, &value, NULL))
1495 error ("Invalid time specification");
1497 format_string = code_convert_string_norecord (format_string,
1498 Vlocale_coding_system, 1);
1500 /* This is probably enough. */
1501 size = STRING_BYTES (XSTRING (format_string)) * 6 + 50;
1503 tm = ut ? gmtime (&value) : localtime (&value);
1504 if (! tm)
1505 error ("Specified time is not representable");
1507 synchronize_system_time_locale ();
1509 while (1)
1511 char *buf = (char *) alloca (size + 1);
1512 int result;
1514 buf[0] = '\1';
1515 result = emacs_memftimeu (buf, size, XSTRING (format_string)->data,
1516 STRING_BYTES (XSTRING (format_string)),
1517 tm, ut);
1518 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1519 return code_convert_string_norecord (make_string (buf, result),
1520 Vlocale_coding_system, 0);
1522 /* If buffer was too small, make it bigger and try again. */
1523 result = emacs_memftimeu (NULL, (size_t) -1,
1524 XSTRING (format_string)->data,
1525 STRING_BYTES (XSTRING (format_string)),
1526 tm, ut);
1527 size = result + 1;
1531 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1532 "Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).\n\
1533 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)\n\
1534 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'\n\
1535 to use the current time. The list has the following nine members:\n\
1536 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which\n\
1537 only some operating systems support. MINUTE is an integer between 0 and 59.\n\
1538 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.\n\
1539 MONTH is an integer between 1 and 12. YEAR is an integer indicating the\n\
1540 four-digit year. DOW is the day of week, an integer between 0 and 6, where\n\
1541 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.\n\
1542 ZONE is an integer indicating the number of seconds east of Greenwich.\n\
1543 \(Note that Common Lisp has different meanings for DOW and ZONE.)")
1544 (specified_time)
1545 Lisp_Object specified_time;
1547 time_t time_spec;
1548 struct tm save_tm;
1549 struct tm *decoded_time;
1550 Lisp_Object list_args[9];
1552 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1553 error ("Invalid time specification");
1555 decoded_time = localtime (&time_spec);
1556 if (! decoded_time)
1557 error ("Specified time is not representable");
1558 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1559 XSETFASTINT (list_args[1], decoded_time->tm_min);
1560 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1561 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1562 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1563 XSETINT (list_args[5], decoded_time->tm_year + 1900);
1564 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1565 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1567 /* Make a copy, in case gmtime modifies the struct. */
1568 save_tm = *decoded_time;
1569 decoded_time = gmtime (&time_spec);
1570 if (decoded_time == 0)
1571 list_args[8] = Qnil;
1572 else
1573 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1574 return Flist (9, list_args);
1577 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1578 "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
1579 This is the reverse operation of `decode-time', which see.\n\
1580 ZONE defaults to the current time zone rule. This can\n\
1581 be a string or t (as from `set-time-zone-rule'), or it can be a list\n\
1582 \(as from `current-time-zone') or an integer (as from `decode-time')\n\
1583 applied without consideration for daylight savings time.\n\
1585 You can pass more than 7 arguments; then the first six arguments\n\
1586 are used as SECOND through YEAR, and the *last* argument is used as ZONE.\n\
1587 The intervening arguments are ignored.\n\
1588 This feature lets (apply 'encode-time (decode-time ...)) work.\n\
1590 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;\n\
1591 for example, a DAY of 0 means the day preceding the given month.\n\
1592 Year numbers less than 100 are treated just like other year numbers.\n\
1593 If you want them to stand for years in this century, you must do that yourself.")
1594 (nargs, args)
1595 int nargs;
1596 register Lisp_Object *args;
1598 time_t time;
1599 struct tm tm;
1600 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1602 CHECK_NUMBER (args[0], 0); /* second */
1603 CHECK_NUMBER (args[1], 1); /* minute */
1604 CHECK_NUMBER (args[2], 2); /* hour */
1605 CHECK_NUMBER (args[3], 3); /* day */
1606 CHECK_NUMBER (args[4], 4); /* month */
1607 CHECK_NUMBER (args[5], 5); /* year */
1609 tm.tm_sec = XINT (args[0]);
1610 tm.tm_min = XINT (args[1]);
1611 tm.tm_hour = XINT (args[2]);
1612 tm.tm_mday = XINT (args[3]);
1613 tm.tm_mon = XINT (args[4]) - 1;
1614 tm.tm_year = XINT (args[5]) - 1900;
1615 tm.tm_isdst = -1;
1617 if (CONSP (zone))
1618 zone = Fcar (zone);
1619 if (NILP (zone))
1620 time = mktime (&tm);
1621 else
1623 char tzbuf[100];
1624 char *tzstring;
1625 char **oldenv = environ, **newenv;
1627 if (EQ (zone, Qt))
1628 tzstring = "UTC0";
1629 else if (STRINGP (zone))
1630 tzstring = (char *) XSTRING (zone)->data;
1631 else if (INTEGERP (zone))
1633 int abszone = abs (XINT (zone));
1634 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1635 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1636 tzstring = tzbuf;
1638 else
1639 error ("Invalid time zone specification");
1641 /* Set TZ before calling mktime; merely adjusting mktime's returned
1642 value doesn't suffice, since that would mishandle leap seconds. */
1643 set_time_zone_rule (tzstring);
1645 time = mktime (&tm);
1647 /* Restore TZ to previous value. */
1648 newenv = environ;
1649 environ = oldenv;
1650 xfree (newenv);
1651 #ifdef LOCALTIME_CACHE
1652 tzset ();
1653 #endif
1656 if (time == (time_t) -1)
1657 error ("Specified time is not representable");
1659 return make_time (time);
1662 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1663 "Return the current time, as a human-readable string.\n\
1664 Programs can use this function to decode a time,\n\
1665 since the number of columns in each field is fixed.\n\
1666 The format is `Sun Sep 16 01:03:52 1973'.\n\
1667 However, see also the functions `decode-time' and `format-time-string'\n\
1668 which provide a much more powerful and general facility.\n\
1670 If an argument is given, it specifies a time to format\n\
1671 instead of the current time. The argument should have the form:\n\
1672 (HIGH . LOW)\n\
1673 or the form:\n\
1674 (HIGH LOW . IGNORED).\n\
1675 Thus, you can use times obtained from `current-time'\n\
1676 and from `file-attributes'.")
1677 (specified_time)
1678 Lisp_Object specified_time;
1680 time_t value;
1681 char buf[30];
1682 register char *tem;
1684 if (! lisp_time_argument (specified_time, &value, NULL))
1685 value = -1;
1686 tem = (char *) ctime (&value);
1688 strncpy (buf, tem, 24);
1689 buf[24] = 0;
1691 return build_string (buf);
1694 #define TM_YEAR_BASE 1900
1696 /* Yield A - B, measured in seconds.
1697 This function is copied from the GNU C Library. */
1698 static int
1699 tm_diff (a, b)
1700 struct tm *a, *b;
1702 /* Compute intervening leap days correctly even if year is negative.
1703 Take care to avoid int overflow in leap day calculations,
1704 but it's OK to assume that A and B are close to each other. */
1705 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1706 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1707 int a100 = a4 / 25 - (a4 % 25 < 0);
1708 int b100 = b4 / 25 - (b4 % 25 < 0);
1709 int a400 = a100 >> 2;
1710 int b400 = b100 >> 2;
1711 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1712 int years = a->tm_year - b->tm_year;
1713 int days = (365 * years + intervening_leap_days
1714 + (a->tm_yday - b->tm_yday));
1715 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1716 + (a->tm_min - b->tm_min))
1717 + (a->tm_sec - b->tm_sec));
1720 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1721 "Return the offset and name for the local time zone.\n\
1722 This returns a list of the form (OFFSET NAME).\n\
1723 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).\n\
1724 A negative value means west of Greenwich.\n\
1725 NAME is a string giving the name of the time zone.\n\
1726 If an argument is given, it specifies when the time zone offset is determined\n\
1727 instead of using the current time. The argument should have the form:\n\
1728 (HIGH . LOW)\n\
1729 or the form:\n\
1730 (HIGH LOW . IGNORED).\n\
1731 Thus, you can use times obtained from `current-time'\n\
1732 and from `file-attributes'.\n\
1734 Some operating systems cannot provide all this information to Emacs;\n\
1735 in this case, `current-time-zone' returns a list containing nil for\n\
1736 the data it can't find.")
1737 (specified_time)
1738 Lisp_Object specified_time;
1740 time_t value;
1741 struct tm *t;
1742 struct tm gmt;
1744 if (lisp_time_argument (specified_time, &value, NULL)
1745 && (t = gmtime (&value)) != 0
1746 && (gmt = *t, t = localtime (&value)) != 0)
1748 int offset = tm_diff (t, &gmt);
1749 char *s = 0;
1750 char buf[6];
1751 #ifdef HAVE_TM_ZONE
1752 if (t->tm_zone)
1753 s = (char *)t->tm_zone;
1754 #else /* not HAVE_TM_ZONE */
1755 #ifdef HAVE_TZNAME
1756 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1757 s = tzname[t->tm_isdst];
1758 #endif
1759 #endif /* not HAVE_TM_ZONE */
1760 if (!s)
1762 /* No local time zone name is available; use "+-NNNN" instead. */
1763 int am = (offset < 0 ? -offset : offset) / 60;
1764 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1765 s = buf;
1767 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
1769 else
1770 return Fmake_list (make_number (2), Qnil);
1773 /* This holds the value of `environ' produced by the previous
1774 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1775 has never been called. */
1776 static char **environbuf;
1778 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
1779 "Set the local time zone using TZ, a string specifying a time zone rule.\n\
1780 If TZ is nil, use implementation-defined default time zone information.\n\
1781 If TZ is t, use Universal Time.")
1782 (tz)
1783 Lisp_Object tz;
1785 char *tzstring;
1787 if (NILP (tz))
1788 tzstring = 0;
1789 else if (EQ (tz, Qt))
1790 tzstring = "UTC0";
1791 else
1793 CHECK_STRING (tz, 0);
1794 tzstring = (char *) XSTRING (tz)->data;
1797 set_time_zone_rule (tzstring);
1798 if (environbuf)
1799 free (environbuf);
1800 environbuf = environ;
1802 return Qnil;
1805 #ifdef LOCALTIME_CACHE
1807 /* These two values are known to load tz files in buggy implementations,
1808 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1809 Their values shouldn't matter in non-buggy implementations.
1810 We don't use string literals for these strings,
1811 since if a string in the environment is in readonly
1812 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1813 See Sun bugs 1113095 and 1114114, ``Timezone routines
1814 improperly modify environment''. */
1816 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1817 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1819 #endif
1821 /* Set the local time zone rule to TZSTRING.
1822 This allocates memory into `environ', which it is the caller's
1823 responsibility to free. */
1825 void
1826 set_time_zone_rule (tzstring)
1827 char *tzstring;
1829 int envptrs;
1830 char **from, **to, **newenv;
1832 /* Make the ENVIRON vector longer with room for TZSTRING. */
1833 for (from = environ; *from; from++)
1834 continue;
1835 envptrs = from - environ + 2;
1836 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1837 + (tzstring ? strlen (tzstring) + 4 : 0));
1839 /* Add TZSTRING to the end of environ, as a value for TZ. */
1840 if (tzstring)
1842 char *t = (char *) (to + envptrs);
1843 strcpy (t, "TZ=");
1844 strcat (t, tzstring);
1845 *to++ = t;
1848 /* Copy the old environ vector elements into NEWENV,
1849 but don't copy the TZ variable.
1850 So we have only one definition of TZ, which came from TZSTRING. */
1851 for (from = environ; *from; from++)
1852 if (strncmp (*from, "TZ=", 3) != 0)
1853 *to++ = *from;
1854 *to = 0;
1856 environ = newenv;
1858 /* If we do have a TZSTRING, NEWENV points to the vector slot where
1859 the TZ variable is stored. If we do not have a TZSTRING,
1860 TO points to the vector slot which has the terminating null. */
1862 #ifdef LOCALTIME_CACHE
1864 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1865 "US/Pacific" that loads a tz file, then changes to a value like
1866 "XXX0" that does not load a tz file, and then changes back to
1867 its original value, the last change is (incorrectly) ignored.
1868 Also, if TZ changes twice in succession to values that do
1869 not load a tz file, tzset can dump core (see Sun bug#1225179).
1870 The following code works around these bugs. */
1872 if (tzstring)
1874 /* Temporarily set TZ to a value that loads a tz file
1875 and that differs from tzstring. */
1876 char *tz = *newenv;
1877 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1878 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1879 tzset ();
1880 *newenv = tz;
1882 else
1884 /* The implied tzstring is unknown, so temporarily set TZ to
1885 two different values that each load a tz file. */
1886 *to = set_time_zone_rule_tz1;
1887 to[1] = 0;
1888 tzset ();
1889 *to = set_time_zone_rule_tz2;
1890 tzset ();
1891 *to = 0;
1894 /* Now TZ has the desired value, and tzset can be invoked safely. */
1897 tzset ();
1898 #endif
1901 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
1902 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
1903 type of object is Lisp_String). INHERIT is passed to
1904 INSERT_FROM_STRING_FUNC as the last argument. */
1906 static void
1907 general_insert_function (insert_func, insert_from_string_func,
1908 inherit, nargs, args)
1909 void (*insert_func) P_ ((unsigned char *, int));
1910 void (*insert_from_string_func) P_ ((Lisp_Object, int, int, int, int, int));
1911 int inherit, nargs;
1912 register Lisp_Object *args;
1914 register int argnum;
1915 register Lisp_Object val;
1917 for (argnum = 0; argnum < nargs; argnum++)
1919 val = args[argnum];
1920 retry:
1921 if (INTEGERP (val))
1923 unsigned char str[MAX_MULTIBYTE_LENGTH];
1924 int len;
1926 if (!NILP (current_buffer->enable_multibyte_characters))
1927 len = CHAR_STRING (XFASTINT (val), str);
1928 else
1930 str[0] = (SINGLE_BYTE_CHAR_P (XINT (val))
1931 ? XINT (val)
1932 : multibyte_char_to_unibyte (XINT (val), Qnil));
1933 len = 1;
1935 (*insert_func) (str, len);
1937 else if (STRINGP (val))
1939 (*insert_from_string_func) (val, 0, 0,
1940 XSTRING (val)->size,
1941 STRING_BYTES (XSTRING (val)),
1942 inherit);
1944 else
1946 val = wrong_type_argument (Qchar_or_string_p, val);
1947 goto retry;
1952 void
1953 insert1 (arg)
1954 Lisp_Object arg;
1956 Finsert (1, &arg);
1960 /* Callers passing one argument to Finsert need not gcpro the
1961 argument "array", since the only element of the array will
1962 not be used after calling insert or insert_from_string, so
1963 we don't care if it gets trashed. */
1965 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
1966 "Insert the arguments, either strings or characters, at point.\n\
1967 Point and before-insertion markers move forward to end up\n\
1968 after the inserted text.\n\
1969 Any other markers at the point of insertion remain before the text.\n\
1971 If the current buffer is multibyte, unibyte strings are converted\n\
1972 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
1973 If the current buffer is unibyte, multibyte strings are converted\n\
1974 to unibyte for insertion.")
1975 (nargs, args)
1976 int nargs;
1977 register Lisp_Object *args;
1979 general_insert_function (insert, insert_from_string, 0, nargs, args);
1980 return Qnil;
1983 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
1984 0, MANY, 0,
1985 "Insert the arguments at point, inheriting properties from adjoining text.\n\
1986 Point and before-insertion markers move forward to end up\n\
1987 after the inserted text.\n\
1988 Any other markers at the point of insertion remain before the text.\n\
1990 If the current buffer is multibyte, unibyte strings are converted\n\
1991 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
1992 If the current buffer is unibyte, multibyte strings are converted\n\
1993 to unibyte for insertion.")
1994 (nargs, args)
1995 int nargs;
1996 register Lisp_Object *args;
1998 general_insert_function (insert_and_inherit, insert_from_string, 1,
1999 nargs, args);
2000 return Qnil;
2003 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2004 "Insert strings or characters at point, relocating markers after the text.\n\
2005 Point and markers move forward to end up after the inserted text.\n\
2007 If the current buffer is multibyte, unibyte strings are converted\n\
2008 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
2009 If the current buffer is unibyte, multibyte strings are converted\n\
2010 to unibyte for insertion.")
2011 (nargs, args)
2012 int nargs;
2013 register Lisp_Object *args;
2015 general_insert_function (insert_before_markers,
2016 insert_from_string_before_markers, 0,
2017 nargs, args);
2018 return Qnil;
2021 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2022 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2023 "Insert text at point, relocating markers and inheriting properties.\n\
2024 Point and markers move forward to end up after the inserted text.\n\
2026 If the current buffer is multibyte, unibyte strings are converted\n\
2027 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
2028 If the current buffer is unibyte, multibyte strings are converted\n\
2029 to unibyte for insertion.")
2030 (nargs, args)
2031 int nargs;
2032 register Lisp_Object *args;
2034 general_insert_function (insert_before_markers_and_inherit,
2035 insert_from_string_before_markers, 1,
2036 nargs, args);
2037 return Qnil;
2040 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2041 "Insert COUNT (second arg) copies of CHARACTER (first arg).\n\
2042 Both arguments are required.\n\
2043 Point, and before-insertion markers, are relocated as in the function `insert'.\n\
2044 The optional third arg INHERIT, if non-nil, says to inherit text properties\n\
2045 from adjoining text, if those properties are sticky.")
2046 (character, count, inherit)
2047 Lisp_Object character, count, inherit;
2049 register unsigned char *string;
2050 register int strlen;
2051 register int i, n;
2052 int len;
2053 unsigned char str[MAX_MULTIBYTE_LENGTH];
2055 CHECK_NUMBER (character, 0);
2056 CHECK_NUMBER (count, 1);
2058 if (!NILP (current_buffer->enable_multibyte_characters))
2059 len = CHAR_STRING (XFASTINT (character), str);
2060 else
2061 str[0] = XFASTINT (character), len = 1;
2062 n = XINT (count) * len;
2063 if (n <= 0)
2064 return Qnil;
2065 strlen = min (n, 256 * len);
2066 string = (unsigned char *) alloca (strlen);
2067 for (i = 0; i < strlen; i++)
2068 string[i] = str[i % len];
2069 while (n >= strlen)
2071 QUIT;
2072 if (!NILP (inherit))
2073 insert_and_inherit (string, strlen);
2074 else
2075 insert (string, strlen);
2076 n -= strlen;
2078 if (n > 0)
2080 if (!NILP (inherit))
2081 insert_and_inherit (string, n);
2082 else
2083 insert (string, n);
2085 return Qnil;
2089 /* Making strings from buffer contents. */
2091 /* Return a Lisp_String containing the text of the current buffer from
2092 START to END. If text properties are in use and the current buffer
2093 has properties in the range specified, the resulting string will also
2094 have them, if PROPS is nonzero.
2096 We don't want to use plain old make_string here, because it calls
2097 make_uninit_string, which can cause the buffer arena to be
2098 compacted. make_string has no way of knowing that the data has
2099 been moved, and thus copies the wrong data into the string. This
2100 doesn't effect most of the other users of make_string, so it should
2101 be left as is. But we should use this function when conjuring
2102 buffer substrings. */
2104 Lisp_Object
2105 make_buffer_string (start, end, props)
2106 int start, end;
2107 int props;
2109 int start_byte = CHAR_TO_BYTE (start);
2110 int end_byte = CHAR_TO_BYTE (end);
2112 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2115 /* Return a Lisp_String containing the text of the current buffer from
2116 START / START_BYTE to END / END_BYTE.
2118 If text properties are in use and the current buffer
2119 has properties in the range specified, the resulting string will also
2120 have them, if PROPS is nonzero.
2122 We don't want to use plain old make_string here, because it calls
2123 make_uninit_string, which can cause the buffer arena to be
2124 compacted. make_string has no way of knowing that the data has
2125 been moved, and thus copies the wrong data into the string. This
2126 doesn't effect most of the other users of make_string, so it should
2127 be left as is. But we should use this function when conjuring
2128 buffer substrings. */
2130 Lisp_Object
2131 make_buffer_string_both (start, start_byte, end, end_byte, props)
2132 int start, start_byte, end, end_byte;
2133 int props;
2135 Lisp_Object result, tem, tem1;
2137 if (start < GPT && GPT < end)
2138 move_gap (start);
2140 if (! NILP (current_buffer->enable_multibyte_characters))
2141 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2142 else
2143 result = make_uninit_string (end - start);
2144 bcopy (BYTE_POS_ADDR (start_byte), XSTRING (result)->data,
2145 end_byte - start_byte);
2147 /* If desired, update and copy the text properties. */
2148 if (props)
2150 update_buffer_properties (start, end);
2152 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2153 tem1 = Ftext_properties_at (make_number (start), Qnil);
2155 if (XINT (tem) != end || !NILP (tem1))
2156 copy_intervals_to_string (result, current_buffer, start,
2157 end - start);
2160 return result;
2163 /* Call Vbuffer_access_fontify_functions for the range START ... END
2164 in the current buffer, if necessary. */
2166 static void
2167 update_buffer_properties (start, end)
2168 int start, end;
2170 /* If this buffer has some access functions,
2171 call them, specifying the range of the buffer being accessed. */
2172 if (!NILP (Vbuffer_access_fontify_functions))
2174 Lisp_Object args[3];
2175 Lisp_Object tem;
2177 args[0] = Qbuffer_access_fontify_functions;
2178 XSETINT (args[1], start);
2179 XSETINT (args[2], end);
2181 /* But don't call them if we can tell that the work
2182 has already been done. */
2183 if (!NILP (Vbuffer_access_fontified_property))
2185 tem = Ftext_property_any (args[1], args[2],
2186 Vbuffer_access_fontified_property,
2187 Qnil, Qnil);
2188 if (! NILP (tem))
2189 Frun_hook_with_args (3, args);
2191 else
2192 Frun_hook_with_args (3, args);
2196 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2197 "Return the contents of part of the current buffer as a string.\n\
2198 The two arguments START and END are character positions;\n\
2199 they can be in either order.\n\
2200 The string returned is multibyte if the buffer is multibyte.\n\
2202 This function copies the text properties of that part of the buffer\n\
2203 into the result string; if you don't want the text properties,\n\
2204 use `buffer-substring-no-properties' instead.")
2205 (start, end)
2206 Lisp_Object start, end;
2208 register int b, e;
2210 validate_region (&start, &end);
2211 b = XINT (start);
2212 e = XINT (end);
2214 return make_buffer_string (b, e, 1);
2217 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2218 Sbuffer_substring_no_properties, 2, 2, 0,
2219 "Return the characters of part of the buffer, without the text properties.\n\
2220 The two arguments START and END are character positions;\n\
2221 they can be in either order.")
2222 (start, end)
2223 Lisp_Object start, end;
2225 register int b, e;
2227 validate_region (&start, &end);
2228 b = XINT (start);
2229 e = XINT (end);
2231 return make_buffer_string (b, e, 0);
2234 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2235 "Return the contents of the current buffer as a string.\n\
2236 If narrowing is in effect, this function returns only the visible part\n\
2237 of the buffer.")
2240 return make_buffer_string (BEGV, ZV, 1);
2243 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2244 1, 3, 0,
2245 "Insert before point a substring of the contents of buffer BUFFER.\n\
2246 BUFFER may be a buffer or a buffer name.\n\
2247 Arguments START and END are character numbers specifying the substring.\n\
2248 They default to the beginning and the end of BUFFER.")
2249 (buf, start, end)
2250 Lisp_Object buf, start, end;
2252 register int b, e, temp;
2253 register struct buffer *bp, *obuf;
2254 Lisp_Object buffer;
2256 buffer = Fget_buffer (buf);
2257 if (NILP (buffer))
2258 nsberror (buf);
2259 bp = XBUFFER (buffer);
2260 if (NILP (bp->name))
2261 error ("Selecting deleted buffer");
2263 if (NILP (start))
2264 b = BUF_BEGV (bp);
2265 else
2267 CHECK_NUMBER_COERCE_MARKER (start, 0);
2268 b = XINT (start);
2270 if (NILP (end))
2271 e = BUF_ZV (bp);
2272 else
2274 CHECK_NUMBER_COERCE_MARKER (end, 1);
2275 e = XINT (end);
2278 if (b > e)
2279 temp = b, b = e, e = temp;
2281 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2282 args_out_of_range (start, end);
2284 obuf = current_buffer;
2285 set_buffer_internal_1 (bp);
2286 update_buffer_properties (b, e);
2287 set_buffer_internal_1 (obuf);
2289 insert_from_buffer (bp, b, e - b, 0);
2290 return Qnil;
2293 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2294 6, 6, 0,
2295 "Compare two substrings of two buffers; return result as number.\n\
2296 the value is -N if first string is less after N-1 chars,\n\
2297 +N if first string is greater after N-1 chars, or 0 if strings match.\n\
2298 Each substring is represented as three arguments: BUFFER, START and END.\n\
2299 That makes six args in all, three for each substring.\n\n\
2300 The value of `case-fold-search' in the current buffer\n\
2301 determines whether case is significant or ignored.")
2302 (buffer1, start1, end1, buffer2, start2, end2)
2303 Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
2305 register int begp1, endp1, begp2, endp2, temp;
2306 register struct buffer *bp1, *bp2;
2307 register Lisp_Object *trt
2308 = (!NILP (current_buffer->case_fold_search)
2309 ? XCHAR_TABLE (current_buffer->case_canon_table)->contents : 0);
2310 int chars = 0;
2311 int i1, i2, i1_byte, i2_byte;
2313 /* Find the first buffer and its substring. */
2315 if (NILP (buffer1))
2316 bp1 = current_buffer;
2317 else
2319 Lisp_Object buf1;
2320 buf1 = Fget_buffer (buffer1);
2321 if (NILP (buf1))
2322 nsberror (buffer1);
2323 bp1 = XBUFFER (buf1);
2324 if (NILP (bp1->name))
2325 error ("Selecting deleted buffer");
2328 if (NILP (start1))
2329 begp1 = BUF_BEGV (bp1);
2330 else
2332 CHECK_NUMBER_COERCE_MARKER (start1, 1);
2333 begp1 = XINT (start1);
2335 if (NILP (end1))
2336 endp1 = BUF_ZV (bp1);
2337 else
2339 CHECK_NUMBER_COERCE_MARKER (end1, 2);
2340 endp1 = XINT (end1);
2343 if (begp1 > endp1)
2344 temp = begp1, begp1 = endp1, endp1 = temp;
2346 if (!(BUF_BEGV (bp1) <= begp1
2347 && begp1 <= endp1
2348 && endp1 <= BUF_ZV (bp1)))
2349 args_out_of_range (start1, end1);
2351 /* Likewise for second substring. */
2353 if (NILP (buffer2))
2354 bp2 = current_buffer;
2355 else
2357 Lisp_Object buf2;
2358 buf2 = Fget_buffer (buffer2);
2359 if (NILP (buf2))
2360 nsberror (buffer2);
2361 bp2 = XBUFFER (buf2);
2362 if (NILP (bp2->name))
2363 error ("Selecting deleted buffer");
2366 if (NILP (start2))
2367 begp2 = BUF_BEGV (bp2);
2368 else
2370 CHECK_NUMBER_COERCE_MARKER (start2, 4);
2371 begp2 = XINT (start2);
2373 if (NILP (end2))
2374 endp2 = BUF_ZV (bp2);
2375 else
2377 CHECK_NUMBER_COERCE_MARKER (end2, 5);
2378 endp2 = XINT (end2);
2381 if (begp2 > endp2)
2382 temp = begp2, begp2 = endp2, endp2 = temp;
2384 if (!(BUF_BEGV (bp2) <= begp2
2385 && begp2 <= endp2
2386 && endp2 <= BUF_ZV (bp2)))
2387 args_out_of_range (start2, end2);
2389 i1 = begp1;
2390 i2 = begp2;
2391 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2392 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2394 while (i1 < endp1 && i2 < endp2)
2396 /* When we find a mismatch, we must compare the
2397 characters, not just the bytes. */
2398 int c1, c2;
2400 if (! NILP (bp1->enable_multibyte_characters))
2402 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2403 BUF_INC_POS (bp1, i1_byte);
2404 i1++;
2406 else
2408 c1 = BUF_FETCH_BYTE (bp1, i1);
2409 c1 = unibyte_char_to_multibyte (c1);
2410 i1++;
2413 if (! NILP (bp2->enable_multibyte_characters))
2415 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2416 BUF_INC_POS (bp2, i2_byte);
2417 i2++;
2419 else
2421 c2 = BUF_FETCH_BYTE (bp2, i2);
2422 c2 = unibyte_char_to_multibyte (c2);
2423 i2++;
2426 if (trt)
2428 c1 = XINT (trt[c1]);
2429 c2 = XINT (trt[c2]);
2431 if (c1 < c2)
2432 return make_number (- 1 - chars);
2433 if (c1 > c2)
2434 return make_number (chars + 1);
2436 chars++;
2439 /* The strings match as far as they go.
2440 If one is shorter, that one is less. */
2441 if (chars < endp1 - begp1)
2442 return make_number (chars + 1);
2443 else if (chars < endp2 - begp2)
2444 return make_number (- chars - 1);
2446 /* Same length too => they are equal. */
2447 return make_number (0);
2450 static Lisp_Object
2451 subst_char_in_region_unwind (arg)
2452 Lisp_Object arg;
2454 return current_buffer->undo_list = arg;
2457 static Lisp_Object
2458 subst_char_in_region_unwind_1 (arg)
2459 Lisp_Object arg;
2461 return current_buffer->filename = arg;
2464 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2465 Ssubst_char_in_region, 4, 5, 0,
2466 "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
2467 If optional arg NOUNDO is non-nil, don't record this change for undo\n\
2468 and don't mark the buffer as really changed.\n\
2469 Both characters must have the same length of multi-byte form.")
2470 (start, end, fromchar, tochar, noundo)
2471 Lisp_Object start, end, fromchar, tochar, noundo;
2473 register int pos, pos_byte, stop, i, len, end_byte;
2474 int changed = 0;
2475 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2476 unsigned char *p;
2477 int count = specpdl_ptr - specpdl;
2478 #define COMBINING_NO 0
2479 #define COMBINING_BEFORE 1
2480 #define COMBINING_AFTER 2
2481 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2482 int maybe_byte_combining = COMBINING_NO;
2483 int last_changed = 0;
2484 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2486 validate_region (&start, &end);
2487 CHECK_NUMBER (fromchar, 2);
2488 CHECK_NUMBER (tochar, 3);
2490 if (multibyte_p)
2492 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2493 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2494 error ("Characters in subst-char-in-region have different byte-lengths");
2495 if (!ASCII_BYTE_P (*tostr))
2497 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2498 complete multibyte character, it may be combined with the
2499 after bytes. If it is in the range 0xA0..0xFF, it may be
2500 combined with the before and after bytes. */
2501 if (!CHAR_HEAD_P (*tostr))
2502 maybe_byte_combining = COMBINING_BOTH;
2503 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2504 maybe_byte_combining = COMBINING_AFTER;
2507 else
2509 len = 1;
2510 fromstr[0] = XFASTINT (fromchar);
2511 tostr[0] = XFASTINT (tochar);
2514 pos = XINT (start);
2515 pos_byte = CHAR_TO_BYTE (pos);
2516 stop = CHAR_TO_BYTE (XINT (end));
2517 end_byte = stop;
2519 /* If we don't want undo, turn off putting stuff on the list.
2520 That's faster than getting rid of things,
2521 and it prevents even the entry for a first change.
2522 Also inhibit locking the file. */
2523 if (!NILP (noundo))
2525 record_unwind_protect (subst_char_in_region_unwind,
2526 current_buffer->undo_list);
2527 current_buffer->undo_list = Qt;
2528 /* Don't do file-locking. */
2529 record_unwind_protect (subst_char_in_region_unwind_1,
2530 current_buffer->filename);
2531 current_buffer->filename = Qnil;
2534 if (pos_byte < GPT_BYTE)
2535 stop = min (stop, GPT_BYTE);
2536 while (1)
2538 int pos_byte_next = pos_byte;
2540 if (pos_byte >= stop)
2542 if (pos_byte >= end_byte) break;
2543 stop = end_byte;
2545 p = BYTE_POS_ADDR (pos_byte);
2546 if (multibyte_p)
2547 INC_POS (pos_byte_next);
2548 else
2549 ++pos_byte_next;
2550 if (pos_byte_next - pos_byte == len
2551 && p[0] == fromstr[0]
2552 && (len == 1
2553 || (p[1] == fromstr[1]
2554 && (len == 2 || (p[2] == fromstr[2]
2555 && (len == 3 || p[3] == fromstr[3]))))))
2557 if (! changed)
2559 changed = pos;
2560 modify_region (current_buffer, changed, XINT (end));
2562 if (! NILP (noundo))
2564 if (MODIFF - 1 == SAVE_MODIFF)
2565 SAVE_MODIFF++;
2566 if (MODIFF - 1 == current_buffer->auto_save_modified)
2567 current_buffer->auto_save_modified++;
2571 /* Take care of the case where the new character
2572 combines with neighboring bytes. */
2573 if (maybe_byte_combining
2574 && (maybe_byte_combining == COMBINING_AFTER
2575 ? (pos_byte_next < Z_BYTE
2576 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2577 : ((pos_byte_next < Z_BYTE
2578 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2579 || (pos_byte > BEG_BYTE
2580 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2582 Lisp_Object tem, string;
2584 struct gcpro gcpro1;
2586 tem = current_buffer->undo_list;
2587 GCPRO1 (tem);
2589 /* Make a multibyte string containing this single character. */
2590 string = make_multibyte_string (tostr, 1, len);
2591 /* replace_range is less efficient, because it moves the gap,
2592 but it handles combining correctly. */
2593 replace_range (pos, pos + 1, string,
2594 0, 0, 1);
2595 pos_byte_next = CHAR_TO_BYTE (pos);
2596 if (pos_byte_next > pos_byte)
2597 /* Before combining happened. We should not increment
2598 POS. So, to cancel the later increment of POS,
2599 decrease it now. */
2600 pos--;
2601 else
2602 INC_POS (pos_byte_next);
2604 if (! NILP (noundo))
2605 current_buffer->undo_list = tem;
2607 UNGCPRO;
2609 else
2611 if (NILP (noundo))
2612 record_change (pos, 1);
2613 for (i = 0; i < len; i++) *p++ = tostr[i];
2615 last_changed = pos + 1;
2617 pos_byte = pos_byte_next;
2618 pos++;
2621 if (changed)
2623 signal_after_change (changed,
2624 last_changed - changed, last_changed - changed);
2625 update_compositions (changed, last_changed, CHECK_ALL);
2628 unbind_to (count, Qnil);
2629 return Qnil;
2632 DEFUN ("translate-region", Ftranslate_region, Stranslate_region, 3, 3, 0,
2633 "From START to END, translate characters according to TABLE.\n\
2634 TABLE is a string; the Nth character in it is the mapping\n\
2635 for the character with code N.\n\
2636 This function does not alter multibyte characters.\n\
2637 It returns the number of characters changed.")
2638 (start, end, table)
2639 Lisp_Object start;
2640 Lisp_Object end;
2641 register Lisp_Object table;
2643 register int pos_byte, stop; /* Limits of the region. */
2644 register unsigned char *tt; /* Trans table. */
2645 register int nc; /* New character. */
2646 int cnt; /* Number of changes made. */
2647 int size; /* Size of translate table. */
2648 int pos;
2649 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
2651 validate_region (&start, &end);
2652 CHECK_STRING (table, 2);
2654 size = STRING_BYTES (XSTRING (table));
2655 tt = XSTRING (table)->data;
2657 pos_byte = CHAR_TO_BYTE (XINT (start));
2658 stop = CHAR_TO_BYTE (XINT (end));
2659 modify_region (current_buffer, XINT (start), XINT (end));
2660 pos = XINT (start);
2662 cnt = 0;
2663 for (; pos_byte < stop; )
2665 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
2666 int len;
2667 int oc;
2668 int pos_byte_next;
2670 if (multibyte)
2671 oc = STRING_CHAR_AND_LENGTH (p, stop - pos_byte, len);
2672 else
2673 oc = *p, len = 1;
2674 pos_byte_next = pos_byte + len;
2675 if (oc < size && len == 1)
2677 nc = tt[oc];
2678 if (nc != oc)
2680 /* Take care of the case where the new character
2681 combines with neighboring bytes. */
2682 if (!ASCII_BYTE_P (nc)
2683 && (CHAR_HEAD_P (nc)
2684 ? ! CHAR_HEAD_P (FETCH_BYTE (pos_byte + 1))
2685 : (pos_byte > BEG_BYTE
2686 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1)))))
2688 Lisp_Object string;
2690 string = make_multibyte_string (tt + oc, 1, 1);
2691 /* This is less efficient, because it moves the gap,
2692 but it handles combining correctly. */
2693 replace_range (pos, pos + 1, string,
2694 1, 0, 1);
2695 pos_byte_next = CHAR_TO_BYTE (pos);
2696 if (pos_byte_next > pos_byte)
2697 /* Before combining happened. We should not
2698 increment POS. So, to cancel the later
2699 increment of POS, we decrease it now. */
2700 pos--;
2701 else
2702 INC_POS (pos_byte_next);
2704 else
2706 record_change (pos, 1);
2707 *p = nc;
2708 signal_after_change (pos, 1, 1);
2709 update_compositions (pos, pos + 1, CHECK_BORDER);
2711 ++cnt;
2714 pos_byte = pos_byte_next;
2715 pos++;
2718 return make_number (cnt);
2721 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
2722 "Delete the text between point and mark.\n\
2723 When called from a program, expects two arguments,\n\
2724 positions (integers or markers) specifying the stretch to be deleted.")
2725 (start, end)
2726 Lisp_Object start, end;
2728 validate_region (&start, &end);
2729 del_range (XINT (start), XINT (end));
2730 return Qnil;
2733 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
2734 Sdelete_and_extract_region, 2, 2, 0,
2735 "Delete the text between START and END and return it.")
2736 (start, end)
2737 Lisp_Object start, end;
2739 validate_region (&start, &end);
2740 return del_range_1 (XINT (start), XINT (end), 1, 1);
2743 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
2744 "Remove restrictions (narrowing) from current buffer.\n\
2745 This allows the buffer's full text to be seen and edited.")
2748 if (BEG != BEGV || Z != ZV)
2749 current_buffer->clip_changed = 1;
2750 BEGV = BEG;
2751 BEGV_BYTE = BEG_BYTE;
2752 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
2753 /* Changing the buffer bounds invalidates any recorded current column. */
2754 invalidate_current_column ();
2755 return Qnil;
2758 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
2759 "Restrict editing in this buffer to the current region.\n\
2760 The rest of the text becomes temporarily invisible and untouchable\n\
2761 but is not deleted; if you save the buffer in a file, the invisible\n\
2762 text is included in the file. \\[widen] makes all visible again.\n\
2763 See also `save-restriction'.\n\
2765 When calling from a program, pass two arguments; positions (integers\n\
2766 or markers) bounding the text that should remain visible.")
2767 (start, end)
2768 register Lisp_Object start, end;
2770 CHECK_NUMBER_COERCE_MARKER (start, 0);
2771 CHECK_NUMBER_COERCE_MARKER (end, 1);
2773 if (XINT (start) > XINT (end))
2775 Lisp_Object tem;
2776 tem = start; start = end; end = tem;
2779 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
2780 args_out_of_range (start, end);
2782 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
2783 current_buffer->clip_changed = 1;
2785 SET_BUF_BEGV (current_buffer, XFASTINT (start));
2786 SET_BUF_ZV (current_buffer, XFASTINT (end));
2787 if (PT < XFASTINT (start))
2788 SET_PT (XFASTINT (start));
2789 if (PT > XFASTINT (end))
2790 SET_PT (XFASTINT (end));
2791 /* Changing the buffer bounds invalidates any recorded current column. */
2792 invalidate_current_column ();
2793 return Qnil;
2796 Lisp_Object
2797 save_restriction_save ()
2799 if (BEGV == BEG && ZV == Z)
2800 /* The common case that the buffer isn't narrowed.
2801 We return just the buffer object, which save_restriction_restore
2802 recognizes as meaning `no restriction'. */
2803 return Fcurrent_buffer ();
2804 else
2805 /* We have to save a restriction, so return a pair of markers, one
2806 for the beginning and one for the end. */
2808 Lisp_Object beg, end;
2810 beg = buildmark (BEGV, BEGV_BYTE);
2811 end = buildmark (ZV, ZV_BYTE);
2813 /* END must move forward if text is inserted at its exact location. */
2814 XMARKER(end)->insertion_type = 1;
2816 return Fcons (beg, end);
2820 Lisp_Object
2821 save_restriction_restore (data)
2822 Lisp_Object data;
2824 if (CONSP (data))
2825 /* A pair of marks bounding a saved restriction. */
2827 struct Lisp_Marker *beg = XMARKER (XCAR (data));
2828 struct Lisp_Marker *end = XMARKER (XCDR (data));
2829 struct buffer *buf = beg->buffer; /* END should have the same buffer. */
2831 if (beg->charpos != BUF_BEGV(buf) || end->charpos != BUF_ZV(buf))
2832 /* The restriction has changed from the saved one, so restore
2833 the saved restriction. */
2835 int pt = BUF_PT (buf);
2837 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
2838 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
2840 if (pt < beg->charpos || pt > end->charpos)
2841 /* The point is outside the new visible range, move it inside. */
2842 SET_BUF_PT_BOTH (buf,
2843 clip_to_bounds (beg->charpos, pt, end->charpos),
2844 clip_to_bounds (beg->bytepos, BUF_PT_BYTE(buf),
2845 end->bytepos));
2847 buf->clip_changed = 1; /* Remember that the narrowing changed. */
2850 else
2851 /* A buffer, which means that there was no old restriction. */
2853 struct buffer *buf = XBUFFER (data);
2855 if (BUF_BEGV(buf) != BUF_BEG(buf) || BUF_ZV(buf) != BUF_Z(buf))
2856 /* The buffer has been narrowed, get rid of the narrowing. */
2858 SET_BUF_BEGV_BOTH (buf, BUF_BEG(buf), BUF_BEG_BYTE(buf));
2859 SET_BUF_ZV_BOTH (buf, BUF_Z(buf), BUF_Z_BYTE(buf));
2861 buf->clip_changed = 1; /* Remember that the narrowing changed. */
2865 return Qnil;
2868 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
2869 "Execute BODY, saving and restoring current buffer's restrictions.\n\
2870 The buffer's restrictions make parts of the beginning and end invisible.\n\
2871 \(They are set up with `narrow-to-region' and eliminated with `widen'.)\n\
2872 This special form, `save-restriction', saves the current buffer's restrictions\n\
2873 when it is entered, and restores them when it is exited.\n\
2874 So any `narrow-to-region' within BODY lasts only until the end of the form.\n\
2875 The old restrictions settings are restored\n\
2876 even in case of abnormal exit (throw or error).\n\
2878 The value returned is the value of the last form in BODY.\n\
2880 Note: if you are using both `save-excursion' and `save-restriction',\n\
2881 use `save-excursion' outermost:\n\
2882 (save-excursion (save-restriction ...))")
2883 (body)
2884 Lisp_Object body;
2886 register Lisp_Object val;
2887 int count = specpdl_ptr - specpdl;
2889 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2890 val = Fprogn (body);
2891 return unbind_to (count, val);
2894 #ifndef HAVE_MENUS
2896 /* Buffer for the most recent text displayed by Fmessage. */
2897 static char *message_text;
2899 /* Allocated length of that buffer. */
2900 static int message_length;
2902 #endif /* not HAVE_MENUS */
2904 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
2905 "Print a one-line message at the bottom of the screen.\n\
2906 The first argument is a format control string, and the rest are data\n\
2907 to be formatted under control of the string. See `format' for details.\n\
2909 If the first argument is nil, clear any existing message; let the\n\
2910 minibuffer contents show.")
2911 (nargs, args)
2912 int nargs;
2913 Lisp_Object *args;
2915 if (NILP (args[0]))
2917 message (0);
2918 return Qnil;
2920 else
2922 register Lisp_Object val;
2923 val = Fformat (nargs, args);
2924 message3 (val, STRING_BYTES (XSTRING (val)), STRING_MULTIBYTE (val));
2925 return val;
2929 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
2930 "Display a message, in a dialog box if possible.\n\
2931 If a dialog box is not available, use the echo area.\n\
2932 The first argument is a format control string, and the rest are data\n\
2933 to be formatted under control of the string. See `format' for details.\n\
2935 If the first argument is nil, clear any existing message; let the\n\
2936 minibuffer contents show.")
2937 (nargs, args)
2938 int nargs;
2939 Lisp_Object *args;
2941 if (NILP (args[0]))
2943 message (0);
2944 return Qnil;
2946 else
2948 register Lisp_Object val;
2949 val = Fformat (nargs, args);
2950 #ifdef HAVE_MENUS
2952 Lisp_Object pane, menu, obj;
2953 struct gcpro gcpro1;
2954 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
2955 GCPRO1 (pane);
2956 menu = Fcons (val, pane);
2957 obj = Fx_popup_dialog (Qt, menu);
2958 UNGCPRO;
2959 return val;
2961 #else /* not HAVE_MENUS */
2962 /* Copy the data so that it won't move when we GC. */
2963 if (! message_text)
2965 message_text = (char *)xmalloc (80);
2966 message_length = 80;
2968 if (STRING_BYTES (XSTRING (val)) > message_length)
2970 message_length = STRING_BYTES (XSTRING (val));
2971 message_text = (char *)xrealloc (message_text, message_length);
2973 bcopy (XSTRING (val)->data, message_text, STRING_BYTES (XSTRING (val)));
2974 message2 (message_text, STRING_BYTES (XSTRING (val)),
2975 STRING_MULTIBYTE (val));
2976 return val;
2977 #endif /* not HAVE_MENUS */
2980 #ifdef HAVE_MENUS
2981 extern Lisp_Object last_nonmenu_event;
2982 #endif
2984 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
2985 "Display a message in a dialog box or in the echo area.\n\
2986 If this command was invoked with the mouse, use a dialog box if\n\
2987 `use-dialog-box' is non-nil.\n\
2988 Otherwise, use the echo area.\n\
2989 The first argument is a format control string, and the rest are data\n\
2990 to be formatted under control of the string. See `format' for details.\n\
2992 If the first argument is nil, clear any existing message; let the\n\
2993 minibuffer contents show.")
2994 (nargs, args)
2995 int nargs;
2996 Lisp_Object *args;
2998 #ifdef HAVE_MENUS
2999 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3000 && use_dialog_box)
3001 return Fmessage_box (nargs, args);
3002 #endif
3003 return Fmessage (nargs, args);
3006 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3007 "Return the string currently displayed in the echo area, or nil if none.")
3010 return current_message ();
3014 DEFUN ("propertize", Fpropertize, Spropertize, 3, MANY, 0,
3015 "Return a copy of STRING with text properties added.\n\
3016 First argument is the string to copy.\n\
3017 Remaining arguments form a sequence of PROPERTY VALUE pairs for text\n\
3018 properties to add to the result ")
3019 (nargs, args)
3020 int nargs;
3021 Lisp_Object *args;
3023 Lisp_Object properties, string;
3024 struct gcpro gcpro1, gcpro2;
3025 int i;
3027 /* Number of args must be odd. */
3028 if ((nargs & 1) == 0 || nargs < 3)
3029 error ("Wrong number of arguments");
3031 properties = string = Qnil;
3032 GCPRO2 (properties, string);
3034 /* First argument must be a string. */
3035 CHECK_STRING (args[0], 0);
3036 string = Fcopy_sequence (args[0]);
3038 for (i = 1; i < nargs; i += 2)
3040 CHECK_SYMBOL (args[i], i);
3041 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3044 Fadd_text_properties (make_number (0),
3045 make_number (XSTRING (string)->size),
3046 properties, string);
3047 RETURN_UNGCPRO (string);
3051 /* Number of bytes that STRING will occupy when put into the result.
3052 MULTIBYTE is nonzero if the result should be multibyte. */
3054 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3055 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3056 ? count_size_as_multibyte (XSTRING (STRING)->data, \
3057 STRING_BYTES (XSTRING (STRING))) \
3058 : STRING_BYTES (XSTRING (STRING)))
3060 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3061 "Format a string out of a control-string and arguments.\n\
3062 The first argument is a control string.\n\
3063 The other arguments are substituted into it to make the result, a string.\n\
3064 It may contain %-sequences meaning to substitute the next argument.\n\
3065 %s means print a string argument. Actually, prints any object, with `princ'.\n\
3066 %d means print as number in decimal (%o octal, %x hex).\n\
3067 %X is like %x, but uses upper case.\n\
3068 %e means print a number in exponential notation.\n\
3069 %f means print a number in decimal-point notation.\n\
3070 %g means print a number in exponential notation\n\
3071 or decimal-point notation, whichever uses fewer characters.\n\
3072 %c means print a number as a single character.\n\
3073 %S means print any object as an s-expression (using `prin1').\n\
3074 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.\n\
3075 Use %% to put a single % into the output.")
3076 (nargs, args)
3077 int nargs;
3078 register Lisp_Object *args;
3080 register int n; /* The number of the next arg to substitute */
3081 register int total; /* An estimate of the final length */
3082 char *buf, *p;
3083 register unsigned char *format, *end;
3084 int nchars;
3085 /* Nonzero if the output should be a multibyte string,
3086 which is true if any of the inputs is one. */
3087 int multibyte = 0;
3088 /* When we make a multibyte string, we must pay attention to the
3089 byte combining problem, i.e., a byte may be combined with a
3090 multibyte charcter of the previous string. This flag tells if we
3091 must consider such a situation or not. */
3092 int maybe_combine_byte;
3093 unsigned char *this_format;
3094 int longest_format;
3095 Lisp_Object val;
3096 struct info
3098 int start, end;
3099 } *info = 0;
3101 /* It should not be necessary to GCPRO ARGS, because
3102 the caller in the interpreter should take care of that. */
3104 /* Try to determine whether the result should be multibyte.
3105 This is not always right; sometimes the result needs to be multibyte
3106 because of an object that we will pass through prin1,
3107 and in that case, we won't know it here. */
3108 for (n = 0; n < nargs; n++)
3109 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3110 multibyte = 1;
3112 CHECK_STRING (args[0], 0);
3114 /* If we start out planning a unibyte result,
3115 and later find it has to be multibyte, we jump back to retry. */
3116 retry:
3118 format = XSTRING (args[0])->data;
3119 end = format + STRING_BYTES (XSTRING (args[0]));
3120 longest_format = 0;
3122 /* Make room in result for all the non-%-codes in the control string. */
3123 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]);
3125 /* Add to TOTAL enough space to hold the converted arguments. */
3127 n = 0;
3128 while (format != end)
3129 if (*format++ == '%')
3131 int thissize = 0;
3132 unsigned char *this_format_start = format - 1;
3133 int field_width, precision;
3135 /* General format specifications look like
3137 '%' [flags] [field-width] [precision] format
3139 where
3141 flags ::= [#-* 0]+
3142 field-width ::= [0-9]+
3143 precision ::= '.' [0-9]*
3145 If a field-width is specified, it specifies to which width
3146 the output should be padded with blanks, iff the output
3147 string is shorter than field-width.
3149 if precision is specified, it specifies the number of
3150 digits to print after the '.' for floats, or the max.
3151 number of chars to print from a string. */
3153 precision = field_width = 0;
3155 while (index ("-*# 0", *format))
3156 ++format;
3158 if (*format >= '0' && *format <= '9')
3160 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3161 field_width = 10 * field_width + *format - '0';
3164 if (*format == '.')
3166 ++format;
3167 for (precision = 0; *format >= '0' && *format <= '9'; ++format)
3168 precision = 10 * precision + *format - '0';
3171 if (format - this_format_start + 1 > longest_format)
3172 longest_format = format - this_format_start + 1;
3174 if (format == end)
3175 error ("Format string ends in middle of format specifier");
3176 if (*format == '%')
3177 format++;
3178 else if (++n >= nargs)
3179 error ("Not enough arguments for format string");
3180 else if (*format == 'S')
3182 /* For `S', prin1 the argument and then treat like a string. */
3183 register Lisp_Object tem;
3184 tem = Fprin1_to_string (args[n], Qnil);
3185 if (STRING_MULTIBYTE (tem) && ! multibyte)
3187 multibyte = 1;
3188 goto retry;
3190 args[n] = tem;
3191 goto string;
3193 else if (SYMBOLP (args[n]))
3195 /* Use a temp var to avoid problems when ENABLE_CHECKING
3196 is turned on. */
3197 struct Lisp_String *t = XSYMBOL (args[n])->name;
3198 XSETSTRING (args[n], t);
3199 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3201 multibyte = 1;
3202 goto retry;
3204 goto string;
3206 else if (STRINGP (args[n]))
3208 string:
3209 if (*format != 's' && *format != 'S')
3210 error ("Format specifier doesn't match argument type");
3211 thissize = CONVERTED_BYTE_SIZE (multibyte, args[n]);
3213 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3214 else if (INTEGERP (args[n]) && *format != 's')
3216 /* The following loop assumes the Lisp type indicates
3217 the proper way to pass the argument.
3218 So make sure we have a flonum if the argument should
3219 be a double. */
3220 if (*format == 'e' || *format == 'f' || *format == 'g')
3221 args[n] = Ffloat (args[n]);
3222 else
3223 if (*format != 'd' && *format != 'o' && *format != 'x'
3224 && *format != 'i' && *format != 'X' && *format != 'c')
3225 error ("Invalid format operation %%%c", *format);
3227 thissize = 30;
3228 if (*format == 'c'
3229 && (! SINGLE_BYTE_CHAR_P (XINT (args[n]))
3230 || XINT (args[n]) == 0))
3232 if (! multibyte)
3234 multibyte = 1;
3235 goto retry;
3237 args[n] = Fchar_to_string (args[n]);
3238 thissize = STRING_BYTES (XSTRING (args[n]));
3241 else if (FLOATP (args[n]) && *format != 's')
3243 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3244 args[n] = Ftruncate (args[n], Qnil);
3246 /* Note that we're using sprintf to print floats,
3247 so we have to take into account what that function
3248 prints. */
3249 thissize = 200 + precision;
3251 else
3253 /* Anything but a string, convert to a string using princ. */
3254 register Lisp_Object tem;
3255 tem = Fprin1_to_string (args[n], Qt);
3256 if (STRING_MULTIBYTE (tem) & ! multibyte)
3258 multibyte = 1;
3259 goto retry;
3261 args[n] = tem;
3262 goto string;
3265 thissize = max (field_width, thissize);
3266 total += thissize + 4;
3269 /* Now we can no longer jump to retry.
3270 TOTAL and LONGEST_FORMAT are known for certain. */
3272 this_format = (unsigned char *) alloca (longest_format + 1);
3274 /* Allocate the space for the result.
3275 Note that TOTAL is an overestimate. */
3276 if (total < 1000)
3277 buf = (char *) alloca (total + 1);
3278 else
3279 buf = (char *) xmalloc (total + 1);
3281 p = buf;
3282 nchars = 0;
3283 n = 0;
3285 /* Scan the format and store result in BUF. */
3286 format = XSTRING (args[0])->data;
3287 maybe_combine_byte = 0;
3288 while (format != end)
3290 if (*format == '%')
3292 int minlen;
3293 int negative = 0;
3294 unsigned char *this_format_start = format;
3296 format++;
3298 /* Process a numeric arg and skip it. */
3299 minlen = atoi (format);
3300 if (minlen < 0)
3301 minlen = - minlen, negative = 1;
3303 while ((*format >= '0' && *format <= '9')
3304 || *format == '-' || *format == ' ' || *format == '.')
3305 format++;
3307 if (*format++ == '%')
3309 *p++ = '%';
3310 nchars++;
3311 continue;
3314 ++n;
3316 if (STRINGP (args[n]))
3318 int padding, nbytes, start, end;
3319 int width = lisp_string_width (args[n], -1, NULL, NULL);
3321 /* If spec requires it, pad on right with spaces. */
3322 padding = minlen - width;
3323 if (! negative)
3324 while (padding-- > 0)
3326 *p++ = ' ';
3327 ++nchars;
3330 start = nchars;
3332 if (p > buf
3333 && multibyte
3334 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3335 && STRING_MULTIBYTE (args[n])
3336 && !CHAR_HEAD_P (XSTRING (args[n])->data[0]))
3337 maybe_combine_byte = 1;
3338 nbytes = copy_text (XSTRING (args[n])->data, p,
3339 STRING_BYTES (XSTRING (args[n])),
3340 STRING_MULTIBYTE (args[n]), multibyte);
3341 p += nbytes;
3342 nchars += XSTRING (args[n])->size;
3343 end = nchars;
3345 if (negative)
3346 while (padding-- > 0)
3348 *p++ = ' ';
3349 nchars++;
3352 /* If this argument has text properties, record where
3353 in the result string it appears. */
3354 if (XSTRING (args[n])->intervals)
3356 if (!info)
3358 int nbytes = nargs * sizeof *info;
3359 info = (struct info *) alloca (nbytes);
3360 bzero (info, nbytes);
3363 info[n].start = start;
3364 info[n].end = end;
3367 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3369 int this_nchars;
3371 bcopy (this_format_start, this_format,
3372 format - this_format_start);
3373 this_format[format - this_format_start] = 0;
3375 if (INTEGERP (args[n]))
3376 sprintf (p, this_format, XINT (args[n]));
3377 else
3378 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3380 if (p > buf
3381 && multibyte
3382 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3383 && !CHAR_HEAD_P (*((unsigned char *) p)))
3384 maybe_combine_byte = 1;
3385 this_nchars = strlen (p);
3386 if (multibyte)
3387 p += str_to_multibyte (p, buf + total - p, this_nchars);
3388 else
3389 p += this_nchars;
3390 nchars += this_nchars;
3393 else if (STRING_MULTIBYTE (args[0]))
3395 /* Copy a whole multibyte character. */
3396 if (p > buf
3397 && multibyte
3398 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3399 && !CHAR_HEAD_P (*format))
3400 maybe_combine_byte = 1;
3401 *p++ = *format++;
3402 while (! CHAR_HEAD_P (*format)) *p++ = *format++;
3403 nchars++;
3405 else if (multibyte)
3407 /* Convert a single-byte character to multibyte. */
3408 int len = copy_text (format, p, 1, 0, 1);
3410 p += len;
3411 format++;
3412 nchars++;
3414 else
3415 *p++ = *format++, nchars++;
3418 if (p > buf + total + 1)
3419 abort ();
3421 if (maybe_combine_byte)
3422 nchars = multibyte_chars_in_text (buf, p - buf);
3423 val = make_specified_string (buf, nchars, p - buf, multibyte);
3425 /* If we allocated BUF with malloc, free it too. */
3426 if (total >= 1000)
3427 xfree (buf);
3429 /* If the format string has text properties, or any of the string
3430 arguments has text properties, set up text properties of the
3431 result string. */
3433 if (XSTRING (args[0])->intervals || info)
3435 Lisp_Object len, new_len, props;
3436 struct gcpro gcpro1;
3438 /* Add text properties from the format string. */
3439 len = make_number (XSTRING (args[0])->size);
3440 props = text_property_list (args[0], make_number (0), len, Qnil);
3441 GCPRO1 (props);
3443 if (CONSP (props))
3445 new_len = make_number (XSTRING (val)->size);
3446 extend_property_ranges (props, len, new_len);
3447 add_text_properties_from_list (val, props, make_number (0));
3450 /* Add text properties from arguments. */
3451 if (info)
3452 for (n = 1; n < nargs; ++n)
3453 if (info[n].end)
3455 len = make_number (XSTRING (args[n])->size);
3456 new_len = make_number (info[n].end - info[n].start);
3457 props = text_property_list (args[n], make_number (0), len, Qnil);
3458 extend_property_ranges (props, len, new_len);
3459 /* If successive arguments have properites, be sure that
3460 the value of `composition' property be the copy. */
3461 if (n > 1 && info[n - 1].end)
3462 make_composition_value_copy (props);
3463 add_text_properties_from_list (val, props,
3464 make_number (info[n].start));
3467 UNGCPRO;
3470 return val;
3474 /* VARARGS 1 */
3475 Lisp_Object
3476 #ifdef NO_ARG_ARRAY
3477 format1 (string1, arg0, arg1, arg2, arg3, arg4)
3478 EMACS_INT arg0, arg1, arg2, arg3, arg4;
3479 #else
3480 format1 (string1)
3481 #endif
3482 char *string1;
3484 char buf[100];
3485 #ifdef NO_ARG_ARRAY
3486 EMACS_INT args[5];
3487 args[0] = arg0;
3488 args[1] = arg1;
3489 args[2] = arg2;
3490 args[3] = arg3;
3491 args[4] = arg4;
3492 doprnt (buf, sizeof buf, string1, (char *)0, 5, (char **) args);
3493 #else
3494 doprnt (buf, sizeof buf, string1, (char *)0, 5, &string1 + 1);
3495 #endif
3496 return build_string (buf);
3499 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
3500 "Return t if two characters match, optionally ignoring case.\n\
3501 Both arguments must be characters (i.e. integers).\n\
3502 Case is ignored if `case-fold-search' is non-nil in the current buffer.")
3503 (c1, c2)
3504 register Lisp_Object c1, c2;
3506 int i1, i2;
3507 CHECK_NUMBER (c1, 0);
3508 CHECK_NUMBER (c2, 1);
3510 if (XINT (c1) == XINT (c2))
3511 return Qt;
3512 if (NILP (current_buffer->case_fold_search))
3513 return Qnil;
3515 /* Do these in separate statements,
3516 then compare the variables.
3517 because of the way DOWNCASE uses temp variables. */
3518 i1 = DOWNCASE (XFASTINT (c1));
3519 i2 = DOWNCASE (XFASTINT (c2));
3520 return (i1 == i2 ? Qt : Qnil);
3523 /* Transpose the markers in two regions of the current buffer, and
3524 adjust the ones between them if necessary (i.e.: if the regions
3525 differ in size).
3527 START1, END1 are the character positions of the first region.
3528 START1_BYTE, END1_BYTE are the byte positions.
3529 START2, END2 are the character positions of the second region.
3530 START2_BYTE, END2_BYTE are the byte positions.
3532 Traverses the entire marker list of the buffer to do so, adding an
3533 appropriate amount to some, subtracting from some, and leaving the
3534 rest untouched. Most of this is copied from adjust_markers in insdel.c.
3536 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
3538 static void
3539 transpose_markers (start1, end1, start2, end2,
3540 start1_byte, end1_byte, start2_byte, end2_byte)
3541 register int start1, end1, start2, end2;
3542 register int start1_byte, end1_byte, start2_byte, end2_byte;
3544 register int amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
3545 register Lisp_Object marker;
3547 /* Update point as if it were a marker. */
3548 if (PT < start1)
3550 else if (PT < end1)
3551 TEMP_SET_PT_BOTH (PT + (end2 - end1),
3552 PT_BYTE + (end2_byte - end1_byte));
3553 else if (PT < start2)
3554 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
3555 (PT_BYTE + (end2_byte - start2_byte)
3556 - (end1_byte - start1_byte)));
3557 else if (PT < end2)
3558 TEMP_SET_PT_BOTH (PT - (start2 - start1),
3559 PT_BYTE - (start2_byte - start1_byte));
3561 /* We used to adjust the endpoints here to account for the gap, but that
3562 isn't good enough. Even if we assume the caller has tried to move the
3563 gap out of our way, it might still be at start1 exactly, for example;
3564 and that places it `inside' the interval, for our purposes. The amount
3565 of adjustment is nontrivial if there's a `denormalized' marker whose
3566 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
3567 the dirty work to Fmarker_position, below. */
3569 /* The difference between the region's lengths */
3570 diff = (end2 - start2) - (end1 - start1);
3571 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
3573 /* For shifting each marker in a region by the length of the other
3574 region plus the distance between the regions. */
3575 amt1 = (end2 - start2) + (start2 - end1);
3576 amt2 = (end1 - start1) + (start2 - end1);
3577 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
3578 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
3580 for (marker = BUF_MARKERS (current_buffer); !NILP (marker);
3581 marker = XMARKER (marker)->chain)
3583 mpos = marker_byte_position (marker);
3584 if (mpos >= start1_byte && mpos < end2_byte)
3586 if (mpos < end1_byte)
3587 mpos += amt1_byte;
3588 else if (mpos < start2_byte)
3589 mpos += diff_byte;
3590 else
3591 mpos -= amt2_byte;
3592 XMARKER (marker)->bytepos = mpos;
3594 mpos = XMARKER (marker)->charpos;
3595 if (mpos >= start1 && mpos < end2)
3597 if (mpos < end1)
3598 mpos += amt1;
3599 else if (mpos < start2)
3600 mpos += diff;
3601 else
3602 mpos -= amt2;
3604 XMARKER (marker)->charpos = mpos;
3608 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
3609 "Transpose region START1 to END1 with START2 to END2.\n\
3610 The regions may not be overlapping, because the size of the buffer is\n\
3611 never changed in a transposition.\n\
3613 Optional fifth arg LEAVE_MARKERS, if non-nil, means don't update\n\
3614 any markers that happen to be located in the regions.\n\
3616 Transposing beyond buffer boundaries is an error.")
3617 (startr1, endr1, startr2, endr2, leave_markers)
3618 Lisp_Object startr1, endr1, startr2, endr2, leave_markers;
3620 register int start1, end1, start2, end2;
3621 int start1_byte, start2_byte, len1_byte, len2_byte;
3622 int gap, len1, len_mid, len2;
3623 unsigned char *start1_addr, *start2_addr, *temp;
3625 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2;
3626 cur_intv = BUF_INTERVALS (current_buffer);
3628 validate_region (&startr1, &endr1);
3629 validate_region (&startr2, &endr2);
3631 start1 = XFASTINT (startr1);
3632 end1 = XFASTINT (endr1);
3633 start2 = XFASTINT (startr2);
3634 end2 = XFASTINT (endr2);
3635 gap = GPT;
3637 /* Swap the regions if they're reversed. */
3638 if (start2 < end1)
3640 register int glumph = start1;
3641 start1 = start2;
3642 start2 = glumph;
3643 glumph = end1;
3644 end1 = end2;
3645 end2 = glumph;
3648 len1 = end1 - start1;
3649 len2 = end2 - start2;
3651 if (start2 < end1)
3652 error ("Transposed regions overlap");
3653 else if (start1 == end1 || start2 == end2)
3654 error ("Transposed region has length 0");
3656 /* The possibilities are:
3657 1. Adjacent (contiguous) regions, or separate but equal regions
3658 (no, really equal, in this case!), or
3659 2. Separate regions of unequal size.
3661 The worst case is usually No. 2. It means that (aside from
3662 potential need for getting the gap out of the way), there also
3663 needs to be a shifting of the text between the two regions. So
3664 if they are spread far apart, we are that much slower... sigh. */
3666 /* It must be pointed out that the really studly thing to do would
3667 be not to move the gap at all, but to leave it in place and work
3668 around it if necessary. This would be extremely efficient,
3669 especially considering that people are likely to do
3670 transpositions near where they are working interactively, which
3671 is exactly where the gap would be found. However, such code
3672 would be much harder to write and to read. So, if you are
3673 reading this comment and are feeling squirrely, by all means have
3674 a go! I just didn't feel like doing it, so I will simply move
3675 the gap the minimum distance to get it out of the way, and then
3676 deal with an unbroken array. */
3678 /* Make sure the gap won't interfere, by moving it out of the text
3679 we will operate on. */
3680 if (start1 < gap && gap < end2)
3682 if (gap - start1 < end2 - gap)
3683 move_gap (start1);
3684 else
3685 move_gap (end2);
3688 start1_byte = CHAR_TO_BYTE (start1);
3689 start2_byte = CHAR_TO_BYTE (start2);
3690 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
3691 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
3693 #ifdef BYTE_COMBINING_DEBUG
3694 if (end1 == start2)
3696 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
3697 len2_byte, start1, start1_byte)
3698 || count_combining_before (BYTE_POS_ADDR (start1_byte),
3699 len1_byte, end2, start2_byte + len2_byte)
3700 || count_combining_after (BYTE_POS_ADDR (start1_byte),
3701 len1_byte, end2, start2_byte + len2_byte))
3702 abort ();
3704 else
3706 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
3707 len2_byte, start1, start1_byte)
3708 || count_combining_before (BYTE_POS_ADDR (start1_byte),
3709 len1_byte, start2, start2_byte)
3710 || count_combining_after (BYTE_POS_ADDR (start2_byte),
3711 len2_byte, end1, start1_byte + len1_byte)
3712 || count_combining_after (BYTE_POS_ADDR (start1_byte),
3713 len1_byte, end2, start2_byte + len2_byte))
3714 abort ();
3716 #endif
3718 /* Hmmm... how about checking to see if the gap is large
3719 enough to use as the temporary storage? That would avoid an
3720 allocation... interesting. Later, don't fool with it now. */
3722 /* Working without memmove, for portability (sigh), so must be
3723 careful of overlapping subsections of the array... */
3725 if (end1 == start2) /* adjacent regions */
3727 modify_region (current_buffer, start1, end2);
3728 record_change (start1, len1 + len2);
3730 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3731 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3732 Fset_text_properties (make_number (start1), make_number (end2),
3733 Qnil, Qnil);
3735 /* First region smaller than second. */
3736 if (len1_byte < len2_byte)
3738 /* We use alloca only if it is small,
3739 because we want to avoid stack overflow. */
3740 if (len2_byte > 20000)
3741 temp = (unsigned char *) xmalloc (len2_byte);
3742 else
3743 temp = (unsigned char *) alloca (len2_byte);
3745 /* Don't precompute these addresses. We have to compute them
3746 at the last minute, because the relocating allocator might
3747 have moved the buffer around during the xmalloc. */
3748 start1_addr = BYTE_POS_ADDR (start1_byte);
3749 start2_addr = BYTE_POS_ADDR (start2_byte);
3751 bcopy (start2_addr, temp, len2_byte);
3752 bcopy (start1_addr, start1_addr + len2_byte, len1_byte);
3753 bcopy (temp, start1_addr, len2_byte);
3754 if (len2_byte > 20000)
3755 xfree (temp);
3757 else
3758 /* First region not smaller than second. */
3760 if (len1_byte > 20000)
3761 temp = (unsigned char *) xmalloc (len1_byte);
3762 else
3763 temp = (unsigned char *) alloca (len1_byte);
3764 start1_addr = BYTE_POS_ADDR (start1_byte);
3765 start2_addr = BYTE_POS_ADDR (start2_byte);
3766 bcopy (start1_addr, temp, len1_byte);
3767 bcopy (start2_addr, start1_addr, len2_byte);
3768 bcopy (temp, start1_addr + len2_byte, len1_byte);
3769 if (len1_byte > 20000)
3770 xfree (temp);
3772 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
3773 len1, current_buffer, 0);
3774 graft_intervals_into_buffer (tmp_interval2, start1,
3775 len2, current_buffer, 0);
3776 update_compositions (start1, start1 + len2, CHECK_BORDER);
3777 update_compositions (start1 + len2, end2, CHECK_TAIL);
3779 /* Non-adjacent regions, because end1 != start2, bleagh... */
3780 else
3782 len_mid = start2_byte - (start1_byte + len1_byte);
3784 if (len1_byte == len2_byte)
3785 /* Regions are same size, though, how nice. */
3787 modify_region (current_buffer, start1, end1);
3788 modify_region (current_buffer, start2, end2);
3789 record_change (start1, len1);
3790 record_change (start2, len2);
3791 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3792 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3793 Fset_text_properties (make_number (start1), make_number (end1),
3794 Qnil, Qnil);
3795 Fset_text_properties (make_number (start2), make_number (end2),
3796 Qnil, Qnil);
3798 if (len1_byte > 20000)
3799 temp = (unsigned char *) xmalloc (len1_byte);
3800 else
3801 temp = (unsigned char *) alloca (len1_byte);
3802 start1_addr = BYTE_POS_ADDR (start1_byte);
3803 start2_addr = BYTE_POS_ADDR (start2_byte);
3804 bcopy (start1_addr, temp, len1_byte);
3805 bcopy (start2_addr, start1_addr, len2_byte);
3806 bcopy (temp, start2_addr, len1_byte);
3807 if (len1_byte > 20000)
3808 xfree (temp);
3809 graft_intervals_into_buffer (tmp_interval1, start2,
3810 len1, current_buffer, 0);
3811 graft_intervals_into_buffer (tmp_interval2, start1,
3812 len2, current_buffer, 0);
3815 else if (len1_byte < len2_byte) /* Second region larger than first */
3816 /* Non-adjacent & unequal size, area between must also be shifted. */
3818 modify_region (current_buffer, start1, end2);
3819 record_change (start1, (end2 - start1));
3820 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3821 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
3822 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3823 Fset_text_properties (make_number (start1), make_number (end2),
3824 Qnil, Qnil);
3826 /* holds region 2 */
3827 if (len2_byte > 20000)
3828 temp = (unsigned char *) xmalloc (len2_byte);
3829 else
3830 temp = (unsigned char *) alloca (len2_byte);
3831 start1_addr = BYTE_POS_ADDR (start1_byte);
3832 start2_addr = BYTE_POS_ADDR (start2_byte);
3833 bcopy (start2_addr, temp, len2_byte);
3834 bcopy (start1_addr, start1_addr + len_mid + len2_byte, len1_byte);
3835 safe_bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
3836 bcopy (temp, start1_addr, len2_byte);
3837 if (len2_byte > 20000)
3838 xfree (temp);
3839 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
3840 len1, current_buffer, 0);
3841 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
3842 len_mid, current_buffer, 0);
3843 graft_intervals_into_buffer (tmp_interval2, start1,
3844 len2, current_buffer, 0);
3846 else
3847 /* Second region smaller than first. */
3849 record_change (start1, (end2 - start1));
3850 modify_region (current_buffer, start1, end2);
3852 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3853 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
3854 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3855 Fset_text_properties (make_number (start1), make_number (end2),
3856 Qnil, Qnil);
3858 /* holds region 1 */
3859 if (len1_byte > 20000)
3860 temp = (unsigned char *) xmalloc (len1_byte);
3861 else
3862 temp = (unsigned char *) alloca (len1_byte);
3863 start1_addr = BYTE_POS_ADDR (start1_byte);
3864 start2_addr = BYTE_POS_ADDR (start2_byte);
3865 bcopy (start1_addr, temp, len1_byte);
3866 bcopy (start2_addr, start1_addr, len2_byte);
3867 bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
3868 bcopy (temp, start1_addr + len2_byte + len_mid, len1_byte);
3869 if (len1_byte > 20000)
3870 xfree (temp);
3871 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
3872 len1, current_buffer, 0);
3873 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
3874 len_mid, current_buffer, 0);
3875 graft_intervals_into_buffer (tmp_interval2, start1,
3876 len2, current_buffer, 0);
3879 update_compositions (start1, start1 + len2, CHECK_BORDER);
3880 update_compositions (end2 - len1, end2, CHECK_BORDER);
3883 /* When doing multiple transpositions, it might be nice
3884 to optimize this. Perhaps the markers in any one buffer
3885 should be organized in some sorted data tree. */
3886 if (NILP (leave_markers))
3888 transpose_markers (start1, end1, start2, end2,
3889 start1_byte, start1_byte + len1_byte,
3890 start2_byte, start2_byte + len2_byte);
3891 fix_overlays_in_range (start1, end2);
3894 return Qnil;
3898 void
3899 syms_of_editfns ()
3901 environbuf = 0;
3903 Qbuffer_access_fontify_functions
3904 = intern ("buffer-access-fontify-functions");
3905 staticpro (&Qbuffer_access_fontify_functions);
3907 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
3908 "Non-nil means.text motion commands don't notice fields.");
3909 Vinhibit_field_text_motion = Qnil;
3911 DEFVAR_LISP ("buffer-access-fontify-functions",
3912 &Vbuffer_access_fontify_functions,
3913 "List of functions called by `buffer-substring' to fontify if necessary.\n\
3914 Each function is called with two arguments which specify the range\n\
3915 of the buffer being accessed.");
3916 Vbuffer_access_fontify_functions = Qnil;
3919 Lisp_Object obuf;
3920 extern Lisp_Object Vprin1_to_string_buffer;
3921 obuf = Fcurrent_buffer ();
3922 /* Do this here, because init_buffer_once is too early--it won't work. */
3923 Fset_buffer (Vprin1_to_string_buffer);
3924 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
3925 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
3926 Qnil);
3927 Fset_buffer (obuf);
3930 DEFVAR_LISP ("buffer-access-fontified-property",
3931 &Vbuffer_access_fontified_property,
3932 "Property which (if non-nil) indicates text has been fontified.\n\
3933 `buffer-substring' need not call the `buffer-access-fontify-functions'\n\
3934 functions if all the text being accessed has this property.");
3935 Vbuffer_access_fontified_property = Qnil;
3937 DEFVAR_LISP ("system-name", &Vsystem_name,
3938 "The name of the machine Emacs is running on.");
3940 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
3941 "The full name of the user logged in.");
3943 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
3944 "The user's name, taken from environment variables if possible.");
3946 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
3947 "The user's name, based upon the real uid only.");
3949 defsubr (&Spropertize);
3950 defsubr (&Schar_equal);
3951 defsubr (&Sgoto_char);
3952 defsubr (&Sstring_to_char);
3953 defsubr (&Schar_to_string);
3954 defsubr (&Sbuffer_substring);
3955 defsubr (&Sbuffer_substring_no_properties);
3956 defsubr (&Sbuffer_string);
3958 defsubr (&Spoint_marker);
3959 defsubr (&Smark_marker);
3960 defsubr (&Spoint);
3961 defsubr (&Sregion_beginning);
3962 defsubr (&Sregion_end);
3964 staticpro (&Qfield);
3965 Qfield = intern ("field");
3966 staticpro (&Qboundary);
3967 Qboundary = intern ("boundary");
3968 defsubr (&Sfield_beginning);
3969 defsubr (&Sfield_end);
3970 defsubr (&Sfield_string);
3971 defsubr (&Sfield_string_no_properties);
3972 defsubr (&Sdelete_field);
3973 defsubr (&Sconstrain_to_field);
3975 defsubr (&Sline_beginning_position);
3976 defsubr (&Sline_end_position);
3978 /* defsubr (&Smark); */
3979 /* defsubr (&Sset_mark); */
3980 defsubr (&Ssave_excursion);
3981 defsubr (&Ssave_current_buffer);
3983 defsubr (&Sbufsize);
3984 defsubr (&Spoint_max);
3985 defsubr (&Spoint_min);
3986 defsubr (&Spoint_min_marker);
3987 defsubr (&Spoint_max_marker);
3988 defsubr (&Sgap_position);
3989 defsubr (&Sgap_size);
3990 defsubr (&Sposition_bytes);
3991 defsubr (&Sbyte_to_position);
3993 defsubr (&Sbobp);
3994 defsubr (&Seobp);
3995 defsubr (&Sbolp);
3996 defsubr (&Seolp);
3997 defsubr (&Sfollowing_char);
3998 defsubr (&Sprevious_char);
3999 defsubr (&Schar_after);
4000 defsubr (&Schar_before);
4001 defsubr (&Sinsert);
4002 defsubr (&Sinsert_before_markers);
4003 defsubr (&Sinsert_and_inherit);
4004 defsubr (&Sinsert_and_inherit_before_markers);
4005 defsubr (&Sinsert_char);
4007 defsubr (&Suser_login_name);
4008 defsubr (&Suser_real_login_name);
4009 defsubr (&Suser_uid);
4010 defsubr (&Suser_real_uid);
4011 defsubr (&Suser_full_name);
4012 defsubr (&Semacs_pid);
4013 defsubr (&Scurrent_time);
4014 defsubr (&Sformat_time_string);
4015 defsubr (&Sfloat_time);
4016 defsubr (&Sdecode_time);
4017 defsubr (&Sencode_time);
4018 defsubr (&Scurrent_time_string);
4019 defsubr (&Scurrent_time_zone);
4020 defsubr (&Sset_time_zone_rule);
4021 defsubr (&Ssystem_name);
4022 defsubr (&Smessage);
4023 defsubr (&Smessage_box);
4024 defsubr (&Smessage_or_box);
4025 defsubr (&Scurrent_message);
4026 defsubr (&Sformat);
4028 defsubr (&Sinsert_buffer_substring);
4029 defsubr (&Scompare_buffer_substrings);
4030 defsubr (&Ssubst_char_in_region);
4031 defsubr (&Stranslate_region);
4032 defsubr (&Sdelete_region);
4033 defsubr (&Sdelete_and_extract_region);
4034 defsubr (&Swiden);
4035 defsubr (&Snarrow_to_region);
4036 defsubr (&Ssave_restriction);
4037 defsubr (&Stranspose_regions);