(byte-compile-log-file): Always insert at eob.
[bpt/emacs.git] / src / editfns.c
CommitLineData
35692fe0 1/* Lisp functions pertaining to editing.
f8c25f1b 2 Copyright (C) 1985,86,87,89,93,94,95 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
738429d1
JB
21#include <sys/types.h>
22
18160b98 23#include <config.h>
bfb61299
JB
24
25#ifdef VMS
956ace37 26#include "vms-pwd.h"
bfb61299 27#else
35692fe0 28#include <pwd.h>
bfb61299
JB
29#endif
30
35692fe0 31#include "lisp.h"
74d6d8c5 32#include "intervals.h"
35692fe0
JB
33#include "buffer.h"
34#include "window.h"
35
956ace37 36#include "systime.h"
35692fe0
JB
37
38#define min(a, b) ((a) < (b) ? (a) : (b))
39#define max(a, b) ((a) > (b) ? (a) : (b))
40
b1b0ee5a 41extern void insert_from_buffer ();
3c887943 42static long difftm ();
b1b0ee5a 43
35692fe0
JB
44/* Some static data, and a function to initialize it for each run */
45
46Lisp_Object Vsystem_name;
47Lisp_Object Vuser_real_name; /* login name of current user ID */
48Lisp_Object Vuser_full_name; /* full name of current user */
2c9ae24e 49Lisp_Object Vuser_name; /* user name from LOGNAME or USER */
35692fe0
JB
50
51void
52init_editfns ()
53{
52b14ac0 54 char *user_name;
35692fe0
JB
55 register unsigned char *p, *q, *r;
56 struct passwd *pw; /* password entry for the current user */
57 extern char *index ();
58 Lisp_Object tem;
59
60 /* Set up system_name even when dumping. */
ac988277 61 init_system_name ();
35692fe0
JB
62
63#ifndef CANNOT_DUMP
64 /* Don't bother with this on initial start when just dumping out */
65 if (!initialized)
66 return;
67#endif /* not CANNOT_DUMP */
68
69 pw = (struct passwd *) getpwuid (getuid ());
87485d6f
MW
70#ifdef MSDOS
71 /* We let the real user name default to "root" because that's quite
72 accurate on MSDOG and because it lets Emacs find the init file.
73 (The DVX libraries override the Djgpp libraries here.) */
74 Vuser_real_name = build_string (pw ? pw->pw_name : "root");
75#else
35692fe0 76 Vuser_real_name = build_string (pw ? pw->pw_name : "unknown");
87485d6f 77#endif
35692fe0 78
52b14ac0
JB
79 /* Get the effective user name, by consulting environment variables,
80 or the effective uid if those are unset. */
2c9ae24e 81 user_name = (char *) getenv ("LOGNAME");
35692fe0 82 if (!user_name)
4691c06d
RS
83#ifdef WINDOWSNT
84 user_name = (char *) getenv ("USERNAME"); /* it's USERNAME on NT */
85#else /* WINDOWSNT */
2c9ae24e 86 user_name = (char *) getenv ("USER");
4691c06d 87#endif /* WINDOWSNT */
52b14ac0
JB
88 if (!user_name)
89 {
90 pw = (struct passwd *) getpwuid (geteuid ());
91 user_name = (char *) (pw ? pw->pw_name : "unknown");
92 }
93 Vuser_name = build_string (user_name);
35692fe0 94
52b14ac0
JB
95 /* If the user name claimed in the environment vars differs from
96 the real uid, use the claimed name to find the full name. */
35692fe0 97 tem = Fstring_equal (Vuser_name, Vuser_real_name);
56a98455 98 if (NILP (tem))
52b14ac0 99 pw = (struct passwd *) getpwnam (XSTRING (Vuser_name)->data);
35692fe0
JB
100
101 p = (unsigned char *) (pw ? USER_FULL_NAME : "unknown");
102 q = (unsigned char *) index (p, ',');
103 Vuser_full_name = make_string (p, q ? q - p : strlen (p));
104
105#ifdef AMPERSAND_FULL_NAME
106 p = XSTRING (Vuser_full_name)->data;
107 q = (char *) index (p, '&');
108 /* Substitute the login name for the &, upcasing the first character. */
109 if (q)
110 {
111 r = (char *) alloca (strlen (p) + XSTRING (Vuser_name)->size + 1);
112 bcopy (p, r, q - p);
113 r[q - p] = 0;
52b14ac0 114 strcat (r, XSTRING (Vuser_name)->data);
35692fe0
JB
115 r[q - p] = UPCASE (r[q - p]);
116 strcat (r, q + 1);
117 Vuser_full_name = build_string (r);
118 }
119#endif /* AMPERSAND_FULL_NAME */
9d36d071
RS
120
121 p = getenv ("NAME");
122 if (p)
123 Vuser_full_name = build_string (p);
35692fe0
JB
124}
125\f
126DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
127 "Convert arg CHAR to a one-character string containing that character.")
128 (n)
129 Lisp_Object n;
130{
131 char c;
132 CHECK_NUMBER (n, 0);
133
134 c = XINT (n);
135 return make_string (&c, 1);
136}
137
138DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
139 "Convert arg STRING to a character, the first character of that string.")
140 (str)
141 register Lisp_Object str;
142{
143 register Lisp_Object val;
144 register struct Lisp_String *p;
145 CHECK_STRING (str, 0);
146
147 p = XSTRING (str);
148 if (p->size)
55561c63 149 XSETFASTINT (val, ((unsigned char *) p->data)[0]);
35692fe0 150 else
55561c63 151 XSETFASTINT (val, 0);
35692fe0
JB
152 return val;
153}
154\f
155static Lisp_Object
156buildmark (val)
157 int val;
158{
159 register Lisp_Object mark;
160 mark = Fmake_marker ();
161 Fset_marker (mark, make_number (val), Qnil);
162 return mark;
163}
164
165DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
166 "Return value of point, as an integer.\n\
167Beginning of buffer is position (point-min)")
168 ()
169{
170 Lisp_Object temp;
55561c63 171 XSETFASTINT (temp, point);
35692fe0
JB
172 return temp;
173}
174
175DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
176 "Return value of point, as a marker object.")
177 ()
178{
179 return buildmark (point);
180}
181
182int
183clip_to_bounds (lower, num, upper)
184 int lower, num, upper;
185{
186 if (num < lower)
187 return lower;
188 else if (num > upper)
189 return upper;
190 else
191 return num;
192}
193
194DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
195 "Set point to POSITION, a number or marker.\n\
196Beginning of buffer is position (point-min), end is (point-max).")
197 (n)
198 register Lisp_Object n;
199{
200 CHECK_NUMBER_COERCE_MARKER (n, 0);
201
202 SET_PT (clip_to_bounds (BEGV, XINT (n), ZV));
203 return n;
204}
205
206static Lisp_Object
207region_limit (beginningp)
208 int beginningp;
209{
646d9d18 210 extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
35692fe0 211 register Lisp_Object m;
c9dd14e1
RM
212 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
213 && NILP (current_buffer->mark_active))
214 Fsignal (Qmark_inactive, Qnil);
35692fe0 215 m = Fmarker_position (current_buffer->mark);
56a98455 216 if (NILP (m)) error ("There is no region now");
35692fe0
JB
217 if ((point < XFASTINT (m)) == beginningp)
218 return (make_number (point));
219 else
220 return (m);
221}
222
223DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
224 "Return position of beginning of region, as an integer.")
225 ()
226{
227 return (region_limit (1));
228}
229
230DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
231 "Return position of end of region, as an integer.")
232 ()
233{
234 return (region_limit (0));
235}
236
237#if 0 /* now in lisp code */
238DEFUN ("mark", Fmark, Smark, 0, 0, 0,
239 "Return this buffer's mark value as integer, or nil if no mark.\n\
240If you are using this in an editing command, you are most likely making\n\
241a mistake; see the documentation of `set-mark'.")
242 ()
243{
244 return Fmarker_position (current_buffer->mark);
245}
246#endif /* commented out code */
247
248DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
249 "Return this buffer's mark, as a marker object.\n\
250Watch out! Moving this marker changes the mark position.\n\
251If you set the marker not to point anywhere, the buffer will have no mark.")
252 ()
253{
254 return current_buffer->mark;
255}
256
257#if 0 /* this is now in lisp code */
258DEFUN ("set-mark", Fset_mark, Sset_mark, 1, 1, 0,
259 "Set this buffer's mark to POS. Don't use this function!\n\
260That is to say, don't use this function unless you want\n\
261the user to see that the mark has moved, and you want the previous\n\
262mark position to be lost.\n\
263\n\
264Normally, when a new mark is set, the old one should go on the stack.\n\
265This is why most applications should use push-mark, not set-mark.\n\
266\n\
267Novice programmers often try to use the mark for the wrong purposes.\n\
268The mark saves a location for the user's convenience.\n\
269Most editing commands should not alter the mark.\n\
270To remember a location for internal use in the Lisp program,\n\
271store it in a Lisp variable. Example:\n\
272\n\
273 (let ((beg (point))) (forward-line 1) (delete-region beg (point))).")
274 (pos)
275 Lisp_Object pos;
276{
56a98455 277 if (NILP (pos))
35692fe0
JB
278 {
279 current_buffer->mark = Qnil;
280 return Qnil;
281 }
282 CHECK_NUMBER_COERCE_MARKER (pos, 0);
283
56a98455 284 if (NILP (current_buffer->mark))
35692fe0
JB
285 current_buffer->mark = Fmake_marker ();
286
287 Fset_marker (current_buffer->mark, pos, Qnil);
288 return pos;
289}
290#endif /* commented-out code */
291
292Lisp_Object
293save_excursion_save ()
294{
0e2c9c70
JB
295 register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
296 == current_buffer);
35692fe0
JB
297
298 return Fcons (Fpoint_marker (),
0e2c9c70 299 Fcons (Fcopy_marker (current_buffer->mark),
9772455e
RS
300 Fcons (visible ? Qt : Qnil,
301 current_buffer->mark_active)));
35692fe0
JB
302}
303
304Lisp_Object
305save_excursion_restore (info)
306 register Lisp_Object info;
307{
03d18690 308 register Lisp_Object tem, tem1, omark, nmark;
35692fe0
JB
309
310 tem = Fmarker_buffer (Fcar (info));
311 /* If buffer being returned to is now deleted, avoid error */
312 /* Otherwise could get error here while unwinding to top level
313 and crash */
314 /* In that case, Fmarker_buffer returns nil now. */
56a98455 315 if (NILP (tem))
35692fe0
JB
316 return Qnil;
317 Fset_buffer (tem);
318 tem = Fcar (info);
319 Fgoto_char (tem);
320 unchain_marker (tem);
321 tem = Fcar (Fcdr (info));
03d18690 322 omark = Fmarker_position (current_buffer->mark);
35692fe0 323 Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
03d18690 324 nmark = Fmarker_position (tem);
35692fe0
JB
325 unchain_marker (tem);
326 tem = Fcdr (Fcdr (info));
ef580991
RS
327#if 0 /* We used to make the current buffer visible in the selected window
328 if that was true previously. That avoids some anomalies.
329 But it creates others, and it wasn't documented, and it is simpler
330 and cleaner never to alter the window/buffer connections. */
9772455e
RS
331 tem1 = Fcar (tem);
332 if (!NILP (tem1)
0e2c9c70 333 && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
35692fe0 334 Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
ef580991 335#endif /* 0 */
9772455e
RS
336
337 tem1 = current_buffer->mark_active;
338 current_buffer->mark_active = Fcdr (tem);
9fed2b18
RS
339 if (!NILP (Vrun_hooks))
340 {
03d18690
RS
341 /* If mark is active now, and either was not active
342 or was at a different place, run the activate hook. */
9fed2b18 343 if (! NILP (current_buffer->mark_active))
03d18690
RS
344 {
345 if (! EQ (omark, nmark))
346 call1 (Vrun_hooks, intern ("activate-mark-hook"));
347 }
348 /* If mark has ceased to be active, run deactivate hook. */
9fed2b18
RS
349 else if (! NILP (tem1))
350 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
351 }
35692fe0
JB
352 return Qnil;
353}
354
355DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
356 "Save point, mark, and current buffer; execute BODY; restore those things.\n\
357Executes BODY just like `progn'.\n\
358The values of point, mark and the current buffer are restored\n\
9772455e
RS
359even in case of abnormal exit (throw or error).\n\
360The state of activation of the mark is also restored.")
35692fe0
JB
361 (args)
362 Lisp_Object args;
363{
364 register Lisp_Object val;
365 int count = specpdl_ptr - specpdl;
366
367 record_unwind_protect (save_excursion_restore, save_excursion_save ());
368
369 val = Fprogn (args);
370 return unbind_to (count, val);
371}
372\f
373DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 0, 0,
374 "Return the number of characters in the current buffer.")
375 ()
376{
377 Lisp_Object temp;
55561c63 378 XSETFASTINT (temp, Z - BEG);
35692fe0
JB
379 return temp;
380}
381
382DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
383 "Return the minimum permissible value of point in the current buffer.\n\
4c390850 384This is 1, unless narrowing (a buffer restriction) is in effect.")
35692fe0
JB
385 ()
386{
387 Lisp_Object temp;
55561c63 388 XSETFASTINT (temp, BEGV);
35692fe0
JB
389 return temp;
390}
391
392DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
393 "Return a marker to the minimum permissible value of point in this buffer.\n\
4c390850 394This is the beginning, unless narrowing (a buffer restriction) is in effect.")
35692fe0
JB
395 ()
396{
397 return buildmark (BEGV);
398}
399
400DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
401 "Return the maximum permissible value of point in the current buffer.\n\
4c390850
RS
402This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
403is in effect, in which case it is less.")
35692fe0
JB
404 ()
405{
406 Lisp_Object temp;
55561c63 407 XSETFASTINT (temp, ZV);
35692fe0
JB
408 return temp;
409}
410
411DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
412 "Return a marker to the maximum permissible value of point in this buffer.\n\
4c390850
RS
413This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
414is in effect, in which case it is less.")
35692fe0
JB
415 ()
416{
417 return buildmark (ZV);
418}
419
850a8179
JB
420DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
421 "Return the character following point, as a number.\n\
422At the end of the buffer or accessible region, return 0.")
35692fe0
JB
423 ()
424{
425 Lisp_Object temp;
850a8179 426 if (point >= ZV)
55561c63 427 XSETFASTINT (temp, 0);
850a8179 428 else
55561c63 429 XSETFASTINT (temp, FETCH_CHAR (point));
35692fe0
JB
430 return temp;
431}
432
850a8179
JB
433DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
434 "Return the character preceding point, as a number.\n\
435At the beginning of the buffer or accessible region, return 0.")
35692fe0
JB
436 ()
437{
438 Lisp_Object temp;
439 if (point <= BEGV)
55561c63 440 XSETFASTINT (temp, 0);
35692fe0 441 else
55561c63 442 XSETFASTINT (temp, FETCH_CHAR (point - 1));
35692fe0
JB
443 return temp;
444}
445
446DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
447 "Return T if point is at the beginning of the buffer.\n\
448If the buffer is narrowed, this means the beginning of the narrowed part.")
449 ()
450{
451 if (point == BEGV)
452 return Qt;
453 return Qnil;
454}
455
456DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
457 "Return T if point is at the end of the buffer.\n\
458If the buffer is narrowed, this means the end of the narrowed part.")
459 ()
460{
461 if (point == ZV)
462 return Qt;
463 return Qnil;
464}
465
466DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
467 "Return T if point is at the beginning of a line.")
468 ()
469{
470 if (point == BEGV || FETCH_CHAR (point - 1) == '\n')
471 return Qt;
472 return Qnil;
473}
474
475DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
476 "Return T if point is at the end of a line.\n\
477`End of a line' includes point being at the end of the buffer.")
478 ()
479{
480 if (point == ZV || FETCH_CHAR (point) == '\n')
481 return Qt;
482 return Qnil;
483}
484
485DEFUN ("char-after", Fchar_after, Schar_after, 1, 1, 0,
486 "Return character in current buffer at position POS.\n\
487POS is an integer or a buffer pointer.\n\
488If POS is out of range, the value is nil.")
489 (pos)
490 Lisp_Object pos;
491{
492 register Lisp_Object val;
493 register int n;
494
495 CHECK_NUMBER_COERCE_MARKER (pos, 0);
496
497 n = XINT (pos);
498 if (n < BEGV || n >= ZV) return Qnil;
499
55561c63 500 XSETFASTINT (val, FETCH_CHAR (n));
35692fe0
JB
501 return val;
502}
503\f
87485d6f 504DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
35692fe0
JB
505 "Return the name under which the user logged in, as a string.\n\
506This is based on the effective uid, not the real uid.\n\
2c9ae24e 507Also, if the environment variable LOGNAME or USER is set,\n\
87485d6f
MW
508that determines the value of this function.\n\n\
509If optional argument UID is an integer, return the login name of the user\n\
510with that uid, or nil if there is no such user.")
511 (uid)
512 Lisp_Object uid;
35692fe0 513{
87485d6f
MW
514 struct passwd *pw;
515
f8a0e364
RS
516 /* Set up the user name info if we didn't do it before.
517 (That can happen if Emacs is dumpable
518 but you decide to run `temacs -l loadup' and not dump. */
519 if (INTEGERP (Vuser_name))
520 init_editfns ();
87485d6f
MW
521
522 if (NILP (uid))
523 return Vuser_name;
524
525 CHECK_NUMBER (uid, 0);
526 pw = (struct passwd *) getpwuid (XINT (uid));
527 return (pw ? build_string (pw->pw_name) : Qnil);
35692fe0
JB
528}
529
530DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
531 0, 0, 0,
532 "Return the name of the user's real uid, as a string.\n\
9658bdd0 533This ignores the environment variables LOGNAME and USER, so it differs from\n\
b1da234a 534`user-login-name' when running under `su'.")
35692fe0
JB
535 ()
536{
f8a0e364
RS
537 /* Set up the user name info if we didn't do it before.
538 (That can happen if Emacs is dumpable
539 but you decide to run `temacs -l loadup' and not dump. */
540 if (INTEGERP (Vuser_name))
541 init_editfns ();
35692fe0
JB
542 return Vuser_real_name;
543}
544
545DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
546 "Return the effective uid of Emacs, as an integer.")
547 ()
548{
549 return make_number (geteuid ());
550}
551
552DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
553 "Return the real uid of Emacs, as an integer.")
554 ()
555{
556 return make_number (getuid ());
557}
558
559DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 0, 0,
560 "Return the full name of the user logged in, as a string.")
561 ()
562{
563 return Vuser_full_name;
564}
565
566DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
567 "Return the name of the machine you are running on, as a string.")
568 ()
569{
570 return Vsystem_name;
571}
572
ac988277
KH
573/* For the benefit of callers who don't want to include lisp.h */
574char *
575get_system_name ()
576{
316506b2 577 return (char *) XSTRING (Vsystem_name)->data;
ac988277
KH
578}
579
7fd233b3
RS
580DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
581 "Return the process ID of Emacs, as an integer.")
582 ()
583{
584 return make_number (getpid ());
585}
586
d940e0e4 587DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
956ace37
JB
588 "Return the current time, as the number of seconds since 12:00 AM January 1970.\n\
589The time is returned as a list of three integers. The first has the\n\
590most significant 16 bits of the seconds, while the second has the\n\
591least significant 16 bits. The third integer gives the microsecond\n\
592count.\n\
593\n\
594The microsecond count is zero on systems that do not provide\n\
595resolution finer than a second.")
d940e0e4
JB
596 ()
597{
956ace37
JB
598 EMACS_TIME t;
599 Lisp_Object result[3];
600
601 EMACS_GET_TIME (t);
d2fd0445
KH
602 XSETINT (result[0], (EMACS_SECS (t) >> 16) & 0xffff);
603 XSETINT (result[1], (EMACS_SECS (t) >> 0) & 0xffff);
604 XSETINT (result[2], EMACS_USECS (t));
956ace37
JB
605
606 return Flist (3, result);
d940e0e4
JB
607}
608\f
609
e3120ab5
JB
610static int
611lisp_time_argument (specified_time, result)
612 Lisp_Object specified_time;
613 time_t *result;
614{
615 if (NILP (specified_time))
616 return time (result) != -1;
617 else
618 {
619 Lisp_Object high, low;
620 high = Fcar (specified_time);
621 CHECK_NUMBER (high, 0);
622 low = Fcdr (specified_time);
ae683129 623 if (CONSP (low))
e3120ab5
JB
624 low = Fcar (low);
625 CHECK_NUMBER (low, 0);
626 *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
627 return *result >> 16 == XINT (high);
628 }
629}
630
a82d387c
RS
631DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 2, 2, 0,
632 "Use FORMAT-STRING to format the time TIME.\n\
633TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from\n\
634`current-time' and `file-attributes'.\n\
635FORMAT-STRING may contain %-sequences to substitute parts of the time.\n\
636%a is replaced by the abbreviated name of the day of week.\n\
637%A is replaced by the full name of the day of week.\n\
638%b is replaced by the abbreviated name of the month.\n\
639%B is replaced by the full name of the month.\n\
640%c is a synonym for \"%x %X\".\n\
641%C is a locale-specific synonym, which defaults to \"%A, %B %e, %Y\" in the C locale.\n\
642%d is replaced by the day of month, zero-padded.\n\
643%D is a synonym for \"%m/%d/%y\".\n\
644%e is replaced by the day of month, blank-padded.\n\
645%h is a synonym for \"%b\".\n\
646%H is replaced by the hour (00-23).\n\
647%I is replaced by the hour (00-12).\n\
648%j is replaced by the day of the year (001-366).\n\
649%k is replaced by the hour (0-23), blank padded.\n\
650%l is replaced by the hour (1-12), blank padded.\n\
651%m is replaced by the month (01-12).\n\
652%M is replaced by the minut (00-59).\n\
653%n is a synonym for \"\\n\".\n\
654%p is replaced by AM or PM, as appropriate.\n\
655%r is a synonym for \"%I:%M:%S %p\".\n\
656%R is a synonym for \"%H:%M\".\n\
657%S is replaced by the seconds (00-60).\n\
658%t is a synonym for \"\\t\".\n\
659%T is a synonym for \"%H:%M:%S\".\n\
660%U is replaced by the week of the year (01-52), first day of week is Sunday.\n\
661%w is replaced by the day of week (0-6), Sunday is day 0.\n\
662%W is replaced by the week of the year (01-52), first day of week is Monday.\n\
663%x is a locale-specific synonym, which defaults to \"%D\" in the C locale.\n\
664%X is a locale-specific synonym, which defaults to \"%T\" in the C locale.\n\
665%y is replaced by the year without century (00-99).\n\
666%Y is replaced by the year with century.\n\
667%Z is replaced by the time zone abbreviation.\n\
668\n\
57937a87 669The number of options reflects the `strftime' function.")
a82d387c
RS
670 (format_string, time)
671 Lisp_Object format_string, time;
672{
673 time_t value;
674 int size;
675
676 CHECK_STRING (format_string, 1);
677
678 if (! lisp_time_argument (time, &value))
679 error ("Invalid time specification");
680
681 /* This is probably enough. */
682 size = XSTRING (format_string)->size * 6 + 50;
683
684 while (1)
685 {
686 char *buf = (char *) alloca (size);
57937a87
RS
687 if (emacs_strftime (buf, size, XSTRING (format_string)->data,
688 localtime (&value)))
a82d387c
RS
689 return build_string (buf);
690 /* If buffer was too small, make it bigger. */
691 size *= 2;
692 }
693}
694
4691c06d
RS
695DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
696 "Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).\n\
697The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)\n\
698or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'\n\
699to use the current time. The list has the following nine members:\n\
700SEC is an integer between 0 and 59. MINUTE is an integer between 0 and 59.\n\
701HOUR is an integer between 0 and 23. DAY is an integer between 1 and 31.\n\
702MONTH is an integer between 1 and 12. YEAR is an integer indicating the\n\
703four-digit year. DOW is the day of week, an integer between 0 and 6, where\n\
7040 is Sunday. DST is t if daylight savings time is effect, otherwise nil.\n\
705ZONE is an integer indicating the number of seconds east of Greenwich.\n\
706(Note that Common Lisp has different meanings for DOW and ZONE.)")
707 (specified_time)
708 Lisp_Object specified_time;
709{
710 time_t time_spec;
3c887943 711 struct tm save_tm;
4691c06d
RS
712 struct tm *decoded_time;
713 Lisp_Object list_args[9];
714
715 if (! lisp_time_argument (specified_time, &time_spec))
716 error ("Invalid time specification");
717
718 decoded_time = localtime (&time_spec);
3c887943
KH
719 XSETFASTINT (list_args[0], decoded_time->tm_sec);
720 XSETFASTINT (list_args[1], decoded_time->tm_min);
721 XSETFASTINT (list_args[2], decoded_time->tm_hour);
722 XSETFASTINT (list_args[3], decoded_time->tm_mday);
723 XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
724 XSETFASTINT (list_args[5], decoded_time->tm_year + 1900);
725 XSETFASTINT (list_args[6], decoded_time->tm_wday);
4691c06d 726 list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
3c887943
KH
727
728 /* Make a copy, in case gmtime modifies the struct. */
729 save_tm = *decoded_time;
730 decoded_time = gmtime (&time_spec);
731 if (decoded_time == 0)
732 list_args[8] = Qnil;
733 else
734 XSETINT (list_args[8], difftm (&save_tm, decoded_time));
4691c06d
RS
735 return Flist (9, list_args);
736}
737
cce7b8a0
RS
738DEFUN ("encode-time", Fencode_time, Sencode_time, 6, 7, 0,
739 "Convert SEC, MIN, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
740This is the reverse operation of `decode-time', which see. ZONE defaults
741to the current time zone and daylight savings time if not specified; if
742specified, it can be either a list (as from `current-time-zone') or an
743integer (as from `decode-time'), and is applied without consideration for
744daylight savings time. If YEAR is less than 100, values in the range 0 to
74537 are interpreted as in the 21st century, all other values arein the 20th
746century.")
747 (sec, min, hour, day, month, year, zone)
748 Lisp_Object sec, min, hour, day, month, year, zone;
749{
750 double universal;
751 int fullyear, mon;
752 static char days[11] = { 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31 };
753
754 CHECK_NATNUM (sec, 0);
755 CHECK_NATNUM (min, 1);
756 CHECK_NATNUM (hour, 2);
757 CHECK_NATNUM (day, 3);
758 CHECK_NATNUM (month, 4);
759 CHECK_NATNUM (year, 5);
760
761 fullyear = XINT (year);
762 if (fullyear < 100)
763 {
764 if (fullyear < 38) /* end of time: 2038-01-19 03:14:08 */
765 fullyear += 2000;
766 else
767 fullyear += 1900;
768 }
769
770 if (NILP (zone))
771 zone = Fcurrent_time_zone (Qnil);
772 if (CONSP (zone))
773 zone = Fcar (zone);
774
775 CHECK_NUMBER (zone, 6);
776
777 /* all of these should evaluate to compile-time constants. */
778#define MIN 60.0 /* 60 */
779#define HOUR (60*MIN) /* 3600 */
780#define DAY (24*HOUR) /* 86400 */
781#define YEAR (365*DAY) /* 31536000 */
782#define YEAR4 (4*YEAR+DAY) /* 126230400 */
783#define YEAR100 (25*YEAR4-DAY) /* 3155673600 */
784#define YEAR400 (4*YEAR100+DAY) /* 12622780800 */
785#define YEAR1900 (4*YEAR400+3*YEAR100) /* 59958144000 */
786#define YEAR1970 (YEAR1900+17*YEAR4+2*YEAR) /* 62167132800 */
787#define LEAPBIAS (59*DAY) /* 5097600 */
788
789 mon = XINT (month) - 1;
790 fullyear--;
791 mon += 10;
792 fullyear += mon/12;
793 mon %= 12;
794
795 universal = XINT (sec) + XINT (min) * MIN + XINT (hour) * HOUR;
796 while (mon-- > 0)
797 universal += days[mon] * DAY;
798 universal += (XINT (day) - 1) * DAY;
799 universal += YEAR400 * (fullyear/400);
800 fullyear %= 400;
801 universal += YEAR100 * (fullyear/100);
802 fullyear %= 100;
803 universal += YEAR4 * (fullyear/4);
804 fullyear %= 4;
805 universal += YEAR * fullyear;
806 universal -= YEAR1970 - LEAPBIAS;
807
808 return make_time ((int)(universal - XINT (zone)));
809
810#undef MIN
811#undef HOUR
812#undef DAY
813#undef YEAR
814#undef YEAR4
815#undef YEAR100
816#undef YEAR400
817#undef YEAR1900
818#undef YEAR1970
819#undef LEAPBIAS
820}
821
2148f2b4 822DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
35692fe0 823 "Return the current time, as a human-readable string.\n\
2148f2b4
RS
824Programs can use this function to decode a time,\n\
825since the number of columns in each field is fixed.\n\
826The format is `Sun Sep 16 01:03:52 1973'.\n\
827If an argument is given, it specifies a time to format\n\
828instead of the current time. The argument should have the form:\n\
829 (HIGH . LOW)\n\
830or the form:\n\
831 (HIGH LOW . IGNORED).\n\
832Thus, you can use times obtained from `current-time'\n\
833and from `file-attributes'.")
834 (specified_time)
835 Lisp_Object specified_time;
836{
e3120ab5 837 time_t value;
35692fe0 838 char buf[30];
2148f2b4
RS
839 register char *tem;
840
e3120ab5
JB
841 if (! lisp_time_argument (specified_time, &value))
842 value = -1;
2148f2b4 843 tem = (char *) ctime (&value);
35692fe0
JB
844
845 strncpy (buf, tem, 24);
846 buf[24] = 0;
847
848 return build_string (buf);
849}
c2662aea 850
e3120ab5
JB
851#define TM_YEAR_ORIGIN 1900
852
853/* Yield A - B, measured in seconds. */
854static long
8e718b4e 855difftm (a, b)
e3120ab5
JB
856 struct tm *a, *b;
857{
858 int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
859 int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
8e718b4e 860 /* Some compilers can't handle this as a single return statement. */
68a49b18 861 long days = (
8e718b4e
KH
862 /* difference in day of year */
863 a->tm_yday - b->tm_yday
864 /* + intervening leap days */
865 + ((ay >> 2) - (by >> 2))
866 - (ay/100 - by/100)
867 + ((ay/100 >> 2) - (by/100 >> 2))
868 /* + difference in years * 365 */
869 + (long)(ay-by) * 365
870 );
871 return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
872 + (a->tm_min - b->tm_min))
873 + (a->tm_sec - b->tm_sec));
e3120ab5
JB
874}
875
876DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
877 "Return the offset and name for the local time zone.\n\
878This returns a list of the form (OFFSET NAME).\n\
879OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).\n\
880 A negative value means west of Greenwich.\n\
881NAME is a string giving the name of the time zone.\n\
882If an argument is given, it specifies when the time zone offset is determined\n\
883instead of using the current time. The argument should have the form:\n\
884 (HIGH . LOW)\n\
885or the form:\n\
886 (HIGH LOW . IGNORED).\n\
887Thus, you can use times obtained from `current-time'\n\
888and from `file-attributes'.\n\
773c1fd3
JB
889\n\
890Some operating systems cannot provide all this information to Emacs;\n\
2d88f747 891in this case, `current-time-zone' returns a list containing nil for\n\
773c1fd3 892the data it can't find.")
e3120ab5
JB
893 (specified_time)
894 Lisp_Object specified_time;
c2662aea 895{
e3120ab5
JB
896 time_t value;
897 struct tm *t;
c2662aea 898
e3120ab5 899 if (lisp_time_argument (specified_time, &value)
2d88f747 900 && (t = gmtime (&value)) != 0)
e3120ab5 901 {
2d88f747 902 struct tm gmt;
e3120ab5
JB
903 long offset;
904 char *s, buf[6];
2d88f747
RS
905
906 gmt = *t; /* Make a copy, in case localtime modifies *t. */
907 t = localtime (&value);
908 offset = difftm (t, &gmt);
e3120ab5
JB
909 s = 0;
910#ifdef HAVE_TM_ZONE
911 if (t->tm_zone)
5fd4de15 912 s = (char *)t->tm_zone;
a7971c39
RS
913#else /* not HAVE_TM_ZONE */
914#ifdef HAVE_TZNAME
915 if (t->tm_isdst == 0 || t->tm_isdst == 1)
916 s = tzname[t->tm_isdst];
c2662aea 917#endif
a7971c39 918#endif /* not HAVE_TM_ZONE */
e3120ab5
JB
919 if (!s)
920 {
921 /* No local time zone name is available; use "+-NNNN" instead. */
00fc94d0 922 int am = (offset < 0 ? -offset : offset) / 60;
e3120ab5
JB
923 sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
924 s = buf;
925 }
926 return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
927 }
928 else
929 return Fmake_list (2, Qnil);
c2662aea
JB
930}
931
35692fe0
JB
932\f
933void
934insert1 (arg)
935 Lisp_Object arg;
936{
937 Finsert (1, &arg);
938}
939
52b14ac0
JB
940
941/* Callers passing one argument to Finsert need not gcpro the
942 argument "array", since the only element of the array will
943 not be used after calling insert or insert_from_string, so
944 we don't care if it gets trashed. */
945
35692fe0
JB
946DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
947 "Insert the arguments, either strings or characters, at point.\n\
948Point moves forward so that it ends up after the inserted text.\n\
949Any other markers at the point of insertion remain before the text.")
950 (nargs, args)
951 int nargs;
952 register Lisp_Object *args;
953{
954 register int argnum;
955 register Lisp_Object tem;
956 char str[1];
35692fe0
JB
957
958 for (argnum = 0; argnum < nargs; argnum++)
959 {
960 tem = args[argnum];
961 retry:
ae683129 962 if (INTEGERP (tem))
35692fe0
JB
963 {
964 str[0] = XINT (tem);
965 insert (str, 1);
966 }
ae683129 967 else if (STRINGP (tem))
35692fe0 968 {
be91036a
RS
969 insert_from_string (tem, 0, XSTRING (tem)->size, 0);
970 }
971 else
972 {
973 tem = wrong_type_argument (Qchar_or_string_p, tem);
974 goto retry;
975 }
976 }
977
978 return Qnil;
979}
980
981DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
982 0, MANY, 0,
983 "Insert the arguments at point, inheriting properties from adjoining text.\n\
984Point moves forward so that it ends up after the inserted text.\n\
985Any other markers at the point of insertion remain before the text.")
986 (nargs, args)
987 int nargs;
988 register Lisp_Object *args;
989{
990 register int argnum;
991 register Lisp_Object tem;
992 char str[1];
993
994 for (argnum = 0; argnum < nargs; argnum++)
995 {
996 tem = args[argnum];
997 retry:
ae683129 998 if (INTEGERP (tem))
be91036a
RS
999 {
1000 str[0] = XINT (tem);
107740f5 1001 insert_and_inherit (str, 1);
be91036a 1002 }
ae683129 1003 else if (STRINGP (tem))
be91036a
RS
1004 {
1005 insert_from_string (tem, 0, XSTRING (tem)->size, 1);
35692fe0
JB
1006 }
1007 else
1008 {
1009 tem = wrong_type_argument (Qchar_or_string_p, tem);
1010 goto retry;
1011 }
1012 }
1013
35692fe0
JB
1014 return Qnil;
1015}
1016
1017DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
1018 "Insert strings or characters at point, relocating markers after the text.\n\
1019Point moves forward so that it ends up after the inserted text.\n\
1020Any other markers at the point of insertion also end up after the text.")
1021 (nargs, args)
1022 int nargs;
1023 register Lisp_Object *args;
1024{
1025 register int argnum;
1026 register Lisp_Object tem;
1027 char str[1];
35692fe0
JB
1028
1029 for (argnum = 0; argnum < nargs; argnum++)
1030 {
1031 tem = args[argnum];
1032 retry:
ae683129 1033 if (INTEGERP (tem))
35692fe0
JB
1034 {
1035 str[0] = XINT (tem);
1036 insert_before_markers (str, 1);
1037 }
ae683129 1038 else if (STRINGP (tem))
35692fe0 1039 {
be91036a
RS
1040 insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 0);
1041 }
1042 else
1043 {
1044 tem = wrong_type_argument (Qchar_or_string_p, tem);
1045 goto retry;
1046 }
1047 }
1048
1049 return Qnil;
1050}
1051
1052DEFUN ("insert-before-markers-and-inherit",
1053 Finsert_and_inherit_before_markers, Sinsert_and_inherit_before_markers,
1054 0, MANY, 0,
1055 "Insert text at point, relocating markers and inheriting properties.\n\
1056Point moves forward so that it ends up after the inserted text.\n\
1057Any other markers at the point of insertion also end up after the text.")
1058 (nargs, args)
1059 int nargs;
1060 register Lisp_Object *args;
1061{
1062 register int argnum;
1063 register Lisp_Object tem;
1064 char str[1];
1065
1066 for (argnum = 0; argnum < nargs; argnum++)
1067 {
1068 tem = args[argnum];
1069 retry:
ae683129 1070 if (INTEGERP (tem))
be91036a
RS
1071 {
1072 str[0] = XINT (tem);
107740f5 1073 insert_before_markers_and_inherit (str, 1);
be91036a 1074 }
ae683129 1075 else if (STRINGP (tem))
be91036a
RS
1076 {
1077 insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 1);
35692fe0
JB
1078 }
1079 else
1080 {
1081 tem = wrong_type_argument (Qchar_or_string_p, tem);
1082 goto retry;
1083 }
1084 }
1085
35692fe0
JB
1086 return Qnil;
1087}
1088\f
e2eeabbb 1089DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
35692fe0
JB
1090 "Insert COUNT (second arg) copies of CHAR (first arg).\n\
1091Point and all markers are affected as in the function `insert'.\n\
e2eeabbb
RS
1092Both arguments are required.\n\
1093The optional third arg INHERIT, if non-nil, says to inherit text properties\n\
1094from adjoining text, if those properties are sticky.")
1095 (chr, count, inherit)
1096 Lisp_Object chr, count, inherit;
35692fe0
JB
1097{
1098 register unsigned char *string;
1099 register int strlen;
1100 register int i, n;
1101
1102 CHECK_NUMBER (chr, 0);
1103 CHECK_NUMBER (count, 1);
1104
1105 n = XINT (count);
1106 if (n <= 0)
1107 return Qnil;
1108 strlen = min (n, 256);
1109 string = (unsigned char *) alloca (strlen);
1110 for (i = 0; i < strlen; i++)
1111 string[i] = XFASTINT (chr);
1112 while (n >= strlen)
1113 {
e2eeabbb
RS
1114 if (!NILP (inherit))
1115 insert_and_inherit (string, strlen);
1116 else
1117 insert (string, strlen);
35692fe0
JB
1118 n -= strlen;
1119 }
1120 if (n > 0)
83951f1e
KH
1121 {
1122 if (!NILP (inherit))
1123 insert_and_inherit (string, n);
1124 else
1125 insert (string, n);
1126 }
35692fe0
JB
1127 return Qnil;
1128}
1129
1130\f
ffd56f97
JB
1131/* Making strings from buffer contents. */
1132
1133/* Return a Lisp_String containing the text of the current buffer from
74d6d8c5 1134 START to END. If text properties are in use and the current buffer
eb8c3be9 1135 has properties in the range specified, the resulting string will also
74d6d8c5 1136 have them.
ffd56f97
JB
1137
1138 We don't want to use plain old make_string here, because it calls
1139 make_uninit_string, which can cause the buffer arena to be
1140 compacted. make_string has no way of knowing that the data has
1141 been moved, and thus copies the wrong data into the string. This
1142 doesn't effect most of the other users of make_string, so it should
1143 be left as is. But we should use this function when conjuring
1144 buffer substrings. */
74d6d8c5 1145
ffd56f97
JB
1146Lisp_Object
1147make_buffer_string (start, end)
1148 int start, end;
1149{
36b0d50e 1150 Lisp_Object result, tem, tem1;
ffd56f97
JB
1151
1152 if (start < GPT && GPT < end)
1153 move_gap (start);
1154
1155 result = make_uninit_string (end - start);
1156 bcopy (&FETCH_CHAR (start), XSTRING (result)->data, end - start);
1157
60b96ee7 1158 tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
36b0d50e 1159 tem1 = Ftext_properties_at (make_number (start), Qnil);
60b96ee7
RS
1160
1161#ifdef USE_TEXT_PROPERTIES
36b0d50e 1162 if (XINT (tem) != end || !NILP (tem1))
60b96ee7
RS
1163 copy_intervals_to_string (result, current_buffer, start, end - start);
1164#endif
74d6d8c5 1165
ffd56f97
JB
1166 return result;
1167}
35692fe0
JB
1168
1169DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
1170 "Return the contents of part of the current buffer as a string.\n\
1171The two arguments START and END are character positions;\n\
1172they can be in either order.")
1173 (b, e)
1174 Lisp_Object b, e;
1175{
1176 register int beg, end;
35692fe0
JB
1177
1178 validate_region (&b, &e);
1179 beg = XINT (b);
1180 end = XINT (e);
1181
ffd56f97 1182 return make_buffer_string (beg, end);
35692fe0
JB
1183}
1184
1185DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
1186 "Return the contents of the current buffer as a string.")
1187 ()
1188{
ffd56f97 1189 return make_buffer_string (BEGV, ZV);
35692fe0
JB
1190}
1191
1192DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
1193 1, 3, 0,
83ea6fc2 1194 "Insert before point a substring of the contents of buffer BUFFER.\n\
35692fe0
JB
1195BUFFER may be a buffer or a buffer name.\n\
1196Arguments START and END are character numbers specifying the substring.\n\
1197They default to the beginning and the end of BUFFER.")
1198 (buf, b, e)
1199 Lisp_Object buf, b, e;
1200{
b1b0ee5a 1201 register int beg, end, temp;
35692fe0 1202 register struct buffer *bp;
3fff2dfa 1203 Lisp_Object buffer;
35692fe0 1204
3fff2dfa
RS
1205 buffer = Fget_buffer (buf);
1206 if (NILP (buffer))
1207 nsberror (buf);
1208 bp = XBUFFER (buffer);
35692fe0 1209
56a98455 1210 if (NILP (b))
35692fe0
JB
1211 beg = BUF_BEGV (bp);
1212 else
1213 {
1214 CHECK_NUMBER_COERCE_MARKER (b, 0);
1215 beg = XINT (b);
1216 }
56a98455 1217 if (NILP (e))
35692fe0
JB
1218 end = BUF_ZV (bp);
1219 else
1220 {
1221 CHECK_NUMBER_COERCE_MARKER (e, 1);
1222 end = XINT (e);
1223 }
1224
1225 if (beg > end)
74d6d8c5 1226 temp = beg, beg = end, end = temp;
35692fe0 1227
b1b0ee5a 1228 if (!(BUF_BEGV (bp) <= beg && end <= BUF_ZV (bp)))
35692fe0
JB
1229 args_out_of_range (b, e);
1230
b1b0ee5a 1231 insert_from_buffer (bp, beg, end - beg, 0);
35692fe0
JB
1232 return Qnil;
1233}
e9cf2084
RS
1234
1235DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
1236 6, 6, 0,
1237 "Compare two substrings of two buffers; return result as number.\n\
1238the value is -N if first string is less after N-1 chars,\n\
1239+N if first string is greater after N-1 chars, or 0 if strings match.\n\
1240Each substring is represented as three arguments: BUFFER, START and END.\n\
1241That makes six args in all, three for each substring.\n\n\
1242The value of `case-fold-search' in the current buffer\n\
1243determines whether case is significant or ignored.")
1244 (buffer1, start1, end1, buffer2, start2, end2)
1245 Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
1246{
1247 register int begp1, endp1, begp2, endp2, temp, len1, len2, length, i;
1248 register struct buffer *bp1, *bp2;
1249 register unsigned char *trt
1250 = (!NILP (current_buffer->case_fold_search)
1251 ? XSTRING (current_buffer->case_canon_table)->data : 0);
1252
1253 /* Find the first buffer and its substring. */
1254
1255 if (NILP (buffer1))
1256 bp1 = current_buffer;
1257 else
1258 {
3fff2dfa
RS
1259 Lisp_Object buf1;
1260 buf1 = Fget_buffer (buffer1);
1261 if (NILP (buf1))
1262 nsberror (buffer1);
1263 bp1 = XBUFFER (buf1);
e9cf2084
RS
1264 }
1265
1266 if (NILP (start1))
1267 begp1 = BUF_BEGV (bp1);
1268 else
1269 {
1270 CHECK_NUMBER_COERCE_MARKER (start1, 1);
1271 begp1 = XINT (start1);
1272 }
1273 if (NILP (end1))
1274 endp1 = BUF_ZV (bp1);
1275 else
1276 {
1277 CHECK_NUMBER_COERCE_MARKER (end1, 2);
1278 endp1 = XINT (end1);
1279 }
1280
1281 if (begp1 > endp1)
1282 temp = begp1, begp1 = endp1, endp1 = temp;
1283
1284 if (!(BUF_BEGV (bp1) <= begp1
1285 && begp1 <= endp1
1286 && endp1 <= BUF_ZV (bp1)))
1287 args_out_of_range (start1, end1);
1288
1289 /* Likewise for second substring. */
1290
1291 if (NILP (buffer2))
1292 bp2 = current_buffer;
1293 else
1294 {
3fff2dfa
RS
1295 Lisp_Object buf2;
1296 buf2 = Fget_buffer (buffer2);
1297 if (NILP (buf2))
1298 nsberror (buffer2);
e9cf2084
RS
1299 bp2 = XBUFFER (buffer2);
1300 }
1301
1302 if (NILP (start2))
1303 begp2 = BUF_BEGV (bp2);
1304 else
1305 {
1306 CHECK_NUMBER_COERCE_MARKER (start2, 4);
1307 begp2 = XINT (start2);
1308 }
1309 if (NILP (end2))
1310 endp2 = BUF_ZV (bp2);
1311 else
1312 {
1313 CHECK_NUMBER_COERCE_MARKER (end2, 5);
1314 endp2 = XINT (end2);
1315 }
1316
1317 if (begp2 > endp2)
1318 temp = begp2, begp2 = endp2, endp2 = temp;
1319
1320 if (!(BUF_BEGV (bp2) <= begp2
1321 && begp2 <= endp2
1322 && endp2 <= BUF_ZV (bp2)))
1323 args_out_of_range (start2, end2);
1324
1325 len1 = endp1 - begp1;
1326 len2 = endp2 - begp2;
1327 length = len1;
1328 if (len2 < length)
1329 length = len2;
1330
1331 for (i = 0; i < length; i++)
1332 {
1333 int c1 = *BUF_CHAR_ADDRESS (bp1, begp1 + i);
1334 int c2 = *BUF_CHAR_ADDRESS (bp2, begp2 + i);
1335 if (trt)
1336 {
1337 c1 = trt[c1];
1338 c2 = trt[c2];
1339 }
1340 if (c1 < c2)
1341 return make_number (- 1 - i);
1342 if (c1 > c2)
1343 return make_number (i + 1);
1344 }
1345
1346 /* The strings match as far as they go.
1347 If one is shorter, that one is less. */
1348 if (length < len1)
1349 return make_number (length + 1);
1350 else if (length < len2)
1351 return make_number (- length - 1);
1352
1353 /* Same length too => they are equal. */
1354 return make_number (0);
1355}
35692fe0 1356\f
d5a539cd
RS
1357static Lisp_Object
1358subst_char_in_region_unwind (arg)
1359 Lisp_Object arg;
1360{
1361 return current_buffer->undo_list = arg;
1362}
1363
35692fe0
JB
1364DEFUN ("subst-char-in-region", Fsubst_char_in_region,
1365 Ssubst_char_in_region, 4, 5, 0,
1366 "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
1367If optional arg NOUNDO is non-nil, don't record this change for undo\n\
1368and don't mark the buffer as really changed.")
1369 (start, end, fromchar, tochar, noundo)
1370 Lisp_Object start, end, fromchar, tochar, noundo;
1371{
1372 register int pos, stop, look;
60b96ee7 1373 int changed = 0;
d5a539cd 1374 int count = specpdl_ptr - specpdl;
35692fe0
JB
1375
1376 validate_region (&start, &end);
1377 CHECK_NUMBER (fromchar, 2);
1378 CHECK_NUMBER (tochar, 3);
1379
1380 pos = XINT (start);
1381 stop = XINT (end);
1382 look = XINT (fromchar);
1383
d5a539cd
RS
1384 /* If we don't want undo, turn off putting stuff on the list.
1385 That's faster than getting rid of things,
1386 and it prevents even the entry for a first change. */
1387 if (!NILP (noundo))
1388 {
1389 record_unwind_protect (subst_char_in_region_unwind,
1390 current_buffer->undo_list);
1391 current_buffer->undo_list = Qt;
1392 }
1393
35692fe0
JB
1394 while (pos < stop)
1395 {
1396 if (FETCH_CHAR (pos) == look)
1397 {
60b96ee7
RS
1398 if (! changed)
1399 {
1400 modify_region (current_buffer, XINT (start), stop);
7653d030
RS
1401
1402 if (! NILP (noundo))
1403 {
1e158d25
RS
1404 if (MODIFF - 1 == SAVE_MODIFF)
1405 SAVE_MODIFF++;
7653d030
RS
1406 if (MODIFF - 1 == current_buffer->auto_save_modified)
1407 current_buffer->auto_save_modified++;
1408 }
1409
1410 changed = 1;
60b96ee7
RS
1411 }
1412
56a98455 1413 if (NILP (noundo))
35692fe0
JB
1414 record_change (pos, 1);
1415 FETCH_CHAR (pos) = XINT (tochar);
35692fe0
JB
1416 }
1417 pos++;
1418 }
1419
60b96ee7
RS
1420 if (changed)
1421 signal_after_change (XINT (start),
1422 stop - XINT (start), stop - XINT (start));
1423
d5a539cd 1424 unbind_to (count, Qnil);
35692fe0
JB
1425 return Qnil;
1426}
1427
1428DEFUN ("translate-region", Ftranslate_region, Stranslate_region, 3, 3, 0,
1429 "From START to END, translate characters according to TABLE.\n\
1430TABLE is a string; the Nth character in it is the mapping\n\
1431for the character with code N. Returns the number of characters changed.")
1432 (start, end, table)
1433 Lisp_Object start;
1434 Lisp_Object end;
1435 register Lisp_Object table;
1436{
1437 register int pos, stop; /* Limits of the region. */
1438 register unsigned char *tt; /* Trans table. */
1439 register int oc; /* Old character. */
1440 register int nc; /* New character. */
1441 int cnt; /* Number of changes made. */
1442 Lisp_Object z; /* Return. */
1443 int size; /* Size of translate table. */
1444
1445 validate_region (&start, &end);
1446 CHECK_STRING (table, 2);
1447
1448 size = XSTRING (table)->size;
1449 tt = XSTRING (table)->data;
1450
1451 pos = XINT (start);
1452 stop = XINT (end);
04a759c8 1453 modify_region (current_buffer, pos, stop);
35692fe0
JB
1454
1455 cnt = 0;
1456 for (; pos < stop; ++pos)
1457 {
1458 oc = FETCH_CHAR (pos);
1459 if (oc < size)
1460 {
1461 nc = tt[oc];
1462 if (nc != oc)
1463 {
1464 record_change (pos, 1);
1465 FETCH_CHAR (pos) = nc;
1466 signal_after_change (pos, 1, 1);
1467 ++cnt;
1468 }
1469 }
1470 }
1471
55561c63 1472 XSETFASTINT (z, cnt);
35692fe0
JB
1473 return (z);
1474}
1475
1476DEFUN ("delete-region", Fdelete_region, Sdelete_region, 2, 2, "r",
1477 "Delete the text between point and mark.\n\
1478When called from a program, expects two arguments,\n\
1479positions (integers or markers) specifying the stretch to be deleted.")
1480 (b, e)
1481 Lisp_Object b, e;
1482{
1483 validate_region (&b, &e);
1484 del_range (XINT (b), XINT (e));
1485 return Qnil;
1486}
1487\f
1488DEFUN ("widen", Fwiden, Swiden, 0, 0, "",
1489 "Remove restrictions (narrowing) from current buffer.\n\
1490This allows the buffer's full text to be seen and edited.")
1491 ()
1492{
1493 BEGV = BEG;
1494 SET_BUF_ZV (current_buffer, Z);
1495 clip_changed = 1;
52b14ac0
JB
1496 /* Changing the buffer bounds invalidates any recorded current column. */
1497 invalidate_current_column ();
35692fe0
JB
1498 return Qnil;
1499}
1500
1501DEFUN ("narrow-to-region", Fnarrow_to_region, Snarrow_to_region, 2, 2, "r",
1502 "Restrict editing in this buffer to the current region.\n\
1503The rest of the text becomes temporarily invisible and untouchable\n\
1504but is not deleted; if you save the buffer in a file, the invisible\n\
1505text is included in the file. \\[widen] makes all visible again.\n\
1506See also `save-restriction'.\n\
1507\n\
1508When calling from a program, pass two arguments; positions (integers\n\
1509or markers) bounding the text that should remain visible.")
1510 (b, e)
1511 register Lisp_Object b, e;
1512{
35692fe0
JB
1513 CHECK_NUMBER_COERCE_MARKER (b, 0);
1514 CHECK_NUMBER_COERCE_MARKER (e, 1);
1515
1516 if (XINT (b) > XINT (e))
1517 {
b5a6948e
KH
1518 Lisp_Object tem;
1519 tem = b; b = e; e = tem;
35692fe0
JB
1520 }
1521
1522 if (!(BEG <= XINT (b) && XINT (b) <= XINT (e) && XINT (e) <= Z))
1523 args_out_of_range (b, e);
1524
1525 BEGV = XFASTINT (b);
1526 SET_BUF_ZV (current_buffer, XFASTINT (e));
1527 if (point < XFASTINT (b))
1528 SET_PT (XFASTINT (b));
1529 if (point > XFASTINT (e))
1530 SET_PT (XFASTINT (e));
1531 clip_changed = 1;
52b14ac0
JB
1532 /* Changing the buffer bounds invalidates any recorded current column. */
1533 invalidate_current_column ();
35692fe0
JB
1534 return Qnil;
1535}
1536
1537Lisp_Object
1538save_restriction_save ()
1539{
1540 register Lisp_Object bottom, top;
1541 /* Note: I tried using markers here, but it does not win
1542 because insertion at the end of the saved region
1543 does not advance mh and is considered "outside" the saved region. */
55561c63
KH
1544 XSETFASTINT (bottom, BEGV - BEG);
1545 XSETFASTINT (top, Z - ZV);
35692fe0
JB
1546
1547 return Fcons (Fcurrent_buffer (), Fcons (bottom, top));
1548}
1549
1550Lisp_Object
1551save_restriction_restore (data)
1552 Lisp_Object data;
1553{
1554 register struct buffer *buf;
1555 register int newhead, newtail;
1556 register Lisp_Object tem;
1557
1558 buf = XBUFFER (XCONS (data)->car);
1559
1560 data = XCONS (data)->cdr;
1561
1562 tem = XCONS (data)->car;
1563 newhead = XINT (tem);
1564 tem = XCONS (data)->cdr;
1565 newtail = XINT (tem);
1566 if (newhead + newtail > BUF_Z (buf) - BUF_BEG (buf))
1567 {
1568 newhead = 0;
1569 newtail = 0;
1570 }
1571 BUF_BEGV (buf) = BUF_BEG (buf) + newhead;
1572 SET_BUF_ZV (buf, BUF_Z (buf) - newtail);
1573 clip_changed = 1;
1574
1575 /* If point is outside the new visible range, move it inside. */
1576 SET_BUF_PT (buf,
1577 clip_to_bounds (BUF_BEGV (buf), BUF_PT (buf), BUF_ZV (buf)));
1578
1579 return Qnil;
1580}
1581
1582DEFUN ("save-restriction", Fsave_restriction, Ssave_restriction, 0, UNEVALLED, 0,
1583 "Execute BODY, saving and restoring current buffer's restrictions.\n\
1584The buffer's restrictions make parts of the beginning and end invisible.\n\
1585\(They are set up with `narrow-to-region' and eliminated with `widen'.)\n\
1586This special form, `save-restriction', saves the current buffer's restrictions\n\
1587when it is entered, and restores them when it is exited.\n\
1588So any `narrow-to-region' within BODY lasts only until the end of the form.\n\
1589The old restrictions settings are restored\n\
1590even in case of abnormal exit (throw or error).\n\
1591\n\
1592The value returned is the value of the last form in BODY.\n\
1593\n\
1594`save-restriction' can get confused if, within the BODY, you widen\n\
1595and then make changes outside the area within the saved restrictions.\n\
1596\n\
1597Note: if you are using both `save-excursion' and `save-restriction',\n\
1598use `save-excursion' outermost:\n\
1599 (save-excursion (save-restriction ...))")
1600 (body)
1601 Lisp_Object body;
1602{
1603 register Lisp_Object val;
1604 int count = specpdl_ptr - specpdl;
1605
1606 record_unwind_protect (save_restriction_restore, save_restriction_save ());
1607 val = Fprogn (body);
1608 return unbind_to (count, val);
1609}
1610\f
671fbc4d
KH
1611/* Buffer for the most recent text displayed by Fmessage. */
1612static char *message_text;
1613
1614/* Allocated length of that buffer. */
1615static int message_length;
1616
35692fe0
JB
1617DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
1618 "Print a one-line message at the bottom of the screen.\n\
1619The first argument is a control string.\n\
1620It may contain %s or %d or %c to print successive following arguments.\n\
1621%s means print an argument as a string, %d means print as number in decimal,\n\
1622%c means print a number as a single character.\n\
1623The argument used by %s must be a string or a symbol;\n\
ccdac5be
JB
1624the argument used by %d or %c must be a number.\n\
1625If the first argument is nil, clear any existing message; let the\n\
1626minibuffer contents show.")
35692fe0
JB
1627 (nargs, args)
1628 int nargs;
1629 Lisp_Object *args;
1630{
ccdac5be 1631 if (NILP (args[0]))
f0250249
JB
1632 {
1633 message (0);
1634 return Qnil;
1635 }
ccdac5be
JB
1636 else
1637 {
1638 register Lisp_Object val;
1639 val = Fformat (nargs, args);
671fbc4d
KH
1640 /* Copy the data so that it won't move when we GC. */
1641 if (! message_text)
1642 {
1643 message_text = (char *)xmalloc (80);
1644 message_length = 80;
1645 }
1646 if (XSTRING (val)->size > message_length)
1647 {
1648 message_length = XSTRING (val)->size;
1649 message_text = (char *)xrealloc (message_text, message_length);
1650 }
1651 bcopy (XSTRING (val)->data, message_text, XSTRING (val)->size);
1652 message2 (message_text, XSTRING (val)->size);
ccdac5be
JB
1653 return val;
1654 }
35692fe0
JB
1655}
1656
cacc3e2c
RS
1657DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0,
1658 "Display a message, in a dialog box if possible.\n\
1659If a dialog box is not available, use the echo area.\n\
1660The first argument is a control string.\n\
1661It may contain %s or %d or %c to print successive following arguments.\n\
1662%s means print an argument as a string, %d means print as number in decimal,\n\
1663%c means print a number as a single character.\n\
1664The argument used by %s must be a string or a symbol;\n\
1665the argument used by %d or %c must be a number.\n\
1666If the first argument is nil, clear any existing message; let the\n\
1667minibuffer contents show.")
1668 (nargs, args)
1669 int nargs;
1670 Lisp_Object *args;
1671{
1672 if (NILP (args[0]))
1673 {
1674 message (0);
1675 return Qnil;
1676 }
1677 else
1678 {
1679 register Lisp_Object val;
1680 val = Fformat (nargs, args);
1681#ifdef HAVE_X_MENU
1682 {
1683 Lisp_Object pane, menu, obj;
1684 struct gcpro gcpro1;
1685 pane = Fcons (Fcons (build_string ("OK"), Qt), Qnil);
1686 GCPRO1 (pane);
1687 menu = Fcons (val, pane);
1688 obj = Fx_popup_dialog (Qt, menu);
1689 UNGCPRO;
1690 return val;
1691 }
1692#else
1693 /* Copy the data so that it won't move when we GC. */
1694 if (! message_text)
1695 {
1696 message_text = (char *)xmalloc (80);
1697 message_length = 80;
1698 }
1699 if (XSTRING (val)->size > message_length)
1700 {
1701 message_length = XSTRING (val)->size;
1702 message_text = (char *)xrealloc (message_text, message_length);
1703 }
1704 bcopy (XSTRING (val)->data, message_text, XSTRING (val)->size);
1705 message2 (message_text, XSTRING (val)->size);
1706 return val;
1707#endif
1708 }
1709}
1710#ifdef HAVE_X_MENU
1711extern Lisp_Object last_nonmenu_event;
1712#endif
1713DEFUN ("message-or-box", Fmessage_or_box, Smessage_or_box, 1, MANY, 0,
1714 "Display a message in a dialog box or in the echo area.\n\
1715If this command was invoked with the mouse, use a dialog box.\n\
1716Otherwise, use the echo area.\n\
1717\n\
1718The first argument is a control string.\n\
1719It may contain %s or %d or %c to print successive following arguments.\n\
1720%s means print an argument as a string, %d means print as number in decimal,\n\
1721%c means print a number as a single character.\n\
1722The argument used by %s must be a string or a symbol;\n\
1723the argument used by %d or %c must be a number.\n\
1724If the first argument is nil, clear any existing message; let the\n\
1725minibuffer contents show.")
1726 (nargs, args)
1727 int nargs;
1728 Lisp_Object *args;
1729{
1730#ifdef HAVE_X_MENU
1731 if (NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
0a56ee6b 1732 return Fmessage_box (nargs, args);
cacc3e2c
RS
1733#endif
1734 return Fmessage (nargs, args);
1735}
1736
35692fe0
JB
1737DEFUN ("format", Fformat, Sformat, 1, MANY, 0,
1738 "Format a string out of a control-string and arguments.\n\
1739The first argument is a control string.\n\
1740The other arguments are substituted into it to make the result, a string.\n\
1741It may contain %-sequences meaning to substitute the next argument.\n\
1742%s means print a string argument. Actually, prints any object, with `princ'.\n\
1743%d means print as number in decimal (%o octal, %x hex).\n\
1744%c means print a number as a single character.\n\
1745%S means print any object as an s-expression (using prin1).\n\
52b14ac0
JB
1746 The argument used for %d, %o, %x or %c must be a number.\n\
1747Use %% to put a single % into the output.")
35692fe0
JB
1748 (nargs, args)
1749 int nargs;
1750 register Lisp_Object *args;
1751{
1752 register int n; /* The number of the next arg to substitute */
1753 register int total = 5; /* An estimate of the final length */
1754 char *buf;
1755 register unsigned char *format, *end;
1756 int length;
1757 extern char *index ();
1758 /* It should not be necessary to GCPRO ARGS, because
1759 the caller in the interpreter should take care of that. */
1760
1761 CHECK_STRING (args[0], 0);
1762 format = XSTRING (args[0])->data;
1763 end = format + XSTRING (args[0])->size;
1764
1765 n = 0;
1766 while (format != end)
1767 if (*format++ == '%')
1768 {
1769 int minlen;
1770
1771 /* Process a numeric arg and skip it. */
1772 minlen = atoi (format);
1773 if (minlen > 0)
1774 total += minlen;
1775 else
1776 total -= minlen;
1777 while ((*format >= '0' && *format <= '9')
1778 || *format == '-' || *format == ' ' || *format == '.')
1779 format++;
1780
1781 if (*format == '%')
1782 format++;
1783 else if (++n >= nargs)
60764552 1784 error ("not enough arguments for format string");
35692fe0
JB
1785 else if (*format == 'S')
1786 {
1787 /* For `S', prin1 the argument and then treat like a string. */
1788 register Lisp_Object tem;
1789 tem = Fprin1_to_string (args[n], Qnil);
1790 args[n] = tem;
1791 goto string;
1792 }
ae683129 1793 else if (SYMBOLP (args[n]))
35692fe0 1794 {
d2fd0445 1795 XSETSTRING (args[n], XSYMBOL (args[n])->name);
35692fe0
JB
1796 goto string;
1797 }
ae683129 1798 else if (STRINGP (args[n]))
35692fe0
JB
1799 {
1800 string:
b22e7ecc
KH
1801 if (*format != 's' && *format != 'S')
1802 error ("format specifier doesn't match argument type");
35692fe0
JB
1803 total += XSTRING (args[n])->size;
1804 }
1805 /* Would get MPV otherwise, since Lisp_Int's `point' to low memory. */
ae683129 1806 else if (INTEGERP (args[n]) && *format != 's')
35692fe0 1807 {
4746118a 1808#ifdef LISP_FLOAT_TYPE
eb8c3be9 1809 /* The following loop assumes the Lisp type indicates
35692fe0
JB
1810 the proper way to pass the argument.
1811 So make sure we have a flonum if the argument should
1812 be a double. */
1813 if (*format == 'e' || *format == 'f' || *format == 'g')
1814 args[n] = Ffloat (args[n]);
4746118a 1815#endif
35692fe0
JB
1816 total += 10;
1817 }
4746118a 1818#ifdef LISP_FLOAT_TYPE
ae683129 1819 else if (FLOATP (args[n]) && *format != 's')
35692fe0
JB
1820 {
1821 if (! (*format == 'e' || *format == 'f' || *format == 'g'))
1822 args[n] = Ftruncate (args[n]);
1823 total += 20;
1824 }
4746118a 1825#endif
35692fe0
JB
1826 else
1827 {
1828 /* Anything but a string, convert to a string using princ. */
1829 register Lisp_Object tem;
1830 tem = Fprin1_to_string (args[n], Qt);
1831 args[n] = tem;
1832 goto string;
1833 }
1834 }
1835
1836 {
1837 register int nstrings = n + 1;
50aa2f90
JB
1838
1839 /* Allocate twice as many strings as we have %-escapes; floats occupy
1840 two slots, and we're not sure how many of those we have. */
35692fe0 1841 register unsigned char **strings
50aa2f90
JB
1842 = (unsigned char **) alloca (2 * nstrings * sizeof (unsigned char *));
1843 int i;
35692fe0 1844
50aa2f90 1845 i = 0;
35692fe0
JB
1846 for (n = 0; n < nstrings; n++)
1847 {
1848 if (n >= nargs)
50aa2f90 1849 strings[i++] = (unsigned char *) "";
ae683129 1850 else if (INTEGERP (args[n]))
35692fe0
JB
1851 /* We checked above that the corresponding format effector
1852 isn't %s, which would cause MPV. */
50aa2f90 1853 strings[i++] = (unsigned char *) XINT (args[n]);
4746118a 1854#ifdef LISP_FLOAT_TYPE
ae683129 1855 else if (FLOATP (args[n]))
35692fe0
JB
1856 {
1857 union { double d; int half[2]; } u;
1858
1859 u.d = XFLOAT (args[n])->data;
57937a87
RS
1860 strings[i++] = (unsigned char *) (EMACS_INT) u.half[0];
1861 strings[i++] = (unsigned char *) (EMACS_INT) u.half[1];
35692fe0 1862 }
4746118a 1863#endif
35692fe0 1864 else
50aa2f90 1865 strings[i++] = XSTRING (args[n])->data;
35692fe0
JB
1866 }
1867
1868 /* Format it in bigger and bigger buf's until it all fits. */
1869 while (1)
1870 {
1871 buf = (char *) alloca (total + 1);
1872 buf[total - 1] = 0;
1873
50aa2f90 1874 length = doprnt (buf, total + 1, strings[0], end, i-1, strings + 1);
35692fe0
JB
1875 if (buf[total - 1] == 0)
1876 break;
1877
1878 total *= 2;
1879 }
1880 }
1881
1882 /* UNGCPRO; */
1883 return make_string (buf, length);
1884}
1885
1886/* VARARGS 1 */
1887Lisp_Object
1888#ifdef NO_ARG_ARRAY
1889format1 (string1, arg0, arg1, arg2, arg3, arg4)
679e18b1 1890 EMACS_INT arg0, arg1, arg2, arg3, arg4;
35692fe0
JB
1891#else
1892format1 (string1)
1893#endif
1894 char *string1;
1895{
1896 char buf[100];
1897#ifdef NO_ARG_ARRAY
679e18b1 1898 EMACS_INT args[5];
35692fe0
JB
1899 args[0] = arg0;
1900 args[1] = arg1;
1901 args[2] = arg2;
1902 args[3] = arg3;
1903 args[4] = arg4;
1904 doprnt (buf, sizeof buf, string1, 0, 5, args);
1905#else
1906 doprnt (buf, sizeof buf, string1, 0, 5, &string1 + 1);
1907#endif
1908 return build_string (buf);
1909}
1910\f
1911DEFUN ("char-equal", Fchar_equal, Schar_equal, 2, 2, 0,
1912 "Return t if two characters match, optionally ignoring case.\n\
1913Both arguments must be characters (i.e. integers).\n\
1914Case is ignored if `case-fold-search' is non-nil in the current buffer.")
1915 (c1, c2)
1916 register Lisp_Object c1, c2;
1917{
1918 unsigned char *downcase = DOWNCASE_TABLE;
1919 CHECK_NUMBER (c1, 0);
1920 CHECK_NUMBER (c2, 1);
1921
56a98455 1922 if (!NILP (current_buffer->case_fold_search)
c34beca9
RS
1923 ? (downcase[0xff & XFASTINT (c1)] == downcase[0xff & XFASTINT (c2)]
1924 && (XFASTINT (c1) & ~0xff) == (XFASTINT (c2) & ~0xff))
35692fe0
JB
1925 : XINT (c1) == XINT (c2))
1926 return Qt;
1927 return Qnil;
1928}
b229b8d1
RS
1929\f
1930/* Transpose the markers in two regions of the current buffer, and
1931 adjust the ones between them if necessary (i.e.: if the regions
1932 differ in size).
1933
1934 Traverses the entire marker list of the buffer to do so, adding an
1935 appropriate amount to some, subtracting from some, and leaving the
1936 rest untouched. Most of this is copied from adjust_markers in insdel.c.
1937
03240d11 1938 It's the caller's job to see that (start1 <= end1 <= start2 <= end2). */
b229b8d1
RS
1939
1940void
1941transpose_markers (start1, end1, start2, end2)
1942 register int start1, end1, start2, end2;
1943{
1944 register int amt1, amt2, diff, mpos;
1945 register Lisp_Object marker;
b229b8d1 1946
03240d11 1947 /* Update point as if it were a marker. */
8de1d5f0
KH
1948 if (PT < start1)
1949 ;
1950 else if (PT < end1)
1951 TEMP_SET_PT (PT + (end2 - end1));
1952 else if (PT < start2)
1953 TEMP_SET_PT (PT + (end2 - start2) - (end1 - start1));
1954 else if (PT < end2)
1955 TEMP_SET_PT (PT - (start2 - start1));
1956
03240d11
KH
1957 /* We used to adjust the endpoints here to account for the gap, but that
1958 isn't good enough. Even if we assume the caller has tried to move the
1959 gap out of our way, it might still be at start1 exactly, for example;
1960 and that places it `inside' the interval, for our purposes. The amount
1961 of adjustment is nontrivial if there's a `denormalized' marker whose
1962 position is between GPT and GPT + GAP_SIZE, so it's simpler to leave
1963 the dirty work to Fmarker_position, below. */
b229b8d1
RS
1964
1965 /* The difference between the region's lengths */
1966 diff = (end2 - start2) - (end1 - start1);
1967
1968 /* For shifting each marker in a region by the length of the other
1969 * region plus the distance between the regions.
1970 */
1971 amt1 = (end2 - start2) + (start2 - end1);
1972 amt2 = (end1 - start1) + (start2 - end1);
1973
1e158d25 1974 for (marker = BUF_MARKERS (current_buffer); !NILP (marker);
03240d11 1975 marker = XMARKER (marker)->chain)
b229b8d1 1976 {
03240d11
KH
1977 mpos = Fmarker_position (marker);
1978 if (mpos >= start1 && mpos < end2)
1979 {
1980 if (mpos < end1)
1981 mpos += amt1;
1982 else if (mpos < start2)
1983 mpos += diff;
1984 else
1985 mpos -= amt2;
1986 if (mpos > GPT) mpos += GAP_SIZE;
1987 XMARKER (marker)->bufpos = mpos;
1988 }
b229b8d1
RS
1989 }
1990}
1991
1992DEFUN ("transpose-regions", Ftranspose_regions, Stranspose_regions, 4, 5, 0,
1993 "Transpose region START1 to END1 with START2 to END2.\n\
1994The regions may not be overlapping, because the size of the buffer is\n\
1995never changed in a transposition.\n\
1996\n\
1997Optional fifth arg LEAVE_MARKERS, if non-nil, means don't transpose\n\
1998any markers that happen to be located in the regions.\n\
1999\n\
2000Transposing beyond buffer boundaries is an error.")
2001 (startr1, endr1, startr2, endr2, leave_markers)
2002 Lisp_Object startr1, endr1, startr2, endr2, leave_markers;
2003{
2004 register int start1, end1, start2, end2,
2005 gap, len1, len_mid, len2;
3c6bc7d0 2006 unsigned char *start1_addr, *start2_addr, *temp;
b229b8d1
RS
2007
2008#ifdef USE_TEXT_PROPERTIES
2009 INTERVAL cur_intv, tmp_interval1, tmp_interval_mid, tmp_interval2;
1e158d25 2010 cur_intv = BUF_INTERVALS (current_buffer);
b229b8d1
RS
2011#endif /* USE_TEXT_PROPERTIES */
2012
2013 validate_region (&startr1, &endr1);
2014 validate_region (&startr2, &endr2);
2015
2016 start1 = XFASTINT (startr1);
2017 end1 = XFASTINT (endr1);
2018 start2 = XFASTINT (startr2);
2019 end2 = XFASTINT (endr2);
2020 gap = GPT;
2021
2022 /* Swap the regions if they're reversed. */
2023 if (start2 < end1)
2024 {
2025 register int glumph = start1;
2026 start1 = start2;
2027 start2 = glumph;
2028 glumph = end1;
2029 end1 = end2;
2030 end2 = glumph;
2031 }
2032
b229b8d1
RS
2033 len1 = end1 - start1;
2034 len2 = end2 - start2;
2035
2036 if (start2 < end1)
2037 error ("transposed regions not properly ordered");
2038 else if (start1 == end1 || start2 == end2)
2039 error ("transposed region may not be of length 0");
2040
2041 /* The possibilities are:
2042 1. Adjacent (contiguous) regions, or separate but equal regions
2043 (no, really equal, in this case!), or
2044 2. Separate regions of unequal size.
2045
2046 The worst case is usually No. 2. It means that (aside from
2047 potential need for getting the gap out of the way), there also
2048 needs to be a shifting of the text between the two regions. So
2049 if they are spread far apart, we are that much slower... sigh. */
2050
2051 /* It must be pointed out that the really studly thing to do would
2052 be not to move the gap at all, but to leave it in place and work
2053 around it if necessary. This would be extremely efficient,
2054 especially considering that people are likely to do
2055 transpositions near where they are working interactively, which
2056 is exactly where the gap would be found. However, such code
2057 would be much harder to write and to read. So, if you are
2058 reading this comment and are feeling squirrely, by all means have
2059 a go! I just didn't feel like doing it, so I will simply move
2060 the gap the minimum distance to get it out of the way, and then
2061 deal with an unbroken array. */
3c6bc7d0
RS
2062
2063 /* Make sure the gap won't interfere, by moving it out of the text
2064 we will operate on. */
2065 if (start1 < gap && gap < end2)
2066 {
2067 if (gap - start1 < end2 - gap)
2068 move_gap (start1);
2069 else
2070 move_gap (end2);
2071 }
b229b8d1
RS
2072
2073 /* Hmmm... how about checking to see if the gap is large
2074 enough to use as the temporary storage? That would avoid an
2075 allocation... interesting. Later, don't fool with it now. */
2076
2077 /* Working without memmove, for portability (sigh), so must be
2078 careful of overlapping subsections of the array... */
2079
2080 if (end1 == start2) /* adjacent regions */
2081 {
b229b8d1
RS
2082 modify_region (current_buffer, start1, end2);
2083 record_change (start1, len1 + len2);
2084
2085#ifdef USE_TEXT_PROPERTIES
2086 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
2087 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
2088 Fset_text_properties (start1, end2, Qnil, Qnil);
2089#endif /* USE_TEXT_PROPERTIES */
2090
2091 /* First region smaller than second. */
2092 if (len1 < len2)
2093 {
3c6bc7d0
RS
2094 /* We use alloca only if it is small,
2095 because we want to avoid stack overflow. */
2096 if (len2 > 20000)
2097 temp = (unsigned char *) xmalloc (len2);
2098 else
2099 temp = (unsigned char *) alloca (len2);
03240d11
KH
2100
2101 /* Don't precompute these addresses. We have to compute them
2102 at the last minute, because the relocating allocator might
2103 have moved the buffer around during the xmalloc. */
2104 start1_addr = BUF_CHAR_ADDRESS (current_buffer, start1);
2105 start2_addr = BUF_CHAR_ADDRESS (current_buffer, start2);
2106
b229b8d1
RS
2107 bcopy (start2_addr, temp, len2);
2108 bcopy (start1_addr, start1_addr + len2, len1);
2109 bcopy (temp, start1_addr, len2);
3c6bc7d0
RS
2110 if (len2 > 20000)
2111 free (temp);
b229b8d1
RS
2112 }
2113 else
2114 /* First region not smaller than second. */
2115 {
3c6bc7d0
RS
2116 if (len1 > 20000)
2117 temp = (unsigned char *) xmalloc (len1);
2118 else
2119 temp = (unsigned char *) alloca (len1);
03240d11
KH
2120 start1_addr = BUF_CHAR_ADDRESS (current_buffer, start1);
2121 start2_addr = BUF_CHAR_ADDRESS (current_buffer, start2);
b229b8d1
RS
2122 bcopy (start1_addr, temp, len1);
2123 bcopy (start2_addr, start1_addr, len2);
2124 bcopy (temp, start1_addr + len2, len1);
3c6bc7d0
RS
2125 if (len1 > 20000)
2126 free (temp);
b229b8d1
RS
2127 }
2128#ifdef USE_TEXT_PROPERTIES
2129 graft_intervals_into_buffer (tmp_interval1, start1 + len2,
2130 len1, current_buffer, 0);
2131 graft_intervals_into_buffer (tmp_interval2, start1,
2132 len2, current_buffer, 0);
2133#endif /* USE_TEXT_PROPERTIES */
2134 }
2135 /* Non-adjacent regions, because end1 != start2, bleagh... */
2136 else
2137 {
b229b8d1
RS
2138 if (len1 == len2)
2139 /* Regions are same size, though, how nice. */
2140 {
2141 modify_region (current_buffer, start1, end1);
2142 modify_region (current_buffer, start2, end2);
2143 record_change (start1, len1);
2144 record_change (start2, len2);
2145#ifdef USE_TEXT_PROPERTIES
2146 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
2147 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
2148 Fset_text_properties (start1, end1, Qnil, Qnil);
2149 Fset_text_properties (start2, end2, Qnil, Qnil);
2150#endif /* USE_TEXT_PROPERTIES */
2151
3c6bc7d0
RS
2152 if (len1 > 20000)
2153 temp = (unsigned char *) xmalloc (len1);
2154 else
2155 temp = (unsigned char *) alloca (len1);
03240d11
KH
2156 start1_addr = BUF_CHAR_ADDRESS (current_buffer, start1);
2157 start2_addr = BUF_CHAR_ADDRESS (current_buffer, start2);
b229b8d1
RS
2158 bcopy (start1_addr, temp, len1);
2159 bcopy (start2_addr, start1_addr, len2);
2160 bcopy (temp, start2_addr, len1);
3c6bc7d0
RS
2161 if (len1 > 20000)
2162 free (temp);
b229b8d1
RS
2163#ifdef USE_TEXT_PROPERTIES
2164 graft_intervals_into_buffer (tmp_interval1, start2,
2165 len1, current_buffer, 0);
2166 graft_intervals_into_buffer (tmp_interval2, start1,
2167 len2, current_buffer, 0);
2168#endif /* USE_TEXT_PROPERTIES */
2169 }
2170
2171 else if (len1 < len2) /* Second region larger than first */
2172 /* Non-adjacent & unequal size, area between must also be shifted. */
2173 {
2174 len_mid = start2 - end1;
2175 modify_region (current_buffer, start1, end2);
2176 record_change (start1, (end2 - start1));
2177#ifdef USE_TEXT_PROPERTIES
2178 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
2179 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
2180 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
2181 Fset_text_properties (start1, end2, Qnil, Qnil);
2182#endif /* USE_TEXT_PROPERTIES */
2183
3c6bc7d0
RS
2184 /* holds region 2 */
2185 if (len2 > 20000)
2186 temp = (unsigned char *) xmalloc (len2);
2187 else
2188 temp = (unsigned char *) alloca (len2);
03240d11
KH
2189 start1_addr = BUF_CHAR_ADDRESS (current_buffer, start1);
2190 start2_addr = BUF_CHAR_ADDRESS (current_buffer, start2);
3c6bc7d0 2191 bcopy (start2_addr, temp, len2);
b229b8d1 2192 bcopy (start1_addr, start1_addr + len_mid + len2, len1);
3c6bc7d0
RS
2193 safe_bcopy (start1_addr + len1, start1_addr + len2, len_mid);
2194 bcopy (temp, start1_addr, len2);
2195 if (len2 > 20000)
2196 free (temp);
b229b8d1
RS
2197#ifdef USE_TEXT_PROPERTIES
2198 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
2199 len1, current_buffer, 0);
2200 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
2201 len_mid, current_buffer, 0);
2202 graft_intervals_into_buffer (tmp_interval2, start1,
2203 len2, current_buffer, 0);
2204#endif /* USE_TEXT_PROPERTIES */
2205 }
2206 else
2207 /* Second region smaller than first. */
2208 {
2209 len_mid = start2 - end1;
2210 record_change (start1, (end2 - start1));
2211 modify_region (current_buffer, start1, end2);
2212
2213#ifdef USE_TEXT_PROPERTIES
2214 tmp_interval1 = copy_intervals (cur_intv, start1, len1);
2215 tmp_interval_mid = copy_intervals (cur_intv, end1, len_mid);
2216 tmp_interval2 = copy_intervals (cur_intv, start2, len2);
2217 Fset_text_properties (start1, end2, Qnil, Qnil);
2218#endif /* USE_TEXT_PROPERTIES */
2219
3c6bc7d0
RS
2220 /* holds region 1 */
2221 if (len1 > 20000)
2222 temp = (unsigned char *) xmalloc (len1);
2223 else
2224 temp = (unsigned char *) alloca (len1);
03240d11
KH
2225 start1_addr = BUF_CHAR_ADDRESS (current_buffer, start1);
2226 start2_addr = BUF_CHAR_ADDRESS (current_buffer, start2);
3c6bc7d0 2227 bcopy (start1_addr, temp, len1);
b229b8d1 2228 bcopy (start2_addr, start1_addr, len2);
3c6bc7d0
RS
2229 bcopy (start1_addr + len1, start1_addr + len2, len_mid);
2230 bcopy (temp, start1_addr + len2 + len_mid, len1);
2231 if (len1 > 20000)
2232 free (temp);
b229b8d1
RS
2233#ifdef USE_TEXT_PROPERTIES
2234 graft_intervals_into_buffer (tmp_interval1, end2 - len1,
2235 len1, current_buffer, 0);
2236 graft_intervals_into_buffer (tmp_interval_mid, start1 + len2,
2237 len_mid, current_buffer, 0);
2238 graft_intervals_into_buffer (tmp_interval2, start1,
2239 len2, current_buffer, 0);
2240#endif /* USE_TEXT_PROPERTIES */
2241 }
2242 }
2243
2244 /* todo: this will be slow, because for every transposition, we
2245 traverse the whole friggin marker list. Possible solutions:
2246 somehow get a list of *all* the markers across multiple
2247 transpositions and do it all in one swell phoop. Or maybe modify
2248 Emacs' marker code to keep an ordered list or tree. This might
2249 be nicer, and more beneficial in the long run, but would be a
2250 bunch of work. Plus the way they're arranged now is nice. */
2251 if (NILP (leave_markers))
8de1d5f0
KH
2252 {
2253 transpose_markers (start1, end1, start2, end2);
2254 fix_overlays_in_range (start1, end2);
2255 }
b229b8d1
RS
2256
2257 return Qnil;
2258}
35692fe0 2259
35692fe0
JB
2260\f
2261void
2262syms_of_editfns ()
2263{
f43754f6
KH
2264 DEFVAR_LISP ("system-name", &Vsystem_name,
2265 "The name of the machine Emacs is running on.");
2266
2267 DEFVAR_LISP ("user-full-name", &Vuser_full_name,
2268 "The full name of the user logged in.");
2269
2270 DEFVAR_LISP ("user-name", &Vuser_name,
2271 "The user's name, taken from environment variables if possible.");
2272
2273 DEFVAR_LISP ("user-real-name", &Vuser_real_name,
2274 "The user's name, based upon the real uid only.");
35692fe0
JB
2275
2276 defsubr (&Schar_equal);
2277 defsubr (&Sgoto_char);
2278 defsubr (&Sstring_to_char);
2279 defsubr (&Schar_to_string);
2280 defsubr (&Sbuffer_substring);
2281 defsubr (&Sbuffer_string);
2282
2283 defsubr (&Spoint_marker);
2284 defsubr (&Smark_marker);
2285 defsubr (&Spoint);
2286 defsubr (&Sregion_beginning);
2287 defsubr (&Sregion_end);
2288/* defsubr (&Smark); */
2289/* defsubr (&Sset_mark); */
2290 defsubr (&Ssave_excursion);
2291
2292 defsubr (&Sbufsize);
2293 defsubr (&Spoint_max);
2294 defsubr (&Spoint_min);
2295 defsubr (&Spoint_min_marker);
2296 defsubr (&Spoint_max_marker);
2297
2298 defsubr (&Sbobp);
2299 defsubr (&Seobp);
2300 defsubr (&Sbolp);
2301 defsubr (&Seolp);
850a8179
JB
2302 defsubr (&Sfollowing_char);
2303 defsubr (&Sprevious_char);
35692fe0
JB
2304 defsubr (&Schar_after);
2305 defsubr (&Sinsert);
2306 defsubr (&Sinsert_before_markers);
be91036a
RS
2307 defsubr (&Sinsert_and_inherit);
2308 defsubr (&Sinsert_and_inherit_before_markers);
35692fe0
JB
2309 defsubr (&Sinsert_char);
2310
2311 defsubr (&Suser_login_name);
2312 defsubr (&Suser_real_login_name);
2313 defsubr (&Suser_uid);
2314 defsubr (&Suser_real_uid);
2315 defsubr (&Suser_full_name);
7fd233b3 2316 defsubr (&Semacs_pid);
d940e0e4 2317 defsubr (&Scurrent_time);
a82d387c 2318 defsubr (&Sformat_time_string);
4691c06d 2319 defsubr (&Sdecode_time);
cce7b8a0 2320 defsubr (&Sencode_time);
35692fe0 2321 defsubr (&Scurrent_time_string);
c2662aea 2322 defsubr (&Scurrent_time_zone);
35692fe0 2323 defsubr (&Ssystem_name);
35692fe0 2324 defsubr (&Smessage);
cacc3e2c
RS
2325 defsubr (&Smessage_box);
2326 defsubr (&Smessage_or_box);
35692fe0 2327 defsubr (&Sformat);
35692fe0
JB
2328
2329 defsubr (&Sinsert_buffer_substring);
e9cf2084 2330 defsubr (&Scompare_buffer_substrings);
35692fe0
JB
2331 defsubr (&Ssubst_char_in_region);
2332 defsubr (&Stranslate_region);
2333 defsubr (&Sdelete_region);
2334 defsubr (&Swiden);
2335 defsubr (&Snarrow_to_region);
2336 defsubr (&Ssave_restriction);
b229b8d1 2337 defsubr (&Stranspose_regions);
35692fe0 2338}