]> code.delx.au - gnu-emacs/blob - src/buffer.c
Merge from emacs--devo--0
[gnu-emacs] / src / buffer.c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994,
3 1995, 1997, 1998, 1999, 2000, 2001, 2002,
4 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
22
23 #include <config.h>
24
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <sys/param.h>
28 #include <errno.h>
29 #include <stdio.h>
30
31 #ifndef USE_CRT_DLL
32 extern int errno;
33 #endif
34
35
36 #ifdef HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
39
40 #include "lisp.h"
41 #include "intervals.h"
42 #include "window.h"
43 #include "commands.h"
44 #include "buffer.h"
45 #include "charset.h"
46 #include "region-cache.h"
47 #include "indent.h"
48 #include "blockinput.h"
49 #include "keyboard.h"
50 #include "keymap.h"
51 #include "frame.h"
52
53 struct buffer *current_buffer; /* the current buffer */
54
55 /* First buffer in chain of all buffers (in reverse order of creation).
56 Threaded through ->next. */
57
58 struct buffer *all_buffers;
59
60 /* This structure holds the default values of the buffer-local variables
61 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
62 The default value occupies the same slot in this structure
63 as an individual buffer's value occupies in that buffer.
64 Setting the default value also goes through the alist of buffers
65 and stores into each buffer that does not say it has a local value. */
66
67 DECL_ALIGN (struct buffer, buffer_defaults);
68
69 /* A Lisp_Object pointer to the above, used for staticpro */
70
71 static Lisp_Object Vbuffer_defaults;
72
73 /* This structure marks which slots in a buffer have corresponding
74 default values in buffer_defaults.
75 Each such slot has a nonzero value in this structure.
76 The value has only one nonzero bit.
77
78 When a buffer has its own local value for a slot,
79 the entry for that slot (found in the same slot in this structure)
80 is turned on in the buffer's local_flags array.
81
82 If a slot in this structure is -1, then even though there may
83 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
84 and the corresponding slot in buffer_defaults is not used.
85
86 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
87 but there is a default value which is copied into each buffer.
88
89 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
90 zero, that is a bug */
91
92 struct buffer buffer_local_flags;
93
94 /* This structure holds the names of symbols whose values may be
95 buffer-local. It is indexed and accessed in the same way as the above. */
96
97 DECL_ALIGN (struct buffer, buffer_local_symbols);
98
99 /* A Lisp_Object pointer to the above, used for staticpro */
100 static Lisp_Object Vbuffer_local_symbols;
101
102 /* This structure holds the required types for the values in the
103 buffer-local slots. If a slot contains Qnil, then the
104 corresponding buffer slot may contain a value of any type. If a
105 slot contains an integer, then prospective values' tags must be
106 equal to that integer (except nil is always allowed).
107 When a tag does not match, the function
108 buffer_slot_type_mismatch will signal an error.
109
110 If a slot here contains -1, the corresponding variable is read-only. */
111 struct buffer buffer_local_types;
112
113 /* Flags indicating which built-in buffer-local variables
114 are permanent locals. */
115 static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
116
117 /* Number of per-buffer variables used. */
118
119 int last_per_buffer_idx;
120
121 Lisp_Object Fset_buffer ();
122 void set_buffer_internal ();
123 void set_buffer_internal_1 ();
124 static void call_overlay_mod_hooks ();
125 static void swap_out_buffer_local_variables ();
126 static void reset_buffer_local_variables ();
127
128 /* Alist of all buffer names vs the buffers. */
129 /* This used to be a variable, but is no longer,
130 to prevent lossage due to user rplac'ing this alist or its elements. */
131 Lisp_Object Vbuffer_alist;
132
133 /* Functions to call before and after each text change. */
134 Lisp_Object Vbefore_change_functions;
135 Lisp_Object Vafter_change_functions;
136
137 Lisp_Object Vtransient_mark_mode;
138
139 /* t means ignore all read-only text properties.
140 A list means ignore such a property if its value is a member of the list.
141 Any non-nil value means ignore buffer-read-only. */
142 Lisp_Object Vinhibit_read_only;
143
144 /* List of functions to call that can query about killing a buffer.
145 If any of these functions returns nil, we don't kill it. */
146 Lisp_Object Vkill_buffer_query_functions;
147 Lisp_Object Qkill_buffer_query_functions;
148
149 /* Hook run before changing a major mode. */
150 Lisp_Object Vchange_major_mode_hook, Qchange_major_mode_hook;
151
152 /* List of functions to call before changing an unmodified buffer. */
153 Lisp_Object Vfirst_change_hook;
154
155 Lisp_Object Qfirst_change_hook;
156 Lisp_Object Qbefore_change_functions;
157 Lisp_Object Qafter_change_functions;
158 Lisp_Object Qucs_set_table_for_input;
159
160 /* If nonzero, all modification hooks are suppressed. */
161 int inhibit_modification_hooks;
162
163 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
164
165 Lisp_Object Qprotected_field;
166
167 Lisp_Object QSFundamental; /* A string "Fundamental" */
168
169 Lisp_Object Qkill_buffer_hook;
170
171 Lisp_Object Qget_file_buffer;
172
173 Lisp_Object Qoverlayp;
174
175 Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
176
177 Lisp_Object Qmodification_hooks;
178 Lisp_Object Qinsert_in_front_hooks;
179 Lisp_Object Qinsert_behind_hooks;
180
181 static void alloc_buffer_text P_ ((struct buffer *, size_t));
182 static void free_buffer_text P_ ((struct buffer *b));
183 static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184 static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
185 static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
186
187
188 /* For debugging; temporary. See set_buffer_internal. */
189 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
190
191 void
192 nsberror (spec)
193 Lisp_Object spec;
194 {
195 if (STRINGP (spec))
196 error ("No buffer named %s", SDATA (spec));
197 error ("Invalid buffer argument");
198 }
199 \f
200 DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
201 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
202 Value is nil if OBJECT is not a buffer or if it has been killed. */)
203 (object)
204 Lisp_Object object;
205 {
206 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
207 ? Qt : Qnil);
208 }
209
210 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
211 doc: /* Return a list of all existing live buffers.
212 If the optional arg FRAME is a frame, we return the buffer list
213 in the proper order for that frame: the buffers in FRAME's `buffer-list'
214 frame parameter come first, followed by the rest of the buffers. */)
215 (frame)
216 Lisp_Object frame;
217 {
218 Lisp_Object general;
219 general = Fmapcar (Qcdr, Vbuffer_alist);
220
221 if (FRAMEP (frame))
222 {
223 Lisp_Object framelist, prevlist, tail;
224 Lisp_Object args[3];
225
226 CHECK_FRAME (frame);
227
228 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
229 prevlist = Fnreverse (Fcopy_sequence (XFRAME (frame)->buried_buffer_list));
230
231 /* Remove from GENERAL any buffer that duplicates one in
232 FRAMELIST or PREVLIST. */
233 tail = framelist;
234 while (CONSP (tail))
235 {
236 general = Fdelq (XCAR (tail), general);
237 tail = XCDR (tail);
238 }
239 tail = prevlist;
240 while (CONSP (tail))
241 {
242 general = Fdelq (XCAR (tail), general);
243 tail = XCDR (tail);
244 }
245
246 args[0] = framelist;
247 args[1] = general;
248 args[2] = prevlist;
249 return Fnconc (3, args);
250 }
251
252 return general;
253 }
254
255 /* Like Fassoc, but use Fstring_equal to compare
256 (which ignores text properties),
257 and don't ever QUIT. */
258
259 static Lisp_Object
260 assoc_ignore_text_properties (key, list)
261 register Lisp_Object key;
262 Lisp_Object list;
263 {
264 register Lisp_Object tail;
265 for (tail = list; CONSP (tail); tail = XCDR (tail))
266 {
267 register Lisp_Object elt, tem;
268 elt = XCAR (tail);
269 tem = Fstring_equal (Fcar (elt), key);
270 if (!NILP (tem))
271 return elt;
272 }
273 return Qnil;
274 }
275
276 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
277 doc: /* Return the buffer named NAME (a string).
278 If there is no live buffer named NAME, return nil.
279 NAME may also be a buffer; if so, the value is that buffer. */)
280 (name)
281 register Lisp_Object name;
282 {
283 if (BUFFERP (name))
284 return name;
285 CHECK_STRING (name);
286
287 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
288 }
289
290 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
291 doc: /* Return the buffer visiting file FILENAME (a string).
292 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
293 If there is no such live buffer, return nil.
294 See also `find-buffer-visiting'. */)
295 (filename)
296 register Lisp_Object filename;
297 {
298 register Lisp_Object tail, buf, tem;
299 Lisp_Object handler;
300
301 CHECK_STRING (filename);
302 filename = Fexpand_file_name (filename, Qnil);
303
304 /* If the file name has special constructs in it,
305 call the corresponding file handler. */
306 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
307 if (!NILP (handler))
308 return call2 (handler, Qget_file_buffer, filename);
309
310 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
311 {
312 buf = Fcdr (XCAR (tail));
313 if (!BUFFERP (buf)) continue;
314 if (!STRINGP (XBUFFER (buf)->filename)) continue;
315 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
316 if (!NILP (tem))
317 return buf;
318 }
319 return Qnil;
320 }
321
322 Lisp_Object
323 get_truename_buffer (filename)
324 register Lisp_Object filename;
325 {
326 register Lisp_Object tail, buf, tem;
327
328 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
329 {
330 buf = Fcdr (XCAR (tail));
331 if (!BUFFERP (buf)) continue;
332 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
333 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
334 if (!NILP (tem))
335 return buf;
336 }
337 return Qnil;
338 }
339
340 /* Incremented for each buffer created, to assign the buffer number. */
341 int buffer_count;
342
343 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
344 doc: /* Return the buffer named NAME, or create such a buffer and return it.
345 A new buffer is created if there is no live buffer named NAME.
346 If NAME starts with a space, the new buffer does not keep undo information.
347 If NAME is a buffer instead of a string, then it is the value returned.
348 The value is never nil. */)
349 (name)
350 register Lisp_Object name;
351 {
352 register Lisp_Object buf;
353 register struct buffer *b;
354
355 buf = Fget_buffer (name);
356 if (!NILP (buf))
357 return buf;
358
359 if (SCHARS (name) == 0)
360 error ("Empty string for buffer name is not allowed");
361
362 b = (struct buffer *) allocate_buffer ();
363
364 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
365
366 /* An ordinary buffer uses its own struct buffer_text. */
367 b->text = &b->own_text;
368 b->base_buffer = 0;
369
370 BUF_GAP_SIZE (b) = 20;
371 BLOCK_INPUT;
372 /* We allocate extra 1-byte at the tail and keep it always '\0' for
373 anchoring a search. */
374 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
375 UNBLOCK_INPUT;
376 if (! BUF_BEG_ADDR (b))
377 buffer_memory_full ();
378
379 BUF_PT (b) = BEG;
380 BUF_GPT (b) = BEG;
381 BUF_BEGV (b) = BEG;
382 BUF_ZV (b) = BEG;
383 BUF_Z (b) = BEG;
384 BUF_PT_BYTE (b) = BEG_BYTE;
385 BUF_GPT_BYTE (b) = BEG_BYTE;
386 BUF_BEGV_BYTE (b) = BEG_BYTE;
387 BUF_ZV_BYTE (b) = BEG_BYTE;
388 BUF_Z_BYTE (b) = BEG_BYTE;
389 BUF_MODIFF (b) = 1;
390 BUF_CHARS_MODIFF (b) = 1;
391 BUF_OVERLAY_MODIFF (b) = 1;
392 BUF_SAVE_MODIFF (b) = 1;
393 BUF_INTERVALS (b) = 0;
394 BUF_UNCHANGED_MODIFIED (b) = 1;
395 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
396 BUF_END_UNCHANGED (b) = 0;
397 BUF_BEG_UNCHANGED (b) = 0;
398 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
399
400 b->newline_cache = 0;
401 b->width_run_cache = 0;
402 b->width_table = Qnil;
403 b->prevent_redisplay_optimizations_p = 1;
404
405 /* Put this on the chain of all buffers including killed ones. */
406 b->next = all_buffers;
407 all_buffers = b;
408
409 /* An ordinary buffer normally doesn't need markers
410 to handle BEGV and ZV. */
411 b->pt_marker = Qnil;
412 b->begv_marker = Qnil;
413 b->zv_marker = Qnil;
414
415 name = Fcopy_sequence (name);
416 STRING_SET_INTERVALS (name, NULL_INTERVAL);
417 b->name = name;
418
419 if (SREF (name, 0) != ' ')
420 b->undo_list = Qnil;
421 else
422 b->undo_list = Qt;
423
424 reset_buffer (b);
425 reset_buffer_local_variables (b, 1);
426
427 b->mark = Fmake_marker ();
428 BUF_MARKERS (b) = NULL;
429 b->name = name;
430
431 /* Put this in the alist of all live buffers. */
432 XSETBUFFER (buf, b);
433 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
434
435 /* An error in calling the function here (should someone redefine it)
436 can lead to infinite regress until you run out of stack. rms
437 says that's not worth protecting against. */
438 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
439 /* buf is on buffer-alist, so no gcpro. */
440 call1 (Qucs_set_table_for_input, buf);
441
442 return buf;
443 }
444
445
446 /* Return a list of overlays which is a copy of the overlay list
447 LIST, but for buffer B. */
448
449 static struct Lisp_Overlay *
450 copy_overlays (b, list)
451 struct buffer *b;
452 struct Lisp_Overlay *list;
453 {
454 Lisp_Object buffer;
455 struct Lisp_Overlay *result = NULL, *tail = NULL;
456
457 XSETBUFFER (buffer, b);
458
459 for (; list; list = list->next)
460 {
461 Lisp_Object overlay, start, end, old_overlay;
462 EMACS_INT charpos;
463
464 XSETMISC (old_overlay, list);
465 charpos = marker_position (OVERLAY_START (old_overlay));
466 start = Fmake_marker ();
467 Fset_marker (start, make_number (charpos), buffer);
468 XMARKER (start)->insertion_type
469 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
470
471 charpos = marker_position (OVERLAY_END (old_overlay));
472 end = Fmake_marker ();
473 Fset_marker (end, make_number (charpos), buffer);
474 XMARKER (end)->insertion_type
475 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
476
477 overlay = allocate_misc ();
478 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
479 OVERLAY_START (overlay) = start;
480 OVERLAY_END (overlay) = end;
481 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
482 XOVERLAY (overlay)->next = NULL;
483
484 if (tail)
485 tail = tail->next = XOVERLAY (overlay);
486 else
487 result = tail = XOVERLAY (overlay);
488 }
489
490 return result;
491 }
492
493
494 /* Clone per-buffer values of buffer FROM.
495
496 Buffer TO gets the same per-buffer values as FROM, with the
497 following exceptions: (1) TO's name is left untouched, (2) markers
498 are copied and made to refer to TO, and (3) overlay lists are
499 copied. */
500
501 static void
502 clone_per_buffer_values (from, to)
503 struct buffer *from, *to;
504 {
505 Lisp_Object to_buffer;
506 int offset;
507
508 XSETBUFFER (to_buffer, to);
509
510 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
511 offset < sizeof *to;
512 offset += sizeof (Lisp_Object))
513 {
514 Lisp_Object obj;
515
516 obj = PER_BUFFER_VALUE (from, offset);
517 if (MARKERP (obj))
518 {
519 struct Lisp_Marker *m = XMARKER (obj);
520 obj = Fmake_marker ();
521 XMARKER (obj)->insertion_type = m->insertion_type;
522 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
523 }
524
525 PER_BUFFER_VALUE (to, offset) = obj;
526 }
527
528 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
529
530 to->overlays_before = copy_overlays (to, from->overlays_before);
531 to->overlays_after = copy_overlays (to, from->overlays_after);
532
533 /* Get (a copy of) the alist of Lisp-level local variables of FROM
534 and install that in TO. */
535 to->local_var_alist = buffer_lisp_local_variables (from);
536 }
537
538 DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
539 2, 3,
540 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
541 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
542 BASE-BUFFER should be a live buffer, or the name of an existing buffer.
543 NAME should be a string which is not the name of an existing buffer.
544 Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
545 such as major and minor modes, in the indirect buffer.
546 CLONE nil means the indirect buffer's state is reset to default values. */)
547 (base_buffer, name, clone)
548 Lisp_Object base_buffer, name, clone;
549 {
550 Lisp_Object buf, tem;
551 struct buffer *b;
552
553 CHECK_STRING (name);
554 buf = Fget_buffer (name);
555 if (!NILP (buf))
556 error ("Buffer name `%s' is in use", SDATA (name));
557
558 tem = base_buffer;
559 base_buffer = Fget_buffer (base_buffer);
560 if (NILP (base_buffer))
561 error ("No such buffer: `%s'", SDATA (tem));
562 if (NILP (XBUFFER (base_buffer)->name))
563 error ("Base buffer has been killed");
564
565 if (SCHARS (name) == 0)
566 error ("Empty string for buffer name is not allowed");
567
568 b = (struct buffer *) allocate_buffer ();
569 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
570
571 if (XBUFFER (base_buffer)->base_buffer)
572 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
573 else
574 b->base_buffer = XBUFFER (base_buffer);
575
576 /* Use the base buffer's text object. */
577 b->text = b->base_buffer->text;
578
579 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
580 BUF_ZV (b) = BUF_ZV (b->base_buffer);
581 BUF_PT (b) = BUF_PT (b->base_buffer);
582 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
583 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
584 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
585
586 b->newline_cache = 0;
587 b->width_run_cache = 0;
588 b->width_table = Qnil;
589
590 /* Put this on the chain of all buffers including killed ones. */
591 b->next = all_buffers;
592 all_buffers = b;
593
594 name = Fcopy_sequence (name);
595 STRING_SET_INTERVALS (name, NULL_INTERVAL);
596 b->name = name;
597
598 reset_buffer (b);
599 reset_buffer_local_variables (b, 1);
600
601 /* Put this in the alist of all live buffers. */
602 XSETBUFFER (buf, b);
603 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
604
605 b->mark = Fmake_marker ();
606 b->name = name;
607
608 /* The multibyte status belongs to the base buffer. */
609 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
610
611 /* Make sure the base buffer has markers for its narrowing. */
612 if (NILP (b->base_buffer->pt_marker))
613 {
614 b->base_buffer->pt_marker = Fmake_marker ();
615 set_marker_both (b->base_buffer->pt_marker, base_buffer,
616 BUF_PT (b->base_buffer),
617 BUF_PT_BYTE (b->base_buffer));
618 }
619 if (NILP (b->base_buffer->begv_marker))
620 {
621 b->base_buffer->begv_marker = Fmake_marker ();
622 set_marker_both (b->base_buffer->begv_marker, base_buffer,
623 BUF_BEGV (b->base_buffer),
624 BUF_BEGV_BYTE (b->base_buffer));
625 }
626 if (NILP (b->base_buffer->zv_marker))
627 {
628 b->base_buffer->zv_marker = Fmake_marker ();
629 set_marker_both (b->base_buffer->zv_marker, base_buffer,
630 BUF_ZV (b->base_buffer),
631 BUF_ZV_BYTE (b->base_buffer));
632 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
633 }
634
635 if (NILP (clone))
636 {
637 /* Give the indirect buffer markers for its narrowing. */
638 b->pt_marker = Fmake_marker ();
639 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
640 b->begv_marker = Fmake_marker ();
641 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
642 b->zv_marker = Fmake_marker ();
643 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
644 XMARKER (b->zv_marker)->insertion_type = 1;
645 }
646 else
647 {
648 struct buffer *old_b = current_buffer;
649
650 clone_per_buffer_values (b->base_buffer, b);
651 b->filename = Qnil;
652 b->file_truename = Qnil;
653 b->display_count = make_number (0);
654 b->backed_up = Qnil;
655 b->auto_save_file_name = Qnil;
656 set_buffer_internal_1 (b);
657 Fset (intern ("buffer-save-without-query"), Qnil);
658 Fset (intern ("buffer-file-number"), Qnil);
659 Fset (intern ("buffer-stale-function"), Qnil);
660 set_buffer_internal_1 (old_b);
661 }
662
663 return buf;
664 }
665
666 void
667 delete_all_overlays (b)
668 struct buffer *b;
669 {
670 Lisp_Object overlay;
671
672 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
673 have to empty the list, otherwise we end up with overlays that
674 think they belong to this buffer while the buffer doesn't know about
675 them any more. */
676 while (b->overlays_before)
677 {
678 XSETMISC (overlay, b->overlays_before);
679 Fdelete_overlay (overlay);
680 }
681 while (b->overlays_after)
682 {
683 XSETMISC (overlay, b->overlays_after);
684 Fdelete_overlay (overlay);
685 }
686 eassert (b->overlays_before == NULL);
687 eassert (b->overlays_after == NULL);
688 }
689
690 /* Reinitialize everything about a buffer except its name and contents
691 and local variables.
692 If called on an already-initialized buffer, the list of overlays
693 should be deleted before calling this function, otherwise we end up
694 with overlays that claim to belong to the buffer but the buffer
695 claims it doesn't belong to it. */
696
697 void
698 reset_buffer (b)
699 register struct buffer *b;
700 {
701 b->filename = Qnil;
702 b->file_truename = Qnil;
703 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
704 b->modtime = 0;
705 XSETFASTINT (b->save_length, 0);
706 b->last_window_start = 1;
707 /* It is more conservative to start out "changed" than "unchanged". */
708 b->clip_changed = 0;
709 b->prevent_redisplay_optimizations_p = 1;
710 b->backed_up = Qnil;
711 b->auto_save_modified = 0;
712 b->auto_save_failure_time = -1;
713 b->auto_save_file_name = Qnil;
714 b->read_only = Qnil;
715 b->overlays_before = NULL;
716 b->overlays_after = NULL;
717 b->overlay_center = BEG;
718 b->mark_active = Qnil;
719 b->point_before_scroll = Qnil;
720 b->file_format = Qnil;
721 b->auto_save_file_format = Qt;
722 b->last_selected_window = Qnil;
723 XSETINT (b->display_count, 0);
724 b->display_time = Qnil;
725 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
726 b->cursor_type = buffer_defaults.cursor_type;
727 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
728
729 b->display_error_modiff = 0;
730 }
731
732 /* Reset buffer B's local variables info.
733 Don't use this on a buffer that has already been in use;
734 it does not treat permanent locals consistently.
735 Instead, use Fkill_all_local_variables.
736
737 If PERMANENT_TOO is 1, then we reset permanent built-in
738 buffer-local variables. If PERMANENT_TOO is 0,
739 we preserve those. */
740
741 static void
742 reset_buffer_local_variables (b, permanent_too)
743 register struct buffer *b;
744 int permanent_too;
745 {
746 register int offset;
747 int i;
748
749 /* Reset the major mode to Fundamental, together with all the
750 things that depend on the major mode.
751 default-major-mode is handled at a higher level.
752 We ignore it here. */
753 b->major_mode = Qfundamental_mode;
754 b->keymap = Qnil;
755 b->mode_name = QSFundamental;
756 b->minor_modes = Qnil;
757
758 /* If the standard case table has been altered and invalidated,
759 fix up its insides first. */
760 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
761 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
762 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
763 Fset_standard_case_table (Vascii_downcase_table);
764
765 b->downcase_table = Vascii_downcase_table;
766 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
767 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
768 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
769 b->invisibility_spec = Qt;
770 #ifndef DOS_NT
771 b->buffer_file_type = Qnil;
772 #endif
773
774 /* Reset all (or most) per-buffer variables to their defaults. */
775 b->local_var_alist = Qnil;
776 for (i = 0; i < last_per_buffer_idx; ++i)
777 if (permanent_too || buffer_permanent_local_flags[i] == 0)
778 SET_PER_BUFFER_VALUE_P (b, i, 0);
779
780 /* For each slot that has a default value,
781 copy that into the slot. */
782
783 for (offset = PER_BUFFER_VAR_OFFSET (name);
784 offset < sizeof *b;
785 offset += sizeof (Lisp_Object))
786 {
787 int idx = PER_BUFFER_IDX (offset);
788 if ((idx > 0
789 && (permanent_too
790 || buffer_permanent_local_flags[idx] == 0))
791 /* Is -2 used anywhere? */
792 || idx == -2)
793 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
794 }
795 }
796
797 /* We split this away from generate-new-buffer, because rename-buffer
798 and set-visited-file-name ought to be able to use this to really
799 rename the buffer properly. */
800
801 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
802 1, 2, 0,
803 doc: /* Return a string that is the name of no existing buffer based on NAME.
804 If there is no live buffer named NAME, then return NAME.
805 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
806 \(starting at 2) until an unused name is found, and then return that name.
807 Optional second argument IGNORE specifies a name that is okay to use (if
808 it is in the sequence to be tried) even if a buffer with that name exists. */)
809 (name, ignore)
810 register Lisp_Object name, ignore;
811 {
812 register Lisp_Object gentemp, tem;
813 int count;
814 char number[10];
815
816 CHECK_STRING (name);
817
818 tem = Fstring_equal (name, ignore);
819 if (!NILP (tem))
820 return name;
821 tem = Fget_buffer (name);
822 if (NILP (tem))
823 return name;
824
825 count = 1;
826 while (1)
827 {
828 sprintf (number, "<%d>", ++count);
829 gentemp = concat2 (name, build_string (number));
830 tem = Fstring_equal (gentemp, ignore);
831 if (!NILP (tem))
832 return gentemp;
833 tem = Fget_buffer (gentemp);
834 if (NILP (tem))
835 return gentemp;
836 }
837 }
838
839 \f
840 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
841 doc: /* Return the name of BUFFER, as a string.
842 With no argument or nil as argument, return the name of the current buffer. */)
843 (buffer)
844 register Lisp_Object buffer;
845 {
846 if (NILP (buffer))
847 return current_buffer->name;
848 CHECK_BUFFER (buffer);
849 return XBUFFER (buffer)->name;
850 }
851
852 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
853 doc: /* Return name of file BUFFER is visiting, or nil if none.
854 No argument or nil as argument means use the current buffer. */)
855 (buffer)
856 register Lisp_Object buffer;
857 {
858 if (NILP (buffer))
859 return current_buffer->filename;
860 CHECK_BUFFER (buffer);
861 return XBUFFER (buffer)->filename;
862 }
863
864 DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
865 0, 1, 0,
866 doc: /* Return the base buffer of indirect buffer BUFFER.
867 If BUFFER is not indirect, return nil.
868 BUFFER defaults to the current buffer. */)
869 (buffer)
870 register Lisp_Object buffer;
871 {
872 struct buffer *base;
873 Lisp_Object base_buffer;
874
875 if (NILP (buffer))
876 base = current_buffer->base_buffer;
877 else
878 {
879 CHECK_BUFFER (buffer);
880 base = XBUFFER (buffer)->base_buffer;
881 }
882
883 if (! base)
884 return Qnil;
885 XSETBUFFER (base_buffer, base);
886 return base_buffer;
887 }
888
889 DEFUN ("buffer-local-value", Fbuffer_local_value,
890 Sbuffer_local_value, 2, 2, 0,
891 doc: /* Return the value of VARIABLE in BUFFER.
892 If VARIABLE does not have a buffer-local binding in BUFFER, the value
893 is the default binding of the variable. */)
894 (variable, buffer)
895 register Lisp_Object variable;
896 register Lisp_Object buffer;
897 {
898 register struct buffer *buf;
899 register Lisp_Object result;
900
901 CHECK_SYMBOL (variable);
902 CHECK_BUFFER (buffer);
903 buf = XBUFFER (buffer);
904
905 if (SYMBOLP (variable))
906 variable = indirect_variable (variable);
907
908 /* Look in local_var_list */
909 result = Fassoc (variable, buf->local_var_alist);
910 if (NILP (result))
911 {
912 int offset, idx;
913 int found = 0;
914
915 /* Look in special slots */
916 for (offset = PER_BUFFER_VAR_OFFSET (name);
917 offset < sizeof (struct buffer);
918 /* sizeof EMACS_INT == sizeof Lisp_Object */
919 offset += (sizeof (EMACS_INT)))
920 {
921 idx = PER_BUFFER_IDX (offset);
922 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
923 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
924 && EQ (PER_BUFFER_SYMBOL (offset), variable))
925 {
926 result = PER_BUFFER_VALUE (buf, offset);
927 found = 1;
928 break;
929 }
930 }
931
932 if (!found)
933 result = Fdefault_value (variable);
934 }
935 else
936 {
937 Lisp_Object valcontents;
938 Lisp_Object current_alist_element;
939
940 /* What binding is loaded right now? */
941 valcontents = SYMBOL_VALUE (variable);
942 current_alist_element
943 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
944
945 /* The value of the currently loaded binding is not
946 stored in it, but rather in the realvalue slot.
947 Store that value into the binding it belongs to
948 in case that is the one we are about to use. */
949
950 Fsetcdr (current_alist_element,
951 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
952
953 /* Now get the (perhaps updated) value out of the binding. */
954 result = XCDR (result);
955 }
956
957 if (!EQ (result, Qunbound))
958 return result;
959
960 xsignal1 (Qvoid_variable, variable);
961 }
962
963 /* Return an alist of the Lisp-level buffer-local bindings of
964 buffer BUF. That is, don't include the variables maintained
965 in special slots in the buffer object. */
966
967 static Lisp_Object
968 buffer_lisp_local_variables (buf)
969 struct buffer *buf;
970 {
971 Lisp_Object result = Qnil;
972 register Lisp_Object tail;
973 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
974 {
975 Lisp_Object val, elt;
976
977 elt = XCAR (tail);
978
979 /* Reference each variable in the alist in buf.
980 If inquiring about the current buffer, this gets the current values,
981 so store them into the alist so the alist is up to date.
982 If inquiring about some other buffer, this swaps out any values
983 for that buffer, making the alist up to date automatically. */
984 val = find_symbol_value (XCAR (elt));
985 /* Use the current buffer value only if buf is the current buffer. */
986 if (buf != current_buffer)
987 val = XCDR (elt);
988
989 /* If symbol is unbound, put just the symbol in the list. */
990 if (EQ (val, Qunbound))
991 result = Fcons (XCAR (elt), result);
992 /* Otherwise, put (symbol . value) in the list. */
993 else
994 result = Fcons (Fcons (XCAR (elt), val), result);
995 }
996
997 return result;
998 }
999
1000 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
1001 Sbuffer_local_variables, 0, 1, 0,
1002 doc: /* Return an alist of variables that are buffer-local in BUFFER.
1003 Most elements look like (SYMBOL . VALUE), describing one variable.
1004 For a symbol that is locally unbound, just the symbol appears in the value.
1005 Note that storing new VALUEs in these elements doesn't change the variables.
1006 No argument or nil as argument means use current buffer as BUFFER. */)
1007 (buffer)
1008 register Lisp_Object buffer;
1009 {
1010 register struct buffer *buf;
1011 register Lisp_Object result;
1012
1013 if (NILP (buffer))
1014 buf = current_buffer;
1015 else
1016 {
1017 CHECK_BUFFER (buffer);
1018 buf = XBUFFER (buffer);
1019 }
1020
1021 result = buffer_lisp_local_variables (buf);
1022
1023 /* Add on all the variables stored in special slots. */
1024 {
1025 int offset, idx;
1026
1027 for (offset = PER_BUFFER_VAR_OFFSET (name);
1028 offset < sizeof (struct buffer);
1029 /* sizeof EMACS_INT == sizeof Lisp_Object */
1030 offset += (sizeof (EMACS_INT)))
1031 {
1032 idx = PER_BUFFER_IDX (offset);
1033 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1034 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1035 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1036 PER_BUFFER_VALUE (buf, offset)),
1037 result);
1038 }
1039 }
1040
1041 return result;
1042 }
1043 \f
1044 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1045 0, 1, 0,
1046 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1047 No argument or nil as argument means use current buffer as BUFFER. */)
1048 (buffer)
1049 register Lisp_Object buffer;
1050 {
1051 register struct buffer *buf;
1052 if (NILP (buffer))
1053 buf = current_buffer;
1054 else
1055 {
1056 CHECK_BUFFER (buffer);
1057 buf = XBUFFER (buffer);
1058 }
1059
1060 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1061 }
1062
1063 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1064 1, 1, 0,
1065 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1066 A non-nil FLAG means mark the buffer modified. */)
1067 (flag)
1068 register Lisp_Object flag;
1069 {
1070 register int already;
1071 register Lisp_Object fn;
1072 Lisp_Object buffer, window;
1073
1074 #ifdef CLASH_DETECTION
1075 /* If buffer becoming modified, lock the file.
1076 If buffer becoming unmodified, unlock the file. */
1077
1078 fn = current_buffer->file_truename;
1079 /* Test buffer-file-name so that binding it to nil is effective. */
1080 if (!NILP (fn) && ! NILP (current_buffer->filename))
1081 {
1082 already = SAVE_MODIFF < MODIFF;
1083 if (!already && !NILP (flag))
1084 lock_file (fn);
1085 else if (already && NILP (flag))
1086 unlock_file (fn);
1087 }
1088 #endif /* CLASH_DETECTION */
1089
1090 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1091
1092 /* Set update_mode_lines only if buffer is displayed in some window.
1093 Packages like jit-lock or lazy-lock preserve a buffer's modified
1094 state by recording/restoring the state around blocks of code.
1095 Setting update_mode_lines makes redisplay consider all windows
1096 (on all frames). Stealth fontification of buffers not displayed
1097 would incur additional redisplay costs if we'd set
1098 update_modes_lines unconditionally.
1099
1100 Ideally, I think there should be another mechanism for fontifying
1101 buffers without "modifying" buffers, or redisplay should be
1102 smarter about updating the `*' in mode lines. --gerd */
1103 XSETBUFFER (buffer, current_buffer);
1104 window = Fget_buffer_window (buffer, Qt);
1105 if (WINDOWP (window))
1106 {
1107 ++update_mode_lines;
1108 current_buffer->prevent_redisplay_optimizations_p = 1;
1109 }
1110
1111 return flag;
1112 }
1113
1114 DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1115 Srestore_buffer_modified_p, 1, 1, 0,
1116 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1117 It is not ensured that mode lines will be updated to show the modified
1118 state of the current buffer. Use with care. */)
1119 (flag)
1120 Lisp_Object flag;
1121 {
1122 #ifdef CLASH_DETECTION
1123 Lisp_Object fn;
1124
1125 /* If buffer becoming modified, lock the file.
1126 If buffer becoming unmodified, unlock the file. */
1127
1128 fn = current_buffer->file_truename;
1129 /* Test buffer-file-name so that binding it to nil is effective. */
1130 if (!NILP (fn) && ! NILP (current_buffer->filename))
1131 {
1132 int already = SAVE_MODIFF < MODIFF;
1133 if (!already && !NILP (flag))
1134 lock_file (fn);
1135 else if (already && NILP (flag))
1136 unlock_file (fn);
1137 }
1138 #endif /* CLASH_DETECTION */
1139
1140 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1141 return flag;
1142 }
1143
1144 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1145 0, 1, 0,
1146 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1147 Each buffer has a tick counter which is incremented each time the
1148 text in that buffer is changed. It wraps around occasionally.
1149 No argument or nil as argument means use current buffer as BUFFER. */)
1150 (buffer)
1151 register Lisp_Object buffer;
1152 {
1153 register struct buffer *buf;
1154 if (NILP (buffer))
1155 buf = current_buffer;
1156 else
1157 {
1158 CHECK_BUFFER (buffer);
1159 buf = XBUFFER (buffer);
1160 }
1161
1162 return make_number (BUF_MODIFF (buf));
1163 }
1164
1165 DEFUN ("buffer-chars-modified-tick", Fbuffer_chars_modified_tick,
1166 Sbuffer_chars_modified_tick, 0, 1, 0,
1167 doc: /* Return BUFFER's character-change tick counter.
1168 Each buffer has a character-change tick counter, which is set to the
1169 value of the buffer's tick counter \(see `buffer-modified-tick'), each
1170 time text in that buffer is inserted or deleted. By comparing the
1171 values returned by two individual calls of `buffer-chars-modified-tick',
1172 you can tell whether a character change occurred in that buffer in
1173 between these calls. No argument or nil as argument means use current
1174 buffer as BUFFER. */)
1175 (buffer)
1176 register Lisp_Object buffer;
1177 {
1178 register struct buffer *buf;
1179 if (NILP (buffer))
1180 buf = current_buffer;
1181 else
1182 {
1183 CHECK_BUFFER (buffer);
1184 buf = XBUFFER (buffer);
1185 }
1186
1187 return make_number (BUF_CHARS_MODIFF (buf));
1188 }
1189 \f
1190 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1191 "sRename buffer (to new name): \nP",
1192 doc: /* Change current buffer's name to NEWNAME (a string).
1193 If second arg UNIQUE is nil or omitted, it is an error if a
1194 buffer named NEWNAME already exists.
1195 If UNIQUE is non-nil, come up with a new name using
1196 `generate-new-buffer-name'.
1197 Interactively, you can set UNIQUE with a prefix argument.
1198 We return the name we actually gave the buffer.
1199 This does not change the name of the visited file (if any). */)
1200 (newname, unique)
1201 register Lisp_Object newname, unique;
1202 {
1203 register Lisp_Object tem, buf;
1204
1205 CHECK_STRING (newname);
1206
1207 if (SCHARS (newname) == 0)
1208 error ("Empty string is invalid as a buffer name");
1209
1210 tem = Fget_buffer (newname);
1211 if (!NILP (tem))
1212 {
1213 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1214 rename the buffer automatically so you can create another
1215 with the original name. It makes UNIQUE equivalent to
1216 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1217 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1218 return current_buffer->name;
1219 if (!NILP (unique))
1220 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1221 else
1222 error ("Buffer name `%s' is in use", SDATA (newname));
1223 }
1224
1225 current_buffer->name = newname;
1226
1227 /* Catch redisplay's attention. Unless we do this, the mode lines for
1228 any windows displaying current_buffer will stay unchanged. */
1229 update_mode_lines++;
1230
1231 XSETBUFFER (buf, current_buffer);
1232 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1233 if (NILP (current_buffer->filename)
1234 && !NILP (current_buffer->auto_save_file_name))
1235 call0 (intern ("rename-auto-save-file"));
1236 /* Refetch since that last call may have done GC. */
1237 return current_buffer->name;
1238 }
1239
1240 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1241 doc: /* Return most recently selected buffer other than BUFFER.
1242 Buffers not visible in windows are preferred to visible buffers,
1243 unless optional second argument VISIBLE-OK is non-nil.
1244 If the optional third argument FRAME is non-nil, use that frame's
1245 buffer list instead of the selected frame's buffer list.
1246 If no other buffer exists, the buffer `*scratch*' is returned.
1247 If BUFFER is omitted or nil, some interesting buffer is returned. */)
1248 (buffer, visible_ok, frame)
1249 register Lisp_Object buffer, visible_ok, frame;
1250 {
1251 Lisp_Object Fset_buffer_major_mode ();
1252 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1253 notsogood = Qnil;
1254
1255 if (NILP (frame))
1256 frame = selected_frame;
1257
1258 tail = Vbuffer_alist;
1259 pred = frame_buffer_predicate (frame);
1260
1261 /* Consider buffers that have been seen in the selected frame
1262 before other buffers. */
1263
1264 tem = frame_buffer_list (frame);
1265 add_ons = Qnil;
1266 while (CONSP (tem))
1267 {
1268 if (BUFFERP (XCAR (tem)))
1269 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1270 tem = XCDR (tem);
1271 }
1272 tail = nconc2 (Fnreverse (add_ons), tail);
1273
1274 for (; CONSP (tail); tail = XCDR (tail))
1275 {
1276 buf = Fcdr (XCAR (tail));
1277 if (EQ (buf, buffer))
1278 continue;
1279 if (NILP (buf))
1280 continue;
1281 if (NILP (XBUFFER (buf)->name))
1282 continue;
1283 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1284 continue;
1285 /* If the selected frame has a buffer_predicate,
1286 disregard buffers that don't fit the predicate. */
1287 if (!NILP (pred))
1288 {
1289 tem = call1 (pred, buf);
1290 if (NILP (tem))
1291 continue;
1292 }
1293
1294 if (NILP (visible_ok))
1295 tem = Fget_buffer_window (buf, Qvisible);
1296 else
1297 tem = Qnil;
1298 if (NILP (tem))
1299 return buf;
1300 if (NILP (notsogood))
1301 notsogood = buf;
1302 }
1303 if (!NILP (notsogood))
1304 return notsogood;
1305 buf = Fget_buffer (build_string ("*scratch*"));
1306 if (NILP (buf))
1307 {
1308 buf = Fget_buffer_create (build_string ("*scratch*"));
1309 Fset_buffer_major_mode (buf);
1310 }
1311 return buf;
1312 }
1313 \f
1314 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1315 0, 1, "",
1316 doc: /* Start keeping undo information for buffer BUFFER.
1317 No argument or nil as argument means do this for the current buffer. */)
1318 (buffer)
1319 register Lisp_Object buffer;
1320 {
1321 Lisp_Object real_buffer;
1322
1323 if (NILP (buffer))
1324 XSETBUFFER (real_buffer, current_buffer);
1325 else
1326 {
1327 real_buffer = Fget_buffer (buffer);
1328 if (NILP (real_buffer))
1329 nsberror (buffer);
1330 }
1331
1332 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1333 XBUFFER (real_buffer)->undo_list = Qnil;
1334
1335 return Qnil;
1336 }
1337
1338 /*
1339 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1340 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1341 The buffer being killed will be current while the hook is running.\n\
1342 See `kill-buffer'."
1343 */
1344 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1345 doc: /* Kill the buffer BUFFER.
1346 The argument may be a buffer or the name of a buffer.
1347 With a nil argument, kill the current buffer.
1348
1349 Value is t if the buffer is actually killed, nil otherwise.
1350
1351 The functions in `kill-buffer-query-functions' are called with BUFFER as
1352 the current buffer. If any of them returns nil, the buffer is not killed.
1353
1354 The hook `kill-buffer-hook' is run before the buffer is actually killed.
1355 The buffer being killed will be current while the hook is running.
1356
1357 Any processes that have this buffer as the `process-buffer' are killed
1358 with SIGHUP. */)
1359 (buffer)
1360 Lisp_Object buffer;
1361 {
1362 Lisp_Object buf;
1363 register struct buffer *b;
1364 register Lisp_Object tem;
1365 register struct Lisp_Marker *m;
1366 struct gcpro gcpro1;
1367
1368 if (NILP (buffer))
1369 buf = Fcurrent_buffer ();
1370 else
1371 buf = Fget_buffer (buffer);
1372 if (NILP (buf))
1373 nsberror (buffer);
1374
1375 b = XBUFFER (buf);
1376
1377 /* Avoid trouble for buffer already dead. */
1378 if (NILP (b->name))
1379 return Qnil;
1380
1381 /* Query if the buffer is still modified. */
1382 if (INTERACTIVE && !NILP (b->filename)
1383 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1384 {
1385 GCPRO1 (buf);
1386 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1387 b->name, make_number (0)));
1388 UNGCPRO;
1389 if (NILP (tem))
1390 return Qnil;
1391 }
1392
1393 /* Run hooks with the buffer to be killed the current buffer. */
1394 {
1395 int count = SPECPDL_INDEX ();
1396 Lisp_Object arglist[1];
1397
1398 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1399 set_buffer_internal (b);
1400
1401 /* First run the query functions; if any query is answered no,
1402 don't kill the buffer. */
1403 arglist[0] = Qkill_buffer_query_functions;
1404 tem = Frun_hook_with_args_until_failure (1, arglist);
1405 if (NILP (tem))
1406 return unbind_to (count, Qnil);
1407
1408 /* Then run the hooks. */
1409 Frun_hooks (1, &Qkill_buffer_hook);
1410 unbind_to (count, Qnil);
1411 }
1412
1413 /* We have no more questions to ask. Verify that it is valid
1414 to kill the buffer. This must be done after the questions
1415 since anything can happen within do_yes_or_no_p. */
1416
1417 /* Don't kill the minibuffer now current. */
1418 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1419 return Qnil;
1420
1421 if (NILP (b->name))
1422 return Qnil;
1423
1424 /* When we kill a base buffer, kill all its indirect buffers.
1425 We do it at this stage so nothing terrible happens if they
1426 ask questions or their hooks get errors. */
1427 if (! b->base_buffer)
1428 {
1429 struct buffer *other;
1430
1431 GCPRO1 (buf);
1432
1433 for (other = all_buffers; other; other = other->next)
1434 /* all_buffers contains dead buffers too;
1435 don't re-kill them. */
1436 if (other->base_buffer == b && !NILP (other->name))
1437 {
1438 Lisp_Object buf;
1439 XSETBUFFER (buf, other);
1440 Fkill_buffer (buf);
1441 }
1442
1443 UNGCPRO;
1444 }
1445
1446 /* Make this buffer not be current.
1447 In the process, notice if this is the sole visible buffer
1448 and give up if so. */
1449 if (b == current_buffer)
1450 {
1451 tem = Fother_buffer (buf, Qnil, Qnil);
1452 Fset_buffer (tem);
1453 if (b == current_buffer)
1454 return Qnil;
1455 }
1456
1457 /* Notice if the buffer to kill is the sole visible buffer
1458 when we're currently in the mini-buffer, and give up if so. */
1459 XSETBUFFER (tem, current_buffer);
1460 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1461 {
1462 tem = Fother_buffer (buf, Qnil, Qnil);
1463 if (EQ (buf, tem))
1464 return Qnil;
1465 }
1466
1467 /* Now there is no question: we can kill the buffer. */
1468
1469 #ifdef CLASH_DETECTION
1470 /* Unlock this buffer's file, if it is locked. */
1471 unlock_buffer (b);
1472 #endif /* CLASH_DETECTION */
1473
1474 GCPRO1 (buf);
1475 kill_buffer_processes (buf);
1476 UNGCPRO;
1477
1478 /* Killing buffer processes may run sentinels which may
1479 have called kill-buffer. */
1480
1481 if (NILP (b->name))
1482 return Qnil;
1483
1484 clear_charpos_cache (b);
1485
1486 tem = Vinhibit_quit;
1487 Vinhibit_quit = Qt;
1488 replace_buffer_in_all_windows (buf);
1489 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1490 frames_discard_buffer (buf);
1491 Vinhibit_quit = tem;
1492
1493 /* Delete any auto-save file, if we saved it in this session.
1494 But not if the buffer is modified. */
1495 if (STRINGP (b->auto_save_file_name)
1496 && b->auto_save_modified != 0
1497 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1498 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1499 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1500 {
1501 Lisp_Object tem;
1502 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1503 if (! NILP (tem))
1504 internal_delete_file (b->auto_save_file_name);
1505 }
1506
1507 if (b->base_buffer)
1508 {
1509 /* Unchain all markers that belong to this indirect buffer.
1510 Don't unchain the markers that belong to the base buffer
1511 or its other indirect buffers. */
1512 for (m = BUF_MARKERS (b); m; )
1513 {
1514 struct Lisp_Marker *next = m->next;
1515 if (m->buffer == b)
1516 unchain_marker (m);
1517 m = next;
1518 }
1519 }
1520 else
1521 {
1522 /* Unchain all markers of this buffer and its indirect buffers.
1523 and leave them pointing nowhere. */
1524 for (m = BUF_MARKERS (b); m; )
1525 {
1526 struct Lisp_Marker *next = m->next;
1527 m->buffer = 0;
1528 m->next = NULL;
1529 m = next;
1530 }
1531 BUF_MARKERS (b) = NULL;
1532 BUF_INTERVALS (b) = NULL_INTERVAL;
1533
1534 /* Perhaps we should explicitly free the interval tree here... */
1535 }
1536
1537 /* Reset the local variables, so that this buffer's local values
1538 won't be protected from GC. They would be protected
1539 if they happened to remain encached in their symbols.
1540 This gets rid of them for certain. */
1541 swap_out_buffer_local_variables (b);
1542 reset_buffer_local_variables (b, 1);
1543
1544 b->name = Qnil;
1545
1546 BLOCK_INPUT;
1547 if (! b->base_buffer)
1548 free_buffer_text (b);
1549
1550 if (b->newline_cache)
1551 {
1552 free_region_cache (b->newline_cache);
1553 b->newline_cache = 0;
1554 }
1555 if (b->width_run_cache)
1556 {
1557 free_region_cache (b->width_run_cache);
1558 b->width_run_cache = 0;
1559 }
1560 b->width_table = Qnil;
1561 UNBLOCK_INPUT;
1562 b->undo_list = Qnil;
1563
1564 return Qt;
1565 }
1566 \f
1567 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
1568 we do this each time BUF is selected visibly, the more recently
1569 selected buffers are always closer to the front of the list. This
1570 means that other_buffer is more likely to choose a relevant buffer. */
1571
1572 void
1573 record_buffer (buf)
1574 Lisp_Object buf;
1575 {
1576 register Lisp_Object link, prev;
1577 Lisp_Object frame;
1578 frame = selected_frame;
1579
1580 prev = Qnil;
1581 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1582 {
1583 if (EQ (XCDR (XCAR (link)), buf))
1584 break;
1585 prev = link;
1586 }
1587
1588 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1589 we cannot use Fdelq itself here because it allows quitting. */
1590
1591 if (NILP (prev))
1592 Vbuffer_alist = XCDR (Vbuffer_alist);
1593 else
1594 XSETCDR (prev, XCDR (XCDR (prev)));
1595
1596 XSETCDR (link, Vbuffer_alist);
1597 Vbuffer_alist = link;
1598
1599 /* Effectively do a delq on buried_buffer_list. */
1600
1601 prev = Qnil;
1602 for (link = XFRAME (frame)->buried_buffer_list; CONSP (link);
1603 link = XCDR (link))
1604 {
1605 if (EQ (XCAR (link), buf))
1606 {
1607 if (NILP (prev))
1608 XFRAME (frame)->buried_buffer_list = XCDR (link);
1609 else
1610 XSETCDR (prev, XCDR (XCDR (prev)));
1611 break;
1612 }
1613 prev = link;
1614 }
1615
1616 /* Now move this buffer to the front of frame_buffer_list also. */
1617
1618 prev = Qnil;
1619 for (link = frame_buffer_list (frame); CONSP (link);
1620 link = XCDR (link))
1621 {
1622 if (EQ (XCAR (link), buf))
1623 break;
1624 prev = link;
1625 }
1626
1627 /* Effectively do delq. */
1628
1629 if (CONSP (link))
1630 {
1631 if (NILP (prev))
1632 set_frame_buffer_list (frame,
1633 XCDR (frame_buffer_list (frame)));
1634 else
1635 XSETCDR (prev, XCDR (XCDR (prev)));
1636
1637 XSETCDR (link, frame_buffer_list (frame));
1638 set_frame_buffer_list (frame, link);
1639 }
1640 else
1641 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1642 }
1643
1644 DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1645 doc: /* Set an appropriate major mode for BUFFER.
1646 For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1647 according to `default-major-mode'.
1648 Use this function before selecting the buffer, since it may need to inspect
1649 the current buffer's major mode. */)
1650 (buffer)
1651 Lisp_Object buffer;
1652 {
1653 int count;
1654 Lisp_Object function;
1655
1656 CHECK_BUFFER (buffer);
1657
1658 if (STRINGP (XBUFFER (buffer)->name)
1659 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1660 function = find_symbol_value (intern ("initial-major-mode"));
1661 else
1662 {
1663 function = buffer_defaults.major_mode;
1664 if (NILP (function)
1665 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1666 function = current_buffer->major_mode;
1667 }
1668
1669 if (NILP (function) || EQ (function, Qfundamental_mode))
1670 return Qnil;
1671
1672 count = SPECPDL_INDEX ();
1673
1674 /* To select a nonfundamental mode,
1675 select the buffer temporarily and then call the mode function. */
1676
1677 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1678
1679 Fset_buffer (buffer);
1680 call0 (function);
1681
1682 return unbind_to (count, Qnil);
1683 }
1684
1685 /* If switching buffers in WINDOW would be an error, return
1686 a C string saying what the error would be. */
1687
1688 char *
1689 no_switch_window (window)
1690 Lisp_Object window;
1691 {
1692 Lisp_Object tem;
1693 if (EQ (minibuf_window, window))
1694 return "Cannot switch buffers in minibuffer window";
1695 tem = Fwindow_dedicated_p (window);
1696 if (EQ (tem, Qt))
1697 return "Cannot switch buffers in a dedicated window";
1698 return NULL;
1699 }
1700
1701 /* Switch to buffer BUFFER in the selected window.
1702 If NORECORD is non-nil, don't call record_buffer. */
1703
1704 Lisp_Object
1705 switch_to_buffer_1 (buffer, norecord)
1706 Lisp_Object buffer, norecord;
1707 {
1708 register Lisp_Object buf;
1709
1710 if (NILP (buffer))
1711 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1712 else
1713 {
1714 buf = Fget_buffer (buffer);
1715 if (NILP (buf))
1716 {
1717 buf = Fget_buffer_create (buffer);
1718 Fset_buffer_major_mode (buf);
1719 }
1720 }
1721 Fset_buffer (buf);
1722 if (NILP (norecord))
1723 record_buffer (buf);
1724
1725 Fset_window_buffer (EQ (selected_window, minibuf_window)
1726 ? Fnext_window (minibuf_window, Qnil, Qnil)
1727 : selected_window,
1728 buf, Qnil);
1729
1730 return buf;
1731 }
1732
1733 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1734 doc: /* Select buffer BUFFER in the current window.
1735 If BUFFER does not identify an existing buffer,
1736 then this function creates a buffer with that name.
1737
1738 When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1739 or nil. If BUFFER is nil, then this function chooses a buffer
1740 using `other-buffer'.
1741 Optional second arg NORECORD non-nil means
1742 do not put this buffer at the front of the list of recently selected ones.
1743 This function returns the buffer it switched to.
1744
1745 WARNING: This is NOT the way to work on another buffer temporarily
1746 within a Lisp program! Use `set-buffer' instead. That avoids messing with
1747 the window-buffer correspondences. */)
1748 (buffer, norecord)
1749 Lisp_Object buffer, norecord;
1750 {
1751 char *err;
1752
1753 if (EQ (buffer, Fwindow_buffer (selected_window)))
1754 {
1755 /* Basically a NOP. Avoid signalling an error in the case where
1756 the selected window is dedicated, or a minibuffer. */
1757
1758 /* But do put this buffer at the front of the buffer list,
1759 unless that has been inhibited. Note that even if
1760 BUFFER is at the front of the main buffer-list already,
1761 we still want to move it to the front of the frame's buffer list. */
1762 if (NILP (norecord))
1763 record_buffer (buffer);
1764 return Fset_buffer (buffer);
1765 }
1766
1767 err = no_switch_window (selected_window);
1768 if (err) error (err);
1769
1770 return switch_to_buffer_1 (buffer, norecord);
1771 }
1772
1773 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1774 doc: /* Select buffer BUFFER in some window, preferably a different one.
1775 BUFFER may be a buffer, a string \(a buffer name), or nil.
1776 If BUFFER is a string which is not the name of an existing buffer,
1777 then this function creates a buffer with that name.
1778 If BUFFER is nil, then it chooses some other buffer.
1779 If `pop-up-windows' is non-nil, windows can be split to do this.
1780 If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1781 window even if BUFFER is already visible in the selected window,
1782 and ignore `same-window-regexps' and `same-window-buffer-names'.
1783 This function returns the buffer it switched to.
1784 This uses the function `display-buffer' as a subroutine; see the documentation
1785 of `display-buffer' for additional customization information.
1786
1787 Optional third arg NORECORD non-nil means
1788 do not put this buffer at the front of the list of recently selected ones. */)
1789 (buffer, other_window, norecord)
1790 Lisp_Object buffer, other_window, norecord;
1791 {
1792 register Lisp_Object buf;
1793 if (NILP (buffer))
1794 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1795 else
1796 {
1797 buf = Fget_buffer (buffer);
1798 if (NILP (buf))
1799 {
1800 buf = Fget_buffer_create (buffer);
1801 Fset_buffer_major_mode (buf);
1802 }
1803 }
1804 Fset_buffer (buf);
1805 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1806 return buf;
1807 }
1808
1809 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1810 doc: /* Return the current buffer as a Lisp object. */)
1811 ()
1812 {
1813 register Lisp_Object buf;
1814 XSETBUFFER (buf, current_buffer);
1815 return buf;
1816 }
1817 \f
1818 /* Set the current buffer to B.
1819
1820 We previously set windows_or_buffers_changed here to invalidate
1821 global unchanged information in beg_unchanged and end_unchanged.
1822 This is no longer necessary because we now compute unchanged
1823 information on a buffer-basis. Every action affecting other
1824 windows than the selected one requires a select_window at some
1825 time, and that increments windows_or_buffers_changed. */
1826
1827 void
1828 set_buffer_internal (b)
1829 register struct buffer *b;
1830 {
1831 if (current_buffer != b)
1832 set_buffer_internal_1 (b);
1833 }
1834
1835 /* Set the current buffer to B, and do not set windows_or_buffers_changed.
1836 This is used by redisplay. */
1837
1838 void
1839 set_buffer_internal_1 (b)
1840 register struct buffer *b;
1841 {
1842 register struct buffer *old_buf;
1843 register Lisp_Object tail, valcontents;
1844 Lisp_Object tem;
1845
1846 #ifdef USE_MMAP_FOR_BUFFERS
1847 if (b->text->beg == NULL)
1848 enlarge_buffer_text (b, 0);
1849 #endif /* USE_MMAP_FOR_BUFFERS */
1850
1851 if (current_buffer == b)
1852 return;
1853
1854 old_buf = current_buffer;
1855 current_buffer = b;
1856 last_known_column_point = -1; /* invalidate indentation cache */
1857
1858 if (old_buf)
1859 {
1860 /* Put the undo list back in the base buffer, so that it appears
1861 that an indirect buffer shares the undo list of its base. */
1862 if (old_buf->base_buffer)
1863 old_buf->base_buffer->undo_list = old_buf->undo_list;
1864
1865 /* If the old current buffer has markers to record PT, BEGV and ZV
1866 when it is not current, update them now. */
1867 if (! NILP (old_buf->pt_marker))
1868 {
1869 Lisp_Object obuf;
1870 XSETBUFFER (obuf, old_buf);
1871 set_marker_both (old_buf->pt_marker, obuf,
1872 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1873 }
1874 if (! NILP (old_buf->begv_marker))
1875 {
1876 Lisp_Object obuf;
1877 XSETBUFFER (obuf, old_buf);
1878 set_marker_both (old_buf->begv_marker, obuf,
1879 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1880 }
1881 if (! NILP (old_buf->zv_marker))
1882 {
1883 Lisp_Object obuf;
1884 XSETBUFFER (obuf, old_buf);
1885 set_marker_both (old_buf->zv_marker, obuf,
1886 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1887 }
1888 }
1889
1890 /* Get the undo list from the base buffer, so that it appears
1891 that an indirect buffer shares the undo list of its base. */
1892 if (b->base_buffer)
1893 b->undo_list = b->base_buffer->undo_list;
1894
1895 /* If the new current buffer has markers to record PT, BEGV and ZV
1896 when it is not current, fetch them now. */
1897 if (! NILP (b->pt_marker))
1898 {
1899 BUF_PT (b) = marker_position (b->pt_marker);
1900 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1901 }
1902 if (! NILP (b->begv_marker))
1903 {
1904 BUF_BEGV (b) = marker_position (b->begv_marker);
1905 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1906 }
1907 if (! NILP (b->zv_marker))
1908 {
1909 BUF_ZV (b) = marker_position (b->zv_marker);
1910 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1911 }
1912
1913 /* Look down buffer's list of local Lisp variables
1914 to find and update any that forward into C variables. */
1915
1916 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1917 {
1918 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1919 if ((BUFFER_LOCAL_VALUEP (valcontents)
1920 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1921 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1922 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1923 /* Just reference the variable
1924 to cause it to become set for this buffer. */
1925 Fsymbol_value (XCAR (XCAR (tail)));
1926 }
1927
1928 /* Do the same with any others that were local to the previous buffer */
1929
1930 if (old_buf)
1931 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1932 {
1933 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1934 if ((BUFFER_LOCAL_VALUEP (valcontents)
1935 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1936 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1937 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1938 /* Just reference the variable
1939 to cause it to become set for this buffer. */
1940 Fsymbol_value (XCAR (XCAR (tail)));
1941 }
1942 }
1943
1944 /* Switch to buffer B temporarily for redisplay purposes.
1945 This avoids certain things that don't need to be done within redisplay. */
1946
1947 void
1948 set_buffer_temp (b)
1949 struct buffer *b;
1950 {
1951 register struct buffer *old_buf;
1952
1953 if (current_buffer == b)
1954 return;
1955
1956 old_buf = current_buffer;
1957 current_buffer = b;
1958
1959 if (old_buf)
1960 {
1961 /* If the old current buffer has markers to record PT, BEGV and ZV
1962 when it is not current, update them now. */
1963 if (! NILP (old_buf->pt_marker))
1964 {
1965 Lisp_Object obuf;
1966 XSETBUFFER (obuf, old_buf);
1967 set_marker_both (old_buf->pt_marker, obuf,
1968 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1969 }
1970 if (! NILP (old_buf->begv_marker))
1971 {
1972 Lisp_Object obuf;
1973 XSETBUFFER (obuf, old_buf);
1974 set_marker_both (old_buf->begv_marker, obuf,
1975 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1976 }
1977 if (! NILP (old_buf->zv_marker))
1978 {
1979 Lisp_Object obuf;
1980 XSETBUFFER (obuf, old_buf);
1981 set_marker_both (old_buf->zv_marker, obuf,
1982 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1983 }
1984 }
1985
1986 /* If the new current buffer has markers to record PT, BEGV and ZV
1987 when it is not current, fetch them now. */
1988 if (! NILP (b->pt_marker))
1989 {
1990 BUF_PT (b) = marker_position (b->pt_marker);
1991 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1992 }
1993 if (! NILP (b->begv_marker))
1994 {
1995 BUF_BEGV (b) = marker_position (b->begv_marker);
1996 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1997 }
1998 if (! NILP (b->zv_marker))
1999 {
2000 BUF_ZV (b) = marker_position (b->zv_marker);
2001 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
2002 }
2003 }
2004
2005 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
2006 doc: /* Make the buffer BUFFER current for editing operations.
2007 BUFFER may be a buffer or the name of an existing buffer.
2008 See also `save-excursion' when you want to make a buffer current temporarily.
2009 This function does not display the buffer, so its effect ends
2010 when the current command terminates.
2011 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
2012 (buffer)
2013 register Lisp_Object buffer;
2014 {
2015 register Lisp_Object buf;
2016 buf = Fget_buffer (buffer);
2017 if (NILP (buf))
2018 nsberror (buffer);
2019 if (NILP (XBUFFER (buf)->name))
2020 error ("Selecting deleted buffer");
2021 set_buffer_internal (XBUFFER (buf));
2022 return buf;
2023 }
2024
2025 /* Set the current buffer to BUFFER provided it is alive. */
2026
2027 Lisp_Object
2028 set_buffer_if_live (buffer)
2029 Lisp_Object buffer;
2030 {
2031 if (! NILP (XBUFFER (buffer)->name))
2032 Fset_buffer (buffer);
2033 return Qnil;
2034 }
2035 \f
2036 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
2037 Sbarf_if_buffer_read_only, 0, 0, 0,
2038 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
2039 ()
2040 {
2041 if (!NILP (current_buffer->read_only)
2042 && NILP (Vinhibit_read_only))
2043 xsignal1 (Qbuffer_read_only, Fcurrent_buffer ());
2044 return Qnil;
2045 }
2046
2047 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
2048 doc: /* Put BUFFER at the end of the list of all buffers.
2049 There it is the least likely candidate for `other-buffer' to return;
2050 thus, the least likely buffer for \\[switch-to-buffer] to select by default.
2051 You can specify a buffer name as BUFFER, or an actual buffer object.
2052 If BUFFER is nil or omitted, bury the current buffer.
2053 Also, if BUFFER is nil or omitted, remove the current buffer from the
2054 selected window if it is displayed there. */)
2055 (buffer)
2056 register Lisp_Object buffer;
2057 {
2058 /* Figure out what buffer we're going to bury. */
2059 if (NILP (buffer))
2060 {
2061 Lisp_Object tem;
2062 XSETBUFFER (buffer, current_buffer);
2063
2064 tem = Fwindow_buffer (selected_window);
2065 /* If we're burying the current buffer, unshow it. */
2066 if (EQ (buffer, tem))
2067 {
2068 if (NILP (Fwindow_dedicated_p (selected_window)))
2069 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
2070 else if (NILP (XWINDOW (selected_window)->parent))
2071 Ficonify_frame (Fwindow_frame (selected_window));
2072 else
2073 Fdelete_window (selected_window);
2074 }
2075 }
2076 else
2077 {
2078 Lisp_Object buf1;
2079
2080 buf1 = Fget_buffer (buffer);
2081 if (NILP (buf1))
2082 nsberror (buffer);
2083 buffer = buf1;
2084 }
2085
2086 /* Move buffer to the end of the buffer list. Do nothing if the
2087 buffer is killed. */
2088 if (!NILP (XBUFFER (buffer)->name))
2089 {
2090 Lisp_Object aelt, link;
2091
2092 aelt = Frassq (buffer, Vbuffer_alist);
2093 link = Fmemq (aelt, Vbuffer_alist);
2094 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2095 XSETCDR (link, Qnil);
2096 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2097
2098 XFRAME (selected_frame)->buffer_list
2099 = Fdelq (buffer, XFRAME (selected_frame)->buffer_list);
2100 XFRAME (selected_frame)->buried_buffer_list
2101 = Fcons (buffer, Fdelq (buffer, XFRAME (selected_frame)->buried_buffer_list));
2102 }
2103
2104 return Qnil;
2105 }
2106 \f
2107 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2108 doc: /* Delete the entire contents of the current buffer.
2109 Any narrowing restriction in effect (see `narrow-to-region') is removed,
2110 so the buffer is truly empty after this. */)
2111 ()
2112 {
2113 Fwiden ();
2114
2115 del_range (BEG, Z);
2116
2117 current_buffer->last_window_start = 1;
2118 /* Prevent warnings, or suspension of auto saving, that would happen
2119 if future size is less than past size. Use of erase-buffer
2120 implies that the future text is not really related to the past text. */
2121 XSETFASTINT (current_buffer->save_length, 0);
2122 return Qnil;
2123 }
2124
2125 void
2126 validate_region (b, e)
2127 register Lisp_Object *b, *e;
2128 {
2129 CHECK_NUMBER_COERCE_MARKER (*b);
2130 CHECK_NUMBER_COERCE_MARKER (*e);
2131
2132 if (XINT (*b) > XINT (*e))
2133 {
2134 Lisp_Object tem;
2135 tem = *b; *b = *e; *e = tem;
2136 }
2137
2138 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2139 && XINT (*e) <= ZV))
2140 args_out_of_range (*b, *e);
2141 }
2142 \f
2143 /* Advance BYTE_POS up to a character boundary
2144 and return the adjusted position. */
2145
2146 static int
2147 advance_to_char_boundary (byte_pos)
2148 int byte_pos;
2149 {
2150 int c;
2151
2152 if (byte_pos == BEG)
2153 /* Beginning of buffer is always a character boundary. */
2154 return BEG;
2155
2156 c = FETCH_BYTE (byte_pos);
2157 if (! CHAR_HEAD_P (c))
2158 {
2159 /* We should advance BYTE_POS only when C is a constituent of a
2160 multibyte sequence. */
2161 int orig_byte_pos = byte_pos;
2162
2163 do
2164 {
2165 byte_pos--;
2166 c = FETCH_BYTE (byte_pos);
2167 }
2168 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2169 INC_POS (byte_pos);
2170 if (byte_pos < orig_byte_pos)
2171 byte_pos = orig_byte_pos;
2172 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2173 surely advance to the correct character boundary. If C is
2174 not, BYTE_POS was unchanged. */
2175 }
2176
2177 return byte_pos;
2178 }
2179
2180 DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2181 1, 1, 0,
2182 doc: /* Set the multibyte flag of the current buffer to FLAG.
2183 If FLAG is t, this makes the buffer a multibyte buffer.
2184 If FLAG is nil, this makes the buffer a single-byte buffer.
2185 The buffer contents remain unchanged as a sequence of bytes
2186 but the contents viewed as characters do change.
2187 If the multibyte flag was really changed, undo information of the
2188 current buffer is cleared. */)
2189 (flag)
2190 Lisp_Object flag;
2191 {
2192 struct Lisp_Marker *tail, *markers;
2193 struct buffer *other;
2194 int begv, zv;
2195 int narrowed = (BEG != BEGV || Z != ZV);
2196 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2197 Lisp_Object old_undo = current_buffer->undo_list;
2198 struct gcpro gcpro1;
2199
2200 if (current_buffer->base_buffer)
2201 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2202
2203 /* Do nothing if nothing actually changes. */
2204 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2205 return flag;
2206
2207 GCPRO1 (old_undo);
2208
2209 /* Don't record these buffer changes. We will put a special undo entry
2210 instead. */
2211 current_buffer->undo_list = Qt;
2212
2213 /* If the cached position is for this buffer, clear it out. */
2214 clear_charpos_cache (current_buffer);
2215
2216 if (NILP (flag))
2217 begv = BEGV_BYTE, zv = ZV_BYTE;
2218 else
2219 begv = BEGV, zv = ZV;
2220
2221 if (narrowed)
2222 Fwiden ();
2223
2224 if (NILP (flag))
2225 {
2226 int pos, stop;
2227 unsigned char *p;
2228
2229 /* Do this first, so it can use CHAR_TO_BYTE
2230 to calculate the old correspondences. */
2231 set_intervals_multibyte (0);
2232
2233 current_buffer->enable_multibyte_characters = Qnil;
2234
2235 Z = Z_BYTE;
2236 BEGV = BEGV_BYTE;
2237 ZV = ZV_BYTE;
2238 GPT = GPT_BYTE;
2239 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2240
2241
2242 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2243 tail->charpos = tail->bytepos;
2244
2245 /* Convert multibyte form of 8-bit characters to unibyte. */
2246 pos = BEG;
2247 stop = GPT;
2248 p = BEG_ADDR;
2249 while (1)
2250 {
2251 int c, bytes;
2252
2253 if (pos == stop)
2254 {
2255 if (pos == Z)
2256 break;
2257 p = GAP_END_ADDR;
2258 stop = Z;
2259 }
2260 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2261 p += bytes, pos += bytes;
2262 else
2263 {
2264 c = STRING_CHAR (p, stop - pos);
2265 /* Delete all bytes for this 8-bit character but the
2266 last one, and change the last one to the charcter
2267 code. */
2268 bytes--;
2269 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2270 p = GAP_END_ADDR;
2271 *p++ = c;
2272 pos++;
2273 if (begv > pos)
2274 begv -= bytes;
2275 if (zv > pos)
2276 zv -= bytes;
2277 stop = Z;
2278 }
2279 }
2280 if (narrowed)
2281 Fnarrow_to_region (make_number (begv), make_number (zv));
2282 }
2283 else
2284 {
2285 int pt = PT;
2286 int pos, stop;
2287 unsigned char *p;
2288
2289 /* Be sure not to have a multibyte sequence striding over the GAP.
2290 Ex: We change this: "...abc\201 _GAP_ \241def..."
2291 to: "...abc _GAP_ \201\241def..." */
2292
2293 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2294 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2295 {
2296 unsigned char *p = GPT_ADDR - 1;
2297
2298 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2299 if (BASE_LEADING_CODE_P (*p))
2300 {
2301 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2302
2303 move_gap_both (new_gpt, new_gpt);
2304 }
2305 }
2306
2307 /* Make the buffer contents valid as multibyte by converting
2308 8-bit characters to multibyte form. */
2309 pos = BEG;
2310 stop = GPT;
2311 p = BEG_ADDR;
2312 while (1)
2313 {
2314 int bytes;
2315
2316 if (pos == stop)
2317 {
2318 if (pos == Z)
2319 break;
2320 p = GAP_END_ADDR;
2321 stop = Z;
2322 }
2323
2324 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2325 p += bytes, pos += bytes;
2326 else
2327 {
2328 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2329
2330 bytes = CHAR_STRING (*p, tmp);
2331 *p = tmp[0];
2332 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2333 bytes--;
2334 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2335 /* Now the gap is after the just inserted data. */
2336 pos = GPT;
2337 p = GAP_END_ADDR;
2338 if (pos <= begv)
2339 begv += bytes;
2340 if (pos <= zv)
2341 zv += bytes;
2342 if (pos <= pt)
2343 pt += bytes;
2344 stop = Z;
2345 }
2346 }
2347
2348 if (pt != PT)
2349 TEMP_SET_PT (pt);
2350
2351 if (narrowed)
2352 Fnarrow_to_region (make_number (begv), make_number (zv));
2353
2354 /* Do this first, so that chars_in_text asks the right question.
2355 set_intervals_multibyte needs it too. */
2356 current_buffer->enable_multibyte_characters = Qt;
2357
2358 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2359 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2360
2361 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2362
2363 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2364 if (BEGV_BYTE > GPT_BYTE)
2365 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2366 else
2367 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2368
2369 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2370 if (ZV_BYTE > GPT_BYTE)
2371 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2372 else
2373 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2374
2375 {
2376 int pt_byte = advance_to_char_boundary (PT_BYTE);
2377 int pt;
2378
2379 if (pt_byte > GPT_BYTE)
2380 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2381 else
2382 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2383 TEMP_SET_PT_BOTH (pt, pt_byte);
2384 }
2385
2386 tail = markers = BUF_MARKERS (current_buffer);
2387
2388 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2389 getting confused by the markers that have not yet been updated.
2390 It is also a signal that it should never create a marker. */
2391 BUF_MARKERS (current_buffer) = NULL;
2392
2393 for (; tail; tail = tail->next)
2394 {
2395 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2396 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2397 }
2398
2399 /* Make sure no markers were put on the chain
2400 while the chain value was incorrect. */
2401 if (BUF_MARKERS (current_buffer))
2402 abort ();
2403
2404 BUF_MARKERS (current_buffer) = markers;
2405
2406 /* Do this last, so it can calculate the new correspondences
2407 between chars and bytes. */
2408 set_intervals_multibyte (1);
2409 }
2410
2411 if (!EQ (old_undo, Qt))
2412 {
2413 /* Represent all the above changes by a special undo entry. */
2414 extern Lisp_Object Qapply;
2415 current_buffer->undo_list = Fcons (list3 (Qapply,
2416 intern ("set-buffer-multibyte"),
2417 NILP (flag) ? Qt : Qnil),
2418 old_undo);
2419 }
2420
2421 UNGCPRO;
2422
2423 /* Changing the multibyteness of a buffer means that all windows
2424 showing that buffer must be updated thoroughly. */
2425 current_buffer->prevent_redisplay_optimizations_p = 1;
2426 ++windows_or_buffers_changed;
2427
2428 /* Copy this buffer's new multibyte status
2429 into all of its indirect buffers. */
2430 for (other = all_buffers; other; other = other->next)
2431 if (other->base_buffer == current_buffer && !NILP (other->name))
2432 {
2433 other->enable_multibyte_characters
2434 = current_buffer->enable_multibyte_characters;
2435 other->prevent_redisplay_optimizations_p = 1;
2436 }
2437
2438 /* Restore the modifiedness of the buffer. */
2439 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2440 Fset_buffer_modified_p (Qnil);
2441
2442 #ifdef subprocesses
2443 /* Update coding systems of this buffer's process (if any). */
2444 {
2445 Lisp_Object process;
2446
2447 process = Fget_buffer_process (Fcurrent_buffer ());
2448 if (PROCESSP (process))
2449 setup_process_coding_systems (process);
2450 }
2451 #endif /* subprocesses */
2452
2453 return flag;
2454 }
2455 \f
2456 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2457 0, 0, 0,
2458 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2459 Most local variable bindings are eliminated so that the default values
2460 become effective once more. Also, the syntax table is set from
2461 `standard-syntax-table', the local keymap is set to nil,
2462 and the abbrev table from `fundamental-mode-abbrev-table'.
2463 This function also forces redisplay of the mode line.
2464
2465 Every function to select a new major mode starts by
2466 calling this function.
2467
2468 As a special exception, local variables whose names have
2469 a non-nil `permanent-local' property are not eliminated by this function.
2470
2471 The first thing this function does is run
2472 the normal hook `change-major-mode-hook'. */)
2473 ()
2474 {
2475 register Lisp_Object alist, sym, tem;
2476 Lisp_Object oalist;
2477
2478 if (!NILP (Vrun_hooks))
2479 call1 (Vrun_hooks, Qchange_major_mode_hook);
2480 oalist = current_buffer->local_var_alist;
2481
2482 /* Make sure none of the bindings in oalist
2483 remain swapped in, in their symbols. */
2484
2485 swap_out_buffer_local_variables (current_buffer);
2486
2487 /* Actually eliminate all local bindings of this buffer. */
2488
2489 reset_buffer_local_variables (current_buffer, 0);
2490
2491 /* Any which are supposed to be permanent,
2492 make local again, with the same values they had. */
2493
2494 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2495 {
2496 sym = XCAR (XCAR (alist));
2497 tem = Fget (sym, Qpermanent_local);
2498 if (! NILP (tem))
2499 {
2500 Fmake_local_variable (sym);
2501 Fset (sym, XCDR (XCAR (alist)));
2502 }
2503 }
2504
2505 /* Force mode-line redisplay. Useful here because all major mode
2506 commands call this function. */
2507 update_mode_lines++;
2508
2509 return Qnil;
2510 }
2511
2512 /* Make sure no local variables remain set up with buffer B
2513 for their current values. */
2514
2515 static void
2516 swap_out_buffer_local_variables (b)
2517 struct buffer *b;
2518 {
2519 Lisp_Object oalist, alist, sym, tem, buffer;
2520
2521 XSETBUFFER (buffer, b);
2522 oalist = b->local_var_alist;
2523
2524 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2525 {
2526 sym = XCAR (XCAR (alist));
2527
2528 /* Need not do anything if some other buffer's binding is now encached. */
2529 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2530 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2531 {
2532 /* Symbol is set up for this buffer's old local value.
2533 Set it up for the current buffer with the default value. */
2534
2535 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2536 /* Store the symbol's current value into the alist entry
2537 it is currently set up for. This is so that, if the
2538 local is marked permanent, and we make it local again
2539 later in Fkill_all_local_variables, we don't lose the value. */
2540 XSETCDR (XCAR (tem),
2541 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2542 /* Switch to the symbol's default-value alist entry. */
2543 XSETCAR (tem, tem);
2544 /* Mark it as current for buffer B. */
2545 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2546 /* Store the current value into any forwarding in the symbol. */
2547 store_symval_forwarding (sym,
2548 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2549 XCDR (tem), NULL);
2550 }
2551 }
2552 }
2553 \f
2554 /* Find all the overlays in the current buffer that contain position POS.
2555 Return the number found, and store them in a vector in *VEC_PTR.
2556 Store in *LEN_PTR the size allocated for the vector.
2557 Store in *NEXT_PTR the next position after POS where an overlay starts,
2558 or ZV if there are no more overlays between POS and ZV.
2559 Store in *PREV_PTR the previous position before POS where an overlay ends,
2560 or where an overlay starts which ends at or after POS;
2561 or BEGV if there are no such overlays from BEGV to POS.
2562 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2563
2564 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2565 when this function is called.
2566
2567 If EXTEND is non-zero, we make the vector bigger if necessary.
2568 If EXTEND is zero, we never extend the vector,
2569 and we store only as many overlays as will fit.
2570 But we still return the total number of overlays.
2571
2572 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2573 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2574 default (BEGV or ZV). */
2575
2576 int
2577 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2578 EMACS_INT pos;
2579 int extend;
2580 Lisp_Object **vec_ptr;
2581 int *len_ptr;
2582 int *next_ptr;
2583 int *prev_ptr;
2584 int change_req;
2585 {
2586 Lisp_Object overlay, start, end;
2587 struct Lisp_Overlay *tail;
2588 int idx = 0;
2589 int len = *len_ptr;
2590 Lisp_Object *vec = *vec_ptr;
2591 int next = ZV;
2592 int prev = BEGV;
2593 int inhibit_storing = 0;
2594
2595 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2596 {
2597 int startpos, endpos;
2598
2599 XSETMISC (overlay, tail);
2600
2601 start = OVERLAY_START (overlay);
2602 end = OVERLAY_END (overlay);
2603 endpos = OVERLAY_POSITION (end);
2604 if (endpos < pos)
2605 {
2606 if (prev < endpos)
2607 prev = endpos;
2608 break;
2609 }
2610 startpos = OVERLAY_POSITION (start);
2611 /* This one ends at or after POS
2612 so its start counts for PREV_PTR if it's before POS. */
2613 if (prev < startpos && startpos < pos)
2614 prev = startpos;
2615 if (endpos == pos)
2616 continue;
2617 if (startpos <= pos)
2618 {
2619 if (idx == len)
2620 {
2621 /* The supplied vector is full.
2622 Either make it bigger, or don't store any more in it. */
2623 if (extend)
2624 {
2625 /* Make it work with an initial len == 0. */
2626 len *= 2;
2627 if (len == 0)
2628 len = 4;
2629 *len_ptr = len;
2630 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2631 *vec_ptr = vec;
2632 }
2633 else
2634 inhibit_storing = 1;
2635 }
2636
2637 if (!inhibit_storing)
2638 vec[idx] = overlay;
2639 /* Keep counting overlays even if we can't return them all. */
2640 idx++;
2641 }
2642 else if (startpos < next)
2643 next = startpos;
2644 }
2645
2646 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2647 {
2648 int startpos, endpos;
2649
2650 XSETMISC (overlay, tail);
2651
2652 start = OVERLAY_START (overlay);
2653 end = OVERLAY_END (overlay);
2654 startpos = OVERLAY_POSITION (start);
2655 if (pos < startpos)
2656 {
2657 if (startpos < next)
2658 next = startpos;
2659 break;
2660 }
2661 endpos = OVERLAY_POSITION (end);
2662 if (pos < endpos)
2663 {
2664 if (idx == len)
2665 {
2666 if (extend)
2667 {
2668 /* Make it work with an initial len == 0. */
2669 len *= 2;
2670 if (len == 0)
2671 len = 4;
2672 *len_ptr = len;
2673 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2674 *vec_ptr = vec;
2675 }
2676 else
2677 inhibit_storing = 1;
2678 }
2679
2680 if (!inhibit_storing)
2681 vec[idx] = overlay;
2682 idx++;
2683
2684 if (startpos < pos && startpos > prev)
2685 prev = startpos;
2686 }
2687 else if (endpos < pos && endpos > prev)
2688 prev = endpos;
2689 else if (endpos == pos && startpos > prev
2690 && (!change_req || startpos < pos))
2691 prev = startpos;
2692 }
2693
2694 if (next_ptr)
2695 *next_ptr = next;
2696 if (prev_ptr)
2697 *prev_ptr = prev;
2698 return idx;
2699 }
2700 \f
2701 /* Find all the overlays in the current buffer that overlap the range BEG-END
2702 or are empty at BEG.
2703
2704 Return the number found, and store them in a vector in *VEC_PTR.
2705 Store in *LEN_PTR the size allocated for the vector.
2706 Store in *NEXT_PTR the next position after POS where an overlay starts,
2707 or ZV if there are no more overlays.
2708 Store in *PREV_PTR the previous position before POS where an overlay ends,
2709 or BEGV if there are no previous overlays.
2710 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2711
2712 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2713 when this function is called.
2714
2715 If EXTEND is non-zero, we make the vector bigger if necessary.
2716 If EXTEND is zero, we never extend the vector,
2717 and we store only as many overlays as will fit.
2718 But we still return the total number of overlays. */
2719
2720 static int
2721 overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2722 int beg, end;
2723 int extend;
2724 Lisp_Object **vec_ptr;
2725 int *len_ptr;
2726 int *next_ptr;
2727 int *prev_ptr;
2728 {
2729 Lisp_Object overlay, ostart, oend;
2730 struct Lisp_Overlay *tail;
2731 int idx = 0;
2732 int len = *len_ptr;
2733 Lisp_Object *vec = *vec_ptr;
2734 int next = ZV;
2735 int prev = BEGV;
2736 int inhibit_storing = 0;
2737
2738 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2739 {
2740 int startpos, endpos;
2741
2742 XSETMISC (overlay, tail);
2743
2744 ostart = OVERLAY_START (overlay);
2745 oend = OVERLAY_END (overlay);
2746 endpos = OVERLAY_POSITION (oend);
2747 if (endpos < beg)
2748 {
2749 if (prev < endpos)
2750 prev = endpos;
2751 break;
2752 }
2753 startpos = OVERLAY_POSITION (ostart);
2754 /* Count an interval if it either overlaps the range
2755 or is empty at the start of the range. */
2756 if ((beg < endpos && startpos < end)
2757 || (startpos == endpos && beg == endpos))
2758 {
2759 if (idx == len)
2760 {
2761 /* The supplied vector is full.
2762 Either make it bigger, or don't store any more in it. */
2763 if (extend)
2764 {
2765 /* Make it work with an initial len == 0. */
2766 len *= 2;
2767 if (len == 0)
2768 len = 4;
2769 *len_ptr = len;
2770 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2771 *vec_ptr = vec;
2772 }
2773 else
2774 inhibit_storing = 1;
2775 }
2776
2777 if (!inhibit_storing)
2778 vec[idx] = overlay;
2779 /* Keep counting overlays even if we can't return them all. */
2780 idx++;
2781 }
2782 else if (startpos < next)
2783 next = startpos;
2784 }
2785
2786 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2787 {
2788 int startpos, endpos;
2789
2790 XSETMISC (overlay, tail);
2791
2792 ostart = OVERLAY_START (overlay);
2793 oend = OVERLAY_END (overlay);
2794 startpos = OVERLAY_POSITION (ostart);
2795 if (end < startpos)
2796 {
2797 if (startpos < next)
2798 next = startpos;
2799 break;
2800 }
2801 endpos = OVERLAY_POSITION (oend);
2802 /* Count an interval if it either overlaps the range
2803 or is empty at the start of the range. */
2804 if ((beg < endpos && startpos < end)
2805 || (startpos == endpos && beg == endpos))
2806 {
2807 if (idx == len)
2808 {
2809 if (extend)
2810 {
2811 /* Make it work with an initial len == 0. */
2812 len *= 2;
2813 if (len == 0)
2814 len = 4;
2815 *len_ptr = len;
2816 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2817 *vec_ptr = vec;
2818 }
2819 else
2820 inhibit_storing = 1;
2821 }
2822
2823 if (!inhibit_storing)
2824 vec[idx] = overlay;
2825 idx++;
2826 }
2827 else if (endpos < beg && endpos > prev)
2828 prev = endpos;
2829 }
2830
2831 if (next_ptr)
2832 *next_ptr = next;
2833 if (prev_ptr)
2834 *prev_ptr = prev;
2835 return idx;
2836 }
2837
2838
2839 /* Return non-zero if there exists an overlay with a non-nil
2840 `mouse-face' property overlapping OVERLAY. */
2841
2842 int
2843 mouse_face_overlay_overlaps (overlay)
2844 Lisp_Object overlay;
2845 {
2846 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2847 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2848 int n, i, size;
2849 Lisp_Object *v, tem;
2850
2851 size = 10;
2852 v = (Lisp_Object *) alloca (size * sizeof *v);
2853 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2854 if (n > size)
2855 {
2856 v = (Lisp_Object *) alloca (n * sizeof *v);
2857 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2858 }
2859
2860 for (i = 0; i < n; ++i)
2861 if (!EQ (v[i], overlay)
2862 && (tem = Foverlay_get (overlay, Qmouse_face),
2863 !NILP (tem)))
2864 break;
2865
2866 return i < n;
2867 }
2868
2869
2870 \f
2871 /* Fast function to just test if we're at an overlay boundary. */
2872 int
2873 overlay_touches_p (pos)
2874 int pos;
2875 {
2876 Lisp_Object overlay;
2877 struct Lisp_Overlay *tail;
2878
2879 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2880 {
2881 int endpos;
2882
2883 XSETMISC (overlay ,tail);
2884 if (!GC_OVERLAYP (overlay))
2885 abort ();
2886
2887 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2888 if (endpos < pos)
2889 break;
2890 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2891 return 1;
2892 }
2893
2894 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2895 {
2896 int startpos;
2897
2898 XSETMISC (overlay, tail);
2899 if (!GC_OVERLAYP (overlay))
2900 abort ();
2901
2902 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2903 if (pos < startpos)
2904 break;
2905 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2906 return 1;
2907 }
2908 return 0;
2909 }
2910 \f
2911 struct sortvec
2912 {
2913 Lisp_Object overlay;
2914 int beg, end;
2915 int priority;
2916 };
2917
2918 static int
2919 compare_overlays (v1, v2)
2920 const void *v1, *v2;
2921 {
2922 const struct sortvec *s1 = (const struct sortvec *) v1;
2923 const struct sortvec *s2 = (const struct sortvec *) v2;
2924 if (s1->priority != s2->priority)
2925 return s1->priority - s2->priority;
2926 if (s1->beg != s2->beg)
2927 return s1->beg - s2->beg;
2928 if (s1->end != s2->end)
2929 return s2->end - s1->end;
2930 return 0;
2931 }
2932
2933 /* Sort an array of overlays by priority. The array is modified in place.
2934 The return value is the new size; this may be smaller than the original
2935 size if some of the overlays were invalid or were window-specific. */
2936 int
2937 sort_overlays (overlay_vec, noverlays, w)
2938 Lisp_Object *overlay_vec;
2939 int noverlays;
2940 struct window *w;
2941 {
2942 int i, j;
2943 struct sortvec *sortvec;
2944 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2945
2946 /* Put the valid and relevant overlays into sortvec. */
2947
2948 for (i = 0, j = 0; i < noverlays; i++)
2949 {
2950 Lisp_Object tem;
2951 Lisp_Object overlay;
2952
2953 overlay = overlay_vec[i];
2954 if (OVERLAY_VALID (overlay)
2955 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2956 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2957 {
2958 /* If we're interested in a specific window, then ignore
2959 overlays that are limited to some other window. */
2960 if (w)
2961 {
2962 Lisp_Object window;
2963
2964 window = Foverlay_get (overlay, Qwindow);
2965 if (WINDOWP (window) && XWINDOW (window) != w)
2966 continue;
2967 }
2968
2969 /* This overlay is good and counts: put it into sortvec. */
2970 sortvec[j].overlay = overlay;
2971 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2972 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2973 tem = Foverlay_get (overlay, Qpriority);
2974 if (INTEGERP (tem))
2975 sortvec[j].priority = XINT (tem);
2976 else
2977 sortvec[j].priority = 0;
2978 j++;
2979 }
2980 }
2981 noverlays = j;
2982
2983 /* Sort the overlays into the proper order: increasing priority. */
2984
2985 if (noverlays > 1)
2986 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2987
2988 for (i = 0; i < noverlays; i++)
2989 overlay_vec[i] = sortvec[i].overlay;
2990 return (noverlays);
2991 }
2992 \f
2993 struct sortstr
2994 {
2995 Lisp_Object string, string2;
2996 int size;
2997 int priority;
2998 };
2999
3000 struct sortstrlist
3001 {
3002 struct sortstr *buf; /* An array that expands as needed; never freed. */
3003 int size; /* Allocated length of that array. */
3004 int used; /* How much of the array is currently in use. */
3005 int bytes; /* Total length of the strings in buf. */
3006 };
3007
3008 /* Buffers for storing information about the overlays touching a given
3009 position. These could be automatic variables in overlay_strings, but
3010 it's more efficient to hold onto the memory instead of repeatedly
3011 allocating and freeing it. */
3012 static struct sortstrlist overlay_heads, overlay_tails;
3013 static unsigned char *overlay_str_buf;
3014
3015 /* Allocated length of overlay_str_buf. */
3016 static int overlay_str_len;
3017
3018 /* A comparison function suitable for passing to qsort. */
3019 static int
3020 cmp_for_strings (as1, as2)
3021 char *as1, *as2;
3022 {
3023 struct sortstr *s1 = (struct sortstr *)as1;
3024 struct sortstr *s2 = (struct sortstr *)as2;
3025 if (s1->size != s2->size)
3026 return s2->size - s1->size;
3027 if (s1->priority != s2->priority)
3028 return s1->priority - s2->priority;
3029 return 0;
3030 }
3031
3032 static void
3033 record_overlay_string (ssl, str, str2, pri, size)
3034 struct sortstrlist *ssl;
3035 Lisp_Object str, str2, pri;
3036 int size;
3037 {
3038 int nbytes;
3039
3040 if (ssl->used == ssl->size)
3041 {
3042 if (ssl->buf)
3043 ssl->size *= 2;
3044 else
3045 ssl->size = 5;
3046 ssl->buf = ((struct sortstr *)
3047 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
3048 }
3049 ssl->buf[ssl->used].string = str;
3050 ssl->buf[ssl->used].string2 = str2;
3051 ssl->buf[ssl->used].size = size;
3052 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
3053 ssl->used++;
3054
3055 if (NILP (current_buffer->enable_multibyte_characters))
3056 nbytes = SCHARS (str);
3057 else if (! STRING_MULTIBYTE (str))
3058 nbytes = count_size_as_multibyte (SDATA (str),
3059 SBYTES (str));
3060 else
3061 nbytes = SBYTES (str);
3062
3063 ssl->bytes += nbytes;
3064
3065 if (STRINGP (str2))
3066 {
3067 if (NILP (current_buffer->enable_multibyte_characters))
3068 nbytes = SCHARS (str2);
3069 else if (! STRING_MULTIBYTE (str2))
3070 nbytes = count_size_as_multibyte (SDATA (str2),
3071 SBYTES (str2));
3072 else
3073 nbytes = SBYTES (str2);
3074
3075 ssl->bytes += nbytes;
3076 }
3077 }
3078
3079 /* Return the concatenation of the strings associated with overlays that
3080 begin or end at POS, ignoring overlays that are specific to a window
3081 other than W. The strings are concatenated in the appropriate order:
3082 shorter overlays nest inside longer ones, and higher priority inside
3083 lower. Normally all of the after-strings come first, but zero-sized
3084 overlays have their after-strings ride along with the before-strings
3085 because it would look strange to print them inside-out.
3086
3087 Returns the string length, and stores the contents indirectly through
3088 PSTR, if that variable is non-null. The string may be overwritten by
3089 subsequent calls. */
3090
3091 int
3092 overlay_strings (pos, w, pstr)
3093 EMACS_INT pos;
3094 struct window *w;
3095 unsigned char **pstr;
3096 {
3097 Lisp_Object overlay, window, str;
3098 struct Lisp_Overlay *ov;
3099 int startpos, endpos;
3100 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3101
3102 overlay_heads.used = overlay_heads.bytes = 0;
3103 overlay_tails.used = overlay_tails.bytes = 0;
3104 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3105 {
3106 XSETMISC (overlay, ov);
3107 eassert (OVERLAYP (overlay));
3108
3109 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3110 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3111 if (endpos < pos)
3112 break;
3113 if (endpos != pos && startpos != pos)
3114 continue;
3115 window = Foverlay_get (overlay, Qwindow);
3116 if (WINDOWP (window) && XWINDOW (window) != w)
3117 continue;
3118 if (startpos == pos
3119 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3120 record_overlay_string (&overlay_heads, str,
3121 (startpos == endpos
3122 ? Foverlay_get (overlay, Qafter_string)
3123 : Qnil),
3124 Foverlay_get (overlay, Qpriority),
3125 endpos - startpos);
3126 else if (endpos == pos
3127 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3128 record_overlay_string (&overlay_tails, str, Qnil,
3129 Foverlay_get (overlay, Qpriority),
3130 endpos - startpos);
3131 }
3132 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3133 {
3134 XSETMISC (overlay, ov);
3135 eassert (OVERLAYP (overlay));
3136
3137 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3138 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3139 if (startpos > pos)
3140 break;
3141 if (endpos != pos && startpos != pos)
3142 continue;
3143 window = Foverlay_get (overlay, Qwindow);
3144 if (WINDOWP (window) && XWINDOW (window) != w)
3145 continue;
3146 if (startpos == pos
3147 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3148 record_overlay_string (&overlay_heads, str,
3149 (startpos == endpos
3150 ? Foverlay_get (overlay, Qafter_string)
3151 : Qnil),
3152 Foverlay_get (overlay, Qpriority),
3153 endpos - startpos);
3154 else if (endpos == pos
3155 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3156 record_overlay_string (&overlay_tails, str, Qnil,
3157 Foverlay_get (overlay, Qpriority),
3158 endpos - startpos);
3159 }
3160 if (overlay_tails.used > 1)
3161 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3162 cmp_for_strings);
3163 if (overlay_heads.used > 1)
3164 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3165 cmp_for_strings);
3166 if (overlay_heads.bytes || overlay_tails.bytes)
3167 {
3168 Lisp_Object tem;
3169 int i;
3170 unsigned char *p;
3171 int total = overlay_heads.bytes + overlay_tails.bytes;
3172
3173 if (total > overlay_str_len)
3174 {
3175 overlay_str_len = total;
3176 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3177 total);
3178 }
3179 p = overlay_str_buf;
3180 for (i = overlay_tails.used; --i >= 0;)
3181 {
3182 int nbytes;
3183 tem = overlay_tails.buf[i].string;
3184 nbytes = copy_text (SDATA (tem), p,
3185 SBYTES (tem),
3186 STRING_MULTIBYTE (tem), multibyte);
3187 p += nbytes;
3188 }
3189 for (i = 0; i < overlay_heads.used; ++i)
3190 {
3191 int nbytes;
3192 tem = overlay_heads.buf[i].string;
3193 nbytes = copy_text (SDATA (tem), p,
3194 SBYTES (tem),
3195 STRING_MULTIBYTE (tem), multibyte);
3196 p += nbytes;
3197 tem = overlay_heads.buf[i].string2;
3198 if (STRINGP (tem))
3199 {
3200 nbytes = copy_text (SDATA (tem), p,
3201 SBYTES (tem),
3202 STRING_MULTIBYTE (tem), multibyte);
3203 p += nbytes;
3204 }
3205 }
3206 if (p != overlay_str_buf + total)
3207 abort ();
3208 if (pstr)
3209 *pstr = overlay_str_buf;
3210 return total;
3211 }
3212 return 0;
3213 }
3214 \f
3215 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3216
3217 void
3218 recenter_overlay_lists (buf, pos)
3219 struct buffer *buf;
3220 EMACS_INT pos;
3221 {
3222 Lisp_Object overlay, beg, end;
3223 struct Lisp_Overlay *prev, *tail, *next;
3224
3225 /* See if anything in overlays_before should move to overlays_after. */
3226
3227 /* We don't strictly need prev in this loop; it should always be nil.
3228 But we use it for symmetry and in case that should cease to be true
3229 with some future change. */
3230 prev = NULL;
3231 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3232 {
3233 next = tail->next;
3234 XSETMISC (overlay, tail);
3235
3236 /* If the overlay is not valid, get rid of it. */
3237 if (!OVERLAY_VALID (overlay))
3238 #if 1
3239 abort ();
3240 #else
3241 {
3242 /* Splice the cons cell TAIL out of overlays_before. */
3243 if (!NILP (prev))
3244 XCDR (prev) = next;
3245 else
3246 buf->overlays_before = next;
3247 tail = prev;
3248 continue;
3249 }
3250 #endif
3251
3252 beg = OVERLAY_START (overlay);
3253 end = OVERLAY_END (overlay);
3254
3255 if (OVERLAY_POSITION (end) > pos)
3256 {
3257 /* OVERLAY needs to be moved. */
3258 int where = OVERLAY_POSITION (beg);
3259 struct Lisp_Overlay *other, *other_prev;
3260
3261 /* Splice the cons cell TAIL out of overlays_before. */
3262 if (prev)
3263 prev->next = next;
3264 else
3265 buf->overlays_before = next;
3266
3267 /* Search thru overlays_after for where to put it. */
3268 other_prev = NULL;
3269 for (other = buf->overlays_after; other;
3270 other_prev = other, other = other->next)
3271 {
3272 Lisp_Object otherbeg, otheroverlay;
3273
3274 XSETMISC (otheroverlay, other);
3275 eassert (OVERLAY_VALID (otheroverlay));
3276
3277 otherbeg = OVERLAY_START (otheroverlay);
3278 if (OVERLAY_POSITION (otherbeg) >= where)
3279 break;
3280 }
3281
3282 /* Add TAIL to overlays_after before OTHER. */
3283 tail->next = other;
3284 if (other_prev)
3285 other_prev->next = tail;
3286 else
3287 buf->overlays_after = tail;
3288 tail = prev;
3289 }
3290 else
3291 /* We've reached the things that should stay in overlays_before.
3292 All the rest of overlays_before must end even earlier,
3293 so stop now. */
3294 break;
3295 }
3296
3297 /* See if anything in overlays_after should be in overlays_before. */
3298 prev = NULL;
3299 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3300 {
3301 next = tail->next;
3302 XSETMISC (overlay, tail);
3303
3304 /* If the overlay is not valid, get rid of it. */
3305 if (!OVERLAY_VALID (overlay))
3306 #if 1
3307 abort ();
3308 #else
3309 {
3310 /* Splice the cons cell TAIL out of overlays_after. */
3311 if (!NILP (prev))
3312 XCDR (prev) = next;
3313 else
3314 buf->overlays_after = next;
3315 tail = prev;
3316 continue;
3317 }
3318 #endif
3319
3320 beg = OVERLAY_START (overlay);
3321 end = OVERLAY_END (overlay);
3322
3323 /* Stop looking, when we know that nothing further
3324 can possibly end before POS. */
3325 if (OVERLAY_POSITION (beg) > pos)
3326 break;
3327
3328 if (OVERLAY_POSITION (end) <= pos)
3329 {
3330 /* OVERLAY needs to be moved. */
3331 int where = OVERLAY_POSITION (end);
3332 struct Lisp_Overlay *other, *other_prev;
3333
3334 /* Splice the cons cell TAIL out of overlays_after. */
3335 if (prev)
3336 prev->next = next;
3337 else
3338 buf->overlays_after = next;
3339
3340 /* Search thru overlays_before for where to put it. */
3341 other_prev = NULL;
3342 for (other = buf->overlays_before; other;
3343 other_prev = other, other = other->next)
3344 {
3345 Lisp_Object otherend, otheroverlay;
3346
3347 XSETMISC (otheroverlay, other);
3348 eassert (OVERLAY_VALID (otheroverlay));
3349
3350 otherend = OVERLAY_END (otheroverlay);
3351 if (OVERLAY_POSITION (otherend) <= where)
3352 break;
3353 }
3354
3355 /* Add TAIL to overlays_before before OTHER. */
3356 tail->next = other;
3357 if (other_prev)
3358 other_prev->next = tail;
3359 else
3360 buf->overlays_before = tail;
3361 tail = prev;
3362 }
3363 }
3364
3365 buf->overlay_center = pos;
3366 }
3367
3368 void
3369 adjust_overlays_for_insert (pos, length)
3370 EMACS_INT pos;
3371 EMACS_INT length;
3372 {
3373 /* After an insertion, the lists are still sorted properly,
3374 but we may need to update the value of the overlay center. */
3375 if (current_buffer->overlay_center >= pos)
3376 current_buffer->overlay_center += length;
3377 }
3378
3379 void
3380 adjust_overlays_for_delete (pos, length)
3381 EMACS_INT pos;
3382 EMACS_INT length;
3383 {
3384 if (current_buffer->overlay_center < pos)
3385 /* The deletion was to our right. No change needed; the before- and
3386 after-lists are still consistent. */
3387 ;
3388 else if (current_buffer->overlay_center > pos + length)
3389 /* The deletion was to our left. We need to adjust the center value
3390 to account for the change in position, but the lists are consistent
3391 given the new value. */
3392 current_buffer->overlay_center -= length;
3393 else
3394 /* We're right in the middle. There might be things on the after-list
3395 that now belong on the before-list. Recentering will move them,
3396 and also update the center point. */
3397 recenter_overlay_lists (current_buffer, pos);
3398 }
3399
3400 /* Fix up overlays that were garbled as a result of permuting markers
3401 in the range START through END. Any overlay with at least one
3402 endpoint in this range will need to be unlinked from the overlay
3403 list and reinserted in its proper place.
3404 Such an overlay might even have negative size at this point.
3405 If so, we'll make the overlay empty. */
3406 void
3407 fix_start_end_in_overlays (start, end)
3408 register int start, end;
3409 {
3410 Lisp_Object overlay;
3411 struct Lisp_Overlay *before_list, *after_list;
3412 /* These are either nil, indicating that before_list or after_list
3413 should be assigned, or the cons cell the cdr of which should be
3414 assigned. */
3415 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3416 /* 'Parent', likewise, indicates a cons cell or
3417 current_buffer->overlays_before or overlays_after, depending
3418 which loop we're in. */
3419 struct Lisp_Overlay *tail, *parent;
3420 int startpos, endpos;
3421
3422 /* This algorithm shifts links around instead of consing and GCing.
3423 The loop invariant is that before_list (resp. after_list) is a
3424 well-formed list except that its last element, the CDR of beforep
3425 (resp. afterp) if beforep (afterp) isn't nil or before_list
3426 (after_list) if it is, is still uninitialized. So it's not a bug
3427 that before_list isn't initialized, although it may look
3428 strange. */
3429 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3430 {
3431 XSETMISC (overlay, tail);
3432
3433 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3434 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3435
3436 /* If the overlay is backwards, make it empty. */
3437 if (endpos < startpos)
3438 {
3439 startpos = endpos;
3440 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3441 Qnil);
3442 }
3443
3444 if (endpos < start)
3445 break;
3446
3447 if (endpos < end
3448 || (startpos >= start && startpos < end))
3449 {
3450 /* Add it to the end of the wrong list. Later on,
3451 recenter_overlay_lists will move it to the right place. */
3452 if (endpos < current_buffer->overlay_center)
3453 {
3454 if (!afterp)
3455 after_list = tail;
3456 else
3457 afterp->next = tail;
3458 afterp = tail;
3459 }
3460 else
3461 {
3462 if (!beforep)
3463 before_list = tail;
3464 else
3465 beforep->next = tail;
3466 beforep = tail;
3467 }
3468 if (!parent)
3469 current_buffer->overlays_before = tail->next;
3470 else
3471 parent->next = tail->next;
3472 tail = tail->next;
3473 }
3474 else
3475 parent = tail, tail = parent->next;
3476 }
3477 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3478 {
3479 XSETMISC (overlay, tail);
3480
3481 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3482 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3483
3484 /* If the overlay is backwards, make it empty. */
3485 if (endpos < startpos)
3486 {
3487 startpos = endpos;
3488 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3489 Qnil);
3490 }
3491
3492 if (startpos >= end)
3493 break;
3494
3495 if (startpos >= start
3496 || (endpos >= start && endpos < end))
3497 {
3498 if (endpos < current_buffer->overlay_center)
3499 {
3500 if (!afterp)
3501 after_list = tail;
3502 else
3503 afterp->next = tail;
3504 afterp = tail;
3505 }
3506 else
3507 {
3508 if (!beforep)
3509 before_list = tail;
3510 else
3511 beforep->next = tail;
3512 beforep = tail;
3513 }
3514 if (!parent)
3515 current_buffer->overlays_after = tail->next;
3516 else
3517 parent->next = tail->next;
3518 tail = tail->next;
3519 }
3520 else
3521 parent = tail, tail = parent->next;
3522 }
3523
3524 /* Splice the constructed (wrong) lists into the buffer's lists,
3525 and let the recenter function make it sane again. */
3526 if (beforep)
3527 {
3528 beforep->next = current_buffer->overlays_before;
3529 current_buffer->overlays_before = before_list;
3530 }
3531 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3532
3533 if (afterp)
3534 {
3535 afterp->next = current_buffer->overlays_after;
3536 current_buffer->overlays_after = after_list;
3537 }
3538 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3539 }
3540
3541 /* We have two types of overlay: the one whose ending marker is
3542 after-insertion-marker (this is the usual case) and the one whose
3543 ending marker is before-insertion-marker. When `overlays_before'
3544 contains overlays of the latter type and the former type in this
3545 order and both overlays end at inserting position, inserting a text
3546 increases only the ending marker of the latter type, which results
3547 in incorrect ordering of `overlays_before'.
3548
3549 This function fixes ordering of overlays in the slot
3550 `overlays_before' of the buffer *BP. Before the insertion, `point'
3551 was at PREV, and now is at POS. */
3552
3553 void
3554 fix_overlays_before (bp, prev, pos)
3555 struct buffer *bp;
3556 EMACS_INT prev, pos;
3557 {
3558 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3559 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3560 Lisp_Object tem;
3561 EMACS_INT end;
3562
3563 /* After the insertion, the several overlays may be in incorrect
3564 order. The possibility is that, in the list `overlays_before',
3565 an overlay which ends at POS appears after an overlay which ends
3566 at PREV. Since POS is greater than PREV, we must fix the
3567 ordering of these overlays, by moving overlays ends at POS before
3568 the overlays ends at PREV. */
3569
3570 /* At first, find a place where disordered overlays should be linked
3571 in. It is where an overlay which end before POS exists. (i.e. an
3572 overlay whose ending marker is after-insertion-marker if disorder
3573 exists). */
3574 while (tail
3575 && (XSETMISC (tem, tail),
3576 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3577 {
3578 parent = tail;
3579 tail = tail->next;
3580 }
3581
3582 /* If we don't find such an overlay,
3583 or the found one ends before PREV,
3584 or the found one is the last one in the list,
3585 we don't have to fix anything. */
3586 if (!tail || end < prev || !tail->next)
3587 return;
3588
3589 right_pair = parent;
3590 parent = tail;
3591 tail = tail->next;
3592
3593 /* Now, end position of overlays in the list TAIL should be before
3594 or equal to PREV. In the loop, an overlay which ends at POS is
3595 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3596 we found an overlay which ends before PREV, the remaining
3597 overlays are in correct order. */
3598 while (tail)
3599 {
3600 XSETMISC (tem, tail);
3601 end = OVERLAY_POSITION (OVERLAY_END (tem));
3602
3603 if (end == pos)
3604 { /* This overlay is disordered. */
3605 struct Lisp_Overlay *found = tail;
3606
3607 /* Unlink the found overlay. */
3608 tail = found->next;
3609 parent->next = tail;
3610 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3611 and link it into the right place. */
3612 if (!right_pair)
3613 {
3614 found->next = bp->overlays_before;
3615 bp->overlays_before = found;
3616 }
3617 else
3618 {
3619 found->next = right_pair->next;
3620 right_pair->next = found;
3621 }
3622 }
3623 else if (end == prev)
3624 {
3625 parent = tail;
3626 tail = tail->next;
3627 }
3628 else /* No more disordered overlay. */
3629 break;
3630 }
3631 }
3632 \f
3633 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3634 doc: /* Return t if OBJECT is an overlay. */)
3635 (object)
3636 Lisp_Object object;
3637 {
3638 return (OVERLAYP (object) ? Qt : Qnil);
3639 }
3640
3641 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3642 doc: /* Create a new overlay with range BEG to END in BUFFER.
3643 If omitted, BUFFER defaults to the current buffer.
3644 BEG and END may be integers or markers.
3645 The fourth arg FRONT-ADVANCE, if non-nil, makes the marker
3646 for the front of the overlay advance when text is inserted there
3647 \(which means the text *is not* included in the overlay).
3648 The fifth arg REAR-ADVANCE, if non-nil, makes the marker
3649 for the rear of the overlay advance when text is inserted there
3650 \(which means the text *is* included in the overlay). */)
3651 (beg, end, buffer, front_advance, rear_advance)
3652 Lisp_Object beg, end, buffer;
3653 Lisp_Object front_advance, rear_advance;
3654 {
3655 Lisp_Object overlay;
3656 struct buffer *b;
3657
3658 if (NILP (buffer))
3659 XSETBUFFER (buffer, current_buffer);
3660 else
3661 CHECK_BUFFER (buffer);
3662 if (MARKERP (beg)
3663 && ! EQ (Fmarker_buffer (beg), buffer))
3664 error ("Marker points into wrong buffer");
3665 if (MARKERP (end)
3666 && ! EQ (Fmarker_buffer (end), buffer))
3667 error ("Marker points into wrong buffer");
3668
3669 CHECK_NUMBER_COERCE_MARKER (beg);
3670 CHECK_NUMBER_COERCE_MARKER (end);
3671
3672 if (XINT (beg) > XINT (end))
3673 {
3674 Lisp_Object temp;
3675 temp = beg; beg = end; end = temp;
3676 }
3677
3678 b = XBUFFER (buffer);
3679
3680 beg = Fset_marker (Fmake_marker (), beg, buffer);
3681 end = Fset_marker (Fmake_marker (), end, buffer);
3682
3683 if (!NILP (front_advance))
3684 XMARKER (beg)->insertion_type = 1;
3685 if (!NILP (rear_advance))
3686 XMARKER (end)->insertion_type = 1;
3687
3688 overlay = allocate_misc ();
3689 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3690 XOVERLAY (overlay)->start = beg;
3691 XOVERLAY (overlay)->end = end;
3692 XOVERLAY (overlay)->plist = Qnil;
3693 XOVERLAY (overlay)->next = NULL;
3694
3695 /* Put the new overlay on the wrong list. */
3696 end = OVERLAY_END (overlay);
3697 if (OVERLAY_POSITION (end) < b->overlay_center)
3698 {
3699 if (b->overlays_after)
3700 XOVERLAY (overlay)->next = b->overlays_after;
3701 b->overlays_after = XOVERLAY (overlay);
3702 }
3703 else
3704 {
3705 if (b->overlays_before)
3706 XOVERLAY (overlay)->next = b->overlays_before;
3707 b->overlays_before = XOVERLAY (overlay);
3708 }
3709
3710 /* This puts it in the right list, and in the right order. */
3711 recenter_overlay_lists (b, b->overlay_center);
3712
3713 /* We don't need to redisplay the region covered by the overlay, because
3714 the overlay has no properties at the moment. */
3715
3716 return overlay;
3717 }
3718 \f
3719 /* Mark a section of BUF as needing redisplay because of overlays changes. */
3720
3721 static void
3722 modify_overlay (buf, start, end)
3723 struct buffer *buf;
3724 EMACS_INT start, end;
3725 {
3726 if (start > end)
3727 {
3728 int temp = start;
3729 start = end;
3730 end = temp;
3731 }
3732
3733 BUF_COMPUTE_UNCHANGED (buf, start, end);
3734
3735 /* If this is a buffer not in the selected window,
3736 we must do other windows. */
3737 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3738 windows_or_buffers_changed = 1;
3739 /* If multiple windows show this buffer, we must do other windows. */
3740 else if (buffer_shared > 1)
3741 windows_or_buffers_changed = 1;
3742 /* If we modify an overlay at the end of the buffer, we cannot
3743 be sure that window end is still valid. */
3744 else if (end >= ZV && start <= ZV)
3745 windows_or_buffers_changed = 1;
3746
3747 ++BUF_OVERLAY_MODIFF (buf);
3748 }
3749
3750 \f
3751 Lisp_Object Fdelete_overlay ();
3752
3753 static struct Lisp_Overlay *
3754 unchain_overlay (list, overlay)
3755 struct Lisp_Overlay *list, *overlay;
3756 {
3757 struct Lisp_Overlay *tmp, *prev;
3758 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3759 if (tmp == overlay)
3760 {
3761 if (prev)
3762 prev->next = tmp->next;
3763 else
3764 list = tmp->next;
3765 overlay->next = NULL;
3766 break;
3767 }
3768 return list;
3769 }
3770
3771 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3772 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3773 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3774 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3775 buffer. */)
3776 (overlay, beg, end, buffer)
3777 Lisp_Object overlay, beg, end, buffer;
3778 {
3779 struct buffer *b, *ob;
3780 Lisp_Object obuffer;
3781 int count = SPECPDL_INDEX ();
3782
3783 CHECK_OVERLAY (overlay);
3784 if (NILP (buffer))
3785 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3786 if (NILP (buffer))
3787 XSETBUFFER (buffer, current_buffer);
3788 CHECK_BUFFER (buffer);
3789
3790 if (MARKERP (beg)
3791 && ! EQ (Fmarker_buffer (beg), buffer))
3792 error ("Marker points into wrong buffer");
3793 if (MARKERP (end)
3794 && ! EQ (Fmarker_buffer (end), buffer))
3795 error ("Marker points into wrong buffer");
3796
3797 CHECK_NUMBER_COERCE_MARKER (beg);
3798 CHECK_NUMBER_COERCE_MARKER (end);
3799
3800 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3801 return Fdelete_overlay (overlay);
3802
3803 if (XINT (beg) > XINT (end))
3804 {
3805 Lisp_Object temp;
3806 temp = beg; beg = end; end = temp;
3807 }
3808
3809 specbind (Qinhibit_quit, Qt);
3810
3811 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3812 b = XBUFFER (buffer);
3813 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3814
3815 /* If the overlay has changed buffers, do a thorough redisplay. */
3816 if (!EQ (buffer, obuffer))
3817 {
3818 /* Redisplay where the overlay was. */
3819 if (!NILP (obuffer))
3820 {
3821 int o_beg;
3822 int o_end;
3823
3824 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3825 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3826
3827 modify_overlay (ob, o_beg, o_end);
3828 }
3829
3830 /* Redisplay where the overlay is going to be. */
3831 modify_overlay (b, XINT (beg), XINT (end));
3832 }
3833 else
3834 /* Redisplay the area the overlay has just left, or just enclosed. */
3835 {
3836 int o_beg, o_end;
3837
3838 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3839 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3840
3841 if (o_beg == XINT (beg))
3842 modify_overlay (b, o_end, XINT (end));
3843 else if (o_end == XINT (end))
3844 modify_overlay (b, o_beg, XINT (beg));
3845 else
3846 {
3847 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3848 if (XINT (end) > o_end) o_end = XINT (end);
3849 modify_overlay (b, o_beg, o_end);
3850 }
3851 }
3852
3853 if (!NILP (obuffer))
3854 {
3855 ob->overlays_before
3856 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3857 ob->overlays_after
3858 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3859 eassert (XOVERLAY (overlay)->next == NULL);
3860 }
3861
3862 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3863 Fset_marker (OVERLAY_END (overlay), end, buffer);
3864
3865 /* Put the overlay on the wrong list. */
3866 end = OVERLAY_END (overlay);
3867 if (OVERLAY_POSITION (end) < b->overlay_center)
3868 {
3869 XOVERLAY (overlay)->next = b->overlays_after;
3870 b->overlays_after = XOVERLAY (overlay);
3871 }
3872 else
3873 {
3874 XOVERLAY (overlay)->next = b->overlays_before;
3875 b->overlays_before = XOVERLAY (overlay);
3876 }
3877
3878 /* This puts it in the right list, and in the right order. */
3879 recenter_overlay_lists (b, b->overlay_center);
3880
3881 return unbind_to (count, overlay);
3882 }
3883
3884 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3885 doc: /* Delete the overlay OVERLAY from its buffer. */)
3886 (overlay)
3887 Lisp_Object overlay;
3888 {
3889 Lisp_Object buffer;
3890 struct buffer *b;
3891 int count = SPECPDL_INDEX ();
3892
3893 CHECK_OVERLAY (overlay);
3894
3895 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3896 if (NILP (buffer))
3897 return Qnil;
3898
3899 b = XBUFFER (buffer);
3900 specbind (Qinhibit_quit, Qt);
3901
3902 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3903 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3904 eassert (XOVERLAY (overlay)->next == NULL);
3905 modify_overlay (b,
3906 marker_position (OVERLAY_START (overlay)),
3907 marker_position (OVERLAY_END (overlay)));
3908 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3909 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3910
3911 /* When deleting an overlay with before or after strings, turn off
3912 display optimizations for the affected buffer, on the basis that
3913 these strings may contain newlines. This is easier to do than to
3914 check for that situation during redisplay. */
3915 if (!windows_or_buffers_changed
3916 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3917 || !NILP (Foverlay_get (overlay, Qafter_string))))
3918 b->prevent_redisplay_optimizations_p = 1;
3919
3920 return unbind_to (count, Qnil);
3921 }
3922 \f
3923 /* Overlay dissection functions. */
3924
3925 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3926 doc: /* Return the position at which OVERLAY starts. */)
3927 (overlay)
3928 Lisp_Object overlay;
3929 {
3930 CHECK_OVERLAY (overlay);
3931
3932 return (Fmarker_position (OVERLAY_START (overlay)));
3933 }
3934
3935 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3936 doc: /* Return the position at which OVERLAY ends. */)
3937 (overlay)
3938 Lisp_Object overlay;
3939 {
3940 CHECK_OVERLAY (overlay);
3941
3942 return (Fmarker_position (OVERLAY_END (overlay)));
3943 }
3944
3945 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3946 doc: /* Return the buffer OVERLAY belongs to.
3947 Return nil if OVERLAY has been deleted. */)
3948 (overlay)
3949 Lisp_Object overlay;
3950 {
3951 CHECK_OVERLAY (overlay);
3952
3953 return Fmarker_buffer (OVERLAY_START (overlay));
3954 }
3955
3956 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3957 doc: /* Return a list of the properties on OVERLAY.
3958 This is a copy of OVERLAY's plist; modifying its conses has no effect on
3959 OVERLAY. */)
3960 (overlay)
3961 Lisp_Object overlay;
3962 {
3963 CHECK_OVERLAY (overlay);
3964
3965 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3966 }
3967
3968 \f
3969 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3970 doc: /* Return a list of the overlays that contain position POS. */)
3971 (pos)
3972 Lisp_Object pos;
3973 {
3974 int noverlays;
3975 Lisp_Object *overlay_vec;
3976 int len;
3977 Lisp_Object result;
3978
3979 CHECK_NUMBER_COERCE_MARKER (pos);
3980
3981 len = 10;
3982 /* We can't use alloca here because overlays_at can call xrealloc. */
3983 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3984
3985 /* Put all the overlays we want in a vector in overlay_vec.
3986 Store the length in len. */
3987 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3988 (int *) 0, (int *) 0, 0);
3989
3990 /* Make a list of them all. */
3991 result = Flist (noverlays, overlay_vec);
3992
3993 xfree (overlay_vec);
3994 return result;
3995 }
3996
3997 DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3998 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3999 Overlap means that at least one character is contained within the overlay
4000 and also contained within the specified region.
4001 Empty overlays are included in the result if they are located at BEG
4002 or between BEG and END. */)
4003 (beg, end)
4004 Lisp_Object beg, end;
4005 {
4006 int noverlays;
4007 Lisp_Object *overlay_vec;
4008 int len;
4009 Lisp_Object result;
4010
4011 CHECK_NUMBER_COERCE_MARKER (beg);
4012 CHECK_NUMBER_COERCE_MARKER (end);
4013
4014 len = 10;
4015 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4016
4017 /* Put all the overlays we want in a vector in overlay_vec.
4018 Store the length in len. */
4019 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
4020 (int *) 0, (int *) 0);
4021
4022 /* Make a list of them all. */
4023 result = Flist (noverlays, overlay_vec);
4024
4025 xfree (overlay_vec);
4026 return result;
4027 }
4028
4029 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
4030 1, 1, 0,
4031 doc: /* Return the next position after POS where an overlay starts or ends.
4032 If there are no overlay boundaries from POS to (point-max),
4033 the value is (point-max). */)
4034 (pos)
4035 Lisp_Object pos;
4036 {
4037 int noverlays;
4038 int endpos;
4039 Lisp_Object *overlay_vec;
4040 int len;
4041 int i;
4042
4043 CHECK_NUMBER_COERCE_MARKER (pos);
4044
4045 len = 10;
4046 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4047
4048 /* Put all the overlays we want in a vector in overlay_vec.
4049 Store the length in len.
4050 endpos gets the position where the next overlay starts. */
4051 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4052 &endpos, (int *) 0, 1);
4053
4054 /* If any of these overlays ends before endpos,
4055 use its ending point instead. */
4056 for (i = 0; i < noverlays; i++)
4057 {
4058 Lisp_Object oend;
4059 int oendpos;
4060
4061 oend = OVERLAY_END (overlay_vec[i]);
4062 oendpos = OVERLAY_POSITION (oend);
4063 if (oendpos < endpos)
4064 endpos = oendpos;
4065 }
4066
4067 xfree (overlay_vec);
4068 return make_number (endpos);
4069 }
4070
4071 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
4072 Sprevious_overlay_change, 1, 1, 0,
4073 doc: /* Return the previous position before POS where an overlay starts or ends.
4074 If there are no overlay boundaries from (point-min) to POS,
4075 the value is (point-min). */)
4076 (pos)
4077 Lisp_Object pos;
4078 {
4079 int noverlays;
4080 int prevpos;
4081 Lisp_Object *overlay_vec;
4082 int len;
4083
4084 CHECK_NUMBER_COERCE_MARKER (pos);
4085
4086 /* At beginning of buffer, we know the answer;
4087 avoid bug subtracting 1 below. */
4088 if (XINT (pos) == BEGV)
4089 return pos;
4090
4091 len = 10;
4092 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
4093
4094 /* Put all the overlays we want in a vector in overlay_vec.
4095 Store the length in len.
4096 prevpos gets the position of the previous change. */
4097 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
4098 (int *) 0, &prevpos, 1);
4099
4100 xfree (overlay_vec);
4101 return make_number (prevpos);
4102 }
4103 \f
4104 /* These functions are for debugging overlays. */
4105
4106 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
4107 doc: /* Return a pair of lists giving all the overlays of the current buffer.
4108 The car has all the overlays before the overlay center;
4109 the cdr has all the overlays after the overlay center.
4110 Recentering overlays moves overlays between these lists.
4111 The lists you get are copies, so that changing them has no effect.
4112 However, the overlays you get are the real objects that the buffer uses. */)
4113 ()
4114 {
4115 struct Lisp_Overlay *ol;
4116 Lisp_Object before = Qnil, after = Qnil, tmp;
4117 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4118 {
4119 XSETMISC (tmp, ol);
4120 before = Fcons (tmp, before);
4121 }
4122 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4123 {
4124 XSETMISC (tmp, ol);
4125 after = Fcons (tmp, after);
4126 }
4127 return Fcons (Fnreverse (before), Fnreverse (after));
4128 }
4129
4130 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4131 doc: /* Recenter the overlays of the current buffer around position POS.
4132 That makes overlay lookup faster for positions near POS (but perhaps slower
4133 for positions far away from POS). */)
4134 (pos)
4135 Lisp_Object pos;
4136 {
4137 CHECK_NUMBER_COERCE_MARKER (pos);
4138
4139 recenter_overlay_lists (current_buffer, XINT (pos));
4140 return Qnil;
4141 }
4142 \f
4143 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4144 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4145 (overlay, prop)
4146 Lisp_Object overlay, prop;
4147 {
4148 CHECK_OVERLAY (overlay);
4149 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4150 }
4151
4152 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4153 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4154 (overlay, prop, value)
4155 Lisp_Object overlay, prop, value;
4156 {
4157 Lisp_Object tail, buffer;
4158 int changed;
4159
4160 CHECK_OVERLAY (overlay);
4161
4162 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4163
4164 for (tail = XOVERLAY (overlay)->plist;
4165 CONSP (tail) && CONSP (XCDR (tail));
4166 tail = XCDR (XCDR (tail)))
4167 if (EQ (XCAR (tail), prop))
4168 {
4169 changed = !EQ (XCAR (XCDR (tail)), value);
4170 XSETCAR (XCDR (tail), value);
4171 goto found;
4172 }
4173 /* It wasn't in the list, so add it to the front. */
4174 changed = !NILP (value);
4175 XOVERLAY (overlay)->plist
4176 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4177 found:
4178 if (! NILP (buffer))
4179 {
4180 if (changed)
4181 modify_overlay (XBUFFER (buffer),
4182 marker_position (OVERLAY_START (overlay)),
4183 marker_position (OVERLAY_END (overlay)));
4184 if (EQ (prop, Qevaporate) && ! NILP (value)
4185 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4186 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4187 Fdelete_overlay (overlay);
4188 }
4189
4190 return value;
4191 }
4192 \f
4193 /* Subroutine of report_overlay_modification. */
4194
4195 /* Lisp vector holding overlay hook functions to call.
4196 Vector elements come in pairs.
4197 Each even-index element is a list of hook functions.
4198 The following odd-index element is the overlay they came from.
4199
4200 Before the buffer change, we fill in this vector
4201 as we call overlay hook functions.
4202 After the buffer change, we get the functions to call from this vector.
4203 This way we always call the same functions before and after the change. */
4204 static Lisp_Object last_overlay_modification_hooks;
4205
4206 /* Number of elements actually used in last_overlay_modification_hooks. */
4207 static int last_overlay_modification_hooks_used;
4208
4209 /* Add one functionlist/overlay pair
4210 to the end of last_overlay_modification_hooks. */
4211
4212 static void
4213 add_overlay_mod_hooklist (functionlist, overlay)
4214 Lisp_Object functionlist, overlay;
4215 {
4216 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4217
4218 if (last_overlay_modification_hooks_used == oldsize)
4219 {
4220 Lisp_Object old;
4221 old = last_overlay_modification_hooks;
4222 last_overlay_modification_hooks
4223 = Fmake_vector (make_number (oldsize * 2), Qnil);
4224 bcopy (XVECTOR (old)->contents,
4225 XVECTOR (last_overlay_modification_hooks)->contents,
4226 sizeof (Lisp_Object) * oldsize);
4227 }
4228 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4229 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4230 }
4231 \f
4232 /* Run the modification-hooks of overlays that include
4233 any part of the text in START to END.
4234 If this change is an insertion, also
4235 run the insert-before-hooks of overlay starting at END,
4236 and the insert-after-hooks of overlay ending at START.
4237
4238 This is called both before and after the modification.
4239 AFTER is nonzero when we call after the modification.
4240
4241 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4242 When AFTER is nonzero, they are the start position,
4243 the position after the inserted new text,
4244 and the length of deleted or replaced old text. */
4245
4246 void
4247 report_overlay_modification (start, end, after, arg1, arg2, arg3)
4248 Lisp_Object start, end;
4249 int after;
4250 Lisp_Object arg1, arg2, arg3;
4251 {
4252 Lisp_Object prop, overlay;
4253 struct Lisp_Overlay *tail;
4254 /* 1 if this change is an insertion. */
4255 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4256 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4257
4258 overlay = Qnil;
4259 tail = NULL;
4260
4261 /* We used to run the functions as soon as we found them and only register
4262 them in last_overlay_modification_hooks for the purpose of the `after'
4263 case. But running elisp code as we traverse the list of overlays is
4264 painful because the list can be modified by the elisp code so we had to
4265 copy at several places. We now simply do a read-only traversal that
4266 only collects the functions to run and we run them afterwards. It's
4267 simpler, especially since all the code was already there. -stef */
4268
4269 if (!after)
4270 {
4271 /* We are being called before a change.
4272 Scan the overlays to find the functions to call. */
4273 last_overlay_modification_hooks_used = 0;
4274 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4275 {
4276 int startpos, endpos;
4277 Lisp_Object ostart, oend;
4278
4279 XSETMISC (overlay, tail);
4280
4281 ostart = OVERLAY_START (overlay);
4282 oend = OVERLAY_END (overlay);
4283 endpos = OVERLAY_POSITION (oend);
4284 if (XFASTINT (start) > endpos)
4285 break;
4286 startpos = OVERLAY_POSITION (ostart);
4287 if (insertion && (XFASTINT (start) == startpos
4288 || XFASTINT (end) == startpos))
4289 {
4290 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4291 if (!NILP (prop))
4292 add_overlay_mod_hooklist (prop, overlay);
4293 }
4294 if (insertion && (XFASTINT (start) == endpos
4295 || XFASTINT (end) == endpos))
4296 {
4297 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4298 if (!NILP (prop))
4299 add_overlay_mod_hooklist (prop, overlay);
4300 }
4301 /* Test for intersecting intervals. This does the right thing
4302 for both insertion and deletion. */
4303 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4304 {
4305 prop = Foverlay_get (overlay, Qmodification_hooks);
4306 if (!NILP (prop))
4307 add_overlay_mod_hooklist (prop, overlay);
4308 }
4309 }
4310
4311 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4312 {
4313 int startpos, endpos;
4314 Lisp_Object ostart, oend;
4315
4316 XSETMISC (overlay, tail);
4317
4318 ostart = OVERLAY_START (overlay);
4319 oend = OVERLAY_END (overlay);
4320 startpos = OVERLAY_POSITION (ostart);
4321 endpos = OVERLAY_POSITION (oend);
4322 if (XFASTINT (end) < startpos)
4323 break;
4324 if (insertion && (XFASTINT (start) == startpos
4325 || XFASTINT (end) == startpos))
4326 {
4327 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4328 if (!NILP (prop))
4329 add_overlay_mod_hooklist (prop, overlay);
4330 }
4331 if (insertion && (XFASTINT (start) == endpos
4332 || XFASTINT (end) == endpos))
4333 {
4334 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4335 if (!NILP (prop))
4336 add_overlay_mod_hooklist (prop, overlay);
4337 }
4338 /* Test for intersecting intervals. This does the right thing
4339 for both insertion and deletion. */
4340 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4341 {
4342 prop = Foverlay_get (overlay, Qmodification_hooks);
4343 if (!NILP (prop))
4344 add_overlay_mod_hooklist (prop, overlay);
4345 }
4346 }
4347 }
4348
4349 GCPRO4 (overlay, arg1, arg2, arg3);
4350 {
4351 /* Call the functions recorded in last_overlay_modification_hooks.
4352 First copy the vector contents, in case some of these hooks
4353 do subsequent modification of the buffer. */
4354 int size = last_overlay_modification_hooks_used;
4355 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4356 int i;
4357
4358 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4359 copy, size * sizeof (Lisp_Object));
4360 gcpro1.var = copy;
4361 gcpro1.nvars = size;
4362
4363 for (i = 0; i < size;)
4364 {
4365 Lisp_Object prop, overlay;
4366 prop = copy[i++];
4367 overlay = copy[i++];
4368 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4369 }
4370 }
4371 UNGCPRO;
4372 }
4373
4374 static void
4375 call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4376 Lisp_Object list, overlay;
4377 int after;
4378 Lisp_Object arg1, arg2, arg3;
4379 {
4380 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4381
4382 GCPRO4 (list, arg1, arg2, arg3);
4383
4384 while (CONSP (list))
4385 {
4386 if (NILP (arg3))
4387 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4388 else
4389 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4390 list = XCDR (list);
4391 }
4392 UNGCPRO;
4393 }
4394
4395 /* Delete any zero-sized overlays at position POS, if the `evaporate'
4396 property is set. */
4397 void
4398 evaporate_overlays (pos)
4399 EMACS_INT pos;
4400 {
4401 Lisp_Object overlay, hit_list;
4402 struct Lisp_Overlay *tail;
4403
4404 hit_list = Qnil;
4405 if (pos <= current_buffer->overlay_center)
4406 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4407 {
4408 int endpos;
4409 XSETMISC (overlay, tail);
4410 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4411 if (endpos < pos)
4412 break;
4413 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4414 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4415 hit_list = Fcons (overlay, hit_list);
4416 }
4417 else
4418 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4419 {
4420 int startpos;
4421 XSETMISC (overlay, tail);
4422 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4423 if (startpos > pos)
4424 break;
4425 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4426 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4427 hit_list = Fcons (overlay, hit_list);
4428 }
4429 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4430 Fdelete_overlay (XCAR (hit_list));
4431 }
4432 \f
4433 /* Somebody has tried to store a value with an unacceptable type
4434 in the slot with offset OFFSET. */
4435
4436 void
4437 buffer_slot_type_mismatch (offset)
4438 int offset;
4439 {
4440 Lisp_Object sym;
4441 char *type_name;
4442
4443 switch (XINT (PER_BUFFER_TYPE (offset)))
4444 {
4445 case Lisp_Int:
4446 type_name = "integers";
4447 break;
4448
4449 case Lisp_String:
4450 type_name = "strings";
4451 break;
4452
4453 case Lisp_Symbol:
4454 type_name = "symbols";
4455 break;
4456
4457 default:
4458 abort ();
4459 }
4460
4461 sym = PER_BUFFER_SYMBOL (offset);
4462 error ("Only %s should be stored in the buffer-local variable %s",
4463 type_name, SDATA (SYMBOL_NAME (sym)));
4464 }
4465
4466 \f
4467 /***********************************************************************
4468 Allocation with mmap
4469 ***********************************************************************/
4470
4471 #ifdef USE_MMAP_FOR_BUFFERS
4472
4473 #include <sys/types.h>
4474 #include <sys/mman.h>
4475
4476 #ifndef MAP_ANON
4477 #ifdef MAP_ANONYMOUS
4478 #define MAP_ANON MAP_ANONYMOUS
4479 #else
4480 #define MAP_ANON 0
4481 #endif
4482 #endif
4483
4484 #ifndef MAP_FAILED
4485 #define MAP_FAILED ((void *) -1)
4486 #endif
4487
4488 #include <stdio.h>
4489 #include <errno.h>
4490
4491 #if MAP_ANON == 0
4492 #include <fcntl.h>
4493 #endif
4494
4495 #include "coding.h"
4496
4497
4498 /* Memory is allocated in regions which are mapped using mmap(2).
4499 The current implementation lets the system select mapped
4500 addresses; we're not using MAP_FIXED in general, except when
4501 trying to enlarge regions.
4502
4503 Each mapped region starts with a mmap_region structure, the user
4504 area starts after that structure, aligned to MEM_ALIGN.
4505
4506 +-----------------------+
4507 | struct mmap_info + |
4508 | padding |
4509 +-----------------------+
4510 | user data |
4511 | |
4512 | |
4513 +-----------------------+ */
4514
4515 struct mmap_region
4516 {
4517 /* User-specified size. */
4518 size_t nbytes_specified;
4519
4520 /* Number of bytes mapped */
4521 size_t nbytes_mapped;
4522
4523 /* Pointer to the location holding the address of the memory
4524 allocated with the mmap'd block. The variable actually points
4525 after this structure. */
4526 POINTER_TYPE **var;
4527
4528 /* Next and previous in list of all mmap'd regions. */
4529 struct mmap_region *next, *prev;
4530 };
4531
4532 /* Doubly-linked list of mmap'd regions. */
4533
4534 static struct mmap_region *mmap_regions;
4535
4536 /* File descriptor for mmap. If we don't have anonymous mapping,
4537 /dev/zero will be opened on it. */
4538
4539 static int mmap_fd;
4540
4541 /* Temporary storage for mmap_set_vars, see there. */
4542
4543 static struct mmap_region *mmap_regions_1;
4544 static int mmap_fd_1;
4545
4546 /* Page size on this system. */
4547
4548 static int mmap_page_size;
4549
4550 /* 1 means mmap has been intialized. */
4551
4552 static int mmap_initialized_p;
4553
4554 /* Value is X rounded up to the next multiple of N. */
4555
4556 #define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4557
4558 /* Size of mmap_region structure plus padding. */
4559
4560 #define MMAP_REGION_STRUCT_SIZE \
4561 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4562
4563 /* Given a pointer P to the start of the user-visible part of a mapped
4564 region, return a pointer to the start of the region. */
4565
4566 #define MMAP_REGION(P) \
4567 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4568
4569 /* Given a pointer P to the start of a mapped region, return a pointer
4570 to the start of the user-visible part of the region. */
4571
4572 #define MMAP_USER_AREA(P) \
4573 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4574
4575 #define MEM_ALIGN sizeof (double)
4576
4577 /* Predicate returning true if part of the address range [START .. END]
4578 is currently mapped. Used to prevent overwriting an existing
4579 memory mapping.
4580
4581 Default is to conservativly assume the address range is occupied by
4582 something else. This can be overridden by system configuration
4583 files if system-specific means to determine this exists. */
4584
4585 #ifndef MMAP_ALLOCATED_P
4586 #define MMAP_ALLOCATED_P(start, end) 1
4587 #endif
4588
4589 /* Function prototypes. */
4590
4591 static int mmap_free_1 P_ ((struct mmap_region *));
4592 static int mmap_enlarge P_ ((struct mmap_region *, int));
4593 static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4594 static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4595 static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4596 static void mmap_free P_ ((POINTER_TYPE **ptr));
4597 static void mmap_init P_ ((void));
4598
4599
4600 /* Return a region overlapping address range START...END, or null if
4601 none. END is not including, i.e. the last byte in the range
4602 is at END - 1. */
4603
4604 static struct mmap_region *
4605 mmap_find (start, end)
4606 POINTER_TYPE *start, *end;
4607 {
4608 struct mmap_region *r;
4609 char *s = (char *) start, *e = (char *) end;
4610
4611 for (r = mmap_regions; r; r = r->next)
4612 {
4613 char *rstart = (char *) r;
4614 char *rend = rstart + r->nbytes_mapped;
4615
4616 if (/* First byte of range, i.e. START, in this region? */
4617 (s >= rstart && s < rend)
4618 /* Last byte of range, i.e. END - 1, in this region? */
4619 || (e > rstart && e <= rend)
4620 /* First byte of this region in the range? */
4621 || (rstart >= s && rstart < e)
4622 /* Last byte of this region in the range? */
4623 || (rend > s && rend <= e))
4624 break;
4625 }
4626
4627 return r;
4628 }
4629
4630
4631 /* Unmap a region. P is a pointer to the start of the user-araa of
4632 the region. Value is non-zero if successful. */
4633
4634 static int
4635 mmap_free_1 (r)
4636 struct mmap_region *r;
4637 {
4638 if (r->next)
4639 r->next->prev = r->prev;
4640 if (r->prev)
4641 r->prev->next = r->next;
4642 else
4643 mmap_regions = r->next;
4644
4645 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4646 {
4647 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4648 return 0;
4649 }
4650
4651 return 1;
4652 }
4653
4654
4655 /* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4656 Value is non-zero if successful. */
4657
4658 static int
4659 mmap_enlarge (r, npages)
4660 struct mmap_region *r;
4661 int npages;
4662 {
4663 char *region_end = (char *) r + r->nbytes_mapped;
4664 size_t nbytes;
4665 int success = 0;
4666
4667 if (npages < 0)
4668 {
4669 /* Unmap pages at the end of the region. */
4670 nbytes = - npages * mmap_page_size;
4671 if (munmap (region_end - nbytes, nbytes) == -1)
4672 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4673 else
4674 {
4675 r->nbytes_mapped -= nbytes;
4676 success = 1;
4677 }
4678 }
4679 else if (npages > 0)
4680 {
4681 nbytes = npages * mmap_page_size;
4682
4683 /* Try to map additional pages at the end of the region. We
4684 cannot do this if the address range is already occupied by
4685 something else because mmap deletes any previous mapping.
4686 I'm not sure this is worth doing, let's see. */
4687 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4688 {
4689 POINTER_TYPE *p;
4690
4691 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4692 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4693 if (p == MAP_FAILED)
4694 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4695 else if (p != (POINTER_TYPE *) region_end)
4696 {
4697 /* Kernels are free to choose a different address. In
4698 that case, unmap what we've mapped above; we have
4699 no use for it. */
4700 if (munmap (p, nbytes) == -1)
4701 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4702 }
4703 else
4704 {
4705 r->nbytes_mapped += nbytes;
4706 success = 1;
4707 }
4708 }
4709 }
4710
4711 return success;
4712 }
4713
4714
4715 /* Set or reset variables holding references to mapped regions. If
4716 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4717 non-zero, set all variables to the start of the user-areas
4718 of mapped regions.
4719
4720 This function is called from Fdump_emacs to ensure that the dumped
4721 Emacs doesn't contain references to memory that won't be mapped
4722 when Emacs starts. */
4723
4724 void
4725 mmap_set_vars (restore_p)
4726 int restore_p;
4727 {
4728 struct mmap_region *r;
4729
4730 if (restore_p)
4731 {
4732 mmap_regions = mmap_regions_1;
4733 mmap_fd = mmap_fd_1;
4734 for (r = mmap_regions; r; r = r->next)
4735 *r->var = MMAP_USER_AREA (r);
4736 }
4737 else
4738 {
4739 for (r = mmap_regions; r; r = r->next)
4740 *r->var = NULL;
4741 mmap_regions_1 = mmap_regions;
4742 mmap_regions = NULL;
4743 mmap_fd_1 = mmap_fd;
4744 mmap_fd = -1;
4745 }
4746 }
4747
4748
4749 /* Allocate a block of storage large enough to hold NBYTES bytes of
4750 data. A pointer to the data is returned in *VAR. VAR is thus the
4751 address of some variable which will use the data area.
4752
4753 The allocation of 0 bytes is valid.
4754
4755 If we can't allocate the necessary memory, set *VAR to null, and
4756 return null. */
4757
4758 static POINTER_TYPE *
4759 mmap_alloc (var, nbytes)
4760 POINTER_TYPE **var;
4761 size_t nbytes;
4762 {
4763 void *p;
4764 size_t map;
4765
4766 mmap_init ();
4767
4768 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4769 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4770 mmap_fd, 0);
4771
4772 if (p == MAP_FAILED)
4773 {
4774 if (errno != ENOMEM)
4775 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4776 p = NULL;
4777 }
4778 else
4779 {
4780 struct mmap_region *r = (struct mmap_region *) p;
4781
4782 r->nbytes_specified = nbytes;
4783 r->nbytes_mapped = map;
4784 r->var = var;
4785 r->prev = NULL;
4786 r->next = mmap_regions;
4787 if (r->next)
4788 r->next->prev = r;
4789 mmap_regions = r;
4790
4791 p = MMAP_USER_AREA (p);
4792 }
4793
4794 return *var = p;
4795 }
4796
4797
4798 /* Given a pointer at address VAR to data allocated with mmap_alloc,
4799 resize it to size NBYTES. Change *VAR to reflect the new block,
4800 and return this value. If more memory cannot be allocated, then
4801 leave *VAR unchanged, and return null. */
4802
4803 static POINTER_TYPE *
4804 mmap_realloc (var, nbytes)
4805 POINTER_TYPE **var;
4806 size_t nbytes;
4807 {
4808 POINTER_TYPE *result;
4809
4810 mmap_init ();
4811
4812 if (*var == NULL)
4813 result = mmap_alloc (var, nbytes);
4814 else if (nbytes == 0)
4815 {
4816 mmap_free (var);
4817 result = mmap_alloc (var, nbytes);
4818 }
4819 else
4820 {
4821 struct mmap_region *r = MMAP_REGION (*var);
4822 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4823
4824 if (room < nbytes)
4825 {
4826 /* Must enlarge. */
4827 POINTER_TYPE *old_ptr = *var;
4828
4829 /* Try to map additional pages at the end of the region.
4830 If that fails, allocate a new region, copy data
4831 from the old region, then free it. */
4832 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4833 / mmap_page_size)))
4834 {
4835 r->nbytes_specified = nbytes;
4836 *var = result = old_ptr;
4837 }
4838 else if (mmap_alloc (var, nbytes))
4839 {
4840 bcopy (old_ptr, *var, r->nbytes_specified);
4841 mmap_free_1 (MMAP_REGION (old_ptr));
4842 result = *var;
4843 r = MMAP_REGION (result);
4844 r->nbytes_specified = nbytes;
4845 }
4846 else
4847 {
4848 *var = old_ptr;
4849 result = NULL;
4850 }
4851 }
4852 else if (room - nbytes >= mmap_page_size)
4853 {
4854 /* Shrinking by at least a page. Let's give some
4855 memory back to the system.
4856
4857 The extra parens are to make the division happens first,
4858 on positive values, so we know it will round towards
4859 zero. */
4860 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4861 result = *var;
4862 r->nbytes_specified = nbytes;
4863 }
4864 else
4865 {
4866 /* Leave it alone. */
4867 result = *var;
4868 r->nbytes_specified = nbytes;
4869 }
4870 }
4871
4872 return result;
4873 }
4874
4875
4876 /* Free a block of relocatable storage whose data is pointed to by
4877 PTR. Store 0 in *PTR to show there's no block allocated. */
4878
4879 static void
4880 mmap_free (var)
4881 POINTER_TYPE **var;
4882 {
4883 mmap_init ();
4884
4885 if (*var)
4886 {
4887 mmap_free_1 (MMAP_REGION (*var));
4888 *var = NULL;
4889 }
4890 }
4891
4892
4893 /* Perform necessary intializations for the use of mmap. */
4894
4895 static void
4896 mmap_init ()
4897 {
4898 #if MAP_ANON == 0
4899 /* The value of mmap_fd is initially 0 in temacs, and -1
4900 in a dumped Emacs. */
4901 if (mmap_fd <= 0)
4902 {
4903 /* No anonymous mmap -- we need the file descriptor. */
4904 mmap_fd = open ("/dev/zero", O_RDONLY);
4905 if (mmap_fd == -1)
4906 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4907 }
4908 #endif /* MAP_ANON == 0 */
4909
4910 if (mmap_initialized_p)
4911 return;
4912 mmap_initialized_p = 1;
4913
4914 #if MAP_ANON != 0
4915 mmap_fd = -1;
4916 #endif
4917
4918 mmap_page_size = getpagesize ();
4919 }
4920
4921 #endif /* USE_MMAP_FOR_BUFFERS */
4922
4923
4924 \f
4925 /***********************************************************************
4926 Buffer-text Allocation
4927 ***********************************************************************/
4928
4929 #ifdef REL_ALLOC
4930 extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4931 extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4932 extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4933 #endif /* REL_ALLOC */
4934
4935
4936 /* Allocate NBYTES bytes for buffer B's text buffer. */
4937
4938 static void
4939 alloc_buffer_text (b, nbytes)
4940 struct buffer *b;
4941 size_t nbytes;
4942 {
4943 POINTER_TYPE *p;
4944
4945 BLOCK_INPUT;
4946 #if defined USE_MMAP_FOR_BUFFERS
4947 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4948 #elif defined REL_ALLOC
4949 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4950 #else
4951 p = xmalloc (nbytes);
4952 #endif
4953
4954 if (p == NULL)
4955 {
4956 UNBLOCK_INPUT;
4957 memory_full ();
4958 }
4959
4960 b->text->beg = (unsigned char *) p;
4961 UNBLOCK_INPUT;
4962 }
4963
4964 /* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4965 shrink it. */
4966
4967 void
4968 enlarge_buffer_text (b, delta)
4969 struct buffer *b;
4970 int delta;
4971 {
4972 POINTER_TYPE *p;
4973 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4974 + delta);
4975 BLOCK_INPUT;
4976 #if defined USE_MMAP_FOR_BUFFERS
4977 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4978 #elif defined REL_ALLOC
4979 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4980 #else
4981 p = xrealloc (b->text->beg, nbytes);
4982 #endif
4983
4984 if (p == NULL)
4985 {
4986 UNBLOCK_INPUT;
4987 memory_full ();
4988 }
4989
4990 BUF_BEG_ADDR (b) = (unsigned char *) p;
4991 UNBLOCK_INPUT;
4992 }
4993
4994
4995 /* Free buffer B's text buffer. */
4996
4997 static void
4998 free_buffer_text (b)
4999 struct buffer *b;
5000 {
5001 BLOCK_INPUT;
5002
5003 #if defined USE_MMAP_FOR_BUFFERS
5004 mmap_free ((POINTER_TYPE **) &b->text->beg);
5005 #elif defined REL_ALLOC
5006 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
5007 #else
5008 xfree (b->text->beg);
5009 #endif
5010
5011 BUF_BEG_ADDR (b) = NULL;
5012 UNBLOCK_INPUT;
5013 }
5014
5015
5016 \f
5017 /***********************************************************************
5018 Initialization
5019 ***********************************************************************/
5020
5021 void
5022 init_buffer_once ()
5023 {
5024 int idx;
5025
5026 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
5027
5028 /* Make sure all markable slots in buffer_defaults
5029 are initialized reasonably, so mark_buffer won't choke. */
5030 reset_buffer (&buffer_defaults);
5031 reset_buffer_local_variables (&buffer_defaults, 1);
5032 reset_buffer (&buffer_local_symbols);
5033 reset_buffer_local_variables (&buffer_local_symbols, 1);
5034 /* Prevent GC from getting confused. */
5035 buffer_defaults.text = &buffer_defaults.own_text;
5036 buffer_local_symbols.text = &buffer_local_symbols.own_text;
5037 BUF_INTERVALS (&buffer_defaults) = 0;
5038 BUF_INTERVALS (&buffer_local_symbols) = 0;
5039 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
5040 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
5041
5042 /* Set up the default values of various buffer slots. */
5043 /* Must do these before making the first buffer! */
5044
5045 /* real setup is done in bindings.el */
5046 buffer_defaults.mode_line_format = build_string ("%-");
5047 buffer_defaults.header_line_format = Qnil;
5048 buffer_defaults.abbrev_mode = Qnil;
5049 buffer_defaults.overwrite_mode = Qnil;
5050 buffer_defaults.case_fold_search = Qt;
5051 buffer_defaults.auto_fill_function = Qnil;
5052 buffer_defaults.selective_display = Qnil;
5053 #ifndef old
5054 buffer_defaults.selective_display_ellipses = Qt;
5055 #endif
5056 buffer_defaults.abbrev_table = Qnil;
5057 buffer_defaults.display_table = Qnil;
5058 buffer_defaults.undo_list = Qnil;
5059 buffer_defaults.mark_active = Qnil;
5060 buffer_defaults.file_format = Qnil;
5061 buffer_defaults.auto_save_file_format = Qt;
5062 buffer_defaults.overlays_before = NULL;
5063 buffer_defaults.overlays_after = NULL;
5064 buffer_defaults.overlay_center = BEG;
5065
5066 XSETFASTINT (buffer_defaults.tab_width, 8);
5067 buffer_defaults.truncate_lines = Qnil;
5068 buffer_defaults.ctl_arrow = Qt;
5069 buffer_defaults.direction_reversed = Qnil;
5070 buffer_defaults.cursor_type = Qt;
5071 buffer_defaults.extra_line_spacing = Qnil;
5072 buffer_defaults.cursor_in_non_selected_windows = Qt;
5073
5074 #ifdef DOS_NT
5075 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
5076 #endif
5077 buffer_defaults.enable_multibyte_characters = Qt;
5078 buffer_defaults.buffer_file_coding_system = Qnil;
5079 XSETFASTINT (buffer_defaults.fill_column, 70);
5080 XSETFASTINT (buffer_defaults.left_margin, 0);
5081 buffer_defaults.cache_long_line_scans = Qnil;
5082 buffer_defaults.file_truename = Qnil;
5083 XSETFASTINT (buffer_defaults.display_count, 0);
5084 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
5085 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
5086 buffer_defaults.left_fringe_width = Qnil;
5087 buffer_defaults.right_fringe_width = Qnil;
5088 buffer_defaults.fringes_outside_margins = Qnil;
5089 buffer_defaults.scroll_bar_width = Qnil;
5090 buffer_defaults.vertical_scroll_bar_type = Qt;
5091 buffer_defaults.indicate_empty_lines = Qnil;
5092 buffer_defaults.indicate_buffer_boundaries = Qnil;
5093 buffer_defaults.fringe_indicator_alist = Qnil;
5094 buffer_defaults.fringe_cursor_alist = Qnil;
5095 buffer_defaults.scroll_up_aggressively = Qnil;
5096 buffer_defaults.scroll_down_aggressively = Qnil;
5097 buffer_defaults.display_time = Qnil;
5098
5099 /* Assign the local-flags to the slots that have default values.
5100 The local flag is a bit that is used in the buffer
5101 to say that it has its own local value for the slot.
5102 The local flag bits are in the local_var_flags slot of the buffer. */
5103
5104 /* Nothing can work if this isn't true */
5105 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
5106
5107 /* 0 means not a lisp var, -1 means always local, else mask */
5108 bzero (&buffer_local_flags, sizeof buffer_local_flags);
5109 XSETINT (buffer_local_flags.filename, -1);
5110 XSETINT (buffer_local_flags.directory, -1);
5111 XSETINT (buffer_local_flags.backed_up, -1);
5112 XSETINT (buffer_local_flags.save_length, -1);
5113 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5114 XSETINT (buffer_local_flags.read_only, -1);
5115 XSETINT (buffer_local_flags.major_mode, -1);
5116 XSETINT (buffer_local_flags.mode_name, -1);
5117 XSETINT (buffer_local_flags.undo_list, -1);
5118 XSETINT (buffer_local_flags.mark_active, -1);
5119 XSETINT (buffer_local_flags.point_before_scroll, -1);
5120 XSETINT (buffer_local_flags.file_truename, -1);
5121 XSETINT (buffer_local_flags.invisibility_spec, -1);
5122 XSETINT (buffer_local_flags.file_format, -1);
5123 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5124 XSETINT (buffer_local_flags.display_count, -1);
5125 XSETINT (buffer_local_flags.display_time, -1);
5126 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5127
5128 idx = 1;
5129 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5130 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5131 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5132 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5133 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5134 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5135 #ifndef old
5136 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5137 #endif
5138 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5139 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5140 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5141 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5142 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5143 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5144 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5145 #ifdef DOS_NT
5146 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5147 /* Make this one a permanent local. */
5148 buffer_permanent_local_flags[idx++] = 1;
5149 #endif
5150 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5151 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5152 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5153 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5154 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5155 /* Make this one a permanent local. */
5156 buffer_permanent_local_flags[idx++] = 1;
5157 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5158 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5159 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5160 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5161 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5162 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5163 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5164 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5165 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5166 XSETFASTINT (buffer_local_flags.fringe_indicator_alist, idx); ++idx;
5167 XSETFASTINT (buffer_local_flags.fringe_cursor_alist, idx); ++idx;
5168 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5169 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5170 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5171 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5172 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5173 XSETFASTINT (buffer_local_flags.cursor_in_non_selected_windows, idx); ++idx;
5174
5175 /* Need more room? */
5176 if (idx >= MAX_PER_BUFFER_VARS)
5177 abort ();
5178 last_per_buffer_idx = idx;
5179
5180 Vbuffer_alist = Qnil;
5181 current_buffer = 0;
5182 all_buffers = 0;
5183
5184 QSFundamental = build_string ("Fundamental");
5185
5186 Qfundamental_mode = intern ("fundamental-mode");
5187 buffer_defaults.major_mode = Qfundamental_mode;
5188
5189 Qmode_class = intern ("mode-class");
5190
5191 Qprotected_field = intern ("protected-field");
5192
5193 Qpermanent_local = intern ("permanent-local");
5194
5195 Qkill_buffer_hook = intern ("kill-buffer-hook");
5196 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5197
5198 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5199
5200 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5201
5202 /* super-magic invisible buffer */
5203 Vbuffer_alist = Qnil;
5204
5205 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5206
5207 inhibit_modification_hooks = 0;
5208 }
5209
5210 void
5211 init_buffer ()
5212 {
5213 char *pwd;
5214 Lisp_Object temp;
5215 int len;
5216
5217 #ifdef USE_MMAP_FOR_BUFFERS
5218 {
5219 /* When using the ralloc implementation based on mmap(2), buffer
5220 text pointers will have been set to null in the dumped Emacs.
5221 Map new memory. */
5222 struct buffer *b;
5223
5224 for (b = all_buffers; b; b = b->next)
5225 if (b->text->beg == NULL)
5226 enlarge_buffer_text (b, 0);
5227 }
5228 #endif /* USE_MMAP_FOR_BUFFERS */
5229
5230 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5231 if (NILP (buffer_defaults.enable_multibyte_characters))
5232 Fset_buffer_multibyte (Qnil);
5233
5234 pwd = get_current_dir_name ();
5235
5236 if (!pwd)
5237 fatal ("`get_current_dir_name' failed: %s\n", strerror (errno));
5238
5239 #ifndef VMS
5240 /* Maybe this should really use some standard subroutine
5241 whose definition is filename syntax dependent. */
5242 len = strlen (pwd);
5243 if (!(IS_DIRECTORY_SEP (pwd[len - 1])))
5244 {
5245 /* Grow buffer to add directory separator and '\0'. */
5246 pwd = (char *) xrealloc (pwd, len + 2);
5247 pwd[len] = DIRECTORY_SEP;
5248 pwd[len + 1] = '\0';
5249 }
5250 #endif /* not VMS */
5251
5252 current_buffer->directory = make_unibyte_string (pwd, strlen (pwd));
5253 if (! NILP (buffer_defaults.enable_multibyte_characters))
5254 /* At this moment, we still don't know how to decode the
5255 directory name. So, we keep the bytes in multibyte form so
5256 that ENCODE_FILE correctly gets the original bytes. */
5257 current_buffer->directory
5258 = string_to_multibyte (current_buffer->directory);
5259
5260 /* Add /: to the front of the name
5261 if it would otherwise be treated as magic. */
5262 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5263 if (! NILP (temp)
5264 /* If the default dir is just /, TEMP is non-nil
5265 because of the ange-ftp completion handler.
5266 However, it is not necessary to turn / into /:/.
5267 So avoid doing that. */
5268 && strcmp ("/", SDATA (current_buffer->directory)))
5269 current_buffer->directory
5270 = concat2 (build_string ("/:"), current_buffer->directory);
5271
5272 temp = get_minibuffer (0);
5273 XBUFFER (temp)->directory = current_buffer->directory;
5274
5275 free (pwd);
5276 }
5277
5278 /* initialize the buffer routines */
5279 void
5280 syms_of_buffer ()
5281 {
5282 staticpro (&last_overlay_modification_hooks);
5283 last_overlay_modification_hooks
5284 = Fmake_vector (make_number (10), Qnil);
5285
5286 staticpro (&Vbuffer_defaults);
5287 staticpro (&Vbuffer_local_symbols);
5288 staticpro (&Qfundamental_mode);
5289 staticpro (&Qmode_class);
5290 staticpro (&QSFundamental);
5291 staticpro (&Vbuffer_alist);
5292 staticpro (&Qprotected_field);
5293 staticpro (&Qpermanent_local);
5294 staticpro (&Qkill_buffer_hook);
5295 Qoverlayp = intern ("overlayp");
5296 staticpro (&Qoverlayp);
5297 Qevaporate = intern ("evaporate");
5298 staticpro (&Qevaporate);
5299 Qmodification_hooks = intern ("modification-hooks");
5300 staticpro (&Qmodification_hooks);
5301 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5302 staticpro (&Qinsert_in_front_hooks);
5303 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5304 staticpro (&Qinsert_behind_hooks);
5305 Qget_file_buffer = intern ("get-file-buffer");
5306 staticpro (&Qget_file_buffer);
5307 Qpriority = intern ("priority");
5308 staticpro (&Qpriority);
5309 Qwindow = intern ("window");
5310 staticpro (&Qwindow);
5311 Qbefore_string = intern ("before-string");
5312 staticpro (&Qbefore_string);
5313 Qafter_string = intern ("after-string");
5314 staticpro (&Qafter_string);
5315 Qfirst_change_hook = intern ("first-change-hook");
5316 staticpro (&Qfirst_change_hook);
5317 Qbefore_change_functions = intern ("before-change-functions");
5318 staticpro (&Qbefore_change_functions);
5319 Qafter_change_functions = intern ("after-change-functions");
5320 staticpro (&Qafter_change_functions);
5321 staticpro (&Qucs_set_table_for_input);
5322
5323 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5324 staticpro (&Qkill_buffer_query_functions);
5325
5326 Fput (Qprotected_field, Qerror_conditions,
5327 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5328 Fput (Qprotected_field, Qerror_message,
5329 build_string ("Attempt to modify a protected field"));
5330
5331 /* All these use DEFVAR_LISP_NOPRO because the slots in
5332 buffer_defaults will all be marked via Vbuffer_defaults. */
5333
5334 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5335 &buffer_defaults.mode_line_format,
5336 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5337 This is the same as (default-value 'mode-line-format). */);
5338
5339 DEFVAR_LISP_NOPRO ("default-header-line-format",
5340 &buffer_defaults.header_line_format,
5341 doc: /* Default value of `header-line-format' for buffers that don't override it.
5342 This is the same as (default-value 'header-line-format). */);
5343
5344 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5345 doc: /* Default value of `cursor-type' for buffers that don't override it.
5346 This is the same as (default-value 'cursor-type). */);
5347
5348 DEFVAR_LISP_NOPRO ("default-line-spacing",
5349 &buffer_defaults.extra_line_spacing,
5350 doc: /* Default value of `line-spacing' for buffers that don't override it.
5351 This is the same as (default-value 'line-spacing). */);
5352
5353 DEFVAR_LISP_NOPRO ("default-cursor-in-non-selected-windows",
5354 &buffer_defaults.cursor_in_non_selected_windows,
5355 doc: /* Default value of `cursor-in-non-selected-windows'.
5356 This is the same as (default-value 'cursor-in-non-selected-windows). */);
5357
5358 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5359 &buffer_defaults.abbrev_mode,
5360 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5361 This is the same as (default-value 'abbrev-mode). */);
5362
5363 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5364 &buffer_defaults.ctl_arrow,
5365 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5366 This is the same as (default-value 'ctl-arrow). */);
5367
5368 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5369 &buffer_defaults.direction_reversed,
5370 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5371 This is the same as (default-value 'direction-reversed). */);
5372
5373 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5374 &buffer_defaults.enable_multibyte_characters,
5375 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5376 This is the same as (default-value 'enable-multibyte-characters). */);
5377
5378 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5379 &buffer_defaults.buffer_file_coding_system,
5380 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5381 This is the same as (default-value 'buffer-file-coding-system). */);
5382
5383 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5384 &buffer_defaults.truncate_lines,
5385 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5386 This is the same as (default-value 'truncate-lines). */);
5387
5388 DEFVAR_LISP_NOPRO ("default-fill-column",
5389 &buffer_defaults.fill_column,
5390 doc: /* Default value of `fill-column' for buffers that do not override it.
5391 This is the same as (default-value 'fill-column). */);
5392
5393 DEFVAR_LISP_NOPRO ("default-left-margin",
5394 &buffer_defaults.left_margin,
5395 doc: /* Default value of `left-margin' for buffers that do not override it.
5396 This is the same as (default-value 'left-margin). */);
5397
5398 DEFVAR_LISP_NOPRO ("default-tab-width",
5399 &buffer_defaults.tab_width,
5400 doc: /* Default value of `tab-width' for buffers that do not override it.
5401 This is the same as (default-value 'tab-width). */);
5402
5403 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5404 &buffer_defaults.case_fold_search,
5405 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5406 This is the same as (default-value 'case-fold-search). */);
5407
5408 #ifdef DOS_NT
5409 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5410 &buffer_defaults.buffer_file_type,
5411 doc: /* Default file type for buffers that do not override it.
5412 This is the same as (default-value 'buffer-file-type).
5413 The file type is nil for text, t for binary. */);
5414 #endif
5415
5416 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5417 &buffer_defaults.left_margin_cols,
5418 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5419 This is the same as (default-value 'left-margin-width). */);
5420
5421 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5422 &buffer_defaults.right_margin_cols,
5423 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5424 This is the same as (default-value 'right-margin-width). */);
5425
5426 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5427 &buffer_defaults.left_fringe_width,
5428 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5429 This is the same as (default-value 'left-fringe-width). */);
5430
5431 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5432 &buffer_defaults.right_fringe_width,
5433 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5434 This is the same as (default-value 'right-fringe-width). */);
5435
5436 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5437 &buffer_defaults.fringes_outside_margins,
5438 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5439 This is the same as (default-value 'fringes-outside-margins). */);
5440
5441 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5442 &buffer_defaults.scroll_bar_width,
5443 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5444 This is the same as (default-value 'scroll-bar-width). */);
5445
5446 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5447 &buffer_defaults.vertical_scroll_bar_type,
5448 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5449 This is the same as (default-value 'vertical-scroll-bar). */);
5450
5451 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5452 &buffer_defaults.indicate_empty_lines,
5453 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5454 This is the same as (default-value 'indicate-empty-lines). */);
5455
5456 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5457 &buffer_defaults.indicate_buffer_boundaries,
5458 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5459 This is the same as (default-value 'indicate-buffer-boundaries). */);
5460
5461 DEFVAR_LISP_NOPRO ("default-fringe-indicator-alist",
5462 &buffer_defaults.fringe_indicator_alist,
5463 doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it.
5464 This is the same as (default-value 'fringe-indicator-alist'). */);
5465
5466 DEFVAR_LISP_NOPRO ("default-fringe-cursor-alist",
5467 &buffer_defaults.fringe_cursor_alist,
5468 doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it.
5469 This is the same as (default-value 'fringe-cursor-alist'). */);
5470
5471 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5472 &buffer_defaults.scroll_up_aggressively,
5473 doc: /* Default value of `scroll-up-aggressively'.
5474 This value applies in buffers that don't have their own local values.
5475 This is the same as (default-value 'scroll-up-aggressively). */);
5476
5477 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5478 &buffer_defaults.scroll_down_aggressively,
5479 doc: /* Default value of `scroll-down-aggressively'.
5480 This value applies in buffers that don't have their own local values.
5481 This is the same as (default-value 'scroll-down-aggressively). */);
5482
5483 DEFVAR_PER_BUFFER ("header-line-format",
5484 &current_buffer->header_line_format,
5485 Qnil,
5486 doc: /* Analogous to `mode-line-format', but controls the header line.
5487 The header line appears, optionally, at the top of a window;
5488 the mode line appears at the bottom. */);
5489
5490 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5491 Qnil,
5492 doc: /* Template for displaying mode line for current buffer.
5493 Each buffer has its own value of this variable.
5494 Value may be nil, a string, a symbol or a list or cons cell.
5495 A value of nil means don't display a mode line.
5496 For a symbol, its value is used (but it is ignored if t or nil).
5497 A string appearing directly as the value of a symbol is processed verbatim
5498 in that the %-constructs below are not recognized.
5499 Note that unless the symbol is marked as a `risky-local-variable', all
5500 properties in any strings, as well as all :eval and :propertize forms
5501 in the value of that symbol will be ignored.
5502 For a list of the form `(:eval FORM)', FORM is evaluated and the result
5503 is used as a mode line element. Be careful--FORM should not load any files,
5504 because that can cause an infinite recursion.
5505 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5506 with the specified properties PROPS applied.
5507 For a list whose car is a symbol, the symbol's value is taken,
5508 and if that is non-nil, the cadr of the list is processed recursively.
5509 Otherwise, the caddr of the list (if there is one) is processed.
5510 For a list whose car is a string or list, each element is processed
5511 recursively and the results are effectively concatenated.
5512 For a list whose car is an integer, the cdr of the list is processed
5513 and padded (if the number is positive) or truncated (if negative)
5514 to the width specified by that number.
5515 A string is printed verbatim in the mode line except for %-constructs:
5516 (%-constructs are allowed when the string is the entire mode-line-format
5517 or when it is found in a cons-cell or a list)
5518 %b -- print buffer name. %f -- print visited file name.
5519 %F -- print frame name.
5520 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5521 %& is like %*, but ignore read-only-ness.
5522 % means buffer is read-only and * means it is modified.
5523 For a modified read-only buffer, %* gives % and %+ gives *.
5524 %s -- print process status. %l -- print the current line number.
5525 %c -- print the current column number (this makes editing slower).
5526 To make the column number update correctly in all cases,
5527 `column-number-mode' must be non-nil.
5528 %i -- print the size of the buffer.
5529 %I -- like %i, but use k, M, G, etc., to abbreviate.
5530 %p -- print percent of buffer above top of window, or Top, Bot or All.
5531 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5532 or print Bottom or All.
5533 %n -- print Narrow if appropriate.
5534 %t -- visited file is text or binary (if OS supports this distinction).
5535 %z -- print mnemonics of keyboard, terminal, and buffer coding systems.
5536 %Z -- like %z, but including the end-of-line format.
5537 %e -- print error message about full memory.
5538 %@ -- print @ or hyphen. @ means that default-directory is on a
5539 remote machine.
5540 %[ -- print one [ for each recursive editing level. %] similar.
5541 %% -- print %. %- -- print infinitely many dashes.
5542 Decimal digits after the % specify field width to which to pad. */);
5543
5544 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5545 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5546 A value of nil means use current buffer's major mode,
5547 provided it is not marked as "special".
5548
5549 When a mode is used by default, `find-file' switches to it
5550 before it reads the contents into the buffer and before
5551 it finishes setting up the buffer. Thus, the mode and
5552 its hooks should not expect certain variables such as
5553 `buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5554
5555 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5556 make_number (Lisp_Symbol),
5557 doc: /* Symbol for current buffer's major mode. */);
5558
5559 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5560 Qnil,
5561 doc: /* Pretty name of current buffer's major mode (a string). */);
5562
5563 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5564 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5565
5566 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5567 Qnil,
5568 doc: /* *Non-nil if searches and matches should ignore case. */);
5569
5570 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5571 make_number (Lisp_Int),
5572 doc: /* *Column beyond which automatic line-wrapping should happen.
5573 Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5574
5575 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5576 make_number (Lisp_Int),
5577 doc: /* *Column for the default `indent-line-function' to indent to.
5578 Linefeed indents to this column in Fundamental mode. */);
5579
5580 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5581 make_number (Lisp_Int),
5582 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5583
5584 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5585 doc: /* *Non-nil means display control chars with uparrow.
5586 A value of nil means use backslash and octal digits.
5587 This variable does not apply to characters whose display is specified
5588 in the current display table (if there is one). */);
5589
5590 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5591 &current_buffer->enable_multibyte_characters,
5592 Qnil,
5593 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5594 Otherwise they are regarded as unibyte. This affects the display,
5595 file I/O and the behavior of various editing commands.
5596
5597 This variable is buffer-local but you cannot set it directly;
5598 use the function `set-buffer-multibyte' to change a buffer's representation.
5599 Changing its default value with `setq-default' is supported.
5600 See also variable `default-enable-multibyte-characters' and Info node
5601 `(elisp)Text Representations'. */);
5602 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5603
5604 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5605 &current_buffer->buffer_file_coding_system, Qnil,
5606 doc: /* Coding system to be used for encoding the buffer contents on saving.
5607 This variable applies to saving the buffer, and also to `write-region'
5608 and other functions that use `write-region'.
5609 It does not apply to sending output to subprocesses, however.
5610
5611 If this is nil, the buffer is saved without any code conversion
5612 unless some coding system is specified in `file-coding-system-alist'
5613 for the buffer file.
5614
5615 If the text to be saved cannot be encoded as specified by this variable,
5616 an alternative encoding is selected by `select-safe-coding-system', which see.
5617
5618 The variable `coding-system-for-write', if non-nil, overrides this variable.
5619
5620 This variable is never applied to a way of decoding a file while reading it. */);
5621
5622 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5623 Qnil,
5624 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5625
5626 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5627 doc: /* *Non-nil means do not display continuation lines.
5628 Instead, give each line of text just one screen line.
5629
5630 Note that this is overridden by the variable
5631 `truncate-partial-width-windows' if that variable is non-nil
5632 and this buffer is not full-frame width. */);
5633
5634 #ifdef DOS_NT
5635 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5636 Qnil,
5637 doc: /* Non-nil if the visited file is a binary file.
5638 This variable is meaningful on MS-DOG and Windows NT.
5639 On those systems, it is automatically local in every buffer.
5640 On other systems, this variable is normally always nil. */);
5641 #endif
5642
5643 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5644 make_number (Lisp_String),
5645 doc: /* Name of default directory of current buffer. Should end with slash.
5646 To interactively change the default directory, use command `cd'. */);
5647
5648 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5649 Qnil,
5650 doc: /* Function called (if non-nil) to perform auto-fill.
5651 It is called after self-inserting any character specified in
5652 the `auto-fill-chars' table.
5653 NOTE: This variable is not a hook;
5654 its value may not be a list of functions. */);
5655
5656 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5657 make_number (Lisp_String),
5658 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5659
5660 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5661 make_number (Lisp_String),
5662 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5663 The truename of a file is calculated by `file-truename'
5664 and then abbreviated with `abbreviate-file-name'. */);
5665
5666 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5667 &current_buffer->auto_save_file_name,
5668 make_number (Lisp_String),
5669 doc: /* Name of file for auto-saving current buffer.
5670 If it is nil, that means don't auto-save this buffer. */);
5671
5672 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5673 doc: /* Non-nil if this buffer is read-only. */);
5674
5675 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5676 doc: /* Non-nil if this buffer's file has been backed up.
5677 Backing up is done before the first time the file is saved. */);
5678
5679 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5680 make_number (Lisp_Int),
5681 doc: /* Length of current buffer when last read in, saved or auto-saved.
5682 0 initially. */);
5683
5684 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5685 Qnil,
5686 doc: /* Non-nil enables selective display.
5687 An integer N as value means display only lines
5688 that start with less than N columns of space.
5689 A value of t means that the character ^M makes itself and
5690 all the rest of the line invisible; also, when saving the buffer
5691 in a file, save the ^M as a newline. */);
5692
5693 #ifndef old
5694 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5695 &current_buffer->selective_display_ellipses,
5696 Qnil,
5697 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5698 #endif
5699
5700 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5701 doc: /* Non-nil if self-insertion should replace existing text.
5702 The value should be one of `overwrite-mode-textual',
5703 `overwrite-mode-binary', or nil.
5704 If it is `overwrite-mode-textual', self-insertion still
5705 inserts at the end of a line, and inserts when point is before a tab,
5706 until the tab is filled in.
5707 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5708
5709 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5710 Qnil,
5711 doc: /* Display table that controls display of the contents of current buffer.
5712
5713 If this variable is nil, the value of `standard-display-table' is used.
5714 Each window can have its own, overriding display table, see
5715 `set-window-display-table' and `window-display-table'.
5716
5717 The display table is a char-table created with `make-display-table'.
5718 A char-table is an array indexed by character codes. Normal array
5719 primitives `aref' and `aset' can be used to access elements of a char-table.
5720
5721 Each of the char-table elements control how to display the corresponding
5722 text character: the element at index C in the table says how to display
5723 the character whose code is C. Each element should be a vector of
5724 characters or nil. The value nil means display the character in the
5725 default fashion; otherwise, the characters from the vector are delivered
5726 to the screen instead of the original character.
5727
5728 For example, (aset buffer-display-table ?X [?Y]) tells Emacs
5729 to display a capital Y instead of each X character.
5730
5731 In addition, a char-table has six extra slots to control the display of:
5732
5733 the end of a truncated screen line (extra-slot 0, a single character);
5734 the end of a continued line (extra-slot 1, a single character);
5735 the escape character used to display character codes in octal
5736 (extra-slot 2, a single character);
5737 the character used as an arrow for control characters (extra-slot 3,
5738 a single character);
5739 the decoration indicating the presence of invisible lines (extra-slot 4,
5740 a vector of characters);
5741 the character used to draw the border between side-by-side windows
5742 (extra-slot 5, a single character).
5743
5744 See also the functions `display-table-slot' and `set-display-table-slot'. */);
5745
5746 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5747 Qnil,
5748 doc: /* *Width of left marginal area for display of a buffer.
5749 A value of nil means no marginal area. */);
5750
5751 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5752 Qnil,
5753 doc: /* *Width of right marginal area for display of a buffer.
5754 A value of nil means no marginal area. */);
5755
5756 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5757 Qnil,
5758 doc: /* *Width of this buffer's left fringe (in pixels).
5759 A value of 0 means no left fringe is shown in this buffer's window.
5760 A value of nil means to use the left fringe width from the window's frame. */);
5761
5762 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5763 Qnil,
5764 doc: /* *Width of this buffer's right fringe (in pixels).
5765 A value of 0 means no right fringe is shown in this buffer's window.
5766 A value of nil means to use the right fringe width from the window's frame. */);
5767
5768 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5769 Qnil,
5770 doc: /* *Non-nil means to display fringes outside display margins.
5771 A value of nil means to display fringes between margins and buffer text. */);
5772
5773 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5774 Qnil,
5775 doc: /* *Width of this buffer's scroll bars in pixels.
5776 A value of nil means to use the scroll bar width from the window's frame. */);
5777
5778 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5779 Qnil,
5780 doc: /* *Position of this buffer's vertical scroll bar.
5781 The value takes effect whenever you tell a window to display this buffer;
5782 for instance, with `set-window-buffer' or when `display-buffer' displays it.
5783
5784 A value of `left' or `right' means put the vertical scroll bar at that side
5785 of the window; a value of nil means don't show any vertical scroll bars.
5786 A value of t (the default) means do whatever the window's frame specifies. */);
5787
5788 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5789 &current_buffer->indicate_empty_lines, Qnil,
5790 doc: /* *Visually indicate empty lines after the buffer end.
5791 If non-nil, a bitmap is displayed in the left fringe of a window on
5792 window-systems. */);
5793
5794 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5795 &current_buffer->indicate_buffer_boundaries, Qnil,
5796 doc: /* *Visually indicate buffer boundaries and scrolling.
5797 If non-nil, the first and last line of the buffer are marked in the fringe
5798 of a window on window-systems with angle bitmaps, or if the window can be
5799 scrolled, the top and bottom line of the window are marked with up and down
5800 arrow bitmaps.
5801
5802 If value is a symbol `left' or `right', both angle and arrow bitmaps
5803 are displayed in the left or right fringe, resp. Any other value
5804 that doesn't look like an alist means display the angle bitmaps in
5805 the left fringe but no arrows.
5806
5807 You can exercise more precise control by using an alist as the
5808 value. Each alist element (INDICATOR . POSITION) specifies
5809 where to show one of the indicators. INDICATOR is one of `top',
5810 `bottom', `up', `down', or t, which specifies the default position,
5811 and POSITION is one of `left', `right', or nil, meaning do not show
5812 this indicator.
5813
5814 For example, ((top . left) (t . right)) places the top angle bitmap in
5815 left fringe, the bottom angle bitmap in right fringe, and both arrow
5816 bitmaps in right fringe. To show just the angle bitmaps in the left
5817 fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5818
5819 DEFVAR_PER_BUFFER ("fringe-indicator-alist",
5820 &current_buffer->fringe_indicator_alist, Qnil,
5821 doc: /* *Mapping from logical to physical fringe indicator bitmaps.
5822 The value is an alist where each element (INDICATOR . BITMAPS)
5823 specifies the fringe bitmaps used to display a specific logical
5824 fringe indicator.
5825
5826 INDICATOR specifies the logical indicator type which is one of the
5827 following symbols: `truncation' , `continuation', `overlay-arrow',
5828 `top', `bottom', `up', `down', `one-line', `empty-line', or `unknown'.
5829
5830 BITMAPS is list of symbols (LEFT RIGHT [LEFT1 RIGHT1]) which specifies
5831 the actual bitmap shown in the left or right fringe for the logical
5832 indicator. LEFT and RIGHT are the bitmaps shown in the left and/or
5833 right fringe for the specific indicator. The LEFT1 or RIGHT1 bitmaps
5834 are used only for the `bottom' and `one-line' indicators when the last
5835 \(only) line in has no final newline. BITMAPS may also be a single
5836 symbol which is used in both left and right fringes. */);
5837
5838 DEFVAR_PER_BUFFER ("fringe-cursor-alist",
5839 &current_buffer->fringe_cursor_alist, Qnil,
5840 doc: /* *Mapping from logical to physical fringe cursor bitmaps.
5841 The value is an alist where each element (CURSOR . BITMAP)
5842 specifies the fringe bitmaps used to display a specific logical
5843 cursor type in the fringe.
5844
5845 CURSOR specifies the logical cursor type which is one of the following
5846 symbols: `box' , `hollow', `bar', `hbar', or `hollow-small'. The last
5847 one is used to show a hollow cursor on narrow lines display lines
5848 where the normal hollow cursor will not fit.
5849
5850 BITMAP is the corresponding fringe bitmap shown for the logical
5851 cursor type. */);
5852
5853 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5854 &current_buffer->scroll_up_aggressively, Qnil,
5855 doc: /* How far to scroll windows upward.
5856 If you move point off the bottom, the window scrolls automatically.
5857 This variable controls how far it scrolls. The value nil, the default,
5858 means scroll to center point. A fraction means scroll to put point
5859 that fraction of the window's height from the bottom of the window.
5860 When the value is 0.0, point goes at the bottom line, which in the simple
5861 case that you moved off with C-f means scrolling just one line. 1.0 means
5862 point goes at the top, so that in that simple case, the window
5863 scrolls by a full window height. Meaningful values are
5864 between 0.0 and 1.0, inclusive. */);
5865
5866 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5867 &current_buffer->scroll_down_aggressively, Qnil,
5868 doc: /* How far to scroll windows downward.
5869 If you move point off the top, the window scrolls automatically.
5870 This variable controls how far it scrolls. The value nil, the default,
5871 means scroll to center point. A fraction means scroll to put point
5872 that fraction of the window's height from the top of the window.
5873 When the value is 0.0, point goes at the top line, which in the simple
5874 case that you moved off with C-b means scrolling just one line. 1.0 means
5875 point goes at the bottom, so that in that simple case, the window
5876 scrolls by a full window height. Meaningful values are
5877 between 0.0 and 1.0, inclusive. */);
5878
5879 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5880 "Don't ask.");
5881 */
5882
5883 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5884 doc: /* List of functions to call before each text change.
5885 Two arguments are passed to each function: the positions of
5886 the beginning and end of the range of old text to be changed.
5887 \(For an insertion, the beginning and end are at the same place.)
5888 No information is given about the length of the text after the change.
5889
5890 Buffer changes made while executing the `before-change-functions'
5891 don't call any before-change or after-change functions.
5892 That's because these variables are temporarily set to nil.
5893 As a result, a hook function cannot straightforwardly alter the value of
5894 these variables. See the Emacs Lisp manual for a way of
5895 accomplishing an equivalent result by using other variables.
5896
5897 If an unhandled error happens in running these functions,
5898 the variable's value remains nil. That prevents the error
5899 from happening repeatedly and making Emacs nonfunctional. */);
5900 Vbefore_change_functions = Qnil;
5901
5902 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5903 doc: /* List of functions to call after each text change.
5904 Three arguments are passed to each function: the positions of
5905 the beginning and end of the range of changed text,
5906 and the length in bytes of the pre-change text replaced by that range.
5907 \(For an insertion, the pre-change length is zero;
5908 for a deletion, that length is the number of bytes deleted,
5909 and the post-change beginning and end are at the same place.)
5910
5911 Buffer changes made while executing the `after-change-functions'
5912 don't call any before-change or after-change functions.
5913 That's because these variables are temporarily set to nil.
5914 As a result, a hook function cannot straightforwardly alter the value of
5915 these variables. See the Emacs Lisp manual for a way of
5916 accomplishing an equivalent result by using other variables.
5917
5918 If an unhandled error happens in running these functions,
5919 the variable's value remains nil. That prevents the error
5920 from happening repeatedly and making Emacs nonfunctional. */);
5921 Vafter_change_functions = Qnil;
5922
5923 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5924 doc: /* A list of functions to call before changing a buffer which is unmodified.
5925 The functions are run using the `run-hooks' function. */);
5926 Vfirst_change_hook = Qnil;
5927
5928 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5929 doc: /* List of undo entries in current buffer.
5930 Recent changes come first; older changes follow newer.
5931
5932 An entry (BEG . END) represents an insertion which begins at
5933 position BEG and ends at position END.
5934
5935 An entry (TEXT . POSITION) represents the deletion of the string TEXT
5936 from (abs POSITION). If POSITION is positive, point was at the front
5937 of the text being deleted; if negative, point was at the end.
5938
5939 An entry (t HIGH . LOW) indicates that the buffer previously had
5940 \"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5941 of the visited file's modification time, as of that time. If the
5942 modification time of the most recent save is different, this entry is
5943 obsolete.
5944
5945 An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5946 was modified between BEG and END. PROPERTY is the property name,
5947 and VALUE is the old value.
5948
5949 An entry (apply FUN-NAME . ARGS) means undo the change with
5950 \(apply FUN-NAME ARGS).
5951
5952 An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5953 in the active region. BEG and END is the range affected by this entry
5954 and DELTA is the number of bytes added or deleted in that range by
5955 this change.
5956
5957 An entry (MARKER . DISTANCE) indicates that the marker MARKER
5958 was adjusted in position by the offset DISTANCE (an integer).
5959
5960 An entry of the form POSITION indicates that point was at the buffer
5961 location given by the integer. Undoing an entry of this form places
5962 point at POSITION.
5963
5964 Entries with value `nil' mark undo boundaries. The undo command treats
5965 the changes between two undo boundaries as a single step to be undone.
5966
5967 If the value of the variable is t, undo information is not recorded. */);
5968
5969 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5970 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5971
5972 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5973 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5974
5975 Normally, the line-motion functions work by scanning the buffer for
5976 newlines. Columnar operations (like `move-to-column' and
5977 `compute-motion') also work by scanning the buffer, summing character
5978 widths as they go. This works well for ordinary text, but if the
5979 buffer's lines are very long (say, more than 500 characters), these
5980 motion functions will take longer to execute. Emacs may also take
5981 longer to update the display.
5982
5983 If `cache-long-line-scans' is non-nil, these motion functions cache the
5984 results of their scans, and consult the cache to avoid rescanning
5985 regions of the buffer until the text is modified. The caches are most
5986 beneficial when they prevent the most searching---that is, when the
5987 buffer contains long lines and large regions of characters with the
5988 same, fixed screen width.
5989
5990 When `cache-long-line-scans' is non-nil, processing short lines will
5991 become slightly slower (because of the overhead of consulting the
5992 cache), and the caches will use memory roughly proportional to the
5993 number of newlines and characters whose screen width varies.
5994
5995 The caches require no explicit maintenance; their accuracy is
5996 maintained internally by the Emacs primitives. Enabling or disabling
5997 the cache should not affect the behavior of any of the motion
5998 functions; it should only affect their performance. */);
5999
6000 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
6001 doc: /* Value of point before the last series of scroll operations, or nil. */);
6002
6003 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
6004 doc: /* List of formats to use when saving this buffer.
6005 Formats are defined by `format-alist'. This variable is
6006 set when a file is visited. */);
6007
6008 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
6009 &current_buffer->auto_save_file_format, Qnil,
6010 doc: /* *Format in which to write auto-save files.
6011 Should be a list of symbols naming formats that are defined in `format-alist'.
6012 If it is t, which is the default, auto-save files are written in the
6013 same format as a regular save would use. */);
6014
6015 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
6016 &current_buffer->invisibility_spec, Qnil,
6017 doc: /* Invisibility spec of this buffer.
6018 The default is t, which means that text is invisible
6019 if it has a non-nil `invisible' property.
6020 If the value is a list, a text character is invisible if its `invisible'
6021 property is an element in that list (or is a list with members in common).
6022 If an element is a cons cell of the form (PROP . ELLIPSIS),
6023 then characters with property value PROP are invisible,
6024 and they have an ellipsis as well if ELLIPSIS is non-nil. */);
6025
6026 DEFVAR_PER_BUFFER ("buffer-display-count",
6027 &current_buffer->display_count, Qnil,
6028 doc: /* A number incremented each time this buffer is displayed in a window.
6029 The function `set-window-buffer' increments it. */);
6030
6031 DEFVAR_PER_BUFFER ("buffer-display-time",
6032 &current_buffer->display_time, Qnil,
6033 doc: /* Time stamp updated each time this buffer is displayed in a window.
6034 The function `set-window-buffer' updates this variable
6035 to the value obtained by calling `current-time'.
6036 If the buffer has never been shown in a window, the value is nil. */);
6037
6038 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
6039 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
6040 Non-nil also enables highlighting of the region whenever the mark is active.
6041 The variable `highlight-nonselected-windows' controls whether to highlight
6042 all windows or just the selected window.
6043
6044 If the value is `lambda', that enables Transient Mark mode temporarily
6045 until the next buffer modification. If a command sets the value to `only',
6046 that enables Transient Mark mode for the following command only.
6047 During that following command, the value of `transient-mark-mode'
6048 is `identity'. If it is still `identity' at the end of that command,
6049 it changes to nil. */);
6050 Vtransient_mark_mode = Qnil;
6051
6052 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
6053 doc: /* *Non-nil means disregard read-only status of buffers or characters.
6054 If the value is t, disregard `buffer-read-only' and all `read-only'
6055 text properties. If the value is a list, disregard `buffer-read-only'
6056 and disregard a `read-only' text property if the property value
6057 is a member of the list. */);
6058 Vinhibit_read_only = Qnil;
6059
6060 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
6061 doc: /* Cursor to use when this buffer is in the selected window.
6062 Values are interpreted as follows:
6063
6064 t use the cursor specified for the frame
6065 nil don't display a cursor
6066 box display a filled box cursor
6067 hollow display a hollow box cursor
6068 bar display a vertical bar cursor with default width
6069 (bar . WIDTH) display a vertical bar cursor with width WIDTH
6070 hbar display a horizontal bar cursor with default height
6071 (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT
6072 ANYTHING ELSE display a hollow box cursor
6073
6074 When the buffer is displayed in a nonselected window,
6075 this variable has no effect; the cursor appears as a hollow box. */);
6076
6077 DEFVAR_PER_BUFFER ("line-spacing",
6078 &current_buffer->extra_line_spacing, Qnil,
6079 doc: /* Additional space to put between lines when displaying a buffer.
6080 The space is measured in pixels, and put below lines on window systems.
6081 If value is a floating point number, it specifies the spacing relative
6082 to the default frame line height. A value of nil means add no extra space. */);
6083
6084 DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
6085 &current_buffer->cursor_in_non_selected_windows, Qnil,
6086 doc: /* *Cursor type to display in non-selected windows.
6087 The value t means to use hollow box cursor. See `cursor-type' for other values. */);
6088
6089 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
6090 doc: /* List of functions called with no args to query before killing a buffer.
6091 The buffer being killed will be current while the functions are running.
6092 If any of them returns nil, the buffer is not killed. */);
6093 Vkill_buffer_query_functions = Qnil;
6094
6095 DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,
6096 doc: /* Normal hook run before changing the major mode of a buffer.
6097 The function `kill-all-local-variables' runs this before doing anything else. */);
6098 Vchange_major_mode_hook = Qnil;
6099 Qchange_major_mode_hook = intern ("change-major-mode-hook");
6100 staticpro (&Qchange_major_mode_hook);
6101
6102 defsubr (&Sbuffer_live_p);
6103 defsubr (&Sbuffer_list);
6104 defsubr (&Sget_buffer);
6105 defsubr (&Sget_file_buffer);
6106 defsubr (&Sget_buffer_create);
6107 defsubr (&Smake_indirect_buffer);
6108 defsubr (&Sgenerate_new_buffer_name);
6109 defsubr (&Sbuffer_name);
6110 /*defsubr (&Sbuffer_number);*/
6111 defsubr (&Sbuffer_file_name);
6112 defsubr (&Sbuffer_base_buffer);
6113 defsubr (&Sbuffer_local_value);
6114 defsubr (&Sbuffer_local_variables);
6115 defsubr (&Sbuffer_modified_p);
6116 defsubr (&Sset_buffer_modified_p);
6117 defsubr (&Sbuffer_modified_tick);
6118 defsubr (&Sbuffer_chars_modified_tick);
6119 defsubr (&Srename_buffer);
6120 defsubr (&Sother_buffer);
6121 defsubr (&Sbuffer_enable_undo);
6122 defsubr (&Skill_buffer);
6123 defsubr (&Sset_buffer_major_mode);
6124 defsubr (&Sswitch_to_buffer);
6125 defsubr (&Spop_to_buffer);
6126 defsubr (&Scurrent_buffer);
6127 defsubr (&Sset_buffer);
6128 defsubr (&Sbarf_if_buffer_read_only);
6129 defsubr (&Sbury_buffer);
6130 defsubr (&Serase_buffer);
6131 defsubr (&Sset_buffer_multibyte);
6132 defsubr (&Skill_all_local_variables);
6133
6134 defsubr (&Soverlayp);
6135 defsubr (&Smake_overlay);
6136 defsubr (&Sdelete_overlay);
6137 defsubr (&Smove_overlay);
6138 defsubr (&Soverlay_start);
6139 defsubr (&Soverlay_end);
6140 defsubr (&Soverlay_buffer);
6141 defsubr (&Soverlay_properties);
6142 defsubr (&Soverlays_at);
6143 defsubr (&Soverlays_in);
6144 defsubr (&Snext_overlay_change);
6145 defsubr (&Sprevious_overlay_change);
6146 defsubr (&Soverlay_recenter);
6147 defsubr (&Soverlay_lists);
6148 defsubr (&Soverlay_get);
6149 defsubr (&Soverlay_put);
6150 defsubr (&Srestore_buffer_modified_p);
6151 }
6152
6153 void
6154 keys_of_buffer ()
6155 {
6156 initial_define_key (control_x_map, 'b', "switch-to-buffer");
6157 initial_define_key (control_x_map, 'k', "kill-buffer");
6158
6159 /* This must not be in syms_of_buffer, because Qdisabled is not
6160 initialized when that function gets called. */
6161 Fput (intern ("erase-buffer"), Qdisabled, Qt);
6162 }
6163
6164 /* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
6165 (do not change this comment) */