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