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