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