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