ebrowse.texi 42.3 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2 3 4 5 6
\input texinfo   @c -*-texinfo-*-

@comment %**start of header
@setfilename ../info/ebrowse
@settitle A Class Browser for C++
@setchapternewpage odd
Gerd Moellmann's avatar
Gerd Moellmann committed
7
@syncodeindex fn cp
Gerd Moellmann's avatar
Gerd Moellmann committed
8 9
@comment %**end of header

Karl Berry's avatar
Karl Berry committed
10
@copying
Gerd Moellmann's avatar
Gerd Moellmann committed
11 12
This file documents Ebrowse, a C++ class browser for GNU Emacs.

Karl Berry's avatar
Karl Berry committed
13
Copyright @copyright{} 2000, 2002 Free Software Foundation, Inc.
Dave Love's avatar
Dave Love committed
14

Karl Berry's avatar
Karl Berry committed
15
@quotation
Dave Love's avatar
Dave Love committed
16 17 18 19
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU
Richard M. Stallman's avatar
Richard M. Stallman committed
20
Manual,'' and with the Back-Cover Texts as in (a) below.  A copy of the
Dave Love's avatar
Dave Love committed
21 22 23 24 25 26 27 28 29 30 31
license is included in the section entitled ``GNU Free Documentation
License'' in the Emacs manual.

