Nuke arch-tags.
[emacs.git] / src / editfns.c
blobcd313f754f167c77ed4cdc8101d89a9ad237626e
1 /* Lisp functions pertaining to editing.
3 Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
5 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include <config.h>
24 #include <sys/types.h>
25 #include <stdio.h>
26 #include <setjmp.h>
28 #ifdef HAVE_PWD_H
29 #include <pwd.h>
30 #endif
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
36 #ifdef HAVE_SYS_UTSNAME_H
37 #include <sys/utsname.h>
38 #endif
40 #include "lisp.h"
42 /* systime.h includes <sys/time.h> which, on some systems, is required
43 for <sys/resource.h>; thus systime.h must be included before
44 <sys/resource.h> */
45 #include "systime.h"
47 #if defined HAVE_SYS_RESOURCE_H
48 #include <sys/resource.h>
49 #endif
51 #include <ctype.h>
53 #include "intervals.h"
54 #include "buffer.h"
55 #include "character.h"
56 #include "coding.h"
57 #include "frame.h"
58 #include "window.h"
59 #include "blockinput.h"
61 #ifdef STDC_HEADERS
62 #include <float.h>
63 #define MAX_10_EXP DBL_MAX_10_EXP
64 #else
65 #define MAX_10_EXP 310
66 #endif
68 #ifndef NULL
69 #define NULL 0
70 #endif
72 #ifndef USER_FULL_NAME
73 #define USER_FULL_NAME pw->pw_gecos
74 #endif
76 #ifndef USE_CRT_DLL
77 extern char **environ;
78 #endif
80 #define TM_YEAR_BASE 1900
82 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
83 asctime to have well-defined behavior. */
84 #ifndef TM_YEAR_IN_ASCTIME_RANGE
85 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
86 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
87 #endif
89 extern size_t emacs_strftimeu (char *, size_t, const char *,
90 const struct tm *, int);
92 #ifdef WINDOWSNT
93 extern Lisp_Object w32_get_internal_run_time (void);
94 #endif
96 static int tm_diff (struct tm *, struct tm *);
97 static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
98 EMACS_INT *, Lisp_Object, EMACS_INT *);
99 static void update_buffer_properties (EMACS_INT, EMACS_INT);
100 static Lisp_Object region_limit (int);
101 static size_t emacs_memftimeu (char *, size_t, const char *,
102 size_t, const struct tm *, int);
103 static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
104 void (*) (Lisp_Object, EMACS_INT,
105 EMACS_INT, EMACS_INT,
106 EMACS_INT, int),
107 int, int, Lisp_Object *);
108 static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
109 static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
110 static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
111 EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
113 Lisp_Object Vbuffer_access_fontify_functions;
114 Lisp_Object Qbuffer_access_fontify_functions;
115 Lisp_Object Vbuffer_access_fontified_property;
117 Lisp_Object Fuser_full_name (Lisp_Object);
119 /* Non-nil means don't stop at field boundary in text motion commands. */
121 Lisp_Object Vinhibit_field_text_motion;
123 /* Some static data, and a function to initialize it for each run */
125 Lisp_Object Vsystem_name;
126 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
127 Lisp_Object Vuser_full_name; /* full name of current user */
128 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER */
129 Lisp_Object Voperating_system_release; /* Operating System Release */
131 /* Symbol for the text property used to mark fields. */
133 Lisp_Object Qfield;
135 /* A special value for Qfield properties. */
137 Lisp_Object Qboundary;
140 void
141 init_editfns (void)
143 char *user_name;
144 register unsigned char *p;
145 struct passwd *pw; /* password entry for the current user */
146 Lisp_Object tem;
148 /* Set up system_name even when dumping. */
149 init_system_name ();
151 #ifndef CANNOT_DUMP
152 /* Don't bother with this on initial start when just dumping out */
153 if (!initialized)
154 return;
155 #endif /* not CANNOT_DUMP */
157 pw = (struct passwd *) getpwuid (getuid ());
158 #ifdef MSDOS
159 /* We let the real user name default to "root" because that's quite
160 accurate on MSDOG and because it lets Emacs find the init file.
161 (The DVX libraries override the Djgpp libraries here.) */
162 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
163 #else
164 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
165 #endif
167 /* Get the effective user name, by consulting environment variables,
168 or the effective uid if those are unset. */
169 user_name = (char *) getenv ("LOGNAME");
170 if (!user_name)
171 #ifdef WINDOWSNT
172 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
173 #else /* WINDOWSNT */
174 user_name = (char *) getenv ("USER");
175 #endif /* WINDOWSNT */
176 if (!user_name)
178 pw = (struct passwd *) getpwuid (geteuid ());
179 user_name = (char *) (pw ? pw->pw_name : "unknown");
181 Vuser_login_name = build_string (user_name);
183 /* If the user name claimed in the environment vars differs from
184 the real uid, use the claimed name to find the full name. */
185 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
186 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
187 : Vuser_login_name);
189 p = (unsigned char *) getenv ("NAME");
190 if (p)
191 Vuser_full_name = build_string (p);
192 else if (NILP (Vuser_full_name))
193 Vuser_full_name = build_string ("unknown");
195 #ifdef HAVE_SYS_UTSNAME_H
197 struct utsname uts;
198 uname (&uts);
199 Voperating_system_release = build_string (uts.release);
201 #else
202 Voperating_system_release = Qnil;
203 #endif
206 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
207 doc: /* Convert arg CHAR to a string containing that character.
208 usage: (char-to-string CHAR) */)
209 (Lisp_Object character)
211 int len;
212 unsigned char str[MAX_MULTIBYTE_LENGTH];
214 CHECK_CHARACTER (character);
216 len = CHAR_STRING (XFASTINT (character), str);
217 return make_string_from_bytes (str, 1, len);
220 DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
221 doc: /* Convert arg BYTE to a unibyte string containing that byte. */)
222 (Lisp_Object byte)
224 unsigned char b;
225 CHECK_NUMBER (byte);
226 if (XINT (byte) < 0 || XINT (byte) > 255)
227 error ("Invalid byte");
228 b = XINT (byte);
229 return make_string_from_bytes (&b, 1, 1);
232 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
233 doc: /* Convert arg STRING to a character, the first character of that string.
234 A multibyte character is handled correctly. */)
235 (register Lisp_Object string)
237 register Lisp_Object val;
238 CHECK_STRING (string);
239 if (SCHARS (string))
241 if (STRING_MULTIBYTE (string))
242 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
243 else
244 XSETFASTINT (val, SREF (string, 0));
246 else
247 XSETFASTINT (val, 0);
248 return val;
251 static Lisp_Object
252 buildmark (EMACS_INT charpos, EMACS_INT bytepos)
254 register Lisp_Object mark;
255 mark = Fmake_marker ();
256 set_marker_both (mark, Qnil, charpos, bytepos);
257 return mark;
260 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
261 doc: /* Return value of point, as an integer.
262 Beginning of buffer is position (point-min). */)
263 (void)
265 Lisp_Object temp;
266 XSETFASTINT (temp, PT);
267 return temp;
270 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
271 doc: /* Return value of point, as a marker object. */)
272 (void)
274 return buildmark (PT, PT_BYTE);
277 EMACS_INT
278 clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
280 if (num < lower)
281 return lower;
282 else if (num > upper)
283 return upper;
284 else
285 return num;
288 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
289 doc: /* Set point to POSITION, a number or marker.
290 Beginning of buffer is position (point-min), end is (point-max).
292 The return value is POSITION. */)
293 (register Lisp_Object position)
295 EMACS_INT pos;
297 if (MARKERP (position)
298 && current_buffer == XMARKER (position)->buffer)
300 pos = marker_position (position);
301 if (pos < BEGV)
302 SET_PT_BOTH (BEGV, BEGV_BYTE);
303 else if (pos > ZV)
304 SET_PT_BOTH (ZV, ZV_BYTE);
305 else
306 SET_PT_BOTH (pos, marker_byte_position (position));
308 return position;
311 CHECK_NUMBER_COERCE_MARKER (position);
313 pos = clip_to_bounds (BEGV, XINT (position), ZV);
314 SET_PT (pos);
315 return position;
319 /* Return the start or end position of the region.
320 BEGINNINGP non-zero means return the start.
321 If there is no region active, signal an error. */
323 static Lisp_Object
324 region_limit (int beginningp)
326 Lisp_Object m;
328 if (!NILP (Vtransient_mark_mode)
329 && NILP (Vmark_even_if_inactive)
330 && NILP (current_buffer->mark_active))
331 xsignal0 (Qmark_inactive);
333 m = Fmarker_position (current_buffer->mark);
334 if (NILP (m))
335 error ("The mark is not set now, so there is no region");
337 if ((PT < XFASTINT (m)) == (beginningp != 0))
338 m = make_number (PT);
339 return m;
342 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
343 doc: /* Return the integer value of point or mark, whichever is smaller. */)
344 (void)
346 return region_limit (1);
349 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
350 doc: /* Return the integer value of point or mark, whichever is larger. */)
351 (void)
353 return region_limit (0);
356 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
357 doc: /* Return this buffer's mark, as a marker object.
358 Watch out! Moving this marker changes the mark position.
359 If you set the marker not to point anywhere, the buffer will have no mark. */)
360 (void)
362 return current_buffer->mark;
366 /* Find all the overlays in the current buffer that touch position POS.
367 Return the number found, and store them in a vector in VEC
368 of length LEN. */
370 static int
371 overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
373 Lisp_Object overlay, start, end;
374 struct Lisp_Overlay *tail;
375 EMACS_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 (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
429 CHECK_NUMBER_COERCE_MARKER (position);
431 if (NILP (object))
432 XSETBUFFER (object, current_buffer);
433 else if (WINDOWP (object))
434 object = XWINDOW (object)->buffer;
436 if (!BUFFERP (object))
437 /* pos-property only makes sense in buffers right now, since strings
438 have no overlays and no notion of insertion for which stickiness
439 could be obeyed. */
440 return Fget_text_property (position, prop, object);
441 else
443 EMACS_INT posn = XINT (position);
444 int noverlays;
445 Lisp_Object *overlay_vec, tem;
446 struct buffer *obuf = current_buffer;
448 set_buffer_temp (XBUFFER (object));
450 /* First try with room for 40 overlays. */
451 noverlays = 40;
452 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
453 noverlays = overlays_around (posn, overlay_vec, noverlays);
455 /* If there are more than 40,
456 make enough space for all, and try again. */
457 if (noverlays > 40)
459 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
460 noverlays = overlays_around (posn, overlay_vec, noverlays);
462 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
464 set_buffer_temp (obuf);
466 /* Now check the overlays in order of decreasing priority. */
467 while (--noverlays >= 0)
469 Lisp_Object ol = overlay_vec[noverlays];
470 tem = Foverlay_get (ol, prop);
471 if (!NILP (tem))
473 /* Check the overlay is indeed active at point. */
474 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
475 if ((OVERLAY_POSITION (start) == posn
476 && XMARKER (start)->insertion_type == 1)
477 || (OVERLAY_POSITION (finish) == posn
478 && XMARKER (finish)->insertion_type == 0))
479 ; /* The overlay will not cover a char inserted at point. */
480 else
482 return tem;
487 { /* Now check the text properties. */
488 int stickiness = text_property_stickiness (prop, position, object);
489 if (stickiness > 0)
490 return Fget_text_property (position, prop, object);
491 else if (stickiness < 0
492 && XINT (position) > BUF_BEGV (XBUFFER (object)))
493 return Fget_text_property (make_number (XINT (position) - 1),
494 prop, object);
495 else
496 return Qnil;
501 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
502 the value of point is used instead. If BEG or END is null,
503 means don't store the beginning or end of the field.
505 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
506 results; they do not effect boundary behavior.
508 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
509 position of a field, then the beginning of the previous field is
510 returned instead of the beginning of POS's field (since the end of a
511 field is actually also the beginning of the next input field, this
512 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
513 true case, if two fields are separated by a field with the special
514 value `boundary', and POS lies within it, then the two separated
515 fields are considered to be adjacent, and POS between them, when
516 finding the beginning and ending of the "merged" field.
518 Either BEG or END may be 0, in which case the corresponding value
519 is not stored. */
521 static void
522 find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
523 Lisp_Object beg_limit,
524 EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
526 /* Fields right before and after the point. */
527 Lisp_Object before_field, after_field;
528 /* 1 if POS counts as the start of a field. */
529 int at_field_start = 0;
530 /* 1 if POS counts as the end of a field. */
531 int at_field_end = 0;
533 if (NILP (pos))
534 XSETFASTINT (pos, PT);
535 else
536 CHECK_NUMBER_COERCE_MARKER (pos);
538 after_field
539 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
540 before_field
541 = (XFASTINT (pos) > BEGV
542 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
543 Qfield, Qnil, NULL)
544 /* Using nil here would be a more obvious choice, but it would
545 fail when the buffer starts with a non-sticky field. */
546 : after_field);
548 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
549 and POS is at beginning of a field, which can also be interpreted
550 as the end of the previous field. Note that the case where if
551 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
552 more natural one; then we avoid treating the beginning of a field
553 specially. */
554 if (NILP (merge_at_boundary))
556 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
557 if (!EQ (field, after_field))
558 at_field_end = 1;
559 if (!EQ (field, before_field))
560 at_field_start = 1;
561 if (NILP (field) && at_field_start && at_field_end)
562 /* If an inserted char would have a nil field while the surrounding
563 text is non-nil, we're probably not looking at a
564 zero-length field, but instead at a non-nil field that's
565 not intended for editing (such as comint's prompts). */
566 at_field_end = at_field_start = 0;
569 /* Note about special `boundary' fields:
571 Consider the case where the point (`.') is between the fields `x' and `y':
573 xxxx.yyyy
575 In this situation, if merge_at_boundary is true, we consider the
576 `x' and `y' fields as forming one big merged field, and so the end
577 of the field is the end of `y'.
579 However, if `x' and `y' are separated by a special `boundary' field
580 (a field with a `field' char-property of 'boundary), then we ignore
581 this special field when merging adjacent fields. Here's the same
582 situation, but with a `boundary' field between the `x' and `y' fields:
584 xxx.BBBByyyy
586 Here, if point is at the end of `x', the beginning of `y', or
587 anywhere in-between (within the `boundary' field), we merge all
588 three fields and consider the beginning as being the beginning of
589 the `x' field, and the end as being the end of the `y' field. */
591 if (beg)
593 if (at_field_start)
594 /* POS is at the edge of a field, and we should consider it as
595 the beginning of the following field. */
596 *beg = XFASTINT (pos);
597 else
598 /* Find the previous field boundary. */
600 Lisp_Object p = pos;
601 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
602 /* Skip a `boundary' field. */
603 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
604 beg_limit);
606 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
607 beg_limit);
608 *beg = NILP (p) ? BEGV : XFASTINT (p);
612 if (end)
614 if (at_field_end)
615 /* POS is at the edge of a field, and we should consider it as
616 the end of the previous field. */
617 *end = XFASTINT (pos);
618 else
619 /* Find the next field boundary. */
621 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
622 /* Skip a `boundary' field. */
623 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
624 end_limit);
626 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
627 end_limit);
628 *end = NILP (pos) ? ZV : XFASTINT (pos);
634 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
635 doc: /* Delete the field surrounding POS.
636 A field is a region of text with the same `field' property.
637 If POS is nil, the value of point is used for POS. */)
638 (Lisp_Object pos)
640 EMACS_INT beg, end;
641 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
642 if (beg != end)
643 del_range (beg, end);
644 return Qnil;
647 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
648 doc: /* Return the contents of the field surrounding POS as a string.
649 A field is a region of text with the same `field' property.
650 If POS is nil, the value of point is used for POS. */)
651 (Lisp_Object pos)
653 EMACS_INT beg, end;
654 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
655 return make_buffer_string (beg, end, 1);
658 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
659 doc: /* Return the contents of the field around POS, without text properties.
660 A field is a region of text with the same `field' property.
661 If POS is nil, the value of point is used for POS. */)
662 (Lisp_Object pos)
664 EMACS_INT beg, end;
665 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
666 return make_buffer_string (beg, end, 0);
669 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
670 doc: /* Return the beginning of the field surrounding POS.
671 A field is a region of text with the same `field' property.
672 If POS is nil, the value of point is used for POS.
673 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
674 field, then the beginning of the *previous* field is returned.
675 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
676 is before LIMIT, then LIMIT will be returned instead. */)
677 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
679 EMACS_INT beg;
680 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
681 return make_number (beg);
684 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
685 doc: /* Return the end of the field surrounding POS.
686 A field is a region of text with the same `field' property.
687 If POS is nil, the value of point is used for POS.
688 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
689 then the end of the *following* field is returned.
690 If LIMIT is non-nil, it is a buffer position; if the end of the field
691 is after LIMIT, then LIMIT will be returned instead. */)
692 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
694 EMACS_INT end;
695 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
696 return make_number (end);
699 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
700 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
702 A field is a region of text with the same `field' property.
703 If NEW-POS is nil, then the current point is used instead, and set to the
704 constrained position if that is different.
706 If OLD-POS is at the boundary of two fields, then the allowable
707 positions for NEW-POS depends on the value of the optional argument
708 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
709 constrained to the field that has the same `field' char-property
710 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
711 is non-nil, NEW-POS is constrained to the union of the two adjacent
712 fields. Additionally, if two fields are separated by another field with
713 the special value `boundary', then any point within this special field is
714 also considered to be `on the boundary'.
716 If the optional argument ONLY-IN-LINE is non-nil and constraining
717 NEW-POS would move it to a different line, NEW-POS is returned
718 unconstrained. This useful for commands that move by line, like
719 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
720 only in the case where they can still move to the right line.
722 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
723 a non-nil property of that name, then any field boundaries are ignored.
725 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
726 (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
728 /* If non-zero, then the original point, before re-positioning. */
729 EMACS_INT orig_point = 0;
730 int fwd;
731 Lisp_Object prev_old, prev_new;
733 if (NILP (new_pos))
734 /* Use the current point, and afterwards, set it. */
736 orig_point = PT;
737 XSETFASTINT (new_pos, PT);
740 CHECK_NUMBER_COERCE_MARKER (new_pos);
741 CHECK_NUMBER_COERCE_MARKER (old_pos);
743 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
745 prev_old = make_number (XFASTINT (old_pos) - 1);
746 prev_new = make_number (XFASTINT (new_pos) - 1);
748 if (NILP (Vinhibit_field_text_motion)
749 && !EQ (new_pos, old_pos)
750 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
751 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
752 /* To recognize field boundaries, we must also look at the
753 previous positions; we could use `get_pos_property'
754 instead, but in itself that would fail inside non-sticky
755 fields (like comint prompts). */
756 || (XFASTINT (new_pos) > BEGV
757 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
758 || (XFASTINT (old_pos) > BEGV
759 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
760 && (NILP (inhibit_capture_property)
761 /* Field boundaries are again a problem; but now we must
762 decide the case exactly, so we need to call
763 `get_pos_property' as well. */
764 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
765 && (XFASTINT (old_pos) <= BEGV
766 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
767 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
768 /* It is possible that NEW_POS is not within the same field as
769 OLD_POS; try to move NEW_POS so that it is. */
771 int shortage;
772 Lisp_Object field_bound;
774 if (fwd)
775 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
776 else
777 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
779 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
780 other side of NEW_POS, which would mean that NEW_POS is
781 already acceptable, and it's not necessary to constrain it
782 to FIELD_BOUND. */
783 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
784 /* NEW_POS should be constrained, but only if either
785 ONLY_IN_LINE is nil (in which case any constraint is OK),
786 or NEW_POS and FIELD_BOUND are on the same line (in which
787 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
788 && (NILP (only_in_line)
789 /* This is the ONLY_IN_LINE case, check that NEW_POS and
790 FIELD_BOUND are on the same line by seeing whether
791 there's an intervening newline or not. */
792 || (scan_buffer ('\n',
793 XFASTINT (new_pos), XFASTINT (field_bound),
794 fwd ? -1 : 1, &shortage, 1),
795 shortage != 0)))
796 /* Constrain NEW_POS to FIELD_BOUND. */
797 new_pos = field_bound;
799 if (orig_point && XFASTINT (new_pos) != orig_point)
800 /* The NEW_POS argument was originally nil, so automatically set PT. */
801 SET_PT (XFASTINT (new_pos));
804 return new_pos;
808 DEFUN ("line-beginning-position",
809 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
810 doc: /* Return the character position of the first character on the current line.
811 With argument N not nil or 1, move forward N - 1 lines first.
812 If scan reaches end of buffer, return that position.
814 The returned position is of the first character in the logical order,
815 i.e. the one that has the smallest character position.
817 This function constrains the returned position to the current field
818 unless that would be on a different line than the original,
819 unconstrained result. If N is nil or 1, and a front-sticky field
820 starts at point, the scan stops as soon as it starts. To ignore field
821 boundaries bind `inhibit-field-text-motion' to t.
823 This function does not move point. */)
824 (Lisp_Object n)
826 EMACS_INT orig, orig_byte, end;
827 int count = SPECPDL_INDEX ();
828 specbind (Qinhibit_point_motion_hooks, Qt);
830 if (NILP (n))
831 XSETFASTINT (n, 1);
832 else
833 CHECK_NUMBER (n);
835 orig = PT;
836 orig_byte = PT_BYTE;
837 Fforward_line (make_number (XINT (n) - 1));
838 end = PT;
840 SET_PT_BOTH (orig, orig_byte);
842 unbind_to (count, Qnil);
844 /* Return END constrained to the current input field. */
845 return Fconstrain_to_field (make_number (end), make_number (orig),
846 XINT (n) != 1 ? Qt : Qnil,
847 Qt, Qnil);
850 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
851 doc: /* Return the character position of the last character on the current line.
852 With argument N not nil or 1, move forward N - 1 lines first.
853 If scan reaches end of buffer, return that position.
855 The returned position is of the last character in the logical order,
856 i.e. the character whose buffer position is the largest one.
858 This function constrains the returned position to the current field
859 unless that would be on a different line than the original,
860 unconstrained result. If N is nil or 1, and a rear-sticky field ends
861 at point, the scan stops as soon as it starts. To ignore field
862 boundaries bind `inhibit-field-text-motion' to t.
864 This function does not move point. */)
865 (Lisp_Object n)
867 EMACS_INT end_pos;
868 EMACS_INT orig = PT;
870 if (NILP (n))
871 XSETFASTINT (n, 1);
872 else
873 CHECK_NUMBER (n);
875 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
877 /* Return END_POS constrained to the current input field. */
878 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
879 Qnil, Qt, Qnil);
883 Lisp_Object
884 save_excursion_save (void)
886 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
887 == current_buffer);
889 return Fcons (Fpoint_marker (),
890 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
891 Fcons (visible ? Qt : Qnil,
892 Fcons (current_buffer->mark_active,
893 selected_window))));
896 Lisp_Object
897 save_excursion_restore (Lisp_Object info)
899 Lisp_Object tem, tem1, omark, nmark;
900 struct gcpro gcpro1, gcpro2, gcpro3;
901 int visible_p;
903 tem = Fmarker_buffer (XCAR (info));
904 /* If buffer being returned to is now deleted, avoid error */
905 /* Otherwise could get error here while unwinding to top level
906 and crash */
907 /* In that case, Fmarker_buffer returns nil now. */
908 if (NILP (tem))
909 return Qnil;
911 omark = nmark = Qnil;
912 GCPRO3 (info, omark, nmark);
914 Fset_buffer (tem);
916 /* Point marker. */
917 tem = XCAR (info);
918 Fgoto_char (tem);
919 unchain_marker (XMARKER (tem));
921 /* Mark marker. */
922 info = XCDR (info);
923 tem = XCAR (info);
924 omark = Fmarker_position (current_buffer->mark);
925 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
926 nmark = Fmarker_position (tem);
927 unchain_marker (XMARKER (tem));
929 /* visible */
930 info = XCDR (info);
931 visible_p = !NILP (XCAR (info));
933 #if 0 /* We used to make the current buffer visible in the selected window
934 if that was true previously. That avoids some anomalies.
935 But it creates others, and it wasn't documented, and it is simpler
936 and cleaner never to alter the window/buffer connections. */
937 tem1 = Fcar (tem);
938 if (!NILP (tem1)
939 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
940 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
941 #endif /* 0 */
943 /* Mark active */
944 info = XCDR (info);
945 tem = XCAR (info);
946 tem1 = current_buffer->mark_active;
947 current_buffer->mark_active = tem;
949 if (!NILP (Vrun_hooks))
951 /* If mark is active now, and either was not active
952 or was at a different place, run the activate hook. */
953 if (! NILP (current_buffer->mark_active))
955 if (! EQ (omark, nmark))
956 call1 (Vrun_hooks, intern ("activate-mark-hook"));
958 /* If mark has ceased to be active, run deactivate hook. */
959 else if (! NILP (tem1))
960 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
963 /* If buffer was visible in a window, and a different window was
964 selected, and the old selected window is still showing this
965 buffer, restore point in that window. */
966 tem = XCDR (info);
967 if (visible_p
968 && !EQ (tem, selected_window)
969 && (tem1 = XWINDOW (tem)->buffer,
970 (/* Window is live... */
971 BUFFERP (tem1)
972 /* ...and it shows the current buffer. */
973 && XBUFFER (tem1) == current_buffer)))
974 Fset_window_point (tem, make_number (PT));
976 UNGCPRO;
977 return Qnil;
980 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
981 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
982 Executes BODY just like `progn'.
983 The values of point, mark and the current buffer are restored
984 even in case of abnormal exit (throw or error).
985 The state of activation of the mark is also restored.
987 This construct does not save `deactivate-mark', and therefore
988 functions that change the buffer will still cause deactivation
989 of the mark at the end of the command. To prevent that, bind
990 `deactivate-mark' with `let'.
992 If you only want to save the current buffer but not point nor mark,
993 then just use `save-current-buffer', or even `with-current-buffer'.
995 usage: (save-excursion &rest BODY) */)
996 (Lisp_Object args)
998 register Lisp_Object val;
999 int count = SPECPDL_INDEX ();
1001 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1003 val = Fprogn (args);
1004 return unbind_to (count, val);
1007 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1008 doc: /* Save the current buffer; execute BODY; restore the current buffer.
1009 Executes BODY just like `progn'.
1010 usage: (save-current-buffer &rest BODY) */)
1011 (Lisp_Object args)
1013 Lisp_Object val;
1014 int count = SPECPDL_INDEX ();
1016 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1018 val = Fprogn (args);
1019 return unbind_to (count, val);
1022 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1023 doc: /* Return the number of characters in the current buffer.
1024 If BUFFER, return the number of characters in that buffer instead. */)
1025 (Lisp_Object buffer)
1027 if (NILP (buffer))
1028 return make_number (Z - BEG);
1029 else
1031 CHECK_BUFFER (buffer);
1032 return make_number (BUF_Z (XBUFFER (buffer))
1033 - BUF_BEG (XBUFFER (buffer)));
1037 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1038 doc: /* Return the minimum permissible value of point in the current buffer.
1039 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1040 (void)
1042 Lisp_Object temp;
1043 XSETFASTINT (temp, BEGV);
1044 return temp;
1047 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1048 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1049 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1050 (void)
1052 return buildmark (BEGV, BEGV_BYTE);
1055 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1056 doc: /* Return the maximum permissible value of point in the current buffer.
1057 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1058 is in effect, in which case it is less. */)
1059 (void)
1061 Lisp_Object temp;
1062 XSETFASTINT (temp, ZV);
1063 return temp;
1066 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1067 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1068 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1069 is in effect, in which case it is less. */)
1070 (void)
1072 return buildmark (ZV, ZV_BYTE);
1075 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1076 doc: /* Return the position of the gap, in the current buffer.
1077 See also `gap-size'. */)
1078 (void)
1080 Lisp_Object temp;
1081 XSETFASTINT (temp, GPT);
1082 return temp;
1085 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1086 doc: /* Return the size of the current buffer's gap.
1087 See also `gap-position'. */)
1088 (void)
1090 Lisp_Object temp;
1091 XSETFASTINT (temp, GAP_SIZE);
1092 return temp;
1095 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1096 doc: /* Return the byte position for character position POSITION.
1097 If POSITION is out of range, the value is nil. */)
1098 (Lisp_Object position)
1100 CHECK_NUMBER_COERCE_MARKER (position);
1101 if (XINT (position) < BEG || XINT (position) > Z)
1102 return Qnil;
1103 return make_number (CHAR_TO_BYTE (XINT (position)));
1106 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1107 doc: /* Return the character position for byte position BYTEPOS.
1108 If BYTEPOS is out of range, the value is nil. */)
1109 (Lisp_Object bytepos)
1111 CHECK_NUMBER (bytepos);
1112 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1113 return Qnil;
1114 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1117 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1118 doc: /* Return the character following point, as a number.
1119 At the end of the buffer or accessible region, return 0. */)
1120 (void)
1122 Lisp_Object temp;
1123 if (PT >= ZV)
1124 XSETFASTINT (temp, 0);
1125 else
1126 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1127 return temp;
1130 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1131 doc: /* Return the character preceding point, as a number.
1132 At the beginning of the buffer or accessible region, return 0. */)
1133 (void)
1135 Lisp_Object temp;
1136 if (PT <= BEGV)
1137 XSETFASTINT (temp, 0);
1138 else if (!NILP (current_buffer->enable_multibyte_characters))
1140 EMACS_INT pos = PT_BYTE;
1141 DEC_POS (pos);
1142 XSETFASTINT (temp, FETCH_CHAR (pos));
1144 else
1145 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1146 return temp;
1149 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1150 doc: /* Return t if point is at the beginning of the buffer.
1151 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1152 (void)
1154 if (PT == BEGV)
1155 return Qt;
1156 return Qnil;
1159 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1160 doc: /* Return t if point is at the end of the buffer.
1161 If the buffer is narrowed, this means the end of the narrowed part. */)
1162 (void)
1164 if (PT == ZV)
1165 return Qt;
1166 return Qnil;
1169 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1170 doc: /* Return t if point is at the beginning of a line. */)
1171 (void)
1173 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1174 return Qt;
1175 return Qnil;
1178 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1179 doc: /* Return t if point is at the end of a line.
1180 `End of a line' includes point being at the end of the buffer. */)
1181 (void)
1183 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1184 return Qt;
1185 return Qnil;
1188 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1189 doc: /* Return character in current buffer at position POS.
1190 POS is an integer or a marker and defaults to point.
1191 If POS is out of range, the value is nil. */)
1192 (Lisp_Object pos)
1194 register EMACS_INT pos_byte;
1196 if (NILP (pos))
1198 pos_byte = PT_BYTE;
1199 XSETFASTINT (pos, PT);
1202 if (MARKERP (pos))
1204 pos_byte = marker_byte_position (pos);
1205 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1206 return Qnil;
1208 else
1210 CHECK_NUMBER_COERCE_MARKER (pos);
1211 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1212 return Qnil;
1214 pos_byte = CHAR_TO_BYTE (XINT (pos));
1217 return make_number (FETCH_CHAR (pos_byte));
1220 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1221 doc: /* Return character in current buffer preceding position POS.
1222 POS is an integer or a marker and defaults to point.
1223 If POS is out of range, the value is nil. */)
1224 (Lisp_Object pos)
1226 register Lisp_Object val;
1227 register EMACS_INT pos_byte;
1229 if (NILP (pos))
1231 pos_byte = PT_BYTE;
1232 XSETFASTINT (pos, PT);
1235 if (MARKERP (pos))
1237 pos_byte = marker_byte_position (pos);
1239 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1240 return Qnil;
1242 else
1244 CHECK_NUMBER_COERCE_MARKER (pos);
1246 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1247 return Qnil;
1249 pos_byte = CHAR_TO_BYTE (XINT (pos));
1252 if (!NILP (current_buffer->enable_multibyte_characters))
1254 DEC_POS (pos_byte);
1255 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1257 else
1259 pos_byte--;
1260 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1262 return val;
1265 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1266 doc: /* Return the name under which the user logged in, as a string.
1267 This is based on the effective uid, not the real uid.
1268 Also, if the environment variables LOGNAME or USER are set,
1269 that determines the value of this function.
1271 If optional argument UID is an integer or a float, return the login name
1272 of the user with that uid, or nil if there is no such user. */)
1273 (Lisp_Object uid)
1275 struct passwd *pw;
1276 uid_t id;
1278 /* Set up the user name info if we didn't do it before.
1279 (That can happen if Emacs is dumpable
1280 but you decide to run `temacs -l loadup' and not dump. */
1281 if (INTEGERP (Vuser_login_name))
1282 init_editfns ();
1284 if (NILP (uid))
1285 return Vuser_login_name;
1287 id = (uid_t)XFLOATINT (uid);
1288 BLOCK_INPUT;
1289 pw = (struct passwd *) getpwuid (id);
1290 UNBLOCK_INPUT;
1291 return (pw ? build_string (pw->pw_name) : Qnil);
1294 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1295 0, 0, 0,
1296 doc: /* Return the name of the user's real uid, as a string.
1297 This ignores the environment variables LOGNAME and USER, so it differs from
1298 `user-login-name' when running under `su'. */)
1299 (void)
1301 /* Set up the user name info if we didn't do it before.
1302 (That can happen if Emacs is dumpable
1303 but you decide to run `temacs -l loadup' and not dump. */
1304 if (INTEGERP (Vuser_login_name))
1305 init_editfns ();
1306 return Vuser_real_login_name;
1309 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1310 doc: /* Return the effective uid of Emacs.
1311 Value is an integer or a float, depending on the value. */)
1312 (void)
1314 /* Assignment to EMACS_INT stops GCC whining about limited range of
1315 data type. */
1316 EMACS_INT euid = geteuid ();
1318 /* Make sure we don't produce a negative UID due to signed integer
1319 overflow. */
1320 if (euid < 0)
1321 return make_float ((double)geteuid ());
1322 return make_fixnum_or_float (euid);
1325 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1326 doc: /* Return the real uid of Emacs.
1327 Value is an integer or a float, depending on the value. */)
1328 (void)
1330 /* Assignment to EMACS_INT stops GCC whining about limited range of
1331 data type. */
1332 EMACS_INT uid = getuid ();
1334 /* Make sure we don't produce a negative UID due to signed integer
1335 overflow. */
1336 if (uid < 0)
1337 return make_float ((double)getuid ());
1338 return make_fixnum_or_float (uid);
1341 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1342 doc: /* Return the full name of the user logged in, as a string.
1343 If the full name corresponding to Emacs's userid is not known,
1344 return "unknown".
1346 If optional argument UID is an integer or float, return the full name
1347 of the user with that uid, or nil if there is no such user.
1348 If UID is a string, return the full name of the user with that login
1349 name, or nil if there is no such user. */)
1350 (Lisp_Object uid)
1352 struct passwd *pw;
1353 register unsigned char *p, *q;
1354 Lisp_Object full;
1356 if (NILP (uid))
1357 return Vuser_full_name;
1358 else if (NUMBERP (uid))
1360 BLOCK_INPUT;
1361 pw = (struct passwd *) getpwuid ((uid_t) XFLOATINT (uid));
1362 UNBLOCK_INPUT;
1364 else if (STRINGP (uid))
1366 BLOCK_INPUT;
1367 pw = (struct passwd *) getpwnam (SDATA (uid));
1368 UNBLOCK_INPUT;
1370 else
1371 error ("Invalid UID specification");
1373 if (!pw)
1374 return Qnil;
1376 p = (unsigned char *) USER_FULL_NAME;
1377 /* Chop off everything after the first comma. */
1378 q = (unsigned char *) strchr (p, ',');
1379 full = make_string (p, q ? q - p : strlen (p));
1381 #ifdef AMPERSAND_FULL_NAME
1382 p = SDATA (full);
1383 q = (unsigned char *) strchr (p, '&');
1384 /* Substitute the login name for the &, upcasing the first character. */
1385 if (q)
1387 register unsigned char *r;
1388 Lisp_Object login;
1390 login = Fuser_login_name (make_number (pw->pw_uid));
1391 r = (unsigned char *) alloca (strlen (p) + SCHARS (login) + 1);
1392 memcpy (r, p, q - p);
1393 r[q - p] = 0;
1394 strcat (r, SDATA (login));
1395 r[q - p] = UPCASE (r[q - p]);
1396 strcat (r, q + 1);
1397 full = build_string (r);
1399 #endif /* AMPERSAND_FULL_NAME */
1401 return full;
1404 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1405 doc: /* Return the host name of the machine you are running on, as a string. */)
1406 (void)
1408 return Vsystem_name;
1411 /* For the benefit of callers who don't want to include lisp.h */
1413 const char *
1414 get_system_name (void)
1416 if (STRINGP (Vsystem_name))
1417 return (const char *) SDATA (Vsystem_name);
1418 else
1419 return "";
1422 const char *
1423 get_operating_system_release (void)
1425 if (STRINGP (Voperating_system_release))
1426 return (char *) SDATA (Voperating_system_release);
1427 else
1428 return "";
1431 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1432 doc: /* Return the process ID of Emacs, as an integer. */)
1433 (void)
1435 return make_number (getpid ());
1438 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1439 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1440 The time is returned as a list of three integers. The first has the
1441 most significant 16 bits of the seconds, while the second has the
1442 least significant 16 bits. The third integer gives the microsecond
1443 count.
1445 The microsecond count is zero on systems that do not provide
1446 resolution finer than a second. */)
1447 (void)
1449 EMACS_TIME t;
1451 EMACS_GET_TIME (t);
1452 return list3 (make_number ((EMACS_SECS (t) >> 16) & 0xffff),
1453 make_number ((EMACS_SECS (t) >> 0) & 0xffff),
1454 make_number (EMACS_USECS (t)));
1457 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1458 0, 0, 0,
1459 doc: /* Return the current run time used by Emacs.
1460 The time is returned as a list of three integers. The first has the
1461 most significant 16 bits of the seconds, while the second has the
1462 least significant 16 bits. The third integer gives the microsecond
1463 count.
1465 On systems that can't determine the run time, `get-internal-run-time'
1466 does the same thing as `current-time'. The microsecond count is zero
1467 on systems that do not provide resolution finer than a second. */)
1468 (void)
1470 #ifdef HAVE_GETRUSAGE
1471 struct rusage usage;
1472 int secs, usecs;
1474 if (getrusage (RUSAGE_SELF, &usage) < 0)
1475 /* This shouldn't happen. What action is appropriate? */
1476 xsignal0 (Qerror);
1478 /* Sum up user time and system time. */
1479 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1480 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1481 if (usecs >= 1000000)
1483 usecs -= 1000000;
1484 secs++;
1487 return list3 (make_number ((secs >> 16) & 0xffff),
1488 make_number ((secs >> 0) & 0xffff),
1489 make_number (usecs));
1490 #else /* ! HAVE_GETRUSAGE */
1491 #ifdef WINDOWSNT
1492 return w32_get_internal_run_time ();
1493 #else /* ! WINDOWSNT */
1494 return Fcurrent_time ();
1495 #endif /* WINDOWSNT */
1496 #endif /* HAVE_GETRUSAGE */
1501 lisp_time_argument (Lisp_Object specified_time, time_t *result, int *usec)
1503 if (NILP (specified_time))
1505 if (usec)
1507 EMACS_TIME t;
1509 EMACS_GET_TIME (t);
1510 *usec = EMACS_USECS (t);
1511 *result = EMACS_SECS (t);
1512 return 1;
1514 else
1515 return time (result) != -1;
1517 else
1519 Lisp_Object high, low;
1520 high = Fcar (specified_time);
1521 CHECK_NUMBER (high);
1522 low = Fcdr (specified_time);
1523 if (CONSP (low))
1525 if (usec)
1527 Lisp_Object usec_l = Fcdr (low);
1528 if (CONSP (usec_l))
1529 usec_l = Fcar (usec_l);
1530 if (NILP (usec_l))
1531 *usec = 0;
1532 else
1534 CHECK_NUMBER (usec_l);
1535 *usec = XINT (usec_l);
1538 low = Fcar (low);
1540 else if (usec)
1541 *usec = 0;
1542 CHECK_NUMBER (low);
1543 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1544 return *result >> 16 == XINT (high);
1548 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1549 doc: /* Return the current time, as a float number of seconds since the epoch.
1550 If SPECIFIED-TIME is given, it is the time to convert to float
1551 instead of the current time. The argument should have the form
1552 (HIGH LOW) or (HIGH LOW USEC). Thus, you can use times obtained from
1553 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1554 have the form (HIGH . LOW), but this is considered obsolete.
1556 WARNING: Since the result is floating point, it may not be exact.
1557 If precise time stamps are required, use either `current-time',
1558 or (if you need time as a string) `format-time-string'. */)
1559 (Lisp_Object specified_time)
1561 time_t sec;
1562 int usec;
1564 if (! lisp_time_argument (specified_time, &sec, &usec))
1565 error ("Invalid time specification");
1567 return make_float ((sec * 1e6 + usec) / 1e6);
1570 /* Write information into buffer S of size MAXSIZE, according to the
1571 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1572 Default to Universal Time if UT is nonzero, local time otherwise.
1573 Return the number of bytes written, not including the terminating
1574 '\0'. If S is NULL, nothing will be written anywhere; so to
1575 determine how many bytes would be written, use NULL for S and
1576 ((size_t) -1) for MAXSIZE.
1578 This function behaves like emacs_strftimeu, except it allows null
1579 bytes in FORMAT. */
1580 static size_t
1581 emacs_memftimeu (char *s, size_t maxsize, const char *format, size_t format_len, const struct tm *tp, int ut)
1583 size_t total = 0;
1585 /* Loop through all the null-terminated strings in the format
1586 argument. Normally there's just one null-terminated string, but
1587 there can be arbitrarily many, concatenated together, if the
1588 format contains '\0' bytes. emacs_strftimeu stops at the first
1589 '\0' byte so we must invoke it separately for each such string. */
1590 for (;;)
1592 size_t len;
1593 size_t result;
1595 if (s)
1596 s[0] = '\1';
1598 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1600 if (s)
1602 if (result == 0 && s[0] != '\0')
1603 return 0;
1604 s += result + 1;
1607 maxsize -= result + 1;
1608 total += result;
1609 len = strlen (format);
1610 if (len == format_len)
1611 return total;
1612 total++;
1613 format += len + 1;
1614 format_len -= len + 1;
1618 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1619 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1620 TIME is specified as (HIGH LOW . IGNORED), as returned by
1621 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1622 is also still accepted.
1623 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1624 as Universal Time; nil means describe TIME in the local time zone.
1625 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1626 by text that describes the specified date and time in TIME:
1628 %Y is the year, %y within the century, %C the century.
1629 %G is the year corresponding to the ISO week, %g within the century.
1630 %m is the numeric month.
1631 %b and %h are the locale's abbreviated month name, %B the full name.
1632 %d is the day of the month, zero-padded, %e is blank-padded.
1633 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1634 %a is the locale's abbreviated name of the day of week, %A the full name.
1635 %U is the week number starting on Sunday, %W starting on Monday,
1636 %V according to ISO 8601.
1637 %j is the day of the year.
1639 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1640 only blank-padded, %l is like %I blank-padded.
1641 %p is the locale's equivalent of either AM or PM.
1642 %M is the minute.
1643 %S is the second.
1644 %Z is the time zone name, %z is the numeric form.
1645 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1647 %c is the locale's date and time format.
1648 %x is the locale's "preferred" date format.
1649 %D is like "%m/%d/%y".
1651 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1652 %X is the locale's "preferred" time format.
1654 Finally, %n is a newline, %t is a tab, %% is a literal %.
1656 Certain flags and modifiers are available with some format controls.
1657 The flags are `_', `-', `^' and `#'. For certain characters X,
1658 %_X is like %X, but padded with blanks; %-X is like %X,
1659 but without padding. %^X is like %X, but with all textual
1660 characters up-cased; %#X is like %X, but with letter-case of
1661 all textual characters reversed.
1662 %NX (where N stands for an integer) is like %X,
1663 but takes up at least N (a number) positions.
1664 The modifiers are `E' and `O'. For certain characters X,
1665 %EX is a locale's alternative version of %X;
1666 %OX is like %X, but uses the locale's number symbols.
1668 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1669 (Lisp_Object format_string, Lisp_Object time, Lisp_Object universal)
1671 time_t value;
1672 int size;
1673 struct tm *tm;
1674 int ut = ! NILP (universal);
1676 CHECK_STRING (format_string);
1678 if (! lisp_time_argument (time, &value, NULL))
1679 error ("Invalid time specification");
1681 format_string = code_convert_string_norecord (format_string,
1682 Vlocale_coding_system, 1);
1684 /* This is probably enough. */
1685 size = SBYTES (format_string) * 6 + 50;
1687 BLOCK_INPUT;
1688 tm = ut ? gmtime (&value) : localtime (&value);
1689 UNBLOCK_INPUT;
1690 if (! tm)
1691 error ("Specified time is not representable");
1693 synchronize_system_time_locale ();
1695 while (1)
1697 char *buf = (char *) alloca (size + 1);
1698 int result;
1700 buf[0] = '\1';
1701 BLOCK_INPUT;
1702 result = emacs_memftimeu (buf, size, SDATA (format_string),
1703 SBYTES (format_string),
1704 tm, ut);
1705 UNBLOCK_INPUT;
1706 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1707 return code_convert_string_norecord (make_unibyte_string (buf, result),
1708 Vlocale_coding_system, 0);
1710 /* If buffer was too small, make it bigger and try again. */
1711 BLOCK_INPUT;
1712 result = emacs_memftimeu (NULL, (size_t) -1,
1713 SDATA (format_string),
1714 SBYTES (format_string),
1715 tm, ut);
1716 UNBLOCK_INPUT;
1717 size = result + 1;
1721 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1722 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1723 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1724 as from `current-time' and `file-attributes', or nil to use the
1725 current time. The obsolete form (HIGH . LOW) is also still accepted.
1726 The list has the following nine members: SEC is an integer between 0
1727 and 60; SEC is 60 for a leap second, which only some operating systems
1728 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1729 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1730 integer between 1 and 12. YEAR is an integer indicating the
1731 four-digit year. DOW is the day of week, an integer between 0 and 6,
1732 where 0 is Sunday. DST is t if daylight saving time is in effect,
1733 otherwise nil. ZONE is an integer indicating the number of seconds
1734 east of Greenwich. (Note that Common Lisp has different meanings for
1735 DOW and ZONE.) */)
1736 (Lisp_Object specified_time)
1738 time_t time_spec;
1739 struct tm save_tm;
1740 struct tm *decoded_time;
1741 Lisp_Object list_args[9];
1743 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1744 error ("Invalid time specification");
1746 BLOCK_INPUT;
1747 decoded_time = localtime (&time_spec);
1748 UNBLOCK_INPUT;
1749 if (! decoded_time)
1750 error ("Specified time is not representable");
1751 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1752 XSETFASTINT (list_args[1], decoded_time->tm_min);
1753 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1754 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1755 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1756 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1757 cast below avoids overflow in int arithmetics. */
1758 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) decoded_time->tm_year);
1759 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1760 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1762 /* Make a copy, in case gmtime modifies the struct. */
1763 save_tm = *decoded_time;
1764 BLOCK_INPUT;
1765 decoded_time = gmtime (&time_spec);
1766 UNBLOCK_INPUT;
1767 if (decoded_time == 0)
1768 list_args[8] = Qnil;
1769 else
1770 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1771 return Flist (9, list_args);
1774 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1775 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1776 This is the reverse operation of `decode-time', which see.
1777 ZONE defaults to the current time zone rule. This can
1778 be a string or t (as from `set-time-zone-rule'), or it can be a list
1779 \(as from `current-time-zone') or an integer (as from `decode-time')
1780 applied without consideration for daylight saving time.
1782 You can pass more than 7 arguments; then the first six arguments
1783 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1784 The intervening arguments are ignored.
1785 This feature lets (apply 'encode-time (decode-time ...)) work.
1787 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1788 for example, a DAY of 0 means the day preceding the given month.
1789 Year numbers less than 100 are treated just like other year numbers.
1790 If you want them to stand for years in this century, you must do that yourself.
1792 Years before 1970 are not guaranteed to work. On some systems,
1793 year values as low as 1901 do work.
1795 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1796 (int nargs, register Lisp_Object *args)
1798 time_t time;
1799 struct tm tm;
1800 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1802 CHECK_NUMBER (args[0]); /* second */
1803 CHECK_NUMBER (args[1]); /* minute */
1804 CHECK_NUMBER (args[2]); /* hour */
1805 CHECK_NUMBER (args[3]); /* day */
1806 CHECK_NUMBER (args[4]); /* month */
1807 CHECK_NUMBER (args[5]); /* year */
1809 tm.tm_sec = XINT (args[0]);
1810 tm.tm_min = XINT (args[1]);
1811 tm.tm_hour = XINT (args[2]);
1812 tm.tm_mday = XINT (args[3]);
1813 tm.tm_mon = XINT (args[4]) - 1;
1814 tm.tm_year = XINT (args[5]) - TM_YEAR_BASE;
1815 tm.tm_isdst = -1;
1817 if (CONSP (zone))
1818 zone = Fcar (zone);
1819 if (NILP (zone))
1821 BLOCK_INPUT;
1822 time = mktime (&tm);
1823 UNBLOCK_INPUT;
1825 else
1827 char tzbuf[100];
1828 const char *tzstring;
1829 char **oldenv = environ, **newenv;
1831 if (EQ (zone, Qt))
1832 tzstring = "UTC0";
1833 else if (STRINGP (zone))
1834 tzstring = (char *) SDATA (zone);
1835 else if (INTEGERP (zone))
1837 int abszone = eabs (XINT (zone));
1838 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1839 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1840 tzstring = tzbuf;
1842 else
1843 error ("Invalid time zone specification");
1845 /* Set TZ before calling mktime; merely adjusting mktime's returned
1846 value doesn't suffice, since that would mishandle leap seconds. */
1847 set_time_zone_rule (tzstring);
1849 BLOCK_INPUT;
1850 time = mktime (&tm);
1851 UNBLOCK_INPUT;
1853 /* Restore TZ to previous value. */
1854 newenv = environ;
1855 environ = oldenv;
1856 xfree (newenv);
1857 #ifdef LOCALTIME_CACHE
1858 tzset ();
1859 #endif
1862 if (time == (time_t) -1)
1863 error ("Specified time is not representable");
1865 return make_time (time);
1868 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1869 doc: /* Return the current local time, as a human-readable string.
1870 Programs can use this function to decode a time,
1871 since the number of columns in each field is fixed
1872 if the year is in the range 1000-9999.
1873 The format is `Sun Sep 16 01:03:52 1973'.
1874 However, see also the functions `decode-time' and `format-time-string'
1875 which provide a much more powerful and general facility.
1877 If SPECIFIED-TIME is given, it is a time to format instead of the
1878 current time. The argument should have the form (HIGH LOW . IGNORED).
1879 Thus, you can use times obtained from `current-time' and from
1880 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1881 but this is considered obsolete. */)
1882 (Lisp_Object specified_time)
1884 time_t value;
1885 struct tm *tm;
1886 register char *tem;
1888 if (! lisp_time_argument (specified_time, &value, NULL))
1889 error ("Invalid time specification");
1891 /* Convert to a string, checking for out-of-range time stamps.
1892 Don't use 'ctime', as that might dump core if VALUE is out of
1893 range. */
1894 BLOCK_INPUT;
1895 tm = localtime (&value);
1896 UNBLOCK_INPUT;
1897 if (! (tm && TM_YEAR_IN_ASCTIME_RANGE (tm->tm_year) && (tem = asctime (tm))))
1898 error ("Specified time is not representable");
1900 /* Remove the trailing newline. */
1901 tem[strlen (tem) - 1] = '\0';
1903 return build_string (tem);
1906 /* Yield A - B, measured in seconds.
1907 This function is copied from the GNU C Library. */
1908 static int
1909 tm_diff (struct tm *a, struct tm *b)
1911 /* Compute intervening leap days correctly even if year is negative.
1912 Take care to avoid int overflow in leap day calculations,
1913 but it's OK to assume that A and B are close to each other. */
1914 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1915 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1916 int a100 = a4 / 25 - (a4 % 25 < 0);
1917 int b100 = b4 / 25 - (b4 % 25 < 0);
1918 int a400 = a100 >> 2;
1919 int b400 = b100 >> 2;
1920 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1921 int years = a->tm_year - b->tm_year;
1922 int days = (365 * years + intervening_leap_days
1923 + (a->tm_yday - b->tm_yday));
1924 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1925 + (a->tm_min - b->tm_min))
1926 + (a->tm_sec - b->tm_sec));
1929 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1930 doc: /* Return the offset and name for the local time zone.
1931 This returns a list of the form (OFFSET NAME).
1932 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1933 A negative value means west of Greenwich.
1934 NAME is a string giving the name of the time zone.
1935 If SPECIFIED-TIME is given, the time zone offset is determined from it
1936 instead of using the current time. The argument should have the form
1937 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1938 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1939 have the form (HIGH . LOW), but this is considered obsolete.
1941 Some operating systems cannot provide all this information to Emacs;
1942 in this case, `current-time-zone' returns a list containing nil for
1943 the data it can't find. */)
1944 (Lisp_Object specified_time)
1946 time_t value;
1947 struct tm *t;
1948 struct tm gmt;
1950 if (!lisp_time_argument (specified_time, &value, NULL))
1951 t = NULL;
1952 else
1954 BLOCK_INPUT;
1955 t = gmtime (&value);
1956 if (t)
1958 gmt = *t;
1959 t = localtime (&value);
1961 UNBLOCK_INPUT;
1964 if (t)
1966 int offset = tm_diff (t, &gmt);
1967 char *s = 0;
1968 char buf[6];
1970 #ifdef HAVE_TM_ZONE
1971 if (t->tm_zone)
1972 s = (char *)t->tm_zone;
1973 #else /* not HAVE_TM_ZONE */
1974 #ifdef HAVE_TZNAME
1975 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1976 s = tzname[t->tm_isdst];
1977 #endif
1978 #endif /* not HAVE_TM_ZONE */
1980 if (!s)
1982 /* No local time zone name is available; use "+-NNNN" instead. */
1983 int am = (offset < 0 ? -offset : offset) / 60;
1984 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1985 s = buf;
1988 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
1990 else
1991 return Fmake_list (make_number (2), Qnil);
1994 /* This holds the value of `environ' produced by the previous
1995 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1996 has never been called. */
1997 static char **environbuf;
1999 /* This holds the startup value of the TZ environment variable so it
2000 can be restored if the user calls set-time-zone-rule with a nil
2001 argument. */
2002 static char *initial_tz;
2004 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
2005 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
2006 If TZ is nil, use implementation-defined default time zone information.
2007 If TZ is t, use Universal Time. */)
2008 (Lisp_Object tz)
2010 const char *tzstring;
2012 /* When called for the first time, save the original TZ. */
2013 if (!environbuf)
2014 initial_tz = (char *) getenv ("TZ");
2016 if (NILP (tz))
2017 tzstring = initial_tz;
2018 else if (EQ (tz, Qt))
2019 tzstring = "UTC0";
2020 else
2022 CHECK_STRING (tz);
2023 tzstring = (char *) SDATA (tz);
2026 set_time_zone_rule (tzstring);
2027 free (environbuf);
2028 environbuf = environ;
2030 return Qnil;
2033 #ifdef LOCALTIME_CACHE
2035 /* These two values are known to load tz files in buggy implementations,
2036 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2037 Their values shouldn't matter in non-buggy implementations.
2038 We don't use string literals for these strings,
2039 since if a string in the environment is in readonly
2040 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2041 See Sun bugs 1113095 and 1114114, ``Timezone routines
2042 improperly modify environment''. */
2044 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2045 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2047 #endif
2049 /* Set the local time zone rule to TZSTRING.
2050 This allocates memory into `environ', which it is the caller's
2051 responsibility to free. */
2053 void
2054 set_time_zone_rule (const char *tzstring)
2056 int envptrs;
2057 char **from, **to, **newenv;
2059 /* Make the ENVIRON vector longer with room for TZSTRING. */
2060 for (from = environ; *from; from++)
2061 continue;
2062 envptrs = from - environ + 2;
2063 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2064 + (tzstring ? strlen (tzstring) + 4 : 0));
2066 /* Add TZSTRING to the end of environ, as a value for TZ. */
2067 if (tzstring)
2069 char *t = (char *) (to + envptrs);
2070 strcpy (t, "TZ=");
2071 strcat (t, tzstring);
2072 *to++ = t;
2075 /* Copy the old environ vector elements into NEWENV,
2076 but don't copy the TZ variable.
2077 So we have only one definition of TZ, which came from TZSTRING. */
2078 for (from = environ; *from; from++)
2079 if (strncmp (*from, "TZ=", 3) != 0)
2080 *to++ = *from;
2081 *to = 0;
2083 environ = newenv;
2085 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2086 the TZ variable is stored. If we do not have a TZSTRING,
2087 TO points to the vector slot which has the terminating null. */
2089 #ifdef LOCALTIME_CACHE
2091 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2092 "US/Pacific" that loads a tz file, then changes to a value like
2093 "XXX0" that does not load a tz file, and then changes back to
2094 its original value, the last change is (incorrectly) ignored.
2095 Also, if TZ changes twice in succession to values that do
2096 not load a tz file, tzset can dump core (see Sun bug#1225179).
2097 The following code works around these bugs. */
2099 if (tzstring)
2101 /* Temporarily set TZ to a value that loads a tz file
2102 and that differs from tzstring. */
2103 char *tz = *newenv;
2104 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2105 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
2106 tzset ();
2107 *newenv = tz;
2109 else
2111 /* The implied tzstring is unknown, so temporarily set TZ to
2112 two different values that each load a tz file. */
2113 *to = set_time_zone_rule_tz1;
2114 to[1] = 0;
2115 tzset ();
2116 *to = set_time_zone_rule_tz2;
2117 tzset ();
2118 *to = 0;
2121 /* Now TZ has the desired value, and tzset can be invoked safely. */
2124 tzset ();
2125 #endif
2128 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2129 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2130 type of object is Lisp_String). INHERIT is passed to
2131 INSERT_FROM_STRING_FUNC as the last argument. */
2133 static void
2134 general_insert_function (void (*insert_func)
2135 (const unsigned char *, EMACS_INT),
2136 void (*insert_from_string_func)
2137 (Lisp_Object, EMACS_INT, EMACS_INT,
2138 EMACS_INT, EMACS_INT, int),
2139 int inherit, int nargs, Lisp_Object *args)
2141 register int argnum;
2142 register Lisp_Object val;
2144 for (argnum = 0; argnum < nargs; argnum++)
2146 val = args[argnum];
2147 if (CHARACTERP (val))
2149 unsigned char str[MAX_MULTIBYTE_LENGTH];
2150 int len;
2152 if (!NILP (current_buffer->enable_multibyte_characters))
2153 len = CHAR_STRING (XFASTINT (val), str);
2154 else
2156 str[0] = (ASCII_CHAR_P (XINT (val))
2157 ? XINT (val)
2158 : multibyte_char_to_unibyte (XINT (val), Qnil));
2159 len = 1;
2161 (*insert_func) (str, len);
2163 else if (STRINGP (val))
2165 (*insert_from_string_func) (val, 0, 0,
2166 SCHARS (val),
2167 SBYTES (val),
2168 inherit);
2170 else
2171 wrong_type_argument (Qchar_or_string_p, val);
2175 void
2176 insert1 (Lisp_Object arg)
2178 Finsert (1, &arg);
2182 /* Callers passing one argument to Finsert need not gcpro the
2183 argument "array", since the only element of the array will
2184 not be used after calling insert or insert_from_string, so
2185 we don't care if it gets trashed. */
2187 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2188 doc: /* Insert the arguments, either strings or characters, at point.
2189 Point and before-insertion markers move forward to end up
2190 after the inserted text.
2191 Any other markers at the point of insertion remain before the text.
2193 If the current buffer is multibyte, unibyte strings are converted
2194 to multibyte for insertion (see `string-make-multibyte').
2195 If the current buffer is unibyte, multibyte strings are converted
2196 to unibyte for insertion (see `string-make-unibyte').
2198 When operating on binary data, it may be necessary to preserve the
2199 original bytes of a unibyte string when inserting it into a multibyte
2200 buffer; to accomplish this, apply `string-as-multibyte' to the string
2201 and insert the result.
2203 usage: (insert &rest ARGS) */)
2204 (int nargs, register Lisp_Object *args)
2206 general_insert_function (insert, insert_from_string, 0, nargs, args);
2207 return Qnil;
2210 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2211 0, MANY, 0,
2212 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2213 Point and before-insertion markers move forward to end up
2214 after the inserted text.
2215 Any other markers at the point of insertion remain before the text.
2217 If the current buffer is multibyte, unibyte strings are converted
2218 to multibyte for insertion (see `unibyte-char-to-multibyte').
2219 If the current buffer is unibyte, multibyte strings are converted
2220 to unibyte for insertion.
2222 usage: (insert-and-inherit &rest ARGS) */)
2223 (int nargs, register Lisp_Object *args)
2225 general_insert_function (insert_and_inherit, insert_from_string, 1,
2226 nargs, args);
2227 return Qnil;
2230 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2231 doc: /* Insert strings or characters at point, relocating markers after the text.
2232 Point and markers move forward to end up after the inserted text.
2234 If the current buffer is multibyte, unibyte strings are converted
2235 to multibyte for insertion (see `unibyte-char-to-multibyte').
2236 If the current buffer is unibyte, multibyte strings are converted
2237 to unibyte for insertion.
2239 usage: (insert-before-markers &rest ARGS) */)
2240 (int nargs, register Lisp_Object *args)
2242 general_insert_function (insert_before_markers,
2243 insert_from_string_before_markers, 0,
2244 nargs, args);
2245 return Qnil;
2248 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2249 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2250 doc: /* Insert text at point, relocating markers and inheriting properties.
2251 Point and markers move forward to end up after the inserted text.
2253 If the current buffer is multibyte, unibyte strings are converted
2254 to multibyte for insertion (see `unibyte-char-to-multibyte').
2255 If the current buffer is unibyte, multibyte strings are converted
2256 to unibyte for insertion.
2258 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2259 (int nargs, register Lisp_Object *args)
2261 general_insert_function (insert_before_markers_and_inherit,
2262 insert_from_string_before_markers, 1,
2263 nargs, args);
2264 return Qnil;
2267 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2268 doc: /* Insert COUNT copies of CHARACTER.
2269 Point, and before-insertion markers, are relocated as in the function `insert'.
2270 The optional third arg INHERIT, if non-nil, says to inherit text properties
2271 from adjoining text, if those properties are sticky. */)
2272 (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
2274 register unsigned char *string;
2275 register EMACS_INT strlen;
2276 register int i;
2277 register EMACS_INT n;
2278 int len;
2279 unsigned char str[MAX_MULTIBYTE_LENGTH];
2281 CHECK_NUMBER (character);
2282 CHECK_NUMBER (count);
2284 if (!NILP (current_buffer->enable_multibyte_characters))
2285 len = CHAR_STRING (XFASTINT (character), str);
2286 else
2287 str[0] = XFASTINT (character), len = 1;
2288 if (MOST_POSITIVE_FIXNUM / len < XINT (count))
2289 error ("Maximum buffer size would be exceeded");
2290 n = XINT (count) * len;
2291 if (n <= 0)
2292 return Qnil;
2293 strlen = min (n, 256 * len);
2294 string = (unsigned char *) alloca (strlen);
2295 for (i = 0; i < strlen; i++)
2296 string[i] = str[i % len];
2297 while (n >= strlen)
2299 QUIT;
2300 if (!NILP (inherit))
2301 insert_and_inherit (string, strlen);
2302 else
2303 insert (string, strlen);
2304 n -= strlen;
2306 if (n > 0)
2308 if (!NILP (inherit))
2309 insert_and_inherit (string, n);
2310 else
2311 insert (string, n);
2313 return Qnil;
2316 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2317 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2318 Both arguments are required.
2319 BYTE is a number of the range 0..255.
2321 If BYTE is 128..255 and the current buffer is multibyte, the
2322 corresponding eight-bit character is inserted.
2324 Point, and before-insertion markers, are relocated as in the function `insert'.
2325 The optional third arg INHERIT, if non-nil, says to inherit text properties
2326 from adjoining text, if those properties are sticky. */)
2327 (Lisp_Object byte, Lisp_Object count, Lisp_Object inherit)
2329 CHECK_NUMBER (byte);
2330 if (XINT (byte) < 0 || XINT (byte) > 255)
2331 args_out_of_range_3 (byte, make_number (0), make_number (255));
2332 if (XINT (byte) >= 128
2333 && ! NILP (current_buffer->enable_multibyte_characters))
2334 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2335 return Finsert_char (byte, count, inherit);
2339 /* Making strings from buffer contents. */
2341 /* Return a Lisp_String containing the text of the current buffer from
2342 START to END. If text properties are in use and the current buffer
2343 has properties in the range specified, the resulting string will also
2344 have them, if PROPS is nonzero.
2346 We don't want to use plain old make_string here, because it calls
2347 make_uninit_string, which can cause the buffer arena to be
2348 compacted. make_string has no way of knowing that the data has
2349 been moved, and thus copies the wrong data into the string. This
2350 doesn't effect most of the other users of make_string, so it should
2351 be left as is. But we should use this function when conjuring
2352 buffer substrings. */
2354 Lisp_Object
2355 make_buffer_string (EMACS_INT start, EMACS_INT end, int props)
2357 EMACS_INT start_byte = CHAR_TO_BYTE (start);
2358 EMACS_INT end_byte = CHAR_TO_BYTE (end);
2360 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2363 /* Return a Lisp_String containing the text of the current buffer from
2364 START / START_BYTE to END / END_BYTE.
2366 If text properties are in use and the current buffer
2367 has properties in the range specified, the resulting string will also
2368 have them, if PROPS is nonzero.
2370 We don't want to use plain old make_string here, because it calls
2371 make_uninit_string, which can cause the buffer arena to be
2372 compacted. make_string has no way of knowing that the data has
2373 been moved, and thus copies the wrong data into the string. This
2374 doesn't effect most of the other users of make_string, so it should
2375 be left as is. But we should use this function when conjuring
2376 buffer substrings. */
2378 Lisp_Object
2379 make_buffer_string_both (EMACS_INT start, EMACS_INT start_byte,
2380 EMACS_INT end, EMACS_INT end_byte, int props)
2382 Lisp_Object result, tem, tem1;
2384 if (start < GPT && GPT < end)
2385 move_gap (start);
2387 if (! NILP (current_buffer->enable_multibyte_characters))
2388 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2389 else
2390 result = make_uninit_string (end - start);
2391 memcpy (SDATA (result), BYTE_POS_ADDR (start_byte), end_byte - start_byte);
2393 /* If desired, update and copy the text properties. */
2394 if (props)
2396 update_buffer_properties (start, end);
2398 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2399 tem1 = Ftext_properties_at (make_number (start), Qnil);
2401 if (XINT (tem) != end || !NILP (tem1))
2402 copy_intervals_to_string (result, current_buffer, start,
2403 end - start);
2406 return result;
2409 /* Call Vbuffer_access_fontify_functions for the range START ... END
2410 in the current buffer, if necessary. */
2412 static void
2413 update_buffer_properties (EMACS_INT start, EMACS_INT end)
2415 /* If this buffer has some access functions,
2416 call them, specifying the range of the buffer being accessed. */
2417 if (!NILP (Vbuffer_access_fontify_functions))
2419 Lisp_Object args[3];
2420 Lisp_Object tem;
2422 args[0] = Qbuffer_access_fontify_functions;
2423 XSETINT (args[1], start);
2424 XSETINT (args[2], end);
2426 /* But don't call them if we can tell that the work
2427 has already been done. */
2428 if (!NILP (Vbuffer_access_fontified_property))
2430 tem = Ftext_property_any (args[1], args[2],
2431 Vbuffer_access_fontified_property,
2432 Qnil, Qnil);
2433 if (! NILP (tem))
2434 Frun_hook_with_args (3, args);
2436 else
2437 Frun_hook_with_args (3, args);
2441 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2442 doc: /* Return the contents of part of the current buffer as a string.
2443 The two arguments START and END are character positions;
2444 they can be in either order.
2445 The string returned is multibyte if the buffer is multibyte.
2447 This function copies the text properties of that part of the buffer
2448 into the result string; if you don't want the text properties,
2449 use `buffer-substring-no-properties' instead. */)
2450 (Lisp_Object start, Lisp_Object end)
2452 register EMACS_INT b, e;
2454 validate_region (&start, &end);
2455 b = XINT (start);
2456 e = XINT (end);
2458 return make_buffer_string (b, e, 1);
2461 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2462 Sbuffer_substring_no_properties, 2, 2, 0,
2463 doc: /* Return the characters of part of the buffer, without the text properties.
2464 The two arguments START and END are character positions;
2465 they can be in either order. */)
2466 (Lisp_Object start, Lisp_Object end)
2468 register EMACS_INT b, e;
2470 validate_region (&start, &end);
2471 b = XINT (start);
2472 e = XINT (end);
2474 return make_buffer_string (b, e, 0);
2477 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2478 doc: /* Return the contents of the current buffer as a string.
2479 If narrowing is in effect, this function returns only the visible part
2480 of the buffer. */)
2481 (void)
2483 return make_buffer_string (BEGV, ZV, 1);
2486 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2487 1, 3, 0,
2488 doc: /* Insert before point a substring of the contents of BUFFER.
2489 BUFFER may be a buffer or a buffer name.
2490 Arguments START and END are character positions specifying the substring.
2491 They default to the values of (point-min) and (point-max) in BUFFER. */)
2492 (Lisp_Object buffer, Lisp_Object start, Lisp_Object end)
2494 register EMACS_INT b, e, temp;
2495 register struct buffer *bp, *obuf;
2496 Lisp_Object buf;
2498 buf = Fget_buffer (buffer);
2499 if (NILP (buf))
2500 nsberror (buffer);
2501 bp = XBUFFER (buf);
2502 if (NILP (bp->name))
2503 error ("Selecting deleted buffer");
2505 if (NILP (start))
2506 b = BUF_BEGV (bp);
2507 else
2509 CHECK_NUMBER_COERCE_MARKER (start);
2510 b = XINT (start);
2512 if (NILP (end))
2513 e = BUF_ZV (bp);
2514 else
2516 CHECK_NUMBER_COERCE_MARKER (end);
2517 e = XINT (end);
2520 if (b > e)
2521 temp = b, b = e, e = temp;
2523 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2524 args_out_of_range (start, end);
2526 obuf = current_buffer;
2527 set_buffer_internal_1 (bp);
2528 update_buffer_properties (b, e);
2529 set_buffer_internal_1 (obuf);
2531 insert_from_buffer (bp, b, e - b, 0);
2532 return Qnil;
2535 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2536 6, 6, 0,
2537 doc: /* Compare two substrings of two buffers; return result as number.
2538 the value is -N if first string is less after N-1 chars,
2539 +N if first string is greater after N-1 chars, or 0 if strings match.
2540 Each substring is represented as three arguments: BUFFER, START and END.
2541 That makes six args in all, three for each substring.
2543 The value of `case-fold-search' in the current buffer
2544 determines whether case is significant or ignored. */)
2545 (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)
2547 register EMACS_INT begp1, endp1, begp2, endp2, temp;
2548 register struct buffer *bp1, *bp2;
2549 register Lisp_Object trt
2550 = (!NILP (current_buffer->case_fold_search)
2551 ? current_buffer->case_canon_table : Qnil);
2552 EMACS_INT chars = 0;
2553 EMACS_INT i1, i2, i1_byte, i2_byte;
2555 /* Find the first buffer and its substring. */
2557 if (NILP (buffer1))
2558 bp1 = current_buffer;
2559 else
2561 Lisp_Object buf1;
2562 buf1 = Fget_buffer (buffer1);
2563 if (NILP (buf1))
2564 nsberror (buffer1);
2565 bp1 = XBUFFER (buf1);
2566 if (NILP (bp1->name))
2567 error ("Selecting deleted buffer");
2570 if (NILP (start1))
2571 begp1 = BUF_BEGV (bp1);
2572 else
2574 CHECK_NUMBER_COERCE_MARKER (start1);
2575 begp1 = XINT (start1);
2577 if (NILP (end1))
2578 endp1 = BUF_ZV (bp1);
2579 else
2581 CHECK_NUMBER_COERCE_MARKER (end1);
2582 endp1 = XINT (end1);
2585 if (begp1 > endp1)
2586 temp = begp1, begp1 = endp1, endp1 = temp;
2588 if (!(BUF_BEGV (bp1) <= begp1
2589 && begp1 <= endp1
2590 && endp1 <= BUF_ZV (bp1)))
2591 args_out_of_range (start1, end1);
2593 /* Likewise for second substring. */
2595 if (NILP (buffer2))
2596 bp2 = current_buffer;
2597 else
2599 Lisp_Object buf2;
2600 buf2 = Fget_buffer (buffer2);
2601 if (NILP (buf2))
2602 nsberror (buffer2);
2603 bp2 = XBUFFER (buf2);
2604 if (NILP (bp2->name))
2605 error ("Selecting deleted buffer");
2608 if (NILP (start2))
2609 begp2 = BUF_BEGV (bp2);
2610 else
2612 CHECK_NUMBER_COERCE_MARKER (start2);
2613 begp2 = XINT (start2);
2615 if (NILP (end2))
2616 endp2 = BUF_ZV (bp2);
2617 else
2619 CHECK_NUMBER_COERCE_MARKER (end2);
2620 endp2 = XINT (end2);
2623 if (begp2 > endp2)
2624 temp = begp2, begp2 = endp2, endp2 = temp;
2626 if (!(BUF_BEGV (bp2) <= begp2
2627 && begp2 <= endp2
2628 && endp2 <= BUF_ZV (bp2)))
2629 args_out_of_range (start2, end2);
2631 i1 = begp1;
2632 i2 = begp2;
2633 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2634 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2636 while (i1 < endp1 && i2 < endp2)
2638 /* When we find a mismatch, we must compare the
2639 characters, not just the bytes. */
2640 int c1, c2;
2642 QUIT;
2644 if (! NILP (bp1->enable_multibyte_characters))
2646 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2647 BUF_INC_POS (bp1, i1_byte);
2648 i1++;
2650 else
2652 c1 = BUF_FETCH_BYTE (bp1, i1);
2653 MAKE_CHAR_MULTIBYTE (c1);
2654 i1++;
2657 if (! NILP (bp2->enable_multibyte_characters))
2659 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2660 BUF_INC_POS (bp2, i2_byte);
2661 i2++;
2663 else
2665 c2 = BUF_FETCH_BYTE (bp2, i2);
2666 MAKE_CHAR_MULTIBYTE (c2);
2667 i2++;
2670 if (!NILP (trt))
2672 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2673 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
2675 if (c1 < c2)
2676 return make_number (- 1 - chars);
2677 if (c1 > c2)
2678 return make_number (chars + 1);
2680 chars++;
2683 /* The strings match as far as they go.
2684 If one is shorter, that one is less. */
2685 if (chars < endp1 - begp1)
2686 return make_number (chars + 1);
2687 else if (chars < endp2 - begp2)
2688 return make_number (- chars - 1);
2690 /* Same length too => they are equal. */
2691 return make_number (0);
2694 static Lisp_Object
2695 subst_char_in_region_unwind (Lisp_Object arg)
2697 return current_buffer->undo_list = arg;
2700 static Lisp_Object
2701 subst_char_in_region_unwind_1 (Lisp_Object arg)
2703 return current_buffer->filename = arg;
2706 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2707 Ssubst_char_in_region, 4, 5, 0,
2708 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2709 If optional arg NOUNDO is non-nil, don't record this change for undo
2710 and don't mark the buffer as really changed.
2711 Both characters must have the same length of multi-byte form. */)
2712 (Lisp_Object start, Lisp_Object end, Lisp_Object fromchar, Lisp_Object tochar, Lisp_Object noundo)
2714 register EMACS_INT pos, pos_byte, stop, i, len, end_byte;
2715 /* Keep track of the first change in the buffer:
2716 if 0 we haven't found it yet.
2717 if < 0 we've found it and we've run the before-change-function.
2718 if > 0 we've actually performed it and the value is its position. */
2719 EMACS_INT changed = 0;
2720 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2721 unsigned char *p;
2722 int count = SPECPDL_INDEX ();
2723 #define COMBINING_NO 0
2724 #define COMBINING_BEFORE 1
2725 #define COMBINING_AFTER 2
2726 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2727 int maybe_byte_combining = COMBINING_NO;
2728 EMACS_INT last_changed = 0;
2729 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2731 restart:
2733 validate_region (&start, &end);
2734 CHECK_NUMBER (fromchar);
2735 CHECK_NUMBER (tochar);
2737 if (multibyte_p)
2739 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2740 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2741 error ("Characters in `subst-char-in-region' have different byte-lengths");
2742 if (!ASCII_BYTE_P (*tostr))
2744 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2745 complete multibyte character, it may be combined with the
2746 after bytes. If it is in the range 0xA0..0xFF, it may be
2747 combined with the before and after bytes. */
2748 if (!CHAR_HEAD_P (*tostr))
2749 maybe_byte_combining = COMBINING_BOTH;
2750 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2751 maybe_byte_combining = COMBINING_AFTER;
2754 else
2756 len = 1;
2757 fromstr[0] = XFASTINT (fromchar);
2758 tostr[0] = XFASTINT (tochar);
2761 pos = XINT (start);
2762 pos_byte = CHAR_TO_BYTE (pos);
2763 stop = CHAR_TO_BYTE (XINT (end));
2764 end_byte = stop;
2766 /* If we don't want undo, turn off putting stuff on the list.
2767 That's faster than getting rid of things,
2768 and it prevents even the entry for a first change.
2769 Also inhibit locking the file. */
2770 if (!changed && !NILP (noundo))
2772 record_unwind_protect (subst_char_in_region_unwind,
2773 current_buffer->undo_list);
2774 current_buffer->undo_list = Qt;
2775 /* Don't do file-locking. */
2776 record_unwind_protect (subst_char_in_region_unwind_1,
2777 current_buffer->filename);
2778 current_buffer->filename = Qnil;
2781 if (pos_byte < GPT_BYTE)
2782 stop = min (stop, GPT_BYTE);
2783 while (1)
2785 EMACS_INT pos_byte_next = pos_byte;
2787 if (pos_byte >= stop)
2789 if (pos_byte >= end_byte) break;
2790 stop = end_byte;
2792 p = BYTE_POS_ADDR (pos_byte);
2793 if (multibyte_p)
2794 INC_POS (pos_byte_next);
2795 else
2796 ++pos_byte_next;
2797 if (pos_byte_next - pos_byte == len
2798 && p[0] == fromstr[0]
2799 && (len == 1
2800 || (p[1] == fromstr[1]
2801 && (len == 2 || (p[2] == fromstr[2]
2802 && (len == 3 || p[3] == fromstr[3]))))))
2804 if (changed < 0)
2805 /* We've already seen this and run the before-change-function;
2806 this time we only need to record the actual position. */
2807 changed = pos;
2808 else if (!changed)
2810 changed = -1;
2811 modify_region (current_buffer, pos, XINT (end), 0);
2813 if (! NILP (noundo))
2815 if (MODIFF - 1 == SAVE_MODIFF)
2816 SAVE_MODIFF++;
2817 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
2818 BUF_AUTOSAVE_MODIFF (current_buffer)++;
2821 /* The before-change-function may have moved the gap
2822 or even modified the buffer so we should start over. */
2823 goto restart;
2826 /* Take care of the case where the new character
2827 combines with neighboring bytes. */
2828 if (maybe_byte_combining
2829 && (maybe_byte_combining == COMBINING_AFTER
2830 ? (pos_byte_next < Z_BYTE
2831 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2832 : ((pos_byte_next < Z_BYTE
2833 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2834 || (pos_byte > BEG_BYTE
2835 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2837 Lisp_Object tem, string;
2839 struct gcpro gcpro1;
2841 tem = current_buffer->undo_list;
2842 GCPRO1 (tem);
2844 /* Make a multibyte string containing this single character. */
2845 string = make_multibyte_string (tostr, 1, len);
2846 /* replace_range is less efficient, because it moves the gap,
2847 but it handles combining correctly. */
2848 replace_range (pos, pos + 1, string,
2849 0, 0, 1);
2850 pos_byte_next = CHAR_TO_BYTE (pos);
2851 if (pos_byte_next > pos_byte)
2852 /* Before combining happened. We should not increment
2853 POS. So, to cancel the later increment of POS,
2854 decrease it now. */
2855 pos--;
2856 else
2857 INC_POS (pos_byte_next);
2859 if (! NILP (noundo))
2860 current_buffer->undo_list = tem;
2862 UNGCPRO;
2864 else
2866 if (NILP (noundo))
2867 record_change (pos, 1);
2868 for (i = 0; i < len; i++) *p++ = tostr[i];
2870 last_changed = pos + 1;
2872 pos_byte = pos_byte_next;
2873 pos++;
2876 if (changed > 0)
2878 signal_after_change (changed,
2879 last_changed - changed, last_changed - changed);
2880 update_compositions (changed, last_changed, CHECK_ALL);
2883 unbind_to (count, Qnil);
2884 return Qnil;
2888 static Lisp_Object check_translation (EMACS_INT, EMACS_INT, EMACS_INT,
2889 Lisp_Object);
2891 /* Helper function for Ftranslate_region_internal.
2893 Check if a character sequence at POS (POS_BYTE) matches an element
2894 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2895 element is found, return it. Otherwise return Qnil. */
2897 static Lisp_Object
2898 check_translation (EMACS_INT pos, EMACS_INT pos_byte, EMACS_INT end,
2899 Lisp_Object val)
2901 int buf_size = 16, buf_used = 0;
2902 int *buf = alloca (sizeof (int) * buf_size);
2904 for (; CONSP (val); val = XCDR (val))
2906 Lisp_Object elt;
2907 EMACS_INT len, i;
2909 elt = XCAR (val);
2910 if (! CONSP (elt))
2911 continue;
2912 elt = XCAR (elt);
2913 if (! VECTORP (elt))
2914 continue;
2915 len = ASIZE (elt);
2916 if (len <= end - pos)
2918 for (i = 0; i < len; i++)
2920 if (buf_used <= i)
2922 unsigned char *p = BYTE_POS_ADDR (pos_byte);
2923 int len1;
2925 if (buf_used == buf_size)
2927 int *newbuf;
2929 buf_size += 16;
2930 newbuf = alloca (sizeof (int) * buf_size);
2931 memcpy (newbuf, buf, sizeof (int) * buf_used);
2932 buf = newbuf;
2934 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len1);
2935 pos_byte += len1;
2937 if (XINT (AREF (elt, i)) != buf[i])
2938 break;
2940 if (i == len)
2941 return XCAR (val);
2944 return Qnil;
2948 DEFUN ("translate-region-internal", Ftranslate_region_internal,
2949 Stranslate_region_internal, 3, 3, 0,
2950 doc: /* Internal use only.
2951 From START to END, translate characters according to TABLE.
2952 TABLE is a string or a char-table; the Nth character in it is the
2953 mapping for the character with code N.
2954 It returns the number of characters changed. */)
2955 (Lisp_Object start, Lisp_Object end, register Lisp_Object table)
2957 register unsigned char *tt; /* Trans table. */
2958 register int nc; /* New character. */
2959 int cnt; /* Number of changes made. */
2960 EMACS_INT size; /* Size of translate table. */
2961 EMACS_INT pos, pos_byte, end_pos;
2962 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
2963 int string_multibyte;
2964 Lisp_Object val;
2966 validate_region (&start, &end);
2967 if (CHAR_TABLE_P (table))
2969 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
2970 error ("Not a translation table");
2971 size = MAX_CHAR;
2972 tt = NULL;
2974 else
2976 CHECK_STRING (table);
2978 if (! multibyte && (SCHARS (table) < SBYTES (table)))
2979 table = string_make_unibyte (table);
2980 string_multibyte = SCHARS (table) < SBYTES (table);
2981 size = SBYTES (table);
2982 tt = SDATA (table);
2985 pos = XINT (start);
2986 pos_byte = CHAR_TO_BYTE (pos);
2987 end_pos = XINT (end);
2988 modify_region (current_buffer, pos, end_pos, 0);
2990 cnt = 0;
2991 for (; pos < end_pos; )
2993 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
2994 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
2995 int len, str_len;
2996 int oc;
2997 Lisp_Object val;
2999 if (multibyte)
3000 oc = STRING_CHAR_AND_LENGTH (p, len);
3001 else
3002 oc = *p, len = 1;
3003 if (oc < size)
3005 if (tt)
3007 /* Reload as signal_after_change in last iteration may GC. */
3008 tt = SDATA (table);
3009 if (string_multibyte)
3011 str = tt + string_char_to_byte (table, oc);
3012 nc = STRING_CHAR_AND_LENGTH (str, str_len);
3014 else
3016 nc = tt[oc];
3017 if (! ASCII_BYTE_P (nc) && multibyte)
3019 str_len = BYTE8_STRING (nc, buf);
3020 str = buf;
3022 else
3024 str_len = 1;
3025 str = tt + oc;
3029 else
3031 EMACS_INT c;
3033 nc = oc;
3034 val = CHAR_TABLE_REF (table, oc);
3035 if (CHARACTERP (val)
3036 && (c = XINT (val), CHAR_VALID_P (c, 0)))
3038 nc = c;
3039 str_len = CHAR_STRING (nc, buf);
3040 str = buf;
3042 else if (VECTORP (val) || (CONSP (val)))
3044 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3045 where TO is TO-CHAR or [TO-CHAR ...]. */
3046 nc = -1;
3050 if (nc != oc && nc >= 0)
3052 /* Simple one char to one char translation. */
3053 if (len != str_len)
3055 Lisp_Object string;
3057 /* This is less efficient, because it moves the gap,
3058 but it should handle multibyte characters correctly. */
3059 string = make_multibyte_string (str, 1, str_len);
3060 replace_range (pos, pos + 1, string, 1, 0, 1);
3061 len = str_len;
3063 else
3065 record_change (pos, 1);
3066 while (str_len-- > 0)
3067 *p++ = *str++;
3068 signal_after_change (pos, 1, 1);
3069 update_compositions (pos, pos + 1, CHECK_BORDER);
3071 ++cnt;
3073 else if (nc < 0)
3075 Lisp_Object string;
3077 if (CONSP (val))
3079 val = check_translation (pos, pos_byte, end_pos, val);
3080 if (NILP (val))
3082 pos_byte += len;
3083 pos++;
3084 continue;
3086 /* VAL is ([FROM-CHAR ...] . TO). */
3087 len = ASIZE (XCAR (val));
3088 val = XCDR (val);
3090 else
3091 len = 1;
3093 if (VECTORP (val))
3095 string = Fconcat (1, &val);
3097 else
3099 string = Fmake_string (make_number (1), val);
3101 replace_range (pos, pos + len, string, 1, 0, 1);
3102 pos_byte += SBYTES (string);
3103 pos += SCHARS (string);
3104 cnt += SCHARS (string);
3105 end_pos += SCHARS (string) - len;
3106 continue;
3109 pos_byte += len;
3110 pos++;
3113 return make_number (cnt);
3116 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3117 doc: /* Delete the text between point and mark.
3119 When called from a program, expects two arguments,
3120 positions (integers or markers) specifying the stretch to be deleted. */)
3121 (Lisp_Object start, Lisp_Object end)
3123 validate_region (&start, &end);
3124 del_range (XINT (start), XINT (end));
3125 return Qnil;
3128 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3129 Sdelete_and_extract_region, 2, 2, 0,
3130 doc: /* Delete the text between START and END and return it. */)
3131 (Lisp_Object start, Lisp_Object end)
3133 validate_region (&start, &end);
3134 if (XINT (start) == XINT (end))
3135 return empty_unibyte_string;
3136 return del_range_1 (XINT (start), XINT (end), 1, 1);
3139 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3140 doc: /* Remove restrictions (narrowing) from current buffer.
3141 This allows the buffer's full text to be seen and edited. */)
3142 (void)
3144 if (BEG != BEGV || Z != ZV)
3145 current_buffer->clip_changed = 1;
3146 BEGV = BEG;
3147 BEGV_BYTE = BEG_BYTE;
3148 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3149 /* Changing the buffer bounds invalidates any recorded current column. */
3150 invalidate_current_column ();
3151 return Qnil;
3154 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3155 doc: /* Restrict editing in this buffer to the current region.
3156 The rest of the text becomes temporarily invisible and untouchable
3157 but is not deleted; if you save the buffer in a file, the invisible
3158 text is included in the file. \\[widen] makes all visible again.
3159 See also `save-restriction'.
3161 When calling from a program, pass two arguments; positions (integers
3162 or markers) bounding the text that should remain visible. */)
3163 (register Lisp_Object start, Lisp_Object end)
3165 CHECK_NUMBER_COERCE_MARKER (start);
3166 CHECK_NUMBER_COERCE_MARKER (end);
3168 if (XINT (start) > XINT (end))
3170 Lisp_Object tem;
3171 tem = start; start = end; end = tem;
3174 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3175 args_out_of_range (start, end);
3177 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3178 current_buffer->clip_changed = 1;
3180 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3181 SET_BUF_ZV (current_buffer, XFASTINT (end));
3182 if (PT < XFASTINT (start))
3183 SET_PT (XFASTINT (start));
3184 if (PT > XFASTINT (end))
3185 SET_PT (XFASTINT (end));
3186 /* Changing the buffer bounds invalidates any recorded current column. */
3187 invalidate_current_column ();
3188 return Qnil;
3191 Lisp_Object
3192 save_restriction_save (void)
3194 if (BEGV == BEG && ZV == Z)
3195 /* The common case that the buffer isn't narrowed.
3196 We return just the buffer object, which save_restriction_restore
3197 recognizes as meaning `no restriction'. */
3198 return Fcurrent_buffer ();
3199 else
3200 /* We have to save a restriction, so return a pair of markers, one
3201 for the beginning and one for the end. */
3203 Lisp_Object beg, end;
3205 beg = buildmark (BEGV, BEGV_BYTE);
3206 end = buildmark (ZV, ZV_BYTE);
3208 /* END must move forward if text is inserted at its exact location. */
3209 XMARKER(end)->insertion_type = 1;
3211 return Fcons (beg, end);
3215 Lisp_Object
3216 save_restriction_restore (Lisp_Object data)
3218 struct buffer *cur = NULL;
3219 struct buffer *buf = (CONSP (data)
3220 ? XMARKER (XCAR (data))->buffer
3221 : XBUFFER (data));
3223 if (buf && buf != current_buffer && !NILP (buf->pt_marker))
3224 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3225 is the case if it is or has an indirect buffer), then make
3226 sure it is current before we update BEGV, so
3227 set_buffer_internal takes care of managing those markers. */
3228 cur = current_buffer;
3229 set_buffer_internal (buf);
3232 if (CONSP (data))
3233 /* A pair of marks bounding a saved restriction. */
3235 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3236 struct Lisp_Marker *end = XMARKER (XCDR (data));
3237 eassert (buf == end->buffer);
3239 if (buf /* Verify marker still points to a buffer. */
3240 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3241 /* The restriction has changed from the saved one, so restore
3242 the saved restriction. */
3244 EMACS_INT pt = BUF_PT (buf);
3246 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3247 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3249 if (pt < beg->charpos || pt > end->charpos)
3250 /* The point is outside the new visible range, move it inside. */
3251 SET_BUF_PT_BOTH (buf,
3252 clip_to_bounds (beg->charpos, pt, end->charpos),
3253 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3254 end->bytepos));
3256 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3259 else
3260 /* A buffer, which means that there was no old restriction. */
3262 if (buf /* Verify marker still points to a buffer. */
3263 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3264 /* The buffer has been narrowed, get rid of the narrowing. */
3266 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3267 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3269 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3273 if (cur)
3274 set_buffer_internal (cur);
3276 return Qnil;
3279 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3280 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3281 The buffer's restrictions make parts of the beginning and end invisible.
3282 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3283 This special form, `save-restriction', saves the current buffer's restrictions
3284 when it is entered, and restores them when it is exited.
3285 So any `narrow-to-region' within BODY lasts only until the end of the form.
3286 The old restrictions settings are restored
3287 even in case of abnormal exit (throw or error).
3289 The value returned is the value of the last form in BODY.
3291 Note: if you are using both `save-excursion' and `save-restriction',
3292 use `save-excursion' outermost:
3293 (save-excursion (save-restriction ...))
3295 usage: (save-restriction &rest BODY) */)
3296 (Lisp_Object body)
3298 register Lisp_Object val;
3299 int count = SPECPDL_INDEX ();
3301 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3302 val = Fprogn (body);
3303 return unbind_to (count, val);
3306 /* Buffer for the most recent text displayed by Fmessage_box. */
3307 static char *message_text;
3309 /* Allocated length of that buffer. */
3310 static int message_length;
3312 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3313 doc: /* Display a message at the bottom of the screen.
3314 The message also goes into the `*Messages*' buffer.
3315 \(In keyboard macros, that's all it does.)
3316 Return the message.
3318 The first argument is a format control string, and the rest are data
3319 to be formatted under control of the string. See `format' for details.
3321 Note: Use (message "%s" VALUE) to print the value of expressions and
3322 variables to avoid accidentally interpreting `%' as format specifiers.
3324 If the first argument is nil or the empty string, the function clears
3325 any existing message; this lets the minibuffer contents show. See
3326 also `current-message'.
3328 usage: (message FORMAT-STRING &rest ARGS) */)
3329 (int nargs, Lisp_Object *args)
3331 if (NILP (args[0])
3332 || (STRINGP (args[0])
3333 && SBYTES (args[0]) == 0))
3335 message (0);
3336 return args[0];
3338 else
3340 register Lisp_Object val;
3341 val = Fformat (nargs, args);
3342 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
3343 return val;
3347 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3348 doc: /* Display a message, in a dialog box if possible.
3349 If a dialog box is not available, use the echo area.
3350 The first argument is a format control string, and the rest are data
3351 to be formatted under control of the string. See `format' for details.
3353 If the first argument is nil or the empty string, clear any existing
3354 message; let the minibuffer contents show.
3356 usage: (message-box FORMAT-STRING &rest ARGS) */)
3357 (int nargs, Lisp_Object *args)
3359 if (NILP (args[0]))
3361 message (0);
3362 return Qnil;
3364 else
3366 register Lisp_Object val;
3367 val = Fformat (nargs, args);
3368 #ifdef HAVE_MENUS
3369 /* The MS-DOS frames support popup menus even though they are
3370 not FRAME_WINDOW_P. */
3371 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3372 || FRAME_MSDOS_P (XFRAME (selected_frame)))
3374 Lisp_Object pane, menu, obj;
3375 struct gcpro gcpro1;
3376 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3377 GCPRO1 (pane);
3378 menu = Fcons (val, pane);
3379 obj = Fx_popup_dialog (Qt, menu, Qt);
3380 UNGCPRO;
3381 return val;
3383 #endif /* HAVE_MENUS */
3384 /* Copy the data so that it won't move when we GC. */
3385 if (! message_text)
3387 message_text = (char *)xmalloc (80);
3388 message_length = 80;
3390 if (SBYTES (val) > message_length)
3392 message_length = SBYTES (val);
3393 message_text = (char *)xrealloc (message_text, message_length);
3395 memcpy (message_text, SDATA (val), SBYTES (val));
3396 message2 (message_text, SBYTES (val),
3397 STRING_MULTIBYTE (val));
3398 return val;
3402 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3403 doc: /* Display a message in a dialog box or in the echo area.
3404 If this command was invoked with the mouse, use a dialog box if
3405 `use-dialog-box' is non-nil.
3406 Otherwise, use the echo area.
3407 The first argument is a format control string, and the rest are data
3408 to be formatted under control of the string. See `format' for details.
3410 If the first argument is nil or the empty string, clear any existing
3411 message; let the minibuffer contents show.
3413 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3414 (int nargs, Lisp_Object *args)
3416 #ifdef HAVE_MENUS
3417 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3418 && use_dialog_box)
3419 return Fmessage_box (nargs, args);
3420 #endif
3421 return Fmessage (nargs, args);
3424 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3425 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3426 (void)
3428 return current_message ();
3432 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3433 doc: /* Return a copy of STRING with text properties added.
3434 First argument is the string to copy.
3435 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3436 properties to add to the result.
3437 usage: (propertize STRING &rest PROPERTIES) */)
3438 (int nargs, Lisp_Object *args)
3440 Lisp_Object properties, string;
3441 struct gcpro gcpro1, gcpro2;
3442 int i;
3444 /* Number of args must be odd. */
3445 if ((nargs & 1) == 0 || nargs < 1)
3446 error ("Wrong number of arguments");
3448 properties = string = Qnil;
3449 GCPRO2 (properties, string);
3451 /* First argument must be a string. */
3452 CHECK_STRING (args[0]);
3453 string = Fcopy_sequence (args[0]);
3455 for (i = 1; i < nargs; i += 2)
3456 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3458 Fadd_text_properties (make_number (0),
3459 make_number (SCHARS (string)),
3460 properties, string);
3461 RETURN_UNGCPRO (string);
3465 /* Number of bytes that STRING will occupy when put into the result.
3466 MULTIBYTE is nonzero if the result should be multibyte. */
3468 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3469 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3470 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3471 : SBYTES (STRING))
3473 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3474 doc: /* Format a string out of a format-string and arguments.
3475 The first argument is a format control string.
3476 The other arguments are substituted into it to make the result, a string.
3478 The format control string may contain %-sequences meaning to substitute
3479 the next available argument:
3481 %s means print a string argument. Actually, prints any object, with `princ'.
3482 %d means print as number in decimal (%o octal, %x hex).
3483 %X is like %x, but uses upper case.
3484 %e means print a number in exponential notation.
3485 %f means print a number in decimal-point notation.
3486 %g means print a number in exponential notation
3487 or decimal-point notation, whichever uses fewer characters.
3488 %c means print a number as a single character.
3489 %S means print any object as an s-expression (using `prin1').
3491 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3492 Use %% to put a single % into the output.
3494 A %-sequence may contain optional flag, width, and precision
3495 specifiers, as follows:
3497 %<flags><width><precision>character
3499 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3501 The + flag character inserts a + before any positive number, while a
3502 space inserts a space before any positive number; these flags only
3503 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3504 The # flag means to use an alternate display form for %o, %x, %X, %e,
3505 %f, and %g sequences. The - and 0 flags affect the width specifier,
3506 as described below.
3508 The width specifier supplies a lower limit for the length of the
3509 printed representation. The padding, if any, normally goes on the
3510 left, but it goes on the right if the - flag is present. The padding
3511 character is normally a space, but it is 0 if the 0 flag is present.
3512 The - flag takes precedence over the 0 flag.
3514 For %e, %f, and %g sequences, the number after the "." in the
3515 precision specifier says how many decimal places to show; if zero, the
3516 decimal point itself is omitted. For %s and %S, the precision
3517 specifier truncates the string to the given width.
3519 usage: (format STRING &rest OBJECTS) */)
3520 (int nargs, register Lisp_Object *args)
3522 register int n; /* The number of the next arg to substitute */
3523 register EMACS_INT total; /* An estimate of the final length */
3524 char *buf, *p;
3525 register unsigned char *format, *end, *format_start;
3526 int nchars;
3527 /* Nonzero if the output should be a multibyte string,
3528 which is true if any of the inputs is one. */
3529 int multibyte = 0;
3530 /* When we make a multibyte string, we must pay attention to the
3531 byte combining problem, i.e., a byte may be combined with a
3532 multibyte character of the previous string. This flag tells if we
3533 must consider such a situation or not. */
3534 int maybe_combine_byte;
3535 unsigned char *this_format;
3536 /* Precision for each spec, or -1, a flag value meaning no precision
3537 was given in that spec. Element 0, corresonding to the format
3538 string itself, will not be used. Element NARGS, corresponding to
3539 no argument, *will* be assigned to in the case that a `%' and `.'
3540 occur after the final format specifier. */
3541 int *precision = (int *) (alloca ((nargs + 1) * sizeof (int)));
3542 int longest_format;
3543 Lisp_Object val;
3544 int arg_intervals = 0;
3545 USE_SAFE_ALLOCA;
3547 /* discarded[I] is 1 if byte I of the format
3548 string was not copied into the output.
3549 It is 2 if byte I was not the first byte of its character. */
3550 char *discarded = 0;
3552 /* Each element records, for one argument,
3553 the start and end bytepos in the output string,
3554 and whether the argument is a string with intervals.
3555 info[0] is unused. Unused elements have -1 for start. */
3556 struct info
3558 int start, end, intervals;
3559 } *info = 0;
3561 /* It should not be necessary to GCPRO ARGS, because
3562 the caller in the interpreter should take care of that. */
3564 /* Try to determine whether the result should be multibyte.
3565 This is not always right; sometimes the result needs to be multibyte
3566 because of an object that we will pass through prin1,
3567 and in that case, we won't know it here. */
3568 for (n = 0; n < nargs; n++)
3570 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3571 multibyte = 1;
3572 /* Piggyback on this loop to initialize precision[N]. */
3573 precision[n] = -1;
3575 precision[nargs] = -1;
3577 CHECK_STRING (args[0]);
3578 /* We may have to change "%S" to "%s". */
3579 args[0] = Fcopy_sequence (args[0]);
3581 /* GC should never happen here, so abort if it does. */
3582 abort_on_gc++;
3584 /* If we start out planning a unibyte result,
3585 then discover it has to be multibyte, we jump back to retry.
3586 That can only happen from the first large while loop below. */
3587 retry:
3589 format = SDATA (args[0]);
3590 format_start = format;
3591 end = format + SBYTES (args[0]);
3592 longest_format = 0;
3594 /* Make room in result for all the non-%-codes in the control string. */
3595 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]) + 1;
3597 /* Allocate the info and discarded tables. */
3599 int nbytes = (nargs+1) * sizeof *info;
3600 int i;
3601 if (!info)
3602 info = (struct info *) alloca (nbytes);
3603 memset (info, 0, nbytes);
3604 for (i = 0; i <= nargs; i++)
3605 info[i].start = -1;
3606 if (!discarded)
3607 SAFE_ALLOCA (discarded, char *, SBYTES (args[0]));
3608 memset (discarded, 0, SBYTES (args[0]));
3611 /* Add to TOTAL enough space to hold the converted arguments. */
3613 n = 0;
3614 while (format != end)
3615 if (*format++ == '%')
3617 EMACS_INT thissize = 0;
3618 EMACS_INT actual_width = 0;
3619 unsigned char *this_format_start = format - 1;
3620 int field_width = 0;
3622 /* General format specifications look like
3624 '%' [flags] [field-width] [precision] format
3626 where
3628 flags ::= [-+ #0]+
3629 field-width ::= [0-9]+
3630 precision ::= '.' [0-9]*
3632 If a field-width is specified, it specifies to which width
3633 the output should be padded with blanks, if the output
3634 string is shorter than field-width.
3636 If precision is specified, it specifies the number of
3637 digits to print after the '.' for floats, or the max.
3638 number of chars to print from a string. */
3640 while (format != end
3641 && (*format == '-' || *format == '0' || *format == '#'
3642 || * format == ' ' || *format == '+'))
3643 ++format;
3645 if (*format >= '0' && *format <= '9')
3647 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3648 field_width = 10 * field_width + *format - '0';
3651 /* N is not incremented for another few lines below, so refer to
3652 element N+1 (which might be precision[NARGS]). */
3653 if (*format == '.')
3655 ++format;
3656 for (precision[n+1] = 0; *format >= '0' && *format <= '9'; ++format)
3657 precision[n+1] = 10 * precision[n+1] + *format - '0';
3660 /* Extra +1 for 'l' that we may need to insert into the
3661 format. */
3662 if (format - this_format_start + 2 > longest_format)
3663 longest_format = format - this_format_start + 2;
3665 if (format == end)
3666 error ("Format string ends in middle of format specifier");
3667 if (*format == '%')
3668 format++;
3669 else if (++n >= nargs)
3670 error ("Not enough arguments for format string");
3671 else if (*format == 'S')
3673 /* For `S', prin1 the argument and then treat like a string. */
3674 register Lisp_Object tem;
3675 tem = Fprin1_to_string (args[n], Qnil);
3676 if (STRING_MULTIBYTE (tem) && ! multibyte)
3678 multibyte = 1;
3679 goto retry;
3681 args[n] = tem;
3682 /* If we restart the loop, we should not come here again
3683 because args[n] is now a string and calling
3684 Fprin1_to_string on it produces superflous double
3685 quotes. So, change "%S" to "%s" now. */
3686 *format = 's';
3687 goto string;
3689 else if (SYMBOLP (args[n]))
3691 args[n] = SYMBOL_NAME (args[n]);
3692 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3694 multibyte = 1;
3695 goto retry;
3697 goto string;
3699 else if (STRINGP (args[n]))
3701 string:
3702 if (*format != 's' && *format != 'S')
3703 error ("Format specifier doesn't match argument type");
3704 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3705 to be as large as is calculated here. Easy check for
3706 the case PRECISION = 0. */
3707 thissize = precision[n] ? CONVERTED_BYTE_SIZE (multibyte, args[n]) : 0;
3708 /* The precision also constrains how much of the argument
3709 string will finally appear (Bug#5710). */
3710 actual_width = lisp_string_width (args[n], -1, NULL, NULL);
3711 if (precision[n] != -1)
3712 actual_width = min (actual_width, precision[n]);
3714 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3715 else if (INTEGERP (args[n]) && *format != 's')
3717 /* The following loop assumes the Lisp type indicates
3718 the proper way to pass the argument.
3719 So make sure we have a flonum if the argument should
3720 be a double. */
3721 if (*format == 'e' || *format == 'f' || *format == 'g')
3722 args[n] = Ffloat (args[n]);
3723 else
3724 if (*format != 'd' && *format != 'o' && *format != 'x'
3725 && *format != 'i' && *format != 'X' && *format != 'c')
3726 error ("Invalid format operation %%%c", *format);
3728 thissize = 30 + (precision[n] > 0 ? precision[n] : 0);
3729 if (*format == 'c')
3731 if (! ASCII_CHAR_P (XINT (args[n]))
3732 /* Note: No one can remeber why we have to treat
3733 the character 0 as a multibyte character here.
3734 But, until it causes a real problem, let's
3735 don't change it. */
3736 || XINT (args[n]) == 0)
3738 if (! multibyte)
3740 multibyte = 1;
3741 goto retry;
3743 args[n] = Fchar_to_string (args[n]);
3744 thissize = SBYTES (args[n]);
3746 else if (! ASCII_BYTE_P (XINT (args[n])) && multibyte)
3748 args[n]
3749 = Fchar_to_string (Funibyte_char_to_multibyte (args[n]));
3750 thissize = SBYTES (args[n]);
3754 else if (FLOATP (args[n]) && *format != 's')
3756 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3758 if (*format != 'd' && *format != 'o' && *format != 'x'
3759 && *format != 'i' && *format != 'X' && *format != 'c')
3760 error ("Invalid format operation %%%c", *format);
3761 /* This fails unnecessarily if args[n] is bigger than
3762 most-positive-fixnum but smaller than MAXINT.
3763 These cases are important because we sometimes use floats
3764 to represent such integer values (typically such values
3765 come from UIDs or PIDs). */
3766 /* args[n] = Ftruncate (args[n], Qnil); */
3769 /* Note that we're using sprintf to print floats,
3770 so we have to take into account what that function
3771 prints. */
3772 /* Filter out flag value of -1. */
3773 thissize = (MAX_10_EXP + 100
3774 + (precision[n] > 0 ? precision[n] : 0));
3776 else
3778 /* Anything but a string, convert to a string using princ. */
3779 register Lisp_Object tem;
3780 tem = Fprin1_to_string (args[n], Qt);
3781 if (STRING_MULTIBYTE (tem) && ! multibyte)
3783 multibyte = 1;
3784 goto retry;
3786 args[n] = tem;
3787 goto string;
3790 thissize += max (0, field_width - actual_width);
3791 total += thissize + 4;
3794 abort_on_gc--;
3796 /* Now we can no longer jump to retry.
3797 TOTAL and LONGEST_FORMAT are known for certain. */
3799 this_format = (unsigned char *) alloca (longest_format + 1);
3801 /* Allocate the space for the result.
3802 Note that TOTAL is an overestimate. */
3803 SAFE_ALLOCA (buf, char *, total);
3805 p = buf;
3806 nchars = 0;
3807 n = 0;
3809 /* Scan the format and store result in BUF. */
3810 format = SDATA (args[0]);
3811 format_start = format;
3812 end = format + SBYTES (args[0]);
3813 maybe_combine_byte = 0;
3814 while (format != end)
3816 if (*format == '%')
3818 int minlen;
3819 int negative = 0;
3820 unsigned char *this_format_start = format;
3822 discarded[format - format_start] = 1;
3823 format++;
3825 while (strchr ("-+0# ", *format))
3827 if (*format == '-')
3829 negative = 1;
3831 discarded[format - format_start] = 1;
3832 ++format;
3835 minlen = atoi (format);
3837 while ((*format >= '0' && *format <= '9') || *format == '.')
3839 discarded[format - format_start] = 1;
3840 format++;
3843 if (*format++ == '%')
3845 *p++ = '%';
3846 nchars++;
3847 continue;
3850 ++n;
3852 discarded[format - format_start - 1] = 1;
3853 info[n].start = nchars;
3855 if (STRINGP (args[n]))
3857 /* handle case (precision[n] >= 0) */
3859 int width, padding;
3860 EMACS_INT nbytes, start, end;
3861 EMACS_INT nchars_string;
3863 /* lisp_string_width ignores a precision of 0, but GNU
3864 libc functions print 0 characters when the precision
3865 is 0. Imitate libc behavior here. Changing
3866 lisp_string_width is the right thing, and will be
3867 done, but meanwhile we work with it. */
3869 if (precision[n] == 0)
3870 width = nchars_string = nbytes = 0;
3871 else if (precision[n] > 0)
3872 width = lisp_string_width (args[n], precision[n],
3873 &nchars_string, &nbytes);
3874 else
3875 { /* no precision spec given for this argument */
3876 width = lisp_string_width (args[n], -1, NULL, NULL);
3877 nbytes = SBYTES (args[n]);
3878 nchars_string = SCHARS (args[n]);
3881 /* If spec requires it, pad on right with spaces. */
3882 padding = minlen - width;
3883 if (! negative)
3884 while (padding-- > 0)
3886 *p++ = ' ';
3887 ++nchars;
3890 info[n].start = start = nchars;
3891 nchars += nchars_string;
3892 end = nchars;
3894 if (p > buf
3895 && multibyte
3896 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3897 && STRING_MULTIBYTE (args[n])
3898 && !CHAR_HEAD_P (SREF (args[n], 0)))
3899 maybe_combine_byte = 1;
3901 p += copy_text (SDATA (args[n]), p,
3902 nbytes,
3903 STRING_MULTIBYTE (args[n]), multibyte);
3905 info[n].end = nchars;
3907 if (negative)
3908 while (padding-- > 0)
3910 *p++ = ' ';
3911 nchars++;
3914 /* If this argument has text properties, record where
3915 in the result string it appears. */
3916 if (STRING_INTERVALS (args[n]))
3917 info[n].intervals = arg_intervals = 1;
3919 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3921 int this_nchars;
3923 memcpy (this_format, this_format_start,
3924 format - this_format_start);
3925 this_format[format - this_format_start] = 0;
3927 if (format[-1] == 'e' || format[-1] == 'f' || format[-1] == 'g')
3928 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3929 else
3931 if (sizeof (EMACS_INT) > sizeof (int)
3932 && format[-1] != 'c')
3934 /* Insert 'l' before format spec. */
3935 this_format[format - this_format_start]
3936 = this_format[format - this_format_start - 1];
3937 this_format[format - this_format_start - 1] = 'l';
3938 this_format[format - this_format_start + 1] = 0;
3941 if (INTEGERP (args[n]))
3943 if (format[-1] == 'c')
3944 sprintf (p, this_format, (int) XINT (args[n]));
3945 else if (format[-1] == 'd')
3946 sprintf (p, this_format, XINT (args[n]));
3947 /* Don't sign-extend for octal or hex printing. */
3948 else
3949 sprintf (p, this_format, XUINT (args[n]));
3951 else if (format[-1] == 'c')
3952 sprintf (p, this_format, (int) XFLOAT_DATA (args[n]));
3953 else if (format[-1] == 'd')
3954 /* Maybe we should use "%1.0f" instead so it also works
3955 for values larger than MAXINT. */
3956 sprintf (p, this_format, (EMACS_INT) XFLOAT_DATA (args[n]));
3957 else
3958 /* Don't sign-extend for octal or hex printing. */
3959 sprintf (p, this_format, (EMACS_UINT) XFLOAT_DATA (args[n]));
3962 if (p > buf
3963 && multibyte
3964 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3965 && !CHAR_HEAD_P (*((unsigned char *) p)))
3966 maybe_combine_byte = 1;
3967 this_nchars = strlen (p);
3968 if (multibyte)
3969 p += str_to_multibyte (p, buf + total - 1 - p, this_nchars);
3970 else
3971 p += this_nchars;
3972 nchars += this_nchars;
3973 info[n].end = nchars;
3977 else if (STRING_MULTIBYTE (args[0]))
3979 /* Copy a whole multibyte character. */
3980 if (p > buf
3981 && multibyte
3982 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3983 && !CHAR_HEAD_P (*format))
3984 maybe_combine_byte = 1;
3985 *p++ = *format++;
3986 while (! CHAR_HEAD_P (*format))
3988 discarded[format - format_start] = 2;
3989 *p++ = *format++;
3991 nchars++;
3993 else if (multibyte)
3995 /* Convert a single-byte character to multibyte. */
3996 int len = copy_text (format, p, 1, 0, 1);
3998 p += len;
3999 format++;
4000 nchars++;
4002 else
4003 *p++ = *format++, nchars++;
4006 if (p > buf + total)
4007 abort ();
4009 if (maybe_combine_byte)
4010 nchars = multibyte_chars_in_text (buf, p - buf);
4011 val = make_specified_string (buf, nchars, p - buf, multibyte);
4013 /* If we allocated BUF with malloc, free it too. */
4014 SAFE_FREE ();
4016 /* If the format string has text properties, or any of the string
4017 arguments has text properties, set up text properties of the
4018 result string. */
4020 if (STRING_INTERVALS (args[0]) || arg_intervals)
4022 Lisp_Object len, new_len, props;
4023 struct gcpro gcpro1;
4025 /* Add text properties from the format string. */
4026 len = make_number (SCHARS (args[0]));
4027 props = text_property_list (args[0], make_number (0), len, Qnil);
4028 GCPRO1 (props);
4030 if (CONSP (props))
4032 EMACS_INT bytepos = 0, position = 0, translated = 0;
4033 int argn = 1;
4034 Lisp_Object list;
4036 /* Adjust the bounds of each text property
4037 to the proper start and end in the output string. */
4039 /* Put the positions in PROPS in increasing order, so that
4040 we can do (effectively) one scan through the position
4041 space of the format string. */
4042 props = Fnreverse (props);
4044 /* BYTEPOS is the byte position in the format string,
4045 POSITION is the untranslated char position in it,
4046 TRANSLATED is the translated char position in BUF,
4047 and ARGN is the number of the next arg we will come to. */
4048 for (list = props; CONSP (list); list = XCDR (list))
4050 Lisp_Object item;
4051 EMACS_INT pos;
4053 item = XCAR (list);
4055 /* First adjust the property start position. */
4056 pos = XINT (XCAR (item));
4058 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4059 up to this position. */
4060 for (; position < pos; bytepos++)
4062 if (! discarded[bytepos])
4063 position++, translated++;
4064 else if (discarded[bytepos] == 1)
4066 position++;
4067 if (translated == info[argn].start)
4069 translated += info[argn].end - info[argn].start;
4070 argn++;
4075 XSETCAR (item, make_number (translated));
4077 /* Likewise adjust the property end position. */
4078 pos = XINT (XCAR (XCDR (item)));
4080 for (; position < pos; bytepos++)
4082 if (! discarded[bytepos])
4083 position++, translated++;
4084 else if (discarded[bytepos] == 1)
4086 position++;
4087 if (translated == info[argn].start)
4089 translated += info[argn].end - info[argn].start;
4090 argn++;
4095 XSETCAR (XCDR (item), make_number (translated));
4098 add_text_properties_from_list (val, props, make_number (0));
4101 /* Add text properties from arguments. */
4102 if (arg_intervals)
4103 for (n = 1; n < nargs; ++n)
4104 if (info[n].intervals)
4106 len = make_number (SCHARS (args[n]));
4107 new_len = make_number (info[n].end - info[n].start);
4108 props = text_property_list (args[n], make_number (0), len, Qnil);
4109 props = extend_property_ranges (props, new_len);
4110 /* If successive arguments have properties, be sure that
4111 the value of `composition' property be the copy. */
4112 if (n > 1 && info[n - 1].end)
4113 make_composition_value_copy (props);
4114 add_text_properties_from_list (val, props,
4115 make_number (info[n].start));
4118 UNGCPRO;
4121 return val;
4124 Lisp_Object
4125 format2 (const char *string1, Lisp_Object arg0, Lisp_Object arg1)
4127 Lisp_Object args[3];
4128 args[0] = build_string (string1);
4129 args[1] = arg0;
4130 args[2] = arg1;
4131 return Fformat (3, args);
4134 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4135 doc: /* Return t if two characters match, optionally ignoring case.
4136 Both arguments must be characters (i.e. integers).
4137 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4138 (register Lisp_Object c1, Lisp_Object c2)
4140 int i1, i2;
4141 /* Check they're chars, not just integers, otherwise we could get array
4142 bounds violations in DOWNCASE. */
4143 CHECK_CHARACTER (c1);
4144 CHECK_CHARACTER (c2);
4146 if (XINT (c1) == XINT (c2))
4147 return Qt;
4148 if (NILP (current_buffer->case_fold_search))
4149 return Qnil;
4151 /* Do these in separate statements,
4152 then compare the variables.
4153 because of the way DOWNCASE uses temp variables. */
4154 i1 = XFASTINT (c1);
4155 if (NILP (current_buffer->enable_multibyte_characters)
4156 && ! ASCII_CHAR_P (i1))
4158 MAKE_CHAR_MULTIBYTE (i1);
4160 i2 = XFASTINT (c2);
4161 if (NILP (current_buffer->enable_multibyte_characters)
4162 && ! ASCII_CHAR_P (i2))
4164 MAKE_CHAR_MULTIBYTE (i2);
4166 i1 = DOWNCASE (i1);
4167 i2 = DOWNCASE (i2);
4168 return (i1 == i2 ? Qt : Qnil);
4171 /* Transpose the markers in two regions of the current buffer, and
4172 adjust the ones between them if necessary (i.e.: if the regions
4173 differ in size).
4175 START1, END1 are the character positions of the first region.
4176 START1_BYTE, END1_BYTE are the byte positions.
4177 START2, END2 are the character positions of the second region.
4178 START2_BYTE, END2_BYTE are the byte positions.
4180 Traverses the entire marker list of the buffer to do so, adding an
4181 appropriate amount to some, subtracting from some, and leaving the
4182 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4184 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4186 static void
4187 transpose_markers (EMACS_INT start1, EMACS_INT end1,
4188 EMACS_INT start2, EMACS_INT end2,
4189 EMACS_INT start1_byte, EMACS_INT end1_byte,
4190 EMACS_INT start2_byte, EMACS_INT end2_byte)
4192 register EMACS_INT amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4193 register struct Lisp_Marker *marker;
4195 /* Update point as if it were a marker. */
4196 if (PT < start1)
4198 else if (PT < end1)
4199 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4200 PT_BYTE + (end2_byte - end1_byte));
4201 else if (PT < start2)
4202 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4203 (PT_BYTE + (end2_byte - start2_byte)
4204 - (end1_byte - start1_byte)));
4205 else if (PT < end2)
4206 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4207 PT_BYTE - (start2_byte - start1_byte));
4209 /* We used to adjust the endpoints here to account for the gap, but that
4210 isn't good enough. Even if we assume the caller has tried to move the
4211 gap out of our way, it might still be at start1 exactly, for example;
4212 and that places it `inside' the interval, for our purposes. The amount
4213 of adjustment is nontrivial if there's a `denormalized' marker whose
4214 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4215 the dirty work to Fmarker_position, below. */
4217 /* The difference between the region's lengths */
4218 diff = (end2 - start2) - (end1 - start1);
4219 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4221 /* For shifting each marker in a region by the length of the other
4222 region plus the distance between the regions. */
4223 amt1 = (end2 - start2) + (start2 - end1);
4224 amt2 = (end1 - start1) + (start2 - end1);
4225 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4226 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4228 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4230 mpos = marker->bytepos;
4231 if (mpos >= start1_byte && mpos < end2_byte)
4233 if (mpos < end1_byte)
4234 mpos += amt1_byte;
4235 else if (mpos < start2_byte)
4236 mpos += diff_byte;
4237 else
4238 mpos -= amt2_byte;
4239 marker->bytepos = mpos;
4241 mpos = marker->charpos;
4242 if (mpos >= start1 && mpos < end2)
4244 if (mpos < end1)
4245 mpos += amt1;
4246 else if (mpos < start2)
4247 mpos += diff;
4248 else
4249 mpos -= amt2;
4251 marker->charpos = mpos;
4255 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4256 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4257 The regions should not be overlapping, because the size of the buffer is
4258 never changed in a transposition.
4260 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4261 any markers that happen to be located in the regions.
4263 Transposing beyond buffer boundaries is an error. */)
4264 (Lisp_Object startr1, Lisp_Object endr1, Lisp_Object startr2, Lisp_Object endr2, Lisp_Object leave_markers)
4266 register EMACS_INT start1, end1, start2, end2;
4267 EMACS_INT start1_byte, start2_byte, len1_byte, len2_byte;
4268 EMACS_INT gap, len1, len_mid, len2;
4269 unsigned char *start1_addr, *start2_addr, *temp;
4271 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4272 Lisp_Object buf;
4274 XSETBUFFER (buf, current_buffer);
4275 cur_intv = BUF_INTERVALS (current_buffer);
4277 validate_region (&startr1, &endr1);
4278 validate_region (&startr2, &endr2);
4280 start1 = XFASTINT (startr1);
4281 end1 = XFASTINT (endr1);
4282 start2 = XFASTINT (startr2);
4283 end2 = XFASTINT (endr2);
4284 gap = GPT;
4286 /* Swap the regions if they're reversed. */
4287 if (start2 < end1)
4289 register EMACS_INT glumph = start1;
4290 start1 = start2;
4291 start2 = glumph;
4292 glumph = end1;
4293 end1 = end2;
4294 end2 = glumph;
4297 len1 = end1 - start1;
4298 len2 = end2 - start2;
4300 if (start2 < end1)
4301 error ("Transposed regions overlap");
4302 else if (start1 == end1 || start2 == end2)
4303 error ("Transposed region has length 0");
4305 /* The possibilities are:
4306 1. Adjacent (contiguous) regions, or separate but equal regions
4307 (no, really equal, in this case!), or
4308 2. Separate regions of unequal size.
4310 The worst case is usually No. 2. It means that (aside from
4311 potential need for getting the gap out of the way), there also
4312 needs to be a shifting of the text between the two regions. So
4313 if they are spread far apart, we are that much slower... sigh. */
4315 /* It must be pointed out that the really studly thing to do would
4316 be not to move the gap at all, but to leave it in place and work
4317 around it if necessary. This would be extremely efficient,
4318 especially considering that people are likely to do
4319 transpositions near where they are working interactively, which
4320 is exactly where the gap would be found. However, such code
4321 would be much harder to write and to read. So, if you are
4322 reading this comment and are feeling squirrely, by all means have
4323 a go! I just didn't feel like doing it, so I will simply move
4324 the gap the minimum distance to get it out of the way, and then
4325 deal with an unbroken array. */
4327 /* Make sure the gap won't interfere, by moving it out of the text
4328 we will operate on. */
4329 if (start1 < gap && gap < end2)
4331 if (gap - start1 < end2 - gap)
4332 move_gap (start1);
4333 else
4334 move_gap (end2);
4337 start1_byte = CHAR_TO_BYTE (start1);
4338 start2_byte = CHAR_TO_BYTE (start2);
4339 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4340 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
4342 #ifdef BYTE_COMBINING_DEBUG
4343 if (end1 == start2)
4345 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4346 len2_byte, start1, start1_byte)
4347 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4348 len1_byte, end2, start2_byte + len2_byte)
4349 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4350 len1_byte, end2, start2_byte + len2_byte))
4351 abort ();
4353 else
4355 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4356 len2_byte, start1, start1_byte)
4357 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4358 len1_byte, start2, start2_byte)
4359 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4360 len2_byte, end1, start1_byte + len1_byte)
4361 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4362 len1_byte, end2, start2_byte + len2_byte))
4363 abort ();
4365 #endif
4367 /* Hmmm... how about checking to see if the gap is large
4368 enough to use as the temporary storage? That would avoid an
4369 allocation... interesting. Later, don't fool with it now. */
4371 /* Working without memmove, for portability (sigh), so must be
4372 careful of overlapping subsections of the array... */
4374 if (end1 == start2) /* adjacent regions */
4376 modify_region (current_buffer, start1, end2, 0);
4377 record_change (start1, len1 + len2);
4379 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4380 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4381 /* Don't use Fset_text_properties: that can cause GC, which can
4382 clobber objects stored in the tmp_intervals. */
4383 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4384 if (!NULL_INTERVAL_P (tmp_interval3))
4385 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4387 /* First region smaller than second. */
4388 if (len1_byte < len2_byte)
4390 USE_SAFE_ALLOCA;
4392 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4394 /* Don't precompute these addresses. We have to compute them
4395 at the last minute, because the relocating allocator might
4396 have moved the buffer around during the xmalloc. */
4397 start1_addr = BYTE_POS_ADDR (start1_byte);
4398 start2_addr = BYTE_POS_ADDR (start2_byte);
4400 memcpy (temp, start2_addr, len2_byte);
4401 memcpy (start1_addr + len2_byte, start1_addr, len1_byte);
4402 memcpy (start1_addr, temp, len2_byte);
4403 SAFE_FREE ();
4405 else
4406 /* First region not smaller than second. */
4408 USE_SAFE_ALLOCA;
4410 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4411 start1_addr = BYTE_POS_ADDR (start1_byte);
4412 start2_addr = BYTE_POS_ADDR (start2_byte);
4413 memcpy (temp, start1_addr, len1_byte);
4414 memcpy (start1_addr, start2_addr, len2_byte);
4415 memcpy (start1_addr + len2_byte, temp, len1_byte);
4416 SAFE_FREE ();
4418 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4419 len1, current_buffer, 0);
4420 graft_intervals_into_buffer (tmp_interval2, start1,
4421 len2, current_buffer, 0);
4422 update_compositions (start1, start1 + len2, CHECK_BORDER);
4423 update_compositions (start1 + len2, end2, CHECK_TAIL);
4425 /* Non-adjacent regions, because end1 != start2, bleagh... */
4426 else
4428 len_mid = start2_byte - (start1_byte + len1_byte);
4430 if (len1_byte == len2_byte)
4431 /* Regions are same size, though, how nice. */
4433 USE_SAFE_ALLOCA;
4435 modify_region (current_buffer, start1, end1, 0);
4436 modify_region (current_buffer, start2, end2, 0);
4437 record_change (start1, len1);
4438 record_change (start2, len2);
4439 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4440 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4442 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4443 if (!NULL_INTERVAL_P (tmp_interval3))
4444 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4446 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4447 if (!NULL_INTERVAL_P (tmp_interval3))
4448 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4450 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4451 start1_addr = BYTE_POS_ADDR (start1_byte);
4452 start2_addr = BYTE_POS_ADDR (start2_byte);
4453 memcpy (temp, start1_addr, len1_byte);
4454 memcpy (start1_addr, start2_addr, len2_byte);
4455 memcpy (start2_addr, temp, len1_byte);
4456 SAFE_FREE ();
4458 graft_intervals_into_buffer (tmp_interval1, start2,
4459 len1, current_buffer, 0);
4460 graft_intervals_into_buffer (tmp_interval2, start1,
4461 len2, current_buffer, 0);
4464 else if (len1_byte < len2_byte) /* Second region larger than first */
4465 /* Non-adjacent & unequal size, area between must also be shifted. */
4467 USE_SAFE_ALLOCA;
4469 modify_region (current_buffer, start1, end2, 0);
4470 record_change (start1, (end2 - start1));
4471 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4472 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4473 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4475 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4476 if (!NULL_INTERVAL_P (tmp_interval3))
4477 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4479 /* holds region 2 */
4480 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4481 start1_addr = BYTE_POS_ADDR (start1_byte);
4482 start2_addr = BYTE_POS_ADDR (start2_byte);
4483 memcpy (temp, start2_addr, len2_byte);
4484 memcpy (start1_addr + len_mid + len2_byte, start1_addr, len1_byte);
4485 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4486 memcpy (start1_addr, temp, len2_byte);
4487 SAFE_FREE ();
4489 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4490 len1, current_buffer, 0);
4491 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4492 len_mid, current_buffer, 0);
4493 graft_intervals_into_buffer (tmp_interval2, start1,
4494 len2, current_buffer, 0);
4496 else
4497 /* Second region smaller than first. */
4499 USE_SAFE_ALLOCA;
4501 record_change (start1, (end2 - start1));
4502 modify_region (current_buffer, start1, end2, 0);
4504 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4505 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4506 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4508 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4509 if (!NULL_INTERVAL_P (tmp_interval3))
4510 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4512 /* holds region 1 */
4513 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4514 start1_addr = BYTE_POS_ADDR (start1_byte);
4515 start2_addr = BYTE_POS_ADDR (start2_byte);
4516 memcpy (temp, start1_addr, len1_byte);
4517 memcpy (start1_addr, start2_addr, len2_byte);
4518 memcpy (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4519 memcpy (start1_addr + len2_byte + len_mid, temp, len1_byte);
4520 SAFE_FREE ();
4522 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4523 len1, current_buffer, 0);
4524 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4525 len_mid, current_buffer, 0);
4526 graft_intervals_into_buffer (tmp_interval2, start1,
4527 len2, current_buffer, 0);
4530 update_compositions (start1, start1 + len2, CHECK_BORDER);
4531 update_compositions (end2 - len1, end2, CHECK_BORDER);
4534 /* When doing multiple transpositions, it might be nice
4535 to optimize this. Perhaps the markers in any one buffer
4536 should be organized in some sorted data tree. */
4537 if (NILP (leave_markers))
4539 transpose_markers (start1, end1, start2, end2,
4540 start1_byte, start1_byte + len1_byte,
4541 start2_byte, start2_byte + len2_byte);
4542 fix_start_end_in_overlays (start1, end2);
4545 signal_after_change (start1, end2 - start1, end2 - start1);
4546 return Qnil;
4550 void
4551 syms_of_editfns (void)
4553 environbuf = 0;
4554 initial_tz = 0;
4556 Qbuffer_access_fontify_functions
4557 = intern_c_string ("buffer-access-fontify-functions");
4558 staticpro (&Qbuffer_access_fontify_functions);
4560 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
4561 doc: /* Non-nil means text motion commands don't notice fields. */);
4562 Vinhibit_field_text_motion = Qnil;
4564 DEFVAR_LISP ("buffer-access-fontify-functions",
4565 &Vbuffer_access_fontify_functions,
4566 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
4567 Each function is called with two arguments which specify the range
4568 of the buffer being accessed. */);
4569 Vbuffer_access_fontify_functions = Qnil;
4572 Lisp_Object obuf;
4573 obuf = Fcurrent_buffer ();
4574 /* Do this here, because init_buffer_once is too early--it won't work. */
4575 Fset_buffer (Vprin1_to_string_buffer);
4576 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4577 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
4578 Qnil);
4579 Fset_buffer (obuf);
4582 DEFVAR_LISP ("buffer-access-fontified-property",
4583 &Vbuffer_access_fontified_property,
4584 doc: /* Property which (if non-nil) indicates text has been fontified.
4585 `buffer-substring' need not call the `buffer-access-fontify-functions'
4586 functions if all the text being accessed has this property. */);
4587 Vbuffer_access_fontified_property = Qnil;
4589 DEFVAR_LISP ("system-name", &Vsystem_name,
4590 doc: /* The host name of the machine Emacs is running on. */);
4592 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
4593 doc: /* The full name of the user logged in. */);
4595 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
4596 doc: /* The user's name, taken from environment variables if possible. */);
4598 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
4599 doc: /* The user's name, based upon the real uid only. */);
4601 DEFVAR_LISP ("operating-system-release", &Voperating_system_release,
4602 doc: /* The release of the operating system Emacs is running on. */);
4604 defsubr (&Spropertize);
4605 defsubr (&Schar_equal);
4606 defsubr (&Sgoto_char);
4607 defsubr (&Sstring_to_char);
4608 defsubr (&Schar_to_string);
4609 defsubr (&Sbyte_to_string);
4610 defsubr (&Sbuffer_substring);
4611 defsubr (&Sbuffer_substring_no_properties);
4612 defsubr (&Sbuffer_string);
4614 defsubr (&Spoint_marker);
4615 defsubr (&Smark_marker);
4616 defsubr (&Spoint);
4617 defsubr (&Sregion_beginning);
4618 defsubr (&Sregion_end);
4620 staticpro (&Qfield);
4621 Qfield = intern_c_string ("field");
4622 staticpro (&Qboundary);
4623 Qboundary = intern_c_string ("boundary");
4624 defsubr (&Sfield_beginning);
4625 defsubr (&Sfield_end);
4626 defsubr (&Sfield_string);
4627 defsubr (&Sfield_string_no_properties);
4628 defsubr (&Sdelete_field);
4629 defsubr (&Sconstrain_to_field);
4631 defsubr (&Sline_beginning_position);
4632 defsubr (&Sline_end_position);
4634 /* defsubr (&Smark); */
4635 /* defsubr (&Sset_mark); */
4636 defsubr (&Ssave_excursion);
4637 defsubr (&Ssave_current_buffer);
4639 defsubr (&Sbufsize);
4640 defsubr (&Spoint_max);
4641 defsubr (&Spoint_min);
4642 defsubr (&Spoint_min_marker);
4643 defsubr (&Spoint_max_marker);
4644 defsubr (&Sgap_position);
4645 defsubr (&Sgap_size);
4646 defsubr (&Sposition_bytes);
4647 defsubr (&Sbyte_to_position);
4649 defsubr (&Sbobp);
4650 defsubr (&Seobp);
4651 defsubr (&Sbolp);
4652 defsubr (&Seolp);
4653 defsubr (&Sfollowing_char);
4654 defsubr (&Sprevious_char);
4655 defsubr (&Schar_after);
4656 defsubr (&Schar_before);
4657 defsubr (&Sinsert);
4658 defsubr (&Sinsert_before_markers);
4659 defsubr (&Sinsert_and_inherit);
4660 defsubr (&Sinsert_and_inherit_before_markers);
4661 defsubr (&Sinsert_char);
4662 defsubr (&Sinsert_byte);
4664 defsubr (&Suser_login_name);
4665 defsubr (&Suser_real_login_name);
4666 defsubr (&Suser_uid);
4667 defsubr (&Suser_real_uid);
4668 defsubr (&Suser_full_name);
4669 defsubr (&Semacs_pid);
4670 defsubr (&Scurrent_time);
4671 defsubr (&Sget_internal_run_time);
4672 defsubr (&Sformat_time_string);
4673 defsubr (&Sfloat_time);
4674 defsubr (&Sdecode_time);
4675 defsubr (&Sencode_time);
4676 defsubr (&Scurrent_time_string);
4677 defsubr (&Scurrent_time_zone);
4678 defsubr (&Sset_time_zone_rule);
4679 defsubr (&Ssystem_name);
4680 defsubr (&Smessage);
4681 defsubr (&Smessage_box);
4682 defsubr (&Smessage_or_box);
4683 defsubr (&Scurrent_message);
4684 defsubr (&Sformat);
4686 defsubr (&Sinsert_buffer_substring);
4687 defsubr (&Scompare_buffer_substrings);
4688 defsubr (&Ssubst_char_in_region);
4689 defsubr (&Stranslate_region_internal);
4690 defsubr (&Sdelete_region);
4691 defsubr (&Sdelete_and_extract_region);
4692 defsubr (&Swiden);
4693 defsubr (&Snarrow_to_region);
4694 defsubr (&Ssave_restriction);
4695 defsubr (&Stranspose_regions);