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