view doc/lispref/locals.texi @ 107984:bef5d1738c0b

Make variable forwarding explicit rather the using special values. Basically, this makes the structure of buffer-local values and object forwarding explicit in the type of Lisp_Symbols rather than use special Lisp_Objects for that. This tends to lead to slightly more verbose code, but is more C-like, simpler, and makes it easier to make sure we handled all cases, among other things by letting the compiler help us check it. * lisp.h (enum Lisp_Misc_Type, union Lisp_Misc): Removing forwarding objects. (enum Lisp_Fwd_Type, enum symbol_redirect, union Lisp_Fwd): New types. (struct Lisp_Symbol): Make the various forms of variable-forwarding explicit rather than hiding them inside Lisp_Object "values". (XFWDTYPE): New macro. (XINTFWD, XBOOLFWD, XOBJFWD, XKBOARD_OBJFWD): Redefine. (XBUFFER_LOCAL_VALUE): Remove. (SYMBOL_VAL, SYMBOL_ALIAS, SYMBOL_BLV, SYMBOL_FWD, SET_SYMBOL_VAL) (SET_SYMBOL_ALIAS, SET_SYMBOL_BLV, SET_SYMBOL_FWD): New macros. (SYMBOL_VALUE, SET_SYMBOL_VALUE): Remove. (struct Lisp_Intfwd, struct Lisp_Boolfwd, struct Lisp_Objfwd) (struct Lisp_Buffer_Objfwd, struct Lisp_Kboard_Objfwd): Remove the Lisp_Misc_* header. (struct Lisp_Buffer_Local_Value): Redefine. (BLV_FOUND, SET_BLV_FOUND, BLV_VALUE, SET_BLV_VALUE): New macros. (struct Lisp_Misc_Any): Add filler to get the right size. (struct Lisp_Free): Use struct Lisp_Misc_Any rather than struct Lisp_Intfwd. (DEFVAR_LISP, DEFVAR_LISP_NOPRO, DEFVAR_BOOL, DEFVAR_INT) (DEFVAR_KBOARD): Allocate a forwarding object. * data.c (do_blv_forwarding, store_blv_forwarding): New macros. (let_shadows_global_binding_p): New function. (union Lisp_Val_Fwd): New type. (make_blv): New function. (swap_in_symval_forwarding, indirect_variable, do_symval_forwarding) (store_symval_forwarding, swap_in_global_binding, Fboundp) (swap_in_symval_forwarding, find_symbol_value, Fset) (let_shadows_buffer_binding_p, set_internal, default_value) (Fset_default, Fmake_variable_buffer_local, Fmake_local_variable) (Fkill_local_variable, Fmake_variable_frame_local) (Flocal_variable_p, Flocal_variable_if_set_p) (Fvariable_binding_locus): * xdisp.c (select_frame_for_redisplay): * lread.c (Fintern, Funintern, init_obarray, defvar_int) (defvar_bool, defvar_lisp_nopro, defvar_lisp, defvar_kboard): * frame.c (store_frame_param): * eval.c (Fdefvaralias, Fuser_variable_p, specbind, unbind_to): * bytecode.c (Fbyte_code) <varref, varset>: Adapt to the new symbol value structure. * buffer.c (PER_BUFFER_SYMBOL): Move from buffer.h. (clone_per_buffer_values): Only adjust markers into the current buffer. (reset_buffer_local_variables): PER_BUFFER_IDX is never -2. (Fbuffer_local_value, set_buffer_internal_1) (swap_out_buffer_local_variables): Adapt to the new symbol value structure. (DEFVAR_PER_BUFFER): Allocate a Lisp_Buffer_Objfwd object. (defvar_per_buffer): Take a new arg for the fwd object. (buffer_lisp_local_variables): Return a proper alist (different fix for bug#4138). * alloc.c (Fmake_symbol): Use SET_SYMBOL_VAL. (Fgarbage_collect): Don't handle buffer_defaults specially. (mark_object): Handle new symbol value structure rather than the old special Lisp_Misc_* objects. (gc_sweep) <symbols>: Free also the buffer-local-value objects. * term.c (set_tty_color_mode): * bidi.c (bidi_initialize): Don't access the ->value field directly. * buffer.h (PER_BUFFER_VAR_OFFSET): Don't bother with a buffer_local_flags. * print.c (print_object): Get rid of impossible forwarding objects.

@c -*-texinfo-*-
@c This is part of the GNU Emacs Lisp Reference Manual.
@c Copyright (C) 1990, 1991, 1992, 1993, 1999, 2001, 2002, 2003, 2004,
@c   2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
@c See the file elisp.texi for copying conditions.
@setfilename ../../info/locals
@node Standard Buffer-Local Variables, Standard Keymaps, Standard Errors, Top
@appendix Buffer-Local Variables
@c The title "Standard Buffer-Local Variables" is too long for
@c smallbook. --rjc 30mar92
@cindex buffer-local variables, general-purpose
@cindex standard buffer-local variables

  The table below lists the general-purpose Emacs variables that
automatically become buffer-local in each buffer.  Most become
buffer-local only when set; a few of them are always local in every
buffer.  Many Lisp packages define such variables for their internal
use, but we don't try to list them all here.

  Every buffer-specific minor mode defines a buffer-local variable
named @samp{@var{modename}-mode}.  @xref{Minor Mode Conventions}.
Minor mode variables will not be listed here.

@table @code
@item auto-fill-function
@xref{Auto Filling}.

@item buffer-auto-save-file-format
@xref{Format Conversion}.

@item buffer-auto-save-file-name
@xref{Auto-Saving}.

@item buffer-backed-up
@xref{Making Backups}.

@item buffer-display-count
@xref{Buffers and Windows}.

@item buffer-display-table
@xref{Active Display Table}.

@item buffer-display-time
@xref{Buffers and Windows}.

@item buffer-file-coding-system
@xref{Encoding and I/O}.

@item buffer-file-format
@xref{Format Conversion}.

@item buffer-file-name
@xref{Buffer File Name}.

@item buffer-file-number
@xref{Buffer File Name}.

@item buffer-file-truename
@xref{Buffer File Name}.

@item buffer-file-type
@xref{MS-DOS File Types}.

@item buffer-invisibility-spec
@xref{Invisible Text}.

@item buffer-offer-save
@xref{Killing Buffers}.

@item buffer-save-without-query
@xref{Killing Buffers}.

@item buffer-read-only
@xref{Read Only Buffers}.

@item buffer-saved-size
@xref{Auto-Saving}.

@item buffer-undo-list
@xref{Undo}.

@item cache-long-line-scans
@xref{Truncation}.

@item case-fold-search
@xref{Searching and Case}.

@item ctl-arrow
@xref{Usual Display}.

@item cursor-in-non-selected-windows
@xref{Basic Windows}.

@item cursor-type
@xref{Cursor Parameters}.

@item comment-column
@xref{Comments,,, emacs, The GNU Emacs Manual}.

@item default-directory
@xref{File Name Expansion}.

@item defun-prompt-regexp
@xref{List Motion}.

@item desktop-save-buffer
@xref{Desktop Save Mode}.

@ignore
@item direction-reversed
Does not work yet.
@end ignore

@item enable-multibyte-characters
@ref{Text Representations}.

@item fill-column
@xref{Margins}.

@item fill-prefix
@xref{Margins}.

@item font-lock-defaults
@xref{Font Lock Basics}.

@item fringe-cursor-alist
@xref{Fringe Cursors}.

@item fringe-indicator-alist
@xref{Fringe Indicators}.

@item fringes-outside-margins
@xref{Fringes}.

@item goal-column
@xref{Moving Point,,, emacs, The GNU Emacs Manual}.

@item header-line-format
@xref{Header Lines}.

@item indicate-buffer-boundaries
@xref{Usual Display}.

@item indicate-empty-lines
@xref{Usual Display}.

@item left-fringe-width
@xref{Fringe Size/Pos}.

@item left-margin
@xref{Margins}.

@item left-margin-width
@xref{Display Margins}.

@item line-spacing
@xref{Line Height}.

@item local-abbrev-table
@xref{Standard Abbrev Tables}.

@item major-mode
@xref{Mode Help}.

@item mark-active
@xref{The Mark}.

@item mark-ring
@xref{The Mark}.

@item mode-line-buffer-identification
@xref{Mode Line Variables}.

@item mode-line-format
@xref{Mode Line Data}.

@item mode-line-modified
@xref{Mode Line Variables}.

@item mode-line-process
@xref{Mode Line Variables}.

@item mode-name
@xref{Mode Line Variables}.

@item point-before-scroll
Used for communication between mouse commands and scroll-bar commands.

@item right-fringe-width
@xref{Fringe Size/Pos}.

@item right-margin-width
@xref{Display Margins}.

@item save-buffer-coding-system
@xref{Encoding and I/O}.

@item scroll-bar-width
@xref{Scroll Bars}.

@item scroll-down-aggressively
@itemx scroll-up-aggressively
@xref{Textual Scrolling}.

@item selective-display
@itemx selective-display-ellipses
@xref{Selective Display}.

@item tab-width
@xref{Usual Display}.

@item truncate-lines
@xref{Truncation}.

@item vertical-scroll-bar
@xref{Scroll Bars}.

@item window-size-fixed
@xref{Resizing Windows}.

@item write-contents-functions
@xref{Saving Buffers}.
@end table


@ignore
   arch-tag: 6baae835-b667-4447-91e2-9829ae1cf543
@end ignore