(bookmark-handle-bookmark): Catch the right error.
[emacs.git] / src / editfns.c
blob093f141bff21d1ff35a41fc8a02d9ff98f7f40db
1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <sys/types.h>
24 #include <stdio.h>
25 #include <setjmp.h>
27 #ifdef HAVE_PWD_H
28 #include <pwd.h>
29 #endif
31 #ifdef HAVE_UNISTD_H
32 #include <unistd.h>
33 #endif
35 #ifdef HAVE_SYS_UTSNAME_H
36 #include <sys/utsname.h>
37 #endif
39 #include "lisp.h"
41 /* systime.h includes <sys/time.h> which, on some systems, is required
42 for <sys/resource.h>; thus systime.h must be included before
43 <sys/resource.h> */
44 #include "systime.h"
46 #if defined HAVE_SYS_RESOURCE_H
47 #include <sys/resource.h>
48 #endif
50 #include <ctype.h>
52 #include "intervals.h"
53 #include "buffer.h"
54 #include "character.h"
55 #include "coding.h"
56 #include "frame.h"
57 #include "window.h"
58 #include "blockinput.h"
60 #ifdef STDC_HEADERS
61 #include <float.h>
62 #define MAX_10_EXP DBL_MAX_10_EXP
63 #else
64 #define MAX_10_EXP 310
65 #endif
67 #ifndef NULL
68 #define NULL 0
69 #endif
71 #ifndef USER_FULL_NAME
72 #define USER_FULL_NAME pw->pw_gecos
73 #endif
75 #ifndef USE_CRT_DLL
76 extern char **environ;
77 #endif
79 #define TM_YEAR_BASE 1900
81 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
82 asctime to have well-defined behavior. */
83 #ifndef TM_YEAR_IN_ASCTIME_RANGE
84 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
85 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
86 #endif
88 extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
89 const struct tm *, int));
91 #ifdef WINDOWSNT
92 extern Lisp_Object w32_get_internal_run_time ();
93 #endif
95 static int tm_diff P_ ((struct tm *, struct tm *));
96 static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
97 static void update_buffer_properties P_ ((int, int));
98 static Lisp_Object region_limit P_ ((int));
99 int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
100 static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
101 size_t, const struct tm *, int));
102 static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
103 void (*) (Lisp_Object, EMACS_INT,
104 EMACS_INT, EMACS_INT,
105 EMACS_INT, int),
106 int, int, Lisp_Object *);
107 static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
108 static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
109 static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
111 #ifdef HAVE_INDEX
112 extern char *index P_ ((const char *, int));
113 #endif
115 Lisp_Object Vbuffer_access_fontify_functions;
116 Lisp_Object Qbuffer_access_fontify_functions;
117 Lisp_Object Vbuffer_access_fontified_property;
119 Lisp_Object Fuser_full_name P_ ((Lisp_Object));
121 /* Non-nil means don't stop at field boundary in text motion commands. */
123 Lisp_Object Vinhibit_field_text_motion;
125 /* Some static data, and a function to initialize it for each run */
127 Lisp_Object Vsystem_name;
128 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
129 Lisp_Object Vuser_full_name; /* full name of current user */
130 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER */
131 Lisp_Object Voperating_system_release; /* Operating System Release */
133 /* Symbol for the text property used to mark fields. */
135 Lisp_Object Qfield;
137 /* A special value for Qfield properties. */
139 Lisp_Object Qboundary;
142 void
143 init_editfns ()
145 char *user_name;
146 register unsigned char *p;
147 struct passwd *pw; /* password entry for the current user */
148 Lisp_Object tem;
150 /* Set up system_name even when dumping. */
151 init_system_name ();
153 #ifndef CANNOT_DUMP
154 /* Don't bother with this on initial start when just dumping out */
155 if (!initialized)
156 return;
157 #endif /* not CANNOT_DUMP */
159 pw = (struct passwd *) getpwuid (getuid ());
160 #ifdef MSDOS
161 /* We let the real user name default to "root" because that's quite
162 accurate on MSDOG and because it lets Emacs find the init file.
163 (The DVX libraries override the Djgpp libraries here.) */
164 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
165 #else
166 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
167 #endif
169 /* Get the effective user name, by consulting environment variables,
170 or the effective uid if those are unset. */
171 user_name = (char *) getenv ("LOGNAME");
172 if (!user_name)
173 #ifdef WINDOWSNT
174 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
175 #else /* WINDOWSNT */
176 user_name = (char *) getenv ("USER");
177 #endif /* WINDOWSNT */
178 if (!user_name)
180 pw = (struct passwd *) getpwuid (geteuid ());
181 user_name = (char *) (pw ? pw->pw_name : "unknown");
183 Vuser_login_name = build_string (user_name);
185 /* If the user name claimed in the environment vars differs from
186 the real uid, use the claimed name to find the full name. */
187 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
188 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
189 : Vuser_login_name);
191 p = (unsigned char *) getenv ("NAME");
192 if (p)
193 Vuser_full_name = build_string (p);
194 else if (NILP (Vuser_full_name))
195 Vuser_full_name = build_string ("unknown");
197 #ifdef HAVE_SYS_UTSNAME_H
199 struct utsname uts;
200 uname (&uts);
201 Voperating_system_release = build_string (uts.release);
203 #else
204 Voperating_system_release = Qnil;
205 #endif
208 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
209 doc: /* Convert arg CHAR to a string containing that character.
210 usage: (char-to-string CHAR) */)
211 (character)
212 Lisp_Object character;
214 int len;
215 unsigned char str[MAX_MULTIBYTE_LENGTH];
217 CHECK_CHARACTER (character);
219 len = CHAR_STRING (XFASTINT (character), str);
220 return make_string_from_bytes (str, 1, len);
223 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
224 doc: /* Convert arg STRING to a character, the first character of that string.
225 A multibyte character is handled correctly. */)
226 (string)
227 register Lisp_Object string;
229 register Lisp_Object val;
230 CHECK_STRING (string);
231 if (SCHARS (string))
233 if (STRING_MULTIBYTE (string))
234 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
235 else
236 XSETFASTINT (val, SREF (string, 0));
238 else
239 XSETFASTINT (val, 0);
240 return val;
243 static Lisp_Object
244 buildmark (charpos, bytepos)
245 int charpos, bytepos;
247 register Lisp_Object mark;
248 mark = Fmake_marker ();
249 set_marker_both (mark, Qnil, charpos, bytepos);
250 return mark;
253 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
254 doc: /* Return value of point, as an integer.
255 Beginning of buffer is position (point-min). */)
258 Lisp_Object temp;
259 XSETFASTINT (temp, PT);
260 return temp;
263 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
264 doc: /* Return value of point, as a marker object. */)
267 return buildmark (PT, PT_BYTE);
271 clip_to_bounds (lower, num, upper)
272 int lower, num, upper;
274 if (num < lower)
275 return lower;
276 else if (num > upper)
277 return upper;
278 else
279 return num;
282 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
283 doc: /* Set point to POSITION, a number or marker.
284 Beginning of buffer is position (point-min), end is (point-max).
286 The return value is POSITION. */)
287 (position)
288 register Lisp_Object position;
290 int pos;
292 if (MARKERP (position)
293 && current_buffer == XMARKER (position)->buffer)
295 pos = marker_position (position);
296 if (pos < BEGV)
297 SET_PT_BOTH (BEGV, BEGV_BYTE);
298 else if (pos > ZV)
299 SET_PT_BOTH (ZV, ZV_BYTE);
300 else
301 SET_PT_BOTH (pos, marker_byte_position (position));
303 return position;
306 CHECK_NUMBER_COERCE_MARKER (position);
308 pos = clip_to_bounds (BEGV, XINT (position), ZV);
309 SET_PT (pos);
310 return position;
314 /* Return the start or end position of the region.
315 BEGINNINGP non-zero means return the start.
316 If there is no region active, signal an error. */
318 static Lisp_Object
319 region_limit (beginningp)
320 int beginningp;
322 extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
323 Lisp_Object m;
325 if (!NILP (Vtransient_mark_mode)
326 && NILP (Vmark_even_if_inactive)
327 && NILP (current_buffer->mark_active))
328 xsignal0 (Qmark_inactive);
330 m = Fmarker_position (current_buffer->mark);
331 if (NILP (m))
332 error ("The mark is not set now, so there is no region");
334 if ((PT < XFASTINT (m)) == (beginningp != 0))
335 m = make_number (PT);
336 return m;
339 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
340 doc: /* Return position of beginning of region, as an integer. */)
343 return region_limit (1);
346 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
347 doc: /* Return position of end of region, as an integer. */)
350 return region_limit (0);
353 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
354 doc: /* Return this buffer's mark, as a marker object.
355 Watch out! Moving this marker changes the mark position.
356 If you set the marker not to point anywhere, the buffer will have no mark. */)
359 return current_buffer->mark;
363 /* Find all the overlays in the current buffer that touch position POS.
364 Return the number found, and store them in a vector in VEC
365 of length LEN. */
367 static int
368 overlays_around (pos, vec, len)
369 int pos;
370 Lisp_Object *vec;
371 int len;
373 Lisp_Object overlay, start, end;
374 struct Lisp_Overlay *tail;
375 int startpos, endpos;
376 int idx = 0;
378 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
380 XSETMISC (overlay, tail);
382 end = OVERLAY_END (overlay);
383 endpos = OVERLAY_POSITION (end);
384 if (endpos < pos)
385 break;
386 start = OVERLAY_START (overlay);
387 startpos = OVERLAY_POSITION (start);
388 if (startpos <= pos)
390 if (idx < len)
391 vec[idx] = overlay;
392 /* Keep counting overlays even if we can't return them all. */
393 idx++;
397 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
399 XSETMISC (overlay, tail);
401 start = OVERLAY_START (overlay);
402 startpos = OVERLAY_POSITION (start);
403 if (pos < startpos)
404 break;
405 end = OVERLAY_END (overlay);
406 endpos = OVERLAY_POSITION (end);
407 if (pos <= endpos)
409 if (idx < len)
410 vec[idx] = overlay;
411 idx++;
415 return idx;
418 /* Return the value of property PROP, in OBJECT at POSITION.
419 It's the value of PROP that a char inserted at POSITION would get.
420 OBJECT is optional and defaults to the current buffer.
421 If OBJECT is a buffer, then overlay properties are considered as well as
422 text properties.
423 If OBJECT is a window, then that window's buffer is used, but
424 window-specific overlays are considered only if they are associated
425 with OBJECT. */
426 Lisp_Object
427 get_pos_property (position, prop, object)
428 Lisp_Object position, object;
429 register Lisp_Object prop;
431 CHECK_NUMBER_COERCE_MARKER (position);
433 if (NILP (object))
434 XSETBUFFER (object, current_buffer);
435 else if (WINDOWP (object))
436 object = XWINDOW (object)->buffer;
438 if (!BUFFERP (object))
439 /* pos-property only makes sense in buffers right now, since strings
440 have no overlays and no notion of insertion for which stickiness
441 could be obeyed. */
442 return Fget_text_property (position, prop, object);
443 else
445 int posn = XINT (position);
446 int noverlays;
447 Lisp_Object *overlay_vec, tem;
448 struct buffer *obuf = current_buffer;
450 set_buffer_temp (XBUFFER (object));
452 /* First try with room for 40 overlays. */
453 noverlays = 40;
454 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
455 noverlays = overlays_around (posn, overlay_vec, noverlays);
457 /* If there are more than 40,
458 make enough space for all, and try again. */
459 if (noverlays > 40)
461 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
462 noverlays = overlays_around (posn, overlay_vec, noverlays);
464 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
466 set_buffer_temp (obuf);
468 /* Now check the overlays in order of decreasing priority. */
469 while (--noverlays >= 0)
471 Lisp_Object ol = overlay_vec[noverlays];
472 tem = Foverlay_get (ol, prop);
473 if (!NILP (tem))
475 /* Check the overlay is indeed active at point. */
476 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
477 if ((OVERLAY_POSITION (start) == posn
478 && XMARKER (start)->insertion_type == 1)
479 || (OVERLAY_POSITION (finish) == posn
480 && XMARKER (finish)->insertion_type == 0))
481 ; /* The overlay will not cover a char inserted at point. */
482 else
484 return tem;
489 { /* Now check the text properties. */
490 int stickiness = text_property_stickiness (prop, position, object);
491 if (stickiness > 0)
492 return Fget_text_property (position, prop, object);
493 else if (stickiness < 0
494 && XINT (position) > BUF_BEGV (XBUFFER (object)))
495 return Fget_text_property (make_number (XINT (position) - 1),
496 prop, object);
497 else
498 return Qnil;
503 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
504 the value of point is used instead. If BEG or END is null,
505 means don't store the beginning or end of the field.
507 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
508 results; they do not effect boundary behavior.
510 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
511 position of a field, then the beginning of the previous field is
512 returned instead of the beginning of POS's field (since the end of a
513 field is actually also the beginning of the next input field, this
514 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
515 true case, if two fields are separated by a field with the special
516 value `boundary', and POS lies within it, then the two separated
517 fields are considered to be adjacent, and POS between them, when
518 finding the beginning and ending of the "merged" field.
520 Either BEG or END may be 0, in which case the corresponding value
521 is not stored. */
523 static void
524 find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
525 Lisp_Object pos;
526 Lisp_Object merge_at_boundary;
527 Lisp_Object beg_limit, end_limit;
528 int *beg, *end;
530 /* Fields right before and after the point. */
531 Lisp_Object before_field, after_field;
532 /* 1 if POS counts as the start of a field. */
533 int at_field_start = 0;
534 /* 1 if POS counts as the end of a field. */
535 int at_field_end = 0;
537 if (NILP (pos))
538 XSETFASTINT (pos, PT);
539 else
540 CHECK_NUMBER_COERCE_MARKER (pos);
542 after_field
543 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
544 before_field
545 = (XFASTINT (pos) > BEGV
546 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
547 Qfield, Qnil, NULL)
548 /* Using nil here would be a more obvious choice, but it would
549 fail when the buffer starts with a non-sticky field. */
550 : after_field);
552 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
553 and POS is at beginning of a field, which can also be interpreted
554 as the end of the previous field. Note that the case where if
555 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
556 more natural one; then we avoid treating the beginning of a field
557 specially. */
558 if (NILP (merge_at_boundary))
560 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
561 if (!EQ (field, after_field))
562 at_field_end = 1;
563 if (!EQ (field, before_field))
564 at_field_start = 1;
565 if (NILP (field) && at_field_start && at_field_end)
566 /* If an inserted char would have a nil field while the surrounding
567 text is non-nil, we're probably not looking at a
568 zero-length field, but instead at a non-nil field that's
569 not intended for editing (such as comint's prompts). */
570 at_field_end = at_field_start = 0;
573 /* Note about special `boundary' fields:
575 Consider the case where the point (`.') is between the fields `x' and `y':
577 xxxx.yyyy
579 In this situation, if merge_at_boundary is true, we consider the
580 `x' and `y' fields as forming one big merged field, and so the end
581 of the field is the end of `y'.
583 However, if `x' and `y' are separated by a special `boundary' field
584 (a field with a `field' char-property of 'boundary), then we ignore
585 this special field when merging adjacent fields. Here's the same
586 situation, but with a `boundary' field between the `x' and `y' fields:
588 xxx.BBBByyyy
590 Here, if point is at the end of `x', the beginning of `y', or
591 anywhere in-between (within the `boundary' field), we merge all
592 three fields and consider the beginning as being the beginning of
593 the `x' field, and the end as being the end of the `y' field. */
595 if (beg)
597 if (at_field_start)
598 /* POS is at the edge of a field, and we should consider it as
599 the beginning of the following field. */
600 *beg = XFASTINT (pos);
601 else
602 /* Find the previous field boundary. */
604 Lisp_Object p = pos;
605 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
606 /* Skip a `boundary' field. */
607 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
608 beg_limit);
610 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
611 beg_limit);
612 *beg = NILP (p) ? BEGV : XFASTINT (p);
616 if (end)
618 if (at_field_end)
619 /* POS is at the edge of a field, and we should consider it as
620 the end of the previous field. */
621 *end = XFASTINT (pos);
622 else
623 /* Find the next field boundary. */
625 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
626 /* Skip a `boundary' field. */
627 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
628 end_limit);
630 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
631 end_limit);
632 *end = NILP (pos) ? ZV : XFASTINT (pos);
638 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
639 doc: /* Delete the field surrounding POS.
640 A field is a region of text with the same `field' property.
641 If POS is nil, the value of point is used for POS. */)
642 (pos)
643 Lisp_Object pos;
645 int beg, end;
646 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
647 if (beg != end)
648 del_range (beg, end);
649 return Qnil;
652 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
653 doc: /* Return the contents of the field surrounding POS as a string.
654 A field is a region of text with the same `field' property.
655 If POS is nil, the value of point is used for POS. */)
656 (pos)
657 Lisp_Object pos;
659 int beg, end;
660 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
661 return make_buffer_string (beg, end, 1);
664 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
665 doc: /* Return the contents of the field around POS, without text properties.
666 A field is a region of text with the same `field' property.
667 If POS is nil, the value of point is used for POS. */)
668 (pos)
669 Lisp_Object pos;
671 int beg, end;
672 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
673 return make_buffer_string (beg, end, 0);
676 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
677 doc: /* Return the beginning of the field surrounding POS.
678 A field is a region of text with the same `field' property.
679 If POS is nil, the value of point is used for POS.
680 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
681 field, then the beginning of the *previous* field is returned.
682 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
683 is before LIMIT, then LIMIT will be returned instead. */)
684 (pos, escape_from_edge, limit)
685 Lisp_Object pos, escape_from_edge, limit;
687 int beg;
688 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
689 return make_number (beg);
692 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
693 doc: /* Return the end of the field surrounding POS.
694 A field is a region of text with the same `field' property.
695 If POS is nil, the value of point is used for POS.
696 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
697 then the end of the *following* field is returned.
698 If LIMIT is non-nil, it is a buffer position; if the end of the field
699 is after LIMIT, then LIMIT will be returned instead. */)
700 (pos, escape_from_edge, limit)
701 Lisp_Object pos, escape_from_edge, limit;
703 int end;
704 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
705 return make_number (end);
708 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
709 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
711 A field is a region of text with the same `field' property.
712 If NEW-POS is nil, then the current point is used instead, and set to the
713 constrained position if that is different.
715 If OLD-POS is at the boundary of two fields, then the allowable
716 positions for NEW-POS depends on the value of the optional argument
717 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
718 constrained to the field that has the same `field' char-property
719 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
720 is non-nil, NEW-POS is constrained to the union of the two adjacent
721 fields. Additionally, if two fields are separated by another field with
722 the special value `boundary', then any point within this special field is
723 also considered to be `on the boundary'.
725 If the optional argument ONLY-IN-LINE is non-nil and constraining
726 NEW-POS would move it to a different line, NEW-POS is returned
727 unconstrained. This useful for commands that move by line, like
728 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
729 only in the case where they can still move to the right line.
731 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
732 a non-nil property of that name, then any field boundaries are ignored.
734 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
735 (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
736 Lisp_Object new_pos, old_pos;
737 Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
739 /* If non-zero, then the original point, before re-positioning. */
740 int orig_point = 0;
741 int fwd;
742 Lisp_Object prev_old, prev_new;
744 if (NILP (new_pos))
745 /* Use the current point, and afterwards, set it. */
747 orig_point = PT;
748 XSETFASTINT (new_pos, PT);
751 CHECK_NUMBER_COERCE_MARKER (new_pos);
752 CHECK_NUMBER_COERCE_MARKER (old_pos);
754 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
756 prev_old = make_number (XFASTINT (old_pos) - 1);
757 prev_new = make_number (XFASTINT (new_pos) - 1);
759 if (NILP (Vinhibit_field_text_motion)
760 && !EQ (new_pos, old_pos)
761 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
762 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
763 /* To recognize field boundaries, we must also look at the
764 previous positions; we could use `get_pos_property'
765 instead, but in itself that would fail inside non-sticky
766 fields (like comint prompts). */
767 || (XFASTINT (new_pos) > BEGV
768 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
769 || (XFASTINT (old_pos) > BEGV
770 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
771 && (NILP (inhibit_capture_property)
772 /* Field boundaries are again a problem; but now we must
773 decide the case exactly, so we need to call
774 `get_pos_property' as well. */
775 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
776 && (XFASTINT (old_pos) <= BEGV
777 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
778 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
779 /* It is possible that NEW_POS is not within the same field as
780 OLD_POS; try to move NEW_POS so that it is. */
782 int shortage;
783 Lisp_Object field_bound;
785 if (fwd)
786 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
787 else
788 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
790 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
791 other side of NEW_POS, which would mean that NEW_POS is
792 already acceptable, and it's not necessary to constrain it
793 to FIELD_BOUND. */
794 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
795 /* NEW_POS should be constrained, but only if either
796 ONLY_IN_LINE is nil (in which case any constraint is OK),
797 or NEW_POS and FIELD_BOUND are on the same line (in which
798 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
799 && (NILP (only_in_line)
800 /* This is the ONLY_IN_LINE case, check that NEW_POS and
801 FIELD_BOUND are on the same line by seeing whether
802 there's an intervening newline or not. */
803 || (scan_buffer ('\n',
804 XFASTINT (new_pos), XFASTINT (field_bound),
805 fwd ? -1 : 1, &shortage, 1),
806 shortage != 0)))
807 /* Constrain NEW_POS to FIELD_BOUND. */
808 new_pos = field_bound;
810 if (orig_point && XFASTINT (new_pos) != orig_point)
811 /* The NEW_POS argument was originally nil, so automatically set PT. */
812 SET_PT (XFASTINT (new_pos));
815 return new_pos;
819 DEFUN ("line-beginning-position",
820 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
821 doc: /* Return the character position of the first character on the current line.
822 With argument N not nil or 1, move forward N - 1 lines first.
823 If scan reaches end of buffer, return that position.
825 This function constrains the returned position to the current field
826 unless that would be on a different line than the original,
827 unconstrained result. If N is nil or 1, and a front-sticky field
828 starts at point, the scan stops as soon as it starts. To ignore field
829 boundaries bind `inhibit-field-text-motion' to t.
831 This function does not move point. */)
833 Lisp_Object n;
835 int orig, orig_byte, end;
836 int count = SPECPDL_INDEX ();
837 specbind (Qinhibit_point_motion_hooks, Qt);
839 if (NILP (n))
840 XSETFASTINT (n, 1);
841 else
842 CHECK_NUMBER (n);
844 orig = PT;
845 orig_byte = PT_BYTE;
846 Fforward_line (make_number (XINT (n) - 1));
847 end = PT;
849 SET_PT_BOTH (orig, orig_byte);
851 unbind_to (count, Qnil);
853 /* Return END constrained to the current input field. */
854 return Fconstrain_to_field (make_number (end), make_number (orig),
855 XINT (n) != 1 ? Qt : Qnil,
856 Qt, Qnil);
859 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
860 doc: /* Return the character position of the last character on the current line.
861 With argument N not nil or 1, move forward N - 1 lines first.
862 If scan reaches end of buffer, return that position.
864 This function constrains the returned position to the current field
865 unless that would be on a different line than the original,
866 unconstrained result. If N is nil or 1, and a rear-sticky field ends
867 at point, the scan stops as soon as it starts. To ignore field
868 boundaries bind `inhibit-field-text-motion' to t.
870 This function does not move point. */)
872 Lisp_Object n;
874 int end_pos;
875 int orig = PT;
877 if (NILP (n))
878 XSETFASTINT (n, 1);
879 else
880 CHECK_NUMBER (n);
882 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
884 /* Return END_POS constrained to the current input field. */
885 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
886 Qnil, Qt, Qnil);
890 Lisp_Object
891 save_excursion_save ()
893 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
894 == current_buffer);
896 return Fcons (Fpoint_marker (),
897 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
898 Fcons (visible ? Qt : Qnil,
899 Fcons (current_buffer->mark_active,
900 selected_window))));
903 Lisp_Object
904 save_excursion_restore (info)
905 Lisp_Object info;
907 Lisp_Object tem, tem1, omark, nmark;
908 struct gcpro gcpro1, gcpro2, gcpro3;
909 int visible_p;
911 tem = Fmarker_buffer (XCAR (info));
912 /* If buffer being returned to is now deleted, avoid error */
913 /* Otherwise could get error here while unwinding to top level
914 and crash */
915 /* In that case, Fmarker_buffer returns nil now. */
916 if (NILP (tem))
917 return Qnil;
919 omark = nmark = Qnil;
920 GCPRO3 (info, omark, nmark);
922 Fset_buffer (tem);
924 /* Point marker. */
925 tem = XCAR (info);
926 Fgoto_char (tem);
927 unchain_marker (XMARKER (tem));
929 /* Mark marker. */
930 info = XCDR (info);
931 tem = XCAR (info);
932 omark = Fmarker_position (current_buffer->mark);
933 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
934 nmark = Fmarker_position (tem);
935 unchain_marker (XMARKER (tem));
937 /* visible */
938 info = XCDR (info);
939 visible_p = !NILP (XCAR (info));
941 #if 0 /* We used to make the current buffer visible in the selected window
942 if that was true previously. That avoids some anomalies.
943 But it creates others, and it wasn't documented, and it is simpler
944 and cleaner never to alter the window/buffer connections. */
945 tem1 = Fcar (tem);
946 if (!NILP (tem1)
947 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
948 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
949 #endif /* 0 */
951 /* Mark active */
952 info = XCDR (info);
953 tem = XCAR (info);
954 tem1 = current_buffer->mark_active;
955 current_buffer->mark_active = tem;
957 if (!NILP (Vrun_hooks))
959 /* If mark is active now, and either was not active
960 or was at a different place, run the activate hook. */
961 if (! NILP (current_buffer->mark_active))
963 if (! EQ (omark, nmark))
964 call1 (Vrun_hooks, intern ("activate-mark-hook"));
966 /* If mark has ceased to be active, run deactivate hook. */
967 else if (! NILP (tem1))
968 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
971 /* If buffer was visible in a window, and a different window was
972 selected, and the old selected window is still showing this
973 buffer, restore point in that window. */
974 tem = XCDR (info);
975 if (visible_p
976 && !EQ (tem, selected_window)
977 && (tem1 = XWINDOW (tem)->buffer,
978 (/* Window is live... */
979 BUFFERP (tem1)
980 /* ...and it shows the current buffer. */
981 && XBUFFER (tem1) == current_buffer)))
982 Fset_window_point (tem, make_number (PT));
984 UNGCPRO;
985 return Qnil;
988 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
989 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
990 Executes BODY just like `progn'.
991 The values of point, mark and the current buffer are restored
992 even in case of abnormal exit (throw or error).
993 The state of activation of the mark is also restored.
995 This construct does not save `deactivate-mark', and therefore
996 functions that change the buffer will still cause deactivation
997 of the mark at the end of the command. To prevent that, bind
998 `deactivate-mark' with `let'.
1000 If you only want to save the current buffer but not point nor mark,
1001 then just use `save-current-buffer', or even `with-current-buffer'.
1003 usage: (save-excursion &rest BODY) */)
1004 (args)
1005 Lisp_Object args;
1007 register Lisp_Object val;
1008 int count = SPECPDL_INDEX ();
1010 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1012 val = Fprogn (args);
1013 return unbind_to (count, val);
1016 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1017 doc: /* Save the current buffer; execute BODY; restore the current buffer.
1018 Executes BODY just like `progn'.
1019 usage: (save-current-buffer &rest BODY) */)
1020 (args)
1021 Lisp_Object args;
1023 Lisp_Object val;
1024 int count = SPECPDL_INDEX ();
1026 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1028 val = Fprogn (args);
1029 return unbind_to (count, val);
1032 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1033 doc: /* Return the number of characters in the current buffer.
1034 If BUFFER, return the number of characters in that buffer instead. */)
1035 (buffer)
1036 Lisp_Object buffer;
1038 if (NILP (buffer))
1039 return make_number (Z - BEG);
1040 else
1042 CHECK_BUFFER (buffer);
1043 return make_number (BUF_Z (XBUFFER (buffer))
1044 - BUF_BEG (XBUFFER (buffer)));
1048 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1049 doc: /* Return the minimum permissible value of point in the current buffer.
1050 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1053 Lisp_Object temp;
1054 XSETFASTINT (temp, BEGV);
1055 return temp;
1058 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1059 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1060 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1063 return buildmark (BEGV, BEGV_BYTE);
1066 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1067 doc: /* Return the maximum permissible value of point in the current buffer.
1068 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1069 is in effect, in which case it is less. */)
1072 Lisp_Object temp;
1073 XSETFASTINT (temp, ZV);
1074 return temp;
1077 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1078 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1079 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1080 is in effect, in which case it is less. */)
1083 return buildmark (ZV, ZV_BYTE);
1086 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1087 doc: /* Return the position of the gap, in the current buffer.
1088 See also `gap-size'. */)
1091 Lisp_Object temp;
1092 XSETFASTINT (temp, GPT);
1093 return temp;
1096 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1097 doc: /* Return the size of the current buffer's gap.
1098 See also `gap-position'. */)
1101 Lisp_Object temp;
1102 XSETFASTINT (temp, GAP_SIZE);
1103 return temp;
1106 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1107 doc: /* Return the byte position for character position POSITION.
1108 If POSITION is out of range, the value is nil. */)
1109 (position)
1110 Lisp_Object position;
1112 CHECK_NUMBER_COERCE_MARKER (position);
1113 if (XINT (position) < BEG || XINT (position) > Z)
1114 return Qnil;
1115 return make_number (CHAR_TO_BYTE (XINT (position)));
1118 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1119 doc: /* Return the character position for byte position BYTEPOS.
1120 If BYTEPOS is out of range, the value is nil. */)
1121 (bytepos)
1122 Lisp_Object bytepos;
1124 CHECK_NUMBER (bytepos);
1125 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1126 return Qnil;
1127 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1130 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1131 doc: /* Return the character following point, as a number.
1132 At the end of the buffer or accessible region, return 0. */)
1135 Lisp_Object temp;
1136 if (PT >= ZV)
1137 XSETFASTINT (temp, 0);
1138 else
1139 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1140 return temp;
1143 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1144 doc: /* Return the character preceding point, as a number.
1145 At the beginning of the buffer or accessible region, return 0. */)
1148 Lisp_Object temp;
1149 if (PT <= BEGV)
1150 XSETFASTINT (temp, 0);
1151 else if (!NILP (current_buffer->enable_multibyte_characters))
1153 int pos = PT_BYTE;
1154 DEC_POS (pos);
1155 XSETFASTINT (temp, FETCH_CHAR (pos));
1157 else
1158 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1159 return temp;
1162 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1163 doc: /* Return t if point is at the beginning of the buffer.
1164 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1167 if (PT == BEGV)
1168 return Qt;
1169 return Qnil;
1172 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1173 doc: /* Return t if point is at the end of the buffer.
1174 If the buffer is narrowed, this means the end of the narrowed part. */)
1177 if (PT == ZV)
1178 return Qt;
1179 return Qnil;
1182 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1183 doc: /* Return t if point is at the beginning of a line. */)
1186 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1187 return Qt;
1188 return Qnil;
1191 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1192 doc: /* Return t if point is at the end of a line.
1193 `End of a line' includes point being at the end of the buffer. */)
1196 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1197 return Qt;
1198 return Qnil;
1201 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1202 doc: /* Return character in current buffer at position POS.
1203 POS is an integer or a marker and defaults to point.
1204 If POS is out of range, the value is nil. */)
1205 (pos)
1206 Lisp_Object pos;
1208 register int pos_byte;
1210 if (NILP (pos))
1212 pos_byte = PT_BYTE;
1213 XSETFASTINT (pos, PT);
1216 if (MARKERP (pos))
1218 pos_byte = marker_byte_position (pos);
1219 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1220 return Qnil;
1222 else
1224 CHECK_NUMBER_COERCE_MARKER (pos);
1225 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1226 return Qnil;
1228 pos_byte = CHAR_TO_BYTE (XINT (pos));
1231 return make_number (FETCH_CHAR (pos_byte));
1234 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1235 doc: /* Return character in current buffer preceding position POS.
1236 POS is an integer or a marker and defaults to point.
1237 If POS is out of range, the value is nil. */)
1238 (pos)
1239 Lisp_Object pos;
1241 register Lisp_Object val;
1242 register int pos_byte;
1244 if (NILP (pos))
1246 pos_byte = PT_BYTE;
1247 XSETFASTINT (pos, PT);
1250 if (MARKERP (pos))
1252 pos_byte = marker_byte_position (pos);
1254 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1255 return Qnil;
1257 else
1259 CHECK_NUMBER_COERCE_MARKER (pos);
1261 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1262 return Qnil;
1264 pos_byte = CHAR_TO_BYTE (XINT (pos));
1267 if (!NILP (current_buffer->enable_multibyte_characters))
1269 DEC_POS (pos_byte);
1270 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1272 else
1274 pos_byte--;
1275 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1277 return val;
1280 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1281 doc: /* Return the name under which the user logged in, as a string.
1282 This is based on the effective uid, not the real uid.
1283 Also, if the environment variables LOGNAME or USER are set,
1284 that determines the value of this function.
1286 If optional argument UID is an integer or a float, return the login name
1287 of the user with that uid, or nil if there is no such user. */)
1288 (uid)
1289 Lisp_Object uid;
1291 struct passwd *pw;
1292 uid_t id;
1294 /* Set up the user name info if we didn't do it before.
1295 (That can happen if Emacs is dumpable
1296 but you decide to run `temacs -l loadup' and not dump. */
1297 if (INTEGERP (Vuser_login_name))
1298 init_editfns ();
1300 if (NILP (uid))
1301 return Vuser_login_name;
1303 id = (uid_t)XFLOATINT (uid);
1304 BLOCK_INPUT;
1305 pw = (struct passwd *) getpwuid (id);
1306 UNBLOCK_INPUT;
1307 return (pw ? build_string (pw->pw_name) : Qnil);
1310 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1311 0, 0, 0,
1312 doc: /* Return the name of the user's real uid, as a string.
1313 This ignores the environment variables LOGNAME and USER, so it differs from
1314 `user-login-name' when running under `su'. */)
1317 /* Set up the user name info if we didn't do it before.
1318 (That can happen if Emacs is dumpable
1319 but you decide to run `temacs -l loadup' and not dump. */
1320 if (INTEGERP (Vuser_login_name))
1321 init_editfns ();
1322 return Vuser_real_login_name;
1325 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1326 doc: /* Return the effective uid of Emacs.
1327 Value is an integer or a float, depending on the value. */)
1330 /* Assignment to EMACS_INT stops GCC whining about limited range of
1331 data type. */
1332 EMACS_INT euid = geteuid ();
1334 /* Make sure we don't produce a negative UID due to signed integer
1335 overflow. */
1336 if (euid < 0)
1337 return make_float ((double)geteuid ());
1338 return make_fixnum_or_float (euid);
1341 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1342 doc: /* Return the real uid of Emacs.
1343 Value is an integer or a float, depending on the value. */)
1346 /* Assignment to EMACS_INT stops GCC whining about limited range of
1347 data type. */
1348 EMACS_INT uid = getuid ();
1350 /* Make sure we don't produce a negative UID due to signed integer
1351 overflow. */
1352 if (uid < 0)
1353 return make_float ((double)getuid ());
1354 return make_fixnum_or_float (uid);
1357 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1358 doc: /* Return the full name of the user logged in, as a string.
1359 If the full name corresponding to Emacs's userid is not known,
1360 return "unknown".
1362 If optional argument UID is an integer or float, return the full name
1363 of the user with that uid, or nil if there is no such user.
1364 If UID is a string, return the full name of the user with that login
1365 name, or nil if there is no such user. */)
1366 (uid)
1367 Lisp_Object uid;
1369 struct passwd *pw;
1370 register unsigned char *p, *q;
1371 Lisp_Object full;
1373 if (NILP (uid))
1374 return Vuser_full_name;
1375 else if (NUMBERP (uid))
1377 BLOCK_INPUT;
1378 pw = (struct passwd *) getpwuid ((uid_t) XFLOATINT (uid));
1379 UNBLOCK_INPUT;
1381 else if (STRINGP (uid))
1383 BLOCK_INPUT;
1384 pw = (struct passwd *) getpwnam (SDATA (uid));
1385 UNBLOCK_INPUT;
1387 else
1388 error ("Invalid UID specification");
1390 if (!pw)
1391 return Qnil;
1393 p = (unsigned char *) USER_FULL_NAME;
1394 /* Chop off everything after the first comma. */
1395 q = (unsigned char *) index (p, ',');
1396 full = make_string (p, q ? q - p : strlen (p));
1398 #ifdef AMPERSAND_FULL_NAME
1399 p = SDATA (full);
1400 q = (unsigned char *) index (p, '&');
1401 /* Substitute the login name for the &, upcasing the first character. */
1402 if (q)
1404 register unsigned char *r;
1405 Lisp_Object login;
1407 login = Fuser_login_name (make_number (pw->pw_uid));
1408 r = (unsigned char *) alloca (strlen (p) + SCHARS (login) + 1);
1409 bcopy (p, r, q - p);
1410 r[q - p] = 0;
1411 strcat (r, SDATA (login));
1412 r[q - p] = UPCASE (r[q - p]);
1413 strcat (r, q + 1);
1414 full = build_string (r);
1416 #endif /* AMPERSAND_FULL_NAME */
1418 return full;
1421 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1422 doc: /* Return the host name of the machine you are running on, as a string. */)
1425 return Vsystem_name;
1428 /* For the benefit of callers who don't want to include lisp.h */
1430 char *
1431 get_system_name ()
1433 if (STRINGP (Vsystem_name))
1434 return (char *) SDATA (Vsystem_name);
1435 else
1436 return "";
1439 char *
1440 get_operating_system_release()
1442 if (STRINGP (Voperating_system_release))
1443 return (char *) SDATA (Voperating_system_release);
1444 else
1445 return "";
1448 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1449 doc: /* Return the process ID of Emacs, as an integer. */)
1452 return make_number (getpid ());
1455 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1456 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1457 The time is returned as a list of three integers. The first has the
1458 most significant 16 bits of the seconds, while the second has the
1459 least significant 16 bits. The third integer gives the microsecond
1460 count.
1462 The microsecond count is zero on systems that do not provide
1463 resolution finer than a second. */)
1466 EMACS_TIME t;
1468 EMACS_GET_TIME (t);
1469 return list3 (make_number ((EMACS_SECS (t) >> 16) & 0xffff),
1470 make_number ((EMACS_SECS (t) >> 0) & 0xffff),
1471 make_number (EMACS_USECS (t)));
1474 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1475 0, 0, 0,
1476 doc: /* Return the current run time used by Emacs.
1477 The time is returned as a list of three integers. The first has the
1478 most significant 16 bits of the seconds, while the second has the
1479 least significant 16 bits. The third integer gives the microsecond
1480 count.
1482 On systems that can't determine the run time, `get-internal-run-time'
1483 does the same thing as `current-time'. The microsecond count is zero
1484 on systems that do not provide resolution finer than a second. */)
1487 #ifdef HAVE_GETRUSAGE
1488 struct rusage usage;
1489 int secs, usecs;
1491 if (getrusage (RUSAGE_SELF, &usage) < 0)
1492 /* This shouldn't happen. What action is appropriate? */
1493 xsignal0 (Qerror);
1495 /* Sum up user time and system time. */
1496 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1497 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1498 if (usecs >= 1000000)
1500 usecs -= 1000000;
1501 secs++;
1504 return list3 (make_number ((secs >> 16) & 0xffff),
1505 make_number ((secs >> 0) & 0xffff),
1506 make_number (usecs));
1507 #else /* ! HAVE_GETRUSAGE */
1508 #ifdef WINDOWSNT
1509 return w32_get_internal_run_time ();
1510 #else /* ! WINDOWSNT */
1511 return Fcurrent_time ();
1512 #endif /* WINDOWSNT */
1513 #endif /* HAVE_GETRUSAGE */
1518 lisp_time_argument (specified_time, result, usec)
1519 Lisp_Object specified_time;
1520 time_t *result;
1521 int *usec;
1523 if (NILP (specified_time))
1525 if (usec)
1527 EMACS_TIME t;
1529 EMACS_GET_TIME (t);
1530 *usec = EMACS_USECS (t);
1531 *result = EMACS_SECS (t);
1532 return 1;
1534 else
1535 return time (result) != -1;
1537 else
1539 Lisp_Object high, low;
1540 high = Fcar (specified_time);
1541 CHECK_NUMBER (high);
1542 low = Fcdr (specified_time);
1543 if (CONSP (low))
1545 if (usec)
1547 Lisp_Object usec_l = Fcdr (low);
1548 if (CONSP (usec_l))
1549 usec_l = Fcar (usec_l);
1550 if (NILP (usec_l))
1551 *usec = 0;
1552 else
1554 CHECK_NUMBER (usec_l);
1555 *usec = XINT (usec_l);
1558 low = Fcar (low);
1560 else if (usec)
1561 *usec = 0;
1562 CHECK_NUMBER (low);
1563 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1564 return *result >> 16 == XINT (high);
1568 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1569 doc: /* Return the current time, as a float number of seconds since the epoch.
1570 If SPECIFIED-TIME is given, it is the time to convert to float
1571 instead of the current time. The argument should have the form
1572 (HIGH LOW) or (HIGH LOW USEC). Thus, you can use times obtained from
1573 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1574 have the form (HIGH . LOW), but this is considered obsolete.
1576 WARNING: Since the result is floating point, it may not be exact.
1577 If precise time stamps are required, use either `current-time',
1578 or (if you need time as a string) `format-time-string'. */)
1579 (specified_time)
1580 Lisp_Object specified_time;
1582 time_t sec;
1583 int usec;
1585 if (! lisp_time_argument (specified_time, &sec, &usec))
1586 error ("Invalid time specification");
1588 return make_float ((sec * 1e6 + usec) / 1e6);
1591 /* Write information into buffer S of size MAXSIZE, according to the
1592 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1593 Default to Universal Time if UT is nonzero, local time otherwise.
1594 Return the number of bytes written, not including the terminating
1595 '\0'. If S is NULL, nothing will be written anywhere; so to
1596 determine how many bytes would be written, use NULL for S and
1597 ((size_t) -1) for MAXSIZE.
1599 This function behaves like emacs_strftimeu, except it allows null
1600 bytes in FORMAT. */
1601 static size_t
1602 emacs_memftimeu (s, maxsize, format, format_len, tp, ut)
1603 char *s;
1604 size_t maxsize;
1605 const char *format;
1606 size_t format_len;
1607 const struct tm *tp;
1608 int ut;
1610 size_t total = 0;
1612 /* Loop through all the null-terminated strings in the format
1613 argument. Normally there's just one null-terminated string, but
1614 there can be arbitrarily many, concatenated together, if the
1615 format contains '\0' bytes. emacs_strftimeu stops at the first
1616 '\0' byte so we must invoke it separately for each such string. */
1617 for (;;)
1619 size_t len;
1620 size_t result;
1622 if (s)
1623 s[0] = '\1';
1625 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1627 if (s)
1629 if (result == 0 && s[0] != '\0')
1630 return 0;
1631 s += result + 1;
1634 maxsize -= result + 1;
1635 total += result;
1636 len = strlen (format);
1637 if (len == format_len)
1638 return total;
1639 total++;
1640 format += len + 1;
1641 format_len -= len + 1;
1645 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1646 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1647 TIME is specified as (HIGH LOW . IGNORED), as returned by
1648 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1649 is also still accepted.
1650 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1651 as Universal Time; nil means describe TIME in the local time zone.
1652 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1653 by text that describes the specified date and time in TIME:
1655 %Y is the year, %y within the century, %C the century.
1656 %G is the year corresponding to the ISO week, %g within the century.
1657 %m is the numeric month.
1658 %b and %h are the locale's abbreviated month name, %B the full name.
1659 %d is the day of the month, zero-padded, %e is blank-padded.
1660 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1661 %a is the locale's abbreviated name of the day of week, %A the full name.
1662 %U is the week number starting on Sunday, %W starting on Monday,
1663 %V according to ISO 8601.
1664 %j is the day of the year.
1666 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1667 only blank-padded, %l is like %I blank-padded.
1668 %p is the locale's equivalent of either AM or PM.
1669 %M is the minute.
1670 %S is the second.
1671 %Z is the time zone name, %z is the numeric form.
1672 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1674 %c is the locale's date and time format.
1675 %x is the locale's "preferred" date format.
1676 %D is like "%m/%d/%y".
1678 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1679 %X is the locale's "preferred" time format.
1681 Finally, %n is a newline, %t is a tab, %% is a literal %.
1683 Certain flags and modifiers are available with some format controls.
1684 The flags are `_', `-', `^' and `#'. For certain characters X,
1685 %_X is like %X, but padded with blanks; %-X is like %X,
1686 but without padding. %^X is like %X, but with all textual
1687 characters up-cased; %#X is like %X, but with letter-case of
1688 all textual characters reversed.
1689 %NX (where N stands for an integer) is like %X,
1690 but takes up at least N (a number) positions.
1691 The modifiers are `E' and `O'. For certain characters X,
1692 %EX is a locale's alternative version of %X;
1693 %OX is like %X, but uses the locale's number symbols.
1695 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1696 (format_string, time, universal)
1697 Lisp_Object format_string, time, universal;
1699 time_t value;
1700 int size;
1701 struct tm *tm;
1702 int ut = ! NILP (universal);
1704 CHECK_STRING (format_string);
1706 if (! lisp_time_argument (time, &value, NULL))
1707 error ("Invalid time specification");
1709 format_string = code_convert_string_norecord (format_string,
1710 Vlocale_coding_system, 1);
1712 /* This is probably enough. */
1713 size = SBYTES (format_string) * 6 + 50;
1715 BLOCK_INPUT;
1716 tm = ut ? gmtime (&value) : localtime (&value);
1717 UNBLOCK_INPUT;
1718 if (! tm)
1719 error ("Specified time is not representable");
1721 synchronize_system_time_locale ();
1723 while (1)
1725 char *buf = (char *) alloca (size + 1);
1726 int result;
1728 buf[0] = '\1';
1729 BLOCK_INPUT;
1730 result = emacs_memftimeu (buf, size, SDATA (format_string),
1731 SBYTES (format_string),
1732 tm, ut);
1733 UNBLOCK_INPUT;
1734 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1735 return code_convert_string_norecord (make_unibyte_string (buf, result),
1736 Vlocale_coding_system, 0);
1738 /* If buffer was too small, make it bigger and try again. */
1739 BLOCK_INPUT;
1740 result = emacs_memftimeu (NULL, (size_t) -1,
1741 SDATA (format_string),
1742 SBYTES (format_string),
1743 tm, ut);
1744 UNBLOCK_INPUT;
1745 size = result + 1;
1749 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1750 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1751 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1752 as from `current-time' and `file-attributes', or nil to use the
1753 current time. The obsolete form (HIGH . LOW) is also still accepted.
1754 The list has the following nine members: SEC is an integer between 0
1755 and 60; SEC is 60 for a leap second, which only some operating systems
1756 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1757 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1758 integer between 1 and 12. YEAR is an integer indicating the
1759 four-digit year. DOW is the day of week, an integer between 0 and 6,
1760 where 0 is Sunday. DST is t if daylight saving time is in effect,
1761 otherwise nil. ZONE is an integer indicating the number of seconds
1762 east of Greenwich. (Note that Common Lisp has different meanings for
1763 DOW and ZONE.) */)
1764 (specified_time)
1765 Lisp_Object specified_time;
1767 time_t time_spec;
1768 struct tm save_tm;
1769 struct tm *decoded_time;
1770 Lisp_Object list_args[9];
1772 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1773 error ("Invalid time specification");
1775 BLOCK_INPUT;
1776 decoded_time = localtime (&time_spec);
1777 UNBLOCK_INPUT;
1778 if (! decoded_time)
1779 error ("Specified time is not representable");
1780 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1781 XSETFASTINT (list_args[1], decoded_time->tm_min);
1782 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1783 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1784 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1785 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1786 cast below avoids overflow in int arithmetics. */
1787 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) decoded_time->tm_year);
1788 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1789 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1791 /* Make a copy, in case gmtime modifies the struct. */
1792 save_tm = *decoded_time;
1793 BLOCK_INPUT;
1794 decoded_time = gmtime (&time_spec);
1795 UNBLOCK_INPUT;
1796 if (decoded_time == 0)
1797 list_args[8] = Qnil;
1798 else
1799 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1800 return Flist (9, list_args);
1803 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1804 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1805 This is the reverse operation of `decode-time', which see.
1806 ZONE defaults to the current time zone rule. This can
1807 be a string or t (as from `set-time-zone-rule'), or it can be a list
1808 \(as from `current-time-zone') or an integer (as from `decode-time')
1809 applied without consideration for daylight saving time.
1811 You can pass more than 7 arguments; then the first six arguments
1812 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1813 The intervening arguments are ignored.
1814 This feature lets (apply 'encode-time (decode-time ...)) work.
1816 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1817 for example, a DAY of 0 means the day preceding the given month.
1818 Year numbers less than 100 are treated just like other year numbers.
1819 If you want them to stand for years in this century, you must do that yourself.
1821 Years before 1970 are not guaranteed to work. On some systems,
1822 year values as low as 1901 do work.
1824 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1825 (nargs, args)
1826 int nargs;
1827 register Lisp_Object *args;
1829 time_t time;
1830 struct tm tm;
1831 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1833 CHECK_NUMBER (args[0]); /* second */
1834 CHECK_NUMBER (args[1]); /* minute */
1835 CHECK_NUMBER (args[2]); /* hour */
1836 CHECK_NUMBER (args[3]); /* day */
1837 CHECK_NUMBER (args[4]); /* month */
1838 CHECK_NUMBER (args[5]); /* year */
1840 tm.tm_sec = XINT (args[0]);
1841 tm.tm_min = XINT (args[1]);
1842 tm.tm_hour = XINT (args[2]);
1843 tm.tm_mday = XINT (args[3]);
1844 tm.tm_mon = XINT (args[4]) - 1;
1845 tm.tm_year = XINT (args[5]) - TM_YEAR_BASE;
1846 tm.tm_isdst = -1;
1848 if (CONSP (zone))
1849 zone = Fcar (zone);
1850 if (NILP (zone))
1852 BLOCK_INPUT;
1853 time = mktime (&tm);
1854 UNBLOCK_INPUT;
1856 else
1858 char tzbuf[100];
1859 char *tzstring;
1860 char **oldenv = environ, **newenv;
1862 if (EQ (zone, Qt))
1863 tzstring = "UTC0";
1864 else if (STRINGP (zone))
1865 tzstring = (char *) SDATA (zone);
1866 else if (INTEGERP (zone))
1868 int abszone = eabs (XINT (zone));
1869 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1870 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1871 tzstring = tzbuf;
1873 else
1874 error ("Invalid time zone specification");
1876 /* Set TZ before calling mktime; merely adjusting mktime's returned
1877 value doesn't suffice, since that would mishandle leap seconds. */
1878 set_time_zone_rule (tzstring);
1880 BLOCK_INPUT;
1881 time = mktime (&tm);
1882 UNBLOCK_INPUT;
1884 /* Restore TZ to previous value. */
1885 newenv = environ;
1886 environ = oldenv;
1887 xfree (newenv);
1888 #ifdef LOCALTIME_CACHE
1889 tzset ();
1890 #endif
1893 if (time == (time_t) -1)
1894 error ("Specified time is not representable");
1896 return make_time (time);
1899 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1900 doc: /* Return the current local time, as a human-readable string.
1901 Programs can use this function to decode a time,
1902 since the number of columns in each field is fixed
1903 if the year is in the range 1000-9999.
1904 The format is `Sun Sep 16 01:03:52 1973'.
1905 However, see also the functions `decode-time' and `format-time-string'
1906 which provide a much more powerful and general facility.
1908 If SPECIFIED-TIME is given, it is a time to format instead of the
1909 current time. The argument should have the form (HIGH LOW . IGNORED).
1910 Thus, you can use times obtained from `current-time' and from
1911 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1912 but this is considered obsolete. */)
1913 (specified_time)
1914 Lisp_Object specified_time;
1916 time_t value;
1917 struct tm *tm;
1918 register char *tem;
1920 if (! lisp_time_argument (specified_time, &value, NULL))
1921 error ("Invalid time specification");
1923 /* Convert to a string, checking for out-of-range time stamps.
1924 Don't use 'ctime', as that might dump core if VALUE is out of
1925 range. */
1926 BLOCK_INPUT;
1927 tm = localtime (&value);
1928 UNBLOCK_INPUT;
1929 if (! (tm && TM_YEAR_IN_ASCTIME_RANGE (tm->tm_year) && (tem = asctime (tm))))
1930 error ("Specified time is not representable");
1932 /* Remove the trailing newline. */
1933 tem[strlen (tem) - 1] = '\0';
1935 return build_string (tem);
1938 /* Yield A - B, measured in seconds.
1939 This function is copied from the GNU C Library. */
1940 static int
1941 tm_diff (a, b)
1942 struct tm *a, *b;
1944 /* Compute intervening leap days correctly even if year is negative.
1945 Take care to avoid int overflow in leap day calculations,
1946 but it's OK to assume that A and B are close to each other. */
1947 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1948 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1949 int a100 = a4 / 25 - (a4 % 25 < 0);
1950 int b100 = b4 / 25 - (b4 % 25 < 0);
1951 int a400 = a100 >> 2;
1952 int b400 = b100 >> 2;
1953 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1954 int years = a->tm_year - b->tm_year;
1955 int days = (365 * years + intervening_leap_days
1956 + (a->tm_yday - b->tm_yday));
1957 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1958 + (a->tm_min - b->tm_min))
1959 + (a->tm_sec - b->tm_sec));
1962 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1963 doc: /* Return the offset and name for the local time zone.
1964 This returns a list of the form (OFFSET NAME).
1965 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1966 A negative value means west of Greenwich.
1967 NAME is a string giving the name of the time zone.
1968 If SPECIFIED-TIME is given, the time zone offset is determined from it
1969 instead of using the current time. The argument should have the form
1970 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1971 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1972 have the form (HIGH . LOW), but this is considered obsolete.
1974 Some operating systems cannot provide all this information to Emacs;
1975 in this case, `current-time-zone' returns a list containing nil for
1976 the data it can't find. */)
1977 (specified_time)
1978 Lisp_Object specified_time;
1980 time_t value;
1981 struct tm *t;
1982 struct tm gmt;
1984 if (!lisp_time_argument (specified_time, &value, NULL))
1985 t = NULL;
1986 else
1988 BLOCK_INPUT;
1989 t = gmtime (&value);
1990 if (t)
1992 gmt = *t;
1993 t = localtime (&value);
1995 UNBLOCK_INPUT;
1998 if (t)
2000 int offset = tm_diff (t, &gmt);
2001 char *s = 0;
2002 char buf[6];
2004 #ifdef HAVE_TM_ZONE
2005 if (t->tm_zone)
2006 s = (char *)t->tm_zone;
2007 #else /* not HAVE_TM_ZONE */
2008 #ifdef HAVE_TZNAME
2009 if (t->tm_isdst == 0 || t->tm_isdst == 1)
2010 s = tzname[t->tm_isdst];
2011 #endif
2012 #endif /* not HAVE_TM_ZONE */
2014 if (!s)
2016 /* No local time zone name is available; use "+-NNNN" instead. */
2017 int am = (offset < 0 ? -offset : offset) / 60;
2018 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
2019 s = buf;
2022 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
2024 else
2025 return Fmake_list (make_number (2), Qnil);
2028 /* This holds the value of `environ' produced by the previous
2029 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
2030 has never been called. */
2031 static char **environbuf;
2033 /* This holds the startup value of the TZ environment variable so it
2034 can be restored if the user calls set-time-zone-rule with a nil
2035 argument. */
2036 static char *initial_tz;
2038 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
2039 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
2040 If TZ is nil, use implementation-defined default time zone information.
2041 If TZ is t, use Universal Time. */)
2042 (tz)
2043 Lisp_Object tz;
2045 char *tzstring;
2047 /* When called for the first time, save the original TZ. */
2048 if (!environbuf)
2049 initial_tz = (char *) getenv ("TZ");
2051 if (NILP (tz))
2052 tzstring = initial_tz;
2053 else if (EQ (tz, Qt))
2054 tzstring = "UTC0";
2055 else
2057 CHECK_STRING (tz);
2058 tzstring = (char *) SDATA (tz);
2061 set_time_zone_rule (tzstring);
2062 free (environbuf);
2063 environbuf = environ;
2065 return Qnil;
2068 #ifdef LOCALTIME_CACHE
2070 /* These two values are known to load tz files in buggy implementations,
2071 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2072 Their values shouldn't matter in non-buggy implementations.
2073 We don't use string literals for these strings,
2074 since if a string in the environment is in readonly
2075 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2076 See Sun bugs 1113095 and 1114114, ``Timezone routines
2077 improperly modify environment''. */
2079 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2080 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2082 #endif
2084 /* Set the local time zone rule to TZSTRING.
2085 This allocates memory into `environ', which it is the caller's
2086 responsibility to free. */
2088 void
2089 set_time_zone_rule (tzstring)
2090 char *tzstring;
2092 int envptrs;
2093 char **from, **to, **newenv;
2095 /* Make the ENVIRON vector longer with room for TZSTRING. */
2096 for (from = environ; *from; from++)
2097 continue;
2098 envptrs = from - environ + 2;
2099 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2100 + (tzstring ? strlen (tzstring) + 4 : 0));
2102 /* Add TZSTRING to the end of environ, as a value for TZ. */
2103 if (tzstring)
2105 char *t = (char *) (to + envptrs);
2106 strcpy (t, "TZ=");
2107 strcat (t, tzstring);
2108 *to++ = t;
2111 /* Copy the old environ vector elements into NEWENV,
2112 but don't copy the TZ variable.
2113 So we have only one definition of TZ, which came from TZSTRING. */
2114 for (from = environ; *from; from++)
2115 if (strncmp (*from, "TZ=", 3) != 0)
2116 *to++ = *from;
2117 *to = 0;
2119 environ = newenv;
2121 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2122 the TZ variable is stored. If we do not have a TZSTRING,
2123 TO points to the vector slot which has the terminating null. */
2125 #ifdef LOCALTIME_CACHE
2127 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2128 "US/Pacific" that loads a tz file, then changes to a value like
2129 "XXX0" that does not load a tz file, and then changes back to
2130 its original value, the last change is (incorrectly) ignored.
2131 Also, if TZ changes twice in succession to values that do
2132 not load a tz file, tzset can dump core (see Sun bug#1225179).
2133 The following code works around these bugs. */
2135 if (tzstring)
2137 /* Temporarily set TZ to a value that loads a tz file
2138 and that differs from tzstring. */
2139 char *tz = *newenv;
2140 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2141 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
2142 tzset ();
2143 *newenv = tz;
2145 else
2147 /* The implied tzstring is unknown, so temporarily set TZ to
2148 two different values that each load a tz file. */
2149 *to = set_time_zone_rule_tz1;
2150 to[1] = 0;
2151 tzset ();
2152 *to = set_time_zone_rule_tz2;
2153 tzset ();
2154 *to = 0;
2157 /* Now TZ has the desired value, and tzset can be invoked safely. */
2160 tzset ();
2161 #endif
2164 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2165 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2166 type of object is Lisp_String). INHERIT is passed to
2167 INSERT_FROM_STRING_FUNC as the last argument. */
2169 static void
2170 general_insert_function (void (*insert_func)
2171 (const unsigned char *, EMACS_INT),
2172 void (*insert_from_string_func)
2173 (Lisp_Object, EMACS_INT, EMACS_INT,
2174 EMACS_INT, EMACS_INT, int),
2175 int inherit, int nargs, Lisp_Object *args)
2177 register int argnum;
2178 register Lisp_Object val;
2180 for (argnum = 0; argnum < nargs; argnum++)
2182 val = args[argnum];
2183 if (CHARACTERP (val))
2185 unsigned char str[MAX_MULTIBYTE_LENGTH];
2186 int len;
2188 if (!NILP (current_buffer->enable_multibyte_characters))
2189 len = CHAR_STRING (XFASTINT (val), str);
2190 else
2192 str[0] = (ASCII_CHAR_P (XINT (val))
2193 ? XINT (val)
2194 : multibyte_char_to_unibyte (XINT (val), Qnil));
2195 len = 1;
2197 (*insert_func) (str, len);
2199 else if (STRINGP (val))
2201 (*insert_from_string_func) (val, 0, 0,
2202 SCHARS (val),
2203 SBYTES (val),
2204 inherit);
2206 else
2207 wrong_type_argument (Qchar_or_string_p, val);
2211 void
2212 insert1 (arg)
2213 Lisp_Object arg;
2215 Finsert (1, &arg);
2219 /* Callers passing one argument to Finsert need not gcpro the
2220 argument "array", since the only element of the array will
2221 not be used after calling insert or insert_from_string, so
2222 we don't care if it gets trashed. */
2224 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2225 doc: /* Insert the arguments, either strings or characters, at point.
2226 Point and before-insertion markers move forward to end up
2227 after the inserted text.
2228 Any other markers at the point of insertion remain before the text.
2230 If the current buffer is multibyte, unibyte strings are converted
2231 to multibyte for insertion (see `string-make-multibyte').
2232 If the current buffer is unibyte, multibyte strings are converted
2233 to unibyte for insertion (see `string-make-unibyte').
2235 When operating on binary data, it may be necessary to preserve the
2236 original bytes of a unibyte string when inserting it into a multibyte
2237 buffer; to accomplish this, apply `string-as-multibyte' to the string
2238 and insert the result.
2240 usage: (insert &rest ARGS) */)
2241 (nargs, args)
2242 int nargs;
2243 register Lisp_Object *args;
2245 general_insert_function (insert, insert_from_string, 0, nargs, args);
2246 return Qnil;
2249 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2250 0, MANY, 0,
2251 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2252 Point and before-insertion markers move forward to end up
2253 after the inserted text.
2254 Any other markers at the point of insertion remain before the text.
2256 If the current buffer is multibyte, unibyte strings are converted
2257 to multibyte for insertion (see `unibyte-char-to-multibyte').
2258 If the current buffer is unibyte, multibyte strings are converted
2259 to unibyte for insertion.
2261 usage: (insert-and-inherit &rest ARGS) */)
2262 (nargs, args)
2263 int nargs;
2264 register Lisp_Object *args;
2266 general_insert_function (insert_and_inherit, insert_from_string, 1,
2267 nargs, args);
2268 return Qnil;
2271 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2272 doc: /* Insert strings or characters at point, relocating markers after the text.
2273 Point and markers move forward to end up after the inserted text.
2275 If the current buffer is multibyte, unibyte strings are converted
2276 to multibyte for insertion (see `unibyte-char-to-multibyte').
2277 If the current buffer is unibyte, multibyte strings are converted
2278 to unibyte for insertion.
2280 usage: (insert-before-markers &rest ARGS) */)
2281 (nargs, args)
2282 int nargs;
2283 register Lisp_Object *args;
2285 general_insert_function (insert_before_markers,
2286 insert_from_string_before_markers, 0,
2287 nargs, args);
2288 return Qnil;
2291 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2292 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2293 doc: /* Insert text at point, relocating markers and inheriting properties.
2294 Point and markers move forward to end up after the inserted text.
2296 If the current buffer is multibyte, unibyte strings are converted
2297 to multibyte for insertion (see `unibyte-char-to-multibyte').
2298 If the current buffer is unibyte, multibyte strings are converted
2299 to unibyte for insertion.
2301 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2302 (nargs, args)
2303 int nargs;
2304 register Lisp_Object *args;
2306 general_insert_function (insert_before_markers_and_inherit,
2307 insert_from_string_before_markers, 1,
2308 nargs, args);
2309 return Qnil;
2312 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2313 doc: /* Insert COUNT copies of CHARACTER.
2314 Point, and before-insertion markers, are relocated as in the function `insert'.
2315 The optional third arg INHERIT, if non-nil, says to inherit text properties
2316 from adjoining text, if those properties are sticky. */)
2317 (character, count, inherit)
2318 Lisp_Object character, count, inherit;
2320 register unsigned char *string;
2321 register int strlen;
2322 register int i, n;
2323 int len;
2324 unsigned char str[MAX_MULTIBYTE_LENGTH];
2326 CHECK_NUMBER (character);
2327 CHECK_NUMBER (count);
2329 if (!NILP (current_buffer->enable_multibyte_characters))
2330 len = CHAR_STRING (XFASTINT (character), str);
2331 else
2332 str[0] = XFASTINT (character), len = 1;
2333 n = XINT (count) * len;
2334 if (n <= 0)
2335 return Qnil;
2336 strlen = min (n, 256 * len);
2337 string = (unsigned char *) alloca (strlen);
2338 for (i = 0; i < strlen; i++)
2339 string[i] = str[i % len];
2340 while (n >= strlen)
2342 QUIT;
2343 if (!NILP (inherit))
2344 insert_and_inherit (string, strlen);
2345 else
2346 insert (string, strlen);
2347 n -= strlen;
2349 if (n > 0)
2351 if (!NILP (inherit))
2352 insert_and_inherit (string, n);
2353 else
2354 insert (string, n);
2356 return Qnil;
2359 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2360 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2361 Both arguments are required.
2362 BYTE is a number of the range 0..255.
2364 If BYTE is 128..255 and the current buffer is multibyte, the
2365 corresponding eight-bit character is inserted.
2367 Point, and before-insertion markers, are relocated as in the function `insert'.
2368 The optional third arg INHERIT, if non-nil, says to inherit text properties
2369 from adjoining text, if those properties are sticky. */)
2370 (byte, count, inherit)
2371 Lisp_Object byte, count, inherit;
2373 CHECK_NUMBER (byte);
2374 if (XINT (byte) < 0 || XINT (byte) > 255)
2375 args_out_of_range_3 (byte, make_number (0), make_number (255));
2376 if (XINT (byte) >= 128
2377 && ! NILP (current_buffer->enable_multibyte_characters))
2378 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2379 return Finsert_char (byte, count, inherit);
2383 /* Making strings from buffer contents. */
2385 /* Return a Lisp_String containing the text of the current buffer from
2386 START to END. If text properties are in use and the current buffer
2387 has properties in the range specified, the resulting string will also
2388 have them, if PROPS is nonzero.
2390 We don't want to use plain old make_string here, because it calls
2391 make_uninit_string, which can cause the buffer arena to be
2392 compacted. make_string has no way of knowing that the data has
2393 been moved, and thus copies the wrong data into the string. This
2394 doesn't effect most of the other users of make_string, so it should
2395 be left as is. But we should use this function when conjuring
2396 buffer substrings. */
2398 Lisp_Object
2399 make_buffer_string (start, end, props)
2400 int start, end;
2401 int props;
2403 int start_byte = CHAR_TO_BYTE (start);
2404 int end_byte = CHAR_TO_BYTE (end);
2406 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2409 /* Return a Lisp_String containing the text of the current buffer from
2410 START / START_BYTE to END / END_BYTE.
2412 If text properties are in use and the current buffer
2413 has properties in the range specified, the resulting string will also
2414 have them, if PROPS is nonzero.
2416 We don't want to use plain old make_string here, because it calls
2417 make_uninit_string, which can cause the buffer arena to be
2418 compacted. make_string has no way of knowing that the data has
2419 been moved, and thus copies the wrong data into the string. This
2420 doesn't effect most of the other users of make_string, so it should
2421 be left as is. But we should use this function when conjuring
2422 buffer substrings. */
2424 Lisp_Object
2425 make_buffer_string_both (start, start_byte, end, end_byte, props)
2426 int start, start_byte, end, end_byte;
2427 int props;
2429 Lisp_Object result, tem, tem1;
2431 if (start < GPT && GPT < end)
2432 move_gap (start);
2434 if (! NILP (current_buffer->enable_multibyte_characters))
2435 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2436 else
2437 result = make_uninit_string (end - start);
2438 bcopy (BYTE_POS_ADDR (start_byte), SDATA (result),
2439 end_byte - start_byte);
2441 /* If desired, update and copy the text properties. */
2442 if (props)
2444 update_buffer_properties (start, end);
2446 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2447 tem1 = Ftext_properties_at (make_number (start), Qnil);
2449 if (XINT (tem) != end || !NILP (tem1))
2450 copy_intervals_to_string (result, current_buffer, start,
2451 end - start);
2454 return result;
2457 /* Call Vbuffer_access_fontify_functions for the range START ... END
2458 in the current buffer, if necessary. */
2460 static void
2461 update_buffer_properties (start, end)
2462 int start, end;
2464 /* If this buffer has some access functions,
2465 call them, specifying the range of the buffer being accessed. */
2466 if (!NILP (Vbuffer_access_fontify_functions))
2468 Lisp_Object args[3];
2469 Lisp_Object tem;
2471 args[0] = Qbuffer_access_fontify_functions;
2472 XSETINT (args[1], start);
2473 XSETINT (args[2], end);
2475 /* But don't call them if we can tell that the work
2476 has already been done. */
2477 if (!NILP (Vbuffer_access_fontified_property))
2479 tem = Ftext_property_any (args[1], args[2],
2480 Vbuffer_access_fontified_property,
2481 Qnil, Qnil);
2482 if (! NILP (tem))
2483 Frun_hook_with_args (3, args);
2485 else
2486 Frun_hook_with_args (3, args);
2490 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2491 doc: /* Return the contents of part of the current buffer as a string.
2492 The two arguments START and END are character positions;
2493 they can be in either order.
2494 The string returned is multibyte if the buffer is multibyte.
2496 This function copies the text properties of that part of the buffer
2497 into the result string; if you don't want the text properties,
2498 use `buffer-substring-no-properties' instead. */)
2499 (start, end)
2500 Lisp_Object start, end;
2502 register int b, e;
2504 validate_region (&start, &end);
2505 b = XINT (start);
2506 e = XINT (end);
2508 return make_buffer_string (b, e, 1);
2511 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2512 Sbuffer_substring_no_properties, 2, 2, 0,
2513 doc: /* Return the characters of part of the buffer, without the text properties.
2514 The two arguments START and END are character positions;
2515 they can be in either order. */)
2516 (start, end)
2517 Lisp_Object start, end;
2519 register int b, e;
2521 validate_region (&start, &end);
2522 b = XINT (start);
2523 e = XINT (end);
2525 return make_buffer_string (b, e, 0);
2528 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2529 doc: /* Return the contents of the current buffer as a string.
2530 If narrowing is in effect, this function returns only the visible part
2531 of the buffer. */)
2534 return make_buffer_string (BEGV, ZV, 1);
2537 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2538 1, 3, 0,
2539 doc: /* Insert before point a substring of the contents of BUFFER.
2540 BUFFER may be a buffer or a buffer name.
2541 Arguments START and END are character positions specifying the substring.
2542 They default to the values of (point-min) and (point-max) in BUFFER. */)
2543 (buffer, start, end)
2544 Lisp_Object buffer, start, end;
2546 register int b, e, temp;
2547 register struct buffer *bp, *obuf;
2548 Lisp_Object buf;
2550 buf = Fget_buffer (buffer);
2551 if (NILP (buf))
2552 nsberror (buffer);
2553 bp = XBUFFER (buf);
2554 if (NILP (bp->name))
2555 error ("Selecting deleted buffer");
2557 if (NILP (start))
2558 b = BUF_BEGV (bp);
2559 else
2561 CHECK_NUMBER_COERCE_MARKER (start);
2562 b = XINT (start);
2564 if (NILP (end))
2565 e = BUF_ZV (bp);
2566 else
2568 CHECK_NUMBER_COERCE_MARKER (end);
2569 e = XINT (end);
2572 if (b > e)
2573 temp = b, b = e, e = temp;
2575 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2576 args_out_of_range (start, end);
2578 obuf = current_buffer;
2579 set_buffer_internal_1 (bp);
2580 update_buffer_properties (b, e);
2581 set_buffer_internal_1 (obuf);
2583 insert_from_buffer (bp, b, e - b, 0);
2584 return Qnil;
2587 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2588 6, 6, 0,
2589 doc: /* Compare two substrings of two buffers; return result as number.
2590 the value is -N if first string is less after N-1 chars,
2591 +N if first string is greater after N-1 chars, or 0 if strings match.
2592 Each substring is represented as three arguments: BUFFER, START and END.
2593 That makes six args in all, three for each substring.
2595 The value of `case-fold-search' in the current buffer
2596 determines whether case is significant or ignored. */)
2597 (buffer1, start1, end1, buffer2, start2, end2)
2598 Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
2600 register int begp1, endp1, begp2, endp2, temp;
2601 register struct buffer *bp1, *bp2;
2602 register Lisp_Object trt
2603 = (!NILP (current_buffer->case_fold_search)
2604 ? current_buffer->case_canon_table : Qnil);
2605 int chars = 0;
2606 int i1, i2, i1_byte, i2_byte;
2608 /* Find the first buffer and its substring. */
2610 if (NILP (buffer1))
2611 bp1 = current_buffer;
2612 else
2614 Lisp_Object buf1;
2615 buf1 = Fget_buffer (buffer1);
2616 if (NILP (buf1))
2617 nsberror (buffer1);
2618 bp1 = XBUFFER (buf1);
2619 if (NILP (bp1->name))
2620 error ("Selecting deleted buffer");
2623 if (NILP (start1))
2624 begp1 = BUF_BEGV (bp1);
2625 else
2627 CHECK_NUMBER_COERCE_MARKER (start1);
2628 begp1 = XINT (start1);
2630 if (NILP (end1))
2631 endp1 = BUF_ZV (bp1);
2632 else
2634 CHECK_NUMBER_COERCE_MARKER (end1);
2635 endp1 = XINT (end1);
2638 if (begp1 > endp1)
2639 temp = begp1, begp1 = endp1, endp1 = temp;
2641 if (!(BUF_BEGV (bp1) <= begp1
2642 && begp1 <= endp1
2643 && endp1 <= BUF_ZV (bp1)))
2644 args_out_of_range (start1, end1);
2646 /* Likewise for second substring. */
2648 if (NILP (buffer2))
2649 bp2 = current_buffer;
2650 else
2652 Lisp_Object buf2;
2653 buf2 = Fget_buffer (buffer2);
2654 if (NILP (buf2))
2655 nsberror (buffer2);
2656 bp2 = XBUFFER (buf2);
2657 if (NILP (bp2->name))
2658 error ("Selecting deleted buffer");
2661 if (NILP (start2))
2662 begp2 = BUF_BEGV (bp2);
2663 else
2665 CHECK_NUMBER_COERCE_MARKER (start2);
2666 begp2 = XINT (start2);
2668 if (NILP (end2))
2669 endp2 = BUF_ZV (bp2);
2670 else
2672 CHECK_NUMBER_COERCE_MARKER (end2);
2673 endp2 = XINT (end2);
2676 if (begp2 > endp2)
2677 temp = begp2, begp2 = endp2, endp2 = temp;
2679 if (!(BUF_BEGV (bp2) <= begp2
2680 && begp2 <= endp2
2681 && endp2 <= BUF_ZV (bp2)))
2682 args_out_of_range (start2, end2);
2684 i1 = begp1;
2685 i2 = begp2;
2686 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2687 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2689 while (i1 < endp1 && i2 < endp2)
2691 /* When we find a mismatch, we must compare the
2692 characters, not just the bytes. */
2693 int c1, c2;
2695 QUIT;
2697 if (! NILP (bp1->enable_multibyte_characters))
2699 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2700 BUF_INC_POS (bp1, i1_byte);
2701 i1++;
2703 else
2705 c1 = BUF_FETCH_BYTE (bp1, i1);
2706 MAKE_CHAR_MULTIBYTE (c1);
2707 i1++;
2710 if (! NILP (bp2->enable_multibyte_characters))
2712 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2713 BUF_INC_POS (bp2, i2_byte);
2714 i2++;
2716 else
2718 c2 = BUF_FETCH_BYTE (bp2, i2);
2719 MAKE_CHAR_MULTIBYTE (c2);
2720 i2++;
2723 if (!NILP (trt))
2725 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2726 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
2728 if (c1 < c2)
2729 return make_number (- 1 - chars);
2730 if (c1 > c2)
2731 return make_number (chars + 1);
2733 chars++;
2736 /* The strings match as far as they go.
2737 If one is shorter, that one is less. */
2738 if (chars < endp1 - begp1)
2739 return make_number (chars + 1);
2740 else if (chars < endp2 - begp2)
2741 return make_number (- chars - 1);
2743 /* Same length too => they are equal. */
2744 return make_number (0);
2747 static Lisp_Object
2748 subst_char_in_region_unwind (arg)
2749 Lisp_Object arg;
2751 return current_buffer->undo_list = arg;
2754 static Lisp_Object
2755 subst_char_in_region_unwind_1 (arg)
2756 Lisp_Object arg;
2758 return current_buffer->filename = arg;
2761 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2762 Ssubst_char_in_region, 4, 5, 0,
2763 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2764 If optional arg NOUNDO is non-nil, don't record this change for undo
2765 and don't mark the buffer as really changed.
2766 Both characters must have the same length of multi-byte form. */)
2767 (start, end, fromchar, tochar, noundo)
2768 Lisp_Object start, end, fromchar, tochar, noundo;
2770 register int pos, pos_byte, stop, i, len, end_byte;
2771 /* Keep track of the first change in the buffer:
2772 if 0 we haven't found it yet.
2773 if < 0 we've found it and we've run the before-change-function.
2774 if > 0 we've actually performed it and the value is its position. */
2775 int changed = 0;
2776 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2777 unsigned char *p;
2778 int count = SPECPDL_INDEX ();
2779 #define COMBINING_NO 0
2780 #define COMBINING_BEFORE 1
2781 #define COMBINING_AFTER 2
2782 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2783 int maybe_byte_combining = COMBINING_NO;
2784 int last_changed = 0;
2785 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2787 restart:
2789 validate_region (&start, &end);
2790 CHECK_NUMBER (fromchar);
2791 CHECK_NUMBER (tochar);
2793 if (multibyte_p)
2795 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2796 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2797 error ("Characters in `subst-char-in-region' have different byte-lengths");
2798 if (!ASCII_BYTE_P (*tostr))
2800 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2801 complete multibyte character, it may be combined with the
2802 after bytes. If it is in the range 0xA0..0xFF, it may be
2803 combined with the before and after bytes. */
2804 if (!CHAR_HEAD_P (*tostr))
2805 maybe_byte_combining = COMBINING_BOTH;
2806 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2807 maybe_byte_combining = COMBINING_AFTER;
2810 else
2812 len = 1;
2813 fromstr[0] = XFASTINT (fromchar);
2814 tostr[0] = XFASTINT (tochar);
2817 pos = XINT (start);
2818 pos_byte = CHAR_TO_BYTE (pos);
2819 stop = CHAR_TO_BYTE (XINT (end));
2820 end_byte = stop;
2822 /* If we don't want undo, turn off putting stuff on the list.
2823 That's faster than getting rid of things,
2824 and it prevents even the entry for a first change.
2825 Also inhibit locking the file. */
2826 if (!changed && !NILP (noundo))
2828 record_unwind_protect (subst_char_in_region_unwind,
2829 current_buffer->undo_list);
2830 current_buffer->undo_list = Qt;
2831 /* Don't do file-locking. */
2832 record_unwind_protect (subst_char_in_region_unwind_1,
2833 current_buffer->filename);
2834 current_buffer->filename = Qnil;
2837 if (pos_byte < GPT_BYTE)
2838 stop = min (stop, GPT_BYTE);
2839 while (1)
2841 int pos_byte_next = pos_byte;
2843 if (pos_byte >= stop)
2845 if (pos_byte >= end_byte) break;
2846 stop = end_byte;
2848 p = BYTE_POS_ADDR (pos_byte);
2849 if (multibyte_p)
2850 INC_POS (pos_byte_next);
2851 else
2852 ++pos_byte_next;
2853 if (pos_byte_next - pos_byte == len
2854 && p[0] == fromstr[0]
2855 && (len == 1
2856 || (p[1] == fromstr[1]
2857 && (len == 2 || (p[2] == fromstr[2]
2858 && (len == 3 || p[3] == fromstr[3]))))))
2860 if (changed < 0)
2861 /* We've already seen this and run the before-change-function;
2862 this time we only need to record the actual position. */
2863 changed = pos;
2864 else if (!changed)
2866 changed = -1;
2867 modify_region (current_buffer, pos, XINT (end), 0);
2869 if (! NILP (noundo))
2871 if (MODIFF - 1 == SAVE_MODIFF)
2872 SAVE_MODIFF++;
2873 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
2874 BUF_AUTOSAVE_MODIFF (current_buffer)++;
2877 /* The before-change-function may have moved the gap
2878 or even modified the buffer so we should start over. */
2879 goto restart;
2882 /* Take care of the case where the new character
2883 combines with neighboring bytes. */
2884 if (maybe_byte_combining
2885 && (maybe_byte_combining == COMBINING_AFTER
2886 ? (pos_byte_next < Z_BYTE
2887 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2888 : ((pos_byte_next < Z_BYTE
2889 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2890 || (pos_byte > BEG_BYTE
2891 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2893 Lisp_Object tem, string;
2895 struct gcpro gcpro1;
2897 tem = current_buffer->undo_list;
2898 GCPRO1 (tem);
2900 /* Make a multibyte string containing this single character. */
2901 string = make_multibyte_string (tostr, 1, len);
2902 /* replace_range is less efficient, because it moves the gap,
2903 but it handles combining correctly. */
2904 replace_range (pos, pos + 1, string,
2905 0, 0, 1);
2906 pos_byte_next = CHAR_TO_BYTE (pos);
2907 if (pos_byte_next > pos_byte)
2908 /* Before combining happened. We should not increment
2909 POS. So, to cancel the later increment of POS,
2910 decrease it now. */
2911 pos--;
2912 else
2913 INC_POS (pos_byte_next);
2915 if (! NILP (noundo))
2916 current_buffer->undo_list = tem;
2918 UNGCPRO;
2920 else
2922 if (NILP (noundo))
2923 record_change (pos, 1);
2924 for (i = 0; i < len; i++) *p++ = tostr[i];
2926 last_changed = pos + 1;
2928 pos_byte = pos_byte_next;
2929 pos++;
2932 if (changed > 0)
2934 signal_after_change (changed,
2935 last_changed - changed, last_changed - changed);
2936 update_compositions (changed, last_changed, CHECK_ALL);
2939 unbind_to (count, Qnil);
2940 return Qnil;
2944 static Lisp_Object check_translation P_ ((int, int, int, Lisp_Object));
2946 /* Helper function for Ftranslate_region_internal.
2948 Check if a character sequence at POS (POS_BYTE) matches an element
2949 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2950 element is found, return it. Otherwise return Qnil. */
2952 static Lisp_Object
2953 check_translation (pos, pos_byte, end, val)
2954 int pos, pos_byte, end;
2955 Lisp_Object val;
2957 int buf_size = 16, buf_used = 0;
2958 int *buf = alloca (sizeof (int) * buf_size);
2960 for (; CONSP (val); val = XCDR (val))
2962 Lisp_Object elt;
2963 int len, i;
2965 elt = XCAR (val);
2966 if (! CONSP (elt))
2967 continue;
2968 elt = XCAR (elt);
2969 if (! VECTORP (elt))
2970 continue;
2971 len = ASIZE (elt);
2972 if (len <= end - pos)
2974 for (i = 0; i < len; i++)
2976 if (buf_used <= i)
2978 unsigned char *p = BYTE_POS_ADDR (pos_byte);
2979 int len;
2981 if (buf_used == buf_size)
2983 int *newbuf;
2985 buf_size += 16;
2986 newbuf = alloca (sizeof (int) * buf_size);
2987 memcpy (newbuf, buf, sizeof (int) * buf_used);
2988 buf = newbuf;
2990 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len);
2991 pos_byte += len;
2993 if (XINT (AREF (elt, i)) != buf[i])
2994 break;
2996 if (i == len)
2997 return XCAR (val);
3000 return Qnil;
3004 DEFUN ("translate-region-internal", Ftranslate_region_internal,
3005 Stranslate_region_internal, 3, 3, 0,
3006 doc: /* Internal use only.
3007 From START to END, translate characters according to TABLE.
3008 TABLE is a string or a char-table; the Nth character in it is the
3009 mapping for the character with code N.
3010 It returns the number of characters changed. */)
3011 (start, end, table)
3012 Lisp_Object start;
3013 Lisp_Object end;
3014 register Lisp_Object table;
3016 register unsigned char *tt; /* Trans table. */
3017 register int nc; /* New character. */
3018 int cnt; /* Number of changes made. */
3019 int size; /* Size of translate table. */
3020 int pos, pos_byte, end_pos;
3021 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
3022 int string_multibyte;
3023 Lisp_Object val;
3025 validate_region (&start, &end);
3026 if (CHAR_TABLE_P (table))
3028 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
3029 error ("Not a translation table");
3030 size = MAX_CHAR;
3031 tt = NULL;
3033 else
3035 CHECK_STRING (table);
3037 if (! multibyte && (SCHARS (table) < SBYTES (table)))
3038 table = string_make_unibyte (table);
3039 string_multibyte = SCHARS (table) < SBYTES (table);
3040 size = SBYTES (table);
3041 tt = SDATA (table);
3044 pos = XINT (start);
3045 pos_byte = CHAR_TO_BYTE (pos);
3046 end_pos = XINT (end);
3047 modify_region (current_buffer, pos, end_pos, 0);
3049 cnt = 0;
3050 for (; pos < end_pos; )
3052 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
3053 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
3054 int len, str_len;
3055 int oc;
3056 Lisp_Object val;
3058 if (multibyte)
3059 oc = STRING_CHAR_AND_LENGTH (p, len);
3060 else
3061 oc = *p, len = 1;
3062 if (oc < size)
3064 if (tt)
3066 /* Reload as signal_after_change in last iteration may GC. */
3067 tt = SDATA (table);
3068 if (string_multibyte)
3070 str = tt + string_char_to_byte (table, oc);
3071 nc = STRING_CHAR_AND_LENGTH (str, str_len);
3073 else
3075 nc = tt[oc];
3076 if (! ASCII_BYTE_P (nc) && multibyte)
3078 str_len = BYTE8_STRING (nc, buf);
3079 str = buf;
3081 else
3083 str_len = 1;
3084 str = tt + oc;
3088 else
3090 int c;
3092 nc = oc;
3093 val = CHAR_TABLE_REF (table, oc);
3094 if (CHARACTERP (val)
3095 && (c = XINT (val), CHAR_VALID_P (c, 0)))
3097 nc = c;
3098 str_len = CHAR_STRING (nc, buf);
3099 str = buf;
3101 else if (VECTORP (val) || (CONSP (val)))
3103 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3104 where TO is TO-CHAR or [TO-CHAR ...]. */
3105 nc = -1;
3109 if (nc != oc && nc >= 0)
3111 /* Simple one char to one char translation. */
3112 if (len != str_len)
3114 Lisp_Object string;
3116 /* This is less efficient, because it moves the gap,
3117 but it should handle multibyte characters correctly. */
3118 string = make_multibyte_string (str, 1, str_len);
3119 replace_range (pos, pos + 1, string, 1, 0, 1);
3120 len = str_len;
3122 else
3124 record_change (pos, 1);
3125 while (str_len-- > 0)
3126 *p++ = *str++;
3127 signal_after_change (pos, 1, 1);
3128 update_compositions (pos, pos + 1, CHECK_BORDER);
3130 ++cnt;
3132 else if (nc < 0)
3134 Lisp_Object string;
3136 if (CONSP (val))
3138 val = check_translation (pos, pos_byte, end_pos, val);
3139 if (NILP (val))
3141 pos_byte += len;
3142 pos++;
3143 continue;
3145 /* VAL is ([FROM-CHAR ...] . TO). */
3146 len = ASIZE (XCAR (val));
3147 val = XCDR (val);
3149 else
3150 len = 1;
3152 if (VECTORP (val))
3154 string = Fconcat (1, &val);
3156 else
3158 string = Fmake_string (make_number (1), val);
3160 replace_range (pos, pos + len, string, 1, 0, 1);
3161 pos_byte += SBYTES (string);
3162 pos += SCHARS (string);
3163 cnt += SCHARS (string);
3164 end_pos += SCHARS (string) - len;
3165 continue;
3168 pos_byte += len;
3169 pos++;
3172 return make_number (cnt);
3175 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3176 doc: /* Delete the text between point and mark.
3178 When called from a program, expects two arguments,
3179 positions (integers or markers) specifying the stretch to be deleted. */)
3180 (start, end)
3181 Lisp_Object start, end;
3183 validate_region (&start, &end);
3184 del_range (XINT (start), XINT (end));
3185 return Qnil;
3188 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3189 Sdelete_and_extract_region, 2, 2, 0,
3190 doc: /* Delete the text between START and END and return it. */)
3191 (start, end)
3192 Lisp_Object start, end;
3194 validate_region (&start, &end);
3195 if (XINT (start) == XINT (end))
3196 return empty_unibyte_string;
3197 return del_range_1 (XINT (start), XINT (end), 1, 1);
3200 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3201 doc: /* Remove restrictions (narrowing) from current buffer.
3202 This allows the buffer's full text to be seen and edited. */)
3205 if (BEG != BEGV || Z != ZV)
3206 current_buffer->clip_changed = 1;
3207 BEGV = BEG;
3208 BEGV_BYTE = BEG_BYTE;
3209 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3210 /* Changing the buffer bounds invalidates any recorded current column. */
3211 invalidate_current_column ();
3212 return Qnil;
3215 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3216 doc: /* Restrict editing in this buffer to the current region.
3217 The rest of the text becomes temporarily invisible and untouchable
3218 but is not deleted; if you save the buffer in a file, the invisible
3219 text is included in the file. \\[widen] makes all visible again.
3220 See also `save-restriction'.
3222 When calling from a program, pass two arguments; positions (integers
3223 or markers) bounding the text that should remain visible. */)
3224 (start, end)
3225 register Lisp_Object start, end;
3227 CHECK_NUMBER_COERCE_MARKER (start);
3228 CHECK_NUMBER_COERCE_MARKER (end);
3230 if (XINT (start) > XINT (end))
3232 Lisp_Object tem;
3233 tem = start; start = end; end = tem;
3236 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3237 args_out_of_range (start, end);
3239 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3240 current_buffer->clip_changed = 1;
3242 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3243 SET_BUF_ZV (current_buffer, XFASTINT (end));
3244 if (PT < XFASTINT (start))
3245 SET_PT (XFASTINT (start));
3246 if (PT > XFASTINT (end))
3247 SET_PT (XFASTINT (end));
3248 /* Changing the buffer bounds invalidates any recorded current column. */
3249 invalidate_current_column ();
3250 return Qnil;
3253 Lisp_Object
3254 save_restriction_save ()
3256 if (BEGV == BEG && ZV == Z)
3257 /* The common case that the buffer isn't narrowed.
3258 We return just the buffer object, which save_restriction_restore
3259 recognizes as meaning `no restriction'. */
3260 return Fcurrent_buffer ();
3261 else
3262 /* We have to save a restriction, so return a pair of markers, one
3263 for the beginning and one for the end. */
3265 Lisp_Object beg, end;
3267 beg = buildmark (BEGV, BEGV_BYTE);
3268 end = buildmark (ZV, ZV_BYTE);
3270 /* END must move forward if text is inserted at its exact location. */
3271 XMARKER(end)->insertion_type = 1;
3273 return Fcons (beg, end);
3277 Lisp_Object
3278 save_restriction_restore (data)
3279 Lisp_Object data;
3281 struct buffer *cur = NULL;
3282 struct buffer *buf = (CONSP (data)
3283 ? XMARKER (XCAR (data))->buffer
3284 : XBUFFER (data));
3286 if (buf && buf != current_buffer && !NILP (buf->pt_marker))
3287 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3288 is the case if it is or has an indirect buffer), then make
3289 sure it is current before we update BEGV, so
3290 set_buffer_internal takes care of managing those markers. */
3291 cur = current_buffer;
3292 set_buffer_internal (buf);
3295 if (CONSP (data))
3296 /* A pair of marks bounding a saved restriction. */
3298 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3299 struct Lisp_Marker *end = XMARKER (XCDR (data));
3300 eassert (buf == end->buffer);
3302 if (buf /* Verify marker still points to a buffer. */
3303 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3304 /* The restriction has changed from the saved one, so restore
3305 the saved restriction. */
3307 int pt = BUF_PT (buf);
3309 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3310 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3312 if (pt < beg->charpos || pt > end->charpos)
3313 /* The point is outside the new visible range, move it inside. */
3314 SET_BUF_PT_BOTH (buf,
3315 clip_to_bounds (beg->charpos, pt, end->charpos),
3316 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3317 end->bytepos));
3319 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3322 else
3323 /* A buffer, which means that there was no old restriction. */
3325 if (buf /* Verify marker still points to a buffer. */
3326 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3327 /* The buffer has been narrowed, get rid of the narrowing. */
3329 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3330 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3332 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3336 if (cur)
3337 set_buffer_internal (cur);
3339 return Qnil;
3342 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3343 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3344 The buffer's restrictions make parts of the beginning and end invisible.
3345 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3346 This special form, `save-restriction', saves the current buffer's restrictions
3347 when it is entered, and restores them when it is exited.
3348 So any `narrow-to-region' within BODY lasts only until the end of the form.
3349 The old restrictions settings are restored
3350 even in case of abnormal exit (throw or error).
3352 The value returned is the value of the last form in BODY.
3354 Note: if you are using both `save-excursion' and `save-restriction',
3355 use `save-excursion' outermost:
3356 (save-excursion (save-restriction ...))
3358 usage: (save-restriction &rest BODY) */)
3359 (body)
3360 Lisp_Object body;
3362 register Lisp_Object val;
3363 int count = SPECPDL_INDEX ();
3365 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3366 val = Fprogn (body);
3367 return unbind_to (count, val);
3370 /* Buffer for the most recent text displayed by Fmessage_box. */
3371 static char *message_text;
3373 /* Allocated length of that buffer. */
3374 static int message_length;
3376 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3377 doc: /* Display a message at the bottom of the screen.
3378 The message also goes into the `*Messages*' buffer.
3379 \(In keyboard macros, that's all it does.)
3380 Return the message.
3382 The first argument is a format control string, and the rest are data
3383 to be formatted under control of the string. See `format' for details.
3385 Note: Use (message "%s" VALUE) to print the value of expressions and
3386 variables to avoid accidentally interpreting `%' as format specifiers.
3388 If the first argument is nil or the empty string, the function clears
3389 any existing message; this lets the minibuffer contents show. See
3390 also `current-message'.
3392 usage: (message FORMAT-STRING &rest ARGS) */)
3393 (nargs, args)
3394 int nargs;
3395 Lisp_Object *args;
3397 if (NILP (args[0])
3398 || (STRINGP (args[0])
3399 && SBYTES (args[0]) == 0))
3401 message (0);
3402 return args[0];
3404 else
3406 register Lisp_Object val;
3407 val = Fformat (nargs, args);
3408 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
3409 return val;
3413 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3414 doc: /* Display a message, in a dialog box if possible.
3415 If a dialog box is not available, use the echo area.
3416 The first argument is a format control string, and the rest are data
3417 to be formatted under control of the string. See `format' for details.
3419 If the first argument is nil or the empty string, clear any existing
3420 message; let the minibuffer contents show.
3422 usage: (message-box FORMAT-STRING &rest ARGS) */)
3423 (nargs, args)
3424 int nargs;
3425 Lisp_Object *args;
3427 if (NILP (args[0]))
3429 message (0);
3430 return Qnil;
3432 else
3434 register Lisp_Object val;
3435 val = Fformat (nargs, args);
3436 #ifdef HAVE_MENUS
3437 /* The MS-DOS frames support popup menus even though they are
3438 not FRAME_WINDOW_P. */
3439 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3440 || FRAME_MSDOS_P (XFRAME (selected_frame)))
3442 Lisp_Object pane, menu, obj;
3443 struct gcpro gcpro1;
3444 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3445 GCPRO1 (pane);
3446 menu = Fcons (val, pane);
3447 obj = Fx_popup_dialog (Qt, menu, Qt);
3448 UNGCPRO;
3449 return val;
3451 #endif /* HAVE_MENUS */
3452 /* Copy the data so that it won't move when we GC. */
3453 if (! message_text)
3455 message_text = (char *)xmalloc (80);
3456 message_length = 80;
3458 if (SBYTES (val) > message_length)
3460 message_length = SBYTES (val);
3461 message_text = (char *)xrealloc (message_text, message_length);
3463 bcopy (SDATA (val), message_text, SBYTES (val));
3464 message2 (message_text, SBYTES (val),
3465 STRING_MULTIBYTE (val));
3466 return val;
3469 #ifdef HAVE_MENUS
3470 extern Lisp_Object last_nonmenu_event;
3471 #endif
3473 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3474 doc: /* Display a message in a dialog box or in the echo area.
3475 If this command was invoked with the mouse, use a dialog box if
3476 `use-dialog-box' is non-nil.
3477 Otherwise, use the echo area.
3478 The first argument is a format control string, and the rest are data
3479 to be formatted under control of the string. See `format' for details.
3481 If the first argument is nil or the empty string, clear any existing
3482 message; let the minibuffer contents show.
3484 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3485 (nargs, args)
3486 int nargs;
3487 Lisp_Object *args;
3489 #ifdef HAVE_MENUS
3490 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3491 && use_dialog_box)
3492 return Fmessage_box (nargs, args);
3493 #endif
3494 return Fmessage (nargs, args);
3497 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3498 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3501 return current_message ();
3505 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3506 doc: /* Return a copy of STRING with text properties added.
3507 First argument is the string to copy.
3508 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3509 properties to add to the result.
3510 usage: (propertize STRING &rest PROPERTIES) */)
3511 (nargs, args)
3512 int nargs;
3513 Lisp_Object *args;
3515 Lisp_Object properties, string;
3516 struct gcpro gcpro1, gcpro2;
3517 int i;
3519 /* Number of args must be odd. */
3520 if ((nargs & 1) == 0 || nargs < 1)
3521 error ("Wrong number of arguments");
3523 properties = string = Qnil;
3524 GCPRO2 (properties, string);
3526 /* First argument must be a string. */
3527 CHECK_STRING (args[0]);
3528 string = Fcopy_sequence (args[0]);
3530 for (i = 1; i < nargs; i += 2)
3531 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3533 Fadd_text_properties (make_number (0),
3534 make_number (SCHARS (string)),
3535 properties, string);
3536 RETURN_UNGCPRO (string);
3540 /* Number of bytes that STRING will occupy when put into the result.
3541 MULTIBYTE is nonzero if the result should be multibyte. */
3543 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3544 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3545 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3546 : SBYTES (STRING))
3548 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3549 doc: /* Format a string out of a format-string and arguments.
3550 The first argument is a format control string.
3551 The other arguments are substituted into it to make the result, a string.
3553 The format control string may contain %-sequences meaning to substitute
3554 the next available argument:
3556 %s means print a string argument. Actually, prints any object, with `princ'.
3557 %d means print as number in decimal (%o octal, %x hex).
3558 %X is like %x, but uses upper case.
3559 %e means print a number in exponential notation.
3560 %f means print a number in decimal-point notation.
3561 %g means print a number in exponential notation
3562 or decimal-point notation, whichever uses fewer characters.
3563 %c means print a number as a single character.
3564 %S means print any object as an s-expression (using `prin1').
3566 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3567 Use %% to put a single % into the output.
3569 A %-sequence may contain optional flag, width, and precision
3570 specifiers, as follows:
3572 %<flags><width><precision>character
3574 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3576 The + flag character inserts a + before any positive number, while a
3577 space inserts a space before any positive number; these flags only
3578 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3579 The # flag means to use an alternate display form for %o, %x, %X, %e,
3580 %f, and %g sequences. The - and 0 flags affect the width specifier,
3581 as described below.
3583 The width specifier supplies a lower limit for the length of the
3584 printed representation. The padding, if any, normally goes on the
3585 left, but it goes on the right if the - flag is present. The padding
3586 character is normally a space, but it is 0 if the 0 flag is present.
3587 The - flag takes precedence over the 0 flag.
3589 For %e, %f, and %g sequences, the number after the "." in the
3590 precision specifier says how many decimal places to show; if zero, the
3591 decimal point itself is omitted. For %s and %S, the precision
3592 specifier truncates the string to the given width.
3594 usage: (format STRING &rest OBJECTS) */)
3595 (nargs, args)
3596 int nargs;
3597 register Lisp_Object *args;
3599 register int n; /* The number of the next arg to substitute */
3600 register int total; /* An estimate of the final length */
3601 char *buf, *p;
3602 register unsigned char *format, *end, *format_start;
3603 int nchars;
3604 /* Nonzero if the output should be a multibyte string,
3605 which is true if any of the inputs is one. */
3606 int multibyte = 0;
3607 /* When we make a multibyte string, we must pay attention to the
3608 byte combining problem, i.e., a byte may be combined with a
3609 multibyte charcter of the previous string. This flag tells if we
3610 must consider such a situation or not. */
3611 int maybe_combine_byte;
3612 unsigned char *this_format;
3613 /* Precision for each spec, or -1, a flag value meaning no precision
3614 was given in that spec. Element 0, corresonding to the format
3615 string itself, will not be used. Element NARGS, corresponding to
3616 no argument, *will* be assigned to in the case that a `%' and `.'
3617 occur after the final format specifier. */
3618 int *precision = (int *) (alloca((nargs + 1) * sizeof (int)));
3619 int longest_format;
3620 Lisp_Object val;
3621 int arg_intervals = 0;
3622 USE_SAFE_ALLOCA;
3624 /* discarded[I] is 1 if byte I of the format
3625 string was not copied into the output.
3626 It is 2 if byte I was not the first byte of its character. */
3627 char *discarded = 0;
3629 /* Each element records, for one argument,
3630 the start and end bytepos in the output string,
3631 and whether the argument is a string with intervals.
3632 info[0] is unused. Unused elements have -1 for start. */
3633 struct info
3635 int start, end, intervals;
3636 } *info = 0;
3638 /* It should not be necessary to GCPRO ARGS, because
3639 the caller in the interpreter should take care of that. */
3641 /* Try to determine whether the result should be multibyte.
3642 This is not always right; sometimes the result needs to be multibyte
3643 because of an object that we will pass through prin1,
3644 and in that case, we won't know it here. */
3645 for (n = 0; n < nargs; n++)
3647 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3648 multibyte = 1;
3649 /* Piggyback on this loop to initialize precision[N]. */
3650 precision[n] = -1;
3652 precision[nargs] = -1;
3654 CHECK_STRING (args[0]);
3655 /* We may have to change "%S" to "%s". */
3656 args[0] = Fcopy_sequence (args[0]);
3658 /* GC should never happen here, so abort if it does. */
3659 abort_on_gc++;
3661 /* If we start out planning a unibyte result,
3662 then discover it has to be multibyte, we jump back to retry.
3663 That can only happen from the first large while loop below. */
3664 retry:
3666 format = SDATA (args[0]);
3667 format_start = format;
3668 end = format + SBYTES (args[0]);
3669 longest_format = 0;
3671 /* Make room in result for all the non-%-codes in the control string. */
3672 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]) + 1;
3674 /* Allocate the info and discarded tables. */
3676 int nbytes = (nargs+1) * sizeof *info;
3677 int i;
3678 if (!info)
3679 info = (struct info *) alloca (nbytes);
3680 bzero (info, nbytes);
3681 for (i = 0; i <= nargs; i++)
3682 info[i].start = -1;
3683 if (!discarded)
3684 SAFE_ALLOCA (discarded, char *, SBYTES (args[0]));
3685 bzero (discarded, SBYTES (args[0]));
3688 /* Add to TOTAL enough space to hold the converted arguments. */
3690 n = 0;
3691 while (format != end)
3692 if (*format++ == '%')
3694 int thissize = 0;
3695 int actual_width = 0;
3696 unsigned char *this_format_start = format - 1;
3697 int field_width = 0;
3699 /* General format specifications look like
3701 '%' [flags] [field-width] [precision] format
3703 where
3705 flags ::= [-+ #0]+
3706 field-width ::= [0-9]+
3707 precision ::= '.' [0-9]*
3709 If a field-width is specified, it specifies to which width
3710 the output should be padded with blanks, if the output
3711 string is shorter than field-width.
3713 If precision is specified, it specifies the number of
3714 digits to print after the '.' for floats, or the max.
3715 number of chars to print from a string. */
3717 while (format != end
3718 && (*format == '-' || *format == '0' || *format == '#'
3719 || * format == ' ' || *format == '+'))
3720 ++format;
3722 if (*format >= '0' && *format <= '9')
3724 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3725 field_width = 10 * field_width + *format - '0';
3728 /* N is not incremented for another few lines below, so refer to
3729 element N+1 (which might be precision[NARGS]). */
3730 if (*format == '.')
3732 ++format;
3733 for (precision[n+1] = 0; *format >= '0' && *format <= '9'; ++format)
3734 precision[n+1] = 10 * precision[n+1] + *format - '0';
3737 /* Extra +1 for 'l' that we may need to insert into the
3738 format. */
3739 if (format - this_format_start + 2 > longest_format)
3740 longest_format = format - this_format_start + 2;
3742 if (format == end)
3743 error ("Format string ends in middle of format specifier");
3744 if (*format == '%')
3745 format++;
3746 else if (++n >= nargs)
3747 error ("Not enough arguments for format string");
3748 else if (*format == 'S')
3750 /* For `S', prin1 the argument and then treat like a string. */
3751 register Lisp_Object tem;
3752 tem = Fprin1_to_string (args[n], Qnil);
3753 if (STRING_MULTIBYTE (tem) && ! multibyte)
3755 multibyte = 1;
3756 goto retry;
3758 args[n] = tem;
3759 /* If we restart the loop, we should not come here again
3760 because args[n] is now a string and calling
3761 Fprin1_to_string on it produces superflous double
3762 quotes. So, change "%S" to "%s" now. */
3763 *format = 's';
3764 goto string;
3766 else if (SYMBOLP (args[n]))
3768 args[n] = SYMBOL_NAME (args[n]);
3769 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3771 multibyte = 1;
3772 goto retry;
3774 goto string;
3776 else if (STRINGP (args[n]))
3778 string:
3779 if (*format != 's' && *format != 'S')
3780 error ("Format specifier doesn't match argument type");
3781 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3782 to be as large as is calculated here. Easy check for
3783 the case PRECISION = 0. */
3784 thissize = precision[n] ? CONVERTED_BYTE_SIZE (multibyte, args[n]) : 0;
3785 actual_width = lisp_string_width (args[n], -1, NULL, NULL);
3787 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3788 else if (INTEGERP (args[n]) && *format != 's')
3790 /* The following loop assumes the Lisp type indicates
3791 the proper way to pass the argument.
3792 So make sure we have a flonum if the argument should
3793 be a double. */
3794 if (*format == 'e' || *format == 'f' || *format == 'g')
3795 args[n] = Ffloat (args[n]);
3796 else
3797 if (*format != 'd' && *format != 'o' && *format != 'x'
3798 && *format != 'i' && *format != 'X' && *format != 'c')
3799 error ("Invalid format operation %%%c", *format);
3801 thissize = 30 + (precision[n] > 0 ? precision[n] : 0);
3802 if (*format == 'c')
3804 if (! ASCII_CHAR_P (XINT (args[n]))
3805 /* Note: No one can remeber why we have to treat
3806 the character 0 as a multibyte character here.
3807 But, until it causes a real problem, let's
3808 don't change it. */
3809 || XINT (args[n]) == 0)
3811 if (! multibyte)
3813 multibyte = 1;
3814 goto retry;
3816 args[n] = Fchar_to_string (args[n]);
3817 thissize = SBYTES (args[n]);
3819 else if (! ASCII_BYTE_P (XINT (args[n])) && multibyte)
3821 args[n]
3822 = Fchar_to_string (Funibyte_char_to_multibyte (args[n]));
3823 thissize = SBYTES (args[n]);
3827 else if (FLOATP (args[n]) && *format != 's')
3829 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3831 if (*format != 'd' && *format != 'o' && *format != 'x'
3832 && *format != 'i' && *format != 'X' && *format != 'c')
3833 error ("Invalid format operation %%%c", *format);
3834 /* This fails unnecessarily if args[n] is bigger than
3835 most-positive-fixnum but smaller than MAXINT.
3836 These cases are important because we sometimes use floats
3837 to represent such integer values (typically such values
3838 come from UIDs or PIDs). */
3839 /* args[n] = Ftruncate (args[n], Qnil); */
3842 /* Note that we're using sprintf to print floats,
3843 so we have to take into account what that function
3844 prints. */
3845 /* Filter out flag value of -1. */
3846 thissize = (MAX_10_EXP + 100
3847 + (precision[n] > 0 ? precision[n] : 0));
3849 else
3851 /* Anything but a string, convert to a string using princ. */
3852 register Lisp_Object tem;
3853 tem = Fprin1_to_string (args[n], Qt);
3854 if (STRING_MULTIBYTE (tem) && ! multibyte)
3856 multibyte = 1;
3857 goto retry;
3859 args[n] = tem;
3860 goto string;
3863 thissize += max (0, field_width - actual_width);
3864 total += thissize + 4;
3867 abort_on_gc--;
3869 /* Now we can no longer jump to retry.
3870 TOTAL and LONGEST_FORMAT are known for certain. */
3872 this_format = (unsigned char *) alloca (longest_format + 1);
3874 /* Allocate the space for the result.
3875 Note that TOTAL is an overestimate. */
3876 SAFE_ALLOCA (buf, char *, total);
3878 p = buf;
3879 nchars = 0;
3880 n = 0;
3882 /* Scan the format and store result in BUF. */
3883 format = SDATA (args[0]);
3884 format_start = format;
3885 end = format + SBYTES (args[0]);
3886 maybe_combine_byte = 0;
3887 while (format != end)
3889 if (*format == '%')
3891 int minlen;
3892 int negative = 0;
3893 unsigned char *this_format_start = format;
3895 discarded[format - format_start] = 1;
3896 format++;
3898 while (index("-+0# ", *format))
3900 if (*format == '-')
3902 negative = 1;
3904 discarded[format - format_start] = 1;
3905 ++format;
3908 minlen = atoi (format);
3910 while ((*format >= '0' && *format <= '9') || *format == '.')
3912 discarded[format - format_start] = 1;
3913 format++;
3916 if (*format++ == '%')
3918 *p++ = '%';
3919 nchars++;
3920 continue;
3923 ++n;
3925 discarded[format - format_start - 1] = 1;
3926 info[n].start = nchars;
3928 if (STRINGP (args[n]))
3930 /* handle case (precision[n] >= 0) */
3932 int width, padding;
3933 int nbytes, start, end;
3934 int nchars_string;
3936 /* lisp_string_width ignores a precision of 0, but GNU
3937 libc functions print 0 characters when the precision
3938 is 0. Imitate libc behavior here. Changing
3939 lisp_string_width is the right thing, and will be
3940 done, but meanwhile we work with it. */
3942 if (precision[n] == 0)
3943 width = nchars_string = nbytes = 0;
3944 else if (precision[n] > 0)
3945 width = lisp_string_width (args[n], precision[n], &nchars_string, &nbytes);
3946 else
3947 { /* no precision spec given for this argument */
3948 width = lisp_string_width (args[n], -1, NULL, NULL);
3949 nbytes = SBYTES (args[n]);
3950 nchars_string = SCHARS (args[n]);
3953 /* If spec requires it, pad on right with spaces. */
3954 padding = minlen - width;
3955 if (! negative)
3956 while (padding-- > 0)
3958 *p++ = ' ';
3959 ++nchars;
3962 info[n].start = start = nchars;
3963 nchars += nchars_string;
3964 end = nchars;
3966 if (p > buf
3967 && multibyte
3968 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3969 && STRING_MULTIBYTE (args[n])
3970 && !CHAR_HEAD_P (SREF (args[n], 0)))
3971 maybe_combine_byte = 1;
3973 p += copy_text (SDATA (args[n]), p,
3974 nbytes,
3975 STRING_MULTIBYTE (args[n]), multibyte);
3977 info[n].end = nchars;
3979 if (negative)
3980 while (padding-- > 0)
3982 *p++ = ' ';
3983 nchars++;
3986 /* If this argument has text properties, record where
3987 in the result string it appears. */
3988 if (STRING_INTERVALS (args[n]))
3989 info[n].intervals = arg_intervals = 1;
3991 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3993 int this_nchars;
3995 bcopy (this_format_start, this_format,
3996 format - this_format_start);
3997 this_format[format - this_format_start] = 0;
3999 if (format[-1] == 'e' || format[-1] == 'f' || format[-1] == 'g')
4000 sprintf (p, this_format, XFLOAT_DATA (args[n]));
4001 else
4003 if (sizeof (EMACS_INT) > sizeof (int)
4004 && format[-1] != 'c')
4006 /* Insert 'l' before format spec. */
4007 this_format[format - this_format_start]
4008 = this_format[format - this_format_start - 1];
4009 this_format[format - this_format_start - 1] = 'l';
4010 this_format[format - this_format_start + 1] = 0;
4013 if (INTEGERP (args[n]))
4015 if (format[-1] == 'c')
4016 sprintf (p, this_format, (int) XINT (args[n]));
4017 else if (format[-1] == 'd')
4018 sprintf (p, this_format, XINT (args[n]));
4019 /* Don't sign-extend for octal or hex printing. */
4020 else
4021 sprintf (p, this_format, XUINT (args[n]));
4023 else if (format[-1] == 'c')
4024 sprintf (p, this_format, (int) XFLOAT_DATA (args[n]));
4025 else if (format[-1] == 'd')
4026 /* Maybe we should use "%1.0f" instead so it also works
4027 for values larger than MAXINT. */
4028 sprintf (p, this_format, (EMACS_INT) XFLOAT_DATA (args[n]));
4029 else
4030 /* Don't sign-extend for octal or hex printing. */
4031 sprintf (p, this_format, (EMACS_UINT) XFLOAT_DATA (args[n]));
4034 if (p > buf
4035 && multibyte
4036 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
4037 && !CHAR_HEAD_P (*((unsigned char *) p)))
4038 maybe_combine_byte = 1;
4039 this_nchars = strlen (p);
4040 if (multibyte)
4041 p += str_to_multibyte (p, buf + total - 1 - p, this_nchars);
4042 else
4043 p += this_nchars;
4044 nchars += this_nchars;
4045 info[n].end = nchars;
4049 else if (STRING_MULTIBYTE (args[0]))
4051 /* Copy a whole multibyte character. */
4052 if (p > buf
4053 && multibyte
4054 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
4055 && !CHAR_HEAD_P (*format))
4056 maybe_combine_byte = 1;
4057 *p++ = *format++;
4058 while (! CHAR_HEAD_P (*format))
4060 discarded[format - format_start] = 2;
4061 *p++ = *format++;
4063 nchars++;
4065 else if (multibyte)
4067 /* Convert a single-byte character to multibyte. */
4068 int len = copy_text (format, p, 1, 0, 1);
4070 p += len;
4071 format++;
4072 nchars++;
4074 else
4075 *p++ = *format++, nchars++;
4078 if (p > buf + total)
4079 abort ();
4081 if (maybe_combine_byte)
4082 nchars = multibyte_chars_in_text (buf, p - buf);
4083 val = make_specified_string (buf, nchars, p - buf, multibyte);
4085 /* If we allocated BUF with malloc, free it too. */
4086 SAFE_FREE ();
4088 /* If the format string has text properties, or any of the string
4089 arguments has text properties, set up text properties of the
4090 result string. */
4092 if (STRING_INTERVALS (args[0]) || arg_intervals)
4094 Lisp_Object len, new_len, props;
4095 struct gcpro gcpro1;
4097 /* Add text properties from the format string. */
4098 len = make_number (SCHARS (args[0]));
4099 props = text_property_list (args[0], make_number (0), len, Qnil);
4100 GCPRO1 (props);
4102 if (CONSP (props))
4104 int bytepos = 0, position = 0, translated = 0, argn = 1;
4105 Lisp_Object list;
4107 /* Adjust the bounds of each text property
4108 to the proper start and end in the output string. */
4110 /* Put the positions in PROPS in increasing order, so that
4111 we can do (effectively) one scan through the position
4112 space of the format string. */
4113 props = Fnreverse (props);
4115 /* BYTEPOS is the byte position in the format string,
4116 POSITION is the untranslated char position in it,
4117 TRANSLATED is the translated char position in BUF,
4118 and ARGN is the number of the next arg we will come to. */
4119 for (list = props; CONSP (list); list = XCDR (list))
4121 Lisp_Object item;
4122 int pos;
4124 item = XCAR (list);
4126 /* First adjust the property start position. */
4127 pos = XINT (XCAR (item));
4129 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4130 up to this position. */
4131 for (; position < pos; bytepos++)
4133 if (! discarded[bytepos])
4134 position++, translated++;
4135 else if (discarded[bytepos] == 1)
4137 position++;
4138 if (translated == info[argn].start)
4140 translated += info[argn].end - info[argn].start;
4141 argn++;
4146 XSETCAR (item, make_number (translated));
4148 /* Likewise adjust the property end position. */
4149 pos = XINT (XCAR (XCDR (item)));
4151 for (; position < pos; bytepos++)
4153 if (! discarded[bytepos])
4154 position++, translated++;
4155 else if (discarded[bytepos] == 1)
4157 position++;
4158 if (translated == info[argn].start)
4160 translated += info[argn].end - info[argn].start;
4161 argn++;
4166 XSETCAR (XCDR (item), make_number (translated));
4169 add_text_properties_from_list (val, props, make_number (0));
4172 /* Add text properties from arguments. */
4173 if (arg_intervals)
4174 for (n = 1; n < nargs; ++n)
4175 if (info[n].intervals)
4177 len = make_number (SCHARS (args[n]));
4178 new_len = make_number (info[n].end - info[n].start);
4179 props = text_property_list (args[n], make_number (0), len, Qnil);
4180 props = extend_property_ranges (props, new_len);
4181 /* If successive arguments have properties, be sure that
4182 the value of `composition' property be the copy. */
4183 if (n > 1 && info[n - 1].end)
4184 make_composition_value_copy (props);
4185 add_text_properties_from_list (val, props,
4186 make_number (info[n].start));
4189 UNGCPRO;
4192 return val;
4195 Lisp_Object
4196 format2 (string1, arg0, arg1)
4197 char *string1;
4198 Lisp_Object arg0, arg1;
4200 Lisp_Object args[3];
4201 args[0] = build_string (string1);
4202 args[1] = arg0;
4203 args[2] = arg1;
4204 return Fformat (3, args);
4207 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4208 doc: /* Return t if two characters match, optionally ignoring case.
4209 Both arguments must be characters (i.e. integers).
4210 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4211 (c1, c2)
4212 register Lisp_Object c1, c2;
4214 int i1, i2;
4215 /* Check they're chars, not just integers, otherwise we could get array
4216 bounds violations in DOWNCASE. */
4217 CHECK_CHARACTER (c1);
4218 CHECK_CHARACTER (c2);
4220 if (XINT (c1) == XINT (c2))
4221 return Qt;
4222 if (NILP (current_buffer->case_fold_search))
4223 return Qnil;
4225 /* Do these in separate statements,
4226 then compare the variables.
4227 because of the way DOWNCASE uses temp variables. */
4228 i1 = XFASTINT (c1);
4229 if (NILP (current_buffer->enable_multibyte_characters)
4230 && ! ASCII_CHAR_P (i1))
4232 MAKE_CHAR_MULTIBYTE (i1);
4234 i2 = XFASTINT (c2);
4235 if (NILP (current_buffer->enable_multibyte_characters)
4236 && ! ASCII_CHAR_P (i2))
4238 MAKE_CHAR_MULTIBYTE (i2);
4240 i1 = DOWNCASE (i1);
4241 i2 = DOWNCASE (i2);
4242 return (i1 == i2 ? Qt : Qnil);
4245 /* Transpose the markers in two regions of the current buffer, and
4246 adjust the ones between them if necessary (i.e.: if the regions
4247 differ in size).
4249 START1, END1 are the character positions of the first region.
4250 START1_BYTE, END1_BYTE are the byte positions.
4251 START2, END2 are the character positions of the second region.
4252 START2_BYTE, END2_BYTE are the byte positions.
4254 Traverses the entire marker list of the buffer to do so, adding an
4255 appropriate amount to some, subtracting from some, and leaving the
4256 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4258 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4260 static void
4261 transpose_markers (start1, end1, start2, end2,
4262 start1_byte, end1_byte, start2_byte, end2_byte)
4263 register int start1, end1, start2, end2;
4264 register int start1_byte, end1_byte, start2_byte, end2_byte;
4266 register int amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4267 register struct Lisp_Marker *marker;
4269 /* Update point as if it were a marker. */
4270 if (PT < start1)
4272 else if (PT < end1)
4273 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4274 PT_BYTE + (end2_byte - end1_byte));
4275 else if (PT < start2)
4276 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4277 (PT_BYTE + (end2_byte - start2_byte)
4278 - (end1_byte - start1_byte)));
4279 else if (PT < end2)
4280 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4281 PT_BYTE - (start2_byte - start1_byte));
4283 /* We used to adjust the endpoints here to account for the gap, but that
4284 isn't good enough. Even if we assume the caller has tried to move the
4285 gap out of our way, it might still be at start1 exactly, for example;
4286 and that places it `inside' the interval, for our purposes. The amount
4287 of adjustment is nontrivial if there's a `denormalized' marker whose
4288 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4289 the dirty work to Fmarker_position, below. */
4291 /* The difference between the region's lengths */
4292 diff = (end2 - start2) - (end1 - start1);
4293 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4295 /* For shifting each marker in a region by the length of the other
4296 region plus the distance between the regions. */
4297 amt1 = (end2 - start2) + (start2 - end1);
4298 amt2 = (end1 - start1) + (start2 - end1);
4299 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4300 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4302 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4304 mpos = marker->bytepos;
4305 if (mpos >= start1_byte && mpos < end2_byte)
4307 if (mpos < end1_byte)
4308 mpos += amt1_byte;
4309 else if (mpos < start2_byte)
4310 mpos += diff_byte;
4311 else
4312 mpos -= amt2_byte;
4313 marker->bytepos = mpos;
4315 mpos = marker->charpos;
4316 if (mpos >= start1 && mpos < end2)
4318 if (mpos < end1)
4319 mpos += amt1;
4320 else if (mpos < start2)
4321 mpos += diff;
4322 else
4323 mpos -= amt2;
4325 marker->charpos = mpos;
4329 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4330 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4331 The regions should not be overlapping, because the size of the buffer is
4332 never changed in a transposition.
4334 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4335 any markers that happen to be located in the regions.
4337 Transposing beyond buffer boundaries is an error. */)
4338 (startr1, endr1, startr2, endr2, leave_markers)
4339 Lisp_Object startr1, endr1, startr2, endr2, leave_markers;
4341 register EMACS_INT start1, end1, start2, end2;
4342 EMACS_INT start1_byte, start2_byte, len1_byte, len2_byte;
4343 EMACS_INT gap, len1, len_mid, len2;
4344 unsigned char *start1_addr, *start2_addr, *temp;
4346 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4347 Lisp_Object buf;
4349 XSETBUFFER (buf, current_buffer);
4350 cur_intv = BUF_INTERVALS (current_buffer);
4352 validate_region (&startr1, &endr1);
4353 validate_region (&startr2, &endr2);
4355 start1 = XFASTINT (startr1);
4356 end1 = XFASTINT (endr1);
4357 start2 = XFASTINT (startr2);
4358 end2 = XFASTINT (endr2);
4359 gap = GPT;
4361 /* Swap the regions if they're reversed. */
4362 if (start2 < end1)
4364 register int glumph = start1;
4365 start1 = start2;
4366 start2 = glumph;
4367 glumph = end1;
4368 end1 = end2;
4369 end2 = glumph;
4372 len1 = end1 - start1;
4373 len2 = end2 - start2;
4375 if (start2 < end1)
4376 error ("Transposed regions overlap");
4377 else if (start1 == end1 || start2 == end2)
4378 error ("Transposed region has length 0");
4380 /* The possibilities are:
4381 1. Adjacent (contiguous) regions, or separate but equal regions
4382 (no, really equal, in this case!), or
4383 2. Separate regions of unequal size.
4385 The worst case is usually No. 2. It means that (aside from
4386 potential need for getting the gap out of the way), there also
4387 needs to be a shifting of the text between the two regions. So
4388 if they are spread far apart, we are that much slower... sigh. */
4390 /* It must be pointed out that the really studly thing to do would
4391 be not to move the gap at all, but to leave it in place and work
4392 around it if necessary. This would be extremely efficient,
4393 especially considering that people are likely to do
4394 transpositions near where they are working interactively, which
4395 is exactly where the gap would be found. However, such code
4396 would be much harder to write and to read. So, if you are
4397 reading this comment and are feeling squirrely, by all means have
4398 a go! I just didn't feel like doing it, so I will simply move
4399 the gap the minimum distance to get it out of the way, and then
4400 deal with an unbroken array. */
4402 /* Make sure the gap won't interfere, by moving it out of the text
4403 we will operate on. */
4404 if (start1 < gap && gap < end2)
4406 if (gap - start1 < end2 - gap)
4407 move_gap (start1);
4408 else
4409 move_gap (end2);
4412 start1_byte = CHAR_TO_BYTE (start1);
4413 start2_byte = CHAR_TO_BYTE (start2);
4414 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4415 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
4417 #ifdef BYTE_COMBINING_DEBUG
4418 if (end1 == start2)
4420 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4421 len2_byte, start1, start1_byte)
4422 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4423 len1_byte, end2, start2_byte + len2_byte)
4424 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4425 len1_byte, end2, start2_byte + len2_byte))
4426 abort ();
4428 else
4430 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4431 len2_byte, start1, start1_byte)
4432 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4433 len1_byte, start2, start2_byte)
4434 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4435 len2_byte, end1, start1_byte + len1_byte)
4436 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4437 len1_byte, end2, start2_byte + len2_byte))
4438 abort ();
4440 #endif
4442 /* Hmmm... how about checking to see if the gap is large
4443 enough to use as the temporary storage? That would avoid an
4444 allocation... interesting. Later, don't fool with it now. */
4446 /* Working without memmove, for portability (sigh), so must be
4447 careful of overlapping subsections of the array... */
4449 if (end1 == start2) /* adjacent regions */
4451 modify_region (current_buffer, start1, end2, 0);
4452 record_change (start1, len1 + len2);
4454 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4455 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4456 /* Don't use Fset_text_properties: that can cause GC, which can
4457 clobber objects stored in the tmp_intervals. */
4458 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4459 if (!NULL_INTERVAL_P (tmp_interval3))
4460 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4462 /* First region smaller than second. */
4463 if (len1_byte < len2_byte)
4465 USE_SAFE_ALLOCA;
4467 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4469 /* Don't precompute these addresses. We have to compute them
4470 at the last minute, because the relocating allocator might
4471 have moved the buffer around during the xmalloc. */
4472 start1_addr = BYTE_POS_ADDR (start1_byte);
4473 start2_addr = BYTE_POS_ADDR (start2_byte);
4475 bcopy (start2_addr, temp, len2_byte);
4476 bcopy (start1_addr, start1_addr + len2_byte, len1_byte);
4477 bcopy (temp, start1_addr, len2_byte);
4478 SAFE_FREE ();
4480 else
4481 /* First region not smaller than second. */
4483 USE_SAFE_ALLOCA;
4485 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4486 start1_addr = BYTE_POS_ADDR (start1_byte);
4487 start2_addr = BYTE_POS_ADDR (start2_byte);
4488 bcopy (start1_addr, temp, len1_byte);
4489 bcopy (start2_addr, start1_addr, len2_byte);
4490 bcopy (temp, start1_addr + len2_byte, len1_byte);
4491 SAFE_FREE ();
4493 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4494 len1, current_buffer, 0);
4495 graft_intervals_into_buffer (tmp_interval2, start1,
4496 len2, current_buffer, 0);
4497 update_compositions (start1, start1 + len2, CHECK_BORDER);
4498 update_compositions (start1 + len2, end2, CHECK_TAIL);
4500 /* Non-adjacent regions, because end1 != start2, bleagh... */
4501 else
4503 len_mid = start2_byte - (start1_byte + len1_byte);
4505 if (len1_byte == len2_byte)
4506 /* Regions are same size, though, how nice. */
4508 USE_SAFE_ALLOCA;
4510 modify_region (current_buffer, start1, end1, 0);
4511 modify_region (current_buffer, start2, end2, 0);
4512 record_change (start1, len1);
4513 record_change (start2, len2);
4514 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4515 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4517 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4518 if (!NULL_INTERVAL_P (tmp_interval3))
4519 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4521 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4522 if (!NULL_INTERVAL_P (tmp_interval3))
4523 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4525 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4526 start1_addr = BYTE_POS_ADDR (start1_byte);
4527 start2_addr = BYTE_POS_ADDR (start2_byte);
4528 bcopy (start1_addr, temp, len1_byte);
4529 bcopy (start2_addr, start1_addr, len2_byte);
4530 bcopy (temp, start2_addr, len1_byte);
4531 SAFE_FREE ();
4533 graft_intervals_into_buffer (tmp_interval1, start2,
4534 len1, current_buffer, 0);
4535 graft_intervals_into_buffer (tmp_interval2, start1,
4536 len2, current_buffer, 0);
4539 else if (len1_byte < len2_byte) /* Second region larger than first */
4540 /* Non-adjacent & unequal size, area between must also be shifted. */
4542 USE_SAFE_ALLOCA;
4544 modify_region (current_buffer, start1, end2, 0);
4545 record_change (start1, (end2 - start1));
4546 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4547 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4548 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4550 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4551 if (!NULL_INTERVAL_P (tmp_interval3))
4552 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4554 /* holds region 2 */
4555 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4556 start1_addr = BYTE_POS_ADDR (start1_byte);
4557 start2_addr = BYTE_POS_ADDR (start2_byte);
4558 bcopy (start2_addr, temp, len2_byte);
4559 bcopy (start1_addr, start1_addr + len_mid + len2_byte, len1_byte);
4560 safe_bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
4561 bcopy (temp, start1_addr, len2_byte);
4562 SAFE_FREE ();
4564 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4565 len1, current_buffer, 0);
4566 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4567 len_mid, current_buffer, 0);
4568 graft_intervals_into_buffer (tmp_interval2, start1,
4569 len2, current_buffer, 0);
4571 else
4572 /* Second region smaller than first. */
4574 USE_SAFE_ALLOCA;
4576 record_change (start1, (end2 - start1));
4577 modify_region (current_buffer, start1, end2, 0);
4579 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4580 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4581 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4583 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4584 if (!NULL_INTERVAL_P (tmp_interval3))
4585 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4587 /* holds region 1 */
4588 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4589 start1_addr = BYTE_POS_ADDR (start1_byte);
4590 start2_addr = BYTE_POS_ADDR (start2_byte);
4591 bcopy (start1_addr, temp, len1_byte);
4592 bcopy (start2_addr, start1_addr, len2_byte);
4593 bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
4594 bcopy (temp, start1_addr + len2_byte + len_mid, len1_byte);
4595 SAFE_FREE ();
4597 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4598 len1, current_buffer, 0);
4599 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4600 len_mid, current_buffer, 0);
4601 graft_intervals_into_buffer (tmp_interval2, start1,
4602 len2, current_buffer, 0);
4605 update_compositions (start1, start1 + len2, CHECK_BORDER);
4606 update_compositions (end2 - len1, end2, CHECK_BORDER);
4609 /* When doing multiple transpositions, it might be nice
4610 to optimize this. Perhaps the markers in any one buffer
4611 should be organized in some sorted data tree. */
4612 if (NILP (leave_markers))
4614 transpose_markers (start1, end1, start2, end2,
4615 start1_byte, start1_byte + len1_byte,
4616 start2_byte, start2_byte + len2_byte);
4617 fix_start_end_in_overlays (start1, end2);
4620 signal_after_change (start1, end2 - start1, end2 - start1);
4621 return Qnil;
4625 void
4626 syms_of_editfns ()
4628 environbuf = 0;
4629 initial_tz = 0;
4631 Qbuffer_access_fontify_functions
4632 = intern_c_string ("buffer-access-fontify-functions");
4633 staticpro (&Qbuffer_access_fontify_functions);
4635 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
4636 doc: /* Non-nil means text motion commands don't notice fields. */);
4637 Vinhibit_field_text_motion = Qnil;
4639 DEFVAR_LISP ("buffer-access-fontify-functions",
4640 &Vbuffer_access_fontify_functions,
4641 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
4642 Each function is called with two arguments which specify the range
4643 of the buffer being accessed. */);
4644 Vbuffer_access_fontify_functions = Qnil;
4647 Lisp_Object obuf;
4648 extern Lisp_Object Vprin1_to_string_buffer;
4649 obuf = Fcurrent_buffer ();
4650 /* Do this here, because init_buffer_once is too early--it won't work. */
4651 Fset_buffer (Vprin1_to_string_buffer);
4652 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4653 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
4654 Qnil);
4655 Fset_buffer (obuf);
4658 DEFVAR_LISP ("buffer-access-fontified-property",
4659 &Vbuffer_access_fontified_property,
4660 doc: /* Property which (if non-nil) indicates text has been fontified.
4661 `buffer-substring' need not call the `buffer-access-fontify-functions'
4662 functions if all the text being accessed has this property. */);
4663 Vbuffer_access_fontified_property = Qnil;
4665 DEFVAR_LISP ("system-name", &Vsystem_name,
4666 doc: /* The host name of the machine Emacs is running on. */);
4668 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
4669 doc: /* The full name of the user logged in. */);
4671 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
4672 doc: /* The user's name, taken from environment variables if possible. */);
4674 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
4675 doc: /* The user's name, based upon the real uid only. */);
4677 DEFVAR_LISP ("operating-system-release", &Voperating_system_release,
4678 doc: /* The release of the operating system Emacs is running on. */);
4680 defsubr (&Spropertize);
4681 defsubr (&Schar_equal);
4682 defsubr (&Sgoto_char);
4683 defsubr (&Sstring_to_char);
4684 defsubr (&Schar_to_string);
4685 defsubr (&Sbuffer_substring);
4686 defsubr (&Sbuffer_substring_no_properties);
4687 defsubr (&Sbuffer_string);
4689 defsubr (&Spoint_marker);
4690 defsubr (&Smark_marker);
4691 defsubr (&Spoint);
4692 defsubr (&Sregion_beginning);
4693 defsubr (&Sregion_end);
4695 staticpro (&Qfield);
4696 Qfield = intern_c_string ("field");
4697 staticpro (&Qboundary);
4698 Qboundary = intern_c_string ("boundary");
4699 defsubr (&Sfield_beginning);
4700 defsubr (&Sfield_end);
4701 defsubr (&Sfield_string);
4702 defsubr (&Sfield_string_no_properties);
4703 defsubr (&Sdelete_field);
4704 defsubr (&Sconstrain_to_field);
4706 defsubr (&Sline_beginning_position);
4707 defsubr (&Sline_end_position);
4709 /* defsubr (&Smark); */
4710 /* defsubr (&Sset_mark); */
4711 defsubr (&Ssave_excursion);
4712 defsubr (&Ssave_current_buffer);
4714 defsubr (&Sbufsize);
4715 defsubr (&Spoint_max);
4716 defsubr (&Spoint_min);
4717 defsubr (&Spoint_min_marker);
4718 defsubr (&Spoint_max_marker);
4719 defsubr (&Sgap_position);
4720 defsubr (&Sgap_size);
4721 defsubr (&Sposition_bytes);
4722 defsubr (&Sbyte_to_position);
4724 defsubr (&Sbobp);
4725 defsubr (&Seobp);
4726 defsubr (&Sbolp);
4727 defsubr (&Seolp);
4728 defsubr (&Sfollowing_char);
4729 defsubr (&Sprevious_char);
4730 defsubr (&Schar_after);
4731 defsubr (&Schar_before);
4732 defsubr (&Sinsert);
4733 defsubr (&Sinsert_before_markers);
4734 defsubr (&Sinsert_and_inherit);
4735 defsubr (&Sinsert_and_inherit_before_markers);
4736 defsubr (&Sinsert_char);
4737 defsubr (&Sinsert_byte);
4739 defsubr (&Suser_login_name);
4740 defsubr (&Suser_real_login_name);
4741 defsubr (&Suser_uid);
4742 defsubr (&Suser_real_uid);
4743 defsubr (&Suser_full_name);
4744 defsubr (&Semacs_pid);
4745 defsubr (&Scurrent_time);
4746 defsubr (&Sget_internal_run_time);
4747 defsubr (&Sformat_time_string);
4748 defsubr (&Sfloat_time);
4749 defsubr (&Sdecode_time);
4750 defsubr (&Sencode_time);
4751 defsubr (&Scurrent_time_string);
4752 defsubr (&Scurrent_time_zone);
4753 defsubr (&Sset_time_zone_rule);
4754 defsubr (&Ssystem_name);
4755 defsubr (&Smessage);
4756 defsubr (&Smessage_box);
4757 defsubr (&Smessage_or_box);
4758 defsubr (&Scurrent_message);
4759 defsubr (&Sformat);
4761 defsubr (&Sinsert_buffer_substring);
4762 defsubr (&Scompare_buffer_substrings);
4763 defsubr (&Ssubst_char_in_region);
4764 defsubr (&Stranslate_region_internal);
4765 defsubr (&Sdelete_region);
4766 defsubr (&Sdelete_and_extract_region);
4767 defsubr (&Swiden);
4768 defsubr (&Snarrow_to_region);
4769 defsubr (&Ssave_restriction);
4770 defsubr (&Stranspose_regions);
4773 /* arch-tag: fc3827d8-6f60-4067-b11e-c3218031b018
4774 (do not change this comment) */