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