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