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