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