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