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