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