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