(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
this GNU Manual, like GNU software.  Copies published by the Free
Software Foundation raise funds for GNU development.''

This document is part of a collection distributed under the GNU Free
Documentation License.  If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license.
Karl Berry's avatar
Karl Berry committed
32 33 34 35 36 37 38
@end quotation
@end copying

@dircategory Emacs
@direntry 
* Ebrowse: (ebrowse).   A C++ class browser for Emacs.
@end direntry
Gerd Moellmann's avatar
Gerd Moellmann committed
39 40

@titlepage
Gerd Moellmann's avatar
Gerd Moellmann committed
41 42 43 44 45 46 47 48 49
@title Ebrowse User's Manual
@sp 4
@subtitle Ebrowse/Emacs 21
@sp 1
@subtitle May 2000
@sp 5
@author Gerd Moellmann
@page
@vskip 0pt plus 1filll
Karl Berry's avatar
Karl Berry committed
50
@insertcopying
Gerd Moellmann's avatar
Gerd Moellmann committed
51 52 53 54
@end titlepage

@node Top, Overview, (dir), (dir)

Gerd Moellmann's avatar
Gerd Moellmann committed
55
@ifnottex
Gerd Moellmann's avatar
Gerd Moellmann committed
56 57
You can browse C++ class hierarchies from within Emacs by using
Ebrowse.
Gerd Moellmann's avatar
Gerd Moellmann committed
58
@end ifnottex
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

@menu
* Overview::			What is it and now does it work?
* Generating browser files::	How to process C++ source files
* Loading a Tree::		How to start browsing
* Tree Buffers::		Traversing class hierarchies
* Member Buffers::		Looking at member information
* Tags-like Functions::		Finding members from source files
* Concept Index::		An entry for each concept defined
@end menu




@node Overview, Generating browser files, Top, Top
@chapter Introduction

When working in software projects using C++, I frequently missed
software support for two things:

@itemize @bullet
@item
When you get a new class library, or you have to work on source code you
haven't written yourself (or written sufficiently long ago), you need a
83 84 85
tool to let you navigate class hierarchies and investigate
features of the software.  Without such a tool you often end up
@command{grep}ing through dozens or even hundreds of files.
Gerd Moellmann's avatar
Gerd Moellmann committed
86 87 88 89 90 91 92 93 94 95 96 97 98

@item
Once you are productive, it would be nice to have a tool that knows your
sources and can help you while you are editing source code.  Imagine to
be able to jump to the definition of an identifier while you are
editing, or something that can complete long identifier names because it
knows what identifiers are defined in your program@dots{}.
@end itemize

The design of Ebrowse reflects these two needs.

How does it work? 

Gerd Moellmann's avatar
Gerd Moellmann committed
99
@cindex parser for C++ sources
Gerd Moellmann's avatar
Gerd Moellmann committed
100 101
A fast parser written in C is used to process C++ source files.
The parser generates a data base containing information about classes,
102
members, global functions, defines, types etc.@: found in the sources.
Gerd Moellmann's avatar
Gerd Moellmann committed
103 104 105 106 107 108

The second part of Ebrowse is a Lisp program.  This program reads
the data base generated by the parser.  It displays its contents in
various forms and allows you to perform operations on it, or do
something with the help of the knowledge contained in the data base.

Gerd Moellmann's avatar
Gerd Moellmann committed
109
@cindex major modes, of Ebrowse buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112
@dfn{Navigational} use of Ebrowse is centered around two
types of buffers which define their own major modes:

Gerd Moellmann's avatar
Gerd Moellmann committed
113
@cindex tree buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
114 115 116 117
@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
Gerd Moellmann's avatar
Gerd Moellmann committed
118
buffers.  @xref{Tree Buffers}.
Gerd Moellmann's avatar
Gerd Moellmann committed
119

Gerd Moellmann's avatar
Gerd Moellmann committed
120
@cindex member buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122 123 124 125 126
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:

@itemize @bullet
@item
127
Instance member variables;
Gerd Moellmann's avatar
Gerd Moellmann committed
128 129

@item
130
Instance member functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
131 132

@item
133
Static member variables;
Gerd Moellmann's avatar
Gerd Moellmann committed
134 135

@item
136
Static member functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
137 138

@item
139 140
Friends/Defines.  The list of defines is contained in the friends
list of the pseudo-class @samp{*Globals*};
Gerd Moellmann's avatar
Gerd Moellmann committed
141 142 143 144 145 146 147 148 149 150

@item
Types (@code{enum}s, and @code{typedef}s defined with class
scope).@refill
@end itemize

You can switch member buffers from one list to another, or to another
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
Gerd Moellmann's avatar
Gerd Moellmann committed
151
with a keystroke.  @xref{Member Buffers}.
Gerd Moellmann's avatar
Gerd Moellmann committed
152 153 154 155 156 157 158 159 160 161 162 163

These two buffer types and the commands they provide support the
navigational use of the browser.  The second form resembles Emacs' Tags
package for C and other procedural languages.  Ebrowse's commands of
this type are not confined to special buffers; they are most often used
while you are editing your source code.

To list just a subset of what you can use the Tags part of Ebrowse for:

@itemize @bullet
@item
Jump to the definition or declaration of an identifier in your source
Gerd Moellmann's avatar
Gerd Moellmann committed
164
code, with an electric position stack that lets you easily navigate
Gerd Moellmann's avatar
Gerd Moellmann committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
back and forth.

@item
Complete identifiers in your source with a completion list containing
identifiers from your source code only.

@item
Perform search and query replace operations over some or all of your
source files.

@item
Show all identifiers matching a regular expression---and jump to one of
them, if you like.
@end itemize




@node Generating browser files, Loading a Tree, Overview, Top
@comment node-name,  next,  previous,  up
@chapter Processing Source Files

Gerd Moellmann's avatar
Gerd Moellmann committed
187 188
@cindex @command{ebrowse}, the program
@cindex class data base creation
Gerd Moellmann's avatar
Gerd Moellmann committed
189
Before you can start browsing a class hierarchy, you must run the parser
Gerd Moellmann's avatar
Gerd Moellmann committed
190
@command{ebrowse} on your source files in order to generate a Lisp data
Gerd Moellmann's avatar
Gerd Moellmann committed
191 192
base describing your program.

Gerd Moellmann's avatar
Gerd Moellmann committed
193 194
@cindex command line for @command{ebrowse}
The operation of @command{ebrowse} can be tailored with command line
Gerd Moellmann's avatar
Gerd Moellmann committed
195 196 197 198 199 200 201 202 203
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:

@example
ebrowse *.h *.cc
@end example

@noindent
Gerd Moellmann's avatar
Gerd Moellmann committed
204
or, if your shell doesn't allow all the file names to be specified on
Gerd Moellmann's avatar
Gerd Moellmann committed
205 206 207 208 209 210 211 212 213 214
the command line,

@example
ebrowse --files=@var{file}
@end example

@noindent
where @var{file} contains the names of the files to be parsed, one
per line.

Gerd Moellmann's avatar
Gerd Moellmann committed
215 216
@findex --help
When invoked with option @samp{--help}, @command{ebrowse} prints a list of
Gerd Moellmann's avatar
Gerd Moellmann committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
available command line options.@refill

@menu
* Input files::		Specifying which files to parse
* Output file::		Changing the output file name
* Structs and unions::	Omitting @code{struct}s and @code{union}s
* Matching::		Setting regular expression lengths
* Verbosity::           Getting feedback for lengthy operations
@end menu




@comment name,     next,        prev,                     up
@node Input files, Output file, Generating browser files, Generating browser files
@section Specifying Input Files

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
235
@cindex input files, for @command{ebrowse}
Gerd Moellmann's avatar
Gerd Moellmann committed
236
@item file
Gerd Moellmann's avatar
Gerd Moellmann committed
237
Each file name on the command line tells @command{ebrowse} to parse
Gerd Moellmann's avatar
Gerd Moellmann committed
238 239
that file.

Gerd Moellmann's avatar
Gerd Moellmann committed
240 241
@cindex response files
@findex --files
Gerd Moellmann's avatar
Gerd Moellmann committed
242 243 244 245 246 247 248
@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
name.  More than one option of this kind is allowed.  You might, for
instance, want to use one file for header files, and another for source
files.

Gerd Moellmann's avatar
Gerd Moellmann committed
249
@cindex standard input, specifying input files
Gerd Moellmann's avatar
Gerd Moellmann committed
250
@item standard input
Gerd Moellmann's avatar
Gerd Moellmann committed
251
When @command{ebrowse} finds no file names on the command line, and no
Gerd Moellmann's avatar
Gerd Moellmann committed
252
@samp{--file} option is specified, it reads file names from standard
Gerd Moellmann's avatar
Gerd Moellmann committed
253
input.  This is sometimes convenient when @command{ebrowse} is used as part
Gerd Moellmann's avatar
Gerd Moellmann committed
254 255
of a command pipe.

Gerd Moellmann's avatar
Gerd Moellmann committed
256
@findex --search-path
Gerd Moellmann's avatar
Gerd Moellmann committed
257
@item --search-path=@var{paths}
258
This option lets you specify search paths for your input files.
Gerd Moellmann's avatar
Gerd Moellmann committed
259 260 261 262
@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

Gerd Moellmann's avatar
Gerd Moellmann committed
263 264
@cindex header files
@cindex friend functions
Gerd Moellmann's avatar
Gerd Moellmann committed
265 266 267 268 269 270 271 272 273 274 275
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

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
276 277 278
@cindex output file name
@findex --output-file
@cindex @file{BROWSE} file
Gerd Moellmann's avatar
Gerd Moellmann committed
279
@item --output-file=@var{file}
Gerd Moellmann's avatar
Gerd Moellmann committed
280
This option instructs @command{ebrowse} to generate a Lisp data base with
Gerd Moellmann's avatar
Gerd Moellmann committed
281
name @var{file}.  By default, the data base is named @file{BROWSE}, and
Gerd Moellmann's avatar
Gerd Moellmann committed
282
is written in the directory in which @command{ebrowse} is invoked.
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284

If you regularly use data base names different from the default, you
Gerd Moellmann's avatar
Gerd Moellmann committed
285
might want to add this to your init file:
Gerd Moellmann's avatar
Gerd Moellmann committed
286 287 288 289 290 291 292 293

@lisp
(add-to-list 'auto-mode-alist '(@var{NAME} . ebrowse-tree-mode))
@end lisp

@noindent 
where @var{NAME} is the Lisp data base name you are using.

Gerd Moellmann's avatar
Gerd Moellmann committed
294 295
@findex --append
@cindex appending output to class data base
Gerd Moellmann's avatar
Gerd Moellmann committed
296
@item --append
Gerd Moellmann's avatar
Gerd Moellmann committed
297 298
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
Pavel Janík's avatar
Pavel Janík committed
299
append its output to an existing file produced by @command{ebrowse}
300
with this command line option.
Gerd Moellmann's avatar
Gerd Moellmann committed
301 302 303 304 305 306 307 308 309 310 311 312
@end table




@comment name,            next,     prev,        up
@node Structs and unions, Matching, Output file, Generating browser files
@section Structs and Unions
@cindex structs
@cindex unions

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
313
@findex --no-structs-or-unions
Gerd Moellmann's avatar
Gerd Moellmann committed
314 315 316 317
@item --no-structs-or-unions
This switch suppresses all classes in the data base declared as
@code{struct} or @code{union} in the output.

318
This is mainly useful when you are converting an existing
Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321 322 323 324 325 326 327 328 329
C program to C++, and do not want to see the old C structs in a class
tree.
@end table




@comment name,  next,      prev,               up
@node Matching, Verbosity, Structs and unions, Generating browser files
@section Regular Expressions

Gerd Moellmann's avatar
Gerd Moellmann committed
330 331 332
@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,
333
variables etc.@: in their source files.
Gerd Moellmann's avatar
Gerd Moellmann committed
334

Gerd Moellmann's avatar
Gerd Moellmann committed
335 336
You can instruct @command{ebrowse} to omit these regular expressions by
calling it with the command line switch @samp{--no-regexps}.
Gerd Moellmann's avatar
Gerd Moellmann committed
337 338 339 340 341 342 343 344

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
member in source files.  This works fine in most cases, but the
automatic generation of regular expressions can be too weak if unusual
coding styles are used.

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
345
@findex --no-regexps
Gerd Moellmann's avatar
Gerd Moellmann committed
346
@item --no-regexps
347
This option turns off regular expression recording.
Gerd Moellmann's avatar
Gerd Moellmann committed
348

Gerd Moellmann's avatar
Gerd Moellmann committed
349 350
@findex --min-regexp-length
@cindex minimum regexp length for recording
Gerd Moellmann's avatar
Gerd Moellmann committed
351 352 353 354
@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
Gerd Moellmann's avatar
Gerd Moellmann committed
355
@command{ebrowse}.
Gerd Moellmann's avatar
Gerd Moellmann committed
356

357
The smaller the minimum length, the higher the probability that
Gerd Moellmann's avatar
Gerd Moellmann committed
358 359 360 361
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.

Gerd Moellmann's avatar
Gerd Moellmann committed
362 363
@findex --max-regexp-length
@cindex maximum regexp length for recording
Gerd Moellmann's avatar
Gerd Moellmann committed
364 365 366 367
@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
Gerd Moellmann's avatar
Gerd Moellmann committed
368
@command{ebrowse}.
Gerd Moellmann's avatar
Gerd Moellmann committed
369

370
The larger the maximum length, the higher the probability that the
Gerd Moellmann's avatar
Gerd Moellmann committed
371 372
browser will find a correct match, but the larger the value the larger
the output file and therefore the memory consumption once the data is
373
read.  As a second effect, the larger the regular expression, the higher
Gerd Moellmann's avatar
Gerd Moellmann committed
374 375 376 377 378 379 380 381 382
the probability that it will no longer match after editing the file.
@end table




@node Verbosity, , Matching, Generating browser files
@comment  node-name,  next,  previous,  up
@section Verbose Mode
Gerd Moellmann's avatar
Gerd Moellmann committed
383
@cindex verbose operation
Gerd Moellmann's avatar
Gerd Moellmann committed
384 385

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
386
@findex --verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
387
@item --verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
388
When this option is specified on the command line, @command{ebrowse} prints
Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391
a period for each file parsed, and it displays a @samp{+} for each
class written to the output file.

Gerd Moellmann's avatar
Gerd Moellmann committed
392
@findex --very-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
393
@item --very-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
394
This option makes @command{ebrowse} print out the names of the files and
Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398 399 400 401 402 403 404 405 406
the names of the classes seen.
@end table




@node Loading a Tree, Tree Buffers, Generating browser files, Top
@comment  node-name,  next,  previous,  up
@chapter Starting to Browse
@cindex loading
@cindex browsing

Gerd Moellmann's avatar
Gerd Moellmann committed
407
You start browsing a class hierarchy parsed by @command{ebrowse} by just
Gerd Moellmann's avatar
Gerd Moellmann committed
408 409 410 411 412 413 414 415 416 417 418 419 420
finding the @file{BROWSE} file with @kbd{C-x C-f}.

An example of a tree buffer display is shown below.

@example
|  Collection
|    IndexedCollection
|      Array
|        FixedArray
|    Set
|    Dictionary
@end example

Gerd Moellmann's avatar
Gerd Moellmann committed
421 422
@cindex mouse highlight in tree buffers
When you run Emacs on a display which supports colors and the mouse, you
423
will notice that certain areas in the tree buffer are highlighted
Gerd Moellmann's avatar
Gerd Moellmann committed
424 425 426
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.
Gerd Moellmann's avatar
Gerd Moellmann committed
427

Gerd Moellmann's avatar
Gerd Moellmann committed
428
@cindex context menu
Richard M. Stallman's avatar
Richard M. Stallman committed
429
A click with @kbd{Mouse-3} on a mouse-sensitive region opens a context
Gerd Moellmann's avatar
Gerd Moellmann committed
430
menu.  In addition to this, each buffer also has a buffer-specific menu
Richard M. Stallman's avatar
Richard M. Stallman committed
431
that is opened with a click with @kbd{Mouse-3} somewhere in the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
where no highlight is displayed.



@comment ****************************************************************
@comment ***
@comment ***                 TREE BUFFERS
@comment ***
@comment ****************************************************************

@node Tree Buffers, Member Buffers, Loading a Tree, Top
@comment  node-name,  next,  previous,  up
@chapter Tree Buffers
@cindex tree buffer mode
@cindex class trees

Class trees are displayed in @dfn{tree buffers} which install their own
major mode.  Most Emacs keys work in tree buffers in the usual way,
450
e.g.@: you can move around in the buffer with the usual @kbd{C-f},
Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
@kbd{C-v} etc., or you can search with @kbd{C-s}.

Tree-specific commands are bound to simple keystrokes, similar to
@code{Gnus}.  You can take a look at the key bindings by entering
@kbd{?} which calls @code{M-x describe-mode} in both tree and member
buffers.

@menu
* Source Display::		Viewing and finding a class declaration
* Member Display::		Showing members, switching to member buffers
* Go to Class::			Finding a class
* Quitting::			Discarding and burying the tree buffer
* File Name Display::		Showing file names in the tree
* Expanding and Collapsing::	Expanding and collapsing branches
* Tree Indentation::		Changing the tree indentation
* Killing Classes::		Removing class from the tree
* Saving a Tree::		Saving a modified tree
* Statistics::			Displaying class tree statistics
* Marking Classes::		Marking and unmarking classes
@end menu



@node Source Display, Member Display, Tree Buffers, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Viewing and Finding Class Declarations
@cindex viewing, class
Gerd Moellmann's avatar
Gerd Moellmann committed
478
@cindex finding a class
Gerd Moellmann's avatar
Gerd Moellmann committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
@cindex class declaration

You can view or find a class declaration when the cursor is on a class
name.

@table @kbd
@item SPC
This command views the class declaration if the database
contains informations about it.  If you don't parse the entire source
you are working on, some classes will only be known to exist but the
location of their declarations and definitions will not be known.@refill

@item RET
Works like @kbd{SPC}, except that it finds the class
declaration rather than viewing it, so that it is ready for
editing.@refill
@end table

The same functionality is available from the menu opened with
Richard M. Stallman's avatar
Richard M. Stallman committed
498
@kbd{Mouse-3} on the class name.
Gerd Moellmann's avatar
Gerd Moellmann committed
499 500 501 502 503 504 505




@node Member Display, Go to Class, Source Display, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Displaying Members
Gerd Moellmann's avatar
Gerd Moellmann committed
506
@cindex @samp{*Members*} buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
507
@cindex @samp{*Globals*}
Gerd Moellmann's avatar
Gerd Moellmann committed
508 509
@cindex freezing a member buffer
@cindex member lists, in tree buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

Ebrowse distinguishes six different kinds of members, each of
which is displayed as a separate @dfn{member list}: instance variables,
instance functions, static variables, static functions, friend
functions, and types.

Each of these lists can be displayed in a member buffer with a command
starting with @kbd{L} when the cursor is on a class name.  By default,
there is only one member buffer named @dfn{*Members*} that is reused
each time you display a member list---this has proven to be more
practical than to clutter up the buffer list with dozens of member
buffers.

If you want to display more than one member list at a time you can
@dfn{freeze} its member buffer. Freezing a member buffer prevents it
from being overwritten the next time you display a member list. You can
toggle this buffer status at any time.

Every member list display command in the tree buffer can be used with a
prefix argument (@kbd{C-u}).  Without a prefix argument, the command will
pop to a member buffer displaying the member list.  With prefix argument,
the member buffer will additionally be @dfn{frozen}.

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
534
@cindex instance member variables, list
Gerd Moellmann's avatar
Gerd Moellmann committed
535 536 537
@item L v
This command displays the list of instance member variables.

Gerd Moellmann's avatar
Gerd Moellmann committed
538
@cindex static variables, list
Gerd Moellmann's avatar
Gerd Moellmann committed
539 540 541
@item L V
Display the list of static variables.

Gerd Moellmann's avatar
Gerd Moellmann committed
542
@cindex friend functions, list
Gerd Moellmann's avatar
Gerd Moellmann committed
543 544 545 546 547
@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.

Gerd Moellmann's avatar
Gerd Moellmann committed
548
@cindex member functions, list
Gerd Moellmann's avatar
Gerd Moellmann committed
549 550 551
@item L f
Display the list of member functions.

Gerd Moellmann's avatar
Gerd Moellmann committed
552
@cindex static member functions, list
Gerd Moellmann's avatar
Gerd Moellmann committed
553 554 555
@item L F
Display the list of static member functions.

Gerd Moellmann's avatar
Gerd Moellmann committed
556
@cindex types, list
Gerd Moellmann's avatar
Gerd Moellmann committed
557 558 559 560 561
@item L t
Display a list of types.
@end table

These lists are also available from the class' context menu invoked with
Richard M. Stallman's avatar
Richard M. Stallman committed
562
@kbd{Mouse-3} on the class name.
Gerd Moellmann's avatar
Gerd Moellmann committed
563 564 565 566 567 568 569 570 571




@node Go to Class, Quitting, Member Display, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Finding a Class
@cindex locate class
@cindex expanding branches
Gerd Moellmann's avatar
Gerd Moellmann committed
572
@cindex class location
Gerd Moellmann's avatar
Gerd Moellmann committed
573 574

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
575
@cindex search for class
Gerd Moellmann's avatar
Gerd Moellmann committed
576 577 578 579 580 581
@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
Gerd Moellmann's avatar
Gerd Moellmann committed
582
recursively made visible.  (See also @ref{Expanding and
Gerd Moellmann's avatar
Gerd Moellmann committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
Collapsing}.)@refill

This function is also available from the tree buffer's context menu.

@item n
Repeat the last search done with @kbd{/}.  Each tree buffer has its own
local copy of the regular expression last searched in it.
@end table




@node Quitting, File Name Display, Go to Class, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Burying a Tree Buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
598
@cindex burying tree buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612

@table @kbd
@item q
Is a synonym for @kbd{M-x bury-buffer}.
@end table




@node File Name Display, Expanding and Collapsing, Quitting, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Displaying File Names

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
613
@cindex file names in tree buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
@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
class declaration are shown to the right of the class names.  If the
file is not known, the string @samp{unknown} is displayed.

This command is also provided in the tree buffer's context menu.

@item s
Display file names for the current line, or for the number of lines
given by a prefix argument. 
@end table

Here is an example of a tree buffer with file names displayed.

@example
|  Collection		(unknown)
|    IndexedCollection	(indexedcltn.h)
|      Array		(array.h)
|        FixedArray	(fixedarray.h)
|    Set		(set.h)
|    Dictionary		(dict.h)
@end example




@node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Expanding and Collapsing a Tree
Gerd Moellmann's avatar
Gerd Moellmann committed
644 645 646 647
@cindex expand tree branch
@cindex collapse tree branch
@cindex branches of class tree
@cindex class tree, collapse or expand
Gerd Moellmann's avatar
Gerd Moellmann committed
648 649 650 651

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
Gerd Moellmann's avatar
Gerd Moellmann committed
652
also @ref{Go to Class}.)@refill
Gerd Moellmann's avatar
Gerd Moellmann committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

