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