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. */
34 #include "events.h" /* for EVENTP */
41 #include "line-number.h"
46 #include "sysfile.h" /* for getcwd */
48 /* Some static data, and a function to initialize it for each run */
50 Lisp_Object Vsystem_name; /* #### - I don't see why this should be */
51 /* static, either... --Stig */
52 #if 0 /* XEmacs - this is now dynamic */
53 /* if at some point it's deemed desirable to
54 use lisp variables here, then they can be
55 initialized to nil and then set to their
56 real values upon the first call to the
57 functions that generate them. --stig */
58 Lisp_Object Vuser_real_login_name; /* login name of current user ID */
59 Lisp_Object Vuser_login_name; /* user name from LOGNAME or USER. */
62 /* It's useful to be able to set this as user customization, so we'll
64 Lisp_Object Vuser_full_name;
65 EXFUN (Fuser_full_name, 1);
69 Lisp_Object Qpoint, Qmark, Qregion_beginning, Qregion_end;
71 Lisp_Object Quser_files_and_directories;
73 /* This holds the value of `environ' produced by the previous
74 call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
75 has never been called. */
76 static char **environbuf;
81 /* Only used in removed code below. */
86 /* Set up system_name even when dumping. */
94 if ((p = getenv ("NAME")))
95 /* I don't think it's the right thing to do the ampersand
96 modification on NAME. Not that it matters anymore... -hniksic */
97 Vuser_full_name = build_ext_string (p, Qnative);
99 Vuser_full_name = Fuser_full_name (Qnil);
102 DEFUN ("char-to-string", Fchar_to_string, 1, 1, 0, /*
103 Convert CHARACTER to a one-character string containing that character.
108 Bufbyte str[MAX_EMCHAR_LEN];
110 if (EVENTP (character))
112 Lisp_Object ch2 = Fevent_to_character (character, Qt, Qnil, Qnil);
115 signal_simple_continuable_error
116 ("character has no ASCII equivalent:", Fcopy_event (character, Qnil));
120 CHECK_CHAR_COERCE_INT (character);
122 len = set_charptr_emchar (str, XCHAR (character));
123 return make_string (str, len);
126 DEFUN ("string-to-char", Fstring_to_char, 1, 1, 0, /*
127 Convert arg STRING to a character, the first character of that string.
128 An empty string will return the constant `nil'.
133 CHECK_STRING (string);
135 p = XSTRING (string);
136 if (string_length (p) != 0)
137 return make_char (string_char (p, 0));
139 /* This used to return Qzero. That is broken, broken, broken. */
140 /* It might be kinder to signal an error directly. -slb */
146 buildmark (Bufpos val, Lisp_Object buffer)
148 Lisp_Object mark = Fmake_marker ();
149 Fset_marker (mark, make_int (val), buffer);
153 DEFUN ("point", Fpoint, 0, 1, 0, /*
154 Return value of point, as an integer.
155 Beginning of buffer is position (point-min).
156 If BUFFER is nil, the current buffer is assumed.
160 struct buffer *b = decode_buffer (buffer, 1);
161 return make_int (BUF_PT (b));
164 DEFUN ("point-marker", Fpoint_marker, 0, 2, 0, /*
165 Return value of point, as a marker object.
166 This marker is a copy; you may modify it with reckless abandon.
167 If optional argument DONT-COPY-P is non-nil, then it returns the real
168 point-marker; modifying the position of this marker will move point.
169 It is illegal to change the buffer of it, or make it point nowhere.
170 If BUFFER is nil, the current buffer is assumed.
172 (dont_copy_p, buffer))
174 struct buffer *b = decode_buffer (buffer, 1);
175 if (NILP (dont_copy_p))
176 return Fcopy_marker (b->point_marker, Qnil);
178 return b->point_marker;
181 /* The following two functions end up being identical but it's
182 cleaner to declare them separately. */
185 bufpos_clip_to_bounds (Bufpos lower, Bufpos num, Bufpos upper)
187 return (num < lower ? lower :
188 num > upper ? upper :
193 bytind_clip_to_bounds (Bytind lower, Bytind num, Bytind upper)
195 return (num < lower ? lower :
196 num > upper ? upper :
202 * There is no absolute way to determine if goto-char is the function
203 * being run. this-command doesn't work because it is often eval'd
204 * and this-command ends up set to eval-expression. So this flag gets
207 * Jamie thinks he's wrong, but we'll leave this in for now.
209 int atomic_extent_goto_char_p;
211 DEFUN ("goto-char", Fgoto_char, 1, 2, "NGoto char: ", /*
212 Set point to POSITION, a number or marker.
213 Beginning of buffer is position (point-min), end is (point-max).
214 If BUFFER is nil, the current buffer is assumed.
215 Return value of POSITION, as an integer.
219 struct buffer *b = decode_buffer (buffer, 1);
220 Bufpos n = get_buffer_pos_char (b, position, GB_COERCE_RANGE);
222 atomic_extent_goto_char_p = 1;
227 region_limit (int beginningp, struct buffer *b)
232 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
233 && NILP (b->mark_active))
234 Fsignal (Qmark_inactive, Qnil);
236 m = Fmarker_position (b->mark);
237 if (NILP (m)) error ("There is no region now");
238 if (!!(BUF_PT (b) < XINT (m)) == !!beginningp)
239 return make_int (BUF_PT (b));
244 DEFUN ("region-beginning", Fregion_beginning, 0, 1, 0, /*
245 Return position of beginning of region in BUFFER, as an integer.
246 If BUFFER is nil, the current buffer is assumed.
250 return region_limit (1, decode_buffer (buffer, 1));
253 DEFUN ("region-end", Fregion_end, 0, 1, 0, /*
254 Return position of end of region in BUFFER, as an integer.
255 If BUFFER is nil, the current buffer is assumed.
259 return region_limit (0, decode_buffer (buffer, 1));
262 /* Whether to use lispm-style active-regions */
265 /* Whether the zmacs region is active. This is not per-buffer because
266 there can be only one active region at a time. #### Now that the
267 zmacs region are not directly tied to the X selections this may not
268 necessarily have to be true. */
269 int zmacs_region_active_p;
271 int zmacs_region_stays;
273 Lisp_Object Qzmacs_update_region, Qzmacs_deactivate_region;
274 Lisp_Object Qzmacs_region_buffer;
277 zmacs_update_region (void)
279 /* This function can GC */
280 if (zmacs_region_active_p)
281 call0 (Qzmacs_update_region);
285 zmacs_deactivate_region (void)
287 /* This function can GC */
288 if (zmacs_region_active_p)
289 call0 (Qzmacs_deactivate_region);
293 zmacs_region_buffer (void)
295 if (zmacs_region_active_p)
296 return call0 (Qzmacs_region_buffer);
301 DEFUN ("mark-marker", Fmark_marker, 0, 2, 0, /*
302 Return this buffer's mark, as a marker object.
303 If `zmacs-regions' is true, then this returns nil unless the region is
304 currently in the active (highlighted) state. If optional argument FORCE
305 is t, this returns the mark (if there is one) regardless of the zmacs-region
306 state. You should *generally* not use the mark unless the region is active,
307 if the user has expressed a preference for the zmacs-region model.
308 Watch out! Moving this marker changes the mark position.
309 If you set the marker not to point anywhere, the buffer will have no mark.
310 If BUFFER is nil, the current buffer is assumed.
314 struct buffer *b = decode_buffer (buffer, 1);
315 if (! zmacs_regions || zmacs_region_active_p || !NILP (force))
321 /* The saved object is a cons:
323 (COPY-OF-POINT-MARKER . COPY-OF-MARK)
325 We used to have another cons for a VISIBLE-P element, which was t
326 if `(eq (current-buffer) (window-buffer (selected-window)))' but it
327 was unused for a long time, so I removed it. --hniksic */
329 save_excursion_save (void)
333 /* #### Huh? --hniksic */
334 /*if (preparing_for_armageddon) return Qnil;*/
336 #ifdef ERROR_CHECK_BUFPOS
337 assert (XINT (Fpoint (Qnil)) ==
338 XINT (Fmarker_position (Fpoint_marker (Qt, Qnil))));
343 return noseeum_cons (noseeum_copy_marker (b->point_marker, Qnil),
344 noseeum_copy_marker (b->mark, Qnil));
348 save_excursion_restore (Lisp_Object info)
350 Lisp_Object buffer = Fmarker_buffer (XCAR (info));
352 /* If buffer being returned to is now deleted, avoid error --
353 otherwise could get error here while unwinding to top level and
354 crash. In that case, Fmarker_buffer returns nil now. */
357 struct buffer *buf = XBUFFER (buffer);
360 set_buffer_internal (buf);
361 Fgoto_char (XCAR (info), buffer);
362 Fset_marker (buf->mark, XCDR (info), buffer);
364 #if 0 /* We used to make the current buffer visible in the selected window
365 if that was true previously. That avoids some anomalies.
366 But it creates others, and it wasn't documented, and it is simpler
367 and cleaner never to alter the window/buffer connections. */
368 /* I'm certain some code somewhere depends on this behavior. --jwz */
369 /* Even if it did, it certainly doesn't matter anymore, because
370 this has been the behavior for countless XEmacs releases
373 && (current_buffer != XBUFFER (XWINDOW (selected_window)->buffer)))
374 switch_to_buffer (Fcurrent_buffer (), Qnil);
380 /* Free all the junk we allocated, so that a `save-excursion' comes
381 for free in terms of GC junk. */
382 free_marker (XMARKER (XCAR (info)));
383 free_marker (XMARKER (XCDR (info)));
384 free_cons (XCONS (info));
388 DEFUN ("save-excursion", Fsave_excursion, 0, UNEVALLED, 0, /*
389 Save point, mark, and current buffer; execute BODY; restore those things.
390 Executes BODY just like `progn'.
391 The values of point, mark and the current buffer are restored
392 even in case of abnormal exit (throw or error).
396 /* This function can GC */
397 int speccount = specpdl_depth ();
399 record_unwind_protect (save_excursion_restore, save_excursion_save ());
401 return unbind_to (speccount, Fprogn (args));
405 save_current_buffer_restore (Lisp_Object buffer)
407 struct buffer *buf = XBUFFER (buffer);
408 /* Avoid signaling an error if the buffer is no longer alive. This
409 is for consistency with save-excursion. */
410 if (BUFFER_LIVE_P (buf))
411 set_buffer_internal (buf);
415 DEFUN ("save-current-buffer", Fsave_current_buffer, 0, UNEVALLED, 0, /*
416 Save the current buffer; execute BODY; restore the current buffer.
417 Executes BODY just like `progn'.
421 /* This function can GC */
422 int speccount = specpdl_depth ();
424 record_unwind_protect (save_current_buffer_restore, Fcurrent_buffer ());
426 return unbind_to (speccount, Fprogn (args));
429 DEFUN ("buffer-size", Fbuffer_size, 0, 1, 0, /*
430 Return the number of characters in BUFFER.
431 If BUFFER is nil, the current buffer is assumed.
435 struct buffer *b = decode_buffer (buffer, 1);
436 return make_int (BUF_SIZE (b));
439 DEFUN ("point-min", Fpoint_min, 0, 1, 0, /*
440 Return the minimum permissible value of point in BUFFER.
441 This is 1, unless narrowing (a buffer restriction)
442 is in effect, in which case it may be greater.
443 If BUFFER is nil, the current buffer is assumed.
447 struct buffer *b = decode_buffer (buffer, 1);
448 return make_int (BUF_BEGV (b));
451 DEFUN ("point-min-marker", Fpoint_min_marker, 0, 1, 0, /*
452 Return a marker to the minimum permissible value of point in BUFFER.
453 This is the beginning, unless narrowing (a buffer restriction)
454 is in effect, in which case it may be greater.
455 If BUFFER is nil, the current buffer is assumed.
459 struct buffer *b = decode_buffer (buffer, 1);
460 return buildmark (BUF_BEGV (b), make_buffer (b));
463 DEFUN ("point-max", Fpoint_max, 0, 1, 0, /*
464 Return the maximum permissible value of point in BUFFER.
465 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
466 is in effect, in which case it may be less.
467 If BUFFER is nil, the current buffer is assumed.
471 struct buffer *b = decode_buffer (buffer, 1);
472 return make_int (BUF_ZV (b));
475 DEFUN ("point-max-marker", Fpoint_max_marker, 0, 1, 0, /*
476 Return a marker to the maximum permissible value of point in BUFFER.
477 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
478 is in effect, in which case it may be less.
479 If BUFFER is nil, the current buffer is assumed.
483 struct buffer *b = decode_buffer (buffer, 1);
484 return buildmark (BUF_ZV (b), make_buffer (b));
487 DEFUN ("following-char", Ffollowing_char, 0, 1, 0, /*
488 Return the character following point.
489 At the end of the buffer or accessible region, return 0.
490 If BUFFER is nil, the current buffer is assumed.
494 struct buffer *b = decode_buffer (buffer, 1);
495 if (BUF_PT (b) >= BUF_ZV (b))
496 return Qzero; /* #### Gag me! */
498 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b)));
501 DEFUN ("preceding-char", Fpreceding_char, 0, 1, 0, /*
502 Return the character preceding point.
503 At the beginning of the buffer or accessible region, return 0.
504 If BUFFER is nil, the current buffer is assumed.
508 struct buffer *b = decode_buffer (buffer, 1);
509 if (BUF_PT (b) <= BUF_BEGV (b))
510 return Qzero; /* #### Gag me! */
512 return make_char (BUF_FETCH_CHAR (b, BUF_PT (b) - 1));
515 DEFUN ("bobp", Fbobp, 0, 1, 0, /*
516 Return t if point is at the beginning of the buffer.
517 If the buffer is narrowed, this means the beginning of the narrowed part.
518 If BUFFER is nil, the current buffer is assumed.
522 struct buffer *b = decode_buffer (buffer, 1);
523 return BUF_PT (b) == BUF_BEGV (b) ? Qt : Qnil;
526 DEFUN ("eobp", Feobp, 0, 1, 0, /*
527 Return t if point is at the end of the buffer.
528 If the buffer is narrowed, this means the end of the narrowed part.
529 If BUFFER is nil, the current buffer is assumed.
533 struct buffer *b = decode_buffer (buffer, 1);
534 return BUF_PT (b) == BUF_ZV (b) ? Qt : Qnil;
538 beginning_of_line_p (struct buffer *b, Bufpos pt)
540 return pt <= BUF_BEGV (b) || BUF_FETCH_CHAR (b, pt - 1) == '\n';
544 DEFUN ("bolp", Fbolp, 0, 1, 0, /*
545 Return t if point is at the beginning of a line.
546 If BUFFER is nil, the current buffer is assumed.
550 struct buffer *b = decode_buffer (buffer, 1);
551 return beginning_of_line_p (b, BUF_PT (b)) ? Qt : Qnil;
554 DEFUN ("eolp", Feolp, 0, 1, 0, /*
555 Return t if point is at the end of a line.
556 `End of a line' includes point being at the end of the buffer.
557 If BUFFER is nil, the current buffer is assumed.
561 struct buffer *b = decode_buffer (buffer, 1);
562 return (BUF_PT (b) == BUF_ZV (b) || BUF_FETCH_CHAR (b, BUF_PT (b)) == '\n')
566 DEFUN ("char-after", Fchar_after, 0, 2, 0, /*
567 Return the character at position POS in BUFFER.
568 POS is an integer or a marker.
569 If POS is out of range, the value is nil.
570 if POS is nil, the value of point is assumed.
571 If BUFFER is nil, the current buffer is assumed.
575 struct buffer *b = decode_buffer (buffer, 1);
576 Bufpos n = (NILP (pos) ? BUF_PT (b) :
577 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD));
579 if (n < 0 || n == BUF_ZV (b))
581 return make_char (BUF_FETCH_CHAR (b, n));
584 DEFUN ("char-before", Fchar_before, 0, 2, 0, /*
585 Return the character preceding position POS in BUFFER.
586 POS is an integer or a marker.
587 If POS is out of range, the value is nil.
588 if POS is nil, the value of point is assumed.
589 If BUFFER is nil, the current buffer is assumed.
593 struct buffer *b = decode_buffer (buffer, 1);
594 Bufpos n = (NILP (pos) ? BUF_PT (b) :
595 get_buffer_pos_char (b, pos, GB_NO_ERROR_IF_BAD));
599 if (n < BUF_BEGV (b))
601 return make_char (BUF_FETCH_CHAR (b, n));
604 #if !defined(WINDOWSNT) && !defined(MSDOS)
605 #include <sys/stat.h>
611 DEFUN ("temp-directory", Ftemp_directory, 0, 0, 0, /*
612 Return the pathname to the directory to use for temporary files.
613 On MS Windows, this is obtained from the TEMP or TMP environment variables,
614 defaulting to / if they are both undefined.
615 On Unix it is obtained from TMPDIR, with /tmp as the default.
620 #if defined(WIN32_NATIVE)
621 tmpdir = getenv ("TEMP");
623 tmpdir = getenv ("TMP");
626 #else /* WIN32_NATIVE */
627 tmpdir = getenv ("TMPDIR");
631 int myuid = getuid();
632 static char path[5 /* strlen ("/tmp/") */ + 1 + _POSIX_PATH_MAX];
634 strcpy (path, "/tmp/");
635 strncat (path, user_login_name (NULL), _POSIX_PATH_MAX);
636 if (lstat(path, &st) < 0 && errno == ENOENT)
638 mkdir(path, 0700); /* ignore retval -- checked next anyway. */
640 if (lstat(path, &st) == 0 && st.st_uid == myuid && S_ISDIR(st.st_mode))
646 strcpy(path, getenv("HOME")); strncat(path, "/tmp/", _POSIX_PATH_MAX);
647 if (stat(path, &st) < 0 && errno == ENOENT)
650 char warnpath[1+_POSIX_PATH_MAX];
651 mkdir(path, 0700); /* ignore retvals */
652 strcpy(warnpath, path);
653 strncat(warnpath, ".created_by_xemacs", _POSIX_PATH_MAX);
654 if ((fd = open(warnpath, O_WRONLY|O_CREAT, 0644)) > 0)
656 write(fd, "XEmacs created this directory because /tmp/<yourname> was unavailable -- \nPlease check !\n", 89);
660 if (stat(path, &st) == 0 && S_ISDIR(st.st_mode))
672 return build_ext_string (tmpdir, Qfile_name);
675 DEFUN ("user-login-name", Fuser_login_name, 0, 1, 0, /*
676 Return the name under which the user logged in, as a string.
677 This is based on the effective uid, not the real uid.
678 Also, if the environment variable LOGNAME or USER is set,
679 that determines the value of this function.
680 If the optional argument UID is present, then environment variables are
681 ignored and this function returns the login name for that UID, or nil.
691 local_uid = XINT (uid);
692 returned_name = user_login_name (&local_uid);
696 returned_name = user_login_name (NULL);
698 /* #### - I believe this should return nil instead of "unknown" when pw==0
699 pw=0 is indicated by a null return from user_login_name
701 return returned_name ? build_string (returned_name) : Qnil;
704 /* This function may be called from other C routines when a
705 character string representation of the user_login_name is
706 needed but a Lisp Object is not. The UID is passed by
707 reference. If UID == NULL, then the USER name
708 for the user running XEmacs will be returned. This
709 corresponds to a nil argument to Fuser_login_name.
712 user_login_name (uid_t *uid)
714 /* uid == NULL to return name of this user */
717 struct passwd *pw = getpwuid (*uid);
718 return pw ? pw->pw_name : NULL;
722 /* #### - when euid != uid, then LOGNAME and USER are leftovers from the
723 old environment (I site observed behavior on sunos and linux), so the
724 environment variables should be disregarded in that case. --Stig */
725 char *user_name = getenv ("LOGNAME");
729 "USERNAME" /* it's USERNAME on NT */
738 struct passwd *pw = getpwuid (geteuid ());
740 /* Since the Cygwin environment may not have an /etc/passwd,
741 return "unknown" instead of the null if the username
742 cannot be determined.
744 return pw ? pw->pw_name : "unknown";
746 /* For all but Cygwin return NULL (nil) */
747 return pw ? pw->pw_name : NULL;
753 DEFUN ("user-real-login-name", Fuser_real_login_name, 0, 0, 0, /*
754 Return the name of the user's real uid, as a string.
755 This ignores the environment variables LOGNAME and USER, so it differs from
756 `user-login-name' when running under `su'.
760 struct passwd *pw = getpwuid (getuid ());
761 /* #### - I believe this should return nil instead of "unknown" when pw==0 */
763 Lisp_Object tem = build_string (pw ? pw->pw_name : "unknown");/* no gettext */
767 DEFUN ("user-uid", Fuser_uid, 0, 0, 0, /*
768 Return the effective uid of Emacs, as an integer.
772 return make_int (geteuid ());
775 DEFUN ("user-real-uid", Fuser_real_uid, 0, 0, 0, /*
776 Return the real uid of Emacs, as an integer.
780 return make_int (getuid ());
783 DEFUN ("user-full-name", Fuser_full_name, 0, 1, 0, /*
784 Return the full name of the user logged in, as a string.
785 If the optional argument USER is given, then the full name for that
786 user is returned, or nil. USER may be either a login name or a uid.
788 If USER is nil, and `user-full-name' contains a string, the
789 value of `user-full-name' is returned.
793 Lisp_Object user_name;
794 struct passwd *pw = NULL;
798 if (NILP (user) && STRINGP (Vuser_full_name))
799 return Vuser_full_name;
801 user_name = (STRINGP (user) ? user : Fuser_login_name (user));
802 if (!NILP (user_name)) /* nil when nonexistent UID passed as arg */
804 const char *user_name_ext;
806 /* Fuck me. getpwnam() can call select() and (under IRIX at least)
807 things get wedged if a SIGIO arrives during this time. */
808 TO_EXTERNAL_FORMAT (LISP_STRING, user_name,
809 C_STRING_ALLOCA, user_name_ext,
811 slow_down_interrupts ();
812 pw = (struct passwd *) getpwnam (user_name_ext);
813 speed_up_interrupts ();
816 /* #### - Stig sez: this should return nil instead of "unknown" when pw==0 */
817 /* Ben sez: bad idea because it's likely to break something */
818 #ifndef AMPERSAND_FULL_NAME
819 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
822 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
825 tem = ((!NILP (user) && !pw)
827 : make_ext_string ((Extbyte *) p, (q ? q - p : strlen (p)),
830 #ifdef AMPERSAND_FULL_NAME
833 p = (char *) XSTRING_DATA (tem);
835 /* Substitute the login name for the &, upcasing the first character. */
838 char *r = (char *) alloca (strlen (p) + XSTRING_LENGTH (user_name) + 1);
839 memcpy (r, p, q - p);
841 strcat (r, (char *) XSTRING_DATA (user_name));
842 /* #### current_buffer dependency! */
843 r[q - p] = UPCASE (current_buffer, r[q - p]);
845 tem = build_string (r);
848 #endif /* AMPERSAND_FULL_NAME */
853 static Extbyte *cached_home_directory;
856 uncache_home_directory (void)
858 cached_home_directory = NULL; /* in some cases, this may cause the leaking
862 /* !!#### not Mule correct. */
864 /* Returns the home directory, in external format */
866 get_home_directory (void)
868 /* !!#### this is hopelessly bogus. Rule #1: Do not make any assumptions
869 about what format an external string is in. Could be Unicode, for all
870 we know, and then all the operations below are totally bogus.
871 Instead, convert all data to internal format *right* at the juncture
872 between XEmacs and the outside world, the very moment we first get
874 int output_home_warning = 0;
876 if (cached_home_directory == NULL)
878 if ((cached_home_directory = (Extbyte *) getenv("HOME")) == NULL)
880 #if defined(WIN32_NATIVE)
881 char *homedrive, *homepath;
883 if ((homedrive = getenv("HOMEDRIVE")) != NULL &&
884 (homepath = getenv("HOMEPATH")) != NULL)
886 cached_home_directory =
887 (Extbyte *) xmalloc (strlen (homedrive) +
888 strlen (homepath) + 1);
889 sprintf((char *) cached_home_directory, "%s%s",
895 # if 0 /* changed by ben. This behavior absolutely stinks, and the
896 possibility being addressed here occurs quite commonly.
897 Using the current directory makes absolutely no sense. */
899 * Use the current directory.
900 * This preserves the existing XEmacs behavior, but is different
903 if (initial_directory[0] != '\0')
905 cached_home_directory = (Extbyte*) initial_directory;
909 /* This will probably give the wrong value */
910 cached_home_directory = (Extbyte*) getcwd (NULL, 0);
914 * This is NT Emacs behavior
916 cached_home_directory = (Extbyte *) "C:\\";
917 output_home_warning = 1;
920 #else /* !WIN32_NATIVE */
923 * Using "/" isn't quite right, but what should we do?
924 * We probably should try to extract pw_dir from /etc/passwd,
925 * before falling back to this.
927 cached_home_directory = (Extbyte *) "/";
928 output_home_warning = 1;
929 #endif /* !WIN32_NATIVE */
931 if (initialized && output_home_warning)
933 warn_when_safe (Quser_files_and_directories, Qwarning, "\n"
934 " XEmacs was unable to determine a good value for the user's $HOME\n"
935 " directory, and will be using the value:\n"
937 " This is probably incorrect.",
938 cached_home_directory
942 return cached_home_directory;
945 DEFUN ("user-home-directory", Fuser_home_directory, 0, 0, 0, /*
946 Return the user's home directory, as a string.
950 Extbyte *path = get_home_directory ();
952 return path == NULL ? Qnil :
953 Fexpand_file_name (Fsubstitute_in_file_name
954 (build_ext_string ((char *) path, Qfile_name)),
958 DEFUN ("system-name", Fsystem_name, 0, 0, 0, /*
959 Return the name of the machine you are running on, as a string.
963 return Fcopy_sequence (Vsystem_name);
966 DEFUN ("emacs-pid", Femacs_pid, 0, 0, 0, /*
967 Return the process ID of Emacs, as an integer.
971 return make_int (getpid ());
974 DEFUN ("current-time", Fcurrent_time, 0, 0, 0, /*
975 Return the current time, as the number of seconds since 1970-01-01 00:00:00.
976 The time is returned as a list of three integers. The first has the
977 most significant 16 bits of the seconds, while the second has the
978 least significant 16 bits. The third integer gives the microsecond
981 The microsecond count is zero on systems that do not provide
982 resolution finer than a second.
989 return list3 (make_int ((EMACS_SECS (t) >> 16) & 0xffff),
990 make_int ((EMACS_SECS (t) >> 0) & 0xffff),
991 make_int (EMACS_USECS (t)));
994 DEFUN ("current-process-time", Fcurrent_process_time, 0, 0, 0, /*
995 Return the amount of time used by this XEmacs process so far.
996 The return value is a list of three floating-point numbers, expressing
997 the user, system, and real times used by the process. The user time
998 measures the time actually spent by the CPU executing the code in this
999 process. The system time measures time spent by the CPU executing kernel
1000 code on behalf of this process (e.g. I/O requests made by the process).
1002 Note that the user and system times measure processor time, as opposed
1003 to real time, and only accrue when the processor is actually doing
1004 something: Time spent in an idle wait (waiting for user events to come
1005 in or for I/O on a disk drive or other device to complete) does not
1006 count. Thus, the user and system times will often be considerably
1007 less than the real time.
1009 Some systems do not allow the user and system times to be distinguished.
1010 In this case, the user time will be the total processor time used by
1011 the process, and the system time will be 0.
1013 Some systems do not allow the real and processor times to be distinguished.
1014 In this case, the user and real times will be the same and the system
1019 double user, sys, real;
1021 get_process_times (&user, &sys, &real);
1022 return list3 (make_float (user), make_float (sys), make_float (real));
1026 int lisp_to_time (Lisp_Object specified_time, time_t *result);
1028 lisp_to_time (Lisp_Object specified_time, time_t *result)
1030 Lisp_Object high, low;
1032 if (NILP (specified_time))
1033 return time (result) != -1;
1035 CHECK_CONS (specified_time);
1036 high = XCAR (specified_time);
1037 low = XCDR (specified_time);
1042 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1043 return *result >> 16 == XINT (high);
1046 Lisp_Object time_to_lisp (time_t the_time);
1048 time_to_lisp (time_t the_time)
1050 unsigned int item = (unsigned int) the_time;
1051 return Fcons (make_int (item >> 16), make_int (item & 0xffff));
1054 size_t emacs_strftime (char *string, size_t max, const char *format,
1055 const struct tm *tm);
1056 static long difftm (const struct tm *a, const struct tm *b);
1059 DEFUN ("format-time-string", Fformat_time_string, 1, 2, 0, /*
1060 Use FORMAT-STRING to format the time TIME.
1061 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from
1062 `current-time' and `file-attributes'. If TIME is not specified it
1063 defaults to the current time.
1064 FORMAT-STRING may contain %-sequences to substitute parts of the time.
1065 %a is replaced by the abbreviated name of the day of week.
1066 %A is replaced by the full name of the day of week.
1067 %b is replaced by the abbreviated name of the month.
1068 %B is replaced by the full name of the month.
1069 %c is a synonym for "%x %X".
1070 %C is a locale-specific synonym, which defaults to "%A, %B %e, %Y" in the C locale.
1071 %d is replaced by the day of month, zero-padded.
1072 %D is a synonym for "%m/%d/%y".
1073 %e is replaced by the day of month, blank-padded.
1074 %h is a synonym for "%b".
1075 %H is replaced by the hour (00-23).
1076 %I is replaced by the hour (00-12).
1077 %j is replaced by the day of the year (001-366).
1078 %k is replaced by the hour (0-23), blank padded.
1079 %l is replaced by the hour (1-12), blank padded.
1080 %m is replaced by the month (01-12).
1081 %M is replaced by the minute (00-59).
1082 %n is a synonym for "\\n".
1083 %p is replaced by AM or PM, as appropriate.
1084 %r is a synonym for "%I:%M:%S %p".
1085 %R is a synonym for "%H:%M".
1086 %s is replaced by the time in seconds since 00:00:00, Jan 1, 1970 (a
1087 nonstandard extension)
1088 %S is replaced by the second (00-60).
1089 %t is a synonym for "\\t".
1090 %T is a synonym for "%H:%M:%S".
1091 %U is replaced by the week of the year (00-53), first day of week is Sunday.
1092 %w is replaced by the day of week (0-6), Sunday is day 0.
1093 %W is replaced by the week of the year (00-53), first day of week is Monday.
1094 %x is a locale-specific synonym, which defaults to "%D" in the C locale.
1095 %X is a locale-specific synonym, which defaults to "%T" in the C locale.
1096 %y is replaced by the year without century (00-99).
1097 %Y is replaced by the year with century.
1098 %Z is replaced by the time zone abbreviation.
1100 The number of options reflects the `strftime' function.
1102 BUG: If the charset used by the current locale is not ISO 8859-1, the
1103 characters appearing in the day and month names may be incorrect.
1105 (format_string, time_))
1110 CHECK_STRING (format_string);
1112 if (! lisp_to_time (time_, &value))
1113 error ("Invalid time specification");
1115 /* This is probably enough. */
1116 size = XSTRING_LENGTH (format_string) * 6 + 50;
1120 char *buf = (char *) alloca (size);
1122 if (emacs_strftime (buf, size,
1123 (const char *) XSTRING_DATA (format_string),
1126 return build_ext_string (buf, Qbinary);
1127 /* If buffer was too small, make it bigger. */
1132 DEFUN ("decode-time", Fdecode_time, 0, 1, 0, /*
1133 Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1134 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)
1135 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'
1136 to use the current time. The list has the following nine members:
1137 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which
1138 only some operating systems support. MINUTE is an integer between 0 and 59.
1139 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.
1140 MONTH is an integer between 1 and 12. YEAR is an integer indicating the
1141 four-digit year. DOW is the day of week, an integer between 0 and 6, where
1142 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.
1143 ZONE is an integer indicating the number of seconds east of Greenwich.
1144 \(Note that Common Lisp has different meanings for DOW and ZONE.)
1150 struct tm *decoded_time;
1151 Lisp_Object list_args[9];
1153 if (! lisp_to_time (specified_time, &time_spec))
1154 error ("Invalid time specification");
1156 decoded_time = localtime (&time_spec);
1157 list_args[0] = make_int (decoded_time->tm_sec);
1158 list_args[1] = make_int (decoded_time->tm_min);
1159 list_args[2] = make_int (decoded_time->tm_hour);
1160 list_args[3] = make_int (decoded_time->tm_mday);
1161 list_args[4] = make_int (decoded_time->tm_mon + 1);
1162 list_args[5] = make_int (decoded_time->tm_year + 1900);
1163 list_args[6] = make_int (decoded_time->tm_wday);
1164 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1166 /* Make a copy, in case gmtime modifies the struct. */
1167 save_tm = *decoded_time;
1168 decoded_time = gmtime (&time_spec);
1169 if (decoded_time == 0)
1170 list_args[8] = Qnil;
1172 list_args[8] = make_int (difftm (&save_tm, decoded_time));
1173 return Flist (9, list_args);
1176 static void set_time_zone_rule (char *tzstring);
1178 DEFUN ("encode-time", Fencode_time, 6, MANY, 0, /*
1179 Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1180 This is the reverse operation of `decode-time', which see.
1181 ZONE defaults to the current time zone rule. This can
1182 be a string (as from `set-time-zone-rule'), or it can be a list
1183 \(as from `current-time-zone') or an integer (as from `decode-time')
1184 applied without consideration for daylight savings time.
1186 You can pass more than 7 arguments; then the first six arguments
1187 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1188 The intervening arguments are ignored.
1189 This feature lets (apply 'encode-time (decode-time ...)) work.
1191 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;
1192 for example, a DAY of 0 means the day preceding the given month.
1193 Year numbers less than 100 are treated just like other year numbers.
1194 If you want them to stand for years in this century, you must do that yourself.
1196 (int nargs, Lisp_Object *args))
1200 Lisp_Object zone = (nargs > 6) ? args[nargs - 1] : Qnil;
1202 CHECK_INT (*args); tm.tm_sec = XINT (*args++); /* second */
1203 CHECK_INT (*args); tm.tm_min = XINT (*args++); /* minute */
1204 CHECK_INT (*args); tm.tm_hour = XINT (*args++); /* hour */
1205 CHECK_INT (*args); tm.tm_mday = XINT (*args++); /* day */
1206 CHECK_INT (*args); tm.tm_mon = XINT (*args++) - 1; /* month */
1207 CHECK_INT (*args); tm.tm_year = XINT (*args++) - 1900;/* year */
1214 the_time = mktime (&tm);
1219 char **oldenv = environ, **newenv;
1222 tzstring = (char *) XSTRING_DATA (zone);
1223 else if (INTP (zone))
1225 int abszone = abs (XINT (zone));
1226 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1227 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1231 error ("Invalid time zone specification");
1233 /* Set TZ before calling mktime; merely adjusting mktime's returned
1234 value doesn't suffice, since that would mishandle leap seconds. */
1235 set_time_zone_rule (tzstring);
1237 the_time = mktime (&tm);
1239 /* Restore TZ to previous value. */
1243 #ifdef LOCALTIME_CACHE
1248 if (the_time == (time_t) -1)
1249 error ("Specified time is not representable");
1251 return wasteful_word_to_lisp (the_time);
1254 DEFUN ("current-time-string", Fcurrent_time_string, 0, 1, 0, /*
1255 Return the current time, as a human-readable string.
1256 Programs can use this function to decode a time,
1257 since the number of columns in each field is fixed.
1258 The format is `Sun Sep 16 01:03:52 1973'.
1259 If an argument is given, it specifies a time to format
1260 instead of the current time. The argument should have the form:
1263 (HIGH LOW . IGNORED).
1264 Thus, you can use times obtained from `current-time'
1265 and from `file-attributes'.
1273 if (! lisp_to_time (specified_time, &value))
1275 the_ctime = ctime (&value);
1277 /* ctime is documented as always returning a "\n\0"-terminated
1278 26-byte American time string, but let's be careful anyways. */
1279 for (len = 0; the_ctime[len] != '\n' && the_ctime[len] != '\0'; len++)
1282 return make_ext_string ((Extbyte *) the_ctime, len, Qbinary);
1285 #define TM_YEAR_ORIGIN 1900
1287 /* Yield A - B, measured in seconds. */
1289 difftm (const struct tm *a, const struct tm *b)
1291 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
1292 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
1293 /* Some compilers can't handle this as a single return statement. */
1295 /* difference in day of year */
1296 a->tm_yday - b->tm_yday
1297 /* + intervening leap days */
1298 + ((ay >> 2) - (by >> 2))
1300 + ((ay/100 >> 2) - (by/100 >> 2))
1301 /* + difference in years * 365 */
1302 + (long)(ay-by) * 365
1304 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
1305 + (a->tm_min - b->tm_min))
1306 + (a->tm_sec - b->tm_sec));
1309 DEFUN ("current-time-zone", Fcurrent_time_zone, 0, 1, 0, /*
1310 Return the offset and name for the local time zone.
1311 This returns a list of the form (OFFSET NAME).
1312 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1313 A negative value means west of Greenwich.
1314 NAME is a string giving the name of the time zone.
1315 If an argument is given, it specifies when the time zone offset is determined
1316 instead of using the current time. The argument should have the form:
1319 (HIGH LOW . IGNORED).
1320 Thus, you can use times obtained from `current-time'
1321 and from `file-attributes'.
1323 Some operating systems cannot provide all this information to Emacs;
1324 in this case, `current-time-zone' returns a list containing nil for
1325 the data it can't find.
1330 struct tm *t = NULL;
1332 if (lisp_to_time (specified_time, &value)
1333 && (t = gmtime (&value)) != 0)
1335 struct tm gmt = *t; /* Make a copy, in case localtime modifies *t. */
1339 t = localtime (&value);
1340 offset = difftm (t, &gmt);
1344 s = (char *)t->tm_zone;
1345 #else /* not HAVE_TM_ZONE */
1347 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1348 s = tzname[t->tm_isdst];
1350 #endif /* not HAVE_TM_ZONE */
1353 /* No local time zone name is available; use "+-NNNN" instead. */
1354 int am = (offset < 0 ? -offset : offset) / 60;
1355 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1358 return list2 (make_int (offset), build_string (s));
1361 return list2 (Qnil, Qnil);
1364 #ifdef LOCALTIME_CACHE
1366 /* These two values are known to load tz files in buggy implementations,
1367 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1368 Their values shouldn't matter in non-buggy implementations.
1369 We don't use string literals for these strings,
1370 since if a string in the environment is in readonly
1371 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1372 See Sun bugs 1113095 and 1114114, ``Timezone routines
1373 improperly modify environment''. */
1375 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1376 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1380 /* Set the local time zone rule to TZSTRING.
1381 This allocates memory into `environ', which it is the caller's
1382 responsibility to free. */
1384 set_time_zone_rule (char *tzstring)
1387 char **from, **to, **newenv;
1389 for (from = environ; *from; from++)
1391 envptrs = from - environ + 2;
1392 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1393 + (tzstring ? strlen (tzstring) + 4 : 0));
1396 char *t = (char *) (to + envptrs);
1398 strcat (t, tzstring);
1402 for (from = environ; *from; from++)
1403 if (strncmp (*from, "TZ=", 3) != 0)
1409 #ifdef LOCALTIME_CACHE
1411 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1412 "US/Pacific" that loads a tz file, then changes to a value like
1413 "XXX0" that does not load a tz file, and then changes back to
1414 its original value, the last change is (incorrectly) ignored.
1415 Also, if TZ changes twice in succession to values that do
1416 not load a tz file, tzset can dump core (see Sun bug#1225179).
1417 The following code works around these bugs. */
1421 /* Temporarily set TZ to a value that loads a tz file
1422 and that differs from tzstring. */
1424 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1425 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1431 /* The implied tzstring is unknown, so temporarily set TZ to
1432 two different values that each load a tz file. */
1433 *to = set_time_zone_rule_tz1;
1436 *to = set_time_zone_rule_tz2;
1441 /* Now TZ has the desired value, and tzset can be invoked safely. */
1448 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, 1, 1, 0, /*
1449 Set the local time zone using TZ, a string specifying a time zone rule.
1450 If TZ is nil, use implementation-defined default time zone information.
1461 tzstring = (char *) XSTRING_DATA (tz);
1464 set_time_zone_rule (tzstring);
1467 environbuf = environ;
1474 buffer_insert1 (struct buffer *buf, Lisp_Object arg)
1476 /* This function can GC */
1477 struct gcpro gcpro1;
1480 if (CHAR_OR_CHAR_INTP (arg))
1482 buffer_insert_emacs_char (buf, XCHAR_OR_CHAR_INT (arg));
1484 else if (STRINGP (arg))
1486 buffer_insert_lisp_string (buf, arg);
1490 arg = wrong_type_argument (Qchar_or_string_p, arg);
1497 /* Callers passing one argument to Finsert need not gcpro the
1498 argument "array", since the only element of the array will
1499 not be used after calling insert_emacs_char or insert_lisp_string,
1500 so we don't care if it gets trashed. */
1502 DEFUN ("insert", Finsert, 0, MANY, 0, /*
1503 Insert the arguments, either strings or characters, at point.
1504 Point moves forward so that it ends up after the inserted text.
1505 Any other markers at the point of insertion remain before the text.
1506 If a string has non-null string-extent-data, new extents will be created.
1508 (int nargs, Lisp_Object *args))
1510 /* This function can GC */
1511 REGISTER int argnum;
1513 for (argnum = 0; argnum < nargs; argnum++)
1515 buffer_insert1 (current_buffer, args[argnum]);
1521 DEFUN ("insert-before-markers", Finsert_before_markers, 0, MANY, 0, /*
1522 Insert strings or characters at point, relocating markers after the text.
1523 Point moves forward so that it ends up after the inserted text.
1524 Any other markers at the point of insertion also end up after the text.
1526 (int nargs, Lisp_Object *args))
1528 /* This function can GC */
1529 REGISTER int argnum;
1530 REGISTER Lisp_Object tem;
1532 for (argnum = 0; argnum < nargs; argnum++)
1536 if (CHAR_OR_CHAR_INTP (tem))
1538 buffer_insert_emacs_char_1 (current_buffer, -1,
1539 XCHAR_OR_CHAR_INT (tem),
1540 INSDEL_BEFORE_MARKERS);
1542 else if (STRINGP (tem))
1544 buffer_insert_lisp_string_1 (current_buffer, -1, tem,
1545 INSDEL_BEFORE_MARKERS);
1549 tem = wrong_type_argument (Qchar_or_string_p, tem);
1556 DEFUN ("insert-string", Finsert_string, 1, 2, 0, /*
1557 Insert STRING into BUFFER at BUFFER's point.
1558 Point moves forward so that it ends up after the inserted text.
1559 Any other markers at the point of insertion remain before the text.
1560 If a string has non-null string-extent-data, new extents will be created.
1561 BUFFER defaults to the current buffer.
1565 struct buffer *b = decode_buffer (buffer, 1);
1566 CHECK_STRING (string);
1567 buffer_insert_lisp_string (b, string);
1571 /* Third argument in FSF is INHERIT:
1573 "The optional third arg INHERIT, if non-nil, says to inherit text properties
1574 from adjoining text, if those properties are sticky."
1576 Jamie thinks this is bogus. */
1579 DEFUN ("insert-char", Finsert_char, 1, 4, 0, /*
1580 Insert COUNT copies of CHARACTER into BUFFER.
1581 Point and all markers are affected as in the function `insert'.
1582 COUNT defaults to 1 if omitted.
1583 The optional third arg IGNORED is INHERIT under FSF Emacs.
1584 This is highly bogus, however, and XEmacs always behaves as if
1585 `t' were passed to INHERIT.
1586 The optional fourth arg BUFFER specifies the buffer to insert the
1587 text into. If BUFFER is nil, the current buffer is assumed.
1589 (character, count, ignored, buffer))
1591 /* This function can GC */
1592 REGISTER Bufbyte *string;
1595 REGISTER Bytecount n;
1596 REGISTER Bytecount charlen;
1597 Bufbyte str[MAX_EMCHAR_LEN];
1598 struct buffer *b = decode_buffer (buffer, 1);
1601 CHECK_CHAR_COERCE_INT (character);
1610 charlen = set_charptr_emchar (str, XCHAR (character));
1614 slen = min (n, 768);
1615 string = alloca_array (Bufbyte, slen);
1616 /* Write as many copies of the character into the temp string as will fit. */
1617 for (i = 0; i + charlen <= slen; i += charlen)
1618 for (j = 0; j < charlen; j++)
1619 string[i + j] = str[j];
1623 buffer_insert_raw_string (b, string, slen);
1627 #if 0 /* FSFmacs bogosity */
1629 if (!NILP (inherit))
1630 insert_and_inherit (string, n);
1635 buffer_insert_raw_string (b, string, n);
1642 /* Making strings from buffer contents. */
1644 DEFUN ("buffer-substring", Fbuffer_substring, 0, 3, 0, /*
1645 Return the contents of part of BUFFER as a string.
1646 The two arguments START and END are character positions;
1647 they can be in either order. If omitted, they default to the beginning
1648 and end of BUFFER, respectively.
1649 If there are duplicable extents in the region, the string remembers
1650 them in its extent data.
1651 If BUFFER is nil, the current buffer is assumed.
1653 (start, end, buffer))
1655 /* This function can GC */
1657 struct buffer *b = decode_buffer (buffer, 1);
1659 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1660 return make_string_from_buffer (b, begv, zv - begv);
1663 /* It might make more sense to name this
1664 `buffer-substring-no-extents', but this name is FSFmacs-compatible,
1665 and what the function does is probably good enough for what the
1666 user-code will typically want to use it for. */
1667 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties, 0, 3, 0, /*
1668 Return the text from START to END as a string, without copying the extents.
1670 (start, end, buffer))
1672 /* This function can GC */
1674 struct buffer *b = decode_buffer (buffer, 1);
1676 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1677 return make_string_from_buffer_no_extents (b, begv, zv - begv);
1680 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, 1, 3, 0, /*
1681 Insert before point a substring of the contents of buffer BUFFER.
1682 BUFFER may be a buffer or a buffer name.
1683 Arguments START and END are character numbers specifying the substring.
1684 They default to the beginning and the end of BUFFER.
1686 (buffer, start, end))
1688 /* This function can GC */
1692 bp = XBUFFER (get_buffer (buffer, 1));
1693 get_buffer_range_char (bp, start, end, &b, &e, GB_ALLOW_NIL);
1696 buffer_insert_from_buffer (current_buffer, bp, b, e - b);
1701 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, 6, 6, 0, /*
1702 Compare two substrings of two buffers; return result as number.
1703 the value is -N if first string is less after N-1 chars,
1704 +N if first string is greater after N-1 chars, or 0 if strings match.
1705 Each substring is represented as three arguments: BUFFER, START and END.
1706 That makes six args in all, three for each substring.
1708 The value of `case-fold-search' in the current buffer
1709 determines whether case is significant or ignored.
1711 (buffer1, start1, end1, buffer2, start2, end2))
1713 Bufpos begp1, endp1, begp2, endp2;
1714 REGISTER Charcount len1, len2, length, i;
1715 struct buffer *bp1, *bp2;
1716 Lisp_Object trt = ((!NILP (current_buffer->case_fold_search)) ?
1717 XCASE_TABLE_CANON (current_buffer->case_table) : Qnil);
1719 /* Find the first buffer and its substring. */
1721 bp1 = decode_buffer (buffer1, 1);
1722 get_buffer_range_char (bp1, start1, end1, &begp1, &endp1, GB_ALLOW_NIL);
1724 /* Likewise for second substring. */
1726 bp2 = decode_buffer (buffer2, 1);
1727 get_buffer_range_char (bp2, start2, end2, &begp2, &endp2, GB_ALLOW_NIL);
1729 len1 = endp1 - begp1;
1730 len2 = endp2 - begp2;
1735 for (i = 0; i < length; i++)
1737 Emchar c1 = BUF_FETCH_CHAR (bp1, begp1 + i);
1738 Emchar c2 = BUF_FETCH_CHAR (bp2, begp2 + i);
1741 c1 = TRT_TABLE_OF (trt, c1);
1742 c2 = TRT_TABLE_OF (trt, c2);
1745 return make_int (- 1 - i);
1747 return make_int (i + 1);
1750 /* The strings match as far as they go.
1751 If one is shorter, that one is less. */
1753 return make_int (length + 1);
1754 else if (length < len2)
1755 return make_int (- length - 1);
1757 /* Same length too => they are equal. */
1763 subst_char_in_region_unwind (Lisp_Object arg)
1765 XBUFFER (XCAR (arg))->undo_list = XCDR (arg);
1770 subst_char_in_region_unwind_1 (Lisp_Object arg)
1772 XBUFFER (XCAR (arg))->filename = XCDR (arg);
1776 DEFUN ("subst-char-in-region", Fsubst_char_in_region, 4, 5, 0, /*
1777 From START to END, replace FROMCHAR with TOCHAR each time it occurs.
1778 If optional arg NOUNDO is non-nil, don't record this change for undo
1779 and don't mark the buffer as really changed.
1781 (start, end, fromchar, tochar, noundo))
1783 /* This function can GC */
1787 struct buffer *buf = current_buffer;
1788 int count = specpdl_depth ();
1790 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1791 CHECK_CHAR_COERCE_INT (fromchar);
1792 CHECK_CHAR_COERCE_INT (tochar);
1794 fromc = XCHAR (fromchar);
1795 toc = XCHAR (tochar);
1797 /* If we don't want undo, turn off putting stuff on the list.
1798 That's faster than getting rid of things,
1799 and it prevents even the entry for a first change.
1800 Also inhibit locking the file. */
1803 record_unwind_protect (subst_char_in_region_unwind,
1804 Fcons (Fcurrent_buffer (), buf->undo_list));
1805 buf->undo_list = Qt;
1806 /* Don't do file-locking. */
1807 record_unwind_protect (subst_char_in_region_unwind_1,
1808 Fcons (Fcurrent_buffer (), buf->filename));
1809 buf->filename = Qnil;
1812 mc_count = begin_multiple_change (buf, pos, stop);
1815 if (BUF_FETCH_CHAR (buf, pos) == fromc)
1817 /* There used to be some code here that set the buffer to
1818 unmodified if NOUNDO was specified and there was only
1819 one change to the buffer since it was last saved.
1820 This is a crock of shit, so I'm not duplicating this
1821 behavior. I think this was left over from when
1822 prepare_to_modify_buffer() actually bumped MODIFF,
1823 so that code was supposed to undo this change. --ben */
1824 buffer_replace_char (buf, pos, toc, !NILP (noundo), 0);
1826 /* If noundo is not nil then we don't mark the buffer as
1827 modified. In reality that needs to happen externally
1828 only. Internally redisplay needs to know that the actual
1829 contents it should be displaying have changed. */
1831 Fset_buffer_modified_p (Fbuffer_modified_p (Qnil), Qnil);
1835 end_multiple_change (buf, mc_count);
1837 unbind_to (count, Qnil);
1841 /* #### Shouldn't this also accept a BUFFER argument, in the good old
1842 XEmacs tradition? */
1843 DEFUN ("translate-region", Ftranslate_region, 3, 3, 0, /*
1844 Translate characters from START to END according to TABLE.
1846 If TABLE is a string, the Nth character in it is the mapping for the
1847 character with code N.
1849 If TABLE is a vector, its Nth element is the mapping for character
1850 with code N. The values of elements may be characters, strings, or
1851 nil (nil meaning don't replace.)
1853 If TABLE is a char-table, its elements describe the mapping between
1854 characters and their replacements. The char-table should be of type
1855 `char' or `generic'.
1857 Returns the number of substitutions performed.
1859 (start, end, table))
1861 /* This function can GC */
1862 Bufpos pos, stop; /* Limits of the region. */
1863 int cnt = 0; /* Number of changes made. */
1865 struct buffer *buf = current_buffer;
1868 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1869 mc_count = begin_multiple_change (buf, pos, stop);
1870 if (STRINGP (table))
1872 Lisp_String *stable = XSTRING (table);
1873 Charcount size = string_char_length (stable);
1875 /* Under Mule, string_char(n) is O(n), so for large tables or
1876 large regions it makes sense to create an array of Emchars. */
1877 if (size * (stop - pos) > 65536)
1879 Emchar *etable = alloca_array (Emchar, size);
1880 convert_bufbyte_string_into_emchar_string
1881 (string_data (stable), string_length (stable), etable);
1882 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1886 Emchar nc = etable[oc];
1889 buffer_replace_char (buf, pos, nc, 0, 0);
1898 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1902 Emchar nc = string_char (stable, oc);
1905 buffer_replace_char (buf, pos, nc, 0, 0);
1912 else if (VECTORP (table))
1914 Charcount size = XVECTOR_LENGTH (table);
1915 Lisp_Object *vtable = XVECTOR_DATA (table);
1917 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1921 Lisp_Object replacement = vtable[oc];
1923 if (CHAR_OR_CHAR_INTP (replacement))
1925 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1928 buffer_replace_char (buf, pos, nc, 0, 0);
1932 else if (STRINGP (replacement))
1934 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1935 buffer_delete_range (buf, pos, pos + 1, 0);
1936 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1937 pos += incr, stop += incr;
1940 else if (!NILP (replacement))
1942 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1948 else if (CHAR_TABLEP (table)
1949 && (XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC
1950 || XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR))
1952 Lisp_Char_Table *ctable = XCHAR_TABLE (table);
1954 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1956 Lisp_Object replacement = get_char_table (oc, ctable);
1958 if (CHAR_OR_CHAR_INTP (replacement))
1960 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1963 buffer_replace_char (buf, pos, nc, 0, 0);
1967 else if (STRINGP (replacement))
1969 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1970 buffer_delete_range (buf, pos, pos + 1, 0);
1971 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1972 pos += incr, stop += incr;
1975 else if (!NILP (replacement))
1977 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1983 dead_wrong_type_argument (Qstringp, table);
1984 end_multiple_change (buf, mc_count);
1986 return make_int (cnt);
1989 DEFUN ("delete-region", Fdelete_region, 2, 3, "r", /*
1990 Delete the text between point and mark.
1991 When called from a program, expects two arguments START and END
1992 \(integers or markers) specifying the stretch to be deleted.
1993 If optional third arg BUFFER is nil, the current buffer is assumed.
1995 (start, end, buffer))
1997 /* This function can GC */
1998 Bufpos bp_start, bp_end;
1999 struct buffer *buf = decode_buffer (buffer, 1);
2001 get_buffer_range_char (buf, start, end, &bp_start, &bp_end, 0);
2002 buffer_delete_range (buf, bp_start, bp_end, 0);
2007 widen_buffer (struct buffer *b, int no_clip)
2009 if (BUF_BEGV (b) != BUF_BEG (b))
2012 SET_BOTH_BUF_BEGV (b, BUF_BEG (b), BI_BUF_BEG (b));
2014 if (BUF_ZV (b) != BUF_Z (b))
2017 SET_BOTH_BUF_ZV (b, BUF_Z (b), BI_BUF_Z (b));
2023 /* Changing the buffer bounds invalidates any recorded current
2025 invalidate_current_column ();
2026 narrow_line_number_cache (b);
2030 DEFUN ("widen", Fwiden, 0, 1, "", /*
2031 Remove restrictions (narrowing) from BUFFER.
2032 This allows the buffer's full text to be seen and edited.
2033 If BUFFER is nil, the current buffer is assumed.
2037 struct buffer *b = decode_buffer (buffer, 1);
2038 widen_buffer (b, 0);
2042 DEFUN ("narrow-to-region", Fnarrow_to_region, 2, 3, "r", /*
2043 Restrict editing in BUFFER to the current region.
2044 The rest of the text becomes temporarily invisible and untouchable
2045 but is not deleted; if you save the buffer in a file, the invisible
2046 text is included in the file. \\[widen] makes all visible again.
2047 If BUFFER is nil, the current buffer is assumed.
2048 See also `save-restriction'.
2050 When calling from a program, pass two arguments; positions (integers
2051 or markers) bounding the text that should remain visible.
2053 (start, end, buffer))
2055 Bufpos bp_start, bp_end;
2056 struct buffer *buf = decode_buffer (buffer, 1);
2057 Bytind bi_start, bi_end;
2059 get_buffer_range_char (buf, start, end, &bp_start, &bp_end,
2060 GB_ALLOW_PAST_ACCESSIBLE);
2061 bi_start = bufpos_to_bytind (buf, bp_start);
2062 bi_end = bufpos_to_bytind (buf, bp_end);
2064 SET_BOTH_BUF_BEGV (buf, bp_start, bi_start);
2065 SET_BOTH_BUF_ZV (buf, bp_end, bi_end);
2066 if (BUF_PT (buf) < bp_start)
2067 BUF_SET_PT (buf, bp_start);
2068 if (BUF_PT (buf) > bp_end)
2069 BUF_SET_PT (buf, bp_end);
2071 /* Changing the buffer bounds invalidates any recorded current column. */
2072 invalidate_current_column ();
2073 narrow_line_number_cache (buf);
2078 save_restriction_save (void)
2080 Lisp_Object bottom, top;
2081 /* Note: I tried using markers here, but it does not win
2082 because insertion at the end of the saved region
2083 does not advance mh and is considered "outside" the saved region. */
2084 bottom = make_int (BUF_BEGV (current_buffer) - BUF_BEG (current_buffer));
2085 top = make_int (BUF_Z (current_buffer) - BUF_ZV (current_buffer));
2087 return noseeum_cons (Fcurrent_buffer (), noseeum_cons (bottom, top));
2091 save_restriction_restore (Lisp_Object data)
2094 Charcount newhead, newtail;
2096 int local_clip_changed = 0;
2098 buf = XBUFFER (XCAR (data));
2099 if (!BUFFER_LIVE_P (buf))
2101 /* someone could have killed the buffer in the meantime ... */
2102 free_cons (XCONS (XCDR (data)));
2103 free_cons (XCONS (data));
2107 newhead = XINT (XCAR (tem));
2108 newtail = XINT (XCDR (tem));
2110 free_cons (XCONS (XCDR (data)));
2111 free_cons (XCONS (data));
2113 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
2121 Bytind bi_start, bi_end;
2123 start = BUF_BEG (buf) + newhead;
2124 end = BUF_Z (buf) - newtail;
2126 bi_start = bufpos_to_bytind (buf, start);
2127 bi_end = bufpos_to_bytind (buf, end);
2129 if (BUF_BEGV (buf) != start)
2131 local_clip_changed = 1;
2132 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2133 narrow_line_number_cache (buf);
2135 if (BUF_ZV (buf) != end)
2137 local_clip_changed = 1;
2138 SET_BOTH_BUF_ZV (buf, end, bi_end);
2141 if (local_clip_changed)
2144 /* If point is outside the new visible range, move it inside. */
2146 bufpos_clip_to_bounds (BUF_BEGV (buf),
2153 DEFUN ("save-restriction", Fsave_restriction, 0, UNEVALLED, 0, /*
2154 Execute BODY, saving and restoring current buffer's restrictions.
2155 The buffer's restrictions make parts of the beginning and end invisible.
2156 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
2157 This special form, `save-restriction', saves the current buffer's restrictions
2158 when it is entered, and restores them when it is exited.
2159 So any `narrow-to-region' within BODY lasts only until the end of the form.
2160 The old restrictions settings are restored
2161 even in case of abnormal exit (throw or error).
2163 The value returned is the value of the last form in BODY.
2165 `save-restriction' can get confused if, within the BODY, you widen
2166 and then make changes outside the area within the saved restrictions.
2168 Note: if you are using both `save-excursion' and `save-restriction',
2169 use `save-excursion' outermost:
2170 (save-excursion (save-restriction ...))
2174 /* This function can GC */
2175 int speccount = specpdl_depth ();
2177 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2179 return unbind_to (speccount, Fprogn (body));
2183 DEFUN ("format", Fformat, 1, MANY, 0, /*
2184 Format a string out of a control-string and arguments.
2185 The first argument is a control string.
2186 The other arguments are substituted into it to make the result, a string.
2187 It may contain %-sequences meaning to substitute the next argument.
2188 %s means print all objects as-is, using `princ'.
2189 %S means print all objects as s-expressions, using `prin1'.
2190 %d or %i means print as an integer in decimal (%o octal, %x lowercase hex,
2192 %c means print as a single character.
2193 %f means print as a floating-point number in fixed notation (e.g. 785.200).
2194 %e or %E means print as a floating-point number in scientific notation
2196 %g or %G means print as a floating-point number in "pretty format";
2197 depending on the number, either %f or %e/%E format will be used, and
2198 trailing zeroes are removed from the fractional part.
2199 The argument used for all but %s and %S must be a number. It will be
2200 converted to an integer or a floating-point number as necessary.
2202 %$ means reposition to read a specific numbered argument; for example,
2203 %3$s would apply the `%s' to the third argument after the control string,
2204 and the next format directive would use the fourth argument, the
2205 following one the fifth argument, etc. (There must be a positive integer
2206 between the % and the $).
2207 Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be
2208 specified between the optional repositioning spec and the conversion
2209 character; see below.
2210 An optional minimum field width may be specified after any flag characters
2211 and before the conversion character; it specifies the minimum number of
2212 characters that the converted argument will take up. Padding will be
2213 added on the left (or on the right, if the `-' flag is specified), as
2214 necessary. Padding is done with spaces, or with zeroes if the `0' flag
2216 If the field width is specified as `*', the field width is assumed to have
2217 been specified as an argument. Any repositioning specification that
2218 would normally specify the argument to be converted will now specify
2219 where to find this field width argument, not where to find the argument
2220 to be converted. If there is no repositioning specification, the normal
2221 next argument is used. The argument to be converted will be the next
2222 argument after the field width argument unless the precision is also
2223 specified as `*' (see below).
2225 An optional period character and precision may be specified after any
2226 minimum field width. It specifies the minimum number of digits to
2227 appear in %d, %i, %o, %x, and %X conversions (the number is padded
2228 on the left with zeroes as necessary); the number of digits printed
2229 after the decimal point for %f, %e, and %E conversions; the number
2230 of significant digits printed in %g and %G conversions; and the
2231 maximum number of non-padding characters printed in %s and %S
2232 conversions. The default precision for floating-point conversions
2234 If the precision is specified as `*', the precision is assumed to have been
2235 specified as an argument. The argument used will be the next argument
2236 after the field width argument, if any. If the field width was not
2237 specified as an argument, any repositioning specification that would
2238 normally specify the argument to be converted will now specify where to
2239 find the precision argument. If there is no repositioning specification,
2240 the normal next argument is used.
2242 The ` ' and `+' flags mean prefix non-negative numbers with a space or
2243 plus sign, respectively.
2244 The `#' flag means print numbers in an alternate, more verbose format:
2245 octal numbers begin with zero; hex numbers begin with a 0x or 0X;
2246 a decimal point is printed in %f, %e, and %E conversions even if no
2247 numbers are printed after it; and trailing zeroes are not omitted in
2248 %g and %G conversions.
2250 Use %% to put a single % into the output.
2252 (int nargs, Lisp_Object *args))
2254 /* It should not be necessary to GCPRO ARGS, because
2255 the caller in the interpreter should take care of that. */
2257 CHECK_STRING (args[0]);
2258 return emacs_doprnt_string_lisp (0, args[0], 0, nargs - 1, args + 1);
2262 DEFUN ("char-equal", Fchar_equal, 2, 3, 0, /*
2263 Return t if two characters match, optionally ignoring case.
2264 Both arguments must be characters (i.e. NOT integers).
2265 Case is ignored if `case-fold-search' is non-nil in BUFFER.
2266 If BUFFER is nil, the current buffer is assumed.
2268 (character1, character2, buffer))
2271 struct buffer *b = decode_buffer (buffer, 1);
2273 CHECK_CHAR_COERCE_INT (character1);
2274 CHECK_CHAR_COERCE_INT (character2);
2275 x1 = XCHAR (character1);
2276 x2 = XCHAR (character2);
2278 return (!NILP (b->case_fold_search)
2279 ? DOWNCASE (b, x1) == DOWNCASE (b, x2)
2284 DEFUN ("char=", Fchar_Equal, 2, 2, 0, /*
2285 Return t if two characters match, case is significant.
2286 Both arguments must be characters (i.e. NOT integers).
2288 (character1, character2))
2290 CHECK_CHAR_COERCE_INT (character1);
2291 CHECK_CHAR_COERCE_INT (character2);
2293 return EQ (character1, character2) ? Qt : Qnil;
2296 #if 0 /* Undebugged FSFmacs code */
2297 /* Transpose the markers in two regions of the current buffer, and
2298 adjust the ones between them if necessary (i.e.: if the regions
2301 Traverses the entire marker list of the buffer to do so, adding an
2302 appropriate amount to some, subtracting from some, and leaving the
2303 rest untouched. Most of this is copied from adjust_markers in insdel.c.
2305 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
2308 transpose_markers (Bufpos start1, Bufpos end1, Bufpos start2, Bufpos end2)
2310 Charcount amt1, amt2, diff;
2312 struct buffer *buf = current_buffer;
2314 /* Update point as if it were a marker. */
2315 if (BUF_PT (buf) < start1)
2317 else if (BUF_PT (buf) < end1)
2318 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - end1));
2319 else if (BUF_PT (buf) < start2)
2320 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - start2) - (end1 - start1));
2321 else if (BUF_PT (buf) < end2)
2322 BUF_SET_PT (buf, BUF_PT (buf) - (start2 - start1));
2324 /* We used to adjust the endpoints here to account for the gap, but that
2325 isn't good enough. Even if we assume the caller has tried to move the
2326 gap out of our way, it might still be at start1 exactly, for example;
2327 and that places it `inside' the interval, for our purposes. The amount
2328 of adjustment is nontrivial if there's a `denormalized' marker whose
2329 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
2330 the dirty work to Fmarker_position, below. */
2332 /* The difference between the region's lengths */
2333 diff = (end2 - start2) - (end1 - start1);
2335 /* For shifting each marker in a region by the length of the other
2336 * region plus the distance between the regions.
2338 amt1 = (end2 - start2) + (start2 - end1);
2339 amt2 = (end1 - start1) + (start2 - end1);
2341 for (marker = BUF_MARKERS (buf); !NILP (marker);
2342 marker = XMARKER (marker)->chain)
2344 Bufpos mpos = marker_position (marker);
2345 if (mpos >= start1 && mpos < end2)
2349 else if (mpos < start2)
2353 set_marker_position (marker, mpos);
2360 DEFUN ("transpose-regions", Ftranspose_regions, 4, 5, 0, /*
2361 Transpose region START1 to END1 with START2 to END2.
2362 The regions may not be overlapping, because the size of the buffer is
2363 never changed in a transposition.
2365 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't transpose
2366 any markers that happen to be located in the regions. (#### BUG: currently
2367 this function always acts as if LEAVE-MARKERS is non-nil.)
2369 Transposing beyond buffer boundaries is an error.
2371 (start1, end1, start2, end2, leave_markers))
2373 Bufpos startr1, endr1, startr2, endr2;
2374 Charcount len1, len2;
2375 Lisp_Object string1, string2;
2376 struct buffer *buf = current_buffer;
2378 get_buffer_range_char (buf, start1, end1, &startr1, &endr1, 0);
2379 get_buffer_range_char (buf, start2, end2, &startr2, &endr2, 0);
2381 len1 = endr1 - startr1;
2382 len2 = endr2 - startr2;
2384 if (startr2 < endr1)
2385 error ("transposed regions not properly ordered");
2386 else if (startr1 == endr1 || startr2 == endr2)
2387 error ("transposed region may not be of length 0");
2389 string1 = make_string_from_buffer (buf, startr1, len1);
2390 string2 = make_string_from_buffer (buf, startr2, len2);
2391 buffer_delete_range (buf, startr2, endr2, 0);
2392 buffer_insert_lisp_string_1 (buf, startr2, string1, 0);
2393 buffer_delete_range (buf, startr1, endr1, 0);
2394 buffer_insert_lisp_string_1 (buf, startr1, string2, 0);
2396 /* In FSFmacs there is a whole bunch of really ugly code here
2397 to attempt to transpose the regions without using up any
2398 extra memory. Although the intent may be good, the result
2399 was highly bogus. */
2405 /************************************************************************/
2406 /* initialization */
2407 /************************************************************************/
2410 syms_of_editfns (void)
2412 defsymbol (&Qpoint, "point");
2413 defsymbol (&Qmark, "mark");
2414 defsymbol (&Qregion_beginning, "region-beginning");
2415 defsymbol (&Qregion_end, "region-end");
2416 defsymbol (&Qformat, "format");
2417 defsymbol (&Quser_files_and_directories, "user-files-and-directories");
2419 DEFSUBR (Fchar_equal);
2420 DEFSUBR (Fchar_Equal);
2421 DEFSUBR (Fgoto_char);
2422 DEFSUBR (Fstring_to_char);
2423 DEFSUBR (Fchar_to_string);
2424 DEFSUBR (Fbuffer_substring);
2425 DEFSUBR (Fbuffer_substring_no_properties);
2427 DEFSUBR (Fpoint_marker);
2428 DEFSUBR (Fmark_marker);
2430 DEFSUBR (Fregion_beginning);
2431 DEFSUBR (Fregion_end);
2432 DEFSUBR (Fsave_excursion);
2433 DEFSUBR (Fsave_current_buffer);
2435 DEFSUBR (Fbuffer_size);
2436 DEFSUBR (Fpoint_max);
2437 DEFSUBR (Fpoint_min);
2438 DEFSUBR (Fpoint_min_marker);
2439 DEFSUBR (Fpoint_max_marker);
2445 DEFSUBR (Ffollowing_char);
2446 DEFSUBR (Fpreceding_char);
2447 DEFSUBR (Fchar_after);
2448 DEFSUBR (Fchar_before);
2450 DEFSUBR (Finsert_string);
2451 DEFSUBR (Finsert_before_markers);
2452 DEFSUBR (Finsert_char);
2454 DEFSUBR (Ftemp_directory);
2455 DEFSUBR (Fuser_login_name);
2456 DEFSUBR (Fuser_real_login_name);
2457 DEFSUBR (Fuser_uid);
2458 DEFSUBR (Fuser_real_uid);
2459 DEFSUBR (Fuser_full_name);
2460 DEFSUBR (Fuser_home_directory);
2461 DEFSUBR (Femacs_pid);
2462 DEFSUBR (Fcurrent_time);
2463 DEFSUBR (Fcurrent_process_time);
2464 DEFSUBR (Fformat_time_string);
2465 DEFSUBR (Fdecode_time);
2466 DEFSUBR (Fencode_time);
2467 DEFSUBR (Fcurrent_time_string);
2468 DEFSUBR (Fcurrent_time_zone);
2469 DEFSUBR (Fset_time_zone_rule);
2470 DEFSUBR (Fsystem_name);
2473 DEFSUBR (Finsert_buffer_substring);
2474 DEFSUBR (Fcompare_buffer_substrings);
2475 DEFSUBR (Fsubst_char_in_region);
2476 DEFSUBR (Ftranslate_region);
2477 DEFSUBR (Fdelete_region);
2479 DEFSUBR (Fnarrow_to_region);
2480 DEFSUBR (Fsave_restriction);
2481 DEFSUBR (Ftranspose_regions);
2483 defsymbol (&Qzmacs_update_region, "zmacs-update-region");
2484 defsymbol (&Qzmacs_deactivate_region, "zmacs-deactivate-region");
2485 defsymbol (&Qzmacs_region_buffer, "zmacs-region-buffer");
2489 vars_of_editfns (void)
2491 staticpro (&Vsystem_name);
2493 staticpro (&Vuser_name);
2494 staticpro (&Vuser_real_name);
2496 DEFVAR_BOOL ("zmacs-regions", &zmacs_regions /*
2497 *Whether LISPM-style active regions should be used.
2498 This means that commands which operate on the region (the area between the
2499 point and the mark) will only work while the region is in the ``active''
2500 state, which is indicated by highlighting. Executing most commands causes
2501 the region to not be in the active state, so (for example) \\[kill-region] will only
2502 work immediately after activating the region.
2506 - Commands which operate on the region only work if the region is active.
2507 - Only a very small set of commands cause the region to become active:
2508 Those commands whose semantics are to mark an area, like `mark-defun'.
2509 - The region is deactivated after each command that is executed, except that:
2510 - "Motion" commands do not change whether the region is active or not.
2512 set-mark-command (C-SPC) pushes a mark and activates the region. Moving the
2513 cursor with normal motion commands (C-n, C-p, etc) will cause the region
2514 between point and the recently-pushed mark to be highlighted. It will
2515 remain highlighted until some non-motion command is executed.
2517 exchange-point-and-mark (\\[exchange-point-and-mark]) activates the region. So if you mark a
2518 region and execute a command that operates on it, you can reactivate the
2519 same region with \\[exchange-point-and-mark] (or perhaps \\[exchange-point-and-mark] \\[exchange-point-and-mark]) to operate on it
2522 Generally, commands which push marks as a means of navigation (like
2523 beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
2524 region. But commands which push marks as a means of marking an area of
2525 text (like mark-defun (\\[mark-defun]), mark-word (\\[mark-word]) or mark-whole-buffer (\\[mark-whole-buffer]))
2526 do activate the region.
2528 The way the command loop actually works with regard to deactivating the
2529 region is as follows:
2531 - If the variable `zmacs-region-stays' has been set to t during the command
2532 just executed, the region is left alone (this is how the motion commands
2533 make the region stay around; see the `_' flag in the `interactive'
2534 specification). `zmacs-region-stays' is reset to nil before each command
2536 - If the function `zmacs-activate-region' has been called during the command
2537 just executed, the region is left alone. Very few functions should
2538 actually call this function.
2539 - Otherwise, if the region is active, the region is deactivated and
2540 the `zmacs-deactivate-region-hook' is called.
2542 /* Zmacs style active regions are now ON by default */
2545 DEFVAR_BOOL ("zmacs-region-active-p", &zmacs_region_active_p /*
2546 Do not alter this. It is for internal use only.
2548 zmacs_region_active_p = 0;
2550 DEFVAR_BOOL ("zmacs-region-stays", &zmacs_region_stays /*
2551 Whether the current command will deactivate the region.
2552 Commands which do not wish to affect whether the region is currently
2553 highlighted should set this to t. Normally, the region is turned off after
2554 executing each command that did not explicitly turn it on with the function
2555 zmacs-activate-region. Setting this to true lets a command be non-intrusive.
2556 See the variable `zmacs-regions'.
2558 The same effect can be achieved using the `_' interactive specification.
2560 `zmacs-region-stays' is reset to nil before each command is executed.
2562 zmacs_region_stays = 0;
2564 DEFVAR_BOOL ("atomic-extent-goto-char-p", &atomic_extent_goto_char_p /*
2565 Do not use this -- it will be going away soon.
2566 Indicates if `goto-char' has just been run. This information is allegedly
2567 needed to get the desired behavior for atomic extents and unfortunately
2568 is not available by any other means.
2570 atomic_extent_goto_char_p = 0;
2571 #ifdef AMPERSAND_FULL_NAME
2572 Fprovide(intern("ampersand-full-name"));
2575 DEFVAR_LISP ("user-full-name", &Vuser_full_name /*
2576 *The name of the user.
2577 The function `user-full-name', which will return the value of this
2578 variable, when called without arguments.
2579 This is initialized to the value of the NAME environment variable.
2581 /* Initialized at run-time. */
2582 Vuser_full_name = Qnil;