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