Collapsed branches are indicated with an ellipsis following the class
name like in the example below.

@example
|  Collection
|    IndexedCollection...
|    Set
|    Dictionary
@end example

@table @kbd
@item -
This command collapses the branch of the tree starting at the class the
cursor is on. 

@item +
This command expands the branch of the tree starting at the class the
671
cursor is on.  Both commands for collapsing and expanding branches are
Gerd Moellmann's avatar
Gerd Moellmann committed
672 673 674 675 676 677 678 679 680 681 682 683 684
also available from the class' object menu.

@item *
This command expands all collapsed branches in the tree.
@end table




@node Tree Indentation, Killing Classes, Expanding and Collapsing, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Changing the Tree Indentation
@cindex tree indentation
Gerd Moellmann's avatar
Gerd Moellmann committed
685
@cindex indentation of the tree
Gerd Moellmann's avatar
Gerd Moellmann committed
686 687 688 689

@table @kbd
@item T w
This command reads a new indentation width from the minibuffer and
690
redisplays the tree buffer with the new indentation  It is also
Gerd Moellmann's avatar
Gerd Moellmann committed
691 692 693 694 695 696 697 698 699 700
available from the tree buffer's context menu.
@end table




@node Killing Classes, Saving a Tree, Tree Indentation, Tree Buffers
@comment  node-name,  next,  previous,  up
@section Removing Classes from the Tree
@cindex killing classes
Gerd Moellmann's avatar
Gerd Moellmann committed
701
@cindex class, remove from tree
Gerd Moellmann's avatar
Gerd Moellmann committed
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716

