1 ;;; speedbar --- quick access to files and tags in a frame
3 ;;; Copyright (C) 1996, 97, 98, 99 Free Software Foundation
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Keywords: file, tags, tools
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; The speedbar provides a frame in which files, and locations in
29 ;; files are displayed. These items can be clicked on with mouse-2
30 ;; in order to make the last active frame display that file location.
34 ;; Simply type `M-x speedbar', and it will be autoloaded for you.
36 ;; If you want to choose it from a menu, such as "Tools", you can do this:
38 ;; (define-key-after (lookup-key global-map [menu-bar tools])
39 ;; [speedbar] '("Speedbar" . speedbar-frame-mode) [calendar])
41 ;; If you want to access speedbar using only the keyboard, do this:
43 ;; (global-set-key [f4] 'speedbar-get-focus)
45 ;; This will let you hit f4 (or whatever key you choose) to jump
46 ;; focus to the speedbar frame. Pressing it again will bring you back
47 ;; to the attached frame. Pressing RET or e to jump to a file
48 ;; or tag will move you back to the attached frame. The command
49 ;; `speedbar-get-focus' will also create a speedbar frame if it does
52 ;; Customizing Speedbar:
54 ;; Once a speedbar frame is active, it takes advantage of idle time
55 ;; to keep its contents updated. The contents is usually a list of
56 ;; files in the directory of the currently active buffer. When
57 ;; applicable, tags in the active file can be expanded.
59 ;; To add new supported files types into speedbar, use the function
60 ;; `speedbar-add-supported-extension' If speedbar complains that the
61 ;; file type is not supported, that means there is no built in
62 ;; support from imenu, and the etags part wasn't set up correctly. You
63 ;; may add elements to `speedbar-supported-extension-expressions' as long
64 ;; as it is done before speedbar is loaded.
66 ;; To prevent speedbar from following you into certain directories
67 ;; use the function `speedbar-add-ignored-path-regexp' too add a new
68 ;; regular expression matching a type of path. You may add list
69 ;; elements to `speedbar-ignored-path-expressions' as long as it is
70 ;; done before speedbar is loaded.
72 ;; To add new file types to imenu, see the documentation in the
73 ;; file imenu.el that comes with Emacs. To add new file types which
74 ;; etags supports, you need to modify the variable
75 ;; `speedbar-fetch-etags-parse-list'.
77 ;; If the updates are going too slow for you, modify the variable
78 ;; `speedbar-update-speed' to a longer idle time before updates.
80 ;; If you navigate directories, you will probably notice that you
81 ;; will navigate to a directory which is eventually replaced after
82 ;; you go back to editing a file (unless you pull up a new file.)
83 ;; The delay time before this happens is in
84 ;; `speedbar-navigating-speed', and defaults to 10 seconds.
86 ;; To enable mouse tracking with information in the minibuffer of
87 ;; the attached frame, use the variable `speedbar-track-mouse-flag'.
89 ;; Tag layout can be modified through `speedbar-tag-hierarchy-method',
90 ;; which controls how tags are layed out. It is actually a list of
91 ;; functions that filter the data. The default groups large tag lists
92 ;; into sub-lists. A long flat list can be used instead if needed.
93 ;; Other filters could be easily added.
95 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
96 ;; well. Use the imenu keywords from tex-mode.el for better results.
98 ;;; Developing for speedbar
100 ;; Adding a speedbar specialized display mode:
102 ;; Speedbar can be configured to create a special display for certain
103 ;; modes that do not display tradition file/tag data. Rmail, Info,
104 ;; and the debugger are examples. These modes can, however, benefit
105 ;; from a speedbar style display in their own way.
107 ;; If your `major-mode' is `foo-mode', the only requirement is to
108 ;; create a function called `foo-speedbar-buttons' which takes one
109 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
110 ;; In `foo-speedbar-buttons' there are several functions that make
111 ;; building a speedbar display easy. See the documentation for
112 ;; `speedbar-with-writable' (needed because the buffer is usually
113 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
114 ;; `speedbar-insert-generic-list'. If you use
115 ;; `speedbar-insert-generic-list', also read the doc for
116 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
117 ;; The function `speedbar-with-attached-buffer' brings you back to the
118 ;; buffer speedbar is displaying for.
120 ;; For those functions that make buttons, the "function" should be a
121 ;; symbol that is the function to call when clicked on. The "token"
122 ;; is extra data you can pass along. The "function" must take three
123 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
124 ;; button clicked on. TOKEN is the data passed in when you create the
125 ;; button. INDENT is an indentation level, or 0. You can store
126 ;; indentation levels with `speedbar-make-tag-line' which creates a
127 ;; line with an expander (eg. [+]) and a text button.
129 ;; Some useful functions when writing expand functions, and click
130 ;; functions are `speedbar-change-expand-button-char',
131 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
132 ;; The variable `speedbar-power-click' is set to t in your functions
133 ;; when the user shift-clicks. This indications anything from
134 ;; refreshing cached data to making a buffer appear in a new frame.
136 ;; If you wish to add to the default speedbar menu for the case of
137 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
138 ;; should be a list compatible with the `easymenu' package. It will
139 ;; be spliced into the main menu. (Available with click-mouse-3). If
140 ;; you wish to have extra key bindings in your special mode, create a
141 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
142 ;; or `make-sparse-keymap', use the function
143 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
144 ;; speedbar's default bindings with low overhead.
146 ;; Adding a speedbar top-level display mode:
148 ;; Unlike the specialized modes, there are no name requirements,
149 ;; however the methods for writing a button display, menu, and keymap
150 ;; are the same. Once you create these items, you can call the
151 ;; function `speedbar-add-expansion-list'. It takes one parameter
152 ;; which is a list element of the form (NAME MENU KEYMAP &rest
153 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
154 ;; Displays menu item. MENU is a symbol containing the menu items to
155 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
156 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
158 ;; Another tweekable variable is `speedbar-stealthy-function-list'
159 ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
160 ;; name matching `speedbar-add-expansion-list'. (It does not need to
161 ;; exist.). This provides additional display info which might be
162 ;; time-consuming to calculate.
163 ;; Lastly, `speedbar-mode-functions-list' allows you to set special
164 ;; function overrides. At the moment very few functions are
165 ;; over ridable, but more will be added as the need is discovered.
168 ;; - More functions to create buttons and options
169 ;; - Timeout directories we haven't visited in a while.
170 ;; - Remeber tags when refreshing the display. (Refresh tags too?)
171 ;; - More 'special mode support.
176 (defvar speedbar-xemacsp
(string-match "XEmacs" emacs-version
)
177 "Non-nil if we are running in the XEmacs environment.")
178 (defvar speedbar-xemacs20p
(and speedbar-xemacsp
179 (= emacs-major-version
20)))
181 ;; customization stuff
182 (defgroup speedbar nil
183 "File and tag browser frame."
189 (defgroup speedbar-faces nil
190 "Faces used in speedbar."
195 (defgroup speedbar-vc nil
196 "Version control display in speedbar."
201 (defvar speedbar-initial-expansion-mode-alist
202 '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
203 speedbar-buffer-buttons
)
204 ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
205 speedbar-buffer-buttons-temp
)
206 ;; Files last, means first in the Displays menu
207 ("files" speedbar-easymenu-definition-special speedbar-file-key-map
208 speedbar-directory-buttons speedbar-default-directory-list
)
210 "List of named expansion elements for filling the speedbar frame.
211 These expansion lists are only valid for regular files. Special modes
212 still get to override this list on a mode-by-mode basis. This list of
213 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
214 representing the types of things to be displayed. MENU is an easymenu
215 structure used when in this mode. KEYMAP is a local keymap to install
216 over the regular speedbar keymap. FN1 ... are functions that will be
217 called in order. These functions will always get the default
218 directory to use passed in as the first parameter, and a 0 as the
219 second parameter. The 0 indicates the uppermost indentation level.
220 They must assume that the cursor is at the position where they start
223 (defvar speedbar-initial-expansion-list-name
"files"
224 "A symbol name representing the expansion list to use.
225 The expansion list `speedbar-initial-expansion-mode-alist' contains
226 the names and associated functions to use for buttons in speedbar.")
228 (defvar speedbar-previously-used-expansion-list-name
"files"
229 "Save the last expansion list method.
230 This is used for returning to a previous expansion list method when
231 the user is done with the current expansion list.")
233 (defvar speedbar-stealthy-function-list
235 speedbar-update-current-file speedbar-check-vc speedbar-check-objects
)
237 "List of functions to periodically call stealthily.
238 This list is of the form:
239 '( (\"NAME\" FUNCTION ...)
241 where NAME is the name of the major display mode these functions are
242 for, and the remaining elements FUNCTION are functions to call in order.
243 Each function must return nil if interrupted, or t if completed.
244 Stealthy functions which have a single operation should always return
245 t. Functions which take a long time should maintain a state (where
246 they are in their speedbar related calculations) and permit
247 interruption. See `speedbar-check-vc' as a good example.")
249 (defvar speedbar-mode-functions-list
250 '(("files" (speedbar-item-info . speedbar-files-item-info
)
251 (speedbar-line-path . speedbar-files-line-path
))
252 ("buffers" (speedbar-item-info . speedbar-buffers-item-info
)
253 (speedbar-line-path . speedbar-buffers-line-path
))
254 ("quick buffers" (speedbar-item-info . speedbar-buffers-item-info
)
255 (speedbar-line-path . speedbar-buffers-line-path
))
257 "List of function tables to use for different major display modes.
258 It is not necessary to define any functions for a specialized mode.
259 This just provides a simple way of adding lots of customizations.
260 Each sublist is of the form:
261 (\"NAME\" (FUNCTIONSYMBOL . REPLACEMENTFUNCTION) ...)
262 Where NAME is the name of the specialized mode. The rest of the list
263 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
264 of a function you would like to replace, and REPLACEMENTFUNCTION,
265 which is a function you can call instead. Not all functions can be
266 replaced this way. Replaceable functions must provide that
267 functionality individually.")
269 (defcustom speedbar-mode-specific-contents-flag t
270 "*Non-nil means speedbar will show special mode contents.
271 This permits some modes to create customized contents for the speedbar
276 (defvar speedbar-special-mode-expansion-list nil
277 "Default function list for creating specialized button lists.
278 This list is set by modes that wish to have special speedbar displays.
279 The list is of function names. Each function is called with one
280 parameter BUFFER, the originating buffer. The current buffer is the
283 (defvar speedbar-special-mode-key-map nil
284 "Default keymap used when identifying a specialized display mode.
285 This keymap is local to each buffer that wants to define special keybindings
286 effective when it's display is shown.")
288 (defcustom speedbar-visiting-file-hook nil
289 "Hooks run when speedbar visits a file in the selected frame."
293 (defcustom speedbar-visiting-tag-hook nil
294 "Hooks run when speedbar visits a tag in the selected frame."
298 (defcustom speedbar-load-hook nil
299 "Hooks run when speedbar is loaded."
303 (defcustom speedbar-show-unknown-files nil
304 "*Non-nil show files we can't expand with a ? in the expand button.
305 nil means don't show the file in the list."
309 (defcustom speedbar-update-speed
311 (if speedbar-xemacs20p
312 2 ; 1 is too obrusive in XEmacs
313 5) ; when no idleness, need long delay
315 "*Idle time in seconds needed before speedbar will update itself.
316 Updates occur to allow speedbar to display directory information
317 relevant to the buffer you are currently editing."
321 ;; When I moved to a repeating timer, I had the horrible missfortune
322 ;; of loosing the ability for adaptive speed choice. This update
323 ;; speed currently causes long delays when it should have been turned off.
324 (defcustom speedbar-navigating-speed speedbar-update-speed
325 "*Idle time to wait after navigation commands in speedbar are executed.
326 Navigation commands included expanding/contracting nodes, and moving
327 between different directories."
331 (defcustom speedbar-frame-parameters
'((minibuffer . nil
)
336 "*Parameters to use when creating the speedbar frame in Emacs.
337 Parameters not listed here which will be added automatically are
338 `height' which will be initialized to the height of the frame speedbar
341 :type
'(repeat (sexp :tag
"Parameter:")))
343 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
344 (defcustom speedbar-frame-plist
345 '(minibuffer nil width
20 border-width
0
346 internal-border-width
0 unsplittable t
347 default-toolbar-visible-p nil has-modeline-p nil
348 menubar-visible-p nil
)
349 "*Parameters to use when creating the speedbar frame in XEmacs.
350 Parameters not listed here which will be added automatically are
351 `height' which will be initialized to the height of the frame speedbar
354 :type
'(repeat (group :inline t
355 (symbol :tag
"Property")
356 (sexp :tag
"Value"))))
358 (defcustom speedbar-use-imenu-flag
(stringp (locate-library "imenu"))
359 "*Non-nil means use imenu for file parsing. nil to use etags.
360 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
361 use etags instead. Etags support is not as robust as imenu support."
366 (defcustom speedbar-track-mouse-flag t
367 "*Non-nil means to display info about the line under the mouse."
371 (defcustom speedbar-sort-tags nil
372 "*If Non-nil, sort tags in the speedbar display. *Obsolete*."
376 (defcustom speedbar-tag-hierarchy-method
377 '(prefix-group trim-words
)
378 "*List of methods which speedbar will use to organize tags into groups.
379 Groups are defined as expandable meta-tags. Imenu supports such
380 things in some languages, such as separating variables from functions.
381 Available methods are:
382 sort - Sort tags. (sometimes unnecessary)
383 trim-words - Trim all tags by a common prefix, broken @ word sections.
384 prefix-group - Try to guess groups by prefix.
385 simple-group - If imenu already returned some meta groups, stick all
386 tags that are not in a group into a sub-group."
390 (const :tag
"Sort the tags." sort
)
391 (const :tag
"Trim words to common prefix." trim-words
)
392 (const :tag
"Create groups from common prefixes." prefix-group
)
393 (const :tag
"Group loose tags into their own group." simple-group
))
396 (defcustom speedbar-tag-group-name-minimum-length
4
397 "*The minimum length of a prefix group name before expanding.
398 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
399 and one such groups common characters is less than this number of
400 characters, then the group name will be changed to the form of:
404 This way we won't get silly looking listings."
408 (defcustom speedbar-tag-split-minimum-length
20
409 "*Minimum length before we stop trying to create sub-lists in tags.
410 This is used by all tag-hierarchy methods that break large lists into
415 (defcustom speedbar-tag-regroup-maximum-length
10
416 "*Maximum length of submenus that are regrouped.
417 If the regrouping option is used, then if two or more short subgroups
418 are next to each other, then they are combined until this number of
423 (defcustom speedbar-activity-change-focus-flag nil
424 "*Non-nil means the selected frame will change based on activity.
425 Thus, if a file is selected for edit, the buffer will appear in the
426 selected frame and the focus will change to that frame."
430 (defcustom speedbar-directory-button-trim-method
'span
431 "*Indicates how the directory button will be displayed.
433 'span - span large directories over multiple lines.
434 'trim - trim large directories to only show the last few.
437 :type
'(radio (const :tag
"Span large directories over mutiple lines."
439 (const :tag
"Trim large directories to only show the last few."
441 (const :tag
"No trimming." nil
)))
443 (defcustom speedbar-smart-directory-expand-flag t
444 "*Non-nil means speedbar should use smart expansion.
445 Smart expansion only affects when speedbar wants to display a
446 directory for a file in the attached frame. When smart expansion is
447 enabled, new directories which are children of a displayed directory
448 are expanded in the current framework. If nil, then the current
449 hierarchy would be replaced with the new directory."
453 (defvar speedbar-hide-button-brackets-flag nil
454 "*Non-nil means speedbar will hide the brackets around the + or -.")
456 (defcustom speedbar-before-popup-hook nil
457 "*Hooks called before popping up the speedbar frame."
461 (defcustom speedbar-before-delete-hook nil
462 "*Hooks called before deleting the speedbar frame."
466 (defcustom speedbar-mode-hook nil
467 "*Hooks called after creating a speedbar buffer."
471 (defcustom speedbar-timer-hook nil
472 "*Hooks called after running the speedbar timer function."
476 (defcustom speedbar-verbosity-level
1
477 "*Verbosity level of the speedbar. 0 means say nothing.
478 1 means medium level verbosity. 2 and higher are higher levels of
483 (defvar speedbar-indicator-separator
" "
484 "String separating file text from indicator characters.")
486 (defcustom speedbar-vc-do-check t
487 "*Non-nil check all files in speedbar to see if they have been checked out.
488 Any file checked out is marked with `speedbar-vc-indicator'"
492 (defvar speedbar-vc-indicator
"*"
493 "Text used to mark files which are currently checked out.
494 Currently only RCS is supported. Other version control systems can be
495 added by examining the function `speedbar-this-file-in-vc' and
496 `speedbar-vc-check-dir-p'")
498 (defcustom speedbar-vc-path-enable-hook nil
499 "*Return non-nil if the current path should be checked for Version Control.
500 Functions in this hook must accept one parameter which is the path
505 (defcustom speedbar-vc-in-control-hook nil
506 "*Return non-nil if the specified file is under Version Control.
507 Functions in this hook must accept two parameters. The PATH of the
508 current file, and the FILENAME of the file being checked."
512 (defvar speedbar-vc-to-do-point nil
513 "Local variable maintaining the current version control check position.")
515 (defcustom speedbar-obj-do-check t
516 "*Non-nil check all files in speedbar to see if they have an object file.
517 Any file checked out is marked with `speedbar-obj-indicator', and the
518 marking is based on `speedbar-obj-alist'"
522 (defvar speedbar-obj-to-do-point nil
523 "Local variable maintaining the current version control check position.")
525 (defvar speedbar-obj-indicator
'("#" .
"!")
526 "Text used to mark files that have a corresponding hidden object file.
527 The car is for an up-to-date object. The cdr is for an out of date object.
528 The expression `speedbar-obj-alist' defines who gets tagged.")
530 (defvar speedbar-obj-alist
531 '(("\\.\\([cpC]\\|cpp\\|cc\\)$" .
".o")
533 ("\\.java$" .
".class")
534 ("\\.f\\(or\\|90\\|77\\)?$" .
".o")
536 ("\\.texi$" .
".info"))
537 "Alist of file extensions, and their corresponding object file type.")
539 (defvar speedbar-indicator-regex
540 (concat (regexp-quote speedbar-indicator-separator
)
542 (regexp-quote speedbar-vc-indicator
)
544 (regexp-quote (car speedbar-obj-indicator
))
546 (regexp-quote (cdr speedbar-obj-indicator
))
548 "Regular expression used when identifying files.
549 Permits stripping of indicator characters from a line.")
551 (defcustom speedbar-scanner-reset-hook nil
552 "*Hook called whenever generic scanners are reset.
553 Set this to implement your own scanning / rescan safe functions with
558 (defvar speedbar-ignored-modes nil
559 "*List of major modes which speedbar will not switch directories for.")
561 (defun speedbar-extension-list-to-regex (extlist)
562 "Takes EXTLIST, a list of extensions and transforms it into regexp.
563 All the preceding `.' are stripped for an optimized expression starting
564 with `.' followed by extensions, followed by full-filenames."
565 (let ((regex1 nil
) (regex2 nil
))
567 (if (= (string-to-char (car extlist
)) ?.
)
568 (setq regex1
(concat regex1
(if regex1
"\\|" "")
569 (substring (car extlist
) 1)))
570 (setq regex2
(concat regex2
(if regex2
"\\|" "") (car extlist
))))
571 (setq extlist
(cdr extlist
)))
572 ;; concat all the sub-exressions together, making sure all types
573 ;; of parts exist during concatination.
575 (if regex1
(concat "\\(\\.\\(" regex1
"\\)\\)") "")
576 (if (and regex1 regex2
) "\\|" "")
577 (if regex2
(concat "\\(" regex2
"\\)") "")
580 (defvar speedbar-ignored-path-regexp nil
581 "Regular expression matching paths speedbar will not switch to.
582 Created from `speedbar-ignored-path-expressions' with the function
583 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
584 Use the function `speedbar-add-ignored-path-regexp', or customize the
585 variable `speedbar-ignored-path-expressions' to modify this variable.")
587 (defcustom speedbar-ignored-path-expressions
589 "*List of regular expressions matching directories speedbar will ignore.
590 They should included paths to directories which are notoriously very
591 large and take a long time to load in. Use the function
592 `speedbar-add-ignored-path-regexp' to add new items to this list after
593 speedbar is loaded. You may place anything you like in this list
594 before speedbar has been loaded."
596 :type
'(repeat (regexp :tag
"Path Regexp"))
597 :set
(lambda (sym val
)
598 (setq speedbar-ignored-path-expressions val
599 speedbar-ignored-path-regexp
600 (speedbar-extension-list-to-regex val
))))
602 (defcustom speedbar-directory-unshown-regexp
"^\\(CVS\\|RCS\\|SCCS\\)\\'"
603 "*Regular expression matching directories not to show in speedbar.
604 They should include commonly existing directories which are not
605 useful, such as version control."
609 (defvar speedbar-file-unshown-regexp
610 (let ((nstr "") (noext completion-ignored-extensions
))
612 (setq nstr
(concat nstr
(regexp-quote (car noext
)) "\\'"
613 (if (cdr noext
) "\\|" ""))
615 ;; backup refdir lockfile
616 (concat nstr
"\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
617 "*Regexp matching files we don't want displayed in a speedbar buffer.
618 It is generated from the variable `completion-ignored-extensions'")
620 ;; this is dangerous to customize, because the defaults will probably
621 ;; change in the future.
622 (defcustom speedbar-supported-extension-expressions
623 (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
624 ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?")
625 (if speedbar-use-imenu-flag
626 '(".ada" ".pl" ".tcl" ".m" ".scm" ".pm" ".py"
627 ;; html is not supported by default, but an imenu tags package
628 ;; is available. Also, html files are nice to be able to see.
630 "Makefile\\(\\.in\\)?")))
631 "*List of regular expressions which will match files supported by tagging.
632 Do not prefix the `.' char with a double \\ to quote it, as the period
633 will be stripped by a simplified optimizer when compiled into a
634 singular expression. This variable will be turned into
635 `speedbar-file-regexp' for use with speedbar. You should use the
636 function `speedbar-add-supported-extension' to add a new extension at
637 runtime, or use the configuration dialog to set it in your .emacs
640 :type
'(repeat (regexp :tag
"Extension Regexp"))
641 :set
(lambda (sym val
)
642 (setq speedbar-supported-extension-expressions val
643 speedbar-file-regexp
(speedbar-extension-list-to-regex val
)))
646 (defvar speedbar-file-regexp
647 (speedbar-extension-list-to-regex speedbar-supported-extension-expressions
)
648 "Regular expression matching files we know how to expand.
649 Created from `speedbar-supported-extension-expression' with the
650 function `speedbar-extension-list-to-regex'")
652 (defun speedbar-add-supported-extension (extension)
653 "Add EXTENSION as a new supported extension for speedbar tagging.
654 This should start with a `.' if it is not a complete file name, and
655 the dot should NOT be quoted in with \\. Other regular expression
656 matchers are allowed however. EXTENSION may be a single string or a
658 (interactive "sExtionsion: ")
659 (if (not (listp extension
)) (setq extension
(list extension
)))
661 (if (member (car extension
) speedbar-supported-extension-expressions
)
663 (setq speedbar-supported-extension-expressions
664 (cons (car extension
) speedbar-supported-extension-expressions
)))
665 (setq extension
(cdr extension
)))
666 (setq speedbar-file-regexp
(speedbar-extension-list-to-regex
667 speedbar-supported-extension-expressions
)))
669 (defun speedbar-add-ignored-path-regexp (path-expression)
670 "Add PATH-EXPRESSION as a new ignored path for speedbar tracking.
671 This function will modify `speedbar-ignored-path-regexp' and add
672 PATH-EXPRESSION to `speedbar-ignored-path-expressions'."
673 (interactive "sPath regex: ")
674 (if (not (listp path-expression
))
675 (setq path-expression
(list path-expression
)))
676 (while path-expression
677 (if (member (car path-expression
) speedbar-ignored-path-expressions
)
679 (setq speedbar-ignored-path-expressions
680 (cons (car path-expression
) speedbar-ignored-path-expressions
)))
681 (setq path-expression
(cdr path-expression
)))
682 (setq speedbar-ignored-path-regexp
(speedbar-extension-list-to-regex
683 speedbar-ignored-path-expressions
)))
685 ;; If we don't have custom, then we set it here by hand.
686 (if (not (fboundp 'custom-declare-variable
))
687 (setq speedbar-file-regexp
(speedbar-extension-list-to-regex
688 speedbar-supported-extension-expressions
)
689 speedbar-ignored-path-regexp
(speedbar-extension-list-to-regex
690 speedbar-ignored-path-expressions
)))
692 (defvar speedbar-update-flag
(and
693 (or (fboundp 'run-with-idle-timer
)
694 (fboundp 'start-itimer
)
695 (boundp 'post-command-idle-hook
))
697 "*Non-nil means to automatically update the display.
698 When this is nil then speedbar will not follow the attached frame's path.
699 When speedbar is active, use:
701 \\<speedbar-key-map> `\\[speedbar-toggle-updates]'
703 to toggle this value.")
705 (defvar speedbar-syntax-table nil
706 "Syntax-table used on the speedbar.")
708 (if speedbar-syntax-table
710 (setq speedbar-syntax-table
(make-syntax-table))
711 ;; turn off paren matching around here.
712 (modify-syntax-entry ?
\' " " speedbar-syntax-table
)
713 (modify-syntax-entry ?
\" " " speedbar-syntax-table
)
714 (modify-syntax-entry ?
( " " speedbar-syntax-table
)
715 (modify-syntax-entry ?
) " " speedbar-syntax-table
)
716 (modify-syntax-entry ?
[ " " speedbar-syntax-table
)
717 (modify-syntax-entry ?
] " " speedbar-syntax-table
))
719 (defvar speedbar-key-map nil
720 "Keymap used in speedbar buffer.")
724 (setq speedbar-key-map
(make-keymap))
725 (suppress-keymap speedbar-key-map t
)
728 (define-key speedbar-key-map
"g" 'speedbar-refresh
)
729 (define-key speedbar-key-map
"t" 'speedbar-toggle-updates
)
730 (define-key speedbar-key-map
"q" 'speedbar-close-frame
)
731 (define-key speedbar-key-map
"Q" 'delete-frame
)
734 (define-key speedbar-key-map
"n" 'speedbar-next
)
735 (define-key speedbar-key-map
"p" 'speedbar-prev
)
736 (define-key speedbar-key-map
"\M-n" 'speedbar-restricted-next
)
737 (define-key speedbar-key-map
"\M-p" 'speedbar-restricted-prev
)
738 (define-key speedbar-key-map
"\C-\M-n" 'speedbar-forward-list
)
739 (define-key speedbar-key-map
"\C-\M-p" 'speedbar-backward-list
)
740 (define-key speedbar-key-map
" " 'speedbar-scroll-up
)
741 (define-key speedbar-key-map
[delete] 'speedbar-scroll-down)
743 ;; Short cuts I happen to find useful
744 (define-key speedbar-key-map "r"
745 (lambda () (interactive)
746 (speedbar-change-initial-expansion-list
747 speedbar-previously-used-expansion-list-name)))
748 (define-key speedbar-key-map "b"
749 (lambda () (interactive)
750 (speedbar-change-initial-expansion-list "quick buffers")))
751 (define-key speedbar-key-map "f"
752 (lambda () (interactive)
753 (speedbar-change-initial-expansion-list "files")))
756 (substitute-key-definition 'switch-to-buffer
757 'speedbar-switch-buffer-attached-frame
758 speedbar-key-map global-map)
762 ;; mouse bindings so we can manipulate the items on each line
763 (define-key speedbar-key-map 'button2 'speedbar-click)
764 (define-key speedbar-key-map '(shift button2) 'speedbar-power-click)
765 ;; Info doc fix from Bob Weiner
766 (if (featurep 'infodoc)
768 (define-key speedbar-key-map 'button3 'speedbar-xemacs-popup-kludge))
769 (define-key speedbar-key-map '(meta button3) 'speedbar-mouse-item-info)
772 ;; mouse bindings so we can manipulate the items on each line
773 (define-key speedbar-key-map [down-mouse-1] 'speedbar-double-click)
774 (define-key speedbar-key-map [mouse-2] 'speedbar-click)
775 ;; This is the power click for new frames, or refreshing a cache
776 (define-key speedbar-key-map [S-mouse-2] 'speedbar-power-click)
777 ;; This adds a small unecessary visual effect
778 ;;(define-key speedbar-key-map [down-mouse-2] 'speedbar-quick-mouse)
779 (define-key speedbar-key-map [M-mouse-2] 'speedbar-mouse-item-info)
781 (define-key speedbar-key-map [down-mouse-3] 'speedbar-emacs-popup-kludge)
783 ;; This lets the user scroll as if we had a scrollbar... well maybe not
784 (define-key speedbar-key-map [mode-line mouse-2] 'speedbar-mouse-hscroll)
785 ;; another handy place users might click to get our menu.
786 (define-key speedbar-key-map [mode-line down-mouse-1]
787 'speedbar-emacs-popup-kludge)
789 ;; We can't switch buffers with the buffer mouse menu. Lets hack it.
790 (define-key speedbar-key-map [C-down-mouse-1] 'speedbar-hack-buffer-menu)
792 ;; Lastly, we want to track the mouse. Play here
793 (define-key speedbar-key-map [mouse-movement] 'speedbar-track-mouse)
796 (defun speedbar-make-specialized-keymap ()
797 "Create a keymap for use w/ a speedbar major or minor display mode.
798 This basically creates a sparse keymap, and makes it's parent be
800 (let ((k (make-sparse-keymap)))
801 (set-keymap-parent k speedbar-key-map)
804 (defvar speedbar-file-key-map nil
805 "Keymap used in speedbar buffer while files are displayed.")
807 (if speedbar-file-key-map
809 (setq speedbar-file-key-map (speedbar-make-specialized-keymap))
811 ;; Basic tree features
812 (define-key speedbar-file-key-map "e" 'speedbar-edit-line)
813 (define-key speedbar-file-key-map "\C-m" 'speedbar-edit-line)
814 (define-key speedbar-file-key-map "+" 'speedbar-expand-line)
815 (define-key speedbar-file-key-map "-" 'speedbar-contract-line)
817 ;; file based commands
818 (define-key speedbar-file-key-map "U" 'speedbar-up-directory)
819 (define-key speedbar-file-key-map "I" 'speedbar-item-info)
820 (define-key speedbar-file-key-map "B" 'speedbar-item-byte-compile)
821 (define-key speedbar-file-key-map "L" 'speedbar-item-load)
822 (define-key speedbar-file-key-map "C" 'speedbar-item-copy)
823 (define-key speedbar-file-key-map "D" 'speedbar-item-delete)
824 (define-key speedbar-file-key-map "O" 'speedbar-item-object-delete)
825 (define-key speedbar-file-key-map "R" 'speedbar-item-rename)
828 (defvar speedbar-easymenu-definition-base
830 ["Update" speedbar-refresh t]
831 ["Auto Update" speedbar-toggle-updates
832 :style toggle :selected speedbar-update-flag]
834 "Base part of the speedbar menu.")
836 (defvar speedbar-easymenu-definition-special
837 '(["Edit Item On Line" speedbar-edit-line t]
838 ["Show All Files" speedbar-toggle-show-all-files
839 :style toggle :selected speedbar-show-unknown-files]
840 ["Expand File Tags" speedbar-expand-line
841 (save-excursion (beginning-of-line)
842 (looking-at "[0-9]+: *.\\+. "))]
843 ["Contract File Tags" speedbar-contract-line
844 (save-excursion (beginning-of-line)
845 (looking-at "[0-9]+: *.-. "))]
846 ; ["Sort Tags" speedbar-toggle-sorting
847 ; :style toggle :selected speedbar-sort-tags]
849 ["File/Tag Information" speedbar-item-info t]
850 ["Load Lisp File" speedbar-item-load
853 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
854 ["Byte Compile File" speedbar-item-byte-compile
857 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
858 ["Copy File" speedbar-item-copy
859 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
860 ["Rename File" speedbar-item-rename
861 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
862 ["Delete File" speedbar-item-delete
863 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
864 ["Delete Object" speedbar-item-object-delete
865 (save-excursion (beginning-of-line)
866 (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))]
868 "Additional menu items while in file-mode.")
870 (defvar speedbar-easymenu-definition-trailer
872 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
873 (list ["Customize..." speedbar-customize t]))
875 ["Close" speedbar-close-frame t]
876 ["Quit" delete-frame t] ))
877 "Menu items appearing at the end of the speedbar menu.")
879 (defvar speedbar-desired-buffer nil
880 "Non-nil when speedbar is showing buttons specific a special mode.
881 In this case it is the originating buffer.")
882 (defvar speedbar-buffer nil
883 "The buffer displaying the speedbar.")
884 (defvar speedbar-frame nil
885 "The frame displaying speedbar.")
886 (defvar speedbar-cached-frame nil
887 "The frame that was last created, then removed from the display.")
888 (defvar speedbar-full-text-cache nil
889 "The last open directory is saved in its entirety for ultra-fast switching.")
890 (defvar speedbar-timer nil
891 "The speedbar timer used for updating the buffer.")
892 (defvar speedbar-attached-frame nil
893 "The frame which started speedbar mode.
894 This is the frame from which all data displayed in the speedbar is
895 gathered, and in which files and such are displayed.")
897 (defvar speedbar-last-selected-file nil
898 "The last file which was selected in speedbar buffer.")
900 (defvar speedbar-shown-directories nil
901 "Maintain list of directories simultaneously open in the current speedbar.")
903 (defvar speedbar-directory-contents-alist nil
904 "An association list of directories and their contents.
905 Each sublist was returned by `speedbar-file-lists'. This list is
906 maintained to speed up the refresh rate when switching between
909 (defvar speedbar-power-click nil
910 "Never set this by hand. Value is t when S-mouse activity occurs.")
915 (if (fboundp 'frame-parameter)
917 (defalias 'speedbar-frame-parameter 'frame-parameter)
919 (defun speedbar-frame-parameter (frame parameter)
920 "Return FRAME's PARAMETER value."
921 (cdr (assoc parameter (frame-parameters frame)))))
923 ;;; Mode definitions/ user commands
927 (defalias 'speedbar 'speedbar-frame-mode)
929 (defun speedbar-frame-mode (&optional arg)
930 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
931 nil means toggle. Once the speedbar frame is activated, a buffer in
932 `speedbar-mode' will be displayed. Currently, only one speedbar is
934 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
935 `speedbar-before-delete-hook' is called before the frame is deleted."
937 ;; toggle frame on and off.
938 (if (not arg) (if (and (frame-live-p speedbar-frame)
939 (frame-visible-p speedbar-frame))
940 (setq arg -1) (setq arg 1)))
941 ;; turn the frame off on neg number
942 (if (and (numberp arg) (< arg 0))
944 (run-hooks 'speedbar-before-delete-hook)
945 (if (and speedbar-frame (frame-live-p speedbar-frame))
947 (setq speedbar-cached-frame speedbar-frame)
948 (make-frame-invisible speedbar-frame)))
949 (setq speedbar-frame nil)
950 (speedbar-set-timer nil)
951 ;; Used to delete the buffer. This has the annoying affect of
952 ;; preventing whatever took its place from ever appearing
953 ;; as the default after a C-x b was typed
954 ;;(if (bufferp speedbar-buffer)
955 ;; (kill-buffer speedbar-buffer))
957 ;; Set this as our currently attached frame
958 (setq speedbar-attached-frame (selected-frame))
959 (run-hooks 'speedbar-before-popup-hook)
960 ;; Get the frame to work in
961 (if (frame-live-p speedbar-cached-frame)
963 (setq speedbar-frame speedbar-cached-frame)
964 (make-frame-visible speedbar-frame)
965 ;; Get the buffer to play with
967 (select-frame speedbar-frame)
968 (if (not (eq (current-buffer) speedbar-buffer))
969 (switch-to-buffer speedbar-buffer))
970 (set-window-dedicated-p (selected-window) t)
971 (raise-frame speedbar-frame)
972 (speedbar-set-timer speedbar-update-speed)
974 (if (frame-live-p speedbar-frame)
975 (raise-frame speedbar-frame)
978 ;; Only guess height if it is not specified.
979 (if (member 'height speedbar-frame-plist)
980 (make-frame speedbar-frame-plist)
981 (make-frame (nconc (list 'height
982 (speedbar-needed-height))
983 speedbar-frame-plist)))
984 (let* ((mh (speedbar-frame-parameter nil 'menu-bar-lines))
985 (cfx (speedbar-frame-parameter nil 'left))
986 (cfy (speedbar-frame-parameter nil 'top))
987 (cfw (frame-pixel-width))
989 ;; Only add a guessed height if one is not specified
990 ;; in the input parameters.
991 (if (assoc 'height speedbar-frame-parameters)
992 speedbar-frame-parameters
994 speedbar-frame-parameters
995 (list (cons 'height (+ mh (frame-height)))))))
997 (if (or (< emacs-major-version 20)
998 (not (eq window-system 'x)))
1000 (let ((x-pointer-shape x-pointer-top-left-arrow)
1001 (x-sensitive-text-pointer-shape
1003 (make-frame params)))))
1004 ;; Position speedbar frame.
1005 (if (or (not window-system) (eq window-system 'pc)
1006 (assoc 'left speedbar-frame-parameters)
1007 (assoc 'top speedbar-frame-parameters))
1008 ;; Do no positioning if not on a windowing system,
1009 ;; or if left/top were specified in the parameters.
1012 (if (not (consp cfx))
1014 ;; If cfx is a list, that means we grow
1015 ;; from a specific edge of the display.
1016 ;; Convert that to the distance from the
1017 ;; left side of the display.
1018 (if (eq (car cfx) '-)
1019 ;; A - means distance from the right edge
1020 ;; of the display, or DW - cfx - framewidth
1021 (- (x-display-pixel-width) (car (cdr cfx))
1022 (frame-pixel-width))
1024 (modify-frame-parameters
1029 ;; Decide which side to put it
1030 ;; on. 200 is just a buffer
1031 ;; for the left edge of the
1032 ;; screen. The extra 10 is just
1033 ;; dressings for window decorations.
1034 (let ((sfw (frame-pixel-width frame)))
1035 (let ((left-guess (- cfx 10 sfw))
1036 (right-guess (+ cfx cfw 5)))
1037 (let ((left-margin left-guess)
1039 (- (x-display-pixel-width)
1040 right-guess 5 sfw)))
1041 (cond ((>= left-margin 0) left-guess)
1042 ((>= right-margin 0) right-guess)
1043 ;; otherwise choose side we overlap less
1044 ((> left-margin right-margin) 0)
1045 (t (- (x-display-pixel-width) sfw 5)))))))
1048 ;; reset the selection variable
1049 (setq speedbar-last-selected-file nil)
1050 ;; Put the buffer into the frame
1051 (save-window-excursion
1052 ;; Get the buffer to play with
1054 (select-frame speedbar-frame)
1055 (switch-to-buffer speedbar-buffer)
1056 (set-window-dedicated-p (selected-window) t))
1057 (if (and (or (null window-system) (eq window-system 'pc))
1058 (fboundp 'set-frame-name))
1060 (select-frame speedbar-frame)
1061 (set-frame-name "Speedbar")))
1062 (speedbar-set-timer speedbar-update-speed)))))
1065 (defun speedbar-get-focus ()
1066 "Change frame focus to or from the speedbar frame.
1067 If the selected frame is not speedbar, then speedbar frame is
1068 selected. If the speedbar frame is active, then select the attached frame."
1070 (if (eq (selected-frame) speedbar-frame)
1071 (if (frame-live-p speedbar-attached-frame)
1072 (select-frame speedbar-attached-frame))
1073 ;; If updates are off, then refresh the frame (they want it now...)
1074 (if (not speedbar-update-flag)
1075 (let ((speedbar-update-flag t))
1076 (speedbar-timer-fn)))
1077 ;; make sure we have a frame
1078 (if (not (frame-live-p speedbar-frame)) (speedbar-frame-mode 1))
1080 (select-frame speedbar-frame)
1084 (defun speedbar-close-frame ()
1085 "Turn off a currently active speedbar."
1087 (speedbar-frame-mode -1)
1088 (select-frame speedbar-attached-frame)
1091 (defun speedbar-switch-buffer-attached-frame (&optional buffer)
1092 "Switch to BUFFER in speedbar's attached frame, and raise that frame.
1093 This overrides the default behavior of `switch-to-buffer' which is
1094 broken because of the dedicated speedbar frame."
1096 ;; Assume we are in the speedbar frame.
1097 (speedbar-get-focus)
1098 ;; Now switch buffers
1100 (switch-to-buffer buffer)
1101 (call-interactively 'switch-to-buffer nil nil)))
1103 (defmacro speedbar-frame-width ()
1104 "Return the width of the speedbar frame in characters.
1105 nil if it doesn't exist."
1106 '(frame-width speedbar-frame))
1108 ;; XEmacs function only.
1109 (defun speedbar-needed-height (&optional frame)
1110 "The needed height for the tool bar FRAME (in characters)."
1111 (or frame (setq frame (selected-frame)))
1112 ;; The 1 is the missing modeline/minibuffer
1113 (+ 1 (/ (frame-pixel-height frame)
1114 (face-height 'default frame))))
1116 (defun speedbar-mode ()
1117 "Major mode for managing a display of directories and tags.
1118 \\<speedbar-key-map>
1119 The first line represents the default path of the speedbar frame.
1120 Each directory segment is a button which jumps speedbar's default
1121 directory to that path. Buttons are activated by clicking `\\[speedbar-click]'.
1122 In some situations using `\\[speedbar-power-click]' is a `power click' which will
1123 rescan cached items, or pop up new frames.
1125 Each line starting with <+> represents a directory. Click on the <+>
1126 to insert the directory listing into the current tree. Click on the
1127 <-> to retract that list. Click on the directory name to go to that
1128 directory as the default.
1130 Each line starting with [+] is a file. If the variable
1131 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1132 files which don't have imenu support, but are not expressly ignored.
1133 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1134 which is generated from `completion-ignored-extensions'.
1136 Files with a `*' character after their name are files checked out of a
1137 version control system. (currently only RCS is supported.) New
1138 version control systems can be added by examining the documentation
1139 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'
1141 Files with a `#' or `!' character after them are source files that
1142 have an object file associated with them. The `!' indicates that the
1143 files is out of date. You can control what source/object associations
1144 exist through the variable `speedbar-obj-alist'.
1146 Click on the [+] to display a list of tags from that file. Click on
1147 the [-] to retract the list. Click on the file name to edit the file
1148 in the attached frame.
1150 If you open tags, you might find a node starting with {+}, which is a
1151 category of tags. Click the {+} to expand the category. Jump-able
1152 tags start with >. Click the name of the tag to go to that position
1153 in the selected file.
1155 \\{speedbar-key-map}"
1158 (setq speedbar-buffer (set-buffer (get-buffer-create " SPEEDBAR")))
1159 (kill-all-local-variables)
1160 (setq major-mode 'speedbar-mode)
1161 (setq mode-name "Speedbar")
1162 (set-syntax-table speedbar-syntax-table)
1163 (setq font-lock-keywords nil) ;; no font-locking please
1164 (setq truncate-lines t)
1165 (make-local-variable 'frame-title-format)
1166 (setq frame-title-format "Speedbar")
1167 ;; Set this up special just for the speedbar buffer
1168 ;; Terminal minibuffer stuff does not require this.
1169 (if (and window-system (not (eq window-system 'pc))
1170 (null default-minibuffer-frame))
1172 (make-local-variable 'default-minibuffer-frame)
1173 (setq default-minibuffer-frame speedbar-attached-frame)))
1174 ;; Correct use of `temp-buffer-show-function': Bob Weiner
1175 (if (and (boundp 'temp-buffer-show-hook)
1176 (boundp 'temp-buffer-show-function))
1177 (progn (make-local-variable 'temp-buffer-show-hook)
1178 (setq temp-buffer-show-hook temp-buffer-show-function)))
1179 (make-local-variable 'temp-buffer-show-function)
1180 (setq temp-buffer-show-function 'speedbar-temp-buffer-show-function)
1181 (if speedbar-xemacsp
1183 ;; Argh! mouse-track-click-hook doesn't understand the
1184 ;; make-local-hook conventions.
1185 (make-local-variable 'mouse-track-click-hook)
1186 (add-hook 'mouse-track-click-hook
1187 (lambda (event count)
1188 (if (/= (event-button event) 1)
1189 nil ; Do normal operations.
1191 (speedbar-quick-mouse event))
1194 (mouse-set-point event)
1195 (speedbar-do-function-pointer)
1196 (speedbar-quick-mouse event)))
1197 ;; Don't do normal operations.
1199 (make-local-hook 'kill-buffer-hook)
1200 (add-hook 'kill-buffer-hook (lambda () (let ((skilling (boundp 'skilling)))
1203 (if (eq (current-buffer)
1205 (speedbar-frame-mode -1)))))
1207 (toggle-read-only 1)
1208 (speedbar-set-mode-line-format)
1209 (if speedbar-xemacsp
1211 (make-local-variable 'mouse-motion-handler)
1212 (setq mouse-motion-handler 'speedbar-track-mouse-xemacs))
1213 (if speedbar-track-mouse-flag
1215 (make-local-variable 'track-mouse)
1216 (setq track-mouse t))) ;this could be messy.
1217 (setq auto-show-mode nil)) ;no auto-show for Emacs
1218 (run-hooks 'speedbar-mode-hook))
1219 (speedbar-update-contents)
1222 (defmacro speedbar-with-attached-buffer (&rest forms)
1223 "Execute FORMS in the attached frame's special buffer.
1224 Optionally select that frame if necessary."
1225 `(save-selected-window
1226 (speedbar-set-timer speedbar-update-speed)
1227 (select-frame speedbar-attached-frame)
1229 (speedbar-maybee-jump-to-attached-frame)))
1231 (defun speedbar-message (fmt &rest args)
1232 "Like message, but for use in the speedbar frame.
1233 Argument FMT is the format string, and ARGS are the arguments for message."
1234 (save-selected-window
1235 (select-frame speedbar-attached-frame)
1236 (apply 'message fmt args)))
1238 (defun speedbar-y-or-n-p (prompt)
1239 "Like `y-or-n-p', but for use in the speedbar frame.
1240 Argument PROMPT is the prompt to use."
1241 (save-selected-window
1242 (if (and default-minibuffer-frame (not (eq default-minibuffer-frame
1243 speedbar-attached-frame)))
1244 (select-frame speedbar-attached-frame))
1247 (defun speedbar-show-info-under-mouse (&optional event)
1248 "Call the info function for the line under the mouse.
1249 Optional EVENT is currently not used."
1250 (let ((pos (mouse-position))) ; we ignore event until I use it later.
1251 (if (equal (car pos) speedbar-frame)
1253 (save-window-excursion
1254 (apply 'set-mouse-position pos)
1255 (speedbar-item-info))))))
1257 (defun speedbar-set-mode-line-format ()
1258 "Set the format of the mode line based on the current speedbar environment.
1259 This gives visual indications of what is up. It EXPECTS the speedbar
1260 frame and window to be the currently active frame and window."
1261 (if (and (frame-live-p speedbar-frame)
1262 (or (not speedbar-xemacsp)
1263 (specifier-instance has-modeline-p)))
1265 (set-buffer speedbar-buffer)
1266 (let* ((w (or (speedbar-frame-width) 20))
1269 (p3 (if speedbar-update-flag "SPEEDBAR" "SLOWBAR"))
1270 (blank (- w (length p1) (length p3) (length p5)
1271 (if line-number-mode 4 0)))
1273 (make-string (/ blank 2) ? )
1276 (make-string (+ (/ blank 2) (% blank 2)) ? )
1279 (if line-number-mode
1280 (list (concat p1 p2 p3) '(line-number-mode " %3l")
1282 (list (concat p1 p2 p3 p4 p5)))))
1283 (if (not (equal mode-line-format tf))
1285 (setq mode-line-format tf)
1286 (force-mode-line-update)))))))
1288 (defun speedbar-temp-buffer-show-function (buffer)
1289 "Placed in the variable `temp-buffer-show-function' in `speedbar-mode'.
1290 If a user requests help using \\[help-command] <Key> the temp BUFFER will be
1291 redirected into a window on the attached frame."
1292 (if speedbar-attached-frame (select-frame speedbar-attached-frame))
1293 (pop-to-buffer buffer nil)
1295 ;; Fix for using this hook on some platforms: Bob Weiner
1296 (cond ((not speedbar-xemacsp)
1297 (run-hooks 'temp-buffer-show-hook))
1298 ((fboundp 'run-hook-with-args)
1299 (run-hook-with-args 'temp-buffer-show-hook buffer))
1300 ((and (boundp 'temp-buffer-show-hook)
1301 (listp temp-buffer-show-hook))
1302 (mapcar (function (lambda (hook) (funcall hook buffer)))
1303 temp-buffer-show-hook))))
1305 (defvar speedbar-previous-menu nil
1306 "The menu before the last `speedbar-reconfigure-keymaps' was called.")
1308 (defun speedbar-reconfigure-keymaps ()
1309 "Reconfigure the menu-bar in a speedbar frame.
1310 Different menu items are displayed depending on the current display mode
1311 and the existence of packages."
1313 speedbar-easymenu-definition-base
1314 (if speedbar-shown-directories
1315 ;; file display mode version
1316 (speedbar-initial-menu)
1318 (select-frame speedbar-attached-frame)
1319 (if (local-variable-p
1320 'speedbar-easymenu-definition-special
1322 ;; If bound locally, we can use it
1323 speedbar-easymenu-definition-special)))
1324 ;; Dynamic menu stuff
1326 (list (cons "Displays"
1327 (let ((displays nil)
1328 (alist speedbar-initial-expansion-mode-alist))
1333 (capitalize (car (car alist)))
1335 'speedbar-change-initial-expansion-list
1339 (setq alist (cdr alist)))
1342 speedbar-easymenu-definition-trailer))
1343 (localmap (save-excursion
1344 (let ((cf (selected-frame)))
1346 (select-frame speedbar-attached-frame)
1347 (if (local-variable-p
1348 'speedbar-special-mode-key-map
1350 speedbar-special-mode-key-map)
1351 (select-frame cf))))))
1353 (set-buffer speedbar-buffer)
1354 (use-local-map (or localmap
1355 (speedbar-initial-keymap)
1356 ;; This creates a small keymap we can glom the
1357 ;; menu adjustments into.
1358 (speedbar-make-specialized-keymap)))
1359 ;; Delete the old menu if applicable.
1360 (if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu))
1361 (setq speedbar-previous-menu md)
1362 ;; Now add the new menu
1363 (if (not speedbar-xemacsp)
1364 (easy-menu-define speedbar-menu-map (current-local-map)
1366 (easy-menu-add md (current-local-map))
1367 (set-buffer-menubar (list md))))))
1370 ;;; User Input stuff
1373 ;; XEmacs: this can be implemented using modeline keymaps, but there
1374 ;; is no use, as we have horizontal scrollbar (as the docstring
1376 (defun speedbar-mouse-hscroll (e)
1377 "Read a mouse event E from the mode line, and horizontally scroll.
1378 If the mouse is being clicked on the far left, or far right of the
1379 mode-line. This is only useful for non-XEmacs"
1381 (let* ((xp (car (nth 2 (car (cdr e)))))
1382 (cpw (/ (frame-pixel-width)
1384 (oc (1+ (/ xp cpw)))
1388 ((> oc (- (window-width) 3))
1390 (t (speedbar-message
1391 "Click on the edge of the modeline to scroll left/right")))
1392 ;;(speedbar-message "X: Pixel %d Char Pixels %d On char %d" xp cpw oc)
1395 (defun speedbar-customize ()
1396 "Customize speedbar using the Custom package."
1398 (let ((sf (selected-frame)))
1399 (select-frame speedbar-attached-frame)
1400 (customize-group 'speedbar)
1402 (speedbar-maybee-jump-to-attached-frame))
1404 (defun speedbar-track-mouse (event)
1405 "For motion EVENT, display info about the current line."
1407 (if (not speedbar-track-mouse-flag)
1410 (let ((char (nth 1 (car (cdr event)))))
1411 (if (not (numberp char))
1412 (speedbar-message nil)
1414 ;; (speedbar-message "%S" event)
1415 (speedbar-item-info)
1418 (defun speedbar-track-mouse-xemacs (event)
1419 "For motion EVENT, display info about the current line."
1420 (if (functionp (default-value 'mouse-motion-handler))
1421 (funcall (default-value 'mouse-motion-handler) event))
1422 (if speedbar-track-mouse-flag
1424 (save-window-excursion
1426 (progn (mouse-set-point event)
1427 ;; Prevent focus-related bugs.
1428 (if (eq major-mode 'speedbar-mode)
1429 (speedbar-item-info)))
1432 ;; In XEmacs, we make popup menus work on the item over mouse (as
1433 ;; opposed to where the point happens to be.) We attain this by
1434 ;; temporarily moving the point to that place.
1435 ;; Hrvoje Niksic <hniksic@srce.hr>
1436 (defun speedbar-xemacs-popup-kludge (event)
1437 "Pop up a menu related to the clicked on item.
1438 Must be bound to EVENT."
1440 (select-frame speedbar-frame)
1442 (goto-char (event-closest-point event))
1444 (forward-char (min 5 (- (save-excursion (end-of-line) (point))
1445 (save-excursion (beginning-of-line) (point)))))
1447 ;; Wait for menu to bail out. `popup-mode-menu' (and other popup
1448 ;; menu functions) return immediately.
1450 (while (not (misc-user-event-p (setq new (next-event))))
1451 (dispatch-event new))
1452 (dispatch-event new))))
1454 (defun speedbar-emacs-popup-kludge (e)
1455 "Pop up a menu related to the clicked on item.
1456 Must be bound to event E."
1460 ;; This gets the cursor where the user can see it.
1461 (if (not (bolp)) (forward-char -1))
1463 (if (< emacs-major-version 20)
1464 (mouse-major-mode-menu e)
1465 (mouse-major-mode-menu e nil))))
1467 (defun speedbar-hack-buffer-menu (e)
1468 "Control mouse 1 is buffer menu.
1469 This hack overrides it so that the right thing happens in the main
1470 Emacs frame, not in the speedbar frame.
1471 Argument E is the event causing this activity."
1473 (let ((fn (lookup-key global-map (if speedbar-xemacsp
1479 (set-window-dedicated-p (selected-window) nil)
1480 (call-interactively fn)
1481 (setq newbuff (current-buffer)))
1482 (switch-to-buffer speedbar-buffer)
1483 (set-window-dedicated-p (selected-window) t))
1484 (if (not (eq newbuff speedbar-buffer))
1485 (speedbar-with-attached-buffer
1486 (switch-to-buffer newbuff)))))
1488 (defun speedbar-next (arg)
1489 "Move to the next ARGth line in a speedbar buffer."
1491 (forward-line (or arg 1))
1492 (speedbar-item-info)
1493 (speedbar-position-cursor-on-line))
1495 (defun speedbar-prev (arg)
1496 "Move to the previous ARGth line in a speedbar buffer."
1498 (speedbar-next (if arg (- arg) -1)))
1500 (defun speedbar-restricted-move (arg)
1501 "Move to the next ARGth line in a speedbar buffer at the same depth.
1502 This means that movement is restricted to a subnode, and that siblings
1503 of intermediate nodes are skipped."
1504 (if (not (numberp arg)) (signal 'wrong-type-argument (list arg 'numberp)))
1505 ;; First find the extent for which we are allowed to move.
1506 (let ((depth (save-excursion (beginning-of-line)
1507 (if (looking-at "[0-9]+:")
1508 (string-to-int (match-string 0))
1510 (crement (if (< arg 0) 1 -1)) ; decrement or increment
1511 (lastmatch (point)))
1513 (forward-line (- crement))
1514 (let ((subdepth (save-excursion (beginning-of-line)
1515 (if (looking-at "[0-9]+:")
1516 (string-to-int (match-string 0))
1518 (cond ((or (< subdepth depth)
1519 (progn (end-of-line) (eobp))
1520 (progn (beginning-of-line) (bobp)))
1521 ;; We have reached the end of this block.
1522 (goto-char lastmatch)
1524 (error "End of sub-list"))
1526 (setq lastmatch (point)
1527 arg (+ arg crement))))))
1528 (speedbar-position-cursor-on-line)))
1530 (defun speedbar-restricted-next (arg)
1531 "Move to the next ARGth line in a speedbar buffer at the same depth.
1532 This means that movement is restricted to a subnode, and that siblings
1533 of intermediate nodes are skipped."
1535 (speedbar-restricted-move (or arg 1))
1536 (speedbar-item-info))
1539 (defun speedbar-restricted-prev (arg)
1540 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1541 This means that movement is restricted to a subnode, and that siblings
1542 of intermediate nodes are skipped."
1544 (speedbar-restricted-move (if arg (- arg) -1))
1545 (speedbar-item-info))
1547 (defun speedbar-navigate-list (arg)
1548 "Move across ARG groups of similarly typed items in speedbar.
1549 Stop on the first line of the next type of item, or on the last or first item
1550 if we reach a buffer boundary."
1553 (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ")
1554 (let ((str (regexp-quote (match-string 0))))
1555 (while (looking-at str)
1556 (speedbar-restricted-move arg)
1557 (beginning-of-line))))
1558 (speedbar-position-cursor-on-line))
1560 (defun speedbar-forward-list ()
1561 "Move forward over the current list.
1562 A LIST in speedbar is a group of similarly typed items, such as directories,
1563 files, or the directory button."
1565 (speedbar-navigate-list 1)
1566 (speedbar-item-info))
1568 (defun speedbar-backward-list ()
1569 "Move backward over the current list.
1570 A LIST in speedbar is a group of similarly typed items, such as directories,
1571 files, or the directory button."
1573 (speedbar-navigate-list -1)
1574 (speedbar-item-info))
1576 (defun speedbar-scroll-up (&optional arg)
1577 "Page down one screen-full of the speedbar, or ARG lines."
1580 (speedbar-position-cursor-on-line))
1582 (defun speedbar-scroll-down (&optional arg)
1583 "Page up one screen-full of the speedbar, or ARG lines."
1586 (speedbar-position-cursor-on-line))
1588 (defun speedbar-up-directory ()
1589 "Keyboard accelerator for moving the default directory up one.
1590 Assumes that the current buffer is the speedbar buffer"
1592 (setq default-directory (expand-file-name (concat default-directory "../")))
1593 (speedbar-update-contents))
1595 ;;; Speedbar file activity (aka creeping featurism)
1597 (defun speedbar-refresh ()
1598 "Refresh the current speedbar display, disposing of any cached data."
1600 (let ((dl speedbar-shown-directories)
1601 (dm (and (boundp 'deactivate-mark) deactivate-mark)))
1603 (adelete 'speedbar-directory-contents-alist (car dl))
1605 (if (<= 1 speedbar-verbosity-level)
1606 (speedbar-message "Refreshing speedbar..."))
1607 (speedbar-update-contents)
1608 (speedbar-stealthy-updates)
1609 ;; Reset the timer in case it got really hosed for some reason...
1610 (speedbar-set-timer speedbar-update-speed)
1611 (if (<= 1 speedbar-verbosity-level)
1612 (speedbar-message "Refreshing speedbar...done"))
1613 (if (boundp 'deactivate-mark) (setq deactivate-mark dm))))
1615 (defun speedbar-item-load ()
1616 "Load the item under the cursor or mouse if it is a Lisp file."
1618 (let ((f (speedbar-line-file)))
1619 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1620 (if (and (file-exists-p (concat f "c"))
1621 (speedbar-y-or-n-p (format "Load %sc? " f)))
1622 ;; If the compiled version exists, load that instead...
1623 (load-file (concat f "c"))
1625 (error "Not a loadable file"))))
1627 (defun speedbar-item-byte-compile ()
1628 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1630 (let ((f (speedbar-line-file))
1631 (sf (selected-frame)))
1632 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1634 (select-frame speedbar-attached-frame)
1635 (byte-compile-file f nil)
1637 (speedbar-reset-scanners)))
1640 (defun speedbar-mouse-item-info (event)
1641 "Provide information about what the user clicked on.
1642 This should be bound to a mouse EVENT."
1644 (mouse-set-point event)
1645 (speedbar-item-info))
1647 (defun speedbar-generic-item-info ()
1648 "Attempt to derive, and then display information about thils line item.
1649 File style information is displayed with `speedbar-item-info'."
1652 ;; Skip invisible number info.
1653 (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0)))
1654 ;; Skip items in "folder" type text characters.
1655 (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0)))
1657 (speedbar-message "Text: %s" (buffer-substring-no-properties
1658 (point) (progn (end-of-line) (point))))))
1660 (defun speedbar-item-info ()
1661 "Display info in the mini-buffer about the button the mouse is over.
1662 This function can be replaced in `speedbar-mode-functions-list' as
1663 `speedbar-item-info'"
1665 (let (message-log-max)
1666 (funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info)
1667 'speedbar-generic-item-info))))
1669 (defun speedbar-item-info-file-helper (&optional filename)
1670 "Display info about a file that is on the current line.
1671 nil if not applicable. If FILENAME, then use that instead of reading
1672 it from the speedbar buffer."
1673 (let* ((item (or filename (speedbar-line-file)))
1674 (attr (if item (file-attributes item) nil)))
1675 (if (and item attr) (speedbar-message "%s %-6d %s" (nth 8 attr)
1679 (defun speedbar-item-info-tag-helper ()
1680 "Display info about a tag that is on the current line.
1681 nil if not applicable."
1684 (if (re-search-forward " > \\([^ ]+\\)$"
1685 (save-excursion(end-of-line)(point)) t)
1686 (let ((tag (match-string 1))
1687 (attr (get-text-property (match-beginning 1)
1690 (looking-at "\\([0-9]+\\):")
1691 (setq item (speedbar-line-path (string-to-int (match-string 1))))
1692 (speedbar-message "Tag: %s in %s @ %s"
1695 (marker-position attr)
1698 (if (re-search-forward "{[+-]} \\([^\n]+\\)$"
1699 (save-excursion(end-of-line)(point)) t)
1700 (speedbar-message "Group of tags \"%s\"" (match-string 1))
1703 (defun speedbar-files-item-info ()
1704 "Display info in the mini-buffer about the button the mouse is over."
1705 (if (not speedbar-shown-directories)
1706 (speedbar-generic-item-info)
1707 (or (speedbar-item-info-file-helper)
1708 (speedbar-item-info-tag-helper)
1709 (speedbar-generic-item-info))))
1711 (defun speedbar-item-copy ()
1712 "Copy the item under the cursor.
1713 Files can be copied to new names or places."
1715 (let ((f (speedbar-line-file)))
1716 (if (not f) (error "Not a file"))
1717 (if (file-directory-p f)
1718 (error "Cannot copy directory")
1719 (let* ((rt (read-file-name (format "Copy %s to: "
1720 (file-name-nondirectory f))
1721 (file-name-directory f)))
1722 (refresh (member (expand-file-name (file-name-directory rt))
1723 speedbar-shown-directories)))
1724 ;; Create the right file name part
1725 (if (file-directory-p rt)
1727 (concat (expand-file-name rt)
1728 (if (string-match "/$" rt) "" "/")
1729 (file-name-nondirectory f))))
1730 (if (or (not (file-exists-p rt))
1731 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
1733 (copy-file f rt t t)
1734 ;; refresh display if the new place is currently displayed.
1738 (if (not (speedbar-goto-this-file rt))
1739 (speedbar-goto-this-file f))))
1742 (defun speedbar-item-rename ()
1743 "Rename the item under the cursor or mouse.
1744 Files can be renamed to new names or moved to new directories."
1746 (let ((f (speedbar-line-file)))
1748 (let* ((rt (read-file-name (format "Rename %s to: "
1749 (file-name-nondirectory f))
1750 (file-name-directory f)))
1751 (refresh (member (expand-file-name (file-name-directory rt))
1752 speedbar-shown-directories)))
1753 ;; Create the right file name part
1754 (if (file-directory-p rt)
1756 (concat (expand-file-name rt)
1757 (if (string-match "/\\'" rt) "" "/")
1758 (file-name-nondirectory f))))
1759 (if (or (not (file-exists-p rt))
1760 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
1762 (rename-file f rt t)
1763 ;; refresh display if the new place is currently displayed.
1767 (speedbar-goto-this-file rt)
1769 (error "Not a file"))))
1771 (defun speedbar-item-delete ()
1772 "Delete the item under the cursor. Files are removed from disk."
1774 (let ((f (speedbar-line-file)))
1775 (if (not f) (error "Not a file"))
1776 (if (speedbar-y-or-n-p (format "Delete %s? " f))
1778 (if (file-directory-p f)
1779 (delete-directory f)
1781 (speedbar-message "Okie dokie..")
1788 (defun speedbar-item-object-delete ()
1789 "Delete the object associated from the item under the cursor.
1790 The file is removed from disk. The object is determined from the
1791 variable `speedbar-obj-alist'."
1793 (let* ((f (speedbar-line-file))
1795 (oa speedbar-obj-alist))
1796 (if (not f) (error "Not a file"))
1797 (while (and oa (not (string-match (car (car oa)) f)))
1799 (setq obj (concat (file-name-sans-extension f) (cdr (car oa))))
1800 (if (and oa (file-exists-p obj)
1801 (speedbar-y-or-n-p (format "Delete %s? " obj)))
1804 (speedbar-reset-scanners)))))
1806 (defun speedbar-enable-update ()
1807 "Enable automatic updating in speedbar via timers."
1809 (setq speedbar-update-flag t)
1810 (speedbar-set-mode-line-format)
1811 (speedbar-set-timer speedbar-update-speed))
1813 (defun speedbar-disable-update ()
1814 "Disable automatic updating and stop consuming resources."
1816 (setq speedbar-update-flag nil)
1817 (speedbar-set-mode-line-format)
1818 (speedbar-set-timer nil))
1820 (defun speedbar-toggle-updates ()
1821 "Toggle automatic update for the speedbar frame."
1823 (if speedbar-update-flag
1824 (speedbar-disable-update)
1825 (speedbar-enable-update)))
1827 (defun speedbar-toggle-sorting ()
1828 "Toggle automatic update for the speedbar frame."
1830 (setq speedbar-sort-tags (not speedbar-sort-tags)))
1832 (defun speedbar-toggle-show-all-files ()
1833 "Toggle display of files speedbar can not tag."
1835 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files))
1838 ;;; Utility functions
1840 (defun speedbar-set-timer (timeout)
1841 "Apply a timer with TIMEOUT, or remove a timer if TIMOUT is nil.
1842 TIMEOUT is the number of seconds until the speedbar timer is called
1843 again. When TIMEOUT is nil, turn off all timeouts.
1844 This function will also enable or disable the `vc-checkin-hook' used
1845 to track file check ins, and will change the mode line to match
1846 `speedbar-update-flag'."
1851 (progn (delete-itimer speedbar-timer)
1852 (setq speedbar-timer nil)))
1854 (if (and speedbar-xemacsp
1855 (or (>= emacs-major-version 20)
1856 (>= emacs-minor-version 15)))
1857 (setq speedbar-timer (start-itimer "speedbar"
1862 (setq speedbar-timer (start-itimer "speedbar"
1867 ((fboundp 'run-with-idle-timer)
1869 (progn (cancel-timer speedbar-timer)
1870 (setq speedbar-timer nil)))
1872 (setq speedbar-timer
1873 (run-with-idle-timer timeout t 'speedbar-timer-fn))))
1874 ;; Emacs 19.30 (Thanks twice: ptype@dra.hmg.gb)
1875 ((fboundp 'post-command-idle-hook)
1877 (add-hook 'post-command-idle-hook 'speedbar-timer-fn)
1878 (remove-hook 'post-command-idle-hook 'speedbar-timer-fn)))
1879 ;; Older or other Emacsen with no timers. Set up so that its
1880 ;; obvious this emacs can't handle the updates
1882 (setq speedbar-update-flag nil)))
1883 ;; Apply a revert hook that will reset the scanners. We attach to revert
1884 ;; because most reverts occur during VC state change, and this lets our
1885 ;; VC scanner fix itself.
1887 (add-hook 'after-revert-hook 'speedbar-reset-scanners)
1888 (remove-hook 'after-revert-hook 'speedbar-reset-scanners)
1890 ;; change this if it changed for some reason
1891 (speedbar-set-mode-line-format))
1893 (defmacro speedbar-with-writable (&rest forms)
1894 "Allow the buffer to be writable and evaluate FORMS."
1895 (list 'let '((inhibit-read-only t))
1896 (cons 'progn forms)))
1897 (put 'speedbar-with-writable 'lisp-indent-function 0)
1899 (defun speedbar-select-window (buffer)
1900 "Select a window in which BUFFER is shown.
1901 If it is not shown, force it to appear in the default window."
1902 (let ((win (get-buffer-window buffer speedbar-attached-frame)))
1905 (set-window-buffer (selected-window) buffer))))
1907 (defun speedbar-insert-button (text face mouse function
1908 &optional token prevline)
1909 "Insert TEXT as the next logical speedbar button.
1910 FACE is the face to put on the button, MOUSE is the highlight face to use.
1911 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1912 This function assumes that the current buffer is the speedbar buffer.
1913 If PREVLINE, then put this button on the previous line.
1915 This is a convenience function for special mode that create their own
1916 specialized speedbar displays."
1917 (goto-char (point-max))
1918 (if (/= (current-column) 0) (insert "\n"))
1919 (if prevline (progn (delete-char -1) (insert " "))) ;back up if desired...
1920 (let ((start (point)))
1922 (speedbar-make-button start (point) face mouse function token))
1923 (let ((start (point)))
1925 (put-text-property start (point) 'face nil)
1926 (put-text-property start (point) 'mouse-face nil)))
1928 (defun speedbar-make-button (start end face mouse function &optional token)
1929 "Create a button from START to END, with FACE as the display face.
1930 MOUSE is the mouse face. When this button is clicked on FUNCTION
1931 will be run with the TOKEN parameter (any Lisp object)"
1932 (put-text-property start end 'face face)
1933 (put-text-property start end 'mouse-face mouse)
1934 (put-text-property start end 'invisible nil)
1935 (if function (put-text-property start end 'speedbar-function function))
1936 (if token (put-text-property start end 'speedbar-token token))
1939 ;;; Initial Expansion list management
1941 (defun speedbar-initial-expansion-list ()
1942 "Return the current default expansion list.
1943 This is based on `speedbar-initial-expansion-list-name' referencing
1944 `speedbar-initial-expansion-mode-alist'."
1945 ;; cdr1 - name, cdr2 - menu
1946 (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name
1947 speedbar-initial-expansion-mode-alist)))))
1949 (defun speedbar-initial-menu ()
1950 "Return the current default menu data.
1951 This is based on `speedbar-initial-expansion-list-name' referencing
1952 `speedbar-initial-expansion-mode-alist'."
1954 (car (cdr (assoc speedbar-initial-expansion-list-name
1955 speedbar-initial-expansion-mode-alist)))))
1957 (defun speedbar-initial-keymap ()
1958 "Return the current default menu data.
1959 This is based on `speedbar-initial-expansion-list-name' referencing
1960 `speedbar-initial-expansion-mode-alist'."
1962 (car (cdr (cdr (assoc speedbar-initial-expansion-list-name
1963 speedbar-initial-expansion-mode-alist))))))
1965 (defun speedbar-initial-stealthy-functions ()
1966 "Return a list of functions to call stealthily.
1967 This is based on `speedbar-initial-expansion-list-name' referencing
1968 `speedbar-stealthy-function-list'."
1969 (cdr (assoc speedbar-initial-expansion-list-name
1970 speedbar-stealthy-function-list)))
1972 (defun speedbar-add-expansion-list (new-list)
1973 "Add NEW-LIST to the list of expansion lists."
1974 (add-to-list 'speedbar-initial-expansion-mode-alist new-list))
1976 (defun speedbar-change-initial-expansion-list (new-default)
1977 "Change speedbar's default expansion list to NEW-DEFAULT."
1980 (completing-read (format "Speedbar Mode (default %s): "
1981 speedbar-previously-used-expansion-list-name)
1982 speedbar-initial-expansion-mode-alist
1984 speedbar-previously-used-expansion-list-name)))
1985 (setq speedbar-previously-used-expansion-list-name
1986 speedbar-initial-expansion-list-name
1987 speedbar-initial-expansion-list-name new-default)
1989 (speedbar-reconfigure-keymaps))
1991 (defun speedbar-fetch-replacement-function (function)
1992 "Return a current mode specific replacement for function, or nil.
1993 Scans `speedbar-mode-functions-list' first for the current mode, then
1995 (cdr (assoc function
1996 (cdr (assoc speedbar-initial-expansion-list-name
1997 speedbar-mode-functions-list)))))
1999 (defun speedbar-add-mode-functions-list (new-list)
2000 "Add NEW-LIST to the list of mode functions.
2001 See `speedbar-mode-functions-list' for details."
2002 (add-to-list 'speedbar-mode-functions-list new-list))
2005 ;;; Special speedbar display management
2007 (defun speedbar-maybe-add-localized-support (buffer)
2008 "Quick check function called on BUFFERs by the speedbar timer function.
2009 Maintains the value of local variables which control speedbars use
2010 of the special mode functions."
2011 (or speedbar-special-mode-expansion-list
2012 (speedbar-add-localized-speedbar-support buffer)))
2014 (defun speedbar-add-localized-speedbar-support (buffer)
2015 "Add localized speedbar support to BUFFER's mode if it is available."
2016 (interactive "bBuffer: ")
2017 (if (stringp buffer) (setq buffer (get-buffer buffer)))
2018 (if (not (buffer-live-p buffer))
2023 (let ((ms (symbol-name major-mode)) v)
2024 (if (not (string-match "-mode$" ms))
2025 nil ;; do nothing to broken mode
2026 (setq ms (substring ms 0 (match-beginning 0)))
2027 (setq v (intern-soft (concat ms "-speedbar-buttons")))
2028 (make-local-variable 'speedbar-special-mode-expansion-list)
2030 (setq speedbar-special-mode-expansion-list t)
2031 ;; If it is autoloaded, we need to load it now so that
2032 ;; we have access to the varialbe -speedbar-menu-items.
2033 ;; Is this XEmacs safe?
2034 (let ((sf (symbol-function v)))
2035 (if (and (listp sf) (eq (car sf) 'autoload))
2036 (load-library (car (cdr sf)))))
2037 (setq speedbar-special-mode-expansion-list (list v))
2038 (setq v (intern-soft (concat ms "-speedbar-key-map")))
2040 nil ;; don't add special keymap
2041 (make-local-variable 'speedbar-special-mode-key-map)
2042 (setq speedbar-special-mode-key-map
2044 (setq v (intern-soft (concat ms "-speedbar-menu-items")))
2046 nil ;; don't add special menus
2047 (make-local-variable 'speedbar-easymenu-definition-special)
2048 (setq speedbar-easymenu-definition-special
2052 (defun speedbar-remove-localized-speedbar-support (buffer)
2053 "Remove any traces that BUFFER supports speedbar in a specialized way."
2056 (kill-local-variable 'speedbar-special-mode-expansion-list)
2057 (kill-local-variable 'speedbar-special-mode-key-map)
2058 (kill-local-variable 'speedbar-easymenu-definition-special)))
2060 ;;; File button management
2062 (defun speedbar-file-lists (directory)
2063 "Create file lists for DIRECTORY.
2064 The car is the list of directories, the cdr is list of files not
2065 matching ignored headers. Cache any directory files found in
2066 `speedbar-directory-contents-alist' and use that cache before scanning
2068 (setq directory (expand-file-name directory))
2069 ;; If in powerclick mode, then the directory we are getting
2070 ;; should be rescanned.
2071 (if speedbar-power-click
2072 (adelete 'speedbar-directory-contents-alist directory))
2073 ;; find the directory, either in the cache, or build it.
2074 (or (cdr-safe (assoc directory speedbar-directory-contents-alist))
2075 (let ((default-directory directory)
2076 (dir (directory-files directory nil))
2081 (or (string-match speedbar-file-unshown-regexp (car dir))
2082 (string-match speedbar-directory-unshown-regexp (car dir))))
2083 (if (file-directory-p (car dir))
2084 (setq dirs (cons (car dir) dirs))
2085 (setq files (cons (car dir) files))))
2086 (setq dir (cdr dir)))
2087 (let ((nl (cons (nreverse dirs) (list (nreverse files)))))
2088 (aput 'speedbar-directory-contents-alist directory nl)
2092 (defun speedbar-directory-buttons (directory index)
2093 "Insert a single button group at point for DIRECTORY.
2094 Each directory path part is a different button. If part of the path
2095 matches the user directory ~, then it is replaced with a ~.
2096 INDEX is not used, but is required by the caller."
2097 (let* ((tilde (expand-file-name "~"))
2098 (dd (expand-file-name directory))
2099 (junk (string-match (regexp-quote tilde) dd))
2101 (concat "~" (substring dd (match-end 0)))
2104 (if (string-match "^~/?\\'" displayme) (setq displayme (concat tilde "/")))
2108 (while (re-search-forward "\\([^/]+\\)/" nil t)
2109 (speedbar-make-button (match-beginning 1) (match-end 1)
2110 'speedbar-directory-face
2111 'speedbar-highlight-face
2112 'speedbar-directory-buttons-follow
2113 (if (and (= (match-beginning 1) p)
2114 (not (char-equal (char-after (+ p 1)) ?:)))
2115 (expand-file-name "~/") ;the tilde
2116 (buffer-substring-no-properties
2118 ;; Nuke the beginning of the directory if it's too long...
2119 (cond ((eq speedbar-directory-button-trim-method 'span)
2121 (let ((ww (or (speedbar-frame-width) 20)))
2122 (move-to-column ww nil)
2123 (while (>= (current-column) ww)
2124 (re-search-backward "/" nil t)
2125 (if (<= (current-column) 2)
2127 (re-search-forward "/" nil t)
2128 (if (< (current-column) 4)
2129 (re-search-forward "/" nil t))
2131 (if (looking-at "/?$")
2134 (move-to-column ww nil)))))
2135 ((eq speedbar-directory-button-trim-method 'trim)
2137 (let ((ww (or (speedbar-frame-width) 20))
2138 (tl (current-column)))
2141 (move-to-column (- tl ww))
2142 (if (re-search-backward "/" nil t)
2144 (delete-region (point-min) (point))
2148 (if (string-match "\\`/[^/]+/\\'" displayme)
2153 (speedbar-make-button p (point)
2154 'speedbar-directory-face
2155 'speedbar-highlight-face
2156 'speedbar-directory-buttons-follow
2159 (insert-char ?\n 1 nil)))
2161 (defun speedbar-make-tag-line (exp-button-type
2162 exp-button-char exp-button-function
2164 tag-button tag-button-function tag-button-data
2165 tag-button-face depth)
2166 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
2167 This is the button that expands or contracts a node (if applicable),
2168 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
2169 is the function to call if it's clicked on. Button types are
2170 'bracket, 'angle, 'curly, or nil. EXP-BUTTON-DATA is extra data
2171 attached to the text forming the expansion button.
2173 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
2174 function to call if clicked on, and TAG-BUTTON-DATA is the data to
2175 attach to the text field (such a tag positioning, etc).
2176 TAG-BUTTON-FACE is a face used for this type of tag.
2178 Lastly, DEPTH shows the depth of expansion.
2180 This function assumes that the cursor is in the speedbar window at the
2181 position to insert a new item, and that the new item will end with a CR"
2182 (let ((start (point))
2184 (insert (int-to-string depth) ":")
2186 (put-text-property start end 'invisible t)
2188 (insert-char ? depth nil)
2189 (put-text-property (- (point) depth) (point) 'invisible nil)
2190 (let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]")
2191 ((eq exp-button-type 'angle) "<%c>")
2192 ((eq exp-button-type 'curly) "{%c}")
2194 (buttxt (format exp-button exp-button-char))
2196 (end (progn (insert buttxt) (point)))
2197 (bf (if exp-button-type 'speedbar-button-face nil))
2198 (mf (if exp-button-function 'speedbar-highlight-face nil))
2200 (speedbar-make-button start end bf mf exp-button-function exp-button-data)
2201 (if speedbar-hide-button-brackets-flag
2203 (put-text-property start (1+ start) 'invisible t)
2204 (put-text-property end (1- end) 'invisible t)))
2206 (insert-char ? 1 nil)
2207 (put-text-property (1- (point)) (point) 'invisible nil)
2208 (let ((start (point))
2209 (end (progn (insert tag-button) (point))))
2210 (insert-char ?\n 1 nil)
2211 (put-text-property (1- (point)) (point) 'invisible nil)
2212 (speedbar-make-button start end tag-button-face
2213 (if tag-button-function 'speedbar-highlight-face nil)
2214 tag-button-function tag-button-data))
2217 (defun speedbar-change-expand-button-char (char)
2218 "Change the expansion button character to CHAR for the current line."
2221 (if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line)
2223 (speedbar-with-writable
2224 (goto-char (match-beginning 1))
2226 (insert-char char 1 t)
2227 (put-text-property (point) (1- (point)) 'invisible nil)))))
2230 ;;; Build button lists
2232 (defun speedbar-insert-files-at-point (files level)
2233 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2234 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2235 don't know how to manage them. The input parameter FILES is a cons
2236 cell of the form ( 'DIRLIST . 'FILELIST )"
2237 ;; Start inserting all the directories
2238 (let ((dirs (car files)))
2240 (speedbar-make-tag-line 'angle ?+ 'speedbar-dired (car dirs)
2241 (car dirs) 'speedbar-dir-follow nil
2242 'speedbar-directory-face level)
2243 (setq dirs (cdr dirs))))
2244 (let ((lst (car (cdr files)))
2245 (case-fold-search t))
2247 (let* ((known (string-match speedbar-file-regexp (car lst)))
2248 (expchar (if known ?+ ??))
2249 (fn (if known 'speedbar-tag-file nil)))
2250 (if (or speedbar-show-unknown-files (/= expchar ??))
2251 (speedbar-make-tag-line 'bracket expchar fn (car lst)
2252 (car lst) 'speedbar-find-file nil
2253 'speedbar-file-face level)))
2254 (setq lst (cdr lst)))))
2256 (defun speedbar-default-directory-list (directory index)
2257 "Insert files for DIRECTORY with level INDEX at point."
2258 (speedbar-insert-files-at-point
2259 (speedbar-file-lists directory) index)
2260 (speedbar-reset-scanners)
2262 ;; If the shown files variable has extra directories, then
2263 ;; it is our responsibility to redraw them all
2264 ;; Luckilly, the nature of inserting items into this list means
2265 ;; that by reversing it, we can easilly go in the right order
2266 (let ((sf (cdr (reverse speedbar-shown-directories))))
2267 (setq speedbar-shown-directories
2268 (list (expand-file-name default-directory)))
2269 ;; exand them all as we find them
2271 (if (speedbar-goto-this-file (car sf))
2274 (if (looking-at "[0-9]+:[ ]*<")
2276 (goto-char (match-end 0))
2277 (speedbar-do-function-pointer)))
2278 (setq sf (cdr sf)))))
2281 (defun speedbar-apply-one-tag-hierarchy-method (lst method)
2282 "Adjust the tag hierarchy LST by METHOD."
2285 (sort (copy-alist lst)
2286 (lambda (a b) (string< (car a) (car b)))))
2287 ((eq method 'prefix-group)
2292 (short-group-list nil)
2293 (short-start-name nil)
2294 (short-end-name nil)
2295 (num-shorts-grouped 0)
2296 (bins (make-vector 256 nil))
2298 ;; Break out sub-lists
2300 (if (listp (cdr-safe (car-safe lst)))
2301 (setq newlst (cons (car lst) newlst))
2302 (setq sublst (cons (car lst) sublst)))
2303 (setq lst (cdr lst)))
2304 ;; Reverse newlst because it was made backwards.
2305 ;; Sublist doesn't need reversing because the act
2306 ;; of binning things will reverse it for us.
2307 (setq newlst (nreverse newlst))
2308 ;; Now, first find out how long our list is. Never let a
2309 ;; list get-shorter than our minimum.
2310 (if (<= (length sublst) speedbar-tag-split-minimum-length)
2311 (setq work-list (nreverse sublst))
2312 (setq diff-idx (length (try-completion "" sublst)))
2313 ;; Sort the whole list into bins.
2315 (let ((e (car sublst))
2316 (s (car (car sublst))))
2317 (cond ((<= (length s) diff-idx)
2318 ;; 0 storage bin for shorty.
2319 (aset bins 0 (cons e (aref bins 0))))
2321 ;; stuff into a bin based on ascii value at diff
2322 (aset bins (aref s diff-idx)
2323 (cons e (aref bins (aref s diff-idx)))))))
2324 (setq sublst (cdr sublst)))
2325 ;; Go through all our bins Stick singles into our
2326 ;; junk-list, everything else as sublsts in work-list.
2327 ;; If two neighboring lists are both small, make a grouped
2328 ;; group combinding those two sub-lists.
2330 (while (> 256 diff-idx)
2331 (let ((l (nreverse ;; Reverse the list since they are stuck in
2333 (aref bins diff-idx))))
2335 (let ((tmp (cons (try-completion "" l) l)))
2336 (if (or (> (length l) speedbar-tag-regroup-maximum-length)
2337 (> (+ (length l) (length short-group-list))
2338 speedbar-tag-split-minimum-length))
2340 ;; We have reached a longer list, so we
2341 ;; must finish off a grouped group.
2343 ((and short-group-list
2344 (= (length short-group-list)
2345 num-shorts-grouped))
2346 ;; All singles? Junk list
2347 (setq junk-list (append short-group-list
2349 ((= num-shorts-grouped 1)
2350 ;; Only one short group? Just stick it in
2351 ;; there by itself. Make a group, and find
2353 (let ((subexpression (try-completion
2354 "" short-group-list)))
2355 (if (< (length subexpression)
2356 speedbar-tag-group-name-minimum-length)
2358 (concat short-start-name
2361 (car (car short-group-list))
2362 (length short-start-name))
2365 (cons (cons subexpression
2369 ;; Multiple groups to be named in a special
2370 ;; way by displaying the range over which we
2371 ;; have grouped them.
2373 (cons (cons (concat short-start-name
2376 (nreverse short-group-list))
2378 ;; Reset short group list information every time.
2379 (setq short-group-list nil
2380 short-start-name nil
2382 num-shorts-grouped 0)))
2383 ;; Ok, now that we cleaned up the short-group-list,
2384 ;; we can deal with this new list, to decide if it
2385 ;; should go on one of these sub-lists or not.
2386 (if (< (length l) speedbar-tag-regroup-maximum-length)
2387 (setq short-group-list (append short-group-list l)
2388 num-shorts-grouped (1+ num-shorts-grouped)
2389 short-end-name (car tmp)
2390 short-start-name (if short-start-name
2393 (setq work-list (cons tmp work-list))))))
2394 (setq diff-idx (1+ diff-idx))))
2395 ;; Did we run out of things? Drop our new list onto the end.
2397 ((and short-group-list (= (length short-group-list) num-shorts-grouped))
2398 ;; All singles? Junk list
2399 (setq junk-list (append short-group-list junk-list)))
2400 ((= num-shorts-grouped 1)
2401 ;; Only one short group? Just stick it in
2404 (cons (cons (try-completion "" short-group-list)
2408 ;; Multiple groups to be named in a special
2409 ;; way by displaying the range over which we
2410 ;; have grouped them.
2412 (cons (cons (concat short-start-name " to " short-end-name)
2415 ;; Reverse the work list nreversed when consing.
2416 (setq work-list (nreverse work-list))
2417 ;; Now, stick our new list onto the end of
2420 (append newlst work-list junk-list)
2421 (append newlst work-list))
2422 (append newlst junk-list))))
2423 ((eq method 'trim-words)
2430 (if (listp (cdr-safe (car-safe lst)))
2431 (setq newlst (cons (car lst) newlst))
2432 (setq sublst (cons (car lst) sublst)))
2433 (setq lst (cdr lst)))
2434 ;; Get the prefix to trim by. Make sure that we don't trim
2435 ;; off silly pieces, only complete understandable words.
2436 (setq trim-prefix (try-completion "" sublst))
2437 (if (or (= (length sublst) 1)
2439 (not (string-match "\\(\\w+\\W+\\)+" trim-prefix)))
2440 (append (nreverse newlst) (nreverse sublst))
2441 (setq trim-prefix (substring trim-prefix (match-beginning 0)
2443 (setq trim-chars (length trim-prefix))
2446 (cons (substring (car (car sublst)) trim-chars)
2449 sublst (cdr sublst)))
2450 ;; Put the lists together
2451 (append (nreverse newlst) trimlst))))
2452 ((eq method 'simple-group)
2456 (if (listp (cdr-safe (car-safe lst)))
2457 (setq newlst (cons (car lst) newlst))
2458 (setq sublst (cons (car lst) sublst)))
2459 (setq lst (cdr lst)))
2462 (setq newlst (cons (cons "Tags" (nreverse sublst)) newlst))
2463 (nreverse newlst))))
2466 (defun speedbar-create-tag-hierarchy (lst)
2467 "Adjust the tag hierarchy in LST, and return it.
2468 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2469 the list. See it's value for details."
2470 (let* ((f (save-excursion
2472 (speedbar-line-path)))
2473 (methods (if (get-file-buffer f)
2474 (save-excursion (set-buffer (get-file-buffer f))
2475 speedbar-tag-hierarchy-method)
2476 speedbar-tag-hierarchy-method)))
2478 (setq lst (speedbar-apply-one-tag-hierarchy-method lst (car methods))
2479 methods (cdr methods)))
2482 (defun speedbar-insert-generic-list (level lst expand-fun find-fun)
2483 "At LEVEL, insert a generic multi-level alist LST.
2484 Associations with lists get {+} tags (to expand into more nodes) and
2485 those with positions just get a > as the indicator. {+} buttons will
2486 have the function EXPAND-FUN and the token is the CDR list. The token
2487 name will have the function FIND-FUN and not token."
2488 ;; Remove imenu rescan button
2489 (if (string= (car (car lst)) "*Rescan*")
2490 (setq lst (cdr lst)))
2492 (setq lst (speedbar-create-tag-hierarchy lst))
2495 (cond ((null (car-safe lst)) nil) ;this would be a separator
2496 ((or (numberp (cdr-safe (car-safe lst)))
2497 (markerp (cdr-safe (car-safe lst))))
2498 (speedbar-make-tag-line nil nil nil nil ;no expand button data
2499 (car (car lst)) ;button name
2501 (cdr (car lst)) ;token is position
2504 ((listp (cdr-safe (car-safe lst)))
2505 (speedbar-make-tag-line 'curly ?+ expand-fun (cdr (car lst))
2506 (car (car lst)) ;button name
2507 nil nil 'speedbar-tag-face
2509 (t (speedbar-message "Ooops!")))
2510 (setq lst (cdr lst))))
2514 (defun speedbar-update-contents ()
2515 "Generically update the contents of the speedbar buffer."
2517 ;; Set the current special buffer
2518 (setq speedbar-desired-buffer nil)
2519 ;; Check for special modes
2520 (speedbar-maybe-add-localized-support (current-buffer))
2521 ;; Choose the correct method of doodling.
2522 (if (and speedbar-mode-specific-contents-flag
2523 (listp speedbar-special-mode-expansion-list)
2524 speedbar-special-mode-expansion-list
2526 'speedbar-special-mode-expansion-list
2528 ;;(eq (get major-mode 'mode-class 'special)))
2529 (speedbar-update-special-contents)
2530 (speedbar-update-directory-contents)))
2532 (defun speedbar-update-directory-contents ()
2533 "Update the contents of the speedbar buffer based on the current directory."
2534 (let ((cbd (expand-file-name default-directory))
2536 (funclst (speedbar-initial-expansion-list))
2537 (cache speedbar-full-text-cache)
2538 ;; disable stealth during update
2539 (speedbar-stealthy-function-list nil)
2542 ;; Because there is a bug I can't find just yet
2545 (set-buffer speedbar-buffer)
2546 ;; If we are updating contents to where we are, then this is
2547 ;; really a request to update existing contents, so we must be
2548 ;; careful with our text cache!
2549 (if (member cbd speedbar-shown-directories)
2552 ;; If the current directory is not the last element in the dir
2553 ;; list, then we ALSO need to zap the list of expanded directories
2554 (if (/= (length (member cbd speedbar-shown-directories)) 1)
2555 (setq speedbar-shown-directories (list cbd))))
2557 ;; Build cbd-parent, and see if THAT is in the current shown
2558 ;; directories. First, go through pains to get the parent directory
2559 (if (and speedbar-smart-directory-expand-flag
2561 (setq cbd-parent cbd)
2562 (if (string-match "/$" cbd-parent)
2563 (setq cbd-parent (substring cbd-parent 0
2564 (match-beginning 0))))
2565 (setq cbd-parent (file-name-directory cbd-parent)))
2566 (member cbd-parent speedbar-shown-directories))
2567 (setq expand-local t)
2569 ;; If this directory is NOT in the current list of available
2570 ;; paths, then use the cache, and set the cache to our new
2571 ;; value. Make sure to unhighlight the current file, or if we
2572 ;; come back to this directory, it might be a different file
2573 ;; and then we get a mess!
2574 (if (> (point-max) 1)
2576 (speedbar-clear-current-file)
2577 (setq speedbar-full-text-cache
2578 (cons speedbar-shown-directories (buffer-string)))))
2580 ;; Check if our new directory is in the list of directories
2581 ;; shown in the text-cache
2582 (if (member cbd (car cache))
2583 (setq speedbar-shown-directories (car cache)
2585 ;; default the shown directories to this list...
2586 (setq speedbar-shown-directories (list cbd)))
2588 (if (not expand-local) (setq speedbar-last-selected-file nil))
2589 (speedbar-with-writable
2590 (if (and expand-local
2591 ;; Find this directory as a speedbar node.
2592 (speedbar-path-line cbd))
2594 (speedbar-expand-line)
2597 (setq default-directory
2598 (nth (1- (length speedbar-shown-directories))
2599 speedbar-shown-directories))
2600 (insert (cdr cache)))
2603 (setq default-directory cbd)
2604 (funcall (car funclst) cbd 0)
2605 (setq funclst (cdr funclst))))))
2606 (goto-char (point-min)))))
2607 (speedbar-reconfigure-keymaps))
2609 (defun speedbar-update-special-contents ()
2610 "Used the mode-specific variable to fill in the speedbar buffer.
2611 This should only be used by modes classified as special."
2612 (let ((funclst speedbar-special-mode-expansion-list)
2613 (specialbuff (current-buffer)))
2615 (setq speedbar-desired-buffer specialbuff)
2616 (set-buffer speedbar-buffer)
2617 ;; If we are leaving a directory, cache it.
2618 (if (not speedbar-shown-directories)
2621 ;; Clean up directory maintenance stuff
2622 (speedbar-clear-current-file)
2623 (setq speedbar-full-text-cache
2624 (cons speedbar-shown-directories (buffer-string))
2625 speedbar-shown-directories nil))
2626 ;; Now fill in the buffer with our newly found specialized list.
2627 (speedbar-with-writable
2629 ;; We do not erase the buffer because these functions may
2630 ;; decide NOT to update themselves.
2631 (funcall (car funclst) specialbuff)
2632 (setq funclst (cdr funclst))))
2633 (goto-char (point-min))))
2634 (speedbar-reconfigure-keymaps))
2636 (defun speedbar-timer-fn ()
2637 "Run whenever Emacs is idle to update the speedbar item."
2638 (if (not (and (frame-live-p speedbar-frame)
2639 (frame-live-p speedbar-attached-frame)))
2640 (speedbar-set-timer nil)
2641 ;; Save all the match data so that we don't mess up executing fns
2643 ;; Only do stuff if the frame is visible, not an icon, and if
2644 ;; it is currently flagged to do something.
2645 (if (and speedbar-update-flag
2646 (frame-visible-p speedbar-frame)
2647 (not (eq (frame-visible-p speedbar-frame) 'icon)))
2648 (let ((af (selected-frame)))
2649 (save-window-excursion
2650 (select-frame speedbar-attached-frame)
2651 ;; make sure we at least choose a window to
2652 ;; get a good directory from
2653 (if (window-minibuffer-p (selected-window))
2655 ;; Check for special modes
2656 (speedbar-maybe-add-localized-support (current-buffer))
2657 ;; Update for special mode all the time!
2658 (if (and speedbar-mode-specific-contents-flag
2659 (listp speedbar-special-mode-expansion-list)
2660 speedbar-special-mode-expansion-list
2662 'speedbar-special-mode-expansion-list
2664 ;;(eq (get major-mode 'mode-class 'special)))
2666 (if (<= 2 speedbar-verbosity-level)
2668 "Updating speedbar to special mode: %s..."
2670 (speedbar-update-special-contents)
2671 (if (<= 2 speedbar-verbosity-level)
2674 "Updating speedbar to special mode: %s...done"
2676 (speedbar-message nil))))
2677 ;; Update all the contents if directories change!
2678 (if (or (member (expand-file-name default-directory)
2679 speedbar-shown-directories)
2680 (and speedbar-ignored-path-regexp
2682 speedbar-ignored-path-regexp
2683 (expand-file-name default-directory)))
2684 (member major-mode speedbar-ignored-modes)
2685 (eq af speedbar-frame)
2686 (not (buffer-file-name)))
2688 (if (<= 1 speedbar-verbosity-level)
2689 (speedbar-message "Updating speedbar to: %s..."
2691 (speedbar-update-directory-contents)
2692 (if (<= 1 speedbar-verbosity-level)
2694 (speedbar-message "Updating speedbar to: %s...done"
2696 (speedbar-message nil)))))
2698 ;; Now run stealthy updates of time-consuming items
2699 (speedbar-stealthy-updates)))
2700 ;; Now run the mouse tracking system
2701 (speedbar-show-info-under-mouse)))
2702 (run-hooks 'speedbar-timer-hook))
2705 ;;; Stealthy activities
2707 (defvar speedbar-stealthy-update-recurse nil
2708 "Recursion avoidance variable for stealthy update.")
2710 (defun speedbar-stealthy-updates ()
2711 "For a given speedbar, run all items in the stealthy function list.
2712 Each item returns t if it completes successfully, or nil if
2713 interrupted by the user."
2714 (if (not speedbar-stealthy-update-recurse)
2715 (let ((l (speedbar-initial-stealthy-functions))
2716 (speedbar-stealthy-update-recurse t))
2718 (speedbar-with-writable
2719 (while (and l (funcall (car l)))
2722 ;;(speedbar-message "Exit with %S" (car l))
2725 (defun speedbar-reset-scanners ()
2726 "Reset any variables used by functions in the stealthy list as state.
2727 If new functions are added, their state needs to be updated here."
2728 (setq speedbar-vc-to-do-point t
2729 speedbar-obj-to-do-point t)
2730 (run-hooks 'speedbar-scanner-reset-hook)
2733 (defun speedbar-find-selected-file (file)
2734 "Goto the line where FILE is."
2735 (goto-char (point-min))
2737 (while (and (setq m (re-search-forward
2738 (concat " \\(" (file-name-nondirectory file)
2739 "\\)\\(" speedbar-indicator-regex "\\)?\n")
2745 (goto-char (match-beginning 0))
2748 (looking-at "[0-9]+:")
2749 (string-to-number (match-string 0)))))
2750 (match-string 1))))))
2753 (goto-char (match-beginning 1))
2754 (match-string 1)))))
2756 (defun speedbar-clear-current-file ()
2757 "Locate the file thought to be current, and remove its highlighting."
2759 (set-buffer speedbar-buffer)
2760 (if speedbar-last-selected-file
2761 (speedbar-with-writable
2762 (if (speedbar-find-selected-file speedbar-last-selected-file)
2763 (put-text-property (match-beginning 1)
2766 'speedbar-file-face))))))
2768 (defun speedbar-update-current-file ()
2769 "Find the current file, and update our visuals to indicate its name.
2770 This is specific to file names. If the file name doesn't show up, but
2771 it should be in the list, then the directory cache needs to be
2773 (let* ((lastf (selected-frame))
2774 (newcfd (save-excursion
2775 (select-frame speedbar-attached-frame)
2776 (let ((rf (if (buffer-file-name)
2779 (select-frame lastf)
2781 (newcf (if newcfd newcfd))
2782 (lastb (current-buffer))
2783 (sucf-recursive (boundp 'sucf-recursive))
2784 (case-fold-search t))
2786 ;; check here, that way we won't refresh to newcf until
2787 ;; its been written, thus saving ourselves some time
2788 (file-exists-p newcf)
2789 (not (string= newcf speedbar-last-selected-file)))
2791 ;; It is important to select the frame, otherwise the window
2792 ;; we want the cursor to move in will not be updated by the
2793 ;; search-forward command.
2794 (select-frame speedbar-frame)
2795 ;; Remove the old file...
2796 (speedbar-clear-current-file)
2797 ;; now highlight the new one.
2798 (set-buffer speedbar-buffer)
2799 (speedbar-with-writable
2800 (if (speedbar-find-selected-file newcf)
2801 ;; put the property on it
2802 (put-text-property (match-beginning 1)
2805 'speedbar-selected-face)
2806 ;; Oops, it's not in the list. Should it be?
2807 (if (and (string-match speedbar-file-regexp newcf)
2808 (string= (file-name-directory newcfd)
2809 (expand-file-name default-directory)))
2810 ;; yes, it is (we will ignore unknowns for now...)
2813 (if (speedbar-find-selected-file newcf)
2814 ;; put the property on it
2815 (put-text-property (match-beginning 1)
2818 'speedbar-selected-face)))
2819 ;; if it's not in there now, whatever...
2821 (setq speedbar-last-selected-file newcf))
2822 (if (not sucf-recursive)
2824 (speedbar-center-buffer-smartly)
2825 (speedbar-position-cursor-on-line)
2828 (select-frame lastf)
2830 ;; return that we are done with this activity.
2833 (defun speedbar-add-indicator (indicator-string &optional replace-this)
2834 "Add INDICATOR-STRING to the end of this speedbar line.
2835 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2836 an the existing indicator is removed. If there is already an
2837 indicator, then do not add a space."
2839 ;; The nature of the beast: Assume we are in "the right place"
2841 (skip-chars-backward (concat " " speedbar-vc-indicator
2842 (car speedbar-obj-indicator)
2843 (cdr speedbar-obj-indicator)))
2844 (if (and (not (looking-at speedbar-indicator-regex))
2845 (not (string= indicator-string " ")))
2846 (insert speedbar-indicator-separator))
2847 (speedbar-with-writable
2849 (if (and replace-this
2850 (re-search-forward replace-this (save-excursion (end-of-line)
2853 (delete-region (match-beginning 0) (match-end 0))))
2855 (if (not (string= " " indicator-string))
2856 (insert indicator-string))))
2858 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2859 ;; Steven L Baur <steve@xemacs.org> said this was important:
2860 (eval-when-compile (or (featurep 'xemacs)
2861 (condition-case () (require 'efs)
2862 (error (require 'ange-ftp)))))
2864 (defun speedbar-check-vc ()
2865 "Scan all files in a directory, and for each see if it's checked out.
2866 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2867 to add more types of version control systems."
2868 ;; Check for to-do to be reset. If reset but no RCS is available
2869 ;; then set to nil (do nothing) otherwise, start at the beginning
2871 (set-buffer speedbar-buffer)
2872 (if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t)
2873 (speedbar-vc-check-dir-p default-directory)
2874 (not (or (and (featurep 'ange-ftp)
2876 (car (if speedbar-xemacsp
2877 ange-ftp-path-format
2878 ange-ftp-name-format))
2879 (expand-file-name default-directory)))
2880 ;; efs support: Bob Weiner
2881 (and (featurep 'efs)
2883 (car efs-path-regexp)
2884 (expand-file-name default-directory))))))
2885 (setq speedbar-vc-to-do-point 0))
2886 (if (numberp speedbar-vc-to-do-point)
2888 (goto-char speedbar-vc-to-do-point)
2889 (while (and (not (input-pending-p))
2890 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
2892 (setq speedbar-vc-to-do-point (point))
2893 (if (speedbar-check-vc-this-line (match-string 1))
2894 (speedbar-add-indicator speedbar-vc-indicator
2895 (regexp-quote speedbar-vc-indicator))
2896 (speedbar-add-indicator " "
2897 (regexp-quote speedbar-vc-indicator))))
2898 (if (input-pending-p)
2899 ;; return that we are incomplete
2901 ;; we are done, set to-do to nil
2902 (setq speedbar-vc-to-do-point nil)
2907 (defun speedbar-check-vc-this-line (depth)
2908 "Return t if the file on this line is check of of a version control system.
2909 Parameter DEPTH is a string with the current depth of indentation of
2910 the file being checked."
2911 (let* ((d (string-to-int depth))
2912 (f (speedbar-line-path d))
2913 (fn (buffer-substring-no-properties
2914 ;; Skip-chars: thanks ptype@dra.hmg.gb
2916 (skip-chars-forward "^ "
2917 (save-excursion (end-of-line)
2920 (fulln (concat f fn)))
2921 (if (<= 2 speedbar-verbosity-level)
2922 (speedbar-message "Speedbar vc check...%s" fulln))
2923 (and (file-writable-p fulln)
2924 (speedbar-this-file-in-vc f fn))))
2926 (defun speedbar-vc-check-dir-p (path)
2927 "Return t if we should bother checking PATH for version control files.
2928 This can be overloaded to add new types of version control systems."
2931 (file-exists-p (concat path "RCS/"))
2933 (file-exists-p (concat path "SCCS/"))
2934 ;; Remote SCCS project
2935 (let ((proj-dir (getenv "PROJECTDIR")))
2937 (file-exists-p (concat proj-dir "/SCCS"))
2940 (run-hook-with-args 'speedbar-vc-path-enable-hook path)
2943 (defun speedbar-this-file-in-vc (path name)
2944 "Check to see if the file in PATH with NAME is in a version control system.
2945 You can add new VC systems by overriding this function. You can
2946 optimize this function by overriding it and only doing those checks
2947 that will occur on your system."
2950 (file-exists-p (concat path "RCS/" name ",v"))
2951 (file-exists-p (concat path "RCS/" name))
2952 ;; Local SCCS file name
2953 (file-exists-p (concat path "SCCS/s." name))
2954 ;; Remote SCCS file name
2955 (let ((proj-dir (getenv "PROJECTDIR")))
2957 (file-exists-p (concat proj-dir "/SCCS/s." name))
2960 (run-hook-with-args 'speedbar-vc-in-control-hook path name)
2963 ;; Objet File scanning
2964 (defun speedbar-check-objects ()
2965 "Scan all files in a directory, and for each see if there is an object.
2966 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2967 to add more object types."
2968 ;; Check for to-do to be reset. If reset but no RCS is available
2969 ;; then set to nil (do nothing) otherwise, start at the beginning
2971 (set-buffer speedbar-buffer)
2972 (if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t))
2973 (setq speedbar-obj-to-do-point 0))
2974 (if (numberp speedbar-obj-to-do-point)
2976 (goto-char speedbar-obj-to-do-point)
2977 (while (and (not (input-pending-p))
2978 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
2980 (setq speedbar-obj-to-do-point (point))
2981 (let ((ind (speedbar-check-obj-this-line (match-string 1))))
2982 (if (not ind) (setq ind " "))
2983 (speedbar-add-indicator ind (concat
2984 (car speedbar-obj-indicator)
2986 (cdr speedbar-obj-indicator)))))
2987 (if (input-pending-p)
2988 ;; return that we are incomplete
2990 ;; we are done, set to-do to nil
2991 (setq speedbar-obj-to-do-point nil)
2996 (defun speedbar-check-obj-this-line (depth)
2997 "Return t if the file on this line has an associated object.
2998 Parameter DEPTH is a string with the current depth of indentation of
2999 the file being checked."
3000 (let* ((d (string-to-int depth))
3001 (f (speedbar-line-path d))
3002 (fn (buffer-substring-no-properties
3003 ;; Skip-chars: thanks ptype@dra.hmg.gb
3005 (skip-chars-forward "^ "
3006 (save-excursion (end-of-line)
3009 (fulln (concat f fn)))
3010 (if (<= 2 speedbar-verbosity-level)
3011 (speedbar-message "Speedbar obj check...%s" fulln))
3012 (let ((oa speedbar-obj-alist))
3013 (while (and oa (not (string-match (car (car oa)) fulln)))
3015 (if (not (and oa (file-exists-p (concat (file-name-sans-extension fulln)
3018 ;; Find out if the object is out of date or not.
3019 (let ((date1 (nth 5 (file-attributes fulln)))
3020 (date2 (nth 5 (file-attributes (concat
3021 (file-name-sans-extension fulln)
3023 (if (or (< (car date1) (car date2))
3024 (and (= (car date1) (car date2))
3025 (< (nth 1 date1) (nth 1 date2))))
3026 (car speedbar-obj-indicator)
3027 (cdr speedbar-obj-indicator)))))))
3029 ;;; Clicking Activity
3031 (defun speedbar-quick-mouse (e)
3032 "Since mouse events are strange, this will keep the mouse nicely positioned.
3033 This should be bound to mouse event E."
3036 (speedbar-position-cursor-on-line)
3039 (defun speedbar-position-cursor-on-line ()
3040 "Position the cursor on a line."
3041 (let ((oldpos (point)))
3043 (if (looking-at "[0-9]+:\\s-*..?.? ")
3044 (goto-char (1- (match-end 0)))
3045 (goto-char oldpos))))
3047 (defun speedbar-power-click (e)
3048 "Activate any speedbar button as a power click.
3049 This should be bound to mouse event E."
3051 (let ((speedbar-power-click t))
3052 (speedbar-click e)))
3054 (defun speedbar-click (e)
3055 "Activate any speedbar buttons where the mouse is clicked.
3056 This must be bound to a mouse event. A button is any location of text
3057 with a mouse face that has a text property called `speedbar-function'.
3058 This should be bound to mouse event E."
3061 (speedbar-do-function-pointer)
3062 (speedbar-quick-mouse e))
3064 (defun speedbar-double-click (e)
3065 "Activate any speedbar buttons where the mouse is clicked.
3066 This must be bound to a mouse event. A button is any location of text
3067 with a mouse face that has a text property called `speedbar-function'.
3068 This should be bound to mouse event E."
3070 ;; Emacs only. XEmacs handles this via `mouse-track-click-hook'.
3071 (cond ((eq (car e) 'down-mouse-1)
3072 (mouse-set-point e))
3073 ((eq (car e) 'mouse-1)
3074 (speedbar-quick-mouse e))
3075 ((or (eq (car e) 'double-down-mouse-1)
3076 (eq (car e) 'triple-down-mouse-1))
3078 (speedbar-do-function-pointer)
3079 (speedbar-quick-mouse e))))
3081 (defun speedbar-do-function-pointer ()
3082 "Look under the cursor and examine the text properties.
3083 From this extract the file/tag name, token, indentation level and call
3084 a function if appropriate"
3085 (let* ((fn (get-text-property (point) 'speedbar-function))
3086 (tok (get-text-property (point) 'speedbar-token))
3087 ;; The 1-,+ is safe because scaning starts AFTER the point
3088 ;; specified. This lets the search include the character the
3090 (tp (previous-single-property-change
3091 (1+ (point)) 'speedbar-function))
3092 (np (next-single-property-change
3093 (point) 'speedbar-function))
3094 (txt (buffer-substring-no-properties (or tp (point-min))
3095 (or np (point-max))))
3096 (dent (save-excursion (beginning-of-line)
3098 (if (looking-at "[0-9]+")
3099 (buffer-substring-no-properties
3100 (match-beginning 0) (match-end 0))
3102 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3103 (and fn (funcall fn txt tok dent)))
3104 (speedbar-position-cursor-on-line))
3106 ;;; Reading info from the speedbar buffer
3108 (defun speedbar-line-text (&optional p)
3109 "Retrieve the text after prefix junk for the current line.
3110 Optional argument P is where to start the search from."
3112 (if p (goto-char p))
3114 (if (looking-at (concat
3115 "\\([0-9]+\\): *[[<{][-+?][]>}] \\([^ \n]+\\)\\("
3116 speedbar-indicator-regex "\\)?"))
3120 (defun speedbar-line-token (&optional p)
3121 "Retrieve the token information after the prefix junk for the current line.
3122 Optional argument P is where to start the search from."
3124 (if p (goto-char p))
3126 (if (looking-at (concat
3127 "\\([0-9]+\\): *[[<{][-+?][]>}] \\([^ \n]+\\)\\("
3128 speedbar-indicator-regex "\\)?"))
3130 (goto-char (match-beginning 2))
3131 (get-text-property (point) 'speedbar-token))
3134 (defun speedbar-line-file (&optional p)
3135 "Retrieve the file or whatever from the line at P point.
3136 The return value is a string representing the file. If it is a
3137 directory, then it is the directory name."
3139 (let ((f (speedbar-line-text p)))
3141 (let* ((depth (string-to-int (match-string 1)))
3142 (path (speedbar-line-path depth)))
3146 (defun speedbar-goto-this-file (file)
3147 "If FILE is displayed, goto this line and return t.
3148 Otherwise do not move and return nil."
3149 (let ((path (substring (file-name-directory (expand-file-name file))
3150 (length (expand-file-name default-directory))))
3153 (goto-char (point-min))
3154 ;; scan all the directories
3155 (while (and path (not (eq path t)))
3156 (if (string-match "^/?\\([^/]+\\)" path)
3157 (let ((pp (match-string 1 path)))
3158 (if (save-match-data
3159 (re-search-forward (concat "> " (regexp-quote pp) "$")
3161 (setq path (substring path (match-end 1)))
3164 ;; find the file part
3165 (if (or (not path) (string= (file-name-nondirectory file) ""))
3166 ;; only had a dir part
3169 (speedbar-position-cursor-on-line)
3171 (goto-char dest) nil)
3172 ;; find the file part
3173 (let ((nd (file-name-nondirectory file)))
3174 (if (re-search-forward
3175 (concat "] \\(" (regexp-quote nd)
3176 "\\)\\(" speedbar-indicator-regex "\\)$")
3179 (speedbar-position-cursor-on-line)
3184 (defun speedbar-line-path (&optional depth)
3185 "Retrieve the pathname associated with the current line.
3186 This may require traversing backwards from DEPTH and combining the default
3187 directory with these items. This function is replaceable in
3188 `speedbar-mode-functions-list' as `speedbar-line-path'"
3189 (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-path)))
3190 (if rf (funcall rf depth) default-directory)))
3192 (defun speedbar-files-line-path (&optional depth)
3193 "Retrieve the pathname associated with the current line.
3194 This may require traversing backwards from DEPTH and combining the default
3195 directory with these items."
3201 (looking-at "^\\([0-9]+\\):")
3202 (setq depth (string-to-int (match-string 1)))))
3204 (setq depth (1- depth))
3205 (while (/= depth -1)
3206 (if (not (re-search-backward (format "^%d:" depth) nil t))
3207 (error "Error building path of tag")
3208 (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)$")
3209 (setq path (concat (buffer-substring-no-properties
3210 (match-beginning 1) (match-end 1))
3213 ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)$")
3214 ;; This is the start of our path.
3215 (setq path (buffer-substring-no-properties
3216 (match-beginning 1) (match-end 1))))))
3217 (setq depth (1- depth)))
3219 (string-match (concat speedbar-indicator-regex "$")
3221 (setq path (substring path 0 (match-beginning 0))))
3222 (concat default-directory path)))))
3224 (defun speedbar-path-line (path)
3225 "Position the cursor on the line specified by PATH."
3227 (if (string-match "/$" path)
3228 (setq path (substring path 0 (match-beginning 0))))
3229 (let ((nomatch t) (depth 0)
3230 (fname (file-name-nondirectory path))
3231 (pname (file-name-directory path)))
3232 (if (not (member pname speedbar-shown-directories))
3233 (error "Internal Error: File %s not shown in speedbar" path))
3234 (goto-char (point-min))
3237 (concat "[]>] \\(" (regexp-quote fname)
3238 "\\)\\(" speedbar-indicator-regex "\\)?$")
3241 (looking-at "\\([0-9]+\\):")
3242 (setq depth (string-to-int (match-string 0))
3243 nomatch (not (string= pname (speedbar-line-path depth))))
3248 (defun speedbar-edit-line ()
3249 "Edit whatever tag or file is on the current speedbar line."
3253 ;; If this fails, then it is a non-standard click, and as such,
3254 ;; perfectly allowed.
3255 (if (re-search-forward "[]>?}] [^ ]"
3256 (save-excursion (end-of-line) (point))
3258 (speedbar-do-function-pointer)
3260 (speedbar-do-function-pointer)))
3262 (defun speedbar-expand-line ()
3263 "Expand the line under the cursor."
3266 (re-search-forward ":\\s-*.\\+. " (save-excursion (end-of-line) (point)))
3268 (speedbar-do-function-pointer))
3270 (defun speedbar-contract-line ()
3271 "Contract the line under the cursor."
3274 (re-search-forward ":\\s-*.-. " (save-excursion (end-of-line) (point)))
3276 (speedbar-do-function-pointer))
3278 (if speedbar-xemacsp
3279 (defalias 'speedbar-mouse-event-p 'button-press-event-p)
3280 (defun speedbar-mouse-event-p (event)
3281 "Return t if the event is a mouse related event"
3282 ;; And Emacs does it this way
3283 (if (and (listp event)
3284 (member (event-basic-type event)
3285 '(mouse-1 mouse-2 mouse-3)))
3289 (defun speedbar-maybee-jump-to-attached-frame ()
3290 "Jump to the attached frame ONLY if this was not a mouse event."
3291 (if (or (not (speedbar-mouse-event-p last-input-event))
3292 speedbar-activity-change-focus-flag)
3294 (select-frame speedbar-attached-frame)
3297 (defun speedbar-find-file (text token indent)
3298 "Speedbar click handler for filenames.
3299 TEXT, the file will be displayed in the attached frame.
3300 TOKEN is unused, but required by the click handler. INDENT is the
3301 current indentation level."
3302 (let ((cdd (speedbar-line-path indent)))
3303 (speedbar-find-file-in-frame (concat cdd text))
3304 (speedbar-stealthy-updates)
3305 (run-hooks 'speedbar-visiting-file-hook)
3306 ;; Reset the timer with a new timeout when cliking a file
3307 ;; in case the user was navigating directories, we can cancel
3308 ;; that other timer.
3309 (speedbar-set-timer speedbar-update-speed))
3310 (speedbar-maybee-jump-to-attached-frame))
3312 (defun speedbar-dir-follow (text token indent)
3313 "Speedbar click handler for directory names.
3314 Clicking a directory will cause the speedbar to list files in the
3315 the subdirectory TEXT. TOKEN is an unused requirement. The
3316 subdirectory chosen will be at INDENT level."
3317 (setq default-directory
3318 (concat (expand-file-name (concat (speedbar-line-path indent) text))
3320 ;; Because we leave speedbar as the current buffer,
3321 ;; update contents will change directory without
3322 ;; having to touch the attached frame. Turn off smart expand just
3324 (let ((speedbar-smart-directory-expand-flag nil))
3325 (speedbar-update-contents))
3326 (speedbar-set-timer speedbar-navigating-speed)
3327 (setq speedbar-last-selected-file nil)
3328 (speedbar-stealthy-updates))
3330 (defun speedbar-delete-subblock (indent)
3331 "Delete text from point to indentation level INDENT or greater.
3332 Handles end-of-sublist smartly."
3333 (speedbar-with-writable
3335 (end-of-line) (forward-char 1)
3336 (let ((start (point)))
3337 (while (and (looking-at "^\\([0-9]+\\):")
3338 (> (string-to-int (match-string 1)) indent)
3341 (beginning-of-line))
3342 (delete-region start (point))))))
3344 (defun speedbar-dired (text token indent)
3345 "Speedbar click handler for directory expand button.
3346 Clicking this button expands or contracts a directory. TEXT is the
3347 button clicked which has either a + or -. TOKEN is the directory to be
3348 expanded. INDENT is the current indentation level."
3349 (cond ((string-match "+" text) ;we have to expand this dir
3350 (setq speedbar-shown-directories
3351 (cons (expand-file-name
3352 (concat (speedbar-line-path indent) token "/"))
3353 speedbar-shown-directories))
3354 (speedbar-change-expand-button-char ?-)
3355 (speedbar-reset-scanners)
3357 (end-of-line) (forward-char 1)
3358 (speedbar-with-writable
3359 (speedbar-default-directory-list
3360 (concat (speedbar-line-path indent) token "/")
3362 ((string-match "-" text) ;we have to contract this node
3363 (speedbar-reset-scanners)
3364 (let ((oldl speedbar-shown-directories)
3366 (td (expand-file-name
3367 (concat (speedbar-line-path indent) token))))
3369 (if (not (string-match (concat "^" (regexp-quote td)) (car oldl)))
3370 (setq newl (cons (car oldl) newl)))
3371 (setq oldl (cdr oldl)))
3372 (setq speedbar-shown-directories (nreverse newl)))
3373 (speedbar-change-expand-button-char ?+)
3374 (speedbar-delete-subblock indent)
3376 (t (error "Ooops... not sure what to do")))
3377 (speedbar-center-buffer-smartly)
3378 (setq speedbar-last-selected-file nil)
3379 (save-excursion (speedbar-stealthy-updates)))
3381 (defun speedbar-directory-buttons-follow (text token indent)
3382 "Speedbar click handler for default directory buttons.
3383 TEXT is the button clicked on. TOKEN is the directory to follow.
3384 INDENT is the current indentation level and is unused."
3385 (if (string-match "^[A-z]:$" token)
3386 (setq default-directory (concat token (char-to-string directory-sep-char)))
3387 (setq default-directory token))
3388 ;; Because we leave speedbar as the current buffer,
3389 ;; update contents will change directory without
3390 ;; having to touch the attached frame.
3391 (speedbar-update-contents)
3392 (speedbar-set-timer speedbar-navigating-speed))
3394 (defun speedbar-tag-file (text token indent)
3395 "The cursor is on a selected line. Expand the tags in the specified file.
3396 The parameter TEXT and TOKEN are required, where TEXT is the button
3397 clicked, and TOKEN is the file to expand. INDENT is the current
3399 (cond ((string-match "+" text) ;we have to expand this file
3400 (let* ((fn (expand-file-name (concat (speedbar-line-path indent)
3402 (lst (if speedbar-use-imenu-flag
3403 (let ((tim (speedbar-fetch-dynamic-imenu fn)))
3405 (speedbar-fetch-dynamic-etags fn)
3407 (speedbar-fetch-dynamic-etags fn))))
3408 ;; if no list, then remove expando button
3410 (speedbar-change-expand-button-char ??)
3411 (speedbar-change-expand-button-char ?-)
3412 (speedbar-with-writable
3414 (end-of-line) (forward-char 1)
3415 (speedbar-insert-generic-list indent
3416 lst 'speedbar-tag-expand
3417 'speedbar-tag-find))))))
3418 ((string-match "-" text) ;we have to contract this node
3419 (speedbar-change-expand-button-char ?+)
3420 (speedbar-delete-subblock indent))
3421 (t (error "Ooops... not sure what to do")))
3422 (speedbar-center-buffer-smartly))
3424 (defun speedbar-tag-find (text token indent)
3425 "For the tag TEXT in a file TOKEN, goto that position.
3426 INDENT is the current indentation level."
3427 (let ((file (speedbar-line-path indent)))
3428 (speedbar-find-file-in-frame file)
3429 (save-excursion (speedbar-stealthy-updates))
3430 ;; Reset the timer with a new timeout when cliking a file
3431 ;; in case the user was navigating directories, we can cancel
3432 ;; that other timer.
3433 (speedbar-set-timer speedbar-update-speed)
3435 (run-hooks 'speedbar-visiting-tag-hook)
3437 (speedbar-maybee-jump-to-attached-frame)
3440 (defun speedbar-tag-expand (text token indent)
3441 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3442 Etags does not support this feature. TEXT will be the button
3443 string. TOKEN will be the list, and INDENT is the current indentation
3445 (cond ((string-match "+" text) ;we have to expand this file
3446 (speedbar-change-expand-button-char ?-)
3447 (speedbar-with-writable
3449 (end-of-line) (forward-char 1)
3450 (speedbar-insert-generic-list indent token 'speedbar-tag-expand
3451 'speedbar-tag-find))))
3452 ((string-match "-" text) ;we have to contract this node
3453 (speedbar-change-expand-button-char ?+)
3454 (speedbar-delete-subblock indent))
3455 (t (error "Ooops... not sure what to do")))
3456 (speedbar-center-buffer-smartly))
3458 ;;; Loading files into the attached frame.
3460 (defun speedbar-find-file-in-frame (file)
3461 "This will load FILE into the speedbar attached frame.
3462 If the file is being displayed in a different frame already, then raise that
3464 (let* ((buff (find-file-noselect file))
3465 (bwin (get-buffer-window buff 0)))
3468 (select-window bwin)
3469 (raise-frame (window-frame bwin)))
3470 (if speedbar-power-click
3471 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3472 (select-frame speedbar-attached-frame)
3473 (switch-to-buffer buff))))
3476 ;;; Centering Utility
3478 (defun speedbar-center-buffer-smartly ()
3479 "Recenter a speedbar buffer so the current indentation level is all visible.
3480 This assumes that the cursor is on a file, or tag of a file which the user is
3482 (if (<= (count-lines (point-min) (point-max))
3483 (1- (window-height (selected-window))))
3484 ;; whole buffer fits
3486 (goto-char (point-min))
3490 (let (depth start end exp p)
3493 (setq depth (if (looking-at "[0-9]+")
3494 (string-to-int (buffer-substring-no-properties
3495 (match-beginning 0) (match-end 0)))
3497 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3500 (if (re-search-backward exp nil t)
3501 (setq start (point))
3502 (setq start (point-min)))
3503 (save-excursion ;Not sure about this part.
3506 (while (and (not (re-search-forward exp nil t))
3508 (setq depth (1- depth))
3509 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3512 (setq end (point-max)))))
3513 ;; Now work out the details of centering
3514 (let ((nl (count-lines start end))
3516 (if (> nl (window-height (selected-window)))
3517 ;; We can't fit it all, so just center on cursor
3518 (progn (goto-char start)
3520 ;; we can fit everything on the screen, but...
3521 (if (and (pos-visible-in-window-p start (selected-window))
3522 (pos-visible-in-window-p end (selected-window)))
3525 ;; we need to do something...
3527 (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
3528 (lte (count-lines start (point-max))))
3529 (if (and (< (+ newcent lte) (window-height (selected-window)))
3530 (> (- (window-height (selected-window)) lte 1)
3532 (setq newcent (- (window-height (selected-window))
3534 (recenter newcent))))
3538 ;;; Tag Management -- Imenu
3540 (if (not speedbar-use-imenu-flag)
3544 (eval-when-compile (if (locate-library "imenu") (require 'imenu)))
3546 (defun speedbar-fetch-dynamic-imenu (file)
3547 "Load FILE into a buffer, and generate tags using Imenu.
3548 Returns the tag list, or t for an error."
3549 ;; Load this AND compile it in
3552 (set-buffer (find-file-noselect file))
3553 (if speedbar-power-click (setq imenu--index-alist nil))
3555 (let ((index-alist (imenu--make-index-alist t)))
3556 (if speedbar-sort-tags
3557 (sort (copy-alist index-alist)
3558 (lambda (a b) (string< (car a) (car b))))
3563 ;;; Tag Management -- etags (old XEmacs compatibility part)
3565 (defvar speedbar-fetch-etags-parse-list
3566 '(;; Note that java has the same parse-group as c
3567 ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\)\\'" .
3568 speedbar-parse-c-or-c++tag)
3569 ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
3570 "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
3571 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3572 ; speedbar-parse-fortran77-tag)
3573 ("\\.tex\\'" . speedbar-parse-tex-string)
3575 "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?")
3577 "Associations of file extensions and expressions for extracting tags.
3578 To add a new file type, you would want to add a new association to the
3579 list, where the car is the file match, and the cdr is the way to
3580 extract an element from the tags output. If the output is complex,
3581 use a function symbol instead of regexp. The function should expect
3582 to be at the beginning of a line in the etags buffer.
3584 This variable is ignored if `speedbar-use-imenu-flag' is non-nil.")
3586 (defvar speedbar-fetch-etags-command "etags"
3587 "*Command used to create an etags file.
3589 This variable is ignored if `speedbar-use-imenu-flag' is t")
3591 (defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-")
3592 "*List of arguments to use with `speedbar-fetch-etags-command'.
3593 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3594 modify this list conveniently.
3596 This variable is ignored if `speedbar-use-imenu-flag' is t")
3598 (defun speedbar-toggle-etags (flag)
3599 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3600 FLAG then becomes a member of etags command line arguments. If flag
3601 is \"sort\", then toggle the value of `speedbar-sort-tags'. If its
3602 value is \"show\" then toggle the value of
3603 `speedbar-show-unknown-files'.
3605 This function is a convenience function for XEmacs menu created by
3606 Farzin Guilak <farzin@protocol.com>"
3609 ((equal flag "sort")
3610 (setq speedbar-sort-tags (not speedbar-sort-tags)))
3611 ((equal flag "show")
3612 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files)))
3613 ((or (equal flag "-C")
3616 (if (member flag speedbar-fetch-etags-arguments)
3617 (setq speedbar-fetch-etags-arguments
3618 (delete flag speedbar-fetch-etags-arguments))
3619 (add-to-list 'speedbar-fetch-etags-arguments flag)))
3622 (defun speedbar-fetch-dynamic-etags (file)
3623 "For FILE, run etags and create a list of symbols extracted.
3624 Each symbol will be associated with its line position in FILE."
3625 (let ((newlist nil))
3628 (if (get-buffer "*etags tmp*")
3629 (kill-buffer "*etags tmp*")) ;kill to clean it up
3630 (if (<= 1 speedbar-verbosity-level)
3631 (speedbar-message "Fetching etags..."))
3632 (set-buffer (get-buffer-create "*etags tmp*"))
3633 (apply 'call-process speedbar-fetch-etags-command nil
3634 (current-buffer) nil
3635 (append speedbar-fetch-etags-arguments (list file)))
3636 (goto-char (point-min))
3637 (if (<= 1 speedbar-verbosity-level)
3638 (speedbar-message "Fetching etags..."))
3640 (let ((exprlst speedbar-fetch-etags-parse-list)
3642 (while (and (not ans) exprlst)
3643 (if (string-match (car (car exprlst)) file)
3644 (setq ans (car exprlst)))
3645 (setq exprlst (cdr exprlst)))
3649 (while (not (save-excursion (end-of-line) (eobp)))
3651 (setq tnl (speedbar-extract-one-symbol expr)))
3652 (if tnl (setq newlist (cons tnl newlist)))
3655 "Sorry, no support for a file of that extension"))))
3657 (if speedbar-sort-tags
3658 (sort newlist (lambda (a b) (string< (car a) (car b))))
3659 (reverse newlist))))
3661 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3662 ;; sure it's needed with the different sorting method.
3664 ;(defun speedbar-clean-etags()
3665 ; "Removes spaces before the ^? character, and removes `#define',
3666 ;return types, etc. preceding tags. This ensures that the sort operation
3667 ;works on the tags, not the return types."
3669 ; (goto-char (point-min))
3671 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3672 ; (replace-match "\C-?" nil nil))
3673 ; (goto-char (point-min))
3675 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3676 ; (delete-region (match-beginning 1) (match-end 1)))))
3678 (defun speedbar-extract-one-symbol (expr)
3679 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3680 The line should contain output from etags. Parse the output using the
3681 regular expression EXPR"
3682 (let* ((sym (if (stringp expr)
3684 (re-search-forward expr (save-excursion
3687 (buffer-substring-no-properties (match-beginning 1)
3690 (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)"
3696 (1+ (string-to-int (buffer-substring-no-properties
3704 (defun speedbar-parse-c-or-c++tag ()
3705 "Parse a c or c++ tag, which tends to be a little complex."
3707 (let ((bound (save-excursion (end-of-line) (point))))
3708 (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t)
3709 (buffer-substring-no-properties (match-beginning 1)
3711 ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t)
3712 (buffer-substring-no-properties (match-beginning 1)
3714 ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t)
3715 (buffer-substring-no-properties (match-beginning 1)
3720 (defun speedbar-parse-tex-string ()
3721 "Parse a Tex string. Only find data which is relevant."
3723 (let ((bound (save-excursion (end-of-line) (point))))
3724 (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t)
3725 (buffer-substring-no-properties (match-beginning 0)
3730 ;;; BUFFER DISPLAY mode.
3732 (defvar speedbar-buffers-key-map nil
3733 "Keymap used when in the buffers display mode.")
3735 (if speedbar-buffers-key-map
3737 (setq speedbar-buffers-key-map (speedbar-make-specialized-keymap))
3739 ;; Basic tree features
3740 (define-key speedbar-buffers-key-map "e" 'speedbar-edit-line)
3741 (define-key speedbar-buffers-key-map "\C-m" 'speedbar-edit-line)
3742 (define-key speedbar-buffers-key-map "+" 'speedbar-expand-line)
3743 (define-key speedbar-buffers-key-map "-" 'speedbar-contract-line)
3745 ;; Buffer specific keybindings
3746 (define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer)
3747 (define-key speedbar-buffers-key-map "r" 'speedbar-buffer-revert-buffer)
3751 (defvar speedbar-buffer-easymenu-definition
3752 '(["Jump to buffer" speedbar-edit-line t]
3753 ["Expand File Tags" speedbar-expand-line
3754 (save-excursion (beginning-of-line)
3755 (looking-at "[0-9]+: *.\\+. "))]
3756 ["Contract File Tags" speedbar-contract-line
3757 (save-excursion (beginning-of-line)
3758 (looking-at "[0-9]+: *.-. "))]
3760 "Menu item elements shown when displaying a buffer list.")
3762 (defun speedbar-buffer-buttons (directory zero)
3763 "Create speedbar buttons based on the buffers currently loaded.
3764 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3765 (speedbar-buffer-buttons-engine nil))
3767 (defun speedbar-buffer-buttons-temp (directory zero)
3768 "Create speedbar buttons based on the buffers currently loaded.
3769 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3770 (speedbar-buffer-buttons-engine t))
3772 (defun speedbar-buffer-buttons-engine (temp)
3773 "Create speedbar buffer buttons.
3774 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3775 (insert "Active Buffers:\n")
3776 (let ((bl (buffer-list)))
3778 (if (string-match "^[ *]" (buffer-name (car bl)))
3780 (let* ((known (string-match speedbar-file-regexp
3781 (buffer-name (car bl))))
3782 (expchar (if known ?+ ??))
3783 (fn (if known 'speedbar-tag-file nil))
3784 (fname (save-excursion (set-buffer (car bl))
3785 (buffer-file-name))))
3786 (speedbar-make-tag-line 'bracket expchar fn fname
3787 (buffer-name (car bl))
3788 'speedbar-buffer-click temp
3789 'speedbar-file-face 0)))
3791 (setq bl (buffer-list))
3792 (insert "Scratch Buffers:\n")
3794 (if (not (string-match "^\\*" (buffer-name (car bl))))
3796 (if (eq (car bl) speedbar-buffer)
3798 (speedbar-make-tag-line 'bracket ?? nil nil
3799 (buffer-name (car bl))
3800 'speedbar-buffer-click temp
3801 'speedbar-file-face 0)))
3803 (setq bl (buffer-list))
3804 (insert "Hidden Buffers:\n")
3806 (if (not (string-match "^ " (buffer-name (car bl))))
3808 (if (eq (car bl) speedbar-buffer)
3810 (speedbar-make-tag-line 'bracket ?? nil nil
3811 (buffer-name (car bl))
3812 'speedbar-buffer-click temp
3813 'speedbar-file-face 0)))
3814 (setq bl (cdr bl)))))
3816 (defun speedbar-buffers-item-info ()
3817 "Display information about the current buffer on the current line."
3818 (or (speedbar-item-info-tag-helper)
3819 (let* ((item (speedbar-line-text))
3820 (buffer (if item (get-buffer item) nil)))
3822 (speedbar-message "%s%s %S %d %s"
3823 (if (buffer-modified-p buffer) "* " "")
3825 (save-excursion (set-buffer buffer) major-mode)
3826 (save-excursion (set-buffer buffer)
3828 (or (buffer-file-name buffer) "<No file>"))))))
3830 (defun speedbar-buffers-line-path (&optional depth)
3831 "Fetch the full path to the file (buffer) specified on the current line.
3832 Optional argument DEPTH specifies the current depth of the back search."
3834 ;; Buffers are always at level 0
3835 (if (not (re-search-backward "^0:" nil t))
3837 (let* ((bn (speedbar-line-text))
3838 (buffer (if bn (get-buffer bn))))
3839 (if buffer (file-name-directory (buffer-file-name buffer))))))
3841 (defun speedbar-buffer-click (text token indent)
3842 "When the users clicks on a buffer-button in speedbar.
3843 TEXT is the buffer's name, TOKEN and INDENT are unused."
3844 (if speedbar-power-click
3845 (let ((pop-up-frames t)) (select-window (display-buffer text)))
3846 (select-frame speedbar-attached-frame)
3847 (switch-to-buffer text)
3848 (if token (speedbar-change-initial-expansion-list
3849 speedbar-previously-used-expansion-list-name))))
3851 (defun speedbar-buffer-kill-buffer ()
3852 "Kill the buffer the cursor is on in the speedbar buffer."
3856 ;; If this fails, then it is a non-standard click, and as such,
3857 ;; perfectly allowed.
3858 (if (re-search-forward "[]>?}] [^ ]"
3859 (save-excursion (end-of-line) (point))
3863 (buffer-substring (point) (save-excursion
3866 (if (and (get-buffer text)
3867 (speedbar-y-or-n-p (format "Kill buffer %s? " text)))
3869 (speedbar-refresh))))))
3871 (defun speedbar-buffer-revert-buffer ()
3872 "Revert the buffer the cursor is on in the speedbar buffer."
3876 ;; If this fails, then it is a non-standard click, and as such,
3877 ;; perfectly allowed
3878 (if (re-search-forward "[]>?}] [^ ]"
3879 (save-excursion (end-of-line) (point))
3883 (buffer-substring (point) (save-excursion
3886 (if (get-buffer text)
3889 (revert-buffer t)))))))
3893 ;;; Color loading section This is messy *Blech!*
3895 (defface speedbar-button-face '((((class color) (background light))
3896 (:foreground "green4"))
3897 (((class color) (background dark))
3898 (:foreground "green3")))
3899 "Face used for +/- buttons."
3900 :group 'speedbar-faces)
3902 (defface speedbar-file-face '((((class color) (background light))
3903 (:foreground "cyan4"))
3904 (((class color) (background dark))
3905 (:foreground "cyan"))
3907 "Face used for file names."
3908 :group 'speedbar-faces)
3910 (defface speedbar-directory-face '((((class color) (background light))
3911 (:foreground "blue4"))
3912 (((class color) (background dark))
3913 (:foreground "light blue")))
3914 "Faced used for directory names."
3915 :group 'speedbar-faces)
3916 (defface speedbar-tag-face '((((class color) (background light))
3917 (:foreground "brown"))
3918 (((class color) (background dark))
3919 (:foreground "yellow")))
3920 "Face used for displaying tags."
3921 :group 'speedbar-faces)
3923 (defface speedbar-selected-face '((((class color) (background light))
3924 (:foreground "red" :underline t))
3925 (((class color) (background dark))
3926 (:foreground "red" :underline t))
3928 "Face used to underline the file in the active window."
3929 :group 'speedbar-faces)
3931 (defface speedbar-highlight-face '((((class color) (background light))
3932 (:background "green"))
3933 (((class color) (background dark))
3934 (:background "sea green"))
3935 (((class grayscale monochrome)
3937 (:background "black"))
3938 (((class grayscale monochrome)
3940 (:background "white")))
3941 "Face used for highlighting buttons with the mouse."
3942 :group 'speedbar-faces)
3944 ;; some edebug hooks
3945 (add-hook 'edebug-setup-hook
3947 (def-edebug-spec speedbar-with-writable def-body)))
3950 ;;; speedbar ends here
3952 ;; run load-time hooks
3953 (run-hooks 'speedbar-load-hook)