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"
49 /* Some static data, and a function to initialize it for each run */
51 Lisp_Object Vsystem_name; /* #### - I don't see why this should be */
52 /* static, either... --Stig */
53 #if 0 /* XEmacs - this is now dynamic */
54 /* if at some point it's deemed desirable to
55 use lisp variables here, then they can be
56 initialized to nil and then set to their
57 real values upon the first call to the
58 functions that generate them. --stig */
59 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
60 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER. */
63 /* It's useful to be able to set this as user customization, so we'll
65 Lisp_Object Vuser_full_name;
66 EXFUN (Fuser_full_name, 1);
68 char *get_system_name (void);
72 Lisp_Object Qpoint, Qmark, Qregion_beginning, Qregion_end;
74 Lisp_Object Quser_files_and_directories;
76 /* This holds the value of `environ' produced by the previous
77 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
78 has never been called. */
79 static char **environbuf;
84 /* Only used in removed code below. */
89 /* Set up system_name even when dumping. */
97 if ((p = getenv ("NAME")))
98 /* I don't think it's the right thing to do the ampersand
99 modification on NAME. Not that it matters anymore... -hniksic */
100 Vuser_full_name = build_ext_string (p, FORMAT_OS);
102 Vuser_full_name = Fuser_full_name (Qnil);
105 DEFUN ("char-to-string", Fchar_to_string, 1, 1, 0, /*
106 Convert arg CH to a one-character string containing that character.
111 Bufbyte str[MAX_EMCHAR_LEN];
115 Lisp_Object ch2 = Fevent_to_character (ch, Qt, Qnil, Qnil);
118 signal_simple_continuable_error
119 ("character has no ASCII equivalent:", Fcopy_event (ch, Qnil));
123 CHECK_CHAR_COERCE_INT (ch);
125 len = set_charptr_emchar (str, XCHAR (ch));
126 return make_string (str, len);
129 DEFUN ("string-to-char", Fstring_to_char, 1, 1, 0, /*
130 Convert arg STRING to a character, the first character of that string.
131 An empty string will return the constant `nil'.
135 struct Lisp_String *p;
139 if (string_length (p) != 0)
140 return make_char (string_char (p, 0));
142 /* This used to return Qzero. That is broken, broken, broken. */
143 /* It might be kinder to signal an error directly. -slb */
149 buildmark (Bufpos val, Lisp_Object buffer)
151 Lisp_Object mark = Fmake_marker ();
152 Fset_marker (mark, make_int (val), buffer);
156 DEFUN ("point", Fpoint, 0, 1, 0, /*
157 Return value of point, as an integer.
158 Beginning of buffer is position (point-min).
159 If BUFFER is nil, the current buffer is assumed.
163 struct buffer *b = decode_buffer (buffer, 1);
164 return make_int (BUF_PT (b));
167 DEFUN ("point-marker", Fpoint_marker, 0, 2, 0, /*
168 Return value of point, as a marker object.
169 This marker is a copy; you may modify it with reckless abandon.
170 If optional argument DONT-COPY-P is non-nil, then it returns the real
171 point-marker; modifying the position of this marker will move point.
172 It is illegal to change the buffer of it, or make it point nowhere.
173 If BUFFER is nil, the current buffer is assumed.
175 (dont_copy_p, buffer))
177 struct buffer *b = decode_buffer (buffer, 1);
178 if (NILP (dont_copy_p))
179 return Fcopy_marker (b->point_marker, Qnil);
181 return b->point_marker;
184 /* The following two functions end up being identical but it's
185 cleaner to declare them separately. */
188 bufpos_clip_to_bounds (Bufpos lower, Bufpos num, Bufpos upper)
190 return (num < lower ? lower :
191 num > upper ? upper :
196 bytind_clip_to_bounds (Bytind lower, Bytind num, Bytind upper)
198 return (num < lower ? lower :
199 num > upper ? upper :
205 * There is no absolute way to determine if goto-char is the function
206 * being run. this-command doesn't work because it is often eval'd
207 * and this-command ends up set to eval-expression. So this flag gets
210 * Jamie thinks he's wrong, but we'll leave this in for now.
212 int atomic_extent_goto_char_p;
214 DEFUN ("goto-char", Fgoto_char, 1, 2, "NGoto char: ", /*
215 Set point to POSITION, a number or marker.
216 Beginning of buffer is position (point-min), end is (point-max).
217 If BUFFER is nil, the current buffer is assumed.
218 Return value of POSITION, as an integer.
222 struct buffer *b = decode_buffer (buffer, 1);
223 Bufpos n = get_buffer_pos_char (b, position, GB_COERCE_RANGE);
225 atomic_extent_goto_char_p = 1;
230 region_limit (int beginningp, struct buffer *b)
235 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
236 && NILP (b->mark_active))
237 Fsignal (Qmark_inactive, Qnil);
239 m = Fmarker_position (b->mark);
240 if (NILP (m)) error ("There is no region now");
241 if (!!(BUF_PT (b) < XINT (m)) == !!beginningp)
242 return make_int (BUF_PT (b));
247 DEFUN ("region-beginning", Fregion_beginning, 0, 1, 0, /*
248 Return position of beginning of region in BUFFER, as an integer.
249 If BUFFER is nil, the current buffer is assumed.
253 return region_limit (1, decode_buffer (buffer, 1));
256 DEFUN ("region-end", Fregion_end, 0, 1, 0, /*
257 Return position of end of region in BUFFER, as an integer.
258 If BUFFER is nil, the current buffer is assumed.
262 return region_limit (0, decode_buffer (buffer, 1));
265 /* Whether to use lispm-style active-regions */
268 /* Whether the zmacs region is active. This is not per-buffer because
269 there can be only one active region at a time. #### Now that the
270 zmacs region are not directly tied to the X selections this may not
271 necessarily have to be true. */
272 int zmacs_region_active_p;
274 int zmacs_region_stays;
276 Lisp_Object Qzmacs_update_region, Qzmacs_deactivate_region;
277 Lisp_Object Qzmacs_region_buffer;
280 zmacs_update_region (void)
282 /* This function can GC */
283 if (zmacs_region_active_p)
284 call0 (Qzmacs_update_region);
288 zmacs_deactivate_region (void)
290 /* This function can GC */
291 if (zmacs_region_active_p)
292 call0 (Qzmacs_deactivate_region);
296 zmacs_region_buffer (void)
298 if (zmacs_region_active_p)
299 return call0 (Qzmacs_region_buffer);
304 DEFUN ("mark-marker", Fmark_marker, 0, 2, 0, /*
305 Return this buffer's mark, as a marker object.
306 If `zmacs-regions' is true, then this returns nil unless the region is
307 currently in the active (highlighted) state. If optional argument FORCE
308 is t, this returns the mark (if there is one) regardless of the zmacs-region
309 state. You should *generally* not use the mark unless the region is active,
310 if the user has expressed a preference for the zmacs-region model.
311 Watch out! Moving this marker changes the mark position.
312 If you set the marker not to point anywhere, the buffer will have no mark.
313 If BUFFER is nil, the current buffer is assumed.
317 struct buffer *b = decode_buffer (buffer, 1);
318 if (! zmacs_regions || zmacs_region_active_p || !NILP (force))
324 /* The saved object is a cons:
326 (COPY-OF-POINT-MARKER . COPY-OF-MARK)
328 We used to have another cons for a VISIBLE-P element, which was t
329 if `(eq (current-buffer) (window-buffer (selected-window)))' but it
330 was unused for a long time, so I removed it. --hniksic */
332 save_excursion_save (void)
336 /* #### Huh? --hniksic */
337 /*if (preparing_for_armageddon) return Qnil;*/
339 #ifdef ERROR_CHECK_BUFPOS
340 assert (XINT (Fpoint (Qnil)) ==
341 XINT (Fmarker_position (Fpoint_marker (Qt, Qnil))));
346 return noseeum_cons (noseeum_copy_marker (b->point_marker, Qnil),
347 noseeum_copy_marker (b->mark, Qnil));
351 save_excursion_restore (Lisp_Object info)
353 Lisp_Object buffer = Fmarker_buffer (XCAR (info));
355 /* If buffer being returned to is now deleted, avoid error --
356 otherwise could get error here while unwinding to top level and
357 crash. In that case, Fmarker_buffer returns nil now. */
360 struct buffer *buf = XBUFFER (buffer);
363 set_buffer_internal (buf);
364 Fgoto_char (XCAR (info), buffer);
365 Fset_marker (buf->mark, XCDR (info), buffer);
367 #if 0 /* We used to make the current buffer visible in the selected window
368 if that was true previously. That avoids some anomalies.
369 But it creates others, and it wasn't documented, and it is simpler
370 and cleaner never to alter the window/buffer connections. */
371 /* I'm certain some code somewhere depends on this behavior. --jwz */
372 /* Even if it did, it certainly doesn't matter anymore, because
373 this has been the behavior for countless XEmacs releases
376 && (current_buffer != XBUFFER (XWINDOW (selected_window)->buffer)))
377 switch_to_buffer (Fcurrent_buffer (), Qnil);
383 /* Free all the junk we allocated, so that a `save-excursion' comes
384 for free in terms of GC junk. */
385 free_marker (XMARKER (XCAR (info)));
386 free_marker (XMARKER (XCDR (info)));
387 free_cons (XCONS (info));
391 DEFUN ("save-excursion", Fsave_excursion, 0, UNEVALLED, 0, /*
392 Save point, mark, and current buffer; execute BODY; restore those things.
393 Executes BODY just like `progn'.
394 The values of point, mark and the current buffer are restored
395 even in case of abnormal exit (throw or error).
399 /* This function can GC */
400 int speccount = specpdl_depth ();
402 record_unwind_protect (save_excursion_restore, save_excursion_save ());
404 return unbind_to (speccount, Fprogn (args));
408 save_current_buffer_restore (Lisp_Object buffer)
410 struct buffer *buf = XBUFFER (buffer);
411 /* Avoid signaling an error if the buffer is no longer alive. This
412 is for consistency with save-excursion. */
413 if (BUFFER_LIVE_P (buf))
414 set_buffer_internal (buf);
418 DEFUN ("save-current-buffer", Fsave_current_buffer, 0, UNEVALLED, 0, /*
419 Save the current buffer; execute BODY; restore the current buffer.
420 Executes BODY just like `progn'.
424 /* This function can GC */
425 int speccount = specpdl_depth ();
427 record_unwind_protect (save_current_buffer_restore, Fcurrent_buffer ());
429 return unbind_to (speccount, Fprogn (args));
432 DEFUN ("buffer-size", Fbuffer_size, 0, 1, 0, /*
433 Return the number of characters in BUFFER.
434 If BUFFER is nil, the current buffer is assumed.
438 struct buffer *b = decode_buffer (buffer, 1);
439 return make_int (BUF_SIZE (b));
442 DEFUN ("point-min", Fpoint_min, 0, 1, 0, /*
443 Return the minimum permissible value of point in BUFFER.
444 This is 1, unless narrowing (a buffer restriction) is in effect.
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) is in effect.
456 If BUFFER is nil, the current buffer is assumed.
460 struct buffer *b = decode_buffer (buffer, 1);
461 return buildmark (BUF_BEGV (b), make_buffer (b));
464 DEFUN ("point-max", Fpoint_max, 0, 1, 0, /*
465 Return the maximum permissible value of point in BUFFER.
466 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
467 is in effect, in which case it is less.
468 If BUFFER is nil, the current buffer is assumed.
472 struct buffer *b = decode_buffer (buffer, 1);
473 return make_int (BUF_ZV (b));
476 DEFUN ("point-max-marker", Fpoint_max_marker, 0, 1, 0, /*
477 Return a marker to the maximum permissible value of point BUFFER.
478 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
479 is in effect, in which case it is less.
480 If BUFFER is nil, the current buffer is assumed.
484 struct buffer *b = decode_buffer (buffer, 1);
485 return buildmark (BUF_ZV (b), make_buffer (b));
488 DEFUN ("following-char", Ffollowing_char, 0, 1, 0, /*
489 Return the character following point.
490 At the end of the buffer or accessible region, return 0.
491 If BUFFER is nil, the current buffer is assumed.
495 struct buffer *b = decode_buffer (buffer, 1);
496 if (BUF_PT (b) >= BUF_ZV (b))
497 return Qzero; /* #### Gag me! */
499 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b)));
502 DEFUN ("preceding-char", Fpreceding_char, 0, 1, 0, /*
503 Return the character preceding point.
504 At the beginning of the buffer or accessible region, return 0.
505 If BUFFER is nil, the current buffer is assumed.
509 struct buffer *b = decode_buffer (buffer, 1);
510 if (BUF_PT (b) <= BUF_BEGV (b))
511 return Qzero; /* #### Gag me! */
513 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b) - 1));
516 DEFUN ("bobp", Fbobp, 0, 1, 0, /*
517 Return t if point is at the beginning of the buffer.
518 If the buffer is narrowed, this means the beginning of the narrowed part.
519 If BUFFER is nil, the current buffer is assumed.
523 struct buffer *b = decode_buffer (buffer, 1);
524 return BUF_PT (b) == BUF_BEGV (b) ? Qt : Qnil;
527 DEFUN ("eobp", Feobp, 0, 1, 0, /*
528 Return t if point is at the end of the buffer.
529 If the buffer is narrowed, this means the end of the narrowed part.
530 If BUFFER is nil, the current buffer is assumed.
534 struct buffer *b = decode_buffer (buffer, 1);
535 return BUF_PT (b) == BUF_ZV (b) ? Qt : Qnil;
539 beginning_of_line_p (struct buffer *b, Bufpos pt)
541 return pt <= BUF_BEGV (b) || BUF_FETCH_CHAR (b, pt - 1) == '\n';
545 DEFUN ("bolp", Fbolp, 0, 1, 0, /*
546 Return t if point is at the beginning of a line.
547 If BUFFER is nil, the current buffer is assumed.
551 struct buffer *b = decode_buffer (buffer, 1);
552 return beginning_of_line_p (b, BUF_PT (b)) ? Qt : Qnil;
555 DEFUN ("eolp", Feolp, 0, 1, 0, /*
556 Return t if point is at the end of a line.
557 `End of a line' includes point being at the end of the buffer.
558 If BUFFER is nil, the current buffer is assumed.
562 struct buffer *b = decode_buffer (buffer, 1);
563 return (BUF_PT (b) == BUF_ZV (b) || BUF_FETCH_CHAR (b, BUF_PT (b)) == '\n')
567 DEFUN ("char-after", Fchar_after, 0, 2, 0, /*
568 Return character in BUFFER at position POS.
569 POS is an integer or a buffer pointer.
570 If POS is out of range, the value is nil.
571 If BUFFER is nil, the current buffer is assumed.
572 if POS is nil, the value of point is assumed.
576 struct buffer *b = decode_buffer (buffer, 1);
577 Bufpos n = (NILP (pos) ? BUF_PT (b) :
578 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD));
580 if (n < 0 || n == BUF_ZV (b))
582 return make_char (BUF_FETCH_CHAR (b, n));
585 DEFUN ("char-before", Fchar_before, 0, 2, 0, /*
586 Return character in BUFFER before position POS.
587 POS is an integer or a buffer pointer.
588 If POS is out of range, the value is nil.
589 If BUFFER is nil, the current buffer is assumed.
590 if POS is nil, the value of point is assumed.
594 struct buffer *b = decode_buffer (buffer, 1);
595 Bufpos n = ((NILP (pos) ? BUF_PT (b) :
596 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD)));
600 if (n < BUF_BEGV (b))
602 return make_char (BUF_FETCH_CHAR (b, n));
606 DEFUN ("temp-directory", Ftemp_directory, 0, 0, 0, /*
607 Return the pathname to the directory to use for temporary files.
608 On NT/MSDOS, this is obtained from the TEMP or TMP environment variables,
609 defaulting to / if they are both undefined.
610 On Unix it is obtained from TMPDIR, with /tmp as the default
615 #if defined(WINDOWSNT) || defined(MSDOS)
616 tmpdir = getenv ("TEMP");
618 tmpdir = getenv ("TMP");
621 #else /* WINDOWSNT || MSDOS */
622 tmpdir = getenv ("TMPDIR");
627 return build_ext_string (tmpdir, FORMAT_FILENAME);
630 DEFUN ("user-login-name", Fuser_login_name, 0, 1, 0, /*
631 Return the name under which the user logged in, as a string.
632 This is based on the effective uid, not the real uid.
633 Also, if the environment variable LOGNAME or USER is set,
634 that determines the value of this function.
635 If the optional argument UID is present, then environment variables are
636 ignored and this function returns the login name for that UID, or nil.
646 local_uid = XINT(uid);
647 returned_name = user_login_name(&local_uid);
651 returned_name = user_login_name(NULL);
653 /* #### - I believe this should return nil instead of "unknown" when pw==0
654 pw=0 is indicated by a null return from user_login_name
656 return returned_name ? build_string (returned_name) : Qnil;
659 /* This function may be called from other C routines when a
660 character string representation of the user_login_name is
661 needed but a Lisp Object is not. The UID is passed by
662 reference. If UID == NULL, then the USER name
663 for the user running XEmacs will be returned. This
664 corresponds to a nil argument to Fuser_login_name.
667 user_login_name (int *uid)
669 struct passwd *pw = NULL;
671 /* uid == NULL to return name of this user */
674 pw = getpwuid (*uid);
675 return pw ? pw->pw_name : NULL;
679 /* #### - when euid != uid, then LOGNAME and USER are leftovers from the
680 old environment (I site observed behavior on sunos and linux), so the
681 environment variables should be disregarded in that case. --Stig */
682 char *user_name = getenv ("LOGNAME");
686 "USERNAME" /* it's USERNAME on NT */
695 pw = getpwuid (geteuid ());
697 /* Since the Cygwin environment may not have an /etc/passwd,
698 return "unknown" instead of the null if the username
699 cannot be determined.
701 return pw ? pw->pw_name : "unknown";
703 /* For all but Cygwin return NULL (nil) */
704 return pw ? pw->pw_name : NULL;
710 DEFUN ("user-real-login-name", Fuser_real_login_name, 0, 0, 0, /*
711 Return the name of the user's real uid, as a string.
712 This ignores the environment variables LOGNAME and USER, so it differs from
713 `user-login-name' when running under `su'.
717 struct passwd *pw = getpwuid (getuid ());
718 /* #### - I believe this should return nil instead of "unknown" when pw==0 */
721 /* We let the real user name default to "root" because that's quite
722 accurate on MSDOG and because it lets Emacs find the init file.
723 (The DVX libraries override the Djgpp libraries here.) */
724 Lisp_Object tem = build_string (pw ? pw->pw_name : "root");/* no gettext */
726 Lisp_Object tem = build_string (pw ? pw->pw_name : "unknown");/* no gettext */
731 DEFUN ("user-uid", Fuser_uid, 0, 0, 0, /*
732 Return the effective uid of Emacs, as an integer.
736 return make_int (geteuid ());
739 DEFUN ("user-real-uid", Fuser_real_uid, 0, 0, 0, /*
740 Return the real uid of Emacs, as an integer.
744 return make_int (getuid ());
747 DEFUN ("user-full-name", Fuser_full_name, 0, 1, 0, /*
748 Return the full name of the user logged in, as a string.
749 If the optional argument USER is given, then the full name for that
750 user is returned, or nil. USER may be either a login name or a uid.
752 If USER is nil, and `user-full-name' contains a string, the
753 value of `user-full-name' is returned.
757 Lisp_Object user_name;
758 struct passwd *pw = NULL;
762 if (NILP (user) && STRINGP (Vuser_full_name))
763 return Vuser_full_name;
765 user_name = (STRINGP (user) ? user : Fuser_login_name (user));
766 if (!NILP (user_name)) /* nil when nonexistent UID passed as arg */
768 CONST char *user_name_ext;
770 /* Fuck me. getpwnam() can call select() and (under IRIX at least)
771 things get wedged if a SIGIO arrives during this time. */
772 GET_C_STRING_OS_DATA_ALLOCA (user_name, user_name_ext);
773 slow_down_interrupts ();
774 pw = (struct passwd *) getpwnam (user_name_ext);
775 speed_up_interrupts ();
778 /* #### - Stig sez: this should return nil instead of "unknown" when pw==0 */
779 /* Ben sez: bad idea because it's likely to break something */
780 #ifndef AMPERSAND_FULL_NAME
781 p = ((pw) ? USER_FULL_NAME : "unknown"); /* don't gettext */
784 p = ((pw) ? USER_FULL_NAME : "unknown"); /* don't gettext */
787 tem = ((!NILP (user) && !pw)
789 : make_ext_string ((Extbyte *) p, (q ? q - p : strlen (p)),
792 #ifdef AMPERSAND_FULL_NAME
795 p = (char *) XSTRING_DATA (tem);
797 /* Substitute the login name for the &, upcasing the first character. */
800 char *r = (char *) alloca (strlen (p) + XSTRING_LENGTH (user_name) + 1);
801 memcpy (r, p, q - p);
803 strcat (r, (char *) XSTRING_DATA (user_name));
804 /* #### current_buffer dependency! */
805 r[q - p] = UPCASE (current_buffer, r[q - p]);
807 tem = build_string (r);
810 #endif /* AMPERSAND_FULL_NAME */
815 static char *cached_home_directory;
818 uncache_home_directory (void)
820 cached_home_directory = NULL; /* in some cases, this may cause the leaking
824 /* Returns the home directory, in external format */
826 get_home_directory (void)
828 int output_home_warning = 0;
830 if (cached_home_directory == NULL)
832 if ((cached_home_directory = getenv("HOME")) == NULL)
834 #if defined(WINDOWSNT) && !defined(__CYGWIN32__)
835 char *homedrive, *homepath;
837 if ((homedrive = getenv("HOMEDRIVE")) != NULL &&
838 (homepath = getenv("HOMEPATH")) != NULL)
840 cached_home_directory =
841 (char *) xmalloc(strlen(homedrive) + strlen(homepath) + 1);
842 sprintf(cached_home_directory, "%s%s", homedrive, homepath);
848 * Use the current directory.
849 * This preserves the existing XEmacs behavior, but is different
852 if (initial_directory[0] != '\0')
854 cached_home_directory = initial_directory;
858 /* This will probably give the wrong value */
859 cached_home_directory = getcwd (NULL, 0);
863 * This is NT Emacs behavior
865 cached_home_directory = "C:\\";
866 output_home_warning = 1;
869 #else /* !WINDOWSNT */
872 * Using "/" isn't quite right, but what should we do?
873 * We probably should try to extract pw_dir from /etc/passwd,
874 * before falling back to this.
876 cached_home_directory = "/";
877 output_home_warning = 1;
878 #endif /* !WINDOWSNT */
880 if (initialized && output_home_warning)
882 warn_when_safe (Quser_files_and_directories, Qwarning, "\n"
883 " XEmacs was unable to determine a good value for the user's $HOME\n"
884 " directory, and will be using the value:\n"
886 " This is probably incorrect.",
887 cached_home_directory
891 return cached_home_directory;
894 DEFUN ("user-home-directory", Fuser_home_directory, 0, 0, 0, /*
895 Return the user's home directory, as a string.
899 char *path = get_home_directory ();
901 return path == NULL ? Qnil :
902 Fexpand_file_name (Fsubstitute_in_file_name
903 (build_ext_string (path, FORMAT_FILENAME)),
907 DEFUN ("system-name", Fsystem_name, 0, 0, 0, /*
908 Return the name of the machine you are running on, as a string.
912 return Fcopy_sequence (Vsystem_name);
915 /* For the benefit of callers who don't want to include lisp.h.
918 get_system_name (void)
920 return xstrdup ((char *) XSTRING_DATA (Vsystem_name));
923 DEFUN ("emacs-pid", Femacs_pid, 0, 0, 0, /*
924 Return the process ID of Emacs, as an integer.
928 return make_int (getpid ());
931 DEFUN ("current-time", Fcurrent_time, 0, 0, 0, /*
932 Return the current time, as the number of seconds since 1970-01-01 00:00:00.
933 The time is returned as a list of three integers. The first has the
934 most significant 16 bits of the seconds, while the second has the
935 least significant 16 bits. The third integer gives the microsecond
938 The microsecond count is zero on systems that do not provide
939 resolution finer than a second.
946 return list3 (make_int ((EMACS_SECS (t) >> 16) & 0xffff),
947 make_int ((EMACS_SECS (t) >> 0) & 0xffff),
948 make_int (EMACS_USECS (t)));
951 DEFUN ("current-process-time", Fcurrent_process_time, 0, 0, 0, /*
952 Return the amount of time used by this XEmacs process so far.
953 The return value is a list of three floating-point numbers, expressing
954 the user, system, and real times used by the process. The user time
955 measures the time actually spent by the CPU executing the code in this
956 process. The system time measures time spent by the CPU executing kernel
957 code on behalf of this process (e.g. I/O requests made by the process).
959 Note that the user and system times measure processor time, as opposed
960 to real time, and only accrue when the processor is actually doing
961 something: Time spent in an idle wait (waiting for user events to come
962 in or for I/O on a disk drive or other device to complete) does not
963 count. Thus, the user and system times will often be considerably
964 less than the real time.
966 Some systems do not allow the user and system times to be distinguished.
967 In this case, the user time will be the total processor time used by
968 the process, and the system time will be 0.
970 Some systems do not allow the real and processor times to be distinguished.
971 In this case, the user and real times will be the same and the system
976 double user, sys, real;
978 get_process_times (&user, &sys, &real);
979 return list3 (make_float (user), make_float (sys), make_float (real));
983 int lisp_to_time (Lisp_Object specified_time, time_t *result);
985 lisp_to_time (Lisp_Object specified_time, time_t *result)
987 Lisp_Object high, low;
989 if (NILP (specified_time))
990 return time (result) != -1;
992 CHECK_CONS (specified_time);
993 high = XCAR (specified_time);
994 low = XCDR (specified_time);
999 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1000 return *result >> 16 == XINT (high);
1003 Lisp_Object time_to_lisp (time_t the_time);
1005 time_to_lisp (time_t the_time)
1007 unsigned int item = (unsigned int) the_time;
1008 return Fcons (make_int (item >> 16), make_int (item & 0xffff));
1011 size_t emacs_strftime (char *string, size_t max, CONST char *format,
1012 CONST struct tm *tm);
1013 static long difftm (CONST struct tm *a, CONST struct tm *b);
1016 DEFUN ("format-time-string", Fformat_time_string, 1, 2, 0, /*
1017 Use FORMAT-STRING to format the time TIME.
1018 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from
1019 `current-time' and `file-attributes'. If TIME is not specified it
1020 defaults to the current time.
1021 FORMAT-STRING may contain %-sequences to substitute parts of the time.
1022 %a is replaced by the abbreviated name of the day of week.
1023 %A is replaced by the full name of the day of week.
1024 %b is replaced by the abbreviated name of the month.
1025 %B is replaced by the full name of the month.
1026 %c is a synonym for "%x %X".
1027 %C is a locale-specific synonym, which defaults to "%A, %B %e, %Y" in the C locale.
1028 %d is replaced by the day of month, zero-padded.
1029 %D is a synonym for "%m/%d/%y".
1030 %e is replaced by the day of month, blank-padded.
1031 %h is a synonym for "%b".
1032 %H is replaced by the hour (00-23).
1033 %I is replaced by the hour (00-12).
1034 %j is replaced by the day of the year (001-366).
1035 %k is replaced by the hour (0-23), blank padded.
1036 %l is replaced by the hour (1-12), blank padded.
1037 %m is replaced by the month (01-12).
1038 %M is replaced by the minute (00-59).
1039 %n is a synonym for "\\n".
1040 %p is replaced by AM or PM, as appropriate.
1041 %r is a synonym for "%I:%M:%S %p".
1042 %R is a synonym for "%H:%M".
1043 %S is replaced by the second (00-60).
1044 %t is a synonym for "\\t".
1045 %T is a synonym for "%H:%M:%S".
1046 %U is replaced by the week of the year (00-53), first day of week is Sunday.
1047 %w is replaced by the day of week (0-6), Sunday is day 0.
1048 %W is replaced by the week of the year (00-53), first day of week is Monday.
1049 %x is a locale-specific synonym, which defaults to "%D" in the C locale.
1050 %X is a locale-specific synonym, which defaults to "%T" in the C locale.
1051 %y is replaced by the year without century (00-99).
1052 %Y is replaced by the year with century.
1053 %Z is replaced by the time zone abbreviation.
1055 The number of options reflects the `strftime' function.
1057 BUG: If the charset used by the current locale is not ISO 8859-1, the
1058 characters appearing in the day and month names may be incorrect.
1060 (format_string, time_))
1065 CHECK_STRING (format_string);
1067 if (! lisp_to_time (time_, &value))
1068 error ("Invalid time specification");
1070 /* This is probably enough. */
1071 size = XSTRING_LENGTH (format_string) * 6 + 50;
1075 char *buf = (char *) alloca (size);
1077 if (emacs_strftime (buf, size,
1078 (CONST char *) XSTRING_DATA (format_string),
1081 return build_ext_string (buf, FORMAT_BINARY);
1082 /* If buffer was too small, make it bigger. */
1087 DEFUN ("decode-time", Fdecode_time, 0, 1, 0, /*
1088 Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1089 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)
1090 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'
1091 to use the current time. The list has the following nine members:
1092 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which
1093 only some operating systems support. MINUTE is an integer between 0 and 59.
1094 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.
1095 MONTH is an integer between 1 and 12. YEAR is an integer indicating the
1096 four-digit year. DOW is the day of week, an integer between 0 and 6, where
1097 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.
1098 ZONE is an integer indicating the number of seconds east of Greenwich.
1099 \(Note that Common Lisp has different meanings for DOW and ZONE.)
1105 struct tm *decoded_time;
1106 Lisp_Object list_args[9];
1108 if (! lisp_to_time (specified_time, &time_spec))
1109 error ("Invalid time specification");
1111 decoded_time = localtime (&time_spec);
1112 list_args[0] = make_int (decoded_time->tm_sec);
1113 list_args[1] = make_int (decoded_time->tm_min);
1114 list_args[2] = make_int (decoded_time->tm_hour);
1115 list_args[3] = make_int (decoded_time->tm_mday);
1116 list_args[4] = make_int (decoded_time->tm_mon + 1);
1117 list_args[5] = make_int (decoded_time->tm_year + 1900);
1118 list_args[6] = make_int (decoded_time->tm_wday);
1119 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1121 /* Make a copy, in case gmtime modifies the struct. */
1122 save_tm = *decoded_time;
1123 decoded_time = gmtime (&time_spec);
1124 if (decoded_time == 0)
1125 list_args[8] = Qnil;
1127 list_args[8] = make_int (difftm (&save_tm, decoded_time));
1128 return Flist (9, list_args);
1131 static void set_time_zone_rule (char *tzstring);
1133 DEFUN ("encode-time", Fencode_time, 6, MANY, 0, /*
1134 Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1135 This is the reverse operation of `decode-time', which see.
1136 ZONE defaults to the current time zone rule. This can
1137 be a string (as from `set-time-zone-rule'), or it can be a list
1138 \(as from `current-time-zone') or an integer (as from `decode-time')
1139 applied without consideration for daylight savings time.
1141 You can pass more than 7 arguments; then the first six arguments
1142 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1143 The intervening arguments are ignored.
1144 This feature lets (apply 'encode-time (decode-time ...)) work.
1146 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;
1147 for example, a DAY of 0 means the day preceding the given month.
1148 Year numbers less than 100 are treated just like other year numbers.
1149 If you want them to stand for years in this century, you must do that yourself.
1151 (int nargs, Lisp_Object *args))
1155 Lisp_Object zone = (nargs > 6) ? args[nargs - 1] : Qnil;
1157 CHECK_INT (*args); tm.tm_sec = XINT (*args++); /* second */
1158 CHECK_INT (*args); tm.tm_min = XINT (*args++); /* minute */
1159 CHECK_INT (*args); tm.tm_hour = XINT (*args++); /* hour */
1160 CHECK_INT (*args); tm.tm_mday = XINT (*args++); /* day */
1161 CHECK_INT (*args); tm.tm_mon = XINT (*args++) - 1; /* month */
1162 CHECK_INT (*args); tm.tm_year = XINT (*args++) - 1900;/* year */
1169 the_time = mktime (&tm);
1174 char **oldenv = environ, **newenv;
1177 tzstring = (char *) XSTRING_DATA (zone);
1178 else if (INTP (zone))
1180 int abszone = abs (XINT (zone));
1181 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1182 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1186 error ("Invalid time zone specification");
1188 /* Set TZ before calling mktime; merely adjusting mktime's returned
1189 value doesn't suffice, since that would mishandle leap seconds. */
1190 set_time_zone_rule (tzstring);
1192 the_time = mktime (&tm);
1194 /* Restore TZ to previous value. */
1198 #ifdef LOCALTIME_CACHE
1203 if (the_time == (time_t) -1)
1204 error ("Specified time is not representable");
1206 return wasteful_word_to_lisp (the_time);
1209 DEFUN ("current-time-string", Fcurrent_time_string, 0, 1, 0, /*
1210 Return the current time, as a human-readable string.
1211 Programs can use this function to decode a time,
1212 since the number of columns in each field is fixed.
1213 The format is `Sun Sep 16 01:03:52 1973'.
1214 If an argument is given, it specifies a time to format
1215 instead of the current time. The argument should have the form:
1218 (HIGH LOW . IGNORED).
1219 Thus, you can use times obtained from `current-time'
1220 and from `file-attributes'.
1228 if (! lisp_to_time (specified_time, &value))
1230 tem = (char *) ctime (&value);
1232 strncpy (buf, tem, 24);
1235 return build_ext_string (buf, FORMAT_BINARY);
1238 #define TM_YEAR_ORIGIN 1900
1240 /* Yield A - B, measured in seconds. */
1242 difftm (CONST struct tm *a, CONST struct tm *b)
1244 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
1245 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
1246 /* Some compilers can't handle this as a single return statement. */
1248 /* difference in day of year */
1249 a->tm_yday - b->tm_yday
1250 /* + intervening leap days */
1251 + ((ay >> 2) - (by >> 2))
1253 + ((ay/100 >> 2) - (by/100 >> 2))
1254 /* + difference in years * 365 */
1255 + (long)(ay-by) * 365
1257 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
1258 + (a->tm_min - b->tm_min))
1259 + (a->tm_sec - b->tm_sec));
1262 DEFUN ("current-time-zone", Fcurrent_time_zone, 0, 1, 0, /*
1263 Return the offset and name for the local time zone.
1264 This returns a list of the form (OFFSET NAME).
1265 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1266 A negative value means west of Greenwich.
1267 NAME is a string giving the name of the time zone.
1268 If an argument is given, it specifies when the time zone offset is determined
1269 instead of using the current time. The argument should have the form:
1272 (HIGH LOW . IGNORED).
1273 Thus, you can use times obtained from `current-time'
1274 and from `file-attributes'.
1276 Some operating systems cannot provide all this information to Emacs;
1277 in this case, `current-time-zone' returns a list containing nil for
1278 the data it can't find.
1283 struct tm *t = NULL;
1285 if (lisp_to_time (specified_time, &value)
1286 && (t = gmtime (&value)) != 0)
1288 struct tm gmt = *t; /* Make a copy, in case localtime modifies *t. */
1292 t = localtime (&value);
1293 offset = difftm (t, &gmt);
1297 s = (char *)t->tm_zone;
1298 #else /* not HAVE_TM_ZONE */
1300 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1301 s = tzname[t->tm_isdst];
1303 #endif /* not HAVE_TM_ZONE */
1306 /* No local time zone name is available; use "+-NNNN" instead. */
1307 int am = (offset < 0 ? -offset : offset) / 60;
1308 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1311 return list2 (make_int (offset), build_string (s));
1314 return list2 (Qnil, Qnil);
1317 #ifdef LOCALTIME_CACHE
1319 /* These two values are known to load tz files in buggy implementations,
1320 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1321 Their values shouldn't matter in non-buggy implementations.
1322 We don't use string literals for these strings,
1323 since if a string in the environment is in readonly
1324 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1325 See Sun bugs 1113095 and 1114114, ``Timezone routines
1326 improperly modify environment''. */
1328 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1329 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1333 /* Set the local time zone rule to TZSTRING.
1334 This allocates memory into `environ', which it is the caller's
1335 responsibility to free. */
1337 set_time_zone_rule (char *tzstring)
1340 char **from, **to, **newenv;
1342 for (from = environ; *from; from++)
1344 envptrs = from - environ + 2;
1345 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1346 + (tzstring ? strlen (tzstring) + 4 : 0));
1349 char *t = (char *) (to + envptrs);
1351 strcat (t, tzstring);
1355 for (from = environ; *from; from++)
1356 if (strncmp (*from, "TZ=", 3) != 0)
1362 #ifdef LOCALTIME_CACHE
1364 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1365 "US/Pacific" that loads a tz file, then changes to a value like
1366 "XXX0" that does not load a tz file, and then changes back to
1367 its original value, the last change is (incorrectly) ignored.
1368 Also, if TZ changes twice in succession to values that do
1369 not load a tz file, tzset can dump core (see Sun bug#1225179).
1370 The following code works around these bugs. */
1374 /* Temporarily set TZ to a value that loads a tz file
1375 and that differs from tzstring. */
1377 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1378 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1384 /* The implied tzstring is unknown, so temporarily set TZ to
1385 two different values that each load a tz file. */
1386 *to = set_time_zone_rule_tz1;
1389 *to = set_time_zone_rule_tz2;
1394 /* Now TZ has the desired value, and tzset can be invoked safely. */
1401 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, 1, 1, 0, /*
1402 Set the local time zone using TZ, a string specifying a time zone rule.
1403 If TZ is nil, use implementation-defined default time zone information.
1414 tzstring = (char *) XSTRING_DATA (tz);
1417 set_time_zone_rule (tzstring);
1420 environbuf = environ;
1427 buffer_insert1 (struct buffer *buf, Lisp_Object arg)
1429 /* This function can GC */
1430 struct gcpro gcpro1;
1433 if (CHAR_OR_CHAR_INTP (arg))
1435 buffer_insert_emacs_char (buf, XCHAR_OR_CHAR_INT (arg));
1437 else if (STRINGP (arg))
1439 buffer_insert_lisp_string (buf, arg);
1443 arg = wrong_type_argument (Qchar_or_string_p, arg);
1446 zmacs_region_stays = 0;
1451 /* Callers passing one argument to Finsert need not gcpro the
1452 argument "array", since the only element of the array will
1453 not be used after calling insert_emacs_char or insert_lisp_string,
1454 so we don't care if it gets trashed. */
1456 DEFUN ("insert", Finsert, 0, MANY, 0, /*
1457 Insert the arguments, either strings or characters, at point.
1458 Point moves forward so that it ends up after the inserted text.
1459 Any other markers at the point of insertion remain before the text.
1460 If a string has non-null string-extent-data, new extents will be created.
1462 (int nargs, Lisp_Object *args))
1464 /* This function can GC */
1465 REGISTER int argnum;
1467 for (argnum = 0; argnum < nargs; argnum++)
1469 buffer_insert1 (current_buffer, args[argnum]);
1475 DEFUN ("insert-before-markers", Finsert_before_markers, 0, MANY, 0, /*
1476 Insert strings or characters at point, relocating markers after the text.
1477 Point moves forward so that it ends up after the inserted text.
1478 Any other markers at the point of insertion also end up after the text.
1480 (int nargs, Lisp_Object *args))
1482 /* This function can GC */
1483 REGISTER int argnum;
1484 REGISTER Lisp_Object tem;
1486 for (argnum = 0; argnum < nargs; argnum++)
1490 if (CHAR_OR_CHAR_INTP (tem))
1492 buffer_insert_emacs_char_1 (current_buffer, -1,
1493 XCHAR_OR_CHAR_INT (tem),
1494 INSDEL_BEFORE_MARKERS);
1496 else if (STRINGP (tem))
1498 buffer_insert_lisp_string_1 (current_buffer, -1, tem,
1499 INSDEL_BEFORE_MARKERS);
1503 tem = wrong_type_argument (Qchar_or_string_p, tem);
1507 zmacs_region_stays = 0;
1511 DEFUN ("insert-string", Finsert_string, 1, 2, 0, /*
1512 Insert STRING into BUFFER at BUFFER's point.
1513 Point moves forward so that it ends up after the inserted text.
1514 Any other markers at the point of insertion remain before the text.
1515 If a string has non-null string-extent-data, new extents will be created.
1516 BUFFER defaults to the current buffer.
1520 struct buffer *b = decode_buffer (buffer, 1);
1521 CHECK_STRING (string);
1522 buffer_insert_lisp_string (b, string);
1523 zmacs_region_stays = 0;
1527 /* Third argument in FSF is INHERIT:
1529 "The optional third arg INHERIT, if non-nil, says to inherit text properties
1530 from adjoining text, if those properties are sticky."
1532 Jamie thinks this is bogus. */
1535 DEFUN ("insert-char", Finsert_char, 1, 4, 0, /*
1536 Insert COUNT (second arg) copies of CHR (first arg).
1537 Point and all markers are affected as in the function `insert'.
1538 COUNT defaults to 1 if omitted.
1539 The optional third arg IGNORED is INHERIT under FSF Emacs.
1540 This is highly bogus, however, and XEmacs always behaves as if
1541 `t' were passed to INHERIT.
1542 The optional fourth arg BUFFER specifies the buffer to insert the
1543 text into. If BUFFER is nil, the current buffer is assumed.
1545 (chr, count, ignored, buffer))
1547 /* This function can GC */
1548 REGISTER Bufbyte *string;
1551 REGISTER Bytecount n;
1552 REGISTER Bytecount charlen;
1553 Bufbyte str[MAX_EMCHAR_LEN];
1554 struct buffer *b = decode_buffer (buffer, 1);
1557 CHECK_CHAR_COERCE_INT (chr);
1566 charlen = set_charptr_emchar (str, XCHAR (chr));
1570 slen = min (n, 768);
1571 string = alloca_array (Bufbyte, slen);
1572 /* Write as many copies of the character into the temp string as will fit. */
1573 for (i = 0; i + charlen <= slen; i += charlen)
1574 for (j = 0; j < charlen; j++)
1575 string[i + j] = str[j];
1579 buffer_insert_raw_string (b, string, slen);
1583 #if 0 /* FSFmacs bogosity */
1585 if (!NILP (inherit))
1586 insert_and_inherit (string, n);
1591 buffer_insert_raw_string (b, string, n);
1594 zmacs_region_stays = 0;
1599 /* Making strings from buffer contents. */
1601 DEFUN ("buffer-substring", Fbuffer_substring, 0, 3, 0, /*
1602 Return the contents of part of BUFFER as a string.
1603 The two arguments START and END are character positions;
1604 they can be in either order. If omitted, they default to the beginning
1605 and end of BUFFER, respectively.
1606 If there are duplicable extents in the region, the string remembers
1607 them in its extent data.
1608 If BUFFER is nil, the current buffer is assumed.
1610 (start, end, buffer))
1612 /* This function can GC */
1614 struct buffer *b = decode_buffer (buffer, 1);
1616 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1617 return make_string_from_buffer (b, begv, zv - begv);
1620 /* It might make more sense to name this
1621 `buffer-substring-no-extents', but this name is FSFmacs-compatible,
1622 and what the function does is probably good enough for what the
1623 user-code will typically want to use it for. */
1624 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties, 0, 3, 0, /*
1625 Return the text from BEG to END, as a string, without copying the extents.
1627 (start, end, buffer))
1629 /* This function can GC */
1631 struct buffer *b = decode_buffer (buffer, 1);
1633 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1634 return make_string_from_buffer_no_extents (b, begv, zv - begv);
1637 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, 1, 3, 0, /*
1638 Insert before point a substring of the contents of buffer BUFFER.
1639 BUFFER may be a buffer or a buffer name.
1640 Arguments START and END are character numbers specifying the substring.
1641 They default to the beginning and the end of BUFFER.
1643 (buffer, start, end))
1645 /* This function can GC */
1649 bp = XBUFFER (get_buffer (buffer, 1));
1650 get_buffer_range_char (bp, start, end, &b, &e, GB_ALLOW_NIL);
1653 buffer_insert_from_buffer (current_buffer, bp, b, e - b);
1658 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, 6, 6, 0, /*
1659 Compare two substrings of two buffers; return result as number.
1660 the value is -N if first string is less after N-1 chars,
1661 +N if first string is greater after N-1 chars, or 0 if strings match.
1662 Each substring is represented as three arguments: BUFFER, START and END.
1663 That makes six args in all, three for each substring.
1665 The value of `case-fold-search' in the current buffer
1666 determines whether case is significant or ignored.
1668 (buffer1, start1, end1, buffer2, start2, end2))
1670 Bufpos begp1, endp1, begp2, endp2;
1671 REGISTER Charcount len1, len2, length, i;
1672 struct buffer *bp1, *bp2;
1673 Lisp_Object trt = ((!NILP (current_buffer->case_fold_search)) ?
1674 current_buffer->case_canon_table : Qnil);
1676 /* Find the first buffer and its substring. */
1678 bp1 = decode_buffer (buffer1, 1);
1679 get_buffer_range_char (bp1, start1, end1, &begp1, &endp1, GB_ALLOW_NIL);
1681 /* Likewise for second substring. */
1683 bp2 = decode_buffer (buffer2, 1);
1684 get_buffer_range_char (bp2, start2, end2, &begp2, &endp2, GB_ALLOW_NIL);
1686 len1 = endp1 - begp1;
1687 len2 = endp2 - begp2;
1692 for (i = 0; i < length; i++)
1694 Emchar c1 = BUF_FETCH_CHAR (bp1, begp1 + i);
1695 Emchar c2 = BUF_FETCH_CHAR (bp2, begp2 + i);
1698 c1 = TRT_TABLE_OF (trt, c1);
1699 c2 = TRT_TABLE_OF (trt, c2);
1702 return make_int (- 1 - i);
1704 return make_int (i + 1);
1707 /* The strings match as far as they go.
1708 If one is shorter, that one is less. */
1710 return make_int (length + 1);
1711 else if (length < len2)
1712 return make_int (- length - 1);
1714 /* Same length too => they are equal. */
1720 subst_char_in_region_unwind (Lisp_Object arg)
1722 XBUFFER (XCAR (arg))->undo_list = XCDR (arg);
1727 subst_char_in_region_unwind_1 (Lisp_Object arg)
1729 XBUFFER (XCAR (arg))->filename = XCDR (arg);
1733 DEFUN ("subst-char-in-region", Fsubst_char_in_region, 4, 5, 0, /*
1734 From START to END, replace FROMCHAR with TOCHAR each time it occurs.
1735 If optional arg NOUNDO is non-nil, don't record this change for undo
1736 and don't mark the buffer as really changed.
1738 (start, end, fromchar, tochar, noundo))
1740 /* This function can GC */
1744 struct buffer *buf = current_buffer;
1745 int count = specpdl_depth ();
1747 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1748 CHECK_CHAR_COERCE_INT (fromchar);
1749 CHECK_CHAR_COERCE_INT (tochar);
1751 fromc = XCHAR (fromchar);
1752 toc = XCHAR (tochar);
1754 /* If we don't want undo, turn off putting stuff on the list.
1755 That's faster than getting rid of things,
1756 and it prevents even the entry for a first change.
1757 Also inhibit locking the file. */
1760 record_unwind_protect (subst_char_in_region_unwind,
1761 Fcons (Fcurrent_buffer (), buf->undo_list));
1762 buf->undo_list = Qt;
1763 /* Don't do file-locking. */
1764 record_unwind_protect (subst_char_in_region_unwind_1,
1765 Fcons (Fcurrent_buffer (), buf->filename));
1766 buf->filename = Qnil;
1769 mc_count = begin_multiple_change (buf, pos, stop);
1772 if (BUF_FETCH_CHAR (buf, pos) == fromc)
1774 /* There used to be some code here that set the buffer to
1775 unmodified if NOUNDO was specified and there was only
1776 one change to the buffer since it was last saved.
1777 This is a crock of shit, so I'm not duplicating this
1778 behavior. I think this was left over from when
1779 prepare_to_modify_buffer() actually bumped MODIFF,
1780 so that code was supposed to undo this change. --ben */
1781 buffer_replace_char (buf, pos, toc, !NILP (noundo), 0);
1783 /* If noundo is not nil then we don't mark the buffer as
1784 modified. In reality that needs to happen externally
1785 only. Internally redisplay needs to know that the actual
1786 contents it should be displaying have changed. */
1788 Fset_buffer_modified_p (Fbuffer_modified_p (Qnil), Qnil);
1792 end_multiple_change (buf, mc_count);
1794 unbind_to (count, Qnil);
1798 /* #### Shouldn't this also accept a BUFFER argument, in the good old
1799 XEmacs tradition? */
1800 DEFUN ("translate-region", Ftranslate_region, 3, 3, 0, /*
1801 Translate characters from START to END according to TABLE.
1803 If TABLE is a string, the Nth character in it is the mapping for the
1804 character with code N.
1806 If TABLE is a vector, its Nth element is the mapping for character
1807 with code N. The values of elements may be characters, strings, or
1808 nil (nil meaning don't replace.)
1810 If TABLE is a char-table, its elements describe the mapping between
1811 characters and their replacements. The char-table should be of type
1812 `char' or `generic'.
1814 Returns the number of substitutions performed.
1816 (start, end, table))
1818 /* This function can GC */
1819 Bufpos pos, stop; /* Limits of the region. */
1820 int cnt = 0; /* Number of changes made. */
1822 struct buffer *buf = current_buffer;
1825 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1826 mc_count = begin_multiple_change (buf, pos, stop);
1827 if (STRINGP (table))
1829 struct Lisp_String *stable = XSTRING (table);
1830 Charcount size = string_char_length (stable);
1832 /* Under Mule, string_char(n) is O(n), so for large tables or
1833 large regions it makes sense to create an array of Emchars. */
1834 if (size * (stop - pos) > 65536)
1836 Emchar *etable = alloca_array (Emchar, size);
1837 convert_bufbyte_string_into_emchar_string
1838 (string_data (stable), string_length (stable), etable);
1839 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1843 Emchar nc = etable[oc];
1846 buffer_replace_char (buf, pos, nc, 0, 0);
1855 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1859 Emchar nc = string_char (stable, oc);
1862 buffer_replace_char (buf, pos, nc, 0, 0);
1869 else if (VECTORP (table))
1871 Charcount size = XVECTOR_LENGTH (table);
1872 Lisp_Object *vtable = XVECTOR_DATA (table);
1874 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1878 Lisp_Object replacement = vtable[oc];
1880 if (CHAR_OR_CHAR_INTP (replacement))
1882 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1885 buffer_replace_char (buf, pos, nc, 0, 0);
1889 else if (STRINGP (replacement))
1891 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1892 buffer_delete_range (buf, pos, pos + 1, 0);
1893 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1894 pos += incr, stop += incr;
1897 else if (!NILP (replacement))
1899 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1905 else if (CHAR_TABLEP (table)
1906 && (XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC
1907 || XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR))
1909 struct Lisp_Char_Table *ctable = XCHAR_TABLE (table);
1911 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1913 Lisp_Object replacement = get_char_table (oc, ctable);
1915 if (CHAR_OR_CHAR_INTP (replacement))
1917 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1920 buffer_replace_char (buf, pos, nc, 0, 0);
1924 else if (STRINGP (replacement))
1926 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1927 buffer_delete_range (buf, pos, pos + 1, 0);
1928 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1929 pos += incr, stop += incr;
1932 else if (!NILP (replacement))
1934 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1940 dead_wrong_type_argument (Qstringp, table);
1941 end_multiple_change (buf, mc_count);
1943 return make_int (cnt);
1946 DEFUN ("delete-region", Fdelete_region, 2, 3, "r", /*
1947 Delete the text between point and mark.
1948 When called from a program, expects two arguments,
1949 positions (integers or markers) specifying the stretch to be deleted.
1950 If BUFFER is nil, the current buffer is assumed.
1954 /* This function can GC */
1956 struct buffer *buf = decode_buffer (buffer, 1);
1958 get_buffer_range_char (buf, b, e, &start, &end, 0);
1959 buffer_delete_range (buf, start, end, 0);
1960 zmacs_region_stays = 0;
1965 widen_buffer (struct buffer *b, int no_clip)
1967 if (BUF_BEGV (b) != BUF_BEG (b))
1970 SET_BOTH_BUF_BEGV (b, BUF_BEG (b), BI_BUF_BEG (b));
1972 if (BUF_ZV (b) != BUF_Z (b))
1975 SET_BOTH_BUF_ZV (b, BUF_Z (b), BI_BUF_Z (b));
1981 /* Changing the buffer bounds invalidates any recorded current
1983 invalidate_current_column ();
1984 narrow_line_number_cache (b);
1988 DEFUN ("widen", Fwiden, 0, 1, "", /*
1989 Remove restrictions (narrowing) from BUFFER.
1990 This allows the buffer's full text to be seen and edited.
1991 If BUFFER is nil, the current buffer is assumed.
1995 struct buffer *b = decode_buffer (buffer, 1);
1996 widen_buffer (b, 0);
1997 zmacs_region_stays = 0;
2001 DEFUN ("narrow-to-region", Fnarrow_to_region, 2, 3, "r", /*
2002 Restrict editing in BUFFER to the current region.
2003 The rest of the text becomes temporarily invisible and untouchable
2004 but is not deleted; if you save the buffer in a file, the invisible
2005 text is included in the file. \\[widen] makes all visible again.
2006 If BUFFER is nil, the current buffer is assumed.
2007 See also `save-restriction'.
2009 When calling from a program, pass two arguments; positions (integers
2010 or markers) bounding the text that should remain visible.
2015 struct buffer *buf = decode_buffer (buffer, 1);
2016 Bytind bi_start, bi_end;
2018 get_buffer_range_char (buf, b, e, &start, &end, GB_ALLOW_PAST_ACCESSIBLE);
2019 bi_start = bufpos_to_bytind (buf, start);
2020 bi_end = bufpos_to_bytind (buf, end);
2022 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2023 SET_BOTH_BUF_ZV (buf, end, bi_end);
2024 if (BUF_PT (buf) < start)
2025 BUF_SET_PT (buf, start);
2026 if (BUF_PT (buf) > end)
2027 BUF_SET_PT (buf, end);
2029 /* Changing the buffer bounds invalidates any recorded current column. */
2030 invalidate_current_column ();
2031 narrow_line_number_cache (buf);
2032 zmacs_region_stays = 0;
2037 save_restriction_save (void)
2039 Lisp_Object bottom, top;
2040 /* Note: I tried using markers here, but it does not win
2041 because insertion at the end of the saved region
2042 does not advance mh and is considered "outside" the saved region. */
2043 bottom = make_int (BUF_BEGV (current_buffer) - BUF_BEG (current_buffer));
2044 top = make_int (BUF_Z (current_buffer) - BUF_ZV (current_buffer));
2046 return noseeum_cons (Fcurrent_buffer (), noseeum_cons (bottom, top));
2050 save_restriction_restore (Lisp_Object data)
2053 Charcount newhead, newtail;
2055 int local_clip_changed = 0;
2057 buf = XBUFFER (XCAR (data));
2058 if (!BUFFER_LIVE_P (buf))
2060 /* someone could have killed the buffer in the meantime ... */
2061 free_cons (XCONS (XCDR (data)));
2062 free_cons (XCONS (data));
2066 newhead = XINT (XCAR (tem));
2067 newtail = XINT (XCDR (tem));
2069 free_cons (XCONS (XCDR (data)));
2070 free_cons (XCONS (data));
2072 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
2080 Bytind bi_start, bi_end;
2082 start = BUF_BEG (buf) + newhead;
2083 end = BUF_Z (buf) - newtail;
2085 bi_start = bufpos_to_bytind (buf, start);
2086 bi_end = bufpos_to_bytind (buf, end);
2088 if (BUF_BEGV (buf) != start)
2090 local_clip_changed = 1;
2091 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2092 narrow_line_number_cache (buf);
2094 if (BUF_ZV (buf) != end)
2096 local_clip_changed = 1;
2097 SET_BOTH_BUF_ZV (buf, end, bi_end);
2100 if (local_clip_changed)
2103 /* If point is outside the new visible range, move it inside. */
2105 bufpos_clip_to_bounds (BUF_BEGV (buf),
2112 DEFUN ("save-restriction", Fsave_restriction, 0, UNEVALLED, 0, /*
2113 Execute BODY, saving and restoring current buffer's restrictions.
2114 The buffer's restrictions make parts of the beginning and end invisible.
2115 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
2116 This special form, `save-restriction', saves the current buffer's restrictions
2117 when it is entered, and restores them when it is exited.
2118 So any `narrow-to-region' within BODY lasts only until the end of the form.
2119 The old restrictions settings are restored
2120 even in case of abnormal exit (throw or error).
2122 The value returned is the value of the last form in BODY.
2124 `save-restriction' can get confused if, within the BODY, you widen
2125 and then make changes outside the area within the saved restrictions.
2127 Note: if you are using both `save-excursion' and `save-restriction',
2128 use `save-excursion' outermost:
2129 (save-excursion (save-restriction ...))
2133 /* This function can GC */
2134 int speccount = specpdl_depth ();
2136 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2138 return unbind_to (speccount, Fprogn (body));
2142 DEFUN ("format", Fformat, 1, MANY, 0, /*
2143 Format a string out of a control-string and arguments.
2144 The first argument is a control string.
2145 The other arguments are substituted into it to make the result, a string.
2146 It may contain %-sequences meaning to substitute the next argument.
2147 %s means print all objects as-is, using `princ'.
2148 %S means print all objects as s-expressions, using `prin1'.
2149 %d or %i means print as an integer in decimal (%o octal, %x lowercase hex,
2151 %c means print as a single character.
2152 %f means print as a floating-point number in fixed notation (e.g. 785.200).
2153 %e or %E means print as a floating-point number in scientific notation
2155 %g or %G means print as a floating-point number in "pretty format";
2156 depending on the number, either %f or %e/%E format will be used, and
2157 trailing zeroes are removed from the fractional part.
2158 The argument used for all but %s and %S must be a number. It will be
2159 converted to an integer or a floating-point number as necessary.
2161 %$ means reposition to read a specific numbered argument; for example,
2162 %3$s would apply the `%s' to the third argument after the control string,
2163 and the next format directive would use the fourth argument, the
2164 following one the fifth argument, etc. (There must be a positive integer
2165 between the % and the $).
2166 Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be
2167 specified between the optional repositioning spec and the conversion
2168 character; see below.
2169 An optional minimum field width may be specified after any flag characters
2170 and before the conversion character; it specifies the minimum number of
2171 characters that the converted argument will take up. Padding will be
2172 added on the left (or on the right, if the `-' flag is specified), as
2173 necessary. Padding is done with spaces, or with zeroes if the `0' flag
2175 If the field width is specified as `*', the field width is assumed to have
2176 been specified as an argument. Any repositioning specification that
2177 would normally specify the argument to be converted will now specify
2178 where to find this field width argument, not where to find the argument
2179 to be converted. If there is no repositioning specification, the normal
2180 next argument is used. The argument to be converted will be the next
2181 argument after the field width argument unless the precision is also
2182 specified as `*' (see below).
2184 An optional period character and precision may be specified after any
2185 minimum field width. It specifies the minimum number of digits to
2186 appear in %d, %i, %o, %x, and %X conversions (the number is padded
2187 on the left with zeroes as necessary); the number of digits printed
2188 after the decimal point for %f, %e, and %E conversions; the number
2189 of significant digits printed in %g and %G conversions; and the
2190 maximum number of non-padding characters printed in %s and %S
2191 conversions. The default precision for floating-point conversions
2193 If the precision is specified as `*', the precision is assumed to have been
2194 specified as an argument. The argument used will be the next argument
2195 after the field width argument, if any. If the field width was not
2196 specified as an argument, any repositioning specification that would
2197 normally specify the argument to be converted will now specify where to
2198 find the precision argument. If there is no repositioning specification,
2199 the normal next argument is used.
2201 The ` ' and `+' flags mean prefix non-negative numbers with a space or
2202 plus sign, respectively.
2203 The `#' flag means print numbers in an alternate, more verbose format:
2204 octal numbers begin with zero; hex numbers begin with a 0x or 0X;
2205 a decimal point is printed in %f, %e, and %E conversions even if no
2206 numbers are printed after it; and trailing zeroes are not omitted in
2207 %g and %G conversions.
2209 Use %% to put a single % into the output.
2211 (int nargs, Lisp_Object *args))
2213 /* It should not be necessary to GCPRO ARGS, because
2214 the caller in the interpreter should take care of that. */
2216 CHECK_STRING (args[0]);
2217 return emacs_doprnt_string_lisp (0, args[0], 0, nargs - 1, args + 1);
2221 DEFUN ("char-equal", Fchar_equal, 2, 3, 0, /*
2222 Return t if two characters match, optionally ignoring case.
2223 Both arguments must be characters (i.e. NOT integers).
2224 Case is ignored if `case-fold-search' is non-nil in BUFFER.
2225 If BUFFER is nil, the current buffer is assumed.
2230 struct buffer *b = decode_buffer (buffer, 1);
2232 CHECK_CHAR_COERCE_INT (c1);
2233 CHECK_CHAR_COERCE_INT (c2);
2237 return (!NILP (b->case_fold_search)
2238 ? DOWNCASE (b, x1) == DOWNCASE (b, x2)
2243 DEFUN ("char=", Fchar_Equal, 2, 3, 0, /*
2244 Return t if two characters match, case is significant.
2245 Both arguments must be characters (i.e. NOT integers).
2246 The optional buffer argument is for symmetry and is ignored.
2250 CHECK_CHAR_COERCE_INT (c1);
2251 CHECK_CHAR_COERCE_INT (c2);
2253 return XCHAR(c1) == XCHAR(c2) ? Qt : Qnil;
2256 #if 0 /* Undebugged FSFmacs code */
2257 /* Transpose the markers in two regions of the current buffer, and
2258 adjust the ones between them if necessary (i.e.: if the regions
2261 Traverses the entire marker list of the buffer to do so, adding an
2262 appropriate amount to some, subtracting from some, and leaving the
2263 rest untouched. Most of this is copied from adjust_markers in insdel.c.
2265 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
2268 transpose_markers (Bufpos start1, Bufpos end1, Bufpos start2, Bufpos end2)
2270 Charcount amt1, amt2, diff;
2272 struct buffer *buf = current_buffer;
2274 /* Update point as if it were a marker. */
2275 if (BUF_PT (buf) < start1)
2277 else if (BUF_PT (buf) < end1)
2278 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - end1));
2279 else if (BUF_PT (buf) < start2)
2280 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - start2) - (end1 - start1));
2281 else if (BUF_PT (buf) < end2)
2282 BUF_SET_PT (buf, BUF_PT (buf) - (start2 - start1));
2284 /* We used to adjust the endpoints here to account for the gap, but that
2285 isn't good enough. Even if we assume the caller has tried to move the
2286 gap out of our way, it might still be at start1 exactly, for example;
2287 and that places it `inside' the interval, for our purposes. The amount
2288 of adjustment is nontrivial if there's a `denormalized' marker whose
2289 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
2290 the dirty work to Fmarker_position, below. */
2292 /* The difference between the region's lengths */
2293 diff = (end2 - start2) - (end1 - start1);
2295 /* For shifting each marker in a region by the length of the other
2296 * region plus the distance between the regions.
2298 amt1 = (end2 - start2) + (start2 - end1);
2299 amt2 = (end1 - start1) + (start2 - end1);
2301 for (marker = BUF_MARKERS (buf); !NILP (marker);
2302 marker = XMARKER (marker)->chain)
2304 Bufpos mpos = marker_position (marker);
2305 if (mpos >= start1 && mpos < end2)
2309 else if (mpos < start2)
2313 set_marker_position (marker, mpos);
2320 DEFUN ("transpose-regions", Ftranspose_regions, 4, 5, 0, /*
2321 Transpose region START1 to END1 with START2 to END2.
2322 The regions may not be overlapping, because the size of the buffer is
2323 never changed in a transposition.
2325 Optional fifth arg LEAVE_MARKERS, if non-nil, means don't transpose
2326 any markers that happen to be located in the regions. (#### BUG: currently
2327 this function always acts as if LEAVE_MARKERS is non-nil.)
2329 Transposing beyond buffer boundaries is an error.
2331 (startr1, endr1, startr2, endr2, leave_markers))
2333 Bufpos start1, end1, start2, end2;
2334 Charcount len1, len2;
2335 Lisp_Object string1, string2;
2336 struct buffer *buf = current_buffer;
2338 get_buffer_range_char (buf, startr1, endr1, &start1, &end1, 0);
2339 get_buffer_range_char (buf, startr2, endr2, &start2, &end2, 0);
2341 len1 = end1 - start1;
2342 len2 = end2 - start2;
2345 error ("transposed regions not properly ordered");
2346 else if (start1 == end1 || start2 == end2)
2347 error ("transposed region may not be of length 0");
2349 string1 = make_string_from_buffer (buf, start1, len1);
2350 string2 = make_string_from_buffer (buf, start2, len2);
2351 buffer_delete_range (buf, start2, end2, 0);
2352 buffer_insert_lisp_string_1 (buf, start2, string1, 0);
2353 buffer_delete_range (buf, start1, end1, 0);
2354 buffer_insert_lisp_string_1 (buf, start1, string2, 0);
2356 /* In FSFmacs there is a whole bunch of really ugly code here
2357 to attempt to transpose the regions without using up any
2358 extra memory. Although the intent may be good, the result
2359 was highly bogus. */
2365 /************************************************************************/
2366 /* initialization */
2367 /************************************************************************/
2370 syms_of_editfns (void)
2372 defsymbol (&Qpoint, "point");
2373 defsymbol (&Qmark, "mark");
2374 defsymbol (&Qregion_beginning, "region-beginning");
2375 defsymbol (&Qregion_end, "region-end");
2376 defsymbol (&Qformat, "format");
2377 defsymbol (&Quser_files_and_directories, "user-files-and-directories");
2379 DEFSUBR (Fchar_equal);
2380 DEFSUBR (Fchar_Equal);
2381 DEFSUBR (Fgoto_char);
2382 DEFSUBR (Fstring_to_char);
2383 DEFSUBR (Fchar_to_string);
2384 DEFSUBR (Fbuffer_substring);
2385 DEFSUBR (Fbuffer_substring_no_properties);
2387 DEFSUBR (Fpoint_marker);
2388 DEFSUBR (Fmark_marker);
2390 DEFSUBR (Fregion_beginning);
2391 DEFSUBR (Fregion_end);
2392 DEFSUBR (Fsave_excursion);
2393 DEFSUBR (Fsave_current_buffer);
2395 DEFSUBR (Fbuffer_size);
2396 DEFSUBR (Fpoint_max);
2397 DEFSUBR (Fpoint_min);
2398 DEFSUBR (Fpoint_min_marker);
2399 DEFSUBR (Fpoint_max_marker);
2405 DEFSUBR (Ffollowing_char);
2406 DEFSUBR (Fpreceding_char);
2407 DEFSUBR (Fchar_after);
2408 DEFSUBR (Fchar_before);
2410 DEFSUBR (Finsert_string);
2411 DEFSUBR (Finsert_before_markers);
2412 DEFSUBR (Finsert_char);
2414 DEFSUBR (Ftemp_directory);
2415 DEFSUBR (Fuser_login_name);
2416 DEFSUBR (Fuser_real_login_name);
2417 DEFSUBR (Fuser_uid);
2418 DEFSUBR (Fuser_real_uid);
2419 DEFSUBR (Fuser_full_name);
2420 DEFSUBR (Fuser_home_directory);
2421 DEFSUBR (Femacs_pid);
2422 DEFSUBR (Fcurrent_time);
2423 DEFSUBR (Fcurrent_process_time);
2424 DEFSUBR (Fformat_time_string);
2425 DEFSUBR (Fdecode_time);
2426 DEFSUBR (Fencode_time);
2427 DEFSUBR (Fcurrent_time_string);
2428 DEFSUBR (Fcurrent_time_zone);
2429 DEFSUBR (Fset_time_zone_rule);
2430 DEFSUBR (Fsystem_name);
2433 DEFSUBR (Finsert_buffer_substring);
2434 DEFSUBR (Fcompare_buffer_substrings);
2435 DEFSUBR (Fsubst_char_in_region);
2436 DEFSUBR (Ftranslate_region);
2437 DEFSUBR (Fdelete_region);
2439 DEFSUBR (Fnarrow_to_region);
2440 DEFSUBR (Fsave_restriction);
2441 DEFSUBR (Ftranspose_regions);
2443 defsymbol (&Qzmacs_update_region, "zmacs-update-region");
2444 defsymbol (&Qzmacs_deactivate_region, "zmacs-deactivate-region");
2445 defsymbol (&Qzmacs_region_buffer, "zmacs-region-buffer");
2449 vars_of_editfns (void)
2451 staticpro (&Vsystem_name);
2453 staticpro (&Vuser_name);
2454 staticpro (&Vuser_real_name);
2456 DEFVAR_BOOL ("zmacs-regions", &zmacs_regions /*
2457 *Whether LISPM-style active regions should be used.
2458 This means that commands which operate on the region (the area between the
2459 point and the mark) will only work while the region is in the ``active''
2460 state, which is indicated by highlighting. Executing most commands causes
2461 the region to not be in the active state, so (for example) \\[kill-region] will only
2462 work immediately after activating the region.
2466 - Commands which operate on the region only work if the region is active.
2467 - Only a very small set of commands cause the region to become active:
2468 Those commands whose semantics are to mark an area, like mark-defun.
2469 - The region is deactivated after each command that is executed, except that:
2470 - "Motion" commands do not change whether the region is active or not.
2472 set-mark-command (C-SPC) pushes a mark and activates the region. Moving the
2473 cursor with normal motion commands (C-n, C-p, etc) will cause the region
2474 between point and the recently-pushed mark to be highlighted. It will
2475 remain highlighted until some non-motion command is executed.
2477 exchange-point-and-mark (\\[exchange-point-and-mark]) activates the region. So if you mark a
2478 region and execute a command that operates on it, you can reactivate the
2479 same region with \\[exchange-point-and-mark] (or perhaps \\[exchange-point-and-mark] \\[exchange-point-and-mark]) to operate on it
2482 Generally, commands which push marks as a means of navigation (like
2483 beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
2484 region. But commands which push marks as a means of marking an area of
2485 text (like mark-defun (\\[mark-defun]), mark-word (\\[mark-word]) or mark-whole-buffer (\\[mark-whole-buffer]))
2486 do activate the region.
2488 The way the command loop actually works with regard to deactivating the
2489 region is as follows:
2491 - If the variable `zmacs-region-stays' has been set to t during the command
2492 just executed, the region is left alone (this is how the motion commands
2493 make the region stay around; see the `_' flag in the `interactive'
2494 specification). `zmacs-region-stays' is reset to nil before each command
2496 - If the function `zmacs-activate-region' has been called during the command
2497 just executed, the region is left alone. Very few functions should
2498 actually call this function.
2499 - Otherwise, if the region is active, the region is deactivated and
2500 the `zmacs-deactivate-region-hook' is called.
2502 /* Zmacs style active regions are now ON by default */
2505 DEFVAR_BOOL ("zmacs-region-active-p", &zmacs_region_active_p /*
2506 Do not alter this. It is for internal use only.
2508 zmacs_region_active_p = 0;
2510 DEFVAR_BOOL ("zmacs-region-stays", &zmacs_region_stays /*
2511 Whether the current command will deactivate the region.
2512 Commands which do not wish to affect whether the region is currently
2513 highlighted should set this to t. Normally, the region is turned off after
2514 executing each command that did not explicitly turn it on with the function
2515 zmacs-activate-region. Setting this to true lets a command be non-intrusive.
2516 See the variable `zmacs-regions'.
2518 The same effect can be achieved using the `_' interactive specification.
2520 zmacs_region_stays = 0;
2522 DEFVAR_BOOL ("atomic-extent-goto-char-p", &atomic_extent_goto_char_p /*
2523 Do not use this -- it will be going away soon.
2524 Indicates if `goto-char' has just been run. This information is allegedly
2525 needed to get the desired behavior for atomic extents and unfortunately
2526 is not available by any other means.
2528 atomic_extent_goto_char_p = 0;
2529 #ifdef AMPERSAND_FULL_NAME
2530 Fprovide(intern("ampersand-full-name"));
2533 DEFVAR_LISP ("user-full-name", &Vuser_full_name /*
2534 *The name of the user.
2535 The function `user-full-name', which will return the value of this
2536 variable, when called without arguments.
2537 This is initialized to the value of the NAME environment variable.
2539 /* Initialized at run-time. */
2540 Vuser_full_name = Qnil;