@table @kbd
@item C-k
This command removes the class the cursor is on and all its derived
classes from the tree.  The user is asked for confirmation before the
deletion is actually performed.
@end table




@node Saving a Tree, Statistics, Killing Classes, Tree Buffers
@comment  node-name,  next,  previous,  up
@comment node-name, next, previous, up
@section Saving a Tree
Gerd Moellmann's avatar
Gerd Moellmann committed
717 718 719
@cindex save tree to a file
@cindex tree, save to a file
@cindex class tree, save to a file
Gerd Moellmann's avatar
Gerd Moellmann committed
720 721 722

@table @kbd
@item C-x C-s
723 724
This command writes a class tree to the file from which it was read.
This is useful after classes have been deleted from a tree.
Gerd Moellmann's avatar
Gerd Moellmann committed
725 726 727 728 729 730 731 732 733 734

@item  C-x C-w
Writes the tree to a file whose name is read from the minibuffer.
@end table




@node     Statistics, Marking Classes, Saving a Tree, Tree Buffers
@comment  node-name,  next,        previous, up
Gerd Moellmann's avatar
Gerd Moellmann committed
735 736 737
@cindex statistics for a tree
@cindex tree statistics
@cindex class statistics
Gerd Moellmann's avatar
Gerd Moellmann committed
738 739 740 741 742 743 744 745 746 747 748 749 750 751

