1 /* Lisp functions pertaining to editing.
2 Copyright (C) 1985, 1986, 1987, 1989, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 1, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
21 #include <sys/types.h>
32 #include "intervals.h"
38 #define min(a, b) ((a) < (b) ? (a) : (b))
39 #define max(a, b) ((a) > (b) ? (a) : (b))
41 /* Some static data, and a function to initialize it for each run */
43 Lisp_Object Vsystem_name
;
44 Lisp_Object Vuser_real_name
; /* login name of current user ID */
45 Lisp_Object Vuser_full_name
; /* full name of current user */
46 Lisp_Object Vuser_name
; /* user name from USER or LOGNAME. */
52 register unsigned char *p
, *q
, *r
;
53 struct passwd
*pw
; /* password entry for the current user */
54 extern char *index ();
57 /* Set up system_name even when dumping. */
59 Vsystem_name
= build_string (get_system_name ());
60 p
= XSTRING (Vsystem_name
)->data
;
63 if (*p
== ' ' || *p
== '\t')
69 /* Don't bother with this on initial start when just dumping out */
72 #endif /* not CANNOT_DUMP */
74 pw
= (struct passwd
*) getpwuid (getuid ());
75 Vuser_real_name
= build_string (pw
? pw
->pw_name
: "unknown");
77 /* Get the effective user name, by consulting environment variables,
78 or the effective uid if those are unset. */
79 user_name
= (char *) getenv ("USER");
81 user_name
= (char *) getenv ("LOGNAME");
84 pw
= (struct passwd
*) getpwuid (geteuid ());
85 user_name
= (char *) (pw
? pw
->pw_name
: "unknown");
87 Vuser_name
= build_string (user_name
);
89 /* If the user name claimed in the environment vars differs from
90 the real uid, use the claimed name to find the full name. */
91 tem
= Fstring_equal (Vuser_name
, Vuser_real_name
);
93 pw
= (struct passwd
*) getpwnam (XSTRING (Vuser_name
)->data
);
95 p
= (unsigned char *) (pw
? USER_FULL_NAME
: "unknown");
96 q
= (unsigned char *) index (p
, ',');
97 Vuser_full_name
= make_string (p
, q
? q
- p
: strlen (p
));
99 #ifdef AMPERSAND_FULL_NAME
100 p
= XSTRING (Vuser_full_name
)->data
;
101 q
= (char *) index (p
, '&');
102 /* Substitute the login name for the &, upcasing the first character. */
105 r
= (char *) alloca (strlen (p
) + XSTRING (Vuser_name
)->size
+ 1);
108 strcat (r
, XSTRING (Vuser_name
)->data
);
109 r
[q
- p
] = UPCASE (r
[q
- p
]);
111 Vuser_full_name
= build_string (r
);
113 #endif /* AMPERSAND_FULL_NAME */
116 DEFUN ("char-to-string", Fchar_to_string
, Schar_to_string
, 1, 1, 0,
117 "Convert arg CHAR to a one-character string containing that character.")
125 return make_string (&c
, 1);
128 DEFUN ("string-to-char", Fstring_to_char
, Sstring_to_char
, 1, 1, 0,
129 "Convert arg STRING to a character, the first character of that string.")
131 register Lisp_Object str
;
133 register Lisp_Object val
;
134 register struct Lisp_String
*p
;
135 CHECK_STRING (str
, 0);
139 XFASTINT (val
) = ((unsigned char *) p
->data
)[0];
149 register Lisp_Object mark
;
150 mark
= Fmake_marker ();
151 Fset_marker (mark
, make_number (val
), Qnil
);
155 DEFUN ("point", Fpoint
, Spoint
, 0, 0, 0,
156 "Return value of point, as an integer.\n\
157 Beginning of buffer is position (point-min)")
161 XFASTINT (temp
) = point
;
165 DEFUN ("point-marker", Fpoint_marker
, Spoint_marker
, 0, 0, 0,
166 "Return value of point, as a marker object.")
169 return buildmark (point
);
173 clip_to_bounds (lower
, num
, upper
)
174 int lower
, num
, upper
;
178 else if (num
> upper
)
184 DEFUN ("goto-char", Fgoto_char
, Sgoto_char
, 1, 1, "NGoto char: ",
185 "Set point to POSITION, a number or marker.\n\
186 Beginning of buffer is position (point-min), end is (point-max).")
188 register Lisp_Object n
;
190 CHECK_NUMBER_COERCE_MARKER (n
, 0);
192 SET_PT (clip_to_bounds (BEGV
, XINT (n
), ZV
));
197 region_limit (beginningp
)
200 extern Lisp_Object Vmark_even_if_inactive
; /* Defined in callint.c. */
201 register Lisp_Object m
;
202 if (!NILP (Vtransient_mark_mode
) && NILP (Vmark_even_if_inactive
)
203 && NILP (current_buffer
->mark_active
))
204 Fsignal (Qmark_inactive
, Qnil
);
205 m
= Fmarker_position (current_buffer
->mark
);
206 if (NILP (m
)) error ("There is no region now");
207 if ((point
< XFASTINT (m
)) == beginningp
)
208 return (make_number (point
));
213 DEFUN ("region-beginning", Fregion_beginning
, Sregion_beginning
, 0, 0, 0,
214 "Return position of beginning of region, as an integer.")
217 return (region_limit (1));
220 DEFUN ("region-end", Fregion_end
, Sregion_end
, 0, 0, 0,
221 "Return position of end of region, as an integer.")
224 return (region_limit (0));
227 #if 0 /* now in lisp code */
228 DEFUN ("mark", Fmark
, Smark
, 0, 0, 0,
229 "Return this buffer's mark value as integer, or nil if no mark.\n\
230 If you are using this in an editing command, you are most likely making\n\
231 a mistake; see the documentation of `set-mark'.")
234 return Fmarker_position (current_buffer
->mark
);
236 #endif /* commented out code */
238 DEFUN ("mark-marker", Fmark_marker
, Smark_marker
, 0, 0, 0,
239 "Return this buffer's mark, as a marker object.\n\
240 Watch out! Moving this marker changes the mark position.\n\
241 If you set the marker not to point anywhere, the buffer will have no mark.")
244 return current_buffer
->mark
;
247 #if 0 /* this is now in lisp code */
248 DEFUN ("set-mark", Fset_mark
, Sset_mark
, 1, 1, 0,
249 "Set this buffer's mark to POS. Don't use this function!\n\
250 That is to say, don't use this function unless you want\n\
251 the user to see that the mark has moved, and you want the previous\n\
252 mark position to be lost.\n\
254 Normally, when a new mark is set, the old one should go on the stack.\n\
255 This is why most applications should use push-mark, not set-mark.\n\
257 Novice programmers often try to use the mark for the wrong purposes.\n\
258 The mark saves a location for the user's convenience.\n\
259 Most editing commands should not alter the mark.\n\
260 To remember a location for internal use in the Lisp program,\n\
261 store it in a Lisp variable. Example:\n\
263 (let ((beg (point))) (forward-line 1) (delete-region beg (point))).")
269 current_buffer
->mark
= Qnil
;
272 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
274 if (NILP (current_buffer
->mark
))
275 current_buffer
->mark
= Fmake_marker ();
277 Fset_marker (current_buffer
->mark
, pos
, Qnil
);
280 #endif /* commented-out code */
283 save_excursion_save ()
285 register int visible
= (XBUFFER (XWINDOW (selected_window
)->buffer
)
288 return Fcons (Fpoint_marker (),
289 Fcons (Fcopy_marker (current_buffer
->mark
),
290 Fcons (visible
? Qt
: Qnil
,
291 current_buffer
->mark_active
)));
295 save_excursion_restore (info
)
296 register Lisp_Object info
;
298 register Lisp_Object tem
, tem1
;
300 tem
= Fmarker_buffer (Fcar (info
));
301 /* If buffer being returned to is now deleted, avoid error */
302 /* Otherwise could get error here while unwinding to top level
304 /* In that case, Fmarker_buffer returns nil now. */
310 unchain_marker (tem
);
311 tem
= Fcar (Fcdr (info
));
312 Fset_marker (current_buffer
->mark
, tem
, Fcurrent_buffer ());
313 unchain_marker (tem
);
314 tem
= Fcdr (Fcdr (info
));
315 #if 0 /* We used to make the current buffer visible in the selected window
316 if that was true previously. That avoids some anomalies.
317 But it creates others, and it wasn't documented, and it is simpler
318 and cleaner never to alter the window/buffer connections. */
321 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
322 Fswitch_to_buffer (Fcurrent_buffer (), Qnil
);
325 tem1
= current_buffer
->mark_active
;
326 current_buffer
->mark_active
= Fcdr (tem
);
327 if (! NILP (current_buffer
->mark_active
))
328 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
329 else if (! NILP (tem1
))
330 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
334 DEFUN ("save-excursion", Fsave_excursion
, Ssave_excursion
, 0, UNEVALLED
, 0,
335 "Save point, mark, and current buffer; execute BODY; restore those things.\n\
336 Executes BODY just like `progn'.\n\
337 The values of point, mark and the current buffer are restored\n\
338 even in case of abnormal exit (throw or error).\n\
339 The state of activation of the mark is also restored.")
343 register Lisp_Object val
;
344 int count
= specpdl_ptr
- specpdl
;
346 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
349 return unbind_to (count
, val
);
352 DEFUN ("buffer-size", Fbufsize
, Sbufsize
, 0, 0, 0,
353 "Return the number of characters in the current buffer.")
357 XFASTINT (temp
) = Z
- BEG
;
361 DEFUN ("point-min", Fpoint_min
, Spoint_min
, 0, 0, 0,
362 "Return the minimum permissible value of point in the current buffer.\n\
363 This is 1, unless narrowing (a buffer restriction) is in effect.")
367 XFASTINT (temp
) = BEGV
;
371 DEFUN ("point-min-marker", Fpoint_min_marker
, Spoint_min_marker
, 0, 0, 0,
372 "Return a marker to the minimum permissible value of point in this buffer.\n\
373 This is the beginning, unless narrowing (a buffer restriction) is in effect.")
376 return buildmark (BEGV
);
379 DEFUN ("point-max", Fpoint_max
, Spoint_max
, 0, 0, 0,
380 "Return the maximum permissible value of point in the current buffer.\n\
381 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
382 is in effect, in which case it is less.")
386 XFASTINT (temp
) = ZV
;
390 DEFUN ("point-max-marker", Fpoint_max_marker
, Spoint_max_marker
, 0, 0, 0,
391 "Return a marker to the maximum permissible value of point in this buffer.\n\
392 This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
393 is in effect, in which case it is less.")
396 return buildmark (ZV
);
399 DEFUN ("following-char", Ffollowing_char
, Sfollowing_char
, 0, 0, 0,
400 "Return the character following point, as a number.\n\
401 At the end of the buffer or accessible region, return 0.")
408 XFASTINT (temp
) = FETCH_CHAR (point
);
412 DEFUN ("preceding-char", Fprevious_char
, Sprevious_char
, 0, 0, 0,
413 "Return the character preceding point, as a number.\n\
414 At the beginning of the buffer or accessible region, return 0.")
421 XFASTINT (temp
) = FETCH_CHAR (point
- 1);
425 DEFUN ("bobp", Fbobp
, Sbobp
, 0, 0, 0,
426 "Return T if point is at the beginning of the buffer.\n\
427 If the buffer is narrowed, this means the beginning of the narrowed part.")
435 DEFUN ("eobp", Feobp
, Seobp
, 0, 0, 0,
436 "Return T if point is at the end of the buffer.\n\
437 If the buffer is narrowed, this means the end of the narrowed part.")
445 DEFUN ("bolp", Fbolp
, Sbolp
, 0, 0, 0,
446 "Return T if point is at the beginning of a line.")
449 if (point
== BEGV
|| FETCH_CHAR (point
- 1) == '\n')
454 DEFUN ("eolp", Feolp
, Seolp
, 0, 0, 0,
455 "Return T if point is at the end of a line.\n\
456 `End of a line' includes point being at the end of the buffer.")
459 if (point
== ZV
|| FETCH_CHAR (point
) == '\n')
464 DEFUN ("char-after", Fchar_after
, Schar_after
, 1, 1, 0,
465 "Return character in current buffer at position POS.\n\
466 POS is an integer or a buffer pointer.\n\
467 If POS is out of range, the value is nil.")
471 register Lisp_Object val
;
474 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
477 if (n
< BEGV
|| n
>= ZV
) return Qnil
;
479 XFASTINT (val
) = FETCH_CHAR (n
);
483 DEFUN ("user-login-name", Fuser_login_name
, Suser_login_name
, 0, 0, 0,
484 "Return the name under which the user logged in, as a string.\n\
485 This is based on the effective uid, not the real uid.\n\
486 Also, if the environment variable USER or LOGNAME is set,\n\
487 that determines the value of this function.")
493 DEFUN ("user-real-login-name", Fuser_real_login_name
, Suser_real_login_name
,
495 "Return the name of the user's real uid, as a string.\n\
496 Differs from `user-login-name' when running under `su'.")
499 return Vuser_real_name
;
502 DEFUN ("user-uid", Fuser_uid
, Suser_uid
, 0, 0, 0,
503 "Return the effective uid of Emacs, as an integer.")
506 return make_number (geteuid ());
509 DEFUN ("user-real-uid", Fuser_real_uid
, Suser_real_uid
, 0, 0, 0,
510 "Return the real uid of Emacs, as an integer.")
513 return make_number (getuid ());
516 DEFUN ("user-full-name", Fuser_full_name
, Suser_full_name
, 0, 0, 0,
517 "Return the full name of the user logged in, as a string.")
520 return Vuser_full_name
;
523 DEFUN ("system-name", Fsystem_name
, Ssystem_name
, 0, 0, 0,
524 "Return the name of the machine you are running on, as a string.")
530 DEFUN ("emacs-pid", Femacs_pid
, Semacs_pid
, 0, 0, 0,
531 "Return the process ID of Emacs, as an integer.")
534 return make_number (getpid ());
537 DEFUN ("current-time", Fcurrent_time
, Scurrent_time
, 0, 0, 0,
538 "Return the current time, as the number of seconds since 12:00 AM January 1970.\n\
539 The time is returned as a list of three integers. The first has the\n\
540 most significant 16 bits of the seconds, while the second has the\n\
541 least significant 16 bits. The third integer gives the microsecond\n\
544 The microsecond count is zero on systems that do not provide\n\
545 resolution finer than a second.")
549 Lisp_Object result
[3];
552 XSET (result
[0], Lisp_Int
, (EMACS_SECS (t
) >> 16) & 0xffff);
553 XSET (result
[1], Lisp_Int
, (EMACS_SECS (t
) >> 0) & 0xffff);
554 XSET (result
[2], Lisp_Int
, EMACS_USECS (t
));
556 return Flist (3, result
);
561 lisp_time_argument (specified_time
, result
)
562 Lisp_Object specified_time
;
565 if (NILP (specified_time
))
566 return time (result
) != -1;
569 Lisp_Object high
, low
;
570 high
= Fcar (specified_time
);
571 CHECK_NUMBER (high
, 0);
572 low
= Fcdr (specified_time
);
573 if (XTYPE (low
) == Lisp_Cons
)
575 CHECK_NUMBER (low
, 0);
576 *result
= (XINT (high
) << 16) + (XINT (low
) & 0xffff);
577 return *result
>> 16 == XINT (high
);
581 DEFUN ("current-time-string", Fcurrent_time_string
, Scurrent_time_string
, 0, 1, 0,
582 "Return the current time, as a human-readable string.\n\
583 Programs can use this function to decode a time,\n\
584 since the number of columns in each field is fixed.\n\
585 The format is `Sun Sep 16 01:03:52 1973'.\n\
586 If an argument is given, it specifies a time to format\n\
587 instead of the current time. The argument should have the form:\n\
590 (HIGH LOW . IGNORED).\n\
591 Thus, you can use times obtained from `current-time'\n\
592 and from `file-attributes'.")
594 Lisp_Object specified_time
;
600 if (! lisp_time_argument (specified_time
, &value
))
602 tem
= (char *) ctime (&value
);
604 strncpy (buf
, tem
, 24);
607 return build_string (buf
);
610 #define TM_YEAR_ORIGIN 1900
612 /* Yield A - B, measured in seconds. */
617 int ay
= a
->tm_year
+ (TM_YEAR_ORIGIN
- 1);
618 int by
= b
->tm_year
+ (TM_YEAR_ORIGIN
- 1);
623 /* difference in day of year */
624 a
->tm_yday
- b
->tm_yday
625 /* + intervening leap days */
626 + ((ay
>> 2) - (by
>> 2))
628 + ((ay
/100 >> 2) - (by
/100 >> 2))
629 /* + difference in years * 365 */
630 + (long)(ay
-by
) * 365
631 )*24 + (a
->tm_hour
- b
->tm_hour
)
632 )*60 + (a
->tm_min
- b
->tm_min
)
633 )*60 + (a
->tm_sec
- b
->tm_sec
);
636 DEFUN ("current-time-zone", Fcurrent_time_zone
, Scurrent_time_zone
, 0, 1, 0,
637 "Return the offset and name for the local time zone.\n\
638 This returns a list of the form (OFFSET NAME).\n\
639 OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).\n\
640 A negative value means west of Greenwich.\n\
641 NAME is a string giving the name of the time zone.\n\
642 If an argument is given, it specifies when the time zone offset is determined\n\
643 instead of using the current time. The argument should have the form:\n\
646 (HIGH LOW . IGNORED).\n\
647 Thus, you can use times obtained from `current-time'\n\
648 and from `file-attributes'.\n\
650 Some operating systems cannot provide all this information to Emacs;\n\
651 in this case, `current-time-zone' returns a list containing nil for\n\
652 the data it can't find.")
654 Lisp_Object specified_time
;
659 if (lisp_time_argument (specified_time
, &value
)
660 && (t
= gmtime (&value
)) != 0)
666 gmt
= *t
; /* Make a copy, in case localtime modifies *t. */
667 t
= localtime (&value
);
668 offset
= difftm (t
, &gmt
);
673 #else /* not HAVE_TM_ZONE */
675 if (t
->tm_isdst
== 0 || t
->tm_isdst
== 1)
676 s
= tzname
[t
->tm_isdst
];
678 #endif /* not HAVE_TM_ZONE */
681 /* No local time zone name is available; use "+-NNNN" instead. */
682 int am
= (offset
< 0 ? -offset
: offset
) / 60;
683 sprintf (buf
, "%c%02d%02d", (offset
< 0 ? '-' : '+'), am
/60, am
%60);
686 return Fcons (make_number (offset
), Fcons (build_string (s
), Qnil
));
689 return Fmake_list (2, Qnil
);
701 /* Callers passing one argument to Finsert need not gcpro the
702 argument "array", since the only element of the array will
703 not be used after calling insert or insert_from_string, so
704 we don't care if it gets trashed. */
706 DEFUN ("insert", Finsert
, Sinsert
, 0, MANY
, 0,
707 "Insert the arguments, either strings or characters, at point.\n\
708 Point moves forward so that it ends up after the inserted text.\n\
709 Any other markers at the point of insertion remain before the text.")
712 register Lisp_Object
*args
;
715 register Lisp_Object tem
;
718 for (argnum
= 0; argnum
< nargs
; argnum
++)
722 if (XTYPE (tem
) == Lisp_Int
)
727 else if (XTYPE (tem
) == Lisp_String
)
729 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
733 tem
= wrong_type_argument (Qchar_or_string_p
, tem
);
741 DEFUN ("insert-and-inherit", Finsert_and_inherit
, Sinsert_and_inherit
,
743 "Insert the arguments at point, inheriting properties from adjoining text.\n\
744 Point moves forward so that it ends up after the inserted text.\n\
745 Any other markers at the point of insertion remain before the text.")
748 register Lisp_Object
*args
;
751 register Lisp_Object tem
;
754 for (argnum
= 0; argnum
< nargs
; argnum
++)
758 if (XTYPE (tem
) == Lisp_Int
)
763 else if (XTYPE (tem
) == Lisp_String
)
765 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 1);
769 tem
= wrong_type_argument (Qchar_or_string_p
, tem
);
777 DEFUN ("insert-before-markers", Finsert_before_markers
, Sinsert_before_markers
, 0, MANY
, 0,
778 "Insert strings or characters at point, relocating markers after the text.\n\
779 Point moves forward so that it ends up after the inserted text.\n\
780 Any other markers at the point of insertion also end up after the text.")
783 register Lisp_Object
*args
;
786 register Lisp_Object tem
;
789 for (argnum
= 0; argnum
< nargs
; argnum
++)
793 if (XTYPE (tem
) == Lisp_Int
)
796 insert_before_markers (str
, 1);
798 else if (XTYPE (tem
) == Lisp_String
)
800 insert_from_string_before_markers (tem
, 0, XSTRING (tem
)->size
, 0);
804 tem
= wrong_type_argument (Qchar_or_string_p
, tem
);
812 DEFUN ("insert-before-markers-and-inherit",
813 Finsert_and_inherit_before_markers
, Sinsert_and_inherit_before_markers
,
815 "Insert text at point, relocating markers and inheriting properties.\n\
816 Point moves forward so that it ends up after the inserted text.\n\
817 Any other markers at the point of insertion also end up after the text.")
820 register Lisp_Object
*args
;
823 register Lisp_Object tem
;
826 for (argnum
= 0; argnum
< nargs
; argnum
++)
830 if (XTYPE (tem
) == Lisp_Int
)
833 insert_before_markers (str
, 1);
835 else if (XTYPE (tem
) == Lisp_String
)
837 insert_from_string_before_markers (tem
, 0, XSTRING (tem
)->size
, 1);
841 tem
= wrong_type_argument (Qchar_or_string_p
, tem
);
849 DEFUN ("insert-char", Finsert_char
, Sinsert_char
, 2, 2, 0,
850 "Insert COUNT (second arg) copies of CHAR (first arg).\n\
851 Point and all markers are affected as in the function `insert'.\n\
852 Both arguments are required.")
854 Lisp_Object chr
, count
;
856 register unsigned char *string
;
860 CHECK_NUMBER (chr
, 0);
861 CHECK_NUMBER (count
, 1);
866 strlen
= min (n
, 256);
867 string
= (unsigned char *) alloca (strlen
);
868 for (i
= 0; i
< strlen
; i
++)
869 string
[i
] = XFASTINT (chr
);
872 insert (string
, strlen
);
881 /* Making strings from buffer contents. */
883 /* Return a Lisp_String containing the text of the current buffer from
884 START to END. If text properties are in use and the current buffer
885 has properties in the range specified, the resulting string will also
888 We don't want to use plain old make_string here, because it calls
889 make_uninit_string, which can cause the buffer arena to be
890 compacted. make_string has no way of knowing that the data has
891 been moved, and thus copies the wrong data into the string. This
892 doesn't effect most of the other users of make_string, so it should
893 be left as is. But we should use this function when conjuring
894 buffer substrings. */
897 make_buffer_string (start
, end
)
900 Lisp_Object result
, tem
;
902 if (start
< GPT
&& GPT
< end
)
905 result
= make_uninit_string (end
- start
);
906 bcopy (&FETCH_CHAR (start
), XSTRING (result
)->data
, end
- start
);
908 tem
= Fnext_property_change (make_number (start
), Qnil
, make_number (end
));
910 #ifdef USE_TEXT_PROPERTIES
911 if (XINT (tem
) != end
)
912 copy_intervals_to_string (result
, current_buffer
, start
, end
- start
);
918 DEFUN ("buffer-substring", Fbuffer_substring
, Sbuffer_substring
, 2, 2, 0,
919 "Return the contents of part of the current buffer as a string.\n\
920 The two arguments START and END are character positions;\n\
921 they can be in either order.")
925 register int beg
, end
;
927 validate_region (&b
, &e
);
931 return make_buffer_string (beg
, end
);
934 DEFUN ("buffer-string", Fbuffer_string
, Sbuffer_string
, 0, 0, 0,
935 "Return the contents of the current buffer as a string.")
938 return make_buffer_string (BEGV
, ZV
);
941 DEFUN ("insert-buffer-substring", Finsert_buffer_substring
, Sinsert_buffer_substring
,
943 "Insert before point a substring of the contents of buffer BUFFER.\n\
944 BUFFER may be a buffer or a buffer name.\n\
945 Arguments START and END are character numbers specifying the substring.\n\
946 They default to the beginning and the end of BUFFER.")
948 Lisp_Object buf
, b
, e
;
950 register int beg
, end
, temp
, len
, opoint
, start
;
951 register struct buffer
*bp
;
954 buffer
= Fget_buffer (buf
);
957 bp
= XBUFFER (buffer
);
963 CHECK_NUMBER_COERCE_MARKER (b
, 0);
970 CHECK_NUMBER_COERCE_MARKER (e
, 1);
975 temp
= beg
, beg
= end
, end
= temp
;
977 /* Move the gap or create enough gap in the current buffer. */
981 if (GAP_SIZE
< end
- beg
)
982 make_gap (end
- beg
- GAP_SIZE
);
988 if (!(BUF_BEGV (bp
) <= beg
990 && end
<= BUF_ZV (bp
)))
991 args_out_of_range (b
, e
);
993 /* Now the actual insertion will not do any gap motion,
994 so it matters not if BUF is the current buffer. */
995 if (beg
< BUF_GPT (bp
))
997 insert (BUF_CHAR_ADDRESS (bp
, beg
), min (end
, BUF_GPT (bp
)) - beg
);
998 beg
= min (end
, BUF_GPT (bp
));
1001 insert (BUF_CHAR_ADDRESS (bp
, beg
), end
- beg
);
1003 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
1004 graft_intervals_into_buffer (copy_intervals (bp
->intervals
, start
, len
),
1005 opoint
, len
, current_buffer
, 0);
1010 DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings
, Scompare_buffer_substrings
,
1012 "Compare two substrings of two buffers; return result as number.\n\
1013 the value is -N if first string is less after N-1 chars,\n\
1014 +N if first string is greater after N-1 chars, or 0 if strings match.\n\
1015 Each substring is represented as three arguments: BUFFER, START and END.\n\
1016 That makes six args in all, three for each substring.\n\n\
1017 The value of `case-fold-search' in the current buffer\n\
1018 determines whether case is significant or ignored.")
1019 (buffer1
, start1
, end1
, buffer2
, start2
, end2
)
1020 Lisp_Object buffer1
, start1
, end1
, buffer2
, start2
, end2
;
1022 register int begp1
, endp1
, begp2
, endp2
, temp
, len1
, len2
, length
, i
;
1023 register struct buffer
*bp1
, *bp2
;
1024 register unsigned char *trt
1025 = (!NILP (current_buffer
->case_fold_search
)
1026 ? XSTRING (current_buffer
->case_canon_table
)->data
: 0);
1028 /* Find the first buffer and its substring. */
1031 bp1
= current_buffer
;
1035 buf1
= Fget_buffer (buffer1
);
1038 bp1
= XBUFFER (buf1
);
1042 begp1
= BUF_BEGV (bp1
);
1045 CHECK_NUMBER_COERCE_MARKER (start1
, 1);
1046 begp1
= XINT (start1
);
1049 endp1
= BUF_ZV (bp1
);
1052 CHECK_NUMBER_COERCE_MARKER (end1
, 2);
1053 endp1
= XINT (end1
);
1057 temp
= begp1
, begp1
= endp1
, endp1
= temp
;
1059 if (!(BUF_BEGV (bp1
) <= begp1
1061 && endp1
<= BUF_ZV (bp1
)))
1062 args_out_of_range (start1
, end1
);
1064 /* Likewise for second substring. */
1067 bp2
= current_buffer
;
1071 buf2
= Fget_buffer (buffer2
);
1074 bp2
= XBUFFER (buffer2
);
1078 begp2
= BUF_BEGV (bp2
);
1081 CHECK_NUMBER_COERCE_MARKER (start2
, 4);
1082 begp2
= XINT (start2
);
1085 endp2
= BUF_ZV (bp2
);
1088 CHECK_NUMBER_COERCE_MARKER (end2
, 5);
1089 endp2
= XINT (end2
);
1093 temp
= begp2
, begp2
= endp2
, endp2
= temp
;
1095 if (!(BUF_BEGV (bp2
) <= begp2
1097 && endp2
<= BUF_ZV (bp2
)))
1098 args_out_of_range (start2
, end2
);
1100 len1
= endp1
- begp1
;
1101 len2
= endp2
- begp2
;
1106 for (i
= 0; i
< length
; i
++)
1108 int c1
= *BUF_CHAR_ADDRESS (bp1
, begp1
+ i
);
1109 int c2
= *BUF_CHAR_ADDRESS (bp2
, begp2
+ i
);
1116 return make_number (- 1 - i
);
1118 return make_number (i
+ 1);
1121 /* The strings match as far as they go.
1122 If one is shorter, that one is less. */
1124 return make_number (length
+ 1);
1125 else if (length
< len2
)
1126 return make_number (- length
- 1);
1128 /* Same length too => they are equal. */
1129 return make_number (0);
1132 DEFUN ("subst-char-in-region", Fsubst_char_in_region
,
1133 Ssubst_char_in_region
, 4, 5, 0,
1134 "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
1135 If optional arg NOUNDO is non-nil, don't record this change for undo\n\
1136 and don't mark the buffer as really changed.")
1137 (start
, end
, fromchar
, tochar
, noundo
)
1138 Lisp_Object start
, end
, fromchar
, tochar
, noundo
;
1140 register int pos
, stop
, look
;
1143 validate_region (&start
, &end
);
1144 CHECK_NUMBER (fromchar
, 2);
1145 CHECK_NUMBER (tochar
, 3);
1149 look
= XINT (fromchar
);
1153 if (FETCH_CHAR (pos
) == look
)
1157 modify_region (current_buffer
, XINT (start
), stop
);
1159 if (! NILP (noundo
))
1161 if (MODIFF
- 1 == current_buffer
->save_modified
)
1162 current_buffer
->save_modified
++;
1163 if (MODIFF
- 1 == current_buffer
->auto_save_modified
)
1164 current_buffer
->auto_save_modified
++;
1171 record_change (pos
, 1);
1172 FETCH_CHAR (pos
) = XINT (tochar
);
1178 signal_after_change (XINT (start
),
1179 stop
- XINT (start
), stop
- XINT (start
));
1184 DEFUN ("translate-region", Ftranslate_region
, Stranslate_region
, 3, 3, 0,
1185 "From START to END, translate characters according to TABLE.\n\
1186 TABLE is a string; the Nth character in it is the mapping\n\
1187 for the character with code N. Returns the number of characters changed.")
1191 register Lisp_Object table
;
1193 register int pos
, stop
; /* Limits of the region. */
1194 register unsigned char *tt
; /* Trans table. */
1195 register int oc
; /* Old character. */
1196 register int nc
; /* New character. */
1197 int cnt
; /* Number of changes made. */
1198 Lisp_Object z
; /* Return. */
1199 int size
; /* Size of translate table. */
1201 validate_region (&start
, &end
);
1202 CHECK_STRING (table
, 2);
1204 size
= XSTRING (table
)->size
;
1205 tt
= XSTRING (table
)->data
;
1209 modify_region (current_buffer
, pos
, stop
);
1212 for (; pos
< stop
; ++pos
)
1214 oc
= FETCH_CHAR (pos
);
1220 record_change (pos
, 1);
1221 FETCH_CHAR (pos
) = nc
;
1222 signal_after_change (pos
, 1, 1);
1232 DEFUN ("delete-region", Fdelete_region
, Sdelete_region
, 2, 2, "r",
1233 "Delete the text between point and mark.\n\
1234 When called from a program, expects two arguments,\n\
1235 positions (integers or markers) specifying the stretch to be deleted.")
1239 validate_region (&b
, &e
);
1240 del_range (XINT (b
), XINT (e
));
1244 DEFUN ("widen", Fwiden
, Swiden
, 0, 0, "",
1245 "Remove restrictions (narrowing) from current buffer.\n\
1246 This allows the buffer's full text to be seen and edited.")
1250 SET_BUF_ZV (current_buffer
, Z
);
1252 /* Changing the buffer bounds invalidates any recorded current column. */
1253 invalidate_current_column ();
1257 DEFUN ("narrow-to-region", Fnarrow_to_region
, Snarrow_to_region
, 2, 2, "r",
1258 "Restrict editing in this buffer to the current region.\n\
1259 The rest of the text becomes temporarily invisible and untouchable\n\
1260 but is not deleted; if you save the buffer in a file, the invisible\n\
1261 text is included in the file. \\[widen] makes all visible again.\n\
1262 See also `save-restriction'.\n\
1264 When calling from a program, pass two arguments; positions (integers\n\
1265 or markers) bounding the text that should remain visible.")
1267 register Lisp_Object b
, e
;
1271 CHECK_NUMBER_COERCE_MARKER (b
, 0);
1272 CHECK_NUMBER_COERCE_MARKER (e
, 1);
1274 if (XINT (b
) > XINT (e
))
1281 if (!(BEG
<= XINT (b
) && XINT (b
) <= XINT (e
) && XINT (e
) <= Z
))
1282 args_out_of_range (b
, e
);
1284 BEGV
= XFASTINT (b
);
1285 SET_BUF_ZV (current_buffer
, XFASTINT (e
));
1286 if (point
< XFASTINT (b
))
1287 SET_PT (XFASTINT (b
));
1288 if (point
> XFASTINT (e
))
1289 SET_PT (XFASTINT (e
));
1291 /* Changing the buffer bounds invalidates any recorded current column. */
1292 invalidate_current_column ();
1297 save_restriction_save ()
1299 register Lisp_Object bottom
, top
;
1300 /* Note: I tried using markers here, but it does not win
1301 because insertion at the end of the saved region
1302 does not advance mh and is considered "outside" the saved region. */
1303 XFASTINT (bottom
) = BEGV
- BEG
;
1304 XFASTINT (top
) = Z
- ZV
;
1306 return Fcons (Fcurrent_buffer (), Fcons (bottom
, top
));
1310 save_restriction_restore (data
)
1313 register struct buffer
*buf
;
1314 register int newhead
, newtail
;
1315 register Lisp_Object tem
;
1317 buf
= XBUFFER (XCONS (data
)->car
);
1319 data
= XCONS (data
)->cdr
;
1321 tem
= XCONS (data
)->car
;
1322 newhead
= XINT (tem
);
1323 tem
= XCONS (data
)->cdr
;
1324 newtail
= XINT (tem
);
1325 if (newhead
+ newtail
> BUF_Z (buf
) - BUF_BEG (buf
))
1330 BUF_BEGV (buf
) = BUF_BEG (buf
) + newhead
;
1331 SET_BUF_ZV (buf
, BUF_Z (buf
) - newtail
);
1334 /* If point is outside the new visible range, move it inside. */
1336 clip_to_bounds (BUF_BEGV (buf
), BUF_PT (buf
), BUF_ZV (buf
)));
1341 DEFUN ("save-restriction", Fsave_restriction
, Ssave_restriction
, 0, UNEVALLED
, 0,
1342 "Execute BODY, saving and restoring current buffer's restrictions.\n\
1343 The buffer's restrictions make parts of the beginning and end invisible.\n\
1344 \(They are set up with `narrow-to-region' and eliminated with `widen'.)\n\
1345 This special form, `save-restriction', saves the current buffer's restrictions\n\
1346 when it is entered, and restores them when it is exited.\n\
1347 So any `narrow-to-region' within BODY lasts only until the end of the form.\n\
1348 The old restrictions settings are restored\n\
1349 even in case of abnormal exit (throw or error).\n\
1351 The value returned is the value of the last form in BODY.\n\
1353 `save-restriction' can get confused if, within the BODY, you widen\n\
1354 and then make changes outside the area within the saved restrictions.\n\
1356 Note: if you are using both `save-excursion' and `save-restriction',\n\
1357 use `save-excursion' outermost:\n\
1358 (save-excursion (save-restriction ...))")
1362 register Lisp_Object val
;
1363 int count
= specpdl_ptr
- specpdl
;
1365 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
1366 val
= Fprogn (body
);
1367 return unbind_to (count
, val
);
1370 DEFUN ("message", Fmessage
, Smessage
, 1, MANY
, 0,
1371 "Print a one-line message at the bottom of the screen.\n\
1372 The first argument is a control string.\n\
1373 It may contain %s or %d or %c to print successive following arguments.\n\
1374 %s means print an argument as a string, %d means print as number in decimal,\n\
1375 %c means print a number as a single character.\n\
1376 The argument used by %s must be a string or a symbol;\n\
1377 the argument used by %d or %c must be a number.\n\
1378 If the first argument is nil, clear any existing message; let the\n\
1379 minibuffer contents show.")
1391 register Lisp_Object val
;
1392 val
= Fformat (nargs
, args
);
1393 message2 (XSTRING (val
)->data
, XSTRING (val
)->size
);
1398 DEFUN ("format", Fformat
, Sformat
, 1, MANY
, 0,
1399 "Format a string out of a control-string and arguments.\n\
1400 The first argument is a control string.\n\
1401 The other arguments are substituted into it to make the result, a string.\n\
1402 It may contain %-sequences meaning to substitute the next argument.\n\
1403 %s means print a string argument. Actually, prints any object, with `princ'.\n\
1404 %d means print as number in decimal (%o octal, %x hex).\n\
1405 %c means print a number as a single character.\n\
1406 %S means print any object as an s-expression (using prin1).\n\
1407 The argument used for %d, %o, %x or %c must be a number.\n\
1408 Use %% to put a single % into the output.")
1411 register Lisp_Object
*args
;
1413 register int n
; /* The number of the next arg to substitute */
1414 register int total
= 5; /* An estimate of the final length */
1416 register unsigned char *format
, *end
;
1418 extern char *index ();
1419 /* It should not be necessary to GCPRO ARGS, because
1420 the caller in the interpreter should take care of that. */
1422 CHECK_STRING (args
[0], 0);
1423 format
= XSTRING (args
[0])->data
;
1424 end
= format
+ XSTRING (args
[0])->size
;
1427 while (format
!= end
)
1428 if (*format
++ == '%')
1432 /* Process a numeric arg and skip it. */
1433 minlen
= atoi (format
);
1438 while ((*format
>= '0' && *format
<= '9')
1439 || *format
== '-' || *format
== ' ' || *format
== '.')
1444 else if (++n
>= nargs
)
1446 else if (*format
== 'S')
1448 /* For `S', prin1 the argument and then treat like a string. */
1449 register Lisp_Object tem
;
1450 tem
= Fprin1_to_string (args
[n
], Qnil
);
1454 else if (XTYPE (args
[n
]) == Lisp_Symbol
)
1456 XSET (args
[n
], Lisp_String
, XSYMBOL (args
[n
])->name
);
1459 else if (XTYPE (args
[n
]) == Lisp_String
)
1462 total
+= XSTRING (args
[n
])->size
;
1464 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
1465 else if (XTYPE (args
[n
]) == Lisp_Int
&& *format
!= 's')
1467 #ifdef LISP_FLOAT_TYPE
1468 /* The following loop assumes the Lisp type indicates
1469 the proper way to pass the argument.
1470 So make sure we have a flonum if the argument should
1472 if (*format
== 'e' || *format
== 'f' || *format
== 'g')
1473 args
[n
] = Ffloat (args
[n
]);
1477 #ifdef LISP_FLOAT_TYPE
1478 else if (XTYPE (args
[n
]) == Lisp_Float
&& *format
!= 's')
1480 if (! (*format
== 'e' || *format
== 'f' || *format
== 'g'))
1481 args
[n
] = Ftruncate (args
[n
]);
1487 /* Anything but a string, convert to a string using princ. */
1488 register Lisp_Object tem
;
1489 tem
= Fprin1_to_string (args
[n
], Qt
);
1496 register int nstrings
= n
+ 1;
1498 /* Allocate twice as many strings as we have %-escapes; floats occupy
1499 two slots, and we're not sure how many of those we have. */
1500 register unsigned char **strings
1501 = (unsigned char **) alloca (2 * nstrings
* sizeof (unsigned char *));
1505 for (n
= 0; n
< nstrings
; n
++)
1508 strings
[i
++] = (unsigned char *) "";
1509 else if (XTYPE (args
[n
]) == Lisp_Int
)
1510 /* We checked above that the corresponding format effector
1511 isn't %s, which would cause MPV. */
1512 strings
[i
++] = (unsigned char *) XINT (args
[n
]);
1513 #ifdef LISP_FLOAT_TYPE
1514 else if (XTYPE (args
[n
]) == Lisp_Float
)
1516 union { double d
; int half
[2]; } u
;
1518 u
.d
= XFLOAT (args
[n
])->data
;
1519 strings
[i
++] = (unsigned char *) u
.half
[0];
1520 strings
[i
++] = (unsigned char *) u
.half
[1];
1524 strings
[i
++] = XSTRING (args
[n
])->data
;
1527 /* Format it in bigger and bigger buf's until it all fits. */
1530 buf
= (char *) alloca (total
+ 1);
1533 length
= doprnt (buf
, total
+ 1, strings
[0], end
, i
-1, strings
+ 1);
1534 if (buf
[total
- 1] == 0)
1542 return make_string (buf
, length
);
1548 format1 (string1
, arg0
, arg1
, arg2
, arg3
, arg4
)
1549 int arg0
, arg1
, arg2
, arg3
, arg4
;
1563 doprnt (buf
, sizeof buf
, string1
, 0, 5, args
);
1565 doprnt (buf
, sizeof buf
, string1
, 0, 5, &string1
+ 1);
1567 return build_string (buf
);
1570 DEFUN ("char-equal", Fchar_equal
, Schar_equal
, 2, 2, 0,
1571 "Return t if two characters match, optionally ignoring case.\n\
1572 Both arguments must be characters (i.e. integers).\n\
1573 Case is ignored if `case-fold-search' is non-nil in the current buffer.")
1575 register Lisp_Object c1
, c2
;
1577 unsigned char *downcase
= DOWNCASE_TABLE
;
1578 CHECK_NUMBER (c1
, 0);
1579 CHECK_NUMBER (c2
, 1);
1581 if (!NILP (current_buffer
->case_fold_search
)
1582 ? (downcase
[0xff & XFASTINT (c1
)] == downcase
[0xff & XFASTINT (c2
)]
1583 && (XFASTINT (c1
) & ~0xff) == (XFASTINT (c2
) & ~0xff))
1584 : XINT (c1
) == XINT (c2
))
1593 staticpro (&Vuser_name
);
1594 staticpro (&Vuser_full_name
);
1595 staticpro (&Vuser_real_name
);
1596 staticpro (&Vsystem_name
);
1598 defsubr (&Schar_equal
);
1599 defsubr (&Sgoto_char
);
1600 defsubr (&Sstring_to_char
);
1601 defsubr (&Schar_to_string
);
1602 defsubr (&Sbuffer_substring
);
1603 defsubr (&Sbuffer_string
);
1605 defsubr (&Spoint_marker
);
1606 defsubr (&Smark_marker
);
1608 defsubr (&Sregion_beginning
);
1609 defsubr (&Sregion_end
);
1610 /* defsubr (&Smark); */
1611 /* defsubr (&Sset_mark); */
1612 defsubr (&Ssave_excursion
);
1614 defsubr (&Sbufsize
);
1615 defsubr (&Spoint_max
);
1616 defsubr (&Spoint_min
);
1617 defsubr (&Spoint_min_marker
);
1618 defsubr (&Spoint_max_marker
);
1624 defsubr (&Sfollowing_char
);
1625 defsubr (&Sprevious_char
);
1626 defsubr (&Schar_after
);
1628 defsubr (&Sinsert_before_markers
);
1629 defsubr (&Sinsert_and_inherit
);
1630 defsubr (&Sinsert_and_inherit_before_markers
);
1631 defsubr (&Sinsert_char
);
1633 defsubr (&Suser_login_name
);
1634 defsubr (&Suser_real_login_name
);
1635 defsubr (&Suser_uid
);
1636 defsubr (&Suser_real_uid
);
1637 defsubr (&Suser_full_name
);
1638 defsubr (&Semacs_pid
);
1639 defsubr (&Scurrent_time
);
1640 defsubr (&Scurrent_time_string
);
1641 defsubr (&Scurrent_time_zone
);
1642 defsubr (&Ssystem_name
);
1643 defsubr (&Smessage
);
1646 defsubr (&Sinsert_buffer_substring
);
1647 defsubr (&Scompare_buffer_substrings
);
1648 defsubr (&Ssubst_char_in_region
);
1649 defsubr (&Stranslate_region
);
1650 defsubr (&Sdelete_region
);
1652 defsubr (&Snarrow_to_region
);
1653 defsubr (&Ssave_restriction
);