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