annotate man/ebrowse.texi @ 66171:1b475d6de39b

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