Fix copyright years.
[emacs.git] / src / editfns.c
blobe83e92f1396f124c29bdb0d664b43ccb1dfe546a
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 = CHAR_STRING (XFASTINT (character), str);
171 return make_string_from_bytes (str, 1, len);
174 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
175 "Convert arg STRING to a character, the first character of that string.\n\
176 A multibyte character is handled correctly.")
177 (string)
178 register Lisp_Object string;
180 register Lisp_Object val;
181 register struct Lisp_String *p;
182 CHECK_STRING (string, 0);
183 p = XSTRING (string);
184 if (p->size)
186 if (STRING_MULTIBYTE (string))
187 XSETFASTINT (val, STRING_CHAR (p->data, STRING_BYTES (p)));
188 else
189 XSETFASTINT (val, p->data[0]);
191 else
192 XSETFASTINT (val, 0);
193 return val;
196 static Lisp_Object
197 buildmark (charpos, bytepos)
198 int charpos, bytepos;
200 register Lisp_Object mark;
201 mark = Fmake_marker ();
202 set_marker_both (mark, Qnil, charpos, bytepos);
203 return mark;
206 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
207 "Return value of point, as an integer.\n\
208 Beginning of buffer is position (point-min)")
211 Lisp_Object temp;
212 XSETFASTINT (temp, PT);
213 return temp;
216 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
217 "Return value of point, as a marker object.")
220 return buildmark (PT, PT_BYTE);
224 clip_to_bounds (lower, num, upper)
225 int lower, num, upper;
227 if (num < lower)
228 return lower;
229 else if (num > upper)
230 return upper;
231 else
232 return num;
235 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
236 "Set point to POSITION, a number or marker.\n\
237 Beginning of buffer is position (point-min), end is (point-max).\n\
238 If the position is in the middle of a multibyte form,\n\
239 the actual point is set at the head of the multibyte form\n\
240 except in the case that `enable-multibyte-characters' is nil.")
241 (position)
242 register Lisp_Object position;
244 int pos;
246 if (MARKERP (position)
247 && current_buffer == XMARKER (position)->buffer)
249 pos = marker_position (position);
250 if (pos < BEGV)
251 SET_PT_BOTH (BEGV, BEGV_BYTE);
252 else if (pos > ZV)
253 SET_PT_BOTH (ZV, ZV_BYTE);
254 else
255 SET_PT_BOTH (pos, marker_byte_position (position));
257 return position;
260 CHECK_NUMBER_COERCE_MARKER (position, 0);
262 pos = clip_to_bounds (BEGV, XINT (position), ZV);
263 SET_PT (pos);
264 return position;
268 /* Return the start or end position of the region.
269 BEGINNINGP non-zero means return the start.
270 If there is no region active, signal an error. */
272 static Lisp_Object
273 region_limit (beginningp)
274 int beginningp;
276 extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
277 Lisp_Object m;
279 if (!NILP (Vtransient_mark_mode)
280 && NILP (Vmark_even_if_inactive)
281 && NILP (current_buffer->mark_active))
282 Fsignal (Qmark_inactive, Qnil);
284 m = Fmarker_position (current_buffer->mark);
285 if (NILP (m))
286 error ("There is no region now");
288 if ((PT < XFASTINT (m)) == beginningp)
289 m = make_number (PT);
290 return m;
293 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
294 "Return position of beginning of region, as an integer.")
297 return region_limit (1);
300 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
301 "Return position of end of region, as an integer.")
304 return region_limit (0);
307 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
308 "Return this buffer's mark, as a marker object.\n\
309 Watch out! Moving this marker changes the mark position.\n\
310 If you set the marker not to point anywhere, the buffer will have no mark.")
313 return current_buffer->mark;
317 /* Return nonzero if POS1 and POS2 have the same value
318 for the text property PROP. */
320 static int
321 char_property_eq (prop, pos1, pos2)
322 Lisp_Object prop;
323 Lisp_Object pos1, pos2;
325 Lisp_Object pval1, pval2;
327 pval1 = Fget_char_property (pos1, prop, Qnil);
328 pval2 = Fget_char_property (pos2, prop, Qnil);
330 return EQ (pval1, pval2);
333 /* Return the direction from which the text-property PROP would be
334 inherited by any new text inserted at POS: 1 if it would be
335 inherited from the char after POS, -1 if it would be inherited from
336 the char before POS, and 0 if from neither. */
338 static int
339 text_property_stickiness (prop, pos)
340 Lisp_Object prop;
341 Lisp_Object pos;
343 Lisp_Object front_sticky;
345 if (XINT (pos) > BEGV)
346 /* Consider previous character. */
348 Lisp_Object prev_pos, rear_non_sticky;
350 prev_pos = make_number (XINT (pos) - 1);
351 rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);
353 if (EQ (rear_non_sticky, Qnil)
354 || (CONSP (rear_non_sticky)
355 && NILP (Fmemq (prop, rear_non_sticky))))
356 /* PROP is not rear-non-sticky, and since this takes precedence over
357 any front-stickiness, PROP is inherited from before. */
358 return -1;
361 /* Consider following character. */
362 front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
364 if (EQ (front_sticky, Qt)
365 || (CONSP (front_sticky)
366 && !NILP (Fmemq (prop, front_sticky))))
367 /* PROP is inherited from after. */
368 return 1;
370 /* PROP is not inherited from either side. */
371 return 0;
375 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
376 the value of point is used instead. If BEG or END null,
377 means don't store the beginning or end of the field.
379 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
380 position of a field, then the beginning of the previous field is
381 returned instead of the beginning of POS's field (since the end of a
382 field is actually also the beginning of the next input field, this
383 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
384 true case, if two fields are separated by a field with the special
385 value `boundary', and POS lies within it, then the two separated
386 fields are considered to be adjacent, and POS between them, when
387 finding the beginning and ending of the "merged" field.
389 Either BEG or END may be 0, in which case the corresponding value
390 is not stored. */
392 static void
393 find_field (pos, merge_at_boundary, beg, end)
394 Lisp_Object pos;
395 Lisp_Object merge_at_boundary;
396 int *beg, *end;
398 /* Fields right before and after the point. */
399 Lisp_Object before_field, after_field;
400 /* If the fields came from overlays, the associated overlays.
401 Qnil means they came from text-properties. */
402 Lisp_Object before_overlay = Qnil, after_overlay = Qnil;
403 /* 1 if POS counts as the start of a field. */
404 int at_field_start = 0;
405 /* 1 if POS counts as the end of a field. */
406 int at_field_end = 0;
408 if (NILP (pos))
409 XSETFASTINT (pos, PT);
410 else
411 CHECK_NUMBER_COERCE_MARKER (pos, 0);
413 after_field
414 = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
415 before_field
416 = (XFASTINT (pos) > BEGV
417 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
418 Qfield, Qnil,
419 &before_overlay)
420 : Qnil);
422 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
423 and POS is at beginning of a field, which can also be interpreted
424 as the end of the previous field. Note that the case where if
425 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
426 more natural one; then we avoid treating the beginning of a field
427 specially. */
428 if (NILP (merge_at_boundary) && !EQ (after_field, before_field))
429 /* We are at a boundary, see which direction is inclusive. We
430 decide by seeing which field the `field' property sticks to. */
432 /* -1 means insertions go into before_field, 1 means they go
433 into after_field, 0 means neither. */
434 int stickiness;
435 /* Whether the before/after_field come from overlays. */
436 int bop = !NILP (before_overlay);
437 int aop = !NILP (after_overlay);
439 if (bop && XMARKER (OVERLAY_END (before_overlay))->insertion_type == 1)
440 /* before_field is from an overlay, which expands upon
441 end-insertions. Note that it's possible for after_overlay to
442 also eat insertions here, but then they will overlap, and
443 there's not much we can do. */
444 stickiness = -1;
445 else if (aop
446 && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
447 /* after_field is from an overlay, which expand to contain
448 start-insertions. */
449 stickiness = 1;
450 else if (bop && aop)
451 /* Both fields come from overlays, but neither will contain any
452 insertion here. */
453 stickiness = 0;
454 else if (bop)
455 /* before_field is an overlay that won't eat any insertion, but
456 after_field is from a text-property. Assume that the
457 text-property continues underneath the overlay, and so will
458 be inherited by any insertion, regardless of any stickiness
459 settings. */
460 stickiness = 1;
461 else if (aop)
462 /* Similarly, when after_field is the overlay. */
463 stickiness = -1;
464 else
465 /* Both fields come from text-properties. Look for explicit
466 stickiness properties. */
467 stickiness = text_property_stickiness (Qfield, pos);
469 if (stickiness > 0)
470 at_field_start = 1;
471 else if (stickiness < 0)
472 at_field_end = 1;
473 else
474 /* STICKINESS == 0 means that any inserted text will get a
475 `field' char-property of nil, so check to see if that
476 matches either of the adjacent characters (this being a
477 kind of "stickiness by default"). */
479 if (NILP (before_field))
480 at_field_end = 1; /* Sticks to the left. */
481 else if (NILP (after_field))
482 at_field_start = 1; /* Sticks to the right. */
486 /* Note about special `boundary' fields:
488 Consider the case where the point (`.') is between the fields `x' and `y':
490 xxxx.yyyy
492 In this situation, if merge_at_boundary is true, we consider the
493 `x' and `y' fields as forming one big merged field, and so the end
494 of the field is the end of `y'.
496 However, if `x' and `y' are separated by a special `boundary' field
497 (a field with a `field' char-property of 'boundary), then we ignore
498 this special field when merging adjacent fields. Here's the same
499 situation, but with a `boundary' field between the `x' and `y' fields:
501 xxx.BBBByyyy
503 Here, if point is at the end of `x', the beginning of `y', or
504 anywhere in-between (within the `boundary' field), we merge all
505 three fields and consider the beginning as being the beginning of
506 the `x' field, and the end as being the end of the `y' field. */
508 if (beg)
510 if (at_field_start)
511 /* POS is at the edge of a field, and we should consider it as
512 the beginning of the following field. */
513 *beg = XFASTINT (pos);
514 else
515 /* Find the previous field boundary. */
517 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
518 /* Skip a `boundary' field. */
519 pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,Qnil);
521 pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
522 *beg = NILP (pos) ? BEGV : XFASTINT (pos);
526 if (end)
528 if (at_field_end)
529 /* POS is at the edge of a field, and we should consider it as
530 the end of the previous field. */
531 *end = XFASTINT (pos);
532 else
533 /* Find the next field boundary. */
535 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
536 /* Skip a `boundary' field. */
537 pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
539 pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
540 *end = NILP (pos) ? ZV : XFASTINT (pos);
546 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
547 "Delete the field surrounding POS.\n\
548 A field is a region of text with the same `field' property.\n\
549 If POS is nil, the value of point is used for POS.")
550 (pos)
551 Lisp_Object pos;
553 int beg, end;
554 find_field (pos, Qnil, &beg, &end);
555 if (beg != end)
556 del_range (beg, end);
557 return Qnil;
560 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
561 "Return the contents of the field surrounding POS as a string.\n\
562 A field is a region of text with the same `field' property.\n\
563 If POS is nil, the value of point is used for POS.")
564 (pos)
565 Lisp_Object pos;
567 int beg, end;
568 find_field (pos, Qnil, &beg, &end);
569 return make_buffer_string (beg, end, 1);
572 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
573 "Return the contents of the field around POS, without text-properties.\n\
574 A field is a region of text with the same `field' property.\n\
575 If POS is nil, the value of point is used for POS.")
576 (pos)
577 Lisp_Object pos;
579 int beg, end;
580 find_field (pos, Qnil, &beg, &end);
581 return make_buffer_string (beg, end, 0);
584 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 2, 0,
585 "Return the beginning of the field surrounding POS.\n\
586 A field is a region of text with the same `field' property.\n\
587 If POS is nil, the value of point is used for POS.\n\
588 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its\n\
589 field, then the beginning of the *previous* field is returned.")
590 (pos, escape_from_edge)
591 Lisp_Object pos, escape_from_edge;
593 int beg;
594 find_field (pos, escape_from_edge, &beg, 0);
595 return make_number (beg);
598 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 2, 0,
599 "Return the end of the field surrounding POS.\n\
600 A field is a region of text with the same `field' property.\n\
601 If POS is nil, the value of point is used for POS.\n\
602 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,\n\
603 then the end of the *following* field is returned.")
604 (pos, escape_from_edge)
605 Lisp_Object pos, escape_from_edge;
607 int end;
608 find_field (pos, escape_from_edge, 0, &end);
609 return make_number (end);
612 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
613 "Return the position closest to NEW-POS that is in the same field as OLD-POS.\n\
615 A field is a region of text with the same `field' property.\n\
616 If NEW-POS is nil, then the current point is used instead, and set to the\n\
617 constrained position if that is is different.\n\
619 If OLD-POS is at the boundary of two fields, then the allowable\n\
620 positions for NEW-POS depends on the value of the optional argument\n\
621 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is\n\
622 constrained to the field that has the same `field' char-property\n\
623 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE\n\
624 is non-nil, NEW-POS is constrained to the union of the two adjacent\n\
625 fields. Additionally, if two fields are separated by another field with\n\
626 the special value `boundary', then any point within this special field is\n\
627 also considered to be `on the boundary'.\n\
629 If the optional argument ONLY-IN-LINE is non-nil and constraining\n\
630 NEW-POS would move it to a different line, NEW-POS is returned\n\
631 unconstrained. This useful for commands that move by line, like\n\
632 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries\n\
633 only in the case where they can still move to the right line.\n\
635 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has\n\
636 a non-nil property of that name, then any field boundaries are ignored.\n\
638 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.")
639 (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
640 Lisp_Object new_pos, old_pos;
641 Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
643 /* If non-zero, then the original point, before re-positioning. */
644 int orig_point = 0;
646 if (NILP (new_pos))
647 /* Use the current point, and afterwards, set it. */
649 orig_point = PT;
650 XSETFASTINT (new_pos, PT);
653 if (NILP (Vinhibit_field_text_motion)
654 && !EQ (new_pos, old_pos)
655 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
656 || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
657 && (NILP (inhibit_capture_property)
658 || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
659 /* NEW_POS is not within the same field as OLD_POS; try to
660 move NEW_POS so that it is. */
662 int fwd, shortage;
663 Lisp_Object field_bound;
665 CHECK_NUMBER_COERCE_MARKER (new_pos, 0);
666 CHECK_NUMBER_COERCE_MARKER (old_pos, 0);
668 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
670 if (fwd)
671 field_bound = Ffield_end (old_pos, escape_from_edge);
672 else
673 field_bound = Ffield_beginning (old_pos, escape_from_edge);
675 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
676 other side of NEW_POS, which would mean that NEW_POS is
677 already acceptable, and it's not necessary to constrain it
678 to FIELD_BOUND. */
679 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
680 /* NEW_POS should be constrained, but only if either
681 ONLY_IN_LINE is nil (in which case any constraint is OK),
682 or NEW_POS and FIELD_BOUND are on the same line (in which
683 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
684 && (NILP (only_in_line)
685 /* This is the ONLY_IN_LINE case, check that NEW_POS and
686 FIELD_BOUND are on the same line by seeing whether
687 there's an intervening newline or not. */
688 || (scan_buffer ('\n',
689 XFASTINT (new_pos), XFASTINT (field_bound),
690 fwd ? -1 : 1, &shortage, 1),
691 shortage != 0)))
692 /* Constrain NEW_POS to FIELD_BOUND. */
693 new_pos = field_bound;
695 if (orig_point && XFASTINT (new_pos) != orig_point)
696 /* The NEW_POS argument was originally nil, so automatically set PT. */
697 SET_PT (XFASTINT (new_pos));
700 return new_pos;
704 DEFUN ("line-beginning-position", Fline_beginning_position, Sline_beginning_position,
705 0, 1, 0,
706 "Return the character position of the first character on the current line.\n\
707 With argument N not nil or 1, move forward N - 1 lines first.\n\
708 If scan reaches end of buffer, return that position.\n\
709 The scan does not cross a field boundary unless it would move\n\
710 beyond there to a different line. Field boundaries are not noticed if\n\
711 `inhibit-field-text-motion' is non-nil. .And if N is nil or 1,\n\
712 and scan starts at a field boundary, the scan stops as soon as it starts.\n\
714 This function does not move point.")
716 Lisp_Object n;
718 int orig, orig_byte, end;
720 if (NILP (n))
721 XSETFASTINT (n, 1);
722 else
723 CHECK_NUMBER (n, 0);
725 orig = PT;
726 orig_byte = PT_BYTE;
727 Fforward_line (make_number (XINT (n) - 1));
728 end = PT;
730 SET_PT_BOTH (orig, orig_byte);
732 /* Return END constrained to the current input field. */
733 return Fconstrain_to_field (make_number (end), make_number (orig),
734 XINT (n) != 1 ? Qt : Qnil,
735 Qt, Qnil);
738 DEFUN ("line-end-position", Fline_end_position, Sline_end_position,
739 0, 1, 0,
740 "Return the character position of the last character on the current line.\n\
741 With argument N not nil or 1, move forward N - 1 lines first.\n\
742 If scan reaches end of buffer, return that position.\n\
743 This function does not move point.")
745 Lisp_Object n;
747 int end_pos;
748 int orig = PT;
750 if (NILP (n))
751 XSETFASTINT (n, 1);
752 else
753 CHECK_NUMBER (n, 0);
755 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
757 /* Return END_POS constrained to the current input field. */
758 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
759 Qnil, Qt, Qnil);
762 Lisp_Object
763 save_excursion_save ()
765 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
766 == current_buffer);
768 return Fcons (Fpoint_marker (),
769 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
770 Fcons (visible ? Qt : Qnil,
771 Fcons (current_buffer->mark_active,
772 selected_window))));
775 Lisp_Object
776 save_excursion_restore (info)
777 Lisp_Object info;
779 Lisp_Object tem, tem1, omark, nmark;
780 struct gcpro gcpro1, gcpro2, gcpro3;
781 int visible_p;
783 tem = Fmarker_buffer (XCAR (info));
784 /* If buffer being returned to is now deleted, avoid error */
785 /* Otherwise could get error here while unwinding to top level
786 and crash */
787 /* In that case, Fmarker_buffer returns nil now. */
788 if (NILP (tem))
789 return Qnil;
791 omark = nmark = Qnil;
792 GCPRO3 (info, omark, nmark);
794 Fset_buffer (tem);
796 /* Point marker. */
797 tem = XCAR (info);
798 Fgoto_char (tem);
799 unchain_marker (tem);
801 /* Mark marker. */
802 info = XCDR (info);
803 tem = XCAR (info);
804 omark = Fmarker_position (current_buffer->mark);
805 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
806 nmark = Fmarker_position (tem);
807 unchain_marker (tem);
809 /* visible */
810 info = XCDR (info);
811 visible_p = !NILP (XCAR (info));
813 #if 0 /* We used to make the current buffer visible in the selected window
814 if that was true previously. That avoids some anomalies.
815 But it creates others, and it wasn't documented, and it is simpler
816 and cleaner never to alter the window/buffer connections. */
817 tem1 = Fcar (tem);
818 if (!NILP (tem1)
819 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
820 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
821 #endif /* 0 */
823 /* Mark active */
824 info = XCDR (info);
825 tem = XCAR (info);
826 tem1 = current_buffer->mark_active;
827 current_buffer->mark_active = tem;
829 if (!NILP (Vrun_hooks))
831 /* If mark is active now, and either was not active
832 or was at a different place, run the activate hook. */
833 if (! NILP (current_buffer->mark_active))
835 if (! EQ (omark, nmark))
836 call1 (Vrun_hooks, intern ("activate-mark-hook"));
838 /* If mark has ceased to be active, run deactivate hook. */
839 else if (! NILP (tem1))
840 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
843 /* If buffer was visible in a window, and a different window was
844 selected, and the old selected window is still showing this
845 buffer, restore point in that window. */
846 tem = XCDR (info);
847 if (visible_p
848 && !EQ (tem, selected_window)
849 /* This also verifies that the window is still live. */
850 && XBUFFER (XWINDOW (tem)->buffer) == current_buffer)
851 Fset_window_point (tem, make_number (PT));
853 UNGCPRO;
854 return Qnil;
857 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
858 "Save point, mark, and current buffer; execute BODY; restore those things.\n\
859 Executes BODY just like `progn'.\n\
860 The values of point, mark and the current buffer are restored\n\
861 even in case of abnormal exit (throw or error).\n\
862 The state of activation of the mark is also restored.\n\
864 This construct does not save `deactivate-mark', and therefore\n\
865 functions that change the buffer will still cause deactivation\n\
866 of the mark at the end of the command. To prevent that, bind\n\
867 `deactivate-mark' with `let'.")
868 (args)
869 Lisp_Object args;
871 register Lisp_Object val;
872 int count = specpdl_ptr - specpdl;
874 record_unwind_protect (save_excursion_restore, save_excursion_save ());
876 val = Fprogn (args);
877 return unbind_to (count, val);
880 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
881 "Save the current buffer; execute BODY; restore the current buffer.\n\
882 Executes BODY just like `progn'.")
883 (args)
884 Lisp_Object args;
886 Lisp_Object val;
887 int count = specpdl_ptr - specpdl;
889 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
891 val = Fprogn (args);
892 return unbind_to (count, val);
895 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
896 "Return the number of characters in the current buffer.\n\
897 If BUFFER, return the number of characters in that buffer instead.")
898 (buffer)
899 Lisp_Object buffer;
901 if (NILP (buffer))
902 return make_number (Z - BEG);
903 else
905 CHECK_BUFFER (buffer, 1);
906 return make_number (BUF_Z (XBUFFER (buffer))
907 - BUF_BEG (XBUFFER (buffer)));
911 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
912 "Return the minimum permissible value of point in the current buffer.\n\
913 This is 1, unless narrowing (a buffer restriction) is in effect.")
916 Lisp_Object temp;
917 XSETFASTINT (temp, BEGV);
918 return temp;
921 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
922 "Return a marker to the minimum permissible value of point in this buffer.\n\
923 This is the beginning, unless narrowing (a buffer restriction) is in effect.")
926 return buildmark (BEGV, BEGV_BYTE);
929 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
930 "Return the maximum permissible value of point in the current buffer.\n\
931 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
932 is in effect, in which case it is less.")
935 Lisp_Object temp;
936 XSETFASTINT (temp, ZV);
937 return temp;
940 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
941 "Return a marker to the maximum permissible value of point in this buffer.\n\
942 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
943 is in effect, in which case it is less.")
946 return buildmark (ZV, ZV_BYTE);
949 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
950 "Return the position of the gap, in the current buffer.\n\
951 See also `gap-size'.")
954 Lisp_Object temp;
955 XSETFASTINT (temp, GPT);
956 return temp;
959 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
960 "Return the size of the current buffer's gap.\n\
961 See also `gap-position'.")
964 Lisp_Object temp;
965 XSETFASTINT (temp, GAP_SIZE);
966 return temp;
969 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
970 "Return the byte position for character position POSITION.\n\
971 If POSITION is out of range, the value is nil.")
972 (position)
973 Lisp_Object position;
975 CHECK_NUMBER_COERCE_MARKER (position, 1);
976 if (XINT (position) < BEG || XINT (position) > Z)
977 return Qnil;
978 return make_number (CHAR_TO_BYTE (XINT (position)));
981 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
982 "Return the character position for byte position BYTEPOS.\n\
983 If BYTEPOS is out of range, the value is nil.")
984 (bytepos)
985 Lisp_Object bytepos;
987 CHECK_NUMBER (bytepos, 1);
988 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
989 return Qnil;
990 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
993 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
994 "Return the character following point, as a number.\n\
995 At the end of the buffer or accessible region, return 0.")
998 Lisp_Object temp;
999 if (PT >= ZV)
1000 XSETFASTINT (temp, 0);
1001 else
1002 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1003 return temp;
1006 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1007 "Return the character preceding point, as a number.\n\
1008 At the beginning of the buffer or accessible region, return 0.")
1011 Lisp_Object temp;
1012 if (PT <= BEGV)
1013 XSETFASTINT (temp, 0);
1014 else if (!NILP (current_buffer->enable_multibyte_characters))
1016 int pos = PT_BYTE;
1017 DEC_POS (pos);
1018 XSETFASTINT (temp, FETCH_CHAR (pos));
1020 else
1021 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1022 return temp;
1025 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1026 "Return t if point is at the beginning of the buffer.\n\
1027 If the buffer is narrowed, this means the beginning of the narrowed part.")
1030 if (PT == BEGV)
1031 return Qt;
1032 return Qnil;
1035 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1036 "Return t if point is at the end of the buffer.\n\
1037 If the buffer is narrowed, this means the end of the narrowed part.")
1040 if (PT == ZV)
1041 return Qt;
1042 return Qnil;
1045 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1046 "Return t if point is at the beginning of a line.")
1049 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1050 return Qt;
1051 return Qnil;
1054 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1055 "Return t if point is at the end of a line.\n\
1056 `End of a line' includes point being at the end of the buffer.")
1059 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1060 return Qt;
1061 return Qnil;
1064 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1065 "Return character in current buffer at position POS.\n\
1066 POS is an integer or a marker.\n\
1067 If POS is out of range, the value is nil.")
1068 (pos)
1069 Lisp_Object pos;
1071 register int pos_byte;
1073 if (NILP (pos))
1075 pos_byte = PT_BYTE;
1076 XSETFASTINT (pos, PT);
1079 if (MARKERP (pos))
1081 pos_byte = marker_byte_position (pos);
1082 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1083 return Qnil;
1085 else
1087 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1088 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1089 return Qnil;
1091 pos_byte = CHAR_TO_BYTE (XINT (pos));
1094 return make_number (FETCH_CHAR (pos_byte));
1097 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1098 "Return character in current buffer preceding position POS.\n\
1099 POS is an integer or a marker.\n\
1100 If POS is out of range, the value is nil.")
1101 (pos)
1102 Lisp_Object pos;
1104 register Lisp_Object val;
1105 register int pos_byte;
1107 if (NILP (pos))
1109 pos_byte = PT_BYTE;
1110 XSETFASTINT (pos, PT);
1113 if (MARKERP (pos))
1115 pos_byte = marker_byte_position (pos);
1117 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1118 return Qnil;
1120 else
1122 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1124 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1125 return Qnil;
1127 pos_byte = CHAR_TO_BYTE (XINT (pos));
1130 if (!NILP (current_buffer->enable_multibyte_characters))
1132 DEC_POS (pos_byte);
1133 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1135 else
1137 pos_byte--;
1138 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1140 return val;
1143 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1144 "Return the name under which the user logged in, as a string.\n\
1145 This is based on the effective uid, not the real uid.\n\
1146 Also, if the environment variable LOGNAME or USER is set,\n\
1147 that determines the value of this function.\n\n\
1148 If optional argument UID is an integer, return the login name of the user\n\
1149 with that uid, or nil if there is no such user.")
1150 (uid)
1151 Lisp_Object uid;
1153 struct passwd *pw;
1155 /* Set up the user name info if we didn't do it before.
1156 (That can happen if Emacs is dumpable
1157 but you decide to run `temacs -l loadup' and not dump. */
1158 if (INTEGERP (Vuser_login_name))
1159 init_editfns ();
1161 if (NILP (uid))
1162 return Vuser_login_name;
1164 CHECK_NUMBER (uid, 0);
1165 pw = (struct passwd *) getpwuid (XINT (uid));
1166 return (pw ? build_string (pw->pw_name) : Qnil);
1169 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1170 0, 0, 0,
1171 "Return the name of the user's real uid, as a string.\n\
1172 This ignores the environment variables LOGNAME and USER, so it differs from\n\
1173 `user-login-name' when running under `su'.")
1176 /* Set up the user name info if we didn't do it before.
1177 (That can happen if Emacs is dumpable
1178 but you decide to run `temacs -l loadup' and not dump. */
1179 if (INTEGERP (Vuser_login_name))
1180 init_editfns ();
1181 return Vuser_real_login_name;
1184 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1185 "Return the effective uid of Emacs, as an integer.")
1188 return make_number (geteuid ());
1191 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1192 "Return the real uid of Emacs, as an integer.")
1195 return make_number (getuid ());
1198 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1199 "Return the full name of the user logged in, as a string.\n\
1200 If the full name corresponding to Emacs's userid is not known,\n\
1201 return \"unknown\".\n\
1203 If optional argument UID is an integer, return the full name of the user\n\
1204 with that uid, or nil if there is no such user.\n\
1205 If UID is a string, return the full name of the user with that login\n\
1206 name, or nil if there is no such user.")
1207 (uid)
1208 Lisp_Object uid;
1210 struct passwd *pw;
1211 register unsigned char *p, *q;
1212 Lisp_Object full;
1214 if (NILP (uid))
1215 return Vuser_full_name;
1216 else if (NUMBERP (uid))
1217 pw = (struct passwd *) getpwuid (XINT (uid));
1218 else if (STRINGP (uid))
1219 pw = (struct passwd *) getpwnam (XSTRING (uid)->data);
1220 else
1221 error ("Invalid UID specification");
1223 if (!pw)
1224 return Qnil;
1226 p = (unsigned char *) USER_FULL_NAME;
1227 /* Chop off everything after the first comma. */
1228 q = (unsigned char *) index (p, ',');
1229 full = make_string (p, q ? q - p : strlen (p));
1231 #ifdef AMPERSAND_FULL_NAME
1232 p = XSTRING (full)->data;
1233 q = (unsigned char *) index (p, '&');
1234 /* Substitute the login name for the &, upcasing the first character. */
1235 if (q)
1237 register unsigned char *r;
1238 Lisp_Object login;
1240 login = Fuser_login_name (make_number (pw->pw_uid));
1241 r = (unsigned char *) alloca (strlen (p) + XSTRING (login)->size + 1);
1242 bcopy (p, r, q - p);
1243 r[q - p] = 0;
1244 strcat (r, XSTRING (login)->data);
1245 r[q - p] = UPCASE (r[q - p]);
1246 strcat (r, q + 1);
1247 full = build_string (r);
1249 #endif /* AMPERSAND_FULL_NAME */
1251 return full;
1254 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1255 "Return the name of the machine you are running on, as a string.")
1258 return Vsystem_name;
1261 /* For the benefit of callers who don't want to include lisp.h */
1263 char *
1264 get_system_name ()
1266 if (STRINGP (Vsystem_name))
1267 return (char *) XSTRING (Vsystem_name)->data;
1268 else
1269 return "";
1272 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1273 "Return the process ID of Emacs, as an integer.")
1276 return make_number (getpid ());
1279 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1280 "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
1281 The time is returned as a list of three integers. The first has the\n\
1282 most significant 16 bits of the seconds, while the second has the\n\
1283 least significant 16 bits. The third integer gives the microsecond\n\
1284 count.\n\
1286 The microsecond count is zero on systems that do not provide\n\
1287 resolution finer than a second.")
1290 EMACS_TIME t;
1291 Lisp_Object result[3];
1293 EMACS_GET_TIME (t);
1294 XSETINT (result[0], (EMACS_SECS (t) >> 16) & 0xffff);
1295 XSETINT (result[1], (EMACS_SECS (t) >> 0) & 0xffff);
1296 XSETINT (result[2], EMACS_USECS (t));
1298 return Flist (3, result);
1302 static int
1303 lisp_time_argument (specified_time, result, usec)
1304 Lisp_Object specified_time;
1305 time_t *result;
1306 int *usec;
1308 if (NILP (specified_time))
1310 if (usec)
1312 EMACS_TIME t;
1314 EMACS_GET_TIME (t);
1315 *usec = EMACS_USECS (t);
1316 *result = EMACS_SECS (t);
1317 return 1;
1319 else
1320 return time (result) != -1;
1322 else
1324 Lisp_Object high, low;
1325 high = Fcar (specified_time);
1326 CHECK_NUMBER (high, 0);
1327 low = Fcdr (specified_time);
1328 if (CONSP (low))
1330 if (usec)
1332 Lisp_Object usec_l = Fcdr (low);
1333 if (CONSP (usec_l))
1334 usec_l = Fcar (usec_l);
1335 if (NILP (usec_l))
1336 *usec = 0;
1337 else
1339 CHECK_NUMBER (usec_l, 0);
1340 *usec = XINT (usec_l);
1343 low = Fcar (low);
1345 else if (usec)
1346 *usec = 0;
1347 CHECK_NUMBER (low, 0);
1348 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1349 return *result >> 16 == XINT (high);
1353 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1354 "Return the current time, as a float number of seconds since the epoch.\n\
1355 If an argument is given, it specifies a time to convert to float\n\
1356 instead of the current time. The argument should have the forms:\n\
1357 (HIGH . LOW) or (HIGH LOW USEC) or (HIGH LOW . USEC).\n\
1358 Thus, you can use times obtained from `current-time'\n\
1359 and from `file-attributes'.")
1360 (specified_time)
1361 Lisp_Object specified_time;
1363 time_t sec;
1364 int usec;
1366 if (! lisp_time_argument (specified_time, &sec, &usec))
1367 error ("Invalid time specification");
1369 return make_float (sec + usec * 0.0000001);
1372 /* Write information into buffer S of size MAXSIZE, according to the
1373 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1374 Default to Universal Time if UT is nonzero, local time otherwise.
1375 Return the number of bytes written, not including the terminating
1376 '\0'. If S is NULL, nothing will be written anywhere; so to
1377 determine how many bytes would be written, use NULL for S and
1378 ((size_t) -1) for MAXSIZE.
1380 This function behaves like emacs_strftimeu, except it allows null
1381 bytes in FORMAT. */
1382 static size_t
1383 emacs_memftimeu (s, maxsize, format, format_len, tp, ut)
1384 char *s;
1385 size_t maxsize;
1386 const char *format;
1387 size_t format_len;
1388 const struct tm *tp;
1389 int ut;
1391 size_t total = 0;
1393 /* Loop through all the null-terminated strings in the format
1394 argument. Normally there's just one null-terminated string, but
1395 there can be arbitrarily many, concatenated together, if the
1396 format contains '\0' bytes. emacs_strftimeu stops at the first
1397 '\0' byte so we must invoke it separately for each such string. */
1398 for (;;)
1400 size_t len;
1401 size_t result;
1403 if (s)
1404 s[0] = '\1';
1406 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1408 if (s)
1410 if (result == 0 && s[0] != '\0')
1411 return 0;
1412 s += result + 1;
1415 maxsize -= result + 1;
1416 total += result;
1417 len = strlen (format);
1418 if (len == format_len)
1419 return total;
1420 total++;
1421 format += len + 1;
1422 format_len -= len + 1;
1427 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1428 "Use FORMAT-STRING to format the time TIME, or now if omitted.\n\
1429 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as returned by\n\
1430 `current-time' or `file-attributes'.\n\
1431 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME\n\
1432 as Universal Time; nil means describe TIME in the local time zone.\n\
1433 The value is a copy of FORMAT-STRING, but with certain constructs replaced\n\
1434 by text that describes the specified date and time in TIME:\n\
1436 %Y is the year, %y within the century, %C the century.\n\
1437 %G is the year corresponding to the ISO week, %g within the century.\n\
1438 %m is the numeric month.\n\
1439 %b and %h are the locale's abbreviated month name, %B the full name.\n\
1440 %d is the day of the month, zero-padded, %e is blank-padded.\n\
1441 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.\n\
1442 %a is the locale's abbreviated name of the day of week, %A the full name.\n\
1443 %U is the week number starting on Sunday, %W starting on Monday,\n\
1444 %V according to ISO 8601.\n\
1445 %j is the day of the year.\n\
1447 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H\n\
1448 only blank-padded, %l is like %I blank-padded.\n\
1449 %p is the locale's equivalent of either AM or PM.\n\
1450 %M is the minute.\n\
1451 %S is the second.\n\
1452 %Z is the time zone name, %z is the numeric form.\n\
1453 %s is the number of seconds since 1970-01-01 00:00:00 +0000.\n\
1455 %c is the locale's date and time format.\n\
1456 %x is the locale's \"preferred\" date format.\n\
1457 %D is like \"%m/%d/%y\".\n\
1459 %R is like \"%H:%M\", %T is like \"%H:%M:%S\", %r is like \"%I:%M:%S %p\".\n\
1460 %X is the locale's \"preferred\" time format.\n\
1462 Finally, %n is a newline, %t is a tab, %% is a literal %.\n\
1464 Certain flags and modifiers are available with some format controls.\n\
1465 The flags are `_' and `-'. For certain characters X, %_X is like %X,\n\
1466 but padded with blanks; %-X is like %X, but without padding.\n\
1467 %NX (where N stands for an integer) is like %X,\n\
1468 but takes up at least N (a number) positions.\n\
1469 The modifiers are `E' and `O'. For certain characters X,\n\
1470 %EX is a locale's alternative version of %X;\n\
1471 %OX is like %X, but uses the locale's number symbols.\n\
1473 For example, to produce full ISO 8601 format, use \"%Y-%m-%dT%T%z\".")
1474 (format_string, time, universal)
1477 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1478 0 /* See immediately above */)
1479 (format_string, time, universal)
1480 Lisp_Object format_string, time, universal;
1482 time_t value;
1483 int size;
1484 struct tm *tm;
1485 int ut = ! NILP (universal);
1487 CHECK_STRING (format_string, 1);
1489 if (! lisp_time_argument (time, &value, NULL))
1490 error ("Invalid time specification");
1492 format_string = code_convert_string_norecord (format_string,
1493 Vlocale_coding_system, 1);
1495 /* This is probably enough. */
1496 size = STRING_BYTES (XSTRING (format_string)) * 6 + 50;
1498 tm = ut ? gmtime (&value) : localtime (&value);
1499 if (! tm)
1500 error ("Specified time is not representable");
1502 synchronize_system_time_locale ();
1504 while (1)
1506 char *buf = (char *) alloca (size + 1);
1507 int result;
1509 buf[0] = '\1';
1510 result = emacs_memftimeu (buf, size, XSTRING (format_string)->data,
1511 STRING_BYTES (XSTRING (format_string)),
1512 tm, ut);
1513 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1514 return code_convert_string_norecord (make_string (buf, result),
1515 Vlocale_coding_system, 0);
1517 /* If buffer was too small, make it bigger and try again. */
1518 result = emacs_memftimeu (NULL, (size_t) -1,
1519 XSTRING (format_string)->data,
1520 STRING_BYTES (XSTRING (format_string)),
1521 tm, ut);
1522 size = result + 1;
1526 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1527 "Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).\n\
1528 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)\n\
1529 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'\n\
1530 to use the current time. The list has the following nine members:\n\
1531 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which\n\
1532 only some operating systems support. MINUTE is an integer between 0 and 59.\n\
1533 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.\n\
1534 MONTH is an integer between 1 and 12. YEAR is an integer indicating the\n\
1535 four-digit year. DOW is the day of week, an integer between 0 and 6, where\n\
1536 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.\n\
1537 ZONE is an integer indicating the number of seconds east of Greenwich.\n\
1538 \(Note that Common Lisp has different meanings for DOW and ZONE.)")
1539 (specified_time)
1540 Lisp_Object specified_time;
1542 time_t time_spec;
1543 struct tm save_tm;
1544 struct tm *decoded_time;
1545 Lisp_Object list_args[9];
1547 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1548 error ("Invalid time specification");
1550 decoded_time = localtime (&time_spec);
1551 if (! decoded_time)
1552 error ("Specified time is not representable");
1553 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1554 XSETFASTINT (list_args[1], decoded_time->tm_min);
1555 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1556 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1557 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1558 XSETINT (list_args[5], decoded_time->tm_year + 1900);
1559 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1560 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1562 /* Make a copy, in case gmtime modifies the struct. */
1563 save_tm = *decoded_time;
1564 decoded_time = gmtime (&time_spec);
1565 if (decoded_time == 0)
1566 list_args[8] = Qnil;
1567 else
1568 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1569 return Flist (9, list_args);
1572 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1573 "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
1574 This is the reverse operation of `decode-time', which see.\n\
1575 ZONE defaults to the current time zone rule. This can\n\
1576 be a string or t (as from `set-time-zone-rule'), or it can be a list\n\
1577 \(as from `current-time-zone') or an integer (as from `decode-time')\n\
1578 applied without consideration for daylight savings time.\n\
1580 You can pass more than 7 arguments; then the first six arguments\n\
1581 are used as SECOND through YEAR, and the *last* argument is used as ZONE.\n\
1582 The intervening arguments are ignored.\n\
1583 This feature lets (apply 'encode-time (decode-time ...)) work.\n\
1585 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;\n\
1586 for example, a DAY of 0 means the day preceding the given month.\n\
1587 Year numbers less than 100 are treated just like other year numbers.\n\
1588 If you want them to stand for years in this century, you must do that yourself.")
1589 (nargs, args)
1590 int nargs;
1591 register Lisp_Object *args;
1593 time_t time;
1594 struct tm tm;
1595 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1597 CHECK_NUMBER (args[0], 0); /* second */
1598 CHECK_NUMBER (args[1], 1); /* minute */
1599 CHECK_NUMBER (args[2], 2); /* hour */
1600 CHECK_NUMBER (args[3], 3); /* day */
1601 CHECK_NUMBER (args[4], 4); /* month */
1602 CHECK_NUMBER (args[5], 5); /* year */
1604 tm.tm_sec = XINT (args[0]);
1605 tm.tm_min = XINT (args[1]);
1606 tm.tm_hour = XINT (args[2]);
1607 tm.tm_mday = XINT (args[3]);
1608 tm.tm_mon = XINT (args[4]) - 1;
1609 tm.tm_year = XINT (args[5]) - 1900;
1610 tm.tm_isdst = -1;
1612 if (CONSP (zone))
1613 zone = Fcar (zone);
1614 if (NILP (zone))
1615 time = mktime (&tm);
1616 else
1618 char tzbuf[100];
1619 char *tzstring;
1620 char **oldenv = environ, **newenv;
1622 if (EQ (zone, Qt))
1623 tzstring = "UTC0";
1624 else if (STRINGP (zone))
1625 tzstring = (char *) XSTRING (zone)->data;
1626 else if (INTEGERP (zone))
1628 int abszone = abs (XINT (zone));
1629 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1630 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1631 tzstring = tzbuf;
1633 else
1634 error ("Invalid time zone specification");
1636 /* Set TZ before calling mktime; merely adjusting mktime's returned
1637 value doesn't suffice, since that would mishandle leap seconds. */
1638 set_time_zone_rule (tzstring);
1640 time = mktime (&tm);
1642 /* Restore TZ to previous value. */
1643 newenv = environ;
1644 environ = oldenv;
1645 xfree (newenv);
1646 #ifdef LOCALTIME_CACHE
1647 tzset ();
1648 #endif
1651 if (time == (time_t) -1)
1652 error ("Specified time is not representable");
1654 return make_time (time);
1657 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1658 "Return the current time, as a human-readable string.\n\
1659 Programs can use this function to decode a time,\n\
1660 since the number of columns in each field is fixed.\n\
1661 The format is `Sun Sep 16 01:03:52 1973'.\n\
1662 However, see also the functions `decode-time' and `format-time-string'\n\
1663 which provide a much more powerful and general facility.\n\
1665 If an argument is given, it specifies a time to format\n\
1666 instead of the current time. The argument should have the form:\n\
1667 (HIGH . LOW)\n\
1668 or the form:\n\
1669 (HIGH LOW . IGNORED).\n\
1670 Thus, you can use times obtained from `current-time'\n\
1671 and from `file-attributes'.")
1672 (specified_time)
1673 Lisp_Object specified_time;
1675 time_t value;
1676 char buf[30];
1677 register char *tem;
1679 if (! lisp_time_argument (specified_time, &value, NULL))
1680 value = -1;
1681 tem = (char *) ctime (&value);
1683 strncpy (buf, tem, 24);
1684 buf[24] = 0;
1686 return build_string (buf);
1689 #define TM_YEAR_BASE 1900
1691 /* Yield A - B, measured in seconds.
1692 This function is copied from the GNU C Library. */
1693 static int
1694 tm_diff (a, b)
1695 struct tm *a, *b;
1697 /* Compute intervening leap days correctly even if year is negative.
1698 Take care to avoid int overflow in leap day calculations,
1699 but it's OK to assume that A and B are close to each other. */
1700 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1701 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1702 int a100 = a4 / 25 - (a4 % 25 < 0);
1703 int b100 = b4 / 25 - (b4 % 25 < 0);
1704 int a400 = a100 >> 2;
1705 int b400 = b100 >> 2;
1706 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1707 int years = a->tm_year - b->tm_year;
1708 int days = (365 * years + intervening_leap_days
1709 + (a->tm_yday - b->tm_yday));
1710 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1711 + (a->tm_min - b->tm_min))
1712 + (a->tm_sec - b->tm_sec));
1715 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1716 "Return the offset and name for the local time zone.\n\
1717 This returns a list of the form (OFFSET NAME).\n\
1718 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).\n\
1719 A negative value means west of Greenwich.\n\
1720 NAME is a string giving the name of the time zone.\n\
1721 If an argument is given, it specifies when the time zone offset is determined\n\
1722 instead of using the current time. The argument should have the form:\n\
1723 (HIGH . LOW)\n\
1724 or the form:\n\
1725 (HIGH LOW . IGNORED).\n\
1726 Thus, you can use times obtained from `current-time'\n\
1727 and from `file-attributes'.\n\
1729 Some operating systems cannot provide all this information to Emacs;\n\
1730 in this case, `current-time-zone' returns a list containing nil for\n\
1731 the data it can't find.")
1732 (specified_time)
1733 Lisp_Object specified_time;
1735 time_t value;
1736 struct tm *t;
1737 struct tm gmt;
1739 if (lisp_time_argument (specified_time, &value, NULL)
1740 && (t = gmtime (&value)) != 0
1741 && (gmt = *t, t = localtime (&value)) != 0)
1743 int offset = tm_diff (t, &gmt);
1744 char *s = 0;
1745 char buf[6];
1746 #ifdef HAVE_TM_ZONE
1747 if (t->tm_zone)
1748 s = (char *)t->tm_zone;
1749 #else /* not HAVE_TM_ZONE */
1750 #ifdef HAVE_TZNAME
1751 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1752 s = tzname[t->tm_isdst];
1753 #endif
1754 #endif /* not HAVE_TM_ZONE */
1755 if (!s)
1757 /* No local time zone name is available; use "+-NNNN" instead. */
1758 int am = (offset < 0 ? -offset : offset) / 60;
1759 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1760 s = buf;
1762 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
1764 else
1765 return Fmake_list (make_number (2), Qnil);
1768 /* This holds the value of `environ' produced by the previous
1769 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1770 has never been called. */
1771 static char **environbuf;
1773 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
1774 "Set the local time zone using TZ, a string specifying a time zone rule.\n\
1775 If TZ is nil, use implementation-defined default time zone information.\n\
1776 If TZ is t, use Universal Time.")
1777 (tz)
1778 Lisp_Object tz;
1780 char *tzstring;
1782 if (NILP (tz))
1783 tzstring = 0;
1784 else if (EQ (tz, Qt))
1785 tzstring = "UTC0";
1786 else
1788 CHECK_STRING (tz, 0);
1789 tzstring = (char *) XSTRING (tz)->data;
1792 set_time_zone_rule (tzstring);
1793 if (environbuf)
1794 free (environbuf);
1795 environbuf = environ;
1797 return Qnil;
1800 #ifdef LOCALTIME_CACHE
1802 /* These two values are known to load tz files in buggy implementations,
1803 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1804 Their values shouldn't matter in non-buggy implementations.
1805 We don't use string literals for these strings,
1806 since if a string in the environment is in readonly
1807 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1808 See Sun bugs 1113095 and 1114114, ``Timezone routines
1809 improperly modify environment''. */
1811 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1812 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1814 #endif
1816 /* Set the local time zone rule to TZSTRING.
1817 This allocates memory into `environ', which it is the caller's
1818 responsibility to free. */
1820 void
1821 set_time_zone_rule (tzstring)
1822 char *tzstring;
1824 int envptrs;
1825 char **from, **to, **newenv;
1827 /* Make the ENVIRON vector longer with room for TZSTRING. */
1828 for (from = environ; *from; from++)
1829 continue;
1830 envptrs = from - environ + 2;
1831 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1832 + (tzstring ? strlen (tzstring) + 4 : 0));
1834 /* Add TZSTRING to the end of environ, as a value for TZ. */
1835 if (tzstring)
1837 char *t = (char *) (to + envptrs);
1838 strcpy (t, "TZ=");
1839 strcat (t, tzstring);
1840 *to++ = t;
1843 /* Copy the old environ vector elements into NEWENV,
1844 but don't copy the TZ variable.
1845 So we have only one definition of TZ, which came from TZSTRING. */
1846 for (from = environ; *from; from++)
1847 if (strncmp (*from, "TZ=", 3) != 0)
1848 *to++ = *from;
1849 *to = 0;
1851 environ = newenv;
1853 /* If we do have a TZSTRING, NEWENV points to the vector slot where
1854 the TZ variable is stored. If we do not have a TZSTRING,
1855 TO points to the vector slot which has the terminating null. */
1857 #ifdef LOCALTIME_CACHE
1859 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1860 "US/Pacific" that loads a tz file, then changes to a value like
1861 "XXX0" that does not load a tz file, and then changes back to
1862 its original value, the last change is (incorrectly) ignored.
1863 Also, if TZ changes twice in succession to values that do
1864 not load a tz file, tzset can dump core (see Sun bug#1225179).
1865 The following code works around these bugs. */
1867 if (tzstring)
1869 /* Temporarily set TZ to a value that loads a tz file
1870 and that differs from tzstring. */
1871 char *tz = *newenv;
1872 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1873 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1874 tzset ();
1875 *newenv = tz;
1877 else
1879 /* The implied tzstring is unknown, so temporarily set TZ to
1880 two different values that each load a tz file. */
1881 *to = set_time_zone_rule_tz1;
1882 to[1] = 0;
1883 tzset ();
1884 *to = set_time_zone_rule_tz2;
1885 tzset ();
1886 *to = 0;
1889 /* Now TZ has the desired value, and tzset can be invoked safely. */
1892 tzset ();
1893 #endif
1896 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
1897 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
1898 type of object is Lisp_String). INHERIT is passed to
1899 INSERT_FROM_STRING_FUNC as the last argument. */
1901 static void
1902 general_insert_function (insert_func, insert_from_string_func,
1903 inherit, nargs, args)
1904 void (*insert_func) P_ ((unsigned char *, int));
1905 void (*insert_from_string_func) P_ ((Lisp_Object, int, int, int, int, int));
1906 int inherit, nargs;
1907 register Lisp_Object *args;
1909 register int argnum;
1910 register Lisp_Object val;
1912 for (argnum = 0; argnum < nargs; argnum++)
1914 val = args[argnum];
1915 retry:
1916 if (INTEGERP (val))
1918 unsigned char str[MAX_MULTIBYTE_LENGTH];
1919 int len;
1921 if (!NILP (current_buffer->enable_multibyte_characters))
1922 len = CHAR_STRING (XFASTINT (val), str);
1923 else
1925 str[0] = (SINGLE_BYTE_CHAR_P (XINT (val))
1926 ? XINT (val)
1927 : multibyte_char_to_unibyte (XINT (val), Qnil));
1928 len = 1;
1930 (*insert_func) (str, len);
1932 else if (STRINGP (val))
1934 (*insert_from_string_func) (val, 0, 0,
1935 XSTRING (val)->size,
1936 STRING_BYTES (XSTRING (val)),
1937 inherit);
1939 else
1941 val = wrong_type_argument (Qchar_or_string_p, val);
1942 goto retry;
1947 void
1948 insert1 (arg)
1949 Lisp_Object arg;
1951 Finsert (1, &arg);
1955 /* Callers passing one argument to Finsert need not gcpro the
1956 argument "array", since the only element of the array will
1957 not be used after calling insert or insert_from_string, so
1958 we don't care if it gets trashed. */
1960 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
1961 "Insert the arguments, either strings or characters, at point.\n\
1962 Point and before-insertion markers move forward to end up\n\
1963 after the inserted text.\n\
1964 Any other markers at the point of insertion remain before the text.\n\
1966 If the current buffer is multibyte, unibyte strings are converted\n\
1967 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
1968 If the current buffer is unibyte, multibyte strings are converted\n\
1969 to unibyte for insertion.")
1970 (nargs, args)
1971 int nargs;
1972 register Lisp_Object *args;
1974 general_insert_function (insert, insert_from_string, 0, nargs, args);
1975 return Qnil;
1978 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
1979 0, MANY, 0,
1980 "Insert the arguments at point, inheriting properties from adjoining text.\n\
1981 Point and before-insertion markers move forward to end up\n\
1982 after the inserted text.\n\
1983 Any other markers at the point of insertion remain before the text.\n\
1985 If the current buffer is multibyte, unibyte strings are converted\n\
1986 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
1987 If the current buffer is unibyte, multibyte strings are converted\n\
1988 to unibyte for insertion.")
1989 (nargs, args)
1990 int nargs;
1991 register Lisp_Object *args;
1993 general_insert_function (insert_and_inherit, insert_from_string, 1,
1994 nargs, args);
1995 return Qnil;
1998 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
1999 "Insert strings or characters at point, relocating markers after the text.\n\
2000 Point and markers move forward to end up after the inserted text.\n\
2002 If the current buffer is multibyte, unibyte strings are converted\n\
2003 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
2004 If the current buffer is unibyte, multibyte strings are converted\n\
2005 to unibyte for insertion.")
2006 (nargs, args)
2007 int nargs;
2008 register Lisp_Object *args;
2010 general_insert_function (insert_before_markers,
2011 insert_from_string_before_markers, 0,
2012 nargs, args);
2013 return Qnil;
2016 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2017 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2018 "Insert text at point, relocating markers and inheriting properties.\n\
2019 Point and markers move forward to end up after the inserted text.\n\
2021 If the current buffer is multibyte, unibyte strings are converted\n\
2022 to multibyte for insertion (see `unibyte-char-to-multibyte').\n\
2023 If the current buffer is unibyte, multibyte strings are converted\n\
2024 to unibyte for insertion.")
2025 (nargs, args)
2026 int nargs;
2027 register Lisp_Object *args;
2029 general_insert_function (insert_before_markers_and_inherit,
2030 insert_from_string_before_markers, 1,
2031 nargs, args);
2032 return Qnil;
2035 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2036 "Insert COUNT (second arg) copies of CHARACTER (first arg).\n\
2037 Both arguments are required.\n\
2038 Point, and before-insertion markers, are relocated as in the function `insert'.\n\
2039 The optional third arg INHERIT, if non-nil, says to inherit text properties\n\
2040 from adjoining text, if those properties are sticky.")
2041 (character, count, inherit)
2042 Lisp_Object character, count, inherit;
2044 register unsigned char *string;
2045 register int strlen;
2046 register int i, n;
2047 int len;
2048 unsigned char str[MAX_MULTIBYTE_LENGTH];
2050 CHECK_NUMBER (character, 0);
2051 CHECK_NUMBER (count, 1);
2053 if (!NILP (current_buffer->enable_multibyte_characters))
2054 len = CHAR_STRING (XFASTINT (character), str);
2055 else
2056 str[0] = XFASTINT (character), len = 1;
2057 n = XINT (count) * len;
2058 if (n <= 0)
2059 return Qnil;
2060 strlen = min (n, 256 * len);
2061 string = (unsigned char *) alloca (strlen);
2062 for (i = 0; i < strlen; i++)
2063 string[i] = str[i % len];
2064 while (n >= strlen)
2066 QUIT;
2067 if (!NILP (inherit))
2068 insert_and_inherit (string, strlen);
2069 else
2070 insert (string, strlen);
2071 n -= strlen;
2073 if (n > 0)
2075 if (!NILP (inherit))
2076 insert_and_inherit (string, n);
2077 else
2078 insert (string, n);
2080 return Qnil;
2084 /* Making strings from buffer contents. */
2086 /* Return a Lisp_String containing the text of the current buffer from
2087 START to END. If text properties are in use and the current buffer
2088 has properties in the range specified, the resulting string will also
2089 have them, if PROPS is nonzero.
2091 We don't want to use plain old make_string here, because it calls
2092 make_uninit_string, which can cause the buffer arena to be
2093 compacted. make_string has no way of knowing that the data has
2094 been moved, and thus copies the wrong data into the string. This
2095 doesn't effect most of the other users of make_string, so it should
2096 be left as is. But we should use this function when conjuring
2097 buffer substrings. */
2099 Lisp_Object
2100 make_buffer_string (start, end, props)
2101 int start, end;
2102 int props;
2104 int start_byte = CHAR_TO_BYTE (start);
2105 int end_byte = CHAR_TO_BYTE (end);
2107 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2110 /* Return a Lisp_String containing the text of the current buffer from
2111 START / START_BYTE to END / END_BYTE.
2113 If text properties are in use and the current buffer
2114 has properties in the range specified, the resulting string will also
2115 have them, if PROPS is nonzero.
2117 We don't want to use plain old make_string here, because it calls
2118 make_uninit_string, which can cause the buffer arena to be
2119 compacted. make_string has no way of knowing that the data has
2120 been moved, and thus copies the wrong data into the string. This
2121 doesn't effect most of the other users of make_string, so it should
2122 be left as is. But we should use this function when conjuring
2123 buffer substrings. */
2125 Lisp_Object
2126 make_buffer_string_both (start, start_byte, end, end_byte, props)
2127 int start, start_byte, end, end_byte;
2128 int props;
2130 Lisp_Object result, tem, tem1;
2132 if (start < GPT && GPT < end)
2133 move_gap (start);
2135 if (! NILP (current_buffer->enable_multibyte_characters))
2136 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2137 else
2138 result = make_uninit_string (end - start);
2139 bcopy (BYTE_POS_ADDR (start_byte), XSTRING (result)->data,
2140 end_byte - start_byte);
2142 /* If desired, update and copy the text properties. */
2143 if (props)
2145 update_buffer_properties (start, end);
2147 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2148 tem1 = Ftext_properties_at (make_number (start), Qnil);
2150 if (XINT (tem) != end || !NILP (tem1))
2151 copy_intervals_to_string (result, current_buffer, start,
2152 end - start);
2155 return result;
2158 /* Call Vbuffer_access_fontify_functions for the range START ... END
2159 in the current buffer, if necessary. */
2161 static void
2162 update_buffer_properties (start, end)
2163 int start, end;
2165 /* If this buffer has some access functions,
2166 call them, specifying the range of the buffer being accessed. */
2167 if (!NILP (Vbuffer_access_fontify_functions))
2169 Lisp_Object args[3];
2170 Lisp_Object tem;
2172 args[0] = Qbuffer_access_fontify_functions;
2173 XSETINT (args[1], start);
2174 XSETINT (args[2], end);
2176 /* But don't call them if we can tell that the work
2177 has already been done. */
2178 if (!NILP (Vbuffer_access_fontified_property))
2180 tem = Ftext_property_any (args[1], args[2],
2181 Vbuffer_access_fontified_property,
2182 Qnil, Qnil);
2183 if (! NILP (tem))
2184 Frun_hook_with_args (3, args);
2186 else
2187 Frun_hook_with_args (3, args);
2191 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2192 "Return the contents of part of the current buffer as a string.\n\
2193 The two arguments START and END are character positions;\n\
2194 they can be in either order.\n\
2195 The string returned is multibyte if the buffer is multibyte.")
2196 (start, end)
2197 Lisp_Object start, end;
2199 register int b, e;
2201 validate_region (&start, &end);
2202 b = XINT (start);
2203 e = XINT (end);
2205 return make_buffer_string (b, e, 1);
2208 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2209 Sbuffer_substring_no_properties, 2, 2, 0,
2210 "Return the characters of part of the buffer, without the text properties.\n\
2211 The two arguments START and END are character positions;\n\
2212 they can be in either order.")
2213 (start, end)
2214 Lisp_Object start, end;
2216 register int b, e;
2218 validate_region (&start, &end);
2219 b = XINT (start);
2220 e = XINT (end);
2222 return make_buffer_string (b, e, 0);
2225 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2226 "Return the contents of the current buffer as a string.\n\
2227 If narrowing is in effect, this function returns only the visible part\n\
2228 of the buffer.")
2231 return make_buffer_string (BEGV, ZV, 1);
2234 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2235 1, 3, 0,
2236 "Insert before point a substring of the contents of buffer BUFFER.\n\
2237 BUFFER may be a buffer or a buffer name.\n\
2238 Arguments START and END are character numbers specifying the substring.\n\
2239 They default to the beginning and the end of BUFFER.")
2240 (buf, start, end)
2241 Lisp_Object buf, start, end;
2243 register int b, e, temp;
2244 register struct buffer *bp, *obuf;
2245 Lisp_Object buffer;
2247 buffer = Fget_buffer (buf);
2248 if (NILP (buffer))
2249 nsberror (buf);
2250 bp = XBUFFER (buffer);
2251 if (NILP (bp->name))
2252 error ("Selecting deleted buffer");
2254 if (NILP (start))
2255 b = BUF_BEGV (bp);
2256 else
2258 CHECK_NUMBER_COERCE_MARKER (start, 0);
2259 b = XINT (start);
2261 if (NILP (end))
2262 e = BUF_ZV (bp);
2263 else
2265 CHECK_NUMBER_COERCE_MARKER (end, 1);
2266 e = XINT (end);
2269 if (b > e)
2270 temp = b, b = e, e = temp;
2272 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2273 args_out_of_range (start, end);
2275 obuf = current_buffer;
2276 set_buffer_internal_1 (bp);
2277 update_buffer_properties (b, e);
2278 set_buffer_internal_1 (obuf);
2280 insert_from_buffer (bp, b, e - b, 0);
2281 return Qnil;
2284 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2285 6, 6, 0,
2286 "Compare two substrings of two buffers; return result as number.\n\
2287 the value is -N if first string is less after N-1 chars,\n\
2288 +N if first string is greater after N-1 chars, or 0 if strings match.\n\
2289 Each substring is represented as three arguments: BUFFER, START and END.\n\
2290 That makes six args in all, three for each substring.\n\n\
2291 The value of `case-fold-search' in the current buffer\n\
2292 determines whether case is significant or ignored.")
2293 (buffer1, start1, end1, buffer2, start2, end2)
2294 Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
2296 register int begp1, endp1, begp2, endp2, temp;
2297 register struct buffer *bp1, *bp2;
2298 register Lisp_Object *trt
2299 = (!NILP (current_buffer->case_fold_search)
2300 ? XCHAR_TABLE (current_buffer->case_canon_table)->contents : 0);
2301 int chars = 0;
2302 int i1, i2, i1_byte, i2_byte;
2304 /* Find the first buffer and its substring. */
2306 if (NILP (buffer1))
2307 bp1 = current_buffer;
2308 else
2310 Lisp_Object buf1;
2311 buf1 = Fget_buffer (buffer1);
2312 if (NILP (buf1))
2313 nsberror (buffer1);
2314 bp1 = XBUFFER (buf1);
2315 if (NILP (bp1->name))
2316 error ("Selecting deleted buffer");
2319 if (NILP (start1))
2320 begp1 = BUF_BEGV (bp1);
2321 else
2323 CHECK_NUMBER_COERCE_MARKER (start1, 1);
2324 begp1 = XINT (start1);
2326 if (NILP (end1))
2327 endp1 = BUF_ZV (bp1);
2328 else
2330 CHECK_NUMBER_COERCE_MARKER (end1, 2);
2331 endp1 = XINT (end1);
2334 if (begp1 > endp1)
2335 temp = begp1, begp1 = endp1, endp1 = temp;
2337 if (!(BUF_BEGV (bp1) <= begp1
2338 && begp1 <= endp1
2339 && endp1 <= BUF_ZV (bp1)))
2340 args_out_of_range (start1, end1);
2342 /* Likewise for second substring. */
2344 if (NILP (buffer2))
2345 bp2 = current_buffer;
2346 else
2348 Lisp_Object buf2;
2349 buf2 = Fget_buffer (buffer2);
2350 if (NILP (buf2))
2351 nsberror (buffer2);
2352 bp2 = XBUFFER (buf2);
2353 if (NILP (bp2->name))
2354 error ("Selecting deleted buffer");
2357 if (NILP (start2))
2358 begp2 = BUF_BEGV (bp2);
2359 else
2361 CHECK_NUMBER_COERCE_MARKER (start2, 4);
2362 begp2 = XINT (start2);
2364 if (NILP (end2))
2365 endp2 = BUF_ZV (bp2);
2366 else
2368 CHECK_NUMBER_COERCE_MARKER (end2, 5);
2369 endp2 = XINT (end2);
2372 if (begp2 > endp2)
2373 temp = begp2, begp2 = endp2, endp2 = temp;
2375 if (!(BUF_BEGV (bp2) <= begp2
2376 && begp2 <= endp2
2377 && endp2 <= BUF_ZV (bp2)))
2378 args_out_of_range (start2, end2);
2380 i1 = begp1;
2381 i2 = begp2;
2382 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2383 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2385 while (i1 < endp1 && i2 < endp2)
2387 /* When we find a mismatch, we must compare the
2388 characters, not just the bytes. */
2389 int c1, c2;
2391 if (! NILP (bp1->enable_multibyte_characters))
2393 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2394 BUF_INC_POS (bp1, i1_byte);
2395 i1++;
2397 else
2399 c1 = BUF_FETCH_BYTE (bp1, i1);
2400 c1 = unibyte_char_to_multibyte (c1);
2401 i1++;
2404 if (! NILP (bp2->enable_multibyte_characters))
2406 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2407 BUF_INC_POS (bp2, i2_byte);
2408 i2++;
2410 else
2412 c2 = BUF_FETCH_BYTE (bp2, i2);
2413 c2 = unibyte_char_to_multibyte (c2);
2414 i2++;
2417 if (trt)
2419 c1 = XINT (trt[c1]);
2420 c2 = XINT (trt[c2]);
2422 if (c1 < c2)
2423 return make_number (- 1 - chars);
2424 if (c1 > c2)
2425 return make_number (chars + 1);
2427 chars++;
2430 /* The strings match as far as they go.
2431 If one is shorter, that one is less. */
2432 if (chars < endp1 - begp1)
2433 return make_number (chars + 1);
2434 else if (chars < endp2 - begp2)
2435 return make_number (- chars - 1);
2437 /* Same length too => they are equal. */
2438 return make_number (0);
2441 static Lisp_Object
2442 subst_char_in_region_unwind (arg)
2443 Lisp_Object arg;
2445 return current_buffer->undo_list = arg;
2448 static Lisp_Object
2449 subst_char_in_region_unwind_1 (arg)
2450 Lisp_Object arg;
2452 return current_buffer->filename = arg;
2455 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2456 Ssubst_char_in_region, 4, 5, 0,
2457 "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
2458 If optional arg NOUNDO is non-nil, don't record this change for undo\n\
2459 and don't mark the buffer as really changed.\n\
2460 Both characters must have the same length of multi-byte form.")
2461 (start, end, fromchar, tochar, noundo)
2462 Lisp_Object start, end, fromchar, tochar, noundo;
2464 register int pos, pos_byte, stop, i, len, end_byte;
2465 int changed = 0;
2466 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2467 unsigned char *p;
2468 int count = specpdl_ptr - specpdl;
2469 #define COMBINING_NO 0
2470 #define COMBINING_BEFORE 1
2471 #define COMBINING_AFTER 2
2472 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2473 int maybe_byte_combining = COMBINING_NO;
2474 int last_changed = 0;
2475 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2477 validate_region (&start, &end);
2478 CHECK_NUMBER (fromchar, 2);
2479 CHECK_NUMBER (tochar, 3);
2481 if (multibyte_p)
2483 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2484 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2485 error ("Characters in subst-char-in-region have different byte-lengths");
2486 if (!ASCII_BYTE_P (*tostr))
2488 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2489 complete multibyte character, it may be combined with the
2490 after bytes. If it is in the range 0xA0..0xFF, it may be
2491 combined with the before and after bytes. */
2492 if (!CHAR_HEAD_P (*tostr))
2493 maybe_byte_combining = COMBINING_BOTH;
2494 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2495 maybe_byte_combining = COMBINING_AFTER;
2498 else
2500 len = 1;
2501 fromstr[0] = XFASTINT (fromchar);
2502 tostr[0] = XFASTINT (tochar);
2505 pos = XINT (start);
2506 pos_byte = CHAR_TO_BYTE (pos);
2507 stop = CHAR_TO_BYTE (XINT (end));
2508 end_byte = stop;
2510 /* If we don't want undo, turn off putting stuff on the list.
2511 That's faster than getting rid of things,
2512 and it prevents even the entry for a first change.
2513 Also inhibit locking the file. */
2514 if (!NILP (noundo))
2516 record_unwind_protect (subst_char_in_region_unwind,
2517 current_buffer->undo_list);
2518 current_buffer->undo_list = Qt;
2519 /* Don't do file-locking. */
2520 record_unwind_protect (subst_char_in_region_unwind_1,
2521 current_buffer->filename);
2522 current_buffer->filename = Qnil;
2525 if (pos_byte < GPT_BYTE)
2526 stop = min (stop, GPT_BYTE);
2527 while (1)
2529 int pos_byte_next = pos_byte;
2531 if (pos_byte >= stop)
2533 if (pos_byte >= end_byte) break;
2534 stop = end_byte;
2536 p = BYTE_POS_ADDR (pos_byte);
2537 if (multibyte_p)
2538 INC_POS (pos_byte_next);
2539 else
2540 ++pos_byte_next;
2541 if (pos_byte_next - pos_byte == len
2542 && p[0] == fromstr[0]
2543 && (len == 1
2544 || (p[1] == fromstr[1]
2545 && (len == 2 || (p[2] == fromstr[2]
2546 && (len == 3 || p[3] == fromstr[3]))))))
2548 if (! changed)
2550 changed = pos;
2551 modify_region (current_buffer, changed, XINT (end));
2553 if (! NILP (noundo))
2555 if (MODIFF - 1 == SAVE_MODIFF)
2556 SAVE_MODIFF++;
2557 if (MODIFF - 1 == current_buffer->auto_save_modified)
2558 current_buffer->auto_save_modified++;
2562 /* Take care of the case where the new character
2563 combines with neighboring bytes. */
2564 if (maybe_byte_combining
2565 && (maybe_byte_combining == COMBINING_AFTER
2566 ? (pos_byte_next < Z_BYTE
2567 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2568 : ((pos_byte_next < Z_BYTE
2569 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2570 || (pos_byte > BEG_BYTE
2571 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2573 Lisp_Object tem, string;
2575 struct gcpro gcpro1;
2577 tem = current_buffer->undo_list;
2578 GCPRO1 (tem);
2580 /* Make a multibyte string containing this single character. */
2581 string = make_multibyte_string (tostr, 1, len);
2582 /* replace_range is less efficient, because it moves the gap,
2583 but it handles combining correctly. */
2584 replace_range (pos, pos + 1, string,
2585 0, 0, 1);
2586 pos_byte_next = CHAR_TO_BYTE (pos);
2587 if (pos_byte_next > pos_byte)
2588 /* Before combining happened. We should not increment
2589 POS. So, to cancel the later increment of POS,
2590 decrease it now. */
2591 pos--;
2592 else
2593 INC_POS (pos_byte_next);
2595 if (! NILP (noundo))
2596 current_buffer->undo_list = tem;
2598 UNGCPRO;
2600 else
2602 if (NILP (noundo))
2603 record_change (pos, 1);
2604 for (i = 0; i < len; i++) *p++ = tostr[i];
2606 last_changed = pos + 1;
2608 pos_byte = pos_byte_next;
2609 pos++;
2612 if (changed)
2614 signal_after_change (changed,
2615 last_changed - changed, last_changed - changed);
2616 update_compositions (changed, last_changed, CHECK_ALL);
2619 unbind_to (count, Qnil);
2620 return Qnil;
2623 DEFUN ("translate-region", Ftranslate_region, Stranslate_region, 3, 3, 0,
2624 "From START to END, translate characters according to TABLE.\n\
2625 TABLE is a string; the Nth character in it is the mapping\n\
2626 for the character with code N.\n\
2627 This function does not alter multibyte characters.\n\
2628 It returns the number of characters changed.")
2629 (start, end, table)
2630 Lisp_Object start;
2631 Lisp_Object end;
2632 register Lisp_Object table;
2634 register int pos_byte, stop; /* Limits of the region. */
2635 register unsigned char *tt; /* Trans table. */
2636 register int nc; /* New character. */
2637 int cnt; /* Number of changes made. */
2638 int size; /* Size of translate table. */
2639 int pos;
2640 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
2642 validate_region (&start, &end);
2643 CHECK_STRING (table, 2);
2645 size = STRING_BYTES (XSTRING (table));
2646 tt = XSTRING (table)->data;
2648 pos_byte = CHAR_TO_BYTE (XINT (start));
2649 stop = CHAR_TO_BYTE (XINT (end));
2650 modify_region (current_buffer, XINT (start), XINT (end));
2651 pos = XINT (start);
2653 cnt = 0;
2654 for (; pos_byte < stop; )
2656 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
2657 int len;
2658 int oc;
2659 int pos_byte_next;
2661 if (multibyte)
2662 oc = STRING_CHAR_AND_LENGTH (p, stop - pos_byte, len);
2663 else
2664 oc = *p, len = 1;
2665 pos_byte_next = pos_byte + len;
2666 if (oc < size && len == 1)
2668 nc = tt[oc];
2669 if (nc != oc)
2671 /* Take care of the case where the new character
2672 combines with neighboring bytes. */
2673 if (!ASCII_BYTE_P (nc)
2674 && (CHAR_HEAD_P (nc)
2675 ? ! CHAR_HEAD_P (FETCH_BYTE (pos_byte + 1))
2676 : (pos_byte > BEG_BYTE
2677 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1)))))
2679 Lisp_Object string;
2681 string = make_multibyte_string (tt + oc, 1, 1);
2682 /* This is less efficient, because it moves the gap,
2683 but it handles combining correctly. */
2684 replace_range (pos, pos + 1, string,
2685 1, 0, 1);
2686 pos_byte_next = CHAR_TO_BYTE (pos);
2687 if (pos_byte_next > pos_byte)
2688 /* Before combining happened. We should not
2689 increment POS. So, to cancel the later
2690 increment of POS, we decrease it now. */
2691 pos--;
2692 else
2693 INC_POS (pos_byte_next);
2695 else
2697 record_change (pos, 1);
2698 *p = nc;
2699 signal_after_change (pos, 1, 1);
2700 update_compositions (pos, pos + 1, CHECK_BORDER);
2702 ++cnt;
2705 pos_byte = pos_byte_next;
2706 pos++;
2709 return make_number (cnt);
2712 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
2713 "Delete the text between point and mark.\n\
2714 When called from a program, expects two arguments,\n\
2715 positions (integers or markers) specifying the stretch to be deleted.")
2716 (start, end)
2717 Lisp_Object start, end;
2719 validate_region (&start, &end);
2720 del_range (XINT (start), XINT (end));
2721 return Qnil;
2724 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
2725 Sdelete_and_extract_region, 2, 2, 0,
2726 "Delete the text between START and END and return it.")
2727 (start, end)
2728 Lisp_Object start, end;
2730 validate_region (&start, &end);
2731 return del_range_1 (XINT (start), XINT (end), 1, 1);
2734 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
2735 "Remove restrictions (narrowing) from current buffer.\n\
2736 This allows the buffer's full text to be seen and edited.")
2739 if (BEG != BEGV || Z != ZV)
2740 current_buffer->clip_changed = 1;
2741 BEGV = BEG;
2742 BEGV_BYTE = BEG_BYTE;
2743 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
2744 /* Changing the buffer bounds invalidates any recorded current column. */
2745 invalidate_current_column ();
2746 return Qnil;
2749 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
2750 "Restrict editing in this buffer to the current region.\n\
2751 The rest of the text becomes temporarily invisible and untouchable\n\
2752 but is not deleted; if you save the buffer in a file, the invisible\n\
2753 text is included in the file. \\[widen] makes all visible again.\n\
2754 See also `save-restriction'.\n\
2756 When calling from a program, pass two arguments; positions (integers\n\
2757 or markers) bounding the text that should remain visible.")
2758 (start, end)
2759 register Lisp_Object start, end;
2761 CHECK_NUMBER_COERCE_MARKER (start, 0);
2762 CHECK_NUMBER_COERCE_MARKER (end, 1);
2764 if (XINT (start) > XINT (end))
2766 Lisp_Object tem;
2767 tem = start; start = end; end = tem;
2770 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
2771 args_out_of_range (start, end);
2773 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
2774 current_buffer->clip_changed = 1;
2776 SET_BUF_BEGV (current_buffer, XFASTINT (start));
2777 SET_BUF_ZV (current_buffer, XFASTINT (end));
2778 if (PT < XFASTINT (start))
2779 SET_PT (XFASTINT (start));
2780 if (PT > XFASTINT (end))
2781 SET_PT (XFASTINT (end));
2782 /* Changing the buffer bounds invalidates any recorded current column. */
2783 invalidate_current_column ();
2784 return Qnil;
2787 Lisp_Object
2788 save_restriction_save ()
2790 if (BEGV == BEG && ZV == Z)
2791 /* The common case that the buffer isn't narrowed.
2792 We return just the buffer object, which save_restriction_restore
2793 recognizes as meaning `no restriction'. */
2794 return Fcurrent_buffer ();
2795 else
2796 /* We have to save a restriction, so return a pair of markers, one
2797 for the beginning and one for the end. */
2799 Lisp_Object beg, end;
2801 beg = buildmark (BEGV, BEGV_BYTE);
2802 end = buildmark (ZV, ZV_BYTE);
2804 /* END must move forward if text is inserted at its exact location. */
2805 XMARKER(end)->insertion_type = 1;
2807 return Fcons (beg, end);
2811 Lisp_Object
2812 save_restriction_restore (data)
2813 Lisp_Object data;
2815 if (CONSP (data))
2816 /* A pair of marks bounding a saved restriction. */
2818 struct Lisp_Marker *beg = XMARKER (XCAR (data));
2819 struct Lisp_Marker *end = XMARKER (XCDR (data));
2820 struct buffer *buf = beg->buffer; /* END should have the same buffer. */
2822 if (beg->charpos != BUF_BEGV(buf) || end->charpos != BUF_ZV(buf))
2823 /* The restriction has changed from the saved one, so restore
2824 the saved restriction. */
2826 int pt = BUF_PT (buf);
2828 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
2829 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
2831 if (pt < beg->charpos || pt > end->charpos)
2832 /* The point is outside the new visible range, move it inside. */
2833 SET_BUF_PT_BOTH (buf,
2834 clip_to_bounds (beg->charpos, pt, end->charpos),
2835 clip_to_bounds (beg->bytepos, BUF_PT_BYTE(buf),
2836 end->bytepos));
2838 buf->clip_changed = 1; /* Remember that the narrowing changed. */
2841 else
2842 /* A buffer, which means that there was no old restriction. */
2844 struct buffer *buf = XBUFFER (data);
2846 if (BUF_BEGV(buf) != BUF_BEG(buf) || BUF_ZV(buf) != BUF_Z(buf))
2847 /* The buffer has been narrowed, get rid of the narrowing. */
2849 SET_BUF_BEGV_BOTH (buf, BUF_BEG(buf), BUF_BEG_BYTE(buf));
2850 SET_BUF_ZV_BOTH (buf, BUF_Z(buf), BUF_Z_BYTE(buf));
2852 buf->clip_changed = 1; /* Remember that the narrowing changed. */
2856 return Qnil;
2859 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
2860 "Execute BODY, saving and restoring current buffer's restrictions.\n\
2861 The buffer's restrictions make parts of the beginning and end invisible.\n\
2862 \(They are set up with `narrow-to-region' and eliminated with `widen'.)\n\
2863 This special form, `save-restriction', saves the current buffer's restrictions\n\
2864 when it is entered, and restores them when it is exited.\n\
2865 So any `narrow-to-region' within BODY lasts only until the end of the form.\n\
2866 The old restrictions settings are restored\n\
2867 even in case of abnormal exit (throw or error).\n\
2869 The value returned is the value of the last form in BODY.\n\
2871 Note: if you are using both `save-excursion' and `save-restriction',\n\
2872 use `save-excursion' outermost:\n\
2873 (save-excursion (save-restriction ...))")
2874 (body)
2875 Lisp_Object body;
2877 register Lisp_Object val;
2878 int count = specpdl_ptr - specpdl;
2880 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2881 val = Fprogn (body);
2882 return unbind_to (count, val);
2885 #ifndef HAVE_MENUS
2887 /* Buffer for the most recent text displayed by Fmessage. */
2888 static char *message_text;
2890 /* Allocated length of that buffer. */
2891 static int message_length;
2893 #endif /* not HAVE_MENUS */
2895 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
2896 "Print a one-line message at the bottom of the screen.\n\
2897 The first argument is a format control string, and the rest are data\n\
2898 to be formatted under control of the string. See `format' for details.\n\
2900 If the first argument is nil, clear any existing message; let the\n\
2901 minibuffer contents show.")
2902 (nargs, args)
2903 int nargs;
2904 Lisp_Object *args;
2906 if (NILP (args[0]))
2908 message (0);
2909 return Qnil;
2911 else
2913 register Lisp_Object val;
2914 val = Fformat (nargs, args);
2915 message3 (val, STRING_BYTES (XSTRING (val)), STRING_MULTIBYTE (val));
2916 return val;
2920 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
2921 "Display a message, in a dialog box if possible.\n\
2922 If a dialog box is not available, use the echo area.\n\
2923 The first argument is a format control string, and the rest are data\n\
2924 to be formatted under control of the string. See `format' for details.\n\
2926 If the first argument is nil, clear any existing message; let the\n\
2927 minibuffer contents show.")
2928 (nargs, args)
2929 int nargs;
2930 Lisp_Object *args;
2932 if (NILP (args[0]))
2934 message (0);
2935 return Qnil;
2937 else
2939 register Lisp_Object val;
2940 val = Fformat (nargs, args);
2941 #ifdef HAVE_MENUS
2943 Lisp_Object pane, menu, obj;
2944 struct gcpro gcpro1;
2945 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
2946 GCPRO1 (pane);
2947 menu = Fcons (val, pane);
2948 obj = Fx_popup_dialog (Qt, menu);
2949 UNGCPRO;
2950 return val;
2952 #else /* not HAVE_MENUS */
2953 /* Copy the data so that it won't move when we GC. */
2954 if (! message_text)
2956 message_text = (char *)xmalloc (80);
2957 message_length = 80;
2959 if (STRING_BYTES (XSTRING (val)) > message_length)
2961 message_length = STRING_BYTES (XSTRING (val));
2962 message_text = (char *)xrealloc (message_text, message_length);
2964 bcopy (XSTRING (val)->data, message_text, STRING_BYTES (XSTRING (val)));
2965 message2 (message_text, STRING_BYTES (XSTRING (val)),
2966 STRING_MULTIBYTE (val));
2967 return val;
2968 #endif /* not HAVE_MENUS */
2971 #ifdef HAVE_MENUS
2972 extern Lisp_Object last_nonmenu_event;
2973 #endif
2975 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
2976 "Display a message in a dialog box or in the echo area.\n\
2977 If this command was invoked with the mouse, use a dialog box if\n\
2978 `use-dialog-box' is non-nil.\n\
2979 Otherwise, use the echo area.\n\
2980 The first argument is a format control string, and the rest are data\n\
2981 to be formatted under control of the string. See `format' for details.\n\
2983 If the first argument is nil, clear any existing message; let the\n\
2984 minibuffer contents show.")
2985 (nargs, args)
2986 int nargs;
2987 Lisp_Object *args;
2989 #ifdef HAVE_MENUS
2990 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
2991 && use_dialog_box)
2992 return Fmessage_box (nargs, args);
2993 #endif
2994 return Fmessage (nargs, args);
2997 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
2998 "Return the string currently displayed in the echo area, or nil if none.")
3001 return current_message ();
3005 DEFUN ("propertize", Fpropertize, Spropertize, 3, MANY, 0,
3006 "Return a copy of STRING with text properties added.\n\
3007 First argument is the string to copy.\n\
3008 Remaining arguments form a sequence of PROPERTY VALUE pairs for text\n\
3009 properties to add to the result ")
3010 (nargs, args)
3011 int nargs;
3012 Lisp_Object *args;
3014 Lisp_Object properties, string;
3015 struct gcpro gcpro1, gcpro2;
3016 int i;
3018 /* Number of args must be odd. */
3019 if ((nargs & 1) == 0 || nargs < 3)
3020 error ("Wrong number of arguments");
3022 properties = string = Qnil;
3023 GCPRO2 (properties, string);
3025 /* First argument must be a string. */
3026 CHECK_STRING (args[0], 0);
3027 string = Fcopy_sequence (args[0]);
3029 for (i = 1; i < nargs; i += 2)
3031 CHECK_SYMBOL (args[i], i);
3032 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3035 Fadd_text_properties (make_number (0),
3036 make_number (XSTRING (string)->size),
3037 properties, string);
3038 RETURN_UNGCPRO (string);
3042 /* Number of bytes that STRING will occupy when put into the result.
3043 MULTIBYTE is nonzero if the result should be multibyte. */
3045 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3046 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3047 ? count_size_as_multibyte (XSTRING (STRING)->data, \
3048 STRING_BYTES (XSTRING (STRING))) \
3049 : STRING_BYTES (XSTRING (STRING)))
3051 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3052 "Format a string out of a control-string and arguments.\n\
3053 The first argument is a control string.\n\
3054 The other arguments are substituted into it to make the result, a string.\n\
3055 It may contain %-sequences meaning to substitute the next argument.\n\
3056 %s means print a string argument. Actually, prints any object, with `princ'.\n\
3057 %d means print as number in decimal (%o octal, %x hex).\n\
3058 %e means print a number in exponential notation.\n\
3059 %f means print a number in decimal-point notation.\n\
3060 %g means print a number in exponential notation\n\
3061 or decimal-point notation, whichever uses fewer characters.\n\
3062 %c means print a number as a single character.\n\
3063 %S means print any object as an s-expression (using `prin1').\n\
3064 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.\n\
3065 Use %% to put a single % into the output.")
3066 (nargs, args)
3067 int nargs;
3068 register Lisp_Object *args;
3070 register int n; /* The number of the next arg to substitute */
3071 register int total; /* An estimate of the final length */
3072 char *buf, *p;
3073 register unsigned char *format, *end;
3074 int nchars;
3075 /* Nonzero if the output should be a multibyte string,
3076 which is true if any of the inputs is one. */
3077 int multibyte = 0;
3078 /* When we make a multibyte string, we must pay attention to the
3079 byte combining problem, i.e., a byte may be combined with a
3080 multibyte charcter of the previous string. This flag tells if we
3081 must consider such a situation or not. */
3082 int maybe_combine_byte;
3083 unsigned char *this_format;
3084 int longest_format;
3085 Lisp_Object val;
3086 struct info
3088 int start, end;
3089 } *info = 0;
3091 /* It should not be necessary to GCPRO ARGS, because
3092 the caller in the interpreter should take care of that. */
3094 /* Try to determine whether the result should be multibyte.
3095 This is not always right; sometimes the result needs to be multibyte
3096 because of an object that we will pass through prin1,
3097 and in that case, we won't know it here. */
3098 for (n = 0; n < nargs; n++)
3099 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3100 multibyte = 1;
3102 CHECK_STRING (args[0], 0);
3104 /* If we start out planning a unibyte result,
3105 and later find it has to be multibyte, we jump back to retry. */
3106 retry:
3108 format = XSTRING (args[0])->data;
3109 end = format + STRING_BYTES (XSTRING (args[0]));
3110 longest_format = 0;
3112 /* Make room in result for all the non-%-codes in the control string. */
3113 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]);
3115 /* Add to TOTAL enough space to hold the converted arguments. */
3117 n = 0;
3118 while (format != end)
3119 if (*format++ == '%')
3121 int minlen, thissize = 0;
3122 unsigned char *this_format_start = format - 1;
3124 /* Process a numeric arg and skip it. */
3125 minlen = atoi (format);
3126 if (minlen < 0)
3127 minlen = - minlen;
3129 while ((*format >= '0' && *format <= '9')
3130 || *format == '-' || *format == ' ' || *format == '.')
3131 format++;
3133 if (format - this_format_start + 1 > longest_format)
3134 longest_format = format - this_format_start + 1;
3136 if (format == end)
3137 error ("Format string ends in middle of format specifier");
3138 if (*format == '%')
3139 format++;
3140 else if (++n >= nargs)
3141 error ("Not enough arguments for format string");
3142 else if (*format == 'S')
3144 /* For `S', prin1 the argument and then treat like a string. */
3145 register Lisp_Object tem;
3146 tem = Fprin1_to_string (args[n], Qnil);
3147 if (STRING_MULTIBYTE (tem) && ! multibyte)
3149 multibyte = 1;
3150 goto retry;
3152 args[n] = tem;
3153 goto string;
3155 else if (SYMBOLP (args[n]))
3157 /* Use a temp var to avoid problems when ENABLE_CHECKING
3158 is turned on. */
3159 struct Lisp_String *t = XSYMBOL (args[n])->name;
3160 XSETSTRING (args[n], t);
3161 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3163 multibyte = 1;
3164 goto retry;
3166 goto string;
3168 else if (STRINGP (args[n]))
3170 string:
3171 if (*format != 's' && *format != 'S')
3172 error ("Format specifier doesn't match argument type");
3173 thissize = CONVERTED_BYTE_SIZE (multibyte, args[n]);
3175 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3176 else if (INTEGERP (args[n]) && *format != 's')
3178 /* The following loop assumes the Lisp type indicates
3179 the proper way to pass the argument.
3180 So make sure we have a flonum if the argument should
3181 be a double. */
3182 if (*format == 'e' || *format == 'f' || *format == 'g')
3183 args[n] = Ffloat (args[n]);
3184 else
3185 if (*format != 'd' && *format != 'o' && *format != 'x'
3186 && *format != 'i' && *format != 'X' && *format != 'c')
3187 error ("Invalid format operation %%%c", *format);
3189 thissize = 30;
3190 if (*format == 'c'
3191 && (! SINGLE_BYTE_CHAR_P (XINT (args[n]))
3192 || XINT (args[n]) == 0))
3194 if (! multibyte)
3196 multibyte = 1;
3197 goto retry;
3199 args[n] = Fchar_to_string (args[n]);
3200 thissize = STRING_BYTES (XSTRING (args[n]));
3203 else if (FLOATP (args[n]) && *format != 's')
3205 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3206 args[n] = Ftruncate (args[n], Qnil);
3207 thissize = 200;
3209 else
3211 /* Anything but a string, convert to a string using princ. */
3212 register Lisp_Object tem;
3213 tem = Fprin1_to_string (args[n], Qt);
3214 if (STRING_MULTIBYTE (tem) & ! multibyte)
3216 multibyte = 1;
3217 goto retry;
3219 args[n] = tem;
3220 goto string;
3223 if (thissize < minlen)
3224 thissize = minlen;
3226 total += thissize + 4;
3229 /* Now we can no longer jump to retry.
3230 TOTAL and LONGEST_FORMAT are known for certain. */
3232 this_format = (unsigned char *) alloca (longest_format + 1);
3234 /* Allocate the space for the result.
3235 Note that TOTAL is an overestimate. */
3236 if (total < 1000)
3237 buf = (char *) alloca (total + 1);
3238 else
3239 buf = (char *) xmalloc (total + 1);
3241 p = buf;
3242 nchars = 0;
3243 n = 0;
3245 /* Scan the format and store result in BUF. */
3246 format = XSTRING (args[0])->data;
3247 maybe_combine_byte = 0;
3248 while (format != end)
3250 if (*format == '%')
3252 int minlen;
3253 int negative = 0;
3254 unsigned char *this_format_start = format;
3256 format++;
3258 /* Process a numeric arg and skip it. */
3259 minlen = atoi (format);
3260 if (minlen < 0)
3261 minlen = - minlen, negative = 1;
3263 while ((*format >= '0' && *format <= '9')
3264 || *format == '-' || *format == ' ' || *format == '.')
3265 format++;
3267 if (*format++ == '%')
3269 *p++ = '%';
3270 nchars++;
3271 continue;
3274 ++n;
3276 if (STRINGP (args[n]))
3278 int padding, nbytes;
3279 int width = strwidth (XSTRING (args[n])->data,
3280 STRING_BYTES (XSTRING (args[n])));
3281 int start = nchars;
3283 /* If spec requires it, pad on right with spaces. */
3284 padding = minlen - width;
3285 if (! negative)
3286 while (padding-- > 0)
3288 *p++ = ' ';
3289 nchars++;
3292 if (p > buf
3293 && multibyte
3294 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3295 && STRING_MULTIBYTE (args[n])
3296 && !CHAR_HEAD_P (XSTRING (args[n])->data[0]))
3297 maybe_combine_byte = 1;
3298 nbytes = copy_text (XSTRING (args[n])->data, p,
3299 STRING_BYTES (XSTRING (args[n])),
3300 STRING_MULTIBYTE (args[n]), multibyte);
3301 p += nbytes;
3302 nchars += XSTRING (args[n])->size;
3304 if (negative)
3305 while (padding-- > 0)
3307 *p++ = ' ';
3308 nchars++;
3311 /* If this argument has text properties, record where
3312 in the result string it appears. */
3313 if (XSTRING (args[n])->intervals)
3315 if (!info)
3317 int nbytes = nargs * sizeof *info;
3318 info = (struct info *) alloca (nbytes);
3319 bzero (info, nbytes);
3322 info[n].start = start;
3323 info[n].end = nchars;
3326 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3328 int this_nchars;
3330 bcopy (this_format_start, this_format,
3331 format - this_format_start);
3332 this_format[format - this_format_start] = 0;
3334 if (INTEGERP (args[n]))
3335 sprintf (p, this_format, XINT (args[n]));
3336 else
3337 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3339 if (p > buf
3340 && multibyte
3341 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3342 && !CHAR_HEAD_P (*((unsigned char *) p)))
3343 maybe_combine_byte = 1;
3344 this_nchars = strlen (p);
3345 if (multibyte)
3346 p += str_to_multibyte (p, buf + total - p, this_nchars);
3347 else
3348 p += this_nchars;
3349 nchars += this_nchars;
3352 else if (STRING_MULTIBYTE (args[0]))
3354 /* Copy a whole multibyte character. */
3355 if (p > buf
3356 && multibyte
3357 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3358 && !CHAR_HEAD_P (*format))
3359 maybe_combine_byte = 1;
3360 *p++ = *format++;
3361 while (! CHAR_HEAD_P (*format)) *p++ = *format++;
3362 nchars++;
3364 else if (multibyte)
3366 /* Convert a single-byte character to multibyte. */
3367 int len = copy_text (format, p, 1, 0, 1);
3369 p += len;
3370 format++;
3371 nchars++;
3373 else
3374 *p++ = *format++, nchars++;
3377 if (maybe_combine_byte)
3378 nchars = multibyte_chars_in_text (buf, p - buf);
3379 val = make_specified_string (buf, nchars, p - buf, multibyte);
3381 /* If we allocated BUF with malloc, free it too. */
3382 if (total >= 1000)
3383 xfree (buf);
3385 /* If the format string has text properties, or any of the string
3386 arguments has text properties, set up text properties of the
3387 result string. */
3389 if (XSTRING (args[0])->intervals || info)
3391 Lisp_Object len, new_len, props;
3392 struct gcpro gcpro1;
3394 /* Add text properties from the format string. */
3395 len = make_number (XSTRING (args[0])->size);
3396 props = text_property_list (args[0], make_number (0), len, Qnil);
3397 GCPRO1 (props);
3399 if (CONSP (props))
3401 new_len = make_number (XSTRING (val)->size);
3402 extend_property_ranges (props, len, new_len);
3403 add_text_properties_from_list (val, props, make_number (0));
3406 /* Add text properties from arguments. */
3407 if (info)
3408 for (n = 1; n < nargs; ++n)
3409 if (info[n].end)
3411 len = make_number (XSTRING (args[n])->size);
3412 new_len = make_number (info[n].end - info[n].start);
3413 props = text_property_list (args[n], make_number (0), len, Qnil);
3414 extend_property_ranges (props, len, new_len);
3415 /* If successive arguments have properites, be sure that
3416 the value of `composition' property be the copy. */
3417 if (n > 1 && info[n - 1].end)
3418 make_composition_value_copy (props);
3419 add_text_properties_from_list (val, props,
3420 make_number (info[n].start));
3423 UNGCPRO;
3426 return val;
3430 /* VARARGS 1 */
3431 Lisp_Object
3432 #ifdef NO_ARG_ARRAY
3433 format1 (string1, arg0, arg1, arg2, arg3, arg4)
3434 EMACS_INT arg0, arg1, arg2, arg3, arg4;
3435 #else
3436 format1 (string1)
3437 #endif
3438 char *string1;
3440 char buf[100];
3441 #ifdef NO_ARG_ARRAY
3442 EMACS_INT args[5];
3443 args[0] = arg0;
3444 args[1] = arg1;
3445 args[2] = arg2;
3446 args[3] = arg3;
3447 args[4] = arg4;
3448 doprnt (buf, sizeof buf, string1, (char *)0, 5, (char **) args);
3449 #else
3450 doprnt (buf, sizeof buf, string1, (char *)0, 5, &string1 + 1);
3451 #endif
3452 return build_string (buf);
3455 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
3456 "Return t if two characters match, optionally ignoring case.\n\
3457 Both arguments must be characters (i.e. integers).\n\
3458 Case is ignored if `case-fold-search' is non-nil in the current buffer.")
3459 (c1, c2)
3460 register Lisp_Object c1, c2;
3462 int i1, i2;
3463 CHECK_NUMBER (c1, 0);
3464 CHECK_NUMBER (c2, 1);
3466 if (XINT (c1) == XINT (c2))
3467 return Qt;
3468 if (NILP (current_buffer->case_fold_search))
3469 return Qnil;
3471 /* Do these in separate statements,
3472 then compare the variables.
3473 because of the way DOWNCASE uses temp variables. */
3474 i1 = DOWNCASE (XFASTINT (c1));
3475 i2 = DOWNCASE (XFASTINT (c2));
3476 return (i1 == i2 ? Qt : Qnil);
3479 /* Transpose the markers in two regions of the current buffer, and
3480 adjust the ones between them if necessary (i.e.: if the regions
3481 differ in size).
3483 START1, END1 are the character positions of the first region.
3484 START1_BYTE, END1_BYTE are the byte positions.
3485 START2, END2 are the character positions of the second region.
3486 START2_BYTE, END2_BYTE are the byte positions.
3488 Traverses the entire marker list of the buffer to do so, adding an
3489 appropriate amount to some, subtracting from some, and leaving the
3490 rest untouched. Most of this is copied from adjust_markers in insdel.c.
3492 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
3494 static void
3495 transpose_markers (start1, end1, start2, end2,
3496 start1_byte, end1_byte, start2_byte, end2_byte)
3497 register int start1, end1, start2, end2;
3498 register int start1_byte, end1_byte, start2_byte, end2_byte;
3500 register int amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
3501 register Lisp_Object marker;
3503 /* Update point as if it were a marker. */
3504 if (PT < start1)
3506 else if (PT < end1)
3507 TEMP_SET_PT_BOTH (PT + (end2 - end1),
3508 PT_BYTE + (end2_byte - end1_byte));
3509 else if (PT < start2)
3510 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
3511 (PT_BYTE + (end2_byte - start2_byte)
3512 - (end1_byte - start1_byte)));
3513 else if (PT < end2)
3514 TEMP_SET_PT_BOTH (PT - (start2 - start1),
3515 PT_BYTE - (start2_byte - start1_byte));
3517 /* We used to adjust the endpoints here to account for the gap, but that
3518 isn't good enough. Even if we assume the caller has tried to move the
3519 gap out of our way, it might still be at start1 exactly, for example;
3520 and that places it `inside' the interval, for our purposes. The amount
3521 of adjustment is nontrivial if there's a `denormalized' marker whose
3522 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
3523 the dirty work to Fmarker_position, below. */
3525 /* The difference between the region's lengths */
3526 diff = (end2 - start2) - (end1 - start1);
3527 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
3529 /* For shifting each marker in a region by the length of the other
3530 region plus the distance between the regions. */
3531 amt1 = (end2 - start2) + (start2 - end1);
3532 amt2 = (end1 - start1) + (start2 - end1);
3533 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
3534 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
3536 for (marker = BUF_MARKERS (current_buffer); !NILP (marker);
3537 marker = XMARKER (marker)->chain)
3539 mpos = marker_byte_position (marker);
3540 if (mpos >= start1_byte && mpos < end2_byte)
3542 if (mpos < end1_byte)
3543 mpos += amt1_byte;
3544 else if (mpos < start2_byte)
3545 mpos += diff_byte;
3546 else
3547 mpos -= amt2_byte;
3548 XMARKER (marker)->bytepos = mpos;
3550 mpos = XMARKER (marker)->charpos;
3551 if (mpos >= start1 && mpos < end2)
3553 if (mpos < end1)
3554 mpos += amt1;
3555 else if (mpos < start2)
3556 mpos += diff;
3557 else
3558 mpos -= amt2;
3560 XMARKER (marker)->charpos = mpos;
3564 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
3565 "Transpose region START1 to END1 with START2 to END2.\n\
3566 The regions may not be overlapping, because the size of the buffer is\n\
3567 never changed in a transposition.\n\
3569 Optional fifth arg LEAVE_MARKERS, if non-nil, means don't update\n\
3570 any markers that happen to be located in the regions.\n\
3572 Transposing beyond buffer boundaries is an error.")
3573 (startr1, endr1, startr2, endr2, leave_markers)
3574 Lisp_Object startr1, endr1, startr2, endr2, leave_markers;
3576 register int start1, end1, start2, end2;
3577 int start1_byte, start2_byte, len1_byte, len2_byte;
3578 int gap, len1, len_mid, len2;
3579 unsigned char *start1_addr, *start2_addr, *temp;
3580 struct gcpro gcpro1, gcpro2;
3582 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2;
3583 cur_intv = BUF_INTERVALS (current_buffer);
3585 validate_region (&startr1, &endr1);
3586 validate_region (&startr2, &endr2);
3588 start1 = XFASTINT (startr1);
3589 end1 = XFASTINT (endr1);
3590 start2 = XFASTINT (startr2);
3591 end2 = XFASTINT (endr2);
3592 gap = GPT;
3594 /* Swap the regions if they're reversed. */
3595 if (start2 < end1)
3597 register int glumph = start1;
3598 start1 = start2;
3599 start2 = glumph;
3600 glumph = end1;
3601 end1 = end2;
3602 end2 = glumph;
3605 len1 = end1 - start1;
3606 len2 = end2 - start2;
3608 if (start2 < end1)
3609 error ("Transposed regions overlap");
3610 else if (start1 == end1 || start2 == end2)
3611 error ("Transposed region has length 0");
3613 /* The possibilities are:
3614 1. Adjacent (contiguous) regions, or separate but equal regions
3615 (no, really equal, in this case!), or
3616 2. Separate regions of unequal size.
3618 The worst case is usually No. 2. It means that (aside from
3619 potential need for getting the gap out of the way), there also
3620 needs to be a shifting of the text between the two regions. So
3621 if they are spread far apart, we are that much slower... sigh. */
3623 /* It must be pointed out that the really studly thing to do would
3624 be not to move the gap at all, but to leave it in place and work
3625 around it if necessary. This would be extremely efficient,
3626 especially considering that people are likely to do
3627 transpositions near where they are working interactively, which
3628 is exactly where the gap would be found. However, such code
3629 would be much harder to write and to read. So, if you are
3630 reading this comment and are feeling squirrely, by all means have
3631 a go! I just didn't feel like doing it, so I will simply move
3632 the gap the minimum distance to get it out of the way, and then
3633 deal with an unbroken array. */
3635 /* Make sure the gap won't interfere, by moving it out of the text
3636 we will operate on. */
3637 if (start1 < gap && gap < end2)
3639 if (gap - start1 < end2 - gap)
3640 move_gap (start1);
3641 else
3642 move_gap (end2);
3645 start1_byte = CHAR_TO_BYTE (start1);
3646 start2_byte = CHAR_TO_BYTE (start2);
3647 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
3648 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
3650 #ifdef BYTE_COMBINING_DEBUG
3651 if (end1 == start2)
3653 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
3654 len2_byte, start1, start1_byte)
3655 || count_combining_before (BYTE_POS_ADDR (start1_byte),
3656 len1_byte, end2, start2_byte + len2_byte)
3657 || count_combining_after (BYTE_POS_ADDR (start1_byte),
3658 len1_byte, end2, start2_byte + len2_byte))
3659 abort ();
3661 else
3663 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
3664 len2_byte, start1, start1_byte)
3665 || count_combining_before (BYTE_POS_ADDR (start1_byte),
3666 len1_byte, start2, start2_byte)
3667 || count_combining_after (BYTE_POS_ADDR (start2_byte),
3668 len2_byte, end1, start1_byte + len1_byte)
3669 || count_combining_after (BYTE_POS_ADDR (start1_byte),
3670 len1_byte, end2, start2_byte + len2_byte))
3671 abort ();
3673 #endif
3675 /* Hmmm... how about checking to see if the gap is large
3676 enough to use as the temporary storage? That would avoid an
3677 allocation... interesting. Later, don't fool with it now. */
3679 /* Working without memmove, for portability (sigh), so must be
3680 careful of overlapping subsections of the array... */
3682 if (end1 == start2) /* adjacent regions */
3684 modify_region (current_buffer, start1, end2);
3685 record_change (start1, len1 + len2);
3687 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3688 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3689 Fset_text_properties (make_number (start1), make_number (end2),
3690 Qnil, Qnil);
3692 /* First region smaller than second. */
3693 if (len1_byte < len2_byte)
3695 /* We use alloca only if it is small,
3696 because we want to avoid stack overflow. */
3697 if (len2_byte > 20000)
3698 temp = (unsigned char *) xmalloc (len2_byte);
3699 else
3700 temp = (unsigned char *) alloca (len2_byte);
3702 /* Don't precompute these addresses. We have to compute them
3703 at the last minute, because the relocating allocator might
3704 have moved the buffer around during the xmalloc. */
3705 start1_addr = BYTE_POS_ADDR (start1_byte);
3706 start2_addr = BYTE_POS_ADDR (start2_byte);
3708 bcopy (start2_addr, temp, len2_byte);
3709 bcopy (start1_addr, start1_addr + len2_byte, len1_byte);
3710 bcopy (temp, start1_addr, len2_byte);
3711 if (len2_byte > 20000)
3712 xfree (temp);
3714 else
3715 /* First region not smaller than second. */
3717 if (len1_byte > 20000)
3718 temp = (unsigned char *) xmalloc (len1_byte);
3719 else
3720 temp = (unsigned char *) alloca (len1_byte);
3721 start1_addr = BYTE_POS_ADDR (start1_byte);
3722 start2_addr = BYTE_POS_ADDR (start2_byte);
3723 bcopy (start1_addr, temp, len1_byte);
3724 bcopy (start2_addr, start1_addr, len2_byte);
3725 bcopy (temp, start1_addr + len2_byte, len1_byte);
3726 if (len1_byte > 20000)
3727 xfree (temp);
3729 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
3730 len1, current_buffer, 0);
3731 graft_intervals_into_buffer (tmp_interval2, start1,
3732 len2, current_buffer, 0);
3733 update_compositions (start1, start1 + len2, CHECK_BORDER);
3734 update_compositions (start1 + len2, end2, CHECK_TAIL);
3736 /* Non-adjacent regions, because end1 != start2, bleagh... */
3737 else
3739 len_mid = start2_byte - (start1_byte + len1_byte);
3741 if (len1_byte == len2_byte)
3742 /* Regions are same size, though, how nice. */
3744 modify_region (current_buffer, start1, end1);
3745 modify_region (current_buffer, start2, end2);
3746 record_change (start1, len1);
3747 record_change (start2, len2);
3748 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3749 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3750 Fset_text_properties (make_number (start1), make_number (end1),
3751 Qnil, Qnil);
3752 Fset_text_properties (make_number (start2), make_number (end2),
3753 Qnil, Qnil);
3755 if (len1_byte > 20000)
3756 temp = (unsigned char *) xmalloc (len1_byte);
3757 else
3758 temp = (unsigned char *) alloca (len1_byte);
3759 start1_addr = BYTE_POS_ADDR (start1_byte);
3760 start2_addr = BYTE_POS_ADDR (start2_byte);
3761 bcopy (start1_addr, temp, len1_byte);
3762 bcopy (start2_addr, start1_addr, len2_byte);
3763 bcopy (temp, start2_addr, len1_byte);
3764 if (len1_byte > 20000)
3765 xfree (temp);
3766 graft_intervals_into_buffer (tmp_interval1, start2,
3767 len1, current_buffer, 0);
3768 graft_intervals_into_buffer (tmp_interval2, start1,
3769 len2, current_buffer, 0);
3772 else if (len1_byte < len2_byte) /* Second region larger than first */
3773 /* Non-adjacent & unequal size, area between must also be shifted. */
3775 modify_region (current_buffer, start1, end2);
3776 record_change (start1, (end2 - start1));
3777 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3778 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
3779 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3780 Fset_text_properties (make_number (start1), make_number (end2),
3781 Qnil, Qnil);
3783 /* holds region 2 */
3784 if (len2_byte > 20000)
3785 temp = (unsigned char *) xmalloc (len2_byte);
3786 else
3787 temp = (unsigned char *) alloca (len2_byte);
3788 start1_addr = BYTE_POS_ADDR (start1_byte);
3789 start2_addr = BYTE_POS_ADDR (start2_byte);
3790 bcopy (start2_addr, temp, len2_byte);
3791 bcopy (start1_addr, start1_addr + len_mid + len2_byte, len1_byte);
3792 safe_bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
3793 bcopy (temp, start1_addr, len2_byte);
3794 if (len2_byte > 20000)
3795 xfree (temp);
3796 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
3797 len1, current_buffer, 0);
3798 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
3799 len_mid, current_buffer, 0);
3800 graft_intervals_into_buffer (tmp_interval2, start1,
3801 len2, current_buffer, 0);
3803 else
3804 /* Second region smaller than first. */
3806 record_change (start1, (end2 - start1));
3807 modify_region (current_buffer, start1, end2);
3809 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
3810 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
3811 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
3812 Fset_text_properties (make_number (start1), make_number (end2),
3813 Qnil, Qnil);
3815 /* holds region 1 */
3816 if (len1_byte > 20000)
3817 temp = (unsigned char *) xmalloc (len1_byte);
3818 else
3819 temp = (unsigned char *) alloca (len1_byte);
3820 start1_addr = BYTE_POS_ADDR (start1_byte);
3821 start2_addr = BYTE_POS_ADDR (start2_byte);
3822 bcopy (start1_addr, temp, len1_byte);
3823 bcopy (start2_addr, start1_addr, len2_byte);
3824 bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
3825 bcopy (temp, start1_addr + len2_byte + len_mid, len1_byte);
3826 if (len1_byte > 20000)
3827 xfree (temp);
3828 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
3829 len1, current_buffer, 0);
3830 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
3831 len_mid, current_buffer, 0);
3832 graft_intervals_into_buffer (tmp_interval2, start1,
3833 len2, current_buffer, 0);
3836 update_compositions (start1, start1 + len2, CHECK_BORDER);
3837 update_compositions (end2 - len1, end2, CHECK_BORDER);
3840 /* When doing multiple transpositions, it might be nice
3841 to optimize this. Perhaps the markers in any one buffer
3842 should be organized in some sorted data tree. */
3843 if (NILP (leave_markers))
3845 transpose_markers (start1, end1, start2, end2,
3846 start1_byte, start1_byte + len1_byte,
3847 start2_byte, start2_byte + len2_byte);
3848 fix_overlays_in_range (start1, end2);
3851 return Qnil;
3855 void
3856 syms_of_editfns ()
3858 environbuf = 0;
3860 Qbuffer_access_fontify_functions
3861 = intern ("buffer-access-fontify-functions");
3862 staticpro (&Qbuffer_access_fontify_functions);
3864 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
3865 "Non-nil means.text motion commands don't notice fields.");
3866 Vinhibit_field_text_motion = Qnil;
3868 DEFVAR_LISP ("buffer-access-fontify-functions",
3869 &Vbuffer_access_fontify_functions,
3870 "List of functions called by `buffer-substring' to fontify if necessary.\n\
3871 Each function is called with two arguments which specify the range\n\
3872 of the buffer being accessed.");
3873 Vbuffer_access_fontify_functions = Qnil;
3876 Lisp_Object obuf;
3877 extern Lisp_Object Vprin1_to_string_buffer;
3878 obuf = Fcurrent_buffer ();
3879 /* Do this here, because init_buffer_once is too early--it won't work. */
3880 Fset_buffer (Vprin1_to_string_buffer);
3881 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
3882 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
3883 Qnil);
3884 Fset_buffer (obuf);
3887 DEFVAR_LISP ("buffer-access-fontified-property",
3888 &Vbuffer_access_fontified_property,
3889 "Property which (if non-nil) indicates text has been fontified.\n\
3890 `buffer-substring' need not call the `buffer-access-fontify-functions'\n\
3891 functions if all the text being accessed has this property.");
3892 Vbuffer_access_fontified_property = Qnil;
3894 DEFVAR_LISP ("system-name", &Vsystem_name,
3895 "The name of the machine Emacs is running on.");
3897 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
3898 "The full name of the user logged in.");
3900 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
3901 "The user's name, taken from environment variables if possible.");
3903 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
3904 "The user's name, based upon the real uid only.");
3906 defsubr (&Spropertize);
3907 defsubr (&Schar_equal);
3908 defsubr (&Sgoto_char);
3909 defsubr (&Sstring_to_char);
3910 defsubr (&Schar_to_string);
3911 defsubr (&Sbuffer_substring);
3912 defsubr (&Sbuffer_substring_no_properties);
3913 defsubr (&Sbuffer_string);
3915 defsubr (&Spoint_marker);
3916 defsubr (&Smark_marker);
3917 defsubr (&Spoint);
3918 defsubr (&Sregion_beginning);
3919 defsubr (&Sregion_end);
3921 staticpro (&Qfield);
3922 Qfield = intern ("field");
3923 staticpro (&Qboundary);
3924 Qboundary = intern ("boundary");
3925 defsubr (&Sfield_beginning);
3926 defsubr (&Sfield_end);
3927 defsubr (&Sfield_string);
3928 defsubr (&Sfield_string_no_properties);
3929 defsubr (&Sdelete_field);
3930 defsubr (&Sconstrain_to_field);
3932 defsubr (&Sline_beginning_position);
3933 defsubr (&Sline_end_position);
3935 /* defsubr (&Smark); */
3936 /* defsubr (&Sset_mark); */
3937 defsubr (&Ssave_excursion);
3938 defsubr (&Ssave_current_buffer);
3940 defsubr (&Sbufsize);
3941 defsubr (&Spoint_max);
3942 defsubr (&Spoint_min);
3943 defsubr (&Spoint_min_marker);
3944 defsubr (&Spoint_max_marker);
3945 defsubr (&Sgap_position);
3946 defsubr (&Sgap_size);
3947 defsubr (&Sposition_bytes);
3948 defsubr (&Sbyte_to_position);
3950 defsubr (&Sbobp);
3951 defsubr (&Seobp);
3952 defsubr (&Sbolp);
3953 defsubr (&Seolp);
3954 defsubr (&Sfollowing_char);
3955 defsubr (&Sprevious_char);
3956 defsubr (&Schar_after);
3957 defsubr (&Schar_before);
3958 defsubr (&Sinsert);
3959 defsubr (&Sinsert_before_markers);
3960 defsubr (&Sinsert_and_inherit);
3961 defsubr (&Sinsert_and_inherit_before_markers);
3962 defsubr (&Sinsert_char);
3964 defsubr (&Suser_login_name);
3965 defsubr (&Suser_real_login_name);
3966 defsubr (&Suser_uid);
3967 defsubr (&Suser_real_uid);
3968 defsubr (&Suser_full_name);
3969 defsubr (&Semacs_pid);
3970 defsubr (&Scurrent_time);
3971 defsubr (&Sformat_time_string);
3972 defsubr (&Sfloat_time);
3973 defsubr (&Sdecode_time);
3974 defsubr (&Sencode_time);
3975 defsubr (&Scurrent_time_string);
3976 defsubr (&Scurrent_time_zone);
3977 defsubr (&Sset_time_zone_rule);
3978 defsubr (&Ssystem_name);
3979 defsubr (&Smessage);
3980 defsubr (&Smessage_box);
3981 defsubr (&Smessage_or_box);
3982 defsubr (&Scurrent_message);
3983 defsubr (&Sformat);
3985 defsubr (&Sinsert_buffer_substring);
3986 defsubr (&Scompare_buffer_substrings);
3987 defsubr (&Ssubst_char_in_region);
3988 defsubr (&Stranslate_region);
3989 defsubr (&Sdelete_region);
3990 defsubr (&Sdelete_and_extract_region);
3991 defsubr (&Swiden);
3992 defsubr (&Snarrow_to_region);
3993 defsubr (&Ssave_restriction);
3994 defsubr (&Stranspose_regions);