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