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