@table @kbd
@item x
Display statistics for the tree, like number of classes in it, number of
member functions, etc.  This command can also be found in the buffer's
context menu.
@end table




@node     Marking Classes, , Statistics, Tree Buffers
@comment  node-name,       next,       previous,      up
@cindex marking classes
Gerd Moellmann's avatar
Gerd Moellmann committed
752
@cindex operations on marked classes
Gerd Moellmann's avatar
Gerd Moellmann committed
753 754 755 756 757 758

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
Gerd Moellmann's avatar
Gerd Moellmann committed
759
@cindex toggle mark
Gerd Moellmann's avatar
Gerd Moellmann committed
760 761 762 763 764
@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. 

Gerd Moellmann's avatar
Gerd Moellmann committed
765
@cindex unmark all
Gerd Moellmann's avatar
Gerd Moellmann committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
@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
found in the buffer's object menu.
@end table

Marked classes are displayed with an @code{>} in column one of the tree
display, like in the following example

@example
|> Collection
|    IndexedCollection...
|>   Set
|    Dictionary
@end example




@c ****************************************************************
@c ***
@c ***                 MEMBER BUFFERS
@c ***
@c ****************************************************************

@node Member Buffers, Tags-like Functions, Tree Buffers, Top
@comment  node-name,       next,       previous,      up
@chapter Member Buffers
@cindex members
@cindex member buffer mode

