Merge from mainline.
[emacs.git] / src / editfns.c
blobe7da96265bf22aa6b20e4b653678b73380a303fb
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 #include <unistd.h>
34 #ifdef HAVE_SYS_UTSNAME_H
35 #include <sys/utsname.h>
36 #endif
38 #include "lisp.h"
40 /* systime.h includes <sys/time.h> which, on some systems, is required
41 for <sys/resource.h>; thus systime.h must be included before
42 <sys/resource.h> */
43 #include "systime.h"
45 #if defined HAVE_SYS_RESOURCE_H
46 #include <sys/resource.h>
47 #endif
49 #include <ctype.h>
51 #include "intervals.h"
52 #include "buffer.h"
53 #include "character.h"
54 #include "coding.h"
55 #include "frame.h"
56 #include "window.h"
57 #include "blockinput.h"
59 #ifdef STDC_HEADERS
60 #include <float.h>
61 #define MAX_10_EXP DBL_MAX_10_EXP
62 #else
63 #define MAX_10_EXP 310
64 #endif
66 #ifndef NULL
67 #define NULL 0
68 #endif
70 #ifndef USER_FULL_NAME
71 #define USER_FULL_NAME pw->pw_gecos
72 #endif
74 #ifndef USE_CRT_DLL
75 extern char **environ;
76 #endif
78 #define TM_YEAR_BASE 1900
80 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
81 asctime to have well-defined behavior. */
82 #ifndef TM_YEAR_IN_ASCTIME_RANGE
83 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
84 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
85 #endif
87 extern size_t emacs_strftimeu (char *, size_t, const char *,
88 const struct tm *, int);
90 #ifdef WINDOWSNT
91 extern Lisp_Object w32_get_internal_run_time (void);
92 #endif
94 static int tm_diff (struct tm *, struct tm *);
95 static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
96 EMACS_INT *, Lisp_Object, EMACS_INT *);
97 static void update_buffer_properties (EMACS_INT, EMACS_INT);
98 static Lisp_Object region_limit (int);
99 static size_t emacs_memftimeu (char *, size_t, const char *,
100 size_t, const struct tm *, int);
101 static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
102 void (*) (Lisp_Object, EMACS_INT,
103 EMACS_INT, EMACS_INT,
104 EMACS_INT, int),
105 int, int, Lisp_Object *);
106 static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
107 static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
108 static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
109 EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
111 Lisp_Object Vbuffer_access_fontify_functions;
112 Lisp_Object Qbuffer_access_fontify_functions;
113 Lisp_Object Vbuffer_access_fontified_property;
115 Lisp_Object Fuser_full_name (Lisp_Object);
117 /* Non-nil means don't stop at field boundary in text motion commands. */
119 Lisp_Object Vinhibit_field_text_motion;
121 /* Some static data, and a function to initialize it for each run */
123 Lisp_Object Vsystem_name;
124 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
125 Lisp_Object Vuser_full_name; /* full name of current user */
126 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER */
127 Lisp_Object Voperating_system_release; /* Operating System Release */
129 /* Symbol for the text property used to mark fields. */
131 Lisp_Object Qfield;
133 /* A special value for Qfield properties. */
135 Lisp_Object Qboundary;
138 void
139 init_editfns (void)
141 char *user_name;
142 register unsigned char *p;
143 struct passwd *pw; /* password entry for the current user */
144 Lisp_Object tem;
146 /* Set up system_name even when dumping. */
147 init_system_name ();
149 #ifndef CANNOT_DUMP
150 /* Don't bother with this on initial start when just dumping out */
151 if (!initialized)
152 return;
153 #endif /* not CANNOT_DUMP */
155 pw = (struct passwd *) getpwuid (getuid ());
156 #ifdef MSDOS
157 /* We let the real user name default to "root" because that's quite
158 accurate on MSDOG and because it lets Emacs find the init file.
159 (The DVX libraries override the Djgpp libraries here.) */
160 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
161 #else
162 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
163 #endif
165 /* Get the effective user name, by consulting environment variables,
166 or the effective uid if those are unset. */
167 user_name = (char *) getenv ("LOGNAME");
168 if (!user_name)
169 #ifdef WINDOWSNT
170 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
171 #else /* WINDOWSNT */
172 user_name = (char *) getenv ("USER");
173 #endif /* WINDOWSNT */
174 if (!user_name)
176 pw = (struct passwd *) getpwuid (geteuid ());
177 user_name = (char *) (pw ? pw->pw_name : "unknown");
179 Vuser_login_name = build_string (user_name);
181 /* If the user name claimed in the environment vars differs from
182 the real uid, use the claimed name to find the full name. */
183 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
184 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
185 : Vuser_login_name);
187 p = (unsigned char *) getenv ("NAME");
188 if (p)
189 Vuser_full_name = build_string (p);
190 else if (NILP (Vuser_full_name))
191 Vuser_full_name = build_string ("unknown");
193 #ifdef HAVE_SYS_UTSNAME_H
195 struct utsname uts;
196 uname (&uts);
197 Voperating_system_release = build_string (uts.release);
199 #else
200 Voperating_system_release = Qnil;
201 #endif
204 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
205 doc: /* Convert arg CHAR to a string containing that character.
206 usage: (char-to-string CHAR) */)
207 (Lisp_Object character)
209 int len;
210 unsigned char str[MAX_MULTIBYTE_LENGTH];
212 CHECK_CHARACTER (character);
214 len = CHAR_STRING (XFASTINT (character), str);
215 return make_string_from_bytes (str, 1, len);
218 DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
219 doc: /* Convert arg BYTE to a unibyte string containing that byte. */)
220 (Lisp_Object byte)
222 unsigned char b;
223 CHECK_NUMBER (byte);
224 if (XINT (byte) < 0 || XINT (byte) > 255)
225 error ("Invalid byte");
226 b = XINT (byte);
227 return make_string_from_bytes (&b, 1, 1);
230 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
231 doc: /* Convert arg STRING to a character, the first character of that string.
232 A multibyte character is handled correctly. */)
233 (register Lisp_Object string)
235 register Lisp_Object val;
236 CHECK_STRING (string);
237 if (SCHARS (string))
239 if (STRING_MULTIBYTE (string))
240 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
241 else
242 XSETFASTINT (val, SREF (string, 0));
244 else
245 XSETFASTINT (val, 0);
246 return val;
249 static Lisp_Object
250 buildmark (EMACS_INT charpos, EMACS_INT bytepos)
252 register Lisp_Object mark;
253 mark = Fmake_marker ();
254 set_marker_both (mark, Qnil, charpos, bytepos);
255 return mark;
258 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
259 doc: /* Return value of point, as an integer.
260 Beginning of buffer is position (point-min). */)
261 (void)
263 Lisp_Object temp;
264 XSETFASTINT (temp, PT);
265 return temp;
268 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
269 doc: /* Return value of point, as a marker object. */)
270 (void)
272 return buildmark (PT, PT_BYTE);
275 EMACS_INT
276 clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
278 if (num < lower)
279 return lower;
280 else if (num > upper)
281 return upper;
282 else
283 return num;
286 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
287 doc: /* Set point to POSITION, a number or marker.
288 Beginning of buffer is position (point-min), end is (point-max).
290 The return value is POSITION. */)
291 (register Lisp_Object position)
293 EMACS_INT pos;
295 if (MARKERP (position)
296 && current_buffer == XMARKER (position)->buffer)
298 pos = marker_position (position);
299 if (pos < BEGV)
300 SET_PT_BOTH (BEGV, BEGV_BYTE);
301 else if (pos > ZV)
302 SET_PT_BOTH (ZV, ZV_BYTE);
303 else
304 SET_PT_BOTH (pos, marker_byte_position (position));
306 return position;
309 CHECK_NUMBER_COERCE_MARKER (position);
311 pos = clip_to_bounds (BEGV, XINT (position), ZV);
312 SET_PT (pos);
313 return position;
317 /* Return the start or end position of the region.
318 BEGINNINGP non-zero means return the start.
319 If there is no region active, signal an error. */
321 static Lisp_Object
322 region_limit (int beginningp)
324 Lisp_Object m;
326 if (!NILP (Vtransient_mark_mode)
327 && NILP (Vmark_even_if_inactive)
328 && NILP (current_buffer->mark_active))
329 xsignal0 (Qmark_inactive);
331 m = Fmarker_position (current_buffer->mark);
332 if (NILP (m))
333 error ("The mark is not set now, so there is no region");
335 if ((PT < XFASTINT (m)) == (beginningp != 0))
336 m = make_number (PT);
337 return m;
340 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
341 doc: /* Return the integer value of point or mark, whichever is smaller. */)
342 (void)
344 return region_limit (1);
347 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
348 doc: /* Return the integer value of point or mark, whichever is larger. */)
349 (void)
351 return region_limit (0);
354 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
355 doc: /* Return this buffer's mark, as a marker object.
356 Watch out! Moving this marker changes the mark position.
357 If you set the marker not to point anywhere, the buffer will have no mark. */)
358 (void)
360 return current_buffer->mark;
364 /* Find all the overlays in the current buffer that touch position POS.
365 Return the number found, and store them in a vector in VEC
366 of length LEN. */
368 static int
369 overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
371 Lisp_Object overlay, start, end;
372 struct Lisp_Overlay *tail;
373 EMACS_INT startpos, endpos;
374 int idx = 0;
376 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
378 XSETMISC (overlay, tail);
380 end = OVERLAY_END (overlay);
381 endpos = OVERLAY_POSITION (end);
382 if (endpos < pos)
383 break;
384 start = OVERLAY_START (overlay);
385 startpos = OVERLAY_POSITION (start);
386 if (startpos <= pos)
388 if (idx < len)
389 vec[idx] = overlay;
390 /* Keep counting overlays even if we can't return them all. */
391 idx++;
395 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
397 XSETMISC (overlay, tail);
399 start = OVERLAY_START (overlay);
400 startpos = OVERLAY_POSITION (start);
401 if (pos < startpos)
402 break;
403 end = OVERLAY_END (overlay);
404 endpos = OVERLAY_POSITION (end);
405 if (pos <= endpos)
407 if (idx < len)
408 vec[idx] = overlay;
409 idx++;
413 return idx;
416 /* Return the value of property PROP, in OBJECT at POSITION.
417 It's the value of PROP that a char inserted at POSITION would get.
418 OBJECT is optional and defaults to the current buffer.
419 If OBJECT is a buffer, then overlay properties are considered as well as
420 text properties.
421 If OBJECT is a window, then that window's buffer is used, but
422 window-specific overlays are considered only if they are associated
423 with OBJECT. */
424 Lisp_Object
425 get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
427 CHECK_NUMBER_COERCE_MARKER (position);
429 if (NILP (object))
430 XSETBUFFER (object, current_buffer);
431 else if (WINDOWP (object))
432 object = XWINDOW (object)->buffer;
434 if (!BUFFERP (object))
435 /* pos-property only makes sense in buffers right now, since strings
436 have no overlays and no notion of insertion for which stickiness
437 could be obeyed. */
438 return Fget_text_property (position, prop, object);
439 else
441 EMACS_INT posn = XINT (position);
442 int noverlays;
443 Lisp_Object *overlay_vec, tem;
444 struct buffer *obuf = current_buffer;
446 set_buffer_temp (XBUFFER (object));
448 /* First try with room for 40 overlays. */
449 noverlays = 40;
450 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
451 noverlays = overlays_around (posn, overlay_vec, noverlays);
453 /* If there are more than 40,
454 make enough space for all, and try again. */
455 if (noverlays > 40)
457 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
458 noverlays = overlays_around (posn, overlay_vec, noverlays);
460 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
462 set_buffer_temp (obuf);
464 /* Now check the overlays in order of decreasing priority. */
465 while (--noverlays >= 0)
467 Lisp_Object ol = overlay_vec[noverlays];
468 tem = Foverlay_get (ol, prop);
469 if (!NILP (tem))
471 /* Check the overlay is indeed active at point. */
472 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
473 if ((OVERLAY_POSITION (start) == posn
474 && XMARKER (start)->insertion_type == 1)
475 || (OVERLAY_POSITION (finish) == posn
476 && XMARKER (finish)->insertion_type == 0))
477 ; /* The overlay will not cover a char inserted at point. */
478 else
480 return tem;
485 { /* Now check the text properties. */
486 int stickiness = text_property_stickiness (prop, position, object);
487 if (stickiness > 0)
488 return Fget_text_property (position, prop, object);
489 else if (stickiness < 0
490 && XINT (position) > BUF_BEGV (XBUFFER (object)))
491 return Fget_text_property (make_number (XINT (position) - 1),
492 prop, object);
493 else
494 return Qnil;
499 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
500 the value of point is used instead. If BEG or END is null,
501 means don't store the beginning or end of the field.
503 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
504 results; they do not effect boundary behavior.
506 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
507 position of a field, then the beginning of the previous field is
508 returned instead of the beginning of POS's field (since the end of a
509 field is actually also the beginning of the next input field, this
510 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
511 true case, if two fields are separated by a field with the special
512 value `boundary', and POS lies within it, then the two separated
513 fields are considered to be adjacent, and POS between them, when
514 finding the beginning and ending of the "merged" field.
516 Either BEG or END may be 0, in which case the corresponding value
517 is not stored. */
519 static void
520 find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
521 Lisp_Object beg_limit,
522 EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
524 /* Fields right before and after the point. */
525 Lisp_Object before_field, after_field;
526 /* 1 if POS counts as the start of a field. */
527 int at_field_start = 0;
528 /* 1 if POS counts as the end of a field. */
529 int at_field_end = 0;
531 if (NILP (pos))
532 XSETFASTINT (pos, PT);
533 else
534 CHECK_NUMBER_COERCE_MARKER (pos);
536 after_field
537 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
538 before_field
539 = (XFASTINT (pos) > BEGV
540 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
541 Qfield, Qnil, NULL)
542 /* Using nil here would be a more obvious choice, but it would
543 fail when the buffer starts with a non-sticky field. */
544 : after_field);
546 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
547 and POS is at beginning of a field, which can also be interpreted
548 as the end of the previous field. Note that the case where if
549 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
550 more natural one; then we avoid treating the beginning of a field
551 specially. */
552 if (NILP (merge_at_boundary))
554 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
555 if (!EQ (field, after_field))
556 at_field_end = 1;
557 if (!EQ (field, before_field))
558 at_field_start = 1;
559 if (NILP (field) && at_field_start && at_field_end)
560 /* If an inserted char would have a nil field while the surrounding
561 text is non-nil, we're probably not looking at a
562 zero-length field, but instead at a non-nil field that's
563 not intended for editing (such as comint's prompts). */
564 at_field_end = at_field_start = 0;
567 /* Note about special `boundary' fields:
569 Consider the case where the point (`.') is between the fields `x' and `y':
571 xxxx.yyyy
573 In this situation, if merge_at_boundary is true, we consider the
574 `x' and `y' fields as forming one big merged field, and so the end
575 of the field is the end of `y'.
577 However, if `x' and `y' are separated by a special `boundary' field
578 (a field with a `field' char-property of 'boundary), then we ignore
579 this special field when merging adjacent fields. Here's the same
580 situation, but with a `boundary' field between the `x' and `y' fields:
582 xxx.BBBByyyy
584 Here, if point is at the end of `x', the beginning of `y', or
585 anywhere in-between (within the `boundary' field), we merge all
586 three fields and consider the beginning as being the beginning of
587 the `x' field, and the end as being the end of the `y' field. */
589 if (beg)
591 if (at_field_start)
592 /* POS is at the edge of a field, and we should consider it as
593 the beginning of the following field. */
594 *beg = XFASTINT (pos);
595 else
596 /* Find the previous field boundary. */
598 Lisp_Object p = pos;
599 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
600 /* Skip a `boundary' field. */
601 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
602 beg_limit);
604 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
605 beg_limit);
606 *beg = NILP (p) ? BEGV : XFASTINT (p);
610 if (end)
612 if (at_field_end)
613 /* POS is at the edge of a field, and we should consider it as
614 the end of the previous field. */
615 *end = XFASTINT (pos);
616 else
617 /* Find the next field boundary. */
619 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
620 /* Skip a `boundary' field. */
621 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
622 end_limit);
624 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
625 end_limit);
626 *end = NILP (pos) ? ZV : XFASTINT (pos);
632 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
633 doc: /* Delete the field surrounding POS.
634 A field is a region of text with the same `field' property.
635 If POS is nil, the value of point is used for POS. */)
636 (Lisp_Object pos)
638 EMACS_INT beg, end;
639 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
640 if (beg != end)
641 del_range (beg, end);
642 return Qnil;
645 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
646 doc: /* Return the contents of the field surrounding POS as a string.
647 A field is a region of text with the same `field' property.
648 If POS is nil, the value of point is used for POS. */)
649 (Lisp_Object pos)
651 EMACS_INT beg, end;
652 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
653 return make_buffer_string (beg, end, 1);
656 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
657 doc: /* Return the contents of the field around POS, without text properties.
658 A field is a region of text with the same `field' property.
659 If POS is nil, the value of point is used for POS. */)
660 (Lisp_Object pos)
662 EMACS_INT beg, end;
663 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
664 return make_buffer_string (beg, end, 0);
667 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
668 doc: /* Return the beginning of the field surrounding POS.
669 A field is a region of text with the same `field' property.
670 If POS is nil, the value of point is used for POS.
671 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
672 field, then the beginning of the *previous* field is returned.
673 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
674 is before LIMIT, then LIMIT will be returned instead. */)
675 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
677 EMACS_INT beg;
678 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
679 return make_number (beg);
682 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
683 doc: /* Return the end of the field surrounding POS.
684 A field is a region of text with the same `field' property.
685 If POS is nil, the value of point is used for POS.
686 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
687 then the end of the *following* field is returned.
688 If LIMIT is non-nil, it is a buffer position; if the end of the field
689 is after LIMIT, then LIMIT will be returned instead. */)
690 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
692 EMACS_INT end;
693 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
694 return make_number (end);
697 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
698 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
700 A field is a region of text with the same `field' property.
701 If NEW-POS is nil, then the current point is used instead, and set to the
702 constrained position if that is different.
704 If OLD-POS is at the boundary of two fields, then the allowable
705 positions for NEW-POS depends on the value of the optional argument
706 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
707 constrained to the field that has the same `field' char-property
708 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
709 is non-nil, NEW-POS is constrained to the union of the two adjacent
710 fields. Additionally, if two fields are separated by another field with
711 the special value `boundary', then any point within this special field is
712 also considered to be `on the boundary'.
714 If the optional argument ONLY-IN-LINE is non-nil and constraining
715 NEW-POS would move it to a different line, NEW-POS is returned
716 unconstrained. This useful for commands that move by line, like
717 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
718 only in the case where they can still move to the right line.
720 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
721 a non-nil property of that name, then any field boundaries are ignored.
723 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
724 (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
726 /* If non-zero, then the original point, before re-positioning. */
727 EMACS_INT orig_point = 0;
728 int fwd;
729 Lisp_Object prev_old, prev_new;
731 if (NILP (new_pos))
732 /* Use the current point, and afterwards, set it. */
734 orig_point = PT;
735 XSETFASTINT (new_pos, PT);
738 CHECK_NUMBER_COERCE_MARKER (new_pos);
739 CHECK_NUMBER_COERCE_MARKER (old_pos);
741 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
743 prev_old = make_number (XFASTINT (old_pos) - 1);
744 prev_new = make_number (XFASTINT (new_pos) - 1);
746 if (NILP (Vinhibit_field_text_motion)
747 && !EQ (new_pos, old_pos)
748 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
749 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
750 /* To recognize field boundaries, we must also look at the
751 previous positions; we could use `get_pos_property'
752 instead, but in itself that would fail inside non-sticky
753 fields (like comint prompts). */
754 || (XFASTINT (new_pos) > BEGV
755 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
756 || (XFASTINT (old_pos) > BEGV
757 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
758 && (NILP (inhibit_capture_property)
759 /* Field boundaries are again a problem; but now we must
760 decide the case exactly, so we need to call
761 `get_pos_property' as well. */
762 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
763 && (XFASTINT (old_pos) <= BEGV
764 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
765 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
766 /* It is possible that NEW_POS is not within the same field as
767 OLD_POS; try to move NEW_POS so that it is. */
769 int shortage;
770 Lisp_Object field_bound;
772 if (fwd)
773 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
774 else
775 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
777 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
778 other side of NEW_POS, which would mean that NEW_POS is
779 already acceptable, and it's not necessary to constrain it
780 to FIELD_BOUND. */
781 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
782 /* NEW_POS should be constrained, but only if either
783 ONLY_IN_LINE is nil (in which case any constraint is OK),
784 or NEW_POS and FIELD_BOUND are on the same line (in which
785 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
786 && (NILP (only_in_line)
787 /* This is the ONLY_IN_LINE case, check that NEW_POS and
788 FIELD_BOUND are on the same line by seeing whether
789 there's an intervening newline or not. */
790 || (scan_buffer ('\n',
791 XFASTINT (new_pos), XFASTINT (field_bound),
792 fwd ? -1 : 1, &shortage, 1),
793 shortage != 0)))
794 /* Constrain NEW_POS to FIELD_BOUND. */
795 new_pos = field_bound;
797 if (orig_point && XFASTINT (new_pos) != orig_point)
798 /* The NEW_POS argument was originally nil, so automatically set PT. */
799 SET_PT (XFASTINT (new_pos));
802 return new_pos;
806 DEFUN ("line-beginning-position",
807 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
808 doc: /* Return the character position of the first character on the current line.
809 With argument N not nil or 1, move forward N - 1 lines first.
810 If scan reaches end of buffer, return that position.
812 The returned position is of the first character in the logical order,
813 i.e. the one that has the smallest character position.
815 This function constrains the returned position to the current field
816 unless that would be on a different line than the original,
817 unconstrained result. If N is nil or 1, and a front-sticky field
818 starts at point, the scan stops as soon as it starts. To ignore field
819 boundaries bind `inhibit-field-text-motion' to t.
821 This function does not move point. */)
822 (Lisp_Object n)
824 EMACS_INT orig, orig_byte, end;
825 int count = SPECPDL_INDEX ();
826 specbind (Qinhibit_point_motion_hooks, Qt);
828 if (NILP (n))
829 XSETFASTINT (n, 1);
830 else
831 CHECK_NUMBER (n);
833 orig = PT;
834 orig_byte = PT_BYTE;
835 Fforward_line (make_number (XINT (n) - 1));
836 end = PT;
838 SET_PT_BOTH (orig, orig_byte);
840 unbind_to (count, Qnil);
842 /* Return END constrained to the current input field. */
843 return Fconstrain_to_field (make_number (end), make_number (orig),
844 XINT (n) != 1 ? Qt : Qnil,
845 Qt, Qnil);
848 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
849 doc: /* Return the character position of the last character on the current line.
850 With argument N not nil or 1, move forward N - 1 lines first.
851 If scan reaches end of buffer, return that position.
853 The returned position is of the last character in the logical order,
854 i.e. the character whose buffer position is the largest one.
856 This function constrains the returned position to the current field
857 unless that would be on a different line than the original,
858 unconstrained result. If N is nil or 1, and a rear-sticky field ends
859 at point, the scan stops as soon as it starts. To ignore field
860 boundaries bind `inhibit-field-text-motion' to t.
862 This function does not move point. */)
863 (Lisp_Object n)
865 EMACS_INT end_pos;
866 EMACS_INT orig = PT;
868 if (NILP (n))
869 XSETFASTINT (n, 1);
870 else
871 CHECK_NUMBER (n);
873 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
875 /* Return END_POS constrained to the current input field. */
876 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
877 Qnil, Qt, Qnil);
881 Lisp_Object
882 save_excursion_save (void)
884 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
885 == current_buffer);
887 return Fcons (Fpoint_marker (),
888 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
889 Fcons (visible ? Qt : Qnil,
890 Fcons (current_buffer->mark_active,
891 selected_window))));
894 Lisp_Object
895 save_excursion_restore (Lisp_Object info)
897 Lisp_Object tem, tem1, omark, nmark;
898 struct gcpro gcpro1, gcpro2, gcpro3;
899 int visible_p;
901 tem = Fmarker_buffer (XCAR (info));
902 /* If buffer being returned to is now deleted, avoid error */
903 /* Otherwise could get error here while unwinding to top level
904 and crash */
905 /* In that case, Fmarker_buffer returns nil now. */
906 if (NILP (tem))
907 return Qnil;
909 omark = nmark = Qnil;
910 GCPRO3 (info, omark, nmark);
912 Fset_buffer (tem);
914 /* Point marker. */
915 tem = XCAR (info);
916 Fgoto_char (tem);
917 unchain_marker (XMARKER (tem));
919 /* Mark marker. */
920 info = XCDR (info);
921 tem = XCAR (info);
922 omark = Fmarker_position (current_buffer->mark);
923 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
924 nmark = Fmarker_position (tem);
925 unchain_marker (XMARKER (tem));
927 /* visible */
928 info = XCDR (info);
929 visible_p = !NILP (XCAR (info));
931 #if 0 /* We used to make the current buffer visible in the selected window
932 if that was true previously. That avoids some anomalies.
933 But it creates others, and it wasn't documented, and it is simpler
934 and cleaner never to alter the window/buffer connections. */
935 tem1 = Fcar (tem);
936 if (!NILP (tem1)
937 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
938 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
939 #endif /* 0 */
941 /* Mark active */
942 info = XCDR (info);
943 tem = XCAR (info);
944 tem1 = current_buffer->mark_active;
945 current_buffer->mark_active = tem;
947 if (!NILP (Vrun_hooks))
949 /* If mark is active now, and either was not active
950 or was at a different place, run the activate hook. */
951 if (! NILP (current_buffer->mark_active))
953 if (! EQ (omark, nmark))
954 call1 (Vrun_hooks, intern ("activate-mark-hook"));
956 /* If mark has ceased to be active, run deactivate hook. */
957 else if (! NILP (tem1))
958 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
961 /* If buffer was visible in a window, and a different window was
962 selected, and the old selected window is still showing this
963 buffer, restore point in that window. */
964 tem = XCDR (info);
965 if (visible_p
966 && !EQ (tem, selected_window)
967 && (tem1 = XWINDOW (tem)->buffer,
968 (/* Window is live... */
969 BUFFERP (tem1)
970 /* ...and it shows the current buffer. */
971 && XBUFFER (tem1) == current_buffer)))
972 Fset_window_point (tem, make_number (PT));
974 UNGCPRO;
975 return Qnil;
978 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
979 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
980 Executes BODY just like `progn'.
981 The values of point, mark and the current buffer are restored
982 even in case of abnormal exit (throw or error).
983 The state of activation of the mark is also restored.
985 This construct does not save `deactivate-mark', and therefore
986 functions that change the buffer will still cause deactivation
987 of the mark at the end of the command. To prevent that, bind
988 `deactivate-mark' with `let'.
990 If you only want to save the current buffer but not point nor mark,
991 then just use `save-current-buffer', or even `with-current-buffer'.
993 usage: (save-excursion &rest BODY) */)
994 (Lisp_Object args)
996 register Lisp_Object val;
997 int count = SPECPDL_INDEX ();
999 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1001 val = Fprogn (args);
1002 return unbind_to (count, val);
1005 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1006 doc: /* Save the current buffer; execute BODY; restore the current buffer.
1007 Executes BODY just like `progn'.
1008 usage: (save-current-buffer &rest BODY) */)
1009 (Lisp_Object args)
1011 Lisp_Object val;
1012 int count = SPECPDL_INDEX ();
1014 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1016 val = Fprogn (args);
1017 return unbind_to (count, val);
1020 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1021 doc: /* Return the number of characters in the current buffer.
1022 If BUFFER, return the number of characters in that buffer instead. */)
1023 (Lisp_Object buffer)
1025 if (NILP (buffer))
1026 return make_number (Z - BEG);
1027 else
1029 CHECK_BUFFER (buffer);
1030 return make_number (BUF_Z (XBUFFER (buffer))
1031 - BUF_BEG (XBUFFER (buffer)));
1035 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1036 doc: /* Return the minimum permissible value of point in the current buffer.
1037 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1038 (void)
1040 Lisp_Object temp;
1041 XSETFASTINT (temp, BEGV);
1042 return temp;
1045 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1046 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1047 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1048 (void)
1050 return buildmark (BEGV, BEGV_BYTE);
1053 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1054 doc: /* Return the maximum permissible value of point in the current buffer.
1055 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1056 is in effect, in which case it is less. */)
1057 (void)
1059 Lisp_Object temp;
1060 XSETFASTINT (temp, ZV);
1061 return temp;
1064 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1065 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1066 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1067 is in effect, in which case it is less. */)
1068 (void)
1070 return buildmark (ZV, ZV_BYTE);
1073 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1074 doc: /* Return the position of the gap, in the current buffer.
1075 See also `gap-size'. */)
1076 (void)
1078 Lisp_Object temp;
1079 XSETFASTINT (temp, GPT);
1080 return temp;
1083 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1084 doc: /* Return the size of the current buffer's gap.
1085 See also `gap-position'. */)
1086 (void)
1088 Lisp_Object temp;
1089 XSETFASTINT (temp, GAP_SIZE);
1090 return temp;
1093 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1094 doc: /* Return the byte position for character position POSITION.
1095 If POSITION is out of range, the value is nil. */)
1096 (Lisp_Object position)
1098 CHECK_NUMBER_COERCE_MARKER (position);
1099 if (XINT (position) < BEG || XINT (position) > Z)
1100 return Qnil;
1101 return make_number (CHAR_TO_BYTE (XINT (position)));
1104 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1105 doc: /* Return the character position for byte position BYTEPOS.
1106 If BYTEPOS is out of range, the value is nil. */)
1107 (Lisp_Object bytepos)
1109 CHECK_NUMBER (bytepos);
1110 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1111 return Qnil;
1112 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1115 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1116 doc: /* Return the character following point, as a number.
1117 At the end of the buffer or accessible region, return 0. */)
1118 (void)
1120 Lisp_Object temp;
1121 if (PT >= ZV)
1122 XSETFASTINT (temp, 0);
1123 else
1124 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1125 return temp;
1128 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1129 doc: /* Return the character preceding point, as a number.
1130 At the beginning of the buffer or accessible region, return 0. */)
1131 (void)
1133 Lisp_Object temp;
1134 if (PT <= BEGV)
1135 XSETFASTINT (temp, 0);
1136 else if (!NILP (current_buffer->enable_multibyte_characters))
1138 EMACS_INT pos = PT_BYTE;
1139 DEC_POS (pos);
1140 XSETFASTINT (temp, FETCH_CHAR (pos));
1142 else
1143 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1144 return temp;
1147 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1148 doc: /* Return t if point is at the beginning of the buffer.
1149 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1150 (void)
1152 if (PT == BEGV)
1153 return Qt;
1154 return Qnil;
1157 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1158 doc: /* Return t if point is at the end of the buffer.
1159 If the buffer is narrowed, this means the end of the narrowed part. */)
1160 (void)
1162 if (PT == ZV)
1163 return Qt;
1164 return Qnil;
1167 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1168 doc: /* Return t if point is at the beginning of a line. */)
1169 (void)
1171 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1172 return Qt;
1173 return Qnil;
1176 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1177 doc: /* Return t if point is at the end of a line.
1178 `End of a line' includes point being at the end of the buffer. */)
1179 (void)
1181 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1182 return Qt;
1183 return Qnil;
1186 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1187 doc: /* Return character in current buffer at position POS.
1188 POS is an integer or a marker and defaults to point.
1189 If POS is out of range, the value is nil. */)
1190 (Lisp_Object pos)
1192 register EMACS_INT pos_byte;
1194 if (NILP (pos))
1196 pos_byte = PT_BYTE;
1197 XSETFASTINT (pos, PT);
1200 if (MARKERP (pos))
1202 pos_byte = marker_byte_position (pos);
1203 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1204 return Qnil;
1206 else
1208 CHECK_NUMBER_COERCE_MARKER (pos);
1209 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1210 return Qnil;
1212 pos_byte = CHAR_TO_BYTE (XINT (pos));
1215 return make_number (FETCH_CHAR (pos_byte));
1218 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1219 doc: /* Return character in current buffer preceding position POS.
1220 POS is an integer or a marker and defaults to point.
1221 If POS is out of range, the value is nil. */)
1222 (Lisp_Object pos)
1224 register Lisp_Object val;
1225 register EMACS_INT pos_byte;
1227 if (NILP (pos))
1229 pos_byte = PT_BYTE;
1230 XSETFASTINT (pos, PT);
1233 if (MARKERP (pos))
1235 pos_byte = marker_byte_position (pos);
1237 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1238 return Qnil;
1240 else
1242 CHECK_NUMBER_COERCE_MARKER (pos);
1244 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1245 return Qnil;
1247 pos_byte = CHAR_TO_BYTE (XINT (pos));
1250 if (!NILP (current_buffer->enable_multibyte_characters))
1252 DEC_POS (pos_byte);
1253 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1255 else
1257 pos_byte--;
1258 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1260 return val;
1263 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1264 doc: /* Return the name under which the user logged in, as a string.
1265 This is based on the effective uid, not the real uid.
1266 Also, if the environment variables LOGNAME or USER are set,
1267 that determines the value of this function.
1269 If optional argument UID is an integer or a float, return the login name
1270 of the user with that uid, or nil if there is no such user. */)
1271 (Lisp_Object uid)
1273 struct passwd *pw;
1274 uid_t id;
1276 /* Set up the user name info if we didn't do it before.
1277 (That can happen if Emacs is dumpable
1278 but you decide to run `temacs -l loadup' and not dump. */
1279 if (INTEGERP (Vuser_login_name))
1280 init_editfns ();
1282 if (NILP (uid))
1283 return Vuser_login_name;
1285 id = (uid_t)XFLOATINT (uid);
1286 BLOCK_INPUT;
1287 pw = (struct passwd *) getpwuid (id);
1288 UNBLOCK_INPUT;
1289 return (pw ? build_string (pw->pw_name) : Qnil);
1292 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1293 0, 0, 0,
1294 doc: /* Return the name of the user's real uid, as a string.
1295 This ignores the environment variables LOGNAME and USER, so it differs from
1296 `user-login-name' when running under `su'. */)
1297 (void)
1299 /* Set up the user name info if we didn't do it before.
1300 (That can happen if Emacs is dumpable
1301 but you decide to run `temacs -l loadup' and not dump. */
1302 if (INTEGERP (Vuser_login_name))
1303 init_editfns ();
1304 return Vuser_real_login_name;
1307 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1308 doc: /* Return the effective uid of Emacs.
1309 Value is an integer or a float, depending on the value. */)
1310 (void)
1312 /* Assignment to EMACS_INT stops GCC whining about limited range of
1313 data type. */
1314 EMACS_INT euid = geteuid ();
1316 /* Make sure we don't produce a negative UID due to signed integer
1317 overflow. */
1318 if (euid < 0)
1319 return make_float ((double)geteuid ());
1320 return make_fixnum_or_float (euid);
1323 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1324 doc: /* Return the real uid of Emacs.
1325 Value is an integer or a float, depending on the value. */)
1326 (void)
1328 /* Assignment to EMACS_INT stops GCC whining about limited range of
1329 data type. */
1330 EMACS_INT uid = getuid ();
1332 /* Make sure we don't produce a negative UID due to signed integer
1333 overflow. */
1334 if (uid < 0)
1335 return make_float ((double)getuid ());
1336 return make_fixnum_or_float (uid);
1339 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1340 doc: /* Return the full name of the user logged in, as a string.
1341 If the full name corresponding to Emacs's userid is not known,
1342 return "unknown".
1344 If optional argument UID is an integer or float, return the full name
1345 of the user with that uid, or nil if there is no such user.
1346 If UID is a string, return the full name of the user with that login
1347 name, or nil if there is no such user. */)
1348 (Lisp_Object uid)
1350 struct passwd *pw;
1351 register unsigned char *p, *q;
1352 Lisp_Object full;
1354 if (NILP (uid))
1355 return Vuser_full_name;
1356 else if (NUMBERP (uid))
1358 BLOCK_INPUT;
1359 pw = (struct passwd *) getpwuid ((uid_t) XFLOATINT (uid));
1360 UNBLOCK_INPUT;
1362 else if (STRINGP (uid))
1364 BLOCK_INPUT;
1365 pw = (struct passwd *) getpwnam (SDATA (uid));
1366 UNBLOCK_INPUT;
1368 else
1369 error ("Invalid UID specification");
1371 if (!pw)
1372 return Qnil;
1374 p = (unsigned char *) USER_FULL_NAME;
1375 /* Chop off everything after the first comma. */
1376 q = (unsigned char *) strchr (p, ',');
1377 full = make_string (p, q ? q - p : strlen (p));
1379 #ifdef AMPERSAND_FULL_NAME
1380 p = SDATA (full);
1381 q = (unsigned char *) strchr (p, '&');
1382 /* Substitute the login name for the &, upcasing the first character. */
1383 if (q)
1385 register unsigned char *r;
1386 Lisp_Object login;
1388 login = Fuser_login_name (make_number (pw->pw_uid));
1389 r = (unsigned char *) alloca (strlen (p) + SCHARS (login) + 1);
1390 memcpy (r, p, q - p);
1391 r[q - p] = 0;
1392 strcat (r, SDATA (login));
1393 r[q - p] = UPCASE (r[q - p]);
1394 strcat (r, q + 1);
1395 full = build_string (r);
1397 #endif /* AMPERSAND_FULL_NAME */
1399 return full;
1402 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1403 doc: /* Return the host name of the machine you are running on, as a string. */)
1404 (void)
1406 return Vsystem_name;
1409 /* For the benefit of callers who don't want to include lisp.h */
1411 const char *
1412 get_system_name (void)
1414 if (STRINGP (Vsystem_name))
1415 return (const char *) SDATA (Vsystem_name);
1416 else
1417 return "";
1420 const char *
1421 get_operating_system_release (void)
1423 if (STRINGP (Voperating_system_release))
1424 return (char *) SDATA (Voperating_system_release);
1425 else
1426 return "";
1429 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1430 doc: /* Return the process ID of Emacs, as an integer. */)
1431 (void)
1433 return make_number (getpid ());
1436 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1437 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1438 The time is returned as a list of three integers. The first has the
1439 most significant 16 bits of the seconds, while the second has the
1440 least significant 16 bits. The third integer gives the microsecond
1441 count.
1443 The microsecond count is zero on systems that do not provide
1444 resolution finer than a second. */)
1445 (void)
1447 EMACS_TIME t;
1449 EMACS_GET_TIME (t);
1450 return list3 (make_number ((EMACS_SECS (t) >> 16) & 0xffff),
1451 make_number ((EMACS_SECS (t) >> 0) & 0xffff),
1452 make_number (EMACS_USECS (t)));
1455 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1456 0, 0, 0,
1457 doc: /* Return the current run time used by Emacs.
1458 The time is returned as a list of three integers. The first has the
1459 most significant 16 bits of the seconds, while the second has the
1460 least significant 16 bits. The third integer gives the microsecond
1461 count.
1463 On systems that can't determine the run time, `get-internal-run-time'
1464 does the same thing as `current-time'. The microsecond count is zero
1465 on systems that do not provide resolution finer than a second. */)
1466 (void)
1468 #ifdef HAVE_GETRUSAGE
1469 struct rusage usage;
1470 int secs, usecs;
1472 if (getrusage (RUSAGE_SELF, &usage) < 0)
1473 /* This shouldn't happen. What action is appropriate? */
1474 xsignal0 (Qerror);
1476 /* Sum up user time and system time. */
1477 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1478 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1479 if (usecs >= 1000000)
1481 usecs -= 1000000;
1482 secs++;
1485 return list3 (make_number ((secs >> 16) & 0xffff),
1486 make_number ((secs >> 0) & 0xffff),
1487 make_number (usecs));
1488 #else /* ! HAVE_GETRUSAGE */
1489 #ifdef WINDOWSNT
1490 return w32_get_internal_run_time ();
1491 #else /* ! WINDOWSNT */
1492 return Fcurrent_time ();
1493 #endif /* WINDOWSNT */
1494 #endif /* HAVE_GETRUSAGE */
1499 lisp_time_argument (Lisp_Object specified_time, time_t *result, int *usec)
1501 if (NILP (specified_time))
1503 if (usec)
1505 EMACS_TIME t;
1507 EMACS_GET_TIME (t);
1508 *usec = EMACS_USECS (t);
1509 *result = EMACS_SECS (t);
1510 return 1;
1512 else
1513 return time (result) != -1;
1515 else
1517 Lisp_Object high, low;
1518 high = Fcar (specified_time);
1519 CHECK_NUMBER (high);
1520 low = Fcdr (specified_time);
1521 if (CONSP (low))
1523 if (usec)
1525 Lisp_Object usec_l = Fcdr (low);
1526 if (CONSP (usec_l))
1527 usec_l = Fcar (usec_l);
1528 if (NILP (usec_l))
1529 *usec = 0;
1530 else
1532 CHECK_NUMBER (usec_l);
1533 *usec = XINT (usec_l);
1536 low = Fcar (low);
1538 else if (usec)
1539 *usec = 0;
1540 CHECK_NUMBER (low);
1541 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1542 return *result >> 16 == XINT (high);
1546 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1547 doc: /* Return the current time, as a float number of seconds since the epoch.
1548 If SPECIFIED-TIME is given, it is the time to convert to float
1549 instead of the current time. The argument should have the form
1550 (HIGH LOW) or (HIGH LOW USEC). Thus, you can use times obtained from
1551 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1552 have the form (HIGH . LOW), but this is considered obsolete.
1554 WARNING: Since the result is floating point, it may not be exact.
1555 If precise time stamps are required, use either `current-time',
1556 or (if you need time as a string) `format-time-string'. */)
1557 (Lisp_Object specified_time)
1559 time_t sec;
1560 int usec;
1562 if (! lisp_time_argument (specified_time, &sec, &usec))
1563 error ("Invalid time specification");
1565 return make_float ((sec * 1e6 + usec) / 1e6);
1568 /* Write information into buffer S of size MAXSIZE, according to the
1569 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1570 Default to Universal Time if UT is nonzero, local time otherwise.
1571 Return the number of bytes written, not including the terminating
1572 '\0'. If S is NULL, nothing will be written anywhere; so to
1573 determine how many bytes would be written, use NULL for S and
1574 ((size_t) -1) for MAXSIZE.
1576 This function behaves like emacs_strftimeu, except it allows null
1577 bytes in FORMAT. */
1578 static size_t
1579 emacs_memftimeu (char *s, size_t maxsize, const char *format, size_t format_len, const struct tm *tp, int ut)
1581 size_t total = 0;
1583 /* Loop through all the null-terminated strings in the format
1584 argument. Normally there's just one null-terminated string, but
1585 there can be arbitrarily many, concatenated together, if the
1586 format contains '\0' bytes. emacs_strftimeu stops at the first
1587 '\0' byte so we must invoke it separately for each such string. */
1588 for (;;)
1590 size_t len;
1591 size_t result;
1593 if (s)
1594 s[0] = '\1';
1596 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1598 if (s)
1600 if (result == 0 && s[0] != '\0')
1601 return 0;
1602 s += result + 1;
1605 maxsize -= result + 1;
1606 total += result;
1607 len = strlen (format);
1608 if (len == format_len)
1609 return total;
1610 total++;
1611 format += len + 1;
1612 format_len -= len + 1;
1616 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1617 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1618 TIME is specified as (HIGH LOW . IGNORED), as returned by
1619 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1620 is also still accepted.
1621 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1622 as Universal Time; nil means describe TIME in the local time zone.
1623 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1624 by text that describes the specified date and time in TIME:
1626 %Y is the year, %y within the century, %C the century.
1627 %G is the year corresponding to the ISO week, %g within the century.
1628 %m is the numeric month.
1629 %b and %h are the locale's abbreviated month name, %B the full name.
1630 %d is the day of the month, zero-padded, %e is blank-padded.
1631 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1632 %a is the locale's abbreviated name of the day of week, %A the full name.
1633 %U is the week number starting on Sunday, %W starting on Monday,
1634 %V according to ISO 8601.
1635 %j is the day of the year.
1637 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1638 only blank-padded, %l is like %I blank-padded.
1639 %p is the locale's equivalent of either AM or PM.
1640 %M is the minute.
1641 %S is the second.
1642 %Z is the time zone name, %z is the numeric form.
1643 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1645 %c is the locale's date and time format.
1646 %x is the locale's "preferred" date format.
1647 %D is like "%m/%d/%y".
1649 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1650 %X is the locale's "preferred" time format.
1652 Finally, %n is a newline, %t is a tab, %% is a literal %.
1654 Certain flags and modifiers are available with some format controls.
1655 The flags are `_', `-', `^' and `#'. For certain characters X,
1656 %_X is like %X, but padded with blanks; %-X is like %X,
1657 but without padding. %^X is like %X, but with all textual
1658 characters up-cased; %#X is like %X, but with letter-case of
1659 all textual characters reversed.
1660 %NX (where N stands for an integer) is like %X,
1661 but takes up at least N (a number) positions.
1662 The modifiers are `E' and `O'. For certain characters X,
1663 %EX is a locale's alternative version of %X;
1664 %OX is like %X, but uses the locale's number symbols.
1666 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1667 (Lisp_Object format_string, Lisp_Object time, Lisp_Object universal)
1669 time_t value;
1670 int size;
1671 struct tm *tm;
1672 int ut = ! NILP (universal);
1674 CHECK_STRING (format_string);
1676 if (! lisp_time_argument (time, &value, NULL))
1677 error ("Invalid time specification");
1679 format_string = code_convert_string_norecord (format_string,
1680 Vlocale_coding_system, 1);
1682 /* This is probably enough. */
1683 size = SBYTES (format_string) * 6 + 50;
1685 BLOCK_INPUT;
1686 tm = ut ? gmtime (&value) : localtime (&value);
1687 UNBLOCK_INPUT;
1688 if (! tm)
1689 error ("Specified time is not representable");
1691 synchronize_system_time_locale ();
1693 while (1)
1695 char *buf = (char *) alloca (size + 1);
1696 int result;
1698 buf[0] = '\1';
1699 BLOCK_INPUT;
1700 result = emacs_memftimeu (buf, size, SDATA (format_string),
1701 SBYTES (format_string),
1702 tm, ut);
1703 UNBLOCK_INPUT;
1704 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1705 return code_convert_string_norecord (make_unibyte_string (buf, result),
1706 Vlocale_coding_system, 0);
1708 /* If buffer was too small, make it bigger and try again. */
1709 BLOCK_INPUT;
1710 result = emacs_memftimeu (NULL, (size_t) -1,
1711 SDATA (format_string),
1712 SBYTES (format_string),
1713 tm, ut);
1714 UNBLOCK_INPUT;
1715 size = result + 1;
1719 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1720 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1721 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1722 as from `current-time' and `file-attributes', or nil to use the
1723 current time. The obsolete form (HIGH . LOW) is also still accepted.
1724 The list has the following nine members: SEC is an integer between 0
1725 and 60; SEC is 60 for a leap second, which only some operating systems
1726 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1727 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1728 integer between 1 and 12. YEAR is an integer indicating the
1729 four-digit year. DOW is the day of week, an integer between 0 and 6,
1730 where 0 is Sunday. DST is t if daylight saving time is in effect,
1731 otherwise nil. ZONE is an integer indicating the number of seconds
1732 east of Greenwich. (Note that Common Lisp has different meanings for
1733 DOW and ZONE.) */)
1734 (Lisp_Object specified_time)
1736 time_t time_spec;
1737 struct tm save_tm;
1738 struct tm *decoded_time;
1739 Lisp_Object list_args[9];
1741 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1742 error ("Invalid time specification");
1744 BLOCK_INPUT;
1745 decoded_time = localtime (&time_spec);
1746 UNBLOCK_INPUT;
1747 if (! decoded_time)
1748 error ("Specified time is not representable");
1749 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1750 XSETFASTINT (list_args[1], decoded_time->tm_min);
1751 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1752 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1753 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1754 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1755 cast below avoids overflow in int arithmetics. */
1756 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) decoded_time->tm_year);
1757 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1758 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1760 /* Make a copy, in case gmtime modifies the struct. */
1761 save_tm = *decoded_time;
1762 BLOCK_INPUT;
1763 decoded_time = gmtime (&time_spec);
1764 UNBLOCK_INPUT;
1765 if (decoded_time == 0)
1766 list_args[8] = Qnil;
1767 else
1768 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1769 return Flist (9, list_args);
1772 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1773 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1774 This is the reverse operation of `decode-time', which see.
1775 ZONE defaults to the current time zone rule. This can
1776 be a string or t (as from `set-time-zone-rule'), or it can be a list
1777 \(as from `current-time-zone') or an integer (as from `decode-time')
1778 applied without consideration for daylight saving time.
1780 You can pass more than 7 arguments; then the first six arguments
1781 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1782 The intervening arguments are ignored.
1783 This feature lets (apply 'encode-time (decode-time ...)) work.
1785 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1786 for example, a DAY of 0 means the day preceding the given month.
1787 Year numbers less than 100 are treated just like other year numbers.
1788 If you want them to stand for years in this century, you must do that yourself.
1790 Years before 1970 are not guaranteed to work. On some systems,
1791 year values as low as 1901 do work.
1793 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1794 (int nargs, register Lisp_Object *args)
1796 time_t time;
1797 struct tm tm;
1798 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1800 CHECK_NUMBER (args[0]); /* second */
1801 CHECK_NUMBER (args[1]); /* minute */
1802 CHECK_NUMBER (args[2]); /* hour */
1803 CHECK_NUMBER (args[3]); /* day */
1804 CHECK_NUMBER (args[4]); /* month */
1805 CHECK_NUMBER (args[5]); /* year */
1807 tm.tm_sec = XINT (args[0]);
1808 tm.tm_min = XINT (args[1]);
1809 tm.tm_hour = XINT (args[2]);
1810 tm.tm_mday = XINT (args[3]);
1811 tm.tm_mon = XINT (args[4]) - 1;
1812 tm.tm_year = XINT (args[5]) - TM_YEAR_BASE;
1813 tm.tm_isdst = -1;
1815 if (CONSP (zone))
1816 zone = Fcar (zone);
1817 if (NILP (zone))
1819 BLOCK_INPUT;
1820 time = mktime (&tm);
1821 UNBLOCK_INPUT;
1823 else
1825 char tzbuf[100];
1826 const char *tzstring;
1827 char **oldenv = environ, **newenv;
1829 if (EQ (zone, Qt))
1830 tzstring = "UTC0";
1831 else if (STRINGP (zone))
1832 tzstring = (char *) SDATA (zone);
1833 else if (INTEGERP (zone))
1835 int abszone = eabs (XINT (zone));
1836 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1837 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1838 tzstring = tzbuf;
1840 else
1841 error ("Invalid time zone specification");
1843 /* Set TZ before calling mktime; merely adjusting mktime's returned
1844 value doesn't suffice, since that would mishandle leap seconds. */
1845 set_time_zone_rule (tzstring);
1847 BLOCK_INPUT;
1848 time = mktime (&tm);
1849 UNBLOCK_INPUT;
1851 /* Restore TZ to previous value. */
1852 newenv = environ;
1853 environ = oldenv;
1854 xfree (newenv);
1855 #ifdef LOCALTIME_CACHE
1856 tzset ();
1857 #endif
1860 if (time == (time_t) -1)
1861 error ("Specified time is not representable");
1863 return make_time (time);
1866 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1867 doc: /* Return the current local time, as a human-readable string.
1868 Programs can use this function to decode a time,
1869 since the number of columns in each field is fixed
1870 if the year is in the range 1000-9999.
1871 The format is `Sun Sep 16 01:03:52 1973'.
1872 However, see also the functions `decode-time' and `format-time-string'
1873 which provide a much more powerful and general facility.
1875 If SPECIFIED-TIME is given, it is a time to format instead of the
1876 current time. The argument should have the form (HIGH LOW . IGNORED).
1877 Thus, you can use times obtained from `current-time' and from
1878 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1879 but this is considered obsolete. */)
1880 (Lisp_Object specified_time)
1882 time_t value;
1883 struct tm *tm;
1884 register char *tem;
1886 if (! lisp_time_argument (specified_time, &value, NULL))
1887 error ("Invalid time specification");
1889 /* Convert to a string, checking for out-of-range time stamps.
1890 Don't use 'ctime', as that might dump core if VALUE is out of
1891 range. */
1892 BLOCK_INPUT;
1893 tm = localtime (&value);
1894 UNBLOCK_INPUT;
1895 if (! (tm && TM_YEAR_IN_ASCTIME_RANGE (tm->tm_year) && (tem = asctime (tm))))
1896 error ("Specified time is not representable");
1898 /* Remove the trailing newline. */
1899 tem[strlen (tem) - 1] = '\0';
1901 return build_string (tem);
1904 /* Yield A - B, measured in seconds.
1905 This function is copied from the GNU C Library. */
1906 static int
1907 tm_diff (struct tm *a, struct tm *b)
1909 /* Compute intervening leap days correctly even if year is negative.
1910 Take care to avoid int overflow in leap day calculations,
1911 but it's OK to assume that A and B are close to each other. */
1912 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1913 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1914 int a100 = a4 / 25 - (a4 % 25 < 0);
1915 int b100 = b4 / 25 - (b4 % 25 < 0);
1916 int a400 = a100 >> 2;
1917 int b400 = b100 >> 2;
1918 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1919 int years = a->tm_year - b->tm_year;
1920 int days = (365 * years + intervening_leap_days
1921 + (a->tm_yday - b->tm_yday));
1922 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1923 + (a->tm_min - b->tm_min))
1924 + (a->tm_sec - b->tm_sec));
1927 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1928 doc: /* Return the offset and name for the local time zone.
1929 This returns a list of the form (OFFSET NAME).
1930 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1931 A negative value means west of Greenwich.
1932 NAME is a string giving the name of the time zone.
1933 If SPECIFIED-TIME is given, the time zone offset is determined from it
1934 instead of using the current time. The argument should have the form
1935 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1936 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1937 have the form (HIGH . LOW), but this is considered obsolete.
1939 Some operating systems cannot provide all this information to Emacs;
1940 in this case, `current-time-zone' returns a list containing nil for
1941 the data it can't find. */)
1942 (Lisp_Object specified_time)
1944 time_t value;
1945 struct tm *t;
1946 struct tm gmt;
1948 if (!lisp_time_argument (specified_time, &value, NULL))
1949 t = NULL;
1950 else
1952 BLOCK_INPUT;
1953 t = gmtime (&value);
1954 if (t)
1956 gmt = *t;
1957 t = localtime (&value);
1959 UNBLOCK_INPUT;
1962 if (t)
1964 int offset = tm_diff (t, &gmt);
1965 char *s = 0;
1966 char buf[6];
1968 #ifdef HAVE_TM_ZONE
1969 if (t->tm_zone)
1970 s = (char *)t->tm_zone;
1971 #else /* not HAVE_TM_ZONE */
1972 #ifdef HAVE_TZNAME
1973 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1974 s = tzname[t->tm_isdst];
1975 #endif
1976 #endif /* not HAVE_TM_ZONE */
1978 if (!s)
1980 /* No local time zone name is available; use "+-NNNN" instead. */
1981 int am = (offset < 0 ? -offset : offset) / 60;
1982 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1983 s = buf;
1986 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
1988 else
1989 return Fmake_list (make_number (2), Qnil);
1992 /* This holds the value of `environ' produced by the previous
1993 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1994 has never been called. */
1995 static char **environbuf;
1997 /* This holds the startup value of the TZ environment variable so it
1998 can be restored if the user calls set-time-zone-rule with a nil
1999 argument. */
2000 static char *initial_tz;
2002 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
2003 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
2004 If TZ is nil, use implementation-defined default time zone information.
2005 If TZ is t, use Universal Time. */)
2006 (Lisp_Object tz)
2008 const char *tzstring;
2010 /* When called for the first time, save the original TZ. */
2011 if (!environbuf)
2012 initial_tz = (char *) getenv ("TZ");
2014 if (NILP (tz))
2015 tzstring = initial_tz;
2016 else if (EQ (tz, Qt))
2017 tzstring = "UTC0";
2018 else
2020 CHECK_STRING (tz);
2021 tzstring = (char *) SDATA (tz);
2024 set_time_zone_rule (tzstring);
2025 free (environbuf);
2026 environbuf = environ;
2028 return Qnil;
2031 #ifdef LOCALTIME_CACHE
2033 /* These two values are known to load tz files in buggy implementations,
2034 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2035 Their values shouldn't matter in non-buggy implementations.
2036 We don't use string literals for these strings,
2037 since if a string in the environment is in readonly
2038 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2039 See Sun bugs 1113095 and 1114114, ``Timezone routines
2040 improperly modify environment''. */
2042 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2043 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2045 #endif
2047 /* Set the local time zone rule to TZSTRING.
2048 This allocates memory into `environ', which it is the caller's
2049 responsibility to free. */
2051 void
2052 set_time_zone_rule (const char *tzstring)
2054 int envptrs;
2055 char **from, **to, **newenv;
2057 /* Make the ENVIRON vector longer with room for TZSTRING. */
2058 for (from = environ; *from; from++)
2059 continue;
2060 envptrs = from - environ + 2;
2061 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2062 + (tzstring ? strlen (tzstring) + 4 : 0));
2064 /* Add TZSTRING to the end of environ, as a value for TZ. */
2065 if (tzstring)
2067 char *t = (char *) (to + envptrs);
2068 strcpy (t, "TZ=");
2069 strcat (t, tzstring);
2070 *to++ = t;
2073 /* Copy the old environ vector elements into NEWENV,
2074 but don't copy the TZ variable.
2075 So we have only one definition of TZ, which came from TZSTRING. */
2076 for (from = environ; *from; from++)
2077 if (strncmp (*from, "TZ=", 3) != 0)
2078 *to++ = *from;
2079 *to = 0;
2081 environ = newenv;
2083 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2084 the TZ variable is stored. If we do not have a TZSTRING,
2085 TO points to the vector slot which has the terminating null. */
2087 #ifdef LOCALTIME_CACHE
2089 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2090 "US/Pacific" that loads a tz file, then changes to a value like
2091 "XXX0" that does not load a tz file, and then changes back to
2092 its original value, the last change is (incorrectly) ignored.
2093 Also, if TZ changes twice in succession to values that do
2094 not load a tz file, tzset can dump core (see Sun bug#1225179).
2095 The following code works around these bugs. */
2097 if (tzstring)
2099 /* Temporarily set TZ to a value that loads a tz file
2100 and that differs from tzstring. */
2101 char *tz = *newenv;
2102 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2103 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
2104 tzset ();
2105 *newenv = tz;
2107 else
2109 /* The implied tzstring is unknown, so temporarily set TZ to
2110 two different values that each load a tz file. */
2111 *to = set_time_zone_rule_tz1;
2112 to[1] = 0;
2113 tzset ();
2114 *to = set_time_zone_rule_tz2;
2115 tzset ();
2116 *to = 0;
2119 /* Now TZ has the desired value, and tzset can be invoked safely. */
2122 tzset ();
2123 #endif
2126 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2127 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2128 type of object is Lisp_String). INHERIT is passed to
2129 INSERT_FROM_STRING_FUNC as the last argument. */
2131 static void
2132 general_insert_function (void (*insert_func)
2133 (const unsigned char *, EMACS_INT),
2134 void (*insert_from_string_func)
2135 (Lisp_Object, EMACS_INT, EMACS_INT,
2136 EMACS_INT, EMACS_INT, int),
2137 int inherit, int nargs, Lisp_Object *args)
2139 register int argnum;
2140 register Lisp_Object val;
2142 for (argnum = 0; argnum < nargs; argnum++)
2144 val = args[argnum];
2145 if (CHARACTERP (val))
2147 unsigned char str[MAX_MULTIBYTE_LENGTH];
2148 int len;
2150 if (!NILP (current_buffer->enable_multibyte_characters))
2151 len = CHAR_STRING (XFASTINT (val), str);
2152 else
2154 str[0] = (ASCII_CHAR_P (XINT (val))
2155 ? XINT (val)
2156 : multibyte_char_to_unibyte (XINT (val), Qnil));
2157 len = 1;
2159 (*insert_func) (str, len);
2161 else if (STRINGP (val))
2163 (*insert_from_string_func) (val, 0, 0,
2164 SCHARS (val),
2165 SBYTES (val),
2166 inherit);
2168 else
2169 wrong_type_argument (Qchar_or_string_p, val);
2173 void
2174 insert1 (Lisp_Object arg)
2176 Finsert (1, &arg);
2180 /* Callers passing one argument to Finsert need not gcpro the
2181 argument "array", since the only element of the array will
2182 not be used after calling insert or insert_from_string, so
2183 we don't care if it gets trashed. */
2185 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2186 doc: /* Insert the arguments, either strings or characters, at point.
2187 Point and before-insertion markers move forward to end up
2188 after the inserted text.
2189 Any other markers at the point of insertion remain before the text.
2191 If the current buffer is multibyte, unibyte strings are converted
2192 to multibyte for insertion (see `string-make-multibyte').
2193 If the current buffer is unibyte, multibyte strings are converted
2194 to unibyte for insertion (see `string-make-unibyte').
2196 When operating on binary data, it may be necessary to preserve the
2197 original bytes of a unibyte string when inserting it into a multibyte
2198 buffer; to accomplish this, apply `string-as-multibyte' to the string
2199 and insert the result.
2201 usage: (insert &rest ARGS) */)
2202 (int nargs, register Lisp_Object *args)
2204 general_insert_function (insert, insert_from_string, 0, nargs, args);
2205 return Qnil;
2208 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2209 0, MANY, 0,
2210 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2211 Point and before-insertion markers move forward to end up
2212 after the inserted text.
2213 Any other markers at the point of insertion remain before the text.
2215 If the current buffer is multibyte, unibyte strings are converted
2216 to multibyte for insertion (see `unibyte-char-to-multibyte').
2217 If the current buffer is unibyte, multibyte strings are converted
2218 to unibyte for insertion.
2220 usage: (insert-and-inherit &rest ARGS) */)
2221 (int nargs, register Lisp_Object *args)
2223 general_insert_function (insert_and_inherit, insert_from_string, 1,
2224 nargs, args);
2225 return Qnil;
2228 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2229 doc: /* Insert strings or characters at point, relocating markers after the text.
2230 Point and markers move forward to end up after the inserted text.
2232 If the current buffer is multibyte, unibyte strings are converted
2233 to multibyte for insertion (see `unibyte-char-to-multibyte').
2234 If the current buffer is unibyte, multibyte strings are converted
2235 to unibyte for insertion.
2237 usage: (insert-before-markers &rest ARGS) */)
2238 (int nargs, register Lisp_Object *args)
2240 general_insert_function (insert_before_markers,
2241 insert_from_string_before_markers, 0,
2242 nargs, args);
2243 return Qnil;
2246 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2247 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2248 doc: /* Insert text at point, relocating markers and inheriting properties.
2249 Point and markers move forward to end up after the inserted text.
2251 If the current buffer is multibyte, unibyte strings are converted
2252 to multibyte for insertion (see `unibyte-char-to-multibyte').
2253 If the current buffer is unibyte, multibyte strings are converted
2254 to unibyte for insertion.
2256 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2257 (int nargs, register Lisp_Object *args)
2259 general_insert_function (insert_before_markers_and_inherit,
2260 insert_from_string_before_markers, 1,
2261 nargs, args);
2262 return Qnil;
2265 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2266 doc: /* Insert COUNT copies of CHARACTER.
2267 Point, and before-insertion markers, are relocated as in the function `insert'.
2268 The optional third arg INHERIT, if non-nil, says to inherit text properties
2269 from adjoining text, if those properties are sticky. */)
2270 (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
2272 register unsigned char *string;
2273 register EMACS_INT strlen;
2274 register int i;
2275 register EMACS_INT n;
2276 int len;
2277 unsigned char str[MAX_MULTIBYTE_LENGTH];
2279 CHECK_NUMBER (character);
2280 CHECK_NUMBER (count);
2282 if (!NILP (current_buffer->enable_multibyte_characters))
2283 len = CHAR_STRING (XFASTINT (character), str);
2284 else
2285 str[0] = XFASTINT (character), len = 1;
2286 if (MOST_POSITIVE_FIXNUM / len < XINT (count))
2287 error ("Maximum buffer size would be exceeded");
2288 n = XINT (count) * len;
2289 if (n <= 0)
2290 return Qnil;
2291 strlen = min (n, 256 * len);
2292 string = (unsigned char *) alloca (strlen);
2293 for (i = 0; i < strlen; i++)
2294 string[i] = str[i % len];
2295 while (n >= strlen)
2297 QUIT;
2298 if (!NILP (inherit))
2299 insert_and_inherit (string, strlen);
2300 else
2301 insert (string, strlen);
2302 n -= strlen;
2304 if (n > 0)
2306 if (!NILP (inherit))
2307 insert_and_inherit (string, n);
2308 else
2309 insert (string, n);
2311 return Qnil;
2314 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2315 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2316 Both arguments are required.
2317 BYTE is a number of the range 0..255.
2319 If BYTE is 128..255 and the current buffer is multibyte, the
2320 corresponding eight-bit character is inserted.
2322 Point, and before-insertion markers, are relocated as in the function `insert'.
2323 The optional third arg INHERIT, if non-nil, says to inherit text properties
2324 from adjoining text, if those properties are sticky. */)
2325 (Lisp_Object byte, Lisp_Object count, Lisp_Object inherit)
2327 CHECK_NUMBER (byte);
2328 if (XINT (byte) < 0 || XINT (byte) > 255)
2329 args_out_of_range_3 (byte, make_number (0), make_number (255));
2330 if (XINT (byte) >= 128
2331 && ! NILP (current_buffer->enable_multibyte_characters))
2332 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2333 return Finsert_char (byte, count, inherit);
2337 /* Making strings from buffer contents. */
2339 /* Return a Lisp_String containing the text of the current buffer from
2340 START to END. If text properties are in use and the current buffer
2341 has properties in the range specified, the resulting string will also
2342 have them, if PROPS is nonzero.
2344 We don't want to use plain old make_string here, because it calls
2345 make_uninit_string, which can cause the buffer arena to be
2346 compacted. make_string has no way of knowing that the data has
2347 been moved, and thus copies the wrong data into the string. This
2348 doesn't effect most of the other users of make_string, so it should
2349 be left as is. But we should use this function when conjuring
2350 buffer substrings. */
2352 Lisp_Object
2353 make_buffer_string (EMACS_INT start, EMACS_INT end, int props)
2355 EMACS_INT start_byte = CHAR_TO_BYTE (start);
2356 EMACS_INT end_byte = CHAR_TO_BYTE (end);
2358 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2361 /* Return a Lisp_String containing the text of the current buffer from
2362 START / START_BYTE to END / END_BYTE.
2364 If text properties are in use and the current buffer
2365 has properties in the range specified, the resulting string will also
2366 have them, if PROPS is nonzero.
2368 We don't want to use plain old make_string here, because it calls
2369 make_uninit_string, which can cause the buffer arena to be
2370 compacted. make_string has no way of knowing that the data has
2371 been moved, and thus copies the wrong data into the string. This
2372 doesn't effect most of the other users of make_string, so it should
2373 be left as is. But we should use this function when conjuring
2374 buffer substrings. */
2376 Lisp_Object
2377 make_buffer_string_both (EMACS_INT start, EMACS_INT start_byte,
2378 EMACS_INT end, EMACS_INT end_byte, int props)
2380 Lisp_Object result, tem, tem1;
2382 if (start < GPT && GPT < end)
2383 move_gap (start);
2385 if (! NILP (current_buffer->enable_multibyte_characters))
2386 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2387 else
2388 result = make_uninit_string (end - start);
2389 memcpy (SDATA (result), BYTE_POS_ADDR (start_byte), end_byte - start_byte);
2391 /* If desired, update and copy the text properties. */
2392 if (props)
2394 update_buffer_properties (start, end);
2396 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2397 tem1 = Ftext_properties_at (make_number (start), Qnil);
2399 if (XINT (tem) != end || !NILP (tem1))
2400 copy_intervals_to_string (result, current_buffer, start,
2401 end - start);
2404 return result;
2407 /* Call Vbuffer_access_fontify_functions for the range START ... END
2408 in the current buffer, if necessary. */
2410 static void
2411 update_buffer_properties (EMACS_INT start, EMACS_INT end)
2413 /* If this buffer has some access functions,
2414 call them, specifying the range of the buffer being accessed. */
2415 if (!NILP (Vbuffer_access_fontify_functions))
2417 Lisp_Object args[3];
2418 Lisp_Object tem;
2420 args[0] = Qbuffer_access_fontify_functions;
2421 XSETINT (args[1], start);
2422 XSETINT (args[2], end);
2424 /* But don't call them if we can tell that the work
2425 has already been done. */
2426 if (!NILP (Vbuffer_access_fontified_property))
2428 tem = Ftext_property_any (args[1], args[2],
2429 Vbuffer_access_fontified_property,
2430 Qnil, Qnil);
2431 if (! NILP (tem))
2432 Frun_hook_with_args (3, args);
2434 else
2435 Frun_hook_with_args (3, args);
2439 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2440 doc: /* Return the contents of part of the current buffer as a string.
2441 The two arguments START and END are character positions;
2442 they can be in either order.
2443 The string returned is multibyte if the buffer is multibyte.
2445 This function copies the text properties of that part of the buffer
2446 into the result string; if you don't want the text properties,
2447 use `buffer-substring-no-properties' instead. */)
2448 (Lisp_Object start, Lisp_Object end)
2450 register EMACS_INT b, e;
2452 validate_region (&start, &end);
2453 b = XINT (start);
2454 e = XINT (end);
2456 return make_buffer_string (b, e, 1);
2459 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2460 Sbuffer_substring_no_properties, 2, 2, 0,
2461 doc: /* Return the characters of part of the buffer, without the text properties.
2462 The two arguments START and END are character positions;
2463 they can be in either order. */)
2464 (Lisp_Object start, Lisp_Object end)
2466 register EMACS_INT b, e;
2468 validate_region (&start, &end);
2469 b = XINT (start);
2470 e = XINT (end);
2472 return make_buffer_string (b, e, 0);
2475 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2476 doc: /* Return the contents of the current buffer as a string.
2477 If narrowing is in effect, this function returns only the visible part
2478 of the buffer. */)
2479 (void)
2481 return make_buffer_string (BEGV, ZV, 1);
2484 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2485 1, 3, 0,
2486 doc: /* Insert before point a substring of the contents of BUFFER.
2487 BUFFER may be a buffer or a buffer name.
2488 Arguments START and END are character positions specifying the substring.
2489 They default to the values of (point-min) and (point-max) in BUFFER. */)
2490 (Lisp_Object buffer, Lisp_Object start, Lisp_Object end)
2492 register EMACS_INT b, e, temp;
2493 register struct buffer *bp, *obuf;
2494 Lisp_Object buf;
2496 buf = Fget_buffer (buffer);
2497 if (NILP (buf))
2498 nsberror (buffer);
2499 bp = XBUFFER (buf);
2500 if (NILP (bp->name))
2501 error ("Selecting deleted buffer");
2503 if (NILP (start))
2504 b = BUF_BEGV (bp);
2505 else
2507 CHECK_NUMBER_COERCE_MARKER (start);
2508 b = XINT (start);
2510 if (NILP (end))
2511 e = BUF_ZV (bp);
2512 else
2514 CHECK_NUMBER_COERCE_MARKER (end);
2515 e = XINT (end);
2518 if (b > e)
2519 temp = b, b = e, e = temp;
2521 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2522 args_out_of_range (start, end);
2524 obuf = current_buffer;
2525 set_buffer_internal_1 (bp);
2526 update_buffer_properties (b, e);
2527 set_buffer_internal_1 (obuf);
2529 insert_from_buffer (bp, b, e - b, 0);
2530 return Qnil;
2533 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2534 6, 6, 0,
2535 doc: /* Compare two substrings of two buffers; return result as number.
2536 the value is -N if first string is less after N-1 chars,
2537 +N if first string is greater after N-1 chars, or 0 if strings match.
2538 Each substring is represented as three arguments: BUFFER, START and END.
2539 That makes six args in all, three for each substring.
2541 The value of `case-fold-search' in the current buffer
2542 determines whether case is significant or ignored. */)
2543 (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)
2545 register EMACS_INT begp1, endp1, begp2, endp2, temp;
2546 register struct buffer *bp1, *bp2;
2547 register Lisp_Object trt
2548 = (!NILP (current_buffer->case_fold_search)
2549 ? current_buffer->case_canon_table : Qnil);
2550 EMACS_INT chars = 0;
2551 EMACS_INT i1, i2, i1_byte, i2_byte;
2553 /* Find the first buffer and its substring. */
2555 if (NILP (buffer1))
2556 bp1 = current_buffer;
2557 else
2559 Lisp_Object buf1;
2560 buf1 = Fget_buffer (buffer1);
2561 if (NILP (buf1))
2562 nsberror (buffer1);
2563 bp1 = XBUFFER (buf1);
2564 if (NILP (bp1->name))
2565 error ("Selecting deleted buffer");
2568 if (NILP (start1))
2569 begp1 = BUF_BEGV (bp1);
2570 else
2572 CHECK_NUMBER_COERCE_MARKER (start1);
2573 begp1 = XINT (start1);
2575 if (NILP (end1))
2576 endp1 = BUF_ZV (bp1);
2577 else
2579 CHECK_NUMBER_COERCE_MARKER (end1);
2580 endp1 = XINT (end1);
2583 if (begp1 > endp1)
2584 temp = begp1, begp1 = endp1, endp1 = temp;
2586 if (!(BUF_BEGV (bp1) <= begp1
2587 && begp1 <= endp1
2588 && endp1 <= BUF_ZV (bp1)))
2589 args_out_of_range (start1, end1);
2591 /* Likewise for second substring. */
2593 if (NILP (buffer2))
2594 bp2 = current_buffer;
2595 else
2597 Lisp_Object buf2;
2598 buf2 = Fget_buffer (buffer2);
2599 if (NILP (buf2))
2600 nsberror (buffer2);
2601 bp2 = XBUFFER (buf2);
2602 if (NILP (bp2->name))
2603 error ("Selecting deleted buffer");
2606 if (NILP (start2))
2607 begp2 = BUF_BEGV (bp2);
2608 else
2610 CHECK_NUMBER_COERCE_MARKER (start2);
2611 begp2 = XINT (start2);
2613 if (NILP (end2))
2614 endp2 = BUF_ZV (bp2);
2615 else
2617 CHECK_NUMBER_COERCE_MARKER (end2);
2618 endp2 = XINT (end2);
2621 if (begp2 > endp2)
2622 temp = begp2, begp2 = endp2, endp2 = temp;
2624 if (!(BUF_BEGV (bp2) <= begp2
2625 && begp2 <= endp2
2626 && endp2 <= BUF_ZV (bp2)))
2627 args_out_of_range (start2, end2);
2629 i1 = begp1;
2630 i2 = begp2;
2631 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2632 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2634 while (i1 < endp1 && i2 < endp2)
2636 /* When we find a mismatch, we must compare the
2637 characters, not just the bytes. */
2638 int c1, c2;
2640 QUIT;
2642 if (! NILP (bp1->enable_multibyte_characters))
2644 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2645 BUF_INC_POS (bp1, i1_byte);
2646 i1++;
2648 else
2650 c1 = BUF_FETCH_BYTE (bp1, i1);
2651 MAKE_CHAR_MULTIBYTE (c1);
2652 i1++;
2655 if (! NILP (bp2->enable_multibyte_characters))
2657 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2658 BUF_INC_POS (bp2, i2_byte);
2659 i2++;
2661 else
2663 c2 = BUF_FETCH_BYTE (bp2, i2);
2664 MAKE_CHAR_MULTIBYTE (c2);
2665 i2++;
2668 if (!NILP (trt))
2670 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2671 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
2673 if (c1 < c2)
2674 return make_number (- 1 - chars);
2675 if (c1 > c2)
2676 return make_number (chars + 1);
2678 chars++;
2681 /* The strings match as far as they go.
2682 If one is shorter, that one is less. */
2683 if (chars < endp1 - begp1)
2684 return make_number (chars + 1);
2685 else if (chars < endp2 - begp2)
2686 return make_number (- chars - 1);
2688 /* Same length too => they are equal. */
2689 return make_number (0);
2692 static Lisp_Object
2693 subst_char_in_region_unwind (Lisp_Object arg)
2695 return current_buffer->undo_list = arg;
2698 static Lisp_Object
2699 subst_char_in_region_unwind_1 (Lisp_Object arg)
2701 return current_buffer->filename = arg;
2704 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2705 Ssubst_char_in_region, 4, 5, 0,
2706 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2707 If optional arg NOUNDO is non-nil, don't record this change for undo
2708 and don't mark the buffer as really changed.
2709 Both characters must have the same length of multi-byte form. */)
2710 (Lisp_Object start, Lisp_Object end, Lisp_Object fromchar, Lisp_Object tochar, Lisp_Object noundo)
2712 register EMACS_INT pos, pos_byte, stop, i, len, end_byte;
2713 /* Keep track of the first change in the buffer:
2714 if 0 we haven't found it yet.
2715 if < 0 we've found it and we've run the before-change-function.
2716 if > 0 we've actually performed it and the value is its position. */
2717 EMACS_INT changed = 0;
2718 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2719 unsigned char *p;
2720 int count = SPECPDL_INDEX ();
2721 #define COMBINING_NO 0
2722 #define COMBINING_BEFORE 1
2723 #define COMBINING_AFTER 2
2724 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2725 int maybe_byte_combining = COMBINING_NO;
2726 EMACS_INT last_changed = 0;
2727 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2729 restart:
2731 validate_region (&start, &end);
2732 CHECK_NUMBER (fromchar);
2733 CHECK_NUMBER (tochar);
2735 if (multibyte_p)
2737 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2738 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2739 error ("Characters in `subst-char-in-region' have different byte-lengths");
2740 if (!ASCII_BYTE_P (*tostr))
2742 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2743 complete multibyte character, it may be combined with the
2744 after bytes. If it is in the range 0xA0..0xFF, it may be
2745 combined with the before and after bytes. */
2746 if (!CHAR_HEAD_P (*tostr))
2747 maybe_byte_combining = COMBINING_BOTH;
2748 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2749 maybe_byte_combining = COMBINING_AFTER;
2752 else
2754 len = 1;
2755 fromstr[0] = XFASTINT (fromchar);
2756 tostr[0] = XFASTINT (tochar);
2759 pos = XINT (start);
2760 pos_byte = CHAR_TO_BYTE (pos);
2761 stop = CHAR_TO_BYTE (XINT (end));
2762 end_byte = stop;
2764 /* If we don't want undo, turn off putting stuff on the list.
2765 That's faster than getting rid of things,
2766 and it prevents even the entry for a first change.
2767 Also inhibit locking the file. */
2768 if (!changed && !NILP (noundo))
2770 record_unwind_protect (subst_char_in_region_unwind,
2771 current_buffer->undo_list);
2772 current_buffer->undo_list = Qt;
2773 /* Don't do file-locking. */
2774 record_unwind_protect (subst_char_in_region_unwind_1,
2775 current_buffer->filename);
2776 current_buffer->filename = Qnil;
2779 if (pos_byte < GPT_BYTE)
2780 stop = min (stop, GPT_BYTE);
2781 while (1)
2783 EMACS_INT pos_byte_next = pos_byte;
2785 if (pos_byte >= stop)
2787 if (pos_byte >= end_byte) break;
2788 stop = end_byte;
2790 p = BYTE_POS_ADDR (pos_byte);
2791 if (multibyte_p)
2792 INC_POS (pos_byte_next);
2793 else
2794 ++pos_byte_next;
2795 if (pos_byte_next - pos_byte == len
2796 && p[0] == fromstr[0]
2797 && (len == 1
2798 || (p[1] == fromstr[1]
2799 && (len == 2 || (p[2] == fromstr[2]
2800 && (len == 3 || p[3] == fromstr[3]))))))
2802 if (changed < 0)
2803 /* We've already seen this and run the before-change-function;
2804 this time we only need to record the actual position. */
2805 changed = pos;
2806 else if (!changed)
2808 changed = -1;
2809 modify_region (current_buffer, pos, XINT (end), 0);
2811 if (! NILP (noundo))
2813 if (MODIFF - 1 == SAVE_MODIFF)
2814 SAVE_MODIFF++;
2815 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
2816 BUF_AUTOSAVE_MODIFF (current_buffer)++;
2819 /* The before-change-function may have moved the gap
2820 or even modified the buffer so we should start over. */
2821 goto restart;
2824 /* Take care of the case where the new character
2825 combines with neighboring bytes. */
2826 if (maybe_byte_combining
2827 && (maybe_byte_combining == COMBINING_AFTER
2828 ? (pos_byte_next < Z_BYTE
2829 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2830 : ((pos_byte_next < Z_BYTE
2831 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2832 || (pos_byte > BEG_BYTE
2833 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2835 Lisp_Object tem, string;
2837 struct gcpro gcpro1;
2839 tem = current_buffer->undo_list;
2840 GCPRO1 (tem);
2842 /* Make a multibyte string containing this single character. */
2843 string = make_multibyte_string (tostr, 1, len);
2844 /* replace_range is less efficient, because it moves the gap,
2845 but it handles combining correctly. */
2846 replace_range (pos, pos + 1, string,
2847 0, 0, 1);
2848 pos_byte_next = CHAR_TO_BYTE (pos);
2849 if (pos_byte_next > pos_byte)
2850 /* Before combining happened. We should not increment
2851 POS. So, to cancel the later increment of POS,
2852 decrease it now. */
2853 pos--;
2854 else
2855 INC_POS (pos_byte_next);
2857 if (! NILP (noundo))
2858 current_buffer->undo_list = tem;
2860 UNGCPRO;
2862 else
2864 if (NILP (noundo))
2865 record_change (pos, 1);
2866 for (i = 0; i < len; i++) *p++ = tostr[i];
2868 last_changed = pos + 1;
2870 pos_byte = pos_byte_next;
2871 pos++;
2874 if (changed > 0)
2876 signal_after_change (changed,
2877 last_changed - changed, last_changed - changed);
2878 update_compositions (changed, last_changed, CHECK_ALL);
2881 unbind_to (count, Qnil);
2882 return Qnil;
2886 static Lisp_Object check_translation (EMACS_INT, EMACS_INT, EMACS_INT,
2887 Lisp_Object);
2889 /* Helper function for Ftranslate_region_internal.
2891 Check if a character sequence at POS (POS_BYTE) matches an element
2892 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2893 element is found, return it. Otherwise return Qnil. */
2895 static Lisp_Object
2896 check_translation (EMACS_INT pos, EMACS_INT pos_byte, EMACS_INT end,
2897 Lisp_Object val)
2899 int buf_size = 16, buf_used = 0;
2900 int *buf = alloca (sizeof (int) * buf_size);
2902 for (; CONSP (val); val = XCDR (val))
2904 Lisp_Object elt;
2905 EMACS_INT len, i;
2907 elt = XCAR (val);
2908 if (! CONSP (elt))
2909 continue;
2910 elt = XCAR (elt);
2911 if (! VECTORP (elt))
2912 continue;
2913 len = ASIZE (elt);
2914 if (len <= end - pos)
2916 for (i = 0; i < len; i++)
2918 if (buf_used <= i)
2920 unsigned char *p = BYTE_POS_ADDR (pos_byte);
2921 int len1;
2923 if (buf_used == buf_size)
2925 int *newbuf;
2927 buf_size += 16;
2928 newbuf = alloca (sizeof (int) * buf_size);
2929 memcpy (newbuf, buf, sizeof (int) * buf_used);
2930 buf = newbuf;
2932 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len1);
2933 pos_byte += len1;
2935 if (XINT (AREF (elt, i)) != buf[i])
2936 break;
2938 if (i == len)
2939 return XCAR (val);
2942 return Qnil;
2946 DEFUN ("translate-region-internal", Ftranslate_region_internal,
2947 Stranslate_region_internal, 3, 3, 0,
2948 doc: /* Internal use only.
2949 From START to END, translate characters according to TABLE.
2950 TABLE is a string or a char-table; the Nth character in it is the
2951 mapping for the character with code N.
2952 It returns the number of characters changed. */)
2953 (Lisp_Object start, Lisp_Object end, register Lisp_Object table)
2955 register unsigned char *tt; /* Trans table. */
2956 register int nc; /* New character. */
2957 int cnt; /* Number of changes made. */
2958 EMACS_INT size; /* Size of translate table. */
2959 EMACS_INT pos, pos_byte, end_pos;
2960 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
2961 int string_multibyte;
2962 Lisp_Object val;
2964 validate_region (&start, &end);
2965 if (CHAR_TABLE_P (table))
2967 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
2968 error ("Not a translation table");
2969 size = MAX_CHAR;
2970 tt = NULL;
2972 else
2974 CHECK_STRING (table);
2976 if (! multibyte && (SCHARS (table) < SBYTES (table)))
2977 table = string_make_unibyte (table);
2978 string_multibyte = SCHARS (table) < SBYTES (table);
2979 size = SBYTES (table);
2980 tt = SDATA (table);
2983 pos = XINT (start);
2984 pos_byte = CHAR_TO_BYTE (pos);
2985 end_pos = XINT (end);
2986 modify_region (current_buffer, pos, end_pos, 0);
2988 cnt = 0;
2989 for (; pos < end_pos; )
2991 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
2992 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
2993 int len, str_len;
2994 int oc;
2995 Lisp_Object val;
2997 if (multibyte)
2998 oc = STRING_CHAR_AND_LENGTH (p, len);
2999 else
3000 oc = *p, len = 1;
3001 if (oc < size)
3003 if (tt)
3005 /* Reload as signal_after_change in last iteration may GC. */
3006 tt = SDATA (table);
3007 if (string_multibyte)
3009 str = tt + string_char_to_byte (table, oc);
3010 nc = STRING_CHAR_AND_LENGTH (str, str_len);
3012 else
3014 nc = tt[oc];
3015 if (! ASCII_BYTE_P (nc) && multibyte)
3017 str_len = BYTE8_STRING (nc, buf);
3018 str = buf;
3020 else
3022 str_len = 1;
3023 str = tt + oc;
3027 else
3029 EMACS_INT c;
3031 nc = oc;
3032 val = CHAR_TABLE_REF (table, oc);
3033 if (CHARACTERP (val)
3034 && (c = XINT (val), CHAR_VALID_P (c, 0)))
3036 nc = c;
3037 str_len = CHAR_STRING (nc, buf);
3038 str = buf;
3040 else if (VECTORP (val) || (CONSP (val)))
3042 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3043 where TO is TO-CHAR or [TO-CHAR ...]. */
3044 nc = -1;
3048 if (nc != oc && nc >= 0)
3050 /* Simple one char to one char translation. */
3051 if (len != str_len)
3053 Lisp_Object string;
3055 /* This is less efficient, because it moves the gap,
3056 but it should handle multibyte characters correctly. */
3057 string = make_multibyte_string (str, 1, str_len);
3058 replace_range (pos, pos + 1, string, 1, 0, 1);
3059 len = str_len;
3061 else
3063 record_change (pos, 1);
3064 while (str_len-- > 0)
3065 *p++ = *str++;
3066 signal_after_change (pos, 1, 1);
3067 update_compositions (pos, pos + 1, CHECK_BORDER);
3069 ++cnt;
3071 else if (nc < 0)
3073 Lisp_Object string;
3075 if (CONSP (val))
3077 val = check_translation (pos, pos_byte, end_pos, val);
3078 if (NILP (val))
3080 pos_byte += len;
3081 pos++;
3082 continue;
3084 /* VAL is ([FROM-CHAR ...] . TO). */
3085 len = ASIZE (XCAR (val));
3086 val = XCDR (val);
3088 else
3089 len = 1;
3091 if (VECTORP (val))
3093 string = Fconcat (1, &val);
3095 else
3097 string = Fmake_string (make_number (1), val);
3099 replace_range (pos, pos + len, string, 1, 0, 1);
3100 pos_byte += SBYTES (string);
3101 pos += SCHARS (string);
3102 cnt += SCHARS (string);
3103 end_pos += SCHARS (string) - len;
3104 continue;
3107 pos_byte += len;
3108 pos++;
3111 return make_number (cnt);
3114 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3115 doc: /* Delete the text between point and mark.
3117 When called from a program, expects two arguments,
3118 positions (integers or markers) specifying the stretch to be deleted. */)
3119 (Lisp_Object start, Lisp_Object end)
3121 validate_region (&start, &end);
3122 del_range (XINT (start), XINT (end));
3123 return Qnil;
3126 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3127 Sdelete_and_extract_region, 2, 2, 0,
3128 doc: /* Delete the text between START and END and return it. */)
3129 (Lisp_Object start, Lisp_Object end)
3131 validate_region (&start, &end);
3132 if (XINT (start) == XINT (end))
3133 return empty_unibyte_string;
3134 return del_range_1 (XINT (start), XINT (end), 1, 1);
3137 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3138 doc: /* Remove restrictions (narrowing) from current buffer.
3139 This allows the buffer's full text to be seen and edited. */)
3140 (void)
3142 if (BEG != BEGV || Z != ZV)
3143 current_buffer->clip_changed = 1;
3144 BEGV = BEG;
3145 BEGV_BYTE = BEG_BYTE;
3146 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3147 /* Changing the buffer bounds invalidates any recorded current column. */
3148 invalidate_current_column ();
3149 return Qnil;
3152 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3153 doc: /* Restrict editing in this buffer to the current region.
3154 The rest of the text becomes temporarily invisible and untouchable
3155 but is not deleted; if you save the buffer in a file, the invisible
3156 text is included in the file. \\[widen] makes all visible again.
3157 See also `save-restriction'.
3159 When calling from a program, pass two arguments; positions (integers
3160 or markers) bounding the text that should remain visible. */)
3161 (register Lisp_Object start, Lisp_Object end)
3163 CHECK_NUMBER_COERCE_MARKER (start);
3164 CHECK_NUMBER_COERCE_MARKER (end);
3166 if (XINT (start) > XINT (end))
3168 Lisp_Object tem;
3169 tem = start; start = end; end = tem;
3172 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3173 args_out_of_range (start, end);
3175 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3176 current_buffer->clip_changed = 1;
3178 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3179 SET_BUF_ZV (current_buffer, XFASTINT (end));
3180 if (PT < XFASTINT (start))
3181 SET_PT (XFASTINT (start));
3182 if (PT > XFASTINT (end))
3183 SET_PT (XFASTINT (end));
3184 /* Changing the buffer bounds invalidates any recorded current column. */
3185 invalidate_current_column ();
3186 return Qnil;
3189 Lisp_Object
3190 save_restriction_save (void)
3192 if (BEGV == BEG && ZV == Z)
3193 /* The common case that the buffer isn't narrowed.
3194 We return just the buffer object, which save_restriction_restore
3195 recognizes as meaning `no restriction'. */
3196 return Fcurrent_buffer ();
3197 else
3198 /* We have to save a restriction, so return a pair of markers, one
3199 for the beginning and one for the end. */
3201 Lisp_Object beg, end;
3203 beg = buildmark (BEGV, BEGV_BYTE);
3204 end = buildmark (ZV, ZV_BYTE);
3206 /* END must move forward if text is inserted at its exact location. */
3207 XMARKER(end)->insertion_type = 1;
3209 return Fcons (beg, end);
3213 Lisp_Object
3214 save_restriction_restore (Lisp_Object data)
3216 struct buffer *cur = NULL;
3217 struct buffer *buf = (CONSP (data)
3218 ? XMARKER (XCAR (data))->buffer
3219 : XBUFFER (data));
3221 if (buf && buf != current_buffer && !NILP (buf->pt_marker))
3222 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3223 is the case if it is or has an indirect buffer), then make
3224 sure it is current before we update BEGV, so
3225 set_buffer_internal takes care of managing those markers. */
3226 cur = current_buffer;
3227 set_buffer_internal (buf);
3230 if (CONSP (data))
3231 /* A pair of marks bounding a saved restriction. */
3233 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3234 struct Lisp_Marker *end = XMARKER (XCDR (data));
3235 eassert (buf == end->buffer);
3237 if (buf /* Verify marker still points to a buffer. */
3238 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3239 /* The restriction has changed from the saved one, so restore
3240 the saved restriction. */
3242 EMACS_INT pt = BUF_PT (buf);
3244 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3245 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3247 if (pt < beg->charpos || pt > end->charpos)
3248 /* The point is outside the new visible range, move it inside. */
3249 SET_BUF_PT_BOTH (buf,
3250 clip_to_bounds (beg->charpos, pt, end->charpos),
3251 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3252 end->bytepos));
3254 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3257 else
3258 /* A buffer, which means that there was no old restriction. */
3260 if (buf /* Verify marker still points to a buffer. */
3261 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3262 /* The buffer has been narrowed, get rid of the narrowing. */
3264 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3265 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3267 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3271 if (cur)
3272 set_buffer_internal (cur);
3274 return Qnil;
3277 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3278 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3279 The buffer's restrictions make parts of the beginning and end invisible.
3280 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3281 This special form, `save-restriction', saves the current buffer's restrictions
3282 when it is entered, and restores them when it is exited.
3283 So any `narrow-to-region' within BODY lasts only until the end of the form.
3284 The old restrictions settings are restored
3285 even in case of abnormal exit (throw or error).
3287 The value returned is the value of the last form in BODY.
3289 Note: if you are using both `save-excursion' and `save-restriction',
3290 use `save-excursion' outermost:
3291 (save-excursion (save-restriction ...))
3293 usage: (save-restriction &rest BODY) */)
3294 (Lisp_Object body)
3296 register Lisp_Object val;
3297 int count = SPECPDL_INDEX ();
3299 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3300 val = Fprogn (body);
3301 return unbind_to (count, val);
3304 /* Buffer for the most recent text displayed by Fmessage_box. */
3305 static char *message_text;
3307 /* Allocated length of that buffer. */
3308 static int message_length;
3310 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3311 doc: /* Display a message at the bottom of the screen.
3312 The message also goes into the `*Messages*' buffer.
3313 \(In keyboard macros, that's all it does.)
3314 Return the message.
3316 The first argument is a format control string, and the rest are data
3317 to be formatted under control of the string. See `format' for details.
3319 Note: Use (message "%s" VALUE) to print the value of expressions and
3320 variables to avoid accidentally interpreting `%' as format specifiers.
3322 If the first argument is nil or the empty string, the function clears
3323 any existing message; this lets the minibuffer contents show. See
3324 also `current-message'.
3326 usage: (message FORMAT-STRING &rest ARGS) */)
3327 (int nargs, Lisp_Object *args)
3329 if (NILP (args[0])
3330 || (STRINGP (args[0])
3331 && SBYTES (args[0]) == 0))
3333 message (0);
3334 return args[0];
3336 else
3338 register Lisp_Object val;
3339 val = Fformat (nargs, args);
3340 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
3341 return val;
3345 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3346 doc: /* Display a message, in a dialog box if possible.
3347 If a dialog box is not available, use the echo area.
3348 The first argument is a format control string, and the rest are data
3349 to be formatted under control of the string. See `format' for details.
3351 If the first argument is nil or the empty string, clear any existing
3352 message; let the minibuffer contents show.
3354 usage: (message-box FORMAT-STRING &rest ARGS) */)
3355 (int nargs, Lisp_Object *args)
3357 if (NILP (args[0]))
3359 message (0);
3360 return Qnil;
3362 else
3364 register Lisp_Object val;
3365 val = Fformat (nargs, args);
3366 #ifdef HAVE_MENUS
3367 /* The MS-DOS frames support popup menus even though they are
3368 not FRAME_WINDOW_P. */
3369 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3370 || FRAME_MSDOS_P (XFRAME (selected_frame)))
3372 Lisp_Object pane, menu, obj;
3373 struct gcpro gcpro1;
3374 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3375 GCPRO1 (pane);
3376 menu = Fcons (val, pane);
3377 obj = Fx_popup_dialog (Qt, menu, Qt);
3378 UNGCPRO;
3379 return val;
3381 #endif /* HAVE_MENUS */
3382 /* Copy the data so that it won't move when we GC. */
3383 if (! message_text)
3385 message_text = (char *)xmalloc (80);
3386 message_length = 80;
3388 if (SBYTES (val) > message_length)
3390 message_length = SBYTES (val);
3391 message_text = (char *)xrealloc (message_text, message_length);
3393 memcpy (message_text, SDATA (val), SBYTES (val));
3394 message2 (message_text, SBYTES (val),
3395 STRING_MULTIBYTE (val));
3396 return val;
3400 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3401 doc: /* Display a message in a dialog box or in the echo area.
3402 If this command was invoked with the mouse, use a dialog box if
3403 `use-dialog-box' is non-nil.
3404 Otherwise, use the echo area.
3405 The first argument is a format control string, and the rest are data
3406 to be formatted under control of the string. See `format' for details.
3408 If the first argument is nil or the empty string, clear any existing
3409 message; let the minibuffer contents show.
3411 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3412 (int nargs, Lisp_Object *args)
3414 #ifdef HAVE_MENUS
3415 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3416 && use_dialog_box)
3417 return Fmessage_box (nargs, args);
3418 #endif
3419 return Fmessage (nargs, args);
3422 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3423 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3424 (void)
3426 return current_message ();
3430 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3431 doc: /* Return a copy of STRING with text properties added.
3432 First argument is the string to copy.
3433 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3434 properties to add to the result.
3435 usage: (propertize STRING &rest PROPERTIES) */)
3436 (int nargs, Lisp_Object *args)
3438 Lisp_Object properties, string;
3439 struct gcpro gcpro1, gcpro2;
3440 int i;
3442 /* Number of args must be odd. */
3443 if ((nargs & 1) == 0 || nargs < 1)
3444 error ("Wrong number of arguments");
3446 properties = string = Qnil;
3447 GCPRO2 (properties, string);
3449 /* First argument must be a string. */
3450 CHECK_STRING (args[0]);
3451 string = Fcopy_sequence (args[0]);
3453 for (i = 1; i < nargs; i += 2)
3454 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3456 Fadd_text_properties (make_number (0),
3457 make_number (SCHARS (string)),
3458 properties, string);
3459 RETURN_UNGCPRO (string);
3463 /* Number of bytes that STRING will occupy when put into the result.
3464 MULTIBYTE is nonzero if the result should be multibyte. */
3466 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3467 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3468 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3469 : SBYTES (STRING))
3471 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3472 doc: /* Format a string out of a format-string and arguments.
3473 The first argument is a format control string.
3474 The other arguments are substituted into it to make the result, a string.
3476 The format control string may contain %-sequences meaning to substitute
3477 the next available argument:
3479 %s means print a string argument. Actually, prints any object, with `princ'.
3480 %d means print as number in decimal (%o octal, %x hex).
3481 %X is like %x, but uses upper case.
3482 %e means print a number in exponential notation.
3483 %f means print a number in decimal-point notation.
3484 %g means print a number in exponential notation
3485 or decimal-point notation, whichever uses fewer characters.
3486 %c means print a number as a single character.
3487 %S means print any object as an s-expression (using `prin1').
3489 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3490 Use %% to put a single % into the output.
3492 A %-sequence may contain optional flag, width, and precision
3493 specifiers, as follows:
3495 %<flags><width><precision>character
3497 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3499 The + flag character inserts a + before any positive number, while a
3500 space inserts a space before any positive number; these flags only
3501 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3502 The # flag means to use an alternate display form for %o, %x, %X, %e,
3503 %f, and %g sequences. The - and 0 flags affect the width specifier,
3504 as described below.
3506 The width specifier supplies a lower limit for the length of the
3507 printed representation. The padding, if any, normally goes on the
3508 left, but it goes on the right if the - flag is present. The padding
3509 character is normally a space, but it is 0 if the 0 flag is present.
3510 The - flag takes precedence over the 0 flag.
3512 For %e, %f, and %g sequences, the number after the "." in the
3513 precision specifier says how many decimal places to show; if zero, the
3514 decimal point itself is omitted. For %s and %S, the precision
3515 specifier truncates the string to the given width.
3517 usage: (format STRING &rest OBJECTS) */)
3518 (int nargs, register Lisp_Object *args)
3520 register int n; /* The number of the next arg to substitute */
3521 register EMACS_INT total; /* An estimate of the final length */
3522 char *buf, *p;
3523 register unsigned char *format, *end, *format_start;
3524 int nchars;
3525 /* Nonzero if the output should be a multibyte string,
3526 which is true if any of the inputs is one. */
3527 int multibyte = 0;
3528 /* When we make a multibyte string, we must pay attention to the
3529 byte combining problem, i.e., a byte may be combined with a
3530 multibyte character of the previous string. This flag tells if we
3531 must consider such a situation or not. */
3532 int maybe_combine_byte;
3533 unsigned char *this_format;
3534 /* Precision for each spec, or -1, a flag value meaning no precision
3535 was given in that spec. Element 0, corresonding to the format
3536 string itself, will not be used. Element NARGS, corresponding to
3537 no argument, *will* be assigned to in the case that a `%' and `.'
3538 occur after the final format specifier. */
3539 int *precision = (int *) (alloca ((nargs + 1) * sizeof (int)));
3540 int longest_format;
3541 Lisp_Object val;
3542 int arg_intervals = 0;
3543 USE_SAFE_ALLOCA;
3545 /* discarded[I] is 1 if byte I of the format
3546 string was not copied into the output.
3547 It is 2 if byte I was not the first byte of its character. */
3548 char *discarded = 0;
3550 /* Each element records, for one argument,
3551 the start and end bytepos in the output string,
3552 and whether the argument is a string with intervals.
3553 info[0] is unused. Unused elements have -1 for start. */
3554 struct info
3556 int start, end, intervals;
3557 } *info = 0;
3559 /* It should not be necessary to GCPRO ARGS, because
3560 the caller in the interpreter should take care of that. */
3562 /* Try to determine whether the result should be multibyte.
3563 This is not always right; sometimes the result needs to be multibyte
3564 because of an object that we will pass through prin1,
3565 and in that case, we won't know it here. */
3566 for (n = 0; n < nargs; n++)
3568 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3569 multibyte = 1;
3570 /* Piggyback on this loop to initialize precision[N]. */
3571 precision[n] = -1;
3573 precision[nargs] = -1;
3575 CHECK_STRING (args[0]);
3576 /* We may have to change "%S" to "%s". */
3577 args[0] = Fcopy_sequence (args[0]);
3579 /* GC should never happen here, so abort if it does. */
3580 abort_on_gc++;
3582 /* If we start out planning a unibyte result,
3583 then discover it has to be multibyte, we jump back to retry.
3584 That can only happen from the first large while loop below. */
3585 retry:
3587 format = SDATA (args[0]);
3588 format_start = format;
3589 end = format + SBYTES (args[0]);
3590 longest_format = 0;
3592 /* Make room in result for all the non-%-codes in the control string. */
3593 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]) + 1;
3595 /* Allocate the info and discarded tables. */
3597 int nbytes = (nargs+1) * sizeof *info;
3598 int i;
3599 if (!info)
3600 info = (struct info *) alloca (nbytes);
3601 memset (info, 0, nbytes);
3602 for (i = 0; i <= nargs; i++)
3603 info[i].start = -1;
3604 if (!discarded)
3605 SAFE_ALLOCA (discarded, char *, SBYTES (args[0]));
3606 memset (discarded, 0, SBYTES (args[0]));
3609 /* Add to TOTAL enough space to hold the converted arguments. */
3611 n = 0;
3612 while (format != end)
3613 if (*format++ == '%')
3615 EMACS_INT thissize = 0;
3616 EMACS_INT actual_width = 0;
3617 unsigned char *this_format_start = format - 1;
3618 int field_width = 0;
3620 /* General format specifications look like
3622 '%' [flags] [field-width] [precision] format
3624 where
3626 flags ::= [-+ #0]+
3627 field-width ::= [0-9]+
3628 precision ::= '.' [0-9]*
3630 If a field-width is specified, it specifies to which width
3631 the output should be padded with blanks, if the output
3632 string is shorter than field-width.
3634 If precision is specified, it specifies the number of
3635 digits to print after the '.' for floats, or the max.
3636 number of chars to print from a string. */
3638 while (format != end
3639 && (*format == '-' || *format == '0' || *format == '#'
3640 || * format == ' ' || *format == '+'))
3641 ++format;
3643 if (*format >= '0' && *format <= '9')
3645 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3646 field_width = 10 * field_width + *format - '0';
3649 /* N is not incremented for another few lines below, so refer to
3650 element N+1 (which might be precision[NARGS]). */
3651 if (*format == '.')
3653 ++format;
3654 for (precision[n+1] = 0; *format >= '0' && *format <= '9'; ++format)
3655 precision[n+1] = 10 * precision[n+1] + *format - '0';
3658 /* Extra +1 for 'l' that we may need to insert into the
3659 format. */
3660 if (format - this_format_start + 2 > longest_format)
3661 longest_format = format - this_format_start + 2;
3663 if (format == end)
3664 error ("Format string ends in middle of format specifier");
3665 if (*format == '%')
3666 format++;
3667 else if (++n >= nargs)
3668 error ("Not enough arguments for format string");
3669 else if (*format == 'S')
3671 /* For `S', prin1 the argument and then treat like a string. */
3672 register Lisp_Object tem;
3673 tem = Fprin1_to_string (args[n], Qnil);
3674 if (STRING_MULTIBYTE (tem) && ! multibyte)
3676 multibyte = 1;
3677 goto retry;
3679 args[n] = tem;
3680 /* If we restart the loop, we should not come here again
3681 because args[n] is now a string and calling
3682 Fprin1_to_string on it produces superflous double
3683 quotes. So, change "%S" to "%s" now. */
3684 *format = 's';
3685 goto string;
3687 else if (SYMBOLP (args[n]))
3689 args[n] = SYMBOL_NAME (args[n]);
3690 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3692 multibyte = 1;
3693 goto retry;
3695 goto string;
3697 else if (STRINGP (args[n]))
3699 string:
3700 if (*format != 's' && *format != 'S')
3701 error ("Format specifier doesn't match argument type");
3702 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3703 to be as large as is calculated here. Easy check for
3704 the case PRECISION = 0. */
3705 thissize = precision[n] ? CONVERTED_BYTE_SIZE (multibyte, args[n]) : 0;
3706 /* The precision also constrains how much of the argument
3707 string will finally appear (Bug#5710). */
3708 actual_width = lisp_string_width (args[n], -1, NULL, NULL);
3709 if (precision[n] != -1)
3710 actual_width = min (actual_width, precision[n]);
3712 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3713 else if (INTEGERP (args[n]) && *format != 's')
3715 /* The following loop assumes the Lisp type indicates
3716 the proper way to pass the argument.
3717 So make sure we have a flonum if the argument should
3718 be a double. */
3719 if (*format == 'e' || *format == 'f' || *format == 'g')
3720 args[n] = Ffloat (args[n]);
3721 else
3722 if (*format != 'd' && *format != 'o' && *format != 'x'
3723 && *format != 'i' && *format != 'X' && *format != 'c')
3724 error ("Invalid format operation %%%c", *format);
3726 thissize = 30 + (precision[n] > 0 ? precision[n] : 0);
3727 if (*format == 'c')
3729 if (! ASCII_CHAR_P (XINT (args[n]))
3730 /* Note: No one can remeber why we have to treat
3731 the character 0 as a multibyte character here.
3732 But, until it causes a real problem, let's
3733 don't change it. */
3734 || XINT (args[n]) == 0)
3736 if (! multibyte)
3738 multibyte = 1;
3739 goto retry;
3741 args[n] = Fchar_to_string (args[n]);
3742 thissize = SBYTES (args[n]);
3744 else if (! ASCII_BYTE_P (XINT (args[n])) && multibyte)
3746 args[n]
3747 = Fchar_to_string (Funibyte_char_to_multibyte (args[n]));
3748 thissize = SBYTES (args[n]);
3752 else if (FLOATP (args[n]) && *format != 's')
3754 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3756 if (*format != 'd' && *format != 'o' && *format != 'x'
3757 && *format != 'i' && *format != 'X' && *format != 'c')
3758 error ("Invalid format operation %%%c", *format);
3759 /* This fails unnecessarily if args[n] is bigger than
3760 most-positive-fixnum but smaller than MAXINT.
3761 These cases are important because we sometimes use floats
3762 to represent such integer values (typically such values
3763 come from UIDs or PIDs). */
3764 /* args[n] = Ftruncate (args[n], Qnil); */
3767 /* Note that we're using sprintf to print floats,
3768 so we have to take into account what that function
3769 prints. */
3770 /* Filter out flag value of -1. */
3771 thissize = (MAX_10_EXP + 100
3772 + (precision[n] > 0 ? precision[n] : 0));
3774 else
3776 /* Anything but a string, convert to a string using princ. */
3777 register Lisp_Object tem;
3778 tem = Fprin1_to_string (args[n], Qt);
3779 if (STRING_MULTIBYTE (tem) && ! multibyte)
3781 multibyte = 1;
3782 goto retry;
3784 args[n] = tem;
3785 goto string;
3788 thissize += max (0, field_width - actual_width);
3789 total += thissize + 4;
3792 abort_on_gc--;
3794 /* Now we can no longer jump to retry.
3795 TOTAL and LONGEST_FORMAT are known for certain. */
3797 this_format = (unsigned char *) alloca (longest_format + 1);
3799 /* Allocate the space for the result.
3800 Note that TOTAL is an overestimate. */
3801 SAFE_ALLOCA (buf, char *, total);
3803 p = buf;
3804 nchars = 0;
3805 n = 0;
3807 /* Scan the format and store result in BUF. */
3808 format = SDATA (args[0]);
3809 format_start = format;
3810 end = format + SBYTES (args[0]);
3811 maybe_combine_byte = 0;
3812 while (format != end)
3814 if (*format == '%')
3816 int minlen;
3817 int negative = 0;
3818 unsigned char *this_format_start = format;
3820 discarded[format - format_start] = 1;
3821 format++;
3823 while (strchr ("-+0# ", *format))
3825 if (*format == '-')
3827 negative = 1;
3829 discarded[format - format_start] = 1;
3830 ++format;
3833 minlen = atoi (format);
3835 while ((*format >= '0' && *format <= '9') || *format == '.')
3837 discarded[format - format_start] = 1;
3838 format++;
3841 if (*format++ == '%')
3843 *p++ = '%';
3844 nchars++;
3845 continue;
3848 ++n;
3850 discarded[format - format_start - 1] = 1;
3851 info[n].start = nchars;
3853 if (STRINGP (args[n]))
3855 /* handle case (precision[n] >= 0) */
3857 int width, padding;
3858 EMACS_INT nbytes, start, end;
3859 EMACS_INT nchars_string;
3861 /* lisp_string_width ignores a precision of 0, but GNU
3862 libc functions print 0 characters when the precision
3863 is 0. Imitate libc behavior here. Changing
3864 lisp_string_width is the right thing, and will be
3865 done, but meanwhile we work with it. */
3867 if (precision[n] == 0)
3868 width = nchars_string = nbytes = 0;
3869 else if (precision[n] > 0)
3870 width = lisp_string_width (args[n], precision[n],
3871 &nchars_string, &nbytes);
3872 else
3873 { /* no precision spec given for this argument */
3874 width = lisp_string_width (args[n], -1, NULL, NULL);
3875 nbytes = SBYTES (args[n]);
3876 nchars_string = SCHARS (args[n]);
3879 /* If spec requires it, pad on right with spaces. */
3880 padding = minlen - width;
3881 if (! negative)
3882 while (padding-- > 0)
3884 *p++ = ' ';
3885 ++nchars;
3888 info[n].start = start = nchars;
3889 nchars += nchars_string;
3890 end = nchars;
3892 if (p > buf
3893 && multibyte
3894 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3895 && STRING_MULTIBYTE (args[n])
3896 && !CHAR_HEAD_P (SREF (args[n], 0)))
3897 maybe_combine_byte = 1;
3899 p += copy_text (SDATA (args[n]), p,
3900 nbytes,
3901 STRING_MULTIBYTE (args[n]), multibyte);
3903 info[n].end = nchars;
3905 if (negative)
3906 while (padding-- > 0)
3908 *p++ = ' ';
3909 nchars++;
3912 /* If this argument has text properties, record where
3913 in the result string it appears. */
3914 if (STRING_INTERVALS (args[n]))
3915 info[n].intervals = arg_intervals = 1;
3917 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3919 int this_nchars;
3921 memcpy (this_format, this_format_start,
3922 format - this_format_start);
3923 this_format[format - this_format_start] = 0;
3925 if (format[-1] == 'e' || format[-1] == 'f' || format[-1] == 'g')
3926 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3927 else
3929 if (sizeof (EMACS_INT) > sizeof (int)
3930 && format[-1] != 'c')
3932 /* Insert 'l' before format spec. */
3933 this_format[format - this_format_start]
3934 = this_format[format - this_format_start - 1];
3935 this_format[format - this_format_start - 1] = 'l';
3936 this_format[format - this_format_start + 1] = 0;
3939 if (INTEGERP (args[n]))
3941 if (format[-1] == 'c')
3942 sprintf (p, this_format, (int) XINT (args[n]));
3943 else if (format[-1] == 'd')
3944 sprintf (p, this_format, XINT (args[n]));
3945 /* Don't sign-extend for octal or hex printing. */
3946 else
3947 sprintf (p, this_format, XUINT (args[n]));
3949 else if (format[-1] == 'c')
3950 sprintf (p, this_format, (int) XFLOAT_DATA (args[n]));
3951 else if (format[-1] == 'd')
3952 /* Maybe we should use "%1.0f" instead so it also works
3953 for values larger than MAXINT. */
3954 sprintf (p, this_format, (EMACS_INT) XFLOAT_DATA (args[n]));
3955 else
3956 /* Don't sign-extend for octal or hex printing. */
3957 sprintf (p, this_format, (EMACS_UINT) XFLOAT_DATA (args[n]));
3960 if (p > buf
3961 && multibyte
3962 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3963 && !CHAR_HEAD_P (*((unsigned char *) p)))
3964 maybe_combine_byte = 1;
3965 this_nchars = strlen (p);
3966 if (multibyte)
3967 p += str_to_multibyte (p, buf + total - 1 - p, this_nchars);
3968 else
3969 p += this_nchars;
3970 nchars += this_nchars;
3971 info[n].end = nchars;
3975 else if (STRING_MULTIBYTE (args[0]))
3977 /* Copy a whole multibyte character. */
3978 if (p > buf
3979 && multibyte
3980 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3981 && !CHAR_HEAD_P (*format))
3982 maybe_combine_byte = 1;
3983 *p++ = *format++;
3984 while (! CHAR_HEAD_P (*format))
3986 discarded[format - format_start] = 2;
3987 *p++ = *format++;
3989 nchars++;
3991 else if (multibyte)
3993 /* Convert a single-byte character to multibyte. */
3994 int len = copy_text (format, p, 1, 0, 1);
3996 p += len;
3997 format++;
3998 nchars++;
4000 else
4001 *p++ = *format++, nchars++;
4004 if (p > buf + total)
4005 abort ();
4007 if (maybe_combine_byte)
4008 nchars = multibyte_chars_in_text (buf, p - buf);
4009 val = make_specified_string (buf, nchars, p - buf, multibyte);
4011 /* If we allocated BUF with malloc, free it too. */
4012 SAFE_FREE ();
4014 /* If the format string has text properties, or any of the string
4015 arguments has text properties, set up text properties of the
4016 result string. */
4018 if (STRING_INTERVALS (args[0]) || arg_intervals)
4020 Lisp_Object len, new_len, props;
4021 struct gcpro gcpro1;
4023 /* Add text properties from the format string. */
4024 len = make_number (SCHARS (args[0]));
4025 props = text_property_list (args[0], make_number (0), len, Qnil);
4026 GCPRO1 (props);
4028 if (CONSP (props))
4030 EMACS_INT bytepos = 0, position = 0, translated = 0;
4031 int argn = 1;
4032 Lisp_Object list;
4034 /* Adjust the bounds of each text property
4035 to the proper start and end in the output string. */
4037 /* Put the positions in PROPS in increasing order, so that
4038 we can do (effectively) one scan through the position
4039 space of the format string. */
4040 props = Fnreverse (props);
4042 /* BYTEPOS is the byte position in the format string,
4043 POSITION is the untranslated char position in it,
4044 TRANSLATED is the translated char position in BUF,
4045 and ARGN is the number of the next arg we will come to. */
4046 for (list = props; CONSP (list); list = XCDR (list))
4048 Lisp_Object item;
4049 EMACS_INT pos;
4051 item = XCAR (list);
4053 /* First adjust the property start position. */
4054 pos = XINT (XCAR (item));
4056 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4057 up to this position. */
4058 for (; position < pos; bytepos++)
4060 if (! discarded[bytepos])
4061 position++, translated++;
4062 else if (discarded[bytepos] == 1)
4064 position++;
4065 if (translated == info[argn].start)
4067 translated += info[argn].end - info[argn].start;
4068 argn++;
4073 XSETCAR (item, make_number (translated));
4075 /* Likewise adjust the property end position. */
4076 pos = XINT (XCAR (XCDR (item)));
4078 for (; position < pos; bytepos++)
4080 if (! discarded[bytepos])
4081 position++, translated++;
4082 else if (discarded[bytepos] == 1)
4084 position++;
4085 if (translated == info[argn].start)
4087 translated += info[argn].end - info[argn].start;
4088 argn++;
4093 XSETCAR (XCDR (item), make_number (translated));
4096 add_text_properties_from_list (val, props, make_number (0));
4099 /* Add text properties from arguments. */
4100 if (arg_intervals)
4101 for (n = 1; n < nargs; ++n)
4102 if (info[n].intervals)
4104 len = make_number (SCHARS (args[n]));
4105 new_len = make_number (info[n].end - info[n].start);
4106 props = text_property_list (args[n], make_number (0), len, Qnil);
4107 props = extend_property_ranges (props, new_len);
4108 /* If successive arguments have properties, be sure that
4109 the value of `composition' property be the copy. */
4110 if (n > 1 && info[n - 1].end)
4111 make_composition_value_copy (props);
4112 add_text_properties_from_list (val, props,
4113 make_number (info[n].start));
4116 UNGCPRO;
4119 return val;
4122 Lisp_Object
4123 format2 (const char *string1, Lisp_Object arg0, Lisp_Object arg1)
4125 Lisp_Object args[3];
4126 args[0] = build_string (string1);
4127 args[1] = arg0;
4128 args[2] = arg1;
4129 return Fformat (3, args);
4132 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4133 doc: /* Return t if two characters match, optionally ignoring case.
4134 Both arguments must be characters (i.e. integers).
4135 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4136 (register Lisp_Object c1, Lisp_Object c2)
4138 int i1, i2;
4139 /* Check they're chars, not just integers, otherwise we could get array
4140 bounds violations in DOWNCASE. */
4141 CHECK_CHARACTER (c1);
4142 CHECK_CHARACTER (c2);
4144 if (XINT (c1) == XINT (c2))
4145 return Qt;
4146 if (NILP (current_buffer->case_fold_search))
4147 return Qnil;
4149 /* Do these in separate statements,
4150 then compare the variables.
4151 because of the way DOWNCASE uses temp variables. */
4152 i1 = XFASTINT (c1);
4153 if (NILP (current_buffer->enable_multibyte_characters)
4154 && ! ASCII_CHAR_P (i1))
4156 MAKE_CHAR_MULTIBYTE (i1);
4158 i2 = XFASTINT (c2);
4159 if (NILP (current_buffer->enable_multibyte_characters)
4160 && ! ASCII_CHAR_P (i2))
4162 MAKE_CHAR_MULTIBYTE (i2);
4164 i1 = DOWNCASE (i1);
4165 i2 = DOWNCASE (i2);
4166 return (i1 == i2 ? Qt : Qnil);
4169 /* Transpose the markers in two regions of the current buffer, and
4170 adjust the ones between them if necessary (i.e.: if the regions
4171 differ in size).
4173 START1, END1 are the character positions of the first region.
4174 START1_BYTE, END1_BYTE are the byte positions.
4175 START2, END2 are the character positions of the second region.
4176 START2_BYTE, END2_BYTE are the byte positions.
4178 Traverses the entire marker list of the buffer to do so, adding an
4179 appropriate amount to some, subtracting from some, and leaving the
4180 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4182 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4184 static void
4185 transpose_markers (EMACS_INT start1, EMACS_INT end1,
4186 EMACS_INT start2, EMACS_INT end2,
4187 EMACS_INT start1_byte, EMACS_INT end1_byte,
4188 EMACS_INT start2_byte, EMACS_INT end2_byte)
4190 register EMACS_INT amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4191 register struct Lisp_Marker *marker;
4193 /* Update point as if it were a marker. */
4194 if (PT < start1)
4196 else if (PT < end1)
4197 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4198 PT_BYTE + (end2_byte - end1_byte));
4199 else if (PT < start2)
4200 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4201 (PT_BYTE + (end2_byte - start2_byte)
4202 - (end1_byte - start1_byte)));
4203 else if (PT < end2)
4204 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4205 PT_BYTE - (start2_byte - start1_byte));
4207 /* We used to adjust the endpoints here to account for the gap, but that
4208 isn't good enough. Even if we assume the caller has tried to move the
4209 gap out of our way, it might still be at start1 exactly, for example;
4210 and that places it `inside' the interval, for our purposes. The amount
4211 of adjustment is nontrivial if there's a `denormalized' marker whose
4212 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4213 the dirty work to Fmarker_position, below. */
4215 /* The difference between the region's lengths */
4216 diff = (end2 - start2) - (end1 - start1);
4217 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4219 /* For shifting each marker in a region by the length of the other
4220 region plus the distance between the regions. */
4221 amt1 = (end2 - start2) + (start2 - end1);
4222 amt2 = (end1 - start1) + (start2 - end1);
4223 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4224 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4226 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4228 mpos = marker->bytepos;
4229 if (mpos >= start1_byte && mpos < end2_byte)
4231 if (mpos < end1_byte)
4232 mpos += amt1_byte;
4233 else if (mpos < start2_byte)
4234 mpos += diff_byte;
4235 else
4236 mpos -= amt2_byte;
4237 marker->bytepos = mpos;
4239 mpos = marker->charpos;
4240 if (mpos >= start1 && mpos < end2)
4242 if (mpos < end1)
4243 mpos += amt1;
4244 else if (mpos < start2)
4245 mpos += diff;
4246 else
4247 mpos -= amt2;
4249 marker->charpos = mpos;
4253 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4254 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4255 The regions should not be overlapping, because the size of the buffer is
4256 never changed in a transposition.
4258 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4259 any markers that happen to be located in the regions.
4261 Transposing beyond buffer boundaries is an error. */)
4262 (Lisp_Object startr1, Lisp_Object endr1, Lisp_Object startr2, Lisp_Object endr2, Lisp_Object leave_markers)
4264 register EMACS_INT start1, end1, start2, end2;
4265 EMACS_INT start1_byte, start2_byte, len1_byte, len2_byte;
4266 EMACS_INT gap, len1, len_mid, len2;
4267 unsigned char *start1_addr, *start2_addr, *temp;
4269 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4270 Lisp_Object buf;
4272 XSETBUFFER (buf, current_buffer);
4273 cur_intv = BUF_INTERVALS (current_buffer);
4275 validate_region (&startr1, &endr1);
4276 validate_region (&startr2, &endr2);
4278 start1 = XFASTINT (startr1);
4279 end1 = XFASTINT (endr1);
4280 start2 = XFASTINT (startr2);
4281 end2 = XFASTINT (endr2);
4282 gap = GPT;
4284 /* Swap the regions if they're reversed. */
4285 if (start2 < end1)
4287 register EMACS_INT glumph = start1;
4288 start1 = start2;
4289 start2 = glumph;
4290 glumph = end1;
4291 end1 = end2;
4292 end2 = glumph;
4295 len1 = end1 - start1;
4296 len2 = end2 - start2;
4298 if (start2 < end1)
4299 error ("Transposed regions overlap");
4300 else if (start1 == end1 || start2 == end2)
4301 error ("Transposed region has length 0");
4303 /* The possibilities are:
4304 1. Adjacent (contiguous) regions, or separate but equal regions
4305 (no, really equal, in this case!), or
4306 2. Separate regions of unequal size.
4308 The worst case is usually No. 2. It means that (aside from
4309 potential need for getting the gap out of the way), there also
4310 needs to be a shifting of the text between the two regions. So
4311 if they are spread far apart, we are that much slower... sigh. */
4313 /* It must be pointed out that the really studly thing to do would
4314 be not to move the gap at all, but to leave it in place and work
4315 around it if necessary. This would be extremely efficient,
4316 especially considering that people are likely to do
4317 transpositions near where they are working interactively, which
4318 is exactly where the gap would be found. However, such code
4319 would be much harder to write and to read. So, if you are
4320 reading this comment and are feeling squirrely, by all means have
4321 a go! I just didn't feel like doing it, so I will simply move
4322 the gap the minimum distance to get it out of the way, and then
4323 deal with an unbroken array. */
4325 /* Make sure the gap won't interfere, by moving it out of the text
4326 we will operate on. */
4327 if (start1 < gap && gap < end2)
4329 if (gap - start1 < end2 - gap)
4330 move_gap (start1);
4331 else
4332 move_gap (end2);
4335 start1_byte = CHAR_TO_BYTE (start1);
4336 start2_byte = CHAR_TO_BYTE (start2);
4337 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4338 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
4340 #ifdef BYTE_COMBINING_DEBUG
4341 if (end1 == start2)
4343 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4344 len2_byte, start1, start1_byte)
4345 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4346 len1_byte, end2, start2_byte + len2_byte)
4347 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4348 len1_byte, end2, start2_byte + len2_byte))
4349 abort ();
4351 else
4353 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4354 len2_byte, start1, start1_byte)
4355 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4356 len1_byte, start2, start2_byte)
4357 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4358 len2_byte, end1, start1_byte + len1_byte)
4359 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4360 len1_byte, end2, start2_byte + len2_byte))
4361 abort ();
4363 #endif
4365 /* Hmmm... how about checking to see if the gap is large
4366 enough to use as the temporary storage? That would avoid an
4367 allocation... interesting. Later, don't fool with it now. */
4369 /* Working without memmove, for portability (sigh), so must be
4370 careful of overlapping subsections of the array... */
4372 if (end1 == start2) /* adjacent regions */
4374 modify_region (current_buffer, start1, end2, 0);
4375 record_change (start1, len1 + len2);
4377 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4378 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4379 /* Don't use Fset_text_properties: that can cause GC, which can
4380 clobber objects stored in the tmp_intervals. */
4381 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4382 if (!NULL_INTERVAL_P (tmp_interval3))
4383 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4385 /* First region smaller than second. */
4386 if (len1_byte < len2_byte)
4388 USE_SAFE_ALLOCA;
4390 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4392 /* Don't precompute these addresses. We have to compute them
4393 at the last minute, because the relocating allocator might
4394 have moved the buffer around during the xmalloc. */
4395 start1_addr = BYTE_POS_ADDR (start1_byte);
4396 start2_addr = BYTE_POS_ADDR (start2_byte);
4398 memcpy (temp, start2_addr, len2_byte);
4399 memcpy (start1_addr + len2_byte, start1_addr, len1_byte);
4400 memcpy (start1_addr, temp, len2_byte);
4401 SAFE_FREE ();
4403 else
4404 /* First region not smaller than second. */
4406 USE_SAFE_ALLOCA;
4408 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4409 start1_addr = BYTE_POS_ADDR (start1_byte);
4410 start2_addr = BYTE_POS_ADDR (start2_byte);
4411 memcpy (temp, start1_addr, len1_byte);
4412 memcpy (start1_addr, start2_addr, len2_byte);
4413 memcpy (start1_addr + len2_byte, temp, len1_byte);
4414 SAFE_FREE ();
4416 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4417 len1, current_buffer, 0);
4418 graft_intervals_into_buffer (tmp_interval2, start1,
4419 len2, current_buffer, 0);
4420 update_compositions (start1, start1 + len2, CHECK_BORDER);
4421 update_compositions (start1 + len2, end2, CHECK_TAIL);
4423 /* Non-adjacent regions, because end1 != start2, bleagh... */
4424 else
4426 len_mid = start2_byte - (start1_byte + len1_byte);
4428 if (len1_byte == len2_byte)
4429 /* Regions are same size, though, how nice. */
4431 USE_SAFE_ALLOCA;
4433 modify_region (current_buffer, start1, end1, 0);
4434 modify_region (current_buffer, start2, end2, 0);
4435 record_change (start1, len1);
4436 record_change (start2, len2);
4437 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4438 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4440 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4441 if (!NULL_INTERVAL_P (tmp_interval3))
4442 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4444 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4445 if (!NULL_INTERVAL_P (tmp_interval3))
4446 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4448 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4449 start1_addr = BYTE_POS_ADDR (start1_byte);
4450 start2_addr = BYTE_POS_ADDR (start2_byte);
4451 memcpy (temp, start1_addr, len1_byte);
4452 memcpy (start1_addr, start2_addr, len2_byte);
4453 memcpy (start2_addr, temp, len1_byte);
4454 SAFE_FREE ();
4456 graft_intervals_into_buffer (tmp_interval1, start2,
4457 len1, current_buffer, 0);
4458 graft_intervals_into_buffer (tmp_interval2, start1,
4459 len2, current_buffer, 0);
4462 else if (len1_byte < len2_byte) /* Second region larger than first */
4463 /* Non-adjacent & unequal size, area between must also be shifted. */
4465 USE_SAFE_ALLOCA;
4467 modify_region (current_buffer, start1, end2, 0);
4468 record_change (start1, (end2 - start1));
4469 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4470 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4471 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4473 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4474 if (!NULL_INTERVAL_P (tmp_interval3))
4475 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4477 /* holds region 2 */
4478 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4479 start1_addr = BYTE_POS_ADDR (start1_byte);
4480 start2_addr = BYTE_POS_ADDR (start2_byte);
4481 memcpy (temp, start2_addr, len2_byte);
4482 memcpy (start1_addr + len_mid + len2_byte, start1_addr, len1_byte);
4483 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4484 memcpy (start1_addr, temp, len2_byte);
4485 SAFE_FREE ();
4487 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4488 len1, current_buffer, 0);
4489 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4490 len_mid, current_buffer, 0);
4491 graft_intervals_into_buffer (tmp_interval2, start1,
4492 len2, current_buffer, 0);
4494 else
4495 /* Second region smaller than first. */
4497 USE_SAFE_ALLOCA;
4499 record_change (start1, (end2 - start1));
4500 modify_region (current_buffer, start1, end2, 0);
4502 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4503 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4504 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4506 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4507 if (!NULL_INTERVAL_P (tmp_interval3))
4508 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4510 /* holds region 1 */
4511 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4512 start1_addr = BYTE_POS_ADDR (start1_byte);
4513 start2_addr = BYTE_POS_ADDR (start2_byte);
4514 memcpy (temp, start1_addr, len1_byte);
4515 memcpy (start1_addr, start2_addr, len2_byte);
4516 memcpy (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4517 memcpy (start1_addr + len2_byte + len_mid, temp, len1_byte);
4518 SAFE_FREE ();
4520 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4521 len1, current_buffer, 0);
4522 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4523 len_mid, current_buffer, 0);
4524 graft_intervals_into_buffer (tmp_interval2, start1,
4525 len2, current_buffer, 0);
4528 update_compositions (start1, start1 + len2, CHECK_BORDER);
4529 update_compositions (end2 - len1, end2, CHECK_BORDER);
4532 /* When doing multiple transpositions, it might be nice
4533 to optimize this. Perhaps the markers in any one buffer
4534 should be organized in some sorted data tree. */
4535 if (NILP (leave_markers))
4537 transpose_markers (start1, end1, start2, end2,
4538 start1_byte, start1_byte + len1_byte,
4539 start2_byte, start2_byte + len2_byte);
4540 fix_start_end_in_overlays (start1, end2);
4543 signal_after_change (start1, end2 - start1, end2 - start1);
4544 return Qnil;
4548 void
4549 syms_of_editfns (void)
4551 environbuf = 0;
4552 initial_tz = 0;
4554 Qbuffer_access_fontify_functions
4555 = intern_c_string ("buffer-access-fontify-functions");
4556 staticpro (&Qbuffer_access_fontify_functions);
4558 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
4559 doc: /* Non-nil means text motion commands don't notice fields. */);
4560 Vinhibit_field_text_motion = Qnil;
4562 DEFVAR_LISP ("buffer-access-fontify-functions",
4563 &Vbuffer_access_fontify_functions,
4564 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
4565 Each function is called with two arguments which specify the range
4566 of the buffer being accessed. */);
4567 Vbuffer_access_fontify_functions = Qnil;
4570 Lisp_Object obuf;
4571 obuf = Fcurrent_buffer ();
4572 /* Do this here, because init_buffer_once is too early--it won't work. */
4573 Fset_buffer (Vprin1_to_string_buffer);
4574 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4575 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
4576 Qnil);
4577 Fset_buffer (obuf);
4580 DEFVAR_LISP ("buffer-access-fontified-property",
4581 &Vbuffer_access_fontified_property,
4582 doc: /* Property which (if non-nil) indicates text has been fontified.
4583 `buffer-substring' need not call the `buffer-access-fontify-functions'
4584 functions if all the text being accessed has this property. */);
4585 Vbuffer_access_fontified_property = Qnil;
4587 DEFVAR_LISP ("system-name", &Vsystem_name,
4588 doc: /* The host name of the machine Emacs is running on. */);
4590 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
4591 doc: /* The full name of the user logged in. */);
4593 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
4594 doc: /* The user's name, taken from environment variables if possible. */);
4596 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
4597 doc: /* The user's name, based upon the real uid only. */);
4599 DEFVAR_LISP ("operating-system-release", &Voperating_system_release,
4600 doc: /* The release of the operating system Emacs is running on. */);
4602 defsubr (&Spropertize);
4603 defsubr (&Schar_equal);
4604 defsubr (&Sgoto_char);
4605 defsubr (&Sstring_to_char);
4606 defsubr (&Schar_to_string);
4607 defsubr (&Sbyte_to_string);
4608 defsubr (&Sbuffer_substring);
4609 defsubr (&Sbuffer_substring_no_properties);
4610 defsubr (&Sbuffer_string);
4612 defsubr (&Spoint_marker);
4613 defsubr (&Smark_marker);
4614 defsubr (&Spoint);
4615 defsubr (&Sregion_beginning);
4616 defsubr (&Sregion_end);
4618 staticpro (&Qfield);
4619 Qfield = intern_c_string ("field");
4620 staticpro (&Qboundary);
4621 Qboundary = intern_c_string ("boundary");
4622 defsubr (&Sfield_beginning);
4623 defsubr (&Sfield_end);
4624 defsubr (&Sfield_string);
4625 defsubr (&Sfield_string_no_properties);
4626 defsubr (&Sdelete_field);
4627 defsubr (&Sconstrain_to_field);
4629 defsubr (&Sline_beginning_position);
4630 defsubr (&Sline_end_position);
4632 /* defsubr (&Smark); */
4633 /* defsubr (&Sset_mark); */
4634 defsubr (&Ssave_excursion);
4635 defsubr (&Ssave_current_buffer);
4637 defsubr (&Sbufsize);
4638 defsubr (&Spoint_max);
4639 defsubr (&Spoint_min);
4640 defsubr (&Spoint_min_marker);
4641 defsubr (&Spoint_max_marker);
4642 defsubr (&Sgap_position);
4643 defsubr (&Sgap_size);
4644 defsubr (&Sposition_bytes);
4645 defsubr (&Sbyte_to_position);
4647 defsubr (&Sbobp);
4648 defsubr (&Seobp);
4649 defsubr (&Sbolp);
4650 defsubr (&Seolp);
4651 defsubr (&Sfollowing_char);
4652 defsubr (&Sprevious_char);
4653 defsubr (&Schar_after);
4654 defsubr (&Schar_before);
4655 defsubr (&Sinsert);
4656 defsubr (&Sinsert_before_markers);
4657 defsubr (&Sinsert_and_inherit);
4658 defsubr (&Sinsert_and_inherit_before_markers);
4659 defsubr (&Sinsert_char);
4660 defsubr (&Sinsert_byte);
4662 defsubr (&Suser_login_name);
4663 defsubr (&Suser_real_login_name);
4664 defsubr (&Suser_uid);
4665 defsubr (&Suser_real_uid);
4666 defsubr (&Suser_full_name);
4667 defsubr (&Semacs_pid);
4668 defsubr (&Scurrent_time);
4669 defsubr (&Sget_internal_run_time);
4670 defsubr (&Sformat_time_string);
4671 defsubr (&Sfloat_time);
4672 defsubr (&Sdecode_time);
4673 defsubr (&Sencode_time);
4674 defsubr (&Scurrent_time_string);
4675 defsubr (&Scurrent_time_zone);
4676 defsubr (&Sset_time_zone_rule);
4677 defsubr (&Ssystem_name);
4678 defsubr (&Smessage);
4679 defsubr (&Smessage_box);
4680 defsubr (&Smessage_or_box);
4681 defsubr (&Scurrent_message);
4682 defsubr (&Sformat);
4684 defsubr (&Sinsert_buffer_substring);
4685 defsubr (&Scompare_buffer_substrings);
4686 defsubr (&Ssubst_char_in_region);
4687 defsubr (&Stranslate_region_internal);
4688 defsubr (&Sdelete_region);
4689 defsubr (&Sdelete_and_extract_region);
4690 defsubr (&Swiden);
4691 defsubr (&Snarrow_to_region);
4692 defsubr (&Ssave_restriction);
4693 defsubr (&Stranspose_regions);