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