@setfilename ../info/ebrowse
@settitle A Class Browser for C++
@setchapternewpage odd
+@syncodeindex fn cp
@comment %**end of header
@ifinfo
are preserved on all copies.
@ignore
-Permission is granted to process this file through Tex and print the
+Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).
original English.
@end ifinfo
+@iftex
@titlepage
-@sp 10
-@center @titlefont{A C++ Browser for GNU Emacs}
-@vskip 0pt plus 1filll
-Copyright @copyright{} 1992--1999, 2000 Free Software Foundation, Inc.
-
-Permission is granted to make and distribute verbatim copies of this
-manual provided the copyright notice and this permission notice are
-preserved on all copies.
+@title Ebrowse User's Manual
+@sp 4
+@subtitle Ebrowse/Emacs 21
+@sp 1
+@subtitle May 2000
+@sp 5
+@author Gerd Moellmann
+@page
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided also that the
-sections entitled ``Distribution'' and ``General Public License'' are
-included exactly as in the original, and provided that the entire
-resulting derived work is distributed under the terms of a permission
-notice identical to this one.
+@vskip 0pt plus 1filll
+@noindent
+Copyright @copyright{} 2000 Free Software Foundation, Inc.
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that the sections entitled ``Distribution'' and ``General Public
-License'' may be included in a translation approved by the author
-instead of in the original English.
+Permission is granted to make and distribute verbatim copies of
+this manual provided the copyright notice and this permission notice
+are preserved on all copies.
@end titlepage
-
-
+@page
+@end iftex
@node Top, Overview, (dir), (dir)
+@ifnottex
You can browse C++ class hierarchies from within Emacs by using
Ebrowse.
+@end ifnottex
@menu
* Overview:: What is it and now does it work?
@node Overview, Generating browser files, Top, Top
@chapter Introduction
-@cindex tree buffer
-@cindex member buffer
-@cindex major modes
-@cindex parser
-@cindex @samp{*Globals*}
When working in software projects using C++, I frequently missed
software support for two things:
How does it work?
+@cindex parser for C++ sources
A fast parser written in C is used to process C++ source files.
The parser generates a data base containing information about classes,
members, global functions, defines, types etc. found in the sources.
various forms and allows you to perform operations on it, or do
something with the help of the knowledge contained in the data base.
+@cindex major modes, of Ebrowse buffers
@dfn{Navigational} use of Ebrowse is centered around two
types of buffers which define their own major modes:
+@cindex tree buffer
@dfn{Tree buffers} are used to view class hierarchies in tree form.
They allow you to quickly find classes, find or view class declarations,
perform operations like query replace on sets of your source files, and
finally tree buffers are used to produce the second buffer form---member
-buffers.
+buffers. @xref{Tree Buffers}.
+@cindex member buffer
Members are displayed in @dfn{member buffers}. Ebrowse
distinguishes between six different types of members; each type is
displayed as a member list of its own:
class. You can include inherited members in the display, you can set
filters that remove categories of members from the display, and most
importantly you can find or view member declarations and definitions
-with a keystroke.
+with a keystroke. @xref{Member Buffers}.
These two buffer types and the commands they provide support the
navigational use of the browser. The second form resembles Emacs' Tags
@itemize @bullet
@item
Jump to the definition or declaration of an identifier in your source
-code, with an electric position stack that let's you easily navigate
+code, with an electric position stack that lets you easily navigate
back and forth.
@item
@node Generating browser files, Loading a Tree, Overview, Top
@comment node-name, next, previous, up
@chapter Processing Source Files
-@cindex command line
-@cindex options
-@cindex switches
-@cindex parser switches
+@cindex @command{ebrowse}, the program
+@cindex class data base creation
Before you can start browsing a class hierarchy, you must run the parser
-@file{ebrowse} on your source files in order to generate a Lisp data
+@command{ebrowse} on your source files in order to generate a Lisp data
base describing your program.
-The operation of @file{ebrowse} can be tailored with command line
+@cindex command line for @command{ebrowse}
+The operation of @command{ebrowse} can be tailored with command line
options. Under normal circumstances it suffices to let the parser use
its default settings. If you want to do that, call it with a command
line like:
@end example
@noindent
-or, if your shell doesn't allow all file names to be specified on
+or, if your shell doesn't allow all the file names to be specified on
the command line,
@example
where @var{file} contains the names of the files to be parsed, one
per line.
-When invoked with option @samp{--help}, @file{ebrowse} prints a list of
+@findex --help
+When invoked with option @samp{--help}, @command{ebrowse} prints a list of
available command line options.@refill
@menu
@comment name, next, prev, up
@node Input files, Output file, Generating browser files, Generating browser files
@section Specifying Input Files
-@cindex input files
-@cindex response files
-@cindex @samp{--files}
-@cindex @samp{--search-path}
-@cindex standard input
-@cindex header files
-@cindex friend functions
@table @samp
+@cindex input files, for @command{ebrowse}
@item file
-Each file name on the command line tells @file{ebrowse} to parse
+Each file name on the command line tells @command{ebrowse} to parse
that file.
+@cindex response files
+@findex --files
@item --files=@var{file}
This command line switch specifies that @var{file} contains a list of
file names to parse. Each line in @var{file} must contain one file
instance, want to use one file for header files, and another for source
files.
+@cindex standard input, specifying input files
@item standard input
-When @file{ebrowse} finds no file names on the command line, and no
+When @command{ebrowse} finds no file names on the command line, and no
@samp{--file} option is specified, it reads file names from standard
-input. This is sometimes convenient when @file{ebrowse} is used as part
+input. This is sometimes convenient when @command{ebrowse} is used as part
of a command pipe.
+@findex --search-path
@item --search-path=@var{paths}
This option let's you specify search paths for your input files.
@var{paths} is a list of directory names, separated from each other by a
either a colon or a semicolon, depending on the operating system.
@end table
+@cindex header files
+@cindex friend functions
It is generally a good idea to specify input files so that header files
are parsed before source files. This facilitates the parser's work of
properly identifying friend functions of a class.
@comment name, next, prev, up
@node Output file, Structs and unions, Input files, Generating browser files
@section Changing the Output File Name
-@cindex output file name
-@cindex @samp{BROWSE}
-@cindex appending output
-@cindex @samp{--output-file}
-@cindex @samp{--append}
@table @samp
+@cindex output file name
+@findex --output-file
+@cindex @file{BROWSE} file
@item --output-file=@var{file}
-This option instructs @file{ebrowse} to generate a Lisp data base with
+This option instructs @command{ebrowse} to generate a Lisp data base with
name @var{file}. By default, the data base is named @file{BROWSE}, and
-is written in the directory in which @file{ebrowse} is invoked.
+is written in the directory in which @command{ebrowse} is invoked.
If you regularly use data base names different from the default, you
-might want to add this to your init file
+might want to add this to your init file:
@lisp
(add-to-list 'auto-mode-alist '(@var{NAME} . ebrowse-tree-mode))
@noindent
where @var{NAME} is the Lisp data base name you are using.
+@findex --append
+@cindex appending output to class data base
@item --append
-By default, each run of @file{ebrowse} erases the old contents of the
-output file when writing to it. You can instruct @file{ebrowse} to
+By default, each run of @command{ebrowse} erases the old contents of the
+output file when writing to it. You can instruct @command{ebrowse} to
append its output to an existing file with this command line option.
@end table
@section Structs and Unions
@cindex structs
@cindex unions
-@cindex @samp{--no-structs-or-unions}
@table @samp
+@findex --no-structs-or-unions
@item --no-structs-or-unions
This switch suppresses all classes in the data base declared as
@code{struct} or @code{union} in the output.
@comment name, next, prev, up
@node Matching, Verbosity, Structs and unions, Generating browser files
@section Regular Expressions
-@cindex regular expressions
-@cindex minimum regexp length
-@cindex maximum regexp length
-@cindex @samp{--min-regexp-length}
-@cindex @samp{--max-regexp-length}
-@cindex @samp{--no-regexps}
-The parser @file{ebrowse} normally writes strings to its output file
-that help the Lisp part of Ebrowse to find functions, variables etc. in
-their source files.
+@cindex regular expressions, recording
+The parser @command{ebrowse} normally writes regular expressions to its
+output file that help the Lisp part of Ebrowse to find functions,
+variables etc. in their source files.
-You can instruct @file{ebrowse} to omit these strings by calling it
-with the command line switch @samp{--no-regexps}.
+You can instruct @command{ebrowse} to omit these regular expressions by
+calling it with the command line switch @samp{--no-regexps}.
When you do this, the Lisp part of Ebrowse tries to guess, from member
or class names, suitable regular expressions to locate that class or
coding styles are used.
@table @samp
+@findex --no-regexps
@item --no-regexps
This option turns regular expression recording off.
+@findex --min-regexp-length
+@cindex minimum regexp length for recording
@item --min-regexp-length=@var{n}
The number @var{n} following this option specifies the minimum length of
the regular expressions recorded to match class and member declarations
and definitions. The default value is set at compilation time of
-@file{ebrowse}.
+@command{ebrowse}.
The smaller the minimum length the higher the probability that
Ebrowse will find a wrong match. The larger the value, the
larger the output file and therefore the memory consumption once the
file is read from Emacs.
+@findex --max-regexp-length
+@cindex maximum regexp length for recording
@item --max-regexp-length=@var{n}
The number following this option specifies the maximum length of the
regular expressions used to match class and member declarations and
definitions. The default value is set at compilation time of
-@file{ebrowse}.
+@command{ebrowse}.
The larger the maximum length the higher the probability that the
browser will find a correct match, but the larger the value the larger
@node Verbosity, , Matching, Generating browser files
@comment node-name, next, previous, up
@section Verbose Mode
-@cindex verbose
-@cindex @samp{--verbose}
-@cindex @samp{--very-verbose}
+@cindex verbose operation
@table @samp
+@findex --verbose
@item --verbose
-When this option is specified on the command line, @file{ebrowse} prints
+When this option is specified on the command line, @command{ebrowse} prints
a period for each file parsed, and it displays a @samp{+} for each
class written to the output file.
+@findex --very-verbose
@item --very-verbose
-This option makes @file{ebrowse} print out the names of the files and
+This option makes @command{ebrowse} print out the names of the files and
the names of the classes seen.
@end table
@cindex loading
@cindex browsing
-You start browsing a class hierarchy parsed by @file{ebrowse} by just
+You start browsing a class hierarchy parsed by @command{ebrowse} by just
finding the @file{BROWSE} file with @kbd{C-x C-f}.
An example of a tree buffer display is shown below.
| Dictionary
@end example
-When you run Emacs under X, you will notice that that certain areas in
-the tree buffer are highlighted when you move the mouse over them. This
-highlight marks mouse-sensitive regions in the buffer. Please notice
-the help strings in the echo area when the mouse moves over a sensitive
-region.
+@cindex mouse highlight in tree buffers
+When you run Emacs on a display which supports colors and the mouse, you
+will notice that that certain areas in the tree buffer are highlighted
+when you move the mouse over them. This highlight marks mouse-sensitive
+regions in the buffer. Please notice the help strings in the echo area
+when the mouse moves over a sensitive region.
+@cindex context menu
A click with @kbd{mouse-3} on a mouse-sensitive region opens a context
menu. In addition to this, each buffer also has a buffer-specific menu
that is opened with a click with @kbd{mouse-3} somewhere in the buffer
@node Tree Buffers, Member Buffers, Loading a Tree, Top
@comment node-name, next, previous, up
@chapter Tree Buffers
-@cindex tree buffers
-@cindex tree
@cindex tree buffer mode
@cindex class trees
@comment node-name, next, previous, up
@section Viewing and Finding Class Declarations
@cindex viewing, class
-@cindex finding, class
+@cindex finding a class
@cindex class declaration
You can view or find a class declaration when the cursor is on a class
@node Member Display, Go to Class, Source Display, Tree Buffers
@comment node-name, next, previous, up
@section Displaying Members
-@cindex @samp{*Members*}
+@cindex @samp{*Members*} buffer
@cindex @samp{*Globals*}
-@cindex freezing
-@cindex member lists
+@cindex freezing a member buffer
+@cindex member lists, in tree buffers
Ebrowse distinguishes six different kinds of members, each of
which is displayed as a separate @dfn{member list}: instance variables,
the member buffer will additionally be @dfn{frozen}.
@table @kbd
+@cindex instance member variables, list
@item L v
This command displays the list of instance member variables.
+@cindex static variables, list
@item L V
Display the list of static variables.
+@cindex friend functions, list
@item L d
Display the list of friend functions. This list is used for defines if
you are viewing the class @samp{*Globals*} which is a place holder for
global symbols.
+@cindex member functions, list
@item L f
Display the list of member functions.
+@cindex static member functions, list
@item L F
Display the list of static member functions.
+@cindex types, list
@item L t
Display a list of types.
@end table
@section Finding a Class
@cindex locate class
@cindex expanding branches
+@cindex class location
@table @kbd
+@cindex search for class
@item /
This command reads a class name from the minibuffer with completion and
positions the cursor on the class in the class tree.
If the branch of the class tree containing the class searched for is
currently collapsed, the class itself and all its base classes are
-recursively made visible. (See also @xref{Expanding and
+recursively made visible. (See also @ref{Expanding and
Collapsing}.)@refill
This function is also available from the tree buffer's context menu.
@node Quitting, File Name Display, Go to Class, Tree Buffers
@comment node-name, next, previous, up
@section Burying a Tree Buffer
-@cindex burying buffer, tree
+@cindex burying tree buffer
@table @kbd
@item q
@node File Name Display, Expanding and Collapsing, Quitting, Tree Buffers
@comment node-name, next, previous, up
@section Displaying File Names
-@cindex file name display
@table @kbd
+@cindex file names in tree buffers
@item T f
This command toggles the display of file names in a tree buffer. If
file name display is switched on, the names of the files containing the
@node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers
@comment node-name, next, previous, up
@section Expanding and Collapsing a Tree
-@cindex expand
-@cindex collapse
-@cindex branches
+@cindex expand tree branch
+@cindex collapse tree branch
+@cindex branches of class tree
+@cindex class tree, collapse or expand
You can expand and collapse parts of a tree to reduce the complexity of
large class hierarchies. Expanding or collapsing branches of a tree has
no impact on the functionality of other commands, like @kbd{/}. (See
-also @xref{Go to Class}.)@refill
+also @ref{Go to Class}.)@refill
Collapsed branches are indicated with an ellipsis following the class
name like in the example below.
@comment node-name, next, previous, up
@section Changing the Tree Indentation
@cindex tree indentation
-@cindex indentation
+@cindex indentation of the tree
@table @kbd
@item T w
@comment node-name, next, previous, up
@section Removing Classes from the Tree
@cindex killing classes
+@cindex class, remove from tree
@table @kbd
@item C-k
@comment node-name, next, previous, up
@comment node-name, next, previous, up
@section Saving a Tree
-@cindex saving tree
+@cindex save tree to a file
+@cindex tree, save to a file
+@cindex class tree, save to a file
@table @kbd
@item C-x C-s
@node Statistics, Marking Classes, Saving a Tree, Tree Buffers
@comment node-name, next, previous, up
-@cindex statistics
+@cindex statistics for a tree
+@cindex tree statistics
+@cindex class statistics
@table @kbd
@item x
@node Marking Classes, , Statistics, Tree Buffers
@comment node-name, next, previous, up
@cindex marking classes
+@cindex operations on marked classes
Classes can be marked for operations similar to the standard Emacs
commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see
also @xref{Tags-like Functions}.)@refill
@table @kbd
+@cindex toggle mark
@item M t
Toggle the mark of the line point is in or for as many lines as given by
a prefix command. This command can also be found in the class' context
menu.
+@cindex unmark all
@item M a
Unmark all classes. With prefix argument @kbd{C-u}, mark all classes in
the tree. Since this command operates on the whole buffer, it can also be
@node Member Buffers, Tags-like Functions, Tree Buffers, Top
@comment node-name, next, previous, up
@chapter Member Buffers
-@cindex member buffer
@cindex members
@cindex member buffer mode
+@cindex class members, types
+@cindex types of class members
@dfn{Member buffers} are used to operate on lists of members of a class.
Ebrowse distinguishes six kinds of lists:
@node Switching Member Lists, Finding/Viewing, Member Buffers, Member Buffers
@comment node-name, next, previous, up
@section Switching Member Lists
-@cindex member lists
+@cindex member lists, in member buffers
@cindex static members
@cindex friends
@cindex types
@cindex defines
@table @kbd
+@cindex next member list
@item L n
This command switches the member buffer display to the next member list.
+@cindex previous member list
@item L p
This command switches the member buffer display to the previous member
list.
@item L f
Switch to the list of member functions.
+@cindex static
@item L F
Switch to the list of static member functions.
@node Finding/Viewing, Inherited Members, Switching Member Lists, Member Buffers
@comment node-name, next, previous, up
@section Finding and Viewing Member Source
-@cindex finding members
-@cindex viewing members
-@cindex member definitions
-@cindex member declarations
-@cindex definitions
-@cindex declarations
+@cindex finding members, in member buffers
+@cindex viewing members, in member buffers
+@cindex member definitions, in member buffers
+@cindex member declarations, in member buffers
+@cindex definition of a member, in member buffers
+@cindex declaration of a member, in member buffers
@table @kbd
@item RET
@node Inherited Members, Searching Members, Finding/Viewing, Member Buffers
@comment node-name, next, previous, up
@section Display of Inherited Members
-@cindex superclasses
-@cindex base classes
+@cindex superclasses, members
+@cindex base classes, members
@cindex inherited members
@table @kbd
@node Switching to Tree, Filters, Searching Members, Member Buffers
@comment node-name, next, previous, up
@section Switching to Tree Buffer
-@cindex tree buffer
+@cindex tree buffer, switch to
@cindex buffer switching
@cindex switching buffers
@comment node-name, next, previous, up
@section Filters
@cindex filters
-@cindex @code{public}
-@cindex @code{protected}
-@cindex @code{private}
-@cindex @code{virtual}
-@cindex @code{inline}
-@cindex @code{const}
-@cindex pure virtual members
@table @kbd
+@cindex @code{public} members
@item F a u
This command toggles the display of @code{public} members. The
@samp{a} stands for `access'.
+@cindex @code{protected} members
@item F a o
This command toggles the display of @code{protected} members.
+@cindex @code{private} members
@item F a i
This command toggles the display of @code{private} members.
+@cindex @code{virtual} members
@item F v
This command toggles the display of @code{virtual} members.
+@cindex @code{inline} members
@item F i
This command toggles the display of @code{inline} members.
+@cindex @code{const} members
@item F c
This command toggles the display of @code{const} members.
+@cindex pure virtual members
@item F p
This command toggles the display of pure virtual members.
+@cindex remove filters
@item F r
This command removes all filters.
@end table
@comment node-name, next, previous, up
@section Displaying Member Attributes
@cindex attributes
-@cindex member attributes
-@cindex @code{virtual}
-@cindex @code{extern "C"}
-@cindex @code{mutable}
-@cindex @code{explicit}
-@cindex @code{template}
-@cindex @code{inline}
-@cindex @code{const}
-@cindex pure virtual
+@cindex member attribute display
@table @kbd
@item D a
the attribute is false. The list of attributes from left to right is
@table @samp
+@cindex @code{template} attribute
@item T
The member is a template.
+@cindex @code{extern "C"} attribute
@item C
The member is declared @code{extern "C"}.
+@cindex @code{virtual} attribute
@item v
Means the member is declared @code{virtual}.
+@cindex @code{inline}
@item i
The member is declared @code{inline}.
+@cindex @code{const} attribute
@item c
The member is @code{const}.
+@cindex pure virtual function attribute
@item 0
The member is a pure virtual function.
+@cindex @code{mutable} attribute
@item m
The member is declared @code{mutable}.
+@cindex @code{explicit} attribute
@item e
The member is declared @code{explicit}.
@cindex display form
@cindex long display
@cindex short display
-@cindex @samp{--no-regexps}
@table @kbd
@item D l
@end example
Regular expressions will only be displayed when the Lisp database has
-not been produced with the @file{ebrowse} option @samp{--no-regexps}.
+not been produced with the @command{ebrowse} option @samp{--no-regexps}.
+@xref{Matching, --no-regexps, Regular Expressions}.
@end table
@end table
Regular expressions will only be displayed when the Lisp database has
-not been produced with the @file{ebrowse} option @samp{--no-regexps}.
+not been produced with the @command{ebrowse} option @samp{--no-regexps},
+see @ref{Matching, --no-regexps, Regular Expressions}.
@node Switching Classes, Killing/Burying, Regexp Display, Member Buffers
@comment node-name, next, previous, up
@section Displaying Another Class
-@cindex base classes
-@cindex derived classes
-@cindex superclasses
-@cindex subclasses
+@cindex base class, display
+@cindex derived class, display
+@cindex superclass, display
+@cindex subclass, display
@cindex class display
@table @kbd
@node Redisplay, Getting Help, Column Width, Member Buffers
@comment node-name, next, previous, up
@section Forced Redisplay
-@cindex redisplay
+@cindex redisplay of member buffers
@table @kbd
@item C-l
@node Finding and Viewing, Position Stack, Tags-like Functions, Tags-like Functions
@comment node-name, next, previous, up
@section Finding and Viewing Members
-@cindex finding member
-@cindex viewing member
+@cindex finding class member, in C++ source
+@cindex viewing class member, in C++ source
@cindex tags
-@cindex member definition
-@cindex member declaration
+@cindex member definition, finding, in C++ source
+@cindex member declaration, finding, in C++ source
+
+The functions in this section are similar to those described in
+@ref{Source Display}, and also in @ref{Finding/Viewing}, except that
+they work in a C++ source buffer, not in member and tree buffers created
+by Ebrowse.
@table @kbd
@item C-c b f
the completion.
@item C-c b F
-Fin the declaration of the member around point.
+Find the declaration of the member around point.
@item C-c b v
View the definition of the member around point.
move to positions in the stack:@refill
@table @kbd
+@cindex return to original position
@item C-c b -
This command sets point to the previous position in the position stack.
Directly after you performed a jump, this will put you back to the
-@node Search & Replace, Members in Files, Position Stack, Tags-like Functions
+@node Search & Replace, Members in Files, Position Stack, Tags-like Functions
@comment node-name, next, previous, up
@section Searching and Replacing
-@cindex searching
-@cindex replacing
+@cindex searching multiple C++ files
+@cindex replacing in multiple C++ files
@cindex restart tags-operation
Ebrowse allows you to perform operations on all or a subset of the files
@comment node-name, next, previous, up
@section Members in Files
@cindex files
-@cindex members in file
+@cindex members in file, listing
+@cindex list class members in a file
@cindex file, members
The command @kbd{C-c b l}, lists all members in a given file. The file
@node Apropos, Symbol Completion, Members in Files, Tags-like Functions
@comment node-name, next, previous, up
@section Member Apropos
-@cindex apropos
+@cindex apropos on class members
@cindex members, matching regexp
The command @kbd{C-c b a} can be used to display all members matching a
@node Member Buffer Display, , Symbol Completion, Tags-like Functions
@section Quick Member Display
-@cindex member buffer
+@cindex member buffer, for member at point
You can quickly display a member buffer containing the member the cursor
in on with the command @kbd{C-c b m}.
projects / emacs.git / commitdiff