annotate doc/misc/ebrowse.texi @ 110322:f2f4402bbb2e

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