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