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