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