(overlays_at): New arg PREV_PTR.
[bpt/emacs.git] / src / buffer.c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994
3 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20
21
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25
26 #ifndef MAXPATHLEN
27 /* in 4.1, param.h fails to define this. */
28 #define MAXPATHLEN 1024
29 #endif /* not MAXPATHLEN */
30
31 #include <config.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "indent.h"
38 #include "blockinput.h"
39
40 struct buffer *current_buffer; /* the current buffer */
41
42 /* First buffer in chain of all buffers (in reverse order of creation).
43 Threaded through ->next. */
44
45 struct buffer *all_buffers;
46
47 /* This structure holds the default values of the buffer-local variables
48 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
49 The default value occupies the same slot in this structure
50 as an individual buffer's value occupies in that buffer.
51 Setting the default value also goes through the alist of buffers
52 and stores into each buffer that does not say it has a local value. */
53
54 struct buffer buffer_defaults;
55
56 /* A Lisp_Object pointer to the above, used for staticpro */
57
58 static Lisp_Object Vbuffer_defaults;
59
60 /* This structure marks which slots in a buffer have corresponding
61 default values in buffer_defaults.
62 Each such slot has a nonzero value in this structure.
63 The value has only one nonzero bit.
64
65 When a buffer has its own local value for a slot,
66 the bit for that slot (found in the same slot in this structure)
67 is turned on in the buffer's local_var_flags slot.
68
69 If a slot in this structure is -1, then even though there may
70 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
71 and the corresponding slot in buffer_defaults is not used.
72
73 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
74 but there is a default value which is copied into each buffer.
75
76 If a slot in this structure is negative, then even though there may
77 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
78 and the corresponding slot in buffer_defaults is not used.
79
80 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
81 zero, that is a bug */
82
83 struct buffer buffer_local_flags;
84
85 /* This structure holds the names of symbols whose values may be
86 buffer-local. It is indexed and accessed in the same way as the above. */
87
88 struct buffer buffer_local_symbols;
89 /* A Lisp_Object pointer to the above, used for staticpro */
90 static Lisp_Object Vbuffer_local_symbols;
91
92 /* This structure holds the required types for the values in the
93 buffer-local slots. If a slot contains Qnil, then the
94 corresponding buffer slot may contain a value of any type. If a
95 slot contains an integer, then prospective values' tags must be
96 equal to that integer. When a tag does not match, the function
97 buffer_slot_type_mismatch will signal an error. */
98 struct buffer buffer_local_types;
99
100 Lisp_Object Fset_buffer ();
101 void set_buffer_internal ();
102 static void call_overlay_mod_hooks ();
103
104 /* Alist of all buffer names vs the buffers. */
105 /* This used to be a variable, but is no longer,
106 to prevent lossage due to user rplac'ing this alist or its elements. */
107 Lisp_Object Vbuffer_alist;
108
109 /* Functions to call before and after each text change. */
110 Lisp_Object Vbefore_change_function;
111 Lisp_Object Vafter_change_function;
112 Lisp_Object Vbefore_change_functions;
113 Lisp_Object Vafter_change_functions;
114
115 Lisp_Object Vtransient_mark_mode;
116
117 /* t means ignore all read-only text properties.
118 A list means ignore such a property if its value is a member of the list.
119 Any non-nil value means ignore buffer-read-only. */
120 Lisp_Object Vinhibit_read_only;
121
122 /* List of functions to call that can query about killing a buffer.
123 If any of these functions returns nil, we don't kill it. */
124 Lisp_Object Vkill_buffer_query_functions;
125
126 /* List of functions to call before changing an unmodified buffer. */
127 Lisp_Object Vfirst_change_hook;
128 Lisp_Object Qfirst_change_hook;
129
130 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
131
132 Lisp_Object Qprotected_field;
133
134 Lisp_Object QSFundamental; /* A string "Fundamental" */
135
136 Lisp_Object Qkill_buffer_hook;
137
138 Lisp_Object Qget_file_buffer;
139
140 Lisp_Object Qoverlayp;
141
142 Lisp_Object Qpriority, Qwindow, Qevaporate;
143
144 Lisp_Object Qmodification_hooks;
145 Lisp_Object Qinsert_in_front_hooks;
146 Lisp_Object Qinsert_behind_hooks;
147
148 /* For debugging; temporary. See set_buffer_internal. */
149 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
150
151 nsberror (spec)
152 Lisp_Object spec;
153 {
154 if (XTYPE (spec) == Lisp_String)
155 error ("No buffer named %s", XSTRING (spec)->data);
156 error ("Invalid buffer argument");
157 }
158 \f
159 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 0, 0,
160 "Return a list of all existing live buffers.")
161 ()
162 {
163 return Fmapcar (Qcdr, Vbuffer_alist);
164 }
165
166 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
167 "Return the buffer named NAME (a string).\n\
168 If there is no live buffer named NAME, return nil.\n\
169 NAME may also be a buffer; if so, the value is that buffer.")
170 (name)
171 register Lisp_Object name;
172 {
173 if (XTYPE (name) == Lisp_Buffer)
174 return name;
175 CHECK_STRING (name, 0);
176
177 return Fcdr (Fassoc (name, Vbuffer_alist));
178 }
179
180 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
181 "Return the buffer visiting file FILENAME (a string).\n\
182 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
183 If there is no such live buffer, return nil.")
184 (filename)
185 register Lisp_Object filename;
186 {
187 register Lisp_Object tail, buf, tem;
188 Lisp_Object handler;
189
190 CHECK_STRING (filename, 0);
191 filename = Fexpand_file_name (filename, Qnil);
192
193 /* If the file name has special constructs in it,
194 call the corresponding file handler. */
195 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
196 if (!NILP (handler))
197 return call2 (handler, Qget_file_buffer, filename);
198
199 for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
200 {
201 buf = Fcdr (XCONS (tail)->car);
202 if (XTYPE (buf) != Lisp_Buffer) continue;
203 if (XTYPE (XBUFFER (buf)->filename) != Lisp_String) continue;
204 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
205 if (!NILP (tem))
206 return buf;
207 }
208 return Qnil;
209 }
210
211 /* Incremented for each buffer created, to assign the buffer number. */
212 int buffer_count;
213
214 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
215 "Return the buffer named NAME, or create such a buffer and return it.\n\
216 A new buffer is created if there is no live buffer named NAME.\n\
217 If NAME starts with a space, the new buffer does not keep undo information.\n\
218 If NAME is a buffer instead of a string, then it is the value returned.\n\
219 The value is never nil.")
220 (name)
221 register Lisp_Object name;
222 {
223 register Lisp_Object buf, function, tem;
224 int count = specpdl_ptr - specpdl;
225 register struct buffer *b;
226
227 buf = Fget_buffer (name);
228 if (!NILP (buf))
229 return buf;
230
231 if (XSTRING (name)->size == 0)
232 error ("Empty string for buffer name is not allowed");
233
234 b = (struct buffer *) xmalloc (sizeof (struct buffer));
235
236 BUF_GAP_SIZE (b) = 20;
237 BLOCK_INPUT;
238 BUFFER_ALLOC (BUF_BEG_ADDR (b), BUF_GAP_SIZE (b));
239 UNBLOCK_INPUT;
240 if (! BUF_BEG_ADDR (b))
241 memory_full ();
242
243 BUF_PT (b) = 1;
244 BUF_GPT (b) = 1;
245 BUF_BEGV (b) = 1;
246 BUF_ZV (b) = 1;
247 BUF_Z (b) = 1;
248 BUF_MODIFF (b) = 1;
249
250 /* Put this on the chain of all buffers including killed ones. */
251 b->next = all_buffers;
252 all_buffers = b;
253
254 b->mark = Fmake_marker ();
255 /*b->number = make_number (++buffer_count);*/
256 b->name = name;
257 if (XSTRING (name)->data[0] != ' ')
258 b->undo_list = Qnil;
259 else
260 b->undo_list = Qt;
261
262 reset_buffer (b);
263 reset_buffer_local_variables (b);
264
265 /* Put this in the alist of all live buffers. */
266 XSET (buf, Lisp_Buffer, b);
267 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
268
269 b->mark = Fmake_marker ();
270 b->markers = Qnil;
271 b->name = name;
272
273 function = buffer_defaults.major_mode;
274 if (NILP (function))
275 {
276 tem = Fget (current_buffer->major_mode, Qmode_class);
277 if (EQ (tem, Qnil))
278 function = current_buffer->major_mode;
279 }
280
281 if (NILP (function) || EQ (function, Qfundamental_mode))
282 return buf;
283
284 /* To select a nonfundamental mode,
285 select the buffer temporarily and then call the mode function. */
286
287 record_unwind_protect (save_excursion_restore, save_excursion_save ());
288
289 Fset_buffer (buf);
290 call0 (function);
291
292 return unbind_to (count, buf);
293 }
294
295 /* Reinitialize everything about a buffer except its name and contents
296 and local variables. */
297
298 void
299 reset_buffer (b)
300 register struct buffer *b;
301 {
302 b->filename = Qnil;
303 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
304 b->modtime = 0;
305 b->save_modified = 1;
306 XFASTINT (b->save_length) = 0;
307 b->last_window_start = 1;
308 b->backed_up = Qnil;
309 b->auto_save_modified = 0;
310 b->auto_save_failure_time = -1;
311 b->auto_save_file_name = Qnil;
312 b->read_only = Qnil;
313 b->overlays_before = Qnil;
314 b->overlays_after = Qnil;
315 XFASTINT (b->overlay_center) = 1;
316 b->mark_active = Qnil;
317
318 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
319 INITIALIZE_INTERVAL (b, NULL_INTERVAL);
320 }
321
322 /* Reset buffer B's local variables info.
323 Don't use this on a buffer that has already been in use;
324 it does not treat permanent locals consistently.
325 Instead, use Fkill_all_local_variables. */
326
327 reset_buffer_local_variables (b)
328 register struct buffer *b;
329 {
330 register int offset;
331
332 /* Reset the major mode to Fundamental, together with all the
333 things that depend on the major mode.
334 default-major-mode is handled at a higher level.
335 We ignore it here. */
336 b->major_mode = Qfundamental_mode;
337 b->keymap = Qnil;
338 b->abbrev_table = Vfundamental_mode_abbrev_table;
339 b->mode_name = QSFundamental;
340 b->minor_modes = Qnil;
341 b->downcase_table = Vascii_downcase_table;
342 b->upcase_table = Vascii_upcase_table;
343 b->case_canon_table = Vascii_canon_table;
344 b->case_eqv_table = Vascii_eqv_table;
345 #if 0
346 b->sort_table = XSTRING (Vascii_sort_table);
347 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
348 #endif /* 0 */
349
350 /* Reset all per-buffer variables to their defaults. */
351 b->local_var_alist = Qnil;
352 b->local_var_flags = 0;
353
354 /* For each slot that has a default value,
355 copy that into the slot. */
356
357 for (offset = (char *)&buffer_local_flags.name - (char *)&buffer_local_flags;
358 offset < sizeof (struct buffer);
359 offset += sizeof (Lisp_Object)) /* sizeof EMACS_INT == sizeof Lisp_Object */
360 if (*(EMACS_INT *)(offset + (char *) &buffer_local_flags) > 0
361 || *(EMACS_INT *)(offset + (char *) &buffer_local_flags) == -2)
362 *(Lisp_Object *)(offset + (char *)b) =
363 *(Lisp_Object *)(offset + (char *)&buffer_defaults);
364 }
365
366 /* We split this away from generate-new-buffer, because rename-buffer
367 and set-visited-file-name ought to be able to use this to really
368 rename the buffer properly. */
369
370 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
371 1, 2, 0,
372 "Return a string that is the name of no existing buffer based on NAME.\n\
373 If there is no live buffer named NAME, then return NAME.\n\
374 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
375 until an unused name is found, and then return that name.\n\
376 Optional second argument IGNORE specifies a name that is okay to use\n\
377 \(if it is in the sequence to be tried)\n\
378 even if a buffer with that name exists.")
379 (name, ignore)
380 register Lisp_Object name, ignore;
381 {
382 register Lisp_Object gentemp, tem;
383 int count;
384 char number[10];
385
386 CHECK_STRING (name, 0);
387
388 tem = Fget_buffer (name);
389 if (NILP (tem))
390 return name;
391
392 count = 1;
393 while (1)
394 {
395 sprintf (number, "<%d>", ++count);
396 gentemp = concat2 (name, build_string (number));
397 tem = Fstring_equal (gentemp, ignore);
398 if (!NILP (tem))
399 return gentemp;
400 tem = Fget_buffer (gentemp);
401 if (NILP (tem))
402 return gentemp;
403 }
404 }
405
406 \f
407 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
408 "Return the name of BUFFER, as a string.\n\
409 With no argument or nil as argument, return the name of the current buffer.")
410 (buffer)
411 register Lisp_Object buffer;
412 {
413 if (NILP (buffer))
414 return current_buffer->name;
415 CHECK_BUFFER (buffer, 0);
416 return XBUFFER (buffer)->name;
417 }
418
419 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
420 "Return name of file BUFFER is visiting, or nil if none.\n\
421 No argument or nil as argument means use the current buffer.")
422 (buffer)
423 register Lisp_Object buffer;
424 {
425 if (NILP (buffer))
426 return current_buffer->filename;
427 CHECK_BUFFER (buffer, 0);
428 return XBUFFER (buffer)->filename;
429 }
430
431 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
432 Sbuffer_local_variables, 0, 1, 0,
433 "Return an alist of variables that are buffer-local in BUFFER.\n\
434 Most elements look like (SYMBOL . VALUE), describing one variable.\n\
435 For a symbol that is locally unbound, just the symbol appears in the value.\n\
436 Note that storing new VALUEs in these elements doesn't change the variables.\n\
437 No argument or nil as argument means use current buffer as BUFFER.")
438 (buffer)
439 register Lisp_Object buffer;
440 {
441 register struct buffer *buf;
442 register Lisp_Object result;
443
444 if (NILP (buffer))
445 buf = current_buffer;
446 else
447 {
448 CHECK_BUFFER (buffer, 0);
449 buf = XBUFFER (buffer);
450 }
451
452 result = Qnil;
453
454 {
455 /* Reference each variable in the alist in our current buffer.
456 If inquiring about the current buffer, this gets the current values,
457 so store them into the alist so the alist is up to date.
458 If inquiring about some other buffer, this swaps out any values
459 for that buffer, making the alist up to date automatically. */
460 register Lisp_Object tail;
461 for (tail = buf->local_var_alist; CONSP (tail); tail = XCONS (tail)->cdr)
462 {
463 Lisp_Object val, elt;
464
465 elt = XCONS (tail)->car;
466
467 if (buf == current_buffer)
468 val = find_symbol_value (XCONS (elt)->car);
469 else
470 val = XCONS (elt)->cdr;
471
472 /* If symbol is unbound, put just the symbol in the list. */
473 if (EQ (val, Qunbound))
474 result = Fcons (XCONS (elt)->car, result);
475 /* Otherwise, put (symbol . value) in the list. */
476 else
477 result = Fcons (Fcons (XCONS (elt)->car, val), result);
478 }
479 }
480
481 /* Add on all the variables stored in special slots. */
482 {
483 register int offset, mask;
484
485 for (offset = (char *)&buffer_local_symbols.name - (char *)&buffer_local_symbols;
486 offset < sizeof (struct buffer);
487 offset += (sizeof (EMACS_INT))) /* sizeof EMACS_INT == sizeof Lisp_Object */
488 {
489 mask = *(EMACS_INT *)(offset + (char *) &buffer_local_flags);
490 if (mask == -1 || (buf->local_var_flags & mask))
491 if (XTYPE (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols))
492 == Lisp_Symbol)
493 result = Fcons (Fcons (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols),
494 *(Lisp_Object *)(offset + (char *)buf)),
495 result);
496 }
497 }
498
499 return result;
500 }
501
502 \f
503 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
504 0, 1, 0,
505 "Return t if BUFFER was modified since its file was last read or saved.\n\
506 No argument or nil as argument means use current buffer as BUFFER.")
507 (buffer)
508 register Lisp_Object buffer;
509 {
510 register struct buffer *buf;
511 if (NILP (buffer))
512 buf = current_buffer;
513 else
514 {
515 CHECK_BUFFER (buffer, 0);
516 buf = XBUFFER (buffer);
517 }
518
519 return buf->save_modified < BUF_MODIFF (buf) ? Qt : Qnil;
520 }
521
522 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
523 1, 1, 0,
524 "Mark current buffer as modified or unmodified according to FLAG.\n\
525 A non-nil FLAG means mark the buffer modified.")
526 (flag)
527 register Lisp_Object flag;
528 {
529 register int already;
530 register Lisp_Object fn;
531
532 #ifdef CLASH_DETECTION
533 /* If buffer becoming modified, lock the file.
534 If buffer becoming unmodified, unlock the file. */
535
536 fn = current_buffer->filename;
537 if (!NILP (fn))
538 {
539 already = current_buffer->save_modified < MODIFF;
540 if (!already && !NILP (flag))
541 lock_file (fn);
542 else if (already && NILP (flag))
543 unlock_file (fn);
544 }
545 #endif /* CLASH_DETECTION */
546
547 current_buffer->save_modified = NILP (flag) ? MODIFF : 0;
548 update_mode_lines++;
549 return flag;
550 }
551
552 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
553 0, 1, 0,
554 "Return BUFFER's tick counter, incremented for each change in text.\n\
555 Each buffer has a tick counter which is incremented each time the text in\n\
556 that buffer is changed. It wraps around occasionally.\n\
557 No argument or nil as argument means use current buffer as BUFFER.")
558 (buffer)
559 register Lisp_Object buffer;
560 {
561 register struct buffer *buf;
562 if (NILP (buffer))
563 buf = current_buffer;
564 else
565 {
566 CHECK_BUFFER (buffer, 0);
567 buf = XBUFFER (buffer);
568 }
569
570 return make_number (BUF_MODIFF (buf));
571 }
572 \f
573 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
574 "sRename buffer (to new name): \nP",
575 "Change current buffer's name to NEWNAME (a string).\n\
576 If second arg UNIQUE is nil or omitted, it is an error if a\n\
577 buffer named NEWNAME already exists.\n\
578 If UNIQUE is non-nil, come up with a new name using\n\
579 `generate-new-buffer-name'.\n\
580 Interactively, you can set UNIQUE with a prefix argument.\n\
581 We return the name we actually gave the buffer.\n\
582 This does not change the name of the visited file (if any).")
583 (name, unique)
584 register Lisp_Object name, unique;
585 {
586 register Lisp_Object tem, buf;
587
588 CHECK_STRING (name, 0);
589
590 if (XSTRING (name)->size == 0)
591 error ("Empty string is invalid as a buffer name");
592
593 tem = Fget_buffer (name);
594 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
595 the buffer automatically so you can create another with the original name.
596 It makes UNIQUE equivalent to
597 (rename-buffer (generate-new-buffer-name NAME)). */
598 if (NILP (unique) && XBUFFER (tem) == current_buffer)
599 return current_buffer->name;
600 if (!NILP (tem))
601 {
602 if (!NILP (unique))
603 name = Fgenerate_new_buffer_name (name, current_buffer->name);
604 else
605 error ("Buffer name \"%s\" is in use", XSTRING (name)->data);
606 }
607
608 current_buffer->name = name;
609
610 /* Catch redisplay's attention. Unless we do this, the mode lines for
611 any windows displaying current_buffer will stay unchanged. */
612 update_mode_lines++;
613
614 XSET (buf, Lisp_Buffer, current_buffer);
615 Fsetcar (Frassq (buf, Vbuffer_alist), name);
616 if (NILP (current_buffer->filename)
617 && !NILP (current_buffer->auto_save_file_name))
618 call0 (intern ("rename-auto-save-file"));
619 /* refetch since that last call may have done GC */
620 return current_buffer->name;
621 }
622
623 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 2, 0,
624 "Return most recently selected buffer other than BUFFER.\n\
625 Buffers not visible in windows are preferred to visible buffers,\n\
626 unless optional second argument VISIBLE-OK is non-nil.\n\
627 If no other buffer exists, the buffer `*scratch*' is returned.\n\
628 If BUFFER is omitted or nil, some interesting buffer is returned.")
629 (buffer, visible_ok)
630 register Lisp_Object buffer, visible_ok;
631 {
632 register Lisp_Object tail, buf, notsogood, tem;
633 notsogood = Qnil;
634
635 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
636 {
637 buf = Fcdr (Fcar (tail));
638 if (EQ (buf, buffer))
639 continue;
640 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
641 continue;
642 if (NILP (visible_ok))
643 tem = Fget_buffer_window (buf, Qt);
644 else
645 tem = Qnil;
646 if (NILP (tem))
647 return buf;
648 if (NILP (notsogood))
649 notsogood = buf;
650 }
651 if (!NILP (notsogood))
652 return notsogood;
653 return Fget_buffer_create (build_string ("*scratch*"));
654 }
655 \f
656 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo, 0, 1,
657 0,
658 "Make BUFFER stop keeping undo information.\n\
659 No argument or nil as argument means do this for the current buffer.")
660 (buffer)
661 register Lisp_Object buffer;
662 {
663 Lisp_Object real_buffer;
664
665 if (NILP (buffer))
666 XSET (real_buffer, Lisp_Buffer, current_buffer);
667 else
668 {
669 real_buffer = Fget_buffer (buffer);
670 if (NILP (real_buffer))
671 nsberror (buffer);
672 }
673
674 XBUFFER (real_buffer)->undo_list = Qt;
675
676 return Qnil;
677 }
678
679 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
680 0, 1, "",
681 "Start keeping undo information for buffer BUFFER.\n\
682 No argument or nil as argument means do this for the current buffer.")
683 (buffer)
684 register Lisp_Object buffer;
685 {
686 Lisp_Object real_buffer;
687
688 if (NILP (buffer))
689 XSET (real_buffer, Lisp_Buffer, current_buffer);
690 else
691 {
692 real_buffer = Fget_buffer (buffer);
693 if (NILP (real_buffer))
694 nsberror (buffer);
695 }
696
697 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
698 XBUFFER (real_buffer)->undo_list = Qnil;
699
700 return Qnil;
701 }
702
703 /*
704 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
705 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
706 The buffer being killed will be current while the hook is running.\n\
707 See `kill-buffer'."
708 */
709 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
710 "Kill the buffer BUFFER.\n\
711 The argument may be a buffer or may be the name of a buffer.\n\
712 An argument of nil means kill the current buffer.\n\n\
713 Value is t if the buffer is actually killed, nil if user says no.\n\n\
714 The value of `kill-buffer-hook' (which may be local to that buffer),\n\
715 if not void, is a list of functions to be called, with no arguments,\n\
716 before the buffer is actually killed. The buffer to be killed is current\n\
717 when the hook functions are called.\n\n\
718 Any processes that have this buffer as the `process-buffer' are killed\n\
719 with `delete-process'.")
720 (bufname)
721 Lisp_Object bufname;
722 {
723 Lisp_Object buf;
724 register struct buffer *b;
725 register Lisp_Object tem;
726 register struct Lisp_Marker *m;
727 struct gcpro gcpro1, gcpro2;
728
729 if (NILP (bufname))
730 buf = Fcurrent_buffer ();
731 else
732 buf = Fget_buffer (bufname);
733 if (NILP (buf))
734 nsberror (bufname);
735
736 b = XBUFFER (buf);
737
738 /* Query if the buffer is still modified. */
739 if (INTERACTIVE && !NILP (b->filename)
740 && BUF_MODIFF (b) > b->save_modified)
741 {
742 GCPRO2 (buf, bufname);
743 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
744 XSTRING (b->name)->data));
745 UNGCPRO;
746 if (NILP (tem))
747 return Qnil;
748 }
749
750 /* Run hooks with the buffer to be killed the current buffer. */
751 {
752 register Lisp_Object val;
753 int count = specpdl_ptr - specpdl;
754 Lisp_Object list;
755
756 record_unwind_protect (save_excursion_restore, save_excursion_save ());
757 set_buffer_internal (b);
758
759 /* First run the query functions; if any query is answered no,
760 don't kill the buffer. */
761 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
762 {
763 tem = call0 (Fcar (list));
764 if (NILP (tem))
765 return unbind_to (count, Qnil);
766 }
767
768 /* Then run the hooks. */
769 if (!NILP (Vrun_hooks))
770 call1 (Vrun_hooks, Qkill_buffer_hook);
771 unbind_to (count, Qnil);
772 }
773
774 /* We have no more questions to ask. Verify that it is valid
775 to kill the buffer. This must be done after the questions
776 since anything can happen within do_yes_or_no_p. */
777
778 /* Don't kill the minibuffer now current. */
779 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
780 return Qnil;
781
782 if (NILP (b->name))
783 return Qnil;
784
785 /* Make this buffer not be current.
786 In the process, notice if this is the sole visible buffer
787 and give up if so. */
788 if (b == current_buffer)
789 {
790 tem = Fother_buffer (buf, Qnil);
791 Fset_buffer (tem);
792 if (b == current_buffer)
793 return Qnil;
794 }
795
796 /* Now there is no question: we can kill the buffer. */
797
798 #ifdef CLASH_DETECTION
799 /* Unlock this buffer's file, if it is locked. */
800 unlock_buffer (b);
801 #endif /* CLASH_DETECTION */
802
803 kill_buffer_processes (buf);
804
805 tem = Vinhibit_quit;
806 Vinhibit_quit = Qt;
807 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
808 Freplace_buffer_in_windows (buf);
809 Vinhibit_quit = tem;
810
811 /* Delete any auto-save file, if we saved it in this session. */
812 if (XTYPE (b->auto_save_file_name) == Lisp_String
813 && b->auto_save_modified != 0)
814 {
815 Lisp_Object tem;
816 tem = Fsymbol_value (intern ("delete-auto-save-files"));
817 if (! NILP (tem))
818 unlink (XSTRING (b->auto_save_file_name)->data);
819 }
820
821 /* Unchain all markers of this buffer
822 and leave them pointing nowhere. */
823 for (tem = b->markers; !EQ (tem, Qnil); )
824 {
825 m = XMARKER (tem);
826 m->buffer = 0;
827 tem = m->chain;
828 m->chain = Qnil;
829 }
830 b->markers = Qnil;
831
832 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
833 INITIALIZE_INTERVAL (b, NULL_INTERVAL);
834 /* Perhaps we should explicitly free the interval tree here... */
835
836 b->name = Qnil;
837 BLOCK_INPUT;
838 BUFFER_FREE (BUF_BEG_ADDR (b));
839 UNBLOCK_INPUT;
840 b->undo_list = Qnil;
841
842 return Qt;
843 }
844 \f
845 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
846 we do this each time BUF is selected visibly, the more recently
847 selected buffers are always closer to the front of the list. This
848 means that other_buffer is more likely to choose a relevant buffer. */
849
850 record_buffer (buf)
851 Lisp_Object buf;
852 {
853 register Lisp_Object link, prev;
854
855 prev = Qnil;
856 for (link = Vbuffer_alist; CONSP (link); link = XCONS (link)->cdr)
857 {
858 if (EQ (XCONS (XCONS (link)->car)->cdr, buf))
859 break;
860 prev = link;
861 }
862
863 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
864 we cannot use Fdelq itself here because it allows quitting. */
865
866 if (NILP (prev))
867 Vbuffer_alist = XCONS (Vbuffer_alist)->cdr;
868 else
869 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
870
871 XCONS(link)->cdr = Vbuffer_alist;
872 Vbuffer_alist = link;
873 }
874
875 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
876 "Select buffer BUFFER in the current window.\n\
877 BUFFER may be a buffer or a buffer name.\n\
878 Optional second arg NORECORD non-nil means\n\
879 do not put this buffer at the front of the list of recently selected ones.\n\
880 \n\
881 WARNING: This is NOT the way to work on another buffer temporarily\n\
882 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
883 the window-buffer correspondences.")
884 (bufname, norecord)
885 Lisp_Object bufname, norecord;
886 {
887 register Lisp_Object buf;
888 Lisp_Object tem;
889
890 if (EQ (minibuf_window, selected_window))
891 error ("Cannot switch buffers in minibuffer window");
892 tem = Fwindow_dedicated_p (selected_window);
893 if (!NILP (tem))
894 error ("Cannot switch buffers in a dedicated window");
895
896 if (NILP (bufname))
897 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
898 else
899 buf = Fget_buffer_create (bufname);
900 Fset_buffer (buf);
901 if (NILP (norecord))
902 record_buffer (buf);
903
904 Fset_window_buffer (EQ (selected_window, minibuf_window)
905 ? Fnext_window (minibuf_window, Qnil, Qnil)
906 : selected_window,
907 buf);
908
909 return buf;
910 }
911
912 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 2, 0,
913 "Select buffer BUFFER in some window, preferably a different one.\n\
914 If BUFFER is nil, then some other buffer is chosen.\n\
915 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
916 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
917 window even if BUFFER is already visible in the selected window.")
918 (bufname, other)
919 Lisp_Object bufname, other;
920 {
921 register Lisp_Object buf;
922 if (NILP (bufname))
923 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
924 else
925 buf = Fget_buffer_create (bufname);
926 Fset_buffer (buf);
927 record_buffer (buf);
928 Fselect_window (Fdisplay_buffer (buf, other));
929 return buf;
930 }
931
932 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
933 "Return the current buffer as a Lisp object.")
934 ()
935 {
936 register Lisp_Object buf;
937 XSET (buf, Lisp_Buffer, current_buffer);
938 return buf;
939 }
940 \f
941 /* Set the current buffer to b */
942
943 void
944 set_buffer_internal (b)
945 register struct buffer *b;
946 {
947 register struct buffer *old_buf;
948 register Lisp_Object tail, valcontents;
949 enum Lisp_Type tem;
950
951 if (current_buffer == b)
952 return;
953
954 windows_or_buffers_changed = 1;
955 old_buf = current_buffer;
956 current_buffer = b;
957 last_known_column_point = -1; /* invalidate indentation cache */
958
959 /* Look down buffer's list of local Lisp variables
960 to find and update any that forward into C variables. */
961
962 for (tail = b->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
963 {
964 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
965 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
966 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
967 && (tem = XTYPE (XCONS (valcontents)->car),
968 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
969 || tem == Lisp_Objfwd)))
970 /* Just reference the variable
971 to cause it to become set for this buffer. */
972 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
973 }
974
975 /* Do the same with any others that were local to the previous buffer */
976
977 if (old_buf)
978 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
979 {
980 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
981 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
982 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
983 && (tem = XTYPE (XCONS (valcontents)->car),
984 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
985 || tem == Lisp_Objfwd)))
986 /* Just reference the variable
987 to cause it to become set for this buffer. */
988 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
989 }
990 }
991
992 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
993 "Make the buffer BUFFER current for editing operations.\n\
994 BUFFER may be a buffer or the name of an existing buffer.\n\
995 See also `save-excursion' when you want to make a buffer current temporarily.\n\
996 This function does not display the buffer, so its effect ends\n\
997 when the current command terminates.\n\
998 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
999 (bufname)
1000 register Lisp_Object bufname;
1001 {
1002 register Lisp_Object buffer;
1003 buffer = Fget_buffer (bufname);
1004 if (NILP (buffer))
1005 nsberror (bufname);
1006 if (NILP (XBUFFER (buffer)->name))
1007 error ("Selecting deleted buffer");
1008 set_buffer_internal (XBUFFER (buffer));
1009 return buffer;
1010 }
1011 \f
1012 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1013 Sbarf_if_buffer_read_only, 0, 0, 0,
1014 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1015 ()
1016 {
1017 if (!NILP (current_buffer->read_only)
1018 && NILP (Vinhibit_read_only))
1019 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1020 return Qnil;
1021 }
1022
1023 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1024 "Put BUFFER at the end of the list of all buffers.\n\
1025 There it is the least likely candidate for `other-buffer' to return;\n\
1026 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1027 If BUFFER is nil or omitted, bury the current buffer.\n\
1028 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1029 selected window if it is displayed there.")
1030 (buf)
1031 register Lisp_Object buf;
1032 {
1033 /* Figure out what buffer we're going to bury. */
1034 if (NILP (buf))
1035 {
1036 XSET (buf, Lisp_Buffer, current_buffer);
1037
1038 /* If we're burying the current buffer, unshow it. */
1039 Fswitch_to_buffer (Fother_buffer (buf, Qnil), Qnil);
1040 }
1041 else
1042 {
1043 Lisp_Object buf1;
1044
1045 buf1 = Fget_buffer (buf);
1046 if (NILP (buf1))
1047 nsberror (buf);
1048 buf = buf1;
1049 }
1050
1051 /* Move buf to the end of the buffer list. */
1052 {
1053 register Lisp_Object aelt, link;
1054
1055 aelt = Frassq (buf, Vbuffer_alist);
1056 link = Fmemq (aelt, Vbuffer_alist);
1057 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1058 XCONS (link)->cdr = Qnil;
1059 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1060 }
1061
1062 return Qnil;
1063 }
1064 \f
1065 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1066 "Delete the entire contents of the current buffer.\n\
1067 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1068 so the buffer is truly empty after this.")
1069 ()
1070 {
1071 Fwiden ();
1072 del_range (BEG, Z);
1073 current_buffer->last_window_start = 1;
1074 /* Prevent warnings, or suspension of auto saving, that would happen
1075 if future size is less than past size. Use of erase-buffer
1076 implies that the future text is not really related to the past text. */
1077 XFASTINT (current_buffer->save_length) = 0;
1078 return Qnil;
1079 }
1080
1081 validate_region (b, e)
1082 register Lisp_Object *b, *e;
1083 {
1084 register int i;
1085
1086 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1087 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1088
1089 if (XINT (*b) > XINT (*e))
1090 {
1091 i = XFASTINT (*b); /* This is legit even if *b is < 0 */
1092 *b = *e;
1093 XFASTINT (*e) = i; /* because this is all we do with i. */
1094 }
1095
1096 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1097 && XINT (*e) <= ZV))
1098 args_out_of_range (*b, *e);
1099 }
1100 \f
1101 static Lisp_Object
1102 list_buffers_1 (files)
1103 Lisp_Object files;
1104 {
1105 register Lisp_Object tail, tem, buf;
1106 Lisp_Object col1, col2, col3, minspace;
1107 register struct buffer *old = current_buffer, *b;
1108 Lisp_Object desired_point;
1109 Lisp_Object other_file_symbol;
1110
1111 desired_point = Qnil;
1112 other_file_symbol = intern ("list-buffers-directory");
1113
1114 XFASTINT (col1) = 19;
1115 XFASTINT (col2) = 26;
1116 XFASTINT (col3) = 40;
1117 XFASTINT (minspace) = 1;
1118
1119 Fset_buffer (Vstandard_output);
1120 Fbuffer_disable_undo (Vstandard_output);
1121 current_buffer->read_only = Qnil;
1122
1123 write_string ("\
1124 MR Buffer Size Mode File\n\
1125 -- ------ ---- ---- ----\n", -1);
1126
1127 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
1128 {
1129 buf = Fcdr (Fcar (tail));
1130 b = XBUFFER (buf);
1131 /* Don't mention the minibuffers. */
1132 if (XSTRING (b->name)->data[0] == ' ')
1133 continue;
1134 /* Optionally don't mention buffers that lack files. */
1135 if (!NILP (files) && NILP (b->filename))
1136 continue;
1137 /* Identify the current buffer. */
1138 if (b == old)
1139 XFASTINT (desired_point) = point;
1140 write_string (b == old ? "." : " ", -1);
1141 /* Identify modified buffers */
1142 write_string (BUF_MODIFF (b) > b->save_modified ? "*" : " ", -1);
1143 write_string (NILP (b->read_only) ? " " : "% ", -1);
1144 Fprinc (b->name, Qnil);
1145 Findent_to (col1, make_number (2));
1146 XFASTINT (tem) = BUF_Z (b) - BUF_BEG (b);
1147 Fprin1 (tem, Qnil);
1148 Findent_to (col2, minspace);
1149 Fprinc (b->mode_name, Qnil);
1150 Findent_to (col3, minspace);
1151
1152 if (!NILP (b->filename))
1153 Fprinc (b->filename, Qnil);
1154 else
1155 {
1156 /* No visited file; check local value of list-buffers-directory. */
1157 Lisp_Object tem;
1158 set_buffer_internal (b);
1159 tem = Fboundp (other_file_symbol);
1160 if (!NILP (tem))
1161 {
1162 tem = Fsymbol_value (other_file_symbol);
1163 Fset_buffer (Vstandard_output);
1164 if (XTYPE (tem) == Lisp_String)
1165 Fprinc (tem, Qnil);
1166 }
1167 else
1168 Fset_buffer (Vstandard_output);
1169 }
1170 write_string ("\n", -1);
1171 }
1172
1173 tail = intern ("Buffer-menu-mode");
1174 if ((tem = Ffboundp (tail), !NILP (tem)))
1175 call0 (tail);
1176 set_buffer_internal (old);
1177 return desired_point;
1178 }
1179
1180 DEFUN ("list-buffers", Flist_buffers, Slist_buffers, 0, 1, "P",
1181 "Display a list of names of existing buffers.\n\
1182 The list is displayed in a buffer named `*Buffer List*'.\n\
1183 Note that buffers with names starting with spaces are omitted.\n\
1184 Non-null optional arg FILES-ONLY means mention only file buffers.\n\
1185 \n\
1186 The M column contains a * for buffers that are modified.\n\
1187 The R column contains a % for buffers that are read-only.")
1188 (files)
1189 Lisp_Object files;
1190 {
1191 Lisp_Object desired_point;
1192
1193 desired_point
1194 = internal_with_output_to_temp_buffer ("*Buffer List*",
1195 list_buffers_1, files);
1196
1197 if (NUMBERP (desired_point))
1198 {
1199 int count = specpdl_ptr - specpdl;
1200 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1201 Fset_buffer (build_string ("*Buffer List*"));
1202 SET_PT (XINT (desired_point));
1203 return unbind_to (count, Qnil);
1204 }
1205 return Qnil;
1206 }
1207
1208 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
1209 0, 0, 0,
1210 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1211 Most local variable bindings are eliminated so that the default values\n\
1212 become effective once more. Also, the syntax table is set from\n\
1213 `standard-syntax-table', the local keymap is set to nil,\n\
1214 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1215 This function also forces redisplay of the mode line.\n\
1216 \n\
1217 Every function to select a new major mode starts by\n\
1218 calling this function.\n\n\
1219 As a special exception, local variables whose names have\n\
1220 a non-nil `permanent-local' property are not eliminated by this function.\n\
1221 \n\
1222 The first thing this function does is run\n\
1223 the normal hook `change-major-mode-hook'.")
1224 ()
1225 {
1226 register Lisp_Object alist, sym, tem;
1227 Lisp_Object oalist;
1228
1229 if (!NILP (Vrun_hooks))
1230 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
1231 oalist = current_buffer->local_var_alist;
1232
1233 /* Make sure no local variables remain set up with this buffer
1234 for their current values. */
1235
1236 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1237 {
1238 sym = XCONS (XCONS (alist)->car)->car;
1239
1240 /* Need not do anything if some other buffer's binding is now encached. */
1241 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car;
1242 if (XBUFFER (tem) == current_buffer)
1243 {
1244 /* Symbol is set up for this buffer's old local value.
1245 Set it up for the current buffer with the default value. */
1246
1247 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->cdr;
1248 /* Store the symbol's current value into the alist entry
1249 it is currently set up for. This is so that, if the
1250 local is marked permanent, and we make it local again below,
1251 we don't lose the value. */
1252 XCONS (XCONS (tem)->car)->cdr
1253 = do_symval_forwarding (XCONS (XSYMBOL (sym)->value)->car);
1254 /* Switch to the symbol's default-value alist entry. */
1255 XCONS (tem)->car = tem;
1256 /* Mark it as current for the current buffer. */
1257 XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car = Fcurrent_buffer ();
1258 /* Store the current value into any forwarding in the symbol. */
1259 store_symval_forwarding (sym, XCONS (XSYMBOL (sym)->value)->car,
1260 XCONS (tem)->cdr);
1261 }
1262 }
1263
1264 /* Actually eliminate all local bindings of this buffer. */
1265
1266 reset_buffer_local_variables (current_buffer);
1267
1268 /* Redisplay mode lines; we are changing major mode. */
1269
1270 update_mode_lines++;
1271
1272 /* Any which are supposed to be permanent,
1273 make local again, with the same values they had. */
1274
1275 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1276 {
1277 sym = XCONS (XCONS (alist)->car)->car;
1278 tem = Fget (sym, Qpermanent_local);
1279 if (! NILP (tem))
1280 {
1281 Fmake_local_variable (sym);
1282 Fset (sym, XCONS (XCONS (alist)->car)->cdr);
1283 }
1284 }
1285
1286 /* Force mode-line redisplay. Useful here because all major mode
1287 commands call this function. */
1288 update_mode_lines++;
1289
1290 return Qnil;
1291 }
1292 \f
1293 /* Find all the overlays in the current buffer that contain position POS.
1294 Return the number found, and store them in a vector in *VEC_PTR.
1295 Store in *LEN_PTR the size allocated for the vector.
1296 Store in *NEXT_PTR the next position after POS where an overlay starts,
1297 or ZV if there are no more overlays.
1298 Store in *PREV_PTR the previous position after POS where an overlay ends,
1299 or BEGV if there are no previous overlays.
1300 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
1301
1302 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1303 when this function is called.
1304
1305 If EXTEND is non-zero, we make the vector bigger if necessary.
1306 If EXTEND is zero, we never extend the vector,
1307 and we store only as many overlays as will fit.
1308 But we still return the total number of overlays. */
1309
1310 int
1311 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
1312 int pos;
1313 int extend;
1314 Lisp_Object **vec_ptr;
1315 int *len_ptr;
1316 int *next_ptr;
1317 int *prev_ptr;
1318 {
1319 Lisp_Object tail, overlay, start, end, result;
1320 int idx = 0;
1321 int len = *len_ptr;
1322 Lisp_Object *vec = *vec_ptr;
1323 int next = ZV;
1324 int prev = BEGV;
1325 int inhibit_storing = 0;
1326
1327 for (tail = current_buffer->overlays_before;
1328 XGCTYPE (tail) == Lisp_Cons;
1329 tail = XCONS (tail)->cdr)
1330 {
1331 int startpos, endpos;
1332
1333 overlay = XCONS (tail)->car;
1334 if (XGCTYPE (overlay) != Lisp_Overlay)
1335 abort ();
1336
1337 start = OVERLAY_START (overlay);
1338 end = OVERLAY_END (overlay);
1339 endpos = OVERLAY_POSITION (end);
1340 if (endpos < pos)
1341 {
1342 if (prev < endpos)
1343 prev = endpos;
1344 break;
1345 }
1346 if (endpos == pos)
1347 continue;
1348 startpos = OVERLAY_POSITION (start);
1349 if (startpos <= pos)
1350 {
1351 if (idx == len)
1352 {
1353 /* The supplied vector is full.
1354 Either make it bigger, or don't store any more in it. */
1355 if (extend)
1356 {
1357 *len_ptr = len *= 2;
1358 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1359 *vec_ptr = vec;
1360 }
1361 else
1362 inhibit_storing = 1;
1363 }
1364
1365 if (!inhibit_storing)
1366 vec[idx] = overlay;
1367 /* Keep counting overlays even if we can't return them all. */
1368 idx++;
1369 }
1370 else if (startpos < next)
1371 next = startpos;
1372 }
1373
1374 for (tail = current_buffer->overlays_after;
1375 XGCTYPE (tail) == Lisp_Cons;
1376 tail = XCONS (tail)->cdr)
1377 {
1378 int startpos, endpos;
1379
1380 overlay = XCONS (tail)->car;
1381 if (XGCTYPE (overlay) != Lisp_Overlay)
1382 abort ();
1383
1384 start = OVERLAY_START (overlay);
1385 end = OVERLAY_END (overlay);
1386 startpos = OVERLAY_POSITION (start);
1387 if (pos < startpos)
1388 {
1389 if (startpos < next)
1390 next = startpos;
1391 break;
1392 }
1393 endpos = OVERLAY_POSITION (end);
1394 if (pos < endpos)
1395 {
1396 if (idx == len)
1397 {
1398 if (extend)
1399 {
1400 *len_ptr = len *= 2;
1401 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1402 *vec_ptr = vec;
1403 }
1404 else
1405 inhibit_storing = 1;
1406 }
1407
1408 if (!inhibit_storing)
1409 vec[idx] = overlay;
1410 idx++;
1411 }
1412 else if (endpos < pos && endpos > prev)
1413 prev = endpos;
1414 }
1415
1416 if (next_ptr)
1417 *next_ptr = next;
1418 if (prev_ptr)
1419 *prev_ptr = prev;
1420 return idx;
1421 }
1422 \f
1423 struct sortvec
1424 {
1425 Lisp_Object overlay;
1426 int beg, end;
1427 int priority;
1428 };
1429
1430 static int
1431 compare_overlays (s1, s2)
1432 struct sortvec *s1, *s2;
1433 {
1434 if (s1->priority != s2->priority)
1435 return s1->priority - s2->priority;
1436 if (s1->beg != s2->beg)
1437 return s1->beg - s2->beg;
1438 if (s1->end != s2->end)
1439 return s2->end - s1->end;
1440 return 0;
1441 }
1442
1443 /* Sort an array of overlays by priority. The array is modified in place.
1444 The return value is the new size; this may be smaller than the original
1445 size if some of the overlays were invalid or were window-specific. */
1446 int
1447 sort_overlays (overlay_vec, noverlays, w)
1448 Lisp_Object *overlay_vec;
1449 int noverlays;
1450 struct window *w;
1451 {
1452 int i, j;
1453 struct sortvec *sortvec;
1454 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
1455
1456 /* Put the valid and relevant overlays into sortvec. */
1457
1458 for (i = 0, j = 0; i < noverlays; i++)
1459 {
1460 Lisp_Object tem;
1461 Lisp_Object overlay;
1462
1463 overlay = overlay_vec[i];
1464 if (OVERLAY_VALID (overlay)
1465 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
1466 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
1467 {
1468 /* If we're interested in a specific window, then ignore
1469 overlays that are limited to some other window. */
1470 if (w)
1471 {
1472 Lisp_Object window;
1473
1474 window = Foverlay_get (overlay, Qwindow);
1475 if (XTYPE (window) == Lisp_Window && XWINDOW (window) != w)
1476 continue;
1477 }
1478
1479 /* This overlay is good and counts: put it into sortvec. */
1480 sortvec[j].overlay = overlay;
1481 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
1482 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
1483 tem = Foverlay_get (overlay, Qpriority);
1484 if (INTEGERP (tem))
1485 sortvec[j].priority = XINT (tem);
1486 else
1487 sortvec[j].priority = 0;
1488 j++;
1489 }
1490 }
1491 noverlays = j;
1492
1493 /* Sort the overlays into the proper order: increasing priority. */
1494
1495 if (noverlays > 1)
1496 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
1497
1498 for (i = 0; i < noverlays; i++)
1499 overlay_vec[i] = sortvec[i].overlay;
1500 return (noverlays);
1501 }
1502 \f
1503 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1504
1505 void
1506 recenter_overlay_lists (buf, pos)
1507 struct buffer *buf;
1508 int pos;
1509 {
1510 Lisp_Object overlay, tail, next, prev, beg, end;
1511
1512 /* See if anything in overlays_before should move to overlays_after. */
1513
1514 /* We don't strictly need prev in this loop; it should always be nil.
1515 But we use it for symmetry and in case that should cease to be true
1516 with some future change. */
1517 prev = Qnil;
1518 for (tail = buf->overlays_before;
1519 CONSP (tail);
1520 prev = tail, tail = next)
1521 {
1522 next = XCONS (tail)->cdr;
1523 overlay = XCONS (tail)->car;
1524
1525 /* If the overlay is not valid, get rid of it. */
1526 if (!OVERLAY_VALID (overlay))
1527 #if 1
1528 abort ();
1529 #else
1530 {
1531 /* Splice the cons cell TAIL out of overlays_before. */
1532 if (!NILP (prev))
1533 XCONS (prev)->cdr = next;
1534 else
1535 buf->overlays_before = next;
1536 tail = prev;
1537 continue;
1538 }
1539 #endif
1540
1541 beg = OVERLAY_START (overlay);
1542 end = OVERLAY_END (overlay);
1543
1544 if (OVERLAY_POSITION (end) > pos)
1545 {
1546 /* OVERLAY needs to be moved. */
1547 int where = OVERLAY_POSITION (beg);
1548 Lisp_Object other, other_prev;
1549
1550 /* Splice the cons cell TAIL out of overlays_before. */
1551 if (!NILP (prev))
1552 XCONS (prev)->cdr = next;
1553 else
1554 buf->overlays_before = next;
1555
1556 /* Search thru overlays_after for where to put it. */
1557 other_prev = Qnil;
1558 for (other = buf->overlays_after;
1559 CONSP (other);
1560 other_prev = other, other = XCONS (other)->cdr)
1561 {
1562 Lisp_Object otherbeg, otheroverlay, follower;
1563 int win;
1564
1565 otheroverlay = XCONS (other)->car;
1566 if (! OVERLAY_VALID (otheroverlay))
1567 abort ();
1568
1569 otherbeg = OVERLAY_START (otheroverlay);
1570 if (OVERLAY_POSITION (otherbeg) >= where)
1571 break;
1572 }
1573
1574 /* Add TAIL to overlays_after before OTHER. */
1575 XCONS (tail)->cdr = other;
1576 if (!NILP (other_prev))
1577 XCONS (other_prev)->cdr = tail;
1578 else
1579 buf->overlays_after = tail;
1580 tail = prev;
1581 }
1582 else
1583 /* We've reached the things that should stay in overlays_before.
1584 All the rest of overlays_before must end even earlier,
1585 so stop now. */
1586 break;
1587 }
1588
1589 /* See if anything in overlays_after should be in overlays_before. */
1590 prev = Qnil;
1591 for (tail = buf->overlays_after;
1592 CONSP (tail);
1593 prev = tail, tail = next)
1594 {
1595 next = XCONS (tail)->cdr;
1596 overlay = XCONS (tail)->car;
1597
1598 /* If the overlay is not valid, get rid of it. */
1599 if (!OVERLAY_VALID (overlay))
1600 #if 1
1601 abort ();
1602 #else
1603 {
1604 /* Splice the cons cell TAIL out of overlays_after. */
1605 if (!NILP (prev))
1606 XCONS (prev)->cdr = next;
1607 else
1608 buf->overlays_after = next;
1609 tail = prev;
1610 continue;
1611 }
1612 #endif
1613
1614 beg = OVERLAY_START (overlay);
1615 end = OVERLAY_END (overlay);
1616
1617 /* Stop looking, when we know that nothing further
1618 can possibly end before POS. */
1619 if (OVERLAY_POSITION (beg) > pos)
1620 break;
1621
1622 if (OVERLAY_POSITION (end) <= pos)
1623 {
1624 /* OVERLAY needs to be moved. */
1625 int where = OVERLAY_POSITION (end);
1626 Lisp_Object other, other_prev;
1627
1628 /* Splice the cons cell TAIL out of overlays_after. */
1629 if (!NILP (prev))
1630 XCONS (prev)->cdr = next;
1631 else
1632 buf->overlays_after = next;
1633
1634 /* Search thru overlays_before for where to put it. */
1635 other_prev = Qnil;
1636 for (other = buf->overlays_before;
1637 CONSP (other);
1638 other_prev = other, other = XCONS (other)->cdr)
1639 {
1640 Lisp_Object otherend, otheroverlay;
1641 int win;
1642
1643 otheroverlay = XCONS (other)->car;
1644 if (! OVERLAY_VALID (otheroverlay))
1645 abort ();
1646
1647 otherend = OVERLAY_END (otheroverlay);
1648 if (OVERLAY_POSITION (otherend) <= where)
1649 break;
1650 }
1651
1652 /* Add TAIL to overlays_before before OTHER. */
1653 XCONS (tail)->cdr = other;
1654 if (!NILP (other_prev))
1655 XCONS (other_prev)->cdr = tail;
1656 else
1657 buf->overlays_before = tail;
1658 tail = prev;
1659 }
1660 }
1661
1662 XFASTINT (buf->overlay_center) = pos;
1663 }
1664
1665 /* Fix up overlays that were garbled as a result of permuting markers
1666 in the range START through END. Any overlay with at least one
1667 endpoint in this range will need to be unlinked from the overlay
1668 list and reinserted in its proper place.
1669 Such an overlay might even have negative size at this point.
1670 If so, we'll reverse the endpoints. Can you think of anything
1671 better to do in this situation? */
1672 void
1673 fix_overlays_in_range (start, end)
1674 register int start, end;
1675 {
1676 Lisp_Object tem, overlay;
1677 Lisp_Object before_list, after_list;
1678 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
1679 int startpos, endpos;
1680
1681 /* This algorithm shifts links around instead of consing and GCing.
1682 The loop invariant is that before_list (resp. after_list) is a
1683 well-formed list except that its last element, the one that
1684 *pbefore (resp. *pafter) points to, is still uninitialized.
1685 So it's not a bug that before_list isn't initialized, although
1686 it may look strange. */
1687 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
1688 {
1689 overlay = XCONS (*ptail)->car;
1690 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1691 if (endpos < start)
1692 break;
1693 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1694 if (endpos < end
1695 || (startpos >= start && startpos < end))
1696 {
1697 /* If the overlay is backwards, fix that now. */
1698 if (startpos > endpos)
1699 {
1700 int tem;
1701 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1702 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1703 tem = startpos; startpos = endpos; endpos = tem;
1704 }
1705 /* Add it to the end of the wrong list. Later on,
1706 recenter_overlay_lists will move it to the right place. */
1707 if (endpos < XINT (current_buffer->overlay_center))
1708 {
1709 *pafter = *ptail;
1710 pafter = &XCONS (*ptail)->cdr;
1711 }
1712 else
1713 {
1714 *pbefore = *ptail;
1715 pbefore = &XCONS (*ptail)->cdr;
1716 }
1717 *ptail = XCONS (*ptail)->cdr;
1718 }
1719 else
1720 ptail = &XCONS (*ptail)->cdr;
1721 }
1722 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
1723 {
1724 overlay = XCONS (*ptail)->car;
1725 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1726 if (startpos >= end)
1727 break;
1728 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1729 if (startpos >= start
1730 || (endpos >= start && endpos < end))
1731 {
1732 if (startpos > endpos)
1733 {
1734 int tem;
1735 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1736 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1737 tem = startpos; startpos = endpos; endpos = tem;
1738 }
1739 if (endpos < XINT (current_buffer->overlay_center))
1740 {
1741 *pafter = *ptail;
1742 pafter = &XCONS (*ptail)->cdr;
1743 }
1744 else
1745 {
1746 *pbefore = *ptail;
1747 pbefore = &XCONS (*ptail)->cdr;
1748 }
1749 *ptail = XCONS (*ptail)->cdr;
1750 }
1751 else
1752 ptail = &XCONS (*ptail)->cdr;
1753 }
1754
1755 /* Splice the constructed (wrong) lists into the buffer's lists,
1756 and let the recenter function make it sane again. */
1757 *pbefore = current_buffer->overlays_before;
1758 current_buffer->overlays_before = before_list;
1759 recenter_overlay_lists (current_buffer,
1760 XINT (current_buffer->overlay_center));
1761
1762 *pafter = current_buffer->overlays_after;
1763 current_buffer->overlays_after = after_list;
1764 recenter_overlay_lists (current_buffer,
1765 XINT (current_buffer->overlay_center));
1766 }
1767 \f
1768 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
1769 "Return t if OBJECT is an overlay.")
1770 (object)
1771 Lisp_Object object;
1772 {
1773 return (OVERLAYP (object) ? Qt : Qnil);
1774 }
1775
1776 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 3, 0,
1777 "Create a new overlay with range BEG to END in BUFFER.\n\
1778 If omitted, BUFFER defaults to the current buffer.\n\
1779 BEG and END may be integers or markers.")
1780 (beg, end, buffer)
1781 Lisp_Object beg, end, buffer;
1782 {
1783 Lisp_Object overlay;
1784 struct buffer *b;
1785
1786 if (NILP (buffer))
1787 XSET (buffer, Lisp_Buffer, current_buffer);
1788 else
1789 CHECK_BUFFER (buffer, 2);
1790 if (MARKERP (beg)
1791 && ! EQ (Fmarker_buffer (beg), buffer))
1792 error ("Marker points into wrong buffer");
1793 if (MARKERP (end)
1794 && ! EQ (Fmarker_buffer (end), buffer))
1795 error ("Marker points into wrong buffer");
1796
1797 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1798 CHECK_NUMBER_COERCE_MARKER (end, 1);
1799
1800 if (XINT (beg) > XINT (end))
1801 {
1802 Lisp_Object temp;
1803 temp = beg; beg = end; end = temp;
1804 }
1805
1806 b = XBUFFER (buffer);
1807
1808 beg = Fset_marker (Fmake_marker (), beg, buffer);
1809 end = Fset_marker (Fmake_marker (), end, buffer);
1810
1811 overlay = Fcons (Fcons (beg, end), Qnil);
1812 XSETTYPE (overlay, Lisp_Overlay);
1813
1814 /* Put the new overlay on the wrong list. */
1815 end = OVERLAY_END (overlay);
1816 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1817 b->overlays_after = Fcons (overlay, b->overlays_after);
1818 else
1819 b->overlays_before = Fcons (overlay, b->overlays_before);
1820
1821 /* This puts it in the right list, and in the right order. */
1822 recenter_overlay_lists (b, XINT (b->overlay_center));
1823
1824 /* We don't need to redisplay the region covered by the overlay, because
1825 the overlay has no properties at the moment. */
1826
1827 return overlay;
1828 }
1829
1830 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
1831 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
1832 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
1833 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
1834 buffer.")
1835 (overlay, beg, end, buffer)
1836 Lisp_Object overlay, beg, end, buffer;
1837 {
1838 struct buffer *b, *ob;
1839 Lisp_Object obuffer;
1840 int count = specpdl_ptr - specpdl;
1841
1842 CHECK_OVERLAY (overlay, 0);
1843 if (NILP (buffer))
1844 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1845 if (NILP (buffer))
1846 XSET (buffer, Lisp_Buffer, current_buffer);
1847 CHECK_BUFFER (buffer, 3);
1848
1849 if (MARKERP (beg)
1850 && ! EQ (Fmarker_buffer (beg), buffer))
1851 error ("Marker points into wrong buffer");
1852 if (MARKERP (end)
1853 && ! EQ (Fmarker_buffer (end), buffer))
1854 error ("Marker points into wrong buffer");
1855
1856 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1857 CHECK_NUMBER_COERCE_MARKER (end, 1);
1858
1859 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
1860 return Fdelete_overlay (overlay);
1861
1862 if (XINT (beg) > XINT (end))
1863 {
1864 Lisp_Object temp;
1865 temp = beg; beg = end; end = temp;
1866 }
1867
1868 specbind (Qinhibit_quit, Qt);
1869
1870 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
1871 b = XBUFFER (buffer);
1872 ob = XBUFFER (obuffer);
1873
1874 /* If the overlay has changed buffers, do a thorough redisplay. */
1875 if (!EQ (buffer, obuffer))
1876 {
1877 /* Redisplay where the overlay was. */
1878 if (!NILP (obuffer))
1879 {
1880 Lisp_Object o_beg;
1881 Lisp_Object o_end;
1882
1883 o_beg = OVERLAY_START (overlay);
1884 o_end = OVERLAY_END (overlay);
1885 o_beg = OVERLAY_POSITION (o_beg);
1886 o_end = OVERLAY_POSITION (o_end);
1887
1888 redisplay_region (ob, XINT (o_beg), XINT (o_end));
1889 }
1890
1891 /* Redisplay where the overlay is going to be. */
1892 redisplay_region (b, XINT (beg), XINT (end));
1893
1894 /* Don't limit redisplay to the selected window. */
1895 windows_or_buffers_changed = 1;
1896 }
1897 else
1898 /* Redisplay the area the overlay has just left, or just enclosed. */
1899 {
1900 Lisp_Object o_beg;
1901 Lisp_Object o_end;
1902 int change_beg, change_end;
1903
1904 o_beg = OVERLAY_START (overlay);
1905 o_end = OVERLAY_END (overlay);
1906 o_beg = OVERLAY_POSITION (o_beg);
1907 o_end = OVERLAY_POSITION (o_end);
1908
1909 if (XINT (o_beg) == XINT (beg))
1910 redisplay_region (b, XINT (o_end), XINT (end));
1911 else if (XINT (o_end) == XINT (end))
1912 redisplay_region (b, XINT (o_beg), XINT (beg));
1913 else
1914 {
1915 if (XINT (beg) < XINT (o_beg)) o_beg = beg;
1916 if (XINT (end) > XINT (o_end)) o_end = end;
1917 redisplay_region (b, XINT (o_beg), XINT (o_end));
1918 }
1919 }
1920
1921 if (!NILP (obuffer))
1922 {
1923 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
1924 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
1925 }
1926
1927 Fset_marker (OVERLAY_START (overlay), beg, buffer);
1928 Fset_marker (OVERLAY_END (overlay), end, buffer);
1929
1930 /* Put the overlay on the wrong list. */
1931 end = OVERLAY_END (overlay);
1932 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1933 b->overlays_after = Fcons (overlay, b->overlays_after);
1934 else
1935 b->overlays_before = Fcons (overlay, b->overlays_before);
1936
1937 /* This puts it in the right list, and in the right order. */
1938 recenter_overlay_lists (b, XINT (b->overlay_center));
1939
1940 return unbind_to (count, overlay);
1941 }
1942
1943 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
1944 "Delete the overlay OVERLAY from its buffer.")
1945 (overlay)
1946 Lisp_Object overlay;
1947 {
1948 Lisp_Object buffer;
1949 struct buffer *b;
1950 int count = specpdl_ptr - specpdl;
1951
1952 CHECK_OVERLAY (overlay, 0);
1953
1954 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1955 if (NILP (buffer))
1956 return Qnil;
1957
1958 b = XBUFFER (buffer);
1959
1960 specbind (Qinhibit_quit, Qt);
1961
1962 b->overlays_before = Fdelq (overlay, b->overlays_before);
1963 b->overlays_after = Fdelq (overlay, b->overlays_after);
1964
1965 redisplay_region (b,
1966 marker_position (OVERLAY_START (overlay)),
1967 marker_position (OVERLAY_END (overlay)));
1968
1969 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
1970 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
1971
1972 return unbind_to (count, Qnil);
1973 }
1974 \f
1975 /* Overlay dissection functions. */
1976
1977 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
1978 "Return the position at which OVERLAY starts.")
1979 (overlay)
1980 Lisp_Object overlay;
1981 {
1982 CHECK_OVERLAY (overlay, 0);
1983
1984 return (Fmarker_position (OVERLAY_START (overlay)));
1985 }
1986
1987 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
1988 "Return the position at which OVERLAY ends.")
1989 (overlay)
1990 Lisp_Object overlay;
1991 {
1992 CHECK_OVERLAY (overlay, 0);
1993
1994 return (Fmarker_position (OVERLAY_END (overlay)));
1995 }
1996
1997 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
1998 "Return the buffer OVERLAY belongs to.")
1999 (overlay)
2000 Lisp_Object overlay;
2001 {
2002 CHECK_OVERLAY (overlay, 0);
2003
2004 return Fmarker_buffer (OVERLAY_START (overlay));
2005 }
2006
2007 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
2008 "Return a list of the properties on OVERLAY.\n\
2009 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
2010 OVERLAY.")
2011 (overlay)
2012 Lisp_Object overlay;
2013 {
2014 CHECK_OVERLAY (overlay, 0);
2015
2016 return Fcopy_sequence (Fcdr_safe (XCONS (overlay)->cdr));
2017 }
2018
2019 \f
2020 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
2021 "Return a list of the overlays that contain position POS.")
2022 (pos)
2023 Lisp_Object pos;
2024 {
2025 int noverlays;
2026 Lisp_Object *overlay_vec;
2027 int len;
2028 Lisp_Object result;
2029
2030 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2031
2032 len = 10;
2033 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2034
2035 /* Put all the overlays we want in a vector in overlay_vec.
2036 Store the length in len. */
2037 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, NULL, NULL);
2038
2039 /* Make a list of them all. */
2040 result = Flist (noverlays, overlay_vec);
2041
2042 xfree (overlay_vec);
2043 return result;
2044 }
2045
2046 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
2047 1, 1, 0,
2048 "Return the next position after POS where an overlay starts or ends.\n\
2049 If there are no more overlay boundaries after POS, return (point-max).")
2050 (pos)
2051 Lisp_Object pos;
2052 {
2053 int noverlays;
2054 int endpos;
2055 Lisp_Object *overlay_vec;
2056 int len;
2057 int i;
2058
2059 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2060
2061 len = 10;
2062 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2063
2064 /* Put all the overlays we want in a vector in overlay_vec.
2065 Store the length in len.
2066 endpos gets the position where the next overlay starts. */
2067 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, &endpos, NULL);
2068
2069 /* If any of these overlays ends before endpos,
2070 use its ending point instead. */
2071 for (i = 0; i < noverlays; i++)
2072 {
2073 Lisp_Object oend;
2074 int oendpos;
2075
2076 oend = OVERLAY_END (overlay_vec[i]);
2077 oendpos = OVERLAY_POSITION (oend);
2078 if (oendpos < endpos)
2079 endpos = oendpos;
2080 }
2081
2082 xfree (overlay_vec);
2083 return make_number (endpos);
2084 }
2085
2086 DEFUN ("previous-overlay-change", Fprevious_overlay_change,
2087 Sprevious_overlay_change, 1, 1, 0,
2088 "Return the previous position before POS where an overlay starts or ends.\n\
2089 If there are no more overlay boundaries after POS, return (point-min).")
2090 (pos)
2091 Lisp_Object pos;
2092 {
2093 int noverlays;
2094 int prevpos;
2095 Lisp_Object *overlay_vec;
2096 int len;
2097 int i;
2098
2099 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2100
2101 len = 10;
2102 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2103
2104 /* Put all the overlays we want in a vector in overlay_vec.
2105 Store the length in len.
2106 prevpos gets the position of an overlay end. */
2107 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, NULL, &prevpos);
2108
2109 /* If any of these overlays starts before endpos,
2110 maybe use its starting point instead. */
2111 for (i = 0; i < noverlays; i++)
2112 {
2113 Lisp_Object ostart;
2114 int ostartpos;
2115
2116 ostart = OVERLAY_START (overlay_vec[i]);
2117 ostartpos = OVERLAY_POSITION (ostart);
2118 if (ostartpos > prevpos && ostartpos < XINT (pos))
2119 prevpos = ostartpos;
2120 }
2121
2122 xfree (overlay_vec);
2123 return make_number (prevpos);
2124 }
2125 \f
2126 /* These functions are for debugging overlays. */
2127
2128 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
2129 "Return a pair of lists giving all the overlays of the current buffer.\n\
2130 The car has all the overlays before the overlay center;\n\
2131 the cdr has all the overlays after the overlay center.\n\
2132 Recentering overlays moves overlays between these lists.\n\
2133 The lists you get are copies, so that changing them has no effect.\n\
2134 However, the overlays you get are the real objects that the buffer uses.")
2135 ()
2136 {
2137 Lisp_Object before, after;
2138 before = current_buffer->overlays_before;
2139 if (CONSP (before))
2140 before = Fcopy_sequence (before);
2141 after = current_buffer->overlays_after;
2142 if (CONSP (after))
2143 after = Fcopy_sequence (after);
2144
2145 return Fcons (before, after);
2146 }
2147
2148 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
2149 "Recenter the overlays of the current buffer around position POS.")
2150 (pos)
2151 Lisp_Object pos;
2152 {
2153 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2154
2155 recenter_overlay_lists (current_buffer, XINT (pos));
2156 return Qnil;
2157 }
2158 \f
2159 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
2160 "Get the property of overlay OVERLAY with property name NAME.")
2161 (overlay, prop)
2162 Lisp_Object overlay, prop;
2163 {
2164 Lisp_Object plist;
2165
2166 CHECK_OVERLAY (overlay, 0);
2167
2168 for (plist = Fcdr_safe (XCONS (overlay)->cdr);
2169 CONSP (plist) && CONSP (XCONS (plist)->cdr);
2170 plist = XCONS (XCONS (plist)->cdr)->cdr)
2171 {
2172 if (EQ (XCONS (plist)->car, prop))
2173 return XCONS (XCONS (plist)->cdr)->car;
2174 }
2175
2176 return Qnil;
2177 }
2178
2179 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
2180 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
2181 (overlay, prop, value)
2182 Lisp_Object overlay, prop, value;
2183 {
2184 Lisp_Object plist, tail, buffer;
2185 int changed;
2186
2187 CHECK_OVERLAY (overlay, 0);
2188
2189 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2190
2191 plist = Fcdr_safe (XCONS (overlay)->cdr);
2192
2193 for (tail = plist;
2194 CONSP (tail) && CONSP (XCONS (tail)->cdr);
2195 tail = XCONS (XCONS (tail)->cdr)->cdr)
2196 if (EQ (XCONS (tail)->car, prop))
2197 {
2198 changed = !EQ (XCONS (XCONS (tail)->cdr)->car, value);
2199 XCONS (XCONS (tail)->cdr)->car = value;
2200 goto found;
2201 }
2202 /* It wasn't in the list, so add it to the front. */
2203 changed = !NILP (value);
2204 if (! CONSP (XCONS (overlay)->cdr))
2205 XCONS (overlay)->cdr = Fcons (Qnil, Qnil);
2206 XCONS (XCONS (overlay)->cdr)->cdr = Fcons (prop, Fcons (value, plist));
2207 found:
2208 if (! NILP (buffer))
2209 {
2210 if (changed)
2211 redisplay_region (XBUFFER (buffer),
2212 marker_position (OVERLAY_START (overlay)),
2213 marker_position (OVERLAY_END (overlay)));
2214 if (EQ (prop, Qevaporate) && ! NILP (value)
2215 && (OVERLAY_POSITION (OVERLAY_START (overlay))
2216 == OVERLAY_POSITION (OVERLAY_END (overlay))))
2217 Fdelete_overlay (overlay);
2218 }
2219 return value;
2220 }
2221 \f
2222 /* Run the modification-hooks of overlays that include
2223 any part of the text in START to END.
2224 Run the insert-before-hooks of overlay starting at END,
2225 and the insert-after-hooks of overlay ending at START. */
2226
2227 void
2228 verify_overlay_modification (start, end)
2229 Lisp_Object start, end;
2230 {
2231 Lisp_Object prop, overlay, tail;
2232 int insertion = EQ (start, end);
2233 int tail_copied;
2234 struct gcpro gcpro1, gcpro2;
2235
2236 overlay = Qnil;
2237 tail = Qnil;
2238 GCPRO2 (overlay, tail);
2239
2240 tail_copied = 0;
2241 for (tail = current_buffer->overlays_before;
2242 CONSP (tail);
2243 tail = XCONS (tail)->cdr)
2244 {
2245 int startpos, endpos;
2246 Lisp_Object ostart, oend;
2247
2248 overlay = XCONS (tail)->car;
2249
2250 ostart = OVERLAY_START (overlay);
2251 oend = OVERLAY_END (overlay);
2252 endpos = OVERLAY_POSITION (oend);
2253 if (XFASTINT (start) > endpos)
2254 break;
2255 startpos = OVERLAY_POSITION (ostart);
2256 if (XFASTINT (end) == startpos && insertion)
2257 {
2258 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2259 if (!NILP (prop))
2260 {
2261 /* Copy TAIL in case the hook recenters the overlay lists. */
2262 if (!tail_copied)
2263 tail = Fcopy_sequence (tail);
2264 tail_copied = 1;
2265 call_overlay_mod_hooks (prop, overlay, start, end);
2266 }
2267 }
2268 if (XFASTINT (start) == endpos && insertion)
2269 {
2270 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2271 if (!NILP (prop))
2272 {
2273 if (!tail_copied)
2274 tail = Fcopy_sequence (tail);
2275 tail_copied = 1;
2276 call_overlay_mod_hooks (prop, overlay, start, end);
2277 }
2278 }
2279 /* Test for intersecting intervals. This does the right thing
2280 for both insertion and deletion. */
2281 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2282 {
2283 prop = Foverlay_get (overlay, Qmodification_hooks);
2284 if (!NILP (prop))
2285 {
2286 if (!tail_copied)
2287 tail = Fcopy_sequence (tail);
2288 tail_copied = 1;
2289 call_overlay_mod_hooks (prop, overlay, start, end);
2290 }
2291 }
2292 }
2293
2294 tail_copied = 0;
2295 for (tail = current_buffer->overlays_after;
2296 CONSP (tail);
2297 tail = XCONS (tail)->cdr)
2298 {
2299 int startpos, endpos;
2300 Lisp_Object ostart, oend;
2301
2302 overlay = XCONS (tail)->car;
2303
2304 ostart = OVERLAY_START (overlay);
2305 oend = OVERLAY_END (overlay);
2306 startpos = OVERLAY_POSITION (ostart);
2307 endpos = OVERLAY_POSITION (oend);
2308 if (XFASTINT (end) < startpos)
2309 break;
2310 if (XFASTINT (end) == startpos && insertion)
2311 {
2312 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2313 if (!NILP (prop))
2314 {
2315 if (!tail_copied)
2316 tail = Fcopy_sequence (tail);
2317 tail_copied = 1;
2318 call_overlay_mod_hooks (prop, overlay, start, end);
2319 }
2320 }
2321 if (XFASTINT (start) == endpos && insertion)
2322 {
2323 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2324 if (!NILP (prop))
2325 {
2326 if (!tail_copied)
2327 tail = Fcopy_sequence (tail);
2328 tail_copied = 1;
2329 call_overlay_mod_hooks (prop, overlay, start, end);
2330 }
2331 }
2332 /* Test for intersecting intervals. This does the right thing
2333 for both insertion and deletion. */
2334 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2335 {
2336 prop = Foverlay_get (overlay, Qmodification_hooks);
2337 if (!NILP (prop))
2338 {
2339 if (!tail_copied)
2340 tail = Fcopy_sequence (tail);
2341 tail_copied = 1;
2342 call_overlay_mod_hooks (prop, overlay, start, end);
2343 }
2344 }
2345 }
2346
2347 UNGCPRO;
2348 }
2349
2350 static void
2351 call_overlay_mod_hooks (list, overlay, start, end)
2352 Lisp_Object list, overlay, start, end;
2353 {
2354 struct gcpro gcpro1;
2355 GCPRO1 (list);
2356 while (!NILP (list))
2357 {
2358 call3 (Fcar (list), overlay, start, end);
2359 list = Fcdr (list);
2360 }
2361 UNGCPRO;
2362 }
2363
2364 /* Delete any zero-sized overlays at position POS, if the `evaporate'
2365 property is set. */
2366 void
2367 evaporate_overlays (pos)
2368 int pos;
2369 {
2370 Lisp_Object tail, overlay, hit_list;
2371
2372 hit_list = Qnil;
2373 if (pos <= XFASTINT (current_buffer->overlay_center))
2374 for (tail = current_buffer->overlays_before; CONSP (tail);
2375 tail = XCONS (tail)->cdr)
2376 {
2377 int endpos;
2378 overlay = XCONS (tail)->car;
2379 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2380 if (endpos < pos)
2381 break;
2382 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
2383 && Foverlay_get (overlay, Qevaporate))
2384 hit_list = Fcons (overlay, hit_list);
2385 }
2386 else
2387 for (tail = current_buffer->overlays_after; CONSP (tail);
2388 tail = XCONS (tail)->cdr)
2389 {
2390 int startpos;
2391 overlay = XCONS (tail)->cdr;
2392 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2393 if (startpos > pos)
2394 break;
2395 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
2396 && Foverlay_get (overlay, Qevaporate))
2397 hit_list = Fcons (overlay, hit_list);
2398 }
2399 for (; CONSP (hit_list); hit_list = XCONS (hit_list)->cdr)
2400 Fdelete_overlay (XCONS (hit_list)->car);
2401 }
2402 \f
2403 /* Somebody has tried to store NEWVAL into the buffer-local slot with
2404 offset XUINT (valcontents), and NEWVAL has an unacceptable type. */
2405 void
2406 buffer_slot_type_mismatch (valcontents, newval)
2407 Lisp_Object valcontents, newval;
2408 {
2409 unsigned int offset = XUINT (valcontents);
2410 unsigned char *symbol_name =
2411 (XSYMBOL (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols))
2412 ->name->data);
2413 char *type_name;
2414
2415 switch (XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_types)))
2416 {
2417 case Lisp_Int: type_name = "integers"; break;
2418 case Lisp_String: type_name = "strings"; break;
2419 case Lisp_Marker: type_name = "markers"; break;
2420 case Lisp_Symbol: type_name = "symbols"; break;
2421 case Lisp_Cons: type_name = "lists"; break;
2422 case Lisp_Vector: type_name = "vectors"; break;
2423 default:
2424 abort ();
2425 }
2426
2427 error ("only %s should be stored in the buffer-local variable %s",
2428 type_name, symbol_name);
2429 }
2430 \f
2431 init_buffer_once ()
2432 {
2433 register Lisp_Object tem;
2434
2435 /* Make sure all markable slots in buffer_defaults
2436 are initialized reasonably, so mark_buffer won't choke. */
2437 reset_buffer (&buffer_defaults);
2438 reset_buffer_local_variables (&buffer_defaults);
2439 reset_buffer (&buffer_local_symbols);
2440 reset_buffer_local_variables (&buffer_local_symbols);
2441 XSET (Vbuffer_defaults, Lisp_Buffer, &buffer_defaults);
2442 XSET (Vbuffer_local_symbols, Lisp_Buffer, &buffer_local_symbols);
2443
2444 /* Set up the default values of various buffer slots. */
2445 /* Must do these before making the first buffer! */
2446
2447 /* real setup is done in loaddefs.el */
2448 buffer_defaults.mode_line_format = build_string ("%-");
2449 buffer_defaults.abbrev_mode = Qnil;
2450 buffer_defaults.overwrite_mode = Qnil;
2451 buffer_defaults.case_fold_search = Qt;
2452 buffer_defaults.auto_fill_function = Qnil;
2453 buffer_defaults.selective_display = Qnil;
2454 #ifndef old
2455 buffer_defaults.selective_display_ellipses = Qt;
2456 #endif
2457 buffer_defaults.abbrev_table = Qnil;
2458 buffer_defaults.display_table = Qnil;
2459 buffer_defaults.undo_list = Qnil;
2460 buffer_defaults.mark_active = Qnil;
2461 buffer_defaults.overlays_before = Qnil;
2462 buffer_defaults.overlays_after = Qnil;
2463 XFASTINT (buffer_defaults.overlay_center) = 1;
2464
2465 XFASTINT (buffer_defaults.tab_width) = 8;
2466 buffer_defaults.truncate_lines = Qnil;
2467 buffer_defaults.ctl_arrow = Qt;
2468
2469 #ifdef MSDOS
2470 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
2471 #endif
2472 XFASTINT (buffer_defaults.fill_column) = 70;
2473 XFASTINT (buffer_defaults.left_margin) = 0;
2474
2475 /* Assign the local-flags to the slots that have default values.
2476 The local flag is a bit that is used in the buffer
2477 to say that it has its own local value for the slot.
2478 The local flag bits are in the local_var_flags slot of the buffer. */
2479
2480 /* Nothing can work if this isn't true */
2481 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
2482
2483 /* 0 means not a lisp var, -1 means always local, else mask */
2484 bzero (&buffer_local_flags, sizeof buffer_local_flags);
2485 XFASTINT (buffer_local_flags.filename) = -1;
2486 XFASTINT (buffer_local_flags.directory) = -1;
2487 XFASTINT (buffer_local_flags.backed_up) = -1;
2488 XFASTINT (buffer_local_flags.save_length) = -1;
2489 XFASTINT (buffer_local_flags.auto_save_file_name) = -1;
2490 XFASTINT (buffer_local_flags.read_only) = -1;
2491 XFASTINT (buffer_local_flags.major_mode) = -1;
2492 XFASTINT (buffer_local_flags.mode_name) = -1;
2493 XFASTINT (buffer_local_flags.undo_list) = -1;
2494 XFASTINT (buffer_local_flags.mark_active) = -1;
2495
2496 XFASTINT (buffer_local_flags.mode_line_format) = 1;
2497 XFASTINT (buffer_local_flags.abbrev_mode) = 2;
2498 XFASTINT (buffer_local_flags.overwrite_mode) = 4;
2499 XFASTINT (buffer_local_flags.case_fold_search) = 8;
2500 XFASTINT (buffer_local_flags.auto_fill_function) = 0x10;
2501 XFASTINT (buffer_local_flags.selective_display) = 0x20;
2502 #ifndef old
2503 XFASTINT (buffer_local_flags.selective_display_ellipses) = 0x40;
2504 #endif
2505 XFASTINT (buffer_local_flags.tab_width) = 0x80;
2506 XFASTINT (buffer_local_flags.truncate_lines) = 0x100;
2507 XFASTINT (buffer_local_flags.ctl_arrow) = 0x200;
2508 XFASTINT (buffer_local_flags.fill_column) = 0x400;
2509 XFASTINT (buffer_local_flags.left_margin) = 0x800;
2510 XFASTINT (buffer_local_flags.abbrev_table) = 0x1000;
2511 XFASTINT (buffer_local_flags.display_table) = 0x2000;
2512 XFASTINT (buffer_local_flags.syntax_table) = 0x8000;
2513 #ifdef MSDOS
2514 XFASTINT (buffer_local_flags.buffer_file_type) = 0x4000;
2515 #endif
2516
2517 Vbuffer_alist = Qnil;
2518 current_buffer = 0;
2519 all_buffers = 0;
2520
2521 QSFundamental = build_string ("Fundamental");
2522
2523 Qfundamental_mode = intern ("fundamental-mode");
2524 buffer_defaults.major_mode = Qfundamental_mode;
2525
2526 Qmode_class = intern ("mode-class");
2527
2528 Qprotected_field = intern ("protected-field");
2529
2530 Qpermanent_local = intern ("permanent-local");
2531
2532 Qkill_buffer_hook = intern ("kill-buffer-hook");
2533
2534 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
2535 /* super-magic invisible buffer */
2536 Vbuffer_alist = Qnil;
2537
2538 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2539 }
2540
2541 init_buffer ()
2542 {
2543 char buf[MAXPATHLEN+1];
2544 char *pwd;
2545 struct stat dotstat, pwdstat;
2546 Lisp_Object temp;
2547
2548 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2549
2550 /* If PWD is accurate, use it instead of calling getwd. This is faster
2551 when PWD is right, and may avoid a fatal error. */
2552 if ((pwd = getenv ("PWD")) != 0 && *pwd == '/'
2553 && stat (pwd, &pwdstat) == 0
2554 && stat (".", &dotstat) == 0
2555 && dotstat.st_ino == pwdstat.st_ino
2556 && dotstat.st_dev == pwdstat.st_dev
2557 && strlen (pwd) < MAXPATHLEN)
2558 strcpy (buf, pwd);
2559 else if (getwd (buf) == 0)
2560 fatal ("`getwd' failed: %s.\n", buf);
2561
2562 #ifndef VMS
2563 /* Maybe this should really use some standard subroutine
2564 whose definition is filename syntax dependent. */
2565 if (buf[strlen (buf) - 1] != '/')
2566 strcat (buf, "/");
2567 #endif /* not VMS */
2568 current_buffer->directory = build_string (buf);
2569
2570 temp = get_minibuffer (0);
2571 XBUFFER (temp)->directory = current_buffer->directory;
2572 }
2573
2574 /* initialize the buffer routines */
2575 syms_of_buffer ()
2576 {
2577 extern Lisp_Object Qdisabled;
2578
2579 staticpro (&Vbuffer_defaults);
2580 staticpro (&Vbuffer_local_symbols);
2581 staticpro (&Qfundamental_mode);
2582 staticpro (&Qmode_class);
2583 staticpro (&QSFundamental);
2584 staticpro (&Vbuffer_alist);
2585 staticpro (&Qprotected_field);
2586 staticpro (&Qpermanent_local);
2587 staticpro (&Qkill_buffer_hook);
2588 staticpro (&Qoverlayp);
2589 Qevaporate = intern ("evaporate");
2590 staticpro (&Qevaporate);
2591 staticpro (&Qmodification_hooks);
2592 Qmodification_hooks = intern ("modification-hooks");
2593 staticpro (&Qinsert_in_front_hooks);
2594 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
2595 staticpro (&Qinsert_behind_hooks);
2596 Qinsert_behind_hooks = intern ("insert-behind-hooks");
2597 staticpro (&Qget_file_buffer);
2598 Qget_file_buffer = intern ("get-file-buffer");
2599 Qpriority = intern ("priority");
2600 staticpro (&Qpriority);
2601 Qwindow = intern ("window");
2602 staticpro (&Qwindow);
2603
2604 Qoverlayp = intern ("overlayp");
2605
2606 Fput (Qprotected_field, Qerror_conditions,
2607 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
2608 Fput (Qprotected_field, Qerror_message,
2609 build_string ("Attempt to modify a protected field"));
2610
2611 /* All these use DEFVAR_LISP_NOPRO because the slots in
2612 buffer_defaults will all be marked via Vbuffer_defaults. */
2613
2614 DEFVAR_LISP_NOPRO ("default-mode-line-format",
2615 &buffer_defaults.mode_line_format,
2616 "Default value of `mode-line-format' for buffers that don't override it.\n\
2617 This is the same as (default-value 'mode-line-format).");
2618
2619 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
2620 &buffer_defaults.abbrev_mode,
2621 "Default value of `abbrev-mode' for buffers that do not override it.\n\
2622 This is the same as (default-value 'abbrev-mode).");
2623
2624 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
2625 &buffer_defaults.ctl_arrow,
2626 "Default value of `ctl-arrow' for buffers that do not override it.\n\
2627 This is the same as (default-value 'ctl-arrow).");
2628
2629 DEFVAR_LISP_NOPRO ("default-truncate-lines",
2630 &buffer_defaults.truncate_lines,
2631 "Default value of `truncate-lines' for buffers that do not override it.\n\
2632 This is the same as (default-value 'truncate-lines).");
2633
2634 DEFVAR_LISP_NOPRO ("default-fill-column",
2635 &buffer_defaults.fill_column,
2636 "Default value of `fill-column' for buffers that do not override it.\n\
2637 This is the same as (default-value 'fill-column).");
2638
2639 DEFVAR_LISP_NOPRO ("default-left-margin",
2640 &buffer_defaults.left_margin,
2641 "Default value of `left-margin' for buffers that do not override it.\n\
2642 This is the same as (default-value 'left-margin).");
2643
2644 DEFVAR_LISP_NOPRO ("default-tab-width",
2645 &buffer_defaults.tab_width,
2646 "Default value of `tab-width' for buffers that do not override it.\n\
2647 This is the same as (default-value 'tab-width).");
2648
2649 DEFVAR_LISP_NOPRO ("default-case-fold-search",
2650 &buffer_defaults.case_fold_search,
2651 "Default value of `case-fold-search' for buffers that don't override it.\n\
2652 This is the same as (default-value 'case-fold-search).");
2653
2654 #ifdef MSDOS
2655 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
2656 &buffer_defaults.buffer_file_type,
2657 "Default file type for buffers that do not override it.\n\
2658 This is the same as (default-value 'buffer-file-type).\n\
2659 The file type is nil for text, t for binary.");
2660 #endif
2661
2662 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2663 Qnil, 0);
2664
2665 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
2666 But make-docfile finds it!
2667 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2668 Qnil,
2669 "Template for displaying mode line for current buffer.\n\
2670 Each buffer has its own value of this variable.\n\
2671 Value may be a string, a symbol or a list or cons cell.\n\
2672 For a symbol, its value is used (but it is ignored if t or nil).\n\
2673 A string appearing directly as the value of a symbol is processed verbatim\n\
2674 in that the %-constructs below are not recognized.\n\
2675 For a list whose car is a symbol, the symbol's value is taken,\n\
2676 and if that is non-nil, the cadr of the list is processed recursively.\n\
2677 Otherwise, the caddr of the list (if there is one) is processed.\n\
2678 For a list whose car is a string or list, each element is processed\n\
2679 recursively and the results are effectively concatenated.\n\
2680 For a list whose car is an integer, the cdr of the list is processed\n\
2681 and padded (if the number is positive) or truncated (if negative)\n\
2682 to the width specified by that number.\n\
2683 A string is printed verbatim in the mode line except for %-constructs:\n\
2684 (%-constructs are allowed when the string is the entire mode-line-format\n\
2685 or when it is found in a cons-cell or a list)\n\
2686 %b -- print buffer name. %f -- print visited file name.\n\
2687 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
2688 % means buffer is read-only and * means it is modified.\n\
2689 For a modified read-only buffer, %* gives % and %+ gives *.\n\
2690 %s -- print process status. %l -- print the current line number.\n\
2691 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
2692 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
2693 or print Bottom or All.\n\
2694 %n -- print Narrow if appropriate.\n\
2695 %t -- print T if files is text, B if binary.\n\
2696 %[ -- print one [ for each recursive editing level. %] similar.\n\
2697 %% -- print %. %- -- print infinitely many dashes.\n\
2698 Decimal digits after the % specify field width to which to pad.");
2699 */
2700
2701 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
2702 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
2703 nil here means use current buffer's major mode.");
2704
2705 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
2706 make_number (Lisp_Symbol),
2707 "Symbol for current buffer's major mode.");
2708
2709 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
2710 make_number (Lisp_String),
2711 "Pretty name of current buffer's major mode (a string).");
2712
2713 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
2714 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
2715 Automatically becomes buffer-local when set in any fashion.");
2716
2717 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
2718 Qnil,
2719 "*Non-nil if searches should ignore case.\n\
2720 Automatically becomes buffer-local when set in any fashion.");
2721
2722 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
2723 make_number (Lisp_Int),
2724 "*Column beyond which automatic line-wrapping should happen.\n\
2725 Automatically becomes buffer-local when set in any fashion.");
2726
2727 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
2728 make_number (Lisp_Int),
2729 "*Column for the default indent-line-function to indent to.\n\
2730 Linefeed indents to this column in Fundamental mode.\n\
2731 Automatically becomes buffer-local when set in any fashion.");
2732
2733 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
2734 make_number (Lisp_Int),
2735 "*Distance between tab stops (for display of tab characters), in columns.\n\
2736 Automatically becomes buffer-local when set in any fashion.");
2737
2738 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
2739 "*Non-nil means display control chars with uparrow.\n\
2740 Nil means use backslash and octal digits.\n\
2741 Automatically becomes buffer-local when set in any fashion.\n\
2742 This variable does not apply to characters whose display is specified\n\
2743 in the current display table (if there is one).");
2744
2745 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
2746 "*Non-nil means do not display continuation lines;\n\
2747 give each line of text one screen line.\n\
2748 Automatically becomes buffer-local when set in any fashion.\n\
2749 \n\
2750 Note that this is overridden by the variable\n\
2751 `truncate-partial-width-windows' if that variable is non-nil\n\
2752 and this buffer is not full-frame width.");
2753
2754 #ifdef MSDOS
2755 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
2756 Qnil,
2757 "*If visited file is text, nil; otherwise, t.");
2758 #endif
2759
2760 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
2761 make_number (Lisp_String),
2762 "Name of default directory of current buffer. Should end with slash.\n\
2763 Each buffer has its own value of this variable.");
2764
2765 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
2766 Qnil,
2767 "Function called (if non-nil) to perform auto-fill.\n\
2768 It is called after self-inserting a space at a column beyond `fill-column'.\n\
2769 Each buffer has its own value of this variable.\n\
2770 NOTE: This variable is not an ordinary hook;\n\
2771 It may not be a list of functions.");
2772
2773 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
2774 make_number (Lisp_String),
2775 "Name of file visited in current buffer, or nil if not visiting a file.\n\
2776 Each buffer has its own value of this variable.");
2777
2778 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
2779 &current_buffer->auto_save_file_name,
2780 make_number (Lisp_String),
2781 "Name of file for auto-saving current buffer,\n\
2782 or nil if buffer should not be auto-saved.\n\
2783 Each buffer has its own value of this variable.");
2784
2785 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
2786 "Non-nil if this buffer is read-only.\n\
2787 Each buffer has its own value of this variable.");
2788
2789 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
2790 "Non-nil if this buffer's file has been backed up.\n\
2791 Backing up is done before the first time the file is saved.\n\
2792 Each buffer has its own value of this variable.");
2793
2794 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
2795 make_number (Lisp_Int),
2796 "Length of current buffer when last read in, saved or auto-saved.\n\
2797 0 initially.\n\
2798 Each buffer has its own value of this variable.");
2799
2800 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
2801 Qnil,
2802 "Non-nil enables selective display:\n\
2803 Integer N as value means display only lines\n\
2804 that start with less than n columns of space.\n\
2805 A value of t means, after a ^M, all the rest of the line is invisible.\n\
2806 Then ^M's in the file are written into files as newlines.\n\n\
2807 Automatically becomes buffer-local when set in any fashion.");
2808
2809 #ifndef old
2810 DEFVAR_PER_BUFFER ("selective-display-ellipses",
2811 &current_buffer->selective_display_ellipses,
2812 Qnil,
2813 "t means display ... on previous line when a line is invisible.\n\
2814 Automatically becomes buffer-local when set in any fashion.");
2815 #endif
2816
2817 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
2818 "Non-nil if self-insertion should replace existing text.\n\
2819 If non-nil and not `overwrite-mode-binary', self-insertion still\n\
2820 inserts at the end of a line, and inserts when point is before a tab,\n\
2821 until the tab is filled in.\n\
2822 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
2823 Automatically becomes buffer-local when set in any fashion.");
2824
2825 #if 0 /* The doc string is too long for some compilers,
2826 but make-docfile can find it in this comment. */
2827 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2828 Qnil,
2829 "Display table that controls display of the contents of current buffer.\n\
2830 Automatically becomes buffer-local when set in any fashion.\n\
2831 The display table is a vector created with `make-display-table'.\n\
2832 The first 256 elements control how to display each possible text character.\n\
2833 Each value should be a vector of characters or nil;\n\
2834 nil means display the character in the default fashion.\n\
2835 The remaining six elements control the display of\n\
2836 the end of a truncated screen line (element 256, a single character);\n\
2837 the end of a continued line (element 257, a single character);\n\
2838 the escape character used to display character codes in octal\n\
2839 (element 258, a single character);\n\
2840 the character used as an arrow for control characters (element 259,\n\
2841 a single character);\n\
2842 the decoration indicating the presence of invisible lines (element 260,\n\
2843 a vector of characters);\n\
2844 the character used to draw the border between side-by-side windows\n\
2845 (element 261, a single character).\n\
2846 If this variable is nil, the value of `standard-display-table' is used.\n\
2847 Each window can have its own, overriding display table.");
2848 #endif
2849 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2850 Qnil, 0);
2851
2852 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
2853 "Don't ask.");
2854 */
2855 DEFVAR_LISP ("before-change-function", &Vbefore_change_function,
2856 "Function to call before each text change.\n\
2857 Two arguments are passed to the function: the positions of\n\
2858 the beginning and end of the range of old text to be changed.\n\
2859 \(For an insertion, the beginning and end are at the same place.)\n\
2860 No information is given about the length of the text after the change.\n\
2861 \n\
2862 Buffer changes made while executing the `before-change-function'\n\
2863 don't call any before-change or after-change functions.\n\
2864 That's because these variables are temporarily set to nil.\n\
2865 As a result, a hook function cannot straightforwardly alter the value of\n\
2866 these variables. See the Emacs Lisp manual for a way of\n\
2867 accomplishing an equivalent result by using other variables.");
2868 Vbefore_change_function = Qnil;
2869
2870 DEFVAR_LISP ("after-change-function", &Vafter_change_function,
2871 "Function to call after each text change.\n\
2872 Three arguments are passed to the function: the positions of\n\
2873 the beginning and end of the range of changed text,\n\
2874 and the length of the pre-change text replaced by that range.\n\
2875 \(For an insertion, the pre-change length is zero;\n\
2876 for a deletion, that length is the number of characters deleted,\n\
2877 and the post-change beginning and end are at the same place.)\n\
2878 \n\
2879 Buffer changes made while executing the `after-change-function'\n\
2880 don't call any before-change or after-change functions.\n\
2881 That's because these variables are temporarily set to nil.\n\
2882 As a result, a hook function cannot straightforwardly alter the value of\n\
2883 these variables. See the Emacs Lisp manual for a way of\n\
2884 accomplishing an equivalent result by using other variables.");
2885 Vafter_change_function = Qnil;
2886
2887 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
2888 "List of functions to call before each text change.\n\
2889 Two arguments are passed to each function: the positions of\n\
2890 the beginning and end of the range of old text to be changed.\n\
2891 \(For an insertion, the beginning and end are at the same place.)\n\
2892 No information is given about the length of the text after the change.\n\
2893 \n\
2894 Buffer changes made while executing the `before-change-functions'\n\
2895 don't call any before-change or after-change functions.\n\
2896 That's because these variables are temporarily set to nil.\n\
2897 As a result, a hook function cannot straightforwardly alter the value of\n\
2898 these variables. See the Emacs Lisp manual for a way of\n\
2899 accomplishing an equivalent result by using other variables.");
2900 Vbefore_change_functions = Qnil;
2901
2902 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
2903 "List of function to call after each text change.\n\
2904 Three arguments are passed to each function: the positions of\n\
2905 the beginning and end of the range of changed text,\n\
2906 and the length of the pre-change text replaced by that range.\n\
2907 \(For an insertion, the pre-change length is zero;\n\
2908 for a deletion, that length is the number of characters deleted,\n\
2909 and the post-change beginning and end are at the same place.)\n\
2910 \n\
2911 Buffer changes made while executing the `after-change-functions'\n\
2912 don't call any before-change or after-change functions.\n\
2913 That's because these variables are temporarily set to nil.\n\
2914 As a result, a hook function cannot straightforwardly alter the value of\n\
2915 these variables. See the Emacs Lisp manual for a way of\n\
2916 accomplishing an equivalent result by using other variables.");
2917
2918 Vafter_change_functions = Qnil;
2919
2920 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
2921 "A list of functions to call before changing a buffer which is unmodified.\n\
2922 The functions are run using the `run-hooks' function.");
2923 Vfirst_change_hook = Qnil;
2924 Qfirst_change_hook = intern ("first-change-hook");
2925 staticpro (&Qfirst_change_hook);
2926
2927 #if 0 /* The doc string is too long for some compilers,
2928 but make-docfile can find it in this comment. */
2929 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2930 "List of undo entries in current buffer.\n\
2931 Recent changes come first; older changes follow newer.\n\
2932 \n\
2933 An entry (START . END) represents an insertion which begins at\n\
2934 position START and ends at position END.\n\
2935 \n\
2936 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
2937 from (abs POSITION). If POSITION is positive, point was at the front\n\
2938 of the text being deleted; if negative, point was at the end.\n\
2939 \n\
2940 An entry (t HIGHWORD LOWWORD) indicates that the buffer had been\n\
2941 previously unmodified. HIGHWORD and LOWWORD are the high and low\n\
2942 16-bit words of the buffer's modification count at the time. If the\n\
2943 modification count of the most recent save is different, this entry is\n\
2944 obsolete.\n\
2945 \n\
2946 An entry (nil PROP VAL BEG . END) indicates that a text property\n\
2947 was modified between BEG and END. PROP is the property name,\n\
2948 and VAL is the old value.\n\
2949 \n\
2950 An entry of the form POSITION indicates that point was at the buffer\n\
2951 location given by the integer. Undoing an entry of this form places\n\
2952 point at POSITION.\n\
2953 \n\
2954 nil marks undo boundaries. The undo command treats the changes\n\
2955 between two undo boundaries as a single step to be undone.\n\
2956 \n\
2957 If the value of the variable is t, undo information is not recorded.");
2958 #endif
2959 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2960 0);
2961
2962 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
2963 "Non-nil means the mark and region are currently active in this buffer.\n\
2964 Automatically local in all buffers.");
2965
2966 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
2967 "*Non-nil means deactivate the mark when the buffer contents change.");
2968 Vtransient_mark_mode = Qnil;
2969
2970 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
2971 "*Non-nil means disregard read-only status of buffers or characters.\n\
2972 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
2973 text properties. If the value is a list, disregard `buffer-read-only'\n\
2974 and disregard a `read-only' text property if the property value\n\
2975 is a member of the list.");
2976 Vinhibit_read_only = Qnil;
2977
2978 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
2979 "List of functions called with no args to query before killing a buffer.");
2980 Vkill_buffer_query_functions = Qnil;
2981
2982 defsubr (&Sbuffer_list);
2983 defsubr (&Sget_buffer);
2984 defsubr (&Sget_file_buffer);
2985 defsubr (&Sget_buffer_create);
2986 defsubr (&Sgenerate_new_buffer_name);
2987 defsubr (&Sbuffer_name);
2988 /*defsubr (&Sbuffer_number);*/
2989 defsubr (&Sbuffer_file_name);
2990 defsubr (&Sbuffer_local_variables);
2991 defsubr (&Sbuffer_modified_p);
2992 defsubr (&Sset_buffer_modified_p);
2993 defsubr (&Sbuffer_modified_tick);
2994 defsubr (&Srename_buffer);
2995 defsubr (&Sother_buffer);
2996 defsubr (&Sbuffer_disable_undo);
2997 defsubr (&Sbuffer_enable_undo);
2998 defsubr (&Skill_buffer);
2999 defsubr (&Serase_buffer);
3000 defsubr (&Sswitch_to_buffer);
3001 defsubr (&Spop_to_buffer);
3002 defsubr (&Scurrent_buffer);
3003 defsubr (&Sset_buffer);
3004 defsubr (&Sbarf_if_buffer_read_only);
3005 defsubr (&Sbury_buffer);
3006 defsubr (&Slist_buffers);
3007 defsubr (&Skill_all_local_variables);
3008
3009 defsubr (&Soverlayp);
3010 defsubr (&Smake_overlay);
3011 defsubr (&Sdelete_overlay);
3012 defsubr (&Smove_overlay);
3013 defsubr (&Soverlay_start);
3014 defsubr (&Soverlay_end);
3015 defsubr (&Soverlay_buffer);
3016 defsubr (&Soverlay_properties);
3017 defsubr (&Soverlays_at);
3018 defsubr (&Snext_overlay_change);
3019 defsubr (&Sprevious_overlay_change);
3020 defsubr (&Soverlay_recenter);
3021 defsubr (&Soverlay_lists);
3022 defsubr (&Soverlay_get);
3023 defsubr (&Soverlay_put);
3024 }
3025
3026 keys_of_buffer ()
3027 {
3028 initial_define_key (control_x_map, 'b', "switch-to-buffer");
3029 initial_define_key (control_x_map, 'k', "kill-buffer");
3030 initial_define_key (control_x_map, Ctl ('B'), "list-buffers");
3031
3032 /* This must not be in syms_of_buffer, because Qdisabled is not
3033 initialized when that function gets called. */
3034 Fput (intern ("erase-buffer"), Qdisabled, Qt);
3035 }