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