Gerd Moellmann's avatar
Gerd Moellmann committed
797 798
@cindex class members, types
@cindex types of class members
Gerd Moellmann's avatar
Gerd Moellmann committed
799 800 801 802 803
@dfn{Member buffers} are used to operate on lists of members of a class.
Ebrowse distinguishes six kinds of lists:

@itemize @bullet
@item
804
Instance variables (normal member variables);
Gerd Moellmann's avatar
Gerd Moellmann committed
805
@item
806
Instance functions (normal member functions);
Gerd Moellmann's avatar
Gerd Moellmann committed
807
@item
808
Static variables;
Gerd Moellmann's avatar
Gerd Moellmann committed
809
@item
810
Static member functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
811
@item
812
Friend functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
@item
Types (@code{enum}s and @code{typedef}s defined with class scope.
Nested classes will be shown in the class tree like normal classes.
@end itemize

Like tree buffers, member buffers install their own major mode.  Also
like in tree buffers, menus are provided for certain areas in the
buffer: members, classes, and the buffer itself.

@menu
* Switching Member Lists::	Choosing which members to display
* Finding/Viewing::		Modifying source code
* Inherited Members::		Display of Inherited Members
* Searching Members::		Finding members in member buffer
* Switching to Tree::		Going back to the tree buffer
* Filters::			Selective member display
* Attributes::			Display of @code{virtual} etc.
* Long and Short Display::	Comprehensive and verbose display
* Regexp Display::		Showing matching regular expressions
* Switching Classes::		Displaying another class
* Killing/Burying::		Getting rid of the member buffer
* Column Width::		Display style
* Redisplay::			Redrawing the member list
* Getting Help::		How to get help for key bindings
@end menu




@node Switching Member Lists, Finding/Viewing, Member Buffers, Member Buffers
@comment  node-name,       next,       previous,      up
@section Switching Member Lists
Gerd Moellmann's avatar
Gerd Moellmann committed
845
@cindex member lists, in member buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
846 847 848 849 850 851
@cindex static members
@cindex friends
@cindex types
@cindex defines

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
852
@cindex next member list
Gerd Moellmann's avatar
Gerd Moellmann committed
853 854 855
@item L n
This command switches the member buffer display to the next member list.

Gerd Moellmann's avatar
Gerd Moellmann committed
856
@cindex previous member list
Gerd Moellmann's avatar
Gerd Moellmann committed
857 858 859 860 861 862 863
@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.

Gerd Moellmann's avatar
Gerd Moellmann committed
864
@cindex static 
Gerd Moellmann's avatar
Gerd Moellmann committed
865 866 867 868 869 870 871 872 873 874 875 876 877
@item L F
Switch to the list of static member functions.

@item L v
Switch to the list of member variables.

@item L V
Switch to the list of static member variables.

@item L d
Switch to the list of friends or defines.

@item L t
878
Switch to the list of types.
Gerd Moellmann's avatar
Gerd Moellmann committed
879 880 881 882 883 884 885 886 887 888 889 890 891
@end table

Both commands cycle through the member list.

Most of the commands are also available from the member buffer's 
context menu.




@node Finding/Viewing, Inherited Members, Switching Member Lists, Member Buffers
@comment  node-name,       next,       previous,      up
@section Finding and Viewing Member Source
Gerd Moellmann's avatar
Gerd Moellmann committed
892 893 894 895 896 897
@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
Gerd Moellmann's avatar
Gerd Moellmann committed
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

@table @kbd
@item RET
This command finds the definition of the member the cursor is on.
Finding involves roughly the same as the standard Emacs tags facility
does---loading the file and searching for a regular expression matching
the member.

@item f
This command finds the declaration of the member the cursor is on.

@item SPC
This is the same command as @kbd{RET}, but views the member definition
instead of finding the member's source file.

@item v
This is the same command as @kbd{f}, but views the member's declaration
instead of finding the file the declaration is in.
@end table

You can install a hook function to perform actions after a member or
class declaration or definition has been found, or when it is not found.

All the commands described above can also be found in the context menu
Richard M. Stallman's avatar
Richard M. Stallman committed
922
displayed when clicking @kbd{Mouse-2} on a member name.
Gerd Moellmann's avatar
Gerd Moellmann committed
923 924 925 926 927 928 929




@node Inherited Members, Searching Members, Finding/Viewing, Member Buffers
@comment  node-name,       next,       previous,      up
@section Display of Inherited Members
Gerd Moellmann's avatar
Gerd Moellmann committed
930 931
@cindex superclasses, members
@cindex base classes, members
Gerd Moellmann's avatar
Gerd Moellmann committed
932 933 934 935 936
@cindex inherited members

@table @kbd
@item D b
This command toggles the display of inherited members in the member
937
buffer.  This is also in the buffer's context menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
@end table




@node Searching Members, Switching to Tree, Inherited Members, Member Buffers
@comment  node-name,       next,       previous,      up
@section Searching Members
@cindex searching members

@table @kbd
@item G v
Position the cursor on a member whose name is read from the minibuffer;
only members shown in the current member buffer appear in the completion
list.

@item G m
Like the above command, but all members for the current class appear in
956
the completion list.  If necessary, the current member list is switched
Gerd Moellmann's avatar
Gerd Moellmann committed
957 958 959
to the one containing the member.

With a prefix argument (@kbd{C-u}), all members in the class tree,
960 961
i.e.@: all members the browser knows about appear in the completion
list.  The member display will be switched to the class and member list
Gerd Moellmann's avatar
Gerd Moellmann committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975
containing the member.

@item G n
Repeat the last member search.
@end table

Look into the buffer's context menu for a convenient way to do this with
a mouse.



@node Switching to Tree, Filters, Searching Members, Member Buffers
@comment  node-name,       next,       previous,      up
@section Switching to Tree Buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
976
@cindex tree buffer, switch to
Gerd Moellmann's avatar
Gerd Moellmann committed
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
@cindex buffer switching
@cindex switching buffers

@table @kbd
@item TAB
Pop up the tree buffer to which the member buffer belongs.

@item t
Do the same as @kbd{TAB} but also position the cursor on the class
displayed in the member buffer.
@end table




@node Filters, Attributes, Switching to Tree, Member Buffers
@comment  node-name,       next,       previous,      up
@section Filters
@cindex filters

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
998
@cindex @code{public} members
Gerd Moellmann's avatar
Gerd Moellmann committed
999 1000 1001 1002
@item F a u 
This command toggles the display of @code{public} members.  The
@samp{a} stands for `access'.

Gerd Moellmann's avatar
Gerd Moellmann committed
1003
@cindex @code{protected} members
Gerd Moellmann's avatar
Gerd Moellmann committed
1004 1005 1006
@item F a o
This command toggles the display of @code{protected} members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1007
@cindex @code{private} members
Gerd Moellmann's avatar
Gerd Moellmann committed
1008 1009 1010
@item F a i
This command toggles the display of @code{private} members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1011
@cindex @code{virtual} members
Gerd Moellmann's avatar
Gerd Moellmann committed
1012 1013 1014
@item F v
This command toggles the display of @code{virtual} members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1015
@cindex @code{inline} members
Gerd Moellmann's avatar
Gerd Moellmann committed
1016 1017 1018
@item F i
This command toggles the display of @code{inline} members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1019
@cindex @code{const} members
Gerd Moellmann's avatar
Gerd Moellmann committed
1020 1021 1022
@item F c
This command toggles the display of @code{const} members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1023
@cindex pure virtual members
Gerd Moellmann's avatar
Gerd Moellmann committed
1024 1025 1026
@item F p
This command toggles the display of pure virtual members.

Gerd Moellmann's avatar
Gerd Moellmann committed
1027
@cindex remove filters
Gerd Moellmann's avatar
Gerd Moellmann committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
@item F r
This command removes all filters.
@end table

These commands are also found in the buffer's context menu.




@node Attributes, Long and Short Display, Filters, Member Buffers
@comment  node-name,       next,       previous,      up
@section Displaying Member Attributes
@cindex attributes
Gerd Moellmann's avatar
Gerd Moellmann committed
1041
@cindex member attribute display
Gerd Moellmann's avatar
Gerd Moellmann committed
1042 1043 1044 1045 1046

@table @kbd
@item D a
Toggle the display of member attributes (default is on).

1047
The nine member attributes Ebrowse knows about are displayed
Gerd Moellmann's avatar
Gerd Moellmann committed
1048 1049 1050 1051 1052
as a list a single-characters flags enclosed in angle brackets in front
the of the member's name.  A @samp{-} at a given position means that
the attribute is false.  The list of attributes from left to right is

@table @samp
Gerd Moellmann's avatar
Gerd Moellmann committed
1053
@cindex @code{template} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1054 1055 1056
@item T
The member is a template.

Gerd Moellmann's avatar
Gerd Moellmann committed
1057
@cindex @code{extern "C"} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1058 1059 1060
@item C
The member is declared @code{extern "C"}.

Gerd Moellmann's avatar
Gerd Moellmann committed
1061
@cindex @code{virtual} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1062 1063 1064
@item v
Means the member is declared @code{virtual}.

Gerd Moellmann's avatar
Gerd Moellmann committed
1065
@cindex @code{inline}
Gerd Moellmann's avatar
Gerd Moellmann committed
1066 1067 1068
@item i
The member is declared @code{inline}.

Gerd Moellmann's avatar
Gerd Moellmann committed
1069
@cindex @code{const} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1070 1071 1072
@item c
The member is @code{const}.

Gerd Moellmann's avatar
Gerd Moellmann committed
1073
@cindex pure virtual function attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1074 1075 1076
@item 0
The member is a pure virtual function.

Gerd Moellmann's avatar
Gerd Moellmann committed
1077
@cindex @code{mutable} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1078 1079 1080
@item m
The member is declared @code{mutable}.

Gerd Moellmann's avatar
Gerd Moellmann committed
1081
@cindex @code{explicit} attribute
Gerd Moellmann's avatar
Gerd Moellmann committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
@item e
The member is declared @code{explicit}.

@item t
The member is a function with a throw list.
@end table
@end table

This command is also in the buffer's context menu.



@node Long and Short Display, Regexp Display, Attributes, Member Buffers
@comment  node-name,       next,       previous,      up
@section Long and Short Member Display
@cindex display form
@cindex long display
@cindex short display

@table @kbd
@item D l
This command toggles the member buffer between short and long display
form.  The short display form displays member names, only:

@example
| isEmpty        contains       hasMember      create
| storeSize      hash           isEqual        restoreGuts
| saveGuts
@end example

The long display shows one member per line with member name and regular
expressions matching the member (if known):

@example
| isEmpty               Bool isEmpty () const...
| hash                  unsigned hash () const...
| isEqual               int isEqual (...
@end example

Regular expressions will only be displayed when the Lisp database has
Gerd Moellmann's avatar
Gerd Moellmann committed
1122 1123
not been produced with the @command{ebrowse} option @samp{--no-regexps}.
@xref{Matching, --no-regexps, Regular Expressions}.
Gerd Moellmann's avatar
Gerd Moellmann committed
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
@end table




@node Regexp Display, Switching Classes, Long and Short Display, Member Buffers
@comment  node-name,       next,       previous,      up
@section Display of Regular Expressions
@cindex regular expression display

@table @kbd
@item D r
This command toggles the long display form from displaying the regular
expressions matching the member declarations to those expressions
matching member definitions.
@end table

Regular expressions will only be displayed when the Lisp database has
Gerd Moellmann's avatar
Gerd Moellmann committed
1142 1143
not been produced with the @command{ebrowse} option @samp{--no-regexps},
see @ref{Matching, --no-regexps, Regular Expressions}.
Gerd Moellmann's avatar
Gerd Moellmann committed
1144 1145 1146 1147 1148 1149 1150




@node Switching Classes, Killing/Burying, Regexp Display, Member Buffers
@comment  node-name,       next,       previous,      up
@section Displaying Another Class
Gerd Moellmann's avatar
Gerd Moellmann committed
1151 1152 1153 1154
@cindex base class, display
@cindex derived class, display
@cindex superclass, display
@cindex subclass, display
Gerd Moellmann's avatar
Gerd Moellmann committed
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
@cindex class display

@table @kbd
@item C c
This command lets you switch the member buffer to another class.  It
reads the name of the new class from the minibuffer with completion.

@item C b
This is the same command as @kbd{C c} but restricts the classes shown in
the completion list to immediate base classes, only.  If only one base
class exists, this one is immediately shown in the minibuffer.

@item C d
Same as @kbd{C b}, but for derived classes.

@item C p
Switch to the previous class in the class hierarchy on the same level as
the class currently displayed.

@item C n
Switch to the next sibling of the class in the class tree.
@end table




@node Killing/Burying, Column Width, Switching Classes, Member Buffers
@comment  node-name,       next,       previous,      up
@section Burying a Member Buffer
@cindex burying member buffers

@table @kbd
@item q
This command is a synonym for @kbd{M-x bury-buffer}.
@end table




@node Column Width, Redisplay, Killing/Burying, Member Buffers
@comment  node-name,       next,       previous,      up
@section Setting the Column Width
@cindex column width
@cindex member indentation
@cindex indentation, member

@table @kbd
@item D w
This command sets the column width depending on the display form used
(long or short display).
@end table




@node Redisplay, Getting Help, Column Width, Member Buffers
@comment  node-name,       next,       previous,      up
@section Forced Redisplay
Gerd Moellmann's avatar
Gerd Moellmann committed
1213
@cindex redisplay of member buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264

@table @kbd
@item C-l
This command forces a redisplay of the member buffer.  If the width
of the window displaying the member buffer is changed this command
redraws the member list with the appropriate column widths and number of
columns. 
@end table




@node Getting Help, , Redisplay, Member Buffers
@comment  node-name,  next,  previous,  up
@cindex help

@table @kbd
@item ?
This key is bound to @code{describe-mode}.
@end table




@comment **************************************************************
@comment ***		    TAGS LIKE FUNCTIONS
@comment **************************************************************

@node Tags-like Functions, Concept Index, Member Buffers, Top
@comment  node-name,       next,       previous,      up
@chapter Tags-like Functions

Ebrowse provides tags functions similar to those of the standard
Emacs Tags facility, but better suited to the needs of C++ programmers.

@menu
* Finding and Viewing::	Going to a member declaration/definition
* Position Stack::	Moving to previous locations
* Search & Replace::    Searching and replacing over class tree files
* Members in Files::    Listing all members in a given file
* Apropos::             Listing members matching a regular expression
* Symbol Completion::   Completing names while editing
* Member Buffer Display:: Quickly display a member buffer for some
                        identifier
@end menu



@node Finding and Viewing, Position Stack, Tags-like Functions, Tags-like Functions
@comment  node-name,       next,       previous,      up
@section Finding and Viewing Members
Gerd Moellmann's avatar
Gerd Moellmann committed
1265 1266
@cindex finding class member, in C++ source
@cindex viewing class member, in C++ source
Gerd Moellmann's avatar
Gerd Moellmann committed
1267
@cindex tags
Gerd Moellmann's avatar
Gerd Moellmann committed
1268 1269 1270 1271 1272 1273 1274
@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.
Gerd Moellmann's avatar
Gerd Moellmann committed
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286

@table @kbd
@item C-c b f
Find the definition of the member around point.  If you invoke this
function with a prefix argument, the declaration is searched.

If more than one class contains a member with the given name you can
select the class with completion.  If there is a scope declaration in
front of the member name, this class name is used as initial input for
the completion.

@item C-c b F
Gerd Moellmann's avatar
Gerd Moellmann committed
1287
Find the declaration of the member around point.
Gerd Moellmann's avatar
Gerd Moellmann committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333

@item C-c b v
View the definition of the member around point.

@item C-c b V
View the declaration of the member around point.

@item C-c b 4 f
Find a member's definition in another window.

@item C-c b 4 F
Find a member's declaration in another window.

@item C-c b 4 v
View a member's definition in another window.

@item C-c b 4 V
View a member's declaration in another window.

@item C-c b 5 f
Find a member's definition in another frame.

@item C-c b 5 F
Find a member's declaration in another frame.

@item C-c b 5 v
View a member's definition in another frame.

@item C-c b 5 V
View a member's declaration in another frame.
@end table



@node Position Stack, Search & Replace, Finding and Viewing, Tags-like Functions
@comment  node-name,       next,       previous,      up
@section The Position Stack
@cindex position stack

When jumping to a member declaration or definition with one of
Ebrowse's commands, the position from where you performed the
jump and the position where you jumped to are recorded in a
@dfn{position stack}.  There are several ways in which you can quickly
move to positions in the stack:@refill

@table @kbd
Gerd Moellmann's avatar
Gerd Moellmann committed
1334
@cindex return to original position
Gerd Moellmann's avatar
Gerd Moellmann committed
1335 1336 1337 1338 1339
@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