view doc/man/ebrowse.1 @ 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.

.\" See section COPYING for copyright and redistribution information.
.TH EBROWSE 1
.SH NAME
ebrowse \- create a class hierarchy database
.SH SYNOPSIS
.B ebrowse
.RI [ options ]
.RI [ FILES .\|.\|.]
.SH "DESCRIPTION"
This manual page documents briefly the
.BR ebrowse
command.  Full documentation is available in the GNU Info format.
.PP
.B ebrowse
is used to create the database used by the class browser in Emacs.
.PP
.SH OPTIONS
The program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
.TP
.B \-a, \-\-append
append output to existing file
.TP
.B \-f, \-\-files=FILES
read input file names from
.I FILE
.TP
.B \-I, \-\-search-path=LIST
set search path for input files
.TP
.B \-m, \-\-min-regexp-length=N
set minimum regexp length to
.I N
.TP
.B \-M, \-\-max-regexp-length=N
set maximum regexp length to
.I N
.TP
.B \-n, \-\-no-nested-classes
exclude nested classes
.TP
.B \-o, \-\-output-file=FILE
set output file name to
.I FILE
.TP
.B \-p, \-\-position-info
print info about position in file
.TP
.B \-s, \-\-no-structs-or-unions
don't record structs or unions
.TP
.B \-v, \-\-verbose
be verbose
.TP
.B \-V, \-\-very-verbose
be very verbose
.TP
.B \-x, \-\-no-regexps
don't record regular expressions
.TP
.B \-\-help
display this help
.TP
.B \-\-version
display version info
.SH "SEE ALSO"
.BR emacs (1),
.BR etags (1),
and the full documentation for
.B ebrowse
which is maintained as a Texinfo manual.  If the
.B info
and
.B ebrowse
programs are properly installed at your site, the command
.IP
.B info ebrowse
.PP
should give you access to the complete manual.
.SH AUTHOR
.I Ebrowse
was written by Gerd Moellmann.
.
.SH COPYING
Copyright
.if t \(co
.if n (C)
2008, 2009, 2010 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
preserved on all copies.
.PP
Permission is granted to copy and distribute modified versions of
this document under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of
a permission notice identical to this one.
.PP
Permission is granted to copy and distribute translations of this
document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
.
.\" arch-tag: b771158b-90cb-43a5-b9af-dbc506311817