(run-at-time): Use a pipe to talk to the timer process.
[bpt/emacs.git] / src / editfns.c
CommitLineData
35692fe0 1/* Lisp functions pertaining to editing.
956ace37 2 Copyright (C) 1985, 1986, 1987, 1989, 1992 Free Software Foundation, Inc.
35692fe0
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 1, or (at your option)
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20
21#include "config.h"
bfb61299
JB
22
23#ifdef VMS
956ace37 24#include "vms-pwd.h"
bfb61299 25#else
35692fe0 26#include <pwd.h>
bfb61299
JB
27#endif
28
35692fe0 29#include "lisp.h"
74d6d8c5 30#include "intervals.h"
35692fe0
JB
31#include "buffer.h"
32#include "window.h"
33
956ace37 34#include "systime.h"
35692fe0
JB
35
36#define min(a, b) ((a) < (b) ? (a) : (b))
37#define max(a, b) ((a) > (b) ? (a) : (b))
38
39/* Some static data, and a function to initialize it for each run */
40
41Lisp_Object Vsystem_name;
42Lisp_Object Vuser_real_name; /* login name of current user ID */
43Lisp_Object Vuser_full_name; /* full name of current user */
44Lisp_Object Vuser_name; /* user name from USER or LOGNAME. */
45
46void
47init_editfns ()
48{
52b14ac0 49 char *user_name;
35692fe0
JB
50 register unsigned char *p, *q, *r;
51 struct passwd *pw; /* password entry for the current user */
52 extern char *index ();
53 Lisp_Object tem;
54
55 /* Set up system_name even when dumping. */
56
57 Vsystem_name = build_string (get_system_name ());
58 p = XSTRING (Vsystem_name)->data;
59 while (*p)
60 {
61 if (*p == ' ' || *p == '\t')
62 *p = '-';
63 p++;
64 }
65
66#ifndef CANNOT_DUMP
67 /* Don't bother with this on initial start when just dumping out */
68 if (!initialized)
69 return;
70#endif /* not CANNOT_DUMP */
71
72 pw = (struct passwd *) getpwuid (getuid ());
73 Vuser_real_name = build_string (pw ? pw->pw_name : "unknown");
74
52b14ac0
JB
75 /* Get the effective user name, by consulting environment variables,
76 or the effective uid if those are unset. */
77 user_name = (char *) getenv ("USER");
35692fe0 78 if (!user_name)
52b14ac0
JB
79 user_name = (char *) getenv ("LOGNAME");
80 if (!user_name)
81 {
82 pw = (struct passwd *) getpwuid (geteuid ());
83 user_name = (char *) (pw ? pw->pw_name : "unknown");
84 }
85 Vuser_name = build_string (user_name);
35692fe0 86
52b14ac0
JB
87 /* If the user name claimed in the environment vars differs from
88 the real uid, use the claimed name to find the full name. */
35692fe0 89 tem = Fstring_equal (Vuser_name, Vuser_real_name);
56a98455 90 if (NILP (tem))
52b14ac0 91 pw = (struct passwd *) getpwnam (XSTRING (Vuser_name)->data);
35692fe0
JB
92
93 p = (unsigned char *) (pw ? USER_FULL_NAME : "unknown");
94 q = (unsigned char *) index (p, ',');
95 Vuser_full_name = make_string (p, q ? q - p : strlen (p));
96
97#ifdef AMPERSAND_FULL_NAME
98 p = XSTRING (Vuser_full_name)->data;
99 q = (char *) index (p, '&');
100 /* Substitute the login name for the &, upcasing the first character. */
101 if (q)
102 {
103 r = (char *) alloca (strlen (p) + XSTRING (Vuser_name)->size + 1);
104 bcopy (p, r, q - p);
105 r[q - p] = 0;
52b14ac0 106 strcat (r, XSTRING (Vuser_name)->data);
35692fe0
JB
107 r[q - p] = UPCASE (r[q - p]);
108 strcat (r, q + 1);
109 Vuser_full_name = build_string (r);
110 }
111#endif /* AMPERSAND_FULL_NAME */
112}
113\f
114DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
115 "Convert arg CHAR to a one-character string containing that character.")
116 (n)
117 Lisp_Object n;
118{
119 char c;
120 CHECK_NUMBER (n, 0);
121
122 c = XINT (n);
123 return make_string (&c, 1);
124}
125
126DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
127 "Convert arg STRING to a character, the first character of that string.")
128 (str)
129 register Lisp_Object str;
130{
131 register Lisp_Object val;
132 register struct Lisp_String *p;
133 CHECK_STRING (str, 0);
134
135 p = XSTRING (str);
136 if (p->size)
137 XFASTINT (val) = ((unsigned char *) p->data)[0];
138 else
139 XFASTINT (val) = 0;
140 return val;
141}
142\f
143static Lisp_Object
144buildmark (val)
145 int val;
146{
147 register Lisp_Object mark;
148 mark = Fmake_marker ();
149 Fset_marker (mark, make_number (val), Qnil);
150 return mark;
151}
152
153DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
154 "Return value of point, as an integer.\n\
155Beginning of buffer is position (point-min)")
156 ()
157{
158 Lisp_Object temp;
159 XFASTINT (temp) = point;
160 return temp;
161}
162
163DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
164 "Return value of point, as a marker object.")
165 ()
166{
167 return buildmark (point);
168}
169
170int
171clip_to_bounds (lower, num, upper)
172 int lower, num, upper;
173{
174 if (num < lower)
175 return lower;
176 else if (num > upper)
177 return upper;
178 else
179 return num;
180}
181
182DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
183 "Set point to POSITION, a number or marker.\n\
184Beginning of buffer is position (point-min), end is (point-max).")
185 (n)
186 register Lisp_Object n;
187{
188 CHECK_NUMBER_COERCE_MARKER (n, 0);
189
190 SET_PT (clip_to_bounds (BEGV, XINT (n), ZV));
191 return n;
192}
193
194static Lisp_Object
195region_limit (beginningp)
196 int beginningp;
197{
198 register Lisp_Object m;
199 m = Fmarker_position (current_buffer->mark);
56a98455 200 if (NILP (m)) error ("There is no region now");
35692fe0
JB
201 if ((point < XFASTINT (m)) == beginningp)
202 return (make_number (point));
203 else
204 return (m);
205}
206
207DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
208 "Return position of beginning of region, as an integer.")
209 ()
210{
211 return (region_limit (1));
212}
213
214DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
215 "Return position of end of region, as an integer.")
216 ()
217{
218 return (region_limit (0));
219}
220
221#if 0 /* now in lisp code */
222DEFUN ("mark", Fmark, Smark, 0, 0, 0,
223 "Return this buffer's mark value as integer, or nil if no mark.\n\
224If you are using this in an editing command, you are most likely making\n\
225a mistake; see the documentation of `set-mark'.")
226 ()
227{
228 return Fmarker_position (current_buffer->mark);
229}
230#endif /* commented out code */
231
232DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
233 "Return this buffer's mark, as a marker object.\n\
234Watch out! Moving this marker changes the mark position.\n\
235If you set the marker not to point anywhere, the buffer will have no mark.")
236 ()
237{
238 return current_buffer->mark;
239}
240
241#if 0 /* this is now in lisp code */
242DEFUN ("set-mark", Fset_mark, Sset_mark, 1, 1, 0,
243 "Set this buffer's mark to POS. Don't use this function!\n\
244That is to say, don't use this function unless you want\n\
245the user to see that the mark has moved, and you want the previous\n\
246mark position to be lost.\n\
247\n\
248Normally, when a new mark is set, the old one should go on the stack.\n\
249This is why most applications should use push-mark, not set-mark.\n\
250\n\
251Novice programmers often try to use the mark for the wrong purposes.\n\
252The mark saves a location for the user's convenience.\n\
253Most editing commands should not alter the mark.\n\
254To remember a location for internal use in the Lisp program,\n\
255store it in a Lisp variable. Example:\n\
256\n\
257 (let ((beg (point))) (forward-line 1) (delete-region beg (point))).")
258 (pos)
259 Lisp_Object pos;
260{
56a98455 261 if (NILP (pos))
35692fe0
JB
262 {
263 current_buffer->mark = Qnil;
264 return Qnil;
265 }
266 CHECK_NUMBER_COERCE_MARKER (pos, 0);
267
56a98455 268 if (NILP (current_buffer->mark))
35692fe0
JB
269 current_buffer->mark = Fmake_marker ();
270
271 Fset_marker (current_buffer->mark, pos, Qnil);
272 return pos;
273}
274#endif /* commented-out code */
275
276Lisp_Object
277save_excursion_save ()
278{
0e2c9c70
JB
279 register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
280 == current_buffer);
35692fe0
JB
281
282 return Fcons (Fpoint_marker (),
0e2c9c70
JB
283 Fcons (Fcopy_marker (current_buffer->mark),
284 visible ? Qt : Qnil));
35692fe0
JB
285}
286
287Lisp_Object
288save_excursion_restore (info)
289 register Lisp_Object info;
290{
291 register Lisp_Object tem;
292
293 tem = Fmarker_buffer (Fcar (info));
294 /* If buffer being returned to is now deleted, avoid error */
295 /* Otherwise could get error here while unwinding to top level
296 and crash */
297 /* In that case, Fmarker_buffer returns nil now. */
56a98455 298 if (NILP (tem))
35692fe0
JB
299 return Qnil;
300 Fset_buffer (tem);
301 tem = Fcar (info);
302 Fgoto_char (tem);
303 unchain_marker (tem);
304 tem = Fcar (Fcdr (info));
305 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
306 unchain_marker (tem);
307 tem = Fcdr (Fcdr (info));
0e2c9c70
JB
308 if (!NILP (tem)
309 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
35692fe0
JB
310 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
311 return Qnil;
312}
313
314DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
315 "Save point, mark, and current buffer; execute BODY; restore those things.\n\
316Executes BODY just like `progn'.\n\
317The values of point, mark and the current buffer are restored\n\
318even in case of abnormal exit (throw or error).")
319 (args)
320 Lisp_Object args;
321{
322 register Lisp_Object val;
323 int count = specpdl_ptr - specpdl;
324
325 record_unwind_protect (save_excursion_restore, save_excursion_save ());
326
327 val = Fprogn (args);
328 return unbind_to (count, val);
329}
330\f
331DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 0, 0,
332 "Return the number of characters in the current buffer.")
333 ()
334{
335 Lisp_Object temp;
336 XFASTINT (temp) = Z - BEG;
337 return temp;
338}
339
340DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
341 "Return the minimum permissible value of point in the current buffer.\n\
342This is 1, unless a clipping restriction is in effect.")
343 ()
344{
345 Lisp_Object temp;
346 XFASTINT (temp) = BEGV;
347 return temp;
348}
349
350DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
351 "Return a marker to the minimum permissible value of point in this buffer.\n\
352This is the beginning, unless a clipping restriction is in effect.")
353 ()
354{
355 return buildmark (BEGV);
356}
357
358DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
359 "Return the maximum permissible value of point in the current buffer.\n\
360This is (1+ (buffer-size)), unless a clipping restriction is in effect,\n\
361in which case it is less.")
362 ()
363{
364 Lisp_Object temp;
365 XFASTINT (temp) = ZV;
366 return temp;
367}
368
369DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
370 "Return a marker to the maximum permissible value of point in this buffer.\n\
371This is (1+ (buffer-size)), unless a clipping restriction is in effect,\n\
372in which case it is less.")
373 ()
374{
375 return buildmark (ZV);
376}
377
850a8179
JB
378DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
379 "Return the character following point, as a number.\n\
380At the end of the buffer or accessible region, return 0.")
35692fe0
JB
381 ()
382{
383 Lisp_Object temp;
850a8179
JB
384 if (point >= ZV)
385 XFASTINT (temp) = 0;
386 else
387 XFASTINT (temp) = FETCH_CHAR (point);
35692fe0
JB
388 return temp;
389}
390
850a8179
JB
391DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
392 "Return the character preceding point, as a number.\n\
393At the beginning of the buffer or accessible region, return 0.")
35692fe0
JB
394 ()
395{
396 Lisp_Object temp;
397 if (point <= BEGV)
398 XFASTINT (temp) = 0;
399 else
400 XFASTINT (temp) = FETCH_CHAR (point - 1);
401 return temp;
402}
403
404DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
405 "Return T if point is at the beginning of the buffer.\n\
406If the buffer is narrowed, this means the beginning of the narrowed part.")
407 ()
408{
409 if (point == BEGV)
410 return Qt;
411 return Qnil;
412}
413
414DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
415 "Return T if point is at the end of the buffer.\n\
416If the buffer is narrowed, this means the end of the narrowed part.")
417 ()
418{
419 if (point == ZV)
420 return Qt;
421 return Qnil;
422}
423
424DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
425 "Return T if point is at the beginning of a line.")
426 ()
427{
428 if (point == BEGV || FETCH_CHAR (point - 1) == '\n')
429 return Qt;
430 return Qnil;
431}
432
433DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
434 "Return T if point is at the end of a line.\n\
435`End of a line' includes point being at the end of the buffer.")
436 ()
437{
438 if (point == ZV || FETCH_CHAR (point) == '\n')
439 return Qt;
440 return Qnil;
441}
442
443DEFUN ("char-after", Fchar_after, Schar_after, 1, 1, 0,
444 "Return character in current buffer at position POS.\n\
445POS is an integer or a buffer pointer.\n\
446If POS is out of range, the value is nil.")
447 (pos)
448 Lisp_Object pos;
449{
450 register Lisp_Object val;
451 register int n;
452
453 CHECK_NUMBER_COERCE_MARKER (pos, 0);
454
455 n = XINT (pos);
456 if (n < BEGV || n >= ZV) return Qnil;
457
458 XFASTINT (val) = FETCH_CHAR (n);
459 return val;
460}
461\f
462DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 0, 0,
463 "Return the name under which the user logged in, as a string.\n\
464This is based on the effective uid, not the real uid.\n\
465Also, if the environment variable USER or LOGNAME is set,\n\
466that determines the value of this function.")
467 ()
468{
469 return Vuser_name;
470}
471
472DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
473 0, 0, 0,
474 "Return the name of the user's real uid, as a string.\n\
475Differs from `user-login-name' when running under `su'.")
476 ()
477{
478 return Vuser_real_name;
479}
480
481DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
482 "Return the effective uid of Emacs, as an integer.")
483 ()
484{
485 return make_number (geteuid ());
486}
487
488DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
489 "Return the real uid of Emacs, as an integer.")
490 ()
491{
492 return make_number (getuid ());
493}
494
495DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 0, 0,
496 "Return the full name of the user logged in, as a string.")
497 ()
498{
499 return Vuser_full_name;
500}
501
502DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
503 "Return the name of the machine you are running on, as a string.")
504 ()
505{
506 return Vsystem_name;
507}
508
d940e0e4 509DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
956ace37
JB
510 "Return the current time, as the number of seconds since 12:00 AM January 1970.\n\
511The time is returned as a list of three integers. The first has the\n\
512most significant 16 bits of the seconds, while the second has the\n\
513least significant 16 bits. The third integer gives the microsecond\n\
514count.\n\
515\n\
516The microsecond count is zero on systems that do not provide\n\
517resolution finer than a second.")
d940e0e4
JB
518 ()
519{
956ace37
JB
520 EMACS_TIME t;
521 Lisp_Object result[3];
522
523 EMACS_GET_TIME (t);
524 XSET (result[0], Lisp_Int, (EMACS_SECS (t) >> 16) & 0xffff);
525 XSET (result[1], Lisp_Int, (EMACS_SECS (t) >> 0) & 0xffff);
526 XSET (result[2], Lisp_Int, EMACS_USECS (t));
527
528 return Flist (3, result);
d940e0e4
JB
529}
530\f
531
35692fe0
JB
532DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 0, 0,
533 "Return the current time, as a human-readable string.\n\
534Programs can use it too, since the number of columns in each field is fixed.\n\
535The format is `Sun Sep 16 01:03:52 1973'.\n\
4b93635c 536In a future Emacs version, the time zone may be added at the end.")
35692fe0
JB
537 ()
538{
539 long current_time = time ((long *) 0);
540 char buf[30];
541 register char *tem = (char *) ctime (&current_time);
542
543 strncpy (buf, tem, 24);
544 buf[24] = 0;
545
546 return build_string (buf);
547}
c2662aea
JB
548
549DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 0, 0,
550 "Return the offset, savings state, and names for the current time zone.\n\
551This returns a list of the form (OFFSET SAVINGS-FLAG STANDARD SAVINGS).\n\
552OFFSET is an integer specifying how many minutes east of Greenwich the\n\
553 current time zone is located. A negative value means west of\n\
554 Greenwich. Note that this describes the standard time; If daylight\n\
555 savings time is in effect, it does not affect this value.\n\
556SAVINGS-FLAG is non-nil iff daylight savings time or some other sort\n\
557 of seasonal time adjustment is in effect.\n\
558STANDARD is a string giving the name of the time zone when no seasonal\n\
559 time adjustment is in effect.\n\
560SAVINGS is a string giving the name of the time zone when there is a\n\
561 seasonal time adjustment in effect.\n\
562If the local area does not use a seasonal time adjustment,\n\
563SAVINGS-FLAG will always be nil, and STANDARD and SAVINGS will be the\n\
564same.")
565 ()
566{
567#ifdef EMACS_CURRENT_TIME_ZONE
568 int offset, savings_flag;
569 char standard[11];
570 char savings[11];
571
572 EMACS_CURRENT_TIME_ZONE (&offset, &savings_flag, standard, savings);
573
574 return Fcons (make_number (offset),
575 Fcons ((savings_flag ? Qt : Qnil),
576 Fcons (build_string (standard),
577 Fcons (build_string (savings),
578 Qnil))));
579#else
580 error
581 ("current-time-zone has not been implemented on this operating system.");
582#endif
583}
584
35692fe0
JB
585\f
586void
587insert1 (arg)
588 Lisp_Object arg;
589{
590 Finsert (1, &arg);
591}
592
52b14ac0
JB
593
594/* Callers passing one argument to Finsert need not gcpro the
595 argument "array", since the only element of the array will
596 not be used after calling insert or insert_from_string, so
597 we don't care if it gets trashed. */
598
35692fe0
JB
599DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
600 "Insert the arguments, either strings or characters, at point.\n\
601Point moves forward so that it ends up after the inserted text.\n\
602Any other markers at the point of insertion remain before the text.")
603 (nargs, args)
604 int nargs;
605 register Lisp_Object *args;
606{
607 register int argnum;
608 register Lisp_Object tem;
609 char str[1];
35692fe0
JB
610
611 for (argnum = 0; argnum < nargs; argnum++)
612 {
613 tem = args[argnum];
614 retry:
615 if (XTYPE (tem) == Lisp_Int)
616 {
617 str[0] = XINT (tem);
618 insert (str, 1);
619 }
620 else if (XTYPE (tem) == Lisp_String)
621 {
622 insert_from_string (tem, 0, XSTRING (tem)->size);
623 }
624 else
625 {
626 tem = wrong_type_argument (Qchar_or_string_p, tem);
627 goto retry;
628 }
629 }
630
35692fe0
JB
631 return Qnil;
632}
633
634DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
635 "Insert strings or characters at point, relocating markers after the text.\n\
636Point moves forward so that it ends up after the inserted text.\n\
637Any other markers at the point of insertion also end up after the text.")
638 (nargs, args)
639 int nargs;
640 register Lisp_Object *args;
641{
642 register int argnum;
643 register Lisp_Object tem;
644 char str[1];
35692fe0
JB
645
646 for (argnum = 0; argnum < nargs; argnum++)
647 {
648 tem = args[argnum];
649 retry:
650 if (XTYPE (tem) == Lisp_Int)
651 {
652 str[0] = XINT (tem);
653 insert_before_markers (str, 1);
654 }
655 else if (XTYPE (tem) == Lisp_String)
656 {
657 insert_from_string_before_markers (tem, 0, XSTRING (tem)->size);
658 }
659 else
660 {
661 tem = wrong_type_argument (Qchar_or_string_p, tem);
662 goto retry;
663 }
664 }
665
35692fe0
JB
666 return Qnil;
667}
668\f
669DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 2, 0,
670 "Insert COUNT (second arg) copies of CHAR (first arg).\n\
671Point and all markers are affected as in the function `insert'.\n\
672Both arguments are required.")
673 (chr, count)
674 Lisp_Object chr, count;
675{
676 register unsigned char *string;
677 register int strlen;
678 register int i, n;
679
680 CHECK_NUMBER (chr, 0);
681 CHECK_NUMBER (count, 1);
682
683 n = XINT (count);
684 if (n <= 0)
685 return Qnil;
686 strlen = min (n, 256);
687 string = (unsigned char *) alloca (strlen);
688 for (i = 0; i < strlen; i++)
689 string[i] = XFASTINT (chr);
690 while (n >= strlen)
691 {
692 insert (string, strlen);
693 n -= strlen;
694 }
695 if (n > 0)
696 insert (string, n);
697 return Qnil;
698}
699
700\f
ffd56f97
JB
701/* Making strings from buffer contents. */
702
703/* Return a Lisp_String containing the text of the current buffer from
74d6d8c5
JA
704 START to END. If text properties are in use and the current buffer
705 has properties in the range specifed, the resulting string will also
706 have them.
ffd56f97
JB
707
708 We don't want to use plain old make_string here, because it calls
709 make_uninit_string, which can cause the buffer arena to be
710 compacted. make_string has no way of knowing that the data has
711 been moved, and thus copies the wrong data into the string. This
712 doesn't effect most of the other users of make_string, so it should
713 be left as is. But we should use this function when conjuring
714 buffer substrings. */
74d6d8c5 715
ffd56f97
JB
716Lisp_Object
717make_buffer_string (start, end)
718 int start, end;
719{
720 Lisp_Object result;
721
722 if (start < GPT && GPT < end)
723 move_gap (start);
724
725 result = make_uninit_string (end - start);
726 bcopy (&FETCH_CHAR (start), XSTRING (result)->data, end - start);
727
74d6d8c5
JA
728 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
729 copy_intervals_to_string (result, current_buffer, start, end - start);
730
ffd56f97
JB
731 return result;
732}
35692fe0
JB
733
734DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
735 "Return the contents of part of the current buffer as a string.\n\
736The two arguments START and END are character positions;\n\
737they can be in either order.")
738 (b, e)
739 Lisp_Object b, e;
740{
741 register int beg, end;
35692fe0
JB
742
743 validate_region (&b, &e);
744 beg = XINT (b);
745 end = XINT (e);
746
ffd56f97 747 return make_buffer_string (beg, end);
35692fe0
JB
748}
749
750DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
751 "Return the contents of the current buffer as a string.")
752 ()
753{
ffd56f97 754 return make_buffer_string (BEGV, ZV);
35692fe0
JB
755}
756
757DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
758 1, 3, 0,
759 "Insert before point a substring of the contents buffer BUFFER.\n\
760BUFFER may be a buffer or a buffer name.\n\
761Arguments START and END are character numbers specifying the substring.\n\
762They default to the beginning and the end of BUFFER.")
763 (buf, b, e)
764 Lisp_Object buf, b, e;
765{
74d6d8c5 766 register int beg, end, temp, len, opoint, start;
35692fe0
JB
767 register struct buffer *bp;
768
769 buf = Fget_buffer (buf);
770 bp = XBUFFER (buf);
771
56a98455 772 if (NILP (b))
35692fe0
JB
773 beg = BUF_BEGV (bp);
774 else
775 {
776 CHECK_NUMBER_COERCE_MARKER (b, 0);
777 beg = XINT (b);
778 }
56a98455 779 if (NILP (e))
35692fe0
JB
780 end = BUF_ZV (bp);
781 else
782 {
783 CHECK_NUMBER_COERCE_MARKER (e, 1);
784 end = XINT (e);
785 }
786
787 if (beg > end)
74d6d8c5 788 temp = beg, beg = end, end = temp;
35692fe0
JB
789
790 /* Move the gap or create enough gap in the current buffer. */
791
792 if (point != GPT)
793 move_gap (point);
794 if (GAP_SIZE < end - beg)
795 make_gap (end - beg - GAP_SIZE);
796
74d6d8c5
JA
797 len = end - beg;
798 start = beg;
799 opoint = point;
800
35692fe0
JB
801 if (!(BUF_BEGV (bp) <= beg
802 && beg <= end
803 && end <= BUF_ZV (bp)))
804 args_out_of_range (b, e);
805
806 /* Now the actual insertion will not do any gap motion,
807 so it matters not if BUF is the current buffer. */
808 if (beg < BUF_GPT (bp))
809 {
810 insert (BUF_CHAR_ADDRESS (bp, beg), min (end, BUF_GPT (bp)) - beg);
811 beg = min (end, BUF_GPT (bp));
812 }
813 if (beg < end)
814 insert (BUF_CHAR_ADDRESS (bp, beg), end - beg);
815
74d6d8c5
JA
816 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
817 graft_intervals_into_buffer (copy_intervals (bp->intervals, start, len),
818 opoint, bp);
819
35692fe0
JB
820 return Qnil;
821}
822\f
823DEFUN ("subst-char-in-region", Fsubst_char_in_region,
824 Ssubst_char_in_region, 4, 5, 0,
825 "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
826If optional arg NOUNDO is non-nil, don't record this change for undo\n\
827and don't mark the buffer as really changed.")
828 (start, end, fromchar, tochar, noundo)
829 Lisp_Object start, end, fromchar, tochar, noundo;
830{
831 register int pos, stop, look;
832
833 validate_region (&start, &end);
834 CHECK_NUMBER (fromchar, 2);
835 CHECK_NUMBER (tochar, 3);
836
837 pos = XINT (start);
838 stop = XINT (end);
839 look = XINT (fromchar);
840
841 modify_region (pos, stop);
56a98455 842 if (! NILP (noundo))
35692fe0
JB
843 {
844 if (MODIFF - 1 == current_buffer->save_modified)
845 current_buffer->save_modified++;
846 if (MODIFF - 1 == current_buffer->auto_save_modified)
847 current_buffer->auto_save_modified++;
848 }
849
850 while (pos < stop)
851 {
852 if (FETCH_CHAR (pos) == look)
853 {
56a98455 854 if (NILP (noundo))
35692fe0
JB
855 record_change (pos, 1);
856 FETCH_CHAR (pos) = XINT (tochar);
56a98455 857 if (NILP (noundo))
35692fe0
JB
858 signal_after_change (pos, 1, 1);
859 }
860 pos++;
861 }
862
863 return Qnil;
864}
865
866DEFUN ("translate-region", Ftranslate_region, Stranslate_region, 3, 3, 0,
867 "From START to END, translate characters according to TABLE.\n\
868TABLE is a string; the Nth character in it is the mapping\n\
869for the character with code N. Returns the number of characters changed.")
870 (start, end, table)
871 Lisp_Object start;
872 Lisp_Object end;
873 register Lisp_Object table;
874{
875 register int pos, stop; /* Limits of the region. */
876 register unsigned char *tt; /* Trans table. */
877 register int oc; /* Old character. */
878 register int nc; /* New character. */
879 int cnt; /* Number of changes made. */
880 Lisp_Object z; /* Return. */
881 int size; /* Size of translate table. */
882
883 validate_region (&start, &end);
884 CHECK_STRING (table, 2);
885
886 size = XSTRING (table)->size;
887 tt = XSTRING (table)->data;
888
889 pos = XINT (start);
890 stop = XINT (end);
891 modify_region (pos, stop);
892
893 cnt = 0;
894 for (; pos < stop; ++pos)
895 {
896 oc = FETCH_CHAR (pos);
897 if (oc < size)
898 {
899 nc = tt[oc];
900 if (nc != oc)
901 {
902 record_change (pos, 1);
903 FETCH_CHAR (pos) = nc;
904 signal_after_change (pos, 1, 1);
905 ++cnt;
906 }
907 }
908 }
909
910 XFASTINT (z) = cnt;
911 return (z);
912}
913
914DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
915 "Delete the text between point and mark.\n\
916When called from a program, expects two arguments,\n\
917positions (integers or markers) specifying the stretch to be deleted.")
918 (b, e)
919 Lisp_Object b, e;
920{
921 validate_region (&b, &e);
922 del_range (XINT (b), XINT (e));
923 return Qnil;
924}
925\f
926DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
927 "Remove restrictions (narrowing) from current buffer.\n\
928This allows the buffer's full text to be seen and edited.")
929 ()
930{
931 BEGV = BEG;
932 SET_BUF_ZV (current_buffer, Z);
933 clip_changed = 1;
52b14ac0
JB
934 /* Changing the buffer bounds invalidates any recorded current column. */
935 invalidate_current_column ();
35692fe0
JB
936 return Qnil;
937}
938
939DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
940 "Restrict editing in this buffer to the current region.\n\
941The rest of the text becomes temporarily invisible and untouchable\n\
942but is not deleted; if you save the buffer in a file, the invisible\n\
943text is included in the file. \\[widen] makes all visible again.\n\
944See also `save-restriction'.\n\
945\n\
946When calling from a program, pass two arguments; positions (integers\n\
947or markers) bounding the text that should remain visible.")
948 (b, e)
949 register Lisp_Object b, e;
950{
951 register int i;
952
953 CHECK_NUMBER_COERCE_MARKER (b, 0);
954 CHECK_NUMBER_COERCE_MARKER (e, 1);
955
956 if (XINT (b) > XINT (e))
957 {
958 i = XFASTINT (b);
959 b = e;
960 XFASTINT (e) = i;
961 }
962
963 if (!(BEG <= XINT (b) && XINT (b) <= XINT (e) && XINT (e) <= Z))
964 args_out_of_range (b, e);
965
966 BEGV = XFASTINT (b);
967 SET_BUF_ZV (current_buffer, XFASTINT (e));
968 if (point < XFASTINT (b))
969 SET_PT (XFASTINT (b));
970 if (point > XFASTINT (e))
971 SET_PT (XFASTINT (e));
972 clip_changed = 1;
52b14ac0
JB
973 /* Changing the buffer bounds invalidates any recorded current column. */
974 invalidate_current_column ();
35692fe0
JB
975 return Qnil;
976}
977
978Lisp_Object
979save_restriction_save ()
980{
981 register Lisp_Object bottom, top;
982 /* Note: I tried using markers here, but it does not win
983 because insertion at the end of the saved region
984 does not advance mh and is considered "outside" the saved region. */
985 XFASTINT (bottom) = BEGV - BEG;
986 XFASTINT (top) = Z - ZV;
987
988 return Fcons (Fcurrent_buffer (), Fcons (bottom, top));
989}
990
991Lisp_Object
992save_restriction_restore (data)
993 Lisp_Object data;
994{
995 register struct buffer *buf;
996 register int newhead, newtail;
997 register Lisp_Object tem;
998
999 buf = XBUFFER (XCONS (data)->car);
1000
1001 data = XCONS (data)->cdr;
1002
1003 tem = XCONS (data)->car;
1004 newhead = XINT (tem);
1005 tem = XCONS (data)->cdr;
1006 newtail = XINT (tem);
1007 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
1008 {
1009 newhead = 0;
1010 newtail = 0;
1011 }
1012 BUF_BEGV (buf) = BUF_BEG (buf) + newhead;
1013 SET_BUF_ZV (buf, BUF_Z (buf) - newtail);
1014 clip_changed = 1;
1015
1016 /* If point is outside the new visible range, move it inside. */
1017 SET_BUF_PT (buf,
1018 clip_to_bounds (BUF_BEGV (buf), BUF_PT (buf), BUF_ZV (buf)));
1019
1020 return Qnil;
1021}
1022
1023DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
1024 "Execute BODY, saving and restoring current buffer's restrictions.\n\
1025The buffer's restrictions make parts of the beginning and end invisible.\n\
1026\(They are set up with `narrow-to-region' and eliminated with `widen'.)\n\
1027This special form, `save-restriction', saves the current buffer's restrictions\n\
1028when it is entered, and restores them when it is exited.\n\
1029So any `narrow-to-region' within BODY lasts only until the end of the form.\n\
1030The old restrictions settings are restored\n\
1031even in case of abnormal exit (throw or error).\n\
1032\n\
1033The value returned is the value of the last form in BODY.\n\
1034\n\
1035`save-restriction' can get confused if, within the BODY, you widen\n\
1036and then make changes outside the area within the saved restrictions.\n\
1037\n\
1038Note: if you are using both `save-excursion' and `save-restriction',\n\
1039use `save-excursion' outermost:\n\
1040 (save-excursion (save-restriction ...))")
1041 (body)
1042 Lisp_Object body;
1043{
1044 register Lisp_Object val;
1045 int count = specpdl_ptr - specpdl;
1046
1047 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1048 val = Fprogn (body);
1049 return unbind_to (count, val);
1050}
1051\f
1052DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
1053 "Print a one-line message at the bottom of the screen.\n\
1054The first argument is a control string.\n\
1055It may contain %s or %d or %c to print successive following arguments.\n\
1056%s means print an argument as a string, %d means print as number in decimal,\n\
1057%c means print a number as a single character.\n\
1058The argument used by %s must be a string or a symbol;\n\
ccdac5be
JB
1059the argument used by %d or %c must be a number.\n\
1060If the first argument is nil, clear any existing message; let the\n\
1061minibuffer contents show.")
35692fe0
JB
1062 (nargs, args)
1063 int nargs;
1064 Lisp_Object *args;
1065{
ccdac5be
JB
1066 if (NILP (args[0]))
1067 message (0);
1068 else
1069 {
1070 register Lisp_Object val;
1071 val = Fformat (nargs, args);
1072 message ("%s", XSTRING (val)->data);
1073 return val;
1074 }
35692fe0
JB
1075}
1076
1077DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
1078 "Format a string out of a control-string and arguments.\n\
1079The first argument is a control string.\n\
1080The other arguments are substituted into it to make the result, a string.\n\
1081It may contain %-sequences meaning to substitute the next argument.\n\
1082%s means print a string argument. Actually, prints any object, with `princ'.\n\
1083%d means print as number in decimal (%o octal, %x hex).\n\
1084%c means print a number as a single character.\n\
1085%S means print any object as an s-expression (using prin1).\n\
52b14ac0
JB
1086 The argument used for %d, %o, %x or %c must be a number.\n\
1087Use %% to put a single % into the output.")
35692fe0
JB
1088 (nargs, args)
1089 int nargs;
1090 register Lisp_Object *args;
1091{
1092 register int n; /* The number of the next arg to substitute */
1093 register int total = 5; /* An estimate of the final length */
1094 char *buf;
1095 register unsigned char *format, *end;
1096 int length;
1097 extern char *index ();
1098 /* It should not be necessary to GCPRO ARGS, because
1099 the caller in the interpreter should take care of that. */
1100
1101 CHECK_STRING (args[0], 0);
1102 format = XSTRING (args[0])->data;
1103 end = format + XSTRING (args[0])->size;
1104
1105 n = 0;
1106 while (format != end)
1107 if (*format++ == '%')
1108 {
1109 int minlen;
1110
1111 /* Process a numeric arg and skip it. */
1112 minlen = atoi (format);
1113 if (minlen > 0)
1114 total += minlen;
1115 else
1116 total -= minlen;
1117 while ((*format >= '0' && *format <= '9')
1118 || *format == '-' || *format == ' ' || *format == '.')
1119 format++;
1120
1121 if (*format == '%')
1122 format++;
1123 else if (++n >= nargs)
1124 ;
1125 else if (*format == 'S')
1126 {
1127 /* For `S', prin1 the argument and then treat like a string. */
1128 register Lisp_Object tem;
1129 tem = Fprin1_to_string (args[n], Qnil);
1130 args[n] = tem;
1131 goto string;
1132 }
1133 else if (XTYPE (args[n]) == Lisp_Symbol)
1134 {
1135 XSET (args[n], Lisp_String, XSYMBOL (args[n])->name);
1136 goto string;
1137 }
1138 else if (XTYPE (args[n]) == Lisp_String)
1139 {
1140 string:
1141 total += XSTRING (args[n])->size;
1142 }
1143 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
1144 else if (XTYPE (args[n]) == Lisp_Int && *format != 's')
1145 {
4746118a 1146#ifdef LISP_FLOAT_TYPE
35692fe0
JB
1147 /* The following loop issumes the Lisp type indicates
1148 the proper way to pass the argument.
1149 So make sure we have a flonum if the argument should
1150 be a double. */
1151 if (*format == 'e' || *format == 'f' || *format == 'g')
1152 args[n] = Ffloat (args[n]);
4746118a 1153#endif
35692fe0
JB
1154 total += 10;
1155 }
4746118a 1156#ifdef LISP_FLOAT_TYPE
35692fe0
JB
1157 else if (XTYPE (args[n]) == Lisp_Float && *format != 's')
1158 {
1159 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
1160 args[n] = Ftruncate (args[n]);
1161 total += 20;
1162 }
4746118a 1163#endif
35692fe0
JB
1164 else
1165 {
1166 /* Anything but a string, convert to a string using princ. */
1167 register Lisp_Object tem;
1168 tem = Fprin1_to_string (args[n], Qt);
1169 args[n] = tem;
1170 goto string;
1171 }
1172 }
1173
1174 {
1175 register int nstrings = n + 1;
1176 register unsigned char **strings
1177 = (unsigned char **) alloca (nstrings * sizeof (unsigned char *));
1178
1179 for (n = 0; n < nstrings; n++)
1180 {
1181 if (n >= nargs)
1182 strings[n] = (unsigned char *) "";
1183 else if (XTYPE (args[n]) == Lisp_Int)
1184 /* We checked above that the corresponding format effector
1185 isn't %s, which would cause MPV. */
1186 strings[n] = (unsigned char *) XINT (args[n]);
4746118a 1187#ifdef LISP_FLOAT_TYPE
35692fe0
JB
1188 else if (XTYPE (args[n]) == Lisp_Float)
1189 {
1190 union { double d; int half[2]; } u;
1191
1192 u.d = XFLOAT (args[n])->data;
1193 strings[n++] = (unsigned char *) u.half[0];
1194 strings[n] = (unsigned char *) u.half[1];
1195 }
4746118a 1196#endif
35692fe0
JB
1197 else
1198 strings[n] = XSTRING (args[n])->data;
1199 }
1200
1201 /* Format it in bigger and bigger buf's until it all fits. */
1202 while (1)
1203 {
1204 buf = (char *) alloca (total + 1);
1205 buf[total - 1] = 0;
1206
1207 length = doprnt (buf, total + 1, strings[0], end, nargs, strings + 1);
1208 if (buf[total - 1] == 0)
1209 break;
1210
1211 total *= 2;
1212 }
1213 }
1214
1215 /* UNGCPRO; */
1216 return make_string (buf, length);
1217}
1218
1219/* VARARGS 1 */
1220Lisp_Object
1221#ifdef NO_ARG_ARRAY
1222format1 (string1, arg0, arg1, arg2, arg3, arg4)
1223 int arg0, arg1, arg2, arg3, arg4;
1224#else
1225format1 (string1)
1226#endif
1227 char *string1;
1228{
1229 char buf[100];
1230#ifdef NO_ARG_ARRAY
1231 int args[5];
1232 args[0] = arg0;
1233 args[1] = arg1;
1234 args[2] = arg2;
1235 args[3] = arg3;
1236 args[4] = arg4;
1237 doprnt (buf, sizeof buf, string1, 0, 5, args);
1238#else
1239 doprnt (buf, sizeof buf, string1, 0, 5, &string1 + 1);
1240#endif
1241 return build_string (buf);
1242}
1243\f
1244DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
1245 "Return t if two characters match, optionally ignoring case.\n\
1246Both arguments must be characters (i.e. integers).\n\
1247Case is ignored if `case-fold-search' is non-nil in the current buffer.")
1248 (c1, c2)
1249 register Lisp_Object c1, c2;
1250{
1251 unsigned char *downcase = DOWNCASE_TABLE;
1252 CHECK_NUMBER (c1, 0);
1253 CHECK_NUMBER (c2, 1);
1254
56a98455 1255 if (!NILP (current_buffer->case_fold_search)
35692fe0
JB
1256 ? downcase[0xff & XFASTINT (c1)] == downcase[0xff & XFASTINT (c2)]
1257 : XINT (c1) == XINT (c2))
1258 return Qt;
1259 return Qnil;
1260}
1261
35692fe0
JB
1262\f
1263void
1264syms_of_editfns ()
1265{
1266 DEFVAR_LISP ("system-name", &Vsystem_name,
1267 "The name of the machine Emacs is running on.");
1268
1269 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
1270 "The full name of the user logged in.");
1271
1272 DEFVAR_LISP ("user-name", &Vuser_name,
1273 "The user's name, based on the effective uid.");
1274
1275 DEFVAR_LISP ("user-real-name", &Vuser_real_name,
1276 "The user's name, base upon the real uid.");
1277
1278 defsubr (&Schar_equal);
1279 defsubr (&Sgoto_char);
1280 defsubr (&Sstring_to_char);
1281 defsubr (&Schar_to_string);
1282 defsubr (&Sbuffer_substring);
1283 defsubr (&Sbuffer_string);
1284
1285 defsubr (&Spoint_marker);
1286 defsubr (&Smark_marker);
1287 defsubr (&Spoint);
1288 defsubr (&Sregion_beginning);
1289 defsubr (&Sregion_end);
1290/* defsubr (&Smark); */
1291/* defsubr (&Sset_mark); */
1292 defsubr (&Ssave_excursion);
1293
1294 defsubr (&Sbufsize);
1295 defsubr (&Spoint_max);
1296 defsubr (&Spoint_min);
1297 defsubr (&Spoint_min_marker);
1298 defsubr (&Spoint_max_marker);
1299
1300 defsubr (&Sbobp);
1301 defsubr (&Seobp);
1302 defsubr (&Sbolp);
1303 defsubr (&Seolp);
850a8179
JB
1304 defsubr (&Sfollowing_char);
1305 defsubr (&Sprevious_char);
35692fe0
JB
1306 defsubr (&Schar_after);
1307 defsubr (&Sinsert);
1308 defsubr (&Sinsert_before_markers);
1309 defsubr (&Sinsert_char);
1310
1311 defsubr (&Suser_login_name);
1312 defsubr (&Suser_real_login_name);
1313 defsubr (&Suser_uid);
1314 defsubr (&Suser_real_uid);
1315 defsubr (&Suser_full_name);
d940e0e4 1316 defsubr (&Scurrent_time);
35692fe0 1317 defsubr (&Scurrent_time_string);
c2662aea 1318 defsubr (&Scurrent_time_zone);
35692fe0 1319 defsubr (&Ssystem_name);
35692fe0
JB
1320 defsubr (&Smessage);
1321 defsubr (&Sformat);
35692fe0
JB
1322
1323 defsubr (&Sinsert_buffer_substring);
1324 defsubr (&Ssubst_char_in_region);
1325 defsubr (&Stranslate_region);
1326 defsubr (&Sdelete_region);
1327 defsubr (&Swiden);
1328 defsubr (&Snarrow_to_region);
1329 defsubr (&Ssave_restriction);
1330}