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 == (uid_t) myuid &&
647 strcpy(path, getenv("HOME")); strncat(path, "/tmp/", _POSIX_PATH_MAX);
648 if (stat(path, &st) < 0 && errno == ENOENT)
651 char warnpath[1+_POSIX_PATH_MAX];
652 mkdir(path, 0700); /* ignore retvals */
653 strcpy(warnpath, path);
654 strncat(warnpath, ".created_by_xemacs", _POSIX_PATH_MAX);
655 if ((fd = open(warnpath, O_WRONLY|O_CREAT, 0644)) > 0)
657 write(fd, "XEmacs created this directory because /tmp/<yourname> was unavailable -- \nPlease check !\n", 89);
661 if (stat(path, &st) == 0 && S_ISDIR(st.st_mode))
673 return build_ext_string (tmpdir, Qfile_name);
676 DEFUN ("user-login-name", Fuser_login_name, 0, 1, 0, /*
677 Return the name under which the user logged in, as a string.
678 This is based on the effective uid, not the real uid.
679 Also, if the environment variable LOGNAME or USER is set,
680 that determines the value of this function.
681 If the optional argument UID is present, then environment variables are
682 ignored and this function returns the login name for that UID, or nil.
692 local_uid = XINT (uid);
693 returned_name = user_login_name (&local_uid);
697 returned_name = user_login_name (NULL);
699 /* #### - I believe this should return nil instead of "unknown" when pw==0
700 pw=0 is indicated by a null return from user_login_name
702 return returned_name ? build_string (returned_name) : Qnil;
705 /* This function may be called from other C routines when a
706 character string representation of the user_login_name is
707 needed but a Lisp Object is not. The UID is passed by
708 reference. If UID == NULL, then the USER name
709 for the user running XEmacs will be returned. This
710 corresponds to a nil argument to Fuser_login_name.
713 user_login_name (uid_t *uid)
715 /* uid == NULL to return name of this user */
718 struct passwd *pw = getpwuid (*uid);
719 return pw ? pw->pw_name : NULL;
723 /* #### - when euid != uid, then LOGNAME and USER are leftovers from the
724 old environment (I site observed behavior on sunos and linux), so the
725 environment variables should be disregarded in that case. --Stig */
726 char *user_name = getenv ("LOGNAME");
730 "USERNAME" /* it's USERNAME on NT */
739 struct passwd *pw = getpwuid (geteuid ());
741 /* Since the Cygwin environment may not have an /etc/passwd,
742 return "unknown" instead of the null if the username
743 cannot be determined.
745 return pw ? pw->pw_name : "unknown";
747 /* For all but Cygwin return NULL (nil) */
748 return pw ? pw->pw_name : NULL;
754 DEFUN ("user-real-login-name", Fuser_real_login_name, 0, 0, 0, /*
755 Return the name of the user's real uid, as a string.
756 This ignores the environment variables LOGNAME and USER, so it differs from
757 `user-login-name' when running under `su'.
761 struct passwd *pw = getpwuid (getuid ());
762 /* #### - I believe this should return nil instead of "unknown" when pw==0 */
764 Lisp_Object tem = build_string (pw ? pw->pw_name : "unknown");/* no gettext */
768 DEFUN ("user-uid", Fuser_uid, 0, 0, 0, /*
769 Return the effective uid of Emacs, as an integer.
773 return make_int (geteuid ());
776 DEFUN ("user-real-uid", Fuser_real_uid, 0, 0, 0, /*
777 Return the real uid of Emacs, as an integer.
781 return make_int (getuid ());
784 DEFUN ("user-full-name", Fuser_full_name, 0, 1, 0, /*
785 Return the full name of the user logged in, as a string.
786 If the optional argument USER is given, then the full name for that
787 user is returned, or nil. USER may be either a login name or a uid.
789 If USER is nil, and `user-full-name' contains a string, the
790 value of `user-full-name' is returned.
794 Lisp_Object user_name;
795 struct passwd *pw = NULL;
799 if (NILP (user) && STRINGP (Vuser_full_name))
800 return Vuser_full_name;
802 user_name = (STRINGP (user) ? user : Fuser_login_name (user));
803 if (!NILP (user_name)) /* nil when nonexistent UID passed as arg */
805 const char *user_name_ext;
807 /* Fuck me. getpwnam() can call select() and (under IRIX at least)
808 things get wedged if a SIGIO arrives during this time. */
809 TO_EXTERNAL_FORMAT (LISP_STRING, user_name,
810 C_STRING_ALLOCA, user_name_ext,
812 slow_down_interrupts ();
813 pw = (struct passwd *) getpwnam (user_name_ext);
814 speed_up_interrupts ();
817 /* #### - Stig sez: this should return nil instead of "unknown" when pw==0 */
818 /* Ben sez: bad idea because it's likely to break something */
819 #ifndef AMPERSAND_FULL_NAME
820 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
823 p = pw ? USER_FULL_NAME : "unknown"; /* don't gettext */
826 tem = ((!NILP (user) && !pw)
828 : make_ext_string ((Extbyte *) p, (q ? q - p : (int) strlen (p)),
831 #ifdef AMPERSAND_FULL_NAME
834 p = (char *) XSTRING_DATA (tem);
836 /* Substitute the login name for the &, upcasing the first character. */
839 char *r = (char *) alloca (strlen (p) + XSTRING_LENGTH (user_name) + 1);
840 memcpy (r, p, q - p);
842 strcat (r, (char *) XSTRING_DATA (user_name));
843 /* #### current_buffer dependency! */
844 r[q - p] = UPCASE (current_buffer, r[q - p]);
846 tem = build_string (r);
849 #endif /* AMPERSAND_FULL_NAME */
854 static Extbyte *cached_home_directory;
857 uncache_home_directory (void)
859 cached_home_directory = NULL; /* in some cases, this may cause the leaking
863 /* !!#### not Mule correct. */
865 /* Returns the home directory, in external format */
867 get_home_directory (void)
869 /* !!#### this is hopelessly bogus. Rule #1: Do not make any assumptions
870 about what format an external string is in. Could be Unicode, for all
871 we know, and then all the operations below are totally bogus.
872 Instead, convert all data to internal format *right* at the juncture
873 between XEmacs and the outside world, the very moment we first get
875 int output_home_warning = 0;
877 if (cached_home_directory == NULL)
879 if ((cached_home_directory = (Extbyte *) getenv("HOME")) == NULL)
881 #if defined(WIN32_NATIVE)
882 char *homedrive, *homepath;
884 if ((homedrive = getenv("HOMEDRIVE")) != NULL &&
885 (homepath = getenv("HOMEPATH")) != NULL)
887 cached_home_directory =
888 (Extbyte *) xmalloc (strlen (homedrive) +
889 strlen (homepath) + 1);
890 sprintf((char *) cached_home_directory, "%s%s",
896 # if 0 /* changed by ben. This behavior absolutely stinks, and the
897 possibility being addressed here occurs quite commonly.
898 Using the current directory makes absolutely no sense. */
900 * Use the current directory.
901 * This preserves the existing XEmacs behavior, but is different
904 if (initial_directory[0] != '\0')
906 cached_home_directory = (Extbyte*) initial_directory;
910 /* This will probably give the wrong value */
911 cached_home_directory = (Extbyte*) getcwd (NULL, 0);
915 * This is NT Emacs behavior
917 cached_home_directory = (Extbyte *) "C:\\";
918 output_home_warning = 1;
921 #else /* !WIN32_NATIVE */
924 * Using "/" isn't quite right, but what should we do?
925 * We probably should try to extract pw_dir from /etc/passwd,
926 * before falling back to this.
928 cached_home_directory = (Extbyte *) "/";
929 output_home_warning = 1;
930 #endif /* !WIN32_NATIVE */
932 if (initialized && output_home_warning)
934 warn_when_safe (Quser_files_and_directories, Qwarning, "\n"
935 " XEmacs was unable to determine a good value for the user's $HOME\n"
936 " directory, and will be using the value:\n"
938 " This is probably incorrect.",
939 cached_home_directory
943 return cached_home_directory;
946 DEFUN ("user-home-directory", Fuser_home_directory, 0, 0, 0, /*
947 Return the user's home directory, as a string.
951 Extbyte *path = get_home_directory ();
953 return path == NULL ? Qnil :
954 Fexpand_file_name (Fsubstitute_in_file_name
955 (build_ext_string ((char *) path, Qfile_name)),
959 DEFUN ("system-name", Fsystem_name, 0, 0, 0, /*
960 Return the name of the machine you are running on, as a string.
964 return Fcopy_sequence (Vsystem_name);
967 DEFUN ("emacs-pid", Femacs_pid, 0, 0, 0, /*
968 Return the process ID of Emacs, as an integer.
972 return make_int (getpid ());
975 DEFUN ("current-time", Fcurrent_time, 0, 0, 0, /*
976 Return the current time, as the number of seconds since 1970-01-01 00:00:00.
977 The time is returned as a list of three integers. The first has the
978 most significant 16 bits of the seconds, while the second has the
979 least significant 16 bits. The third integer gives the microsecond
982 The microsecond count is zero on systems that do not provide
983 resolution finer than a second.
990 return list3 (make_int ((EMACS_SECS (t) >> 16) & 0xffff),
991 make_int ((EMACS_SECS (t) >> 0) & 0xffff),
992 make_int (EMACS_USECS (t)));
995 DEFUN ("current-process-time", Fcurrent_process_time, 0, 0, 0, /*
996 Return the amount of time used by this XEmacs process so far.
997 The return value is a list of three floating-point numbers, expressing
998 the user, system, and real times used by the process. The user time
999 measures the time actually spent by the CPU executing the code in this
1000 process. The system time measures time spent by the CPU executing kernel
1001 code on behalf of this process (e.g. I/O requests made by the process).
1003 Note that the user and system times measure processor time, as opposed
1004 to real time, and only accrue when the processor is actually doing
1005 something: Time spent in an idle wait (waiting for user events to come
1006 in or for I/O on a disk drive or other device to complete) does not
1007 count. Thus, the user and system times will often be considerably
1008 less than the real time.
1010 Some systems do not allow the user and system times to be distinguished.
1011 In this case, the user time will be the total processor time used by
1012 the process, and the system time will be 0.
1014 Some systems do not allow the real and processor times to be distinguished.
1015 In this case, the user and real times will be the same and the system
1020 double user, sys, real;
1022 get_process_times (&user, &sys, &real);
1023 return list3 (make_float (user), make_float (sys), make_float (real));
1027 int lisp_to_time (Lisp_Object specified_time, time_t *result);
1029 lisp_to_time (Lisp_Object specified_time, time_t *result)
1031 Lisp_Object high, low;
1033 if (NILP (specified_time))
1034 return time (result) != -1;
1036 CHECK_CONS (specified_time);
1037 high = XCAR (specified_time);
1038 low = XCDR (specified_time);
1043 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
1044 return *result >> 16 == XINT (high);
1047 Lisp_Object time_to_lisp (time_t the_time);
1049 time_to_lisp (time_t the_time)
1051 unsigned int item = (unsigned int) the_time;
1052 return Fcons (make_int (item >> 16), make_int (item & 0xffff));
1055 size_t emacs_strftime (char *string, size_t max, const char *format,
1056 const struct tm *tm);
1057 static long difftm (const struct tm *a, const struct tm *b);
1060 DEFUN ("format-time-string", Fformat_time_string, 1, 2, 0, /*
1061 Use FORMAT-STRING to format the time TIME.
1062 TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from
1063 `current-time' and `file-attributes'. If TIME is not specified it
1064 defaults to the current time.
1065 FORMAT-STRING may contain %-sequences to substitute parts of the time.
1066 %a is replaced by the abbreviated name of the day of week.
1067 %A is replaced by the full name of the day of week.
1068 %b is replaced by the abbreviated name of the month.
1069 %B is replaced by the full name of the month.
1070 %c is a synonym for "%x %X".
1071 %C is a locale-specific synonym, which defaults to "%A, %B %e, %Y" in the C locale.
1072 %d is replaced by the day of month, zero-padded.
1073 %D is a synonym for "%m/%d/%y".
1074 %e is replaced by the day of month, blank-padded.
1075 %h is a synonym for "%b".
1076 %H is replaced by the hour (00-23).
1077 %I is replaced by the hour (00-12).
1078 %j is replaced by the day of the year (001-366).
1079 %k is replaced by the hour (0-23), blank padded.
1080 %l is replaced by the hour (1-12), blank padded.
1081 %m is replaced by the month (01-12).
1082 %M is replaced by the minute (00-59).
1083 %n is a synonym for "\\n".
1084 %p is replaced by AM or PM, as appropriate.
1085 %r is a synonym for "%I:%M:%S %p".
1086 %R is a synonym for "%H:%M".
1087 %s is replaced by the time in seconds since 00:00:00, Jan 1, 1970 (a
1088 nonstandard extension)
1089 %S is replaced by the second (00-60).
1090 %t is a synonym for "\\t".
1091 %T is a synonym for "%H:%M:%S".
1092 %U is replaced by the week of the year (00-53), first day of week is Sunday.
1093 %w is replaced by the day of week (0-6), Sunday is day 0.
1094 %W is replaced by the week of the year (00-53), first day of week is Monday.
1095 %x is a locale-specific synonym, which defaults to "%D" in the C locale.
1096 %X is a locale-specific synonym, which defaults to "%T" in the C locale.
1097 %y is replaced by the year without century (00-99).
1098 %Y is replaced by the year with century.
1099 %Z is replaced by the time zone abbreviation.
1101 The number of options reflects the `strftime' function.
1103 BUG: If the charset used by the current locale is not ISO 8859-1, the
1104 characters appearing in the day and month names may be incorrect.
1106 (format_string, time_))
1111 CHECK_STRING (format_string);
1113 if (! lisp_to_time (time_, &value))
1114 error ("Invalid time specification");
1116 /* This is probably enough. */
1117 size = XSTRING_LENGTH (format_string) * 6 + 50;
1121 char *buf = (char *) alloca (size);
1123 if (emacs_strftime (buf, size,
1124 (const char *) XSTRING_DATA (format_string),
1127 return build_ext_string (buf, Qbinary);
1128 /* If buffer was too small, make it bigger. */
1133 DEFUN ("decode-time", Fdecode_time, 0, 1, 0, /*
1134 Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).
1135 The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)
1136 or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'
1137 to use the current time. The list has the following nine members:
1138 SEC is an integer between 0 and 60; SEC is 60 for a leap second, which
1139 only some operating systems support. MINUTE is an integer between 0 and 59.
1140 HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.
1141 MONTH is an integer between 1 and 12. YEAR is an integer indicating the
1142 four-digit year. DOW is the day of week, an integer between 0 and 6, where
1143 0 is Sunday. DST is t if daylight savings time is effect, otherwise nil.
1144 ZONE is an integer indicating the number of seconds east of Greenwich.
1145 \(Note that Common Lisp has different meanings for DOW and ZONE.)
1151 struct tm *decoded_time;
1152 Lisp_Object list_args[9];
1154 if (! lisp_to_time (specified_time, &time_spec))
1155 error ("Invalid time specification");
1157 decoded_time = localtime (&time_spec);
1158 list_args[0] = make_int (decoded_time->tm_sec);
1159 list_args[1] = make_int (decoded_time->tm_min);
1160 list_args[2] = make_int (decoded_time->tm_hour);
1161 list_args[3] = make_int (decoded_time->tm_mday);
1162 list_args[4] = make_int (decoded_time->tm_mon + 1);
1163 list_args[5] = make_int (decoded_time->tm_year + 1900);
1164 list_args[6] = make_int (decoded_time->tm_wday);
1165 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1167 /* Make a copy, in case gmtime modifies the struct. */
1168 save_tm = *decoded_time;
1169 decoded_time = gmtime (&time_spec);
1170 if (decoded_time == 0)
1171 list_args[8] = Qnil;
1173 list_args[8] = make_int (difftm (&save_tm, decoded_time));
1174 return Flist (9, list_args);
1177 static void set_time_zone_rule (char *tzstring);
1179 /* from GNU Emacs 21, per Simon Josefsson, modified by stephen
1180 The slight inefficiency is justified since negative times are weird. */
1182 make_time (time_t time)
1184 return list2 (make_int (time < 0 ? time / 0x10000 : time >> 16),
1185 make_int (time & 0xFFFF));
1188 DEFUN ("encode-time", Fencode_time, 6, MANY, 0, /*
1189 Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.
1190 This is the reverse operation of `decode-time', which see.
1191 ZONE defaults to the current time zone rule. This can
1192 be a string (as from `set-time-zone-rule'), or it can be a list
1193 \(as from `current-time-zone') or an integer (as from `decode-time')
1194 applied without consideration for daylight savings time.
1196 You can pass more than 7 arguments; then the first six arguments
1197 are used as SECOND through YEAR, and the *last* argument is used as ZONE.
1198 The intervening arguments are ignored.
1199 This feature lets (apply 'encode-time (decode-time ...)) work.
1201 Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;
1202 for example, a DAY of 0 means the day preceding the given month.
1203 Year numbers less than 100 are treated just like other year numbers.
1204 If you want them to stand for years in this century, you must do that yourself.
1206 (int nargs, Lisp_Object *args))
1210 Lisp_Object zone = (nargs > 6) ? args[nargs - 1] : Qnil;
1212 CHECK_INT (*args); tm.tm_sec = XINT (*args++); /* second */
1213 CHECK_INT (*args); tm.tm_min = XINT (*args++); /* minute */
1214 CHECK_INT (*args); tm.tm_hour = XINT (*args++); /* hour */
1215 CHECK_INT (*args); tm.tm_mday = XINT (*args++); /* day */
1216 CHECK_INT (*args); tm.tm_mon = XINT (*args++) - 1; /* month */
1217 CHECK_INT (*args); tm.tm_year = XINT (*args++) - 1900;/* year */
1224 the_time = mktime (&tm);
1229 char **oldenv = environ, **newenv;
1232 tzstring = (char *) XSTRING_DATA (zone);
1233 else if (INTP (zone))
1235 int abszone = abs (XINT (zone));
1236 sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
1237 abszone / (60*60), (abszone/60) % 60, abszone % 60);
1241 error ("Invalid time zone specification");
1243 /* Set TZ before calling mktime; merely adjusting mktime's returned
1244 value doesn't suffice, since that would mishandle leap seconds. */
1245 set_time_zone_rule (tzstring);
1247 the_time = mktime (&tm);
1249 /* Restore TZ to previous value. */
1253 #ifdef LOCALTIME_CACHE
1258 if (the_time == (time_t) -1)
1259 error ("Specified time is not representable");
1261 return make_time (the_time);
1264 DEFUN ("current-time-string", Fcurrent_time_string, 0, 1, 0, /*
1265 Return the current time, as a human-readable string.
1266 Programs can use this function to decode a time,
1267 since the number of columns in each field is fixed.
1268 The format is `Sun Sep 16 01:03:52 1973'.
1269 If an argument is given, it specifies a time to format
1270 instead of the current time. The argument should have the form:
1273 (HIGH LOW . IGNORED).
1274 Thus, you can use times obtained from `current-time'
1275 and from `file-attributes'.
1283 if (! lisp_to_time (specified_time, &value))
1285 the_ctime = ctime (&value);
1287 /* ctime is documented as always returning a "\n\0"-terminated
1288 26-byte American time string, but let's be careful anyways. */
1289 for (len = 0; the_ctime[len] != '\n' && the_ctime[len] != '\0'; len++)
1292 return make_ext_string ((Extbyte *) the_ctime, len, Qbinary);
1295 #define TM_YEAR_ORIGIN 1900
1297 /* Yield A - B, measured in seconds. */
1299 difftm (const struct tm *a, const struct tm *b)
1301 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
1302 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
1303 /* Some compilers can't handle this as a single return statement. */
1305 /* difference in day of year */
1306 a->tm_yday - b->tm_yday
1307 /* + intervening leap days */
1308 + ((ay >> 2) - (by >> 2))
1310 + ((ay/100 >> 2) - (by/100 >> 2))
1311 /* + difference in years * 365 */
1312 + (long)(ay-by) * 365
1314 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
1315 + (a->tm_min - b->tm_min))
1316 + (a->tm_sec - b->tm_sec));
1319 DEFUN ("current-time-zone", Fcurrent_time_zone, 0, 1, 0, /*
1320 Return the offset and name for the local time zone.
1321 This returns a list of the form (OFFSET NAME).
1322 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).
1323 A negative value means west of Greenwich.
1324 NAME is a string giving the name of the time zone.
1325 If an argument is given, it specifies when the time zone offset is determined
1326 instead of using the current time. The argument should have the form:
1329 (HIGH LOW . IGNORED).
1330 Thus, you can use times obtained from `current-time'
1331 and from `file-attributes'.
1333 Some operating systems cannot provide all this information to Emacs;
1334 in this case, `current-time-zone' returns a list containing nil for
1335 the data it can't find.
1340 struct tm *t = NULL;
1342 if (lisp_to_time (specified_time, &value)
1343 && (t = gmtime (&value)) != 0)
1345 struct tm gmt = *t; /* Make a copy, in case localtime modifies *t. */
1349 t = localtime (&value);
1350 offset = difftm (t, &gmt);
1354 s = (char *)t->tm_zone;
1355 #else /* not HAVE_TM_ZONE */
1357 if (t->tm_isdst == 0 || t->tm_isdst == 1)
1358 s = tzname[t->tm_isdst];
1360 #endif /* not HAVE_TM_ZONE */
1363 /* No local time zone name is available; use "+-NNNN" instead. */
1364 int am = (offset < 0 ? -offset : offset) / 60;
1365 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
1368 return list2 (make_int (offset), build_string (s));
1371 return list2 (Qnil, Qnil);
1374 #ifdef LOCALTIME_CACHE
1376 /* These two values are known to load tz files in buggy implementations,
1377 i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1378 Their values shouldn't matter in non-buggy implementations.
1379 We don't use string literals for these strings,
1380 since if a string in the environment is in readonly
1381 storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
1382 See Sun bugs 1113095 and 1114114, ``Timezone routines
1383 improperly modify environment''. */
1385 static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
1386 static char set_time_zone_rule_tz2[] = "TZ=GMT+1";
1390 /* Set the local time zone rule to TZSTRING.
1391 This allocates memory into `environ', which it is the caller's
1392 responsibility to free. */
1394 set_time_zone_rule (char *tzstring)
1397 char **from, **to, **newenv;
1399 for (from = environ; *from; from++)
1401 envptrs = from - environ + 2;
1402 newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
1403 + (tzstring ? strlen (tzstring) + 4 : 0));
1406 char *t = (char *) (to + envptrs);
1408 strcat (t, tzstring);
1412 for (from = environ; *from; from++)
1413 if (strncmp (*from, "TZ=", 3) != 0)
1419 #ifdef LOCALTIME_CACHE
1421 /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
1422 "US/Pacific" that loads a tz file, then changes to a value like
1423 "XXX0" that does not load a tz file, and then changes back to
1424 its original value, the last change is (incorrectly) ignored.
1425 Also, if TZ changes twice in succession to values that do
1426 not load a tz file, tzset can dump core (see Sun bug#1225179).
1427 The following code works around these bugs. */
1431 /* Temporarily set TZ to a value that loads a tz file
1432 and that differs from tzstring. */
1434 *newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3) == 0
1435 ? set_time_zone_rule_tz2 : set_time_zone_rule_tz1);
1441 /* The implied tzstring is unknown, so temporarily set TZ to
1442 two different values that each load a tz file. */
1443 *to = set_time_zone_rule_tz1;
1446 *to = set_time_zone_rule_tz2;
1451 /* Now TZ has the desired value, and tzset can be invoked safely. */
1458 DEFUN ("set-time-zone-rule", Fset_time_zone_rule, 1, 1, 0, /*
1459 Set the local time zone using TZ, a string specifying a time zone rule.
1460 If TZ is nil, use implementation-defined default time zone information.
1471 tzstring = (char *) XSTRING_DATA (tz);
1474 set_time_zone_rule (tzstring);
1477 environbuf = environ;
1484 buffer_insert1 (struct buffer *buf, Lisp_Object arg)
1486 /* This function can GC */
1487 struct gcpro gcpro1;
1490 if (CHAR_OR_CHAR_INTP (arg))
1492 buffer_insert_emacs_char (buf, XCHAR_OR_CHAR_INT (arg));
1494 else if (STRINGP (arg))
1496 buffer_insert_lisp_string (buf, arg);
1500 arg = wrong_type_argument (Qchar_or_string_p, arg);
1507 /* Callers passing one argument to Finsert need not gcpro the
1508 argument "array", since the only element of the array will
1509 not be used after calling insert_emacs_char or insert_lisp_string,
1510 so we don't care if it gets trashed. */
1512 DEFUN ("insert", Finsert, 0, MANY, 0, /*
1513 Insert the arguments, either strings or characters, at point.
1514 Point moves forward so that it ends up after the inserted text.
1515 Any other markers at the point of insertion remain before the text.
1516 If a string has non-null string-extent-data, new extents will be created.
1518 (int nargs, Lisp_Object *args))
1520 /* This function can GC */
1521 REGISTER int argnum;
1523 for (argnum = 0; argnum < nargs; argnum++)
1525 buffer_insert1 (current_buffer, args[argnum]);
1531 DEFUN ("insert-before-markers", Finsert_before_markers, 0, MANY, 0, /*
1532 Insert strings or characters at point, relocating markers after the text.
1533 Point moves forward so that it ends up after the inserted text.
1534 Any other markers at the point of insertion also end up after the text.
1536 (int nargs, Lisp_Object *args))
1538 /* This function can GC */
1539 REGISTER int argnum;
1540 REGISTER Lisp_Object tem;
1542 for (argnum = 0; argnum < nargs; argnum++)
1546 if (CHAR_OR_CHAR_INTP (tem))
1548 buffer_insert_emacs_char_1 (current_buffer, -1,
1549 XCHAR_OR_CHAR_INT (tem),
1550 INSDEL_BEFORE_MARKERS);
1552 else if (STRINGP (tem))
1554 buffer_insert_lisp_string_1 (current_buffer, -1, tem,
1555 INSDEL_BEFORE_MARKERS);
1559 tem = wrong_type_argument (Qchar_or_string_p, tem);
1566 DEFUN ("insert-string", Finsert_string, 1, 2, 0, /*
1567 Insert STRING into BUFFER at BUFFER's point.
1568 Point moves forward so that it ends up after the inserted text.
1569 Any other markers at the point of insertion remain before the text.
1570 If a string has non-null string-extent-data, new extents will be created.
1571 BUFFER defaults to the current buffer.
1575 struct buffer *b = decode_buffer (buffer, 1);
1576 CHECK_STRING (string);
1577 buffer_insert_lisp_string (b, string);
1581 /* Third argument in FSF is INHERIT:
1583 "The optional third arg INHERIT, if non-nil, says to inherit text properties
1584 from adjoining text, if those properties are sticky."
1586 Jamie thinks this is bogus. */
1589 DEFUN ("insert-char", Finsert_char, 1, 4, 0, /*
1590 Insert COUNT copies of CHARACTER into BUFFER.
1591 Point and all markers are affected as in the function `insert'.
1592 COUNT defaults to 1 if omitted.
1593 The optional third arg IGNORED is INHERIT under FSF Emacs.
1594 This is highly bogus, however, and XEmacs always behaves as if
1595 `t' were passed to INHERIT.
1596 The optional fourth arg BUFFER specifies the buffer to insert the
1597 text into. If BUFFER is nil, the current buffer is assumed.
1599 (character, count, ignored, buffer))
1601 /* This function can GC */
1602 REGISTER Bufbyte *string;
1605 REGISTER Bytecount n;
1606 REGISTER Bytecount charlen;
1607 Bufbyte str[MAX_EMCHAR_LEN];
1608 struct buffer *b = decode_buffer (buffer, 1);
1611 CHECK_CHAR_COERCE_INT (character);
1620 charlen = set_charptr_emchar (str, XCHAR (character));
1624 slen = min (n, 768);
1625 string = alloca_array (Bufbyte, slen);
1626 /* Write as many copies of the character into the temp string as will fit. */
1627 for (i = 0; i + charlen <= slen; i += charlen)
1628 for (j = 0; j < charlen; j++)
1629 string[i + j] = str[j];
1633 buffer_insert_raw_string (b, string, slen);
1637 #if 0 /* FSFmacs bogosity */
1639 if (!NILP (inherit))
1640 insert_and_inherit (string, n);
1645 buffer_insert_raw_string (b, string, n);
1652 /* Making strings from buffer contents. */
1654 DEFUN ("buffer-substring", Fbuffer_substring, 0, 3, 0, /*
1655 Return the contents of part of BUFFER as a string.
1656 The two arguments START and END are character positions;
1657 they can be in either order. If omitted, they default to the beginning
1658 and end of BUFFER, respectively.
1659 If there are duplicable extents in the region, the string remembers
1660 them in its extent data.
1661 If BUFFER is nil, the current buffer is assumed.
1663 (start, end, buffer))
1665 /* This function can GC */
1667 struct buffer *b = decode_buffer (buffer, 1);
1669 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1670 return make_string_from_buffer (b, begv, zv - begv);
1673 /* It might make more sense to name this
1674 `buffer-substring-no-extents', but this name is FSFmacs-compatible,
1675 and what the function does is probably good enough for what the
1676 user-code will typically want to use it for. */
1677 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties, 0, 3, 0, /*
1678 Return the text from START to END as a string, without copying the extents.
1680 (start, end, buffer))
1682 /* This function can GC */
1684 struct buffer *b = decode_buffer (buffer, 1);
1686 get_buffer_range_char (b, start, end, &begv, &zv, GB_ALLOW_NIL);
1687 return make_string_from_buffer_no_extents (b, begv, zv - begv);
1690 DEFUN ("insert-buffer-substring", Finsert_buffer_substring, 1, 3, 0, /*
1691 Insert before point a substring of the contents of buffer BUFFER.
1692 BUFFER may be a buffer or a buffer name.
1693 Arguments START and END are character numbers specifying the substring.
1694 They default to the beginning and the end of BUFFER.
1696 (buffer, start, end))
1698 /* This function can GC */
1702 bp = XBUFFER (get_buffer (buffer, 1));
1703 get_buffer_range_char (bp, start, end, &b, &e, GB_ALLOW_NIL);
1706 buffer_insert_from_buffer (current_buffer, bp, b, e - b);
1711 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, 6, 6, 0, /*
1712 Compare two substrings of two buffers; return result as number.
1713 the value is -N if first string is less after N-1 chars,
1714 +N if first string is greater after N-1 chars, or 0 if strings match.
1715 Each substring is represented as three arguments: BUFFER, START and END.
1716 That makes six args in all, three for each substring.
1718 The value of `case-fold-search' in the current buffer
1719 determines whether case is significant or ignored.
1721 (buffer1, start1, end1, buffer2, start2, end2))
1723 Bufpos begp1, endp1, begp2, endp2;
1724 REGISTER Charcount len1, len2, length, i;
1725 struct buffer *bp1, *bp2;
1726 Lisp_Object trt = ((!NILP (current_buffer->case_fold_search)) ?
1727 XCASE_TABLE_CANON (current_buffer->case_table) : Qnil);
1729 /* Find the first buffer and its substring. */
1731 bp1 = decode_buffer (buffer1, 1);
1732 get_buffer_range_char (bp1, start1, end1, &begp1, &endp1, GB_ALLOW_NIL);
1734 /* Likewise for second substring. */
1736 bp2 = decode_buffer (buffer2, 1);
1737 get_buffer_range_char (bp2, start2, end2, &begp2, &endp2, GB_ALLOW_NIL);
1739 len1 = endp1 - begp1;
1740 len2 = endp2 - begp2;
1745 for (i = 0; i < length; i++)
1747 Emchar c1 = BUF_FETCH_CHAR (bp1, begp1 + i);
1748 Emchar c2 = BUF_FETCH_CHAR (bp2, begp2 + i);
1751 c1 = TRT_TABLE_OF (trt, c1);
1752 c2 = TRT_TABLE_OF (trt, c2);
1755 return make_int (- 1 - i);
1757 return make_int (i + 1);
1760 /* The strings match as far as they go.
1761 If one is shorter, that one is less. */
1763 return make_int (length + 1);
1764 else if (length < len2)
1765 return make_int (- length - 1);
1767 /* Same length too => they are equal. */
1773 subst_char_in_region_unwind (Lisp_Object arg)
1775 XBUFFER (XCAR (arg))->undo_list = XCDR (arg);
1780 subst_char_in_region_unwind_1 (Lisp_Object arg)
1782 XBUFFER (XCAR (arg))->filename = XCDR (arg);
1786 DEFUN ("subst-char-in-region", Fsubst_char_in_region, 4, 5, 0, /*
1787 From START to END, replace FROMCHAR with TOCHAR each time it occurs.
1788 If optional arg NOUNDO is non-nil, don't record this change for undo
1789 and don't mark the buffer as really changed.
1791 (start, end, fromchar, tochar, noundo))
1793 /* This function can GC */
1797 struct buffer *buf = current_buffer;
1798 int count = specpdl_depth ();
1800 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1801 CHECK_CHAR_COERCE_INT (fromchar);
1802 CHECK_CHAR_COERCE_INT (tochar);
1804 fromc = XCHAR (fromchar);
1805 toc = XCHAR (tochar);
1807 /* If we don't want undo, turn off putting stuff on the list.
1808 That's faster than getting rid of things,
1809 and it prevents even the entry for a first change.
1810 Also inhibit locking the file. */
1813 record_unwind_protect (subst_char_in_region_unwind,
1814 Fcons (Fcurrent_buffer (), buf->undo_list));
1815 buf->undo_list = Qt;
1816 /* Don't do file-locking. */
1817 record_unwind_protect (subst_char_in_region_unwind_1,
1818 Fcons (Fcurrent_buffer (), buf->filename));
1819 buf->filename = Qnil;
1822 mc_count = begin_multiple_change (buf, pos, stop);
1825 if (BUF_FETCH_CHAR (buf, pos) == fromc)
1827 /* There used to be some code here that set the buffer to
1828 unmodified if NOUNDO was specified and there was only
1829 one change to the buffer since it was last saved.
1830 This is a crock of shit, so I'm not duplicating this
1831 behavior. I think this was left over from when
1832 prepare_to_modify_buffer() actually bumped MODIFF,
1833 so that code was supposed to undo this change. --ben */
1834 buffer_replace_char (buf, pos, toc, !NILP (noundo), 0);
1836 /* If noundo is not nil then we don't mark the buffer as
1837 modified. In reality that needs to happen externally
1838 only. Internally redisplay needs to know that the actual
1839 contents it should be displaying have changed. */
1841 Fset_buffer_modified_p (Fbuffer_modified_p (Qnil), Qnil);
1845 end_multiple_change (buf, mc_count);
1847 unbind_to (count, Qnil);
1851 /* #### Shouldn't this also accept a BUFFER argument, in the good old
1852 XEmacs tradition? */
1853 DEFUN ("translate-region", Ftranslate_region, 3, 3, 0, /*
1854 Translate characters from START to END according to TABLE.
1856 If TABLE is a string, the Nth character in it is the mapping for the
1857 character with code N.
1859 If TABLE is a vector, its Nth element is the mapping for character
1860 with code N. The values of elements may be characters, strings, or
1861 nil (nil meaning don't replace.)
1863 If TABLE is a char-table, its elements describe the mapping between
1864 characters and their replacements. The char-table should be of type
1865 `char' or `generic'.
1867 Returns the number of substitutions performed.
1869 (start, end, table))
1871 /* This function can GC */
1872 Bufpos pos, stop; /* Limits of the region. */
1873 int cnt = 0; /* Number of changes made. */
1875 struct buffer *buf = current_buffer;
1878 get_buffer_range_char (buf, start, end, &pos, &stop, 0);
1879 mc_count = begin_multiple_change (buf, pos, stop);
1880 if (STRINGP (table))
1882 Lisp_String *stable = XSTRING (table);
1883 Charcount size = string_char_length (stable);
1885 /* Under Mule, string_char(n) is O(n), so for large tables or
1886 large regions it makes sense to create an array of Emchars. */
1887 if (size * (stop - pos) > 65536)
1889 Emchar *etable = alloca_array (Emchar, size);
1890 convert_bufbyte_string_into_emchar_string
1891 (string_data (stable), string_length (stable), etable);
1892 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1896 Emchar nc = etable[oc];
1899 buffer_replace_char (buf, pos, nc, 0, 0);
1908 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1912 Emchar nc = string_char (stable, oc);
1915 buffer_replace_char (buf, pos, nc, 0, 0);
1922 else if (VECTORP (table))
1924 Charcount size = XVECTOR_LENGTH (table);
1925 Lisp_Object *vtable = XVECTOR_DATA (table);
1927 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1931 Lisp_Object replacement = vtable[oc];
1933 if (CHAR_OR_CHAR_INTP (replacement))
1935 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1938 buffer_replace_char (buf, pos, nc, 0, 0);
1942 else if (STRINGP (replacement))
1944 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1945 buffer_delete_range (buf, pos, pos + 1, 0);
1946 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1947 pos += incr, stop += incr;
1950 else if (!NILP (replacement))
1952 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1958 else if (CHAR_TABLEP (table)
1959 && (XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC
1960 || XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR))
1962 Lisp_Char_Table *ctable = XCHAR_TABLE (table);
1964 for (; pos < stop && (oc = BUF_FETCH_CHAR (buf, pos), 1); pos++)
1966 Lisp_Object replacement = get_char_table (oc, ctable);
1968 if (CHAR_OR_CHAR_INTP (replacement))
1970 Emchar nc = XCHAR_OR_CHAR_INT (replacement);
1973 buffer_replace_char (buf, pos, nc, 0, 0);
1977 else if (STRINGP (replacement))
1979 Charcount incr = XSTRING_CHAR_LENGTH (replacement) - 1;
1980 buffer_delete_range (buf, pos, pos + 1, 0);
1981 buffer_insert_lisp_string_1 (buf, pos, replacement, 0);
1982 pos += incr, stop += incr;
1985 else if (!NILP (replacement))
1987 replacement = wrong_type_argument (Qchar_or_string_p, replacement);
1993 dead_wrong_type_argument (Qstringp, table);
1994 end_multiple_change (buf, mc_count);
1996 return make_int (cnt);
1999 DEFUN ("delete-region", Fdelete_region, 2, 3, "r", /*
2000 Delete the text between point and mark.
2001 When called from a program, expects two arguments START and END
2002 \(integers or markers) specifying the stretch to be deleted.
2003 If optional third arg BUFFER is nil, the current buffer is assumed.
2005 (start, end, buffer))
2007 /* This function can GC */
2008 Bufpos bp_start, bp_end;
2009 struct buffer *buf = decode_buffer (buffer, 1);
2011 get_buffer_range_char (buf, start, end, &bp_start, &bp_end, 0);
2012 buffer_delete_range (buf, bp_start, bp_end, 0);
2017 widen_buffer (struct buffer *b, int no_clip)
2019 if (BUF_BEGV (b) != BUF_BEG (b))
2022 SET_BOTH_BUF_BEGV (b, BUF_BEG (b), BI_BUF_BEG (b));
2024 if (BUF_ZV (b) != BUF_Z (b))
2027 SET_BOTH_BUF_ZV (b, BUF_Z (b), BI_BUF_Z (b));
2033 /* Changing the buffer bounds invalidates any recorded current
2035 invalidate_current_column ();
2036 narrow_line_number_cache (b);
2040 DEFUN ("widen", Fwiden, 0, 1, "", /*
2041 Remove restrictions (narrowing) from BUFFER.
2042 This allows the buffer's full text to be seen and edited.
2043 If BUFFER is nil, the current buffer is assumed.
2047 struct buffer *b = decode_buffer (buffer, 1);
2048 widen_buffer (b, 0);
2052 DEFUN ("narrow-to-region", Fnarrow_to_region, 2, 3, "r", /*
2053 Restrict editing in BUFFER to the current region.
2054 The rest of the text becomes temporarily invisible and untouchable
2055 but is not deleted; if you save the buffer in a file, the invisible
2056 text is included in the file. \\[widen] makes all visible again.
2057 If BUFFER is nil, the current buffer is assumed.
2058 See also `save-restriction'.
2060 When calling from a program, pass two arguments; positions (integers
2061 or markers) bounding the text that should remain visible.
2063 (start, end, buffer))
2065 Bufpos bp_start, bp_end;
2066 struct buffer *buf = decode_buffer (buffer, 1);
2067 Bytind bi_start, bi_end;
2069 get_buffer_range_char (buf, start, end, &bp_start, &bp_end,
2070 GB_ALLOW_PAST_ACCESSIBLE);
2071 bi_start = bufpos_to_bytind (buf, bp_start);
2072 bi_end = bufpos_to_bytind (buf, bp_end);
2074 SET_BOTH_BUF_BEGV (buf, bp_start, bi_start);
2075 SET_BOTH_BUF_ZV (buf, bp_end, bi_end);
2076 if (BUF_PT (buf) < bp_start)
2077 BUF_SET_PT (buf, bp_start);
2078 if (BUF_PT (buf) > bp_end)
2079 BUF_SET_PT (buf, bp_end);
2081 /* Changing the buffer bounds invalidates any recorded current column. */
2082 invalidate_current_column ();
2083 narrow_line_number_cache (buf);
2088 save_restriction_save (void)
2090 Lisp_Object bottom, top;
2091 /* Note: I tried using markers here, but it does not win
2092 because insertion at the end of the saved region
2093 does not advance mh and is considered "outside" the saved region. */
2094 bottom = make_int (BUF_BEGV (current_buffer) - BUF_BEG (current_buffer));
2095 top = make_int (BUF_Z (current_buffer) - BUF_ZV (current_buffer));
2097 return noseeum_cons (Fcurrent_buffer (), noseeum_cons (bottom, top));
2101 save_restriction_restore (Lisp_Object data)
2104 Charcount newhead, newtail;
2106 int local_clip_changed = 0;
2108 buf = XBUFFER (XCAR (data));
2109 if (!BUFFER_LIVE_P (buf))
2111 /* someone could have killed the buffer in the meantime ... */
2112 free_cons (XCONS (XCDR (data)));
2113 free_cons (XCONS (data));
2117 newhead = XINT (XCAR (tem));
2118 newtail = XINT (XCDR (tem));
2120 free_cons (XCONS (XCDR (data)));
2121 free_cons (XCONS (data));
2123 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
2131 Bytind bi_start, bi_end;
2133 start = BUF_BEG (buf) + newhead;
2134 end = BUF_Z (buf) - newtail;
2136 bi_start = bufpos_to_bytind (buf, start);
2137 bi_end = bufpos_to_bytind (buf, end);
2139 if (BUF_BEGV (buf) != start)
2141 local_clip_changed = 1;
2142 SET_BOTH_BUF_BEGV (buf, start, bi_start);
2143 narrow_line_number_cache (buf);
2145 if (BUF_ZV (buf) != end)
2147 local_clip_changed = 1;
2148 SET_BOTH_BUF_ZV (buf, end, bi_end);
2151 if (local_clip_changed)
2154 /* If point is outside the new visible range, move it inside. */
2156 bufpos_clip_to_bounds (BUF_BEGV (buf),
2163 DEFUN ("save-restriction", Fsave_restriction, 0, UNEVALLED, 0, /*
2164 Execute BODY, saving and restoring current buffer's restrictions.
2165 The buffer's restrictions make parts of the beginning and end invisible.
2166 \(They are set up with `narrow-to-region' and eliminated with `widen'.)
2167 This special form, `save-restriction', saves the current buffer's restrictions
2168 when it is entered, and restores them when it is exited.
2169 So any `narrow-to-region' within BODY lasts only until the end of the form.
2170 The old restrictions settings are restored
2171 even in case of abnormal exit (throw or error).
2173 The value returned is the value of the last form in BODY.
2175 `save-restriction' can get confused if, within the BODY, you widen
2176 and then make changes outside the area within the saved restrictions.
2178 Note: if you are using both `save-excursion' and `save-restriction',
2179 use `save-excursion' outermost:
2180 (save-excursion (save-restriction ...))
2184 /* This function can GC */
2185 int speccount = specpdl_depth ();
2187 record_unwind_protect (save_restriction_restore, save_restriction_save ());
2189 return unbind_to (speccount, Fprogn (body));
2193 DEFUN ("format", Fformat, 1, MANY, 0, /*
2194 Format a string out of a control-string and arguments.
2195 The first argument is a control string.
2196 The other arguments are substituted into it to make the result, a string.
2197 It may contain %-sequences meaning to substitute the next argument.
2198 %s means print all objects as-is, using `princ'.
2199 %S means print all objects as s-expressions, using `prin1'.
2200 %d or %i means print as an integer in decimal (%o octal, %x lowercase hex,
2202 %c means print as a single character.
2203 %f means print as a floating-point number in fixed notation (e.g. 785.200).
2204 %e or %E means print as a floating-point number in scientific notation
2206 %g or %G means print as a floating-point number in "pretty format";
2207 depending on the number, either %f or %e/%E format will be used, and
2208 trailing zeroes are removed from the fractional part.
2209 The argument used for all but %s and %S must be a number. It will be
2210 converted to an integer or a floating-point number as necessary.
2212 %$ means reposition to read a specific numbered argument; for example,
2213 %3$s would apply the `%s' to the third argument after the control string,
2214 and the next format directive would use the fourth argument, the
2215 following one the fifth argument, etc. (There must be a positive integer
2216 between the % and the $).
2217 Zero or more of the flag characters `-', `+', ` ', `0', and `#' may be
2218 specified between the optional repositioning spec and the conversion
2219 character; see below.
2220 An optional minimum field width may be specified after any flag characters
2221 and before the conversion character; it specifies the minimum number of
2222 characters that the converted argument will take up. Padding will be
2223 added on the left (or on the right, if the `-' flag is specified), as
2224 necessary. Padding is done with spaces, or with zeroes if the `0' flag
2226 If the field width is specified as `*', the field width is assumed to have
2227 been specified as an argument. Any repositioning specification that
2228 would normally specify the argument to be converted will now specify
2229 where to find this field width argument, not where to find the argument
2230 to be converted. If there is no repositioning specification, the normal
2231 next argument is used. The argument to be converted will be the next
2232 argument after the field width argument unless the precision is also
2233 specified as `*' (see below).
2235 An optional period character and precision may be specified after any
2236 minimum field width. It specifies the minimum number of digits to
2237 appear in %d, %i, %o, %x, and %X conversions (the number is padded
2238 on the left with zeroes as necessary); the number of digits printed
2239 after the decimal point for %f, %e, and %E conversions; the number
2240 of significant digits printed in %g and %G conversions; and the
2241 maximum number of non-padding characters printed in %s and %S
2242 conversions. The default precision for floating-point conversions
2244 If the precision is specified as `*', the precision is assumed to have been
2245 specified as an argument. The argument used will be the next argument
2246 after the field width argument, if any. If the field width was not
2247 specified as an argument, any repositioning specification that would
2248 normally specify the argument to be converted will now specify where to
2249 find the precision argument. If there is no repositioning specification,
2250 the normal next argument is used.
2252 The ` ' and `+' flags mean prefix non-negative numbers with a space or
2253 plus sign, respectively.
2254 The `#' flag means print numbers in an alternate, more verbose format:
2255 octal numbers begin with zero; hex numbers begin with a 0x or 0X;
2256 a decimal point is printed in %f, %e, and %E conversions even if no
2257 numbers are printed after it; and trailing zeroes are not omitted in
2258 %g and %G conversions.
2260 Use %% to put a single % into the output.
2262 (int nargs, Lisp_Object *args))
2264 /* It should not be necessary to GCPRO ARGS, because
2265 the caller in the interpreter should take care of that. */
2267 CHECK_STRING (args[0]);
2268 return emacs_doprnt_string_lisp (0, args[0], 0, nargs - 1, args + 1);
2272 DEFUN ("char-equal", Fchar_equal, 2, 3, 0, /*
2273 Return t if two characters match, optionally ignoring case.
2274 Both arguments must be characters (i.e. NOT integers).
2275 Case is ignored if `case-fold-search' is non-nil in BUFFER.
2276 If BUFFER is nil, the current buffer is assumed.
2278 (character1, character2, buffer))
2281 struct buffer *b = decode_buffer (buffer, 1);
2283 CHECK_CHAR_COERCE_INT (character1);
2284 CHECK_CHAR_COERCE_INT (character2);
2285 x1 = XCHAR (character1);
2286 x2 = XCHAR (character2);
2288 return (!NILP (b->case_fold_search)
2289 ? DOWNCASE (b, x1) == DOWNCASE (b, x2)
2294 DEFUN ("char=", Fchar_Equal, 2, 2, 0, /*
2295 Return t if two characters match, case is significant.
2296 Both arguments must be characters (i.e. NOT integers).
2298 (character1, character2))
2300 CHECK_CHAR_COERCE_INT (character1);
2301 CHECK_CHAR_COERCE_INT (character2);
2303 return EQ (character1, character2) ? Qt : Qnil;
2306 #if 0 /* Undebugged FSFmacs code */
2307 /* Transpose the markers in two regions of the current buffer, and
2308 adjust the ones between them if necessary (i.e.: if the regions
2311 Traverses the entire marker list of the buffer to do so, adding an
2312 appropriate amount to some, subtracting from some, and leaving the
2313 rest untouched. Most of this is copied from adjust_markers in insdel.c.
2315 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
2318 transpose_markers (Bufpos start1, Bufpos end1, Bufpos start2, Bufpos end2)
2320 Charcount amt1, amt2, diff;
2322 struct buffer *buf = current_buffer;
2324 /* Update point as if it were a marker. */
2325 if (BUF_PT (buf) < start1)
2327 else if (BUF_PT (buf) < end1)
2328 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - end1));
2329 else if (BUF_PT (buf) < start2)
2330 BUF_SET_PT (buf, BUF_PT (buf) + (end2 - start2) - (end1 - start1));
2331 else if (BUF_PT (buf) < end2)
2332 BUF_SET_PT (buf, BUF_PT (buf) - (start2 - start1));
2334 /* We used to adjust the endpoints here to account for the gap, but that
2335 isn't good enough. Even if we assume the caller has tried to move the
2336 gap out of our way, it might still be at start1 exactly, for example;
2337 and that places it `inside' the interval, for our purposes. The amount
2338 of adjustment is nontrivial if there's a `denormalized' marker whose
2339 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
2340 the dirty work to Fmarker_position, below. */
2342 /* The difference between the region's lengths */
2343 diff = (end2 - start2) - (end1 - start1);
2345 /* For shifting each marker in a region by the length of the other
2346 * region plus the distance between the regions.
2348 amt1 = (end2 - start2) + (start2 - end1);
2349 amt2 = (end1 - start1) + (start2 - end1);
2351 for (marker = BUF_MARKERS (buf); !NILP (marker);
2352 marker = XMARKER (marker)->chain)
2354 Bufpos mpos = marker_position (marker);
2355 if (mpos >= start1 && mpos < end2)
2359 else if (mpos < start2)
2363 set_marker_position (marker, mpos);
2370 DEFUN ("transpose-regions", Ftranspose_regions, 4, 5, 0, /*
2371 Transpose region START1 to END1 with START2 to END2.
2372 The regions may not be overlapping, because the size of the buffer is
2373 never changed in a transposition.
2375 Optional fifth arg LEAVE-MARKERS, if non-nil, means don't transpose
2376 any markers that happen to be located in the regions. (#### BUG: currently
2377 this function always acts as if LEAVE-MARKERS is non-nil.)
2379 Transposing beyond buffer boundaries is an error.
2381 (start1, end1, start2, end2, leave_markers))
2383 Bufpos startr1, endr1, startr2, endr2;
2384 Charcount len1, len2;
2385 Lisp_Object string1, string2;
2386 struct buffer *buf = current_buffer;
2388 get_buffer_range_char (buf, start1, end1, &startr1, &endr1, 0);
2389 get_buffer_range_char (buf, start2, end2, &startr2, &endr2, 0);
2391 len1 = endr1 - startr1;
2392 len2 = endr2 - startr2;
2394 if (startr2 < endr1)
2395 error ("transposed regions not properly ordered");
2396 else if (startr1 == endr1 || startr2 == endr2)
2397 error ("transposed region may not be of length 0");
2399 string1 = make_string_from_buffer (buf, startr1, len1);
2400 string2 = make_string_from_buffer (buf, startr2, len2);
2401 buffer_delete_range (buf, startr2, endr2, 0);
2402 buffer_insert_lisp_string_1 (buf, startr2, string1, 0);
2403 buffer_delete_range (buf, startr1, endr1, 0);
2404 buffer_insert_lisp_string_1 (buf, startr1, string2, 0);
2406 /* In FSFmacs there is a whole bunch of really ugly code here
2407 to attempt to transpose the regions without using up any
2408 extra memory. Although the intent may be good, the result
2409 was highly bogus. */
2415 /************************************************************************/
2416 /* initialization */
2417 /************************************************************************/
2420 syms_of_editfns (void)
2422 defsymbol (&Qpoint, "point");
2423 defsymbol (&Qmark, "mark");
2424 defsymbol (&Qregion_beginning, "region-beginning");
2425 defsymbol (&Qregion_end, "region-end");
2426 defsymbol (&Qformat, "format");
2427 defsymbol (&Quser_files_and_directories, "user-files-and-directories");
2429 DEFSUBR (Fchar_equal);
2430 DEFSUBR (Fchar_Equal);
2431 DEFSUBR (Fgoto_char);
2432 DEFSUBR (Fstring_to_char);
2433 DEFSUBR (Fchar_to_string);
2434 DEFSUBR (Fbuffer_substring);
2435 DEFSUBR (Fbuffer_substring_no_properties);
2437 DEFSUBR (Fpoint_marker);
2438 DEFSUBR (Fmark_marker);
2440 DEFSUBR (Fregion_beginning);
2441 DEFSUBR (Fregion_end);
2442 DEFSUBR (Fsave_excursion);
2443 DEFSUBR (Fsave_current_buffer);
2445 DEFSUBR (Fbuffer_size);
2446 DEFSUBR (Fpoint_max);
2447 DEFSUBR (Fpoint_min);
2448 DEFSUBR (Fpoint_min_marker);
2449 DEFSUBR (Fpoint_max_marker);
2455 DEFSUBR (Ffollowing_char);
2456 DEFSUBR (Fpreceding_char);
2457 DEFSUBR (Fchar_after);
2458 DEFSUBR (Fchar_before);
2460 DEFSUBR (Finsert_string);
2461 DEFSUBR (Finsert_before_markers);
2462 DEFSUBR (Finsert_char);
2464 DEFSUBR (Ftemp_directory);
2465 DEFSUBR (Fuser_login_name);
2466 DEFSUBR (Fuser_real_login_name);
2467 DEFSUBR (Fuser_uid);
2468 DEFSUBR (Fuser_real_uid);
2469 DEFSUBR (Fuser_full_name);
2470 DEFSUBR (Fuser_home_directory);
2471 DEFSUBR (Femacs_pid);
2472 DEFSUBR (Fcurrent_time);
2473 DEFSUBR (Fcurrent_process_time);
2474 DEFSUBR (Fformat_time_string);
2475 DEFSUBR (Fdecode_time);
2476 DEFSUBR (Fencode_time);
2477 DEFSUBR (Fcurrent_time_string);
2478 DEFSUBR (Fcurrent_time_zone);
2479 DEFSUBR (Fset_time_zone_rule);
2480 DEFSUBR (Fsystem_name);
2483 DEFSUBR (Finsert_buffer_substring);
2484 DEFSUBR (Fcompare_buffer_substrings);
2485 DEFSUBR (Fsubst_char_in_region);
2486 DEFSUBR (Ftranslate_region);
2487 DEFSUBR (Fdelete_region);
2489 DEFSUBR (Fnarrow_to_region);
2490 DEFSUBR (Fsave_restriction);
2491 DEFSUBR (Ftranspose_regions);
2493 defsymbol (&Qzmacs_update_region, "zmacs-update-region");
2494 defsymbol (&Qzmacs_deactivate_region, "zmacs-deactivate-region");
2495 defsymbol (&Qzmacs_region_buffer, "zmacs-region-buffer");
2499 vars_of_editfns (void)
2501 staticpro (&Vsystem_name);
2503 staticpro (&Vuser_name);
2504 staticpro (&Vuser_real_name);
2506 DEFVAR_BOOL ("zmacs-regions", &zmacs_regions /*
2507 *Whether LISPM-style active regions should be used.
2508 This means that commands which operate on the region (the area between the
2509 point and the mark) will only work while the region is in the ``active''
2510 state, which is indicated by highlighting. Executing most commands causes
2511 the region to not be in the active state, so (for example) \\[kill-region] will only
2512 work immediately after activating the region.
2516 - Commands which operate on the region only work if the region is active.
2517 - Only a very small set of commands cause the region to become active:
2518 Those commands whose semantics are to mark an area, like `mark-defun'.
2519 - The region is deactivated after each command that is executed, except that:
2520 - "Motion" commands do not change whether the region is active or not.
2522 set-mark-command (C-SPC) pushes a mark and activates the region. Moving the
2523 cursor with normal motion commands (C-n, C-p, etc) will cause the region
2524 between point and the recently-pushed mark to be highlighted. It will
2525 remain highlighted until some non-motion command is executed.
2527 exchange-point-and-mark (\\[exchange-point-and-mark]) activates the region. So if you mark a
2528 region and execute a command that operates on it, you can reactivate the
2529 same region with \\[exchange-point-and-mark] (or perhaps \\[exchange-point-and-mark] \\[exchange-point-and-mark]) to operate on it
2532 Generally, commands which push marks as a means of navigation (like
2533 beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
2534 region. But commands which push marks as a means of marking an area of
2535 text (like mark-defun (\\[mark-defun]), mark-word (\\[mark-word]) or mark-whole-buffer (\\[mark-whole-buffer]))
2536 do activate the region.
2538 The way the command loop actually works with regard to deactivating the
2539 region is as follows:
2541 - If the variable `zmacs-region-stays' has been set to t during the command
2542 just executed, the region is left alone (this is how the motion commands
2543 make the region stay around; see the `_' flag in the `interactive'
2544 specification). `zmacs-region-stays' is reset to nil before each command
2546 - If the function `zmacs-activate-region' has been called during the command
2547 just executed, the region is left alone. Very few functions should
2548 actually call this function.
2549 - Otherwise, if the region is active, the region is deactivated and
2550 the `zmacs-deactivate-region-hook' is called.
2552 /* Zmacs style active regions are now ON by default */
2555 DEFVAR_BOOL ("zmacs-region-active-p", &zmacs_region_active_p /*
2556 Do not alter this. It is for internal use only.
2558 zmacs_region_active_p = 0;
2560 DEFVAR_BOOL ("zmacs-region-stays", &zmacs_region_stays /*
2561 Whether the current command will deactivate the region.
2562 Commands which do not wish to affect whether the region is currently
2563 highlighted should set this to t. Normally, the region is turned off after
2564 executing each command that did not explicitly turn it on with the function
2565 zmacs-activate-region. Setting this to true lets a command be non-intrusive.
2566 See the variable `zmacs-regions'.
2568 The same effect can be achieved using the `_' interactive specification.
2570 `zmacs-region-stays' is reset to nil before each command is executed.
2572 zmacs_region_stays = 0;
2574 DEFVAR_BOOL ("atomic-extent-goto-char-p", &atomic_extent_goto_char_p /*
2575 Do not use this -- it will be going away soon.
2576 Indicates if `goto-char' has just been run. This information is allegedly
2577 needed to get the desired behavior for atomic extents and unfortunately
2578 is not available by any other means.
2580 atomic_extent_goto_char_p = 0;
2581 #ifdef AMPERSAND_FULL_NAME
2582 Fprovide(intern("ampersand-full-name"));
2585 DEFVAR_LISP ("user-full-name", &Vuser_full_name /*
2586 *The name of the user.
2587 The function `user-full-name', which will return the value of this
2588 variable, when called without arguments.
2589 This is initialized to the value of the NAME environment variable.
2591 /* Initialized at run-time. */
2592 Vuser_full_name = Qnil;