Compute freevars in cconv-analyse.
[emacs.git] / src / editfns.c
blob5d6189f2a3c480927c2b2f6207387aeaa34efb67
1 /* Lisp functions pertaining to editing.
3 Copyright (C) 1985-1987, 1989, 1993-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <sys/types.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #ifdef HAVE_PWD_H
27 #include <pwd.h>
28 #endif
30 #include <unistd.h>
32 #ifdef HAVE_SYS_UTSNAME_H
33 #include <sys/utsname.h>
34 #endif
36 #include "lisp.h"
38 /* systime.h includes <sys/time.h> which, on some systems, is required
39 for <sys/resource.h>; thus systime.h must be included before
40 <sys/resource.h> */
41 #include "systime.h"
43 #if defined HAVE_SYS_RESOURCE_H
44 #include <sys/resource.h>
45 #endif
47 #include <ctype.h>
48 #include <strftime.h>
50 #include "intervals.h"
51 #include "buffer.h"
52 #include "character.h"
53 #include "coding.h"
54 #include "frame.h"
55 #include "window.h"
56 #include "blockinput.h"
58 #ifdef STDC_HEADERS
59 #include <float.h>
60 #define MAX_10_EXP DBL_MAX_10_EXP
61 #else
62 #define MAX_10_EXP 310
63 #endif
65 #ifndef NULL
66 #define NULL 0
67 #endif
69 #ifndef USER_FULL_NAME
70 #define USER_FULL_NAME pw->pw_gecos
71 #endif
73 #ifndef USE_CRT_DLL
74 extern char **environ;
75 #endif
77 #define TM_YEAR_BASE 1900
79 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
80 asctime to have well-defined behavior. */
81 #ifndef TM_YEAR_IN_ASCTIME_RANGE
82 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
83 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
84 #endif
86 #ifdef WINDOWSNT
87 extern Lisp_Object w32_get_internal_run_time (void);
88 #endif
90 static int tm_diff (struct tm *, struct tm *);
91 static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
92 EMACS_INT *, Lisp_Object, EMACS_INT *);
93 static void update_buffer_properties (EMACS_INT, EMACS_INT);
94 static Lisp_Object region_limit (int);
95 static size_t emacs_nmemftime (char *, size_t, const char *,
96 size_t, const struct tm *, int, int);
97 static void general_insert_function (void (*) (const char *, EMACS_INT),
98 void (*) (Lisp_Object, EMACS_INT,
99 EMACS_INT, EMACS_INT,
100 EMACS_INT, int),
101 int, int, Lisp_Object *);
102 static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
103 static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
104 static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
105 EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
107 Lisp_Object Qbuffer_access_fontify_functions;
108 Lisp_Object Fuser_full_name (Lisp_Object);
110 /* Symbol for the text property used to mark fields. */
112 Lisp_Object Qfield;
114 /* A special value for Qfield properties. */
116 Lisp_Object Qboundary;
119 void
120 init_editfns (void)
122 char *user_name;
123 register char *p;
124 struct passwd *pw; /* password entry for the current user */
125 Lisp_Object tem;
127 /* Set up system_name even when dumping. */
128 init_system_name ();
130 #ifndef CANNOT_DUMP
131 /* Don't bother with this on initial start when just dumping out */
132 if (!initialized)
133 return;
134 #endif /* not CANNOT_DUMP */
136 pw = (struct passwd *) getpwuid (getuid ());
137 #ifdef MSDOS
138 /* We let the real user name default to "root" because that's quite
139 accurate on MSDOG and because it lets Emacs find the init file.
140 (The DVX libraries override the Djgpp libraries here.) */
141 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
142 #else
143 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
144 #endif
146 /* Get the effective user name, by consulting environment variables,
147 or the effective uid if those are unset. */
148 user_name = (char *) getenv ("LOGNAME");
149 if (!user_name)
150 #ifdef WINDOWSNT
151 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
152 #else /* WINDOWSNT */
153 user_name = (char *) getenv ("USER");
154 #endif /* WINDOWSNT */
155 if (!user_name)
157 pw = (struct passwd *) getpwuid (geteuid ());
158 user_name = (char *) (pw ? pw->pw_name : "unknown");
160 Vuser_login_name = build_string (user_name);
162 /* If the user name claimed in the environment vars differs from
163 the real uid, use the claimed name to find the full name. */
164 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
165 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
166 : Vuser_login_name);
168 p = getenv ("NAME");
169 if (p)
170 Vuser_full_name = build_string (p);
171 else if (NILP (Vuser_full_name))
172 Vuser_full_name = build_string ("unknown");
174 #ifdef HAVE_SYS_UTSNAME_H
176 struct utsname uts;
177 uname (&uts);
178 Voperating_system_release = build_string (uts.release);
180 #else
181 Voperating_system_release = Qnil;
182 #endif
185 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
186 doc: /* Convert arg CHAR to a string containing that character.
187 usage: (char-to-string CHAR) */)
188 (Lisp_Object character)
190 int len;
191 unsigned char str[MAX_MULTIBYTE_LENGTH];
193 CHECK_CHARACTER (character);
195 len = CHAR_STRING (XFASTINT (character), str);
196 return make_string_from_bytes ((char *) str, 1, len);
199 DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
200 doc: /* Convert arg BYTE to a unibyte string containing that byte. */)
201 (Lisp_Object byte)
203 unsigned char b;
204 CHECK_NUMBER (byte);
205 if (XINT (byte) < 0 || XINT (byte) > 255)
206 error ("Invalid byte");
207 b = XINT (byte);
208 return make_string_from_bytes ((char *) &b, 1, 1);
211 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
212 doc: /* Convert arg STRING to a character, the first character of that string.
213 A multibyte character is handled correctly. */)
214 (register Lisp_Object string)
216 register Lisp_Object val;
217 CHECK_STRING (string);
218 if (SCHARS (string))
220 if (STRING_MULTIBYTE (string))
221 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
222 else
223 XSETFASTINT (val, SREF (string, 0));
225 else
226 XSETFASTINT (val, 0);
227 return val;
230 static Lisp_Object
231 buildmark (EMACS_INT charpos, EMACS_INT bytepos)
233 register Lisp_Object mark;
234 mark = Fmake_marker ();
235 set_marker_both (mark, Qnil, charpos, bytepos);
236 return mark;
239 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
240 doc: /* Return value of point, as an integer.
241 Beginning of buffer is position (point-min). */)
242 (void)
244 Lisp_Object temp;
245 XSETFASTINT (temp, PT);
246 return temp;
249 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
250 doc: /* Return value of point, as a marker object. */)
251 (void)
253 return buildmark (PT, PT_BYTE);
256 EMACS_INT
257 clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
259 if (num < lower)
260 return lower;
261 else if (num > upper)
262 return upper;
263 else
264 return num;
267 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
268 doc: /* Set point to POSITION, a number or marker.
269 Beginning of buffer is position (point-min), end is (point-max).
271 The return value is POSITION. */)
272 (register Lisp_Object position)
274 EMACS_INT pos;
276 if (MARKERP (position)
277 && current_buffer == XMARKER (position)->buffer)
279 pos = marker_position (position);
280 if (pos < BEGV)
281 SET_PT_BOTH (BEGV, BEGV_BYTE);
282 else if (pos > ZV)
283 SET_PT_BOTH (ZV, ZV_BYTE);
284 else
285 SET_PT_BOTH (pos, marker_byte_position (position));
287 return position;
290 CHECK_NUMBER_COERCE_MARKER (position);
292 pos = clip_to_bounds (BEGV, XINT (position), ZV);
293 SET_PT (pos);
294 return position;
298 /* Return the start or end position of the region.
299 BEGINNINGP non-zero means return the start.
300 If there is no region active, signal an error. */
302 static Lisp_Object
303 region_limit (int beginningp)
305 Lisp_Object m;
307 if (!NILP (Vtransient_mark_mode)
308 && NILP (Vmark_even_if_inactive)
309 && NILP (BVAR (current_buffer, mark_active)))
310 xsignal0 (Qmark_inactive);
312 m = Fmarker_position (BVAR (current_buffer, mark));
313 if (NILP (m))
314 error ("The mark is not set now, so there is no region");
316 if ((PT < XFASTINT (m)) == (beginningp != 0))
317 m = make_number (PT);
318 return m;
321 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
322 doc: /* Return the integer value of point or mark, whichever is smaller. */)
323 (void)
325 return region_limit (1);
328 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
329 doc: /* Return the integer value of point or mark, whichever is larger. */)
330 (void)
332 return region_limit (0);
335 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
336 doc: /* Return this buffer's mark, as a marker object.
337 Watch out! Moving this marker changes the mark position.
338 If you set the marker not to point anywhere, the buffer will have no mark. */)
339 (void)
341 return BVAR (current_buffer, mark);
345 /* Find all the overlays in the current buffer that touch position POS.
346 Return the number found, and store them in a vector in VEC
347 of length LEN. */
349 static int
350 overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
352 Lisp_Object overlay, start, end;
353 struct Lisp_Overlay *tail;
354 EMACS_INT startpos, endpos;
355 int idx = 0;
357 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
359 XSETMISC (overlay, tail);
361 end = OVERLAY_END (overlay);
362 endpos = OVERLAY_POSITION (end);
363 if (endpos < pos)
364 break;
365 start = OVERLAY_START (overlay);
366 startpos = OVERLAY_POSITION (start);
367 if (startpos <= pos)
369 if (idx < len)
370 vec[idx] = overlay;
371 /* Keep counting overlays even if we can't return them all. */
372 idx++;
376 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
378 XSETMISC (overlay, tail);
380 start = OVERLAY_START (overlay);
381 startpos = OVERLAY_POSITION (start);
382 if (pos < startpos)
383 break;
384 end = OVERLAY_END (overlay);
385 endpos = OVERLAY_POSITION (end);
386 if (pos <= endpos)
388 if (idx < len)
389 vec[idx] = overlay;
390 idx++;
394 return idx;
397 /* Return the value of property PROP, in OBJECT at POSITION.
398 It's the value of PROP that a char inserted at POSITION would get.
399 OBJECT is optional and defaults to the current buffer.
400 If OBJECT is a buffer, then overlay properties are considered as well as
401 text properties.
402 If OBJECT is a window, then that window's buffer is used, but
403 window-specific overlays are considered only if they are associated
404 with OBJECT. */
405 Lisp_Object
406 get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
408 CHECK_NUMBER_COERCE_MARKER (position);
410 if (NILP (object))
411 XSETBUFFER (object, current_buffer);
412 else if (WINDOWP (object))
413 object = XWINDOW (object)->buffer;
415 if (!BUFFERP (object))
416 /* pos-property only makes sense in buffers right now, since strings
417 have no overlays and no notion of insertion for which stickiness
418 could be obeyed. */
419 return Fget_text_property (position, prop, object);
420 else
422 EMACS_INT posn = XINT (position);
423 int noverlays;
424 Lisp_Object *overlay_vec, tem;
425 struct buffer *obuf = current_buffer;
427 set_buffer_temp (XBUFFER (object));
429 /* First try with room for 40 overlays. */
430 noverlays = 40;
431 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
432 noverlays = overlays_around (posn, overlay_vec, noverlays);
434 /* If there are more than 40,
435 make enough space for all, and try again. */
436 if (noverlays > 40)
438 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
439 noverlays = overlays_around (posn, overlay_vec, noverlays);
441 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
443 set_buffer_temp (obuf);
445 /* Now check the overlays in order of decreasing priority. */
446 while (--noverlays >= 0)
448 Lisp_Object ol = overlay_vec[noverlays];
449 tem = Foverlay_get (ol, prop);
450 if (!NILP (tem))
452 /* Check the overlay is indeed active at point. */
453 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
454 if ((OVERLAY_POSITION (start) == posn
455 && XMARKER (start)->insertion_type == 1)
456 || (OVERLAY_POSITION (finish) == posn
457 && XMARKER (finish)->insertion_type == 0))
458 ; /* The overlay will not cover a char inserted at point. */
459 else
461 return tem;
466 { /* Now check the text properties. */
467 int stickiness = text_property_stickiness (prop, position, object);
468 if (stickiness > 0)
469 return Fget_text_property (position, prop, object);
470 else if (stickiness < 0
471 && XINT (position) > BUF_BEGV (XBUFFER (object)))
472 return Fget_text_property (make_number (XINT (position) - 1),
473 prop, object);
474 else
475 return Qnil;
480 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
481 the value of point is used instead. If BEG or END is null,
482 means don't store the beginning or end of the field.
484 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
485 results; they do not effect boundary behavior.
487 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
488 position of a field, then the beginning of the previous field is
489 returned instead of the beginning of POS's field (since the end of a
490 field is actually also the beginning of the next input field, this
491 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
492 true case, if two fields are separated by a field with the special
493 value `boundary', and POS lies within it, then the two separated
494 fields are considered to be adjacent, and POS between them, when
495 finding the beginning and ending of the "merged" field.
497 Either BEG or END may be 0, in which case the corresponding value
498 is not stored. */
500 static void
501 find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
502 Lisp_Object beg_limit,
503 EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
505 /* Fields right before and after the point. */
506 Lisp_Object before_field, after_field;
507 /* 1 if POS counts as the start of a field. */
508 int at_field_start = 0;
509 /* 1 if POS counts as the end of a field. */
510 int at_field_end = 0;
512 if (NILP (pos))
513 XSETFASTINT (pos, PT);
514 else
515 CHECK_NUMBER_COERCE_MARKER (pos);
517 after_field
518 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
519 before_field
520 = (XFASTINT (pos) > BEGV
521 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
522 Qfield, Qnil, NULL)
523 /* Using nil here would be a more obvious choice, but it would
524 fail when the buffer starts with a non-sticky field. */
525 : after_field);
527 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
528 and POS is at beginning of a field, which can also be interpreted
529 as the end of the previous field. Note that the case where if
530 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
531 more natural one; then we avoid treating the beginning of a field
532 specially. */
533 if (NILP (merge_at_boundary))
535 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
536 if (!EQ (field, after_field))
537 at_field_end = 1;
538 if (!EQ (field, before_field))
539 at_field_start = 1;
540 if (NILP (field) && at_field_start && at_field_end)
541 /* If an inserted char would have a nil field while the surrounding
542 text is non-nil, we're probably not looking at a
543 zero-length field, but instead at a non-nil field that's
544 not intended for editing (such as comint's prompts). */
545 at_field_end = at_field_start = 0;
548 /* Note about special `boundary' fields:
550 Consider the case where the point (`.') is between the fields `x' and `y':
552 xxxx.yyyy
554 In this situation, if merge_at_boundary is true, we consider the
555 `x' and `y' fields as forming one big merged field, and so the end
556 of the field is the end of `y'.
558 However, if `x' and `y' are separated by a special `boundary' field
559 (a field with a `field' char-property of 'boundary), then we ignore
560 this special field when merging adjacent fields. Here's the same
561 situation, but with a `boundary' field between the `x' and `y' fields:
563 xxx.BBBByyyy
565 Here, if point is at the end of `x', the beginning of `y', or
566 anywhere in-between (within the `boundary' field), we merge all
567 three fields and consider the beginning as being the beginning of
568 the `x' field, and the end as being the end of the `y' field. */
570 if (beg)
572 if (at_field_start)
573 /* POS is at the edge of a field, and we should consider it as
574 the beginning of the following field. */
575 *beg = XFASTINT (pos);
576 else
577 /* Find the previous field boundary. */
579 Lisp_Object p = pos;
580 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
581 /* Skip a `boundary' field. */
582 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
583 beg_limit);
585 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
586 beg_limit);
587 *beg = NILP (p) ? BEGV : XFASTINT (p);
591 if (end)
593 if (at_field_end)
594 /* POS is at the edge of a field, and we should consider it as
595 the end of the previous field. */
596 *end = XFASTINT (pos);
597 else
598 /* Find the next field boundary. */
600 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
601 /* Skip a `boundary' field. */
602 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
603 end_limit);
605 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
606 end_limit);
607 *end = NILP (pos) ? ZV : XFASTINT (pos);
613 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
614 doc: /* Delete the field surrounding POS.
615 A field is a region of text with the same `field' property.
616 If POS is nil, the value of point is used for POS. */)
617 (Lisp_Object pos)
619 EMACS_INT beg, end;
620 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
621 if (beg != end)
622 del_range (beg, end);
623 return Qnil;
626 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
627 doc: /* Return the contents of the field surrounding POS as a string.
628 A field is a region of text with the same `field' property.
629 If POS is nil, the value of point is used for POS. */)
630 (Lisp_Object pos)
632 EMACS_INT beg, end;
633 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
634 return make_buffer_string (beg, end, 1);
637 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
638 doc: /* Return the contents of the field around POS, without text properties.
639 A field is a region of text with the same `field' property.
640 If POS is nil, the value of point is used for POS. */)
641 (Lisp_Object pos)
643 EMACS_INT beg, end;
644 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
645 return make_buffer_string (beg, end, 0);
648 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
649 doc: /* Return the beginning of the field surrounding POS.
650 A field is a region of text with the same `field' property.
651 If POS is nil, the value of point is used for POS.
652 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
653 field, then the beginning of the *previous* field is returned.
654 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
655 is before LIMIT, then LIMIT will be returned instead. */)
656 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
658 EMACS_INT beg;
659 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
660 return make_number (beg);
663 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
664 doc: /* Return the end of the field surrounding POS.
665 A field is a region of text with the same `field' property.
666 If POS is nil, the value of point is used for POS.
667 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
668 then the end of the *following* field is returned.
669 If LIMIT is non-nil, it is a buffer position; if the end of the field
670 is after LIMIT, then LIMIT will be returned instead. */)
671 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
673 EMACS_INT end;
674 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
675 return make_number (end);
678 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
679 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
681 A field is a region of text with the same `field' property.
682 If NEW-POS is nil, then the current point is used instead, and set to the
683 constrained position if that is different.
685 If OLD-POS is at the boundary of two fields, then the allowable
686 positions for NEW-POS depends on the value of the optional argument
687 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
688 constrained to the field that has the same `field' char-property
689 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
690 is non-nil, NEW-POS is constrained to the union of the two adjacent
691 fields. Additionally, if two fields are separated by another field with
692 the special value `boundary', then any point within this special field is
693 also considered to be `on the boundary'.
695 If the optional argument ONLY-IN-LINE is non-nil and constraining
696 NEW-POS would move it to a different line, NEW-POS is returned
697 unconstrained. This useful for commands that move by line, like
698 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
699 only in the case where they can still move to the right line.
701 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
702 a non-nil property of that name, then any field boundaries are ignored.
704 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
705 (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
707 /* If non-zero, then the original point, before re-positioning. */
708 EMACS_INT orig_point = 0;
709 int fwd;
710 Lisp_Object prev_old, prev_new;
712 if (NILP (new_pos))
713 /* Use the current point, and afterwards, set it. */
715 orig_point = PT;
716 XSETFASTINT (new_pos, PT);
719 CHECK_NUMBER_COERCE_MARKER (new_pos);
720 CHECK_NUMBER_COERCE_MARKER (old_pos);
722 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
724 prev_old = make_number (XFASTINT (old_pos) - 1);
725 prev_new = make_number (XFASTINT (new_pos) - 1);
727 if (NILP (Vinhibit_field_text_motion)
728 && !EQ (new_pos, old_pos)
729 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
730 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
731 /* To recognize field boundaries, we must also look at the
732 previous positions; we could use `get_pos_property'
733 instead, but in itself that would fail inside non-sticky
734 fields (like comint prompts). */
735 || (XFASTINT (new_pos) > BEGV
736 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
737 || (XFASTINT (old_pos) > BEGV
738 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
739 && (NILP (inhibit_capture_property)
740 /* Field boundaries are again a problem; but now we must
741 decide the case exactly, so we need to call
742 `get_pos_property' as well. */
743 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
744 && (XFASTINT (old_pos) <= BEGV
745 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
746 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
747 /* It is possible that NEW_POS is not within the same field as
748 OLD_POS; try to move NEW_POS so that it is. */
750 int shortage;
751 Lisp_Object field_bound;
753 if (fwd)
754 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
755 else
756 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
758 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
759 other side of NEW_POS, which would mean that NEW_POS is
760 already acceptable, and it's not necessary to constrain it
761 to FIELD_BOUND. */
762 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
763 /* NEW_POS should be constrained, but only if either
764 ONLY_IN_LINE is nil (in which case any constraint is OK),
765 or NEW_POS and FIELD_BOUND are on the same line (in which
766 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
767 && (NILP (only_in_line)
768 /* This is the ONLY_IN_LINE case, check that NEW_POS and
769 FIELD_BOUND are on the same line by seeing whether
770 there's an intervening newline or not. */
771 || (scan_buffer ('\n',
772 XFASTINT (new_pos), XFASTINT (field_bound),
773 fwd ? -1 : 1, &shortage, 1),
774 shortage != 0)))
775 /* Constrain NEW_POS to FIELD_BOUND. */
776 new_pos = field_bound;
778 if (orig_point && XFASTINT (new_pos) != orig_point)
779 /* The NEW_POS argument was originally nil, so automatically set PT. */
780 SET_PT (XFASTINT (new_pos));
783 return new_pos;
787 DEFUN ("line-beginning-position",
788 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
789 doc: /* Return the character position of the first character on the current line.
790 With argument N not nil or 1, move forward N - 1 lines first.
791 If scan reaches end of buffer, return that position.
793 The returned position is of the first character in the logical order,
794 i.e. the one that has the smallest character position.
796 This function constrains the returned position to the current field
797 unless that would be on a different line than the original,
798 unconstrained result. If N is nil or 1, and a front-sticky field
799 starts at point, the scan stops as soon as it starts. To ignore field
800 boundaries bind `inhibit-field-text-motion' to t.
802 This function does not move point. */)
803 (Lisp_Object n)
805 EMACS_INT orig, orig_byte, end;
806 int count = SPECPDL_INDEX ();
807 specbind (Qinhibit_point_motion_hooks, Qt);
809 if (NILP (n))
810 XSETFASTINT (n, 1);
811 else
812 CHECK_NUMBER (n);
814 orig = PT;
815 orig_byte = PT_BYTE;
816 Fforward_line (make_number (XINT (n) - 1));
817 end = PT;
819 SET_PT_BOTH (orig, orig_byte);
821 unbind_to (count, Qnil);
823 /* Return END constrained to the current input field. */
824 return Fconstrain_to_field (make_number (end), make_number (orig),
825 XINT (n) != 1 ? Qt : Qnil,
826 Qt, Qnil);
829 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
830 doc: /* Return the character position of the last character on the current line.
831 With argument N not nil or 1, move forward N - 1 lines first.
832 If scan reaches end of buffer, return that position.
834 The returned position is of the last character in the logical order,
835 i.e. the character whose buffer position is the largest one.
837 This function constrains the returned position to the current field
838 unless that would be on a different line than the original,
839 unconstrained result. If N is nil or 1, and a rear-sticky field ends
840 at point, the scan stops as soon as it starts. To ignore field
841 boundaries bind `inhibit-field-text-motion' to t.
843 This function does not move point. */)
844 (Lisp_Object n)
846 EMACS_INT end_pos;
847 EMACS_INT orig = PT;
849 if (NILP (n))
850 XSETFASTINT (n, 1);
851 else
852 CHECK_NUMBER (n);
854 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
856 /* Return END_POS constrained to the current input field. */
857 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
858 Qnil, Qt, Qnil);
862 Lisp_Object
863 save_excursion_save (void)
865 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
866 == current_buffer);
868 return Fcons (Fpoint_marker (),
869 Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
870 Fcons (visible ? Qt : Qnil,
871 Fcons (BVAR (current_buffer, mark_active),
872 selected_window))));
875 Lisp_Object
876 save_excursion_restore (Lisp_Object info)
878 Lisp_Object tem, tem1, omark, nmark;
879 struct gcpro gcpro1, gcpro2, gcpro3;
880 int visible_p;
882 tem = Fmarker_buffer (XCAR (info));
883 /* If buffer being returned to is now deleted, avoid error */
884 /* Otherwise could get error here while unwinding to top level
885 and crash */
886 /* In that case, Fmarker_buffer returns nil now. */
887 if (NILP (tem))
888 return Qnil;
890 omark = nmark = Qnil;
891 GCPRO3 (info, omark, nmark);
893 Fset_buffer (tem);
895 /* Point marker. */
896 tem = XCAR (info);
897 Fgoto_char (tem);
898 unchain_marker (XMARKER (tem));
900 /* Mark marker. */
901 info = XCDR (info);
902 tem = XCAR (info);
903 omark = Fmarker_position (BVAR (current_buffer, mark));
904 Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
905 nmark = Fmarker_position (tem);
906 unchain_marker (XMARKER (tem));
908 /* visible */
909 info = XCDR (info);
910 visible_p = !NILP (XCAR (info));
912 #if 0 /* We used to make the current buffer visible in the selected window
913 if that was true previously. That avoids some anomalies.
914 But it creates others, and it wasn't documented, and it is simpler
915 and cleaner never to alter the window/buffer connections. */
916 tem1 = Fcar (tem);
917 if (!NILP (tem1)
918 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
919 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
920 #endif /* 0 */
922 /* Mark active */
923 info = XCDR (info);
924 tem = XCAR (info);
925 tem1 = BVAR (current_buffer, mark_active);
926 BVAR (current_buffer, mark_active) = tem;
928 if (!NILP (Vrun_hooks))
930 /* If mark is active now, and either was not active
931 or was at a different place, run the activate hook. */
932 if (! NILP (BVAR (current_buffer, mark_active)))
934 if (! EQ (omark, nmark))
935 call1 (Vrun_hooks, intern ("activate-mark-hook"));
937 /* If mark has ceased to be active, run deactivate hook. */
938 else if (! NILP (tem1))
939 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
942 /* If buffer was visible in a window, and a different window was
943 selected, and the old selected window is still showing this
944 buffer, restore point in that window. */
945 tem = XCDR (info);
946 if (visible_p
947 && !EQ (tem, selected_window)
948 && (tem1 = XWINDOW (tem)->buffer,
949 (/* Window is live... */
950 BUFFERP (tem1)
951 /* ...and it shows the current buffer. */
952 && XBUFFER (tem1) == current_buffer)))
953 Fset_window_point (tem, make_number (PT));
955 UNGCPRO;
956 return Qnil;
959 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
960 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
961 Executes BODY just like `progn'.
962 The values of point, mark and the current buffer are restored
963 even in case of abnormal exit (throw or error).
964 The state of activation of the mark is also restored.
966 This construct does not save `deactivate-mark', and therefore
967 functions that change the buffer will still cause deactivation
968 of the mark at the end of the command. To prevent that, bind
969 `deactivate-mark' with `let'.
971 If you only want to save the current buffer but not point nor mark,
972 then just use `save-current-buffer', or even `with-current-buffer'.
974 usage: (save-excursion &rest BODY) */)
975 (Lisp_Object args)
977 register Lisp_Object val;
978 int count = SPECPDL_INDEX ();
980 record_unwind_protect (save_excursion_restore, save_excursion_save ());
982 val = Fprogn (args);
983 return unbind_to (count, val);
986 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
987 doc: /* Save the current buffer; execute BODY; restore the current buffer.
988 Executes BODY just like `progn'.
989 usage: (save-current-buffer &rest BODY) */)
990 (Lisp_Object args)
992 Lisp_Object val;
993 int count = SPECPDL_INDEX ();
995 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
997 val = Fprogn (args);
998 return unbind_to (count, val);
1001 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1002 doc: /* Return the number of characters in the current buffer.
1003 If BUFFER, return the number of characters in that buffer instead. */)
1004 (Lisp_Object buffer)
1006 if (NILP (buffer))
1007 return make_number (Z - BEG);
1008 else
1010 CHECK_BUFFER (buffer);
1011 return make_number (BUF_Z (XBUFFER (buffer))
1012 - BUF_BEG (XBUFFER (buffer)));
1016 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1017 doc: /* Return the minimum permissible value of point in the current buffer.
1018 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1019 (void)
1021 Lisp_Object temp;
1022 XSETFASTINT (temp, BEGV);
1023 return temp;
1026 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1027 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1028 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1029 (void)
1031 return buildmark (BEGV, BEGV_BYTE);
1034 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1035 doc: /* Return the maximum permissible value of point in the current buffer.
1036 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1037 is in effect, in which case it is less. */)
1038 (void)
1040 Lisp_Object temp;
1041 XSETFASTINT (temp, ZV);
1042 return temp;
1045 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1046 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1047 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1048 is in effect, in which case it is less. */)
1049 (void)
1051 return buildmark (ZV, ZV_BYTE);
1054 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1055 doc: /* Return the position of the gap, in the current buffer.
1056 See also `gap-size'. */)
1057 (void)
1059 Lisp_Object temp;
1060 XSETFASTINT (temp, GPT);
1061 return temp;
1064 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1065 doc: /* Return the size of the current buffer's gap.
1066 See also `gap-position'. */)
1067 (void)
1069 Lisp_Object temp;
1070 XSETFASTINT (temp, GAP_SIZE);
1071 return temp;
1074 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1075 doc: /* Return the byte position for character position POSITION.
1076 If POSITION is out of range, the value is nil. */)
1077 (Lisp_Object position)
1079 CHECK_NUMBER_COERCE_MARKER (position);
1080 if (XINT (position) < BEG || XINT (position) > Z)
1081 return Qnil;
1082 return make_number (CHAR_TO_BYTE (XINT (position)));
1085 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1086 doc: /* Return the character position for byte position BYTEPOS.
1087 If BYTEPOS is out of range, the value is nil. */)
1088 (Lisp_Object bytepos)
1090 CHECK_NUMBER (bytepos);
1091 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1092 return Qnil;
1093 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1096 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1097 doc: /* Return the character following point, as a number.
1098 At the end of the buffer or accessible region, return 0. */)
1099 (void)
1101 Lisp_Object temp;
1102 if (PT >= ZV)
1103 XSETFASTINT (temp, 0);
1104 else
1105 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1106 return temp;
1109 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1110 doc: /* Return the character preceding point, as a number.
1111 At the beginning of the buffer or accessible region, return 0. */)
1112 (void)
1114 Lisp_Object temp;
1115 if (PT <= BEGV)
1116 XSETFASTINT (temp, 0);
1117 else if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
1119 EMACS_INT pos = PT_BYTE;
1120 DEC_POS (pos);
1121 XSETFASTINT (temp, FETCH_CHAR (pos));
1123 else
1124 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1125 return temp;
1128 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1129 doc: /* Return t if point is at the beginning of the buffer.
1130 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1131 (void)
1133 if (PT == BEGV)
1134 return Qt;
1135 return Qnil;
1138 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1139 doc: /* Return t if point is at the end of the buffer.
1140 If the buffer is narrowed, this means the end of the narrowed part. */)
1141 (void)
1143 if (PT == ZV)
1144 return Qt;
1145 return Qnil;
1148 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1149 doc: /* Return t if point is at the beginning of a line. */)
1150 (void)
1152 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1153 return Qt;
1154 return Qnil;
1157 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1158 doc: /* Return t if point is at the end of a line.
1159 `End of a line' includes point being at the end of the buffer. */)
1160 (void)
1162 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1163 return Qt;
1164 return Qnil;
1167 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1168 doc: /* Return character in current buffer at position POS.
1169 POS is an integer or a marker and defaults to point.
1170 If POS is out of range, the value is nil. */)
1171 (Lisp_Object pos)
1173 register EMACS_INT pos_byte;
1175 if (NILP (pos))
1177 pos_byte = PT_BYTE;
1178 XSETFASTINT (pos, PT);
1181 if (MARKERP (pos))
1183 pos_byte = marker_byte_position (pos);
1184 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1185 return Qnil;
1187 else
1189 CHECK_NUMBER_COERCE_MARKER (pos);
1190 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1191 return Qnil;
1193 pos_byte = CHAR_TO_BYTE (XINT (pos));
1196 return make_number (FETCH_CHAR (pos_byte));
1199 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1200 doc: /* Return character in current buffer preceding position POS.
1201 POS is an integer or a marker and defaults to point.
1202 If POS is out of range, the value is nil. */)
1203 (Lisp_Object pos)
1205 register Lisp_Object val;
1206 register EMACS_INT pos_byte;
1208 if (NILP (pos))
1210 pos_byte = PT_BYTE;
1211 XSETFASTINT (pos, PT);
1214 if (MARKERP (pos))
1216 pos_byte = marker_byte_position (pos);
1218 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1219 return Qnil;
1221 else
1223 CHECK_NUMBER_COERCE_MARKER (pos);
1225 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1226 return Qnil;
1228 pos_byte = CHAR_TO_BYTE (XINT (pos));
1231 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
1233 DEC_POS (pos_byte);
1234 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1236 else
1238 pos_byte--;
1239 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1241 return val;
1244 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1245 doc: /* Return the name under which the user logged in, as a string.
1246 This is based on the effective uid, not the real uid.
1247 Also, if the environment variables LOGNAME or USER are set,
1248 that determines the value of this function.
1250 If optional argument UID is an integer or a float, return the login name
1251 of the user with that uid, or nil if there is no such user. */)
1252 (Lisp_Object uid)
1254 struct passwd *pw;
1255 uid_t id;
1257 /* Set up the user name info if we didn't do it before.
1258 (That can happen if Emacs is dumpable
1259 but you decide to run `temacs -l loadup' and not dump. */
1260 if (INTEGERP (Vuser_login_name))
1261 init_editfns ();
1263 if (NILP (uid))
1264 return Vuser_login_name;
1266 id = (uid_t)XFLOATINT (uid);
1267 BLOCK_INPUT;
1268 pw = (struct passwd *) getpwuid (id);
1269 UNBLOCK_INPUT;
1270 return (pw ? build_string (pw->pw_name) : Qnil);
1273 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1274 0, 0, 0,
1275 doc: /* Return the name of the user's real uid, as a string.
1276 This ignores the environment variables LOGNAME and USER, so it differs from
1277 `user-login-name' when running under `su'. */)
1278 (void)
1280 /* Set up the user name info if we didn't do it before.
1281 (That can happen if Emacs is dumpable
1282 but you decide to run `temacs -l loadup' and not dump. */
1283 if (INTEGERP (Vuser_login_name))
1284 init_editfns ();
1285 return Vuser_real_login_name;
1288 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1289 doc: /* Return the effective uid of Emacs.
1290 Value is an integer or a float, depending on the value. */)
1291 (void)
1293 /* Assignment to EMACS_INT stops GCC whining about limited range of
1294 data type. */
1295 EMACS_INT euid = geteuid ();
1297 /* Make sure we don't produce a negative UID due to signed integer
1298 overflow. */
1299 if (euid < 0)
1300 return make_float ((double)geteuid ());
1301 return make_fixnum_or_float (euid);
1304 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1305 doc: /* Return the real uid of Emacs.
1306 Value is an integer or a float, depending on the value. */)
1307 (void)
1309 /* Assignment to EMACS_INT stops GCC whining about limited range of
1310 data type. */
1311 EMACS_INT uid = getuid ();
1313 /* Make sure we don't produce a negative UID due to signed integer
1314 overflow. */
1315 if (uid < 0)
1316 return make_float ((double)getuid ());
1317 return make_fixnum_or_float (uid);
1320 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1321 doc: /* Return the full name of the user logged in, as a string.
1322 If the full name corresponding to Emacs's userid is not known,
1323 return "unknown".
1325 If optional argument UID is an integer or float, return the full name
1326 of the user with that uid, or nil if there is no such user.
1327 If UID is a string, return the full name of the user with that login
1328 name, or nil if there is no such user. */)
1329 (Lisp_Object uid)
1331 struct passwd *pw;
1332 register char *p, *q;
1333 Lisp_Object full;
1335 if (NILP (uid))
1336 return Vuser_full_name;
1337 else if (NUMBERP (uid))
1339 BLOCK_INPUT;
1340 pw = (struct passwd *) getpwuid ((uid_t) XFLOATINT (uid));
1341 UNBLOCK_INPUT;
1343 else if (STRINGP (uid))
1345 BLOCK_INPUT;
1346 pw = (struct passwd *) getpwnam (SSDATA (uid));
1347 UNBLOCK_INPUT;
1349 else
1350 error ("Invalid UID specification");
1352 if (!pw)
1353 return Qnil;
1355 p = USER_FULL_NAME;
1356 /* Chop off everything after the first comma. */
1357 q = strchr (p, ',');
1358 full = make_string (p, q ? q - p : strlen (p));
1360 #ifdef AMPERSAND_FULL_NAME
1361 p = SSDATA (full);
1362 q = strchr (p, '&');
1363 /* Substitute the login name for the &, upcasing the first character. */
1364 if (q)
1366 register char *r;
1367 Lisp_Object login;
1369 login = Fuser_login_name (make_number (pw->pw_uid));
1370 r = (char *) alloca (strlen (p) + SCHARS (login) + 1);
1371 memcpy (r, p, q - p);
1372 r[q - p] = 0;
1373 strcat (r, SSDATA (login));
1374 r[q - p] = UPCASE ((unsigned char) r[q - p]);
1375 strcat (r, q + 1);
1376 full = build_string (r);
1378 #endif /* AMPERSAND_FULL_NAME */
1380 return full;
1383 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1384 doc: /* Return the host name of the machine you are running on, as a string. */)
1385 (void)
1387 return Vsystem_name;
1390 /* For the benefit of callers who don't want to include lisp.h */
1392 const char *
1393 get_system_name (void)
1395 if (STRINGP (Vsystem_name))
1396 return SSDATA (Vsystem_name);
1397 else
1398 return "";
1401 const char *
1402 get_operating_system_release (void)
1404 if (STRINGP (Voperating_system_release))
1405 return SSDATA (Voperating_system_release);
1406 else
1407 return "";
1410 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1411 doc: /* Return the process ID of Emacs, as an integer. */)
1412 (void)
1414 return make_number (getpid ());
1417 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1418 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1419 The time is returned as a list of three integers. The first has the
1420 most significant 16 bits of the seconds, while the second has the
1421 least significant 16 bits. The third integer gives the microsecond
1422 count.
1424 The microsecond count is zero on systems that do not provide
1425 resolution finer than a second. */)
1426 (void)
1428 EMACS_TIME t;
1430 EMACS_GET_TIME (t);
1431 return list3 (make_number ((EMACS_SECS (t) >> 16) & 0xffff),
1432 make_number ((EMACS_SECS (t) >> 0) & 0xffff),
1433 make_number (EMACS_USECS (t)));
1436 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1437 0, 0, 0,
1438 doc: /* Return the current run time used by Emacs.
1439 The time is returned as a list of three integers. The first has the
1440 most significant 16 bits of the seconds, while the second has the
1441 least significant 16 bits. The third integer gives the microsecond
1442 count.
1444 On systems that can't determine the run time, `get-internal-run-time'
1445 does the same thing as `current-time'. The microsecond count is zero
1446 on systems that do not provide resolution finer than a second. */)
1447 (void)
1449 #ifdef HAVE_GETRUSAGE
1450 struct rusage usage;
1451 int secs, usecs;
1453 if (getrusage (RUSAGE_SELF, &usage) < 0)
1454 /* This shouldn't happen. What action is appropriate? */
1455 xsignal0 (Qerror);
1457 /* Sum up user time and system time. */
1458 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1459 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1460 if (usecs >= 1000000)
1462 usecs -= 1000000;
1463 secs++;
1466 return list3 (make_number ((secs >> 16) & 0xffff),
1467 make_number ((secs >> 0) & 0xffff),
1468 make_number (usecs));
1469 #else /* ! HAVE_GETRUSAGE */
1470 #ifdef WINDOWSNT
1471 return w32_get_internal_run_time ();
1472 #else /* ! WINDOWSNT */
1473 return Fcurrent_time ();
1474 #endif /* WINDOWSNT */
1475 #endif /* HAVE_GETRUSAGE */
1480 lisp_time_argument (Lisp_Object specified_time, time_t *result, int *usec)
1482 if (NILP (specified_time))
1484 if (usec)
1486 EMACS_TIME t;
1488 EMACS_GET_TIME (t);
1489 *usec = EMACS_USECS (t);
1490 *result = EMACS_SECS (t);
1491 return 1;
1493 else
1494 return time (result) != -1;
1496 else
1498 Lisp_Object high, low;
1499 high = Fcar (specified_time);
1500 CHECK_NUMBER (high);
1501 low = Fcdr (specified_time);
1502 if (CONSP (low))
1504 if (usec)
1506 Lisp_Object usec_l = Fcdr (low);
1507 if (CONSP (usec_l))
1508 usec_l = Fcar (usec_l);
1509 if (NILP (usec_l))
1510 *usec = 0;
1511 else
1513 CHECK_NUMBER (usec_l);
1514 *usec = XINT (usec_l);
1517 low = Fcar (low);
1519 else if (usec)
1520 *usec = 0;
1521 CHECK_NUMBER (low);
1522 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1523 return *result >> 16 == XINT (high);
1527 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1528 doc: /* Return the current time, as a float number of seconds since the epoch.
1529 If SPECIFIED-TIME is given, it is the time to convert to float
1530 instead of the current time. The argument should have the form
1531 (HIGH LOW) or (HIGH LOW USEC). Thus, you can use times obtained from
1532 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1533 have the form (HIGH . LOW), but this is considered obsolete.
1535 WARNING: Since the result is floating point, it may not be exact.
1536 If precise time stamps are required, use either `current-time',
1537 or (if you need time as a string) `format-time-string'. */)
1538 (Lisp_Object specified_time)
1540 time_t sec;
1541 int usec;
1543 if (! lisp_time_argument (specified_time, &sec, &usec))
1544 error ("Invalid time specification");
1546 return make_float ((sec * 1e6 + usec) / 1e6);
1549 /* Write information into buffer S of size MAXSIZE, according to the
1550 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1551 Default to Universal Time if UT is nonzero, local time otherwise.
1552 Use NS as the number of nanoseconds in the %N directive.
1553 Return the number of bytes written, not including the terminating
1554 '\0'. If S is NULL, nothing will be written anywhere; so to
1555 determine how many bytes would be written, use NULL for S and
1556 ((size_t) -1) for MAXSIZE.
1558 This function behaves like nstrftime, except it allows null
1559 bytes in FORMAT and it does not support nanoseconds. */
1560 static size_t
1561 emacs_nmemftime (char *s, size_t maxsize, const char *format,
1562 size_t format_len, const struct tm *tp, int ut, int ns)
1564 size_t total = 0;
1566 /* Loop through all the null-terminated strings in the format
1567 argument. Normally there's just one null-terminated string, but
1568 there can be arbitrarily many, concatenated together, if the
1569 format contains '\0' bytes. nstrftime stops at the first
1570 '\0' byte so we must invoke it separately for each such string. */
1571 for (;;)
1573 size_t len;
1574 size_t result;
1576 if (s)
1577 s[0] = '\1';
1579 result = nstrftime (s, maxsize, format, tp, ut, ns);
1581 if (s)
1583 if (result == 0 && s[0] != '\0')
1584 return 0;
1585 s += result + 1;
1588 maxsize -= result + 1;
1589 total += result;
1590 len = strlen (format);
1591 if (len == format_len)
1592 return total;
1593 total++;
1594 format += len + 1;
1595 format_len -= len + 1;
1599 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1600 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1601 TIME is specified as (HIGH LOW . IGNORED), as returned by
1602 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1603 is also still accepted.
1604 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1605 as Universal Time; nil means describe TIME in the local time zone.
1606 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1607 by text that describes the specified date and time in TIME:
1609 %Y is the year, %y within the century, %C the century.
1610 %G is the year corresponding to the ISO week, %g within the century.
1611 %m is the numeric month.
1612 %b and %h are the locale's abbreviated month name, %B the full name.
1613 %d is the day of the month, zero-padded, %e is blank-padded.
1614 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1615 %a is the locale's abbreviated name of the day of week, %A the full name.
1616 %U is the week number starting on Sunday, %W starting on Monday,
1617 %V according to ISO 8601.
1618 %j is the day of the year.
1620 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1621 only blank-padded, %l is like %I blank-padded.
1622 %p is the locale's equivalent of either AM or PM.
1623 %M is the minute.
1624 %S is the second.
1625 %N is the nanosecond, %6N the microsecond, %3N the millisecond, etc.
1626 %Z is the time zone name, %z is the numeric form.
1627 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1629 %c is the locale's date and time format.
1630 %x is the locale's "preferred" date format.
1631 %D is like "%m/%d/%y".
1633 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1634 %X is the locale's "preferred" time format.
1636 Finally, %n is a newline, %t is a tab, %% is a literal %.
1638 Certain flags and modifiers are available with some format controls.
1639 The flags are `_', `-', `^' and `#'. For certain characters X,
1640 %_X is like %X, but padded with blanks; %-X is like %X,
1641 but without padding. %^X is like %X, but with all textual
1642 characters up-cased; %#X is like %X, but with letter-case of
1643 all textual characters reversed.
1644 %NX (where N stands for an integer) is like %X,
1645 but takes up at least N (a number) positions.
1646 The modifiers are `E' and `O'. For certain characters X,
1647 %EX is a locale's alternative version of %X;
1648 %OX is like %X, but uses the locale's number symbols.
1650 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1651 (Lisp_Object format_string, Lisp_Object time, Lisp_Object universal)
1653 time_t value;
1654 int size;
1655 int usec;
1656 int ns;
1657 struct tm *tm;
1658 int ut = ! NILP (universal);
1660 CHECK_STRING (format_string);
1662 if (! (lisp_time_argument (time, &value, &usec)
1663 && 0 <= usec && usec < 1000000))
1664 error ("Invalid time specification");
1665 ns = usec * 1000;
1667 format_string = code_convert_string_norecord (format_string,
1668 Vlocale_coding_system, 1);
1670 /* This is probably enough. */
1671 size = SBYTES (format_string) * 6 + 50;
1673 BLOCK_INPUT;
1674 tm = ut ? gmtime (&value) : localtime (&value);
1675 UNBLOCK_INPUT;
1676 if (! tm)
1677 error ("Specified time is not representable");
1679 synchronize_system_time_locale ();
1681 while (1)
1683 char *buf = (char *) alloca (size + 1);
1684 int result;
1686 buf[0] = '\1';
1687 BLOCK_INPUT;
1688 result = emacs_nmemftime (buf, size, SSDATA (format_string),
1689 SBYTES (format_string),
1690 tm, ut, ns);
1691 UNBLOCK_INPUT;
1692 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1693 return code_convert_string_norecord (make_unibyte_string (buf, result),
1694 Vlocale_coding_system, 0);
1696 /* If buffer was too small, make it bigger and try again. */
1697 BLOCK_INPUT;
1698 result = emacs_nmemftime (NULL, (size_t) -1,
1699 SSDATA (format_string),
1700 SBYTES (format_string),
1701 tm, ut, ns);
1702 UNBLOCK_INPUT;
1703 size = result + 1;
1707 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1708 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1709 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1710 as from `current-time' and `file-attributes', or nil to use the
1711 current time. The obsolete form (HIGH . LOW) is also still accepted.
1712 The list has the following nine members: SEC is an integer between 0
1713 and 60; SEC is 60 for a leap second, which only some operating systems
1714 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1715 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1716 integer between 1 and 12. YEAR is an integer indicating the
1717 four-digit year. DOW is the day of week, an integer between 0 and 6,
1718 where 0 is Sunday. DST is t if daylight saving time is in effect,
1719 otherwise nil. ZONE is an integer indicating the number of seconds
1720 east of Greenwich. (Note that Common Lisp has different meanings for
1721 DOW and ZONE.) */)
1722 (Lisp_Object specified_time)
1724 time_t time_spec;
1725 struct tm save_tm;
1726 struct tm *decoded_time;
1727 Lisp_Object list_args[9];
1729 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1730 error ("Invalid time specification");
1732 BLOCK_INPUT;
1733 decoded_time = localtime (&time_spec);
1734 UNBLOCK_INPUT;
1735 if (! decoded_time)
1736 error ("Specified time is not representable");
1737 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1738 XSETFASTINT (list_args[1], decoded_time->tm_min);
1739 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1740 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1741 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1742 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1743 cast below avoids overflow in int arithmetics. */
1744 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) decoded_time->tm_year);
1745 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1746 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1748 /* Make a copy, in case gmtime modifies the struct. */
1749 save_tm = *decoded_time;
1750 BLOCK_INPUT;
1751 decoded_time = gmtime (&time_spec);
1752 UNBLOCK_INPUT;
1753 if (decoded_time == 0)
1754 list_args[8] = Qnil;
1755 else
1756 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1757 return Flist (9, list_args);
1760 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1761 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1762 This is the reverse operation of `decode-time', which see.
1763 ZONE defaults to the current time zone rule. This can
1764 be a string or t (as from `set-time-zone-rule'), or it can be a list
1765 \(as from `current-time-zone') or an integer (as from `decode-time')
1766 applied without consideration for daylight saving time.
1768 You can pass more than 7 arguments; then the first six arguments
1769 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1770 The intervening arguments are ignored.
1771 This feature lets (apply 'encode-time (decode-time ...)) work.
1773 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1774 for example, a DAY of 0 means the day preceding the given month.
1775 Year numbers less than 100 are treated just like other year numbers.
1776 If you want them to stand for years in this century, you must do that yourself.
1778 Years before 1970 are not guaranteed to work. On some systems,
1779 year values as low as 1901 do work.
1781 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1782 (int nargs, register Lisp_Object *args)
1784 time_t time;
1785 struct tm tm;
1786 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1788 CHECK_NUMBER (args[0]); /* second */
1789 CHECK_NUMBER (args[1]); /* minute */
1790 CHECK_NUMBER (args[2]); /* hour */
1791 CHECK_NUMBER (args[3]); /* day */
1792 CHECK_NUMBER (args[4]); /* month */
1793 CHECK_NUMBER (args[5]); /* year */
1795 tm.tm_sec = XINT (args[0]);
1796 tm.tm_min = XINT (args[1]);
1797 tm.tm_hour = XINT (args[2]);
1798 tm.tm_mday = XINT (args[3]);
1799 tm.tm_mon = XINT (args[4]) - 1;
1800 tm.tm_year = XINT (args[5]) - TM_YEAR_BASE;
1801 tm.tm_isdst = -1;
1803 if (CONSP (zone))
1804 zone = Fcar (zone);
1805 if (NILP (zone))
1807 BLOCK_INPUT;
1808 time = mktime (&tm);
1809 UNBLOCK_INPUT;
1811 else
1813 char tzbuf[100];
1814 const char *tzstring;
1815 char **oldenv = environ, **newenv;
1817 if (EQ (zone, Qt))
1818 tzstring = "UTC0";
1819 else if (STRINGP (zone))
1820 tzstring = SSDATA (zone);
1821 else if (INTEGERP (zone))
1823 int abszone = eabs (XINT (zone));
1824 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1825 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1826 tzstring = tzbuf;
1828 else
1829 error ("Invalid time zone specification");
1831 /* Set TZ before calling mktime; merely adjusting mktime's returned
1832 value doesn't suffice, since that would mishandle leap seconds. */
1833 set_time_zone_rule (tzstring);
1835 BLOCK_INPUT;
1836 time = mktime (&tm);
1837 UNBLOCK_INPUT;
1839 /* Restore TZ to previous value. */
1840 newenv = environ;
1841 environ = oldenv;
1842 xfree (newenv);
1843 #ifdef LOCALTIME_CACHE
1844 tzset ();
1845 #endif
1848 if (time == (time_t) -1)
1849 error ("Specified time is not representable");
1851 return make_time (time);
1854 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1855 doc: /* Return the current local time, as a human-readable string.
1856 Programs can use this function to decode a time,
1857 since the number of columns in each field is fixed
1858 if the year is in the range 1000-9999.
1859 The format is `Sun Sep 16 01:03:52 1973'.
1860 However, see also the functions `decode-time' and `format-time-string'
1861 which provide a much more powerful and general facility.
1863 If SPECIFIED-TIME is given, it is a time to format instead of the
1864 current time. The argument should have the form (HIGH LOW . IGNORED).
1865 Thus, you can use times obtained from `current-time' and from
1866 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1867 but this is considered obsolete. */)
1868 (Lisp_Object specified_time)
1870 time_t value;
1871 struct tm *tm;
1872 register char *tem;
1874 if (! lisp_time_argument (specified_time, &value, NULL))
1875 error ("Invalid time specification");
1877 /* Convert to a string, checking for out-of-range time stamps.
1878 Don't use 'ctime', as that might dump core if VALUE is out of
1879 range. */
1880 BLOCK_INPUT;
1881 tm = localtime (&value);
1882 UNBLOCK_INPUT;
1883 if (! (tm && TM_YEAR_IN_ASCTIME_RANGE (tm->tm_year) && (tem = asctime (tm))))
1884 error ("Specified time is not representable");
1886 /* Remove the trailing newline. */
1887 tem[strlen (tem) - 1] = '\0';
1889 return build_string (tem);
1892 /* Yield A - B, measured in seconds.
1893 This function is copied from the GNU C Library. */
1894 static int
1895 tm_diff (struct tm *a, struct tm *b)
1897 /* Compute intervening leap days correctly even if year is negative.
1898 Take care to avoid int overflow in leap day calculations,
1899 but it's OK to assume that A and B are close to each other. */
1900 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1901 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1902 int a100 = a4 / 25 - (a4 % 25 < 0);
1903 int b100 = b4 / 25 - (b4 % 25 < 0);
1904 int a400 = a100 >> 2;
1905 int b400 = b100 >> 2;
1906 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1907 int years = a->tm_year - b->tm_year;
1908 int days = (365 * years + intervening_leap_days
1909 + (a->tm_yday - b->tm_yday));
1910 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1911 + (a->tm_min - b->tm_min))
1912 + (a->tm_sec - b->tm_sec));
1915 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1916 doc: /* Return the offset and name for the local time zone.
1917 This returns a list of the form (OFFSET NAME).
1918 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1919 A negative value means west of Greenwich.
1920 NAME is a string giving the name of the time zone.
1921 If SPECIFIED-TIME is given, the time zone offset is determined from it
1922 instead of using the current time. The argument should have the form
1923 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1924 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1925 have the form (HIGH . LOW), but this is considered obsolete.
1927 Some operating systems cannot provide all this information to Emacs;
1928 in this case, `current-time-zone' returns a list containing nil for
1929 the data it can't find. */)
1930 (Lisp_Object specified_time)
1932 time_t value;
1933 struct tm *t;
1934 struct tm gmt;
1936 if (!lisp_time_argument (specified_time, &value, NULL))
1937 t = NULL;
1938 else
1940 BLOCK_INPUT;
1941 t = gmtime (&value);
1942 if (t)
1944 gmt = *t;
1945 t = localtime (&value);
1947 UNBLOCK_INPUT;
1950 if (t)
1952 int offset = tm_diff (t, &gmt);
1953 char *s = 0;
1954 char buf[6];
1956 #ifdef HAVE_TM_ZONE
1957 if (t->tm_zone)
1958 s = (char *)t->tm_zone;
1959 #else /* not HAVE_TM_ZONE */
1960 #ifdef HAVE_TZNAME
1961 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1962 s = tzname[t->tm_isdst];
1963 #endif
1964 #endif /* not HAVE_TM_ZONE */
1966 if (!s)
1968 /* No local time zone name is available; use "+-NNNN" instead. */
1969 int am = (offset < 0 ? -offset : offset) / 60;
1970 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1971 s = buf;
1974 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
1976 else
1977 return Fmake_list (make_number (2), Qnil);
1980 /* This holds the value of `environ' produced by the previous
1981 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
1982 has never been called. */
1983 static char **environbuf;
1985 /* This holds the startup value of the TZ environment variable so it
1986 can be restored if the user calls set-time-zone-rule with a nil
1987 argument. */
1988 static char *initial_tz;
1990 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
1991 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
1992 If TZ is nil, use implementation-defined default time zone information.
1993 If TZ is t, use Universal Time. */)
1994 (Lisp_Object tz)
1996 const char *tzstring;
1998 /* When called for the first time, save the original TZ. */
1999 if (!environbuf)
2000 initial_tz = (char *) getenv ("TZ");
2002 if (NILP (tz))
2003 tzstring = initial_tz;
2004 else if (EQ (tz, Qt))
2005 tzstring = "UTC0";
2006 else
2008 CHECK_STRING (tz);
2009 tzstring = SSDATA (tz);
2012 set_time_zone_rule (tzstring);
2013 free (environbuf);
2014 environbuf = environ;
2016 return Qnil;
2019 #ifdef LOCALTIME_CACHE
2021 /* These two values are known to load tz files in buggy implementations,
2022 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2023 Their values shouldn't matter in non-buggy implementations.
2024 We don't use string literals for these strings,
2025 since if a string in the environment is in readonly
2026 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2027 See Sun bugs 1113095 and 1114114, ``Timezone routines
2028 improperly modify environment''. */
2030 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2031 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2033 #endif
2035 /* Set the local time zone rule to TZSTRING.
2036 This allocates memory into `environ', which it is the caller's
2037 responsibility to free. */
2039 void
2040 set_time_zone_rule (const char *tzstring)
2042 int envptrs;
2043 char **from, **to, **newenv;
2045 /* Make the ENVIRON vector longer with room for TZSTRING. */
2046 for (from = environ; *from; from++)
2047 continue;
2048 envptrs = from - environ + 2;
2049 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2050 + (tzstring ? strlen (tzstring) + 4 : 0));
2052 /* Add TZSTRING to the end of environ, as a value for TZ. */
2053 if (tzstring)
2055 char *t = (char *) (to + envptrs);
2056 strcpy (t, "TZ=");
2057 strcat (t, tzstring);
2058 *to++ = t;
2061 /* Copy the old environ vector elements into NEWENV,
2062 but don't copy the TZ variable.
2063 So we have only one definition of TZ, which came from TZSTRING. */
2064 for (from = environ; *from; from++)
2065 if (strncmp (*from, "TZ=", 3) != 0)
2066 *to++ = *from;
2067 *to = 0;
2069 environ = newenv;
2071 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2072 the TZ variable is stored. If we do not have a TZSTRING,
2073 TO points to the vector slot which has the terminating null. */
2075 #ifdef LOCALTIME_CACHE
2077 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2078 "US/Pacific" that loads a tz file, then changes to a value like
2079 "XXX0" that does not load a tz file, and then changes back to
2080 its original value, the last change is (incorrectly) ignored.
2081 Also, if TZ changes twice in succession to values that do
2082 not load a tz file, tzset can dump core (see Sun bug#1225179).
2083 The following code works around these bugs. */
2085 if (tzstring)
2087 /* Temporarily set TZ to a value that loads a tz file
2088 and that differs from tzstring. */
2089 char *tz = *newenv;
2090 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2091 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
2092 tzset ();
2093 *newenv = tz;
2095 else
2097 /* The implied tzstring is unknown, so temporarily set TZ to
2098 two different values that each load a tz file. */
2099 *to = set_time_zone_rule_tz1;
2100 to[1] = 0;
2101 tzset ();
2102 *to = set_time_zone_rule_tz2;
2103 tzset ();
2104 *to = 0;
2107 /* Now TZ has the desired value, and tzset can be invoked safely. */
2110 tzset ();
2111 #endif
2114 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2115 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2116 type of object is Lisp_String). INHERIT is passed to
2117 INSERT_FROM_STRING_FUNC as the last argument. */
2119 static void
2120 general_insert_function (void (*insert_func)
2121 (const char *, EMACS_INT),
2122 void (*insert_from_string_func)
2123 (Lisp_Object, EMACS_INT, EMACS_INT,
2124 EMACS_INT, EMACS_INT, int),
2125 int inherit, int nargs, Lisp_Object *args)
2127 register int argnum;
2128 register Lisp_Object val;
2130 for (argnum = 0; argnum < nargs; argnum++)
2132 val = args[argnum];
2133 if (CHARACTERP (val))
2135 unsigned char str[MAX_MULTIBYTE_LENGTH];
2136 int len;
2138 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
2139 len = CHAR_STRING (XFASTINT (val), str);
2140 else
2142 str[0] = (ASCII_CHAR_P (XINT (val))
2143 ? XINT (val)
2144 : multibyte_char_to_unibyte (XINT (val), Qnil));
2145 len = 1;
2147 (*insert_func) ((char *) str, len);
2149 else if (STRINGP (val))
2151 (*insert_from_string_func) (val, 0, 0,
2152 SCHARS (val),
2153 SBYTES (val),
2154 inherit);
2156 else
2157 wrong_type_argument (Qchar_or_string_p, val);
2161 void
2162 insert1 (Lisp_Object arg)
2164 Finsert (1, &arg);
2168 /* Callers passing one argument to Finsert need not gcpro the
2169 argument "array", since the only element of the array will
2170 not be used after calling insert or insert_from_string, so
2171 we don't care if it gets trashed. */
2173 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2174 doc: /* Insert the arguments, either strings or characters, at point.
2175 Point and before-insertion markers move forward to end up
2176 after the inserted text.
2177 Any other markers at the point of insertion remain before the text.
2179 If the current buffer is multibyte, unibyte strings are converted
2180 to multibyte for insertion (see `string-make-multibyte').
2181 If the current buffer is unibyte, multibyte strings are converted
2182 to unibyte for insertion (see `string-make-unibyte').
2184 When operating on binary data, it may be necessary to preserve the
2185 original bytes of a unibyte string when inserting it into a multibyte
2186 buffer; to accomplish this, apply `string-as-multibyte' to the string
2187 and insert the result.
2189 usage: (insert &rest ARGS) */)
2190 (int nargs, register Lisp_Object *args)
2192 general_insert_function (insert, insert_from_string, 0, nargs, args);
2193 return Qnil;
2196 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2197 0, MANY, 0,
2198 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2199 Point and before-insertion markers move forward to end up
2200 after the inserted text.
2201 Any other markers at the point of insertion remain before the text.
2203 If the current buffer is multibyte, unibyte strings are converted
2204 to multibyte for insertion (see `unibyte-char-to-multibyte').
2205 If the current buffer is unibyte, multibyte strings are converted
2206 to unibyte for insertion.
2208 usage: (insert-and-inherit &rest ARGS) */)
2209 (int nargs, register Lisp_Object *args)
2211 general_insert_function (insert_and_inherit, insert_from_string, 1,
2212 nargs, args);
2213 return Qnil;
2216 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2217 doc: /* Insert strings or characters at point, relocating markers after the text.
2218 Point and markers move forward to end up after the inserted text.
2220 If the current buffer is multibyte, unibyte strings are converted
2221 to multibyte for insertion (see `unibyte-char-to-multibyte').
2222 If the current buffer is unibyte, multibyte strings are converted
2223 to unibyte for insertion.
2225 usage: (insert-before-markers &rest ARGS) */)
2226 (int nargs, register Lisp_Object *args)
2228 general_insert_function (insert_before_markers,
2229 insert_from_string_before_markers, 0,
2230 nargs, args);
2231 return Qnil;
2234 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2235 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2236 doc: /* Insert text at point, relocating markers and inheriting properties.
2237 Point and markers move forward to end up after the inserted text.
2239 If the current buffer is multibyte, unibyte strings are converted
2240 to multibyte for insertion (see `unibyte-char-to-multibyte').
2241 If the current buffer is unibyte, multibyte strings are converted
2242 to unibyte for insertion.
2244 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2245 (int nargs, register Lisp_Object *args)
2247 general_insert_function (insert_before_markers_and_inherit,
2248 insert_from_string_before_markers, 1,
2249 nargs, args);
2250 return Qnil;
2253 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2254 doc: /* Insert COUNT copies of CHARACTER.
2255 Point, and before-insertion markers, are relocated as in the function `insert'.
2256 The optional third arg INHERIT, if non-nil, says to inherit text properties
2257 from adjoining text, if those properties are sticky. */)
2258 (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
2260 register char *string;
2261 register EMACS_INT strlen;
2262 register int i;
2263 register EMACS_INT n;
2264 int len;
2265 unsigned char str[MAX_MULTIBYTE_LENGTH];
2267 CHECK_NUMBER (character);
2268 CHECK_NUMBER (count);
2270 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
2271 len = CHAR_STRING (XFASTINT (character), str);
2272 else
2273 str[0] = XFASTINT (character), len = 1;
2274 if (MOST_POSITIVE_FIXNUM / len < XINT (count))
2275 error ("Maximum buffer size would be exceeded");
2276 n = XINT (count) * len;
2277 if (n <= 0)
2278 return Qnil;
2279 strlen = min (n, 256 * len);
2280 string = (char *) alloca (strlen);
2281 for (i = 0; i < strlen; i++)
2282 string[i] = str[i % len];
2283 while (n >= strlen)
2285 QUIT;
2286 if (!NILP (inherit))
2287 insert_and_inherit (string, strlen);
2288 else
2289 insert (string, strlen);
2290 n -= strlen;
2292 if (n > 0)
2294 if (!NILP (inherit))
2295 insert_and_inherit (string, n);
2296 else
2297 insert (string, n);
2299 return Qnil;
2302 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2303 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2304 Both arguments are required.
2305 BYTE is a number of the range 0..255.
2307 If BYTE is 128..255 and the current buffer is multibyte, the
2308 corresponding eight-bit character is inserted.
2310 Point, and before-insertion markers, are relocated as in the function `insert'.
2311 The optional third arg INHERIT, if non-nil, says to inherit text properties
2312 from adjoining text, if those properties are sticky. */)
2313 (Lisp_Object byte, Lisp_Object count, Lisp_Object inherit)
2315 CHECK_NUMBER (byte);
2316 if (XINT (byte) < 0 || XINT (byte) > 255)
2317 args_out_of_range_3 (byte, make_number (0), make_number (255));
2318 if (XINT (byte) >= 128
2319 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2320 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2321 return Finsert_char (byte, count, inherit);
2325 /* Making strings from buffer contents. */
2327 /* Return a Lisp_String containing the text of the current buffer from
2328 START to END. If text properties are in use and the current buffer
2329 has properties in the range specified, the resulting string will also
2330 have them, if PROPS is nonzero.
2332 We don't want to use plain old make_string here, because it calls
2333 make_uninit_string, which can cause the buffer arena to be
2334 compacted. make_string has no way of knowing that the data has
2335 been moved, and thus copies the wrong data into the string. This
2336 doesn't effect most of the other users of make_string, so it should
2337 be left as is. But we should use this function when conjuring
2338 buffer substrings. */
2340 Lisp_Object
2341 make_buffer_string (EMACS_INT start, EMACS_INT end, int props)
2343 EMACS_INT start_byte = CHAR_TO_BYTE (start);
2344 EMACS_INT end_byte = CHAR_TO_BYTE (end);
2346 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2349 /* Return a Lisp_String containing the text of the current buffer from
2350 START / START_BYTE to END / END_BYTE.
2352 If text properties are in use and the current buffer
2353 has properties in the range specified, the resulting string will also
2354 have them, if PROPS is nonzero.
2356 We don't want to use plain old make_string here, because it calls
2357 make_uninit_string, which can cause the buffer arena to be
2358 compacted. make_string has no way of knowing that the data has
2359 been moved, and thus copies the wrong data into the string. This
2360 doesn't effect most of the other users of make_string, so it should
2361 be left as is. But we should use this function when conjuring
2362 buffer substrings. */
2364 Lisp_Object
2365 make_buffer_string_both (EMACS_INT start, EMACS_INT start_byte,
2366 EMACS_INT end, EMACS_INT end_byte, int props)
2368 Lisp_Object result, tem, tem1;
2370 if (start < GPT && GPT < end)
2371 move_gap (start);
2373 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2374 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2375 else
2376 result = make_uninit_string (end - start);
2377 memcpy (SDATA (result), BYTE_POS_ADDR (start_byte), end_byte - start_byte);
2379 /* If desired, update and copy the text properties. */
2380 if (props)
2382 update_buffer_properties (start, end);
2384 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2385 tem1 = Ftext_properties_at (make_number (start), Qnil);
2387 if (XINT (tem) != end || !NILP (tem1))
2388 copy_intervals_to_string (result, current_buffer, start,
2389 end - start);
2392 return result;
2395 /* Call Vbuffer_access_fontify_functions for the range START ... END
2396 in the current buffer, if necessary. */
2398 static void
2399 update_buffer_properties (EMACS_INT start, EMACS_INT end)
2401 /* If this buffer has some access functions,
2402 call them, specifying the range of the buffer being accessed. */
2403 if (!NILP (Vbuffer_access_fontify_functions))
2405 Lisp_Object args[3];
2406 Lisp_Object tem;
2408 args[0] = Qbuffer_access_fontify_functions;
2409 XSETINT (args[1], start);
2410 XSETINT (args[2], end);
2412 /* But don't call them if we can tell that the work
2413 has already been done. */
2414 if (!NILP (Vbuffer_access_fontified_property))
2416 tem = Ftext_property_any (args[1], args[2],
2417 Vbuffer_access_fontified_property,
2418 Qnil, Qnil);
2419 if (! NILP (tem))
2420 Frun_hook_with_args (3, args);
2422 else
2423 Frun_hook_with_args (3, args);
2427 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2428 doc: /* Return the contents of part of the current buffer as a string.
2429 The two arguments START and END are character positions;
2430 they can be in either order.
2431 The string returned is multibyte if the buffer is multibyte.
2433 This function copies the text properties of that part of the buffer
2434 into the result string; if you don't want the text properties,
2435 use `buffer-substring-no-properties' instead. */)
2436 (Lisp_Object start, Lisp_Object end)
2438 register EMACS_INT b, e;
2440 validate_region (&start, &end);
2441 b = XINT (start);
2442 e = XINT (end);
2444 return make_buffer_string (b, e, 1);
2447 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2448 Sbuffer_substring_no_properties, 2, 2, 0,
2449 doc: /* Return the characters of part of the buffer, without the text properties.
2450 The two arguments START and END are character positions;
2451 they can be in either order. */)
2452 (Lisp_Object start, Lisp_Object end)
2454 register EMACS_INT b, e;
2456 validate_region (&start, &end);
2457 b = XINT (start);
2458 e = XINT (end);
2460 return make_buffer_string (b, e, 0);
2463 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2464 doc: /* Return the contents of the current buffer as a string.
2465 If narrowing is in effect, this function returns only the visible part
2466 of the buffer. */)
2467 (void)
2469 return make_buffer_string (BEGV, ZV, 1);
2472 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2473 1, 3, 0,
2474 doc: /* Insert before point a substring of the contents of BUFFER.
2475 BUFFER may be a buffer or a buffer name.
2476 Arguments START and END are character positions specifying the substring.
2477 They default to the values of (point-min) and (point-max) in BUFFER. */)
2478 (Lisp_Object buffer, Lisp_Object start, Lisp_Object end)
2480 register EMACS_INT b, e, temp;
2481 register struct buffer *bp, *obuf;
2482 Lisp_Object buf;
2484 buf = Fget_buffer (buffer);
2485 if (NILP (buf))
2486 nsberror (buffer);
2487 bp = XBUFFER (buf);
2488 if (NILP (BVAR (bp, name)))
2489 error ("Selecting deleted buffer");
2491 if (NILP (start))
2492 b = BUF_BEGV (bp);
2493 else
2495 CHECK_NUMBER_COERCE_MARKER (start);
2496 b = XINT (start);
2498 if (NILP (end))
2499 e = BUF_ZV (bp);
2500 else
2502 CHECK_NUMBER_COERCE_MARKER (end);
2503 e = XINT (end);
2506 if (b > e)
2507 temp = b, b = e, e = temp;
2509 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2510 args_out_of_range (start, end);
2512 obuf = current_buffer;
2513 set_buffer_internal_1 (bp);
2514 update_buffer_properties (b, e);
2515 set_buffer_internal_1 (obuf);
2517 insert_from_buffer (bp, b, e - b, 0);
2518 return Qnil;
2521 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2522 6, 6, 0,
2523 doc: /* Compare two substrings of two buffers; return result as number.
2524 the value is -N if first string is less after N-1 chars,
2525 +N if first string is greater after N-1 chars, or 0 if strings match.
2526 Each substring is represented as three arguments: BUFFER, START and END.
2527 That makes six args in all, three for each substring.
2529 The value of `case-fold-search' in the current buffer
2530 determines whether case is significant or ignored. */)
2531 (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)
2533 register EMACS_INT begp1, endp1, begp2, endp2, temp;
2534 register struct buffer *bp1, *bp2;
2535 register Lisp_Object trt
2536 = (!NILP (BVAR (current_buffer, case_fold_search))
2537 ? BVAR (current_buffer, case_canon_table) : Qnil);
2538 EMACS_INT chars = 0;
2539 EMACS_INT i1, i2, i1_byte, i2_byte;
2541 /* Find the first buffer and its substring. */
2543 if (NILP (buffer1))
2544 bp1 = current_buffer;
2545 else
2547 Lisp_Object buf1;
2548 buf1 = Fget_buffer (buffer1);
2549 if (NILP (buf1))
2550 nsberror (buffer1);
2551 bp1 = XBUFFER (buf1);
2552 if (NILP (BVAR (bp1, name)))
2553 error ("Selecting deleted buffer");
2556 if (NILP (start1))
2557 begp1 = BUF_BEGV (bp1);
2558 else
2560 CHECK_NUMBER_COERCE_MARKER (start1);
2561 begp1 = XINT (start1);
2563 if (NILP (end1))
2564 endp1 = BUF_ZV (bp1);
2565 else
2567 CHECK_NUMBER_COERCE_MARKER (end1);
2568 endp1 = XINT (end1);
2571 if (begp1 > endp1)
2572 temp = begp1, begp1 = endp1, endp1 = temp;
2574 if (!(BUF_BEGV (bp1) <= begp1
2575 && begp1 <= endp1
2576 && endp1 <= BUF_ZV (bp1)))
2577 args_out_of_range (start1, end1);
2579 /* Likewise for second substring. */
2581 if (NILP (buffer2))
2582 bp2 = current_buffer;
2583 else
2585 Lisp_Object buf2;
2586 buf2 = Fget_buffer (buffer2);
2587 if (NILP (buf2))
2588 nsberror (buffer2);
2589 bp2 = XBUFFER (buf2);
2590 if (NILP (BVAR (bp2, name)))
2591 error ("Selecting deleted buffer");
2594 if (NILP (start2))
2595 begp2 = BUF_BEGV (bp2);
2596 else
2598 CHECK_NUMBER_COERCE_MARKER (start2);
2599 begp2 = XINT (start2);
2601 if (NILP (end2))
2602 endp2 = BUF_ZV (bp2);
2603 else
2605 CHECK_NUMBER_COERCE_MARKER (end2);
2606 endp2 = XINT (end2);
2609 if (begp2 > endp2)
2610 temp = begp2, begp2 = endp2, endp2 = temp;
2612 if (!(BUF_BEGV (bp2) <= begp2
2613 && begp2 <= endp2
2614 && endp2 <= BUF_ZV (bp2)))
2615 args_out_of_range (start2, end2);
2617 i1 = begp1;
2618 i2 = begp2;
2619 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2620 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2622 while (i1 < endp1 && i2 < endp2)
2624 /* When we find a mismatch, we must compare the
2625 characters, not just the bytes. */
2626 int c1, c2;
2628 QUIT;
2630 if (! NILP (BVAR (bp1, enable_multibyte_characters)))
2632 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2633 BUF_INC_POS (bp1, i1_byte);
2634 i1++;
2636 else
2638 c1 = BUF_FETCH_BYTE (bp1, i1);
2639 MAKE_CHAR_MULTIBYTE (c1);
2640 i1++;
2643 if (! NILP (BVAR (bp2, enable_multibyte_characters)))
2645 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2646 BUF_INC_POS (bp2, i2_byte);
2647 i2++;
2649 else
2651 c2 = BUF_FETCH_BYTE (bp2, i2);
2652 MAKE_CHAR_MULTIBYTE (c2);
2653 i2++;
2656 if (!NILP (trt))
2658 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2659 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
2661 if (c1 < c2)
2662 return make_number (- 1 - chars);
2663 if (c1 > c2)
2664 return make_number (chars + 1);
2666 chars++;
2669 /* The strings match as far as they go.
2670 If one is shorter, that one is less. */
2671 if (chars < endp1 - begp1)
2672 return make_number (chars + 1);
2673 else if (chars < endp2 - begp2)
2674 return make_number (- chars - 1);
2676 /* Same length too => they are equal. */
2677 return make_number (0);
2680 static Lisp_Object
2681 subst_char_in_region_unwind (Lisp_Object arg)
2683 return BVAR (current_buffer, undo_list) = arg;
2686 static Lisp_Object
2687 subst_char_in_region_unwind_1 (Lisp_Object arg)
2689 return BVAR (current_buffer, filename) = arg;
2692 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2693 Ssubst_char_in_region, 4, 5, 0,
2694 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2695 If optional arg NOUNDO is non-nil, don't record this change for undo
2696 and don't mark the buffer as really changed.
2697 Both characters must have the same length of multi-byte form. */)
2698 (Lisp_Object start, Lisp_Object end, Lisp_Object fromchar, Lisp_Object tochar, Lisp_Object noundo)
2700 register EMACS_INT pos, pos_byte, stop, i, len, end_byte;
2701 /* Keep track of the first change in the buffer:
2702 if 0 we haven't found it yet.
2703 if < 0 we've found it and we've run the before-change-function.
2704 if > 0 we've actually performed it and the value is its position. */
2705 EMACS_INT changed = 0;
2706 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2707 unsigned char *p;
2708 int count = SPECPDL_INDEX ();
2709 #define COMBINING_NO 0
2710 #define COMBINING_BEFORE 1
2711 #define COMBINING_AFTER 2
2712 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2713 int maybe_byte_combining = COMBINING_NO;
2714 EMACS_INT last_changed = 0;
2715 int multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2717 restart:
2719 validate_region (&start, &end);
2720 CHECK_NUMBER (fromchar);
2721 CHECK_NUMBER (tochar);
2723 if (multibyte_p)
2725 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2726 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2727 error ("Characters in `subst-char-in-region' have different byte-lengths");
2728 if (!ASCII_BYTE_P (*tostr))
2730 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2731 complete multibyte character, it may be combined with the
2732 after bytes. If it is in the range 0xA0..0xFF, it may be
2733 combined with the before and after bytes. */
2734 if (!CHAR_HEAD_P (*tostr))
2735 maybe_byte_combining = COMBINING_BOTH;
2736 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2737 maybe_byte_combining = COMBINING_AFTER;
2740 else
2742 len = 1;
2743 fromstr[0] = XFASTINT (fromchar);
2744 tostr[0] = XFASTINT (tochar);
2747 pos = XINT (start);
2748 pos_byte = CHAR_TO_BYTE (pos);
2749 stop = CHAR_TO_BYTE (XINT (end));
2750 end_byte = stop;
2752 /* If we don't want undo, turn off putting stuff on the list.
2753 That's faster than getting rid of things,
2754 and it prevents even the entry for a first change.
2755 Also inhibit locking the file. */
2756 if (!changed && !NILP (noundo))
2758 record_unwind_protect (subst_char_in_region_unwind,
2759 BVAR (current_buffer, undo_list));
2760 BVAR (current_buffer, undo_list) = Qt;
2761 /* Don't do file-locking. */
2762 record_unwind_protect (subst_char_in_region_unwind_1,
2763 BVAR (current_buffer, filename));
2764 BVAR (current_buffer, filename) = Qnil;
2767 if (pos_byte < GPT_BYTE)
2768 stop = min (stop, GPT_BYTE);
2769 while (1)
2771 EMACS_INT pos_byte_next = pos_byte;
2773 if (pos_byte >= stop)
2775 if (pos_byte >= end_byte) break;
2776 stop = end_byte;
2778 p = BYTE_POS_ADDR (pos_byte);
2779 if (multibyte_p)
2780 INC_POS (pos_byte_next);
2781 else
2782 ++pos_byte_next;
2783 if (pos_byte_next - pos_byte == len
2784 && p[0] == fromstr[0]
2785 && (len == 1
2786 || (p[1] == fromstr[1]
2787 && (len == 2 || (p[2] == fromstr[2]
2788 && (len == 3 || p[3] == fromstr[3]))))))
2790 if (changed < 0)
2791 /* We've already seen this and run the before-change-function;
2792 this time we only need to record the actual position. */
2793 changed = pos;
2794 else if (!changed)
2796 changed = -1;
2797 modify_region (current_buffer, pos, XINT (end), 0);
2799 if (! NILP (noundo))
2801 if (MODIFF - 1 == SAVE_MODIFF)
2802 SAVE_MODIFF++;
2803 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
2804 BUF_AUTOSAVE_MODIFF (current_buffer)++;
2807 /* The before-change-function may have moved the gap
2808 or even modified the buffer so we should start over. */
2809 goto restart;
2812 /* Take care of the case where the new character
2813 combines with neighboring bytes. */
2814 if (maybe_byte_combining
2815 && (maybe_byte_combining == COMBINING_AFTER
2816 ? (pos_byte_next < Z_BYTE
2817 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2818 : ((pos_byte_next < Z_BYTE
2819 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2820 || (pos_byte > BEG_BYTE
2821 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2823 Lisp_Object tem, string;
2825 struct gcpro gcpro1;
2827 tem = BVAR (current_buffer, undo_list);
2828 GCPRO1 (tem);
2830 /* Make a multibyte string containing this single character. */
2831 string = make_multibyte_string ((char *) tostr, 1, len);
2832 /* replace_range is less efficient, because it moves the gap,
2833 but it handles combining correctly. */
2834 replace_range (pos, pos + 1, string,
2835 0, 0, 1);
2836 pos_byte_next = CHAR_TO_BYTE (pos);
2837 if (pos_byte_next > pos_byte)
2838 /* Before combining happened. We should not increment
2839 POS. So, to cancel the later increment of POS,
2840 decrease it now. */
2841 pos--;
2842 else
2843 INC_POS (pos_byte_next);
2845 if (! NILP (noundo))
2846 BVAR (current_buffer, undo_list) = tem;
2848 UNGCPRO;
2850 else
2852 if (NILP (noundo))
2853 record_change (pos, 1);
2854 for (i = 0; i < len; i++) *p++ = tostr[i];
2856 last_changed = pos + 1;
2858 pos_byte = pos_byte_next;
2859 pos++;
2862 if (changed > 0)
2864 signal_after_change (changed,
2865 last_changed - changed, last_changed - changed);
2866 update_compositions (changed, last_changed, CHECK_ALL);
2869 unbind_to (count, Qnil);
2870 return Qnil;
2874 static Lisp_Object check_translation (EMACS_INT, EMACS_INT, EMACS_INT,
2875 Lisp_Object);
2877 /* Helper function for Ftranslate_region_internal.
2879 Check if a character sequence at POS (POS_BYTE) matches an element
2880 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2881 element is found, return it. Otherwise return Qnil. */
2883 static Lisp_Object
2884 check_translation (EMACS_INT pos, EMACS_INT pos_byte, EMACS_INT end,
2885 Lisp_Object val)
2887 int buf_size = 16, buf_used = 0;
2888 int *buf = alloca (sizeof (int) * buf_size);
2890 for (; CONSP (val); val = XCDR (val))
2892 Lisp_Object elt;
2893 EMACS_INT len, i;
2895 elt = XCAR (val);
2896 if (! CONSP (elt))
2897 continue;
2898 elt = XCAR (elt);
2899 if (! VECTORP (elt))
2900 continue;
2901 len = ASIZE (elt);
2902 if (len <= end - pos)
2904 for (i = 0; i < len; i++)
2906 if (buf_used <= i)
2908 unsigned char *p = BYTE_POS_ADDR (pos_byte);
2909 int len1;
2911 if (buf_used == buf_size)
2913 int *newbuf;
2915 buf_size += 16;
2916 newbuf = alloca (sizeof (int) * buf_size);
2917 memcpy (newbuf, buf, sizeof (int) * buf_used);
2918 buf = newbuf;
2920 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len1);
2921 pos_byte += len1;
2923 if (XINT (AREF (elt, i)) != buf[i])
2924 break;
2926 if (i == len)
2927 return XCAR (val);
2930 return Qnil;
2934 DEFUN ("translate-region-internal", Ftranslate_region_internal,
2935 Stranslate_region_internal, 3, 3, 0,
2936 doc: /* Internal use only.
2937 From START to END, translate characters according to TABLE.
2938 TABLE is a string or a char-table; the Nth character in it is the
2939 mapping for the character with code N.
2940 It returns the number of characters changed. */)
2941 (Lisp_Object start, Lisp_Object end, register Lisp_Object table)
2943 register unsigned char *tt; /* Trans table. */
2944 register int nc; /* New character. */
2945 int cnt; /* Number of changes made. */
2946 EMACS_INT size; /* Size of translate table. */
2947 EMACS_INT pos, pos_byte, end_pos;
2948 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2949 int string_multibyte;
2950 Lisp_Object val;
2952 validate_region (&start, &end);
2953 if (CHAR_TABLE_P (table))
2955 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
2956 error ("Not a translation table");
2957 size = MAX_CHAR;
2958 tt = NULL;
2960 else
2962 CHECK_STRING (table);
2964 if (! multibyte && (SCHARS (table) < SBYTES (table)))
2965 table = string_make_unibyte (table);
2966 string_multibyte = SCHARS (table) < SBYTES (table);
2967 size = SBYTES (table);
2968 tt = SDATA (table);
2971 pos = XINT (start);
2972 pos_byte = CHAR_TO_BYTE (pos);
2973 end_pos = XINT (end);
2974 modify_region (current_buffer, pos, end_pos, 0);
2976 cnt = 0;
2977 for (; pos < end_pos; )
2979 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
2980 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
2981 int len, str_len;
2982 int oc;
2983 Lisp_Object val;
2985 if (multibyte)
2986 oc = STRING_CHAR_AND_LENGTH (p, len);
2987 else
2988 oc = *p, len = 1;
2989 if (oc < size)
2991 if (tt)
2993 /* Reload as signal_after_change in last iteration may GC. */
2994 tt = SDATA (table);
2995 if (string_multibyte)
2997 str = tt + string_char_to_byte (table, oc);
2998 nc = STRING_CHAR_AND_LENGTH (str, str_len);
3000 else
3002 nc = tt[oc];
3003 if (! ASCII_BYTE_P (nc) && multibyte)
3005 str_len = BYTE8_STRING (nc, buf);
3006 str = buf;
3008 else
3010 str_len = 1;
3011 str = tt + oc;
3015 else
3017 EMACS_INT c;
3019 nc = oc;
3020 val = CHAR_TABLE_REF (table, oc);
3021 if (CHARACTERP (val)
3022 && (c = XINT (val), CHAR_VALID_P (c, 0)))
3024 nc = c;
3025 str_len = CHAR_STRING (nc, buf);
3026 str = buf;
3028 else if (VECTORP (val) || (CONSP (val)))
3030 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3031 where TO is TO-CHAR or [TO-CHAR ...]. */
3032 nc = -1;
3036 if (nc != oc && nc >= 0)
3038 /* Simple one char to one char translation. */
3039 if (len != str_len)
3041 Lisp_Object string;
3043 /* This is less efficient, because it moves the gap,
3044 but it should handle multibyte characters correctly. */
3045 string = make_multibyte_string ((char *) str, 1, str_len);
3046 replace_range (pos, pos + 1, string, 1, 0, 1);
3047 len = str_len;
3049 else
3051 record_change (pos, 1);
3052 while (str_len-- > 0)
3053 *p++ = *str++;
3054 signal_after_change (pos, 1, 1);
3055 update_compositions (pos, pos + 1, CHECK_BORDER);
3057 ++cnt;
3059 else if (nc < 0)
3061 Lisp_Object string;
3063 if (CONSP (val))
3065 val = check_translation (pos, pos_byte, end_pos, val);
3066 if (NILP (val))
3068 pos_byte += len;
3069 pos++;
3070 continue;
3072 /* VAL is ([FROM-CHAR ...] . TO). */
3073 len = ASIZE (XCAR (val));
3074 val = XCDR (val);
3076 else
3077 len = 1;
3079 if (VECTORP (val))
3081 string = Fconcat (1, &val);
3083 else
3085 string = Fmake_string (make_number (1), val);
3087 replace_range (pos, pos + len, string, 1, 0, 1);
3088 pos_byte += SBYTES (string);
3089 pos += SCHARS (string);
3090 cnt += SCHARS (string);
3091 end_pos += SCHARS (string) - len;
3092 continue;
3095 pos_byte += len;
3096 pos++;
3099 return make_number (cnt);
3102 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3103 doc: /* Delete the text between point and mark.
3105 When called from a program, expects two arguments,
3106 positions (integers or markers) specifying the stretch to be deleted. */)
3107 (Lisp_Object start, Lisp_Object end)
3109 validate_region (&start, &end);
3110 del_range (XINT (start), XINT (end));
3111 return Qnil;
3114 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3115 Sdelete_and_extract_region, 2, 2, 0,
3116 doc: /* Delete the text between START and END and return it. */)
3117 (Lisp_Object start, Lisp_Object end)
3119 validate_region (&start, &end);
3120 if (XINT (start) == XINT (end))
3121 return empty_unibyte_string;
3122 return del_range_1 (XINT (start), XINT (end), 1, 1);
3125 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3126 doc: /* Remove restrictions (narrowing) from current buffer.
3127 This allows the buffer's full text to be seen and edited. */)
3128 (void)
3130 if (BEG != BEGV || Z != ZV)
3131 current_buffer->clip_changed = 1;
3132 BEGV = BEG;
3133 BEGV_BYTE = BEG_BYTE;
3134 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3135 /* Changing the buffer bounds invalidates any recorded current column. */
3136 invalidate_current_column ();
3137 return Qnil;
3140 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3141 doc: /* Restrict editing in this buffer to the current region.
3142 The rest of the text becomes temporarily invisible and untouchable
3143 but is not deleted; if you save the buffer in a file, the invisible
3144 text is included in the file. \\[widen] makes all visible again.
3145 See also `save-restriction'.
3147 When calling from a program, pass two arguments; positions (integers
3148 or markers) bounding the text that should remain visible. */)
3149 (register Lisp_Object start, Lisp_Object end)
3151 CHECK_NUMBER_COERCE_MARKER (start);
3152 CHECK_NUMBER_COERCE_MARKER (end);
3154 if (XINT (start) > XINT (end))
3156 Lisp_Object tem;
3157 tem = start; start = end; end = tem;
3160 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3161 args_out_of_range (start, end);
3163 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3164 current_buffer->clip_changed = 1;
3166 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3167 SET_BUF_ZV (current_buffer, XFASTINT (end));
3168 if (PT < XFASTINT (start))
3169 SET_PT (XFASTINT (start));
3170 if (PT > XFASTINT (end))
3171 SET_PT (XFASTINT (end));
3172 /* Changing the buffer bounds invalidates any recorded current column. */
3173 invalidate_current_column ();
3174 return Qnil;
3177 Lisp_Object
3178 save_restriction_save (void)
3180 if (BEGV == BEG && ZV == Z)
3181 /* The common case that the buffer isn't narrowed.
3182 We return just the buffer object, which save_restriction_restore
3183 recognizes as meaning `no restriction'. */
3184 return Fcurrent_buffer ();
3185 else
3186 /* We have to save a restriction, so return a pair of markers, one
3187 for the beginning and one for the end. */
3189 Lisp_Object beg, end;
3191 beg = buildmark (BEGV, BEGV_BYTE);
3192 end = buildmark (ZV, ZV_BYTE);
3194 /* END must move forward if text is inserted at its exact location. */
3195 XMARKER(end)->insertion_type = 1;
3197 return Fcons (beg, end);
3201 Lisp_Object
3202 save_restriction_restore (Lisp_Object data)
3204 struct buffer *cur = NULL;
3205 struct buffer *buf = (CONSP (data)
3206 ? XMARKER (XCAR (data))->buffer
3207 : XBUFFER (data));
3209 if (buf && buf != current_buffer && !NILP (BVAR (buf, pt_marker)))
3210 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3211 is the case if it is or has an indirect buffer), then make
3212 sure it is current before we update BEGV, so
3213 set_buffer_internal takes care of managing those markers. */
3214 cur = current_buffer;
3215 set_buffer_internal (buf);
3218 if (CONSP (data))
3219 /* A pair of marks bounding a saved restriction. */
3221 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3222 struct Lisp_Marker *end = XMARKER (XCDR (data));
3223 eassert (buf == end->buffer);
3225 if (buf /* Verify marker still points to a buffer. */
3226 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3227 /* The restriction has changed from the saved one, so restore
3228 the saved restriction. */
3230 EMACS_INT pt = BUF_PT (buf);
3232 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3233 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3235 if (pt < beg->charpos || pt > end->charpos)
3236 /* The point is outside the new visible range, move it inside. */
3237 SET_BUF_PT_BOTH (buf,
3238 clip_to_bounds (beg->charpos, pt, end->charpos),
3239 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3240 end->bytepos));
3242 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3245 else
3246 /* A buffer, which means that there was no old restriction. */
3248 if (buf /* Verify marker still points to a buffer. */
3249 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3250 /* The buffer has been narrowed, get rid of the narrowing. */
3252 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3253 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3255 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3259 /* Changing the buffer bounds invalidates any recorded current column. */
3260 invalidate_current_column ();
3262 if (cur)
3263 set_buffer_internal (cur);
3265 return Qnil;
3268 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3269 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3270 The buffer's restrictions make parts of the beginning and end invisible.
3271 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3272 This special form, `save-restriction', saves the current buffer's restrictions
3273 when it is entered, and restores them when it is exited.
3274 So any `narrow-to-region' within BODY lasts only until the end of the form.
3275 The old restrictions settings are restored
3276 even in case of abnormal exit (throw or error).
3278 The value returned is the value of the last form in BODY.
3280 Note: if you are using both `save-excursion' and `save-restriction',
3281 use `save-excursion' outermost:
3282 (save-excursion (save-restriction ...))
3284 usage: (save-restriction &rest BODY) */)
3285 (Lisp_Object body)
3287 register Lisp_Object val;
3288 int count = SPECPDL_INDEX ();
3290 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3291 val = Fprogn (body);
3292 return unbind_to (count, val);
3295 /* Buffer for the most recent text displayed by Fmessage_box. */
3296 static char *message_text;
3298 /* Allocated length of that buffer. */
3299 static int message_length;
3301 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3302 doc: /* Display a message at the bottom of the screen.
3303 The message also goes into the `*Messages*' buffer.
3304 \(In keyboard macros, that's all it does.)
3305 Return the message.
3307 The first argument is a format control string, and the rest are data
3308 to be formatted under control of the string. See `format' for details.
3310 Note: Use (message "%s" VALUE) to print the value of expressions and
3311 variables to avoid accidentally interpreting `%' as format specifiers.
3313 If the first argument is nil or the empty string, the function clears
3314 any existing message; this lets the minibuffer contents show. See
3315 also `current-message'.
3317 usage: (message FORMAT-STRING &rest ARGS) */)
3318 (int nargs, Lisp_Object *args)
3320 if (NILP (args[0])
3321 || (STRINGP (args[0])
3322 && SBYTES (args[0]) == 0))
3324 message (0);
3325 return args[0];
3327 else
3329 register Lisp_Object val;
3330 val = Fformat (nargs, args);
3331 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
3332 return val;
3336 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3337 doc: /* Display a message, in a dialog box if possible.
3338 If a dialog box is not available, use the echo area.
3339 The first argument is a format control string, and the rest are data
3340 to be formatted under control of the string. See `format' for details.
3342 If the first argument is nil or the empty string, clear any existing
3343 message; let the minibuffer contents show.
3345 usage: (message-box FORMAT-STRING &rest ARGS) */)
3346 (int nargs, Lisp_Object *args)
3348 if (NILP (args[0]))
3350 message (0);
3351 return Qnil;
3353 else
3355 register Lisp_Object val;
3356 val = Fformat (nargs, args);
3357 #ifdef HAVE_MENUS
3358 /* The MS-DOS frames support popup menus even though they are
3359 not FRAME_WINDOW_P. */
3360 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3361 || FRAME_MSDOS_P (XFRAME (selected_frame)))
3363 Lisp_Object pane, menu, obj;
3364 struct gcpro gcpro1;
3365 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3366 GCPRO1 (pane);
3367 menu = Fcons (val, pane);
3368 obj = Fx_popup_dialog (Qt, menu, Qt);
3369 UNGCPRO;
3370 return val;
3372 #endif /* HAVE_MENUS */
3373 /* Copy the data so that it won't move when we GC. */
3374 if (! message_text)
3376 message_text = (char *)xmalloc (80);
3377 message_length = 80;
3379 if (SBYTES (val) > message_length)
3381 message_length = SBYTES (val);
3382 message_text = (char *)xrealloc (message_text, message_length);
3384 memcpy (message_text, SDATA (val), SBYTES (val));
3385 message2 (message_text, SBYTES (val),
3386 STRING_MULTIBYTE (val));
3387 return val;
3391 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3392 doc: /* Display a message in a dialog box or in the echo area.
3393 If this command was invoked with the mouse, use a dialog box if
3394 `use-dialog-box' is non-nil.
3395 Otherwise, use the echo area.
3396 The first argument is a format control string, and the rest are data
3397 to be formatted under control of the string. See `format' for details.
3399 If the first argument is nil or the empty string, clear any existing
3400 message; let the minibuffer contents show.
3402 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3403 (int nargs, Lisp_Object *args)
3405 #ifdef HAVE_MENUS
3406 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3407 && use_dialog_box)
3408 return Fmessage_box (nargs, args);
3409 #endif
3410 return Fmessage (nargs, args);
3413 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3414 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3415 (void)
3417 return current_message ();
3421 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3422 doc: /* Return a copy of STRING with text properties added.
3423 First argument is the string to copy.
3424 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3425 properties to add to the result.
3426 usage: (propertize STRING &rest PROPERTIES) */)
3427 (int nargs, Lisp_Object *args)
3429 Lisp_Object properties, string;
3430 struct gcpro gcpro1, gcpro2;
3431 int i;
3433 /* Number of args must be odd. */
3434 if ((nargs & 1) == 0 || nargs < 1)
3435 error ("Wrong number of arguments");
3437 properties = string = Qnil;
3438 GCPRO2 (properties, string);
3440 /* First argument must be a string. */
3441 CHECK_STRING (args[0]);
3442 string = Fcopy_sequence (args[0]);
3444 for (i = 1; i < nargs; i += 2)
3445 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3447 Fadd_text_properties (make_number (0),
3448 make_number (SCHARS (string)),
3449 properties, string);
3450 RETURN_UNGCPRO (string);
3454 /* Number of bytes that STRING will occupy when put into the result.
3455 MULTIBYTE is nonzero if the result should be multibyte. */
3457 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3458 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3459 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3460 : SBYTES (STRING))
3462 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3463 doc: /* Format a string out of a format-string and arguments.
3464 The first argument is a format control string.
3465 The other arguments are substituted into it to make the result, a string.
3467 The format control string may contain %-sequences meaning to substitute
3468 the next available argument:
3470 %s means print a string argument. Actually, prints any object, with `princ'.
3471 %d means print as number in decimal (%o octal, %x hex).
3472 %X is like %x, but uses upper case.
3473 %e means print a number in exponential notation.
3474 %f means print a number in decimal-point notation.
3475 %g means print a number in exponential notation
3476 or decimal-point notation, whichever uses fewer characters.
3477 %c means print a number as a single character.
3478 %S means print any object as an s-expression (using `prin1').
3480 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3481 Use %% to put a single % into the output.
3483 A %-sequence may contain optional flag, width, and precision
3484 specifiers, as follows:
3486 %<flags><width><precision>character
3488 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3490 The + flag character inserts a + before any positive number, while a
3491 space inserts a space before any positive number; these flags only
3492 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3493 The # flag means to use an alternate display form for %o, %x, %X, %e,
3494 %f, and %g sequences. The - and 0 flags affect the width specifier,
3495 as described below.
3497 The width specifier supplies a lower limit for the length of the
3498 printed representation. The padding, if any, normally goes on the
3499 left, but it goes on the right if the - flag is present. The padding
3500 character is normally a space, but it is 0 if the 0 flag is present.
3501 The - flag takes precedence over the 0 flag.
3503 For %e, %f, and %g sequences, the number after the "." in the
3504 precision specifier says how many decimal places to show; if zero, the
3505 decimal point itself is omitted. For %s and %S, the precision
3506 specifier truncates the string to the given width.
3508 usage: (format STRING &rest OBJECTS) */)
3509 (int nargs, register Lisp_Object *args)
3511 register int n; /* The number of the next arg to substitute */
3512 register EMACS_INT total; /* An estimate of the final length */
3513 char *buf, *p;
3514 register char *format, *end, *format_start;
3515 int nchars;
3516 /* Nonzero if the output should be a multibyte string,
3517 which is true if any of the inputs is one. */
3518 int multibyte = 0;
3519 /* When we make a multibyte string, we must pay attention to the
3520 byte combining problem, i.e., a byte may be combined with a
3521 multibyte character of the previous string. This flag tells if we
3522 must consider such a situation or not. */
3523 int maybe_combine_byte;
3524 char *this_format;
3525 /* Precision for each spec, or -1, a flag value meaning no precision
3526 was given in that spec. Element 0, corresonding to the format
3527 string itself, will not be used. Element NARGS, corresponding to
3528 no argument, *will* be assigned to in the case that a `%' and `.'
3529 occur after the final format specifier. */
3530 int *precision = (int *) (alloca ((nargs + 1) * sizeof (int)));
3531 int longest_format;
3532 Lisp_Object val;
3533 int arg_intervals = 0;
3534 USE_SAFE_ALLOCA;
3536 /* discarded[I] is 1 if byte I of the format
3537 string was not copied into the output.
3538 It is 2 if byte I was not the first byte of its character. */
3539 char *discarded = 0;
3541 /* Each element records, for one argument,
3542 the start and end bytepos in the output string,
3543 and whether the argument is a string with intervals.
3544 info[0] is unused. Unused elements have -1 for start. */
3545 struct info
3547 int start, end, intervals;
3548 } *info = 0;
3550 /* It should not be necessary to GCPRO ARGS, because
3551 the caller in the interpreter should take care of that. */
3553 /* Try to determine whether the result should be multibyte.
3554 This is not always right; sometimes the result needs to be multibyte
3555 because of an object that we will pass through prin1,
3556 and in that case, we won't know it here. */
3557 for (n = 0; n < nargs; n++)
3559 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3560 multibyte = 1;
3561 /* Piggyback on this loop to initialize precision[N]. */
3562 precision[n] = -1;
3564 precision[nargs] = -1;
3566 CHECK_STRING (args[0]);
3567 /* We may have to change "%S" to "%s". */
3568 args[0] = Fcopy_sequence (args[0]);
3570 /* GC should never happen here, so abort if it does. */
3571 abort_on_gc++;
3573 /* If we start out planning a unibyte result,
3574 then discover it has to be multibyte, we jump back to retry.
3575 That can only happen from the first large while loop below. */
3576 retry:
3578 format = SSDATA (args[0]);
3579 format_start = format;
3580 end = format + SBYTES (args[0]);
3581 longest_format = 0;
3583 /* Make room in result for all the non-%-codes in the control string. */
3584 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]) + 1;
3586 /* Allocate the info and discarded tables. */
3588 int nbytes = (nargs+1) * sizeof *info;
3589 int i;
3590 if (!info)
3591 info = (struct info *) alloca (nbytes);
3592 memset (info, 0, nbytes);
3593 for (i = 0; i <= nargs; i++)
3594 info[i].start = -1;
3595 if (!discarded)
3596 SAFE_ALLOCA (discarded, char *, SBYTES (args[0]));
3597 memset (discarded, 0, SBYTES (args[0]));
3600 /* Add to TOTAL enough space to hold the converted arguments. */
3602 n = 0;
3603 while (format != end)
3604 if (*format++ == '%')
3606 EMACS_INT thissize = 0;
3607 EMACS_INT actual_width = 0;
3608 char *this_format_start = format - 1;
3609 int field_width = 0;
3611 /* General format specifications look like
3613 '%' [flags] [field-width] [precision] format
3615 where
3617 flags ::= [-+ #0]+
3618 field-width ::= [0-9]+
3619 precision ::= '.' [0-9]*
3621 If a field-width is specified, it specifies to which width
3622 the output should be padded with blanks, if the output
3623 string is shorter than field-width.
3625 If precision is specified, it specifies the number of
3626 digits to print after the '.' for floats, or the max.
3627 number of chars to print from a string. */
3629 while (format != end
3630 && (*format == '-' || *format == '0' || *format == '#'
3631 || * format == ' ' || *format == '+'))
3632 ++format;
3634 if (*format >= '0' && *format <= '9')
3636 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3637 field_width = 10 * field_width + *format - '0';
3640 /* N is not incremented for another few lines below, so refer to
3641 element N+1 (which might be precision[NARGS]). */
3642 if (*format == '.')
3644 ++format;
3645 for (precision[n+1] = 0; *format >= '0' && *format <= '9'; ++format)
3646 precision[n+1] = 10 * precision[n+1] + *format - '0';
3649 /* Extra +1 for 'l' that we may need to insert into the
3650 format. */
3651 if (format - this_format_start + 2 > longest_format)
3652 longest_format = format - this_format_start + 2;
3654 if (format == end)
3655 error ("Format string ends in middle of format specifier");
3656 if (*format == '%')
3657 format++;
3658 else if (++n >= nargs)
3659 error ("Not enough arguments for format string");
3660 else if (*format == 'S')
3662 /* For `S', prin1 the argument and then treat like a string. */
3663 register Lisp_Object tem;
3664 tem = Fprin1_to_string (args[n], Qnil);
3665 if (STRING_MULTIBYTE (tem) && ! multibyte)
3667 multibyte = 1;
3668 goto retry;
3670 args[n] = tem;
3671 /* If we restart the loop, we should not come here again
3672 because args[n] is now a string and calling
3673 Fprin1_to_string on it produces superflous double
3674 quotes. So, change "%S" to "%s" now. */
3675 *format = 's';
3676 goto string;
3678 else if (SYMBOLP (args[n]))
3680 args[n] = SYMBOL_NAME (args[n]);
3681 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3683 multibyte = 1;
3684 goto retry;
3686 goto string;
3688 else if (STRINGP (args[n]))
3690 string:
3691 if (*format != 's' && *format != 'S')
3692 error ("Format specifier doesn't match argument type");
3693 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3694 to be as large as is calculated here. Easy check for
3695 the case PRECISION = 0. */
3696 thissize = precision[n] ? CONVERTED_BYTE_SIZE (multibyte, args[n]) : 0;
3697 /* The precision also constrains how much of the argument
3698 string will finally appear (Bug#5710). */
3699 actual_width = lisp_string_width (args[n], -1, NULL, NULL);
3700 if (precision[n] != -1)
3701 actual_width = min (actual_width, precision[n]);
3703 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3704 else if (INTEGERP (args[n]) && *format != 's')
3706 /* The following loop assumes the Lisp type indicates
3707 the proper way to pass the argument.
3708 So make sure we have a flonum if the argument should
3709 be a double. */
3710 if (*format == 'e' || *format == 'f' || *format == 'g')
3711 args[n] = Ffloat (args[n]);
3712 else
3713 if (*format != 'd' && *format != 'o' && *format != 'x'
3714 && *format != 'i' && *format != 'X' && *format != 'c')
3715 error ("Invalid format operation %%%c", *format);
3717 thissize = 30 + (precision[n] > 0 ? precision[n] : 0);
3718 if (*format == 'c')
3720 if (! ASCII_CHAR_P (XINT (args[n]))
3721 /* Note: No one can remeber why we have to treat
3722 the character 0 as a multibyte character here.
3723 But, until it causes a real problem, let's
3724 don't change it. */
3725 || XINT (args[n]) == 0)
3727 if (! multibyte)
3729 multibyte = 1;
3730 goto retry;
3732 args[n] = Fchar_to_string (args[n]);
3733 thissize = SBYTES (args[n]);
3735 else if (! ASCII_BYTE_P (XINT (args[n])) && multibyte)
3737 args[n]
3738 = Fchar_to_string (Funibyte_char_to_multibyte (args[n]));
3739 thissize = SBYTES (args[n]);
3743 else if (FLOATP (args[n]) && *format != 's')
3745 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3747 if (*format != 'd' && *format != 'o' && *format != 'x'
3748 && *format != 'i' && *format != 'X' && *format != 'c')
3749 error ("Invalid format operation %%%c", *format);
3750 /* This fails unnecessarily if args[n] is bigger than
3751 most-positive-fixnum but smaller than MAXINT.
3752 These cases are important because we sometimes use floats
3753 to represent such integer values (typically such values
3754 come from UIDs or PIDs). */
3755 /* args[n] = Ftruncate (args[n], Qnil); */
3758 /* Note that we're using sprintf to print floats,
3759 so we have to take into account what that function
3760 prints. */
3761 /* Filter out flag value of -1. */
3762 thissize = (MAX_10_EXP + 100
3763 + (precision[n] > 0 ? precision[n] : 0));
3765 else
3767 /* Anything but a string, convert to a string using princ. */
3768 register Lisp_Object tem;
3769 tem = Fprin1_to_string (args[n], Qt);
3770 if (STRING_MULTIBYTE (tem) && ! multibyte)
3772 multibyte = 1;
3773 goto retry;
3775 args[n] = tem;
3776 goto string;
3779 thissize += max (0, field_width - actual_width);
3780 total += thissize + 4;
3783 abort_on_gc--;
3785 /* Now we can no longer jump to retry.
3786 TOTAL and LONGEST_FORMAT are known for certain. */
3788 this_format = (char *) alloca (longest_format + 1);
3790 /* Allocate the space for the result.
3791 Note that TOTAL is an overestimate. */
3792 SAFE_ALLOCA (buf, char *, total);
3794 p = buf;
3795 nchars = 0;
3796 n = 0;
3798 /* Scan the format and store result in BUF. */
3799 format = SSDATA (args[0]);
3800 format_start = format;
3801 end = format + SBYTES (args[0]);
3802 maybe_combine_byte = 0;
3803 while (format != end)
3805 if (*format == '%')
3807 int minlen;
3808 int negative = 0;
3809 char *this_format_start = format;
3811 discarded[format - format_start] = 1;
3812 format++;
3814 while (strchr ("-+0# ", *format))
3816 if (*format == '-')
3818 negative = 1;
3820 discarded[format - format_start] = 1;
3821 ++format;
3824 minlen = atoi (format);
3826 while ((*format >= '0' && *format <= '9') || *format == '.')
3828 discarded[format - format_start] = 1;
3829 format++;
3832 if (*format++ == '%')
3834 *p++ = '%';
3835 nchars++;
3836 continue;
3839 ++n;
3841 discarded[format - format_start - 1] = 1;
3842 info[n].start = nchars;
3844 if (STRINGP (args[n]))
3846 /* handle case (precision[n] >= 0) */
3848 int width, padding;
3849 EMACS_INT nbytes, start, end;
3850 EMACS_INT nchars_string;
3852 /* lisp_string_width ignores a precision of 0, but GNU
3853 libc functions print 0 characters when the precision
3854 is 0. Imitate libc behavior here. Changing
3855 lisp_string_width is the right thing, and will be
3856 done, but meanwhile we work with it. */
3858 if (precision[n] == 0)
3859 width = nchars_string = nbytes = 0;
3860 else if (precision[n] > 0)
3861 width = lisp_string_width (args[n], precision[n],
3862 &nchars_string, &nbytes);
3863 else
3864 { /* no precision spec given for this argument */
3865 width = lisp_string_width (args[n], -1, NULL, NULL);
3866 nbytes = SBYTES (args[n]);
3867 nchars_string = SCHARS (args[n]);
3870 /* If spec requires it, pad on right with spaces. */
3871 padding = minlen - width;
3872 if (! negative)
3873 while (padding-- > 0)
3875 *p++ = ' ';
3876 ++nchars;
3879 info[n].start = start = nchars;
3880 nchars += nchars_string;
3881 end = nchars;
3883 if (p > buf
3884 && multibyte
3885 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3886 && STRING_MULTIBYTE (args[n])
3887 && !CHAR_HEAD_P (SREF (args[n], 0)))
3888 maybe_combine_byte = 1;
3890 p += copy_text (SDATA (args[n]), (unsigned char *) p,
3891 nbytes,
3892 STRING_MULTIBYTE (args[n]), multibyte);
3894 info[n].end = nchars;
3896 if (negative)
3897 while (padding-- > 0)
3899 *p++ = ' ';
3900 nchars++;
3903 /* If this argument has text properties, record where
3904 in the result string it appears. */
3905 if (STRING_INTERVALS (args[n]))
3906 info[n].intervals = arg_intervals = 1;
3908 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3910 int this_nchars;
3912 memcpy (this_format, this_format_start,
3913 format - this_format_start);
3914 this_format[format - this_format_start] = 0;
3916 if (format[-1] == 'e' || format[-1] == 'f' || format[-1] == 'g')
3917 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3918 else
3920 if (sizeof (EMACS_INT) > sizeof (int)
3921 && format[-1] != 'c')
3923 /* Insert 'l' before format spec. */
3924 this_format[format - this_format_start]
3925 = this_format[format - this_format_start - 1];
3926 this_format[format - this_format_start - 1] = 'l';
3927 this_format[format - this_format_start + 1] = 0;
3930 if (INTEGERP (args[n]))
3932 if (format[-1] == 'c')
3933 sprintf (p, this_format, (int) XINT (args[n]));
3934 else if (format[-1] == 'd')
3935 sprintf (p, this_format, XINT (args[n]));
3936 /* Don't sign-extend for octal or hex printing. */
3937 else
3938 sprintf (p, this_format, XUINT (args[n]));
3940 else if (format[-1] == 'c')
3941 sprintf (p, this_format, (int) XFLOAT_DATA (args[n]));
3942 else if (format[-1] == 'd')
3943 /* Maybe we should use "%1.0f" instead so it also works
3944 for values larger than MAXINT. */
3945 sprintf (p, this_format, (EMACS_INT) XFLOAT_DATA (args[n]));
3946 else
3947 /* Don't sign-extend for octal or hex printing. */
3948 sprintf (p, this_format, (EMACS_UINT) XFLOAT_DATA (args[n]));
3951 if (p > buf
3952 && multibyte
3953 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3954 && !CHAR_HEAD_P (*((unsigned char *) p)))
3955 maybe_combine_byte = 1;
3956 this_nchars = strlen (p);
3957 if (multibyte)
3958 p += str_to_multibyte ((unsigned char *) p,
3959 buf + total - 1 - p, this_nchars);
3960 else
3961 p += this_nchars;
3962 nchars += this_nchars;
3963 info[n].end = nchars;
3967 else if (STRING_MULTIBYTE (args[0]))
3969 /* Copy a whole multibyte character. */
3970 if (p > buf
3971 && multibyte
3972 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3973 && !CHAR_HEAD_P (*format))
3974 maybe_combine_byte = 1;
3975 *p++ = *format++;
3976 while (! CHAR_HEAD_P (*format))
3978 discarded[format - format_start] = 2;
3979 *p++ = *format++;
3981 nchars++;
3983 else if (multibyte)
3985 /* Convert a single-byte character to multibyte. */
3986 int len = copy_text ((unsigned char *) format, (unsigned char *) p,
3987 1, 0, 1);
3989 p += len;
3990 format++;
3991 nchars++;
3993 else
3994 *p++ = *format++, nchars++;
3997 if (p > buf + total)
3998 abort ();
4000 if (maybe_combine_byte)
4001 nchars = multibyte_chars_in_text ((unsigned char *) buf, p - buf);
4002 val = make_specified_string (buf, nchars, p - buf, multibyte);
4004 /* If we allocated BUF with malloc, free it too. */
4005 SAFE_FREE ();
4007 /* If the format string has text properties, or any of the string
4008 arguments has text properties, set up text properties of the
4009 result string. */
4011 if (STRING_INTERVALS (args[0]) || arg_intervals)
4013 Lisp_Object len, new_len, props;
4014 struct gcpro gcpro1;
4016 /* Add text properties from the format string. */
4017 len = make_number (SCHARS (args[0]));
4018 props = text_property_list (args[0], make_number (0), len, Qnil);
4019 GCPRO1 (props);
4021 if (CONSP (props))
4023 EMACS_INT bytepos = 0, position = 0, translated = 0;
4024 int argn = 1;
4025 Lisp_Object list;
4027 /* Adjust the bounds of each text property
4028 to the proper start and end in the output string. */
4030 /* Put the positions in PROPS in increasing order, so that
4031 we can do (effectively) one scan through the position
4032 space of the format string. */
4033 props = Fnreverse (props);
4035 /* BYTEPOS is the byte position in the format string,
4036 POSITION is the untranslated char position in it,
4037 TRANSLATED is the translated char position in BUF,
4038 and ARGN is the number of the next arg we will come to. */
4039 for (list = props; CONSP (list); list = XCDR (list))
4041 Lisp_Object item;
4042 EMACS_INT pos;
4044 item = XCAR (list);
4046 /* First adjust the property start position. */
4047 pos = XINT (XCAR (item));
4049 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4050 up to this position. */
4051 for (; position < pos; bytepos++)
4053 if (! discarded[bytepos])
4054 position++, translated++;
4055 else if (discarded[bytepos] == 1)
4057 position++;
4058 if (translated == info[argn].start)
4060 translated += info[argn].end - info[argn].start;
4061 argn++;
4066 XSETCAR (item, make_number (translated));
4068 /* Likewise adjust the property end position. */
4069 pos = XINT (XCAR (XCDR (item)));
4071 for (; position < pos; bytepos++)
4073 if (! discarded[bytepos])
4074 position++, translated++;
4075 else if (discarded[bytepos] == 1)
4077 position++;
4078 if (translated == info[argn].start)
4080 translated += info[argn].end - info[argn].start;
4081 argn++;
4086 XSETCAR (XCDR (item), make_number (translated));
4089 add_text_properties_from_list (val, props, make_number (0));
4092 /* Add text properties from arguments. */
4093 if (arg_intervals)
4094 for (n = 1; n < nargs; ++n)
4095 if (info[n].intervals)
4097 len = make_number (SCHARS (args[n]));
4098 new_len = make_number (info[n].end - info[n].start);
4099 props = text_property_list (args[n], make_number (0), len, Qnil);
4100 props = extend_property_ranges (props, new_len);
4101 /* If successive arguments have properties, be sure that
4102 the value of `composition' property be the copy. */
4103 if (n > 1 && info[n - 1].end)
4104 make_composition_value_copy (props);
4105 add_text_properties_from_list (val, props,
4106 make_number (info[n].start));
4109 UNGCPRO;
4112 return val;
4115 Lisp_Object
4116 format2 (const char *string1, Lisp_Object arg0, Lisp_Object arg1)
4118 Lisp_Object args[3];
4119 args[0] = build_string (string1);
4120 args[1] = arg0;
4121 args[2] = arg1;
4122 return Fformat (3, args);
4125 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4126 doc: /* Return t if two characters match, optionally ignoring case.
4127 Both arguments must be characters (i.e. integers).
4128 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4129 (register Lisp_Object c1, Lisp_Object c2)
4131 int i1, i2;
4132 /* Check they're chars, not just integers, otherwise we could get array
4133 bounds violations in DOWNCASE. */
4134 CHECK_CHARACTER (c1);
4135 CHECK_CHARACTER (c2);
4137 if (XINT (c1) == XINT (c2))
4138 return Qt;
4139 if (NILP (BVAR (current_buffer, case_fold_search)))
4140 return Qnil;
4142 /* Do these in separate statements,
4143 then compare the variables.
4144 because of the way DOWNCASE uses temp variables. */
4145 i1 = XFASTINT (c1);
4146 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
4147 && ! ASCII_CHAR_P (i1))
4149 MAKE_CHAR_MULTIBYTE (i1);
4151 i2 = XFASTINT (c2);
4152 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
4153 && ! ASCII_CHAR_P (i2))
4155 MAKE_CHAR_MULTIBYTE (i2);
4157 i1 = DOWNCASE (i1);
4158 i2 = DOWNCASE (i2);
4159 return (i1 == i2 ? Qt : Qnil);
4162 /* Transpose the markers in two regions of the current buffer, and
4163 adjust the ones between them if necessary (i.e.: if the regions
4164 differ in size).
4166 START1, END1 are the character positions of the first region.
4167 START1_BYTE, END1_BYTE are the byte positions.
4168 START2, END2 are the character positions of the second region.
4169 START2_BYTE, END2_BYTE are the byte positions.
4171 Traverses the entire marker list of the buffer to do so, adding an
4172 appropriate amount to some, subtracting from some, and leaving the
4173 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4175 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4177 static void
4178 transpose_markers (EMACS_INT start1, EMACS_INT end1,
4179 EMACS_INT start2, EMACS_INT end2,
4180 EMACS_INT start1_byte, EMACS_INT end1_byte,
4181 EMACS_INT start2_byte, EMACS_INT end2_byte)
4183 register EMACS_INT amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4184 register struct Lisp_Marker *marker;
4186 /* Update point as if it were a marker. */
4187 if (PT < start1)
4189 else if (PT < end1)
4190 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4191 PT_BYTE + (end2_byte - end1_byte));
4192 else if (PT < start2)
4193 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4194 (PT_BYTE + (end2_byte - start2_byte)
4195 - (end1_byte - start1_byte)));
4196 else if (PT < end2)
4197 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4198 PT_BYTE - (start2_byte - start1_byte));
4200 /* We used to adjust the endpoints here to account for the gap, but that
4201 isn't good enough. Even if we assume the caller has tried to move the
4202 gap out of our way, it might still be at start1 exactly, for example;
4203 and that places it `inside' the interval, for our purposes. The amount
4204 of adjustment is nontrivial if there's a `denormalized' marker whose
4205 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4206 the dirty work to Fmarker_position, below. */
4208 /* The difference between the region's lengths */
4209 diff = (end2 - start2) - (end1 - start1);
4210 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4212 /* For shifting each marker in a region by the length of the other
4213 region plus the distance between the regions. */
4214 amt1 = (end2 - start2) + (start2 - end1);
4215 amt2 = (end1 - start1) + (start2 - end1);
4216 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4217 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4219 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4221 mpos = marker->bytepos;
4222 if (mpos >= start1_byte && mpos < end2_byte)
4224 if (mpos < end1_byte)
4225 mpos += amt1_byte;
4226 else if (mpos < start2_byte)
4227 mpos += diff_byte;
4228 else
4229 mpos -= amt2_byte;
4230 marker->bytepos = mpos;
4232 mpos = marker->charpos;
4233 if (mpos >= start1 && mpos < end2)
4235 if (mpos < end1)
4236 mpos += amt1;
4237 else if (mpos < start2)
4238 mpos += diff;
4239 else
4240 mpos -= amt2;
4242 marker->charpos = mpos;
4246 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4247 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4248 The regions should not be overlapping, because the size of the buffer is
4249 never changed in a transposition.
4251 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4252 any markers that happen to be located in the regions.
4254 Transposing beyond buffer boundaries is an error. */)
4255 (Lisp_Object startr1, Lisp_Object endr1, Lisp_Object startr2, Lisp_Object endr2, Lisp_Object leave_markers)
4257 register EMACS_INT start1, end1, start2, end2;
4258 EMACS_INT start1_byte, start2_byte, len1_byte, len2_byte;
4259 EMACS_INT gap, len1, len_mid, len2;
4260 unsigned char *start1_addr, *start2_addr, *temp;
4262 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4263 Lisp_Object buf;
4265 XSETBUFFER (buf, current_buffer);
4266 cur_intv = BUF_INTERVALS (current_buffer);
4268 validate_region (&startr1, &endr1);
4269 validate_region (&startr2, &endr2);
4271 start1 = XFASTINT (startr1);
4272 end1 = XFASTINT (endr1);
4273 start2 = XFASTINT (startr2);
4274 end2 = XFASTINT (endr2);
4275 gap = GPT;
4277 /* Swap the regions if they're reversed. */
4278 if (start2 < end1)
4280 register EMACS_INT glumph = start1;
4281 start1 = start2;
4282 start2 = glumph;
4283 glumph = end1;
4284 end1 = end2;
4285 end2 = glumph;
4288 len1 = end1 - start1;
4289 len2 = end2 - start2;
4291 if (start2 < end1)
4292 error ("Transposed regions overlap");
4293 else if (start1 == end1 || start2 == end2)
4294 error ("Transposed region has length 0");
4296 /* The possibilities are:
4297 1. Adjacent (contiguous) regions, or separate but equal regions
4298 (no, really equal, in this case!), or
4299 2. Separate regions of unequal size.
4301 The worst case is usually No. 2. It means that (aside from
4302 potential need for getting the gap out of the way), there also
4303 needs to be a shifting of the text between the two regions. So
4304 if they are spread far apart, we are that much slower... sigh. */
4306 /* It must be pointed out that the really studly thing to do would
4307 be not to move the gap at all, but to leave it in place and work
4308 around it if necessary. This would be extremely efficient,
4309 especially considering that people are likely to do
4310 transpositions near where they are working interactively, which
4311 is exactly where the gap would be found. However, such code
4312 would be much harder to write and to read. So, if you are
4313 reading this comment and are feeling squirrely, by all means have
4314 a go! I just didn't feel like doing it, so I will simply move
4315 the gap the minimum distance to get it out of the way, and then
4316 deal with an unbroken array. */
4318 /* Make sure the gap won't interfere, by moving it out of the text
4319 we will operate on. */
4320 if (start1 < gap && gap < end2)
4322 if (gap - start1 < end2 - gap)
4323 move_gap (start1);
4324 else
4325 move_gap (end2);
4328 start1_byte = CHAR_TO_BYTE (start1);
4329 start2_byte = CHAR_TO_BYTE (start2);
4330 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4331 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
4333 #ifdef BYTE_COMBINING_DEBUG
4334 if (end1 == start2)
4336 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4337 len2_byte, start1, start1_byte)
4338 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4339 len1_byte, end2, start2_byte + len2_byte)
4340 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4341 len1_byte, end2, start2_byte + len2_byte))
4342 abort ();
4344 else
4346 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4347 len2_byte, start1, start1_byte)
4348 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4349 len1_byte, start2, start2_byte)
4350 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4351 len2_byte, end1, start1_byte + len1_byte)
4352 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4353 len1_byte, end2, start2_byte + len2_byte))
4354 abort ();
4356 #endif
4358 /* Hmmm... how about checking to see if the gap is large
4359 enough to use as the temporary storage? That would avoid an
4360 allocation... interesting. Later, don't fool with it now. */
4362 /* Working without memmove, for portability (sigh), so must be
4363 careful of overlapping subsections of the array... */
4365 if (end1 == start2) /* adjacent regions */
4367 modify_region (current_buffer, start1, end2, 0);
4368 record_change (start1, len1 + len2);
4370 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4371 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4372 /* Don't use Fset_text_properties: that can cause GC, which can
4373 clobber objects stored in the tmp_intervals. */
4374 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4375 if (!NULL_INTERVAL_P (tmp_interval3))
4376 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4378 /* First region smaller than second. */
4379 if (len1_byte < len2_byte)
4381 USE_SAFE_ALLOCA;
4383 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4385 /* Don't precompute these addresses. We have to compute them
4386 at the last minute, because the relocating allocator might
4387 have moved the buffer around during the xmalloc. */
4388 start1_addr = BYTE_POS_ADDR (start1_byte);
4389 start2_addr = BYTE_POS_ADDR (start2_byte);
4391 memcpy (temp, start2_addr, len2_byte);
4392 memcpy (start1_addr + len2_byte, start1_addr, len1_byte);
4393 memcpy (start1_addr, temp, len2_byte);
4394 SAFE_FREE ();
4396 else
4397 /* First region not smaller than second. */
4399 USE_SAFE_ALLOCA;
4401 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4402 start1_addr = BYTE_POS_ADDR (start1_byte);
4403 start2_addr = BYTE_POS_ADDR (start2_byte);
4404 memcpy (temp, start1_addr, len1_byte);
4405 memcpy (start1_addr, start2_addr, len2_byte);
4406 memcpy (start1_addr + len2_byte, temp, len1_byte);
4407 SAFE_FREE ();
4409 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4410 len1, current_buffer, 0);
4411 graft_intervals_into_buffer (tmp_interval2, start1,
4412 len2, current_buffer, 0);
4413 update_compositions (start1, start1 + len2, CHECK_BORDER);
4414 update_compositions (start1 + len2, end2, CHECK_TAIL);
4416 /* Non-adjacent regions, because end1 != start2, bleagh... */
4417 else
4419 len_mid = start2_byte - (start1_byte + len1_byte);
4421 if (len1_byte == len2_byte)
4422 /* Regions are same size, though, how nice. */
4424 USE_SAFE_ALLOCA;
4426 modify_region (current_buffer, start1, end1, 0);
4427 modify_region (current_buffer, start2, end2, 0);
4428 record_change (start1, len1);
4429 record_change (start2, len2);
4430 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4431 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4433 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4434 if (!NULL_INTERVAL_P (tmp_interval3))
4435 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4437 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4438 if (!NULL_INTERVAL_P (tmp_interval3))
4439 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4441 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4442 start1_addr = BYTE_POS_ADDR (start1_byte);
4443 start2_addr = BYTE_POS_ADDR (start2_byte);
4444 memcpy (temp, start1_addr, len1_byte);
4445 memcpy (start1_addr, start2_addr, len2_byte);
4446 memcpy (start2_addr, temp, len1_byte);
4447 SAFE_FREE ();
4449 graft_intervals_into_buffer (tmp_interval1, start2,
4450 len1, current_buffer, 0);
4451 graft_intervals_into_buffer (tmp_interval2, start1,
4452 len2, current_buffer, 0);
4455 else if (len1_byte < len2_byte) /* Second region larger than first */
4456 /* Non-adjacent & unequal size, area between must also be shifted. */
4458 USE_SAFE_ALLOCA;
4460 modify_region (current_buffer, start1, end2, 0);
4461 record_change (start1, (end2 - start1));
4462 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4463 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4464 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4466 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4467 if (!NULL_INTERVAL_P (tmp_interval3))
4468 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4470 /* holds region 2 */
4471 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4472 start1_addr = BYTE_POS_ADDR (start1_byte);
4473 start2_addr = BYTE_POS_ADDR (start2_byte);
4474 memcpy (temp, start2_addr, len2_byte);
4475 memcpy (start1_addr + len_mid + len2_byte, start1_addr, len1_byte);
4476 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4477 memcpy (start1_addr, temp, len2_byte);
4478 SAFE_FREE ();
4480 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4481 len1, current_buffer, 0);
4482 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4483 len_mid, current_buffer, 0);
4484 graft_intervals_into_buffer (tmp_interval2, start1,
4485 len2, current_buffer, 0);
4487 else
4488 /* Second region smaller than first. */
4490 USE_SAFE_ALLOCA;
4492 record_change (start1, (end2 - start1));
4493 modify_region (current_buffer, start1, end2, 0);
4495 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4496 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4497 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4499 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4500 if (!NULL_INTERVAL_P (tmp_interval3))
4501 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4503 /* holds region 1 */
4504 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4505 start1_addr = BYTE_POS_ADDR (start1_byte);
4506 start2_addr = BYTE_POS_ADDR (start2_byte);
4507 memcpy (temp, start1_addr, len1_byte);
4508 memcpy (start1_addr, start2_addr, len2_byte);
4509 memcpy (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4510 memcpy (start1_addr + len2_byte + len_mid, temp, len1_byte);
4511 SAFE_FREE ();
4513 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4514 len1, current_buffer, 0);
4515 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4516 len_mid, current_buffer, 0);
4517 graft_intervals_into_buffer (tmp_interval2, start1,
4518 len2, current_buffer, 0);
4521 update_compositions (start1, start1 + len2, CHECK_BORDER);
4522 update_compositions (end2 - len1, end2, CHECK_BORDER);
4525 /* When doing multiple transpositions, it might be nice
4526 to optimize this. Perhaps the markers in any one buffer
4527 should be organized in some sorted data tree. */
4528 if (NILP (leave_markers))
4530 transpose_markers (start1, end1, start2, end2,
4531 start1_byte, start1_byte + len1_byte,
4532 start2_byte, start2_byte + len2_byte);
4533 fix_start_end_in_overlays (start1, end2);
4536 signal_after_change (start1, end2 - start1, end2 - start1);
4537 return Qnil;
4541 void
4542 syms_of_editfns (void)
4544 environbuf = 0;
4545 initial_tz = 0;
4547 Qbuffer_access_fontify_functions
4548 = intern_c_string ("buffer-access-fontify-functions");
4549 staticpro (&Qbuffer_access_fontify_functions);
4551 DEFVAR_LISP ("inhibit-field-text-motion", Vinhibit_field_text_motion,
4552 doc: /* Non-nil means text motion commands don't notice fields. */);
4553 Vinhibit_field_text_motion = Qnil;
4555 DEFVAR_LISP ("buffer-access-fontify-functions",
4556 Vbuffer_access_fontify_functions,
4557 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
4558 Each function is called with two arguments which specify the range
4559 of the buffer being accessed. */);
4560 Vbuffer_access_fontify_functions = Qnil;
4563 Lisp_Object obuf;
4564 obuf = Fcurrent_buffer ();
4565 /* Do this here, because init_buffer_once is too early--it won't work. */
4566 Fset_buffer (Vprin1_to_string_buffer);
4567 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4568 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
4569 Qnil);
4570 Fset_buffer (obuf);
4573 DEFVAR_LISP ("buffer-access-fontified-property",
4574 Vbuffer_access_fontified_property,
4575 doc: /* Property which (if non-nil) indicates text has been fontified.
4576 `buffer-substring' need not call the `buffer-access-fontify-functions'
4577 functions if all the text being accessed has this property. */);
4578 Vbuffer_access_fontified_property = Qnil;
4580 DEFVAR_LISP ("system-name", Vsystem_name,
4581 doc: /* The host name of the machine Emacs is running on. */);
4583 DEFVAR_LISP ("user-full-name", Vuser_full_name,
4584 doc: /* The full name of the user logged in. */);
4586 DEFVAR_LISP ("user-login-name", Vuser_login_name,
4587 doc: /* The user's name, taken from environment variables if possible. */);
4589 DEFVAR_LISP ("user-real-login-name", Vuser_real_login_name,
4590 doc: /* The user's name, based upon the real uid only. */);
4592 DEFVAR_LISP ("operating-system-release", Voperating_system_release,
4593 doc: /* The release of the operating system Emacs is running on. */);
4595 defsubr (&Spropertize);
4596 defsubr (&Schar_equal);
4597 defsubr (&Sgoto_char);
4598 defsubr (&Sstring_to_char);
4599 defsubr (&Schar_to_string);
4600 defsubr (&Sbyte_to_string);
4601 defsubr (&Sbuffer_substring);
4602 defsubr (&Sbuffer_substring_no_properties);
4603 defsubr (&Sbuffer_string);
4605 defsubr (&Spoint_marker);
4606 defsubr (&Smark_marker);
4607 defsubr (&Spoint);
4608 defsubr (&Sregion_beginning);
4609 defsubr (&Sregion_end);
4611 staticpro (&Qfield);
4612 Qfield = intern_c_string ("field");
4613 staticpro (&Qboundary);
4614 Qboundary = intern_c_string ("boundary");
4615 defsubr (&Sfield_beginning);
4616 defsubr (&Sfield_end);
4617 defsubr (&Sfield_string);
4618 defsubr (&Sfield_string_no_properties);
4619 defsubr (&Sdelete_field);
4620 defsubr (&Sconstrain_to_field);
4622 defsubr (&Sline_beginning_position);
4623 defsubr (&Sline_end_position);
4625 /* defsubr (&Smark); */
4626 /* defsubr (&Sset_mark); */
4627 defsubr (&Ssave_excursion);
4628 defsubr (&Ssave_current_buffer);
4630 defsubr (&Sbufsize);
4631 defsubr (&Spoint_max);
4632 defsubr (&Spoint_min);
4633 defsubr (&Spoint_min_marker);
4634 defsubr (&Spoint_max_marker);
4635 defsubr (&Sgap_position);
4636 defsubr (&Sgap_size);
4637 defsubr (&Sposition_bytes);
4638 defsubr (&Sbyte_to_position);
4640 defsubr (&Sbobp);
4641 defsubr (&Seobp);
4642 defsubr (&Sbolp);
4643 defsubr (&Seolp);
4644 defsubr (&Sfollowing_char);
4645 defsubr (&Sprevious_char);
4646 defsubr (&Schar_after);
4647 defsubr (&Schar_before);
4648 defsubr (&Sinsert);
4649 defsubr (&Sinsert_before_markers);
4650 defsubr (&Sinsert_and_inherit);
4651 defsubr (&Sinsert_and_inherit_before_markers);
4652 defsubr (&Sinsert_char);
4653 defsubr (&Sinsert_byte);
4655 defsubr (&Suser_login_name);
4656 defsubr (&Suser_real_login_name);
4657 defsubr (&Suser_uid);
4658 defsubr (&Suser_real_uid);
4659 defsubr (&Suser_full_name);
4660 defsubr (&Semacs_pid);
4661 defsubr (&Scurrent_time);
4662 defsubr (&Sget_internal_run_time);
4663 defsubr (&Sformat_time_string);
4664 defsubr (&Sfloat_time);
4665 defsubr (&Sdecode_time);
4666 defsubr (&Sencode_time);
4667 defsubr (&Scurrent_time_string);
4668 defsubr (&Scurrent_time_zone);
4669 defsubr (&Sset_time_zone_rule);
4670 defsubr (&Ssystem_name);
4671 defsubr (&Smessage);
4672 defsubr (&Smessage_box);
4673 defsubr (&Smessage_or_box);
4674 defsubr (&Scurrent_message);
4675 defsubr (&Sformat);
4677 defsubr (&Sinsert_buffer_substring);
4678 defsubr (&Scompare_buffer_substrings);
4679 defsubr (&Ssubst_char_in_region);
4680 defsubr (&Stranslate_region_internal);
4681 defsubr (&Sdelete_region);
4682 defsubr (&Sdelete_and_extract_region);
4683 defsubr (&Swiden);
4684 defsubr (&Snarrow_to_region);
4685 defsubr (&Ssave_restriction);
4686 defsubr (&Stranspose_regions);