*** empty log message ***
[emacs.git] / man / speedbar.texi
blob8a7ad10701cb54fb2f474217d0738a8b7e18d40d
1 \input texinfo   @c -*-texinfo-*-
2 @c
3 @c $Id: speedbar.texi,v 1.6 2000/12/05 23:06:42 fx Exp $
4 @c
6 @c This file is part of GNU Emacs
8 @c GNU Emacs is free software; you can redistribute it and/or modify it
9 @c under the terms of the GNU General Public License as published by the
10 @c Free Software Foundation; either version 2 of the License, or (at
11 @c your option) any later version.
13 @c GNU Emacs is distributed in the hope that it will be useful, but
14 @c WITHOUT ANY WARRANTY; without even the implied warranty of
15 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 @c General Public License for more details.
18 @c You should have received a copy of the GNU General Public License
19 @c along with Emacs; see the file COPYING.  If not, write to the Free
20 @c Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22 @setfilename ../info/speedbar
23 @settitle Speedbar: File/Tag summarizing utility
25 @dircategory Emacs
26 @direntry
27 * Speedbar: (speedbar).        File/Tag summarizing utility.
28 @end direntry
29 @ifnottex
30 Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc.
32 Permission is granted to copy, distribute and/or modify this document
33 under the terms of the GNU Free Documentation License, Version 1.1 or
34 any later version published by the Free Software Foundation; with the
35 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
36 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
37 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
38 license is included in the section entitled ``GNU Free Documentation
39 License'' in the Emacs manual.
41 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
42 this GNU Manual, like GNU software.  Copies published by the Free
43 Software Foundation raise funds for GNU development.''
45 This document is part of a collection distributed under the GNU Free
46 Documentation License.  If you want to distribute this document
47 separately from the collection, you can do so by adding a copy of the
48 license to the document, as described in section 6 of the license.
49 @end ifnottex
51 @titlepage
52 @sp 10
53 @center @titlefont{Speedbar}
54 @sp 2
55 @center Eric Ludlam
56 @vskip 0pt plus 1 fill
57 @page
58 @vskip 0pt plus 1filll
59 Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc.
60 @sp 1
61 Permission is granted to copy, distribute and/or modify this document
62 under the terms of the GNU Free Documentation License, Version 1.1 or
63 any later version published by the Free Software Foundation; with the
64 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
65 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
66 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
67 license is included in the section entitled ``GNU Free Documentation
68 License'' in the Emacs manual.
70 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
71 this GNU Manual, like GNU software.  Copies published by the Free
72 Software Foundation raise funds for GNU development.''
74 This document is part of a collection distributed under the GNU Free
75 Documentation License.  If you want to distribute this document
76 separately from the collection, you can do so by adding a copy of the
77 license to the document, as described in section 6 of the license.
78 @end titlepage
80 @syncodeindex fn cp
82 @node Top, , , (dir)Top
83 @comment  node-name,  next,  previous,  up
85 Speedbar is a program for Emacs which can be used to summarize
86 information related to the current buffer.  Its original inspiration
87 is the `explorer' often used in modern development environments, office
88 packages, and web browsers.
90 Speedbar displays a narrow frame in which a tree view is shown.  This
91 tree view defaults to containing a list of files and directories.  Files
92 can be `expanded' to list tags inside. Directories can be expanded to
93 list the files within itself.  Each file or tag can be jumped to
94 immediately.
96 Speedbar expands upon `explorer' windows by maintaining context with the
97 user.  For example, when using the file view, the current buffer's file
98 is highlighted.  Speedbar also mimics the explorer windows by providing
99 multiple display modes.  These modes come in two flavors.  Major display
100 modes remain consistent across buffers, and minor display modes appear
101 only when a buffer of the applicable type is shown.  This allows
102 authors of other packages to provide speedbar summaries customized to
103 the needs of that mode.
105 Throughout this manual, activities are defined as `clicking on', or
106 `expanding' items.  Clicking means using using @kbd{Mouse-2} on a
107 button.  Expanding refers to clicking on an expansion button to display
108 an expanded summary of the entry the expansion button is
109 on.  @xref{Basic Navigation}.
111 @menu
112 * Introduction::     Basics of speedbar.
113 * Basic Navigation:: Basics of speedbar common between all modes.
114 * File Mode::        Summarizing files.
115 * Buffer Mode::      Summarizing buffers.
116 * Minor Modes::      Additional minor modes such as Info and RMAIL.
117 * Customizing::      Changing speedbar behavior.
118 * Extending::        Extend speedbar for your own project.
119 * Index::
120 @end menu
122 @node Introduction, Basic Navigation, , Top
123 @comment  node-name,  next,  previous,  up
124 @chapter Introduction
125 @cindex introduction
127 To start using speedbar use the command @kbd{M-x speedbar RET} or select
128 it from the Tools menu in versions of Emacs with speedbar installed by
129 default.  This command will open a new frame to summarize the local
130 files.  On X Window systems or on MS-Windows, speedbar's frame is twenty
131 characters wide, and will mimic the height of the frame from which it
132 was started.  It positions itself to the left or right of the frame you
133 started it from.
135 To use speedbar effectively, it is important to understand its
136 relationship with the frame you started it from.  This frame is the
137 @dfn{attached frame} which speedbar will use as a reference point.  Once
138 started, speedbar watches the contents of this frame, and attempts to
139 make its contents relevant to the buffer loaded into the attached
140 frame.  In addition, all requests made in speedbar that require the
141 display of another buffer will display in the attached frame.
143 When used in terminal mode, the new frame appears the same size as the
144 terminal.  Since it is not visible while working in the attached frame,
145 speedbar will save time by using the @dfn{slowbar mode}, where no tracking is
146 done until speedbar is requested to show itself (i.e., the speedbar's
147 frame becomes the selected frame).
149 @cindex @code{speedbar-get-focus}
150 The function to use when switching between frames using the keyboard is
151 @code{speedbar-get-focus}.  This function will toggle between frames, and
152 it's useful to bind it to a key in terminal mode.  @xref{Customizing}.
154 @node Basic Navigation, File Mode, Introduction, Top
155 @comment  node-name,  next,  previous,  up
156 @chapter Basic Navigation
158 Speedbar can display different types of data, and has several display
159 and behavior modes.  These modes all have a common behavior, menu
160 system, and look.  If one mode is learned, then the other modes are easy
161 to use.
163 @menu
164 * Basic Keybindings::
165 * Basic Visuals::
166 * Mouse Bindings::
167 * Displays Submenu::
168 @end menu
170 @node Basic Keybindings, Basic Visuals, Basic Navigation, Basic Navigation
171 @comment  node-name,  next,  previous,  up
172 @section Basic Keybindings
173 @cindex keybindings
175 These keybindings are common across all modes:
177 @table @kbd
178 @item delete, SPC
179 @cindex scrolling in speedbar
180 Scroll up and down one page.
181 @item Q
182 @cindex quitting speedbar
183 Quit speedbar, and kill the frame.
184 @item q
185 Quit speedbar, and hide the frame.  This makes it faster to restore the
186 speedbar frame, than if you press @kbd{Q}.
187 @item g
188 @cindex refresh speedbar display
189 Refresh whatever contents are in speedbar.
190 @item t
191 @cindex slowbar mode
192 Toggle speedbar to and from slowbar mode.  In slowbar mode, frame
193 tracking is not done.
194 @item n
195 @itemx p
196 @cindex navigation
197 Move, respectively, to the next or previous item.  A summary of that
198 item will be displayed in the attached frame's minibuffer.
199 @item M-n
200 @itemx M-p
201 Move to the next or previous item in a restricted fashion.  If a list is
202 open, the cursor will skip over it.  If the cursor is in an open list,
203 it will not leave it.
204 @item C-M-n
205 @itemx C-M-n
206 Move forwards and backwards across extended groups.  This lets you
207 quickly skip over all files, directories, or other common sub-items at
208 the same current depth.
209 @item C-x b
210 Switch buffers in the attached frame.
211 @end table
213 Speedbar can handle multiple modes.  Two are provided by default.
214 These modes are File mode, and Buffers mode.  There are accelerators to
215 switch into these different modes.
217 @cindex mode switching hotkeys
218 @table @kbd
219 @item b
220 Switch into Quick Buffers mode (@pxref{Buffer Mode}).  After one use, the
221 previous display mode is restored.
222 @item f
223 Switch into File mode.
224 @item r
225 Switch back to the previous mode.
226 @end table
228 Some modes provide groups, lists and tags.  @xref{Basic Visuals}.  When
229 these are available, some additional common bindings are available.
231 @cindex common keys
232 @table @kbd
233 @item RET
234 @itemx e
235 Edit/Open the current group or tag.  This behavior is dependent on the
236 mode.  In general, files or buffers are opened in the attached frame,
237 and directories or group nodes are expanded locally.
238 @item +
239 @itemx =
240 Expand the current group, displaying sub items.
241 When used with a prefix argument, any data that may have been cached is
242 flushed.  This is similar to a power click.  @xref{Mouse Bindings}.
243 @item -
244 Contract the current group, hiding sub items.
245 @end table
247 @node Basic Visuals, Mouse Bindings, Basic Keybindings, Basic Navigation
248 @comment  node-name,  next,  previous,  up
249 @section Basic Visuals
250 @cindex visuals
252 Speedbar has visual cues for indicating different types of data.  These
253 cues are used consistently across the different speedbar modes to make
254 them easier to interpret.
256 At a high level, in File mode, there are directory buttons, sub
257 directory buttons, file buttons, tag buttons, and expansion buttons.
258 This makes it easy to use the mouse to navigate a directory tree, and
259 quickly view files, or a summary of those files.
261 The most basic visual effect used to distinguish between these button
262 types is color and mouse highlighting.  Anything the mouse highlights
263 can be clicked on and is called a button (@pxref{Mouse Bindings}).
264 Anything not highlighted by the mouse will not be clickable.
266 Text in speedbar consists of four different types of data.  Knowing how
267 to read these textual elements will make it easier to navigate by
268 identifying the types of data available.
270 @subsubsection Groups
271 @cindex groups
273 Groups summarize information in a single line, and provide a high level
274 view of more complex systems, like a directory tree, or manual chapters.
276 Groups appear at different indentation levels, and are prefixed with a
277 @samp{+} in some sort of `box'.  The group name will summarize the
278 information within it, and the expansion box will display that
279 information inline.  In File mode, directories and files are `groups'
280 where the @samp{+} is surrounded by brackets like this:
282 @example
283 <+> include
284 <-> src
285  [+] foo.c
286 @end example
288 In this example, we see both open and closed directories, in addition to
289 a file.  The directories have a box consisting of angle brackets, and a
290 file uses square brackets.
292 In all modes, a group can be `edited' by pressing @kbd{RET}, meaning a
293 file will be opened, or a directory explicitly opened in speedbar.  A
294 group can be expanded or contracted using @kbd{+} or
295 @kbd{-}.  @xref{Basic Keybindings}.
297 Sometimes groups may have a @samp{?} in its indicator box.  This means
298 that it is a group type, but there are no contents, or no known way of
299 extracting contents of that group.
301 When a group has been expanded, the indicator button changes from
302 @samp{+} to @samp{-}.  This indicates that the contents are being shown.
303 Click the @samp{-} button to contract the group, or hide the contents
304 currently displayed.
306 @subsubsection Tags
307 @cindex tags
309 Tags are the leaf nodes of the tree system.  Tags are generally prefixed
310 with a simple character, such as @samp{>}.  Tags can only be jumped to using
311 @kbd{RET} or @kbd{e}.
313 @subsubsection Boolean Flags
315 Sometimes a group or tag is given a boolean flag.  These flags appear as
316 extra text characters at the end of the line.  File mode uses boolean
317 flags, such as a @samp{*} to indicate that a file has been checked out
318 of a versioning system.
320 For additional flags, see
321 @c Note to self, update these to sub-nodes which are more relevant.
322 @ref{File Mode}, and @ref{Version Control}.
324 @subsubsection Unadorned Text
326 Unadorned text generally starts in column 0, without any special symbols
327 prefixing them.  In Buffers mode different buffer groups are prefixed
328 with a description of what the following buffers are (Files, scratch
329 buffers, and invisible buffers.)
331 Unadorned text will generally be colorless, and not clickable.
333 @subsubsection Color Cues
335 Each type of Group, item indicator, and label is given a different
336 color.  The colors chosen are dependent on whether the background color
337 is light or dark.
338 Of important note is that the `current item', which may be a buffer or
339 file name, is highlighted red, and underlined.
341 Colors can be customized from the group @code{speedbar-faces}.  Some
342 modes, such as for Info, will use the Info colors instead of default
343 speedbar colors as an indication of what is currently being displayed.
345 The face naming convention mirrors the File display mode.  Modes which
346 do not use files will attempt to use the same colors on analogous
347 entries.
349 @node Mouse Bindings, Displays Submenu, Basic Visuals, Basic Navigation
350 @comment  node-name,  next,  previous,  up
351 @section Mouse Bindings
352 @cindex mouse bindings
354 The mouse has become a common information navigation tool.  Speedbar
355 will use the mouse to navigate file systems, buffer lists, and other
356 data.  The different textual cues provide buttons which can be clicked
357 on (@pxref{Basic Visuals}).  Anything that highlights can be clicked on
358 with the mouse, or affected by the menu.
360 The mouse bindings are:
362 @table @kbd
363 @item Mouse-1
364 Move cursor to that location.
365 @item Mouse-2
366 @itemx Double-Mouse-1
367 Activate the current button.  @kbd{Double-Mouse-1} is called a @dfn{double
368 click} on other platforms, and is useful for windows users with two
369 button mice.
370 @c Isn't it true that with two-button mice, the right button is Mouse-2?
371 @c On GNU/Linux, the right button is Mouse-3.
372 @item S-Mouse-2
373 @itemx S-Double-Mouse-1
374 @cindex power click
375 This has the same effect as @kbd{Mouse-2}, except it is called a power
376 click.  This means that if a group with an expansion button @samp{+} is
377 clicked, any caches are flushed, and subitems re-read.  If it is a name,
378 it will be opened in a new frame.
379 @item Mouse-3
380 Activate the speedbar menu.  The item selected affects the line clicked,
381 not the line where the cursor was.
382 @item Mouse-1 @r{(mode line)}
383 Activate the menu.  This affects the item the cursor is on before the
384 click, since the mouse was not clicked on anything.
385 @item C-Mouse-1
386 Buffers sub-menu.  The buffer in the attached frame is switched.
387 @end table
389 When the mouse moves over buttons in speedbar, details of that item
390 should be displayed in the minibuffer of the attached frame.  Sometimes
391 this can contain extra information such as file permissions, or tag
392 location.
394 @node Displays Submenu, , Mouse Bindings, Basic Navigation
395 @comment  node-name,  next,  previous,  up
396 @section Displays Submenu
397 @cindex displays submenu
399 You can display different data by using different display modes.  These
400 specialized modes make it easier to navigate the relevant pieces of
401 information, such as files and directories, or buffers.
403 In the main menu, found by clicking @kbd{Mouse-3}, there is a submenu
404 labeled @samp{Displays}.  This submenu lets you easily choose between
405 different display modes.
407 The contents are modes currently loaded into emacs.  By default, this
408 would include Files, Quick Buffers, and Buffers.  Other major display
409 modes such as Info are loaded separately.
411 @node File Mode, Buffer Mode, Basic Navigation, Top
412 @comment  node-name,  next,  previous,  up
413 @chapter File Mode
414 @cindex file mode
416 File mode displays a summary of your current directory.  You can display
417 files in the attached frame, or summarize the tags found in files.  You
418 can even see if a file is checked out of a version control system, or
419 has some associated object file.
421 Advanced behavior, like copying and renaming files, is also provided.
423 @menu
424 * Directory Display::   What the display means.
425 * Hidden Files::        How to display hidden files.
426 * File Keybindings::    Performing file operations.
427 @end menu
429 @node Directory Display, Hidden Files, File Mode, File Mode
430 @comment  node-name,  next,  previous,  up
431 @section Directory Display
432 @cindex directory display
434 There are three major sections in the display.  The first line or two is
435 the root directory speedbar is currently viewing.  You can jump to one
436 of the parent directories by clicking on the name of the directory you
437 wish to jump to.
439 Next, directories are listed.  A directory starts with the group
440 indicator button @samp{<+>}.  Clicking the directory name makes speedbar
441 load that directory as the root directory for its display.  Clicking the
442 @samp{<+>} button will list all directories and files beneath.
444 Next, files are listed.  Files start with the group indicator @samp{[+]}
445 or @samp{[?]}.  You can jump to a file in the attached frame by clicking
446 on the file name.  You can expand a file and look at its tags by
447 clicking on the @samp{[+]} symbol near the file name.
449 A typical session might look like this:
451 @example
452 ~/lisp/
453 <+> checkdoc
454 <+> eieio
455 <-> speedbar
456  [+] Makefile
457  [+] rpm.el #
458  [+] sb-gud.el #
459  [+] sb-info.el #
460  [+] sb-rmail.el #
461  [+] sb-w3.el
462  [-] speedbar.el *!
463   @{+@} Types
464   @{+@} Variables
465   @{+@} def (group)
466   @{+@} speedbar-
467  [+] speedbar.texi *
468 <+> testme
469 [+] align.el
470 [+] autoconf.el
471 @end example
473 In this example, you can see several directories.  The directory
474 @file{speedbar} has been opened inline.  Inside the directory
475 @file{speedbar}, the file @file{speedbar.el} has its tags exposed.
476 These tags are extensive, and they are summarized into tag groups.
478 Files get additional boolean flags associated with them.  Valid flags are:
480 @cindex file flags
481 @table @code
482 @item *
483 This file has been checked out of a version control
484 system.  @xref{Version Control}.
485 @cindex @code{speedbar-obj-alist}
486 @item #
487 This file has an up to date object file associated with it.  The
488 variable @code{speedbar-obj-alist} defines how speedbar determines this
489 value.
490 @item !
491 This file has an out of date object file associated with it.
492 @end table
494 A Tag group is prefixed with the symbol @samp{@{+@}}.  Clicking this
495 symbol will show all symbols that have been organized into that group.
496 Different types of files have unique tagging methods as defined by their
497 major mode.  Tags are generated with either the @code{imenu} package, or
498 through the @code{etags} interface.
500 Tag groups are defined in multiple ways which make it easier to find the
501 tag you are looking for.  Imenu keywords explicitly create groups, and
502 speedbar will automatically create groups if tag lists are too long.
504 In our example, Imenu created the groups @samp{Types} and
505 @samp{Variables}.  All remaining top-level symbols are then regrouped
506 based on the variable @code{speedbar-tag-hierarchy-method}.  The
507 subgroups @samp{def} and @samp{speedbar-} are groupings where the first
508 few characters of the given symbols are specified in the group name.
509 Some group names may say something like @samp{speedbar-t to speedbar-v},
510 indicating that all symbols which alphabetically fall between those
511 categories are included in that sub-group.  @xref{Tag Hierarchy Methods}.
513 @node Hidden Files, File Keybindings, Directory Display, File Mode
514 @comment  node-name,  next,  previous,  up
515 @section Hidden Files
516 @cindex hidden files
518 On Unix, a hidden file is a file whose name starts with a period.  They
519 are hidden from a regular directory listing because the user is not
520 generally interested in them.
522 In speedbar, a hidden file is a file which isn't very interesting and
523 might prove distracting to the user.  Any uninteresting files are
524 removed from the File display.  There are two levels of uninterest in
525 speedbar.  The first level of uninterest are files which have no
526 expansion method, or way of extracting tags.  The second level is any
527 file that matches the same pattern used for completion in
528 @code{find-file}.  This is derived from the variable
529 @code{completion-ignored-extensions}.
531 You can toggle the display of uninteresting files from the toggle menu
532 item @samp{Show All Files}.  This will display all level one hidden files.
533 These files will be shown with a @samp{?} indicator.  Level 2 hidden
534 files will still not be shown.
536 Object files fall into the category of level 2 hidden files.  You can
537 determine their presence by the @samp{#} and @samp{!} file indicators.
538 @xref{Directory Display}.
540 @node File Keybindings, , Hidden Files, File Mode
541 @comment  node-name,  next,  previous,  up
542 @section File Keybindings
543 @cindex file keybindings
545 File mode has keybindings permitting different file system operations
546 such as copy or rename.  These commands all operate on the @dfn{current
547 file}.  In this case, the current file is the file at point, or clicked
548 on when pulling up the menu.
550 @table @kbd
551 @item U
552 Move the entire speedbar display up one directory.
553 @item I
554 Display information in the minibuffer about this line.  This is the same
555 information shown when navigating with @kbd{n} and @kbd{p}, or moving
556 the mouse over an item.
557 @item B
558 Byte compile the Emacs Lisp file on this line.
559 @item L
560 Load the Emacs Lisp file on this line.  If a @file{.elc} file exists,
561 optionally load that.
562 @item C
563 Copy the current file to some other location.
564 @item R
565 Rename the current file, possibly moving it to some other location.
566 @item D
567 Delete the current file.
568 @item O
569 Delete the current file's object file.  Use the symbols @samp{#} and
570 @samp{!} to determine if there is an object file available.
571 @end table
573 One menu item toggles the display of all available files.  By default,
574 only files which Emacs understands, and knows how to convert into a tag
575 list, are shown.  By showing all files, additional files such as text files are
576 also displayed, but they are prefixed with the @samp{[?]} symbol.  This
577 means that it is a file, but Emacs doesn't know how to expand it.
579 @node Buffer Mode, Minor Modes, File Mode, Top
580 @comment  node-name,  next,  previous,  up
581 @chapter Buffer Mode
582 @cindex buffer mode
584 Buffer mode is very similar to File mode, except that instead of
585 tracking the current directory and all files available there, the
586 current list of Emacs buffers is shown.
588 These buffers can have their tags expanded in the same way as files,
589 and uses the same unknown file indicator (@pxref{File Mode}).
591 Buffer mode does not have file operation bindings, but the following
592 buffer specific keybindings are available:
594 @table @kbd
595 @item k
596 Kill this buffer.  Do not touch its file.
597 @item r
598 Revert this buffer, reloading from disk.
599 @end table
601 In addition to Buffer mode, there is also Quick Buffer mode.  In fact,
602 Quick Buffers is bound to the @kbd{b} key.  The only difference between
603 Buffers and Quick Buffers is that after one operation  is performed
604 which affects the attached frame, the display is immediately reverted to
605 the last displayed mode.
607 Thus, if you are in File mode, and you need quick access to a buffer,
608 press @kbd{b}, click on the buffer you want, and speedbar will revert
609 back to File mode.
611 @node Minor Modes, Customizing, Buffer Mode, Top
612 @comment  node-name,  next,  previous,  up
613 @chapter Minor Display Modes
614 @cindex minor display modes
616 For some buffers, a list of files and tags makes no sense.  This could
617 be because files are not currently in reference (such as web pages), or
618 that the files you might be interested have special properties (such as
619 email folders.)
621 In these cases, a minor display mode is needed.  A minor display mode
622 will override any major display mode currently being displayed for the
623 duration of the specialized buffer's use.  Minor display modes
624 will follow the general rules of their major counterparts in terms of
625 keybindings and visuals, but will have specialized behaviors.
627 @menu
628 * RMAIL::  Managing folders in speedbar
629 * Info::   Browsing topics in speedbar
630 * GDB::    Managing the current stack trace in speedbar
631 @end menu
633 @node RMAIL, Info, Minor Modes, Minor Modes
634 @comment  node-name,  next,  previous,  up
635 @section RMAIL
636 @cindex RMAIL
638 When using RMAIL, speedbar will display two sections.  The first is a
639 layer one reply button.  Clicking here will initialize a reply buffer
640 showing only this email address in the @samp{To:} field.
642 The second section lists all RMAIL folders in the same directory as your
643 main RMAIL folder.  The general rule is that RMAIL folders always appear
644 in all caps, or numbers.  It is possible to save mail in folders with
645 lower case letters, but there is no clean way of detecting such RMAIL folders
646 without opening them all.
648 Each folder can be visited by clicking the name.  You can move mail from
649 the current RMAIL folder into a different folder by clicking the
650 @samp{<M>} button.  The @samp{M} stands for Move.
652 In this way you can manage your existing RMAIL folders fairly easily
653 using the mouse.
655 @node Info, GDB, RMAIL, Minor Modes
656 @comment  node-name,  next,  previous,  up
657 @section Info
658 @cindex Info
660 When browsing Info files, all local relevant information is displayed in
661 the info buffer and a topical high-level view is provided in speedbar.
662 All top-level info nodes are shown in the speedbar frame, and can be
663 jumped to by clicking the name.
665 You can open these nodes with the @samp{[+]} button to see what sub-topics
666 are available.  Since these sub-topics are not examined until you click
667 the @samp{[+]} button, sometimes a @samp{[?]} will appear when you click on
668 a @samp{[+]}, indicating that there are no sub-topics.
670 @node GDB, , Info, Minor Modes
671 @comment  node-name,  next,  previous,  up
672 @section GDB
673 @cindex gdb
674 @cindex gud
676 If you are debugging an application with GDB in Emacs, speedbar can show
677 you the current stack when the current buffer is the @file{*gdb*}
678 buffer.  Usually, it will just report that there is no stack, but when
679 the application is stopped, the current stack will be shown.
681 You can click on any stack element and gdb will move to that stack
682 level.  You can then check variables local to that level at the GDB
683 prompt.
685 This mode has the unfortunate side-effect of breaking GDB's repeat
686 feature when you hit @kbd{RET} since your previous command is overridden
687 with a stack fetching command.
689 @node Customizing, Extending, Minor Modes, Top
690 @comment  node-name,  next,  previous,  up
691 @chapter Customizing
692 @cindex customizing
694 Speedbar is highly customizable, with a plethora of control elements.
695 Since speedbar is so visual and reduces so much information, this is an
696 important aspect of its behavior.
698 In general, there are three custom groups you can use to quickly modify
699 speedbar's behavior.
701 @table @code
702 @item speedbar
703 Basic speedbar behaviors.
704 @item speedbar-vc
705 Customizations regarding version control handling.
706 @item speedbar-faces
707 Customize speedbar's many colors and fonts.
708 @end table
710 @menu
711 * Frames and Faces::        Visible behaviors.
712 * Tag Hierarchy Methods::   Customizing how tags are displayed.
713 * Version Control::         Adding new VC detection modes.
714 * Hooks::                   The many hooks you can use.
715 @end menu
717 @node Frames and Faces, Tag Hierarchy Methods, Customizing, Customizing
718 @comment  node-name,  next,  previous,  up
719 @section Frames and Faces
720 @cindex faces
721 @cindex frame parameters
723 There are several faces speedbar generates to provide a consistent
724 color scheme across display types.  You can customize these faces using
725 your favorite method.  They are:
727 @table @asis
728 @cindex @code{speedbar-button-face}
729 @item speedbar-button-face
730 Face used on expand/contract buttons.
731 @cindex @code{speedbar-file-face}
732 @item speedbar-file-face
733 Face used on Files.  Should also be used on non-directory like nodes.
734 @cindex @code{speedbar-directory-face}
735 @item speedbar-directory-face
736 Face used for directories, or nodes which consist of groups of other nodes.
737 @cindex @code{speedbar-tag-face}
738 @item speedbar-tag-face
739 Face used for tags in a file, or for leaf items.
740 @cindex @code{speedbar-selected-face}
741 @item speedbar-selected-face
742 Face used to highlight the selected item.  This would be the current
743 file being edited.
744 @cindex @code{speedbar-highlight-face}
745 @item speedbar-highlight-face
746 Face used when the mouse passes over a button.
747 @end table
749 You can also customize speedbar's initial frame parameters.  How this is
750 accomplished is dependent on your platform being Emacs or XEmacs.
752 @cindex @code{speedbar-frame-parameters}, Emacs
753 In Emacs, change the alist @code{speedbar-frame-parameters}.  This
754 variable is used to set up initial details.  Height is also
755 automatically added when speedbar is created, though you can override
758 @cindex @code{speedbar-frame-plist}, XEmacs
759 In XEmacs, change the plist @code{speedbar-frame-plist}.  This is the
760 XEmacs way of doing the same thing.
762 @node Tag Hierarchy Methods, Version Control, Frames and Faces, Customizing
763 @comment  node-name,  next,  previous,  up
764 @section Tag Hierarchy Methods
765 @cindex tag hierarchy
766 @cindex tag groups
767 @cindex tag sorting
769 When listing tags within a file, it is possible to get an annoyingly
770 long list of entries.  Imenu (which generates the tag list in Emacs)
771 will group some classes of items automatically.   Even here, however,
772 some tag groups can be quite large.
774 @cindex @code{speedbar-tag-hierarchy-method}
775 To solve this problem, tags can be grouped into logical units through a
776 hierarchy processor.  The specific variable to use is
777 @code{speedbar-tag-hierarchy-method}.  There are several methods that
778 can be applied in any order.  They are:
780 @table @code
781 @cindex @code{speedbar-trim-words-tag-hierarchy}
782 @item speedbar-trim-words-tag-hierarchy
783 Find a common prefix for all elements of a group, and trim it off.
784 @cindex @code{speedbar-prefix-group-tag-hierarchy}
785 @item speedbar-prefix-group-tag-hierarchy
786 If a group is too large, place sets of tags into bins based on common
787 prefixes.
788 @cindex @code{speedbar-simple-group-tag-hierarchy}
789 @item speedbar-simple-group-tag-hierarchy
790 Take all items in the top level list not in a group, and stick them into
791 a @samp{Tags} group.
792 @cindex @code{speedbar-sort-tag-hierarchy}
793 @item speedbar-sort-tag-hierarchy
794 Sort all items, leaving groups on top.
795 @end table
797 You can also add your own functions to reorganize tags as you see fit.
799 Some other control variables are:
801 @table @code
802 @cindex @code{speedbar-tag-group-name-minimum-length}
803 @item speedbar-tag-group-name-minimum-length
804 Default value: 4.
806 The minimum length of a prefix group name before expanding.  Thus, if
807 the @code{speedbar-tag-hierarchy-method} includes
808 @code{speedbar-prefix-group-tag-hierarchy} and one such group's common
809 characters is less than this number of characters, then the group name
810 will be changed to the form of:
812 @example
813 worda to wordb
814 @end example
816 instead of just
818 @example
819 word
820 @end example
822 This way we won't get silly looking listings.
824 @cindex @code{speedbar-tag-split-minimum-length}
825 @item speedbar-tag-split-minimum-length
826 Default value: 20.
828 Minimum length before we stop trying to create sub-lists in tags.
829 This is used by all tag-hierarchy methods that break large lists into
830 sub-lists.
832 @cindex @code{speedbar-tag-regroup-maximum-length}
833 @item speedbar-tag-regroup-maximum-length
834 Default value: 10.
836 Maximum length of submenus that are regrouped.
837 If the regrouping option is used, then if two or more short subgroups
838 are next to each other, then they are combined until this number of
839 items is reached.
840 @end table
842 @node Version Control, Hooks, Tag Hierarchy Methods, Customizing
843 @comment  node-name,  next,  previous,  up
844 @section Version Control
845 @cindex version control
846 @cindex vc extensions
848 When using the file mode in speedbar, information regarding a version
849 control system adds small details to the display.  If a file is in a
850 version control system, and is ``checked out'' or ``locked'' locally, an
851 asterisk @samp{*} appears at the end of the file name.  In addition,
852 the directory name for Version Control systems are left out of the
853 speedbar display.
855 @cindex @code{speedbar-directory-unshown-regexp}
856 You can easily add new version control systems into speedbar's detection
857 scheme.  To make a directory ``disappear'' from the list, use the variable
858 @code{speedbar-directory-unshown-regexp}.
860 @cindex @code{speedbar-vc-path-enable-hook}
861 Next, you need to write entries for two hooks.  The first is
862 @code{speedbar-vc-path-enable-hook} which will enable a VC check in the
863 current directory for the group of files being checked.  Your hook
864 function should take one parameter (the directory to check) and return
865 @code{t} if your VC method is in control here.
867 @cindex @code{speedbar-vc-in-control-hook}
868 The second function is @code{speedbar-vc-in-control-hook}.  This hook
869 takes two parameters, the @var{path} of the file to check, and the
870 @var{file} name.  Return @code{t} if you want to have the asterisk
871 placed near this file.
873 @cindex @code{speedbar-vc-indicator}
874 Lastly, you can change the VC indicator using the variable
875 @code{speedbar-vc-indicator}, and specify a single character string.
877 @node Hooks, , Version Control, Customizing
878 @comment  node-name,  next,  previous,  up
879 @section Hooks
880 @cindex hooks
882 There are several hooks in speedbar allowing custom behaviors to be
883 added.  Available hooks are:
885 @table @code
886 @cindex @code{speedbar-visiting-file-hook}
887 @item speedbar-visiting-file-hook
888 Hooks run when speedbar visits a file in the selected frame.
889 @cindex @code{speedbar-visiting-tag-hook}
890 @item speedbar-visiting-tag-hook
891 Hooks run when speedbar visits a tag in the selected frame.
892 @cindex @code{speedbar-load-hook}
893 @item speedbar-load-hook
894 Hooks run when speedbar is loaded.
895 @cindex @code{speedbar-reconfigure-keymaps-hook}
896 @item speedbar-reconfigure-keymaps-hook
897 Hooks run when the keymaps are regenerated.  Keymaps are reconfigured
898 whenever modes change.  This will let you add custom keybindings.
899 @cindex @code{speedbar-before-popup-hook}
900 @item speedbar-before-popup-hook
901 Hooks called before popping up the speedbar frame.
902 New frames are often popped up when ``power clicking'' on an item to view
904 @cindex @code{speedbar-before-delete-hook}
905 @item speedbar-before-delete-hook
906 Hooks called before deleting or hiding the speedbar frame.
907 @cindex @code{speedbar-mode-hook}
908 @item speedbar-mode-hook
909 Hooks called after creating a speedbar buffer.
910 @cindex @code{speedbar-timer-hook}
911 @item speedbar-timer-hook
912 Hooks called after running the speedbar timer function.
913 @cindex @code{speedbar-scanner-reset-hook}
914 @item speedbar-scanner-reset-hook
915 Hook called whenever generic scanners are reset.
916 Set this to implement your own scanning or rescan safe functions with
917 state data.
918 @end table
920 @node Extending, Index, Customizing, Top
921 @comment  node-name,  next,  previous,  up
922 @chapter Extending
923 @cindex extending
925 Speedbar can run different types of Major display modes such as Files
926 (@pxref{File Mode}), and Buffers (@pxref{Buffer Mode}).  It can also manage
927 different minor display modes for use with buffers handling specialized
928 data.
930 These major and minor display modes are handled through an extension
931 system which permits specialized keymaps and menu extensions, in
932 addition to a unique rendering function.  You can also specify a wide
933 range of tagging functions.  The default uses @code{imenu}, but new
934 tagging methods can be easily added.  In this chapter, you will
935 learn how to write your own major or minor display modes, and how to
936 create specialized tagging functions.
938 @menu
939 * Minor Display Modes::    How to create a minor display mode.
940 * Major Display Modes::    How to create a major display mode.
941 * Tagging Extensions::     How to create your own tagging methods.
942 * Creating a display::     How to insert buttons and hierarchies.
943 @end menu
945 @node Minor Display Modes, Major Display Modes, Extending, Extending
946 @section Minor Display Modes
947 @cindex create minor display mode
949 A @dfn{minor display mode} is a mode useful when using a specific type of
950 buffer.  This mode might not be useful for any other kind of data or
951 mode, or may just be more useful that a files or buffers based mode when
952 working with a specialized mode.
954 Examples that already exist for speedbar include RMAIL, Info, and gdb.
955 These modes display information specific to the major mode shown in the
956 attached frame.
958 To enable a minor display mode in your favorite Major mode, follow these
959 steps.  The string @samp{@var{name}} is the name of the major mode being
960 augmented with speedbar.
962 @enumerate
963 @item
964 Create the keymap variable @code{@var{name}-speedbar-key-map}.
966 @item
967 Create a function, named whatever you like, which assigns values into your
968 keymap.  Use this command to create the keymap before assigning
969 bindings:
971 @smallexample
972     (setq @var{name}-speedbar-key-map (speedbar-make-specialized-keymap))
973 @end smallexample
975 This function creates a special keymap for use in speedbar.
977 @item
978 Call your install function, or assign it to a hook like this:
980 @smallexample
981 (if (featurep 'speedbar)
982     (@var{name}-install-speedbar-variables)
983   (add-hook 'speedbar-load-hook '@var{name}-install-speedbar-variables))
984 @end smallexample
986 @item
987 Create an easymenu compatible vector named
988 @code{@var{name}-speedbar-menu-items}.  This will be spliced into
989 speedbar's control menu.
991 @item
992 Create a function called @code{@var{name}-speedbar-buttons}.  This function
993 should take one variable, which is the buffer for which it will create
994 buttons.   At this time @code{(current-buffer)} will point to the
995 uncleared speedbar buffer.
996 @end enumerate
998 When writing @code{@var{name}-speedbar-buttons}, the first thing you will
999 want to do is execute a check to see if you need to re-create your
1000 display.  If it needs to be cleared, you need to erase the speedbar
1001 buffer yourself, and start drawing buttons.  @xref{Creating a display}.
1003 @node Major Display Modes, Tagging Extensions, Minor Display Modes, Extending
1004 @section Major Display Modes
1005 @cindex create major display mode
1007 Creating a @dfn{Major Display Mode} for speedbar requires authoring a keymap,
1008 an easy-menu segment, and writing several functions.  These items can be
1009 given any name, and are made the same way as in a minor display mode
1010 (@pxref{Minor Display Modes}).  Once this is done, these items need to be
1011 registered.
1013 Because this setup activity may or may not have speedbar available when
1014 it is being loaded, it is necessary to create an install function.  This
1015 function should create and initialize the keymap, and add your
1016 expansions into the customization tables.
1018 @cindex @code{speedbar-make-specialized-keymap}
1019 When creating the keymap, use the function
1020 @code{speedbar-make-specialized-keymap} instead of other keymap making
1021 functions.  This will provide you with the initial bindings needed.
1022 Some common speedbar functions you might want to bind are:
1024 @table @code
1025 @cindex @code{speedbar-edit-line}
1026 @item speedbar-edit-line
1027 Edit the item on the current line.
1028 @cindex @code{speedbar-expand-line}
1029 @item speedbar-expand-line
1030 Expand the item under the cursor.
1031 With a numeric argument (@kbd{C-u}), flush cached data before expanding.
1032 @cindex @code{speedbar-contract-line}
1033 @item speedbar-contract-line
1034 Contract the item under the cursor.
1035 @end table
1037 @cindex @code{speedbar-line-path}
1038 These function require that function @code{speedbar-line-path} be
1039 correctly overloaded to work.
1041 Next, register your extension like this;
1043 @example
1044   (speedbar-add-expansion-list '("MyExtension"
1045                                  MyExtension-speedbar-menu-items
1046                                  MyExtension-speedbar-key-map
1047                                  MyExtension-speedbar-buttons))
1048 @end example
1050 There are no limitations to the names you use.
1052 The first parameter is the string representing your display mode.
1053 The second parameter is a variable name containing an easymenu compatible
1054 menu definition.  This will be stuck in the middle of speedbar's menu.
1055 The third parameter is the variable name containing the keymap we
1056 discussed earlier.
1057 The last parameter is a function which draws buttons for your mode.
1058 This function must take two parameters.  The directory currently being
1059 displayed, and the depth at which you should start rendering buttons.
1060 The function will then draw (starting at the current cursor position)
1061 any buttons deemed necessary based on the input parameters.
1062 @xref{Creating a display}.
1064 Next, you need to register function overrides.  This may look something
1065 like this:
1067 @example
1068 (speedbar-add-mode-functions-list
1069  '("MYEXTENSION"
1070    (speedbar-item-info . MyExtension-speedbar-item-info)
1071    (speedbar-line-path . MyExtension-speedbar-line-path)))
1072 @end example
1074 The first element in the list is the name of you extension.  The second
1075 is an alist of functions to overload.  The function to overload is
1076 first, followed by what you want called instead.
1078 For @code{speedbar-line-path} your function should take an optional DEPTH
1079 parameter.  This is the starting depth for heavily indented lines.  If
1080 it is not provided, you can derive it like this:
1082 @example
1083 (save-match-data
1084   (if (not depth)
1085       (progn
1086         (beginning-of-line)
1087         (looking-at "^\\([0-9]+\\):")
1088         (setq depth (string-to-int (match-string 1)))))
1089 @end example
1091 @noindent
1092 where the depth is stored as invisible text at the beginning of each
1093 line.
1095 The path returned should be the full path name of the file associated
1096 with that line.  If the cursor is on a tag, then the file containing
1097 that tag should be returned.  This is critical for built in file based
1098 functions to work (meaning less code for you to write).  If your display
1099 does not deal in files, you do not need to overload this function.
1101 @cindex @code{speedbar-item-info}
1102 The function @code{speedbar-item-info}, however, is very likely to need
1103 overloading.  This function takes no parameters and must derive a text
1104 summary to display in the minibuffer.
1106 There are several helper functions you can use if you are going to use
1107 built in tagging.  These functions can be @code{or}ed since each one
1108 returns non-nil if it displays a message.  They are:
1110 @table @code
1111 @cindex @code{speedbar-item-info-file-helper}
1112 @item speedbar-item-info-file-helper
1113 This takes an optional @var{filename} parameter.  You can derive your own
1114 filename, or it will derive it using a (possibly overloaded) function
1115 @code{speedbar-line-file}.  It shows details about a file.
1116 @cindex @code{speedbar-item-info-tag-helper}
1117 @item speedbar-item-info-tag-helper
1118 If the current line is a tag, then display information about that tag,
1119 such as its parent file, and location.
1120 @end table
1122 Your custom function might look like this:
1124 @example
1125 (defun MyExtension-item-info ()
1126   "Display information about the current line."
1127   (or (speedbar-item-info-tag-helper)
1128       (message "Interesting detail.")))
1129 @end example
1131 Once you have done all this, speedbar will show an entry in the
1132 @samp{Displays} menu declaring that your extension is available.
1134 @node Tagging Extensions, Creating a display, Major Display Modes, Extending
1135 @section Tagging Extensions
1137 It is possible to create new methods for tagging files in speedbar.
1138 To do this, you need two basic functions, one function to fetch the
1139 tags from a buffer, the other to insert them below the filename.
1141 @defun my-fetch-dynamic-tags file
1142 Parse @var{file} for a list of tags.  Return the list, or @code{t} if there was
1143 an error.
1144 @end defun
1146 The non-error return value can be anything, as long as it can be
1147 inserted by its paired function:
1149 @defun my-insert-tag-list level lst
1150 Insert a list of tags @var{lst} started at indentation level
1151 @var{level}.  Creates buttons for each tag, and provides any other
1152 display information required.
1153 @end  defun
1155 @cindex @code{speedbar-create-tag-hierarchy}
1156 It is often useful to use @code{speedbar-create-tag-hierarchy} on your
1157 token list.  See that function's documentation for details on what it
1158 requires.
1160 @cindex @code{speedbar-dynamic-tags-function-list}
1161 Once these two functions are written, modify the variable
1162 @code{speedbar-dynamic-tags-function-list} to include your parser at the
1163 beginning, like this:
1165 @example
1166 (add-to-list 'speedbar-dynamic-tags-function-list
1167              '(my-fetch-dynamic-tags  . my-insert-tag-list))
1168 @end example
1170 If your parser is only good for a few types of files, make sure that it
1171 is either a buffer local modification, or that the tag generator returns
1172 @code{t} for non valid buffers.
1174 @node Creating a display, , Tagging Extensions, Extending
1175 @section Creating a display
1176 @cindex creating a display
1178 Rendering a display in speedbar is completely flexible.  When your
1179 button function is called, see @ref{Minor Display Modes}, and @ref{Major
1180 Display Modes}, you have control to @code{insert} anything you want.
1182 The conventions allow almost anything to be inserted, but several helper
1183 functions are provided to make it easy to create the standardized
1184 buttons.
1186 To understand the built in functions, each `button' in speedbar consists
1187 of four important pieces of data.  The text to be displayed, token
1188 data to be associated with the text, a function to call, and some face to
1189 display it in.
1191 When a function is provided, then that text becomes mouse activated,
1192 meaning the mouse will highlight the text.
1194 Additionally, for data which can form deep trees, each line is given a
1195 depth which indicates how far down the tree it is.  This information is
1196 stored in invisible text at the beginning of each line, and is used by
1197 the navigation commands.
1199 @defun speedbar-insert-button text face mouse function &optional token prevline
1200 This function inserts one button into the current location.
1201 @var{text} is the text to insert.  @var{face} is the face in which it
1202 will be displayed.   @var{mouse} is the face to display over the text
1203 when the mouse passes over it.  @var{function} is called whenever the
1204 user clicks on the text.
1206 The optional argument @var{token} is extra data to associated with the
1207 text.  Lastly @var{prevline} should be non-nil if you want this line to
1208 appear directly after the last button which was created instead of on
1209 the next line.
1210 @end defun
1212 @defun speedbar-make-tag-line exp-button-type exp-button-char exp-button-function exp-button-data tag-button tag-button-function tag-button-data tag-button-face depth
1214 Create a tag line with @var{exp-button-type} for the small expansion
1215 button.  This is the button that expands or contracts a node (if
1216 applicable), and @var{exp-button-char} the character in it (@samp{+},
1217 @samp{-}, @samp{?},
1218 etc).  @var{exp-button-function} is the function to call if it's clicked
1219 on.  Button types are @code{'bracket}, @code{'angle}, @code{'curly},
1220 @code{'expandtag}, @code{'statictag}, or nil.  @var{exp-button-data} is
1221 extra data attached to the text forming the expansion button.
1223 Next, @var{tag-button} is the text of the tag.
1224 @var{tag-button-function} is the function to call if clicked on, and
1225 @var{tag-button-data} is the data to attach to the text field (such a
1226 tag positioning, etc).  @var{tag-button-face} is a face used for this
1227 type of tag.
1229 Lastly, @var{depth} shows the depth of expansion.
1231 This function assumes that the cursor is in the speedbar window at the
1232 position to insert a new item, and that the new item will end with a CR.
1233 @end defun
1235 @defun speedbar-insert-generic-list level list expand-fun find-fun
1237 At @var{level}, (the current indentation level desired) insert a generic
1238 multi-level alist @var{list}.  Associations with lists get @samp{@{+@}}
1239 tags (to expand into more nodes) and those with positions or other data
1240 just get a @samp{>} as the indicator.  @samp{@{+@}} buttons will have the
1241 function @var{expand-fun} and the token is the @code{cdr} list.  The
1242 token name will have the function @var{find-fun} and not token.
1244 Each element of the list can have one of these forms:
1246 @table @code
1247 @item (@var{name} . marker-or-number)
1248 One tag at this level.
1249 @item (@var{name} (@var{name} . marker-or-number) (@var{name} . marker-or-number) ... )
1250 One group of tags.
1251 @item (@var{name} marker-or-number (@var{name} . marker-or-number) ... )
1252 One Group of tags where the group has a starting position.
1253 @end table
1255 When you use @code{speedbar-insert-generic-list}, there are some
1256 variables you can set buffer-locally to change the behavior.  The most
1257 obvious is @code{speedbar-tag-hierarchy-method}.
1258 @xref{Tag Hierarchy Methods}.
1260 @defvar speedbar-generic-list-group-expand-button-type
1261 This is the button type used for groups of tags, whether expanded
1262 or added in via a hierarchy method.  Two good values are
1263 @code{'curly} and @code{'expandtag}.  Curly is the default button, and
1264 @code{'expandtag} is useful if the groups also has a position.
1265 @end defvar
1267 @defvar speedbar-generic-list-tag-button-type
1268 This is the button type used for a single tag.
1269 Two good values are @code{nil} and @code{'statictag}.
1270 @code{nil} is the default, and @code{'statictag} has the same width as
1271 @code{'expandtag}.
1272 @end defvar
1274 @end defun
1276 @node Index, , Extending, Top
1277 @comment  node-name,  next,  previous,  up
1278 @unnumbered Concept Index
1279 @printindex cp
1281 @bye
1282 @c  LocalWords:  speedbar's xref Keybindings slowbar kbd subsubsection
1283 @c  LocalWords:  keybindings