Support higher-resolution time stamps.
[bpt/emacs.git] / src / editfns.c
CommitLineData
35692fe0 1/* Lisp functions pertaining to editing.
64c60c2f 2
acaf905b 3Copyright (C) 1985-1987, 1989, 1993-2012 Free Software Foundation, Inc.
35692fe0
JB
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
35692fe0 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
35692fe0
JB
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
35692fe0
JB
19
20
18160b98 21#include <config.h>
68c45bf0 22#include <sys/types.h>
3c14598c 23#include <stdio.h>
d7306fe6 24#include <setjmp.h>
bfb61299 25
5b9c0a1d 26#ifdef HAVE_PWD_H
35692fe0 27#include <pwd.h>
bfb61299
JB
28#endif
29
dfcf069d 30#include <unistd.h>
dfcf069d 31
3bb9abc8
ST
32#ifdef HAVE_SYS_UTSNAME_H
33#include <sys/utsname.h>
34#endif
35
b17f9379
DN
36#include "lisp.h"
37
3c14598c
EZ
38/* systime.h includes <sys/time.h> which, on some systems, is required
39 for <sys/resource.h>; thus systime.h must be included before
40 <sys/resource.h> */
41#include "systime.h"
21acf124
ST
42
43#if defined HAVE_SYS_RESOURCE_H
4211ee7d 44#include <sys/resource.h>
e0f712ba
AC
45#endif
46
409847a1 47#include <ctype.h>
37910ab2 48#include <float.h>
b8d9bd41
PE
49#include <limits.h>
50#include <intprops.h>
16c3e636 51#include <strftime.h>
37910ab2 52#include <verify.h>
409847a1 53
74d6d8c5 54#include "intervals.h"
40fbd254 55#include "character.h"
e5560ff7 56#include "buffer.h"
68c45bf0 57#include "coding.h"
0ae83348 58#include "frame.h"
35692fe0 59#include "window.h"
b91834c3 60#include "blockinput.h"
35692fe0 61
d823c26b
EZ
62#ifndef USER_FULL_NAME
63#define USER_FULL_NAME pw->pw_gecos
64#endif
65
f12ef5eb 66#ifndef USE_CRT_DLL
c59b5089 67extern char **environ;
f12ef5eb
AI
68#endif
69
aac18aa4
PE
70#define TM_YEAR_BASE 1900
71
c433c134 72#ifdef WINDOWSNT
361358ea 73extern Lisp_Object w32_get_internal_run_time (void);
c433c134
JR
74#endif
75
d35af63c
PE
76static Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
77 int, struct tm *);
f57e2426 78static int tm_diff (struct tm *, struct tm *);
d311d28c 79static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
260e2e2a 80
955cbe7b 81static Lisp_Object Qbuffer_access_fontify_functions;
cd64ea1d 82static Lisp_Object Fuser_full_name (Lisp_Object);
e3ed8469 83
acb7cc89
GM
84/* Symbol for the text property used to mark fields. */
85
86Lisp_Object Qfield;
87
88/* A special value for Qfield properties. */
89
955cbe7b 90static Lisp_Object Qboundary;
acb7cc89
GM
91
92
35692fe0 93void
971de7fb 94init_editfns (void)
35692fe0 95{
63c5d10b 96 const char *user_name;
e7f8264d 97 register char *p;
35692fe0 98 struct passwd *pw; /* password entry for the current user */
35692fe0
JB
99 Lisp_Object tem;
100
101 /* Set up system_name even when dumping. */
ac988277 102 init_system_name ();
35692fe0
JB
103
104#ifndef CANNOT_DUMP
105 /* Don't bother with this on initial start when just dumping out */
106 if (!initialized)
107 return;
108#endif /* not CANNOT_DUMP */
109
63c5d10b 110 pw = getpwuid (getuid ());
87485d6f
MW
111#ifdef MSDOS
112 /* We let the real user name default to "root" because that's quite
113 accurate on MSDOG and because it lets Emacs find the init file.
114 (The DVX libraries override the Djgpp libraries here.) */
35b34f72 115 Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
87485d6f 116#else
35b34f72 117 Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
87485d6f 118#endif
35692fe0 119
52b14ac0
JB
120 /* Get the effective user name, by consulting environment variables,
121 or the effective uid if those are unset. */
63c5d10b 122 user_name = getenv ("LOGNAME");
35692fe0 123 if (!user_name)
4691c06d 124#ifdef WINDOWSNT
63c5d10b 125 user_name = getenv ("USERNAME"); /* it's USERNAME on NT */
4691c06d 126#else /* WINDOWSNT */
63c5d10b 127 user_name = getenv ("USER");
4691c06d 128#endif /* WINDOWSNT */
52b14ac0
JB
129 if (!user_name)
130 {
63c5d10b
PE
131 pw = getpwuid (geteuid ());
132 user_name = pw ? pw->pw_name : "unknown";
52b14ac0 133 }
35b34f72 134 Vuser_login_name = build_string (user_name);
35692fe0 135
52b14ac0
JB
136 /* If the user name claimed in the environment vars differs from
137 the real uid, use the claimed name to find the full name. */
35b34f72 138 tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
d311d28c
PE
139 if (! NILP (tem))
140 tem = Vuser_login_name;
141 else
142 {
143 uid_t euid = geteuid ();
144 tem = make_fixnum_or_float (euid);
145 }
146 Vuser_full_name = Fuser_full_name (tem);
34a7a267 147
e7f8264d 148 p = getenv ("NAME");
9d36d071
RS
149 if (p)
150 Vuser_full_name = build_string (p);
3347526c
RS
151 else if (NILP (Vuser_full_name))
152 Vuser_full_name = build_string ("unknown");
3bb9abc8
ST
153
154#ifdef HAVE_SYS_UTSNAME_H
155 {
156 struct utsname uts;
157 uname (&uts);
158 Voperating_system_release = build_string (uts.release);
159 }
160#else
161 Voperating_system_release = Qnil;
162#endif
35692fe0
JB
163}
164\f
a7ca3326 165DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
06283081
PJ
166 doc: /* Convert arg CHAR to a string containing that character.
167usage: (char-to-string CHAR) */)
5842a27b 168 (Lisp_Object character)
35692fe0 169{
13bdea59 170 int c, len;
d5c2c403 171 unsigned char str[MAX_MULTIBYTE_LENGTH];
fb8106e8 172
1b9c91ed 173 CHECK_CHARACTER (character);
13bdea59 174 c = XFASTINT (character);
35692fe0 175
13bdea59 176 len = CHAR_STRING (c, str);
e7f8264d 177 return make_string_from_bytes ((char *) str, 1, len);
35692fe0
JB
178}
179
c3bb441d 180DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
35f1de62 181 doc: /* Convert arg BYTE to a unibyte string containing that byte. */)
5842a27b 182 (Lisp_Object byte)
c3bb441d 183{
64c60c2f 184 unsigned char b;
c3bb441d 185 CHECK_NUMBER (byte);
35f1de62
CY
186 if (XINT (byte) < 0 || XINT (byte) > 255)
187 error ("Invalid byte");
64c60c2f 188 b = XINT (byte);
e7f8264d 189 return make_string_from_bytes ((char *) &b, 1, 1);
c3bb441d
SM
190}
191
35692fe0 192DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
da4adb04 193 doc: /* Return the first character in STRING. */)
5842a27b 194 (register Lisp_Object string)
35692fe0
JB
195{
196 register Lisp_Object val;
b7826503 197 CHECK_STRING (string);
4e491f8d 198 if (SCHARS (string))
d9d851ea
KH
199 {
200 if (STRING_MULTIBYTE (string))
62a6e103 201 XSETFASTINT (val, STRING_CHAR (SDATA (string)));
d9d851ea 202 else
4e491f8d 203 XSETFASTINT (val, SREF (string, 0));
d9d851ea 204 }
35692fe0 205 else
55561c63 206 XSETFASTINT (val, 0);
35692fe0
JB
207 return val;
208}
209\f
210static Lisp_Object
d311d28c 211buildmark (ptrdiff_t charpos, ptrdiff_t bytepos)
35692fe0
JB
212{
213 register Lisp_Object mark;
214 mark = Fmake_marker ();
ec1c14f6 215 set_marker_both (mark, Qnil, charpos, bytepos);
35692fe0
JB
216 return mark;
217}
218
a7ca3326 219DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
7ee72033
MB
220 doc: /* Return value of point, as an integer.
221Beginning of buffer is position (point-min). */)
5842a27b 222 (void)
35692fe0
JB
223{
224 Lisp_Object temp;
6ec8bbd2 225 XSETFASTINT (temp, PT);
35692fe0
JB
226 return temp;
227}
228
a7ca3326 229DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
7ee72033 230 doc: /* Return value of point, as a marker object. */)
5842a27b 231 (void)
35692fe0 232{
ec1c14f6 233 return buildmark (PT, PT_BYTE);
35692fe0
JB
234}
235
a7ca3326 236DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
7ee72033 237 doc: /* Set point to POSITION, a number or marker.
8696b557
EZ
238Beginning of buffer is position (point-min), end is (point-max).
239
240The return value is POSITION. */)
5842a27b 241 (register Lisp_Object position)
35692fe0 242{
d311d28c 243 ptrdiff_t pos;
fb8106e8 244
72ef82ec
RS
245 if (MARKERP (position)
246 && current_buffer == XMARKER (position)->buffer)
ec1c14f6
RS
247 {
248 pos = marker_position (position);
249 if (pos < BEGV)
250 SET_PT_BOTH (BEGV, BEGV_BYTE);
251 else if (pos > ZV)
252 SET_PT_BOTH (ZV, ZV_BYTE);
253 else
254 SET_PT_BOTH (pos, marker_byte_position (position));
255
256 return position;
257 }
258
b7826503 259 CHECK_NUMBER_COERCE_MARKER (position);
35692fe0 260
fb8106e8 261 pos = clip_to_bounds (BEGV, XINT (position), ZV);
fb8106e8 262 SET_PT (pos);
2591ec64 263 return position;
35692fe0
JB
264}
265
acb7cc89
GM
266
267/* Return the start or end position of the region.
268 BEGINNINGP non-zero means return the start.
269 If there is no region active, signal an error. */
270
35692fe0 271static Lisp_Object
971de7fb 272region_limit (int beginningp)
35692fe0 273{
acb7cc89 274 Lisp_Object m;
177c0ea7 275
acb7cc89
GM
276 if (!NILP (Vtransient_mark_mode)
277 && NILP (Vmark_even_if_inactive)
4b4deea2 278 && NILP (BVAR (current_buffer, mark_active)))
8a0ff744 279 xsignal0 (Qmark_inactive);
177c0ea7 280
4b4deea2 281 m = Fmarker_position (BVAR (current_buffer, mark));
acb7cc89 282 if (NILP (m))
7b5ad687 283 error ("The mark is not set now, so there is no region");
177c0ea7 284
f555f8cf 285 if ((PT < XFASTINT (m)) == (beginningp != 0))
acb7cc89
GM
286 m = make_number (PT);
287 return m;
35692fe0
JB
288}
289
290DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
7b0815ba 291 doc: /* Return the integer value of point or mark, whichever is smaller. */)
5842a27b 292 (void)
35692fe0 293{
acb7cc89 294 return region_limit (1);
35692fe0
JB
295}
296
297DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
7b0815ba 298 doc: /* Return the integer value of point or mark, whichever is larger. */)
5842a27b 299 (void)
35692fe0 300{
acb7cc89 301 return region_limit (0);
35692fe0
JB
302}
303
35692fe0 304DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
7ee72033 305 doc: /* Return this buffer's mark, as a marker object.
a1f17501 306Watch out! Moving this marker changes the mark position.
7ee72033 307If you set the marker not to point anywhere, the buffer will have no mark. */)
5842a27b 308 (void)
35692fe0 309{
4b4deea2 310 return BVAR (current_buffer, mark);
35692fe0 311}
acb7cc89 312
c9ed721d 313\f
58401a34
SM
314/* Find all the overlays in the current buffer that touch position POS.
315 Return the number found, and store them in a vector in VEC
316 of length LEN. */
317
b081724f
PE
318static ptrdiff_t
319overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
58401a34 320{
88006f77
SM
321 Lisp_Object overlay, start, end;
322 struct Lisp_Overlay *tail;
d311d28c 323 ptrdiff_t startpos, endpos;
b081724f 324 ptrdiff_t idx = 0;
58401a34 325
88006f77 326 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
58401a34 327 {
88006f77 328 XSETMISC (overlay, tail);
58401a34
SM
329
330 end = OVERLAY_END (overlay);
331 endpos = OVERLAY_POSITION (end);
332 if (endpos < pos)
333 break;
334 start = OVERLAY_START (overlay);
335 startpos = OVERLAY_POSITION (start);
336 if (startpos <= pos)
337 {
338 if (idx < len)
339 vec[idx] = overlay;
340 /* Keep counting overlays even if we can't return them all. */
341 idx++;
342 }
343 }
344
88006f77 345 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
58401a34 346 {
88006f77 347 XSETMISC (overlay, tail);
58401a34
SM
348
349 start = OVERLAY_START (overlay);
350 startpos = OVERLAY_POSITION (start);
351 if (pos < startpos)
352 break;
353 end = OVERLAY_END (overlay);
354 endpos = OVERLAY_POSITION (end);
355 if (pos <= endpos)
356 {
357 if (idx < len)
358 vec[idx] = overlay;
359 idx++;
360 }
361 }
362
363 return idx;
364}
365
366/* Return the value of property PROP, in OBJECT at POSITION.
367 It's the value of PROP that a char inserted at POSITION would get.
368 OBJECT is optional and defaults to the current buffer.
369 If OBJECT is a buffer, then overlay properties are considered as well as
370 text properties.
371 If OBJECT is a window, then that window's buffer is used, but
372 window-specific overlays are considered only if they are associated
373 with OBJECT. */
538f9462 374Lisp_Object
971de7fb 375get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
58401a34 376{
58401a34
SM
377 CHECK_NUMBER_COERCE_MARKER (position);
378
379 if (NILP (object))
380 XSETBUFFER (object, current_buffer);
dfe6cbf8
SM
381 else if (WINDOWP (object))
382 object = XWINDOW (object)->buffer;
383
384 if (!BUFFERP (object))
385 /* pos-property only makes sense in buffers right now, since strings
386 have no overlays and no notion of insertion for which stickiness
387 could be obeyed. */
388 return Fget_text_property (position, prop, object);
389 else
58401a34 390 {
29cdc13e 391 EMACS_INT posn = XINT (position);
b081724f 392 ptrdiff_t noverlays;
58401a34
SM
393 Lisp_Object *overlay_vec, tem;
394 struct buffer *obuf = current_buffer;
395
396 set_buffer_temp (XBUFFER (object));
397
398 /* First try with room for 40 overlays. */
399 noverlays = 40;
400 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
401 noverlays = overlays_around (posn, overlay_vec, noverlays);
402
403 /* If there are more than 40,
404 make enough space for all, and try again. */
405 if (noverlays > 40)
406 {
407 overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
408 noverlays = overlays_around (posn, overlay_vec, noverlays);
409 }
410 noverlays = sort_overlays (overlay_vec, noverlays, NULL);
411
412 set_buffer_temp (obuf);
413
414 /* Now check the overlays in order of decreasing priority. */
415 while (--noverlays >= 0)
416 {
417 Lisp_Object ol = overlay_vec[noverlays];
418 tem = Foverlay_get (ol, prop);
419 if (!NILP (tem))
420 {
421 /* Check the overlay is indeed active at point. */
422 Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
423 if ((OVERLAY_POSITION (start) == posn
424 && XMARKER (start)->insertion_type == 1)
425 || (OVERLAY_POSITION (finish) == posn
426 && XMARKER (finish)->insertion_type == 0))
427 ; /* The overlay will not cover a char inserted at point. */
428 else
429 {
430 return tem;
431 }
432 }
433 }
177c0ea7 434
7a6a86ad 435 { /* Now check the text properties. */
dfe6cbf8
SM
436 int stickiness = text_property_stickiness (prop, position, object);
437 if (stickiness > 0)
438 return Fget_text_property (position, prop, object);
439 else if (stickiness < 0
440 && XINT (position) > BUF_BEGV (XBUFFER (object)))
441 return Fget_text_property (make_number (XINT (position) - 1),
442 prop, object);
443 else
444 return Qnil;
445 }
58401a34 446 }
58401a34
SM
447}
448
a3caef99 449/* Find the field surrounding POS in *BEG and *END. If POS is nil,
59062dce 450 the value of point is used instead. If BEG or END is null,
acb7cc89 451 means don't store the beginning or end of the field.
a3caef99 452
9ac741c5
MB
453 BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
454 results; they do not effect boundary behavior.
455
a3caef99 456 If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
ee547125
MB
457 position of a field, then the beginning of the previous field is
458 returned instead of the beginning of POS's field (since the end of a
459 field is actually also the beginning of the next input field, this
460 behavior is sometimes useful). Additionally in the MERGE_AT_BOUNDARY
461 true case, if two fields are separated by a field with the special
462 value `boundary', and POS lies within it, then the two separated
463 fields are considered to be adjacent, and POS between them, when
464 finding the beginning and ending of the "merged" field.
a3caef99
RS
465
466 Either BEG or END may be 0, in which case the corresponding value
467 is not stored. */
468
acb7cc89 469static void
413d18e7
EZ
470find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
471 Lisp_Object beg_limit,
d311d28c 472 ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
0daf6e8d 473{
ee547125
MB
474 /* Fields right before and after the point. */
475 Lisp_Object before_field, after_field;
a3caef99
RS
476 /* 1 if POS counts as the start of a field. */
477 int at_field_start = 0;
478 /* 1 if POS counts as the end of a field. */
479 int at_field_end = 0;
ee547125 480
0daf6e8d
GM
481 if (NILP (pos))
482 XSETFASTINT (pos, PT);
483 else
b7826503 484 CHECK_NUMBER_COERCE_MARKER (pos);
0daf6e8d 485
acb7cc89 486 after_field
58401a34 487 = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
acb7cc89
GM
488 before_field
489 = (XFASTINT (pos) > BEGV
7ae1c032 490 ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
58401a34 491 Qfield, Qnil, NULL)
e477bb04
KL
492 /* Using nil here would be a more obvious choice, but it would
493 fail when the buffer starts with a non-sticky field. */
494 : after_field);
ee547125
MB
495
496 /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
497 and POS is at beginning of a field, which can also be interpreted
498 as the end of the previous field. Note that the case where if
499 MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
500 more natural one; then we avoid treating the beginning of a field
501 specially. */
58401a34 502 if (NILP (merge_at_boundary))
ee547125 503 {
58401a34
SM
504 Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
505 if (!EQ (field, after_field))
ee547125 506 at_field_end = 1;
58401a34
SM
507 if (!EQ (field, before_field))
508 at_field_start = 1;
2db1186a
SM
509 if (NILP (field) && at_field_start && at_field_end)
510 /* If an inserted char would have a nil field while the surrounding
511 text is non-nil, we're probably not looking at a
512 zero-length field, but instead at a non-nil field that's
513 not intended for editing (such as comint's prompts). */
514 at_field_end = at_field_start = 0;
0daf6e8d
GM
515 }
516
ee547125
MB
517 /* Note about special `boundary' fields:
518
519 Consider the case where the point (`.') is between the fields `x' and `y':
520
521 xxxx.yyyy
522
523 In this situation, if merge_at_boundary is true, we consider the
524 `x' and `y' fields as forming one big merged field, and so the end
525 of the field is the end of `y'.
526
527 However, if `x' and `y' are separated by a special `boundary' field
528 (a field with a `field' char-property of 'boundary), then we ignore
529 this special field when merging adjacent fields. Here's the same
530 situation, but with a `boundary' field between the `x' and `y' fields:
531
532 xxx.BBBByyyy
533
534 Here, if point is at the end of `x', the beginning of `y', or
535 anywhere in-between (within the `boundary' field), we merge all
536 three fields and consider the beginning as being the beginning of
537 the `x' field, and the end as being the end of the `y' field. */
538
0daf6e8d 539 if (beg)
acb7cc89
GM
540 {
541 if (at_field_start)
542 /* POS is at the edge of a field, and we should consider it as
543 the beginning of the following field. */
544 *beg = XFASTINT (pos);
545 else
546 /* Find the previous field boundary. */
547 {
58401a34 548 Lisp_Object p = pos;
acb7cc89
GM
549 if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
550 /* Skip a `boundary' field. */
58401a34 551 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
9ac741c5 552 beg_limit);
58401a34
SM
553
554 p = Fprevious_single_char_property_change (p, Qfield, Qnil,
555 beg_limit);
556 *beg = NILP (p) ? BEGV : XFASTINT (p);
acb7cc89
GM
557 }
558 }
0daf6e8d
GM
559
560 if (end)
acb7cc89
GM
561 {
562 if (at_field_end)
563 /* POS is at the edge of a field, and we should consider it as
564 the end of the previous field. */
565 *end = XFASTINT (pos);
566 else
567 /* Find the next field boundary. */
568 {
569 if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
570 /* Skip a `boundary' field. */
9ac741c5
MB
571 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
572 end_limit);
ee547125 573
9ac741c5
MB
574 pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
575 end_limit);
acb7cc89
GM
576 *end = NILP (pos) ? ZV : XFASTINT (pos);
577 }
578 }
0daf6e8d 579}
acb7cc89 580
0daf6e8d 581\f
d01f3570 582DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
7ee72033 583 doc: /* Delete the field surrounding POS.
a1f17501 584A field is a region of text with the same `field' property.
f554db0f 585If POS is nil, the value of point is used for POS. */)
5842a27b 586 (Lisp_Object pos)
0daf6e8d 587{
d311d28c 588 ptrdiff_t beg, end;
9ac741c5 589 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
0daf6e8d
GM
590 if (beg != end)
591 del_range (beg, end);
d01f3570 592 return Qnil;
0daf6e8d
GM
593}
594
595DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
7ee72033 596 doc: /* Return the contents of the field surrounding POS as a string.
a1f17501 597A field is a region of text with the same `field' property.
f554db0f 598If POS is nil, the value of point is used for POS. */)
5842a27b 599 (Lisp_Object pos)
0daf6e8d 600{
d311d28c 601 ptrdiff_t beg, end;
9ac741c5 602 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
0daf6e8d
GM
603 return make_buffer_string (beg, end, 1);
604}
605
606DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
7a6a86ad 607 doc: /* Return the contents of the field around POS, without text properties.
a1f17501 608A field is a region of text with the same `field' property.
f554db0f 609If POS is nil, the value of point is used for POS. */)
5842a27b 610 (Lisp_Object pos)
0daf6e8d 611{
d311d28c 612 ptrdiff_t beg, end;
9ac741c5 613 find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
0daf6e8d
GM
614 return make_buffer_string (beg, end, 0);
615}
616
9ac741c5 617DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
7ee72033 618 doc: /* Return the beginning of the field surrounding POS.
a1f17501
PJ
619A field is a region of text with the same `field' property.
620If POS is nil, the value of point is used for POS.
621If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
9ac741c5
MB
622field, then the beginning of the *previous* field is returned.
623If LIMIT is non-nil, it is a buffer position; if the beginning of the field
f554db0f 624is before LIMIT, then LIMIT will be returned instead. */)
5842a27b 625 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
0daf6e8d 626{
d311d28c 627 ptrdiff_t beg;
9ac741c5 628 find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
0daf6e8d
GM
629 return make_number (beg);
630}
631
a7ca3326 632DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
7ee72033 633 doc: /* Return the end of the field surrounding POS.
a1f17501
PJ
634A field is a region of text with the same `field' property.
635If POS is nil, the value of point is used for POS.
636If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
9ac741c5
MB
637then the end of the *following* field is returned.
638If LIMIT is non-nil, it is a buffer position; if the end of the field
f554db0f 639is after LIMIT, then LIMIT will be returned instead. */)
5842a27b 640 (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
0daf6e8d 641{
d311d28c 642 ptrdiff_t end;
9ac741c5 643 find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
0daf6e8d
GM
644 return make_number (end);
645}
646
a7ca3326 647DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
7ee72033 648 doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
a1f17501 649A field is a region of text with the same `field' property.
66c5eebd
CY
650
651If NEW-POS is nil, then use the current point instead, and move point
652to the resulting constrained position, in addition to returning that
653position.
a1f17501
PJ
654
655If OLD-POS is at the boundary of two fields, then the allowable
656positions for NEW-POS depends on the value of the optional argument
657ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
658constrained to the field that has the same `field' char-property
659as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
660is non-nil, NEW-POS is constrained to the union of the two adjacent
661fields. Additionally, if two fields are separated by another field with
662the special value `boundary', then any point within this special field is
663also considered to be `on the boundary'.
664
665If the optional argument ONLY-IN-LINE is non-nil and constraining
666NEW-POS would move it to a different line, NEW-POS is returned
667unconstrained. This useful for commands that move by line, like
668\\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
669only in the case where they can still move to the right line.
670
671If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
672a non-nil property of that name, then any field boundaries are ignored.
673
7ee72033 674Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil. */)
5842a27b 675 (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
0daf6e8d
GM
676{
677 /* If non-zero, then the original point, before re-positioning. */
d311d28c 678 ptrdiff_t orig_point = 0;
d63b4018
KR
679 int fwd;
680 Lisp_Object prev_old, prev_new;
aac18aa4 681
0daf6e8d
GM
682 if (NILP (new_pos))
683 /* Use the current point, and afterwards, set it. */
684 {
685 orig_point = PT;
686 XSETFASTINT (new_pos, PT);
687 }
688
e477bb04
KL
689 CHECK_NUMBER_COERCE_MARKER (new_pos);
690 CHECK_NUMBER_COERCE_MARKER (old_pos);
691
d311d28c 692 fwd = (XINT (new_pos) > XINT (old_pos));
e477bb04 693
d311d28c
PE
694 prev_old = make_number (XINT (old_pos) - 1);
695 prev_new = make_number (XINT (new_pos) - 1);
aac18aa4 696
ee5cd4db
GM
697 if (NILP (Vinhibit_field_text_motion)
698 && !EQ (new_pos, old_pos)
42ab8e36
MB
699 && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
700 || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
e477bb04
KL
701 /* To recognize field boundaries, we must also look at the
702 previous positions; we could use `get_pos_property'
703 instead, but in itself that would fail inside non-sticky
704 fields (like comint prompts). */
705 || (XFASTINT (new_pos) > BEGV
42ab8e36 706 && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
e477bb04 707 || (XFASTINT (old_pos) > BEGV
42ab8e36 708 && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
ee547125 709 && (NILP (inhibit_capture_property)
e477bb04
KL
710 /* Field boundaries are again a problem; but now we must
711 decide the case exactly, so we need to call
712 `get_pos_property' as well. */
713 || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
714 && (XFASTINT (old_pos) <= BEGV
42ab8e36
MB
715 || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
716 || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
2cb3aec4
KL
717 /* It is possible that NEW_POS is not within the same field as
718 OLD_POS; try to move NEW_POS so that it is. */
0daf6e8d 719 {
d311d28c 720 ptrdiff_t shortage;
0daf6e8d
GM
721 Lisp_Object field_bound;
722
0daf6e8d 723 if (fwd)
9ac741c5 724 field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
0daf6e8d 725 else
9ac741c5 726 field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
0daf6e8d 727
10b0f752
MB
728 if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
729 other side of NEW_POS, which would mean that NEW_POS is
730 already acceptable, and it's not necessary to constrain it
731 to FIELD_BOUND. */
732 ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
733 /* NEW_POS should be constrained, but only if either
734 ONLY_IN_LINE is nil (in which case any constraint is OK),
735 or NEW_POS and FIELD_BOUND are on the same line (in which
736 case the constraint is OK even if ONLY_IN_LINE is non-nil). */
737 && (NILP (only_in_line)
738 /* This is the ONLY_IN_LINE case, check that NEW_POS and
739 FIELD_BOUND are on the same line by seeing whether
740 there's an intervening newline or not. */
741 || (scan_buffer ('\n',
742 XFASTINT (new_pos), XFASTINT (field_bound),
743 fwd ? -1 : 1, &shortage, 1),
744 shortage != 0)))
0daf6e8d
GM
745 /* Constrain NEW_POS to FIELD_BOUND. */
746 new_pos = field_bound;
747
748 if (orig_point && XFASTINT (new_pos) != orig_point)
749 /* The NEW_POS argument was originally nil, so automatically set PT. */
750 SET_PT (XFASTINT (new_pos));
751 }
752
753 return new_pos;
754}
acb7cc89 755
0daf6e8d 756\f
a7ca3326 757DEFUN ("line-beginning-position",
6d57c318 758 Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
7ee72033 759 doc: /* Return the character position of the first character on the current line.
a1f17501
PJ
760With argument N not nil or 1, move forward N - 1 lines first.
761If scan reaches end of buffer, return that position.
6d57c318 762
cd21226d
EZ
763The returned position is of the first character in the logical order,
764i.e. the one that has the smallest character position.
765
2cb3aec4
KL
766This function constrains the returned position to the current field
767unless that would be on a different line than the original,
768unconstrained result. If N is nil or 1, and a front-sticky field
769starts at point, the scan stops as soon as it starts. To ignore field
6d57c318 770boundaries bind `inhibit-field-text-motion' to t.
a1f17501 771
7ee72033 772This function does not move point. */)
5842a27b 773 (Lisp_Object n)
c9ed721d 774{
d311d28c
PE
775 ptrdiff_t orig, orig_byte, end;
776 ptrdiff_t count = SPECPDL_INDEX ();
4e8f005c 777 specbind (Qinhibit_point_motion_hooks, Qt);
c9ed721d
RS
778
779 if (NILP (n))
780 XSETFASTINT (n, 1);
781 else
b7826503 782 CHECK_NUMBER (n);
c9ed721d
RS
783
784 orig = PT;
ec1c14f6 785 orig_byte = PT_BYTE;
c9ed721d
RS
786 Fforward_line (make_number (XINT (n) - 1));
787 end = PT;
e2dae3f2 788
ec1c14f6 789 SET_PT_BOTH (orig, orig_byte);
35692fe0 790
4e8f005c
CY
791 unbind_to (count, Qnil);
792
0daf6e8d 793 /* Return END constrained to the current input field. */
ee5cd4db
GM
794 return Fconstrain_to_field (make_number (end), make_number (orig),
795 XINT (n) != 1 ? Qt : Qnil,
ee547125 796 Qt, Qnil);
c9ed721d
RS
797}
798
a7ca3326 799DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
7ee72033 800 doc: /* Return the character position of the last character on the current line.
a1f17501
PJ
801With argument N not nil or 1, move forward N - 1 lines first.
802If scan reaches end of buffer, return that position.
6d57c318 803
cd21226d
EZ
804The returned position is of the last character in the logical order,
805i.e. the character whose buffer position is the largest one.
806
2cb3aec4
KL
807This function constrains the returned position to the current field
808unless that would be on a different line than the original,
809unconstrained result. If N is nil or 1, and a rear-sticky field ends
810at point, the scan stops as soon as it starts. To ignore field
6d57c318
MB
811boundaries bind `inhibit-field-text-motion' to t.
812
7ee72033 813This function does not move point. */)
5842a27b 814 (Lisp_Object n)
c9ed721d 815{
d311d28c
PE
816 ptrdiff_t clipped_n;
817 ptrdiff_t end_pos;
818 ptrdiff_t orig = PT;
0daf6e8d 819
c9ed721d
RS
820 if (NILP (n))
821 XSETFASTINT (n, 1);
822 else
b7826503 823 CHECK_NUMBER (n);
c9ed721d 824
d311d28c
PE
825 clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
826 end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0));
0daf6e8d
GM
827
828 /* Return END_POS constrained to the current input field. */
ee5cd4db 829 return Fconstrain_to_field (make_number (end_pos), make_number (orig),
ee547125 830 Qnil, Qt, Qnil);
c9ed721d 831}
6d57c318 832
c9ed721d 833\f
35692fe0 834Lisp_Object
971de7fb 835save_excursion_save (void)
35692fe0 836{
acb7cc89
GM
837 int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
838 == current_buffer);
35692fe0
JB
839
840 return Fcons (Fpoint_marker (),
4b4deea2 841 Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
9772455e 842 Fcons (visible ? Qt : Qnil,
4b4deea2 843 Fcons (BVAR (current_buffer, mark_active),
2483cf58 844 selected_window))));
35692fe0
JB
845}
846
847Lisp_Object
971de7fb 848save_excursion_restore (Lisp_Object info)
35692fe0 849{
4ad8681a
RS
850 Lisp_Object tem, tem1, omark, nmark;
851 struct gcpro gcpro1, gcpro2, gcpro3;
2483cf58 852 int visible_p;
35692fe0 853
2483cf58 854 tem = Fmarker_buffer (XCAR (info));
35692fe0
JB
855 /* If buffer being returned to is now deleted, avoid error */
856 /* Otherwise could get error here while unwinding to top level
857 and crash */
858 /* In that case, Fmarker_buffer returns nil now. */
56a98455 859 if (NILP (tem))
35692fe0 860 return Qnil;
4ad8681a
RS
861
862 omark = nmark = Qnil;
863 GCPRO3 (info, omark, nmark);
864
35692fe0 865 Fset_buffer (tem);
2483cf58
GM
866
867 /* Point marker. */
868 tem = XCAR (info);
35692fe0 869 Fgoto_char (tem);
12038f9f 870 unchain_marker (XMARKER (tem));
2483cf58
GM
871
872 /* Mark marker. */
873 info = XCDR (info);
874 tem = XCAR (info);
4b4deea2
TT
875 omark = Fmarker_position (BVAR (current_buffer, mark));
876 Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
03d18690 877 nmark = Fmarker_position (tem);
12038f9f 878 unchain_marker (XMARKER (tem));
2483cf58
GM
879
880 /* visible */
881 info = XCDR (info);
882 visible_p = !NILP (XCAR (info));
177c0ea7 883
ef580991
RS
884#if 0 /* We used to make the current buffer visible in the selected window
885 if that was true previously. That avoids some anomalies.
886 But it creates others, and it wasn't documented, and it is simpler
887 and cleaner never to alter the window/buffer connections. */
9772455e
RS
888 tem1 = Fcar (tem);
889 if (!NILP (tem1)
0e2c9c70 890 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
35692fe0 891 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
ef580991 892#endif /* 0 */
9772455e 893
2483cf58
GM
894 /* Mark active */
895 info = XCDR (info);
896 tem = XCAR (info);
4b4deea2
TT
897 tem1 = BVAR (current_buffer, mark_active);
898 BVAR (current_buffer, mark_active) = tem;
2483cf58 899
dee091a3
JD
900 /* If mark is active now, and either was not active
901 or was at a different place, run the activate hook. */
902 if (! NILP (tem))
9fed2b18 903 {
dee091a3
JD
904 if (! EQ (omark, nmark))
905 {
906 tem = intern ("activate-mark-hook");
907 Frun_hooks (1, &tem);
908 }
909 }
910 /* If mark has ceased to be active, run deactivate hook. */
911 else if (! NILP (tem1))
912 {
913 tem = intern ("deactivate-mark-hook");
914 Frun_hooks (1, &tem);
9fed2b18 915 }
2483cf58
GM
916
917 /* If buffer was visible in a window, and a different window was
793cd2c8
GM
918 selected, and the old selected window is still showing this
919 buffer, restore point in that window. */
2483cf58
GM
920 tem = XCDR (info);
921 if (visible_p
922 && !EQ (tem, selected_window)
ba973f7a
GM
923 && (tem1 = XWINDOW (tem)->buffer,
924 (/* Window is live... */
925 BUFFERP (tem1)
926 /* ...and it shows the current buffer. */
927 && XBUFFER (tem1) == current_buffer)))
2483cf58
GM
928 Fset_window_point (tem, make_number (PT));
929
4ad8681a 930 UNGCPRO;
35692fe0
JB
931 return Qnil;
932}
933
934DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
7ee72033 935 doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
a1f17501
PJ
936Executes BODY just like `progn'.
937The values of point, mark and the current buffer are restored
938even in case of abnormal exit (throw or error).
939The state of activation of the mark is also restored.
940
941This construct does not save `deactivate-mark', and therefore
942functions that change the buffer will still cause deactivation
943of the mark at the end of the command. To prevent that, bind
33c2d29f
MB
944`deactivate-mark' with `let'.
945
7450fd36
SM
946If you only want to save the current buffer but not point nor mark,
947then just use `save-current-buffer', or even `with-current-buffer'.
948
33c2d29f 949usage: (save-excursion &rest BODY) */)
5842a27b 950 (Lisp_Object args)
35692fe0
JB
951{
952 register Lisp_Object val;
d311d28c 953 ptrdiff_t count = SPECPDL_INDEX ();
35692fe0
JB
954
955 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4bc8c7d2
RS
956
957 val = Fprogn (args);
958 return unbind_to (count, val);
959}
960
961DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
7ee72033 962 doc: /* Save the current buffer; execute BODY; restore the current buffer.
33c2d29f
MB
963Executes BODY just like `progn'.
964usage: (save-current-buffer &rest BODY) */)
5842a27b 965 (Lisp_Object args)
4bc8c7d2 966{
acb7cc89 967 Lisp_Object val;
d311d28c 968 ptrdiff_t count = SPECPDL_INDEX ();
4bc8c7d2 969
cb5e5f74 970 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
4bc8c7d2 971
35692fe0
JB
972 val = Fprogn (args);
973 return unbind_to (count, val);
974}
975\f
95dccf75 976DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
7ee72033
MB
977 doc: /* Return the number of characters in the current buffer.
978If BUFFER, return the number of characters in that buffer instead. */)
5842a27b 979 (Lisp_Object buffer)
35692fe0 980{
95dccf75
RS
981 if (NILP (buffer))
982 return make_number (Z - BEG);
02050596
RS
983 else
984 {
b7826503 985 CHECK_BUFFER (buffer);
02050596
RS
986 return make_number (BUF_Z (XBUFFER (buffer))
987 - BUF_BEG (XBUFFER (buffer)));
988 }
35692fe0
JB
989}
990
991DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
7ee72033
MB
992 doc: /* Return the minimum permissible value of point in the current buffer.
993This is 1, unless narrowing (a buffer restriction) is in effect. */)
5842a27b 994 (void)
35692fe0
JB
995{
996 Lisp_Object temp;
55561c63 997 XSETFASTINT (temp, BEGV);
35692fe0
JB
998 return temp;
999}
1000
1001DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
7ee72033
MB
1002 doc: /* Return a marker to the minimum permissible value of point in this buffer.
1003This is the beginning, unless narrowing (a buffer restriction) is in effect. */)
5842a27b 1004 (void)
35692fe0 1005{
ec1c14f6 1006 return buildmark (BEGV, BEGV_BYTE);
35692fe0
JB
1007}
1008
1009DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
7ee72033 1010 doc: /* Return the maximum permissible value of point in the current buffer.
a1f17501 1011This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
7ee72033 1012is in effect, in which case it is less. */)
5842a27b 1013 (void)
35692fe0
JB
1014{
1015 Lisp_Object temp;
55561c63 1016 XSETFASTINT (temp, ZV);
35692fe0
JB
1017 return temp;
1018}
1019
a7ca3326 1020DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
7ee72033 1021 doc: /* Return a marker to the maximum permissible value of point in this buffer.
a1f17501 1022This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
7ee72033 1023is in effect, in which case it is less. */)
5842a27b 1024 (void)
35692fe0 1025{
ec1c14f6 1026 return buildmark (ZV, ZV_BYTE);
35692fe0
JB
1027}
1028
c86212b9 1029DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
7ee72033
MB
1030 doc: /* Return the position of the gap, in the current buffer.
1031See also `gap-size'. */)
5842a27b 1032 (void)
c86212b9
RS
1033{
1034 Lisp_Object temp;
1035 XSETFASTINT (temp, GPT);
1036 return temp;
1037}
1038
1039DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
7ee72033
MB
1040 doc: /* Return the size of the current buffer's gap.
1041See also `gap-position'. */)
5842a27b 1042 (void)
c86212b9
RS
1043{
1044 Lisp_Object temp;
1045 XSETFASTINT (temp, GAP_SIZE);
1046 return temp;
1047}
1048
7df74da6 1049DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
7ee72033
MB
1050 doc: /* Return the byte position for character position POSITION.
1051If POSITION is out of range, the value is nil. */)
5842a27b 1052 (Lisp_Object position)
7df74da6 1053{
b7826503 1054 CHECK_NUMBER_COERCE_MARKER (position);
fcf9683e
KH
1055 if (XINT (position) < BEG || XINT (position) > Z)
1056 return Qnil;
fa8a5a15 1057 return make_number (CHAR_TO_BYTE (XINT (position)));
7df74da6 1058}
3ab0732d
RS
1059
1060DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
7ee72033
MB
1061 doc: /* Return the character position for byte position BYTEPOS.
1062If BYTEPOS is out of range, the value is nil. */)
5842a27b 1063 (Lisp_Object bytepos)
3ab0732d 1064{
b7826503 1065 CHECK_NUMBER (bytepos);
fcf9683e
KH
1066 if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
1067 return Qnil;
3ab0732d
RS
1068 return make_number (BYTE_TO_CHAR (XINT (bytepos)));
1069}
7df74da6 1070\f
a7ca3326 1071DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
7ee72033
MB
1072 doc: /* Return the character following point, as a number.
1073At the end of the buffer or accessible region, return 0. */)
5842a27b 1074 (void)
35692fe0
JB
1075{
1076 Lisp_Object temp;
6ec8bbd2 1077 if (PT >= ZV)
55561c63 1078 XSETFASTINT (temp, 0);
850a8179 1079 else
ec1c14f6 1080 XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
35692fe0
JB
1081 return temp;
1082}
1083
a7ca3326 1084DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
7ee72033
MB
1085 doc: /* Return the character preceding point, as a number.
1086At the beginning of the buffer or accessible region, return 0. */)
5842a27b 1087 (void)
35692fe0
JB
1088{
1089 Lisp_Object temp;
6ec8bbd2 1090 if (PT <= BEGV)
55561c63 1091 XSETFASTINT (temp, 0);
4b4deea2 1092 else if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
fb8106e8 1093 {
d311d28c 1094 ptrdiff_t pos = PT_BYTE;
fb8106e8
KH
1095 DEC_POS (pos);
1096 XSETFASTINT (temp, FETCH_CHAR (pos));
1097 }
35692fe0 1098 else
ec1c14f6 1099 XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
35692fe0
JB
1100 return temp;
1101}
1102
a7ca3326 1103DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
7ee72033
MB
1104 doc: /* Return t if point is at the beginning of the buffer.
1105If the buffer is narrowed, this means the beginning of the narrowed part. */)
5842a27b 1106 (void)
35692fe0 1107{
6ec8bbd2 1108 if (PT == BEGV)
35692fe0
JB
1109 return Qt;
1110 return Qnil;
1111}
1112
a7ca3326 1113DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
7ee72033
MB
1114 doc: /* Return t if point is at the end of the buffer.
1115If the buffer is narrowed, this means the end of the narrowed part. */)
5842a27b 1116 (void)
35692fe0 1117{
6ec8bbd2 1118 if (PT == ZV)
35692fe0
JB
1119 return Qt;
1120 return Qnil;
1121}
1122
a7ca3326 1123DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
7ee72033 1124 doc: /* Return t if point is at the beginning of a line. */)
5842a27b 1125 (void)
35692fe0 1126{
ec1c14f6 1127 if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
35692fe0
JB
1128 return Qt;
1129 return Qnil;
1130}
1131
a7ca3326 1132DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
7ee72033
MB
1133 doc: /* Return t if point is at the end of a line.
1134`End of a line' includes point being at the end of the buffer. */)
5842a27b 1135 (void)
35692fe0 1136{
ec1c14f6 1137 if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
35692fe0
JB
1138 return Qt;
1139 return Qnil;
1140}
1141
a7ca3326 1142DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
7ee72033 1143 doc: /* Return character in current buffer at position POS.
f555f8cf 1144POS is an integer or a marker and defaults to point.
7ee72033 1145If POS is out of range, the value is nil. */)
5842a27b 1146 (Lisp_Object pos)
35692fe0 1147{
d311d28c 1148 register ptrdiff_t pos_byte;
35692fe0 1149
fa1d3816 1150 if (NILP (pos))
39a4c932
RS
1151 {
1152 pos_byte = PT_BYTE;
3c52e568 1153 XSETFASTINT (pos, PT);
39a4c932
RS
1154 }
1155
1156 if (MARKERP (pos))
85cac557
RS
1157 {
1158 pos_byte = marker_byte_position (pos);
1159 if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
1160 return Qnil;
1161 }
fa1d3816
RS
1162 else
1163 {
b7826503 1164 CHECK_NUMBER_COERCE_MARKER (pos);
b98ef0dc 1165 if (XINT (pos) < BEGV || XINT (pos) >= ZV)
85cac557 1166 return Qnil;
34a7a267 1167
ec1c14f6 1168 pos_byte = CHAR_TO_BYTE (XINT (pos));
fa1d3816 1169 }
35692fe0 1170
ec1c14f6 1171 return make_number (FETCH_CHAR (pos_byte));
35692fe0 1172}
fb8106e8 1173
fa1d3816 1174DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
7ee72033 1175 doc: /* Return character in current buffer preceding position POS.
f555f8cf 1176POS is an integer or a marker and defaults to point.
7ee72033 1177If POS is out of range, the value is nil. */)
5842a27b 1178 (Lisp_Object pos)
fb8106e8
KH
1179{
1180 register Lisp_Object val;
d311d28c 1181 register ptrdiff_t pos_byte;
fb8106e8 1182
fa1d3816 1183 if (NILP (pos))
39a4c932
RS
1184 {
1185 pos_byte = PT_BYTE;
3c52e568 1186 XSETFASTINT (pos, PT);
39a4c932
RS
1187 }
1188
1189 if (MARKERP (pos))
85cac557
RS
1190 {
1191 pos_byte = marker_byte_position (pos);
1192
1193 if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
1194 return Qnil;
1195 }
fa1d3816
RS
1196 else
1197 {
b7826503 1198 CHECK_NUMBER_COERCE_MARKER (pos);
fb8106e8 1199
b98ef0dc 1200 if (XINT (pos) <= BEGV || XINT (pos) > ZV)
85cac557
RS
1201 return Qnil;
1202
ec1c14f6 1203 pos_byte = CHAR_TO_BYTE (XINT (pos));
fa1d3816 1204 }
fb8106e8 1205
4b4deea2 1206 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
fb8106e8 1207 {
ec1c14f6
RS
1208 DEC_POS (pos_byte);
1209 XSETFASTINT (val, FETCH_CHAR (pos_byte));
fb8106e8
KH
1210 }
1211 else
1212 {
ec1c14f6
RS
1213 pos_byte--;
1214 XSETFASTINT (val, FETCH_BYTE (pos_byte));
fb8106e8
KH
1215 }
1216 return val;
1217}
35692fe0 1218\f
a7ca3326 1219DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
7ee72033 1220 doc: /* Return the name under which the user logged in, as a string.
a1f17501 1221This is based on the effective uid, not the real uid.
412f1fab 1222Also, if the environment variables LOGNAME or USER are set,
a1f17501
PJ
1223that determines the value of this function.
1224
7b1c38a4
EZ
1225If optional argument UID is an integer or a float, return the login name
1226of the user with that uid, or nil if there is no such user. */)
5842a27b 1227 (Lisp_Object uid)
35692fe0 1228{
87485d6f 1229 struct passwd *pw;
7b1c38a4 1230 uid_t id;
87485d6f 1231
f8a0e364
RS
1232 /* Set up the user name info if we didn't do it before.
1233 (That can happen if Emacs is dumpable
1234 but you decide to run `temacs -l loadup' and not dump. */
35b34f72 1235 if (INTEGERP (Vuser_login_name))
f8a0e364 1236 init_editfns ();
87485d6f
MW
1237
1238 if (NILP (uid))
35b34f72 1239 return Vuser_login_name;
87485d6f 1240
3f4eabd1 1241 CONS_TO_INTEGER (uid, uid_t, id);
b91834c3 1242 BLOCK_INPUT;
63c5d10b 1243 pw = getpwuid (id);
b91834c3 1244 UNBLOCK_INPUT;
87485d6f 1245 return (pw ? build_string (pw->pw_name) : Qnil);
35692fe0
JB
1246}
1247
1248DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
deb8e082 1249 0, 0, 0,
7ee72033 1250 doc: /* Return the name of the user's real uid, as a string.
a1f17501 1251This ignores the environment variables LOGNAME and USER, so it differs from
7ee72033 1252`user-login-name' when running under `su'. */)
5842a27b 1253 (void)
35692fe0 1254{
f8a0e364
RS
1255 /* Set up the user name info if we didn't do it before.
1256 (That can happen if Emacs is dumpable
1257 but you decide to run `temacs -l loadup' and not dump. */
35b34f72 1258 if (INTEGERP (Vuser_login_name))
f8a0e364 1259 init_editfns ();
35b34f72 1260 return Vuser_real_login_name;
35692fe0
JB
1261}
1262
1263DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
7ee72033 1264 doc: /* Return the effective uid of Emacs.
e00553bf 1265Value is an integer or a float, depending on the value. */)
5842a27b 1266 (void)
35692fe0 1267{
d311d28c 1268 uid_t euid = geteuid ();
3aef3c0a 1269 return make_fixnum_or_float (euid);
35692fe0
JB
1270}
1271
1272DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
7ee72033 1273 doc: /* Return the real uid of Emacs.
e00553bf 1274Value is an integer or a float, depending on the value. */)
5842a27b 1275 (void)
35692fe0 1276{
d311d28c 1277 uid_t uid = getuid ();
3aef3c0a 1278 return make_fixnum_or_float (uid);
35692fe0
JB
1279}
1280
c9ed721d 1281DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
7ee72033 1282 doc: /* Return the full name of the user logged in, as a string.
a1f17501
PJ
1283If the full name corresponding to Emacs's userid is not known,
1284return "unknown".
1285
1286If optional argument UID is an integer or float, return the full name
1287of the user with that uid, or nil if there is no such user.
1288If UID is a string, return the full name of the user with that login
7ee72033 1289name, or nil if there is no such user. */)
5842a27b 1290 (Lisp_Object uid)
35692fe0 1291{
c9ed721d 1292 struct passwd *pw;
e7f8264d 1293 register char *p, *q;
3415b0e9 1294 Lisp_Object full;
c9ed721d
RS
1295
1296 if (NILP (uid))
34a7a267 1297 return Vuser_full_name;
3415b0e9 1298 else if (NUMBERP (uid))
b91834c3 1299 {
3f4eabd1
PE
1300 uid_t u;
1301 CONS_TO_INTEGER (uid, uid_t, u);
b91834c3 1302 BLOCK_INPUT;
63c5d10b 1303 pw = getpwuid (u);
b91834c3
YM
1304 UNBLOCK_INPUT;
1305 }
34a7a267 1306 else if (STRINGP (uid))
b91834c3
YM
1307 {
1308 BLOCK_INPUT;
63c5d10b 1309 pw = getpwnam (SSDATA (uid));
b91834c3
YM
1310 UNBLOCK_INPUT;
1311 }
3415b0e9
RS
1312 else
1313 error ("Invalid UID specification");
c9ed721d 1314
3415b0e9 1315 if (!pw)
3347526c 1316 return Qnil;
34a7a267 1317
e7f8264d 1318 p = USER_FULL_NAME;
3415b0e9 1319 /* Chop off everything after the first comma. */
e7f8264d 1320 q = strchr (p, ',');
3415b0e9 1321 full = make_string (p, q ? q - p : strlen (p));
34a7a267 1322
3415b0e9 1323#ifdef AMPERSAND_FULL_NAME
e7f8264d
PE
1324 p = SSDATA (full);
1325 q = strchr (p, '&');
3415b0e9
RS
1326 /* Substitute the login name for the &, upcasing the first character. */
1327 if (q)
1328 {
e7f8264d 1329 register char *r;
3415b0e9
RS
1330 Lisp_Object login;
1331
1332 login = Fuser_login_name (make_number (pw->pw_uid));
e7f8264d 1333 r = (char *) alloca (strlen (p) + SCHARS (login) + 1);
72af86bd 1334 memcpy (r, p, q - p);
3415b0e9 1335 r[q - p] = 0;
42a5b22f 1336 strcat (r, SSDATA (login));
5da9919f 1337 r[q - p] = upcase ((unsigned char) r[q - p]);
3415b0e9
RS
1338 strcat (r, q + 1);
1339 full = build_string (r);
1340 }
1341#endif /* AMPERSAND_FULL_NAME */
1342
1343 return full;
35692fe0
JB
1344}
1345
a7ca3326 1346DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
1a7e0117 1347 doc: /* Return the host name of the machine you are running on, as a string. */)
5842a27b 1348 (void)
35692fe0
JB
1349{
1350 return Vsystem_name;
1351}
1352
8ea90aa3 1353const char *
971de7fb 1354get_system_name (void)
ac988277 1355{
3d976a9a 1356 if (STRINGP (Vsystem_name))
51b59d79 1357 return SSDATA (Vsystem_name);
3d976a9a
RS
1358 else
1359 return "";
ac988277
KH
1360}
1361
7fd233b3 1362DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
d311d28c 1363 doc: /* Return the process ID of Emacs, as a number. */)
5842a27b 1364 (void)
7fd233b3 1365{
d311d28c
PE
1366 pid_t pid = getpid ();
1367 return make_fixnum_or_float (pid);
7fd233b3
RS
1368}
1369
b8d9bd41
PE
1370\f
1371
1372#ifndef TIME_T_MIN
1373# define TIME_T_MIN TYPE_MINIMUM (time_t)
1374#endif
1375#ifndef TIME_T_MAX
1376# define TIME_T_MAX TYPE_MAXIMUM (time_t)
1377#endif
1378
1379/* Report that a time value is out of range for Emacs. */
d35af63c 1380void
b8d9bd41
PE
1381time_overflow (void)
1382{
1383 error ("Specified time is not representable");
1384}
1385
d35af63c 1386/* Return the upper part of the time T (everything but the bottom 16 bits). */
b8d9bd41
PE
1387static EMACS_INT
1388hi_time (time_t t)
1389{
1390 time_t hi = t >> 16;
313c1e54
PE
1391
1392 /* Check for overflow, helping the compiler for common cases where
1393 no runtime check is needed, and taking care not to convert
1394 negative numbers to unsigned before comparing them. */
1395 if (! ((! TYPE_SIGNED (time_t)
1396 || MOST_NEGATIVE_FIXNUM <= TIME_T_MIN >> 16
1397 || MOST_NEGATIVE_FIXNUM <= hi)
1398 && (TIME_T_MAX >> 16 <= MOST_POSITIVE_FIXNUM
1399 || hi <= MOST_POSITIVE_FIXNUM)))
b8d9bd41 1400 time_overflow ();
313c1e54 1401
b8d9bd41
PE
1402 return hi;
1403}
1404
1405/* Return the bottom 16 bits of the time T. */
d311d28c 1406static int
b8d9bd41
PE
1407lo_time (time_t t)
1408{
1409 return t & ((1 << 16) - 1);
1410}
1411
a7ca3326 1412DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
7ee72033 1413 doc: /* Return the current time, as the number of seconds since 1970-01-01 00:00:00.
d35af63c
PE
1414The time is returned as a list of integers (HIGH LOW USEC PSEC).
1415HIGH has the most significant bits of the seconds, while LOW has the
1416least significant 16 bits. USEC and PSEC are the microsecond and
1417picosecond counts. */)
5842a27b 1418 (void)
d940e0e4 1419{
956ace37 1420 EMACS_TIME t;
956ace37
JB
1421
1422 EMACS_GET_TIME (t);
d35af63c 1423 return make_lisp_time (t);
d940e0e4 1424}
4211ee7d 1425
a7ca3326 1426DEFUN ("get-internal-run-time", Fget_internal_run_time, Sget_internal_run_time,
4211ee7d
EZ
1427 0, 0, 0,
1428 doc: /* Return the current run time used by Emacs.
d35af63c
PE
1429The time is returned as a list (HIGH LOW USEC PSEC), using the same
1430style as (current-time).
4211ee7d 1431
9671c13a 1432On systems that can't determine the run time, `get-internal-run-time'
d35af63c 1433does the same thing as `current-time'. */)
5842a27b 1434 (void)
4211ee7d
EZ
1435{
1436#ifdef HAVE_GETRUSAGE
1437 struct rusage usage;
b8d9bd41
PE
1438 time_t secs;
1439 int usecs;
d35af63c 1440 EMACS_TIME t;
4211ee7d
EZ
1441
1442 if (getrusage (RUSAGE_SELF, &usage) < 0)
1443 /* This shouldn't happen. What action is appropriate? */
8a0ff744 1444 xsignal0 (Qerror);
4211ee7d
EZ
1445
1446 /* Sum up user time and system time. */
1447 secs = usage.ru_utime.tv_sec + usage.ru_stime.tv_sec;
1448 usecs = usage.ru_utime.tv_usec + usage.ru_stime.tv_usec;
1449 if (usecs >= 1000000)
1450 {
1451 usecs -= 1000000;
1452 secs++;
1453 }
d35af63c
PE
1454 EMACS_SET_SECS_USECS (t, secs, usecs);
1455 return make_lisp_time (t);
c433c134 1456#else /* ! HAVE_GETRUSAGE */
43db14bb 1457#ifdef WINDOWSNT
c433c134
JR
1458 return w32_get_internal_run_time ();
1459#else /* ! WINDOWSNT */
4211ee7d 1460 return Fcurrent_time ();
c433c134
JR
1461#endif /* WINDOWSNT */
1462#endif /* HAVE_GETRUSAGE */
4211ee7d 1463}
d940e0e4
JB
1464\f
1465
d35af63c
PE
1466/* Make a Lisp list that represents the time T with fraction TAIL. */
1467static Lisp_Object
1468make_time_tail (time_t t, Lisp_Object tail)
1469{
1470 return Fcons (make_number (hi_time (t)),
1471 Fcons (make_number (lo_time (t)), tail));
1472}
1473
1474/* Make a Lisp list that represents the system time T. */
1475static Lisp_Object
8be6f318
PE
1476make_time (time_t t)
1477{
d35af63c
PE
1478 return make_time_tail (t, Qnil);
1479}
1480
1481/* Make a Lisp list that represents the Emacs time T. T may be an
1482 invalid time, with a slightly negative tv_nsec value such as
1483 UNKNOWN_MODTIME_NSECS; in that case, the Lisp list contains a
1484 correspondingly negative picosecond count. */
1485Lisp_Object
1486make_lisp_time (EMACS_TIME t)
1487{
1488 int ns = EMACS_NSECS (t);
1489 return make_time_tail (EMACS_SECS (t),
1490 list2 (make_number (ns / 1000),
1491 make_number (ns % 1000 * 1000)));
8be6f318
PE
1492}
1493
1494/* Decode a Lisp list SPECIFIED_TIME that represents a time.
d35af63c 1495 Set *PHIGH, *PLOW, *PUSEC, *PPSEC to its parts; do not check their values.
8be6f318 1496 Return nonzero if successful. */
d35af63c
PE
1497static int
1498disassemble_lisp_time (Lisp_Object specified_time, Lisp_Object *phigh,
1499 Lisp_Object *plow, Lisp_Object *pusec,
1500 Lisp_Object *ppsec)
1501{
1502 if (CONSP (specified_time))
1503 {
1504 Lisp_Object low = XCDR (specified_time);
1505 Lisp_Object usec = make_number (0);
1506 Lisp_Object psec = make_number (0);
1507 if (CONSP (low))
1508 {
1509 Lisp_Object low_tail = XCDR (low);
1510 low = XCAR (low);
1511 if (CONSP (low_tail))
1512 {
1513 usec = XCAR (low_tail);
1514 low_tail = XCDR (low_tail);
1515 if (CONSP (low_tail))
1516 psec = XCAR (low_tail);
1517 }
1518 else if (!NILP (low_tail))
1519 usec = low_tail;
1520 }
1521
1522 *phigh = XCAR (specified_time);
1523 *plow = low;
1524 *pusec = usec;
1525 *ppsec = psec;
1526 return 1;
1527 }
1528
1529 return 0;
1530}
1531
1532/* From the time components HIGH, LOW, USEC and PSEC taken from a Lisp
1533 list, generate the corresponding EMACS_TIME value *RESULT, and
1534 if RESULT_PSEC is not null store into *RESULT_PSEC the
1535 (nonnegative) difference in picoseconds between the input time and
1536 the returned time. Return nonzero if successful. */
5c5718b6 1537int
d35af63c
PE
1538decode_time_components (Lisp_Object high, Lisp_Object low, Lisp_Object usec,
1539 Lisp_Object psec, EMACS_TIME *result, int *result_psec)
e3120ab5 1540{
d35af63c
PE
1541 EMACS_INT hi, lo, us, ps;
1542 time_t sec;
1543 if (! (INTEGERP (high) && INTEGERP (low)
1544 && INTEGERP (usec) && INTEGERP (psec)))
1545 return 0;
1546 hi = XINT (high);
1547 lo = XINT (low);
1548 us = XINT (usec);
1549 ps = XINT (psec);
1550
1551 /* Normalize out-of-range lower-order components by carrying
1552 each overflow into the next higher-order component. */
1553 us += ps / 1000000 - (ps % 1000000 < 0);
1554 lo += us / 1000000 - (us % 1000000 < 0);
1555 hi += lo >> 16;
1556 ps = ps % 1000000 + 1000000 * (ps % 1000000 < 0);
1557 us = us % 1000000 + 1000000 * (us % 1000000 < 0);
1558 lo &= (1 << 16) - 1;
1559
1560 /* Check for overflow in the highest-order component. */
1561 if (! ((TYPE_SIGNED (time_t) ? TIME_T_MIN >> 16 <= hi : 0 <= hi)
1562 && hi <= TIME_T_MAX >> 16))
1563 return 0;
1564
1565 sec = hi;
1566 EMACS_SET_SECS_NSECS (*result, (sec << 16) + lo, us * 1000 + ps / 1000);
1567 if (result_psec)
1568 *result_psec = ps % 1000;
1569 return 1;
1570}
1571
1572/* Decode a Lisp list SPECIFIED_TIME that represents a time.
1573 If SPECIFIED_TIME is nil, use the current time.
1574 Round the time down to the nearest EMACS_TIME value, and
1575 if PPSEC is not null store into *PPSEC the (nonnegative) difference in
1576 picoseconds between the input time and the returned time.
1577 Return seconds since the Epoch.
1578 Signal an error if unsuccessful. */
1579EMACS_TIME
1580lisp_time_argument (Lisp_Object specified_time, int *ppsec)
1581{
1582 EMACS_TIME t;
e3120ab5 1583 if (NILP (specified_time))
d35af63c
PE
1584 EMACS_GET_TIME (t);
1585 else
34a7a267 1586 {
d35af63c
PE
1587 Lisp_Object high, low, usec, psec;
1588 if (! (disassemble_lisp_time (specified_time, &high, &low, &usec, &psec)
1589 && decode_time_components (high, low, usec, psec, &t, ppsec)))
1590 error ("Invalid time specification");
34a7a267 1591 }
d35af63c
PE
1592 return t;
1593}
1594
1595/* Like lisp_time_argument, except decode only the seconds part,
1596 and do not check the subseconds part, and always round down. */
1597static time_t
1598lisp_seconds_argument (Lisp_Object specified_time)
1599{
1600 if (NILP (specified_time))
1601 return time (NULL);
e3120ab5
JB
1602 else
1603 {
d35af63c
PE
1604 Lisp_Object high, low, usec, psec;
1605 EMACS_TIME t;
1606 if (! (disassemble_lisp_time (specified_time, &high, &low, &usec, &psec)
1607 && decode_time_components (high, low, make_number (0),
1608 make_number (0), &t, 0)))
1609 error ("Invalid time specification");
1610 return EMACS_SECS (t);
e3120ab5
JB
1611 }
1612}
1613
34a7a267 1614DEFUN ("float-time", Ffloat_time, Sfloat_time, 0, 1, 0,
7ee72033 1615 doc: /* Return the current time, as a float number of seconds since the epoch.
412f1fab 1616If SPECIFIED-TIME is given, it is the time to convert to float
5668fbb8 1617instead of the current time. The argument should have the form
d35af63c
PE
1618(HIGH LOW) or (HIGH LOW USEC) or (HIGH LOW USEC PSEC). Thus,
1619you can use times from `current-time' and from `file-attributes'.
1620SPECIFIED-TIME can also have the form (HIGH . LOW), but this is
1621considered obsolete.
a1f17501
PJ
1622
1623WARNING: Since the result is floating point, it may not be exact.
d427a9fa
EZ
1624If precise time stamps are required, use either `current-time',
1625or (if you need time as a string) `format-time-string'. */)
5842a27b 1626 (Lisp_Object specified_time)
34a7a267 1627{
d35af63c
PE
1628 int psec;
1629 EMACS_TIME t = lisp_time_argument (specified_time, &psec);
1630 double ps = (1000 * 1000 * 1000 <= INTMAX_MAX / 1000
1631 ? EMACS_NSECS (t) * (intmax_t) 1000 + psec
1632 : EMACS_NSECS (t) * 1e3 + psec);
1633 return make_float (EMACS_SECS (t) + ps / 1e12);
34a7a267
SS
1634}
1635
70ebbe5f
PE
1636/* Write information into buffer S of size MAXSIZE, according to the
1637 FORMAT of length FORMAT_LEN, using time information taken from *TP.
68c45bf0 1638 Default to Universal Time if UT is nonzero, local time otherwise.
a4180391 1639 Use NS as the number of nanoseconds in the %N directive.
70ebbe5f
PE
1640 Return the number of bytes written, not including the terminating
1641 '\0'. If S is NULL, nothing will be written anywhere; so to
1642 determine how many bytes would be written, use NULL for S and
1643 ((size_t) -1) for MAXSIZE.
1644
16c3e636
PE
1645 This function behaves like nstrftime, except it allows null
1646 bytes in FORMAT and it does not support nanoseconds. */
70ebbe5f 1647static size_t
a4180391
PE
1648emacs_nmemftime (char *s, size_t maxsize, const char *format,
1649 size_t format_len, const struct tm *tp, int ut, int ns)
70ebbe5f
PE
1650{
1651 size_t total = 0;
1652
be09e6e6
PE
1653 /* Loop through all the null-terminated strings in the format
1654 argument. Normally there's just one null-terminated string, but
1655 there can be arbitrarily many, concatenated together, if the
16c3e636 1656 format contains '\0' bytes. nstrftime stops at the first
be09e6e6 1657 '\0' byte so we must invoke it separately for each such string. */
70ebbe5f
PE
1658 for (;;)
1659 {
1660 size_t len;
1661 size_t result;
1662
1663 if (s)
1664 s[0] = '\1';
1665
a4180391 1666 result = nstrftime (s, maxsize, format, tp, ut, ns);
70ebbe5f
PE
1667
1668 if (s)
1669 {
1670 if (result == 0 && s[0] != '\0')
1671 return 0;
1672 s += result + 1;
1673 }
1674
1675 maxsize -= result + 1;
1676 total += result;
1677 len = strlen (format);
1678 if (len == format_len)
1679 return total;
1680 total++;
1681 format += len + 1;
1682 format_len -= len + 1;
1683 }
1684}
1685
3efcc98a 1686DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
7ee72033 1687 doc: /* Use FORMAT-STRING to format the time TIME, or now if omitted.
d35af63c 1688TIME is specified as (HIGH LOW USEC PSEC), as returned by
5668fbb8
LT
1689`current-time' or `file-attributes'. The obsolete form (HIGH . LOW)
1690is also still accepted.
a1f17501
PJ
1691The third, optional, argument UNIVERSAL, if non-nil, means describe TIME
1692as Universal Time; nil means describe TIME in the local time zone.
1693The value is a copy of FORMAT-STRING, but with certain constructs replaced
1694by text that describes the specified date and time in TIME:
1695
1696%Y is the year, %y within the century, %C the century.
1697%G is the year corresponding to the ISO week, %g within the century.
1698%m is the numeric month.
1699%b and %h are the locale's abbreviated month name, %B the full name.
1700%d is the day of the month, zero-padded, %e is blank-padded.
1701%u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.
1702%a is the locale's abbreviated name of the day of week, %A the full name.
1703%U is the week number starting on Sunday, %W starting on Monday,
1704 %V according to ISO 8601.
1705%j is the day of the year.
1706
1707%H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H
1708 only blank-padded, %l is like %I blank-padded.
1709%p is the locale's equivalent of either AM or PM.
1710%M is the minute.
1711%S is the second.
a4180391 1712%N is the nanosecond, %6N the microsecond, %3N the millisecond, etc.
a1f17501
PJ
1713%Z is the time zone name, %z is the numeric form.
1714%s is the number of seconds since 1970-01-01 00:00:00 +0000.
1715
1716%c is the locale's date and time format.
1717%x is the locale's "preferred" date format.
1718%D is like "%m/%d/%y".
1719
1720%R is like "%H:%M", %T is like "%H:%M:%S", %r is like "%I:%M:%S %p".
1721%X is the locale's "preferred" time format.
1722
1723Finally, %n is a newline, %t is a tab, %% is a literal %.
1724
1725Certain flags and modifiers are available with some format controls.
1726The flags are `_', `-', `^' and `#'. For certain characters X,
1727%_X is like %X, but padded with blanks; %-X is like %X,
a67a233b
MR
1728but without padding. %^X is like %X, but with all textual
1729characters up-cased; %#X is like %X, but with letter-case of
a1f17501
PJ
1730all textual characters reversed.
1731%NX (where N stands for an integer) is like %X,
1732but takes up at least N (a number) positions.
1733The modifiers are `E' and `O'. For certain characters X,
1734%EX is a locale's alternative version of %X;
1735%OX is like %X, but uses the locale's number symbols.
1736
75bfc667
JL
1737For example, to produce full ISO 8601 format, use "%Y-%m-%dT%T%z".
1738
1739usage: (format-time-string FORMAT-STRING &optional TIME UNIVERSAL) */)
545b49b4 1740 (Lisp_Object format_string, Lisp_Object timeval, Lisp_Object universal)
a82d387c 1741{
d35af63c 1742 EMACS_TIME t = lisp_time_argument (timeval, 0);
7ed806a7 1743 struct tm tm;
7da0b018
PE
1744
1745 CHECK_STRING (format_string);
1746 format_string = code_convert_string_norecord (format_string,
1747 Vlocale_coding_system, 1);
1748 return format_time_string (SSDATA (format_string), SBYTES (format_string),
d35af63c 1749 t, ! NILP (universal), &tm);
7da0b018
PE
1750}
1751
1752static Lisp_Object
1753format_time_string (char const *format, ptrdiff_t formatlen,
d35af63c 1754 EMACS_TIME t, int ut, struct tm *tmp)
7da0b018 1755{
7ed806a7
PE
1756 char buffer[4000];
1757 char *buf = buffer;
243e0530 1758 ptrdiff_t size = sizeof buffer;
7ed806a7
PE
1759 size_t len;
1760 Lisp_Object bufstring;
d35af63c 1761 int ns = EMACS_NSECS (t);
177ea5f1 1762 struct tm *tm;
7ed806a7 1763 USE_SAFE_ALLOCA;
a82d387c 1764
a82d387c
RS
1765 while (1)
1766 {
7ed806a7
PE
1767 BLOCK_INPUT;
1768
1769 synchronize_system_time_locale ();
1770
d35af63c 1771 tm = ut ? gmtime (EMACS_SECS_ADDR (t)) : localtime (EMACS_SECS_ADDR (t));
7ed806a7
PE
1772 if (! tm)
1773 {
1774 UNBLOCK_INPUT;
1775 time_overflow ();
1776 }
1777 *tmp = *tm;
b48382a0 1778
bfbcc5ee 1779 buf[0] = '\1';
7ed806a7
PE
1780 len = emacs_nmemftime (buf, size, format, formatlen, tm, ut, ns);
1781 if ((0 < len && len < size) || (len == 0 && buf[0] == '\0'))
1782 break;
b48382a0 1783
7ed806a7
PE
1784 /* Buffer was too small, so make it bigger and try again. */
1785 len = emacs_nmemftime (NULL, SIZE_MAX, format, formatlen, tm, ut, ns);
bcda42c8 1786 UNBLOCK_INPUT;
7ed806a7 1787 if (STRING_BYTES_BOUND <= len)
da64016e 1788 string_overflow ();
7ed806a7
PE
1789 size = len + 1;
1790 SAFE_ALLOCA (buf, char *, size);
a82d387c 1791 }
7ed806a7
PE
1792
1793 UNBLOCK_INPUT;
1794 bufstring = make_unibyte_string (buf, len);
1795 SAFE_FREE ();
1796 return code_convert_string_norecord (bufstring, Vlocale_coding_system, 0);
a82d387c
RS
1797}
1798
4691c06d 1799DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
7ee72033 1800 doc: /* Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
5668fbb8 1801The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED),
9671c13a 1802as from `current-time' and `file-attributes', or nil to use the
5668fbb8
LT
1803current time. The obsolete form (HIGH . LOW) is also still accepted.
1804The list has the following nine members: SEC is an integer between 0
1805and 60; SEC is 60 for a leap second, which only some operating systems
1806support. MINUTE is an integer between 0 and 59. HOUR is an integer
1807between 0 and 23. DAY is an integer between 1 and 31. MONTH is an
1808integer between 1 and 12. YEAR is an integer indicating the
1809four-digit year. DOW is the day of week, an integer between 0 and 6,
f1767e2b 1810where 0 is Sunday. DST is t if daylight saving time is in effect,
5668fbb8
LT
1811otherwise nil. ZONE is an integer indicating the number of seconds
1812east of Greenwich. (Note that Common Lisp has different meanings for
1813DOW and ZONE.) */)
5842a27b 1814 (Lisp_Object specified_time)
4691c06d 1815{
d35af63c 1816 time_t time_spec = lisp_seconds_argument (specified_time);
3c887943 1817 struct tm save_tm;
4691c06d
RS
1818 struct tm *decoded_time;
1819 Lisp_Object list_args[9];
34a7a267 1820
bcda42c8 1821 BLOCK_INPUT;
4691c06d 1822 decoded_time = localtime (&time_spec);
7ed806a7
PE
1823 if (decoded_time)
1824 save_tm = *decoded_time;
bcda42c8 1825 UNBLOCK_INPUT;
b8d9bd41 1826 if (! (decoded_time
7ed806a7
PE
1827 && MOST_NEGATIVE_FIXNUM - TM_YEAR_BASE <= save_tm.tm_year
1828 && save_tm.tm_year <= MOST_POSITIVE_FIXNUM - TM_YEAR_BASE))
fe31d94c 1829 time_overflow ();
7ed806a7
PE
1830 XSETFASTINT (list_args[0], save_tm.tm_sec);
1831 XSETFASTINT (list_args[1], save_tm.tm_min);
1832 XSETFASTINT (list_args[2], save_tm.tm_hour);
1833 XSETFASTINT (list_args[3], save_tm.tm_mday);
1834 XSETFASTINT (list_args[4], save_tm.tm_mon + 1);
71c3f28f
EZ
1835 /* On 64-bit machines an int is narrower than EMACS_INT, thus the
1836 cast below avoids overflow in int arithmetics. */
7ed806a7
PE
1837 XSETINT (list_args[5], TM_YEAR_BASE + (EMACS_INT) save_tm.tm_year);
1838 XSETFASTINT (list_args[6], save_tm.tm_wday);
1839 list_args[7] = save_tm.tm_isdst ? Qt : Qnil;
3c887943 1840
bcda42c8 1841 BLOCK_INPUT;
3c887943
KH
1842 decoded_time = gmtime (&time_spec);
1843 if (decoded_time == 0)
1844 list_args[8] = Qnil;
1845 else
94751666 1846 XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
7ed806a7 1847 UNBLOCK_INPUT;
4691c06d
RS
1848 return Flist (9, list_args);
1849}
1850
b8d9bd41
PE
1851/* Return OBJ - OFFSET, checking that OBJ is a valid fixnum and that
1852 the result is representable as an int. Assume OFFSET is small and
1853 nonnegative. */
1854static int
1855check_tm_member (Lisp_Object obj, int offset)
1856{
1857 EMACS_INT n;
1858 CHECK_NUMBER (obj);
1859 n = XINT (obj);
1860 if (! (INT_MIN + offset <= n && n - offset <= INT_MAX))
1861 time_overflow ();
1862 return n - offset;
1863}
1864
6ee9061c 1865DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
7ee72033 1866 doc: /* Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
a1f17501
PJ
1867This is the reverse operation of `decode-time', which see.
1868ZONE defaults to the current time zone rule. This can
1869be a string or t (as from `set-time-zone-rule'), or it can be a list
b57c2708 1870\(as from `current-time-zone') or an integer (as from `decode-time')
9c279ddf 1871applied without consideration for daylight saving time.
a1f17501
PJ
1872
1873You can pass more than 7 arguments; then the first six arguments
1874are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1875The intervening arguments are ignored.
1876This feature lets (apply 'encode-time (decode-time ...)) work.
1877
412f1fab 1878Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed;
a1f17501
PJ
1879for example, a DAY of 0 means the day preceding the given month.
1880Year numbers less than 100 are treated just like other year numbers.
4bfbe194
MB
1881If you want them to stand for years in this century, you must do that yourself.
1882
f555f8cf
KH
1883Years before 1970 are not guaranteed to work. On some systems,
1884year values as low as 1901 do work.
1885
4bfbe194 1886usage: (encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE) */)
f66c7cf8 1887 (ptrdiff_t nargs, Lisp_Object *args)
cce7b8a0 1888{
545b49b4 1889 time_t value;
c59b5089 1890 struct tm tm;
60653898 1891 Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
6ee9061c 1892
b8d9bd41
PE
1893 tm.tm_sec = check_tm_member (args[0], 0);
1894 tm.tm_min = check_tm_member (args[1], 0);
1895 tm.tm_hour = check_tm_member (args[2], 0);
1896 tm.tm_mday = check_tm_member (args[3], 0);
1897 tm.tm_mon = check_tm_member (args[4], 1);
1898 tm.tm_year = check_tm_member (args[5], TM_YEAR_BASE);
c59b5089
PE
1899 tm.tm_isdst = -1;
1900
1901 if (CONSP (zone))
1902 zone = Fcar (zone);
1b8fa736 1903 if (NILP (zone))
bcda42c8
YM
1904 {
1905 BLOCK_INPUT;
545b49b4 1906 value = mktime (&tm);
bcda42c8
YM
1907 UNBLOCK_INPUT;
1908 }
c59b5089 1909 else
1b8fa736 1910 {
c59b5089 1911 char tzbuf[100];
8ea90aa3 1912 const char *tzstring;
c59b5089 1913 char **oldenv = environ, **newenv;
34a7a267 1914
2e34157c 1915 if (EQ (zone, Qt))
085e9fcb
EN
1916 tzstring = "UTC0";
1917 else if (STRINGP (zone))
51b59d79 1918 tzstring = SSDATA (zone);
c59b5089 1919 else if (INTEGERP (zone))
1b8fa736 1920 {
d311d28c
PE
1921 EMACS_INT abszone = eabs (XINT (zone));
1922 EMACS_INT zone_hr = abszone / (60*60);
1923 int zone_min = (abszone/60) % 60;
1924 int zone_sec = abszone % 60;
1925 sprintf (tzbuf, "XXX%s%"pI"d:%02d:%02d", "-" + (XINT (zone) < 0),
1926 zone_hr, zone_min, zone_sec);
c59b5089 1927 tzstring = tzbuf;
1b8fa736 1928 }
c59b5089
PE
1929 else
1930 error ("Invalid time zone specification");
1931
7ed806a7
PE
1932 BLOCK_INPUT;
1933
34a7a267 1934 /* Set TZ before calling mktime; merely adjusting mktime's returned
c59b5089
PE
1935 value doesn't suffice, since that would mishandle leap seconds. */
1936 set_time_zone_rule (tzstring);
1937
545b49b4 1938 value = mktime (&tm);
c59b5089
PE
1939
1940 /* Restore TZ to previous value. */
1941 newenv = environ;
1942 environ = oldenv;
c59b5089
PE
1943#ifdef LOCALTIME_CACHE
1944 tzset ();
1945#endif
7ed806a7
PE
1946 UNBLOCK_INPUT;
1947
1948 xfree (newenv);
1b8fa736 1949 }
1b8fa736 1950
545b49b4 1951 if (value == (time_t) -1)
fe31d94c 1952 time_overflow ();
c59b5089 1953
545b49b4 1954 return make_time (value);
cce7b8a0
RS
1955}
1956
2148f2b4 1957DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
244b023e 1958 doc: /* Return the current local time, as a human-readable string.
a1f17501 1959Programs can use this function to decode a time,
d65b4235
PE
1960since the number of columns in each field is fixed
1961if the year is in the range 1000-9999.
a1f17501
PJ
1962The format is `Sun Sep 16 01:03:52 1973'.
1963However, see also the functions `decode-time' and `format-time-string'
1964which provide a much more powerful and general facility.
1965
5668fbb8
LT
1966If SPECIFIED-TIME is given, it is a time to format instead of the
1967current time. The argument should have the form (HIGH LOW . IGNORED).
1968Thus, you can use times obtained from `current-time' and from
1969`file-attributes'. SPECIFIED-TIME can also have the form (HIGH . LOW),
1970but this is considered obsolete. */)
5842a27b 1971 (Lisp_Object specified_time)
2148f2b4 1972{
d35af63c 1973 time_t value = lisp_seconds_argument (specified_time);
aac18aa4 1974 struct tm *tm;
ab0fa4e4
PE
1975 char buf[sizeof "Mon Apr 30 12:49:17 " + INT_STRLEN_BOUND (int) + 1];
1976 int len IF_LINT (= 0);
2148f2b4 1977
ab0fa4e4
PE
1978 /* Convert to a string in ctime format, except without the trailing
1979 newline, and without the 4-digit year limit. Don't use asctime
1980 or ctime, as they might dump core if the year is outside the
1981 range -999 .. 9999. */
bcda42c8 1982 BLOCK_INPUT;
aac18aa4 1983 tm = localtime (&value);
ab0fa4e4 1984 if (tm)
7ed806a7 1985 {
ab0fa4e4
PE
1986 static char const wday_name[][4] =
1987 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1988 static char const mon_name[][4] =
1989 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1990 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1991 printmax_t year_base = TM_YEAR_BASE;
1992
1993 len = sprintf (buf, "%s %s%3d %02d:%02d:%02d %"pMd,
1994 wday_name[tm->tm_wday], mon_name[tm->tm_mon], tm->tm_mday,
1995 tm->tm_hour, tm->tm_min, tm->tm_sec,
1996 tm->tm_year + year_base);
7ed806a7 1997 }
bcda42c8 1998 UNBLOCK_INPUT;
ab0fa4e4 1999 if (! tm)
fe31d94c 2000 time_overflow ();
35692fe0 2001
ab0fa4e4 2002 return make_unibyte_string (buf, len);
35692fe0 2003}
c2662aea 2004
94751666
PE
2005/* Yield A - B, measured in seconds.
2006 This function is copied from the GNU C Library. */
2007static int
971de7fb 2008tm_diff (struct tm *a, struct tm *b)
e3120ab5 2009{
94751666
PE
2010 /* Compute intervening leap days correctly even if year is negative.
2011 Take care to avoid int overflow in leap day calculations,
2012 but it's OK to assume that A and B are close to each other. */
2013 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
2014 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
2015 int a100 = a4 / 25 - (a4 % 25 < 0);
2016 int b100 = b4 / 25 - (b4 % 25 < 0);
2017 int a400 = a100 >> 2;
2018 int b400 = b100 >> 2;
2019 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
2020 int years = a->tm_year - b->tm_year;
2021 int days = (365 * years + intervening_leap_days
2022 + (a->tm_yday - b->tm_yday));
2023 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
2024 + (a->tm_min - b->tm_min))
8e718b4e 2025 + (a->tm_sec - b->tm_sec));
e3120ab5
JB
2026}
2027
2028DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
7ee72033 2029 doc: /* Return the offset and name for the local time zone.
a1f17501
PJ
2030This returns a list of the form (OFFSET NAME).
2031OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
2032 A negative value means west of Greenwich.
2033NAME is a string giving the name of the time zone.
412f1fab 2034If SPECIFIED-TIME is given, the time zone offset is determined from it
5668fbb8
LT
2035instead of using the current time. The argument should have the form
2036(HIGH LOW . IGNORED). Thus, you can use times obtained from
2037`current-time' and from `file-attributes'. SPECIFIED-TIME can also
2038have the form (HIGH . LOW), but this is considered obsolete.
a1f17501
PJ
2039
2040Some operating systems cannot provide all this information to Emacs;
2041in this case, `current-time-zone' returns a list containing nil for
7ee72033 2042the data it can't find. */)
5842a27b 2043 (Lisp_Object specified_time)
c2662aea 2044{
d35af63c 2045 EMACS_TIME value;
7ed806a7 2046 int offset;
e3120ab5 2047 struct tm *t;
7da0b018 2048 struct tm localtm;
7da0b018
PE
2049 Lisp_Object zone_offset, zone_name;
2050
2051 zone_offset = Qnil;
d35af63c
PE
2052 EMACS_SET_SECS_NSECS (value, lisp_seconds_argument (specified_time), 0);
2053 zone_name = format_time_string ("%Z", sizeof "%Z" - 1, value, 0, &localtm);
7da0b018 2054 BLOCK_INPUT;
d35af63c 2055 t = gmtime (EMACS_SECS_ADDR (value));
7ed806a7
PE
2056 if (t)
2057 offset = tm_diff (&localtm, t);
7da0b018 2058 UNBLOCK_INPUT;
bcda42c8
YM
2059
2060 if (t)
e3120ab5 2061 {
7da0b018
PE
2062 zone_offset = make_number (offset);
2063 if (SCHARS (zone_name) == 0)
e3120ab5
JB
2064 {
2065 /* No local time zone name is available; use "+-NNNN" instead. */
33ef5c64
PE
2066 int m = offset / 60;
2067 int am = offset < 0 ? - m : m;
7da0b018 2068 char buf[sizeof "+00" + INT_STRLEN_BOUND (int)];
e3120ab5 2069 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
7da0b018 2070 zone_name = build_string (buf);
e3120ab5 2071 }
e3120ab5 2072 }
7da0b018
PE
2073
2074 return list2 (zone_offset, zone_name);
c2662aea
JB
2075}
2076
260e2e2a
KH
2077/* This holds the value of `environ' produced by the previous
2078 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
2079 has never been called. */
2080static char **environbuf;
2081
a03fc5a6
JR
2082/* This holds the startup value of the TZ environment variable so it
2083 can be restored if the user calls set-time-zone-rule with a nil
2084 argument. */
2085static char *initial_tz;
2086
143cb9a9 2087DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
7ee72033 2088 doc: /* Set the local time zone using TZ, a string specifying a time zone rule.
a1f17501 2089If TZ is nil, use implementation-defined default time zone information.
37e11a63
CY
2090If TZ is t, use Universal Time.
2091
2092Instead of calling this function, you typically want (setenv "TZ" TZ).
2093That changes both the environment of the Emacs process and the
2094variable `process-environment', whereas `set-time-zone-rule' affects
2095only the former. */)
5842a27b 2096 (Lisp_Object tz)
143cb9a9 2097{
8ea90aa3 2098 const char *tzstring;
7ed806a7
PE
2099 char **old_environbuf;
2100
2101 if (! (NILP (tz) || EQ (tz, Qt)))
2102 CHECK_STRING (tz);
2103
2104 BLOCK_INPUT;
143cb9a9 2105
a03fc5a6 2106 /* When called for the first time, save the original TZ. */
7ed806a7
PE
2107 old_environbuf = environbuf;
2108 if (!old_environbuf)
a03fc5a6
JR
2109 initial_tz = (char *) getenv ("TZ");
2110
143cb9a9 2111 if (NILP (tz))
a03fc5a6 2112 tzstring = initial_tz;
2e34157c 2113 else if (EQ (tz, Qt))
085e9fcb 2114 tzstring = "UTC0";
143cb9a9 2115 else
7ed806a7 2116 tzstring = SSDATA (tz);
143cb9a9 2117
c59b5089 2118 set_time_zone_rule (tzstring);
c59b5089
PE
2119 environbuf = environ;
2120
7ed806a7
PE
2121 UNBLOCK_INPUT;
2122
2123 xfree (old_environbuf);
c59b5089
PE
2124 return Qnil;
2125}
2126
e0bf9faf
PE
2127#ifdef LOCALTIME_CACHE
2128
2129/* These two values are known to load tz files in buggy implementations,
2130 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1155c453 2131 Their values shouldn't matter in non-buggy implementations.
34a7a267 2132 We don't use string literals for these strings,
1155c453
RS
2133 since if a string in the environment is in readonly
2134 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
2135 See Sun bugs 1113095 and 1114114, ``Timezone routines
2136 improperly modify environment''. */
2137
e0bf9faf
PE
2138static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
2139static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
2140
2141#endif
1155c453 2142
c59b5089
PE
2143/* Set the local time zone rule to TZSTRING.
2144 This allocates memory into `environ', which it is the caller's
2145 responsibility to free. */
acb7cc89 2146
a92ae0ce 2147void
a8fe7202 2148set_time_zone_rule (const char *tzstring)
c59b5089 2149{
c9f8d652 2150 ptrdiff_t envptrs;
c59b5089
PE
2151 char **from, **to, **newenv;
2152
aafe5147 2153 /* Make the ENVIRON vector longer with room for TZSTRING. */
143cb9a9
RS
2154 for (from = environ; *from; from++)
2155 continue;
2156 envptrs = from - environ + 2;
2157 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
2158 + (tzstring ? strlen (tzstring) + 4 : 0));
aafe5147
RS
2159
2160 /* Add TZSTRING to the end of environ, as a value for TZ. */
143cb9a9
RS
2161 if (tzstring)
2162 {
2163 char *t = (char *) (to + envptrs);
2164 strcpy (t, "TZ=");
2165 strcat (t, tzstring);
2166 *to++ = t;
2167 }
2168
aafe5147
RS
2169 /* Copy the old environ vector elements into NEWENV,
2170 but don't copy the TZ variable.
2171 So we have only one definition of TZ, which came from TZSTRING. */
143cb9a9
RS
2172 for (from = environ; *from; from++)
2173 if (strncmp (*from, "TZ=", 3) != 0)
2174 *to++ = *from;
2175 *to = 0;
2176
2177 environ = newenv;
143cb9a9 2178
aafe5147
RS
2179 /* If we do have a TZSTRING, NEWENV points to the vector slot where
2180 the TZ variable is stored. If we do not have a TZSTRING,
2181 TO points to the vector slot which has the terminating null. */
2182
143cb9a9 2183#ifdef LOCALTIME_CACHE
aafe5147
RS
2184 {
2185 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
2186 "US/Pacific" that loads a tz file, then changes to a value like
2187 "XXX0" that does not load a tz file, and then changes back to
2188 its original value, the last change is (incorrectly) ignored.
2189 Also, if TZ changes twice in succession to values that do
2190 not load a tz file, tzset can dump core (see Sun bug#1225179).
2191 The following code works around these bugs. */
2192
aafe5147
RS
2193 if (tzstring)
2194 {
2195 /* Temporarily set TZ to a value that loads a tz file
2196 and that differs from tzstring. */
2197 char *tz = *newenv;
1155c453
RS
2198 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
2199 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
aafe5147
RS
2200 tzset ();
2201 *newenv = tz;
2202 }
2203 else
2204 {
2205 /* The implied tzstring is unknown, so temporarily set TZ to
2206 two different values that each load a tz file. */
1155c453 2207 *to = set_time_zone_rule_tz1;
aafe5147
RS
2208 to[1] = 0;
2209 tzset ();
1155c453 2210 *to = set_time_zone_rule_tz2;
aafe5147
RS
2211 tzset ();
2212 *to = 0;
2213 }
2214
2215 /* Now TZ has the desired value, and tzset can be invoked safely. */
2216 }
2217
143cb9a9
RS
2218 tzset ();
2219#endif
143cb9a9 2220}
35692fe0 2221\f
fb8106e8
KH
2222/* Insert NARGS Lisp objects in the array ARGS by calling INSERT_FUNC
2223 (if a type of object is Lisp_Int) or INSERT_FROM_STRING_FUNC (if a
2224 type of object is Lisp_String). INHERIT is passed to
2225 INSERT_FROM_STRING_FUNC as the last argument. */
2226
acb7cc89 2227static void
9628fed7 2228general_insert_function (void (*insert_func)
d311d28c 2229 (const char *, ptrdiff_t),
9628fed7 2230 void (*insert_from_string_func)
d311d28c
PE
2231 (Lisp_Object, ptrdiff_t, ptrdiff_t,
2232 ptrdiff_t, ptrdiff_t, int),
f66c7cf8 2233 int inherit, ptrdiff_t nargs, Lisp_Object *args)
fb8106e8 2234{
f66c7cf8 2235 ptrdiff_t argnum;
fb8106e8
KH
2236 register Lisp_Object val;
2237
2238 for (argnum = 0; argnum < nargs; argnum++)
2239 {
2240 val = args[argnum];
1b9c91ed 2241 if (CHARACTERP (val))
fb8106e8 2242 {
13bdea59 2243 int c = XFASTINT (val);
d5c2c403 2244 unsigned char str[MAX_MULTIBYTE_LENGTH];
fb8106e8
KH
2245 int len;
2246
4b4deea2 2247 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
13bdea59 2248 len = CHAR_STRING (c, str);
fb8106e8 2249 else
13c148b8 2250 {
abbd3d23 2251 str[0] = ASCII_CHAR_P (c) ? c : multibyte_char_to_unibyte (c);
13c148b8
KH
2252 len = 1;
2253 }
b68864e5 2254 (*insert_func) ((char *) str, len);
fb8106e8
KH
2255 }
2256 else if (STRINGP (val))
2257 {
1f24f4fd 2258 (*insert_from_string_func) (val, 0, 0,
d5db4077
KR
2259 SCHARS (val),
2260 SBYTES (val),
1f24f4fd 2261 inherit);
fb8106e8
KH
2262 }
2263 else
b7f34213 2264 wrong_type_argument (Qchar_or_string_p, val);
fb8106e8
KH
2265 }
2266}
2267
35692fe0 2268void
971de7fb 2269insert1 (Lisp_Object arg)
35692fe0
JB
2270{
2271 Finsert (1, &arg);
2272}
2273
52b14ac0
JB
2274
2275/* Callers passing one argument to Finsert need not gcpro the
2276 argument "array", since the only element of the array will
2277 not be used after calling insert or insert_from_string, so
2278 we don't care if it gets trashed. */
2279
a7ca3326 2280DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
7ee72033 2281 doc: /* Insert the arguments, either strings or characters, at point.
a1f17501
PJ
2282Point and before-insertion markers move forward to end up
2283 after the inserted text.
2284Any other markers at the point of insertion remain before the text.
2285
2286If the current buffer is multibyte, unibyte strings are converted
72bb55c6 2287to multibyte for insertion (see `string-make-multibyte').
a1f17501 2288If the current buffer is unibyte, multibyte strings are converted
72bb55c6
KS
2289to unibyte for insertion (see `string-make-unibyte').
2290
2291When operating on binary data, it may be necessary to preserve the
2292original bytes of a unibyte string when inserting it into a multibyte
2293buffer; to accomplish this, apply `string-as-multibyte' to the string
2294and insert the result.
4bfbe194
MB
2295
2296usage: (insert &rest ARGS) */)
f66c7cf8 2297 (ptrdiff_t nargs, Lisp_Object *args)
35692fe0 2298{
fb8106e8 2299 general_insert_function (insert, insert_from_string, 0, nargs, args);
be91036a
RS
2300 return Qnil;
2301}
2302
2303DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
2304 0, MANY, 0,
7ee72033 2305 doc: /* Insert the arguments at point, inheriting properties from adjoining text.
a1f17501
PJ
2306Point and before-insertion markers move forward to end up
2307 after the inserted text.
2308Any other markers at the point of insertion remain before the text.
2309
2310If the current buffer is multibyte, unibyte strings are converted
2311to multibyte for insertion (see `unibyte-char-to-multibyte').
2312If the current buffer is unibyte, multibyte strings are converted
4bfbe194
MB
2313to unibyte for insertion.
2314
2315usage: (insert-and-inherit &rest ARGS) */)
f66c7cf8 2316 (ptrdiff_t nargs, Lisp_Object *args)
be91036a 2317{
fb8106e8
KH
2318 general_insert_function (insert_and_inherit, insert_from_string, 1,
2319 nargs, args);
35692fe0
JB
2320 return Qnil;
2321}
2322
2323DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
7ee72033 2324 doc: /* Insert strings or characters at point, relocating markers after the text.
a1f17501
PJ
2325Point and markers move forward to end up after the inserted text.
2326
2327If the current buffer is multibyte, unibyte strings are converted
2328to multibyte for insertion (see `unibyte-char-to-multibyte').
2329If the current buffer is unibyte, multibyte strings are converted
4bfbe194
MB
2330to unibyte for insertion.
2331
2332usage: (insert-before-markers &rest ARGS) */)
f66c7cf8 2333 (ptrdiff_t nargs, Lisp_Object *args)
35692fe0 2334{
fb8106e8
KH
2335 general_insert_function (insert_before_markers,
2336 insert_from_string_before_markers, 0,
2337 nargs, args);
be91036a
RS
2338 return Qnil;
2339}
2340
a0d76c27
EN
2341DEFUN ("insert-before-markers-and-inherit", Finsert_and_inherit_before_markers,
2342 Sinsert_and_inherit_before_markers, 0, MANY, 0,
7ee72033 2343 doc: /* Insert text at point, relocating markers and inheriting properties.
a1f17501
PJ
2344Point and markers move forward to end up after the inserted text.
2345
2346If the current buffer is multibyte, unibyte strings are converted
2347to multibyte for insertion (see `unibyte-char-to-multibyte').
2348If the current buffer is unibyte, multibyte strings are converted
4bfbe194
MB
2349to unibyte for insertion.
2350
2351usage: (insert-before-markers-and-inherit &rest ARGS) */)
f66c7cf8 2352 (ptrdiff_t nargs, Lisp_Object *args)
be91036a 2353{
fb8106e8
KH
2354 general_insert_function (insert_before_markers_and_inherit,
2355 insert_from_string_before_markers, 1,
2356 nargs, args);
35692fe0
JB
2357 return Qnil;
2358}
2359\f
a7ca3326 2360DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
9671c13a 2361 doc: /* Insert COUNT copies of CHARACTER.
a1f17501
PJ
2362Point, and before-insertion markers, are relocated as in the function `insert'.
2363The optional third arg INHERIT, if non-nil, says to inherit text properties
7ee72033 2364from adjoining text, if those properties are sticky. */)
5842a27b 2365 (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
35692fe0 2366{
21d890a4 2367 int i, stringlen;
d311d28c 2368 register ptrdiff_t n;
13bdea59 2369 int c, len;
d5c2c403 2370 unsigned char str[MAX_MULTIBYTE_LENGTH];
21d890a4 2371 char string[4000];
35692fe0 2372
13bdea59 2373 CHECK_CHARACTER (character);
b7826503 2374 CHECK_NUMBER (count);
13bdea59 2375 c = XFASTINT (character);
35692fe0 2376
4b4deea2 2377 if (!NILP (BVAR (current_buffer, enable_multibyte_characters)))
13bdea59 2378 len = CHAR_STRING (c, str);
fb8106e8 2379 else
13bdea59 2380 str[0] = c, len = 1;
2e6813b0
PE
2381 if (XINT (count) <= 0)
2382 return Qnil;
d1f3d2af 2383 if (BUF_BYTES_MAX / len < XINT (count))
99561444 2384 buffer_overflow ();
fb8106e8 2385 n = XINT (count) * len;
21d890a4 2386 stringlen = min (n, sizeof string - sizeof string % len);
545b49b4 2387 for (i = 0; i < stringlen; i++)
fb8106e8 2388 string[i] = str[i % len];
21d890a4 2389 while (n > stringlen)
35692fe0 2390 {
54e42e2d 2391 QUIT;
e2eeabbb 2392 if (!NILP (inherit))
545b49b4 2393 insert_and_inherit (string, stringlen);
e2eeabbb 2394 else
545b49b4
PE
2395 insert (string, stringlen);
2396 n -= stringlen;
35692fe0 2397 }
21d890a4
PE
2398 if (!NILP (inherit))
2399 insert_and_inherit (string, n);
2400 else
2401 insert (string, n);
35692fe0
JB
2402 return Qnil;
2403}
2404
48ef988f
KH
2405DEFUN ("insert-byte", Finsert_byte, Sinsert_byte, 2, 3, 0,
2406 doc: /* Insert COUNT (second arg) copies of BYTE (first arg).
2407Both arguments are required.
2408BYTE is a number of the range 0..255.
2409
2410If BYTE is 128..255 and the current buffer is multibyte, the
2411corresponding eight-bit character is inserted.
2412
2413Point, and before-insertion markers, are relocated as in the function `insert'.
2414The optional third arg INHERIT, if non-nil, says to inherit text properties
2415from adjoining text, if those properties are sticky. */)
5842a27b 2416 (Lisp_Object byte, Lisp_Object count, Lisp_Object inherit)
48ef988f
KH
2417{
2418 CHECK_NUMBER (byte);
2419 if (XINT (byte) < 0 || XINT (byte) > 255)
2420 args_out_of_range_3 (byte, make_number (0), make_number (255));
2421 if (XINT (byte) >= 128
4b4deea2 2422 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
48ef988f 2423 XSETFASTINT (byte, BYTE8_TO_CHAR (XINT (byte)));
ed398b0a 2424 return Finsert_char (byte, count, inherit);
48ef988f
KH
2425}
2426
35692fe0 2427\f
ffd56f97
JB
2428/* Making strings from buffer contents. */
2429
2430/* Return a Lisp_String containing the text of the current buffer from
74d6d8c5 2431 START to END. If text properties are in use and the current buffer
eb8c3be9 2432 has properties in the range specified, the resulting string will also
260e2e2a 2433 have them, if PROPS is nonzero.
ffd56f97
JB
2434
2435 We don't want to use plain old make_string here, because it calls
2436 make_uninit_string, which can cause the buffer arena to be
2437 compacted. make_string has no way of knowing that the data has
2438 been moved, and thus copies the wrong data into the string. This
2439 doesn't effect most of the other users of make_string, so it should
2440 be left as is. But we should use this function when conjuring
2441 buffer substrings. */
74d6d8c5 2442
ffd56f97 2443Lisp_Object
d311d28c 2444make_buffer_string (ptrdiff_t start, ptrdiff_t end, int props)
ffd56f97 2445{
d311d28c
PE
2446 ptrdiff_t start_byte = CHAR_TO_BYTE (start);
2447 ptrdiff_t end_byte = CHAR_TO_BYTE (end);
ffd56f97 2448
88441c8e
RS
2449 return make_buffer_string_both (start, start_byte, end, end_byte, props);
2450}
2451
2452/* Return a Lisp_String containing the text of the current buffer from
2453 START / START_BYTE to END / END_BYTE.
2454
2455 If text properties are in use and the current buffer
2456 has properties in the range specified, the resulting string will also
2457 have them, if PROPS is nonzero.
2458
2459 We don't want to use plain old make_string here, because it calls
2460 make_uninit_string, which can cause the buffer arena to be
2461 compacted. make_string has no way of knowing that the data has
2462 been moved, and thus copies the wrong data into the string. This
2463 doesn't effect most of the other users of make_string, so it should
2464 be left as is. But we should use this function when conjuring
2465 buffer substrings. */
2466
2467Lisp_Object
d311d28c
PE
2468make_buffer_string_both (ptrdiff_t start, ptrdiff_t start_byte,
2469 ptrdiff_t end, ptrdiff_t end_byte, int props)
88441c8e
RS
2470{
2471 Lisp_Object result, tem, tem1;
2472
ffd56f97
JB
2473 if (start < GPT && GPT < end)
2474 move_gap (start);
2475
4b4deea2 2476 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
5f75e666
RS
2477 result = make_uninit_multibyte_string (end - start, end_byte - start_byte);
2478 else
2479 result = make_uninit_string (end - start);
72af86bd 2480 memcpy (SDATA (result), BYTE_POS_ADDR (start_byte), end_byte - start_byte);
ffd56f97 2481
260e2e2a 2482 /* If desired, update and copy the text properties. */
260e2e2a
KH
2483 if (props)
2484 {
2485 update_buffer_properties (start, end);
2486
2487 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
2488 tem1 = Ftext_properties_at (make_number (start), Qnil);
2489
2490 if (XINT (tem) != end || !NILP (tem1))
ec1c14f6
RS
2491 copy_intervals_to_string (result, current_buffer, start,
2492 end - start);
260e2e2a 2493 }
74d6d8c5 2494
ffd56f97
JB
2495 return result;
2496}
35692fe0 2497
260e2e2a
KH
2498/* Call Vbuffer_access_fontify_functions for the range START ... END
2499 in the current buffer, if necessary. */
2500
2501static void
d311d28c 2502update_buffer_properties (ptrdiff_t start, ptrdiff_t end)
260e2e2a 2503{
260e2e2a
KH
2504 /* If this buffer has some access functions,
2505 call them, specifying the range of the buffer being accessed. */
2506 if (!NILP (Vbuffer_access_fontify_functions))
2507 {
2508 Lisp_Object args[3];
2509 Lisp_Object tem;
2510
2511 args[0] = Qbuffer_access_fontify_functions;
2512 XSETINT (args[1], start);
2513 XSETINT (args[2], end);
2514
2515 /* But don't call them if we can tell that the work
2516 has already been done. */
2517 if (!NILP (Vbuffer_access_fontified_property))
2518 {
2519 tem = Ftext_property_any (args[1], args[2],
2520 Vbuffer_access_fontified_property,
2521 Qnil, Qnil);
2522 if (! NILP (tem))
ced1d19a 2523 Frun_hook_with_args (3, args);
260e2e2a
KH
2524 }
2525 else
ced1d19a 2526 Frun_hook_with_args (3, args);
260e2e2a 2527 }
260e2e2a
KH
2528}
2529
a7ca3326 2530DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
7ee72033 2531 doc: /* Return the contents of part of the current buffer as a string.
a1f17501
PJ
2532The two arguments START and END are character positions;
2533they can be in either order.
2534The string returned is multibyte if the buffer is multibyte.
2535
2536This function copies the text properties of that part of the buffer
2537into the result string; if you don't want the text properties,
7ee72033 2538use `buffer-substring-no-properties' instead. */)
5842a27b 2539 (Lisp_Object start, Lisp_Object end)
35692fe0 2540{
d311d28c 2541 register ptrdiff_t b, e;
35692fe0 2542
2591ec64
EN
2543 validate_region (&start, &end);
2544 b = XINT (start);
2545 e = XINT (end);
35692fe0 2546
2591ec64 2547 return make_buffer_string (b, e, 1);
260e2e2a
KH
2548}
2549
2550DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
2551 Sbuffer_substring_no_properties, 2, 2, 0,
7ee72033 2552 doc: /* Return the characters of part of the buffer, without the text properties.
a1f17501 2553The two arguments START and END are character positions;
7ee72033 2554they can be in either order. */)
5842a27b 2555 (Lisp_Object start, Lisp_Object end)
260e2e2a 2556{
d311d28c 2557 register ptrdiff_t b, e;
260e2e2a 2558
2591ec64
EN
2559 validate_region (&start, &end);
2560 b = XINT (start);
2561 e = XINT (end);
260e2e2a 2562
2591ec64 2563 return make_buffer_string (b, e, 0);
35692fe0
JB
2564}
2565
a7ca3326 2566DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
7ee72033 2567 doc: /* Return the contents of the current buffer as a string.
a1f17501 2568If narrowing is in effect, this function returns only the visible part
7ee72033 2569of the buffer. */)
5842a27b 2570 (void)
35692fe0 2571{
0daf6e8d 2572 return make_buffer_string (BEGV, ZV, 1);
35692fe0
JB
2573}
2574
2575DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
deb8e082 2576 1, 3, 0,
658ec670 2577 doc: /* Insert before point a substring of the contents of BUFFER.
a1f17501 2578BUFFER may be a buffer or a buffer name.
412f1fab
JB
2579Arguments START and END are character positions specifying the substring.
2580They default to the values of (point-min) and (point-max) in BUFFER. */)
5842a27b 2581 (Lisp_Object buffer, Lisp_Object start, Lisp_Object end)
35692fe0 2582{
29cdc13e 2583 register EMACS_INT b, e, temp;
260e2e2a 2584 register struct buffer *bp, *obuf;
658ec670 2585 Lisp_Object buf;
35692fe0 2586
658ec670
JB
2587 buf = Fget_buffer (buffer);
2588 if (NILP (buf))
2589 nsberror (buffer);
2590 bp = XBUFFER (buf);
4b4deea2 2591 if (NILP (BVAR (bp, name)))
93b62e82 2592 error ("Selecting deleted buffer");
35692fe0 2593
2591ec64
EN
2594 if (NILP (start))
2595 b = BUF_BEGV (bp);
35692fe0
JB
2596 else
2597 {
b7826503 2598 CHECK_NUMBER_COERCE_MARKER (start);
2591ec64 2599 b = XINT (start);
35692fe0 2600 }
2591ec64
EN
2601 if (NILP (end))
2602 e = BUF_ZV (bp);
35692fe0
JB
2603 else
2604 {
b7826503 2605 CHECK_NUMBER_COERCE_MARKER (end);
2591ec64 2606 e = XINT (end);
35692fe0
JB
2607 }
2608
2591ec64
EN
2609 if (b > e)
2610 temp = b, b = e, e = temp;
35692fe0 2611
2591ec64
EN
2612 if (!(BUF_BEGV (bp) <= b && e <= BUF_ZV (bp)))
2613 args_out_of_range (start, end);
35692fe0 2614
260e2e2a
KH
2615 obuf = current_buffer;
2616 set_buffer_internal_1 (bp);
2591ec64 2617 update_buffer_properties (b, e);
260e2e2a
KH
2618 set_buffer_internal_1 (obuf);
2619
2591ec64 2620 insert_from_buffer (bp, b, e - b, 0);
35692fe0
JB
2621 return Qnil;
2622}
e9cf2084
RS
2623
2624DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
deb8e082 2625 6, 6, 0,
7ee72033 2626 doc: /* Compare two substrings of two buffers; return result as number.
a1f17501
PJ
2627the value is -N if first string is less after N-1 chars,
2628+N if first string is greater after N-1 chars, or 0 if strings match.
2629Each substring is represented as three arguments: BUFFER, START and END.
2630That makes six args in all, three for each substring.
2631
2632The value of `case-fold-search' in the current buffer
7ee72033 2633determines whether case is significant or ignored. */)
5842a27b 2634 (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)
e9cf2084 2635{
29cdc13e 2636 register EMACS_INT begp1, endp1, begp2, endp2, temp;
e9cf2084 2637 register struct buffer *bp1, *bp2;
1149fd6f 2638 register Lisp_Object trt
4b4deea2
TT
2639 = (!NILP (BVAR (current_buffer, case_fold_search))
2640 ? BVAR (current_buffer, case_canon_table) : Qnil);
d311d28c
PE
2641 ptrdiff_t chars = 0;
2642 ptrdiff_t i1, i2, i1_byte, i2_byte;
e9cf2084
RS
2643
2644 /* Find the first buffer and its substring. */
2645
2646 if (NILP (buffer1))
2647 bp1 = current_buffer;
2648 else
2649 {
3fff2dfa
RS
2650 Lisp_Object buf1;
2651 buf1 = Fget_buffer (buffer1);
2652 if (NILP (buf1))
2653 nsberror (buffer1);
2654 bp1 = XBUFFER (buf1);
4b4deea2 2655 if (NILP (BVAR (bp1, name)))
93b62e82 2656 error ("Selecting deleted buffer");
e9cf2084
RS
2657 }
2658
2659 if (NILP (start1))
2660 begp1 = BUF_BEGV (bp1);
2661 else
2662 {
b7826503 2663 CHECK_NUMBER_COERCE_MARKER (start1);
e9cf2084
RS
2664 begp1 = XINT (start1);
2665 }
2666 if (NILP (end1))
2667 endp1 = BUF_ZV (bp1);
2668 else
2669 {
b7826503 2670 CHECK_NUMBER_COERCE_MARKER (end1);
e9cf2084
RS
2671 endp1 = XINT (end1);
2672 }
2673
2674 if (begp1 > endp1)
2675 temp = begp1, begp1 = endp1, endp1 = temp;
2676
2677 if (!(BUF_BEGV (bp1) <= begp1
2678 && begp1 <= endp1
2679 && endp1 <= BUF_ZV (bp1)))
2680 args_out_of_range (start1, end1);
2681
2682 /* Likewise for second substring. */
2683
2684 if (NILP (buffer2))
2685 bp2 = current_buffer;
2686 else
2687 {
3fff2dfa
RS
2688 Lisp_Object buf2;
2689 buf2 = Fget_buffer (buffer2);
2690 if (NILP (buf2))
2691 nsberror (buffer2);
3b1fdd85 2692 bp2 = XBUFFER (buf2);
4b4deea2 2693 if (NILP (BVAR (bp2, name)))
93b62e82 2694 error ("Selecting deleted buffer");
e9cf2084
RS
2695 }
2696
2697 if (NILP (start2))
2698 begp2 = BUF_BEGV (bp2);
2699 else
2700 {
b7826503 2701 CHECK_NUMBER_COERCE_MARKER (start2);
e9cf2084
RS
2702 begp2 = XINT (start2);
2703 }
2704 if (NILP (end2))
2705 endp2 = BUF_ZV (bp2);
2706 else
2707 {
b7826503 2708 CHECK_NUMBER_COERCE_MARKER (end2);
e9cf2084
RS
2709 endp2 = XINT (end2);
2710 }
2711
2712 if (begp2 > endp2)
2713 temp = begp2, begp2 = endp2, endp2 = temp;
2714
2715 if (!(BUF_BEGV (bp2) <= begp2
2716 && begp2 <= endp2
2717 && endp2 <= BUF_ZV (bp2)))
2718 args_out_of_range (start2, end2);
2719
07422a12
RS
2720 i1 = begp1;
2721 i2 = begp2;
2722 i1_byte = buf_charpos_to_bytepos (bp1, i1);
2723 i2_byte = buf_charpos_to_bytepos (bp2, i2);
e9cf2084 2724
07422a12 2725 while (i1 < endp1 && i2 < endp2)
e9cf2084 2726 {
07422a12
RS
2727 /* When we find a mismatch, we must compare the
2728 characters, not just the bytes. */
2729 int c1, c2;
ec1c14f6 2730
2221451f
RS
2731 QUIT;
2732
4b4deea2 2733 if (! NILP (BVAR (bp1, enable_multibyte_characters)))
07422a12
RS
2734 {
2735 c1 = BUF_FETCH_MULTIBYTE_CHAR (bp1, i1_byte);
2736 BUF_INC_POS (bp1, i1_byte);
2737 i1++;
2738 }
2739 else
2740 {
2741 c1 = BUF_FETCH_BYTE (bp1, i1);
4c0354d7 2742 MAKE_CHAR_MULTIBYTE (c1);
07422a12
RS
2743 i1++;
2744 }
2745
4b4deea2 2746 if (! NILP (BVAR (bp2, enable_multibyte_characters)))
07422a12
RS
2747 {
2748 c2 = BUF_FETCH_MULTIBYTE_CHAR (bp2, i2_byte);
2749 BUF_INC_POS (bp2, i2_byte);
2750 i2++;
2751 }
2752 else
2753 {
2754 c2 = BUF_FETCH_BYTE (bp2, i2);
4c0354d7 2755 MAKE_CHAR_MULTIBYTE (c2);
07422a12
RS
2756 i2++;
2757 }
ec1c14f6 2758
1149fd6f 2759 if (!NILP (trt))
e9cf2084 2760 {
1149fd6f
SM
2761 c1 = CHAR_TABLE_TRANSLATE (trt, c1);
2762 c2 = CHAR_TABLE_TRANSLATE (trt, c2);
e9cf2084
RS
2763 }
2764 if (c1 < c2)
ec1c14f6 2765 return make_number (- 1 - chars);
e9cf2084 2766 if (c1 > c2)
ec1c14f6 2767 return make_number (chars + 1);
07422a12
RS
2768
2769 chars++;
e9cf2084
RS
2770 }
2771
2772 /* The strings match as far as they go.
2773 If one is shorter, that one is less. */
07422a12 2774 if (chars < endp1 - begp1)
ec1c14f6 2775 return make_number (chars + 1);
07422a12 2776 else if (chars < endp2 - begp2)
ec1c14f6 2777 return make_number (- chars - 1);
e9cf2084
RS
2778
2779 /* Same length too => they are equal. */
2780 return make_number (0);
2781}
35692fe0 2782\f
d5a539cd 2783static Lisp_Object
971de7fb 2784subst_char_in_region_unwind (Lisp_Object arg)
d5a539cd 2785{
4b4deea2 2786 return BVAR (current_buffer, undo_list) = arg;
d5a539cd
RS
2787}
2788
c8e76b47 2789static Lisp_Object
971de7fb 2790subst_char_in_region_unwind_1 (Lisp_Object arg)
c8e76b47 2791{
4b4deea2 2792 return BVAR (current_buffer, filename) = arg;
c8e76b47
RS
2793}
2794
35692fe0 2795DEFUN ("subst-char-in-region", Fsubst_char_in_region,
deb8e082 2796 Ssubst_char_in_region, 4, 5, 0,
7ee72033 2797 doc: /* From START to END, replace FROMCHAR with TOCHAR each time it occurs.
a1f17501
PJ
2798If optional arg NOUNDO is non-nil, don't record this change for undo
2799and don't mark the buffer as really changed.
7ee72033 2800Both characters must have the same length of multi-byte form. */)
5842a27b 2801 (Lisp_Object start, Lisp_Object end, Lisp_Object fromchar, Lisp_Object tochar, Lisp_Object noundo)
35692fe0 2802{
d311d28c 2803 register ptrdiff_t pos, pos_byte, stop, i, len, end_byte;
0f2e2a3b
SM
2804 /* Keep track of the first change in the buffer:
2805 if 0 we haven't found it yet.
2806 if < 0 we've found it and we've run the before-change-function.
2807 if > 0 we've actually performed it and the value is its position. */
d311d28c 2808 ptrdiff_t changed = 0;
d5c2c403
KH
2809 unsigned char fromstr[MAX_MULTIBYTE_LENGTH], tostr[MAX_MULTIBYTE_LENGTH];
2810 unsigned char *p;
d311d28c 2811 ptrdiff_t count = SPECPDL_INDEX ();
aa801467
KH
2812#define COMBINING_NO 0
2813#define COMBINING_BEFORE 1
2814#define COMBINING_AFTER 2
2815#define COMBINING_BOTH (COMBINING_BEFORE | COMBINING_AFTER)
2816 int maybe_byte_combining = COMBINING_NO;
d311d28c 2817 ptrdiff_t last_changed = 0;
4b4deea2 2818 int multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
13bdea59 2819 int fromc, toc;
35692fe0 2820
0f2e2a3b
SM
2821 restart:
2822
35692fe0 2823 validate_region (&start, &end);
13bdea59
PE
2824 CHECK_CHARACTER (fromchar);
2825 CHECK_CHARACTER (tochar);
2826 fromc = XFASTINT (fromchar);
2827 toc = XFASTINT (tochar);
35692fe0 2828
7439e5b9 2829 if (multibyte_p)
fb8106e8 2830 {
13bdea59
PE
2831 len = CHAR_STRING (fromc, fromstr);
2832 if (CHAR_STRING (toc, tostr) != len)
fdd6025e 2833 error ("Characters in `subst-char-in-region' have different byte-lengths");
aa801467
KH
2834 if (!ASCII_BYTE_P (*tostr))
2835 {
2836 /* If *TOSTR is in the range 0x80..0x9F and TOCHAR is not a
2837 complete multibyte character, it may be combined with the
2838 after bytes. If it is in the range 0xA0..0xFF, it may be
2839 combined with the before and after bytes. */
2840 if (!CHAR_HEAD_P (*tostr))
2841 maybe_byte_combining = COMBINING_BOTH;
2842 else if (BYTES_BY_CHAR_HEAD (*tostr) > len)
2843 maybe_byte_combining = COMBINING_AFTER;
2844 }
fb8106e8
KH
2845 }
2846 else
2847 {
2848 len = 1;
13bdea59
PE
2849 fromstr[0] = fromc;
2850 tostr[0] = toc;
fb8106e8
KH
2851 }
2852
84246b95
KH
2853 pos = XINT (start);
2854 pos_byte = CHAR_TO_BYTE (pos);
ec1c14f6
RS
2855 stop = CHAR_TO_BYTE (XINT (end));
2856 end_byte = stop;
35692fe0 2857
d5a539cd
RS
2858 /* If we don't want undo, turn off putting stuff on the list.
2859 That's faster than getting rid of things,
c8e76b47
RS
2860 and it prevents even the entry for a first change.
2861 Also inhibit locking the file. */
0f2e2a3b 2862 if (!changed && !NILP (noundo))
d5a539cd
RS
2863 {
2864 record_unwind_protect (subst_char_in_region_unwind,
4b4deea2
TT
2865 BVAR (current_buffer, undo_list));
2866 BVAR (current_buffer, undo_list) = Qt;
c8e76b47
RS
2867 /* Don't do file-locking. */
2868 record_unwind_protect (subst_char_in_region_unwind_1,
4b4deea2
TT
2869 BVAR (current_buffer, filename));
2870 BVAR (current_buffer, filename) = Qnil;
d5a539cd
RS
2871 }
2872
84246b95 2873 if (pos_byte < GPT_BYTE)
ec1c14f6 2874 stop = min (stop, GPT_BYTE);
fb8106e8 2875 while (1)
35692fe0 2876 {
d311d28c 2877 ptrdiff_t pos_byte_next = pos_byte;
a3360ff9 2878
84246b95 2879 if (pos_byte >= stop)
fb8106e8 2880 {
84246b95 2881 if (pos_byte >= end_byte) break;
ec1c14f6 2882 stop = end_byte;
fb8106e8 2883 }
84246b95 2884 p = BYTE_POS_ADDR (pos_byte);
7439e5b9
GM
2885 if (multibyte_p)
2886 INC_POS (pos_byte_next);
2887 else
2888 ++pos_byte_next;
a3360ff9
KH
2889 if (pos_byte_next - pos_byte == len
2890 && p[0] == fromstr[0]
fb8106e8
KH
2891 && (len == 1
2892 || (p[1] == fromstr[1]
2893 && (len == 2 || (p[2] == fromstr[2]
2894 && (len == 3 || p[3] == fromstr[3]))))))
35692fe0 2895 {
0f2e2a3b
SM
2896 if (changed < 0)
2897 /* We've already seen this and run the before-change-function;
2898 this time we only need to record the actual position. */
2899 changed = pos;
2900 else if (!changed)
60b96ee7 2901 {
0f2e2a3b 2902 changed = -1;
3e145152 2903 modify_region (current_buffer, pos, XINT (end), 0);
7653d030
RS
2904
2905 if (! NILP (noundo))
2906 {
1e158d25
RS
2907 if (MODIFF - 1 == SAVE_MODIFF)
2908 SAVE_MODIFF++;
0b5397c2
SM
2909 if (MODIFF - 1 == BUF_AUTOSAVE_MODIFF (current_buffer))
2910 BUF_AUTOSAVE_MODIFF (current_buffer)++;
7653d030 2911 }
0f2e2a3b
SM
2912
2913 /* The before-change-function may have moved the gap
2914 or even modified the buffer so we should start over. */
2915 goto restart;
60b96ee7
RS
2916 }
2917
0c1e3b85 2918 /* Take care of the case where the new character
34a7a267 2919 combines with neighboring bytes. */
a3360ff9 2920 if (maybe_byte_combining
aa801467
KH
2921 && (maybe_byte_combining == COMBINING_AFTER
2922 ? (pos_byte_next < Z_BYTE
2923 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2924 : ((pos_byte_next < Z_BYTE
2925 && ! CHAR_HEAD_P (FETCH_BYTE (pos_byte_next)))
2926 || (pos_byte > BEG_BYTE
2927 && ! ASCII_BYTE_P (FETCH_BYTE (pos_byte - 1))))))
0c1e3b85
RS
2928 {
2929 Lisp_Object tem, string;
2930
2931 struct gcpro gcpro1;
2932
4b4deea2 2933 tem = BVAR (current_buffer, undo_list);
0c1e3b85
RS
2934 GCPRO1 (tem);
2935
aa801467 2936 /* Make a multibyte string containing this single character. */
e7f8264d 2937 string = make_multibyte_string ((char *) tostr, 1, len);
0c1e3b85
RS
2938 /* replace_range is less efficient, because it moves the gap,
2939 but it handles combining correctly. */
2940 replace_range (pos, pos + 1, string,
9869520f 2941 0, 0, 1);
a3360ff9
KH
2942 pos_byte_next = CHAR_TO_BYTE (pos);
2943 if (pos_byte_next > pos_byte)
2944 /* Before combining happened. We should not increment
3f5409d3
KH
2945 POS. So, to cancel the later increment of POS,
2946 decrease it now. */
2947 pos--;
a3360ff9 2948 else
3f5409d3 2949 INC_POS (pos_byte_next);
34a7a267 2950
0c1e3b85 2951 if (! NILP (noundo))
4b4deea2 2952 BVAR (current_buffer, undo_list) = tem;
0c1e3b85
RS
2953
2954 UNGCPRO;
2955 }
2956 else
2957 {
2958 if (NILP (noundo))
2959 record_change (pos, 1);
2960 for (i = 0; i < len; i++) *p++ = tostr[i];
2961 }
d5c2c403 2962 last_changed = pos + 1;
35692fe0 2963 }
3f5409d3
KH
2964 pos_byte = pos_byte_next;
2965 pos++;
35692fe0
JB
2966 }
2967
0f2e2a3b 2968 if (changed > 0)
d5c2c403
KH
2969 {
2970 signal_after_change (changed,
2971 last_changed - changed, last_changed - changed);
2972 update_compositions (changed, last_changed, CHECK_ALL);
2973 }
60b96ee7 2974
d5a539cd 2975 unbind_to (count, Qnil);
35692fe0
JB
2976 return Qnil;
2977}
2978
f555f8cf 2979
d311d28c 2980static Lisp_Object check_translation (ptrdiff_t, ptrdiff_t, ptrdiff_t,
c8a66ab8 2981 Lisp_Object);
f555f8cf
KH
2982
2983/* Helper function for Ftranslate_region_internal.
2984
2985 Check if a character sequence at POS (POS_BYTE) matches an element
2986 of VAL. VAL is a list (([FROM-CHAR ...] . TO) ...). If a matching
2987 element is found, return it. Otherwise return Qnil. */
2988
2989static Lisp_Object
d311d28c 2990check_translation (ptrdiff_t pos, ptrdiff_t pos_byte, ptrdiff_t end,
c8a66ab8 2991 Lisp_Object val)
f555f8cf
KH
2992{
2993 int buf_size = 16, buf_used = 0;
2994 int *buf = alloca (sizeof (int) * buf_size);
2995
2996 for (; CONSP (val); val = XCDR (val))
2997 {
2998 Lisp_Object elt;
d311d28c 2999 ptrdiff_t len, i;
f555f8cf
KH
3000
3001 elt = XCAR (val);
3002 if (! CONSP (elt))
3003 continue;
3004 elt = XCAR (elt);
3005 if (! VECTORP (elt))
3006 continue;
3007 len = ASIZE (elt);
3008 if (len <= end - pos)
3009 {
3010 for (i = 0; i < len; i++)
3011 {
3012 if (buf_used <= i)
3013 {
3014 unsigned char *p = BYTE_POS_ADDR (pos_byte);
c8a66ab8 3015 int len1;
f555f8cf
KH
3016
3017 if (buf_used == buf_size)
3018 {
3019 int *newbuf;
3020
3021 buf_size += 16;
3022 newbuf = alloca (sizeof (int) * buf_size);
3023 memcpy (newbuf, buf, sizeof (int) * buf_used);
3024 buf = newbuf;
3025 }
c8a66ab8
EZ
3026 buf[buf_used++] = STRING_CHAR_AND_LENGTH (p, len1);
3027 pos_byte += len1;
f555f8cf
KH
3028 }
3029 if (XINT (AREF (elt, i)) != buf[i])
3030 break;
3031 }
3032 if (i == len)
3033 return XCAR (val);
3034 }
3035 }
3036 return Qnil;
3037}
3038
3039
8583605b
KH
3040DEFUN ("translate-region-internal", Ftranslate_region_internal,
3041 Stranslate_region_internal, 3, 3, 0,
3042 doc: /* Internal use only.
3043From START to END, translate characters according to TABLE.
f555f8cf
KH
3044TABLE is a string or a char-table; the Nth character in it is the
3045mapping for the character with code N.
7ee72033 3046It returns the number of characters changed. */)
5842a27b 3047 (Lisp_Object start, Lisp_Object end, register Lisp_Object table)
35692fe0 3048{
35692fe0 3049 register unsigned char *tt; /* Trans table. */
35692fe0
JB
3050 register int nc; /* New character. */
3051 int cnt; /* Number of changes made. */
d311d28c
PE
3052 ptrdiff_t size; /* Size of translate table. */
3053 ptrdiff_t pos, pos_byte, end_pos;
4b4deea2 3054 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
9710023e 3055 int string_multibyte IF_LINT (= 0);
35692fe0
JB
3056
3057 validate_region (&start, &end);
8583605b 3058 if (CHAR_TABLE_P (table))
f555f8cf
KH
3059 {
3060 if (! EQ (XCHAR_TABLE (table)->purpose, Qtranslation_table))
3061 error ("Not a translation table");
eb3d9ec7 3062 size = MAX_CHAR;
f555f8cf
KH
3063 tt = NULL;
3064 }
8583605b
KH
3065 else
3066 {
3067 CHECK_STRING (table);
3068
eb3d9ec7
KH
3069 if (! multibyte && (SCHARS (table) < SBYTES (table)))
3070 table = string_make_unibyte (table);
8583605b
KH
3071 string_multibyte = SCHARS (table) < SBYTES (table);
3072 size = SBYTES (table);
3073 tt = SDATA (table);
3074 }
35692fe0 3075
1f24f4fd 3076 pos = XINT (start);
8583605b 3077 pos_byte = CHAR_TO_BYTE (pos);
e65837df 3078 end_pos = XINT (end);
af6ea8ad 3079 modify_region (current_buffer, pos, end_pos, 0);
35692fe0
JB
3080
3081 cnt = 0;
f555f8cf 3082 for (; pos < end_pos; )
35692fe0 3083 {
ec1c14f6 3084 register unsigned char *p = BYTE_POS_ADDR (pos_byte);
8583605b
KH
3085 unsigned char *str, buf[MAX_MULTIBYTE_LENGTH];
3086 int len, str_len;
1f24f4fd 3087 int oc;
f555f8cf 3088 Lisp_Object val;
ec1c14f6 3089
e8cce5af 3090 if (multibyte)
62a6e103 3091 oc = STRING_CHAR_AND_LENGTH (p, len);
e8cce5af 3092 else
eb3d9ec7
KH
3093 oc = *p, len = 1;
3094 if (oc < size)
35692fe0 3095 {
eb3d9ec7 3096 if (tt)
35692fe0 3097 {
fa056b08
KS
3098 /* Reload as signal_after_change in last iteration may GC. */
3099 tt = SDATA (table);
8583605b 3100 if (string_multibyte)
0c1e3b85 3101 {
8583605b 3102 str = tt + string_char_to_byte (table, oc);
62a6e103 3103 nc = STRING_CHAR_AND_LENGTH (str, str_len);
0c1e3b85
RS
3104 }
3105 else
3106 {
eb3d9ec7
KH
3107 nc = tt[oc];
3108 if (! ASCII_BYTE_P (nc) && multibyte)
3109 {
3110 str_len = BYTE8_STRING (nc, buf);
3111 str = buf;
3112 }
3113 else
3114 {
3115 str_len = 1;
3116 str = tt + oc;
3117 }
0c1e3b85 3118 }
35692fe0 3119 }
eb3d9ec7 3120 else
f555f8cf 3121 {
eb3d9ec7
KH
3122 nc = oc;
3123 val = CHAR_TABLE_REF (table, oc);
045eb8d9 3124 if (CHARACTERP (val))
eb3d9ec7 3125 {
045eb8d9 3126 nc = XFASTINT (val);
eb3d9ec7
KH
3127 str_len = CHAR_STRING (nc, buf);
3128 str = buf;
3129 }
3130 else if (VECTORP (val) || (CONSP (val)))
3131 {
3132 /* VAL is [TO_CHAR ...] or (([FROM-CHAR ...] . TO) ...)
3133 where TO is TO-CHAR or [TO-CHAR ...]. */
3134 nc = -1;
3135 }
f555f8cf 3136 }
8583605b 3137
eb3d9ec7 3138 if (nc != oc && nc >= 0)
8583605b 3139 {
f555f8cf
KH
3140 /* Simple one char to one char translation. */
3141 if (len != str_len)
3142 {
3143 Lisp_Object string;
8583605b 3144
f555f8cf
KH
3145 /* This is less efficient, because it moves the gap,
3146 but it should handle multibyte characters correctly. */
e7f8264d 3147 string = make_multibyte_string ((char *) str, 1, str_len);
f555f8cf
KH
3148 replace_range (pos, pos + 1, string, 1, 0, 1);
3149 len = str_len;
3150 }
3151 else
3152 {
3153 record_change (pos, 1);
3154 while (str_len-- > 0)
3155 *p++ = *str++;
3156 signal_after_change (pos, 1, 1);
3157 update_compositions (pos, pos + 1, CHECK_BORDER);
3158 }
3159 ++cnt;
8583605b 3160 }
eb3d9ec7 3161 else if (nc < 0)
8583605b 3162 {
f555f8cf
KH
3163 Lisp_Object string;
3164
3165 if (CONSP (val))
3166 {
3167 val = check_translation (pos, pos_byte, end_pos, val);
3168 if (NILP (val))
3169 {
3170 pos_byte += len;
3171 pos++;
3172 continue;
3173 }
3174 /* VAL is ([FROM-CHAR ...] . TO). */
3175 len = ASIZE (XCAR (val));
3176 val = XCDR (val);
3177 }
3178 else
3179 len = 1;
3180
3181 if (VECTORP (val))
3182 {
bde25748 3183 string = Fconcat (1, &val);
f555f8cf
KH
3184 }
3185 else
3186 {
3187 string = Fmake_string (make_number (1), val);
3188 }
3189 replace_range (pos, pos + len, string, 1, 0, 1);
3190 pos_byte += SBYTES (string);
3191 pos += SCHARS (string);
3192 cnt += SCHARS (string);
3193 end_pos += SCHARS (string) - len;
3194 continue;
8583605b 3195 }
8583605b
KH
3196 }
3197 pos_byte += len;
3f5409d3 3198 pos++;
35692fe0
JB
3199 }
3200
ec1c14f6 3201 return make_number (cnt);
35692fe0
JB
3202}
3203
a7ca3326 3204DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
3bbd2265 3205 doc: /* Delete the text between START and END.
f0fcdf4b
LMI
3206If called interactively, delete the region between point and mark.
3207This command deletes buffer text without modifying the kill ring. */)
5842a27b 3208 (Lisp_Object start, Lisp_Object end)
35692fe0 3209{
2591ec64
EN
3210 validate_region (&start, &end);
3211 del_range (XINT (start), XINT (end));
35692fe0
JB
3212 return Qnil;
3213}
7dae4502
SM
3214
3215DEFUN ("delete-and-extract-region", Fdelete_and_extract_region,
3216 Sdelete_and_extract_region, 2, 2, 0,
7ee72033 3217 doc: /* Delete the text between START and END and return it. */)
5842a27b 3218 (Lisp_Object start, Lisp_Object end)
7dae4502
SM
3219{
3220 validate_region (&start, &end);
8550b998 3221 if (XINT (start) == XINT (end))
977f6cfb 3222 return empty_unibyte_string;
7dae4502
SM
3223 return del_range_1 (XINT (start), XINT (end), 1, 1);
3224}
35692fe0 3225\f
a7ca3326 3226DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
7ee72033
MB
3227 doc: /* Remove restrictions (narrowing) from current buffer.
3228This allows the buffer's full text to be seen and edited. */)
5842a27b 3229 (void)
35692fe0 3230{
2cad2e34
RS
3231 if (BEG != BEGV || Z != ZV)
3232 current_buffer->clip_changed = 1;
35692fe0 3233 BEGV = BEG;
ec1c14f6
RS
3234 BEGV_BYTE = BEG_BYTE;
3235 SET_BUF_ZV_BOTH (current_buffer, Z, Z_BYTE);
52b14ac0
JB
3236 /* Changing the buffer bounds invalidates any recorded current column. */
3237 invalidate_current_column ();
35692fe0
JB
3238 return Qnil;
3239}
3240
a7ca3326 3241DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
7ee72033 3242 doc: /* Restrict editing in this buffer to the current region.
a1f17501
PJ
3243The rest of the text becomes temporarily invisible and untouchable
3244but is not deleted; if you save the buffer in a file, the invisible
3245text is included in the file. \\[widen] makes all visible again.
3246See also `save-restriction'.
3247
3248When calling from a program, pass two arguments; positions (integers
7ee72033 3249or markers) bounding the text that should remain visible. */)
5842a27b 3250 (register Lisp_Object start, Lisp_Object end)
35692fe0 3251{
b7826503
PJ
3252 CHECK_NUMBER_COERCE_MARKER (start);
3253 CHECK_NUMBER_COERCE_MARKER (end);
35692fe0 3254
2591ec64 3255 if (XINT (start) > XINT (end))
35692fe0 3256 {
b5a6948e 3257 Lisp_Object tem;
2591ec64 3258 tem = start; start = end; end = tem;
35692fe0
JB
3259 }
3260
2591ec64
EN
3261 if (!(BEG <= XINT (start) && XINT (start) <= XINT (end) && XINT (end) <= Z))
3262 args_out_of_range (start, end);
35692fe0 3263
2cad2e34
RS
3264 if (BEGV != XFASTINT (start) || ZV != XFASTINT (end))
3265 current_buffer->clip_changed = 1;
3266
ec1c14f6 3267 SET_BUF_BEGV (current_buffer, XFASTINT (start));
2591ec64 3268 SET_BUF_ZV (current_buffer, XFASTINT (end));
6ec8bbd2 3269 if (PT < XFASTINT (start))
2591ec64 3270 SET_PT (XFASTINT (start));
6ec8bbd2 3271 if (PT > XFASTINT (end))
2591ec64 3272 SET_PT (XFASTINT (end));
52b14ac0
JB
3273 /* Changing the buffer bounds invalidates any recorded current column. */
3274 invalidate_current_column ();
35692fe0
JB
3275 return Qnil;
3276}
3277
3278Lisp_Object
971de7fb 3279save_restriction_save (void)
35692fe0 3280{
d6abb4c7
MB
3281 if (BEGV == BEG && ZV == Z)
3282 /* The common case that the buffer isn't narrowed.
3283 We return just the buffer object, which save_restriction_restore
3284 recognizes as meaning `no restriction'. */
3285 return Fcurrent_buffer ();
3286 else
3287 /* We have to save a restriction, so return a pair of markers, one
3288 for the beginning and one for the end. */
3289 {
3290 Lisp_Object beg, end;
3291
3292 beg = buildmark (BEGV, BEGV_BYTE);
3293 end = buildmark (ZV, ZV_BYTE);
35692fe0 3294
d6abb4c7 3295 /* END must move forward if text is inserted at its exact location. */
5e617bc2 3296 XMARKER (end)->insertion_type = 1;
d6abb4c7
MB
3297
3298 return Fcons (beg, end);
3299 }
35692fe0
JB
3300}
3301
3302Lisp_Object
971de7fb 3303save_restriction_restore (Lisp_Object data)
35692fe0 3304{
d528b1ce
SM
3305 struct buffer *cur = NULL;
3306 struct buffer *buf = (CONSP (data)
3307 ? XMARKER (XCAR (data))->buffer
3308 : XBUFFER (data));
3309
4b4deea2 3310 if (buf && buf != current_buffer && !NILP (BVAR (buf, pt_marker)))
d528b1ce
SM
3311 { /* If `buf' uses markers to keep track of PT, BEGV, and ZV (as
3312 is the case if it is or has an indirect buffer), then make
3313 sure it is current before we update BEGV, so
3314 set_buffer_internal takes care of managing those markers. */
3315 cur = current_buffer;
3316 set_buffer_internal (buf);
3317 }
3318
d6abb4c7
MB
3319 if (CONSP (data))
3320 /* A pair of marks bounding a saved restriction. */
35692fe0 3321 {
d6abb4c7
MB
3322 struct Lisp_Marker *beg = XMARKER (XCAR (data));
3323 struct Lisp_Marker *end = XMARKER (XCDR (data));
d528b1ce 3324 eassert (buf == end->buffer);
2cad2e34 3325
63884563
RS
3326 if (buf /* Verify marker still points to a buffer. */
3327 && (beg->charpos != BUF_BEGV (buf) || end->charpos != BUF_ZV (buf)))
d6abb4c7
MB
3328 /* The restriction has changed from the saved one, so restore
3329 the saved restriction. */
3330 {
d311d28c 3331 ptrdiff_t pt = BUF_PT (buf);
d6abb4c7
MB
3332
3333 SET_BUF_BEGV_BOTH (buf, beg->charpos, beg->bytepos);
3334 SET_BUF_ZV_BOTH (buf, end->charpos, end->bytepos);
3335
3336 if (pt < beg->charpos || pt > end->charpos)
3337 /* The point is outside the new visible range, move it inside. */
3338 SET_BUF_PT_BOTH (buf,
3339 clip_to_bounds (beg->charpos, pt, end->charpos),
63884563 3340 clip_to_bounds (beg->bytepos, BUF_PT_BYTE (buf),
d6abb4c7 3341 end->bytepos));
177c0ea7 3342
d6abb4c7
MB
3343 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3344 }
3345 }
3346 else
3347 /* A buffer, which means that there was no old restriction. */
3348 {
63884563
RS
3349 if (buf /* Verify marker still points to a buffer. */
3350 && (BUF_BEGV (buf) != BUF_BEG (buf) || BUF_ZV (buf) != BUF_Z (buf)))
d6abb4c7
MB
3351 /* The buffer has been narrowed, get rid of the narrowing. */
3352 {
63884563
RS
3353 SET_BUF_BEGV_BOTH (buf, BUF_BEG (buf), BUF_BEG_BYTE (buf));
3354 SET_BUF_ZV_BOTH (buf, BUF_Z (buf), BUF_Z_BYTE (buf));
35692fe0 3355
d6abb4c7
MB
3356 buf->clip_changed = 1; /* Remember that the narrowing changed. */
3357 }
3358 }
35692fe0 3359
aca092ac
SM
3360 /* Changing the buffer bounds invalidates any recorded current column. */
3361 invalidate_current_column ();
3362
d528b1ce
SM
3363 if (cur)
3364 set_buffer_internal (cur);
3365
35692fe0
JB
3366 return Qnil;
3367}
3368
3369DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
7ee72033 3370 doc: /* Execute BODY, saving and restoring current buffer's restrictions.
a1f17501 3371The buffer's restrictions make parts of the beginning and end invisible.
9671c13a 3372\(They are set up with `narrow-to-region' and eliminated with `widen'.)
a1f17501
PJ
3373This special form, `save-restriction', saves the current buffer's restrictions
3374when it is entered, and restores them when it is exited.
3375So any `narrow-to-region' within BODY lasts only until the end of the form.
3376The old restrictions settings are restored
3377even in case of abnormal exit (throw or error).
3378
3379The value returned is the value of the last form in BODY.
3380
3381Note: if you are using both `save-excursion' and `save-restriction',
3382use `save-excursion' outermost:
33c2d29f
MB
3383 (save-excursion (save-restriction ...))
3384
3385usage: (save-restriction &rest BODY) */)
5842a27b 3386 (Lisp_Object body)
35692fe0
JB
3387{
3388 register Lisp_Object val;
d311d28c 3389 ptrdiff_t count = SPECPDL_INDEX ();
35692fe0
JB
3390
3391 record_unwind_protect (save_restriction_restore, save_restriction_save ());
3392 val = Fprogn (body);
3393 return unbind_to (count, val);
3394}
3395\f
0ae83348 3396/* Buffer for the most recent text displayed by Fmessage_box. */
671fbc4d
KH
3397static char *message_text;
3398
3399/* Allocated length of that buffer. */
c9f8d652 3400static ptrdiff_t message_length;
671fbc4d 3401
a7ca3326 3402DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
db18da59 3403 doc: /* Display a message at the bottom of the screen.
281c1721
RS
3404The message also goes into the `*Messages*' buffer.
3405\(In keyboard macros, that's all it does.)
db18da59 3406Return the message.
281c1721 3407
a1f17501
PJ
3408The first argument is a format control string, and the rest are data
3409to be formatted under control of the string. See `format' for details.
3410
7bd5bcfb
KS
3411Note: Use (message "%s" VALUE) to print the value of expressions and
3412variables to avoid accidentally interpreting `%' as format specifiers.
3413
fa056b08
KS
3414If the first argument is nil or the empty string, the function clears
3415any existing message; this lets the minibuffer contents show. See
3416also `current-message'.
4bfbe194 3417
867b9600 3418usage: (message FORMAT-STRING &rest ARGS) */)
f66c7cf8 3419 (ptrdiff_t nargs, Lisp_Object *args)
35692fe0 3420{
6076e561
RS
3421 if (NILP (args[0])
3422 || (STRINGP (args[0])
3423 && SBYTES (args[0]) == 0))
f0250249
JB
3424 {
3425 message (0);
674a954a 3426 return args[0];
f0250249 3427 }
ccdac5be
JB
3428 else
3429 {
3430 register Lisp_Object val;
304f1f12 3431 val = Fformat (nargs, args);
d5db4077 3432 message3 (val, SBYTES (val), STRING_MULTIBYTE (val));
ccdac5be
JB
3433 return val;
3434 }
35692fe0
JB
3435}
3436
cacc3e2c 3437DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
7ee72033 3438 doc: /* Display a message, in a dialog box if possible.
a1f17501
PJ
3439If a dialog box is not available, use the echo area.
3440The first argument is a format control string, and the rest are data
3441to be formatted under control of the string. See `format' for details.
3442
fa056b08
KS
3443If the first argument is nil or the empty string, clear any existing
3444message; let the minibuffer contents show.
4bfbe194 3445
867b9600 3446usage: (message-box FORMAT-STRING &rest ARGS) */)
f66c7cf8 3447 (ptrdiff_t nargs, Lisp_Object *args)
cacc3e2c
RS
3448{
3449 if (NILP (args[0]))
3450 {
3451 message (0);
3452 return Qnil;
3453 }
3454 else
3455 {
3456 register Lisp_Object val;
3457 val = Fformat (nargs, args);
f8250f01 3458#ifdef HAVE_MENUS
0ae83348
EZ
3459 /* The MS-DOS frames support popup menus even though they are
3460 not FRAME_WINDOW_P. */
3461 if (FRAME_WINDOW_P (XFRAME (selected_frame))
3462 || FRAME_MSDOS_P (XFRAME (selected_frame)))
cacc3e2c 3463 {
f838ed7b 3464 Lisp_Object pane, menu;
cacc3e2c
RS
3465 struct gcpro gcpro1;
3466 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
3467 GCPRO1 (pane);
3468 menu = Fcons (val, pane);
f838ed7b 3469 Fx_popup_dialog (Qt, menu, Qt);
cacc3e2c
RS
3470 UNGCPRO;
3471 return val;
3472 }
0ae83348 3473#endif /* HAVE_MENUS */
cacc3e2c
RS
3474 /* Copy the data so that it won't move when we GC. */
3475 if (! message_text)
3476 {
3477 message_text = (char *)xmalloc (80);
3478 message_length = 80;
3479 }
d5db4077 3480 if (SBYTES (val) > message_length)
cacc3e2c 3481 {
c9f8d652 3482 message_text = (char *) xrealloc (message_text, SBYTES (val));
d5db4077 3483 message_length = SBYTES (val);
cacc3e2c 3484 }
72af86bd 3485 memcpy (message_text, SDATA (val), SBYTES (val));
d5db4077 3486 message2 (message_text, SBYTES (val),
d13a8480 3487 STRING_MULTIBYTE (val));
cacc3e2c 3488 return val;
cacc3e2c
RS
3489 }
3490}
f8250f01 3491
cacc3e2c 3492DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
7ee72033 3493 doc: /* Display a message in a dialog box or in the echo area.
a1f17501
PJ
3494If this command was invoked with the mouse, use a dialog box if
3495`use-dialog-box' is non-nil.
3496Otherwise, use the echo area.
3497The first argument is a format control string, and the rest are data
3498to be formatted under control of the string. See `format' for details.
3499
fa056b08
KS
3500If the first argument is nil or the empty string, clear any existing
3501message; let the minibuffer contents show.
4bfbe194 3502
867b9600 3503usage: (message-or-box FORMAT-STRING &rest ARGS) */)
f66c7cf8 3504 (ptrdiff_t nargs, Lisp_Object *args)
cacc3e2c 3505{
f8250f01 3506#ifdef HAVE_MENUS
5920df33 3507 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
c01fbf95 3508 && use_dialog_box)
0a56ee6b 3509 return Fmessage_box (nargs, args);
cacc3e2c
RS
3510#endif
3511 return Fmessage (nargs, args);
3512}
3513
a7ca3326 3514DEFUN ("current-message", Fcurrent_message, Scurrent_message, 0, 0, 0,
7ee72033 3515 doc: /* Return the string currently displayed in the echo area, or nil if none. */)
5842a27b 3516 (void)
b14dda8a 3517{
0634a78e 3518 return current_message ();
b14dda8a
RS
3519}
3520
2d9811c4 3521
d2936d21 3522DEFUN ("propertize", Fpropertize, Spropertize, 1, MANY, 0,
7ee72033 3523 doc: /* Return a copy of STRING with text properties added.
a1f17501
PJ
3524First argument is the string to copy.
3525Remaining arguments form a sequence of PROPERTY VALUE pairs for text
4bfbe194
MB
3526properties to add to the result.
3527usage: (propertize STRING &rest PROPERTIES) */)
f66c7cf8 3528 (ptrdiff_t nargs, Lisp_Object *args)
2d9811c4
GM
3529{
3530 Lisp_Object properties, string;
3531 struct gcpro gcpro1, gcpro2;
f66c7cf8 3532 ptrdiff_t i;
2d9811c4
GM
3533
3534 /* Number of args must be odd. */
c5101a77 3535 if ((nargs & 1) == 0)
2d9811c4
GM
3536 error ("Wrong number of arguments");
3537
3538 properties = string = Qnil;
3539 GCPRO2 (properties, string);
34a7a267 3540
2d9811c4 3541 /* First argument must be a string. */
b7826503 3542 CHECK_STRING (args[0]);
2d9811c4
GM
3543 string = Fcopy_sequence (args[0]);
3544
3545 for (i = 1; i < nargs; i += 2)
9b7a2369 3546 properties = Fcons (args[i], Fcons (args[i + 1], properties));
2d9811c4
GM
3547
3548 Fadd_text_properties (make_number (0),
d5db4077 3549 make_number (SCHARS (string)),
2d9811c4
GM
3550 properties, string);
3551 RETURN_UNGCPRO (string);
3552}
3553
a7ca3326 3554DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
867b9600
JL
3555 doc: /* Format a string out of a format-string and arguments.
3556The first argument is a format control string.
a1f17501 3557The other arguments are substituted into it to make the result, a string.
575b782f
CY
3558
3559The format control string may contain %-sequences meaning to substitute
3560the next available argument:
3561
a1f17501
PJ
3562%s means print a string argument. Actually, prints any object, with `princ'.
3563%d means print as number in decimal (%o octal, %x hex).
3564%X is like %x, but uses upper case.
3565%e means print a number in exponential notation.
3566%f means print a number in decimal-point notation.
3567%g means print a number in exponential notation
3568 or decimal-point notation, whichever uses fewer characters.
3569%c means print a number as a single character.
3570%S means print any object as an s-expression (using `prin1').
575b782f
CY
3571
3572The argument used for %d, %o, %x, %e, %f, %g or %c must be a number.
4bfbe194
MB
3573Use %% to put a single % into the output.
3574
575b782f
CY
3575A %-sequence may contain optional flag, width, and precision
3576specifiers, as follows:
3577
3578 %<flags><width><precision>character
3579
3580where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
3581
3582The + flag character inserts a + before any positive number, while a
3583space inserts a space before any positive number; these flags only
3584affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
3585The # flag means to use an alternate display form for %o, %x, %X, %e,
3586%f, and %g sequences. The - and 0 flags affect the width specifier,
3587as described below.
3588
3589The width specifier supplies a lower limit for the length of the
3590printed representation. The padding, if any, normally goes on the
3591left, but it goes on the right if the - flag is present. The padding
3592character is normally a space, but it is 0 if the 0 flag is present.
a9ab721e
LMI
3593The 0 flag is ignored if the - flag is present, or the format sequence
3594is something other than %d, %e, %f, and %g.
575b782f
CY
3595
3596For %e, %f, and %g sequences, the number after the "." in the
3597precision specifier says how many decimal places to show; if zero, the
3598decimal point itself is omitted. For %s and %S, the precision
3599specifier truncates the string to the given width.
f555f8cf 3600
4bfbe194 3601usage: (format STRING &rest OBJECTS) */)
f66c7cf8 3602 (ptrdiff_t nargs, Lisp_Object *args)
35692fe0 3603{
f66c7cf8 3604 ptrdiff_t n; /* The number of the next arg to substitute */
37910ab2
PE
3605 char initial_buffer[4000];
3606 char *buf = initial_buffer;
d311d28c
PE
3607 ptrdiff_t bufsize = sizeof initial_buffer;
3608 ptrdiff_t max_bufsize = STRING_BYTES_BOUND + 1;
37910ab2
PE
3609 char *p;
3610 Lisp_Object buf_save_value IF_LINT (= {0});
e7f8264d 3611 register char *format, *end, *format_start;
d311d28c 3612 ptrdiff_t formatlen, nchars;
37910ab2
PE
3613 /* Nonzero if the format is multibyte. */
3614 int multibyte_format = 0;
1f24f4fd
RS
3615 /* Nonzero if the output should be a multibyte string,
3616 which is true if any of the inputs is one. */
3617 int multibyte = 0;
8f2917e4
KH
3618 /* When we make a multibyte string, we must pay attention to the
3619 byte combining problem, i.e., a byte may be combined with a
3b59c351 3620 multibyte character of the previous string. This flag tells if we
8f2917e4
KH
3621 must consider such a situation or not. */
3622 int maybe_combine_byte;
8d6179dc 3623 Lisp_Object val;
d147ee84 3624 int arg_intervals = 0;
7e2c051b 3625 USE_SAFE_ALLOCA;
d147ee84
RS
3626
3627 /* discarded[I] is 1 if byte I of the format
3628 string was not copied into the output.
3629 It is 2 if byte I was not the first byte of its character. */
37910ab2 3630 char *discarded;
d147ee84
RS
3631
3632 /* Each element records, for one argument,
3633 the start and end bytepos in the output string,
37910ab2 3634 whether the argument has been converted to string (e.g., due to "%S"),
d147ee84
RS
3635 and whether the argument is a string with intervals.
3636 info[0] is unused. Unused elements have -1 for start. */
5e6d5493
GM
3637 struct info
3638 {
d311d28c 3639 ptrdiff_t start, end;
37910ab2
PE
3640 int converted_to_string;
3641 int intervals;
5e6d5493 3642 } *info = 0;
1f24f4fd 3643
35692fe0
JB
3644 /* It should not be necessary to GCPRO ARGS, because
3645 the caller in the interpreter should take care of that. */
3646
37910ab2
PE
3647 CHECK_STRING (args[0]);
3648 format_start = SSDATA (args[0]);
3649 formatlen = SBYTES (args[0]);
3650
3651 /* Allocate the info and discarded tables. */
3652 {
f66c7cf8 3653 ptrdiff_t i;
37910ab2 3654 if ((SIZE_MAX - formatlen) / sizeof (struct info) <= nargs)
531b0165 3655 memory_full (SIZE_MAX);
37910ab2
PE
3656 SAFE_ALLOCA (info, struct info *, (nargs + 1) * sizeof *info + formatlen);
3657 discarded = (char *) &info[nargs + 1];
3658 for (i = 0; i < nargs + 1; i++)
3659 {
3660 info[i].start = -1;
3661 info[i].intervals = info[i].converted_to_string = 0;
3662 }
3663 memset (discarded, 0, formatlen);
3664 }
3665
e781c49e
RS
3666 /* Try to determine whether the result should be multibyte.
3667 This is not always right; sometimes the result needs to be multibyte
3668 because of an object that we will pass through prin1,
3669 and in that case, we won't know it here. */
37910ab2
PE
3670 multibyte_format = STRING_MULTIBYTE (args[0]);
3671 multibyte = multibyte_format;
3672 for (n = 1; !multibyte && n < nargs; n++)
3673 if (STRINGP (args[n]) && STRING_MULTIBYTE (args[n]))
3674 multibyte = 1;
67965a98 3675
e781c49e 3676 /* If we start out planning a unibyte result,
37910ab2 3677 then discover it has to be multibyte, we jump back to retry. */
e781c49e
RS
3678 retry:
3679
37910ab2
PE
3680 p = buf;
3681 nchars = 0;
3682 n = 0;
d147ee84 3683
37910ab2
PE
3684 /* Scan the format and store result in BUF. */
3685 format = format_start;
3686 end = format + formatlen;
3687 maybe_combine_byte = 0;
35692fe0 3688
35692fe0 3689 while (format != end)
37910ab2
PE
3690 {
3691 /* The values of N and FORMAT when the loop body is entered. */
f66c7cf8 3692 ptrdiff_t n0 = n;
37910ab2 3693 char *format0 = format;
35692fe0 3694
37910ab2 3695 /* Bytes needed to represent the output of this conversion. */
d311d28c 3696 ptrdiff_t convbytes;
537dfb13 3697
37910ab2
PE
3698 if (*format == '%')
3699 {
3700 /* General format specifications look like
a432bfe5 3701
37910ab2 3702 '%' [flags] [field-width] [precision] format
a432bfe5 3703
37910ab2 3704 where
a432bfe5 3705
37910ab2
PE
3706 flags ::= [-+0# ]+
3707 field-width ::= [0-9]+
3708 precision ::= '.' [0-9]*
a432bfe5 3709
37910ab2
PE
3710 If a field-width is specified, it specifies to which width
3711 the output should be padded with blanks, if the output
3712 string is shorter than field-width.
a432bfe5 3713
37910ab2
PE
3714 If precision is specified, it specifies the number of
3715 digits to print after the '.' for floats, or the max.
3716 number of chars to print from a string. */
a432bfe5 3717
37910ab2
PE
3718 int minus_flag = 0;
3719 int plus_flag = 0;
3720 int space_flag = 0;
3721 int sharp_flag = 0;
3722 int zero_flag = 0;
d311d28c 3723 ptrdiff_t field_width;
37910ab2
PE
3724 int precision_given;
3725 uintmax_t precision = UINTMAX_MAX;
3726 char *num_end;
3727 char conversion;
a432bfe5 3728
37910ab2
PE
3729 while (1)
3730 {
3731 switch (*++format)
3732 {
3733 case '-': minus_flag = 1; continue;
3734 case '+': plus_flag = 1; continue;
3735 case ' ': space_flag = 1; continue;
3736 case '#': sharp_flag = 1; continue;
3737 case '0': zero_flag = 1; continue;
3738 }
3739 break;
3740 }
35692fe0 3741
37910ab2
PE
3742 /* Ignore flags when sprintf ignores them. */
3743 space_flag &= ~ plus_flag;
3744 zero_flag &= ~ minus_flag;
1f24f4fd 3745
35692fe0 3746 {
37910ab2
PE
3747 uintmax_t w = strtoumax (format, &num_end, 10);
3748 if (max_bufsize <= w)
3749 string_overflow ();
3750 field_width = w;
35692fe0 3751 }
37910ab2
PE
3752 precision_given = *num_end == '.';
3753 if (precision_given)
3754 precision = strtoumax (num_end + 1, &num_end, 10);
3755 format = num_end;
3756
3757 if (format == end)
3758 error ("Format string ends in middle of format specifier");
3759
3760 memset (&discarded[format0 - format_start], 1, format - format0);
3761 conversion = *format;
3762 if (conversion == '%')
7812ba2d 3763 goto copy_char;
d147ee84 3764 discarded[format - format_start] = 1;
1f24f4fd 3765 format++;
fb893977 3766
37910ab2
PE
3767 ++n;
3768 if (! (n < nargs))
3769 error ("Not enough arguments for format string");
3770
3771 /* For 'S', prin1 the argument, and then treat like 's'.
3772 For 's', princ any argument that is not a string or
3773 symbol. But don't do this conversion twice, which might
3774 happen after retrying. */
3775 if ((conversion == 'S'
3776 || (conversion == 's'
3777 && ! STRINGP (args[n]) && ! SYMBOLP (args[n]))))
f555f8cf 3778 {
37910ab2 3779 if (! info[n].converted_to_string)
f555f8cf 3780 {
37910ab2
PE
3781 Lisp_Object noescape = conversion == 'S' ? Qnil : Qt;
3782 args[n] = Fprin1_to_string (args[n], noescape);
3783 info[n].converted_to_string = 1;
3784 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3785 {
3786 multibyte = 1;
3787 goto retry;
3788 }
f555f8cf 3789 }
37910ab2 3790 conversion = 's';
f555f8cf 3791 }
37910ab2
PE
3792 else if (conversion == 'c')
3793 {
3794 if (FLOATP (args[n]))
3795 {
3796 double d = XFLOAT_DATA (args[n]);
3797 args[n] = make_number (FIXNUM_OVERFLOW_P (d) ? -1 : d);
3798 }
f555f8cf 3799
37910ab2
PE
3800 if (INTEGERP (args[n]) && ! ASCII_CHAR_P (XINT (args[n])))
3801 {
3802 if (!multibyte)
3803 {
3804 multibyte = 1;
3805 goto retry;
3806 }
3807 args[n] = Fchar_to_string (args[n]);
3808 info[n].converted_to_string = 1;
3809 }
f555f8cf 3810
37910ab2
PE
3811 if (info[n].converted_to_string)
3812 conversion = 's';
3813 zero_flag = 0;
d147ee84 3814 }
35692fe0 3815
37910ab2 3816 if (SYMBOLP (args[n]))
1f24f4fd 3817 {
37910ab2
PE
3818 args[n] = SYMBOL_NAME (args[n]);
3819 if (STRING_MULTIBYTE (args[n]) && ! multibyte)
3820 {
3821 multibyte = 1;
3822 goto retry;
3823 }
1f24f4fd
RS
3824 }
3825
37910ab2 3826 if (conversion == 's')
1f24f4fd 3827 {
ac42d7b9
KG
3828 /* handle case (precision[n] >= 0) */
3829
d311d28c
PE
3830 ptrdiff_t width, padding, nbytes;
3831 ptrdiff_t nchars_string;
ac42d7b9 3832
d311d28c
PE
3833 ptrdiff_t prec = -1;
3834 if (precision_given && precision <= TYPE_MAXIMUM (ptrdiff_t))
37910ab2
PE
3835 prec = precision;
3836
ac42d7b9
KG
3837 /* lisp_string_width ignores a precision of 0, but GNU
3838 libc functions print 0 characters when the precision
3839 is 0. Imitate libc behavior here. Changing
3840 lisp_string_width is the right thing, and will be
3841 done, but meanwhile we work with it. */
3842
37910ab2 3843 if (prec == 0)
ac42d7b9 3844 width = nchars_string = nbytes = 0;
ac42d7b9 3845 else
37910ab2 3846 {
d311d28c 3847 ptrdiff_t nch, nby;
37910ab2
PE
3848 width = lisp_string_width (args[n], prec, &nch, &nby);
3849 if (prec < 0)
3850 {
3851 nchars_string = SCHARS (args[n]);
3852 nbytes = SBYTES (args[n]);
3853 }
3854 else
3855 {
3856 nchars_string = nch;
3857 nbytes = nby;
3858 }
ac42d7b9 3859 }
25c9e7fb 3860
37910ab2
PE
3861 convbytes = nbytes;
3862 if (convbytes && multibyte && ! STRING_MULTIBYTE (args[n]))
3863 convbytes = count_size_as_multibyte (SDATA (args[n]), nbytes);
1f24f4fd 3864
37910ab2 3865 padding = width < field_width ? field_width - width : 0;
ac42d7b9 3866
37910ab2
PE
3867 if (max_bufsize - padding <= convbytes)
3868 string_overflow ();
3869 convbytes += padding;
3870 if (convbytes <= buf + bufsize - p)
3871 {
3872 if (! minus_flag)
3873 {
3874 memset (p, ' ', padding);
3875 p += padding;
3876 nchars += padding;
3877 }
ac42d7b9 3878
37910ab2
PE
3879 if (p > buf
3880 && multibyte
3881 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
3882 && STRING_MULTIBYTE (args[n])
3883 && !CHAR_HEAD_P (SREF (args[n], 0)))
3884 maybe_combine_byte = 1;
1f24f4fd 3885
37910ab2
PE
3886 p += copy_text (SDATA (args[n]), (unsigned char *) p,
3887 nbytes,
3888 STRING_MULTIBYTE (args[n]), multibyte);
8f2c9ed8 3889
37910ab2
PE
3890 info[n].start = nchars;
3891 nchars += nchars_string;
3892 info[n].end = nchars;
3893
3894 if (minus_flag)
3895 {
3896 memset (p, ' ', padding);
3897 p += padding;
3898 nchars += padding;
3899 }
5e6d5493 3900
37910ab2
PE
3901 /* If this argument has text properties, record where
3902 in the result string it appears. */
3903 if (STRING_INTERVALS (args[n]))
3904 info[n].intervals = arg_intervals = 1;
3905
3906 continue;
3907 }
1f24f4fd 3908 }
37910ab2
PE
3909 else if (! (conversion == 'c' || conversion == 'd'
3910 || conversion == 'e' || conversion == 'f'
3911 || conversion == 'g' || conversion == 'i'
3912 || conversion == 'o' || conversion == 'x'
3913 || conversion == 'X'))
3914 error ("Invalid format operation %%%c",
3915 STRING_CHAR ((unsigned char *) format - 1));
3916 else if (! (INTEGERP (args[n]) || FLOATP (args[n])))
3917 error ("Format specifier doesn't match argument type");
3918 else
1f24f4fd 3919 {
37910ab2
PE
3920 enum
3921 {
3922 /* Maximum precision for a %f conversion such that the
333f9019 3923 trailing output digit might be nonzero. Any precision
37910ab2
PE
3924 larger than this will not yield useful information. */
3925 USEFUL_PRECISION_MAX =
3926 ((1 - DBL_MIN_EXP)
3927 * (FLT_RADIX == 2 || FLT_RADIX == 10 ? 1
3928 : FLT_RADIX == 16 ? 4
3929 : -1)),
3930
3931 /* Maximum number of bytes generated by any format, if
81f7c12e 3932 precision is no more than USEFUL_PRECISION_MAX.
37910ab2
PE
3933 On all practical hosts, %f is the worst case. */
3934 SPRINTF_BUFSIZE =
a81d11a3
PE
3935 sizeof "-." + (DBL_MAX_10_EXP + 1) + USEFUL_PRECISION_MAX,
3936
3937 /* Length of pM (that is, of pMd without the
3938 trailing "d"). */
3939 pMlen = sizeof pMd - 2
37910ab2
PE
3940 };
3941 verify (0 < USEFUL_PRECISION_MAX);
3942
3943 int prec;
d311d28c 3944 ptrdiff_t padding, sprintf_bytes;
37910ab2
PE
3945 uintmax_t excess_precision, numwidth;
3946 uintmax_t leading_zeros = 0, trailing_zeros = 0;
3947
3948 char sprintf_buf[SPRINTF_BUFSIZE];
3949
3950 /* Copy of conversion specification, modified somewhat.
3951 At most three flags F can be specified at once. */
a81d11a3 3952 char convspec[sizeof "%FFF.*d" + pMlen];
37910ab2
PE
3953
3954 /* Avoid undefined behavior in underlying sprintf. */
3955 if (conversion == 'd' || conversion == 'i')
3956 sharp_flag = 0;
3957
3958 /* Create the copy of the conversion specification, with
3959 any width and precision removed, with ".*" inserted,
a81d11a3 3960 and with pM inserted for integer formats. */
37910ab2
PE
3961 {
3962 char *f = convspec;
3963 *f++ = '%';
3964 *f = '-'; f += minus_flag;
3965 *f = '+'; f += plus_flag;
3966 *f = ' '; f += space_flag;
3967 *f = '#'; f += sharp_flag;
3968 *f = '0'; f += zero_flag;
3969 *f++ = '.';
3970 *f++ = '*';
3971 if (conversion == 'd' || conversion == 'i'
3972 || conversion == 'o' || conversion == 'x'
3973 || conversion == 'X')
3974 {
a81d11a3
PE
3975 memcpy (f, pMd, pMlen);
3976 f += pMlen;
37910ab2
PE
3977 zero_flag &= ~ precision_given;
3978 }
3979 *f++ = conversion;
3980 *f = '\0';
3981 }
1f24f4fd 3982
37910ab2
PE
3983 prec = -1;
3984 if (precision_given)
3985 prec = min (precision, USEFUL_PRECISION_MAX);
3986
3987 /* Use sprintf to format this number into sprintf_buf. Omit
3988 padding and excess precision, though, because sprintf limits
3989 output length to INT_MAX.
3990
3991 There are four types of conversion: double, unsigned
3992 char (passed as int), wide signed int, and wide
3993 unsigned int. Treat them separately because the
3994 sprintf ABI is sensitive to which type is passed. Be
3995 careful about integer overflow, NaNs, infinities, and
3996 conversions; for example, the min and max macros are
3997 not suitable here. */
3998 if (conversion == 'e' || conversion == 'f' || conversion == 'g')
3999 {
4000 double x = (INTEGERP (args[n])
4001 ? XINT (args[n])
4002 : XFLOAT_DATA (args[n]));
4003 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4004 }
4005 else if (conversion == 'c')
4006 {
4007 /* Don't use sprintf here, as it might mishandle prec. */
4008 sprintf_buf[0] = XINT (args[n]);
4009 sprintf_bytes = prec != 0;
4010 }
4011 else if (conversion == 'd')
4012 {
4013 /* For float, maybe we should use "%1.0f"
4014 instead so it also works for values outside
4015 the integer range. */
a81d11a3 4016 printmax_t x;
37910ab2
PE
4017 if (INTEGERP (args[n]))
4018 x = XINT (args[n]);
4019 else
4020 {
4021 double d = XFLOAT_DATA (args[n]);
4022 if (d < 0)
4023 {
a81d11a3 4024 x = TYPE_MINIMUM (printmax_t);
37910ab2
PE
4025 if (x < d)
4026 x = d;
4027 }
4028 else
4029 {
a81d11a3 4030 x = TYPE_MAXIMUM (printmax_t);
37910ab2
PE
4031 if (d < x)
4032 x = d;
4033 }
4034 }
4035 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4036 }
0f860bd7 4037 else
de92d4d4 4038 {
37910ab2 4039 /* Don't sign-extend for octal or hex printing. */
a81d11a3 4040 uprintmax_t x;
37910ab2
PE
4041 if (INTEGERP (args[n]))
4042 x = XUINT (args[n]);
4043 else
0f860bd7 4044 {
37910ab2
PE
4045 double d = XFLOAT_DATA (args[n]);
4046 if (d < 0)
4047 x = 0;
4048 else
4049 {
a81d11a3 4050 x = TYPE_MAXIMUM (uprintmax_t);
37910ab2
PE
4051 if (d < x)
4052 x = d;
4053 }
0f860bd7 4054 }
37910ab2
PE
4055 sprintf_bytes = sprintf (sprintf_buf, convspec, prec, x);
4056 }
0f860bd7 4057
37910ab2
PE
4058 /* Now the length of the formatted item is known, except it omits
4059 padding and excess precision. Deal with excess precision
4060 first. This happens only when the format specifies
4061 ridiculously large precision. */
4062 excess_precision = precision - prec;
4063 if (excess_precision)
4064 {
4065 if (conversion == 'e' || conversion == 'f'
4066 || conversion == 'g')
ff6e6ac8 4067 {
37910ab2
PE
4068 if ((conversion == 'g' && ! sharp_flag)
4069 || ! ('0' <= sprintf_buf[sprintf_bytes - 1]
4070 && sprintf_buf[sprintf_bytes - 1] <= '9'))
4071 excess_precision = 0;
ff6e6ac8 4072 else
37910ab2
PE
4073 {
4074 if (conversion == 'g')
4075 {
4076 char *dot = strchr (sprintf_buf, '.');
4077 if (!dot)
4078 excess_precision = 0;
4079 }
4080 }
4081 trailing_zeros = excess_precision;
ff6e6ac8 4082 }
de92d4d4 4083 else
37910ab2 4084 leading_zeros = excess_precision;
de92d4d4 4085 }
1f24f4fd 4086
37910ab2
PE
4087 /* Compute the total bytes needed for this item, including
4088 excess precision and padding. */
4089 numwidth = sprintf_bytes + excess_precision;
4090 padding = numwidth < field_width ? field_width - numwidth : 0;
4091 if (max_bufsize - sprintf_bytes <= excess_precision
4092 || max_bufsize - padding <= numwidth)
4093 string_overflow ();
4094 convbytes = numwidth + padding;
4095
4096 if (convbytes <= buf + bufsize - p)
4097 {
4098 /* Copy the formatted item from sprintf_buf into buf,
4099 inserting padding and excess-precision zeros. */
4100
4101 char *src = sprintf_buf;
4102 char src0 = src[0];
4103 int exponent_bytes = 0;
4104 int signedp = src0 == '-' || src0 == '+' || src0 == ' ';
4105 int significand_bytes;
172418ad
AS
4106 if (zero_flag
4107 && ((src[signedp] >= '0' && src[signedp] <= '9')
4108 || (src[signedp] >= 'a' && src[signedp] <= 'f')
4109 || (src[signedp] >= 'A' && src[signedp] <= 'F')))
37910ab2
PE
4110 {
4111 leading_zeros += padding;
4112 padding = 0;
4113 }
4114
4115 if (excess_precision
4116 && (conversion == 'e' || conversion == 'g'))
4117 {
4118 char *e = strchr (src, 'e');
4119 if (e)
4120 exponent_bytes = src + sprintf_bytes - e;
4121 }
4122
4123 if (! minus_flag)
4124 {
4125 memset (p, ' ', padding);
4126 p += padding;
4127 nchars += padding;
4128 }
4129
4130 *p = src0;
4131 src += signedp;
4132 p += signedp;
4133 memset (p, '0', leading_zeros);
4134 p += leading_zeros;
4135 significand_bytes = sprintf_bytes - signedp - exponent_bytes;
4136 memcpy (p, src, significand_bytes);
4137 p += significand_bytes;
4138 src += significand_bytes;
4139 memset (p, '0', trailing_zeros);
4140 p += trailing_zeros;
4141 memcpy (p, src, exponent_bytes);
4142 p += exponent_bytes;
4143
4144 info[n].start = nchars;
4145 nchars += leading_zeros + sprintf_bytes + trailing_zeros;
4146 info[n].end = nchars;
4147
4148 if (minus_flag)
4149 {
4150 memset (p, ' ', padding);
4151 p += padding;
4152 nchars += padding;
4153 }
4154
4155 continue;
4156 }
4157 }
4158 }
4159 else
4160 copy_char:
4161 {
4162 /* Copy a single character from format to buf. */
4163
4164 char *src = format;
4165 unsigned char str[MAX_MULTIBYTE_LENGTH];
4166
4167 if (multibyte_format)
4168 {
4169 /* Copy a whole multibyte character. */
8f2917e4 4170 if (p > buf
25aa5d64 4171 && !ASCII_BYTE_P (*((unsigned char *) p - 1))
37910ab2 4172 && !CHAR_HEAD_P (*format))
8f2917e4 4173 maybe_combine_byte = 1;
37910ab2
PE
4174
4175 do
4176 format++;
4177 while (! CHAR_HEAD_P (*format));
4178
a02719a3 4179 convbytes = format - src;
7812ba2d 4180 memset (&discarded[src + 1 - format_start], 2, convbytes - 1);
37910ab2
PE
4181 }
4182 else
4183 {
4184 unsigned char uc = *format++;
4185 if (! multibyte || ASCII_BYTE_P (uc))
4186 convbytes = 1;
9a599130 4187 else
37910ab2
PE
4188 {
4189 int c = BYTE8_TO_CHAR (uc);
4190 convbytes = CHAR_STRING (c, str);
4191 src = (char *) str;
4192 }
1f24f4fd 4193 }
d147ee84 4194
37910ab2 4195 if (convbytes <= buf + bufsize - p)
d147ee84 4196 {
37910ab2
PE
4197 memcpy (p, src, convbytes);
4198 p += convbytes;
4199 nchars++;
4200 continue;
d147ee84 4201 }
7df74da6 4202 }
1f24f4fd 4203
37910ab2
PE
4204 /* There wasn't enough room to store this conversion or single
4205 character. CONVBYTES says how much room is needed. Allocate
4206 enough room (and then some) and do it again. */
4207 {
c9f8d652 4208 ptrdiff_t used = p - buf;
37910ab2
PE
4209
4210 if (max_bufsize - used < convbytes)
4211 string_overflow ();
4212 bufsize = used + convbytes;
4213 bufsize = bufsize < max_bufsize / 2 ? bufsize * 2 : max_bufsize;
4214
4215 if (buf == initial_buffer)
4216 {
4217 buf = xmalloc (bufsize);
4218 sa_must_free = 1;
4219 buf_save_value = make_save_value (buf, 0);
4220 record_unwind_protect (safe_alloca_unwind, buf_save_value);
4221 memcpy (buf, initial_buffer, used);
4222 }
4223 else
4224 XSAVE_VALUE (buf_save_value)->pointer = buf = xrealloc (buf, bufsize);
4225
4226 p = buf + used;
4227 }
4228
4229 format = format0;
4230 n = n0;
1f24f4fd
RS
4231 }
4232
37910ab2 4233 if (bufsize < p - buf)
a432bfe5
GM
4234 abort ();
4235
8f2917e4 4236 if (maybe_combine_byte)
e7f8264d 4237 nchars = multibyte_chars_in_text ((unsigned char *) buf, p - buf);
5f75e666 4238 val = make_specified_string (buf, nchars, p - buf, multibyte);
8d6179dc 4239
1f24f4fd 4240 /* If we allocated BUF with malloc, free it too. */
e65837df 4241 SAFE_FREE ();
35692fe0 4242
5e6d5493
GM
4243 /* If the format string has text properties, or any of the string
4244 arguments has text properties, set up text properties of the
4245 result string. */
34a7a267 4246
d147ee84 4247 if (STRING_INTERVALS (args[0]) || arg_intervals)
5e6d5493
GM
4248 {
4249 Lisp_Object len, new_len, props;
4250 struct gcpro gcpro1;
34a7a267 4251
5e6d5493 4252 /* Add text properties from the format string. */
d5db4077 4253 len = make_number (SCHARS (args[0]));
5e6d5493
GM
4254 props = text_property_list (args[0], make_number (0), len, Qnil);
4255 GCPRO1 (props);
34a7a267 4256
5e6d5493
GM
4257 if (CONSP (props))
4258 {
d311d28c
PE
4259 ptrdiff_t bytepos = 0, position = 0, translated = 0;
4260 ptrdiff_t argn = 1;
d147ee84
RS
4261 Lisp_Object list;
4262
4263 /* Adjust the bounds of each text property
4264 to the proper start and end in the output string. */
d147ee84 4265
15fad037
KS
4266 /* Put the positions in PROPS in increasing order, so that
4267 we can do (effectively) one scan through the position
4268 space of the format string. */
4269 props = Fnreverse (props);
4270
4271 /* BYTEPOS is the byte position in the format string,
d147ee84
RS
4272 POSITION is the untranslated char position in it,
4273 TRANSLATED is the translated char position in BUF,
4274 and ARGN is the number of the next arg we will come to. */
4275 for (list = props; CONSP (list); list = XCDR (list))
4276 {
f3ce1df8 4277 Lisp_Object item;
d311d28c 4278 ptrdiff_t pos;
d147ee84
RS
4279
4280 item = XCAR (list);
4281
4282 /* First adjust the property start position. */
4283 pos = XINT (XCAR (item));
4284
4285 /* Advance BYTEPOS, POSITION, TRANSLATED and ARGN
4286 up to this position. */
4287 for (; position < pos; bytepos++)
4288 {
4289 if (! discarded[bytepos])
4290 position++, translated++;
4291 else if (discarded[bytepos] == 1)
4292 {
4293 position++;
4294 if (translated == info[argn].start)
4295 {
4296 translated += info[argn].end - info[argn].start;
4297 argn++;
4298 }
4299 }
4300 }
4301
4302 XSETCAR (item, make_number (translated));
4303
4304 /* Likewise adjust the property end position. */
4305 pos = XINT (XCAR (XCDR (item)));
4306
d40ec4a0 4307 for (; position < pos; bytepos++)
d147ee84
RS
4308 {
4309 if (! discarded[bytepos])
4310 position++, translated++;
4311 else if (discarded[bytepos] == 1)
4312 {
4313 position++;
4314 if (translated == info[argn].start)
4315 {
4316 translated += info[argn].end - info[argn].start;
4317 argn++;
4318 }
4319 }
4320 }
4321
4322 XSETCAR (XCDR (item), make_number (translated));
4323 }
4324
5e6d5493
GM
4325 add_text_properties_from_list (val, props, make_number (0));
4326 }
4327
4328 /* Add text properties from arguments. */
d147ee84 4329 if (arg_intervals)
5e6d5493 4330 for (n = 1; n < nargs; ++n)
d147ee84 4331 if (info[n].intervals)
5e6d5493 4332 {
d5db4077 4333 len = make_number (SCHARS (args[n]));
5e6d5493
GM
4334 new_len = make_number (info[n].end - info[n].start);
4335 props = text_property_list (args[n], make_number (0), len, Qnil);
e398c61c
CY
4336 props = extend_property_ranges (props, new_len);
4337 /* If successive arguments have properties, be sure that
be17069b
KH
4338 the value of `composition' property be the copy. */
4339 if (n > 1 && info[n - 1].end)
4340 make_composition_value_copy (props);
5e6d5493
GM
4341 add_text_properties_from_list (val, props,
4342 make_number (info[n].start));
4343 }
4344
4345 UNGCPRO;
4346 }
4347
8d6179dc 4348 return val;
35692fe0
JB
4349}
4350
35692fe0 4351Lisp_Object
a8fe7202 4352format2 (const char *string1, Lisp_Object arg0, Lisp_Object arg1)
d40dc1d0
RS
4353{
4354 Lisp_Object args[3];
d40dc1d0
RS
4355 args[0] = build_string (string1);
4356 args[1] = arg0;
4357 args[2] = arg1;
4358 return Fformat (3, args);
35692fe0
JB
4359}
4360\f
4361DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
7ee72033 4362 doc: /* Return t if two characters match, optionally ignoring case.
a1f17501 4363Both arguments must be characters (i.e. integers).
7ee72033 4364Case is ignored if `case-fold-search' is non-nil in the current buffer. */)
5842a27b 4365 (register Lisp_Object c1, Lisp_Object c2)
35692fe0 4366{
1b5d98bb 4367 int i1, i2;
253c3c82 4368 /* Check they're chars, not just integers, otherwise we could get array
5da9919f 4369 bounds violations in downcase. */
253c3c82
SM
4370 CHECK_CHARACTER (c1);
4371 CHECK_CHARACTER (c2);
35692fe0 4372
1b5d98bb 4373 if (XINT (c1) == XINT (c2))
35692fe0 4374 return Qt;
4b4deea2 4375 if (NILP (BVAR (current_buffer, case_fold_search)))
1b5d98bb
RS
4376 return Qnil;
4377
e5112ecb 4378 i1 = XFASTINT (c1);
4b4deea2 4379 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
e5112ecb
KH
4380 && ! ASCII_CHAR_P (i1))
4381 {
4382 MAKE_CHAR_MULTIBYTE (i1);
4383 }
4384 i2 = XFASTINT (c2);
4b4deea2 4385 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
e5112ecb
KH
4386 && ! ASCII_CHAR_P (i2))
4387 {
4388 MAKE_CHAR_MULTIBYTE (i2);
4389 }
0da09c43 4390 return (downcase (i1) == downcase (i2) ? Qt : Qnil);
35692fe0 4391}
b229b8d1
RS
4392\f
4393/* Transpose the markers in two regions of the current buffer, and
4394 adjust the ones between them if necessary (i.e.: if the regions
4395 differ in size).
4396
ec1c14f6
RS
4397 START1, END1 are the character positions of the first region.
4398 START1_BYTE, END1_BYTE are the byte positions.
4399 START2, END2 are the character positions of the second region.
4400 START2_BYTE, END2_BYTE are the byte positions.
4401
b229b8d1
RS
4402 Traverses the entire marker list of the buffer to do so, adding an
4403 appropriate amount to some, subtracting from some, and leaving the
4404 rest untouched. Most of this is copied from adjust_markers in insdel.c.
34a7a267 4405
ec1c14f6 4406 It's the caller's job to ensure that START1 <= END1 <= START2 <= END2. */
b229b8d1 4407
acb7cc89 4408static void
d311d28c
PE
4409transpose_markers (ptrdiff_t start1, ptrdiff_t end1,
4410 ptrdiff_t start2, ptrdiff_t end2,
4411 ptrdiff_t start1_byte, ptrdiff_t end1_byte,
4412 ptrdiff_t start2_byte, ptrdiff_t end2_byte)
b229b8d1 4413{
d311d28c 4414 register ptrdiff_t amt1, amt1_byte, amt2, amt2_byte, diff, diff_byte, mpos;
12038f9f 4415 register struct Lisp_Marker *marker;
b229b8d1 4416
03240d11 4417 /* Update point as if it were a marker. */
8de1d5f0
KH
4418 if (PT < start1)
4419 ;
4420 else if (PT < end1)
ec1c14f6
RS
4421 TEMP_SET_PT_BOTH (PT + (end2 - end1),
4422 PT_BYTE + (end2_byte - end1_byte));
8de1d5f0 4423 else if (PT < start2)
ec1c14f6
RS
4424 TEMP_SET_PT_BOTH (PT + (end2 - start2) - (end1 - start1),
4425 (PT_BYTE + (end2_byte - start2_byte)
4426 - (end1_byte - start1_byte)));
8de1d5f0 4427 else if (PT < end2)
ec1c14f6
RS
4428 TEMP_SET_PT_BOTH (PT - (start2 - start1),
4429 PT_BYTE - (start2_byte - start1_byte));
8de1d5f0 4430
03240d11
KH
4431 /* We used to adjust the endpoints here to account for the gap, but that
4432 isn't good enough. Even if we assume the caller has tried to move the
4433 gap out of our way, it might still be at start1 exactly, for example;
4434 and that places it `inside' the interval, for our purposes. The amount
4435 of adjustment is nontrivial if there's a `denormalized' marker whose
4436 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
4437 the dirty work to Fmarker_position, below. */
b229b8d1
RS
4438
4439 /* The difference between the region's lengths */
4440 diff = (end2 - start2) - (end1 - start1);
ec1c14f6 4441 diff_byte = (end2_byte - start2_byte) - (end1_byte - start1_byte);
34a7a267 4442
b229b8d1 4443 /* For shifting each marker in a region by the length of the other
ec1c14f6 4444 region plus the distance between the regions. */
b229b8d1
RS
4445 amt1 = (end2 - start2) + (start2 - end1);
4446 amt2 = (end1 - start1) + (start2 - end1);
ec1c14f6
RS
4447 amt1_byte = (end2_byte - start2_byte) + (start2_byte - end1_byte);
4448 amt2_byte = (end1_byte - start1_byte) + (start2_byte - end1_byte);
b229b8d1 4449
12038f9f 4450 for (marker = BUF_MARKERS (current_buffer); marker; marker = marker->next)
b229b8d1 4451 {
12038f9f 4452 mpos = marker->bytepos;
ec1c14f6
RS
4453 if (mpos >= start1_byte && mpos < end2_byte)
4454 {
4455 if (mpos < end1_byte)
4456 mpos += amt1_byte;
4457 else if (mpos < start2_byte)
4458 mpos += diff_byte;
4459 else
4460 mpos -= amt2_byte;
12038f9f 4461 marker->bytepos = mpos;
ec1c14f6 4462 }
12038f9f 4463 mpos = marker->charpos;
03240d11
KH
4464 if (mpos >= start1 && mpos < end2)
4465 {
4466 if (mpos < end1)
4467 mpos += amt1;
4468 else if (mpos < start2)
4469 mpos += diff;
4470 else
4471 mpos -= amt2;
03240d11 4472 }
12038f9f 4473 marker->charpos = mpos;
b229b8d1
RS
4474 }
4475}
4476
4477DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
412f1fab 4478 doc: /* Transpose region STARTR1 to ENDR1 with STARTR2 to ENDR2.
27a69fd9 4479The regions should not be overlapping, because the size of the buffer is
a1f17501
PJ
4480never changed in a transposition.
4481
412f1fab 4482Optional fifth arg LEAVE-MARKERS, if non-nil, means don't update
a1f17501
PJ
4483any markers that happen to be located in the regions.
4484
7ee72033 4485Transposing beyond buffer boundaries is an error. */)
5842a27b 4486 (Lisp_Object startr1, Lisp_Object endr1, Lisp_Object startr2, Lisp_Object endr2, Lisp_Object leave_markers)
b229b8d1 4487{
d311d28c
PE
4488 register ptrdiff_t start1, end1, start2, end2;
4489 ptrdiff_t start1_byte, start2_byte, len1_byte, len2_byte;
4490 ptrdiff_t gap, len1, len_mid, len2;
3c6bc7d0 4491 unsigned char *start1_addr, *start2_addr, *temp;
b229b8d1 4492
6cd0f478 4493 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2, tmp_interval3;
916480c4
CY
4494 Lisp_Object buf;
4495
4496 XSETBUFFER (buf, current_buffer);
1e158d25 4497 cur_intv = BUF_INTERVALS (current_buffer);
b229b8d1
RS
4498
4499 validate_region (&startr1, &endr1);
4500 validate_region (&startr2, &endr2);
4501
4502 start1 = XFASTINT (startr1);
4503 end1 = XFASTINT (endr1);
4504 start2 = XFASTINT (startr2);
4505 end2 = XFASTINT (endr2);
4506 gap = GPT;
4507
4508 /* Swap the regions if they're reversed. */
4509 if (start2 < end1)
4510 {
d311d28c 4511 register ptrdiff_t glumph = start1;
b229b8d1
RS
4512 start1 = start2;
4513 start2 = glumph;
4514 glumph = end1;
4515 end1 = end2;
4516 end2 = glumph;
4517 }
4518
b229b8d1
RS
4519 len1 = end1 - start1;
4520 len2 = end2 - start2;
4521
4522 if (start2 < end1)
dc3620af 4523 error ("Transposed regions overlap");
0f4aebc0
LL
4524 /* Nothing to change for adjacent regions with one being empty */
4525 else if ((start1 == end1 || start2 == end2) && end1 == start2)
4526 return Qnil;
b229b8d1
RS
4527
4528 /* The possibilities are:
4529 1. Adjacent (contiguous) regions, or separate but equal regions
4530 (no, really equal, in this case!), or
4531 2. Separate regions of unequal size.
34a7a267 4532
b229b8d1
RS
4533 The worst case is usually No. 2. It means that (aside from
4534 potential need for getting the gap out of the way), there also
4535 needs to be a shifting of the text between the two regions. So
4536 if they are spread far apart, we are that much slower... sigh. */
4537
4538 /* It must be pointed out that the really studly thing to do would
4539 be not to move the gap at all, but to leave it in place and work
4540 around it if necessary. This would be extremely efficient,
4541 especially considering that people are likely to do
4542 transpositions near where they are working interactively, which
4543 is exactly where the gap would be found. However, such code
4544 would be much harder to write and to read. So, if you are
4545 reading this comment and are feeling squirrely, by all means have
4546 a go! I just didn't feel like doing it, so I will simply move
4547 the gap the minimum distance to get it out of the way, and then
4548 deal with an unbroken array. */
3c6bc7d0
RS
4549
4550 /* Make sure the gap won't interfere, by moving it out of the text
4551 we will operate on. */
4552 if (start1 < gap && gap < end2)
4553 {
4554 if (gap - start1 < end2 - gap)
4555 move_gap (start1);
4556 else
4557 move_gap (end2);
4558 }
ec1c14f6
RS
4559
4560 start1_byte = CHAR_TO_BYTE (start1);
4561 start2_byte = CHAR_TO_BYTE (start2);
4562 len1_byte = CHAR_TO_BYTE (end1) - start1_byte;
4563 len2_byte = CHAR_TO_BYTE (end2) - start2_byte;
dc3620af 4564
9a599130 4565#ifdef BYTE_COMBINING_DEBUG
dc3620af
RS
4566 if (end1 == start2)
4567 {
9a599130
KH
4568 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4569 len2_byte, start1, start1_byte)
4570 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4571 len1_byte, end2, start2_byte + len2_byte)
4572 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4573 len1_byte, end2, start2_byte + len2_byte))
4574 abort ();
dc3620af
RS
4575 }
4576 else
4577 {
9a599130
KH
4578 if (count_combining_before (BYTE_POS_ADDR (start2_byte),
4579 len2_byte, start1, start1_byte)
4580 || count_combining_before (BYTE_POS_ADDR (start1_byte),
4581 len1_byte, start2, start2_byte)
4582 || count_combining_after (BYTE_POS_ADDR (start2_byte),
4583 len2_byte, end1, start1_byte + len1_byte)
4584 || count_combining_after (BYTE_POS_ADDR (start1_byte),
4585 len1_byte, end2, start2_byte + len2_byte))
4586 abort ();
dc3620af 4587 }
9a599130 4588#endif
dc3620af 4589
b229b8d1
RS
4590 /* Hmmm... how about checking to see if the gap is large
4591 enough to use as the temporary storage? That would avoid an
4592 allocation... interesting. Later, don't fool with it now. */
4593
4594 /* Working without memmove, for portability (sigh), so must be
4595 careful of overlapping subsections of the array... */
4596
4597 if (end1 == start2) /* adjacent regions */
4598 {
3e145152 4599 modify_region (current_buffer, start1, end2, 0);
b229b8d1
RS
4600 record_change (start1, len1 + len2);
4601
b229b8d1
RS
4602 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4603 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
916480c4
CY
4604 /* Don't use Fset_text_properties: that can cause GC, which can
4605 clobber objects stored in the tmp_intervals. */
6cd0f478
CY
4606 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4607 if (!NULL_INTERVAL_P (tmp_interval3))
4608 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
b229b8d1
RS
4609
4610 /* First region smaller than second. */
ec1c14f6 4611 if (len1_byte < len2_byte)
b229b8d1 4612 {
7e2c051b
KS
4613 USE_SAFE_ALLOCA;
4614
4615 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
03240d11
KH
4616
4617 /* Don't precompute these addresses. We have to compute them
4618 at the last minute, because the relocating allocator might
4619 have moved the buffer around during the xmalloc. */
23017390
KH
4620 start1_addr = BYTE_POS_ADDR (start1_byte);
4621 start2_addr = BYTE_POS_ADDR (start2_byte);
03240d11 4622
72af86bd
AS
4623 memcpy (temp, start2_addr, len2_byte);
4624 memcpy (start1_addr + len2_byte, start1_addr, len1_byte);
4625 memcpy (start1_addr, temp, len2_byte);
e65837df 4626 SAFE_FREE ();
b229b8d1
RS
4627 }
4628 else
4629 /* First region not smaller than second. */
4630 {
7e2c051b
KS
4631 USE_SAFE_ALLOCA;
4632
4633 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
23017390
KH
4634 start1_addr = BYTE_POS_ADDR (start1_byte);
4635 start2_addr = BYTE_POS_ADDR (start2_byte);
72af86bd
AS
4636 memcpy (temp, start1_addr, len1_byte);
4637 memcpy (start1_addr, start2_addr, len2_byte);
4638 memcpy (start1_addr + len2_byte, temp, len1_byte);
e65837df 4639 SAFE_FREE ();
b229b8d1 4640 }
b229b8d1
RS
4641 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
4642 len1, current_buffer, 0);
4643 graft_intervals_into_buffer (tmp_interval2, start1,
4644 len2, current_buffer, 0);
d5c2c403
KH
4645 update_compositions (start1, start1 + len2, CHECK_BORDER);
4646 update_compositions (start1 + len2, end2, CHECK_TAIL);
b229b8d1
RS
4647 }
4648 /* Non-adjacent regions, because end1 != start2, bleagh... */
4649 else
4650 {
ec1c14f6
RS
4651 len_mid = start2_byte - (start1_byte + len1_byte);
4652
4653 if (len1_byte == len2_byte)
b229b8d1
RS
4654 /* Regions are same size, though, how nice. */
4655 {
7e2c051b
KS
4656 USE_SAFE_ALLOCA;
4657
3e145152
CY
4658 modify_region (current_buffer, start1, end1, 0);
4659 modify_region (current_buffer, start2, end2, 0);
b229b8d1
RS
4660 record_change (start1, len1);
4661 record_change (start2, len2);
b229b8d1
RS
4662 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4663 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
6cd0f478
CY
4664
4665 tmp_interval3 = validate_interval_range (buf, &startr1, &endr1, 0);
4666 if (!NULL_INTERVAL_P (tmp_interval3))
4667 set_text_properties_1 (startr1, endr1, Qnil, buf, tmp_interval3);
4668
4669 tmp_interval3 = validate_interval_range (buf, &startr2, &endr2, 0);
4670 if (!NULL_INTERVAL_P (tmp_interval3))
4671 set_text_properties_1 (startr2, endr2, Qnil, buf, tmp_interval3);
b229b8d1 4672
7e2c051b 4673 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
23017390
KH
4674 start1_addr = BYTE_POS_ADDR (start1_byte);
4675 start2_addr = BYTE_POS_ADDR (start2_byte);
72af86bd
AS
4676 memcpy (temp, start1_addr, len1_byte);
4677 memcpy (start1_addr, start2_addr, len2_byte);
4678 memcpy (start2_addr, temp, len1_byte);
e65837df 4679 SAFE_FREE ();
7e2c051b 4680
b229b8d1
RS
4681 graft_intervals_into_buffer (tmp_interval1, start2,
4682 len1, current_buffer, 0);
4683 graft_intervals_into_buffer (tmp_interval2, start1,
4684 len2, current_buffer, 0);
b229b8d1
RS
4685 }
4686
ec1c14f6 4687 else if (len1_byte < len2_byte) /* Second region larger than first */
b229b8d1
RS
4688 /* Non-adjacent & unequal size, area between must also be shifted. */
4689 {
7e2c051b
KS
4690 USE_SAFE_ALLOCA;
4691
3e145152 4692 modify_region (current_buffer, start1, end2, 0);
b229b8d1 4693 record_change (start1, (end2 - start1));
b229b8d1
RS
4694 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4695 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4696 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
6cd0f478
CY
4697
4698 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4699 if (!NULL_INTERVAL_P (tmp_interval3))
4700 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
b229b8d1 4701
3c6bc7d0 4702 /* holds region 2 */
7e2c051b 4703 SAFE_ALLOCA (temp, unsigned char *, len2_byte);
23017390
KH
4704 start1_addr = BYTE_POS_ADDR (start1_byte);
4705 start2_addr = BYTE_POS_ADDR (start2_byte);
72af86bd
AS
4706 memcpy (temp, start2_addr, len2_byte);
4707 memcpy (start1_addr + len_mid + len2_byte, start1_addr, len1_byte);
4708 memmove (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4709 memcpy (start1_addr, temp, len2_byte);
e65837df 4710 SAFE_FREE ();
7e2c051b 4711
b229b8d1
RS
4712 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4713 len1, current_buffer, 0);
4714 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4715 len_mid, current_buffer, 0);
4716 graft_intervals_into_buffer (tmp_interval2, start1,
4717 len2, current_buffer, 0);
b229b8d1
RS
4718 }
4719 else
4720 /* Second region smaller than first. */
4721 {
7e2c051b
KS
4722 USE_SAFE_ALLOCA;
4723
b229b8d1 4724 record_change (start1, (end2 - start1));
3e145152 4725 modify_region (current_buffer, start1, end2, 0);
b229b8d1 4726
b229b8d1
RS
4727 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
4728 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
4729 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
6cd0f478
CY
4730
4731 tmp_interval3 = validate_interval_range (buf, &startr1, &endr2, 0);
4732 if (!NULL_INTERVAL_P (tmp_interval3))
4733 set_text_properties_1 (startr1, endr2, Qnil, buf, tmp_interval3);
b229b8d1 4734
3c6bc7d0 4735 /* holds region 1 */
7e2c051b 4736 SAFE_ALLOCA (temp, unsigned char *, len1_byte);
23017390
KH
4737 start1_addr = BYTE_POS_ADDR (start1_byte);
4738 start2_addr = BYTE_POS_ADDR (start2_byte);
72af86bd
AS
4739 memcpy (temp, start1_addr, len1_byte);
4740 memcpy (start1_addr, start2_addr, len2_byte);
4741 memcpy (start1_addr + len2_byte, start1_addr + len1_byte, len_mid);
4742 memcpy (start1_addr + len2_byte + len_mid, temp, len1_byte);
e65837df 4743 SAFE_FREE ();
7e2c051b 4744
b229b8d1
RS
4745 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
4746 len1, current_buffer, 0);
4747 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
4748 len_mid, current_buffer, 0);
4749 graft_intervals_into_buffer (tmp_interval2, start1,
4750 len2, current_buffer, 0);
b229b8d1 4751 }
d5c2c403
KH
4752
4753 update_compositions (start1, start1 + len2, CHECK_BORDER);
4754 update_compositions (end2 - len1, end2, CHECK_BORDER);
b229b8d1
RS
4755 }
4756
ec1c14f6
RS
4757 /* When doing multiple transpositions, it might be nice
4758 to optimize this. Perhaps the markers in any one buffer
4759 should be organized in some sorted data tree. */
b229b8d1 4760 if (NILP (leave_markers))
8de1d5f0 4761 {
ec1c14f6
RS
4762 transpose_markers (start1, end1, start2, end2,
4763 start1_byte, start1_byte + len1_byte,
4764 start2_byte, start2_byte + len2_byte);
6b61353c 4765 fix_start_end_in_overlays (start1, end2);
8de1d5f0 4766 }
b229b8d1 4767
c10b2810 4768 signal_after_change (start1, end2 - start1, end2 - start1);
b229b8d1
RS
4769 return Qnil;
4770}
35692fe0 4771
35692fe0
JB
4772\f
4773void
971de7fb 4774syms_of_editfns (void)
35692fe0 4775{
260e2e2a 4776 environbuf = 0;
a03fc5a6 4777 initial_tz = 0;
260e2e2a 4778
cd3520a4 4779 DEFSYM (Qbuffer_access_fontify_functions, "buffer-access-fontify-functions");
260e2e2a 4780
29208e82 4781 DEFVAR_LISP ("inhibit-field-text-motion", Vinhibit_field_text_motion,
7dcece14 4782 doc: /* Non-nil means text motion commands don't notice fields. */);
9a74e7e5
GM
4783 Vinhibit_field_text_motion = Qnil;
4784
260e2e2a 4785 DEFVAR_LISP ("buffer-access-fontify-functions",
29208e82 4786 Vbuffer_access_fontify_functions,
7ee72033 4787 doc: /* List of functions called by `buffer-substring' to fontify if necessary.
a1f17501
PJ
4788Each function is called with two arguments which specify the range
4789of the buffer being accessed. */);
260e2e2a
KH
4790 Vbuffer_access_fontify_functions = Qnil;
4791
af209db8
RS
4792 {
4793 Lisp_Object obuf;
af209db8
RS
4794 obuf = Fcurrent_buffer ();
4795 /* Do this here, because init_buffer_once is too early--it won't work. */
4796 Fset_buffer (Vprin1_to_string_buffer);
4797 /* Make sure buffer-access-fontify-functions is nil in this buffer. */
d67b4f80 4798 Fset (Fmake_local_variable (intern_c_string ("buffer-access-fontify-functions")),
af209db8
RS
4799 Qnil);
4800 Fset_buffer (obuf);
4801 }
4802
0b6fd023 4803 DEFVAR_LISP ("buffer-access-fontified-property",
29208e82 4804 Vbuffer_access_fontified_property,
7ee72033 4805 doc: /* Property which (if non-nil) indicates text has been fontified.
a1f17501
PJ
4806`buffer-substring' need not call the `buffer-access-fontify-functions'
4807functions if all the text being accessed has this property. */);
260e2e2a
KH
4808 Vbuffer_access_fontified_property = Qnil;
4809
29208e82 4810 DEFVAR_LISP ("system-name", Vsystem_name,
1a7e0117 4811 doc: /* The host name of the machine Emacs is running on. */);
34a7a267 4812
29208e82 4813 DEFVAR_LISP ("user-full-name", Vuser_full_name,
7ee72033 4814 doc: /* The full name of the user logged in. */);
f43754f6 4815
29208e82 4816 DEFVAR_LISP ("user-login-name", Vuser_login_name,
7ee72033 4817 doc: /* The user's name, taken from environment variables if possible. */);
f43754f6 4818
29208e82 4819 DEFVAR_LISP ("user-real-login-name", Vuser_real_login_name,
7ee72033 4820 doc: /* The user's name, based upon the real uid only. */);
35692fe0 4821
29208e82 4822 DEFVAR_LISP ("operating-system-release", Voperating_system_release,
3bb9abc8
ST
4823 doc: /* The release of the operating system Emacs is running on. */);
4824
0963334d 4825 defsubr (&Spropertize);
35692fe0
JB
4826 defsubr (&Schar_equal);
4827 defsubr (&Sgoto_char);
4828 defsubr (&Sstring_to_char);
4829 defsubr (&Schar_to_string);
c3bb441d 4830 defsubr (&Sbyte_to_string);
35692fe0 4831 defsubr (&Sbuffer_substring);
260e2e2a 4832 defsubr (&Sbuffer_substring_no_properties);
35692fe0
JB
4833 defsubr (&Sbuffer_string);
4834
4835 defsubr (&Spoint_marker);
4836 defsubr (&Smark_marker);
4837 defsubr (&Spoint);
4838 defsubr (&Sregion_beginning);
4839 defsubr (&Sregion_end);
7df74da6 4840
cd3520a4
JB
4841 DEFSYM (Qfield, "field");
4842 DEFSYM (Qboundary, "boundary");
0daf6e8d
GM
4843 defsubr (&Sfield_beginning);
4844 defsubr (&Sfield_end);
4845 defsubr (&Sfield_string);
4846 defsubr (&Sfield_string_no_properties);
8bf64fe8 4847 defsubr (&Sdelete_field);
0daf6e8d
GM
4848 defsubr (&Sconstrain_to_field);
4849
7df74da6
RS
4850 defsubr (&Sline_beginning_position);
4851 defsubr (&Sline_end_position);
4852
35692fe0
JB
4853/* defsubr (&Smark); */
4854/* defsubr (&Sset_mark); */
4855 defsubr (&Ssave_excursion);
4bc8c7d2 4856 defsubr (&Ssave_current_buffer);
35692fe0
JB
4857
4858 defsubr (&Sbufsize);
4859 defsubr (&Spoint_max);
4860 defsubr (&Spoint_min);
4861 defsubr (&Spoint_min_marker);
4862 defsubr (&Spoint_max_marker);
c86212b9
RS
4863 defsubr (&Sgap_position);
4864 defsubr (&Sgap_size);
7df74da6 4865 defsubr (&Sposition_bytes);
3ab0732d 4866 defsubr (&Sbyte_to_position);
c9ed721d 4867
35692fe0
JB
4868 defsubr (&Sbobp);
4869 defsubr (&Seobp);
4870 defsubr (&Sbolp);
4871 defsubr (&Seolp);
850a8179
JB
4872 defsubr (&Sfollowing_char);
4873 defsubr (&Sprevious_char);
35692fe0 4874 defsubr (&Schar_after);
fb8106e8 4875 defsubr (&Schar_before);
35692fe0
JB
4876 defsubr (&Sinsert);
4877 defsubr (&Sinsert_before_markers);
be91036a
RS
4878 defsubr (&Sinsert_and_inherit);
4879 defsubr (&Sinsert_and_inherit_before_markers);
35692fe0 4880 defsubr (&Sinsert_char);
48ef988f 4881 defsubr (&Sinsert_byte);
35692fe0
JB
4882
4883 defsubr (&Suser_login_name);
4884 defsubr (&Suser_real_login_name);
4885 defsubr (&Suser_uid);
4886 defsubr (&Suser_real_uid);
4887 defsubr (&Suser_full_name);
7fd233b3 4888 defsubr (&Semacs_pid);
d940e0e4 4889 defsubr (&Scurrent_time);
4211ee7d 4890 defsubr (&Sget_internal_run_time);
a82d387c 4891 defsubr (&Sformat_time_string);
34a7a267 4892 defsubr (&Sfloat_time);
4691c06d 4893 defsubr (&Sdecode_time);
cce7b8a0 4894 defsubr (&Sencode_time);
35692fe0 4895 defsubr (&Scurrent_time_string);
c2662aea 4896 defsubr (&Scurrent_time_zone);
143cb9a9 4897 defsubr (&Sset_time_zone_rule);
35692fe0 4898 defsubr (&Ssystem_name);
35692fe0 4899 defsubr (&Smessage);
cacc3e2c
RS
4900 defsubr (&Smessage_box);
4901 defsubr (&Smessage_or_box);
b14dda8a 4902 defsubr (&Scurrent_message);
35692fe0 4903 defsubr (&Sformat);
35692fe0
JB
4904
4905 defsubr (&Sinsert_buffer_substring);
e9cf2084 4906 defsubr (&Scompare_buffer_substrings);
35692fe0 4907 defsubr (&Ssubst_char_in_region);
8583605b 4908 defsubr (&Stranslate_region_internal);
35692fe0 4909 defsubr (&Sdelete_region);
7dae4502 4910 defsubr (&Sdelete_and_extract_region);
35692fe0
JB
4911 defsubr (&Swiden);
4912 defsubr (&Snarrow_to_region);
4913 defsubr (&Ssave_restriction);
b229b8d1 4914 defsubr (&Stranspose_regions);
35692fe0 4915}