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