Fix previous change. Define ftfont_variation_glyphs
[emacs.git] / src / editfns.c
blob9d6ff9be6556920197e6486a5a5860e2413c87a2
1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <sys/types.h>
24 #include <stdio.h>
26 #ifdef HAVE_PWD_H
27 #include <pwd.h>
28 #endif
30 #ifdef HAVE_UNISTD_H
31 #include <unistd.h>
32 #endif
34 #ifdef HAVE_SYS_UTSNAME_H
35 #include <sys/utsname.h>
36 #endif
38 #include "lisp.h"
40 /* systime.h includes <sys/time.h> which, on some systems, is required
41 for <sys/resource.h>; thus systime.h must be included before
42 <sys/resource.h> */
43 #include "systime.h"
45 #if defined HAVE_SYS_RESOURCE_H
46 #include <sys/resource.h>
47 #endif
49 #include <ctype.h>
51 #include "intervals.h"
52 #include "buffer.h"
53 #include "character.h"
54 #include "coding.h"
55 #include "frame.h"
56 #include "window.h"
57 #include "blockinput.h"
59 #ifdef STDC_HEADERS
60 #include <float.h>
61 #define MAX_10_EXP DBL_MAX_10_EXP
62 #else
63 #define MAX_10_EXP 310
64 #endif
66 #ifndef NULL
67 #define NULL 0
68 #endif
70 #ifndef USER_FULL_NAME
71 #define USER_FULL_NAME pw->pw_gecos
72 #endif
74 #ifndef USE_CRT_DLL
75 extern char **environ;
76 #endif
78 #define TM_YEAR_BASE 1900
80 /* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
81 asctime to have well-defined behavior. */
82 #ifndef TM_YEAR_IN_ASCTIME_RANGE
83 # define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
84 (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
85 #endif
87 extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
88 const struct tm *, int));
90 #ifdef WINDOWSNT
91 extern Lisp_Object w32_get_internal_run_time ();
92 #endif
94 static int tm_diff P_ ((struct tm *, struct tm *));
95 static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
96 static void update_buffer_properties P_ ((int, int));
97 static Lisp_Object region_limit P_ ((int));
98 int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
99 static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
100 size_t, const struct tm *, int));
101 static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
102 void (*) (Lisp_Object, EMACS_INT,
103 EMACS_INT, EMACS_INT,
104 EMACS_INT, int),
105 int, int, Lisp_Object *);
106 static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
107 static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
108 static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
110 #ifdef HAVE_INDEX
111 extern char *index P_ ((const char *, int));
112 #endif
114 Lisp_Object Vbuffer_access_fontify_functions;
115 Lisp_Object Qbuffer_access_fontify_functions;
116 Lisp_Object Vbuffer_access_fontified_property;
118 Lisp_Object Fuser_full_name P_ ((Lisp_Object));
120 /* Non-nil means don't stop at field boundary in text motion commands. */
122 Lisp_Object Vinhibit_field_text_motion;
124 /* Some static data, and a function to initialize it for each run */
126 Lisp_Object Vsystem_name;
127 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
128 Lisp_Object Vuser_full_name; /* full name of current user */
129 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER */
130 Lisp_Object Voperating_system_release; /* Operating System Release */
132 /* Symbol for the text property used to mark fields. */
134 Lisp_Object Qfield;
136 /* A special value for Qfield properties. */
138 Lisp_Object Qboundary;
141 void
142 init_editfns ()
144 char *user_name;
145 register unsigned char *p;
146 struct passwd *pw; /* password entry for the current user */
147 Lisp_Object tem;
149 /* Set up system_name even when dumping. */
150 init_system_name ();
152 #ifndef CANNOT_DUMP
153 /* Don't bother with this on initial start when just dumping out */
154 if (!initialized)
155 return;
156 #endif /* not CANNOT_DUMP */
158 pw = (struct passwd *) getpwuid (getuid ());
159 #ifdef MSDOS
160 /* We let the real user name default to "root" because that's quite
161 accurate on MSDOG and because it lets Emacs find the init file.
162 (The DVX libraries override the Djgpp libraries here.) */
163 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
164 #else
165 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
166 #endif
168 /* Get the effective user name, by consulting environment variables,
169 or the effective uid if those are unset. */
170 user_name = (char *) getenv ("LOGNAME");
171 if (!user_name)
172 #ifdef WINDOWSNT
173 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
174 #else /* WINDOWSNT */
175 user_name = (char *) getenv ("USER");
176 #endif /* WINDOWSNT */
177 if (!user_name)
179 pw = (struct passwd *) getpwuid (geteuid ());
180 user_name = (char *) (pw ? pw->pw_name : "unknown");
182 Vuser_login_name = build_string (user_name);
184 /* If the user name claimed in the environment vars differs from
185 the real uid, use the claimed name to find the full name. */
186 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
187 Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
188 : Vuser_login_name);
190 p = (unsigned char *) getenv ("NAME");
191 if (p)
192 Vuser_full_name = build_string (p);
193 else if (NILP (Vuser_full_name))
194 Vuser_full_name = build_string ("unknown");
196 #ifdef HAVE_SYS_UTSNAME_H
198 struct utsname uts;
199 uname (&uts);
200 Voperating_system_release = build_string (uts.release);
202 #else
203 Voperating_system_release = Qnil;
204 #endif
207 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
208 doc: /* Convert arg CHAR to a string containing that character.
209 usage: (char-to-string CHAR) */)
210 (character)
211 Lisp_Object character;
213 int len;
214 unsigned char str[MAX_MULTIBYTE_LENGTH];
216 CHECK_CHARACTER (character);
218 len = CHAR_STRING (XFASTINT (character), str);
219 return make_string_from_bytes (str, 1, len);
222 DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
223 doc: /* Convert arg STRING to a character, the first character of that string.
224 A multibyte character is handled correctly. */)
225 (string)
226 register Lisp_Object string;
228 register Lisp_Object val;
229 CHECK_STRING (string);
230 if (SCHARS (string))
232 if (STRING_MULTIBYTE (string))
233 XSETFASTINT (val, STRING_CHAR (SDATA (string), SBYTES (string)));
234 else
235 XSETFASTINT (val, SREF (string, 0));
237 else
238 XSETFASTINT (val, 0);
239 return val;
242 static Lisp_Object
243 buildmark (charpos, bytepos)
244 int charpos, bytepos;
246 register Lisp_Object mark;
247 mark = Fmake_marker ();
248 set_marker_both (mark, Qnil, charpos, bytepos);
249 return mark;
252 DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
253 doc: /* Return value of point, as an integer.
254 Beginning of buffer is position (point-min). */)
257 Lisp_Object temp;
258 XSETFASTINT (temp, PT);
259 return temp;
262 DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
263 doc: /* Return value of point, as a marker object. */)
266 return buildmark (PT, PT_BYTE);
270 clip_to_bounds (lower, num, upper)
271 int lower, num, upper;
273 if (num < lower)
274 return lower;
275 else if (num > upper)
276 return upper;
277 else
278 return num;
281 DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
282 doc: /* Set point to POSITION, a number or marker.
283 Beginning of buffer is position (point-min), end is (point-max).
285 The return value is POSITION. */)
286 (position)
287 register Lisp_Object position;
289 int pos;
291 if (MARKERP (position)
292 && current_buffer == XMARKER (position)->buffer)
294 pos = marker_position (position);
295 if (pos < BEGV)
296 SET_PT_BOTH (BEGV, BEGV_BYTE);
297 else if (pos > ZV)
298 SET_PT_BOTH (ZV, ZV_BYTE);
299 else
300 SET_PT_BOTH (pos, marker_byte_position (position));
302 return position;
305 CHECK_NUMBER_COERCE_MARKER (position);
307 pos = clip_to_bounds (BEGV, XINT (position), ZV);
308 SET_PT (pos);
309 return position;
313 /* Return the start or end position of the region.
314 BEGINNINGP non-zero means return the start.
315 If there is no region active, signal an error. */
317 static Lisp_Object
318 region_limit (beginningp)
319 int beginningp;
321 extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
322 Lisp_Object m;
324 if (!NILP (Vtransient_mark_mode)
325 && NILP (Vmark_even_if_inactive)
326 && NILP (current_buffer->mark_active))
327 xsignal0 (Qmark_inactive);
329 m = Fmarker_position (current_buffer->mark);
330 if (NILP (m))
331 error ("The mark is not set now, so there is no region");
333 if ((PT < XFASTINT (m)) == (beginningp != 0))
334 m = make_number (PT);
335 return m;
338 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
339 doc: /* Return position of beginning of region, as an integer. */)
342 return region_limit (1);
345 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
346 doc: /* Return position of end of region, as an integer. */)
349 return region_limit (0);
352 DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
353 doc: /* Return this buffer's mark, as a marker object.
354 Watch out! Moving this marker changes the mark position.
355 If you set the marker not to point anywhere, the buffer will have no mark. */)
358 return current_buffer->mark;
362 /* Find all the overlays in the current buffer that touch position POS.
363 Return the number found, and store them in a vector in VEC
364 of length LEN. */
366 static int
367 overlays_around (pos, vec, len)
368 int pos;
369 Lisp_Object *vec;
370 int len;
372 Lisp_Object overlay, start, end;
373 struct Lisp_Overlay *tail;
374 int startpos, endpos;
375 int idx = 0;
377 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
379 XSETMISC (overlay, tail);
381 end = OVERLAY_END (overlay);
382 endpos = OVERLAY_POSITION (end);
383 if (endpos < pos)
384 break;
385 start = OVERLAY_START (overlay);
386 startpos = OVERLAY_POSITION (start);
387 if (startpos <= pos)
389 if (idx < len)
390 vec[idx] = overlay;
391 /* Keep counting overlays even if we can't return them all. */
392 idx++;
396 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
398 XSETMISC (overlay, tail);
400 start = OVERLAY_START (overlay);
401 startpos = OVERLAY_POSITION (start);
402 if (pos < startpos)
403 break;
404 end = OVERLAY_END (overlay);
405 endpos = OVERLAY_POSITION (end);
406 if (pos <= endpos)
408 if (idx < len)
409 vec[idx] = overlay;
410 idx++;
414 return idx;
417 /* Return the value of property PROP, in OBJECT at POSITION.
418 It's the value of PROP that a char inserted at POSITION would get.
419 OBJECT is optional and defaults to the current buffer.
420 If OBJECT is a buffer, then overlay properties are considered as well as
421 text properties.
422 If OBJECT is a window, then that window's buffer is used, but
423 window-specific overlays are considered only if they are associated
424 with OBJECT. */
425 Lisp_Object
426 get_pos_property (position, prop, object)
427 Lisp_Object position, object;
428 register Lisp_Object prop;
430 CHECK_NUMBER_COERCE_MARKER (position);
432 if (NILP (object))
433 XSETBUFFER (object, current_buffer);
434 else if (WINDOWP (object))
435 object = XWINDOW (object)->buffer;
437 if (!BUFFERP (object))
438 /* pos-property only makes sense in buffers right now, since strings
439 have no overlays and no notion of insertion for which stickiness
440 could be obeyed. */
441 return Fget_text_property (position, prop, object);
442 else
444 int posn = XINT (position);
445 int noverlays;
446 Lisp_Object *overlay_vec, tem;
447 struct buffer *obuf = current_buffer;
449 set_buffer_temp (XBUFFER (object));
451 /* First try with room for 40 overlays. */
452 noverlays = 40;
453 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
454 noverlays = overlays_around (posn, overlay_vec, noverlays);
456 /* If there are more than 40,
457 make enough space for all, and try again. */
458 if (noverlays > 40)
460 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
461 noverlays = overlays_around (posn, overlay_vec, noverlays);
463 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
465 set_buffer_temp (obuf);
467 /* Now check the overlays in order of decreasing priority. */
468 while (--noverlays >= 0)
470 Lisp_Object ol = overlay_vec[noverlays];
471 tem = Foverlay_get (ol, prop);
472 if (!NILP (tem))
474 /* Check the overlay is indeed active at point. */
475 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
476 if ((OVERLAY_POSITION (start) == posn
477 && XMARKER (start)->insertion_type == 1)
478 || (OVERLAY_POSITION (finish) == posn
479 && XMARKER (finish)->insertion_type == 0))
480 ; /* The overlay will not cover a char inserted at point. */
481 else
483 return tem;
488 { /* Now check the text properties. */
489 int stickiness = text_property_stickiness (prop, position, object);
490 if (stickiness > 0)
491 return Fget_text_property (position, prop, object);
492 else if (stickiness < 0
493 && XINT (position) > BUF_BEGV (XBUFFER (object)))
494 return Fget_text_property (make_number (XINT (position) - 1),
495 prop, object);
496 else
497 return Qnil;
502 /* Find the field surrounding POS in *BEG and *END. If POS is nil,
503 the value of point is used instead. If BEG or END is null,
504 means don't store the beginning or end of the field.
506 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
507 results; they do not effect boundary behavior.
509 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
510 position of a field, then the beginning of the previous field is
511 returned instead of the beginning of POS's field (since the end of a
512 field is actually also the beginning of the next input field, this
513 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
514 true case, if two fields are separated by a field with the special
515 value `boundary', and POS lies within it, then the two separated
516 fields are considered to be adjacent, and POS between them, when
517 finding the beginning and ending of the "merged" field.
519 Either BEG or END may be 0, in which case the corresponding value
520 is not stored. */
522 static void
523 find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
524 Lisp_Object pos;
525 Lisp_Object merge_at_boundary;
526 Lisp_Object beg_limit, end_limit;
527 int *beg, *end;
529 /* Fields right before and after the point. */
530 Lisp_Object before_field, after_field;
531 /* 1 if POS counts as the start of a field. */
532 int at_field_start = 0;
533 /* 1 if POS counts as the end of a field. */
534 int at_field_end = 0;
536 if (NILP (pos))
537 XSETFASTINT (pos, PT);
538 else
539 CHECK_NUMBER_COERCE_MARKER (pos);
541 after_field
542 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
543 before_field
544 = (XFASTINT (pos) > BEGV
545 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
546 Qfield, Qnil, NULL)
547 /* Using nil here would be a more obvious choice, but it would
548 fail when the buffer starts with a non-sticky field. */
549 : after_field);
551 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
552 and POS is at beginning of a field, which can also be interpreted
553 as the end of the previous field. Note that the case where if
554 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
555 more natural one; then we avoid treating the beginning of a field
556 specially. */
557 if (NILP (merge_at_boundary))
559 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
560 if (!EQ (field, after_field))
561 at_field_end = 1;
562 if (!EQ (field, before_field))
563 at_field_start = 1;
564 if (NILP (field) && at_field_start && at_field_end)
565 /* If an inserted char would have a nil field while the surrounding
566 text is non-nil, we're probably not looking at a
567 zero-length field, but instead at a non-nil field that's
568 not intended for editing (such as comint's prompts). */
569 at_field_end = at_field_start = 0;
572 /* Note about special `boundary' fields:
574 Consider the case where the point (`.') is between the fields `x' and `y':
576 xxxx.yyyy
578 In this situation, if merge_at_boundary is true, we consider the
579 `x' and `y' fields as forming one big merged field, and so the end
580 of the field is the end of `y'.
582 However, if `x' and `y' are separated by a special `boundary' field
583 (a field with a `field' char-property of 'boundary), then we ignore
584 this special field when merging adjacent fields. Here's the same
585 situation, but with a `boundary' field between the `x' and `y' fields:
587 xxx.BBBByyyy
589 Here, if point is at the end of `x', the beginning of `y', or
590 anywhere in-between (within the `boundary' field), we merge all
591 three fields and consider the beginning as being the beginning of
592 the `x' field, and the end as being the end of the `y' field. */
594 if (beg)
596 if (at_field_start)
597 /* POS is at the edge of a field, and we should consider it as
598 the beginning of the following field. */
599 *beg = XFASTINT (pos);
600 else
601 /* Find the previous field boundary. */
603 Lisp_Object p = pos;
604 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
605 /* Skip a `boundary' field. */
606 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
607 beg_limit);
609 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
610 beg_limit);
611 *beg = NILP (p) ? BEGV : XFASTINT (p);
615 if (end)
617 if (at_field_end)
618 /* POS is at the edge of a field, and we should consider it as
619 the end of the previous field. */
620 *end = XFASTINT (pos);
621 else
622 /* Find the next field boundary. */
624 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
625 /* Skip a `boundary' field. */
626 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
627 end_limit);
629 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
630 end_limit);
631 *end = NILP (pos) ? ZV : XFASTINT (pos);
637 DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
638 doc: /* Delete the field surrounding POS.
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 (pos)
642 Lisp_Object pos;
644 int beg, end;
645 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
646 if (beg != end)
647 del_range (beg, end);
648 return Qnil;
651 DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
652 doc: /* Return the contents of the field surrounding POS as a string.
653 A field is a region of text with the same `field' property.
654 If POS is nil, the value of point is used for POS. */)
655 (pos)
656 Lisp_Object pos;
658 int beg, end;
659 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
660 return make_buffer_string (beg, end, 1);
663 DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
664 doc: /* Return the contents of the field around POS, without text properties.
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 (pos)
668 Lisp_Object pos;
670 int beg, end;
671 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
672 return make_buffer_string (beg, end, 0);
675 DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
676 doc: /* Return the beginning of the field surrounding POS.
677 A field is a region of text with the same `field' property.
678 If POS is nil, the value of point is used for POS.
679 If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
680 field, then the beginning of the *previous* field is returned.
681 If LIMIT is non-nil, it is a buffer position; if the beginning of the field
682 is before LIMIT, then LIMIT will be returned instead. */)
683 (pos, escape_from_edge, limit)
684 Lisp_Object pos, escape_from_edge, limit;
686 int beg;
687 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
688 return make_number (beg);
691 DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
692 doc: /* Return the end of the field surrounding POS.
693 A field is a region of text with the same `field' property.
694 If POS is nil, the value of point is used for POS.
695 If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
696 then the end of the *following* field is returned.
697 If LIMIT is non-nil, it is a buffer position; if the end of the field
698 is after LIMIT, then LIMIT will be returned instead. */)
699 (pos, escape_from_edge, limit)
700 Lisp_Object pos, escape_from_edge, limit;
702 int end;
703 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
704 return make_number (end);
707 DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
708 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
710 A field is a region of text with the same `field' property.
711 If NEW-POS is nil, then the current point is used instead, and set to the
712 constrained position if that is different.
714 If OLD-POS is at the boundary of two fields, then the allowable
715 positions for NEW-POS depends on the value of the optional argument
716 ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
717 constrained to the field that has the same `field' char-property
718 as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
719 is non-nil, NEW-POS is constrained to the union of the two adjacent
720 fields. Additionally, if two fields are separated by another field with
721 the special value `boundary', then any point within this special field is
722 also considered to be `on the boundary'.
724 If the optional argument ONLY-IN-LINE is non-nil and constraining
725 NEW-POS would move it to a different line, NEW-POS is returned
726 unconstrained. This useful for commands that move by line, like
727 \\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
728 only in the case where they can still move to the right line.
730 If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
731 a non-nil property of that name, then any field boundaries are ignored.
733 Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
734 (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
735 Lisp_Object new_pos, old_pos;
736 Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
738 /* If non-zero, then the original point, before re-positioning. */
739 int orig_point = 0;
740 int fwd;
741 Lisp_Object prev_old, prev_new;
743 if (NILP (new_pos))
744 /* Use the current point, and afterwards, set it. */
746 orig_point = PT;
747 XSETFASTINT (new_pos, PT);
750 CHECK_NUMBER_COERCE_MARKER (new_pos);
751 CHECK_NUMBER_COERCE_MARKER (old_pos);
753 fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));
755 prev_old = make_number (XFASTINT (old_pos) - 1);
756 prev_new = make_number (XFASTINT (new_pos) - 1);
758 if (NILP (Vinhibit_field_text_motion)
759 && !EQ (new_pos, old_pos)
760 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
761 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
762 /* To recognize field boundaries, we must also look at the
763 previous positions; we could use `get_pos_property'
764 instead, but in itself that would fail inside non-sticky
765 fields (like comint prompts). */
766 || (XFASTINT (new_pos) > BEGV
767 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
768 || (XFASTINT (old_pos) > BEGV
769 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
770 && (NILP (inhibit_capture_property)
771 /* Field boundaries are again a problem; but now we must
772 decide the case exactly, so we need to call
773 `get_pos_property' as well. */
774 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
775 && (XFASTINT (old_pos) <= BEGV
776 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
777 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
778 /* It is possible that NEW_POS is not within the same field as
779 OLD_POS; try to move NEW_POS so that it is. */
781 int shortage;
782 Lisp_Object field_bound;
784 if (fwd)
785 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
786 else
787 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
789 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
790 other side of NEW_POS, which would mean that NEW_POS is
791 already acceptable, and it's not necessary to constrain it
792 to FIELD_BOUND. */
793 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
794 /* NEW_POS should be constrained, but only if either
795 ONLY_IN_LINE is nil (in which case any constraint is OK),
796 or NEW_POS and FIELD_BOUND are on the same line (in which
797 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
798 && (NILP (only_in_line)
799 /* This is the ONLY_IN_LINE case, check that NEW_POS and
800 FIELD_BOUND are on the same line by seeing whether
801 there's an intervening newline or not. */
802 || (scan_buffer ('\n',
803 XFASTINT (new_pos), XFASTINT (field_bound),
804 fwd ? -1 : 1, &shortage, 1),
805 shortage != 0)))
806 /* Constrain NEW_POS to FIELD_BOUND. */
807 new_pos = field_bound;
809 if (orig_point && XFASTINT (new_pos) != orig_point)
810 /* The NEW_POS argument was originally nil, so automatically set PT. */
811 SET_PT (XFASTINT (new_pos));
814 return new_pos;
818 DEFUN ("line-beginning-position",
819 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
820 doc: /* Return the character position of the first character on the current line.
821 With argument N not nil or 1, move forward N - 1 lines first.
822 If scan reaches end of buffer, return that position.
824 This function constrains the returned position to the current field
825 unless that would be on a different line than the original,
826 unconstrained result. If N is nil or 1, and a front-sticky field
827 starts at point, the scan stops as soon as it starts. To ignore field
828 boundaries bind `inhibit-field-text-motion' to t.
830 This function does not move point. */)
832 Lisp_Object n;
834 int orig, orig_byte, end;
835 int count = SPECPDL_INDEX ();
836 specbind (Qinhibit_point_motion_hooks, Qt);
838 if (NILP (n))
839 XSETFASTINT (n, 1);
840 else
841 CHECK_NUMBER (n);
843 orig = PT;
844 orig_byte = PT_BYTE;
845 Fforward_line (make_number (XINT (n) - 1));
846 end = PT;
848 SET_PT_BOTH (orig, orig_byte);
850 unbind_to (count, Qnil);
852 /* Return END constrained to the current input field. */
853 return Fconstrain_to_field (make_number (end), make_number (orig),
854 XINT (n) != 1 ? Qt : Qnil,
855 Qt, Qnil);
858 DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
859 doc: /* Return the character position of the last character on the current line.
860 With argument N not nil or 1, move forward N - 1 lines first.
861 If scan reaches end of buffer, return that position.
863 This function constrains the returned position to the current field
864 unless that would be on a different line than the original,
865 unconstrained result. If N is nil or 1, and a rear-sticky field ends
866 at point, the scan stops as soon as it starts. To ignore field
867 boundaries bind `inhibit-field-text-motion' to t.
869 This function does not move point. */)
871 Lisp_Object n;
873 int end_pos;
874 int orig = PT;
876 if (NILP (n))
877 XSETFASTINT (n, 1);
878 else
879 CHECK_NUMBER (n);
881 end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));
883 /* Return END_POS constrained to the current input field. */
884 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
885 Qnil, Qt, Qnil);
889 Lisp_Object
890 save_excursion_save ()
892 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
893 == current_buffer);
895 return Fcons (Fpoint_marker (),
896 Fcons (Fcopy_marker (current_buffer->mark, Qnil),
897 Fcons (visible ? Qt : Qnil,
898 Fcons (current_buffer->mark_active,
899 selected_window))));
902 Lisp_Object
903 save_excursion_restore (info)
904 Lisp_Object info;
906 Lisp_Object tem, tem1, omark, nmark;
907 struct gcpro gcpro1, gcpro2, gcpro3;
908 int visible_p;
910 tem = Fmarker_buffer (XCAR (info));
911 /* If buffer being returned to is now deleted, avoid error */
912 /* Otherwise could get error here while unwinding to top level
913 and crash */
914 /* In that case, Fmarker_buffer returns nil now. */
915 if (NILP (tem))
916 return Qnil;
918 omark = nmark = Qnil;
919 GCPRO3 (info, omark, nmark);
921 Fset_buffer (tem);
923 /* Point marker. */
924 tem = XCAR (info);
925 Fgoto_char (tem);
926 unchain_marker (XMARKER (tem));
928 /* Mark marker. */
929 info = XCDR (info);
930 tem = XCAR (info);
931 omark = Fmarker_position (current_buffer->mark);
932 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
933 nmark = Fmarker_position (tem);
934 unchain_marker (XMARKER (tem));
936 /* visible */
937 info = XCDR (info);
938 visible_p = !NILP (XCAR (info));
940 #if 0 /* We used to make the current buffer visible in the selected window
941 if that was true previously. That avoids some anomalies.
942 But it creates others, and it wasn't documented, and it is simpler
943 and cleaner never to alter the window/buffer connections. */
944 tem1 = Fcar (tem);
945 if (!NILP (tem1)
946 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
947 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
948 #endif /* 0 */
950 /* Mark active */
951 info = XCDR (info);
952 tem = XCAR (info);
953 tem1 = current_buffer->mark_active;
954 current_buffer->mark_active = tem;
956 if (!NILP (Vrun_hooks))
958 /* If mark is active now, and either was not active
959 or was at a different place, run the activate hook. */
960 if (! NILP (current_buffer->mark_active))
962 if (! EQ (omark, nmark))
963 call1 (Vrun_hooks, intern ("activate-mark-hook"));
965 /* If mark has ceased to be active, run deactivate hook. */
966 else if (! NILP (tem1))
967 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
970 /* If buffer was visible in a window, and a different window was
971 selected, and the old selected window is still showing this
972 buffer, restore point in that window. */
973 tem = XCDR (info);
974 if (visible_p
975 && !EQ (tem, selected_window)
976 && (tem1 = XWINDOW (tem)->buffer,
977 (/* Window is live... */
978 BUFFERP (tem1)
979 /* ...and it shows the current buffer. */
980 && XBUFFER (tem1) == current_buffer)))
981 Fset_window_point (tem, make_number (PT));
983 UNGCPRO;
984 return Qnil;
987 DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
988 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
989 Executes BODY just like `progn'.
990 The values of point, mark and the current buffer are restored
991 even in case of abnormal exit (throw or error).
992 The state of activation of the mark is also restored.
994 This construct does not save `deactivate-mark', and therefore
995 functions that change the buffer will still cause deactivation
996 of the mark at the end of the command. To prevent that, bind
997 `deactivate-mark' with `let'.
999 usage: (save-excursion &rest BODY) */)
1000 (args)
1001 Lisp_Object args;
1003 register Lisp_Object val;
1004 int count = SPECPDL_INDEX ();
1006 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1008 val = Fprogn (args);
1009 return unbind_to (count, val);
1012 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1013 doc: /* Save the current buffer; execute BODY; restore the current buffer.
1014 Executes BODY just like `progn'.
1015 usage: (save-current-buffer &rest BODY) */)
1016 (args)
1017 Lisp_Object args;
1019 Lisp_Object val;
1020 int count = SPECPDL_INDEX ();
1022 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1024 val = Fprogn (args);
1025 return unbind_to (count, val);
1028 DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1029 doc: /* Return the number of characters in the current buffer.
1030 If BUFFER, return the number of characters in that buffer instead. */)
1031 (buffer)
1032 Lisp_Object buffer;
1034 if (NILP (buffer))
1035 return make_number (Z - BEG);
1036 else
1038 CHECK_BUFFER (buffer);
1039 return make_number (BUF_Z (XBUFFER (buffer))
1040 - BUF_BEG (XBUFFER (buffer)));
1044 DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1045 doc: /* Return the minimum permissible value of point in the current buffer.
1046 This is 1, unless narrowing (a buffer restriction) is in effect. */)
1049 Lisp_Object temp;
1050 XSETFASTINT (temp, BEGV);
1051 return temp;
1054 DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1055 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1056 This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
1059 return buildmark (BEGV, BEGV_BYTE);
1062 DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1063 doc: /* Return the maximum permissible value of point in the current buffer.
1064 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1065 is in effect, in which case it is less. */)
1068 Lisp_Object temp;
1069 XSETFASTINT (temp, ZV);
1070 return temp;
1073 DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1074 doc: /* Return a marker to the maximum permissible value of point in this buffer.
1075 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1076 is in effect, in which case it is less. */)
1079 return buildmark (ZV, ZV_BYTE);
1082 DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1083 doc: /* Return the position of the gap, in the current buffer.
1084 See also `gap-size'. */)
1087 Lisp_Object temp;
1088 XSETFASTINT (temp, GPT);
1089 return temp;
1092 DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1093 doc: /* Return the size of the current buffer's gap.
1094 See also `gap-position'. */)
1097 Lisp_Object temp;
1098 XSETFASTINT (temp, GAP_SIZE);
1099 return temp;
1102 DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1103 doc: /* Return the byte position for character position POSITION.
1104 If POSITION is out of range, the value is nil. */)
1105 (position)
1106 Lisp_Object position;
1108 CHECK_NUMBER_COERCE_MARKER (position);
1109 if (XINT (position) < BEG || XINT (position) > Z)
1110 return Qnil;
1111 return make_number (CHAR_TO_BYTE (XINT (position)));
1114 DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1115 doc: /* Return the character position for byte position BYTEPOS.
1116 If BYTEPOS is out of range, the value is nil. */)
1117 (bytepos)
1118 Lisp_Object bytepos;
1120 CHECK_NUMBER (bytepos);
1121 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1122 return Qnil;
1123 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1126 DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1127 doc: /* Return the character following point, as a number.
1128 At the end of the buffer or accessible region, return 0. */)
1131 Lisp_Object temp;
1132 if (PT >= ZV)
1133 XSETFASTINT (temp, 0);
1134 else
1135 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
1136 return temp;
1139 DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
1140 doc: /* Return the character preceding point, as a number.
1141 At the beginning of the buffer or accessible region, return 0. */)
1144 Lisp_Object temp;
1145 if (PT <= BEGV)
1146 XSETFASTINT (temp, 0);
1147 else if (!NILP (current_buffer->enable_multibyte_characters))
1149 int pos = PT_BYTE;
1150 DEC_POS (pos);
1151 XSETFASTINT (temp, FETCH_CHAR (pos));
1153 else
1154 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
1155 return temp;
1158 DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1159 doc: /* Return t if point is at the beginning of the buffer.
1160 If the buffer is narrowed, this means the beginning of the narrowed part. */)
1163 if (PT == BEGV)
1164 return Qt;
1165 return Qnil;
1168 DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1169 doc: /* Return t if point is at the end of the buffer.
1170 If the buffer is narrowed, this means the end of the narrowed part. */)
1173 if (PT == ZV)
1174 return Qt;
1175 return Qnil;
1178 DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1179 doc: /* Return t if point is at the beginning of a line. */)
1182 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
1183 return Qt;
1184 return Qnil;
1187 DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1188 doc: /* Return t if point is at the end of a line.
1189 `End of a line' includes point being at the end of the buffer. */)
1192 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
1193 return Qt;
1194 return Qnil;
1197 DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1198 doc: /* Return character in current buffer at position POS.
1199 POS is an integer or a marker and defaults to point.
1200 If POS is out of range, the value is nil. */)
1201 (pos)
1202 Lisp_Object pos;
1204 register int pos_byte;
1206 if (NILP (pos))
1208 pos_byte = PT_BYTE;
1209 XSETFASTINT (pos, PT);
1212 if (MARKERP (pos))
1214 pos_byte = marker_byte_position (pos);
1215 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1216 return Qnil;
1218 else
1220 CHECK_NUMBER_COERCE_MARKER (pos);
1221 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1222 return Qnil;
1224 pos_byte = CHAR_TO_BYTE (XINT (pos));
1227 return make_number (FETCH_CHAR (pos_byte));
1230 DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
1231 doc: /* Return character in current buffer preceding position POS.
1232 POS is an integer or a marker and defaults to point.
1233 If POS is out of range, the value is nil. */)
1234 (pos)
1235 Lisp_Object pos;
1237 register Lisp_Object val;
1238 register int pos_byte;
1240 if (NILP (pos))
1242 pos_byte = PT_BYTE;
1243 XSETFASTINT (pos, PT);
1246 if (MARKERP (pos))
1248 pos_byte = marker_byte_position (pos);
1250 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1251 return Qnil;
1253 else
1255 CHECK_NUMBER_COERCE_MARKER (pos);
1257 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
1258 return Qnil;
1260 pos_byte = CHAR_TO_BYTE (XINT (pos));
1263 if (!NILP (current_buffer->enable_multibyte_characters))
1265 DEC_POS (pos_byte);
1266 XSETFASTINT (val, FETCH_CHAR (pos_byte));
1268 else
1270 pos_byte--;
1271 XSETFASTINT (val, FETCH_BYTE (pos_byte));
1273 return val;
1276 DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
1277 doc: /* Return the name under which the user logged in, as a string.
1278 This is based on the effective uid, not the real uid.
1279 Also, if the environment variables LOGNAME or USER are set,
1280 that determines the value of this function.
1282 If optional argument UID is an integer or a float, return the login name
1283 of the user with that uid, or nil if there is no such user. */)
1284 (uid)
1285 Lisp_Object uid;
1287 struct passwd *pw;
1288 uid_t id;
1290 /* Set up the user name info if we didn't do it before.
1291 (That can happen if Emacs is dumpable
1292 but you decide to run `temacs -l loadup' and not dump. */
1293 if (INTEGERP (Vuser_login_name))
1294 init_editfns ();
1296 if (NILP (uid))
1297 return Vuser_login_name;
1299 id = (uid_t)XFLOATINT (uid);
1300 BLOCK_INPUT;
1301 pw = (struct passwd *) getpwuid (id);
1302 UNBLOCK_INPUT;
1303 return (pw ? build_string (pw->pw_name) : Qnil);
1306 DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
1307 0, 0, 0,
1308 doc: /* Return the name of the user's real uid, as a string.
1309 This ignores the environment variables LOGNAME and USER, so it differs from
1310 `user-login-name' when running under `su'. */)
1313 /* Set up the user name info if we didn't do it before.
1314 (That can happen if Emacs is dumpable
1315 but you decide to run `temacs -l loadup' and not dump. */
1316 if (INTEGERP (Vuser_login_name))
1317 init_editfns ();
1318 return Vuser_real_login_name;
1321 DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
1322 doc: /* Return the effective uid of Emacs.
1323 Value is an integer or a float, depending on the value. */)
1326 /* Assignment to EMACS_INT stops GCC whining about limited range of
1327 data type. */
1328 EMACS_INT euid = geteuid ();
1330 /* Make sure we don't produce a negative UID due to signed integer
1331 overflow. */
1332 if (euid < 0)
1333 return make_float ((double)geteuid ());
1334 return make_fixnum_or_float (euid);
1337 DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
1338 doc: /* Return the real uid of Emacs.
1339 Value is an integer or a float, depending on the value. */)
1342 /* Assignment to EMACS_INT stops GCC whining about limited range of
1343 data type. */
1344 EMACS_INT uid = getuid ();
1346 /* Make sure we don't produce a negative UID due to signed integer
1347 overflow. */
1348 if (uid < 0)
1349 return make_float ((double)getuid ());
1350 return make_fixnum_or_float (uid);
1353 DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
1354 doc: /* Return the full name of the user logged in, as a string.
1355 If the full name corresponding to Emacs's userid is not known,
1356 return "unknown".
1358 If optional argument UID is an integer or float, return the full name
1359 of the user with that uid, or nil if there is no such user.
1360 If UID is a string, return the full name of the user with that login
1361 name, or nil if there is no such user. */)
1362 (uid)
1363 Lisp_Object uid;
1365 struct passwd *pw;
1366 register unsigned char *p, *q;
1367 Lisp_Object full;
1369 if (NILP (uid))
1370 return Vuser_full_name;
1371 else if (NUMBERP (uid))
1373 BLOCK_INPUT;
1374 pw = (struct passwd *) getpwuid ((uid_t) XFLOATINT (uid));
1375 UNBLOCK_INPUT;
1377 else if (STRINGP (uid))
1379 BLOCK_INPUT;
1380 pw = (struct passwd *) getpwnam (SDATA (uid));
1381 UNBLOCK_INPUT;
1383 else
1384 error ("Invalid UID specification");
1386 if (!pw)
1387 return Qnil;
1389 p = (unsigned char *) USER_FULL_NAME;
1390 /* Chop off everything after the first comma. */
1391 q = (unsigned char *) index (p, ',');
1392 full = make_string (p, q ? q - p : strlen (p));
1394 #ifdef AMPERSAND_FULL_NAME
1395 p = SDATA (full);
1396 q = (unsigned char *) index (p, '&');
1397 /* Substitute the login name for the &, upcasing the first character. */
1398 if (q)
1400 register unsigned char *r;
1401 Lisp_Object login;
1403 login = Fuser_login_name (make_number (pw->pw_uid));
1404 r = (unsigned char *) alloca (strlen (p) + SCHARS (login) + 1);
1405 bcopy (p, r, q - p);
1406 r[q - p] = 0;
1407 strcat (r, SDATA (login));
1408 r[q - p] = UPCASE (r[q - p]);
1409 strcat (r, q + 1);
1410 full = build_string (r);
1412 #endif /* AMPERSAND_FULL_NAME */
1414 return full;
1417 DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1418 doc: /* Return the host name of the machine you are running on, as a string. */)
1421 return Vsystem_name;
1424 /* For the benefit of callers who don't want to include lisp.h */
1426 char *
1427 get_system_name ()
1429 if (STRINGP (Vsystem_name))
1430 return (char *) SDATA (Vsystem_name);
1431 else
1432 return "";
1435 char *
1436 get_operating_system_release()
1438 if (STRINGP (Voperating_system_release))
1439 return (char *) SDATA (Voperating_system_release);
1440 else
1441 return "";
1444 DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
1445 doc: /* Return the process ID of Emacs, as an integer. */)
1448 return make_number (getpid ());
1451 DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1452 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
1453 The time is returned as a list of three integers. The first has the
1454 most significant 16 bits of the seconds, while the second has the
1455 least significant 16 bits. The third integer gives the microsecond
1456 count.
1458 The microsecond count is zero on systems that do not provide
1459 resolution finer than a second. */)
1462 EMACS_TIME t;
1464 EMACS_GET_TIME (t);
1465 return list3 (make_number ((EMACS_SECS (t) >> 16) & 0xffff),
1466 make_number ((EMACS_SECS (t) >> 0) & 0xffff),
1467 make_number (EMACS_USECS (t)));
1470 DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
1471 0, 0, 0,
1472 doc: /* Return the current run time used by Emacs.
1473 The time is returned as a list of three integers. The first has the
1474 most significant 16 bits of the seconds, while the second has the
1475 least significant 16 bits. The third integer gives the microsecond
1476 count.
1478 On systems that can't determine the run time, `get-internal-run-time'
1479 does the same thing as `current-time'. The microsecond count is zero
1480 on systems that do not provide resolution finer than a second. */)
1483 #ifdef HAVE_GETRUSAGE
1484 struct rusage usage;
1485 int secs, usecs;
1487 if (getrusage (RUSAGE_SELF, &usage) < 0)
1488 /* This shouldn't happen. What action is appropriate? */
1489 xsignal0 (Qerror);
1491 /* Sum up user time and system time. */
1492 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1493 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1494 if (usecs >= 1000000)
1496 usecs -= 1000000;
1497 secs++;
1500 return list3 (make_number ((secs >> 16) & 0xffff),
1501 make_number ((secs >> 0) & 0xffff),
1502 make_number (usecs));
1503 #else /* ! HAVE_GETRUSAGE */
1504 #ifdef WINDOWSNT
1505 return w32_get_internal_run_time ();
1506 #else /* ! WINDOWSNT */
1507 return Fcurrent_time ();
1508 #endif /* WINDOWSNT */
1509 #endif /* HAVE_GETRUSAGE */
1514 lisp_time_argument (specified_time, result, usec)
1515 Lisp_Object specified_time;
1516 time_t *result;
1517 int *usec;
1519 if (NILP (specified_time))
1521 if (usec)
1523 EMACS_TIME t;
1525 EMACS_GET_TIME (t);
1526 *usec = EMACS_USECS (t);
1527 *result = EMACS_SECS (t);
1528 return 1;
1530 else
1531 return time (result) != -1;
1533 else
1535 Lisp_Object high, low;
1536 high = Fcar (specified_time);
1537 CHECK_NUMBER (high);
1538 low = Fcdr (specified_time);
1539 if (CONSP (low))
1541 if (usec)
1543 Lisp_Object usec_l = Fcdr (low);
1544 if (CONSP (usec_l))
1545 usec_l = Fcar (usec_l);
1546 if (NILP (usec_l))
1547 *usec = 0;
1548 else
1550 CHECK_NUMBER (usec_l);
1551 *usec = XINT (usec_l);
1554 low = Fcar (low);
1556 else if (usec)
1557 *usec = 0;
1558 CHECK_NUMBER (low);
1559 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1560 return *result >> 16 == XINT (high);
1564 DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
1565 doc: /* Return the current time, as a float number of seconds since the epoch.
1566 If SPECIFIED-TIME is given, it is the time to convert to float
1567 instead of the current time. The argument should have the form
1568 (HIGH LOW) or (HIGH LOW USEC). Thus, you can use times obtained from
1569 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1570 have the form (HIGH . LOW), but this is considered obsolete.
1572 WARNING: Since the result is floating point, it may not be exact.
1573 Do not use this function if precise time stamps are required. */)
1574 (specified_time)
1575 Lisp_Object specified_time;
1577 time_t sec;
1578 int usec;
1580 if (! lisp_time_argument (specified_time, &sec, &usec))
1581 error ("Invalid time specification");
1583 return make_float ((sec * 1e6 + usec) / 1e6);
1586 /* Write information into buffer S of size MAXSIZE, according to the
1587 FORMAT of length FORMAT_LEN, using time information taken from *TP.
1588 Default to Universal Time if UT is nonzero, local time otherwise.
1589 Return the number of bytes written, not including the terminating
1590 '\0'. If S is NULL, nothing will be written anywhere; so to
1591 determine how many bytes would be written, use NULL for S and
1592 ((size_t) -1) for MAXSIZE.
1594 This function behaves like emacs_strftimeu, except it allows null
1595 bytes in FORMAT. */
1596 static size_t
1597 emacs_memftimeu (s, maxsize, format, format_len, tp, ut)
1598 char *s;
1599 size_t maxsize;
1600 const char *format;
1601 size_t format_len;
1602 const struct tm *tp;
1603 int ut;
1605 size_t total = 0;
1607 /* Loop through all the null-terminated strings in the format
1608 argument. Normally there's just one null-terminated string, but
1609 there can be arbitrarily many, concatenated together, if the
1610 format contains '\0' bytes. emacs_strftimeu stops at the first
1611 '\0' byte so we must invoke it separately for each such string. */
1612 for (;;)
1614 size_t len;
1615 size_t result;
1617 if (s)
1618 s[0] = '\1';
1620 result = emacs_strftimeu (s, maxsize, format, tp, ut);
1622 if (s)
1624 if (result == 0 && s[0] != '\0')
1625 return 0;
1626 s += result + 1;
1629 maxsize -= result + 1;
1630 total += result;
1631 len = strlen (format);
1632 if (len == format_len)
1633 return total;
1634 total++;
1635 format += len + 1;
1636 format_len -= len + 1;
1640 DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
1641 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
1642 TIME is specified as (HIGH LOW . IGNORED), as returned by
1643 `current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1644 is also still accepted.
1645 The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1646 as Universal Time; nil means describe TIME in the local time zone.
1647 The value is a copy of FORMAT-STRING, but with certain constructs replaced
1648 by text that describes the specified date and time in TIME:
1650 %Y is the year, %y within the century, %C the century.
1651 %G is the year corresponding to the ISO week, %g within the century.
1652 %m is the numeric month.
1653 %b and %h are the locale's abbreviated month name, %B the full name.
1654 %d is the day of the month, zero-padded, %e is blank-padded.
1655 %u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1656 %a is the locale's abbreviated name of the day of week, %A the full name.
1657 %U is the week number starting on Sunday, %W starting on Monday,
1658 %V according to ISO 8601.
1659 %j is the day of the year.
1661 %H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1662 only blank-padded, %l is like %I blank-padded.
1663 %p is the locale's equivalent of either AM or PM.
1664 %M is the minute.
1665 %S is the second.
1666 %Z is the time zone name, %z is the numeric form.
1667 %s is the number of seconds since 1970-01-01 00:00:00 +0000.
1669 %c is the locale's date and time format.
1670 %x is the locale's "preferred" date format.
1671 %D is like "%m/%d/%y".
1673 %R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1674 %X is the locale's "preferred" time format.
1676 Finally, %n is a newline, %t is a tab, %% is a literal %.
1678 Certain flags and modifiers are available with some format controls.
1679 The flags are `_', `-', `^' and `#'. For certain characters X,
1680 %_X is like %X, but padded with blanks; %-X is like %X,
1681 but without padding. %^X is like %X, but with all textual
1682 characters up-cased; %#X is like %X, but with letter-case of
1683 all textual characters reversed.
1684 %NX (where N stands for an integer) is like %X,
1685 but takes up at least N (a number) positions.
1686 The modifiers are `E' and `O'. For certain characters X,
1687 %EX is a locale's alternative version of %X;
1688 %OX is like %X, but uses the locale's number symbols.
1690 For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z". */)
1691 (format_string, time, universal)
1692 Lisp_Object format_string, time, universal;
1694 time_t value;
1695 int size;
1696 struct tm *tm;
1697 int ut = ! NILP (universal);
1699 CHECK_STRING (format_string);
1701 if (! lisp_time_argument (time, &value, NULL))
1702 error ("Invalid time specification");
1704 format_string = code_convert_string_norecord (format_string,
1705 Vlocale_coding_system, 1);
1707 /* This is probably enough. */
1708 size = SBYTES (format_string) * 6 + 50;
1710 BLOCK_INPUT;
1711 tm = ut ? gmtime (&value) : localtime (&value);
1712 UNBLOCK_INPUT;
1713 if (! tm)
1714 error ("Specified time is not representable");
1716 synchronize_system_time_locale ();
1718 while (1)
1720 char *buf = (char *) alloca (size + 1);
1721 int result;
1723 buf[0] = '\1';
1724 BLOCK_INPUT;
1725 result = emacs_memftimeu (buf, size, SDATA (format_string),
1726 SBYTES (format_string),
1727 tm, ut);
1728 UNBLOCK_INPUT;
1729 if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
1730 return code_convert_string_norecord (make_unibyte_string (buf, result),
1731 Vlocale_coding_system, 0);
1733 /* If buffer was too small, make it bigger and try again. */
1734 BLOCK_INPUT;
1735 result = emacs_memftimeu (NULL, (size_t) -1,
1736 SDATA (format_string),
1737 SBYTES (format_string),
1738 tm, ut);
1739 UNBLOCK_INPUT;
1740 size = result + 1;
1744 DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
1745 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1746 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
1747 as from `current-time' and `file-attributes', or nil to use the
1748 current time. The obsolete form (HIGH . LOW) is also still accepted.
1749 The list has the following nine members: SEC is an integer between 0
1750 and 60; SEC is 60 for a leap second, which only some operating systems
1751 support. MINUTE is an integer between 0 and 59. HOUR is an integer
1752 between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1753 integer between 1 and 12. YEAR is an integer indicating the
1754 four-digit year. DOW is the day of week, an integer between 0 and 6,
1755 where 0 is Sunday. DST is t if daylight saving time is in effect,
1756 otherwise nil. ZONE is an integer indicating the number of seconds
1757 east of Greenwich. (Note that Common Lisp has different meanings for
1758 DOW and ZONE.) */)
1759 (specified_time)
1760 Lisp_Object specified_time;
1762 time_t time_spec;
1763 struct tm save_tm;
1764 struct tm *decoded_time;
1765 Lisp_Object list_args[9];
1767 if (! lisp_time_argument (specified_time, &time_spec, NULL))
1768 error ("Invalid time specification");
1770 BLOCK_INPUT;
1771 decoded_time = localtime (&time_spec);
1772 UNBLOCK_INPUT;
1773 if (! decoded_time)
1774 error ("Specified time is not representable");
1775 XSETFASTINT (list_args[0], decoded_time->tm_sec);
1776 XSETFASTINT (list_args[1], decoded_time->tm_min);
1777 XSETFASTINT (list_args[2], decoded_time->tm_hour);
1778 XSETFASTINT (list_args[3], decoded_time->tm_mday);
1779 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
1780 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1781 cast below avoids overflow in int arithmetics. */
1782 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) decoded_time->tm_year);
1783 XSETFASTINT (list_args[6], decoded_time->tm_wday);
1784 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1786 /* Make a copy, in case gmtime modifies the struct. */
1787 save_tm = *decoded_time;
1788 BLOCK_INPUT;
1789 decoded_time = gmtime (&time_spec);
1790 UNBLOCK_INPUT;
1791 if (decoded_time == 0)
1792 list_args[8] = Qnil;
1793 else
1794 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1795 return Flist (9, list_args);
1798 DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1799 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1800 This is the reverse operation of `decode-time', which see.
1801 ZONE defaults to the current time zone rule. This can
1802 be a string or t (as from `set-time-zone-rule'), or it can be a list
1803 \(as from `current-time-zone') or an integer (as from `decode-time')
1804 applied without consideration for daylight saving time.
1806 You can pass more than 7 arguments; then the first six arguments
1807 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1808 The intervening arguments are ignored.
1809 This feature lets (apply 'encode-time (decode-time ...)) work.
1811 Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
1812 for example, a DAY of 0 means the day preceding the given month.
1813 Year numbers less than 100 are treated just like other year numbers.
1814 If you want them to stand for years in this century, you must do that yourself.
1816 Years before 1970 are not guaranteed to work. On some systems,
1817 year values as low as 1901 do work.
1819 usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
1820 (nargs, args)
1821 int nargs;
1822 register Lisp_Object *args;
1824 time_t time;
1825 struct tm tm;
1826 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1828 CHECK_NUMBER (args[0]); /* second */
1829 CHECK_NUMBER (args[1]); /* minute */
1830 CHECK_NUMBER (args[2]); /* hour */
1831 CHECK_NUMBER (args[3]); /* day */
1832 CHECK_NUMBER (args[4]); /* month */
1833 CHECK_NUMBER (args[5]); /* year */
1835 tm.tm_sec = XINT (args[0]);
1836 tm.tm_min = XINT (args[1]);
1837 tm.tm_hour = XINT (args[2]);
1838 tm.tm_mday = XINT (args[3]);
1839 tm.tm_mon = XINT (args[4]) - 1;
1840 tm.tm_year = XINT (args[5]) - TM_YEAR_BASE;
1841 tm.tm_isdst = -1;
1843 if (CONSP (zone))
1844 zone = Fcar (zone);
1845 if (NILP (zone))
1847 BLOCK_INPUT;
1848 time = mktime (&tm);
1849 UNBLOCK_INPUT;
1851 else
1853 char tzbuf[100];
1854 char *tzstring;
1855 char **oldenv = environ, **newenv;
1857 if (EQ (zone, Qt))
1858 tzstring = "UTC0";
1859 else if (STRINGP (zone))
1860 tzstring = (char *) SDATA (zone);
1861 else if (INTEGERP (zone))
1863 int abszone = eabs (XINT (zone));
1864 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1865 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1866 tzstring = tzbuf;
1868 else
1869 error ("Invalid time zone specification");
1871 /* Set TZ before calling mktime; merely adjusting mktime's returned
1872 value doesn't suffice, since that would mishandle leap seconds. */
1873 set_time_zone_rule (tzstring);
1875 BLOCK_INPUT;
1876 time = mktime (&tm);
1877 UNBLOCK_INPUT;
1879 /* Restore TZ to previous value. */
1880 newenv = environ;
1881 environ = oldenv;
1882 xfree (newenv);
1883 #ifdef LOCALTIME_CACHE
1884 tzset ();
1885 #endif
1888 if (time == (time_t) -1)
1889 error ("Specified time is not representable");
1891 return make_time (time);
1894 DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
1895 doc: /* Return the current time, as a human-readable string.
1896 Programs can use this function to decode a time,
1897 since the number of columns in each field is fixed
1898 if the year is in the range 1000-9999.
1899 The format is `Sun Sep 16 01:03:52 1973'.
1900 However, see also the functions `decode-time' and `format-time-string'
1901 which provide a much more powerful and general facility.
1903 If SPECIFIED-TIME is given, it is a time to format instead of the
1904 current time. The argument should have the form (HIGH LOW . IGNORED).
1905 Thus, you can use times obtained from `current-time' and from
1906 `file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1907 but this is considered obsolete. */)
1908 (specified_time)
1909 Lisp_Object specified_time;
1911 time_t value;
1912 struct tm *tm;
1913 register char *tem;
1915 if (! lisp_time_argument (specified_time, &value, NULL))
1916 error ("Invalid time specification");
1918 /* Convert to a string, checking for out-of-range time stamps.
1919 Don't use 'ctime', as that might dump core if VALUE is out of
1920 range. */
1921 BLOCK_INPUT;
1922 tm = localtime (&value);
1923 UNBLOCK_INPUT;
1924 if (! (tm && TM_YEAR_IN_ASCTIME_RANGE (tm->tm_year) && (tem = asctime (tm))))
1925 error ("Specified time is not representable");
1927 /* Remove the trailing newline. */
1928 tem[strlen (tem) - 1] = '\0';
1930 return build_string (tem);
1933 /* Yield A - B, measured in seconds.
1934 This function is copied from the GNU C Library. */
1935 static int
1936 tm_diff (a, b)
1937 struct tm *a, *b;
1939 /* Compute intervening leap days correctly even if year is negative.
1940 Take care to avoid int overflow in leap day calculations,
1941 but it's OK to assume that A and B are close to each other. */
1942 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
1943 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
1944 int a100 = a4 / 25 - (a4 % 25 < 0);
1945 int b100 = b4 / 25 - (b4 % 25 < 0);
1946 int a400 = a100 >> 2;
1947 int b400 = b100 >> 2;
1948 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
1949 int years = a->tm_year - b->tm_year;
1950 int days = (365 * years + intervening_leap_days
1951 + (a->tm_yday - b->tm_yday));
1952 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
1953 + (a->tm_min - b->tm_min))
1954 + (a->tm_sec - b->tm_sec));
1957 DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
1958 doc: /* Return the offset and name for the local time zone.
1959 This returns a list of the form (OFFSET NAME).
1960 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1961 A negative value means west of Greenwich.
1962 NAME is a string giving the name of the time zone.
1963 If SPECIFIED-TIME is given, the time zone offset is determined from it
1964 instead of using the current time. The argument should have the form
1965 (HIGH LOW . IGNORED). Thus, you can use times obtained from
1966 `current-time' and from `file-attributes'. SPECIFIED-TIME can also
1967 have the form (HIGH . LOW), but this is considered obsolete.
1969 Some operating systems cannot provide all this information to Emacs;
1970 in this case, `current-time-zone' returns a list containing nil for
1971 the data it can't find. */)
1972 (specified_time)
1973 Lisp_Object specified_time;
1975 time_t value;
1976 struct tm *t;
1977 struct tm gmt;
1979 if (!lisp_time_argument (specified_time, &value, NULL))
1980 t = NULL;
1981 else
1983 BLOCK_INPUT;
1984 t = gmtime (&value);
1985 if (t)
1987 gmt = *t;
1988 t = localtime (&value);
1990 UNBLOCK_INPUT;
1993 if (t)
1995 int offset = tm_diff (t, &gmt);
1996 char *s = 0;
1997 char buf[6];
1999 #ifdef HAVE_TM_ZONE
2000 if (t->tm_zone)
2001 s = (char *)t->tm_zone;
2002 #else /* not HAVE_TM_ZONE */
2003 #ifdef HAVE_TZNAME
2004 if (t->tm_isdst == 0 || t->tm_isdst == 1)
2005 s = tzname[t->tm_isdst];
2006 #endif
2007 #endif /* not HAVE_TM_ZONE */
2009 if (!s)
2011 /* No local time zone name is available; use "+-NNNN" instead. */
2012 int am = (offset < 0 ? -offset : offset) / 60;
2013 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
2014 s = buf;
2017 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
2019 else
2020 return Fmake_list (make_number (2), Qnil);
2023 /* This holds the value of `environ' produced by the previous
2024 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
2025 has never been called. */
2026 static char **environbuf;
2028 /* This holds the startup value of the TZ environment variable so it
2029 can be restored if the user calls set-time-zone-rule with a nil
2030 argument. */
2031 static char *initial_tz;
2033 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
2034 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
2035 If TZ is nil, use implementation-defined default time zone information.
2036 If TZ is t, use Universal Time. */)
2037 (tz)
2038 Lisp_Object tz;
2040 char *tzstring;
2042 /* When called for the first time, save the original TZ. */
2043 if (!environbuf)
2044 initial_tz = (char *) getenv ("TZ");
2046 if (NILP (tz))
2047 tzstring = initial_tz;
2048 else if (EQ (tz, Qt))
2049 tzstring = "UTC0";
2050 else
2052 CHECK_STRING (tz);
2053 tzstring = (char *) SDATA (tz);
2056 set_time_zone_rule (tzstring);
2057 free (environbuf);
2058 environbuf = environ;
2060 return Qnil;
2063 #ifdef LOCALTIME_CACHE
2065 /* These two values are known to load tz files in buggy implementations,
2066 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
2067 Their values shouldn't matter in non-buggy implementations.
2068 We don't use string literals for these strings,
2069 since if a string in the environment is in readonly
2070 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2071 See Sun bugs 1113095 and 1114114, ``Timezone routines
2072 improperly modify environment''. */
2074 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2075 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2077 #endif
2079 /* Set the local time zone rule to TZSTRING.
2080 This allocates memory into `environ', which it is the caller's
2081 responsibility to free. */
2083 void
2084 set_time_zone_rule (tzstring)
2085 char *tzstring;
2087 int envptrs;
2088 char **from, **to, **newenv;
2090 /* Make the ENVIRON vector longer with room for TZSTRING. */
2091 for (from = environ; *from; from++)
2092 continue;
2093 envptrs = from - environ + 2;
2094 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2095 + (tzstring ? strlen (tzstring) + 4 : 0));
2097 /* Add TZSTRING to the end of environ, as a value for TZ. */
2098 if (tzstring)
2100 char *t = (char *) (to + envptrs);
2101 strcpy (t, "TZ=");
2102 strcat (t, tzstring);
2103 *to++ = t;
2106 /* Copy the old environ vector elements into NEWENV,
2107 but don't copy the TZ variable.
2108 So we have only one definition of TZ, which came from TZSTRING. */
2109 for (from = environ; *from; from++)
2110 if (strncmp (*from, "TZ=", 3) != 0)
2111 *to++ = *from;
2112 *to = 0;
2114 environ = newenv;
2116 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2117 the TZ variable is stored. If we do not have a TZSTRING,
2118 TO points to the vector slot which has the terminating null. */
2120 #ifdef LOCALTIME_CACHE
2122 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2123 "US/Pacific" that loads a tz file, then changes to a value like
2124 "XXX0" that does not load a tz file, and then changes back to
2125 its original value, the last change is (incorrectly) ignored.
2126 Also, if TZ changes twice in succession to values that do
2127 not load a tz file, tzset can dump core (see Sun bug#1225179).
2128 The following code works around these bugs. */
2130 if (tzstring)
2132 /* Temporarily set TZ to a value that loads a tz file
2133 and that differs from tzstring. */
2134 char *tz = *newenv;
2135 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2136 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
2137 tzset ();
2138 *newenv = tz;
2140 else
2142 /* The implied tzstring is unknown, so temporarily set TZ to
2143 two different values that each load a tz file. */
2144 *to = set_time_zone_rule_tz1;
2145 to[1] = 0;
2146 tzset ();
2147 *to = set_time_zone_rule_tz2;
2148 tzset ();
2149 *to = 0;
2152 /* Now TZ has the desired value, and tzset can be invoked safely. */
2155 tzset ();
2156 #endif
2159 /* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2160 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2161 type of object is Lisp_String). INHERIT is passed to
2162 INSERT_FROM_STRING_FUNC as the last argument. */
2164 static void
2165 general_insert_function (void (*insert_func)
2166 (const unsigned char *, EMACS_INT),
2167 void (*insert_from_string_func)
2168 (Lisp_Object, EMACS_INT, EMACS_INT,
2169 EMACS_INT, EMACS_INT, int),
2170 int inherit, int nargs, Lisp_Object *args)
2172 register int argnum;
2173 register Lisp_Object val;
2175 for (argnum = 0; argnum < nargs; argnum++)
2177 val = args[argnum];
2178 if (CHARACTERP (val))
2180 unsigned char str[MAX_MULTIBYTE_LENGTH];
2181 int len;
2183 if (!NILP (current_buffer->enable_multibyte_characters))
2184 len = CHAR_STRING (XFASTINT (val), str);
2185 else
2187 str[0] = (ASCII_CHAR_P (XINT (val))
2188 ? XINT (val)
2189 : multibyte_char_to_unibyte (XINT (val), Qnil));
2190 len = 1;
2192 (*insert_func) (str, len);
2194 else if (STRINGP (val))
2196 (*insert_from_string_func) (val, 0, 0,
2197 SCHARS (val),
2198 SBYTES (val),
2199 inherit);
2201 else
2202 wrong_type_argument (Qchar_or_string_p, val);
2206 void
2207 insert1 (arg)
2208 Lisp_Object arg;
2210 Finsert (1, &arg);
2214 /* Callers passing one argument to Finsert need not gcpro the
2215 argument "array", since the only element of the array will
2216 not be used after calling insert or insert_from_string, so
2217 we don't care if it gets trashed. */
2219 DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
2220 doc: /* Insert the arguments, either strings or characters, at point.
2221 Point and before-insertion markers move forward to end up
2222 after the inserted text.
2223 Any other markers at the point of insertion remain before the text.
2225 If the current buffer is multibyte, unibyte strings are converted
2226 to multibyte for insertion (see `string-make-multibyte').
2227 If the current buffer is unibyte, multibyte strings are converted
2228 to unibyte for insertion (see `string-make-unibyte').
2230 When operating on binary data, it may be necessary to preserve the
2231 original bytes of a unibyte string when inserting it into a multibyte
2232 buffer; to accomplish this, apply `string-as-multibyte' to the string
2233 and insert the result.
2235 usage: (insert &rest ARGS) */)
2236 (nargs, args)
2237 int nargs;
2238 register Lisp_Object *args;
2240 general_insert_function (insert, insert_from_string, 0, nargs, args);
2241 return Qnil;
2244 DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2245 0, MANY, 0,
2246 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
2247 Point and before-insertion markers move forward to end up
2248 after the inserted text.
2249 Any other markers at the point of insertion remain before the text.
2251 If the current buffer is multibyte, unibyte strings are converted
2252 to multibyte for insertion (see `unibyte-char-to-multibyte').
2253 If the current buffer is unibyte, multibyte strings are converted
2254 to unibyte for insertion.
2256 usage: (insert-and-inherit &rest ARGS) */)
2257 (nargs, args)
2258 int nargs;
2259 register Lisp_Object *args;
2261 general_insert_function (insert_and_inherit, insert_from_string, 1,
2262 nargs, args);
2263 return Qnil;
2266 DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
2267 doc: /* Insert strings or characters at point, relocating markers after the text.
2268 Point and markers move forward to end up after the inserted text.
2270 If the current buffer is multibyte, unibyte strings are converted
2271 to multibyte for insertion (see `unibyte-char-to-multibyte').
2272 If the current buffer is unibyte, multibyte strings are converted
2273 to unibyte for insertion.
2275 usage: (insert-before-markers &rest ARGS) */)
2276 (nargs, args)
2277 int nargs;
2278 register Lisp_Object *args;
2280 general_insert_function (insert_before_markers,
2281 insert_from_string_before_markers, 0,
2282 nargs, args);
2283 return Qnil;
2286 DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2287 Sinsert_and_inherit_before_markers, 0, MANY, 0,
2288 doc: /* Insert text at point, relocating markers and inheriting properties.
2289 Point and markers move forward to end up after the inserted text.
2291 If the current buffer is multibyte, unibyte strings are converted
2292 to multibyte for insertion (see `unibyte-char-to-multibyte').
2293 If the current buffer is unibyte, multibyte strings are converted
2294 to unibyte for insertion.
2296 usage: (insert-before-markers-and-inherit &rest ARGS) */)
2297 (nargs, args)
2298 int nargs;
2299 register Lisp_Object *args;
2301 general_insert_function (insert_before_markers_and_inherit,
2302 insert_from_string_before_markers, 1,
2303 nargs, args);
2304 return Qnil;
2307 DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
2308 doc: /* Insert COUNT copies of CHARACTER.
2309 Point, and before-insertion markers, are relocated as in the function `insert'.
2310 The optional third arg INHERIT, if non-nil, says to inherit text properties
2311 from adjoining text, if those properties are sticky. */)
2312 (character, count, inherit)
2313 Lisp_Object character, count, inherit;
2315 register unsigned char *string;
2316 register int strlen;
2317 register int i, n;
2318 int len;
2319 unsigned char str[MAX_MULTIBYTE_LENGTH];
2321 CHECK_NUMBER (character);
2322 CHECK_NUMBER (count);
2324 if (!NILP (current_buffer->enable_multibyte_characters))
2325 len = CHAR_STRING (XFASTINT (character), str);
2326 else
2327 str[0] = XFASTINT (character), len = 1;
2328 n = XINT (count) * len;
2329 if (n <= 0)
2330 return Qnil;
2331 strlen = min (n, 256 * len);
2332 string = (unsigned char *) alloca (strlen);
2333 for (i = 0; i < strlen; i++)
2334 string[i] = str[i % len];
2335 while (n >= strlen)
2337 QUIT;
2338 if (!NILP (inherit))
2339 insert_and_inherit (string, strlen);
2340 else
2341 insert (string, strlen);
2342 n -= strlen;
2344 if (n > 0)
2346 if (!NILP (inherit))
2347 insert_and_inherit (string, n);
2348 else
2349 insert (string, n);
2351 return Qnil;
2354 DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2355 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2356 Both arguments are required.
2357 BYTE is a number of the range 0..255.
2359 If BYTE is 128..255 and the current buffer is multibyte, the
2360 corresponding eight-bit character is inserted.
2362 Point, and before-insertion markers, are relocated as in the function `insert'.
2363 The optional third arg INHERIT, if non-nil, says to inherit text properties
2364 from adjoining text, if those properties are sticky. */)
2365 (byte, count, inherit)
2366 Lisp_Object byte, count, inherit;
2368 CHECK_NUMBER (byte);
2369 if (XINT (byte) < 0 || XINT (byte) > 255)
2370 args_out_of_range_3 (byte, make_number (0), make_number (255));
2371 if (XINT (byte) >= 128
2372 && ! NILP (current_buffer->enable_multibyte_characters))
2373 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
2374 return Finsert_char (byte, count, inherit);
2378 /* Making strings from buffer contents. */
2380 /* Return a Lisp_String containing the text of the current buffer from
2381 START to END. If text properties are in use and the current buffer
2382 has properties in the range specified, the resulting string will also
2383 have them, if PROPS is nonzero.
2385 We don't want to use plain old make_string here, because it calls
2386 make_uninit_string, which can cause the buffer arena to be
2387 compacted. make_string has no way of knowing that the data has
2388 been moved, and thus copies the wrong data into the string. This
2389 doesn't effect most of the other users of make_string, so it should
2390 be left as is. But we should use this function when conjuring
2391 buffer substrings. */
2393 Lisp_Object
2394 make_buffer_string (start, end, props)
2395 int start, end;
2396 int props;
2398 int start_byte = CHAR_TO_BYTE (start);
2399 int end_byte = CHAR_TO_BYTE (end);
2401 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2404 /* Return a Lisp_String containing the text of the current buffer from
2405 START / START_BYTE to END / END_BYTE.
2407 If text properties are in use and the current buffer
2408 has properties in the range specified, the resulting string will also
2409 have them, if PROPS is nonzero.
2411 We don't want to use plain old make_string here, because it calls
2412 make_uninit_string, which can cause the buffer arena to be
2413 compacted. make_string has no way of knowing that the data has
2414 been moved, and thus copies the wrong data into the string. This
2415 doesn't effect most of the other users of make_string, so it should
2416 be left as is. But we should use this function when conjuring
2417 buffer substrings. */
2419 Lisp_Object
2420 make_buffer_string_both (start, start_byte, end, end_byte, props)
2421 int start, start_byte, end, end_byte;
2422 int props;
2424 Lisp_Object result, tem, tem1;
2426 if (start < GPT && GPT < end)
2427 move_gap (start);
2429 if (! NILP (current_buffer->enable_multibyte_characters))
2430 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2431 else
2432 result = make_uninit_string (end - start);
2433 bcopy (BYTE_POS_ADDR (start_byte), SDATA (result),
2434 end_byte - start_byte);
2436 /* If desired, update and copy the text properties. */
2437 if (props)
2439 update_buffer_properties (start, end);
2441 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2442 tem1 = Ftext_properties_at (make_number (start), Qnil);
2444 if (XINT (tem) != end || !NILP (tem1))
2445 copy_intervals_to_string (result, current_buffer, start,
2446 end - start);
2449 return result;
2452 /* Call Vbuffer_access_fontify_functions for the range START ... END
2453 in the current buffer, if necessary. */
2455 static void
2456 update_buffer_properties (start, end)
2457 int start, end;
2459 /* If this buffer has some access functions,
2460 call them, specifying the range of the buffer being accessed. */
2461 if (!NILP (Vbuffer_access_fontify_functions))
2463 Lisp_Object args[3];
2464 Lisp_Object tem;
2466 args[0] = Qbuffer_access_fontify_functions;
2467 XSETINT (args[1], start);
2468 XSETINT (args[2], end);
2470 /* But don't call them if we can tell that the work
2471 has already been done. */
2472 if (!NILP (Vbuffer_access_fontified_property))
2474 tem = Ftext_property_any (args[1], args[2],
2475 Vbuffer_access_fontified_property,
2476 Qnil, Qnil);
2477 if (! NILP (tem))
2478 Frun_hook_with_args (3, args);
2480 else
2481 Frun_hook_with_args (3, args);
2485 DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
2486 doc: /* Return the contents of part of the current buffer as a string.
2487 The two arguments START and END are character positions;
2488 they can be in either order.
2489 The string returned is multibyte if the buffer is multibyte.
2491 This function copies the text properties of that part of the buffer
2492 into the result string; if you don't want the text properties,
2493 use `buffer-substring-no-properties' instead. */)
2494 (start, end)
2495 Lisp_Object start, end;
2497 register int b, e;
2499 validate_region (&start, &end);
2500 b = XINT (start);
2501 e = XINT (end);
2503 return make_buffer_string (b, e, 1);
2506 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2507 Sbuffer_substring_no_properties, 2, 2, 0,
2508 doc: /* Return the characters of part of the buffer, without the text properties.
2509 The two arguments START and END are character positions;
2510 they can be in either order. */)
2511 (start, end)
2512 Lisp_Object start, end;
2514 register int b, e;
2516 validate_region (&start, &end);
2517 b = XINT (start);
2518 e = XINT (end);
2520 return make_buffer_string (b, e, 0);
2523 DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
2524 doc: /* Return the contents of the current buffer as a string.
2525 If narrowing is in effect, this function returns only the visible part
2526 of the buffer. */)
2529 return make_buffer_string (BEGV, ZV, 1);
2532 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
2533 1, 3, 0,
2534 doc: /* Insert before point a substring of the contents of BUFFER.
2535 BUFFER may be a buffer or a buffer name.
2536 Arguments START and END are character positions specifying the substring.
2537 They default to the values of (point-min) and (point-max) in BUFFER. */)
2538 (buffer, start, end)
2539 Lisp_Object buffer, start, end;
2541 register int b, e, temp;
2542 register struct buffer *bp, *obuf;
2543 Lisp_Object buf;
2545 buf = Fget_buffer (buffer);
2546 if (NILP (buf))
2547 nsberror (buffer);
2548 bp = XBUFFER (buf);
2549 if (NILP (bp->name))
2550 error ("Selecting deleted buffer");
2552 if (NILP (start))
2553 b = BUF_BEGV (bp);
2554 else
2556 CHECK_NUMBER_COERCE_MARKER (start);
2557 b = XINT (start);
2559 if (NILP (end))
2560 e = BUF_ZV (bp);
2561 else
2563 CHECK_NUMBER_COERCE_MARKER (end);
2564 e = XINT (end);
2567 if (b > e)
2568 temp = b, b = e, e = temp;
2570 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2571 args_out_of_range (start, end);
2573 obuf = current_buffer;
2574 set_buffer_internal_1 (bp);
2575 update_buffer_properties (b, e);
2576 set_buffer_internal_1 (obuf);
2578 insert_from_buffer (bp, b, e - b, 0);
2579 return Qnil;
2582 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
2583 6, 6, 0,
2584 doc: /* Compare two substrings of two buffers; return result as number.
2585 the value is -N if first string is less after N-1 chars,
2586 +N if first string is greater after N-1 chars, or 0 if strings match.
2587 Each substring is represented as three arguments: BUFFER, START and END.
2588 That makes six args in all, three for each substring.
2590 The value of `case-fold-search' in the current buffer
2591 determines whether case is significant or ignored. */)
2592 (buffer1, start1, end1, buffer2, start2, end2)
2593 Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
2595 register int begp1, endp1, begp2, endp2, temp;
2596 register struct buffer *bp1, *bp2;
2597 register Lisp_Object trt
2598 = (!NILP (current_buffer->case_fold_search)
2599 ? current_buffer->case_canon_table : Qnil);
2600 int chars = 0;
2601 int i1, i2, i1_byte, i2_byte;
2603 /* Find the first buffer and its substring. */
2605 if (NILP (buffer1))
2606 bp1 = current_buffer;
2607 else
2609 Lisp_Object buf1;
2610 buf1 = Fget_buffer (buffer1);
2611 if (NILP (buf1))
2612 nsberror (buffer1);
2613 bp1 = XBUFFER (buf1);
2614 if (NILP (bp1->name))
2615 error ("Selecting deleted buffer");
2618 if (NILP (start1))
2619 begp1 = BUF_BEGV (bp1);
2620 else
2622 CHECK_NUMBER_COERCE_MARKER (start1);
2623 begp1 = XINT (start1);
2625 if (NILP (end1))
2626 endp1 = BUF_ZV (bp1);
2627 else
2629 CHECK_NUMBER_COERCE_MARKER (end1);
2630 endp1 = XINT (end1);
2633 if (begp1 > endp1)
2634 temp = begp1, begp1 = endp1, endp1 = temp;
2636 if (!(BUF_BEGV (bp1) <= begp1
2637 && begp1 <= endp1
2638 && endp1 <= BUF_ZV (bp1)))
2639 args_out_of_range (start1, end1);
2641 /* Likewise for second substring. */
2643 if (NILP (buffer2))
2644 bp2 = current_buffer;
2645 else
2647 Lisp_Object buf2;
2648 buf2 = Fget_buffer (buffer2);
2649 if (NILP (buf2))
2650 nsberror (buffer2);
2651 bp2 = XBUFFER (buf2);
2652 if (NILP (bp2->name))
2653 error ("Selecting deleted buffer");
2656 if (NILP (start2))
2657 begp2 = BUF_BEGV (bp2);
2658 else
2660 CHECK_NUMBER_COERCE_MARKER (start2);
2661 begp2 = XINT (start2);
2663 if (NILP (end2))
2664 endp2 = BUF_ZV (bp2);
2665 else
2667 CHECK_NUMBER_COERCE_MARKER (end2);
2668 endp2 = XINT (end2);
2671 if (begp2 > endp2)
2672 temp = begp2, begp2 = endp2, endp2 = temp;
2674 if (!(BUF_BEGV (bp2) <= begp2
2675 && begp2 <= endp2
2676 && endp2 <= BUF_ZV (bp2)))
2677 args_out_of_range (start2, end2);
2679 i1 = begp1;
2680 i2 = begp2;
2681 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2682 i2_byte = buf_charpos_to_bytepos (bp2, i2);
2684 while (i1 < endp1 && i2 < endp2)
2686 /* When we find a mismatch, we must compare the
2687 characters, not just the bytes. */
2688 int c1, c2;
2690 QUIT;
2692 if (! NILP (bp1->enable_multibyte_characters))
2694 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2695 BUF_INC_POS (bp1, i1_byte);
2696 i1++;
2698 else
2700 c1 = BUF_FETCH_BYTE (bp1, i1);
2701 c1 = unibyte_char_to_multibyte (c1);
2702 i1++;
2705 if (! NILP (bp2->enable_multibyte_characters))
2707 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2708 BUF_INC_POS (bp2, i2_byte);
2709 i2++;
2711 else
2713 c2 = BUF_FETCH_BYTE (bp2, i2);
2714 c2 = unibyte_char_to_multibyte (c2);
2715 i2++;
2718 if (!NILP (trt))
2720 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2721 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
2723 if (c1 < c2)
2724 return make_number (- 1 - chars);
2725 if (c1 > c2)
2726 return make_number (chars + 1);
2728 chars++;
2731 /* The strings match as far as they go.
2732 If one is shorter, that one is less. */
2733 if (chars < endp1 - begp1)
2734 return make_number (chars + 1);
2735 else if (chars < endp2 - begp2)
2736 return make_number (- chars - 1);
2738 /* Same length too => they are equal. */
2739 return make_number (0);
2742 static Lisp_Object
2743 subst_char_in_region_unwind (arg)
2744 Lisp_Object arg;
2746 return current_buffer->undo_list = arg;
2749 static Lisp_Object
2750 subst_char_in_region_unwind_1 (arg)
2751 Lisp_Object arg;
2753 return current_buffer->filename = arg;
2756 DEFUN ("subst-char-in-region", Fsubst_char_in_region,
2757 Ssubst_char_in_region, 4, 5, 0,
2758 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
2759 If optional arg NOUNDO is non-nil, don't record this change for undo
2760 and don't mark the buffer as really changed.
2761 Both characters must have the same length of multi-byte form. */)
2762 (start, end, fromchar, tochar, noundo)
2763 Lisp_Object start, end, fromchar, tochar, noundo;
2765 register int pos, pos_byte, stop, i, len, end_byte;
2766 /* Keep track of the first change in the buffer:
2767 if 0 we haven't found it yet.
2768 if < 0 we've found it and we've run the before-change-function.
2769 if > 0 we've actually performed it and the value is its position. */
2770 int changed = 0;
2771 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2772 unsigned char *p;
2773 int count = SPECPDL_INDEX ();
2774 #define COMBINING_NO 0
2775 #define COMBINING_BEFORE 1
2776 #define COMBINING_AFTER 2
2777 #define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2778 int maybe_byte_combining = COMBINING_NO;
2779 int last_changed = 0;
2780 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
2782 restart:
2784 validate_region (&start, &end);
2785 CHECK_NUMBER (fromchar);
2786 CHECK_NUMBER (tochar);
2788 if (multibyte_p)
2790 len = CHAR_STRING (XFASTINT (fromchar), fromstr);
2791 if (CHAR_STRING (XFASTINT (tochar), tostr) != len)
2792 error ("Characters in `subst-char-in-region' have different byte-lengths");
2793 if (!ASCII_BYTE_P (*tostr))
2795 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2796 complete multibyte character, it may be combined with the
2797 after bytes. If it is in the range 0xA0..0xFF, it may be
2798 combined with the before and after bytes. */
2799 if (!CHAR_HEAD_P (*tostr))
2800 maybe_byte_combining = COMBINING_BOTH;
2801 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2802 maybe_byte_combining = COMBINING_AFTER;
2805 else
2807 len = 1;
2808 fromstr[0] = XFASTINT (fromchar);
2809 tostr[0] = XFASTINT (tochar);
2812 pos = XINT (start);
2813 pos_byte = CHAR_TO_BYTE (pos);
2814 stop = CHAR_TO_BYTE (XINT (end));
2815 end_byte = stop;
2817 /* If we don't want undo, turn off putting stuff on the list.
2818 That's faster than getting rid of things,
2819 and it prevents even the entry for a first change.
2820 Also inhibit locking the file. */
2821 if (!changed && !NILP (noundo))
2823 record_unwind_protect (subst_char_in_region_unwind,
2824 current_buffer->undo_list);
2825 current_buffer->undo_list = Qt;
2826 /* Don't do file-locking. */
2827 record_unwind_protect (subst_char_in_region_unwind_1,
2828 current_buffer->filename);
2829 current_buffer->filename = Qnil;
2832 if (pos_byte < GPT_BYTE)
2833 stop = min (stop, GPT_BYTE);
2834 while (1)
2836 int pos_byte_next = pos_byte;
2838 if (pos_byte >= stop)
2840 if (pos_byte >= end_byte) break;
2841 stop = end_byte;
2843 p = BYTE_POS_ADDR (pos_byte);
2844 if (multibyte_p)
2845 INC_POS (pos_byte_next);
2846 else
2847 ++pos_byte_next;
2848 if (pos_byte_next - pos_byte == len
2849 && p[0] == fromstr[0]
2850 && (len == 1
2851 || (p[1] == fromstr[1]
2852 && (len == 2 || (p[2] == fromstr[2]
2853 && (len == 3 || p[3] == fromstr[3]))))))
2855 if (changed < 0)
2856 /* We've already seen this and run the before-change-function;
2857 this time we only need to record the actual position. */
2858 changed = pos;
2859 else if (!changed)
2861 changed = -1;
2862 modify_region (current_buffer, pos, XINT (end), 0);
2864 if (! NILP (noundo))
2866 if (MODIFF - 1 == SAVE_MODIFF)
2867 SAVE_MODIFF++;
2868 if (MODIFF - 1 == current_buffer->auto_save_modified)
2869 current_buffer->auto_save_modified++;
2872 /* The before-change-function may have moved the gap
2873 or even modified the buffer so we should start over. */
2874 goto restart;
2877 /* Take care of the case where the new character
2878 combines with neighboring bytes. */
2879 if (maybe_byte_combining
2880 && (maybe_byte_combining == COMBINING_AFTER
2881 ? (pos_byte_next < Z_BYTE
2882 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2883 : ((pos_byte_next < Z_BYTE
2884 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2885 || (pos_byte > BEG_BYTE
2886 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
2888 Lisp_Object tem, string;
2890 struct gcpro gcpro1;
2892 tem = current_buffer->undo_list;
2893 GCPRO1 (tem);
2895 /* Make a multibyte string containing this single character. */
2896 string = make_multibyte_string (tostr, 1, len);
2897 /* replace_range is less efficient, because it moves the gap,
2898 but it handles combining correctly. */
2899 replace_range (pos, pos + 1, string,
2900 0, 0, 1);
2901 pos_byte_next = CHAR_TO_BYTE (pos);
2902 if (pos_byte_next > pos_byte)
2903 /* Before combining happened. We should not increment
2904 POS. So, to cancel the later increment of POS,
2905 decrease it now. */
2906 pos--;
2907 else
2908 INC_POS (pos_byte_next);
2910 if (! NILP (noundo))
2911 current_buffer->undo_list = tem;
2913 UNGCPRO;
2915 else
2917 if (NILP (noundo))
2918 record_change (pos, 1);
2919 for (i = 0; i < len; i++) *p++ = tostr[i];
2921 last_changed = pos + 1;
2923 pos_byte = pos_byte_next;
2924 pos++;
2927 if (changed > 0)
2929 signal_after_change (changed,
2930 last_changed - changed, last_changed - changed);
2931 update_compositions (changed, last_changed, CHECK_ALL);
2934 unbind_to (count, Qnil);
2935 return Qnil;
2939 static Lisp_Object check_translation P_ ((int, int, int, Lisp_Object));
2941 /* Helper function for Ftranslate_region_internal.
2943 Check if a character sequence at POS (POS_BYTE) matches an element
2944 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2945 element is found, return it. Otherwise return Qnil. */
2947 static Lisp_Object
2948 check_translation (pos, pos_byte, end, val)
2949 int pos, pos_byte, end;
2950 Lisp_Object val;
2952 int buf_size = 16, buf_used = 0;
2953 int *buf = alloca (sizeof (int) * buf_size);
2955 for (; CONSP (val); val = XCDR (val))
2957 Lisp_Object elt;
2958 int len, i;
2960 elt = XCAR (val);
2961 if (! CONSP (elt))
2962 continue;
2963 elt = XCAR (elt);
2964 if (! VECTORP (elt))
2965 continue;
2966 len = ASIZE (elt);
2967 if (len <= end - pos)
2969 for (i = 0; i < len; i++)
2971 if (buf_used <= i)
2973 unsigned char *p = BYTE_POS_ADDR (pos_byte);
2974 int len;
2976 if (buf_used == buf_size)
2978 int *newbuf;
2980 buf_size += 16;
2981 newbuf = alloca (sizeof (int) * buf_size);
2982 memcpy (newbuf, buf, sizeof (int) * buf_used);
2983 buf = newbuf;
2985 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, 0, len);
2986 pos_byte += len;
2988 if (XINT (AREF (elt, i)) != buf[i])
2989 break;
2991 if (i == len)
2992 return XCAR (val);
2995 return Qnil;
2999 DEFUN ("translate-region-internal", Ftranslate_region_internal,
3000 Stranslate_region_internal, 3, 3, 0,
3001 doc: /* Internal use only.
3002 From START to END, translate characters according to TABLE.
3003 TABLE is a string or a char-table; the Nth character in it is the
3004 mapping for the character with code N.
3005 It returns the number of characters changed. */)
3006 (start, end, table)
3007 Lisp_Object start;
3008 Lisp_Object end;
3009 register Lisp_Object table;
3011 register unsigned char *tt; /* Trans table. */
3012 register int nc; /* New character. */
3013 int cnt; /* Number of changes made. */
3014 int size; /* Size of translate table. */
3015 int pos, pos_byte, end_pos;
3016 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
3017 int string_multibyte;
3018 Lisp_Object val;
3020 validate_region (&start, &end);
3021 if (CHAR_TABLE_P (table))
3023 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
3024 error ("Not a translation table");
3025 size = MAX_CHAR;
3026 tt = NULL;
3028 else
3030 CHECK_STRING (table);
3032 if (! multibyte && (SCHARS (table) < SBYTES (table)))
3033 table = string_make_unibyte (table);
3034 string_multibyte = SCHARS (table) < SBYTES (table);
3035 size = SBYTES (table);
3036 tt = SDATA (table);
3039 pos = XINT (start);
3040 pos_byte = CHAR_TO_BYTE (pos);
3041 end_pos = XINT (end);
3042 modify_region (current_buffer, pos, end_pos, 0);
3044 cnt = 0;
3045 for (; pos < end_pos; )
3047 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
3048 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
3049 int len, str_len;
3050 int oc;
3051 Lisp_Object val;
3053 if (multibyte)
3054 oc = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, len);
3055 else
3056 oc = *p, len = 1;
3057 if (oc < size)
3059 if (tt)
3061 /* Reload as signal_after_change in last iteration may GC. */
3062 tt = SDATA (table);
3063 if (string_multibyte)
3065 str = tt + string_char_to_byte (table, oc);
3066 nc = STRING_CHAR_AND_LENGTH (str, MAX_MULTIBYTE_LENGTH,
3067 str_len);
3069 else
3071 nc = tt[oc];
3072 if (! ASCII_BYTE_P (nc) && multibyte)
3074 str_len = BYTE8_STRING (nc, buf);
3075 str = buf;
3077 else
3079 str_len = 1;
3080 str = tt + oc;
3084 else
3086 int c;
3088 nc = oc;
3089 val = CHAR_TABLE_REF (table, oc);
3090 if (CHARACTERP (val)
3091 && (c = XINT (val), CHAR_VALID_P (c, 0)))
3093 nc = c;
3094 str_len = CHAR_STRING (nc, buf);
3095 str = buf;
3097 else if (VECTORP (val) || (CONSP (val)))
3099 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3100 where TO is TO-CHAR or [TO-CHAR ...]. */
3101 nc = -1;
3105 if (nc != oc && nc >= 0)
3107 /* Simple one char to one char translation. */
3108 if (len != str_len)
3110 Lisp_Object string;
3112 /* This is less efficient, because it moves the gap,
3113 but it should handle multibyte characters correctly. */
3114 string = make_multibyte_string (str, 1, str_len);
3115 replace_range (pos, pos + 1, string, 1, 0, 1);
3116 len = str_len;
3118 else
3120 record_change (pos, 1);
3121 while (str_len-- > 0)
3122 *p++ = *str++;
3123 signal_after_change (pos, 1, 1);
3124 update_compositions (pos, pos + 1, CHECK_BORDER);
3126 ++cnt;
3128 else if (nc < 0)
3130 Lisp_Object string;
3132 if (CONSP (val))
3134 val = check_translation (pos, pos_byte, end_pos, val);
3135 if (NILP (val))
3137 pos_byte += len;
3138 pos++;
3139 continue;
3141 /* VAL is ([FROM-CHAR ...] . TO). */
3142 len = ASIZE (XCAR (val));
3143 val = XCDR (val);
3145 else
3146 len = 1;
3148 if (VECTORP (val))
3150 int i;
3152 string = Fmake_string (make_number (ASIZE (val)),
3153 AREF (val, 0));
3154 for (i = 1; i < ASIZE (val); i++)
3155 Faset (string, make_number (i), AREF (val, i));
3157 else
3159 string = Fmake_string (make_number (1), val);
3161 replace_range (pos, pos + len, string, 1, 0, 1);
3162 pos_byte += SBYTES (string);
3163 pos += SCHARS (string);
3164 cnt += SCHARS (string);
3165 end_pos += SCHARS (string) - len;
3166 continue;
3169 pos_byte += len;
3170 pos++;
3173 return make_number (cnt);
3176 DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3177 doc: /* Delete the text between point and mark.
3179 When called from a program, expects two arguments,
3180 positions (integers or markers) specifying the stretch to be deleted. */)
3181 (start, end)
3182 Lisp_Object start, end;
3184 validate_region (&start, &end);
3185 del_range (XINT (start), XINT (end));
3186 return Qnil;
3189 DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3190 Sdelete_and_extract_region, 2, 2, 0,
3191 doc: /* Delete the text between START and END and return it. */)
3192 (start, end)
3193 Lisp_Object start, end;
3195 validate_region (&start, &end);
3196 if (XINT (start) == XINT (end))
3197 return empty_unibyte_string;
3198 return del_range_1 (XINT (start), XINT (end), 1, 1);
3201 DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
3202 doc: /* Remove restrictions (narrowing) from current buffer.
3203 This allows the buffer's full text to be seen and edited. */)
3206 if (BEG != BEGV || Z != ZV)
3207 current_buffer->clip_changed = 1;
3208 BEGV = BEG;
3209 BEGV_BYTE = BEG_BYTE;
3210 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
3211 /* Changing the buffer bounds invalidates any recorded current column. */
3212 invalidate_current_column ();
3213 return Qnil;
3216 DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
3217 doc: /* Restrict editing in this buffer to the current region.
3218 The rest of the text becomes temporarily invisible and untouchable
3219 but is not deleted; if you save the buffer in a file, the invisible
3220 text is included in the file. \\[widen] makes all visible again.
3221 See also `save-restriction'.
3223 When calling from a program, pass two arguments; positions (integers
3224 or markers) bounding the text that should remain visible. */)
3225 (start, end)
3226 register Lisp_Object start, end;
3228 CHECK_NUMBER_COERCE_MARKER (start);
3229 CHECK_NUMBER_COERCE_MARKER (end);
3231 if (XINT (start) > XINT (end))
3233 Lisp_Object tem;
3234 tem = start; start = end; end = tem;
3237 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3238 args_out_of_range (start, end);
3240 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3241 current_buffer->clip_changed = 1;
3243 SET_BUF_BEGV (current_buffer, XFASTINT (start));
3244 SET_BUF_ZV (current_buffer, XFASTINT (end));
3245 if (PT < XFASTINT (start))
3246 SET_PT (XFASTINT (start));
3247 if (PT > XFASTINT (end))
3248 SET_PT (XFASTINT (end));
3249 /* Changing the buffer bounds invalidates any recorded current column. */
3250 invalidate_current_column ();
3251 return Qnil;
3254 Lisp_Object
3255 save_restriction_save ()
3257 if (BEGV == BEG && ZV == Z)
3258 /* The common case that the buffer isn't narrowed.
3259 We return just the buffer object, which save_restriction_restore
3260 recognizes as meaning `no restriction'. */
3261 return Fcurrent_buffer ();
3262 else
3263 /* We have to save a restriction, so return a pair of markers, one
3264 for the beginning and one for the end. */
3266 Lisp_Object beg, end;
3268 beg = buildmark (BEGV, BEGV_BYTE);
3269 end = buildmark (ZV, ZV_BYTE);
3271 /* END must move forward if text is inserted at its exact location. */
3272 XMARKER(end)->insertion_type = 1;
3274 return Fcons (beg, end);
3278 Lisp_Object
3279 save_restriction_restore (data)
3280 Lisp_Object data;
3282 if (CONSP (data))
3283 /* A pair of marks bounding a saved restriction. */
3285 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3286 struct Lisp_Marker *end = XMARKER (XCDR (data));
3287 struct buffer *buf = beg->buffer; /* END should have the same buffer. */
3289 if (buf /* Verify marker still points to a buffer. */
3290 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
3291 /* The restriction has changed from the saved one, so restore
3292 the saved restriction. */
3294 int pt = BUF_PT (buf);
3296 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3297 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3299 if (pt < beg->charpos || pt > end->charpos)
3300 /* The point is outside the new visible range, move it inside. */
3301 SET_BUF_PT_BOTH (buf,
3302 clip_to_bounds (beg->charpos, pt, end->charpos),
3303 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
3304 end->bytepos));
3306 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3309 else
3310 /* A buffer, which means that there was no old restriction. */
3312 struct buffer *buf = XBUFFER (data);
3314 if (buf /* Verify marker still points to a buffer. */
3315 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
3316 /* The buffer has been narrowed, get rid of the narrowing. */
3318 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3319 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
3321 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3325 return Qnil;
3328 DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
3329 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
3330 The buffer's restrictions make parts of the beginning and end invisible.
3331 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
3332 This special form, `save-restriction', saves the current buffer's restrictions
3333 when it is entered, and restores them when it is exited.
3334 So any `narrow-to-region' within BODY lasts only until the end of the form.
3335 The old restrictions settings are restored
3336 even in case of abnormal exit (throw or error).
3338 The value returned is the value of the last form in BODY.
3340 Note: if you are using both `save-excursion' and `save-restriction',
3341 use `save-excursion' outermost:
3342 (save-excursion (save-restriction ...))
3344 usage: (save-restriction &rest BODY) */)
3345 (body)
3346 Lisp_Object body;
3348 register Lisp_Object val;
3349 int count = SPECPDL_INDEX ();
3351 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3352 val = Fprogn (body);
3353 return unbind_to (count, val);
3356 /* Buffer for the most recent text displayed by Fmessage_box. */
3357 static char *message_text;
3359 /* Allocated length of that buffer. */
3360 static int message_length;
3362 DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
3363 doc: /* Display a message at the bottom of the screen.
3364 The message also goes into the `*Messages*' buffer.
3365 \(In keyboard macros, that's all it does.)
3366 Return the message.
3368 The first argument is a format control string, and the rest are data
3369 to be formatted under control of the string. See `format' for details.
3371 Note: Use (message "%s" VALUE) to print the value of expressions and
3372 variables to avoid accidentally interpreting `%' as format specifiers.
3374 If the first argument is nil or the empty string, the function clears
3375 any existing message; this lets the minibuffer contents show. See
3376 also `current-message'.
3378 usage: (message FORMAT-STRING &rest ARGS) */)
3379 (nargs, args)
3380 int nargs;
3381 Lisp_Object *args;
3383 if (NILP (args[0])
3384 || (STRINGP (args[0])
3385 && SBYTES (args[0]) == 0))
3387 message (0);
3388 return args[0];
3390 else
3392 register Lisp_Object val;
3393 val = Fformat (nargs, args);
3394 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
3395 return val;
3399 DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
3400 doc: /* Display a message, in a dialog box if possible.
3401 If a dialog box is not available, use the echo area.
3402 The first argument is a format control string, and the rest are data
3403 to be formatted under control of the string. See `format' for details.
3405 If the first argument is nil or the empty string, clear any existing
3406 message; let the minibuffer contents show.
3408 usage: (message-box FORMAT-STRING &rest ARGS) */)
3409 (nargs, args)
3410 int nargs;
3411 Lisp_Object *args;
3413 if (NILP (args[0]))
3415 message (0);
3416 return Qnil;
3418 else
3420 register Lisp_Object val;
3421 val = Fformat (nargs, args);
3422 #ifdef HAVE_MENUS
3423 /* The MS-DOS frames support popup menus even though they are
3424 not FRAME_WINDOW_P. */
3425 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3426 || FRAME_MSDOS_P (XFRAME (selected_frame)))
3428 Lisp_Object pane, menu, obj;
3429 struct gcpro gcpro1;
3430 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3431 GCPRO1 (pane);
3432 menu = Fcons (val, pane);
3433 obj = Fx_popup_dialog (Qt, menu, Qt);
3434 UNGCPRO;
3435 return val;
3437 #endif /* HAVE_MENUS */
3438 /* Copy the data so that it won't move when we GC. */
3439 if (! message_text)
3441 message_text = (char *)xmalloc (80);
3442 message_length = 80;
3444 if (SBYTES (val) > message_length)
3446 message_length = SBYTES (val);
3447 message_text = (char *)xrealloc (message_text, message_length);
3449 bcopy (SDATA (val), message_text, SBYTES (val));
3450 message2 (message_text, SBYTES (val),
3451 STRING_MULTIBYTE (val));
3452 return val;
3455 #ifdef HAVE_MENUS
3456 extern Lisp_Object last_nonmenu_event;
3457 #endif
3459 DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
3460 doc: /* Display a message in a dialog box or in the echo area.
3461 If this command was invoked with the mouse, use a dialog box if
3462 `use-dialog-box' is non-nil.
3463 Otherwise, use the echo area.
3464 The first argument is a format control string, and the rest are data
3465 to be formatted under control of the string. See `format' for details.
3467 If the first argument is nil or the empty string, clear any existing
3468 message; let the minibuffer contents show.
3470 usage: (message-or-box FORMAT-STRING &rest ARGS) */)
3471 (nargs, args)
3472 int nargs;
3473 Lisp_Object *args;
3475 #ifdef HAVE_MENUS
3476 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
3477 && use_dialog_box)
3478 return Fmessage_box (nargs, args);
3479 #endif
3480 return Fmessage (nargs, args);
3483 DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
3484 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
3487 return current_message ();
3491 DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
3492 doc: /* Return a copy of STRING with text properties added.
3493 First argument is the string to copy.
3494 Remaining arguments form a sequence of PROPERTY VALUE pairs for text
3495 properties to add to the result.
3496 usage: (propertize STRING &rest PROPERTIES) */)
3497 (nargs, args)
3498 int nargs;
3499 Lisp_Object *args;
3501 Lisp_Object properties, string;
3502 struct gcpro gcpro1, gcpro2;
3503 int i;
3505 /* Number of args must be odd. */
3506 if ((nargs & 1) == 0 || nargs < 1)
3507 error ("Wrong number of arguments");
3509 properties = string = Qnil;
3510 GCPRO2 (properties, string);
3512 /* First argument must be a string. */
3513 CHECK_STRING (args[0]);
3514 string = Fcopy_sequence (args[0]);
3516 for (i = 1; i < nargs; i += 2)
3517 properties = Fcons (args[i], Fcons (args[i + 1], properties));
3519 Fadd_text_properties (make_number (0),
3520 make_number (SCHARS (string)),
3521 properties, string);
3522 RETURN_UNGCPRO (string);
3526 /* Number of bytes that STRING will occupy when put into the result.
3527 MULTIBYTE is nonzero if the result should be multibyte. */
3529 #define CONVERTED_BYTE_SIZE(MULTIBYTE, STRING) \
3530 (((MULTIBYTE) && ! STRING_MULTIBYTE (STRING)) \
3531 ? count_size_as_multibyte (SDATA (STRING), SBYTES (STRING)) \
3532 : SBYTES (STRING))
3534 DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
3535 doc: /* Format a string out of a format-string and arguments.
3536 The first argument is a format control string.
3537 The other arguments are substituted into it to make the result, a string.
3539 The format control string may contain %-sequences meaning to substitute
3540 the next available argument:
3542 %s means print a string argument. Actually, prints any object, with `princ'.
3543 %d means print as number in decimal (%o octal, %x hex).
3544 %X is like %x, but uses upper case.
3545 %e means print a number in exponential notation.
3546 %f means print a number in decimal-point notation.
3547 %g means print a number in exponential notation
3548 or decimal-point notation, whichever uses fewer characters.
3549 %c means print a number as a single character.
3550 %S means print any object as an s-expression (using `prin1').
3552 The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
3553 Use %% to put a single % into the output.
3555 A %-sequence may contain optional flag, width, and precision
3556 specifiers, as follows:
3558 %<flags><width><precision>character
3560 where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3562 The + flag character inserts a + before any positive number, while a
3563 space inserts a space before any positive number; these flags only
3564 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3565 The # flag means to use an alternate display form for %o, %x, %X, %e,
3566 %f, and %g sequences. The - and 0 flags affect the width specifier,
3567 as described below.
3569 The width specifier supplies a lower limit for the length of the
3570 printed representation. The padding, if any, normally goes on the
3571 left, but it goes on the right if the - flag is present. The padding
3572 character is normally a space, but it is 0 if the 0 flag is present.
3573 The - flag takes precedence over the 0 flag.
3575 For %e, %f, and %g sequences, the number after the "." in the
3576 precision specifier says how many decimal places to show; if zero, the
3577 decimal point itself is omitted. For %s and %S, the precision
3578 specifier truncates the string to the given width.
3580 usage: (format STRING &rest OBJECTS) */)
3581 (nargs, args)
3582 int nargs;
3583 register Lisp_Object *args;
3585 register int n; /* The number of the next arg to substitute */
3586 register int total; /* An estimate of the final length */
3587 char *buf, *p;
3588 register unsigned char *format, *end, *format_start;
3589 int nchars;
3590 /* Nonzero if the output should be a multibyte string,
3591 which is true if any of the inputs is one. */
3592 int multibyte = 0;
3593 /* When we make a multibyte string, we must pay attention to the
3594 byte combining problem, i.e., a byte may be combined with a
3595 multibyte charcter of the previous string. This flag tells if we
3596 must consider such a situation or not. */
3597 int maybe_combine_byte;
3598 unsigned char *this_format;
3599 /* Precision for each spec, or -1, a flag value meaning no precision
3600 was given in that spec. Element 0, corresonding to the format
3601 string itself, will not be used. Element NARGS, corresponding to
3602 no argument, *will* be assigned to in the case that a `%' and `.'
3603 occur after the final format specifier. */
3604 int *precision = (int *) (alloca((nargs + 1) * sizeof (int)));
3605 int longest_format;
3606 Lisp_Object val;
3607 int arg_intervals = 0;
3608 USE_SAFE_ALLOCA;
3610 /* discarded[I] is 1 if byte I of the format
3611 string was not copied into the output.
3612 It is 2 if byte I was not the first byte of its character. */
3613 char *discarded = 0;
3615 /* Each element records, for one argument,
3616 the start and end bytepos in the output string,
3617 and whether the argument is a string with intervals.
3618 info[0] is unused. Unused elements have -1 for start. */
3619 struct info
3621 int start, end, intervals;
3622 } *info = 0;
3624 /* It should not be necessary to GCPRO ARGS, because
3625 the caller in the interpreter should take care of that. */
3627 /* Try to determine whether the result should be multibyte.
3628 This is not always right; sometimes the result needs to be multibyte
3629 because of an object that we will pass through prin1,
3630 and in that case, we won't know it here. */
3631 for (n = 0; n < nargs; n++)
3633 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3634 multibyte = 1;
3635 /* Piggyback on this loop to initialize precision[N]. */
3636 precision[n] = -1;
3638 precision[nargs] = -1;
3640 CHECK_STRING (args[0]);
3641 /* We may have to change "%S" to "%s". */
3642 args[0] = Fcopy_sequence (args[0]);
3644 /* GC should never happen here, so abort if it does. */
3645 abort_on_gc++;
3647 /* If we start out planning a unibyte result,
3648 then discover it has to be multibyte, we jump back to retry.
3649 That can only happen from the first large while loop below. */
3650 retry:
3652 format = SDATA (args[0]);
3653 format_start = format;
3654 end = format + SBYTES (args[0]);
3655 longest_format = 0;
3657 /* Make room in result for all the non-%-codes in the control string. */
3658 total = 5 + CONVERTED_BYTE_SIZE (multibyte, args[0]) + 1;
3660 /* Allocate the info and discarded tables. */
3662 int nbytes = (nargs+1) * sizeof *info;
3663 int i;
3664 if (!info)
3665 info = (struct info *) alloca (nbytes);
3666 bzero (info, nbytes);
3667 for (i = 0; i <= nargs; i++)
3668 info[i].start = -1;
3669 if (!discarded)
3670 SAFE_ALLOCA (discarded, char *, SBYTES (args[0]));
3671 bzero (discarded, SBYTES (args[0]));
3674 /* Add to TOTAL enough space to hold the converted arguments. */
3676 n = 0;
3677 while (format != end)
3678 if (*format++ == '%')
3680 int thissize = 0;
3681 int actual_width = 0;
3682 unsigned char *this_format_start = format - 1;
3683 int field_width = 0;
3685 /* General format specifications look like
3687 '%' [flags] [field-width] [precision] format
3689 where
3691 flags ::= [-+ #0]+
3692 field-width ::= [0-9]+
3693 precision ::= '.' [0-9]*
3695 If a field-width is specified, it specifies to which width
3696 the output should be padded with blanks, if the output
3697 string is shorter than field-width.
3699 If precision is specified, it specifies the number of
3700 digits to print after the '.' for floats, or the max.
3701 number of chars to print from a string. */
3703 while (format != end
3704 && (*format == '-' || *format == '0' || *format == '#'
3705 || * format == ' ' || *format == '+'))
3706 ++format;
3708 if (*format >= '0' && *format <= '9')
3710 for (field_width = 0; *format >= '0' && *format <= '9'; ++format)
3711 field_width = 10 * field_width + *format - '0';
3714 /* N is not incremented for another few lines below, so refer to
3715 element N+1 (which might be precision[NARGS]). */
3716 if (*format == '.')
3718 ++format;
3719 for (precision[n+1] = 0; *format >= '0' && *format <= '9'; ++format)
3720 precision[n+1] = 10 * precision[n+1] + *format - '0';
3723 /* Extra +1 for 'l' that we may need to insert into the
3724 format. */
3725 if (format - this_format_start + 2 > longest_format)
3726 longest_format = format - this_format_start + 2;
3728 if (format == end)
3729 error ("Format string ends in middle of format specifier");
3730 if (*format == '%')
3731 format++;
3732 else if (++n >= nargs)
3733 error ("Not enough arguments for format string");
3734 else if (*format == 'S')
3736 /* For `S', prin1 the argument and then treat like a string. */
3737 register Lisp_Object tem;
3738 tem = Fprin1_to_string (args[n], Qnil);
3739 if (STRING_MULTIBYTE (tem) && ! multibyte)
3741 multibyte = 1;
3742 goto retry;
3744 args[n] = tem;
3745 /* If we restart the loop, we should not come here again
3746 because args[n] is now a string and calling
3747 Fprin1_to_string on it produces superflous double
3748 quotes. So, change "%S" to "%s" now. */
3749 *format = 's';
3750 goto string;
3752 else if (SYMBOLP (args[n]))
3754 args[n] = SYMBOL_NAME (args[n]);
3755 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3757 multibyte = 1;
3758 goto retry;
3760 goto string;
3762 else if (STRINGP (args[n]))
3764 string:
3765 if (*format != 's' && *format != 'S')
3766 error ("Format specifier doesn't match argument type");
3767 /* In the case (PRECISION[N] > 0), THISSIZE may not need
3768 to be as large as is calculated here. Easy check for
3769 the case PRECISION = 0. */
3770 thissize = precision[n] ? CONVERTED_BYTE_SIZE (multibyte, args[n]) : 0;
3771 actual_width = lisp_string_width (args[n], -1, NULL, NULL);
3773 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
3774 else if (INTEGERP (args[n]) && *format != 's')
3776 /* The following loop assumes the Lisp type indicates
3777 the proper way to pass the argument.
3778 So make sure we have a flonum if the argument should
3779 be a double. */
3780 if (*format == 'e' || *format == 'f' || *format == 'g')
3781 args[n] = Ffloat (args[n]);
3782 else
3783 if (*format != 'd' && *format != 'o' && *format != 'x'
3784 && *format != 'i' && *format != 'X' && *format != 'c')
3785 error ("Invalid format operation %%%c", *format);
3787 thissize = 30 + (precision[n] > 0 ? precision[n] : 0);
3788 if (*format == 'c')
3790 if (! ASCII_CHAR_P (XINT (args[n]))
3791 /* Note: No one can remeber why we have to treat
3792 the character 0 as a multibyte character here.
3793 But, until it causes a real problem, let's
3794 don't change it. */
3795 || XINT (args[n]) == 0)
3797 if (! multibyte)
3799 multibyte = 1;
3800 goto retry;
3802 args[n] = Fchar_to_string (args[n]);
3803 thissize = SBYTES (args[n]);
3805 else if (! ASCII_BYTE_P (XINT (args[n])) && multibyte)
3807 args[n]
3808 = Fchar_to_string (Funibyte_char_to_multibyte (args[n]));
3809 thissize = SBYTES (args[n]);
3813 else if (FLOATP (args[n]) && *format != 's')
3815 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
3817 if (*format != 'd' && *format != 'o' && *format != 'x'
3818 && *format != 'i' && *format != 'X' && *format != 'c')
3819 error ("Invalid format operation %%%c", *format);
3820 /* This fails unnecessarily if args[n] is bigger than
3821 most-positive-fixnum but smaller than MAXINT.
3822 These cases are important because we sometimes use floats
3823 to represent such integer values (typically such values
3824 come from UIDs or PIDs). */
3825 /* args[n] = Ftruncate (args[n], Qnil); */
3828 /* Note that we're using sprintf to print floats,
3829 so we have to take into account what that function
3830 prints. */
3831 /* Filter out flag value of -1. */
3832 thissize = (MAX_10_EXP + 100
3833 + (precision[n] > 0 ? precision[n] : 0));
3835 else
3837 /* Anything but a string, convert to a string using princ. */
3838 register Lisp_Object tem;
3839 tem = Fprin1_to_string (args[n], Qt);
3840 if (STRING_MULTIBYTE (tem) && ! multibyte)
3842 multibyte = 1;
3843 goto retry;
3845 args[n] = tem;
3846 goto string;
3849 thissize += max (0, field_width - actual_width);
3850 total += thissize + 4;
3853 abort_on_gc--;
3855 /* Now we can no longer jump to retry.
3856 TOTAL and LONGEST_FORMAT are known for certain. */
3858 this_format = (unsigned char *) alloca (longest_format + 1);
3860 /* Allocate the space for the result.
3861 Note that TOTAL is an overestimate. */
3862 SAFE_ALLOCA (buf, char *, total);
3864 p = buf;
3865 nchars = 0;
3866 n = 0;
3868 /* Scan the format and store result in BUF. */
3869 format = SDATA (args[0]);
3870 format_start = format;
3871 end = format + SBYTES (args[0]);
3872 maybe_combine_byte = 0;
3873 while (format != end)
3875 if (*format == '%')
3877 int minlen;
3878 int negative = 0;
3879 unsigned char *this_format_start = format;
3881 discarded[format - format_start] = 1;
3882 format++;
3884 while (index("-+0# ", *format))
3886 if (*format == '-')
3888 negative = 1;
3890 discarded[format - format_start] = 1;
3891 ++format;
3894 minlen = atoi (format);
3896 while ((*format >= '0' && *format <= '9') || *format == '.')
3898 discarded[format - format_start] = 1;
3899 format++;
3902 if (*format++ == '%')
3904 *p++ = '%';
3905 nchars++;
3906 continue;
3909 ++n;
3911 discarded[format - format_start - 1] = 1;
3912 info[n].start = nchars;
3914 if (STRINGP (args[n]))
3916 /* handle case (precision[n] >= 0) */
3918 int width, padding;
3919 int nbytes, start, end;
3920 int nchars_string;
3922 /* lisp_string_width ignores a precision of 0, but GNU
3923 libc functions print 0 characters when the precision
3924 is 0. Imitate libc behavior here. Changing
3925 lisp_string_width is the right thing, and will be
3926 done, but meanwhile we work with it. */
3928 if (precision[n] == 0)
3929 width = nchars_string = nbytes = 0;
3930 else if (precision[n] > 0)
3931 width = lisp_string_width (args[n], precision[n], &nchars_string, &nbytes);
3932 else
3933 { /* no precision spec given for this argument */
3934 width = lisp_string_width (args[n], -1, NULL, NULL);
3935 nbytes = SBYTES (args[n]);
3936 nchars_string = SCHARS (args[n]);
3939 /* If spec requires it, pad on right with spaces. */
3940 padding = minlen - width;
3941 if (! negative)
3942 while (padding-- > 0)
3944 *p++ = ' ';
3945 ++nchars;
3948 info[n].start = start = nchars;
3949 nchars += nchars_string;
3950 end = nchars;
3952 if (p > buf
3953 && multibyte
3954 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3955 && STRING_MULTIBYTE (args[n])
3956 && !CHAR_HEAD_P (SREF (args[n], 0)))
3957 maybe_combine_byte = 1;
3959 p += copy_text (SDATA (args[n]), p,
3960 nbytes,
3961 STRING_MULTIBYTE (args[n]), multibyte);
3963 info[n].end = nchars;
3965 if (negative)
3966 while (padding-- > 0)
3968 *p++ = ' ';
3969 nchars++;
3972 /* If this argument has text properties, record where
3973 in the result string it appears. */
3974 if (STRING_INTERVALS (args[n]))
3975 info[n].intervals = arg_intervals = 1;
3977 else if (INTEGERP (args[n]) || FLOATP (args[n]))
3979 int this_nchars;
3981 bcopy (this_format_start, this_format,
3982 format - this_format_start);
3983 this_format[format - this_format_start] = 0;
3985 if (format[-1] == 'e' || format[-1] == 'f' || format[-1] == 'g')
3986 sprintf (p, this_format, XFLOAT_DATA (args[n]));
3987 else
3989 if (sizeof (EMACS_INT) > sizeof (int)
3990 && format[-1] != 'c')
3992 /* Insert 'l' before format spec. */
3993 this_format[format - this_format_start]
3994 = this_format[format - this_format_start - 1];
3995 this_format[format - this_format_start - 1] = 'l';
3996 this_format[format - this_format_start + 1] = 0;
3999 if (INTEGERP (args[n]))
4001 if (format[-1] == 'c')
4002 sprintf (p, this_format, (int) XINT (args[n]));
4003 else if (format[-1] == 'd')
4004 sprintf (p, this_format, XINT (args[n]));
4005 /* Don't sign-extend for octal or hex printing. */
4006 else
4007 sprintf (p, this_format, XUINT (args[n]));
4009 else if (format[-1] == 'c')
4010 sprintf (p, this_format, (int) XFLOAT_DATA (args[n]));
4011 else if (format[-1] == 'd')
4012 /* Maybe we should use "%1.0f" instead so it also works
4013 for values larger than MAXINT. */
4014 sprintf (p, this_format, (EMACS_INT) XFLOAT_DATA (args[n]));
4015 else
4016 /* Don't sign-extend for octal or hex printing. */
4017 sprintf (p, this_format, (EMACS_UINT) XFLOAT_DATA (args[n]));
4020 if (p > buf
4021 && multibyte
4022 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
4023 && !CHAR_HEAD_P (*((unsigned char *) p)))
4024 maybe_combine_byte = 1;
4025 this_nchars = strlen (p);
4026 if (multibyte)
4027 p += str_to_multibyte (p, buf + total - 1 - p, this_nchars);
4028 else
4029 p += this_nchars;
4030 nchars += this_nchars;
4031 info[n].end = nchars;
4035 else if (STRING_MULTIBYTE (args[0]))
4037 /* Copy a whole multibyte character. */
4038 if (p > buf
4039 && multibyte
4040 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
4041 && !CHAR_HEAD_P (*format))
4042 maybe_combine_byte = 1;
4043 *p++ = *format++;
4044 while (! CHAR_HEAD_P (*format))
4046 discarded[format - format_start] = 2;
4047 *p++ = *format++;
4049 nchars++;
4051 else if (multibyte)
4053 /* Convert a single-byte character to multibyte. */
4054 int len = copy_text (format, p, 1, 0, 1);
4056 p += len;
4057 format++;
4058 nchars++;
4060 else
4061 *p++ = *format++, nchars++;
4064 if (p > buf + total)
4065 abort ();
4067 if (maybe_combine_byte)
4068 nchars = multibyte_chars_in_text (buf, p - buf);
4069 val = make_specified_string (buf, nchars, p - buf, multibyte);
4071 /* If we allocated BUF with malloc, free it too. */
4072 SAFE_FREE ();
4074 /* If the format string has text properties, or any of the string
4075 arguments has text properties, set up text properties of the
4076 result string. */
4078 if (STRING_INTERVALS (args[0]) || arg_intervals)
4080 Lisp_Object len, new_len, props;
4081 struct gcpro gcpro1;
4083 /* Add text properties from the format string. */
4084 len = make_number (SCHARS (args[0]));
4085 props = text_property_list (args[0], make_number (0), len, Qnil);
4086 GCPRO1 (props);
4088 if (CONSP (props))
4090 int bytepos = 0, position = 0, translated = 0, argn = 1;
4091 Lisp_Object list;
4093 /* Adjust the bounds of each text property
4094 to the proper start and end in the output string. */
4096 /* Put the positions in PROPS in increasing order, so that
4097 we can do (effectively) one scan through the position
4098 space of the format string. */
4099 props = Fnreverse (props);
4101 /* BYTEPOS is the byte position in the format string,
4102 POSITION is the untranslated char position in it,
4103 TRANSLATED is the translated char position in BUF,
4104 and ARGN is the number of the next arg we will come to. */
4105 for (list = props; CONSP (list); list = XCDR (list))
4107 Lisp_Object item;
4108 int pos;
4110 item = XCAR (list);
4112 /* First adjust the property start position. */
4113 pos = XINT (XCAR (item));
4115 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4116 up to this position. */
4117 for (; position < pos; bytepos++)
4119 if (! discarded[bytepos])
4120 position++, translated++;
4121 else if (discarded[bytepos] == 1)
4123 position++;
4124 if (translated == info[argn].start)
4126 translated += info[argn].end - info[argn].start;
4127 argn++;
4132 XSETCAR (item, make_number (translated));
4134 /* Likewise adjust the property end position. */
4135 pos = XINT (XCAR (XCDR (item)));
4137 for (; position < pos; bytepos++)
4139 if (! discarded[bytepos])
4140 position++, translated++;
4141 else if (discarded[bytepos] == 1)
4143 position++;
4144 if (translated == info[argn].start)
4146 translated += info[argn].end - info[argn].start;
4147 argn++;
4152 XSETCAR (XCDR (item), make_number (translated));
4155 add_text_properties_from_list (val, props, make_number (0));
4158 /* Add text properties from arguments. */
4159 if (arg_intervals)
4160 for (n = 1; n < nargs; ++n)
4161 if (info[n].intervals)
4163 len = make_number (SCHARS (args[n]));
4164 new_len = make_number (info[n].end - info[n].start);
4165 props = text_property_list (args[n], make_number (0), len, Qnil);
4166 extend_property_ranges (props, len, new_len);
4167 /* If successive arguments have properites, be sure that
4168 the value of `composition' property be the copy. */
4169 if (n > 1 && info[n - 1].end)
4170 make_composition_value_copy (props);
4171 add_text_properties_from_list (val, props,
4172 make_number (info[n].start));
4175 UNGCPRO;
4178 return val;
4181 Lisp_Object
4182 format2 (string1, arg0, arg1)
4183 char *string1;
4184 Lisp_Object arg0, arg1;
4186 Lisp_Object args[3];
4187 args[0] = build_string (string1);
4188 args[1] = arg0;
4189 args[2] = arg1;
4190 return Fformat (3, args);
4193 DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
4194 doc: /* Return t if two characters match, optionally ignoring case.
4195 Both arguments must be characters (i.e. integers).
4196 Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
4197 (c1, c2)
4198 register Lisp_Object c1, c2;
4200 int i1, i2;
4201 /* Check they're chars, not just integers, otherwise we could get array
4202 bounds violations in DOWNCASE. */
4203 CHECK_CHARACTER (c1);
4204 CHECK_CHARACTER (c2);
4206 if (XINT (c1) == XINT (c2))
4207 return Qt;
4208 if (NILP (current_buffer->case_fold_search))
4209 return Qnil;
4211 /* Do these in separate statements,
4212 then compare the variables.
4213 because of the way DOWNCASE uses temp variables. */
4214 i1 = XFASTINT (c1);
4215 if (NILP (current_buffer->enable_multibyte_characters)
4216 && ! ASCII_CHAR_P (i1))
4218 MAKE_CHAR_MULTIBYTE (i1);
4220 i2 = XFASTINT (c2);
4221 if (NILP (current_buffer->enable_multibyte_characters)
4222 && ! ASCII_CHAR_P (i2))
4224 MAKE_CHAR_MULTIBYTE (i2);
4226 i1 = DOWNCASE (i1);
4227 i2 = DOWNCASE (i2);
4228 return (i1 == i2 ? Qt : Qnil);
4231 /* Transpose the markers in two regions of the current buffer, and
4232 adjust the ones between them if necessary (i.e.: if the regions
4233 differ in size).
4235 START1, END1 are the character positions of the first region.
4236 START1_BYTE, END1_BYTE are the byte positions.
4237 START2, END2 are the character positions of the second region.
4238 START2_BYTE, END2_BYTE are the byte positions.
4240 Traverses the entire marker list of the buffer to do so, adding an
4241 appropriate amount to some, subtracting from some, and leaving the
4242 rest untouched. Most of this is copied from adjust_markers in insdel.c.
4244 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
4246 static void
4247 transpose_markers (start1, end1, start2, end2,
4248 start1_byte, end1_byte, start2_byte, end2_byte)
4249 register int start1, end1, start2, end2;
4250 register int start1_byte, end1_byte, start2_byte, end2_byte;
4252 register int amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
4253 register struct Lisp_Marker *marker;
4255 /* Update point as if it were a marker. */
4256 if (PT < start1)
4258 else if (PT < end1)
4259 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4260 PT_BYTE + (end2_byte - end1_byte));
4261 else if (PT < start2)
4262 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4263 (PT_BYTE + (end2_byte - start2_byte)
4264 - (end1_byte - start1_byte)));
4265 else if (PT < end2)
4266 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4267 PT_BYTE - (start2_byte - start1_byte));
4269 /* We used to adjust the endpoints here to account for the gap, but that
4270 isn't good enough. Even if we assume the caller has tried to move the
4271 gap out of our way, it might still be at start1 exactly, for example;
4272 and that places it `inside' the interval, for our purposes. The amount
4273 of adjustment is nontrivial if there's a `denormalized' marker whose
4274 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4275 the dirty work to Fmarker_position, below. */
4277 /* The difference between the region's lengths */
4278 diff = (end2 - start2) - (end1 - start1);
4279 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
4281 /* For shifting each marker in a region by the length of the other
4282 region plus the distance between the regions. */
4283 amt1 = (end2 - start2) + (start2 - end1);
4284 amt2 = (end1 - start1) + (start2 - end1);
4285 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4286 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
4288 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
4290 mpos = marker->bytepos;
4291 if (mpos >= start1_byte && mpos < end2_byte)
4293 if (mpos < end1_byte)
4294 mpos += amt1_byte;
4295 else if (mpos < start2_byte)
4296 mpos += diff_byte;
4297 else
4298 mpos -= amt2_byte;
4299 marker->bytepos = mpos;
4301 mpos = marker->charpos;
4302 if (mpos >= start1 && mpos < end2)
4304 if (mpos < end1)
4305 mpos += amt1;
4306 else if (mpos < start2)
4307 mpos += diff;
4308 else
4309 mpos -= amt2;
4311 marker->charpos = mpos;
4315 DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
4316 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
4317 The regions may not be overlapping, because the size of the buffer is
4318 never changed in a transposition.
4320 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
4321 any markers that happen to be located in the regions.
4323 Transposing beyond buffer boundaries is an error. */)
4324 (startr1, endr1, startr2, endr2, leave_markers)
4325 Lisp_Object startr1, endr1, startr2, endr2, leave_markers;
4327 register EMACS_INT start1, end1, start2, end2;
4328 EMACS_INT start1_byte, start2_byte, len1_byte, len2_byte;
4329 EMACS_INT gap, len1, len_mid, len2;
4330 unsigned char *start1_addr, *start2_addr, *temp;
4332 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
4333 Lisp_Object buf;
4335 XSETBUFFER (buf, current_buffer);
4336 cur_intv = BUF_INTERVALS (current_buffer);
4338 validate_region (&startr1, &endr1);
4339 validate_region (&startr2, &endr2);
4341 start1 = XFASTINT (startr1);
4342 end1 = XFASTINT (endr1);
4343 start2 = XFASTINT (startr2);
4344 end2 = XFASTINT (endr2);
4345 gap = GPT;
4347 /* Swap the regions if they're reversed. */
4348 if (start2 < end1)
4350 register int glumph = start1;
4351 start1 = start2;
4352 start2 = glumph;
4353 glumph = end1;
4354 end1 = end2;
4355 end2 = glumph;
4358 len1 = end1 - start1;
4359 len2 = end2 - start2;
4361 if (start2 < end1)
4362 error ("Transposed regions overlap");
4363 else if (start1 == end1 || start2 == end2)
4364 error ("Transposed region has length 0");
4366 /* The possibilities are:
4367 1. Adjacent (contiguous) regions, or separate but equal regions
4368 (no, really equal, in this case!), or
4369 2. Separate regions of unequal size.
4371 The worst case is usually No. 2. It means that (aside from
4372 potential need for getting the gap out of the way), there also
4373 needs to be a shifting of the text between the two regions. So
4374 if they are spread far apart, we are that much slower... sigh. */
4376 /* It must be pointed out that the really studly thing to do would
4377 be not to move the gap at all, but to leave it in place and work
4378 around it if necessary. This would be extremely efficient,
4379 especially considering that people are likely to do
4380 transpositions near where they are working interactively, which
4381 is exactly where the gap would be found. However, such code
4382 would be much harder to write and to read. So, if you are
4383 reading this comment and are feeling squirrely, by all means have
4384 a go! I just didn't feel like doing it, so I will simply move
4385 the gap the minimum distance to get it out of the way, and then
4386 deal with an unbroken array. */
4388 /* Make sure the gap won't interfere, by moving it out of the text
4389 we will operate on. */
4390 if (start1 < gap && gap < end2)
4392 if (gap - start1 < end2 - gap)
4393 move_gap (start1);
4394 else
4395 move_gap (end2);
4398 start1_byte = CHAR_TO_BYTE (start1);
4399 start2_byte = CHAR_TO_BYTE (start2);
4400 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4401 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
4403 #ifdef BYTE_COMBINING_DEBUG
4404 if (end1 == start2)
4406 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4407 len2_byte, start1, start1_byte)
4408 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4409 len1_byte, end2, start2_byte + len2_byte)
4410 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4411 len1_byte, end2, start2_byte + len2_byte))
4412 abort ();
4414 else
4416 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4417 len2_byte, start1, start1_byte)
4418 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4419 len1_byte, start2, start2_byte)
4420 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4421 len2_byte, end1, start1_byte + len1_byte)
4422 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4423 len1_byte, end2, start2_byte + len2_byte))
4424 abort ();
4426 #endif
4428 /* Hmmm... how about checking to see if the gap is large
4429 enough to use as the temporary storage? That would avoid an
4430 allocation... interesting. Later, don't fool with it now. */
4432 /* Working without memmove, for portability (sigh), so must be
4433 careful of overlapping subsections of the array... */
4435 if (end1 == start2) /* adjacent regions */
4437 modify_region (current_buffer, start1, end2, 0);
4438 record_change (start1, len1 + len2);
4440 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4441 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4442 /* Don't use Fset_text_properties: that can cause GC, which can
4443 clobber objects stored in the tmp_intervals. */
4444 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4445 if (!NULL_INTERVAL_P (tmp_interval3))
4446 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4448 /* First region smaller than second. */
4449 if (len1_byte < len2_byte)
4451 USE_SAFE_ALLOCA;
4453 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4455 /* Don't precompute these addresses. We have to compute them
4456 at the last minute, because the relocating allocator might
4457 have moved the buffer around during the xmalloc. */
4458 start1_addr = BYTE_POS_ADDR (start1_byte);
4459 start2_addr = BYTE_POS_ADDR (start2_byte);
4461 bcopy (start2_addr, temp, len2_byte);
4462 bcopy (start1_addr, start1_addr + len2_byte, len1_byte);
4463 bcopy (temp, start1_addr, len2_byte);
4464 SAFE_FREE ();
4466 else
4467 /* First region not smaller than second. */
4469 USE_SAFE_ALLOCA;
4471 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4472 start1_addr = BYTE_POS_ADDR (start1_byte);
4473 start2_addr = BYTE_POS_ADDR (start2_byte);
4474 bcopy (start1_addr, temp, len1_byte);
4475 bcopy (start2_addr, start1_addr, len2_byte);
4476 bcopy (temp, start1_addr + len2_byte, len1_byte);
4477 SAFE_FREE ();
4479 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4480 len1, current_buffer, 0);
4481 graft_intervals_into_buffer (tmp_interval2, start1,
4482 len2, current_buffer, 0);
4483 update_compositions (start1, start1 + len2, CHECK_BORDER);
4484 update_compositions (start1 + len2, end2, CHECK_TAIL);
4486 /* Non-adjacent regions, because end1 != start2, bleagh... */
4487 else
4489 len_mid = start2_byte - (start1_byte + len1_byte);
4491 if (len1_byte == len2_byte)
4492 /* Regions are same size, though, how nice. */
4494 USE_SAFE_ALLOCA;
4496 modify_region (current_buffer, start1, end1, 0);
4497 modify_region (current_buffer, start2, end2, 0);
4498 record_change (start1, len1);
4499 record_change (start2, len2);
4500 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4501 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4503 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4504 if (!NULL_INTERVAL_P (tmp_interval3))
4505 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4507 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4508 if (!NULL_INTERVAL_P (tmp_interval3))
4509 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
4511 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4512 start1_addr = BYTE_POS_ADDR (start1_byte);
4513 start2_addr = BYTE_POS_ADDR (start2_byte);
4514 bcopy (start1_addr, temp, len1_byte);
4515 bcopy (start2_addr, start1_addr, len2_byte);
4516 bcopy (temp, start2_addr, len1_byte);
4517 SAFE_FREE ();
4519 graft_intervals_into_buffer (tmp_interval1, start2,
4520 len1, current_buffer, 0);
4521 graft_intervals_into_buffer (tmp_interval2, start1,
4522 len2, current_buffer, 0);
4525 else if (len1_byte < len2_byte) /* Second region larger than first */
4526 /* Non-adjacent & unequal size, area between must also be shifted. */
4528 USE_SAFE_ALLOCA;
4530 modify_region (current_buffer, start1, end2, 0);
4531 record_change (start1, (end2 - start1));
4532 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4533 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4534 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4536 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4537 if (!NULL_INTERVAL_P (tmp_interval3))
4538 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4540 /* holds region 2 */
4541 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
4542 start1_addr = BYTE_POS_ADDR (start1_byte);
4543 start2_addr = BYTE_POS_ADDR (start2_byte);
4544 bcopy (start2_addr, temp, len2_byte);
4545 bcopy (start1_addr, start1_addr + len_mid + len2_byte, len1_byte);
4546 safe_bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
4547 bcopy (temp, start1_addr, len2_byte);
4548 SAFE_FREE ();
4550 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4551 len1, current_buffer, 0);
4552 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4553 len_mid, current_buffer, 0);
4554 graft_intervals_into_buffer (tmp_interval2, start1,
4555 len2, current_buffer, 0);
4557 else
4558 /* Second region smaller than first. */
4560 USE_SAFE_ALLOCA;
4562 record_change (start1, (end2 - start1));
4563 modify_region (current_buffer, start1, end2, 0);
4565 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4566 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4567 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
4569 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4570 if (!NULL_INTERVAL_P (tmp_interval3))
4571 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
4573 /* holds region 1 */
4574 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
4575 start1_addr = BYTE_POS_ADDR (start1_byte);
4576 start2_addr = BYTE_POS_ADDR (start2_byte);
4577 bcopy (start1_addr, temp, len1_byte);
4578 bcopy (start2_addr, start1_addr, len2_byte);
4579 bcopy (start1_addr + len1_byte, start1_addr + len2_byte, len_mid);
4580 bcopy (temp, start1_addr + len2_byte + len_mid, len1_byte);
4581 SAFE_FREE ();
4583 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4584 len1, current_buffer, 0);
4585 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4586 len_mid, current_buffer, 0);
4587 graft_intervals_into_buffer (tmp_interval2, start1,
4588 len2, current_buffer, 0);
4591 update_compositions (start1, start1 + len2, CHECK_BORDER);
4592 update_compositions (end2 - len1, end2, CHECK_BORDER);
4595 /* When doing multiple transpositions, it might be nice
4596 to optimize this. Perhaps the markers in any one buffer
4597 should be organized in some sorted data tree. */
4598 if (NILP (leave_markers))
4600 transpose_markers (start1, end1, start2, end2,
4601 start1_byte, start1_byte + len1_byte,
4602 start2_byte, start2_byte + len2_byte);
4603 fix_start_end_in_overlays (start1, end2);
4606 signal_after_change (start1, end2 - start1, end2 - start1);
4607 return Qnil;
4611 void
4612 syms_of_editfns ()
4614 environbuf = 0;
4615 initial_tz = 0;
4617 Qbuffer_access_fontify_functions
4618 = intern ("buffer-access-fontify-functions");
4619 staticpro (&Qbuffer_access_fontify_functions);
4621 DEFVAR_LISP ("inhibit-field-text-motion", &Vinhibit_field_text_motion,
4622 doc: /* Non-nil means text motion commands don't notice fields. */);
4623 Vinhibit_field_text_motion = Qnil;
4625 DEFVAR_LISP ("buffer-access-fontify-functions",
4626 &Vbuffer_access_fontify_functions,
4627 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
4628 Each function is called with two arguments which specify the range
4629 of the buffer being accessed. */);
4630 Vbuffer_access_fontify_functions = Qnil;
4633 Lisp_Object obuf;
4634 extern Lisp_Object Vprin1_to_string_buffer;
4635 obuf = Fcurrent_buffer ();
4636 /* Do this here, because init_buffer_once is too early--it won't work. */
4637 Fset_buffer (Vprin1_to_string_buffer);
4638 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
4639 Fset (Fmake_local_variable (intern ("buffer-access-fontify-functions")),
4640 Qnil);
4641 Fset_buffer (obuf);
4644 DEFVAR_LISP ("buffer-access-fontified-property",
4645 &Vbuffer_access_fontified_property,
4646 doc: /* Property which (if non-nil) indicates text has been fontified.
4647 `buffer-substring' need not call the `buffer-access-fontify-functions'
4648 functions if all the text being accessed has this property. */);
4649 Vbuffer_access_fontified_property = Qnil;
4651 DEFVAR_LISP ("system-name", &Vsystem_name,
4652 doc: /* The host name of the machine Emacs is running on. */);
4654 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
4655 doc: /* The full name of the user logged in. */);
4657 DEFVAR_LISP ("user-login-name", &Vuser_login_name,
4658 doc: /* The user's name, taken from environment variables if possible. */);
4660 DEFVAR_LISP ("user-real-login-name", &Vuser_real_login_name,
4661 doc: /* The user's name, based upon the real uid only. */);
4663 DEFVAR_LISP ("operating-system-release", &Voperating_system_release,
4664 doc: /* The release of the operating system Emacs is running on. */);
4666 defsubr (&Spropertize);
4667 defsubr (&Schar_equal);
4668 defsubr (&Sgoto_char);
4669 defsubr (&Sstring_to_char);
4670 defsubr (&Schar_to_string);
4671 defsubr (&Sbuffer_substring);
4672 defsubr (&Sbuffer_substring_no_properties);
4673 defsubr (&Sbuffer_string);
4675 defsubr (&Spoint_marker);
4676 defsubr (&Smark_marker);
4677 defsubr (&Spoint);
4678 defsubr (&Sregion_beginning);
4679 defsubr (&Sregion_end);
4681 staticpro (&Qfield);
4682 Qfield = intern ("field");
4683 staticpro (&Qboundary);
4684 Qboundary = intern ("boundary");
4685 defsubr (&Sfield_beginning);
4686 defsubr (&Sfield_end);
4687 defsubr (&Sfield_string);
4688 defsubr (&Sfield_string_no_properties);
4689 defsubr (&Sdelete_field);
4690 defsubr (&Sconstrain_to_field);
4692 defsubr (&Sline_beginning_position);
4693 defsubr (&Sline_end_position);
4695 /* defsubr (&Smark); */
4696 /* defsubr (&Sset_mark); */
4697 defsubr (&Ssave_excursion);
4698 defsubr (&Ssave_current_buffer);
4700 defsubr (&Sbufsize);
4701 defsubr (&Spoint_max);
4702 defsubr (&Spoint_min);
4703 defsubr (&Spoint_min_marker);
4704 defsubr (&Spoint_max_marker);
4705 defsubr (&Sgap_position);
4706 defsubr (&Sgap_size);
4707 defsubr (&Sposition_bytes);
4708 defsubr (&Sbyte_to_position);
4710 defsubr (&Sbobp);
4711 defsubr (&Seobp);
4712 defsubr (&Sbolp);
4713 defsubr (&Seolp);
4714 defsubr (&Sfollowing_char);
4715 defsubr (&Sprevious_char);
4716 defsubr (&Schar_after);
4717 defsubr (&Schar_before);
4718 defsubr (&Sinsert);
4719 defsubr (&Sinsert_before_markers);
4720 defsubr (&Sinsert_and_inherit);
4721 defsubr (&Sinsert_and_inherit_before_markers);
4722 defsubr (&Sinsert_char);
4723 defsubr (&Sinsert_byte);
4725 defsubr (&Suser_login_name);
4726 defsubr (&Suser_real_login_name);
4727 defsubr (&Suser_uid);
4728 defsubr (&Suser_real_uid);
4729 defsubr (&Suser_full_name);
4730 defsubr (&Semacs_pid);
4731 defsubr (&Scurrent_time);
4732 defsubr (&Sget_internal_run_time);
4733 defsubr (&Sformat_time_string);
4734 defsubr (&Sfloat_time);
4735 defsubr (&Sdecode_time);
4736 defsubr (&Sencode_time);
4737 defsubr (&Scurrent_time_string);
4738 defsubr (&Scurrent_time_zone);
4739 defsubr (&Sset_time_zone_rule);
4740 defsubr (&Ssystem_name);
4741 defsubr (&Smessage);
4742 defsubr (&Smessage_box);
4743 defsubr (&Smessage_or_box);
4744 defsubr (&Scurrent_message);
4745 defsubr (&Sformat);
4747 defsubr (&Sinsert_buffer_substring);
4748 defsubr (&Scompare_buffer_substrings);
4749 defsubr (&Ssubst_char_in_region);
4750 defsubr (&Stranslate_region_internal);
4751 defsubr (&Sdelete_region);
4752 defsubr (&Sdelete_and_extract_region);
4753 defsubr (&Swiden);
4754 defsubr (&Snarrow_to_region);
4755 defsubr (&Ssave_restriction);
4756 defsubr (&Stranspose_regions);
4759 /* arch-tag: fc3827d8-6f60-4067-b11e-c3218031b018
4760 (do not change this comment) */