annotate man/ebrowse.texi @ 30807:a788b278d7e6

Minor English and formatting changes.
author Dave Love <fx@gnu.org>
date Tue, 15 Aug 2000 13:14:45 +0000
parents 983e65f12610
children 0da9507401c4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
2
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
3 @comment %**start of header
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
4 @setfilename ../info/ebrowse
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5 @settitle A Class Browser for C++
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6 @setchapternewpage odd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
7 @syncodeindex fn cp
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
8 @comment %**end of header
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10 @ifinfo
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11 @direntry
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 * Ebrowse:: A C++ class browser for Emacs.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 @end direntry
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
14
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
15 This file documents Ebrowse, a C++ class browser for GNU Emacs.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
17 Copyright @copyright{} 1992--1999, 2000 Free Software Foundation, Inc.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
18
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
19 Permission is granted to make and distribute verbatim copies of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
20 this manual provided the copyright notice and this permission notice
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
21 are preserved on all copies.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
23 @ignore
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
24 Permission is granted to process this file through TeX and print the
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
25 results, provided the printed document carries copying permission
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26 notice identical to this one except for the removal of this paragraph
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
27 (this paragraph not being relevant to the printed manual).
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
28
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
29 @end ignore
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
30 Permission is granted to copy and distribute modified versions of this
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
31 manual under the conditions for verbatim copying, provided also that the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
32 sections entitled ``The GNU Manifesto'', ``Distribution'' and ``GNU
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 General Public License'' are included exactly as in the original, and
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34 provided that the entire resulting derived work is distributed under the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 terms of a permission notice identical to this one.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
36
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
37 Permission is granted to copy and distribute translations of this manual
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
38 into another language, under the above conditions for modified versions,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
39 except that the sections entitled ``The GNU Manifesto'',
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 ``Distribution'' and ``GNU General Public License'' may be included in a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41 translation approved by the Free Software Foundation instead of in the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 original English.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43 @end ifinfo
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
45 @iftex
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 @titlepage
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
47 @title Ebrowse User's Manual
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
48 @sp 4
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
49 @subtitle Ebrowse/Emacs 21
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
50 @sp 1
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
51 @subtitle May 2000
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
52 @sp 5
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
53 @author Gerd Moellmann
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
54 @page
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
56 @vskip 0pt plus 1filll
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
57 @noindent
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
58 Copyright @copyright{} 2000 Free Software Foundation, Inc.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
60 Permission is granted to make and distribute verbatim copies of
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
61 this manual provided the copyright notice and this permission notice
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
62 are preserved on all copies.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 @end titlepage
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
64 @page
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
65 @end iftex
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67 @node Top, Overview, (dir), (dir)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
68
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
69 @ifnottex
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 You can browse C++ class hierarchies from within Emacs by using
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 Ebrowse.
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
72 @end ifnottex
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74 @menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 * Overview:: What is it and now does it work?
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
76 * Generating browser files:: How to process C++ source files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77 * Loading a Tree:: How to start browsing
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78 * Tree Buffers:: Traversing class hierarchies
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79 * Member Buffers:: Looking at member information
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80 * Tags-like Functions:: Finding members from source files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 * Concept Index:: An entry for each concept defined
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 @end menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87 @node Overview, Generating browser files, Top, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 @chapter Introduction
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90 When working in software projects using C++, I frequently missed
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
91 software support for two things:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
93 @itemize @bullet
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
94 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95 When you get a new class library, or you have to work on source code you
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
96 haven't written yourself (or written sufficiently long ago), you need a
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
97 tool to let you navigate class hierarchies and investigate
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
98 features of the software. Without such a tool you often end up
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
99 @command{grep}ing through dozens or even hundreds of files.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
100
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
101 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
102 Once you are productive, it would be nice to have a tool that knows your
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 sources and can help you while you are editing source code. Imagine to
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
104 be able to jump to the definition of an identifier while you are
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
105 editing, or something that can complete long identifier names because it
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
106 knows what identifiers are defined in your program@dots{}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
107 @end itemize
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109 The design of Ebrowse reflects these two needs.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111 How does it work?
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
113 @cindex parser for C++ sources
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
114 A fast parser written in C is used to process C++ source files.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
115 The parser generates a data base containing information about classes,
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
116 members, global functions, defines, types etc.@: found in the sources.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
118 The second part of Ebrowse is a Lisp program. This program reads
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
119 the data base generated by the parser. It displays its contents in
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120 various forms and allows you to perform operations on it, or do
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
121 something with the help of the knowledge contained in the data base.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
122
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
123 @cindex major modes, of Ebrowse buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124 @dfn{Navigational} use of Ebrowse is centered around two
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125 types of buffers which define their own major modes:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
127 @cindex tree buffer
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
128 @dfn{Tree buffers} are used to view class hierarchies in tree form.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
129 They allow you to quickly find classes, find or view class declarations,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 perform operations like query replace on sets of your source files, and
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
131 finally tree buffers are used to produce the second buffer form---member
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
132 buffers. @xref{Tree Buffers}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
133
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
134 @cindex member buffer
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
135 Members are displayed in @dfn{member buffers}. Ebrowse
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
136 distinguishes between six different types of members; each type is
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
137 displayed as a member list of its own:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
138
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
139 @itemize @bullet
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
140 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
141 Instance member variables;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
142
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
144 Instance member functions;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
147 Static member variables;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
148
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
149 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
150 Static member functions;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
151
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
152 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
153 Friends/Defines. The list of defines is contained in the friends
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
154 list of the pseudo-class @samp{*Globals*};
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
155
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
156 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
157 Types (@code{enum}s, and @code{typedef}s defined with class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
158 scope).@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
159 @end itemize
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
160
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
161 You can switch member buffers from one list to another, or to another
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
162 class. You can include inherited members in the display, you can set
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
163 filters that remove categories of members from the display, and most
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
164 importantly you can find or view member declarations and definitions
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
165 with a keystroke. @xref{Member Buffers}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
166
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
167 These two buffer types and the commands they provide support the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
168 navigational use of the browser. The second form resembles Emacs' Tags
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
169 package for C and other procedural languages. Ebrowse's commands of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
170 this type are not confined to special buffers; they are most often used
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
171 while you are editing your source code.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
172
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
173 To list just a subset of what you can use the Tags part of Ebrowse for:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
174
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
175 @itemize @bullet
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
176 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
177 Jump to the definition or declaration of an identifier in your source
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
178 code, with an electric position stack that lets you easily navigate
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
179 back and forth.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
180
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
181 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
182 Complete identifiers in your source with a completion list containing
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
183 identifiers from your source code only.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
184
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
185 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
186 Perform search and query replace operations over some or all of your
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
187 source files.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
188
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
189 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
190 Show all identifiers matching a regular expression---and jump to one of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
191 them, if you like.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
192 @end itemize
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
193
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
194
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
195
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
196
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
197 @node Generating browser files, Loading a Tree, Overview, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
198 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
199 @chapter Processing Source Files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
200
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
201 @cindex @command{ebrowse}, the program
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
202 @cindex class data base creation
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
203 Before you can start browsing a class hierarchy, you must run the parser
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
204 @command{ebrowse} on your source files in order to generate a Lisp data
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
205 base describing your program.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
206
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
207 @cindex command line for @command{ebrowse}
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
208 The operation of @command{ebrowse} can be tailored with command line
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
209 options. Under normal circumstances it suffices to let the parser use
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
210 its default settings. If you want to do that, call it with a command
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
211 line like:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
212
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
213 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
214 ebrowse *.h *.cc
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
215 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
216
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
217 @noindent
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
218 or, if your shell doesn't allow all the file names to be specified on
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
219 the command line,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
220
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
221 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
222 ebrowse --files=@var{file}
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
223 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
224
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
225 @noindent
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
226 where @var{file} contains the names of the files to be parsed, one
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
227 per line.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
228
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
229 @findex --help
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
230 When invoked with option @samp{--help}, @command{ebrowse} prints a list of
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
231 available command line options.@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
232
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
233 @menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
234 * Input files:: Specifying which files to parse
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
235 * Output file:: Changing the output file name
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
236 * Structs and unions:: Omitting @code{struct}s and @code{union}s
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
237 * Matching:: Setting regular expression lengths
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
238 * Verbosity:: Getting feedback for lengthy operations
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
239 @end menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
240
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
241
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
242
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
243
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
244 @comment name, next, prev, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
245 @node Input files, Output file, Generating browser files, Generating browser files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
246 @section Specifying Input Files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
247
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
248 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
249 @cindex input files, for @command{ebrowse}
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
250 @item file
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
251 Each file name on the command line tells @command{ebrowse} to parse
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
252 that file.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
253
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
254 @cindex response files
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
255 @findex --files
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
256 @item --files=@var{file}
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
257 This command line switch specifies that @var{file} contains a list of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
258 file names to parse. Each line in @var{file} must contain one file
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
259 name. More than one option of this kind is allowed. You might, for
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
260 instance, want to use one file for header files, and another for source
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
261 files.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
262
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
263 @cindex standard input, specifying input files
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
264 @item standard input
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
265 When @command{ebrowse} finds no file names on the command line, and no
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
266 @samp{--file} option is specified, it reads file names from standard
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
267 input. This is sometimes convenient when @command{ebrowse} is used as part
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
268 of a command pipe.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
269
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
270 @findex --search-path
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
271 @item --search-path=@var{paths}
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
272 This option lets you specify search paths for your input files.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
273 @var{paths} is a list of directory names, separated from each other by a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
274 either a colon or a semicolon, depending on the operating system.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
275 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
276
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
277 @cindex header files
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
278 @cindex friend functions
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
279 It is generally a good idea to specify input files so that header files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
280 are parsed before source files. This facilitates the parser's work of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
281 properly identifying friend functions of a class.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
282
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
283
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
284
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
285 @comment name, next, prev, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
286 @node Output file, Structs and unions, Input files, Generating browser files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
287 @section Changing the Output File Name
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
288
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
289 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
290 @cindex output file name
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
291 @findex --output-file
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
292 @cindex @file{BROWSE} file
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
293 @item --output-file=@var{file}
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
294 This option instructs @command{ebrowse} to generate a Lisp data base with
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
295 name @var{file}. By default, the data base is named @file{BROWSE}, and
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
296 is written in the directory in which @command{ebrowse} is invoked.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
297
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
298 If you regularly use data base names different from the default, you
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
299 might want to add this to your init file:
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
300
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
301 @lisp
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
302 (add-to-list 'auto-mode-alist '(@var{NAME} . ebrowse-tree-mode))
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
303 @end lisp
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
304
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
305 @noindent
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
306 where @var{NAME} is the Lisp data base name you are using.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
307
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
308 @findex --append
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
309 @cindex appending output to class data base
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
310 @item --append
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
311 By default, each run of @command{ebrowse} erases the old contents of the
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
312 output file when writing to it. You can instruct @command{ebrowse} to
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
313 append its output to an existing file with this command line option.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
314 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
315
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
316
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
317
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
318
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
319 @comment name, next, prev, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
320 @node Structs and unions, Matching, Output file, Generating browser files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
321 @section Structs and Unions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
322 @cindex structs
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
323 @cindex unions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
324
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
325 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
326 @findex --no-structs-or-unions
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
327 @item --no-structs-or-unions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
328 This switch suppresses all classes in the data base declared as
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
329 @code{struct} or @code{union} in the output.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
330
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
331 This is mainly useful when you are converting an existing
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
332 C program to C++, and do not want to see the old C structs in a class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
333 tree.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
334 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
335
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
336
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
337
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
338
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
339 @comment name, next, prev, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
340 @node Matching, Verbosity, Structs and unions, Generating browser files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
341 @section Regular Expressions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
342
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
343 @cindex regular expressions, recording
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
344 The parser @command{ebrowse} normally writes regular expressions to its
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
345 output file that help the Lisp part of Ebrowse to find functions,
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
346 variables etc.@: in their source files.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
347
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
348 You can instruct @command{ebrowse} to omit these regular expressions by
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
349 calling it with the command line switch @samp{--no-regexps}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
350
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
351 When you do this, the Lisp part of Ebrowse tries to guess, from member
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
352 or class names, suitable regular expressions to locate that class or
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
353 member in source files. This works fine in most cases, but the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
354 automatic generation of regular expressions can be too weak if unusual
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
355 coding styles are used.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
356
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
357 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
358 @findex --no-regexps
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
359 @item --no-regexps
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
360 This option turns off regular expression recording.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
361
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
362 @findex --min-regexp-length
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
363 @cindex minimum regexp length for recording
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
364 @item --min-regexp-length=@var{n}
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
365 The number @var{n} following this option specifies the minimum length of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
366 the regular expressions recorded to match class and member declarations
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
367 and definitions. The default value is set at compilation time of
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
368 @command{ebrowse}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
369
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
370 The smaller the minimum length, the higher the probability that
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
371 Ebrowse will find a wrong match. The larger the value, the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
372 larger the output file and therefore the memory consumption once the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
373 file is read from Emacs.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
374
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
375 @findex --max-regexp-length
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
376 @cindex maximum regexp length for recording
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
377 @item --max-regexp-length=@var{n}
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
378 The number following this option specifies the maximum length of the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
379 regular expressions used to match class and member declarations and
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
380 definitions. The default value is set at compilation time of
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
381 @command{ebrowse}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
382
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
383 The larger the maximum length, the higher the probability that the
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
384 browser will find a correct match, but the larger the value the larger
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
385 the output file and therefore the memory consumption once the data is
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
386 read. As a second effect, the larger the regular expression, the higher
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
387 the probability that it will no longer match after editing the file.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
388 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
389
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
390
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
391
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
392
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
393 @node Verbosity, , Matching, Generating browser files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
394 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
395 @section Verbose Mode
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
396 @cindex verbose operation
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
397
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
398 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
399 @findex --verbose
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
400 @item --verbose
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
401 When this option is specified on the command line, @command{ebrowse} prints
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
402 a period for each file parsed, and it displays a @samp{+} for each
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
403 class written to the output file.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
404
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
405 @findex --very-verbose
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
406 @item --very-verbose
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
407 This option makes @command{ebrowse} print out the names of the files and
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
408 the names of the classes seen.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
409 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
410
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
411
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
412
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
413
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
414 @node Loading a Tree, Tree Buffers, Generating browser files, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
415 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
416 @chapter Starting to Browse
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
417 @cindex loading
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
418 @cindex browsing
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
419
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
420 You start browsing a class hierarchy parsed by @command{ebrowse} by just
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
421 finding the @file{BROWSE} file with @kbd{C-x C-f}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
422
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
423 An example of a tree buffer display is shown below.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
424
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
425 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
426 | Collection
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
427 | IndexedCollection
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
428 | Array
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
429 | FixedArray
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
430 | Set
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
431 | Dictionary
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
432 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
433
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
434 @cindex mouse highlight in tree buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
435 When you run Emacs on a display which supports colors and the mouse, you
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
436 will notice that that certain areas in the tree buffer are highlighted
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
437 when you move the mouse over them. This highlight marks mouse-sensitive
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
438 regions in the buffer. Please notice the help strings in the echo area
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
439 when the mouse moves over a sensitive region.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
440
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
441 @cindex context menu
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
442 A click with @kbd{mouse-3} on a mouse-sensitive region opens a context
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
443 menu. In addition to this, each buffer also has a buffer-specific menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
444 that is opened with a click with @kbd{mouse-3} somewhere in the buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
445 where no highlight is displayed.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
446
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
447
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
448
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
449 @comment ****************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
450 @comment ***
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
451 @comment *** TREE BUFFERS
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
452 @comment ***
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
453 @comment ****************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
454
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
455 @node Tree Buffers, Member Buffers, Loading a Tree, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
456 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
457 @chapter Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
458 @cindex tree buffer mode
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
459 @cindex class trees
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
460
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
461 Class trees are displayed in @dfn{tree buffers} which install their own
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
462 major mode. Most Emacs keys work in tree buffers in the usual way,
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
463 e.g.@: you can move around in the buffer with the usual @kbd{C-f},
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
464 @kbd{C-v} etc., or you can search with @kbd{C-s}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
465
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
466 Tree-specific commands are bound to simple keystrokes, similar to
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
467 @code{Gnus}. You can take a look at the key bindings by entering
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
468 @kbd{?} which calls @code{M-x describe-mode} in both tree and member
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
469 buffers.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
470
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
471 @menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
472 * Source Display:: Viewing and finding a class declaration
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
473 * Member Display:: Showing members, switching to member buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
474 * Go to Class:: Finding a class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
475 * Quitting:: Discarding and burying the tree buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
476 * File Name Display:: Showing file names in the tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
477 * Expanding and Collapsing:: Expanding and collapsing branches
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
478 * Tree Indentation:: Changing the tree indentation
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
479 * Killing Classes:: Removing class from the tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
480 * Saving a Tree:: Saving a modified tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
481 * Statistics:: Displaying class tree statistics
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
482 * Marking Classes:: Marking and unmarking classes
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
483 @end menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
484
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
485
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
486
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
487 @node Source Display, Member Display, Tree Buffers, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
488 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
489 @section Viewing and Finding Class Declarations
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
490 @cindex viewing, class
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
491 @cindex finding a class
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
492 @cindex class declaration
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
493
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
494 You can view or find a class declaration when the cursor is on a class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
495 name.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
496
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
497 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
498 @item SPC
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
499 This command views the class declaration if the database
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
500 contains informations about it. If you don't parse the entire source
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
501 you are working on, some classes will only be known to exist but the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
502 location of their declarations and definitions will not be known.@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
503
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
504 @item RET
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
505 Works like @kbd{SPC}, except that it finds the class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
506 declaration rather than viewing it, so that it is ready for
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
507 editing.@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
508 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
509
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
510 The same functionality is available from the menu opened with
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
511 @kbd{mouse-3} on the class name.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
512
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
513
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
514
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
515
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
516 @node Member Display, Go to Class, Source Display, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
517 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
518 @section Displaying Members
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
519 @cindex @samp{*Members*} buffer
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
520 @cindex @samp{*Globals*}
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
521 @cindex freezing a member buffer
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
522 @cindex member lists, in tree buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
523
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
524 Ebrowse distinguishes six different kinds of members, each of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
525 which is displayed as a separate @dfn{member list}: instance variables,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
526 instance functions, static variables, static functions, friend
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
527 functions, and types.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
528
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
529 Each of these lists can be displayed in a member buffer with a command
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
530 starting with @kbd{L} when the cursor is on a class name. By default,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
531 there is only one member buffer named @dfn{*Members*} that is reused
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
532 each time you display a member list---this has proven to be more
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
533 practical than to clutter up the buffer list with dozens of member
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
534 buffers.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
535
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
536 If you want to display more than one member list at a time you can
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
537 @dfn{freeze} its member buffer. Freezing a member buffer prevents it
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
538 from being overwritten the next time you display a member list. You can
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
539 toggle this buffer status at any time.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
540
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
541 Every member list display command in the tree buffer can be used with a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
542 prefix argument (@kbd{C-u}). Without a prefix argument, the command will
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
543 pop to a member buffer displaying the member list. With prefix argument,
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
544 the member buffer will additionally be @dfn{frozen}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
545
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
546 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
547 @cindex instance member variables, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
548 @item L v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
549 This command displays the list of instance member variables.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
550
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
551 @cindex static variables, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
552 @item L V
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
553 Display the list of static variables.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
554
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
555 @cindex friend functions, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
556 @item L d
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
557 Display the list of friend functions. This list is used for defines if
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
558 you are viewing the class @samp{*Globals*} which is a place holder for
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
559 global symbols.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
560
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
561 @cindex member functions, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
562 @item L f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
563 Display the list of member functions.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
564
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
565 @cindex static member functions, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
566 @item L F
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
567 Display the list of static member functions.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
568
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
569 @cindex types, list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
570 @item L t
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
571 Display a list of types.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
572 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
573
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
574 These lists are also available from the class' context menu invoked with
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
575 @kbd{mouse-3} on the class name.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
576
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
577
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
578
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
579
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
580 @node Go to Class, Quitting, Member Display, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
581 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
582 @section Finding a Class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
583 @cindex locate class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
584 @cindex expanding branches
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
585 @cindex class location
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
586
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
587 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
588 @cindex search for class
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
589 @item /
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
590 This command reads a class name from the minibuffer with completion and
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
591 positions the cursor on the class in the class tree.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
592
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
593 If the branch of the class tree containing the class searched for is
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
594 currently collapsed, the class itself and all its base classes are
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
595 recursively made visible. (See also @ref{Expanding and
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
596 Collapsing}.)@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
597
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
598 This function is also available from the tree buffer's context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
599
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
600 @item n
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
601 Repeat the last search done with @kbd{/}. Each tree buffer has its own
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
602 local copy of the regular expression last searched in it.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
603 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
604
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
605
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
606
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
607
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
608 @node Quitting, File Name Display, Go to Class, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
609 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
610 @section Burying a Tree Buffer
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
611 @cindex burying tree buffer
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
612
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
613 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
614 @item q
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
615 Is a synonym for @kbd{M-x bury-buffer}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
616 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
617
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
618
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
619
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
620
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
621 @node File Name Display, Expanding and Collapsing, Quitting, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
622 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
623 @section Displaying File Names
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
624
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
625 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
626 @cindex file names in tree buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
627 @item T f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
628 This command toggles the display of file names in a tree buffer. If
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
629 file name display is switched on, the names of the files containing the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
630 class declaration are shown to the right of the class names. If the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
631 file is not known, the string @samp{unknown} is displayed.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
632
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
633 This command is also provided in the tree buffer's context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
634
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
635 @item s
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
636 Display file names for the current line, or for the number of lines
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
637 given by a prefix argument.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
638 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
639
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
640 Here is an example of a tree buffer with file names displayed.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
641
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
642 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
643 | Collection (unknown)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
644 | IndexedCollection (indexedcltn.h)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
645 | Array (array.h)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
646 | FixedArray (fixedarray.h)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
647 | Set (set.h)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
648 | Dictionary (dict.h)
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
649 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
650
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
651
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
652
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
653
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
654 @node Expanding and Collapsing, Tree Indentation, File Name Display, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
655 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
656 @section Expanding and Collapsing a Tree
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
657 @cindex expand tree branch
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
658 @cindex collapse tree branch
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
659 @cindex branches of class tree
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
660 @cindex class tree, collapse or expand
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
661
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
662 You can expand and collapse parts of a tree to reduce the complexity of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
663 large class hierarchies. Expanding or collapsing branches of a tree has
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
664 no impact on the functionality of other commands, like @kbd{/}. (See
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
665 also @ref{Go to Class}.)@refill
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
666
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
667 Collapsed branches are indicated with an ellipsis following the class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
668 name like in the example below.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
669
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
670 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
671 | Collection
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
672 | IndexedCollection...
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
673 | Set
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
674 | Dictionary
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
675 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
676
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
677 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
678 @item -
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
679 This command collapses the branch of the tree starting at the class the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
680 cursor is on.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
681
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
682 @item +
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
683 This command expands the branch of the tree starting at the class the
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
684 cursor is on. Both commands for collapsing and expanding branches are
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
685 also available from the class' object menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
686
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
687 @item *
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
688 This command expands all collapsed branches in the tree.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
689 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
690
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
691
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
692
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
693
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
694 @node Tree Indentation, Killing Classes, Expanding and Collapsing, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
695 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
696 @section Changing the Tree Indentation
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
697 @cindex tree indentation
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
698 @cindex indentation of the tree
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
699
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
700 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
701 @item T w
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
702 This command reads a new indentation width from the minibuffer and
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
703 redisplays the tree buffer with the new indentation It is also
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
704 available from the tree buffer's context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
705 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
706
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
707
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
708
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
709
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
710 @node Killing Classes, Saving a Tree, Tree Indentation, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
711 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
712 @section Removing Classes from the Tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
713 @cindex killing classes
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
714 @cindex class, remove from tree
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
715
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
716 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
717 @item C-k
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
718 This command removes the class the cursor is on and all its derived
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
719 classes from the tree. The user is asked for confirmation before the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
720 deletion is actually performed.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
721 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
722
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
723
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
724
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
725
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
726 @node Saving a Tree, Statistics, Killing Classes, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
727 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
728 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
729 @section Saving a Tree
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
730 @cindex save tree to a file
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
731 @cindex tree, save to a file
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
732 @cindex class tree, save to a file
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
733
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
734 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
735 @item C-x C-s
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
736 This command writes a class tree to the file from which it was read.
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
737 This is useful after classes have been deleted from a tree.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
738
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
739 @item C-x C-w
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
740 Writes the tree to a file whose name is read from the minibuffer.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
741 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
742
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
743
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
744
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
745
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
746 @node Statistics, Marking Classes, Saving a Tree, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
747 @comment node-name, next, previous, up
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
748 @cindex statistics for a tree
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
749 @cindex tree statistics
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
750 @cindex class statistics
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
751
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
752 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
753 @item x
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
754 Display statistics for the tree, like number of classes in it, number of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
755 member functions, etc. This command can also be found in the buffer's
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
756 context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
757 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
758
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
759
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
760
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
761
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
762 @node Marking Classes, , Statistics, Tree Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
763 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
764 @cindex marking classes
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
765 @cindex operations on marked classes
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
766
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
767 Classes can be marked for operations similar to the standard Emacs
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
768 commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
769 also @xref{Tags-like Functions}.)@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
770
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
771 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
772 @cindex toggle mark
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
773 @item M t
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
774 Toggle the mark of the line point is in or for as many lines as given by
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
775 a prefix command. This command can also be found in the class' context
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
776 menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
777
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
778 @cindex unmark all
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
779 @item M a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
780 Unmark all classes. With prefix argument @kbd{C-u}, mark all classes in
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
781 the tree. Since this command operates on the whole buffer, it can also be
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
782 found in the buffer's object menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
783 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
784
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
785 Marked classes are displayed with an @code{>} in column one of the tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
786 display, like in the following example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
787
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
788 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
789 |> Collection
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
790 | IndexedCollection...
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
791 |> Set
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
792 | Dictionary
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
793 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
794
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
795
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
796
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
797
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
798 @c ****************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
799 @c ***
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
800 @c *** MEMBER BUFFERS
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
801 @c ***
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
802 @c ****************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
803
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
804 @node Member Buffers, Tags-like Functions, Tree Buffers, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
805 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
806 @chapter Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
807 @cindex members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
808 @cindex member buffer mode
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
809
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
810 @cindex class members, types
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
811 @cindex types of class members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
812 @dfn{Member buffers} are used to operate on lists of members of a class.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
813 Ebrowse distinguishes six kinds of lists:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
814
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
815 @itemize @bullet
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
816 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
817 Instance variables (normal member variables);
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
818 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
819 Instance functions (normal member functions);
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
820 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
821 Static variables;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
822 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
823 Static member functions;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
824 @item
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
825 Friend functions;
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
826 @item
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
827 Types (@code{enum}s and @code{typedef}s defined with class scope.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
828 Nested classes will be shown in the class tree like normal classes.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
829 @end itemize
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
830
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
831 Like tree buffers, member buffers install their own major mode. Also
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
832 like in tree buffers, menus are provided for certain areas in the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
833 buffer: members, classes, and the buffer itself.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
834
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
835 @menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
836 * Switching Member Lists:: Choosing which members to display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
837 * Finding/Viewing:: Modifying source code
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
838 * Inherited Members:: Display of Inherited Members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
839 * Searching Members:: Finding members in member buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
840 * Switching to Tree:: Going back to the tree buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
841 * Filters:: Selective member display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
842 * Attributes:: Display of @code{virtual} etc.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
843 * Long and Short Display:: Comprehensive and verbose display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
844 * Regexp Display:: Showing matching regular expressions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
845 * Switching Classes:: Displaying another class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
846 * Killing/Burying:: Getting rid of the member buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
847 * Column Width:: Display style
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
848 * Redisplay:: Redrawing the member list
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
849 * Getting Help:: How to get help for key bindings
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
850 @end menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
851
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
852
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
853
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
854
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
855 @node Switching Member Lists, Finding/Viewing, Member Buffers, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
856 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
857 @section Switching Member Lists
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
858 @cindex member lists, in member buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
859 @cindex static members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
860 @cindex friends
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
861 @cindex types
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
862 @cindex defines
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
863
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
864 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
865 @cindex next member list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
866 @item L n
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
867 This command switches the member buffer display to the next member list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
868
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
869 @cindex previous member list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
870 @item L p
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
871 This command switches the member buffer display to the previous member
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
872 list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
873
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
874 @item L f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
875 Switch to the list of member functions.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
876
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
877 @cindex static
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
878 @item L F
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
879 Switch to the list of static member functions.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
880
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
881 @item L v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
882 Switch to the list of member variables.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
883
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
884 @item L V
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
885 Switch to the list of static member variables.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
886
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
887 @item L d
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
888 Switch to the list of friends or defines.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
889
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
890 @item L t
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
891 Switch to the list of types.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
892 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
893
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
894 Both commands cycle through the member list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
895
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
896 Most of the commands are also available from the member buffer's
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
897 context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
898
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
899
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
900
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
901
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
902 @node Finding/Viewing, Inherited Members, Switching Member Lists, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
903 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
904 @section Finding and Viewing Member Source
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
905 @cindex finding members, in member buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
906 @cindex viewing members, in member buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
907 @cindex member definitions, in member buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
908 @cindex member declarations, in member buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
909 @cindex definition of a member, in member buffers
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
910 @cindex declaration of a member, in member buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
911
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
912 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
913 @item RET
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
914 This command finds the definition of the member the cursor is on.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
915 Finding involves roughly the same as the standard Emacs tags facility
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
916 does---loading the file and searching for a regular expression matching
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
917 the member.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
918
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
919 @item f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
920 This command finds the declaration of the member the cursor is on.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
921
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
922 @item SPC
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
923 This is the same command as @kbd{RET}, but views the member definition
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
924 instead of finding the member's source file.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
925
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
926 @item v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
927 This is the same command as @kbd{f}, but views the member's declaration
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
928 instead of finding the file the declaration is in.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
929 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
930
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
931 You can install a hook function to perform actions after a member or
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
932 class declaration or definition has been found, or when it is not found.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
933
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
934 All the commands described above can also be found in the context menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
935 displayed when clicking @kbd{mouse-2} on a member name.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
936
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
937
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
938
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
939
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
940 @node Inherited Members, Searching Members, Finding/Viewing, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
941 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
942 @section Display of Inherited Members
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
943 @cindex superclasses, members
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
944 @cindex base classes, members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
945 @cindex inherited members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
946
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
947 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
948 @item D b
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
949 This command toggles the display of inherited members in the member
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
950 buffer. This is also in the buffer's context menu.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
951 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
952
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
953
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
954
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
955
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
956 @node Searching Members, Switching to Tree, Inherited Members, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
957 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
958 @section Searching Members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
959 @cindex searching members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
960
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
961 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
962 @item G v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
963 Position the cursor on a member whose name is read from the minibuffer;
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
964 only members shown in the current member buffer appear in the completion
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
965 list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
966
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
967 @item G m
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
968 Like the above command, but all members for the current class appear in
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
969 the completion list. If necessary, the current member list is switched
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
970 to the one containing the member.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
971
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
972 With a prefix argument (@kbd{C-u}), all members in the class tree,
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
973 i.e.@: all members the browser knows about appear in the completion
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
974 list. The member display will be switched to the class and member list
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
975 containing the member.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
976
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
977 @item G n
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
978 Repeat the last member search.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
979 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
980
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
981 Look into the buffer's context menu for a convenient way to do this with
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
982 a mouse.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
983
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
984
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
985
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
986 @node Switching to Tree, Filters, Searching Members, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
987 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
988 @section Switching to Tree Buffer
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
989 @cindex tree buffer, switch to
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
990 @cindex buffer switching
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
991 @cindex switching buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
992
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
993 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
994 @item TAB
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
995 Pop up the tree buffer to which the member buffer belongs.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
996
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
997 @item t
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
998 Do the same as @kbd{TAB} but also position the cursor on the class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
999 displayed in the member buffer.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1000 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1001
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1002
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1003
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1004
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1005 @node Filters, Attributes, Switching to Tree, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1006 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1007 @section Filters
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1008 @cindex filters
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1009
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1010 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1011 @cindex @code{public} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1012 @item F a u
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1013 This command toggles the display of @code{public} members. The
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1014 @samp{a} stands for `access'.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1015
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1016 @cindex @code{protected} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1017 @item F a o
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1018 This command toggles the display of @code{protected} members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1019
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1020 @cindex @code{private} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1021 @item F a i
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1022 This command toggles the display of @code{private} members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1023
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1024 @cindex @code{virtual} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1025 @item F v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1026 This command toggles the display of @code{virtual} members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1027
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1028 @cindex @code{inline} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1029 @item F i
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1030 This command toggles the display of @code{inline} members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1031
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1032 @cindex @code{const} members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1033 @item F c
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1034 This command toggles the display of @code{const} members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1035
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1036 @cindex pure virtual members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1037 @item F p
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1038 This command toggles the display of pure virtual members.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1039
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1040 @cindex remove filters
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1041 @item F r
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1042 This command removes all filters.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1043 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1044
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1045 These commands are also found in the buffer's context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1046
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1047
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1048
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1049
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1050 @node Attributes, Long and Short Display, Filters, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1051 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1052 @section Displaying Member Attributes
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1053 @cindex attributes
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1054 @cindex member attribute display
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1055
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1056 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1057 @item D a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1058 Toggle the display of member attributes (default is on).
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1059
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1060 The nine member attributes Ebrowse knows about are are displayed
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1061 as a list a single-characters flags enclosed in angle brackets in front
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1062 the of the member's name. A @samp{-} at a given position means that
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1063 the attribute is false. The list of attributes from left to right is
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1064
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1065 @table @samp
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1066 @cindex @code{template} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1067 @item T
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1068 The member is a template.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1069
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1070 @cindex @code{extern "C"} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1071 @item C
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1072 The member is declared @code{extern "C"}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1073
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1074 @cindex @code{virtual} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1075 @item v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1076 Means the member is declared @code{virtual}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1077
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1078 @cindex @code{inline}
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1079 @item i
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1080 The member is declared @code{inline}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1081
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1082 @cindex @code{const} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1083 @item c
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1084 The member is @code{const}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1085
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1086 @cindex pure virtual function attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1087 @item 0
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1088 The member is a pure virtual function.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1089
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1090 @cindex @code{mutable} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1091 @item m
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1092 The member is declared @code{mutable}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1093
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1094 @cindex @code{explicit} attribute
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1095 @item e
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1096 The member is declared @code{explicit}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1097
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1098 @item t
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1099 The member is a function with a throw list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1100 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1101 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1102
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1103 This command is also in the buffer's context menu.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1104
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1105
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1106
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1107 @node Long and Short Display, Regexp Display, Attributes, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1108 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1109 @section Long and Short Member Display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1110 @cindex display form
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1111 @cindex long display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1112 @cindex short display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1113
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1114 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1115 @item D l
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1116 This command toggles the member buffer between short and long display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1117 form. The short display form displays member names, only:
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1118
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1119 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1120 | isEmpty contains hasMember create
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1121 | storeSize hash isEqual restoreGuts
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1122 | saveGuts
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1123 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1124
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1125 The long display shows one member per line with member name and regular
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1126 expressions matching the member (if known):
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1127
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1128 @example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1129 | isEmpty Bool isEmpty () const...
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1130 | hash unsigned hash () const...
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1131 | isEqual int isEqual (...
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1132 @end example
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1133
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1134 Regular expressions will only be displayed when the Lisp database has
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1135 not been produced with the @command{ebrowse} option @samp{--no-regexps}.
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1136 @xref{Matching, --no-regexps, Regular Expressions}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1137 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1138
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1139
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1140
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1141
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1142 @node Regexp Display, Switching Classes, Long and Short Display, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1143 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1144 @section Display of Regular Expressions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1145 @cindex regular expression display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1146
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1147 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1148 @item D r
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1149 This command toggles the long display form from displaying the regular
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1150 expressions matching the member declarations to those expressions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1151 matching member definitions.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1152 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1153
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1154 Regular expressions will only be displayed when the Lisp database has
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1155 not been produced with the @command{ebrowse} option @samp{--no-regexps},
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1156 see @ref{Matching, --no-regexps, Regular Expressions}.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1157
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1158
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1159
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1160
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1161 @node Switching Classes, Killing/Burying, Regexp Display, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1162 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1163 @section Displaying Another Class
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1164 @cindex base class, display
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1165 @cindex derived class, display
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1166 @cindex superclass, display
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1167 @cindex subclass, display
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1168 @cindex class display
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1169
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1170 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1171 @item C c
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1172 This command lets you switch the member buffer to another class. It
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1173 reads the name of the new class from the minibuffer with completion.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1174
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1175 @item C b
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1176 This is the same command as @kbd{C c} but restricts the classes shown in
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1177 the completion list to immediate base classes, only. If only one base
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1178 class exists, this one is immediately shown in the minibuffer.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1179
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1180 @item C d
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1181 Same as @kbd{C b}, but for derived classes.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1182
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1183 @item C p
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1184 Switch to the previous class in the class hierarchy on the same level as
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1185 the class currently displayed.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1186
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1187 @item C n
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1188 Switch to the next sibling of the class in the class tree.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1189 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1190
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1191
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1192
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1193
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1194 @node Killing/Burying, Column Width, Switching Classes, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1195 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1196 @section Burying a Member Buffer
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1197 @cindex burying member buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1198
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1199 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1200 @item q
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1201 This command is a synonym for @kbd{M-x bury-buffer}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1202 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1203
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1204
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1205
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1206
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1207 @node Column Width, Redisplay, Killing/Burying, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1208 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1209 @section Setting the Column Width
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1210 @cindex column width
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1211 @cindex member indentation
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1212 @cindex indentation, member
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1213
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1214 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1215 @item D w
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1216 This command sets the column width depending on the display form used
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1217 (long or short display).
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1218 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1219
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1220
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1221
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1222
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1223 @node Redisplay, Getting Help, Column Width, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1224 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1225 @section Forced Redisplay
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1226 @cindex redisplay of member buffers
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1227
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1228 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1229 @item C-l
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1230 This command forces a redisplay of the member buffer. If the width
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1231 of the window displaying the member buffer is changed this command
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1232 redraws the member list with the appropriate column widths and number of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1233 columns.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1234 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1235
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1236
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1237
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1238
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1239 @node Getting Help, , Redisplay, Member Buffers
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1240 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1241 @cindex help
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1242
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1243 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1244 @item ?
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1245 This key is bound to @code{describe-mode}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1246 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1247
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1248
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1249
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1250
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1251 @comment **************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1252 @comment *** TAGS LIKE FUNCTIONS
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1253 @comment **************************************************************
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1254
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1255 @node Tags-like Functions, Concept Index, Member Buffers, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1256 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1257 @chapter Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1258
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1259 Ebrowse provides tags functions similar to those of the standard
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1260 Emacs Tags facility, but better suited to the needs of C++ programmers.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1261
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1262 @menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1263 * Finding and Viewing:: Going to a member declaration/definition
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1264 * Position Stack:: Moving to previous locations
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1265 * Search & Replace:: Searching and replacing over class tree files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1266 * Members in Files:: Listing all members in a given file
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1267 * Apropos:: Listing members matching a regular expression
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1268 * Symbol Completion:: Completing names while editing
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1269 * Member Buffer Display:: Quickly display a member buffer for some
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1270 identifier
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1271 @end menu
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1272
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1273
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1274
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1275 @node Finding and Viewing, Position Stack, Tags-like Functions, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1276 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1277 @section Finding and Viewing Members
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1278 @cindex finding class member, in C++ source
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1279 @cindex viewing class member, in C++ source
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1280 @cindex tags
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1281 @cindex member definition, finding, in C++ source
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1282 @cindex member declaration, finding, in C++ source
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1283
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1284 The functions in this section are similar to those described in
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1285 @ref{Source Display}, and also in @ref{Finding/Viewing}, except that
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1286 they work in a C++ source buffer, not in member and tree buffers created
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1287 by Ebrowse.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1288
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1289 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1290 @item C-c b f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1291 Find the definition of the member around point. If you invoke this
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1292 function with a prefix argument, the declaration is searched.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1293
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1294 If more than one class contains a member with the given name you can
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1295 select the class with completion. If there is a scope declaration in
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1296 front of the member name, this class name is used as initial input for
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1297 the completion.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1298
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1299 @item C-c b F
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1300 Find the declaration of the member around point.
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1301
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1302 @item C-c b v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1303 View the definition of the member around point.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1304
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1305 @item C-c b V
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1306 View the declaration of the member around point.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1307
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1308 @item C-c b 4 f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1309 Find a member's definition in another window.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1310
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1311 @item C-c b 4 F
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1312 Find a member's declaration in another window.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1313
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1314 @item C-c b 4 v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1315 View a member's definition in another window.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1316
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1317 @item C-c b 4 V
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1318 View a member's declaration in another window.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1319
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1320 @item C-c b 5 f
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1321 Find a member's definition in another frame.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1322
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1323 @item C-c b 5 F
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1324 Find a member's declaration in another frame.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1325
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1326 @item C-c b 5 v
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1327 View a member's definition in another frame.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1328
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1329 @item C-c b 5 V
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1330 View a member's declaration in another frame.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1331 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1332
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1333
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1334
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1335 @node Position Stack, Search & Replace, Finding and Viewing, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1336 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1337 @section The Position Stack
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1338 @cindex position stack
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1339
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1340 When jumping to a member declaration or definition with one of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1341 Ebrowse's commands, the position from where you performed the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1342 jump and the position where you jumped to are recorded in a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1343 @dfn{position stack}. There are several ways in which you can quickly
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1344 move to positions in the stack:@refill
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1345
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1346 @table @kbd
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1347 @cindex return to original position
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1348 @item C-c b -
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1349 This command sets point to the previous position in the position stack.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1350 Directly after you performed a jump, this will put you back to the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1351 position where you came from.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1352
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
1353 The stack is not popped, i.e.@: you can always switch back and forth
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1354 between positions in the stack. To avoid letting the stack grow to
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1355 infinite size there is a maximum number of positions defined. When this
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1356 number is reached, older positions are discarded when new positions are
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1357 pushed on the stack.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1358
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1359 @item C-c b +
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1360 This command moves forward in the position stack, setting point to
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1361 the next position stored in the position stack.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1362
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1363 @item C-c b p
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1364 Displays an electric buffer showing all positions saved in the stack.
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
1365 You can select a position by pressing @kbd{SPC} in a line. You can
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1366 view a position with @kbd{v}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1367 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1368
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1369
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1370
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1371
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1372 @node Search & Replace, Members in Files, Position Stack, Tags-like Functions
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1373 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1374 @section Searching and Replacing
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1375 @cindex searching multiple C++ files
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1376 @cindex replacing in multiple C++ files
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1377 @cindex restart tags-operation
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1378
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1379 Ebrowse allows you to perform operations on all or a subset of the files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1380 mentioned in a class tree. When you invoke one of the following
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1381 functions and more than one class tree is loaded, you must choose a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1382 class tree to use from an electric tree menu. If the selected tree
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1383 contains marked classes, the following commands operate on the files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1384 mentioned in the marked classes only. Otherwise all files in the class
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1385 tree are used.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1386
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1387 @table @kbd
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1388 @item C-c b s
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1389 This function performs a regular expression search in the chosen set of
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1390 files.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1391
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1392 @item C-c b u
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1393 This command performs a search for calls of a given member which is
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1394 selected in the usual way with completion.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1395
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1396 @item C-c b %
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1397 Perform a query replace over the set of files.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1398
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1399 @item C-c b ,
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
1400 All three operations above stop when finding a match. You can restart
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1401 the operation with this command.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1402
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1403 @item C-c b n
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1404 This restarts the last tags operation with the next file in the list.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1405 @end table
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1406
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1407
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1408
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1409
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1410 @node Members in Files, Apropos, Search & Replace, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1411 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1412 @section Members in Files
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1413 @cindex files
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1414 @cindex members in file, listing
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1415 @cindex list class members in a file
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1416 @cindex file, members
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1417
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1418 The command @kbd{C-c b l}, lists all members in a given file. The file
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1419 name is read from the minibuffer with completion.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1420
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1421
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1422
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1423
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1424 @node Apropos, Symbol Completion, Members in Files, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1425 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1426 @section Member Apropos
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1427 @cindex apropos on class members
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1428 @cindex members, matching regexp
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1429
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1430 The command @kbd{C-c b a} can be used to display all members matching a
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1431 given regular expression. This command can be very useful if you
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1432 remember only part of a member name, and not its beginning.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1433
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1434 A special buffer is popped up containing all identifiers matching the
30807
a788b278d7e6 Minor English and formatting changes.
Dave Love <fx@gnu.org>
parents: 29713
diff changeset
1435 regular expression, and what kind of symbol it is (e.g.@: a member
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1436 function, or a type). You can then switch to this buffer, and use the
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1437 command @kbd{C-c b f}, for example, to jump to a specific member.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1438
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1439
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1440
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1441
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1442 @node Symbol Completion, Member Buffer Display, Apropos, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1443 @comment node-name, next, previous, up
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1444 @section Symbol Completion
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1445 @cindex completion
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1446 @cindex symbol completion
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1447
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1448 The command @kbd{C-c b TAB} completes the symbol in front of point.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1449
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1450
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1451
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1452
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1453 @node Member Buffer Display, , Symbol Completion, Tags-like Functions
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1454 @section Quick Member Display
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28867
diff changeset
1455 @cindex member buffer, for member at point
28867
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1456
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1457 You can quickly display a member buffer containing the member the cursor
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1458 in on with the command @kbd{C-c b m}.
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1459
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1460
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1461 @node Concept Index, , Tags-like Functions, Top
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1462 @unnumbered Concept Index
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1463 @printindex cp
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1464
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1465 @contents
48daf6eb57cd *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1466 @bye