1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985-1987, 1989, 1992-1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
4 Copyright (C) 1996 Ben Wing.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Mule 2.0, FSF 19.30. */
25 /* This file has been Mule-ized. */
27 /* Hacked on for Mule by Ben Wing, December 1994. */
37 #include "events.h" /* for EVENTP */
43 #include "line-number.h"
48 #include "sysfile.h" /* for getcwd */
50 /* Some static data, and a function to initialize it for each run */
52 Lisp_Object Vsystem_name; /* #### - I don't see why this should be */
53 /* static, either... --Stig */
54 #if 0 /* XEmacs - this is now dynamic */
55 /* if at some point it's deemed desirable to
56 use lisp variables here, then they can be
57 initialized to nil and then set to their
58 real values upon the first call to the
59 functions that generate them. --stig */
60 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
61 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER. */
64 /* It's useful to be able to set this as user customization, so we'll
66 Lisp_Object Vuser_full_name;
67 EXFUN (Fuser_full_name, 1);
71 Lisp_Object Qpoint, Qmark, Qregion_beginning, Qregion_end;
73 Lisp_Object Quser_files_and_directories;
75 /* This holds the value of `environ' produced by the previous
76 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
77 has never been called. */
78 static char **environbuf;
83 /* Only used in removed code below. */
88 /* Set up system_name even when dumping. */
96 if ((p = getenv ("NAME")))
97 /* I don't think it's the right thing to do the ampersand
98 modification on NAME. Not that it matters anymore... -hniksic */
99 Vuser_full_name = build_ext_string (p, Qnative);
101 Vuser_full_name = Fuser_full_name (Qnil);
104 DEFUN ("char-to-string", Fchar_to_string, 1, 1, 0, /*
105 Convert arg CH to a one-character string containing that character.
110 Bufbyte str[MAX_EMCHAR_LEN];
114 Lisp_Object ch2 = Fevent_to_character (ch, Qt, Qnil, Qnil);
117 signal_simple_continuable_error
118 ("character has no ASCII equivalent:", Fcopy_event (ch, Qnil));
122 CHECK_CHAR_COERCE_INT (ch);
124 len = set_charptr_emchar (str, XCHAR (ch));
125 return make_string (str, len);
128 DEFUN ("string-to-char", Fstring_to_char, 1, 1, 0, /*
129 Convert arg STRING to a character, the first character of that string.
130 An empty string will return the constant `nil'.
138 if (string_length (p) != 0)
139 return make_char (string_char (p, 0));
141 /* This used to return Qzero. That is broken, broken, broken. */
142 /* It might be kinder to signal an error directly. -slb */
148 buildmark (Bufpos val, Lisp_Object buffer)
150 Lisp_Object mark = Fmake_marker ();
151 Fset_marker (mark, make_int (val), buffer);
155 DEFUN ("point", Fpoint, 0, 1, 0, /*
156 Return value of point, as an integer.
157 Beginning of buffer is position (point-min).
158 If BUFFER is nil, the current buffer is assumed.
162 struct buffer *b = decode_buffer (buffer, 1);
163 return make_int (BUF_PT (b));
166 DEFUN ("point-marker", Fpoint_marker, 0, 2, 0, /*
167 Return value of point, as a marker object.
168 This marker is a copy; you may modify it with reckless abandon.
169 If optional argument DONT-COPY-P is non-nil, then it returns the real
170 point-marker; modifying the position of this marker will move point.
171 It is illegal to change the buffer of it, or make it point nowhere.
172 If BUFFER is nil, the current buffer is assumed.
174 (dont_copy_p, buffer))
176 struct buffer *b = decode_buffer (buffer, 1);
177 if (NILP (dont_copy_p))
178 return Fcopy_marker (b->point_marker, Qnil);
180 return b->point_marker;
183 /* The following two functions end up being identical but it's
184 cleaner to declare them separately. */
187 bufpos_clip_to_bounds (Bufpos lower, Bufpos num, Bufpos upper)
189 return (num < lower ? lower :
190 num > upper ? upper :
195 bytind_clip_to_bounds (Bytind lower, Bytind num, Bytind upper)
197 return (num < lower ? lower :
198 num > upper ? upper :
204 * There is no absolute way to determine if goto-char is the function
205 * being run. this-command doesn't work because it is often eval'd
206 * and this-command ends up set to eval-expression. So this flag gets
209 * Jamie thinks he's wrong, but we'll leave this in for now.
211 int atomic_extent_goto_char_p;
213 DEFUN ("goto-char", Fgoto_char, 1, 2, "NGoto char: ", /*
214 Set point to POSITION, a number or marker.
215 Beginning of buffer is position (point-min), end is (point-max).
216 If BUFFER is nil, the current buffer is assumed.
217 Return value of POSITION, as an integer.
221 struct buffer *b = decode_buffer (buffer, 1);
222 Bufpos n = get_buffer_pos_char (b, position, GB_COERCE_RANGE);
224 atomic_extent_goto_char_p = 1;
229 region_limit (int beginningp, struct buffer *b)
234 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
235 && NILP (b->mark_active))
236 Fsignal (Qmark_inactive, Qnil);
238 m = Fmarker_position (b->mark);
239 if (NILP (m)) error ("There is no region now");
240 if (!!(BUF_PT (b) < XINT (m)) == !!beginningp)
241 return make_int (BUF_PT (b));
246 DEFUN ("region-beginning", Fregion_beginning, 0, 1, 0, /*
247 Return position of beginning of region in BUFFER, as an integer.
248 If BUFFER is nil, the current buffer is assumed.
252 return region_limit (1, decode_buffer (buffer, 1));
255 DEFUN ("region-end", Fregion_end, 0, 1, 0, /*
256 Return position of end of region in BUFFER, as an integer.
257 If BUFFER is nil, the current buffer is assumed.
261 return region_limit (0, decode_buffer (buffer, 1));
264 /* Whether to use lispm-style active-regions */
267 /* Whether the zmacs region is active. This is not per-buffer because
268 there can be only one active region at a time. #### Now that the
269 zmacs region are not directly tied to the X selections this may not
270 necessarily have to be true. */
271 int zmacs_region_active_p;
273 int zmacs_region_stays;
275 Lisp_Object Qzmacs_update_region, Qzmacs_deactivate_region;
276 Lisp_Object Qzmacs_region_buffer;
279 zmacs_update_region (void)
281 /* This function can GC */
282 if (zmacs_region_active_p)
283 call0 (Qzmacs_update_region);
287 zmacs_deactivate_region (void)
289 /* This function can GC */
290 if (zmacs_region_active_p)
291 call0 (Qzmacs_deactivate_region);
295 zmacs_region_buffer (void)
297 if (zmacs_region_active_p)
298 return call0 (Qzmacs_region_buffer);
303 DEFUN ("mark-marker", Fmark_marker, 0, 2, 0, /*
304 Return this buffer's mark, as a marker object.
305 If `zmacs-regions' is true, then this returns nil unless the region is
306 currently in the active (highlighted) state. If optional argument FORCE
307 is t, this returns the mark (if there is one) regardless of the zmacs-region
308 state. You should *generally* not use the mark unless the region is active,
309 if the user has expressed a preference for the zmacs-region model.
310 Watch out! Moving this marker changes the mark position.
311 If you set the marker not to point anywhere, the buffer will have no mark.
312 If BUFFER is nil, the current buffer is assumed.
316 struct buffer *b = decode_buffer (buffer, 1);
317 if (! zmacs_regions || zmacs_region_active_p || !NILP (force))
323 /* The saved object is a cons:
325 (COPY-OF-POINT-MARKER . COPY-OF-MARK)
327 We used to have another cons for a VISIBLE-P element, which was t
328 if `(eq (current-buffer) (window-buffer (selected-window)))' but it
329 was unused for a long time, so I removed it. --hniksic */
331 save_excursion_save (void)
335 /* #### Huh? --hniksic */
336 /*if (preparing_for_armageddon) return Qnil;*/
338 #ifdef ERROR_CHECK_BUFPOS
339 assert (XINT (Fpoint (Qnil)) ==
340 XINT (Fmarker_position (Fpoint_marker (Qt, Qnil))));
345 return noseeum_cons (noseeum_copy_marker (b->point_marker, Qnil),
346 noseeum_copy_marker (b->mark, Qnil));
350 save_excursion_restore (Lisp_Object info)
352 Lisp_Object buffer = Fmarker_buffer (XCAR (info));
354 /* If buffer being returned to is now deleted, avoid error --
355 otherwise could get error here while unwinding to top level and
356 crash. In that case, Fmarker_buffer returns nil now. */
359 struct buffer *buf = XBUFFER (buffer);
362 set_buffer_internal (buf);
363 Fgoto_char (XCAR (info), buffer);
364 Fset_marker (buf->mark, XCDR (info), buffer);
366 #if 0 /* We used to make the current buffer visible in the selected window
367 if that was true previously. That avoids some anomalies.
368 But it creates others, and it wasn't documented, and it is simpler
369 and cleaner never to alter the window/buffer connections. */
370 /* I'm certain some code somewhere depends on this behavior. --jwz */
371 /* Even if it did, it certainly doesn't matter anymore, because
372 this has been the behavior for countless XEmacs releases
375 && (current_buffer != XBUFFER (XWINDOW (selected_window)->buffer)))
376 switch_to_buffer (Fcurrent_buffer (), Qnil);
382 /* Free all the junk we allocated, so that a `save-excursion' comes
383 for free in terms of GC junk. */
384 free_marker (XMARKER (XCAR (info)));
385 free_marker (XMARKER (XCDR (info)));
386 free_cons (XCONS (info));
390 DEFUN ("save-excursion", Fsave_excursion, 0, UNEVALLED, 0, /*
391 Save point, mark, and current buffer; execute BODY; restore those things.
392 Executes BODY just like `progn'.
393 The values of point, mark and the current buffer are restored
394 even in case of abnormal exit (throw or error).
398 /* This function can GC */
399 int speccount = specpdl_depth ();
401 record_unwind_protect (save_excursion_restore, save_excursion_save ());
403 return unbind_to (speccount, Fprogn (args));
407 save_current_buffer_restore (Lisp_Object buffer)
409 struct buffer *buf = XBUFFER (buffer);
410 /* Avoid signaling an error if the buffer is no longer alive. This
411 is for consistency with save-excursion. */
412 if (BUFFER_LIVE_P (buf))
413 set_buffer_internal (buf);
417 DEFUN ("save-current-buffer", Fsave_current_buffer, 0, UNEVALLED, 0, /*
418 Save the current buffer; execute BODY; restore the current buffer.
419 Executes BODY just like `progn'.
423 /* This function can GC */
424 int speccount = specpdl_depth ();
426 record_unwind_protect (save_current_buffer_restore, Fcurrent_buffer ());
428 return unbind_to (speccount, Fprogn (args));
431 DEFUN ("buffer-size", Fbuffer_size, 0, 1, 0, /*
432 Return the number of characters in BUFFER.
433 If BUFFER is nil, the current buffer is assumed.
437 struct buffer *b = decode_buffer (buffer, 1);
438 return make_int (BUF_SIZE (b));
441 DEFUN ("point-min", Fpoint_min, 0, 1, 0, /*
442 Return the minimum permissible value of point in BUFFER.
443 This is 1, unless narrowing (a buffer restriction)
444 is in effect, in which case it may be greater.
445 If BUFFER is nil, the current buffer is assumed.
449 struct buffer *b = decode_buffer (buffer, 1);
450 return make_int (BUF_BEGV (b));
453 DEFUN ("point-min-marker", Fpoint_min_marker, 0, 1, 0, /*
454 Return a marker to the minimum permissible value of point in BUFFER.
455 This is the beginning, unless narrowing (a buffer restriction)
456 is in effect, in which case it may be greater.
457 If BUFFER is nil, the current buffer is assumed.
461 struct buffer *b = decode_buffer (buffer, 1);
462 return buildmark (BUF_BEGV (b), make_buffer (b));
465 DEFUN ("point-max", Fpoint_max, 0, 1, 0, /*
466 Return the maximum permissible value of point in BUFFER.
467 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
468 is in effect, in which case it may be less.
469 If BUFFER is nil, the current buffer is assumed.
473 struct buffer *b = decode_buffer (buffer, 1);
474 return make_int (BUF_ZV (b));
477 DEFUN ("point-max-marker", Fpoint_max_marker, 0, 1, 0, /*
478 Return a marker to the maximum permissible value of point in BUFFER.
479 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
480 is in effect, in which case it may be less.
481 If BUFFER is nil, the current buffer is assumed.
485 struct buffer *b = decode_buffer (buffer, 1);
486 return buildmark (BUF_ZV (b), make_buffer (b));
489 DEFUN ("following-char", Ffollowing_char, 0, 1, 0, /*
490 Return the character following point.
491 At the end of the buffer or accessible region, return 0.
492 If BUFFER is nil, the current buffer is assumed.
496 struct buffer *b = decode_buffer (buffer, 1);
497 if (BUF_PT (b) >= BUF_ZV (b))
498 return Qzero; /* #### Gag me! */
500 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b)));
503 DEFUN ("preceding-char", Fpreceding_char, 0, 1, 0, /*
504 Return the character preceding point.
505 At the beginning of the buffer or accessible region, return 0.
506 If BUFFER is nil, the current buffer is assumed.
510 struct buffer *b = decode_buffer (buffer, 1);
511 if (BUF_PT (b) <= BUF_BEGV (b))
512 return Qzero; /* #### Gag me! */
514 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b) - 1));
517 DEFUN ("bobp", Fbobp, 0, 1, 0, /*
518 Return t if point is at the beginning of the buffer.
519 If the buffer is narrowed, this means the beginning of the narrowed part.
520 If BUFFER is nil, the current buffer is assumed.
524 struct buffer *b = decode_buffer (buffer, 1);
525 return BUF_PT (b) == BUF_BEGV (b) ? Qt : Qnil;
528 DEFUN ("eobp", Feobp, 0, 1, 0, /*
529 Return t if point is at the end of the buffer.
530 If the buffer is narrowed, this means the end of the narrowed part.
531 If BUFFER is nil, the current buffer is assumed.
535 struct buffer *b = decode_buffer (buffer, 1);
536 return BUF_PT (b) == BUF_ZV (b) ? Qt : Qnil;
540 beginning_of_line_p (struct buffer *b, Bufpos pt)
542 return pt <= BUF_BEGV (b) || BUF_FETCH_CHAR (b, pt - 1) == '\n';
546 DEFUN ("bolp", Fbolp, 0, 1, 0, /*
547 Return t if point is at the beginning of a line.
548 If BUFFER is nil, the current buffer is assumed.
552 struct buffer *b = decode_buffer (buffer, 1);
553 return beginning_of_line_p (b, BUF_PT (b)) ? Qt : Qnil;
556 DEFUN ("eolp", Feolp, 0, 1, 0, /*
557 Return t if point is at the end of a line.
558 `End of a line' includes point being at the end of the buffer.
559 If BUFFER is nil, the current buffer is assumed.
563 struct buffer *b = decode_buffer (buffer, 1);
564 return (BUF_PT (b) == BUF_ZV (b) || BUF_FETCH_CHAR (b, BUF_PT (b)) == '\n')
568 DEFUN ("char-after", Fchar_after, 0, 2, 0, /*
569 Return the character at position POS in BUFFER.
570 POS is an integer or a marker.
571 If POS is out of range, the value is nil.
572 if POS is nil, the value of point is assumed.
573 If BUFFER is nil, the current buffer is assumed.
577 struct buffer *b = decode_buffer (buffer, 1);
578 Bufpos n = (NILP (pos) ? BUF_PT (b) :
579 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD));
581 if (n < 0 || n == BUF_ZV (b))
583 return make_char (BUF_FETCH_CHAR (b, n));
586 DEFUN ("char-before", Fchar_before, 0, 2, 0, /*
587 Return the character preceding position POS in BUFFER.
588 POS is an integer or a marker.
589 If POS is out of range, the value is nil.
590 if POS is nil, the value of point is assumed.
591 If BUFFER is nil, the current buffer is assumed.
595 struct buffer *b = decode_buffer (buffer, 1);
596 Bufpos n = (NILP (pos) ? BUF_PT (b) :
597 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD));
601 if (n < BUF_BEGV (b))
603 return make_char (BUF_FETCH_CHAR (b, n));
607 DEFUN ("temp-directory", Ftemp_directory, 0, 0, 0, /*
608 Return the pathname to the directory to use for temporary files.
609 On NT/MSDOS, this is obtained from the TEMP or TMP environment variables,
610 defaulting to / if they are both undefined.
611 On Unix it is obtained from TMPDIR, with /tmp as the default
616 #if defined(WINDOWSNT) || defined(MSDOS)
617 tmpdir = getenv ("TEMP");
619 tmpdir = getenv ("TMP");
622 #else /* WINDOWSNT || MSDOS */
623 tmpdir = getenv ("TMPDIR");
628 return build_ext_string (tmpdir, Qfile_name);
631 DEFUN ("user-login-name", Fuser_login_name, 0, 1, 0, /*
632 Return the name under which the user logged in, as a string.
633 This is based on the effective uid, not the real uid.
634 Also, if the environment variable LOGNAME or USER is set,
635 that determines the value of this function.
636 If the optional argument UID is present, then environment variables are
637 ignored and this function returns the login name for that UID, or nil.
647 local_uid = XINT (uid);
648 returned_name = user_login_name (&local_uid);
652 returned_name = user_login_name (NULL);
654 /* #### - I believe this should return nil instead of "unknown" when pw==0
655 pw=0 is indicated by a null return from user_login_name
657 return returned_name ? build_string (returned_name) : Qnil;
660 /* This function may be called from other C routines when a
661 character string representation of the user_login_name is
662 needed but a Lisp Object is not. The UID is passed by
663 reference. If UID == NULL, then the USER name
664 for the user running XEmacs will be returned. This
665 corresponds to a nil argument to Fuser_login_name.
668 user_login_name (uid_t *uid)
670 /* uid == NULL to return name of this user */
673 struct passwd *pw = getpwuid (*uid);
674 return pw ? pw->pw_name : NULL;
678 /* #### - when euid != uid, then LOGNAME and USER are leftovers from the
679 old environment (I site observed behavior on sunos and linux), so the
680 environment variables should be disregarded in that case. --Stig */
681 char *user_name = getenv ("LOGNAME");
685 "USERNAME" /* it's USERNAME on NT */
694 struct passwd *pw = getpwuid (geteuid ());
696 /* Since the Cygwin environment may not have an /etc/passwd,
697 return "unknown" instead of the null if the username
698 cannot be determined.
700 return pw ? pw->pw_name : "unknown";
702 /* For all but Cygwin return NULL (nil) */
703 return pw ? pw->pw_name : NULL;
709 DEFUN ("user-real-login-name", Fuser_real_login_name, 0, 0, 0, /*
710 Return the name of the user's real uid, as a string.
711 This ignores the environment variables LOGNAME and USER, so it differs from
712 `user-login-name' when running under `su'.
716 struct passwd *pw = getpwuid (getuid ());
717 /* #### - I believe this should return nil instead of "unknown" when pw==0 */
720 /* We let the real user name default to "root" because that's quite
721 accurate on MSDOG and because it lets Emacs find the init file.
722 (The DVX libraries override the Djgpp libraries here.) */
723 Lisp_Object tem = build_string (pw ? pw->pw_name : "root");/* no gettext */
725 Lisp_Object tem = build_string (pw ? pw->pw_name : "unknown");/* no gettext */
730 DEFUN ("user-uid", Fuser_uid, 0, 0, 0, /*
731 Return the effective uid of Emacs, as an integer.
735 return make_int (geteuid ());
738 DEFUN ("user-real-uid", Fuser_real_uid, 0, 0, 0, /*
739 Return the real uid of Emacs, as an integer.
743 return make_int (getuid ());
746 DEFUN ("user-full-name", Fuser_full_name, 0, 1, 0, /*
747 Return the full name of the user logged in, as a string.
748 If the optional argument USER is given, then the full name for that
749 user is returned, or nil. USER may be either a login name or a uid.
751 If USER is nil, and `user-full-name' contains a string, the
752 value of `user-full-name' is returned.
756 Lisp_Object user_name;
757 struct passwd *pw = NULL;
761 if (NILP (user) && STRINGP (Vuser_full_name))
762 return Vuser_full_name;
764 user_name = (STRINGP (user) ? user : Fuser_login_name (user));
765 if (!NILP (user_name)) /* nil when nonexistent UID passed as arg */
767 const char *user_name_ext;
769 /* Fuck me. getpwnam() can call select() and (under IRIX at least)
770 things get wedged if a SIGIO arrives during this time. */
771 TO_EXTERNAL_FORMAT (LISP_STRING, user_name,
772 C_STRING_ALLOCA, user_name_ext,
774 slow_down_interrupts ();
775 pw = (struct passwd *) getpwnam (user_name_ext);
776 speed_up_interrupts ();
779 /* #### - Stig sez: this should return nil instead of "unknown" when pw==0 */
780 /* Ben sez: bad idea because it's likely to break something */
781 #ifndef AMPERSAND_FULL_NAME
782 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
785 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
788 tem = ((!NILP (user) && !pw)
790 : make_ext_string ((Extbyte *) p, (q ? q - p : strlen (p)),
793 #ifdef AMPERSAND_FULL_NAME
796 p = (char *) XSTRING_DATA (tem);
798 /* Substitute the login name for the &, upcasing the first character. */
801 char *r = (char *) alloca (strlen (p) + XSTRING_LENGTH (user_name) + 1);
802 memcpy (r, p, q - p);
804 strcat (r, (char *) XSTRING_DATA (user_name));
805 /* #### current_buffer dependency! */
806 r[q - p] = UPCASE (current_buffer, r[q - p]);
808 tem = build_string (r);
811 #endif /* AMPERSAND_FULL_NAME */
816 static Extbyte *cached_home_directory;
819 uncache_home_directory (void)
821 cached_home_directory = NULL; /* in some cases, this may cause the leaking
825 /* Returns the home directory, in external format */
827 get_home_directory (void)
829 int output_home_warning = 0;
831 if (cached_home_directory == NULL)
833 if ((cached_home_directory = (Extbyte *) getenv("HOME")) == NULL)
835 #if defined(WINDOWSNT) && !defined(__CYGWIN32__)
836 char *homedrive, *homepath;
838 if ((homedrive = getenv("HOMEDRIVE")) != NULL &&
839 (homepath = getenv("HOMEPATH")) != NULL)
841 cached_home_directory =
842 (Extbyte *) xmalloc (strlen (homedrive) +
843 strlen (homepath) + 1);
844 sprintf((char *) cached_home_directory, "%s%s",
852 * Use the current directory.
853 * This preserves the existing XEmacs behavior, but is different
856 if (initial_directory[0] != '\0')
858 cached_home_directory = (Extbyte*) initial_directory;
862 /* This will probably give the wrong value */
863 cached_home_directory = (Extbyte*) getcwd (NULL, 0);
867 * This is NT Emacs behavior
869 cached_home_directory = (Extbyte *) "C:\\";
870 output_home_warning = 1;
873 #else /* !WINDOWSNT */
876 * Using "/" isn't quite right, but what should we do?
877 * We probably should try to extract pw_dir from /etc/passwd,
878 * before falling back to this.
880 cached_home_directory = (Extbyte *) "/";
881 output_home_warning = 1;
882 #endif /* !WINDOWSNT */
884 if (initialized && output_home_warning)
886 warn_when_safe (Quser_files_and_directories, Qwarning, "\n"
887 " XEmacs was unable to determine a good value for the user's $HOME\n"
888 " directory, and will be using the value:\n"
890 " This is probably incorrect.",
891 cached_home_directory
895 return cached_home_directory;
898 DEFUN ("user-home-directory", Fuser_home_directory, 0, 0, 0, /*
899 Return the user's home directory, as a string.
903 Extbyte *path = get_home_directory ();
905 return path == NULL ? Qnil :
906 Fexpand_file_name (Fsubstitute_in_file_name
907 (build_ext_string ((char *) path, Qfile_name)),
911 DEFUN ("system-name", Fsystem_name, 0, 0, 0, /*
912 Return the name of the machine you are running on, as a string.
916 return Fcopy_sequence (Vsystem_name);
919 DEFUN ("emacs-pid", Femacs_pid, 0, 0, 0, /*
920 Return the process ID of Emacs, as an integer.
924 return make_int (getpid ());
927 DEFUN ("current-time", Fcurrent_time, 0, 0, 0, /*
928 Return the current time, as the number of seconds since 1970-01-01 00:00:00.
929 The time is returned as a list of three integers. The first has the
930 most significant 16 bits of the seconds, while the second has the
931 least significant 16 bits. The third integer gives the microsecond
934 The microsecond count is zero on systems that do not provide
935 resolution finer than a second.
942 return list3 (make_int ((EMACS_SECS (t) >> 16) & 0xffff),
943 make_int ((EMACS_SECS (t) >> 0) & 0xffff),
944 make_int (EMACS_USECS (t)));
947 DEFUN ("current-process-time", Fcurrent_process_time, 0, 0, 0, /*
948 Return the amount of time used by this XEmacs process so far.
949 The return value is a list of three floating-point numbers, expressing
950 the user, system, and real times used by the process. The user time
951 measures the time actually spent by the CPU executing the code in this
952 process. The system time measures time spent by the CPU executing kernel
953 code on behalf of this process (e.g. I/O requests made by the process).
955 Note that the user and system times measure processor time, as opposed
956 to real time, and only accrue when the processor is actually doing
957 something: Time spent in an idle wait (waiting for user events to come
958 in or for I/O on a disk drive or other device to complete) does not
959 count. Thus, the user and system times will often be considerably
960 less than the real time.
962 Some systems do not allow the user and system times to be distinguished.
963 In this case, the user time will be the total processor time used by
964 the process, and the system time will be 0.
966 Some systems do not allow the real and processor times to be distinguished.
967 In this case, the user and real times will be the same and the system
972 double user, sys, real;
974 get_process_times (&user, &sys, &real);
975 return list3 (make_float (user), make_float (sys), make_float (real));
979 int lisp_to_time (Lisp_Object specified_time, time_t *result);
981 lisp_to_time (Lisp_Object specified_time, time_t *result)
983 Lisp_Object high, low;
985 if (NILP (specified_time))
986 return time (result) != -1;
988 CHECK_CONS (specified_time);
989 high = XCAR (specified_time);
990 low = XCDR (specified_time);
995 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
996 return *result >> 16 == XINT (high);
999 Lisp_Object time_to_lisp (time_t the_time);
1001 time_to_lisp (time_t the_time)
1003 unsigned int item = (unsigned int) the_time;
1004 return Fcons (make_int (item >> 16), make_int (item & 0xffff));
1007 size_t emacs_strftime (char *string, size_t max, const char *format,
1008 const struct tm *tm);
1009 static long difftm (const struct tm *a, const struct tm *b);
1012 DEFUN ("format-time-string", Fformat_time_string, 1, 2, 0, /*
1013 Use FORMAT-STRING to format the time TIME.
1014 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from
1015 `current-time' and `file-attributes'. If TIME is not specified it
1016 defaults to the current time.
1017 FORMAT-STRING may contain %-sequences to substitute parts of the time.
1018 %a is replaced by the abbreviated name of the day of week.
1019 %A is replaced by the full name of the day of week.
1020 %b is replaced by the abbreviated name of the month.
1021 %B is replaced by the full name of the month.
1022 %c is a synonym for "%x %X".
1023 %C is a locale-specific synonym, which defaults to "%A, %B %e, %Y" in the C locale.
1024 %d is replaced by the day of month, zero-padded.
1025 %D is a synonym for "%m/%d/%y".
1026 %e is replaced by the day of month, blank-padded.
1027 %h is a synonym for "%b".
1028 %H is replaced by the hour (00-23).
1029 %I is replaced by the hour (00-12).
1030 %j is replaced by the day of the year (001-366).
1031 %k is replaced by the hour (0-23), blank padded.
1032 %l is replaced by the hour (1-12), blank padded.
1033 %m is replaced by the month (01-12).
1034 %M is replaced by the minute (00-59).
1035 %n is a synonym for "\\n".
1036 %p is replaced by AM or PM, as appropriate.
1037 %r is a synonym for "%I:%M:%S %p".
1038 %R is a synonym for "%H:%M".
1039 %s is replaced by the time in seconds since 00:00:00, Jan 1, 1970 (a
1040 nonstandard extension)
1041 %S is replaced by the second (00-60).
1042 %t is a synonym for "\\t".
1043 %T is a synonym for "%H:%M:%S".
1044 %U is replaced by the week of the year (00-53), first day of week is Sunday.
1045 %w is replaced by the day of week (0-6), Sunday is day 0.
1046 %W is replaced by the week of the year (00-53), first day of week is Monday.
1047 %x is a locale-specific synonym, which defaults to "%D" in the C locale.
1048 %X is a locale-specific synonym, which defaults to "%T" in the C locale.
1049 %y is replaced by the year without century (00-99).
1050 %Y is replaced by the year with century.
1051 %Z is replaced by the time zone abbreviation.
1053 The number of options reflects the `strftime' function.
1055 BUG: If the charset used by the current locale is not ISO 8859-1, the
1056 characters appearing in the day and month names may be incorrect.
1058 (format_string, time_))
1063 CHECK_STRING (format_string);
1065 if (! lisp_to_time (time_, &value))
1066 error ("Invalid time specification");
1068 /* This is probably enough. */
1069 size = XSTRING_LENGTH (format_string) * 6 + 50;
1073 char *buf = (char *) alloca (size);
1075 if (emacs_strftime (buf, size,
1076 (const char *) XSTRING_DATA (format_string),
1079 return build_ext_string (buf, Qbinary);
1080 /* If buffer was too small, make it bigger. */
1085 DEFUN ("decode-time", Fdecode_time, 0, 1, 0, /*
1086 Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1087 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)
1088 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'
1089 to use the current time. The list has the following nine members:
1090 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which
1091 only some operating systems support. MINUTE is an integer between 0 and 59.
1092 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.
1093 MONTH is an integer between 1 and 12. YEAR is an integer indicating the
1094 four-digit year. DOW is the day of week, an integer between 0 and 6, where
1095 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.
1096 ZONE is an integer indicating the number of seconds east of Greenwich.
1097 \(Note that Common Lisp has different meanings for DOW and ZONE.)
1103 struct tm *decoded_time;
1104 Lisp_Object list_args[9];
1106 if (! lisp_to_time (specified_time, &time_spec))
1107 error ("Invalid time specification");
1109 decoded_time = localtime (&time_spec);
1110 list_args[0] = make_int (decoded_time->tm_sec);
1111 list_args[1] = make_int (decoded_time->tm_min);
1112 list_args[2] = make_int (decoded_time->tm_hour);
1113 list_args[3] = make_int (decoded_time->tm_mday);
1114 list_args[4] = make_int (decoded_time->tm_mon + 1);
1115 list_args[5] = make_int (decoded_time->tm_year + 1900);
1116 list_args[6] = make_int (decoded_time->tm_wday);
1117 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1119 /* Make a copy, in case gmtime modifies the struct. */
1120 save_tm = *decoded_time;
1121 decoded_time = gmtime (&time_spec);
1122 if (decoded_time == 0)
1123 list_args[8] = Qnil;
1125 list_args[8] = make_int (difftm (&save_tm, decoded_time));
1126 return Flist (9, list_args);
1129 static void set_time_zone_rule (char *tzstring);
1131 DEFUN ("encode-time", Fencode_time, 6, MANY, 0, /*
1132 Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1133 This is the reverse operation of `decode-time', which see.
1134 ZONE defaults to the current time zone rule. This can
1135 be a string (as from `set-time-zone-rule'), or it can be a list
1136 \(as from `current-time-zone') or an integer (as from `decode-time')
1137 applied without consideration for daylight savings time.
1139 You can pass more than 7 arguments; then the first six arguments
1140 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1141 The intervening arguments are ignored.
1142 This feature lets (apply 'encode-time (decode-time ...)) work.
1144 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;
1145 for example, a DAY of 0 means the day preceding the given month.
1146 Year numbers less than 100 are treated just like other year numbers.
1147 If you want them to stand for years in this century, you must do that yourself.
1149 (int nargs, Lisp_Object *args))
1153 Lisp_Object zone = (nargs > 6) ? args[nargs - 1] : Qnil;
1155 CHECK_INT (*args); tm.tm_sec = XINT (*args++); /* second */
1156 CHECK_INT (*args); tm.tm_min = XINT (*args++); /* minute */
1157 CHECK_INT (*args); tm.tm_hour = XINT (*args++); /* hour */
1158 CHECK_INT (*args); tm.tm_mday = XINT (*args++); /* day */
1159 CHECK_INT (*args); tm.tm_mon = XINT (*args++) - 1; /* month */
1160 CHECK_INT (*args); tm.tm_year = XINT (*args++) - 1900;/* year */
1167 the_time = mktime (&tm);
1172 char **oldenv = environ, **newenv;
1175 tzstring = (char *) XSTRING_DATA (zone);
1176 else if (INTP (zone))
1178 int abszone = abs (XINT (zone));
1179 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1180 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1184 error ("Invalid time zone specification");
1186 /* Set TZ before calling mktime; merely adjusting mktime's returned
1187 value doesn't suffice, since that would mishandle leap seconds. */
1188 set_time_zone_rule (tzstring);
1190 the_time = mktime (&tm);
1192 /* Restore TZ to previous value. */
1196 #ifdef LOCALTIME_CACHE
1201 if (the_time == (time_t) -1)
1202 error ("Specified time is not representable");
1204 return wasteful_word_to_lisp (the_time);
1207 DEFUN ("current-time-string", Fcurrent_time_string, 0, 1, 0, /*
1208 Return the current time, as a human-readable string.
1209 Programs can use this function to decode a time,
1210 since the number of columns in each field is fixed.
1211 The format is `Sun Sep 16 01:03:52 1973'.
1212 If an argument is given, it specifies a time to format
1213 instead of the current time. The argument should have the form:
1216 (HIGH LOW . IGNORED).
1217 Thus, you can use times obtained from `current-time'
1218 and from `file-attributes'.
1226 if (! lisp_to_time (specified_time, &value))
1228 tem = (char *) ctime (&value);
1230 strncpy (buf, tem, 24);
1233 return build_ext_string (buf, Qbinary);
1236 #define TM_YEAR_ORIGIN 1900
1238 /* Yield A - B, measured in seconds. */
1240 difftm (const struct tm *a, const struct tm *b)
1242 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
1243 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
1244 /* Some compilers can't handle this as a single return statement. */
1246 /* difference in day of year */
1247 a->tm_yday - b->tm_yday
1248 /* + intervening leap days */
1249 + ((ay >> 2) - (by >> 2))
1251 + ((ay/100 >> 2) - (by/100 >> 2))
1252 /* + difference in years * 365 */
1253 + (long)(ay-by) * 365
1255 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
1256 + (a->tm_min - b->tm_min))
1257 + (a->tm_sec - b->tm_sec));
1260 DEFUN ("current-time-zone", Fcurrent_time_zone, 0, 1, 0, /*
1261 Return the offset and name for the local time zone.
1262 This returns a list of the form (OFFSET NAME).
1263 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1264 A negative value means west of Greenwich.
1265 NAME is a string giving the name of the time zone.
1266 If an argument is given, it specifies when the time zone offset is determined
1267 instead of using the current time. The argument should have the form:
1270 (HIGH LOW . IGNORED).
1271 Thus, you can use times obtained from `current-time'
1272 and from `file-attributes'.
1274 Some operating systems cannot provide all this information to Emacs;
1275 in this case, `current-time-zone' returns a list containing nil for
1276 the data it can't find.
1281 struct tm *t = NULL;
1283 if (lisp_to_time (specified_time, &value)
1284 && (t = gmtime (&value)) != 0)
1286 struct tm gmt = *t; /* Make a copy, in case localtime modifies *t. */
1290 t = localtime (&value);
1291 offset = difftm (t, &gmt);
1295 s = (char *)t->tm_zone;
1296 #else /* not HAVE_TM_ZONE */
1298 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1299 s = tzname[t->tm_isdst];
1301 #endif /* not HAVE_TM_ZONE */
1304 /* No local time zone name is available; use "+-NNNN" instead. */
1305 int am = (offset < 0 ? -offset : offset) / 60;
1306 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1309 return list2 (make_int (offset), build_string (s));
1312 return list2 (Qnil, Qnil);
1315 #ifdef LOCALTIME_CACHE
1317 /* These two values are known to load tz files in buggy implementations,
1318 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1319 Their values shouldn't matter in non-buggy implementations.
1320 We don't use string literals for these strings,
1321 since if a string in the environment is in readonly
1322 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1323 See Sun bugs 1113095 and 1114114, ``Timezone routines
1324 improperly modify environment''. */
1326 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1327 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1331 /* Set the local time zone rule to TZSTRING.
1332 This allocates memory into `environ', which it is the caller's
1333 responsibility to free. */
1335 set_time_zone_rule (char *tzstring)
1338 char **from, **to, **newenv;
1340 for (from = environ; *from; from++)
1342 envptrs = from - environ + 2;
1343 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1344 + (tzstring ? strlen (tzstring) + 4 : 0));
1347 char *t = (char *) (to + envptrs);
1349 strcat (t, tzstring);
1353 for (from = environ; *from; from++)
1354 if (strncmp (*from, "TZ=", 3) != 0)
1360 #ifdef LOCALTIME_CACHE
1362 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1363 "US/Pacific" that loads a tz file, then changes to a value like
1364 "XXX0" that does not load a tz file, and then changes back to
1365 its original value, the last change is (incorrectly) ignored.
1366 Also, if TZ changes twice in succession to values that do
1367 not load a tz file, tzset can dump core (see Sun bug#1225179).
1368 The following code works around these bugs. */
1372 /* Temporarily set TZ to a value that loads a tz file
1373 and that differs from tzstring. */
1375 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1376 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1382 /* The implied tzstring is unknown, so temporarily set TZ to
1383 two different values that each load a tz file. */
1384 *to = set_time_zone_rule_tz1;
1387 *to = set_time_zone_rule_tz2;
1392 /* Now TZ has the desired value, and tzset can be invoked safely. */
1399 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, 1, 1, 0, /*
1400 Set the local time zone using TZ, a string specifying a time zone rule.
1401 If TZ is nil, use implementation-defined default time zone information.
1412 tzstring = (char *) XSTRING_DATA (tz);
1415 set_time_zone_rule (tzstring);
1418 environbuf = environ;
1425 buffer_insert1 (struct buffer *buf, Lisp_Object arg)
1427 /* This function can GC */
1428 struct gcpro gcpro1;
1431 if (CHAR_OR_CHAR_INTP (arg))
1433 buffer_insert_emacs_char (buf, XCHAR_OR_CHAR_INT (arg));
1435 else if (STRINGP (arg))
1437 buffer_insert_lisp_string (buf, arg);
1441 arg = wrong_type_argument (Qchar_or_string_p, arg);
1444 zmacs_region_stays = 0;
1449 /* Callers passing one argument to Finsert need not gcpro the
1450 argument "array", since the only element of the array will
1451 not be used after calling insert_emacs_char or insert_lisp_string,
1452 so we don't care if it gets trashed. */
1454 DEFUN ("insert", Finsert, 0, MANY, 0, /*
1455 Insert the arguments, either strings or characters, at point.
1456 Point moves forward so that it ends up after the inserted text.
1457 Any other markers at the point of insertion remain before the text.
1458 If a string has non-null string-extent-data, new extents will be created.
1460 (int nargs, Lisp_Object *args))
1462 /* This function can GC */
1463 REGISTER int argnum;
1465 for (argnum = 0; argnum < nargs; argnum++)
1467 buffer_insert1 (current_buffer, args[argnum]);
1473 DEFUN ("insert-before-markers", Finsert_before_markers, 0, MANY, 0, /*
1474 Insert strings or characters at point, relocating markers after the text.
1475 Point moves forward so that it ends up after the inserted text.
1476 Any other markers at the point of insertion also end up after the text.
1478 (int nargs, Lisp_Object *args))
1480 /* This function can GC */
1481 REGISTER int argnum;
1482 REGISTER Lisp_Object tem;
1484 for (argnum = 0; argnum < nargs; argnum++)
1488 if (CHAR_OR_CHAR_INTP (tem))
1490 buffer_insert_emacs_char_1 (current_buffer, -1,
1491 XCHAR_OR_CHAR_INT (tem),
1492 INSDEL_BEFORE_MARKERS);
1494 else if (STRINGP (tem))
1496 buffer_insert_lisp_string_1 (current_buffer, -1, tem,
1497 INSDEL_BEFORE_MARKERS);
1501 tem = wrong_type_argument (Qchar_or_string_p, tem);
1505 zmacs_region_stays = 0;
1509 DEFUN ("insert-string", Finsert_string, 1, 2, 0, /*
1510 Insert STRING into BUFFER at BUFFER's point.
1511 Point moves forward so that it ends up after the inserted text.
1512 Any other markers at the point of insertion remain before the text.
1513 If a string has non-null string-extent-data, new extents will be created.
1514 BUFFER defaults to the current buffer.
1518 struct buffer *b = decode_buffer (buffer, 1);
1519 CHECK_STRING (string);
1520 buffer_insert_lisp_string (b, string);
1521 zmacs_region_stays = 0;
1525 /* Third argument in FSF is INHERIT:
1527 "The optional third arg INHERIT, if non-nil, says to inherit text properties
1528 from adjoining text, if those properties are sticky."
1530 Jamie thinks this is bogus. */
1533 DEFUN ("insert-char", Finsert_char, 1, 4, 0, /*
1534 Insert COUNT (second arg) copies of CHR (first arg).
1535 Point and all markers are affected as in the function `insert'.
1536 COUNT defaults to 1 if omitted.
1537 The optional third arg IGNORED is INHERIT under FSF Emacs.
1538 This is highly bogus, however, and XEmacs always behaves as if
1539 `t' were passed to INHERIT.
1540 The optional fourth arg BUFFER specifies the buffer to insert the
1541 text into. If BUFFER is nil, the current buffer is assumed.
1543 (chr, count, ignored, buffer))
1545 /* This function can GC */
1546 REGISTER Bufbyte *string;
1549 REGISTER Bytecount n;
1550 REGISTER Bytecount charlen;
1551 Bufbyte str[MAX_EMCHAR_LEN];
1552 struct buffer *b = decode_buffer (buffer, 1);
1555 CHECK_CHAR_COERCE_INT (chr);
1564 charlen = set_charptr_emchar (str, XCHAR (chr));
1568 slen = min (n, 768);
1569 string = alloca_array (Bufbyte, slen);
1570 /* Write as many copies of the character into the temp string as will fit. */
1571 for (i = 0; i + charlen <= slen; i += charlen)
1572 for (j = 0; j < charlen; j++)
1573 string[i + j] = str[j];
1577 buffer_insert_raw_string (b, string, slen);
1581 #if 0 /* FSFmacs bogosity */
1583 if (!NILP (inherit))
1584 insert_and_inherit (string, n);
1589 buffer_insert_raw_string (b, string, n);
1592 zmacs_region_stays = 0;
1597 /* Making strings from buffer contents. */
1599 DEFUN ("buffer-substring", Fbuffer_substring, 0, 3, 0, /*
1600 Return the contents of part of BUFFER as a string.
1601 The two arguments START and END are character positions;
1602 they can be in either order. If omitted, they default to the beginning
1603 and end of BUFFER, respectively.
1604 If there are duplicable extents in the region, the string remembers
1605 them in its extent data.
1606 If BUFFER is nil, the current buffer is assumed.
1608 (start, end, buffer))
1610 /* This function can GC */
1612 struct buffer *b = decode_buffer (buffer, 1);
1614 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1615 return make_string_from_buffer (b, begv, zv - begv);
1618 /* It might make more sense to name this
1619 `buffer-substring-no-extents', but this name is FSFmacs-compatible,
1620 and what the function does is probably good enough for what the
1621 user-code will typically want to use it for. */
1622 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties, 0, 3, 0, /*
1623 Return the text from BEG to END, as a string, without copying the extents.
1625 (start, end, buffer))
1627 /* This function can GC */
1629 struct buffer *b = decode_buffer (buffer, 1);
1631 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1632 return make_string_from_buffer_no_extents (b, begv, zv - begv);
1635 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, 1, 3, 0, /*
1636 Insert before point a substring of the contents of buffer BUFFER.
1637 BUFFER may be a buffer or a buffer name.
1638 Arguments START and END are character numbers specifying the substring.
1639 They default to the beginning and the end of BUFFER.
1641 (buffer, start, end))
1643 /* This function can GC */
1647 bp = XBUFFER (get_buffer (buffer, 1));
1648 get_buffer_range_char (bp, start, end, &b, &e, GB_ALLOW_NIL);
1651 buffer_insert_from_buffer (current_buffer, bp, b, e - b);
1656 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, 6, 6, 0, /*
1657 Compare two substrings of two buffers; return result as number.
1658 the value is -N if first string is less after N-1 chars,
1659 +N if first string is greater after N-1 chars, or 0 if strings match.
1660 Each substring is represented as three arguments: BUFFER, START and END.
1661 That makes six args in all, three for each substring.
1663 The value of `case-fold-search' in the current buffer
1664 determines whether case is significant or ignored.
1666 (buffer1, start1, end1, buffer2, start2, end2))
1668 Bufpos begp1, endp1, begp2, endp2;
1669 REGISTER Charcount len1, len2, length, i;
1670 struct buffer *bp1, *bp2;
1671 Lisp_Object trt = ((!NILP (current_buffer->case_fold_search)) ?
1672 current_buffer->case_canon_table : Qnil);
1674 /* Find the first buffer and its substring. */
1676 bp1 = decode_buffer (buffer1, 1);
1677 get_buffer_range_char (bp1, start1, end1, &begp1, &endp1, GB_ALLOW_NIL);
1679 /* Likewise for second substring. */
1681 bp2 = decode_buffer (buffer2, 1);
1682 get_buffer_range_char (bp2, start2, end2, &begp2, &endp2, GB_ALLOW_NIL);
1684 len1 = endp1 - begp1;
1685 len2 = endp2 - begp2;
1690 for (i = 0; i < length; i++)
1692 Emchar c1 = BUF_FETCH_CHAR (bp1, begp1 + i);
1693 Emchar c2 = BUF_FETCH_CHAR (bp2, begp2 + i);
1696 c1 = TRT_TABLE_OF (trt, c1);
1697 c2 = TRT_TABLE_OF (trt, c2);
1700 return make_int (- 1 - i);
1702 return make_int (i + 1);
1705 /* The strings match as far as they go.
1706 If one is shorter, that one is less. */
1708 return make_int (length + 1);
1709 else if (length < len2)
1710 return make_int (- length - 1);
1712 /* Same length too => they are equal. */
1718 subst_char_in_region_unwind (Lisp_Object arg)
1720 XBUFFER (XCAR (arg))->undo_list = XCDR (arg);
1725 subst_char_in_region_unwind_1 (Lisp_Object arg)
1727 XBUFFER (XCAR (arg))->filename = XCDR (arg);
1731 DEFUN ("subst-char-in-region", Fsubst_char_in_region, 4, 5, 0, /*
1732 From START to END, replace FROMCHAR with TOCHAR each time it occurs.
1733 If optional arg NOUNDO is non-nil, don't record this change for undo
1734 and don't mark the buffer as really changed.
1736 (start, end, fromchar, tochar, noundo))
1738 /* This function can GC */
1742 struct buffer *buf = current_buffer;
1743 int count = specpdl_depth ();
1745 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1746 CHECK_CHAR_COERCE_INT (fromchar);
1747 CHECK_CHAR_COERCE_INT (tochar);
1749 fromc = XCHAR (fromchar);
1750 toc = XCHAR (tochar);
1752 /* If we don't want undo, turn off putting stuff on the list.
1753 That's faster than getting rid of things,
1754 and it prevents even the entry for a first change.
1755 Also inhibit locking the file. */
1758 record_unwind_protect (subst_char_in_region_unwind,
1759 Fcons (Fcurrent_buffer (), buf->undo_list));
1760 buf->undo_list = Qt;
1761 /* Don't do file-locking. */
1762 record_unwind_protect (subst_char_in_region_unwind_1,
1763 Fcons (Fcurrent_buffer (), buf->filename));
1764 buf->filename = Qnil;
1767 mc_count = begin_multiple_change (buf, pos, stop);
1770 if (BUF_FETCH_CHAR (buf, pos) == fromc)
1772 /* There used to be some code here that set the buffer to
1773 unmodified if NOUNDO was specified and there was only
1774 one change to the buffer since it was last saved.
1775 This is a crock of shit, so I'm not duplicating this
1776 behavior. I think this was left over from when
1777 prepare_to_modify_buffer() actually bumped MODIFF,
1778 so that code was supposed to undo this change. --ben */
1779 buffer_replace_char (buf, pos, toc, !NILP (noundo), 0);
1781 /* If noundo is not nil then we don't mark the buffer as
1782 modified. In reality that needs to happen externally
1783 only. Internally redisplay needs to know that the actual
1784 contents it should be displaying have changed. */
1786 Fset_buffer_modified_p (Fbuffer_modified_p (Qnil), Qnil);
1790 end_multiple_change (buf, mc_count);
1792 unbind_to (count, Qnil);
1796 /* #### Shouldn't this also accept a BUFFER argument, in the good old
1797 XEmacs tradition? */
1798 DEFUN ("translate-region", Ftranslate_region, 3, 3, 0, /*
1799 Translate characters from START to END according to TABLE.
1801 If TABLE is a string, the Nth character in it is the mapping for the
1802 character with code N.
1804 If TABLE is a vector, its Nth element is the mapping for character
1805 with code N. The values of elements may be characters, strings, or
1806 nil (nil meaning don't replace.)
1808 If TABLE is a char-table, its elements describe the mapping between
1809 characters and their replacements. The char-table should be of type
1810 `char' or `generic'.
1812 Returns the number of substitutions performed.
1814 (start, end, table))
1816 /* This function can GC */
1817 Bufpos pos, stop; /* Limits of the region. */
1818 int cnt = 0; /* Number of changes made. */
1820 struct buffer *buf = current_buffer;
1823 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1824 mc_count = begin_multiple_change (buf, pos, stop);
1825 if (STRINGP (table))
1827 Lisp_String *stable = XSTRING (table);
1828 Charcount size = string_char_length (stable);
1830 /* Under Mule, string_char(n) is O(n), so for large tables or
1831 large regions it makes sense to create an array of Emchars. */
1832 if (size * (stop - pos) > 65536)
1834 Emchar *etable = alloca_array (Emchar, size);
1835 convert_bufbyte_string_into_emchar_string
1836 (string_data (stable), string_length (stable), etable);
1837 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1841 Emchar nc = etable[oc];
1844 buffer_replace_char (buf, pos, nc, 0, 0);
1853 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1857 Emchar nc = string_char (stable, oc);
1860 buffer_replace_char (buf, pos, nc, 0, 0);
1867 else if (VECTORP (table))
1869 Charcount size = XVECTOR_LENGTH (table);
1870 Lisp_Object *vtable = XVECTOR_DATA (table);
1872 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1876 Lisp_Object replacement = vtable[oc];
1878 if (CHAR_OR_CHAR_INTP (replacement))
1880 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1883 buffer_replace_char (buf, pos, nc, 0, 0);
1887 else if (STRINGP (replacement))
1889 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1890 buffer_delete_range (buf, pos, pos + 1, 0);
1891 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1892 pos += incr, stop += incr;
1895 else if (!NILP (replacement))
1897 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1903 else if (CHAR_TABLEP (table)
1904 && (XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC
1905 || XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR))
1907 Lisp_Char_Table *ctable = XCHAR_TABLE (table);
1909 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1911 Lisp_Object replacement = get_char_table (oc, ctable);
1913 if (CHAR_OR_CHAR_INTP (replacement))
1915 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1918 buffer_replace_char (buf, pos, nc, 0, 0);
1922 else if (STRINGP (replacement))
1924 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1925 buffer_delete_range (buf, pos, pos + 1, 0);
1926 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1927 pos += incr, stop += incr;
1930 else if (!NILP (replacement))
1932 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1938 dead_wrong_type_argument (Qstringp, table);
1939 end_multiple_change (buf, mc_count);
1941 return make_int (cnt);
1944 DEFUN ("delete-region", Fdelete_region, 2, 3, "r", /*
1945 Delete the text between point and mark.
1946 When called from a program, expects two arguments,
1947 positions (integers or markers) specifying the stretch to be deleted.
1948 If BUFFER is nil, the current buffer is assumed.
1952 /* This function can GC */
1954 struct buffer *buf = decode_buffer (buffer, 1);
1956 get_buffer_range_char (buf, b, e, &start, &end, 0);
1957 buffer_delete_range (buf, start, end, 0);
1958 zmacs_region_stays = 0;
1963 widen_buffer (struct buffer *b, int no_clip)
1965 if (BUF_BEGV (b) != BUF_BEG (b))
1968 SET_BOTH_BUF_BEGV (b, BUF_BEG (b), BI_BUF_BEG (b));
1970 if (BUF_ZV (b) != BUF_Z (b))
1973 SET_BOTH_BUF_ZV (b, BUF_Z (b), BI_BUF_Z (b));
1979 /* Changing the buffer bounds invalidates any recorded current
1981 invalidate_current_column ();
1982 narrow_line_number_cache (b);
1986 DEFUN ("widen", Fwiden, 0, 1, "", /*
1987 Remove restrictions (narrowing) from BUFFER.
1988 This allows the buffer's full text to be seen and edited.
1989 If BUFFER is nil, the current buffer is assumed.
1993 struct buffer *b = decode_buffer (buffer, 1);
1994 widen_buffer (b, 0);
1995 zmacs_region_stays = 0;
1999 DEFUN ("narrow-to-region", Fnarrow_to_region, 2, 3, "r", /*
2000 Restrict editing in BUFFER to the current region.
2001 The rest of the text becomes temporarily invisible and untouchable
2002 but is not deleted; if you save the buffer in a file, the invisible
2003 text is included in the file. \\[widen] makes all visible again.
2004 If BUFFER is nil, the current buffer is assumed.
2005 See also `save-restriction'.
2007 When calling from a program, pass two arguments; positions (integers
2008 or markers) bounding the text that should remain visible.
2013 struct buffer *buf = decode_buffer (buffer, 1);
2014 Bytind bi_start, bi_end;
2016 get_buffer_range_char (buf, b, e, &start, &end, GB_ALLOW_PAST_ACCESSIBLE);
2017 bi_start = bufpos_to_bytind (buf, start);
2018 bi_end = bufpos_to_bytind (buf, end);
2020 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2021 SET_BOTH_BUF_ZV (buf, end, bi_end);
2022 if (BUF_PT (buf) < start)
2023 BUF_SET_PT (buf, start);
2024 if (BUF_PT (buf) > end)
2025 BUF_SET_PT (buf, end);
2027 /* Changing the buffer bounds invalidates any recorded current column. */
2028 invalidate_current_column ();
2029 narrow_line_number_cache (buf);
2030 zmacs_region_stays = 0;
2035 save_restriction_save (void)
2037 Lisp_Object bottom, top;
2038 /* Note: I tried using markers here, but it does not win
2039 because insertion at the end of the saved region
2040 does not advance mh and is considered "outside" the saved region. */
2041 bottom = make_int (BUF_BEGV (current_buffer) - BUF_BEG (current_buffer));
2042 top = make_int (BUF_Z (current_buffer) - BUF_ZV (current_buffer));
2044 return noseeum_cons (Fcurrent_buffer (), noseeum_cons (bottom, top));
2048 save_restriction_restore (Lisp_Object data)
2051 Charcount newhead, newtail;
2053 int local_clip_changed = 0;
2055 buf = XBUFFER (XCAR (data));
2056 if (!BUFFER_LIVE_P (buf))
2058 /* someone could have killed the buffer in the meantime ... */
2059 free_cons (XCONS (XCDR (data)));
2060 free_cons (XCONS (data));
2064 newhead = XINT (XCAR (tem));
2065 newtail = XINT (XCDR (tem));
2067 free_cons (XCONS (XCDR (data)));
2068 free_cons (XCONS (data));
2070 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
2078 Bytind bi_start, bi_end;
2080 start = BUF_BEG (buf) + newhead;
2081 end = BUF_Z (buf) - newtail;
2083 bi_start = bufpos_to_bytind (buf, start);
2084 bi_end = bufpos_to_bytind (buf, end);
2086 if (BUF_BEGV (buf) != start)
2088 local_clip_changed = 1;
2089 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2090 narrow_line_number_cache (buf);
2092 if (BUF_ZV (buf) != end)
2094 local_clip_changed = 1;
2095 SET_BOTH_BUF_ZV (buf, end, bi_end);
2098 if (local_clip_changed)
2101 /* If point is outside the new visible range, move it inside. */
2103 bufpos_clip_to_bounds (BUF_BEGV (buf),
2110 DEFUN ("save-restriction", Fsave_restriction, 0, UNEVALLED, 0, /*
2111 Execute BODY, saving and restoring current buffer's restrictions.
2112 The buffer's restrictions make parts of the beginning and end invisible.
2113 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
2114 This special form, `save-restriction', saves the current buffer's restrictions
2115 when it is entered, and restores them when it is exited.
2116 So any `narrow-to-region' within BODY lasts only until the end of the form.
2117 The old restrictions settings are restored
2118 even in case of abnormal exit (throw or error).
2120 The value returned is the value of the last form in BODY.
2122 `save-restriction' can get confused if, within the BODY, you widen
2123 and then make changes outside the area within the saved restrictions.
2125 Note: if you are using both `save-excursion' and `save-restriction',
2126 use `save-excursion' outermost:
2127 (save-excursion (save-restriction ...))
2131 /* This function can GC */
2132 int speccount = specpdl_depth ();
2134 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2136 return unbind_to (speccount, Fprogn (body));
2140 DEFUN ("format", Fformat, 1, MANY, 0, /*
2141 Format a string out of a control-string and arguments.
2142 The first argument is a control string.
2143 The other arguments are substituted into it to make the result, a string.
2144 It may contain %-sequences meaning to substitute the next argument.
2145 %s means print all objects as-is, using `princ'.
2146 %S means print all objects as s-expressions, using `prin1'.
2147 %d or %i means print as an integer in decimal (%o octal, %x lowercase hex,
2149 %c means print as a single character.
2150 %f means print as a floating-point number in fixed notation (e.g. 785.200).
2151 %e or %E means print as a floating-point number in scientific notation
2153 %g or %G means print as a floating-point number in "pretty format";
2154 depending on the number, either %f or %e/%E format will be used, and
2155 trailing zeroes are removed from the fractional part.
2156 The argument used for all but %s and %S must be a number. It will be
2157 converted to an integer or a floating-point number as necessary.
2159 %$ means reposition to read a specific numbered argument; for example,
2160 %3$s would apply the `%s' to the third argument after the control string,
2161 and the next format directive would use the fourth argument, the
2162 following one the fifth argument, etc. (There must be a positive integer
2163 between the % and the $).
2164 Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be
2165 specified between the optional repositioning spec and the conversion
2166 character; see below.
2167 An optional minimum field width may be specified after any flag characters
2168 and before the conversion character; it specifies the minimum number of
2169 characters that the converted argument will take up. Padding will be
2170 added on the left (or on the right, if the `-' flag is specified), as
2171 necessary. Padding is done with spaces, or with zeroes if the `0' flag
2173 If the field width is specified as `*', the field width is assumed to have
2174 been specified as an argument. Any repositioning specification that
2175 would normally specify the argument to be converted will now specify
2176 where to find this field width argument, not where to find the argument
2177 to be converted. If there is no repositioning specification, the normal
2178 next argument is used. The argument to be converted will be the next
2179 argument after the field width argument unless the precision is also
2180 specified as `*' (see below).
2182 An optional period character and precision may be specified after any
2183 minimum field width. It specifies the minimum number of digits to
2184 appear in %d, %i, %o, %x, and %X conversions (the number is padded
2185 on the left with zeroes as necessary); the number of digits printed
2186 after the decimal point for %f, %e, and %E conversions; the number
2187 of significant digits printed in %g and %G conversions; and the
2188 maximum number of non-padding characters printed in %s and %S
2189 conversions. The default precision for floating-point conversions
2191 If the precision is specified as `*', the precision is assumed to have been
2192 specified as an argument. The argument used will be the next argument
2193 after the field width argument, if any. If the field width was not
2194 specified as an argument, any repositioning specification that would
2195 normally specify the argument to be converted will now specify where to
2196 find the precision argument. If there is no repositioning specification,
2197 the normal next argument is used.
2199 The ` ' and `+' flags mean prefix non-negative numbers with a space or
2200 plus sign, respectively.
2201 The `#' flag means print numbers in an alternate, more verbose format:
2202 octal numbers begin with zero; hex numbers begin with a 0x or 0X;
2203 a decimal point is printed in %f, %e, and %E conversions even if no
2204 numbers are printed after it; and trailing zeroes are not omitted in
2205 %g and %G conversions.
2207 Use %% to put a single % into the output.
2209 (int nargs, Lisp_Object *args))
2211 /* It should not be necessary to GCPRO ARGS, because
2212 the caller in the interpreter should take care of that. */
2214 CHECK_STRING (args[0]);
2215 return emacs_doprnt_string_lisp (0, args[0], 0, nargs - 1, args + 1);
2219 DEFUN ("char-equal", Fchar_equal, 2, 3, 0, /*
2220 Return t if two characters match, optionally ignoring case.
2221 Both arguments must be characters (i.e. NOT integers).
2222 Case is ignored if `case-fold-search' is non-nil in BUFFER.
2223 If BUFFER is nil, the current buffer is assumed.
2228 struct buffer *b = decode_buffer (buffer, 1);
2230 CHECK_CHAR_COERCE_INT (c1);
2231 CHECK_CHAR_COERCE_INT (c2);
2235 return (!NILP (b->case_fold_search)
2236 ? DOWNCASE (b, x1) == DOWNCASE (b, x2)
2241 DEFUN ("char=", Fchar_Equal, 2, 2, 0, /*
2242 Return t if two characters match, case is significant.
2243 Both arguments must be characters (i.e. NOT integers).
2247 CHECK_CHAR_COERCE_INT (c1);
2248 CHECK_CHAR_COERCE_INT (c2);
2250 return EQ (c1, c2) ? Qt : Qnil;
2253 #if 0 /* Undebugged FSFmacs code */
2254 /* Transpose the markers in two regions of the current buffer, and
2255 adjust the ones between them if necessary (i.e.: if the regions
2258 Traverses the entire marker list of the buffer to do so, adding an
2259 appropriate amount to some, subtracting from some, and leaving the
2260 rest untouched. Most of this is copied from adjust_markers in insdel.c.
2262 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
2265 transpose_markers (Bufpos start1, Bufpos end1, Bufpos start2, Bufpos end2)
2267 Charcount amt1, amt2, diff;
2269 struct buffer *buf = current_buffer;
2271 /* Update point as if it were a marker. */
2272 if (BUF_PT (buf) < start1)
2274 else if (BUF_PT (buf) < end1)
2275 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - end1));
2276 else if (BUF_PT (buf) < start2)
2277 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - start2) - (end1 - start1));
2278 else if (BUF_PT (buf) < end2)
2279 BUF_SET_PT (buf, BUF_PT (buf) - (start2 - start1));
2281 /* We used to adjust the endpoints here to account for the gap, but that
2282 isn't good enough. Even if we assume the caller has tried to move the
2283 gap out of our way, it might still be at start1 exactly, for example;
2284 and that places it `inside' the interval, for our purposes. The amount
2285 of adjustment is nontrivial if there's a `denormalized' marker whose
2286 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
2287 the dirty work to Fmarker_position, below. */
2289 /* The difference between the region's lengths */
2290 diff = (end2 - start2) - (end1 - start1);
2292 /* For shifting each marker in a region by the length of the other
2293 * region plus the distance between the regions.
2295 amt1 = (end2 - start2) + (start2 - end1);
2296 amt2 = (end1 - start1) + (start2 - end1);
2298 for (marker = BUF_MARKERS (buf); !NILP (marker);
2299 marker = XMARKER (marker)->chain)
2301 Bufpos mpos = marker_position (marker);
2302 if (mpos >= start1 && mpos < end2)
2306 else if (mpos < start2)
2310 set_marker_position (marker, mpos);
2317 DEFUN ("transpose-regions", Ftranspose_regions, 4, 5, 0, /*
2318 Transpose region START1 to END1 with START2 to END2.
2319 The regions may not be overlapping, because the size of the buffer is
2320 never changed in a transposition.
2322 Optional fifth arg LEAVE_MARKERS, if non-nil, means don't transpose
2323 any markers that happen to be located in the regions. (#### BUG: currently
2324 this function always acts as if LEAVE_MARKERS is non-nil.)
2326 Transposing beyond buffer boundaries is an error.
2328 (startr1, endr1, startr2, endr2, leave_markers))
2330 Bufpos start1, end1, start2, end2;
2331 Charcount len1, len2;
2332 Lisp_Object string1, string2;
2333 struct buffer *buf = current_buffer;
2335 get_buffer_range_char (buf, startr1, endr1, &start1, &end1, 0);
2336 get_buffer_range_char (buf, startr2, endr2, &start2, &end2, 0);
2338 len1 = end1 - start1;
2339 len2 = end2 - start2;
2342 error ("transposed regions not properly ordered");
2343 else if (start1 == end1 || start2 == end2)
2344 error ("transposed region may not be of length 0");
2346 string1 = make_string_from_buffer (buf, start1, len1);
2347 string2 = make_string_from_buffer (buf, start2, len2);
2348 buffer_delete_range (buf, start2, end2, 0);
2349 buffer_insert_lisp_string_1 (buf, start2, string1, 0);
2350 buffer_delete_range (buf, start1, end1, 0);
2351 buffer_insert_lisp_string_1 (buf, start1, string2, 0);
2353 /* In FSFmacs there is a whole bunch of really ugly code here
2354 to attempt to transpose the regions without using up any
2355 extra memory. Although the intent may be good, the result
2356 was highly bogus. */
2362 /************************************************************************/
2363 /* initialization */
2364 /************************************************************************/
2367 syms_of_editfns (void)
2369 defsymbol (&Qpoint, "point");
2370 defsymbol (&Qmark, "mark");
2371 defsymbol (&Qregion_beginning, "region-beginning");
2372 defsymbol (&Qregion_end, "region-end");
2373 defsymbol (&Qformat, "format");
2374 defsymbol (&Quser_files_and_directories, "user-files-and-directories");
2376 DEFSUBR (Fchar_equal);
2377 DEFSUBR (Fchar_Equal);
2378 DEFSUBR (Fgoto_char);
2379 DEFSUBR (Fstring_to_char);
2380 DEFSUBR (Fchar_to_string);
2381 DEFSUBR (Fbuffer_substring);
2382 DEFSUBR (Fbuffer_substring_no_properties);
2384 DEFSUBR (Fpoint_marker);
2385 DEFSUBR (Fmark_marker);
2387 DEFSUBR (Fregion_beginning);
2388 DEFSUBR (Fregion_end);
2389 DEFSUBR (Fsave_excursion);
2390 DEFSUBR (Fsave_current_buffer);
2392 DEFSUBR (Fbuffer_size);
2393 DEFSUBR (Fpoint_max);
2394 DEFSUBR (Fpoint_min);
2395 DEFSUBR (Fpoint_min_marker);
2396 DEFSUBR (Fpoint_max_marker);
2402 DEFSUBR (Ffollowing_char);
2403 DEFSUBR (Fpreceding_char);
2404 DEFSUBR (Fchar_after);
2405 DEFSUBR (Fchar_before);
2407 DEFSUBR (Finsert_string);
2408 DEFSUBR (Finsert_before_markers);
2409 DEFSUBR (Finsert_char);
2411 DEFSUBR (Ftemp_directory);
2412 DEFSUBR (Fuser_login_name);
2413 DEFSUBR (Fuser_real_login_name);
2414 DEFSUBR (Fuser_uid);
2415 DEFSUBR (Fuser_real_uid);
2416 DEFSUBR (Fuser_full_name);
2417 DEFSUBR (Fuser_home_directory);
2418 DEFSUBR (Femacs_pid);
2419 DEFSUBR (Fcurrent_time);
2420 DEFSUBR (Fcurrent_process_time);
2421 DEFSUBR (Fformat_time_string);
2422 DEFSUBR (Fdecode_time);
2423 DEFSUBR (Fencode_time);
2424 DEFSUBR (Fcurrent_time_string);
2425 DEFSUBR (Fcurrent_time_zone);
2426 DEFSUBR (Fset_time_zone_rule);
2427 DEFSUBR (Fsystem_name);
2430 DEFSUBR (Finsert_buffer_substring);
2431 DEFSUBR (Fcompare_buffer_substrings);
2432 DEFSUBR (Fsubst_char_in_region);
2433 DEFSUBR (Ftranslate_region);
2434 DEFSUBR (Fdelete_region);
2436 DEFSUBR (Fnarrow_to_region);
2437 DEFSUBR (Fsave_restriction);
2438 DEFSUBR (Ftranspose_regions);
2440 defsymbol (&Qzmacs_update_region, "zmacs-update-region");
2441 defsymbol (&Qzmacs_deactivate_region, "zmacs-deactivate-region");
2442 defsymbol (&Qzmacs_region_buffer, "zmacs-region-buffer");
2446 vars_of_editfns (void)
2448 staticpro (&Vsystem_name);
2450 staticpro (&Vuser_name);
2451 staticpro (&Vuser_real_name);
2453 DEFVAR_BOOL ("zmacs-regions", &zmacs_regions /*
2454 *Whether LISPM-style active regions should be used.
2455 This means that commands which operate on the region (the area between the
2456 point and the mark) will only work while the region is in the ``active''
2457 state, which is indicated by highlighting. Executing most commands causes
2458 the region to not be in the active state, so (for example) \\[kill-region] will only
2459 work immediately after activating the region.
2463 - Commands which operate on the region only work if the region is active.
2464 - Only a very small set of commands cause the region to become active:
2465 Those commands whose semantics are to mark an area, like mark-defun.
2466 - The region is deactivated after each command that is executed, except that:
2467 - "Motion" commands do not change whether the region is active or not.
2469 set-mark-command (C-SPC) pushes a mark and activates the region. Moving the
2470 cursor with normal motion commands (C-n, C-p, etc) will cause the region
2471 between point and the recently-pushed mark to be highlighted. It will
2472 remain highlighted until some non-motion command is executed.
2474 exchange-point-and-mark (\\[exchange-point-and-mark]) activates the region. So if you mark a
2475 region and execute a command that operates on it, you can reactivate the
2476 same region with \\[exchange-point-and-mark] (or perhaps \\[exchange-point-and-mark] \\[exchange-point-and-mark]) to operate on it
2479 Generally, commands which push marks as a means of navigation (like
2480 beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
2481 region. But commands which push marks as a means of marking an area of
2482 text (like mark-defun (\\[mark-defun]), mark-word (\\[mark-word]) or mark-whole-buffer (\\[mark-whole-buffer]))
2483 do activate the region.
2485 The way the command loop actually works with regard to deactivating the
2486 region is as follows:
2488 - If the variable `zmacs-region-stays' has been set to t during the command
2489 just executed, the region is left alone (this is how the motion commands
2490 make the region stay around; see the `_' flag in the `interactive'
2491 specification). `zmacs-region-stays' is reset to nil before each command
2493 - If the function `zmacs-activate-region' has been called during the command
2494 just executed, the region is left alone. Very few functions should
2495 actually call this function.
2496 - Otherwise, if the region is active, the region is deactivated and
2497 the `zmacs-deactivate-region-hook' is called.
2499 /* Zmacs style active regions are now ON by default */
2502 DEFVAR_BOOL ("zmacs-region-active-p", &zmacs_region_active_p /*
2503 Do not alter this. It is for internal use only.
2505 zmacs_region_active_p = 0;
2507 DEFVAR_BOOL ("zmacs-region-stays", &zmacs_region_stays /*
2508 Whether the current command will deactivate the region.
2509 Commands which do not wish to affect whether the region is currently
2510 highlighted should set this to t. Normally, the region is turned off after
2511 executing each command that did not explicitly turn it on with the function
2512 zmacs-activate-region. Setting this to true lets a command be non-intrusive.
2513 See the variable `zmacs-regions'.
2515 The same effect can be achieved using the `_' interactive specification.
2517 zmacs_region_stays = 0;
2519 DEFVAR_BOOL ("atomic-extent-goto-char-p", &atomic_extent_goto_char_p /*
2520 Do not use this -- it will be going away soon.
2521 Indicates if `goto-char' has just been run. This information is allegedly
2522 needed to get the desired behavior for atomic extents and unfortunately
2523 is not available by any other means.
2525 atomic_extent_goto_char_p = 0;
2526 #ifdef AMPERSAND_FULL_NAME
2527 Fprovide(intern("ampersand-full-name"));
2530 DEFVAR_LISP ("user-full-name", &Vuser_full_name /*
2531 *The name of the user.
2532 The function `user-full-name', which will return the value of this
2533 variable, when called without arguments.
2534 This is initialized to the value of the NAME environment variable.
2536 /* Initialized at run-time. */
2537 Vuser_full_name = Qnil;