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
825 get_home_directory (void)
827 int output_home_warning = 0;
829 if (cached_home_directory == NULL)
831 if ((cached_home_directory = getenv("HOME")) == NULL)
833 #if defined(WINDOWSNT) && !defined(__CYGWIN32__)
834 char *homedrive, *homepath;
836 if ((homedrive = getenv("HOMEDRIVE")) != NULL &&
837 (homepath = getenv("HOMEPATH")) != NULL)
839 cached_home_directory =
840 (char *) xmalloc(strlen(homedrive) + strlen(homepath) + 1);
841 sprintf(cached_home_directory, "%s%s", homedrive, homepath);
847 * Use the current directory.
848 * This preserves the existing XEmacs behavior, but is different
851 if (initial_directory[0] != '\0')
853 cached_home_directory = initial_directory;
857 /* This will probably give the wrong value */
858 cached_home_directory = getcwd (NULL, 0);
862 * This is NT Emacs behavior
864 cached_home_directory = "C:\\";
865 output_home_warning = 1;
868 #else /* !WINDOWSNT */
871 * Using "/" isn't quite right, but what should we do?
872 * We probably should try to extract pw_dir from /etc/passwd,
873 * before falling back to this.
875 cached_home_directory = "/";
876 output_home_warning = 1;
877 #endif /* !WINDOWSNT */
879 if (initialized && output_home_warning)
881 warn_when_safe(Quser_files_and_directories, Qwarning, "\n"
882 " XEmacs was unable to determine a good value for the user's $HOME\n"
883 " directory, and will be using the value:\n"
885 " This is probably incorrect.",
886 cached_home_directory
890 return (cached_home_directory);
893 DEFUN ("user-home-directory", Fuser_home_directory, 0, 0, 0, /*
894 Return the user's home directory, as a string.
898 Lisp_Object directory;
902 path = get_home_directory ();
906 Fexpand_file_name (Fsubstitute_in_file_name (build_string (path)),
912 DEFUN ("system-name", Fsystem_name, 0, 0, 0, /*
913 Return the name of the machine you are running on, as a string.
917 return Fcopy_sequence (Vsystem_name);
920 /* For the benefit of callers who don't want to include lisp.h.
923 get_system_name (void)
925 return xstrdup ((char *) XSTRING_DATA (Vsystem_name));
928 DEFUN ("emacs-pid", Femacs_pid, 0, 0, 0, /*
929 Return the process ID of Emacs, as an integer.
933 return make_int (getpid ());
936 DEFUN ("current-time", Fcurrent_time, 0, 0, 0, /*
937 Return the current time, as the number of seconds since 1970-01-01 00:00:00.
938 The time is returned as a list of three integers. The first has the
939 most significant 16 bits of the seconds, while the second has the
940 least significant 16 bits. The third integer gives the microsecond
943 The microsecond count is zero on systems that do not provide
944 resolution finer than a second.
951 return list3 (make_int ((EMACS_SECS (t) >> 16) & 0xffff),
952 make_int ((EMACS_SECS (t) >> 0) & 0xffff),
953 make_int (EMACS_USECS (t)));
956 DEFUN ("current-process-time", Fcurrent_process_time, 0, 0, 0, /*
957 Return the amount of time used by this XEmacs process so far.
958 The return value is a list of three floating-point numbers, expressing
959 the user, system, and real times used by the process. The user time
960 measures the time actually spent by the CPU executing the code in this
961 process. The system time measures time spent by the CPU executing kernel
962 code on behalf of this process (e.g. I/O requests made by the process).
964 Note that the user and system times measure processor time, as opposed
965 to real time, and only accrue when the processor is actually doing
966 something: Time spent in an idle wait (waiting for user events to come
967 in or for I/O on a disk drive or other device to complete) does not
968 count. Thus, the user and system times will often be considerably
969 less than the real time.
971 Some systems do not allow the user and system times to be distinguished.
972 In this case, the user time will be the total processor time used by
973 the process, and the system time will be 0.
975 Some systems do not allow the real and processor times to be distinguished.
976 In this case, the user and real times will be the same and the system
981 double user, sys, real;
983 get_process_times (&user, &sys, &real);
984 return list3 (make_float (user), make_float (sys), make_float (real));
988 int lisp_to_time (Lisp_Object specified_time, time_t *result);
990 lisp_to_time (Lisp_Object specified_time, time_t *result)
992 Lisp_Object high, low;
994 if (NILP (specified_time))
995 return time (result) != -1;
997 CHECK_CONS (specified_time);
998 high = XCAR (specified_time);
999 low = XCDR (specified_time);
1004 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1005 return *result >> 16 == XINT (high);
1008 Lisp_Object time_to_lisp (time_t the_time);
1010 time_to_lisp (time_t the_time)
1012 unsigned int item = (unsigned int) the_time;
1013 return Fcons (make_int (item >> 16), make_int (item & 0xffff));
1016 size_t emacs_strftime (char *string, size_t max, CONST char *format,
1017 CONST struct tm *tm);
1018 static long difftm (CONST struct tm *a, CONST struct tm *b);
1021 DEFUN ("format-time-string", Fformat_time_string, 1, 2, 0, /*
1022 Use FORMAT-STRING to format the time TIME.
1023 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from
1024 `current-time' and `file-attributes'. If TIME is not specified it
1025 defaults to the current time.
1026 FORMAT-STRING may contain %-sequences to substitute parts of the time.
1027 %a is replaced by the abbreviated name of the day of week.
1028 %A is replaced by the full name of the day of week.
1029 %b is replaced by the abbreviated name of the month.
1030 %B is replaced by the full name of the month.
1031 %c is a synonym for "%x %X".
1032 %C is a locale-specific synonym, which defaults to "%A, %B %e, %Y" in the C locale.
1033 %d is replaced by the day of month, zero-padded.
1034 %D is a synonym for "%m/%d/%y".
1035 %e is replaced by the day of month, blank-padded.
1036 %h is a synonym for "%b".
1037 %H is replaced by the hour (00-23).
1038 %I is replaced by the hour (00-12).
1039 %j is replaced by the day of the year (001-366).
1040 %k is replaced by the hour (0-23), blank padded.
1041 %l is replaced by the hour (1-12), blank padded.
1042 %m is replaced by the month (01-12).
1043 %M is replaced by the minute (00-59).
1044 %n is a synonym for "\\n".
1045 %p is replaced by AM or PM, as appropriate.
1046 %r is a synonym for "%I:%M:%S %p".
1047 %R is a synonym for "%H:%M".
1048 %S is replaced by the second (00-60).
1049 %t is a synonym for "\\t".
1050 %T is a synonym for "%H:%M:%S".
1051 %U is replaced by the week of the year (00-53), first day of week is Sunday.
1052 %w is replaced by the day of week (0-6), Sunday is day 0.
1053 %W is replaced by the week of the year (00-53), first day of week is Monday.
1054 %x is a locale-specific synonym, which defaults to "%D" in the C locale.
1055 %X is a locale-specific synonym, which defaults to "%T" in the C locale.
1056 %y is replaced by the year without century (00-99).
1057 %Y is replaced by the year with century.
1058 %Z is replaced by the time zone abbreviation.
1060 The number of options reflects the `strftime' function.
1062 BUG: If the charset used by the current locale is not ISO 8859-1, the
1063 characters appearing in the day and month names may be incorrect.
1065 (format_string, time_))
1070 CHECK_STRING (format_string);
1072 if (! lisp_to_time (time_, &value))
1073 error ("Invalid time specification");
1075 /* This is probably enough. */
1076 size = XSTRING_LENGTH (format_string) * 6 + 50;
1080 char *buf = (char *) alloca (size);
1082 if (emacs_strftime (buf, size,
1083 (CONST char *) XSTRING_DATA (format_string),
1086 return build_ext_string (buf, FORMAT_BINARY);
1087 /* If buffer was too small, make it bigger. */
1092 DEFUN ("decode-time", Fdecode_time, 0, 1, 0, /*
1093 Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1094 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)
1095 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'
1096 to use the current time. The list has the following nine members:
1097 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which
1098 only some operating systems support. MINUTE is an integer between 0 and 59.
1099 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.
1100 MONTH is an integer between 1 and 12. YEAR is an integer indicating the
1101 four-digit year. DOW is the day of week, an integer between 0 and 6, where
1102 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.
1103 ZONE is an integer indicating the number of seconds east of Greenwich.
1104 \(Note that Common Lisp has different meanings for DOW and ZONE.)
1110 struct tm *decoded_time;
1111 Lisp_Object list_args[9];
1113 if (! lisp_to_time (specified_time, &time_spec))
1114 error ("Invalid time specification");
1116 decoded_time = localtime (&time_spec);
1117 list_args[0] = make_int (decoded_time->tm_sec);
1118 list_args[1] = make_int (decoded_time->tm_min);
1119 list_args[2] = make_int (decoded_time->tm_hour);
1120 list_args[3] = make_int (decoded_time->tm_mday);
1121 list_args[4] = make_int (decoded_time->tm_mon + 1);
1122 list_args[5] = make_int (decoded_time->tm_year + 1900);
1123 list_args[6] = make_int (decoded_time->tm_wday);
1124 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1126 /* Make a copy, in case gmtime modifies the struct. */
1127 save_tm = *decoded_time;
1128 decoded_time = gmtime (&time_spec);
1129 if (decoded_time == 0)
1130 list_args[8] = Qnil;
1132 list_args[8] = make_int (difftm (&save_tm, decoded_time));
1133 return Flist (9, list_args);
1136 static void set_time_zone_rule (char *tzstring);
1138 DEFUN ("encode-time", Fencode_time, 6, MANY, 0, /*
1139 Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1140 This is the reverse operation of `decode-time', which see.
1141 ZONE defaults to the current time zone rule. This can
1142 be a string (as from `set-time-zone-rule'), or it can be a list
1143 \(as from `current-time-zone') or an integer (as from `decode-time')
1144 applied without consideration for daylight savings time.
1146 You can pass more than 7 arguments; then the first six arguments
1147 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1148 The intervening arguments are ignored.
1149 This feature lets (apply 'encode-time (decode-time ...)) work.
1151 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;
1152 for example, a DAY of 0 means the day preceding the given month.
1153 Year numbers less than 100 are treated just like other year numbers.
1154 If you want them to stand for years in this century, you must do that yourself.
1156 (int nargs, Lisp_Object *args))
1160 Lisp_Object zone = (nargs > 6) ? args[nargs - 1] : Qnil;
1162 CHECK_INT (*args); tm.tm_sec = XINT (*args++); /* second */
1163 CHECK_INT (*args); tm.tm_min = XINT (*args++); /* minute */
1164 CHECK_INT (*args); tm.tm_hour = XINT (*args++); /* hour */
1165 CHECK_INT (*args); tm.tm_mday = XINT (*args++); /* day */
1166 CHECK_INT (*args); tm.tm_mon = XINT (*args++) - 1; /* month */
1167 CHECK_INT (*args); tm.tm_year = XINT (*args++) - 1900;/* year */
1174 the_time = mktime (&tm);
1179 char **oldenv = environ, **newenv;
1182 tzstring = (char *) XSTRING_DATA (zone);
1183 else if (INTP (zone))
1185 int abszone = abs (XINT (zone));
1186 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1187 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1191 error ("Invalid time zone specification");
1193 /* Set TZ before calling mktime; merely adjusting mktime's returned
1194 value doesn't suffice, since that would mishandle leap seconds. */
1195 set_time_zone_rule (tzstring);
1197 the_time = mktime (&tm);
1199 /* Restore TZ to previous value. */
1203 #ifdef LOCALTIME_CACHE
1208 if (the_time == (time_t) -1)
1209 error ("Specified time is not representable");
1211 return wasteful_word_to_lisp (the_time);
1214 DEFUN ("current-time-string", Fcurrent_time_string, 0, 1, 0, /*
1215 Return the current time, as a human-readable string.
1216 Programs can use this function to decode a time,
1217 since the number of columns in each field is fixed.
1218 The format is `Sun Sep 16 01:03:52 1973'.
1219 If an argument is given, it specifies a time to format
1220 instead of the current time. The argument should have the form:
1223 (HIGH LOW . IGNORED).
1224 Thus, you can use times obtained from `current-time'
1225 and from `file-attributes'.
1233 if (! lisp_to_time (specified_time, &value))
1235 tem = (char *) ctime (&value);
1237 strncpy (buf, tem, 24);
1240 return build_ext_string (buf, FORMAT_BINARY);
1243 #define TM_YEAR_ORIGIN 1900
1245 /* Yield A - B, measured in seconds. */
1247 difftm (CONST struct tm *a, CONST struct tm *b)
1249 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
1250 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
1251 /* Some compilers can't handle this as a single return statement. */
1253 /* difference in day of year */
1254 a->tm_yday - b->tm_yday
1255 /* + intervening leap days */
1256 + ((ay >> 2) - (by >> 2))
1258 + ((ay/100 >> 2) - (by/100 >> 2))
1259 /* + difference in years * 365 */
1260 + (long)(ay-by) * 365
1262 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
1263 + (a->tm_min - b->tm_min))
1264 + (a->tm_sec - b->tm_sec));
1267 DEFUN ("current-time-zone", Fcurrent_time_zone, 0, 1, 0, /*
1268 Return the offset and name for the local time zone.
1269 This returns a list of the form (OFFSET NAME).
1270 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1271 A negative value means west of Greenwich.
1272 NAME is a string giving the name of the time zone.
1273 If an argument is given, it specifies when the time zone offset is determined
1274 instead of using the current time. The argument should have the form:
1277 (HIGH LOW . IGNORED).
1278 Thus, you can use times obtained from `current-time'
1279 and from `file-attributes'.
1281 Some operating systems cannot provide all this information to Emacs;
1282 in this case, `current-time-zone' returns a list containing nil for
1283 the data it can't find.
1288 struct tm *t = NULL;
1290 if (lisp_to_time (specified_time, &value)
1291 && (t = gmtime (&value)) != 0)
1293 struct tm gmt = *t; /* Make a copy, in case localtime modifies *t. */
1297 t = localtime (&value);
1298 offset = difftm (t, &gmt);
1302 s = (char *)t->tm_zone;
1303 #else /* not HAVE_TM_ZONE */
1305 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1306 s = tzname[t->tm_isdst];
1308 #endif /* not HAVE_TM_ZONE */
1311 /* No local time zone name is available; use "+-NNNN" instead. */
1312 int am = (offset < 0 ? -offset : offset) / 60;
1313 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1316 return list2 (make_int (offset), build_string (s));
1319 return list2 (Qnil, Qnil);
1322 #ifdef LOCALTIME_CACHE
1324 /* These two values are known to load tz files in buggy implementations,
1325 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1326 Their values shouldn't matter in non-buggy implementations.
1327 We don't use string literals for these strings,
1328 since if a string in the environment is in readonly
1329 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1330 See Sun bugs 1113095 and 1114114, ``Timezone routines
1331 improperly modify environment''. */
1333 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1334 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1338 /* Set the local time zone rule to TZSTRING.
1339 This allocates memory into `environ', which it is the caller's
1340 responsibility to free. */
1342 set_time_zone_rule (char *tzstring)
1345 char **from, **to, **newenv;
1347 for (from = environ; *from; from++)
1349 envptrs = from - environ + 2;
1350 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1351 + (tzstring ? strlen (tzstring) + 4 : 0));
1354 char *t = (char *) (to + envptrs);
1356 strcat (t, tzstring);
1360 for (from = environ; *from; from++)
1361 if (strncmp (*from, "TZ=", 3) != 0)
1367 #ifdef LOCALTIME_CACHE
1369 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1370 "US/Pacific" that loads a tz file, then changes to a value like
1371 "XXX0" that does not load a tz file, and then changes back to
1372 its original value, the last change is (incorrectly) ignored.
1373 Also, if TZ changes twice in succession to values that do
1374 not load a tz file, tzset can dump core (see Sun bug#1225179).
1375 The following code works around these bugs. */
1379 /* Temporarily set TZ to a value that loads a tz file
1380 and that differs from tzstring. */
1382 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1383 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1389 /* The implied tzstring is unknown, so temporarily set TZ to
1390 two different values that each load a tz file. */
1391 *to = set_time_zone_rule_tz1;
1394 *to = set_time_zone_rule_tz2;
1399 /* Now TZ has the desired value, and tzset can be invoked safely. */
1406 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, 1, 1, 0, /*
1407 Set the local time zone using TZ, a string specifying a time zone rule.
1408 If TZ is nil, use implementation-defined default time zone information.
1419 tzstring = (char *) XSTRING_DATA (tz);
1422 set_time_zone_rule (tzstring);
1425 environbuf = environ;
1432 buffer_insert1 (struct buffer *buf, Lisp_Object arg)
1434 /* This function can GC */
1435 struct gcpro gcpro1;
1438 if (CHAR_OR_CHAR_INTP (arg))
1440 buffer_insert_emacs_char (buf, XCHAR_OR_CHAR_INT (arg));
1442 else if (STRINGP (arg))
1444 buffer_insert_lisp_string (buf, arg);
1448 arg = wrong_type_argument (Qchar_or_string_p, arg);
1451 zmacs_region_stays = 0;
1456 /* Callers passing one argument to Finsert need not gcpro the
1457 argument "array", since the only element of the array will
1458 not be used after calling insert_emacs_char or insert_lisp_string,
1459 so we don't care if it gets trashed. */
1461 DEFUN ("insert", Finsert, 0, MANY, 0, /*
1462 Insert the arguments, either strings or characters, at point.
1463 Point moves forward so that it ends up after the inserted text.
1464 Any other markers at the point of insertion remain before the text.
1465 If a string has non-null string-extent-data, new extents will be created.
1467 (int nargs, Lisp_Object *args))
1469 /* This function can GC */
1470 REGISTER int argnum;
1472 for (argnum = 0; argnum < nargs; argnum++)
1474 buffer_insert1 (current_buffer, args[argnum]);
1480 DEFUN ("insert-before-markers", Finsert_before_markers, 0, MANY, 0, /*
1481 Insert strings or characters at point, relocating markers after the text.
1482 Point moves forward so that it ends up after the inserted text.
1483 Any other markers at the point of insertion also end up after the text.
1485 (int nargs, Lisp_Object *args))
1487 /* This function can GC */
1488 REGISTER int argnum;
1489 REGISTER Lisp_Object tem;
1491 for (argnum = 0; argnum < nargs; argnum++)
1495 if (CHAR_OR_CHAR_INTP (tem))
1497 buffer_insert_emacs_char_1 (current_buffer, -1,
1498 XCHAR_OR_CHAR_INT (tem),
1499 INSDEL_BEFORE_MARKERS);
1501 else if (STRINGP (tem))
1503 buffer_insert_lisp_string_1 (current_buffer, -1, tem,
1504 INSDEL_BEFORE_MARKERS);
1508 tem = wrong_type_argument (Qchar_or_string_p, tem);
1512 zmacs_region_stays = 0;
1516 DEFUN ("insert-string", Finsert_string, 1, 2, 0, /*
1517 Insert STRING into BUFFER at BUFFER's point.
1518 Point moves forward so that it ends up after the inserted text.
1519 Any other markers at the point of insertion remain before the text.
1520 If a string has non-null string-extent-data, new extents will be created.
1521 BUFFER defaults to the current buffer.
1525 struct buffer *b = decode_buffer (buffer, 1);
1526 CHECK_STRING (string);
1527 buffer_insert_lisp_string (b, string);
1528 zmacs_region_stays = 0;
1532 /* Third argument in FSF is INHERIT:
1534 "The optional third arg INHERIT, if non-nil, says to inherit text properties
1535 from adjoining text, if those properties are sticky."
1537 Jamie thinks this is bogus. */
1540 DEFUN ("insert-char", Finsert_char, 1, 4, 0, /*
1541 Insert COUNT (second arg) copies of CHR (first arg).
1542 Point and all markers are affected as in the function `insert'.
1543 COUNT defaults to 1 if omitted.
1544 The optional third arg IGNORED is INHERIT under FSF Emacs.
1545 This is highly bogus, however, and XEmacs always behaves as if
1546 `t' were passed to INHERIT.
1547 The optional fourth arg BUFFER specifies the buffer to insert the
1548 text into. If BUFFER is nil, the current buffer is assumed.
1550 (chr, count, ignored, buffer))
1552 /* This function can GC */
1553 REGISTER Bufbyte *string;
1556 REGISTER Bytecount n;
1557 REGISTER Bytecount charlen;
1558 Bufbyte str[MAX_EMCHAR_LEN];
1559 struct buffer *b = decode_buffer (buffer, 1);
1562 CHECK_CHAR_COERCE_INT (chr);
1571 charlen = set_charptr_emchar (str, XCHAR (chr));
1575 slen = min (n, 768);
1576 string = alloca_array (Bufbyte, slen);
1577 /* Write as many copies of the character into the temp string as will fit. */
1578 for (i = 0; i + charlen <= slen; i += charlen)
1579 for (j = 0; j < charlen; j++)
1580 string[i + j] = str[j];
1584 buffer_insert_raw_string (b, string, slen);
1588 #if 0 /* FSFmacs bogosity */
1590 if (!NILP (inherit))
1591 insert_and_inherit (string, n);
1596 buffer_insert_raw_string (b, string, n);
1599 zmacs_region_stays = 0;
1604 /* Making strings from buffer contents. */
1606 DEFUN ("buffer-substring", Fbuffer_substring, 0, 3, 0, /*
1607 Return the contents of part of BUFFER as a string.
1608 The two arguments START and END are character positions;
1609 they can be in either order. If omitted, they default to the beginning
1610 and end of BUFFER, respectively.
1611 If there are duplicable extents in the region, the string remembers
1612 them in its extent data.
1613 If BUFFER is nil, the current buffer is assumed.
1615 (start, end, buffer))
1617 /* This function can GC */
1619 struct buffer *b = decode_buffer (buffer, 1);
1621 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1622 return make_string_from_buffer (b, begv, zv - begv);
1625 /* It might make more sense to name this
1626 `buffer-substring-no-extents', but this name is FSFmacs-compatible,
1627 and what the function does is probably good enough for what the
1628 user-code will typically want to use it for. */
1629 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties, 0, 3, 0, /*
1630 Return the text from BEG to END, as a string, without copying the extents.
1632 (start, end, buffer))
1634 /* This function can GC */
1636 struct buffer *b = decode_buffer (buffer, 1);
1638 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1639 return make_string_from_buffer_no_extents (b, begv, zv - begv);
1642 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, 1, 3, 0, /*
1643 Insert before point a substring of the contents of buffer BUFFER.
1644 BUFFER may be a buffer or a buffer name.
1645 Arguments START and END are character numbers specifying the substring.
1646 They default to the beginning and the end of BUFFER.
1648 (buffer, start, end))
1650 /* This function can GC */
1654 bp = XBUFFER (get_buffer (buffer, 1));
1655 get_buffer_range_char (bp, start, end, &b, &e, GB_ALLOW_NIL);
1658 buffer_insert_from_buffer (current_buffer, bp, b, e - b);
1663 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, 6, 6, 0, /*
1664 Compare two substrings of two buffers; return result as number.
1665 the value is -N if first string is less after N-1 chars,
1666 +N if first string is greater after N-1 chars, or 0 if strings match.
1667 Each substring is represented as three arguments: BUFFER, START and END.
1668 That makes six args in all, three for each substring.
1670 The value of `case-fold-search' in the current buffer
1671 determines whether case is significant or ignored.
1673 (buffer1, start1, end1, buffer2, start2, end2))
1675 Bufpos begp1, endp1, begp2, endp2;
1676 REGISTER Charcount len1, len2, length, i;
1677 struct buffer *bp1, *bp2;
1678 Lisp_Object trt = ((!NILP (current_buffer->case_fold_search)) ?
1679 current_buffer->case_canon_table : Qnil);
1681 /* Find the first buffer and its substring. */
1683 bp1 = decode_buffer (buffer1, 1);
1684 get_buffer_range_char (bp1, start1, end1, &begp1, &endp1, GB_ALLOW_NIL);
1686 /* Likewise for second substring. */
1688 bp2 = decode_buffer (buffer2, 1);
1689 get_buffer_range_char (bp2, start2, end2, &begp2, &endp2, GB_ALLOW_NIL);
1691 len1 = endp1 - begp1;
1692 len2 = endp2 - begp2;
1697 for (i = 0; i < length; i++)
1699 Emchar c1 = BUF_FETCH_CHAR (bp1, begp1 + i);
1700 Emchar c2 = BUF_FETCH_CHAR (bp2, begp2 + i);
1703 c1 = TRT_TABLE_OF (trt, c1);
1704 c2 = TRT_TABLE_OF (trt, c2);
1707 return make_int (- 1 - i);
1709 return make_int (i + 1);
1712 /* The strings match as far as they go.
1713 If one is shorter, that one is less. */
1715 return make_int (length + 1);
1716 else if (length < len2)
1717 return make_int (- length - 1);
1719 /* Same length too => they are equal. */
1725 subst_char_in_region_unwind (Lisp_Object arg)
1727 XBUFFER (XCAR (arg))->undo_list = XCDR (arg);
1732 subst_char_in_region_unwind_1 (Lisp_Object arg)
1734 XBUFFER (XCAR (arg))->filename = XCDR (arg);
1738 DEFUN ("subst-char-in-region", Fsubst_char_in_region, 4, 5, 0, /*
1739 From START to END, replace FROMCHAR with TOCHAR each time it occurs.
1740 If optional arg NOUNDO is non-nil, don't record this change for undo
1741 and don't mark the buffer as really changed.
1743 (start, end, fromchar, tochar, noundo))
1745 /* This function can GC */
1749 struct buffer *buf = current_buffer;
1750 int count = specpdl_depth ();
1752 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1753 CHECK_CHAR_COERCE_INT (fromchar);
1754 CHECK_CHAR_COERCE_INT (tochar);
1756 fromc = XCHAR (fromchar);
1757 toc = XCHAR (tochar);
1759 /* If we don't want undo, turn off putting stuff on the list.
1760 That's faster than getting rid of things,
1761 and it prevents even the entry for a first change.
1762 Also inhibit locking the file. */
1765 record_unwind_protect (subst_char_in_region_unwind,
1766 Fcons (Fcurrent_buffer (), buf->undo_list));
1767 buf->undo_list = Qt;
1768 /* Don't do file-locking. */
1769 record_unwind_protect (subst_char_in_region_unwind_1,
1770 Fcons (Fcurrent_buffer (), buf->filename));
1771 buf->filename = Qnil;
1774 mc_count = begin_multiple_change (buf, pos, stop);
1777 if (BUF_FETCH_CHAR (buf, pos) == fromc)
1779 /* There used to be some code here that set the buffer to
1780 unmodified if NOUNDO was specified and there was only
1781 one change to the buffer since it was last saved.
1782 This is a crock of shit, so I'm not duplicating this
1783 behavior. I think this was left over from when
1784 prepare_to_modify_buffer() actually bumped MODIFF,
1785 so that code was supposed to undo this change. --ben */
1786 buffer_replace_char (buf, pos, toc, !NILP (noundo), 0);
1788 /* If noundo is not nil then we don't mark the buffer as
1789 modified. In reality that needs to happen externally
1790 only. Internally redisplay needs to know that the actual
1791 contents it should be displaying have changed. */
1793 Fset_buffer_modified_p (Fbuffer_modified_p (Qnil), Qnil);
1797 end_multiple_change (buf, mc_count);
1799 unbind_to (count, Qnil);
1803 /* #### Shouldn't this also accept a BUFFER argument, in the good old
1804 XEmacs tradition? */
1805 DEFUN ("translate-region", Ftranslate_region, 3, 3, 0, /*
1806 Translate characters from START to END according to TABLE.
1808 If TABLE is a string, the Nth character in it is the mapping for the
1809 character with code N.
1811 If TABLE is a vector, its Nth element is the mapping for character
1812 with code N. The values of elements may be characters, strings, or
1813 nil (nil meaning don't replace.)
1815 If TABLE is a char-table, its elements describe the mapping between
1816 characters and their replacements. The char-table should be of type
1817 `char' or `generic'.
1819 Returns the number of substitutions performed.
1821 (start, end, table))
1823 /* This function can GC */
1824 Bufpos pos, stop; /* Limits of the region. */
1825 int cnt = 0; /* Number of changes made. */
1827 struct buffer *buf = current_buffer;
1830 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1831 mc_count = begin_multiple_change (buf, pos, stop);
1832 if (STRINGP (table))
1834 struct Lisp_String *stable = XSTRING (table);
1835 Charcount size = string_char_length (stable);
1837 /* Under Mule, string_char(n) is O(n), so for large tables or
1838 large regions it makes sense to create an array of Emchars. */
1839 if (size * (stop - pos) > 65536)
1841 Emchar *etable = alloca_array (Emchar, size);
1842 convert_bufbyte_string_into_emchar_string
1843 (string_data (stable), string_length (stable), etable);
1844 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1848 Emchar nc = etable[oc];
1851 buffer_replace_char (buf, pos, nc, 0, 0);
1860 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1864 Emchar nc = string_char (stable, oc);
1867 buffer_replace_char (buf, pos, nc, 0, 0);
1874 else if (VECTORP (table))
1876 Charcount size = XVECTOR_LENGTH (table);
1877 Lisp_Object *vtable = XVECTOR_DATA (table);
1879 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1883 Lisp_Object replacement = vtable[oc];
1885 if (CHAR_OR_CHAR_INTP (replacement))
1887 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1890 buffer_replace_char (buf, pos, nc, 0, 0);
1894 else if (STRINGP (replacement))
1896 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1897 buffer_delete_range (buf, pos, pos + 1, 0);
1898 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1899 pos += incr, stop += incr;
1902 else if (!NILP (replacement))
1904 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1910 else if (CHAR_TABLEP (table)
1911 && (XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC
1912 || XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR))
1914 struct Lisp_Char_Table *ctable = XCHAR_TABLE (table);
1916 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1918 Lisp_Object replacement = get_char_table (oc, ctable);
1920 if (CHAR_OR_CHAR_INTP (replacement))
1922 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1925 buffer_replace_char (buf, pos, nc, 0, 0);
1929 else if (STRINGP (replacement))
1931 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1932 buffer_delete_range (buf, pos, pos + 1, 0);
1933 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1934 pos += incr, stop += incr;
1937 else if (!NILP (replacement))
1939 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1945 dead_wrong_type_argument (Qstringp, table);
1946 end_multiple_change (buf, mc_count);
1948 return make_int (cnt);
1951 DEFUN ("delete-region", Fdelete_region, 2, 3, "r", /*
1952 Delete the text between point and mark.
1953 When called from a program, expects two arguments,
1954 positions (integers or markers) specifying the stretch to be deleted.
1955 If BUFFER is nil, the current buffer is assumed.
1959 /* This function can GC */
1961 struct buffer *buf = decode_buffer (buffer, 1);
1963 get_buffer_range_char (buf, b, e, &start, &end, 0);
1964 buffer_delete_range (buf, start, end, 0);
1965 zmacs_region_stays = 0;
1970 widen_buffer (struct buffer *b, int no_clip)
1972 if (BUF_BEGV (b) != BUF_BEG (b))
1975 SET_BOTH_BUF_BEGV (b, BUF_BEG (b), BI_BUF_BEG (b));
1977 if (BUF_ZV (b) != BUF_Z (b))
1980 SET_BOTH_BUF_ZV (b, BUF_Z (b), BI_BUF_Z (b));
1986 /* Changing the buffer bounds invalidates any recorded current
1988 invalidate_current_column ();
1989 narrow_line_number_cache (b);
1993 DEFUN ("widen", Fwiden, 0, 1, "", /*
1994 Remove restrictions (narrowing) from BUFFER.
1995 This allows the buffer's full text to be seen and edited.
1996 If BUFFER is nil, the current buffer is assumed.
2000 struct buffer *b = decode_buffer (buffer, 1);
2001 widen_buffer (b, 0);
2002 zmacs_region_stays = 0;
2006 DEFUN ("narrow-to-region", Fnarrow_to_region, 2, 3, "r", /*
2007 Restrict editing in BUFFER to the current region.
2008 The rest of the text becomes temporarily invisible and untouchable
2009 but is not deleted; if you save the buffer in a file, the invisible
2010 text is included in the file. \\[widen] makes all visible again.
2011 If BUFFER is nil, the current buffer is assumed.
2012 See also `save-restriction'.
2014 When calling from a program, pass two arguments; positions (integers
2015 or markers) bounding the text that should remain visible.
2020 struct buffer *buf = decode_buffer (buffer, 1);
2021 Bytind bi_start, bi_end;
2023 get_buffer_range_char (buf, b, e, &start, &end, GB_ALLOW_PAST_ACCESSIBLE);
2024 bi_start = bufpos_to_bytind (buf, start);
2025 bi_end = bufpos_to_bytind (buf, end);
2027 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2028 SET_BOTH_BUF_ZV (buf, end, bi_end);
2029 if (BUF_PT (buf) < start)
2030 BUF_SET_PT (buf, start);
2031 if (BUF_PT (buf) > end)
2032 BUF_SET_PT (buf, end);
2034 /* Changing the buffer bounds invalidates any recorded current column. */
2035 invalidate_current_column ();
2036 narrow_line_number_cache (buf);
2037 zmacs_region_stays = 0;
2042 save_restriction_save (void)
2044 Lisp_Object bottom, top;
2045 /* Note: I tried using markers here, but it does not win
2046 because insertion at the end of the saved region
2047 does not advance mh and is considered "outside" the saved region. */
2048 bottom = make_int (BUF_BEGV (current_buffer) - BUF_BEG (current_buffer));
2049 top = make_int (BUF_Z (current_buffer) - BUF_ZV (current_buffer));
2051 return noseeum_cons (Fcurrent_buffer (), noseeum_cons (bottom, top));
2055 save_restriction_restore (Lisp_Object data)
2058 Charcount newhead, newtail;
2060 int local_clip_changed = 0;
2062 buf = XBUFFER (XCAR (data));
2063 if (!BUFFER_LIVE_P (buf))
2065 /* someone could have killed the buffer in the meantime ... */
2066 free_cons (XCONS (XCDR (data)));
2067 free_cons (XCONS (data));
2071 newhead = XINT (XCAR (tem));
2072 newtail = XINT (XCDR (tem));
2074 free_cons (XCONS (XCDR (data)));
2075 free_cons (XCONS (data));
2077 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
2085 Bytind bi_start, bi_end;
2087 start = BUF_BEG (buf) + newhead;
2088 end = BUF_Z (buf) - newtail;
2090 bi_start = bufpos_to_bytind (buf, start);
2091 bi_end = bufpos_to_bytind (buf, end);
2093 if (BUF_BEGV (buf) != start)
2095 local_clip_changed = 1;
2096 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2097 narrow_line_number_cache (buf);
2099 if (BUF_ZV (buf) != end)
2101 local_clip_changed = 1;
2102 SET_BOTH_BUF_ZV (buf, end, bi_end);
2105 if (local_clip_changed)
2108 /* If point is outside the new visible range, move it inside. */
2110 bufpos_clip_to_bounds (BUF_BEGV (buf),
2117 DEFUN ("save-restriction", Fsave_restriction, 0, UNEVALLED, 0, /*
2118 Execute BODY, saving and restoring current buffer's restrictions.
2119 The buffer's restrictions make parts of the beginning and end invisible.
2120 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
2121 This special form, `save-restriction', saves the current buffer's restrictions
2122 when it is entered, and restores them when it is exited.
2123 So any `narrow-to-region' within BODY lasts only until the end of the form.
2124 The old restrictions settings are restored
2125 even in case of abnormal exit (throw or error).
2127 The value returned is the value of the last form in BODY.
2129 `save-restriction' can get confused if, within the BODY, you widen
2130 and then make changes outside the area within the saved restrictions.
2132 Note: if you are using both `save-excursion' and `save-restriction',
2133 use `save-excursion' outermost:
2134 (save-excursion (save-restriction ...))
2138 /* This function can GC */
2139 int speccount = specpdl_depth ();
2141 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2143 return unbind_to (speccount, Fprogn (body));
2147 DEFUN ("format", Fformat, 1, MANY, 0, /*
2148 Format a string out of a control-string and arguments.
2149 The first argument is a control string.
2150 The other arguments are substituted into it to make the result, a string.
2151 It may contain %-sequences meaning to substitute the next argument.
2152 %s means print all objects as-is, using `princ'.
2153 %S means print all objects as s-expressions, using `prin1'.
2154 %d or %i means print as an integer in decimal (%o octal, %x lowercase hex,
2156 %c means print as a single character.
2157 %f means print as a floating-point number in fixed notation (e.g. 785.200).
2158 %e or %E means print as a floating-point number in scientific notation
2160 %g or %G means print as a floating-point number in "pretty format";
2161 depending on the number, either %f or %e/%E format will be used, and
2162 trailing zeroes are removed from the fractional part.
2163 The argument used for all but %s and %S must be a number. It will be
2164 converted to an integer or a floating-point number as necessary.
2166 %$ means reposition to read a specific numbered argument; for example,
2167 %3$s would apply the `%s' to the third argument after the control string,
2168 and the next format directive would use the fourth argument, the
2169 following one the fifth argument, etc. (There must be a positive integer
2170 between the % and the $).
2171 Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be
2172 specified between the optional repositioning spec and the conversion
2173 character; see below.
2174 An optional minimum field width may be specified after any flag characters
2175 and before the conversion character; it specifies the minimum number of
2176 characters that the converted argument will take up. Padding will be
2177 added on the left (or on the right, if the `-' flag is specified), as
2178 necessary. Padding is done with spaces, or with zeroes if the `0' flag
2180 If the field width is specified as `*', the field width is assumed to have
2181 been specified as an argument. Any repositioning specification that
2182 would normally specify the argument to be converted will now specify
2183 where to find this field width argument, not where to find the argument
2184 to be converted. If there is no repositioning specification, the normal
2185 next argument is used. The argument to be converted will be the next
2186 argument after the field width argument unless the precision is also
2187 specified as `*' (see below).
2189 An optional period character and precision may be specified after any
2190 minimum field width. It specifies the minimum number of digits to
2191 appear in %d, %i, %o, %x, and %X conversions (the number is padded
2192 on the left with zeroes as necessary); the number of digits printed
2193 after the decimal point for %f, %e, and %E conversions; the number
2194 of significant digits printed in %g and %G conversions; and the
2195 maximum number of non-padding characters printed in %s and %S
2196 conversions. The default precision for floating-point conversions
2198 If the precision is specified as `*', the precision is assumed to have been
2199 specified as an argument. The argument used will be the next argument
2200 after the field width argument, if any. If the field width was not
2201 specified as an argument, any repositioning specification that would
2202 normally specify the argument to be converted will now specify where to
2203 find the precision argument. If there is no repositioning specification,
2204 the normal next argument is used.
2206 The ` ' and `+' flags mean prefix non-negative numbers with a space or
2207 plus sign, respectively.
2208 The `#' flag means print numbers in an alternate, more verbose format:
2209 octal numbers begin with zero; hex numbers begin with a 0x or 0X;
2210 a decimal point is printed in %f, %e, and %E conversions even if no
2211 numbers are printed after it; and trailing zeroes are not omitted in
2212 %g and %G conversions.
2214 Use %% to put a single % into the output.
2216 (int nargs, Lisp_Object *args))
2218 /* It should not be necessary to GCPRO ARGS, because
2219 the caller in the interpreter should take care of that. */
2221 CHECK_STRING (args[0]);
2222 return emacs_doprnt_string_lisp (0, args[0], 0, nargs - 1, args + 1);
2226 DEFUN ("char-equal", Fchar_equal, 2, 3, 0, /*
2227 Return t if two characters match, optionally ignoring case.
2228 Both arguments must be characters (i.e. NOT integers).
2229 Case is ignored if `case-fold-search' is non-nil in BUFFER.
2230 If BUFFER is nil, the current buffer is assumed.
2235 struct buffer *b = decode_buffer (buffer, 1);
2237 CHECK_CHAR_COERCE_INT (c1);
2238 CHECK_CHAR_COERCE_INT (c2);
2242 return (!NILP (b->case_fold_search)
2243 ? DOWNCASE (b, x1) == DOWNCASE (b, x2)
2248 DEFUN ("char=", Fchar_Equal, 2, 3, 0, /*
2249 Return t if two characters match, case is significant.
2250 Both arguments must be characters (i.e. NOT integers).
2251 The optional buffer argument is for symmetry and is ignored.
2255 CHECK_CHAR_COERCE_INT (c1);
2256 CHECK_CHAR_COERCE_INT (c2);
2258 return XCHAR(c1) == XCHAR(c2) ? Qt : Qnil;
2261 #if 0 /* Undebugged FSFmacs code */
2262 /* Transpose the markers in two regions of the current buffer, and
2263 adjust the ones between them if necessary (i.e.: if the regions
2266 Traverses the entire marker list of the buffer to do so, adding an
2267 appropriate amount to some, subtracting from some, and leaving the
2268 rest untouched. Most of this is copied from adjust_markers in insdel.c.
2270 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
2273 transpose_markers (Bufpos start1, Bufpos end1, Bufpos start2, Bufpos end2)
2275 Charcount amt1, amt2, diff;
2277 struct buffer *buf = current_buffer;
2279 /* Update point as if it were a marker. */
2280 if (BUF_PT (buf) < start1)
2282 else if (BUF_PT (buf) < end1)
2283 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - end1));
2284 else if (BUF_PT (buf) < start2)
2285 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - start2) - (end1 - start1));
2286 else if (BUF_PT (buf) < end2)
2287 BUF_SET_PT (buf, BUF_PT (buf) - (start2 - start1));
2289 /* We used to adjust the endpoints here to account for the gap, but that
2290 isn't good enough. Even if we assume the caller has tried to move the
2291 gap out of our way, it might still be at start1 exactly, for example;
2292 and that places it `inside' the interval, for our purposes. The amount
2293 of adjustment is nontrivial if there's a `denormalized' marker whose
2294 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
2295 the dirty work to Fmarker_position, below. */
2297 /* The difference between the region's lengths */
2298 diff = (end2 - start2) - (end1 - start1);
2300 /* For shifting each marker in a region by the length of the other
2301 * region plus the distance between the regions.
2303 amt1 = (end2 - start2) + (start2 - end1);
2304 amt2 = (end1 - start1) + (start2 - end1);
2306 for (marker = BUF_MARKERS (buf); !NILP (marker);
2307 marker = XMARKER (marker)->chain)
2309 Bufpos mpos = marker_position (marker);
2310 if (mpos >= start1 && mpos < end2)
2314 else if (mpos < start2)
2318 set_marker_position (marker, mpos);
2325 DEFUN ("transpose-regions", Ftranspose_regions, 4, 5, 0, /*
2326 Transpose region START1 to END1 with START2 to END2.
2327 The regions may not be overlapping, because the size of the buffer is
2328 never changed in a transposition.
2330 Optional fifth arg LEAVE_MARKERS, if non-nil, means don't transpose
2331 any markers that happen to be located in the regions. (#### BUG: currently
2332 this function always acts as if LEAVE_MARKERS is non-nil.)
2334 Transposing beyond buffer boundaries is an error.
2336 (startr1, endr1, startr2, endr2, leave_markers))
2338 Bufpos start1, end1, start2, end2;
2339 Charcount len1, len2;
2340 Lisp_Object string1, string2;
2341 struct buffer *buf = current_buffer;
2343 get_buffer_range_char (buf, startr1, endr1, &start1, &end1, 0);
2344 get_buffer_range_char (buf, startr2, endr2, &start2, &end2, 0);
2346 len1 = end1 - start1;
2347 len2 = end2 - start2;
2350 error ("transposed regions not properly ordered");
2351 else if (start1 == end1 || start2 == end2)
2352 error ("transposed region may not be of length 0");
2354 string1 = make_string_from_buffer (buf, start1, len1);
2355 string2 = make_string_from_buffer (buf, start2, len2);
2356 buffer_delete_range (buf, start2, end2, 0);
2357 buffer_insert_lisp_string_1 (buf, start2, string1, 0);
2358 buffer_delete_range (buf, start1, end1, 0);
2359 buffer_insert_lisp_string_1 (buf, start1, string2, 0);
2361 /* In FSFmacs there is a whole bunch of really ugly code here
2362 to attempt to transpose the regions without using up any
2363 extra memory. Although the intent may be good, the result
2364 was highly bogus. */
2370 /************************************************************************/
2371 /* initialization */
2372 /************************************************************************/
2375 syms_of_editfns (void)
2377 defsymbol (&Qpoint, "point");
2378 defsymbol (&Qmark, "mark");
2379 defsymbol (&Qregion_beginning, "region-beginning");
2380 defsymbol (&Qregion_end, "region-end");
2381 defsymbol (&Qformat, "format");
2382 defsymbol (&Quser_files_and_directories, "user-files-and-directories");
2384 DEFSUBR (Fchar_equal);
2385 DEFSUBR (Fchar_Equal);
2386 DEFSUBR (Fgoto_char);
2387 DEFSUBR (Fstring_to_char);
2388 DEFSUBR (Fchar_to_string);
2389 DEFSUBR (Fbuffer_substring);
2390 DEFSUBR (Fbuffer_substring_no_properties);
2392 DEFSUBR (Fpoint_marker);
2393 DEFSUBR (Fmark_marker);
2395 DEFSUBR (Fregion_beginning);
2396 DEFSUBR (Fregion_end);
2397 DEFSUBR (Fsave_excursion);
2398 DEFSUBR (Fsave_current_buffer);
2400 DEFSUBR (Fbuffer_size);
2401 DEFSUBR (Fpoint_max);
2402 DEFSUBR (Fpoint_min);
2403 DEFSUBR (Fpoint_min_marker);
2404 DEFSUBR (Fpoint_max_marker);
2410 DEFSUBR (Ffollowing_char);
2411 DEFSUBR (Fpreceding_char);
2412 DEFSUBR (Fchar_after);
2413 DEFSUBR (Fchar_before);
2415 DEFSUBR (Finsert_string);
2416 DEFSUBR (Finsert_before_markers);
2417 DEFSUBR (Finsert_char);
2419 DEFSUBR (Ftemp_directory);
2420 DEFSUBR (Fuser_login_name);
2421 DEFSUBR (Fuser_real_login_name);
2422 DEFSUBR (Fuser_uid);
2423 DEFSUBR (Fuser_real_uid);
2424 DEFSUBR (Fuser_full_name);
2425 DEFSUBR (Fuser_home_directory);
2426 DEFSUBR (Femacs_pid);
2427 DEFSUBR (Fcurrent_time);
2428 DEFSUBR (Fcurrent_process_time);
2429 DEFSUBR (Fformat_time_string);
2430 DEFSUBR (Fdecode_time);
2431 DEFSUBR (Fencode_time);
2432 DEFSUBR (Fcurrent_time_string);
2433 DEFSUBR (Fcurrent_time_zone);
2434 DEFSUBR (Fset_time_zone_rule);
2435 DEFSUBR (Fsystem_name);
2438 DEFSUBR (Finsert_buffer_substring);
2439 DEFSUBR (Fcompare_buffer_substrings);
2440 DEFSUBR (Fsubst_char_in_region);
2441 DEFSUBR (Ftranslate_region);
2442 DEFSUBR (Fdelete_region);
2444 DEFSUBR (Fnarrow_to_region);
2445 DEFSUBR (Fsave_restriction);
2446 DEFSUBR (Ftranspose_regions);
2448 defsymbol (&Qzmacs_update_region, "zmacs-update-region");
2449 defsymbol (&Qzmacs_deactivate_region, "zmacs-deactivate-region");
2450 defsymbol (&Qzmacs_region_buffer, "zmacs-region-buffer");
2454 vars_of_editfns (void)
2456 staticpro (&Vsystem_name);
2458 staticpro (&Vuser_name);
2459 staticpro (&Vuser_real_name);
2461 DEFVAR_BOOL ("zmacs-regions", &zmacs_regions /*
2462 *Whether LISPM-style active regions should be used.
2463 This means that commands which operate on the region (the area between the
2464 point and the mark) will only work while the region is in the ``active''
2465 state, which is indicated by highlighting. Executing most commands causes
2466 the region to not be in the active state, so (for example) \\[kill-region] will only
2467 work immediately after activating the region.
2471 - Commands which operate on the region only work if the region is active.
2472 - Only a very small set of commands cause the region to become active:
2473 Those commands whose semantics are to mark an area, like mark-defun.
2474 - The region is deactivated after each command that is executed, except that:
2475 - "Motion" commands do not change whether the region is active or not.
2477 set-mark-command (C-SPC) pushes a mark and activates the region. Moving the
2478 cursor with normal motion commands (C-n, C-p, etc) will cause the region
2479 between point and the recently-pushed mark to be highlighted. It will
2480 remain highlighted until some non-motion command is executed.
2482 exchange-point-and-mark (\\[exchange-point-and-mark]) activates the region. So if you mark a
2483 region and execute a command that operates on it, you can reactivate the
2484 same region with \\[exchange-point-and-mark] (or perhaps \\[exchange-point-and-mark] \\[exchange-point-and-mark]) to operate on it
2487 Generally, commands which push marks as a means of navigation (like
2488 beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
2489 region. But commands which push marks as a means of marking an area of
2490 text (like mark-defun (\\[mark-defun]), mark-word (\\[mark-word]) or mark-whole-buffer (\\[mark-whole-buffer]))
2491 do activate the region.
2493 The way the command loop actually works with regard to deactivating the
2494 region is as follows:
2496 - If the variable `zmacs-region-stays' has been set to t during the command
2497 just executed, the region is left alone (this is how the motion commands
2498 make the region stay around; see the `_' flag in the `interactive'
2499 specification). `zmacs-region-stays' is reset to nil before each command
2501 - If the function `zmacs-activate-region' has been called during the command
2502 just executed, the region is left alone. Very few functions should
2503 actually call this function.
2504 - Otherwise, if the region is active, the region is deactivated and
2505 the `zmacs-deactivate-region-hook' is called.
2507 /* Zmacs style active regions are now ON by default */
2510 DEFVAR_BOOL ("zmacs-region-active-p", &zmacs_region_active_p /*
2511 Do not alter this. It is for internal use only.
2513 zmacs_region_active_p = 0;
2515 DEFVAR_BOOL ("zmacs-region-stays", &zmacs_region_stays /*
2516 Whether the current command will deactivate the region.
2517 Commands which do not wish to affect whether the region is currently
2518 highlighted should set this to t. Normally, the region is turned off after
2519 executing each command that did not explicitly turn it on with the function
2520 zmacs-activate-region. Setting this to true lets a command be non-intrusive.
2521 See the variable `zmacs-regions'.
2523 The same effect can be achieved using the `_' interactive specification.
2525 zmacs_region_stays = 0;
2527 DEFVAR_BOOL ("atomic-extent-goto-char-p", &atomic_extent_goto_char_p /*
2528 Do not use this -- it will be going away soon.
2529 Indicates if `goto-char' has just been run. This information is allegedly
2530 needed to get the desired behavior for atomic extents and unfortunately
2531 is not available by any other means.
2533 atomic_extent_goto_char_p = 0;
2534 #ifdef AMPERSAND_FULL_NAME
2535 Fprovide(intern("ampersand-full-name"));
2538 DEFVAR_LISP ("user-full-name", &Vuser_full_name /*
2539 *The name of the user.
2540 The function `user-full-name', which will return the value of this
2541 variable, when called without arguments.
2542 This is initialized to the value of the NAME environment variable.
2544 /* Initialized at run-time. */
2545 Vuser_full_name = Qnil;