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