1 ;;; speedbar --- quick access to files and tags in a frame
3 ;;; Copyright (C) 1996, 97, 98, 99, 00 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 ;; This file requires the library package assoc (association lists)
100 ;;; Developing for speedbar
102 ;; Adding a speedbar specialized display mode:
104 ;; Speedbar can be configured to create a special display for certain
105 ;; modes that do not display tradition file/tag data. Rmail, Info,
106 ;; and the debugger are examples. These modes can, however, benefit
107 ;; from a speedbar style display in their own way.
109 ;; If your `major-mode' is `foo-mode', the only requirement is to
110 ;; create a function called `foo-speedbar-buttons' which takes one
111 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
112 ;; In `foo-speedbar-buttons' there are several functions that make
113 ;; building a speedbar display easy. See the documentation for
114 ;; `speedbar-with-writable' (needed because the buffer is usually
115 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
116 ;; `speedbar-insert-generic-list'. If you use
117 ;; `speedbar-insert-generic-list', also read the doc for
118 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
119 ;; The function `speedbar-with-attached-buffer' brings you back to the
120 ;; buffer speedbar is displaying for.
122 ;; For those functions that make buttons, the "function" should be a
123 ;; symbol that is the function to call when clicked on. The "token"
124 ;; is extra data you can pass along. The "function" must take three
125 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
126 ;; button clicked on. TOKEN is the data passed in when you create the
127 ;; button. INDENT is an indentation level, or 0. You can store
128 ;; indentation levels with `speedbar-make-tag-line' which creates a
129 ;; line with an expander (eg. [+]) and a text button.
131 ;; Some useful functions when writing expand functions, and click
132 ;; functions are `speedbar-change-expand-button-char',
133 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
134 ;; The variable `speedbar-power-click' is set to t in your functions
135 ;; when the user shift-clicks. This indications anything from
136 ;; refreshing cached data to making a buffer appear in a new frame.
138 ;; If you wish to add to the default speedbar menu for the case of
139 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
140 ;; should be a list compatible with the `easymenu' package. It will
141 ;; be spliced into the main menu. (Available with click-mouse-3). If
142 ;; you wish to have extra key bindings in your special mode, create a
143 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
144 ;; or `make-sparse-keymap', use the function
145 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
146 ;; speedbar's default bindings with low overhead.
148 ;; Adding a speedbar top-level display mode:
150 ;; Unlike the specialized modes, there are no name requirements,
151 ;; however the methods for writing a button display, menu, and keymap
152 ;; are the same. Once you create these items, you can call the
153 ;; function `speedbar-add-expansion-list'. It takes one parameter
154 ;; which is a list element of the form (NAME MENU KEYMAP &rest
155 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
156 ;; Displays menu item. MENU is a symbol containing the menu items to
157 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
158 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
160 ;; Another tweekable variable is `speedbar-stealthy-function-list'
161 ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
162 ;; name matching `speedbar-add-expansion-list'. (It does not need to
163 ;; exist.). This provides additional display info which might be
164 ;; time-consuming to calculate.
165 ;; Lastly, `speedbar-mode-functions-list' allows you to set special
166 ;; function overrides. At the moment very few functions are
167 ;; over ridable, but more will be added as the need is discovered.
170 ;; - More functions to create buttons and options
171 ;; - Timeout directories we haven't visited in a while.
180 (defvar speedbar-xemacsp (string-match "XEmacs" emacs-version)
181 "Non-nil if we are running in the XEmacs environment.")
182 (defvar speedbar-xemacs20p (and speedbar-xemacsp
183 (>= emacs-major-version 20)))
185 ;; customization stuff
186 (defgroup speedbar nil
187 "File and tag browser frame."
193 (defgroup speedbar-faces nil
194 "Faces used in speedbar."
199 (defgroup speedbar-vc nil
200 "Version control display in speedbar."
205 (defvar speedbar-initial-expansion-mode-alist
206 '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
207 speedbar-buffer-buttons)
208 ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
209 speedbar-buffer-buttons-temp)
210 ;; Files last, means first in the Displays menu
211 ("files" speedbar-easymenu-definition-special speedbar-file-key-map
212 speedbar-directory-buttons speedbar-default-directory-list)
214 "List of named expansion elements for filling the speedbar frame.
215 These expansion lists are only valid for regular files. Special modes
216 still get to override this list on a mode-by-mode basis. This list of
217 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
218 representing the types of things to be displayed. MENU is an easymenu
219 structure used when in this mode. KEYMAP is a local keymap to install
220 over the regular speedbar keymap. FN1 ... are functions that will be
221 called in order. These functions will always get the default
222 directory to use passed in as the first parameter, and a 0 as the
223 second parameter. The 0 indicates the uppermost indentation level.
224 They must assume that the cursor is at the position where they start
227 (defvar speedbar-initial-expansion-list-name "files"
228 "A symbol name representing the expansion list to use.
229 The expansion list `speedbar-initial-expansion-mode-alist' contains
230 the names and associated functions to use for buttons in speedbar.")
232 (defvar speedbar-previously-used-expansion-list-name "files"
233 "Save the last expansion list method.
234 This is used for returning to a previous expansion list method when
235 the user is done with the current expansion list.")
237 (defvar speedbar-stealthy-function-list
239 speedbar-update-current-file speedbar-check-vc speedbar-check-objects)
241 "List of functions to periodically call stealthily.
242 This list is of the form:
243 '( (\"NAME\" FUNCTION ...)
245 where NAME is the name of the major display mode these functions are
246 for, and the remaining elements FUNCTION are functions to call in order.
247 Each function must return nil if interrupted, or t if completed.
248 Stealthy functions which have a single operation should always return
249 t. Functions which take a long time should maintain a state (where
250 they are in their speedbar related calculations) and permit
251 interruption. See `speedbar-check-vc' as a good example.")
253 (defvar speedbar-mode-functions-list
254 '(("files" (speedbar-item-info . speedbar-files-item-info)
255 (speedbar-line-path . speedbar-files-line-path))
256 ("buffers" (speedbar-item-info . speedbar-buffers-item-info)
257 (speedbar-line-path . speedbar-buffers-line-path))
258 ("quick buffers" (speedbar-item-info . speedbar-buffers-item-info)
259 (speedbar-line-path . speedbar-buffers-line-path))
261 "List of function tables to use for different major display modes.
262 It is not necessary to define any functions for a specialized mode.
263 This just provides a simple way of adding lots of customizations.
264 Each sublist is of the form:
265 (\"NAME\" (FUNCTIONSYMBOL . REPLACEMENTFUNCTION) ...)
266 Where NAME is the name of the specialized mode. The rest of the list
267 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
268 of a function you would like to replace, and REPLACEMENTFUNCTION,
269 which is a function you can call instead. Not all functions can be
270 replaced this way. Replaceable functions must provide that
271 functionality individually.")
273 (defcustom speedbar-mode-specific-contents-flag t
274 "*Non-nil means speedbar will show special mode contents.
275 This permits some modes to create customized contents for the speedbar
280 (defvar speedbar-special-mode-expansion-list nil
281 "Default function list for creating specialized button lists.
282 This list is set by modes that wish to have special speedbar displays.
283 The list is of function names. Each function is called with one
284 parameter BUFFER, the originating buffer. The current buffer is the
287 (defvar speedbar-special-mode-key-map nil
288 "Default keymap used when identifying a specialized display mode.
289 This keymap is local to each buffer that wants to define special keybindings
290 effective when it's display is shown.")
292 (defcustom speedbar-visiting-file-hook nil
293 "Hooks run when speedbar visits a file in the selected frame."
297 (defcustom speedbar-visiting-tag-hook '(speedbar-highlight-one-tag-line)
298 "Hooks run when speedbar visits a tag in the selected frame."
301 :options '(speedbar-highlight-one-tag-line
302 speedbar-recenter-to-top
306 (defcustom speedbar-load-hook nil
307 "Hooks run when speedbar is loaded."
311 (defcustom speedbar-reconfigure-keymaps-hook nil
312 "Hooks run when the keymaps are regenerated."
316 (defcustom speedbar-show-unknown-files nil
317 "*Non-nil show files we can't expand with a ? in the expand button.
318 nil means don't show the file in the list."
322 (defcustom speedbar-update-speed
324 (if speedbar-xemacs20p
325 2 ; 1 is too obrusive in XEmacs
326 5) ; when no idleness, need long delay
328 "*Idle time in seconds needed before speedbar will update itself.
329 Updates occur to allow speedbar to display directory information
330 relevant to the buffer you are currently editing."
334 ;; When I moved to a repeating timer, I had the horrible missfortune
335 ;; of loosing the ability for adaptive speed choice. This update
336 ;; speed currently causes long delays when it should have been turned off.
337 (defcustom speedbar-navigating-speed speedbar-update-speed
338 "*Idle time to wait after navigation commands in speedbar are executed.
339 Navigation commands included expanding/contracting nodes, and moving
340 between different directories."
344 (defcustom speedbar-frame-parameters '((minibuffer . nil)
349 "*Parameters to use when creating the speedbar frame in Emacs.
350 Any parameter supported by a frame may be added. The parameter `height'
351 will be initialized to the height of the frame speedbar is
352 attached to and added to this list before the new frame is initialized."
354 :type '(repeat (sexp :tag "Parameter:")))
356 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
357 (defcustom speedbar-frame-plist
358 '(minibuffer nil width 20 border-width 0
359 internal-border-width 0 unsplittable t
360 default-toolbar-visible-p nil has-modeline-p nil
361 menubar-visible-p nil)
362 "*Parameters to use when creating the speedbar frame in XEmacs.
363 Parameters not listed here which will be added automatically are
364 `height' which will be initialized to the height of the frame speedbar
367 :type '(repeat (group :inline t
368 (symbol :tag "Property")
369 (sexp :tag "Value"))))
371 (defcustom speedbar-use-imenu-flag (stringp (locate-library "imenu"))
372 "*Non-nil means use imenu for file parsing. nil to use etags.
373 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
374 use etags instead. Etags support is not as robust as imenu support."
375 :tag "Use Imenu for tags"
379 (defvar speedbar-dynamic-tags-function-list
380 '((speedbar-fetch-dynamic-imenu . speedbar-insert-imenu-list)
381 (speedbar-fetch-dynamic-etags . speedbar-insert-etags-list))
382 "Set to a functions which will return and insert a list of tags.
383 Each element is of the form ( FETCH . INSERT ) where FETCH
384 is a funciotn which takes one parameter (the file to tag) and returns a
385 list of tags. The tag list can be of any form as long as the
386 corresponding insert method can handle it. If it returns t, then an
387 error occured, and the next fetch routine is tried.
388 INSERT is a function which takes an INDENTation level, and a LIST of
389 tags to insert. It will then create the speedbar buttons.")
391 (defcustom speedbar-track-mouse-flag t
392 "*Non-nil means to display info about the line under the mouse."
396 (defcustom speedbar-sort-tags nil
397 "*If Non-nil, sort tags in the speedbar display. *Obsolete*."
401 (defcustom speedbar-tag-hierarchy-method
402 '(speedbar-prefix-group-tag-hierarchy
403 speedbar-trim-words-tag-hierarchy)
404 "*List of hooks which speedbar will use to organize tags into groups.
405 Groups are defined as expandable meta-tags. Imenu supports
406 such things in some languages, such as separating variables from
407 functions. Each hook takes one argument LST, and may destructivly
408 create a new list of the same form. LST is a list of elements of the
411 where each ELT is of the form
412 (TAG-NAME-STRING . NUMBER-OR-MARKER)
414 (GROUP-NAME-STRING ELT1 EL2... ELTn)"
417 :options '(speedbar-sort-tag-hierarchy
418 speedbar-trim-words-tag-hierarchy
419 speedbar-prefix-group-tag-hierarchy
420 speedbar-simple-group-tag-hierarchy)
423 (defcustom speedbar-tag-group-name-minimum-length 4
424 "*The minimum length of a prefix group name before expanding.
425 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
426 and one such groups common characters is less than this number of
427 characters, then the group name will be changed to the form of:
431 This way we won't get silly looking listings."
435 (defcustom speedbar-tag-split-minimum-length 20
436 "*Minimum length before we stop trying to create sub-lists in tags.
437 This is used by all tag-hierarchy methods that break large lists into
442 (defcustom speedbar-tag-regroup-maximum-length 10
443 "*Maximum length of submenus that are regrouped.
444 If the regrouping option is used, then if two or more short subgroups
445 are next to each other, then they are combined until this number of
450 (defcustom speedbar-activity-change-focus-flag nil
451 "*Non-nil means the selected frame will change based on activity.
452 Thus, if a file is selected for edit, the buffer will appear in the
453 selected frame and the focus will change to that frame."
457 (defcustom speedbar-directory-button-trim-method 'span
458 "*Indicates how the directory button will be displayed.
460 'span - span large directories over multiple lines.
461 'trim - trim large directories to only show the last few.
464 :type '(radio (const :tag "Span large directories over mutiple lines."
466 (const :tag "Trim large directories to only show the last few."
468 (const :tag "No trimming." nil)))
470 (defcustom speedbar-smart-directory-expand-flag t
471 "*Non-nil means speedbar should use smart expansion.
472 Smart expansion only affects when speedbar wants to display a
473 directory for a file in the attached frame. When smart expansion is
474 enabled, new directories which are children of a displayed directory
475 are expanded in the current framework. If nil, then the current
476 hierarchy would be replaced with the new directory."
480 (defcustom speedbar-indentation-width 1
481 "*When sub-nodes are expanded, the number of spaces used for indentation."
485 (defcustom speedbar-hide-button-brackets-flag nil
486 "*Non-nil means speedbar will hide the brackets around the + or -."
490 (defcustom speedbar-use-images (and (or (fboundp 'defimage)
491 (fboundp 'make-image-specifier))
493 "*Non nil if speedbar should display icons."
497 (defcustom speedbar-before-popup-hook nil
498 "*Hooks called before popping up the speedbar frame."
502 (defcustom speedbar-before-delete-hook nil
503 "*Hooks called before deleting the speedbar frame."
507 (defcustom speedbar-mode-hook nil
508 "*Hooks called after creating a speedbar buffer."
512 (defcustom speedbar-timer-hook nil
513 "*Hooks called after running the speedbar timer function."
517 (defcustom speedbar-verbosity-level 1
518 "*Verbosity level of the speedbar. 0 means say nothing.
519 1 means medium level verbosity. 2 and higher are higher levels of
524 (defvar speedbar-indicator-separator " "
525 "String separating file text from indicator characters.")
527 (defcustom speedbar-vc-do-check t
528 "*Non-nil check all files in speedbar to see if they have been checked out.
529 Any file checked out is marked with `speedbar-vc-indicator'"
533 (defvar speedbar-vc-indicator "*"
534 "Text used to mark files which are currently checked out.
535 Other version control systems can be added by examining the function
536 `speedbar-vc-path-enable-hook' and `speedbar-vc-in-control-hook'.")
538 (defcustom speedbar-vc-path-enable-hook nil
539 "*Return non-nil if the current path should be checked for Version Control.
540 Functions in this hook must accept one parameter which is the path
545 (defcustom speedbar-vc-in-control-hook nil
546 "*Return non-nil if the specified file is under Version Control.
547 Functions in this hook must accept two parameters. The PATH of the
548 current file, and the FILENAME of the file being checked."
552 (defvar speedbar-vc-to-do-point nil
553 "Local variable maintaining the current version control check position.")
555 (defcustom speedbar-obj-do-check t
556 "*Non-nil check all files in speedbar to see if they have an object file.
557 Any file checked out is marked with `speedbar-obj-indicator', and the
558 marking is based on `speedbar-obj-alist'"
562 (defvar speedbar-obj-to-do-point nil
563 "Local variable maintaining the current version control check position.")
565 (defvar speedbar-obj-indicator '("#" . "!")
566 "Text used to mark files that have a corresponding hidden object file.
567 The car is for an up-to-date object. The cdr is for an out of date object.
568 The expression `speedbar-obj-alist' defines who gets tagged.")
570 (defvar speedbar-obj-alist
571 '(("\\.\\([cpC]\\|cpp\\|cc\\)$" . ".o")
573 ("\\.java$" . ".class")
574 ("\\.f\\(or\\|90\\|77\\)?$" . ".o")
576 ("\\.texi$" . ".info"))
577 "Alist of file extensions, and their corresponding object file type.")
579 (defvar speedbar-indicator-regex
580 (concat (regexp-quote speedbar-indicator-separator)
582 (regexp-quote speedbar-vc-indicator)
584 (regexp-quote (car speedbar-obj-indicator))
586 (regexp-quote (cdr speedbar-obj-indicator))
588 "Regular expression used when identifying files.
589 Permits stripping of indicator characters from a line.")
591 (defcustom speedbar-scanner-reset-hook nil
592 "*Hook called whenever generic scanners are reset.
593 Set this to implement your own scanning / rescan safe functions with
598 (defvar speedbar-ignored-modes nil
599 "*List of major modes which speedbar will not switch directories for.")
601 (defun speedbar-extension-list-to-regex (extlist)
602 "Takes EXTLIST, a list of extensions and transforms it into regexp.
603 All the preceding `.' are stripped for an optimized expression starting
604 with `.' followed by extensions, followed by full-filenames."
605 (let ((regex1 nil) (regex2 nil))
607 (if (= (string-to-char (car extlist)) ?.)
608 (setq regex1 (concat regex1 (if regex1 "\\|" "")
609 (substring (car extlist) 1)))
610 (setq regex2 (concat regex2 (if regex2 "\\|" "") (car extlist))))
611 (setq extlist (cdr extlist)))
612 ;; concat all the sub-exressions together, making sure all types
613 ;; of parts exist during concatination.
615 (if regex1 (concat "\\(\\.\\(" regex1 "\\)\\)") "")
616 (if (and regex1 regex2) "\\|" "")
617 (if regex2 (concat "\\(" regex2 "\\)") "")
620 (defvar speedbar-ignored-path-regexp nil
621 "Regular expression matching paths speedbar will not switch to.
622 Created from `speedbar-ignored-path-expressions' with the function
623 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
624 Use the function `speedbar-add-ignored-path-regexp', or customize the
625 variable `speedbar-ignored-path-expressions' to modify this variable.")
627 (defcustom speedbar-ignored-path-expressions
628 '("[/\\]logs?[/\\]\\'")
629 "*List of regular expressions matching directories speedbar will ignore.
630 They should included paths to directories which are notoriously very
631 large and take a long time to load in. Use the function
632 `speedbar-add-ignored-path-regexp' to add new items to this list after
633 speedbar is loaded. You may place anything you like in this list
634 before speedbar has been loaded."
636 :type '(repeat (regexp :tag "Path Regexp"))
637 :set (lambda (sym val)
638 (setq speedbar-ignored-path-expressions val
639 speedbar-ignored-path-regexp
640 (speedbar-extension-list-to-regex val))))
642 (defcustom speedbar-directory-unshown-regexp "^\\(CVS\\|RCS\\|SCCS\\)\\'"
643 "*Regular expression matching directories not to show in speedbar.
644 They should include commonly existing directories which are not
645 useful, such as version control."
649 (defvar speedbar-file-unshown-regexp
650 (let ((nstr "") (noext completion-ignored-extensions))
652 (setq nstr (concat nstr (regexp-quote (car noext)) "\\'"
653 (if (cdr noext) "\\|" ""))
655 ;; backup refdir lockfile
656 (concat nstr "\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
657 "*Regexp matching files we don't want displayed in a speedbar buffer.
658 It is generated from the variable `completion-ignored-extensions'")
660 ;; this is dangerous to customize, because the defaults will probably
661 ;; change in the future.
662 (defcustom speedbar-supported-extension-expressions
663 (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
664 ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?")
665 (if speedbar-use-imenu-flag
666 '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py"
667 ;; html is not supported by default, but an imenu tags package
668 ;; is available. Also, html files are nice to be able to see.
670 "[Mm]akefile\\(\\.in\\)?")))
671 "*List of regular expressions which will match files supported by tagging.
672 Do not prefix the `.' char with a double \\ to quote it, as the period
673 will be stripped by a simplified optimizer when compiled into a
674 singular expression. This variable will be turned into
675 `speedbar-file-regexp' for use with speedbar. You should use the
676 function `speedbar-add-supported-extension' to add a new extension at
677 runtime, or use the configuration dialog to set it in your .emacs
680 :type '(repeat (regexp :tag "Extension Regexp"))
681 :set (lambda (sym val)
682 (setq speedbar-supported-extension-expressions val
683 speedbar-file-regexp (speedbar-extension-list-to-regex val)))
686 (defvar speedbar-file-regexp
687 (speedbar-extension-list-to-regex speedbar-supported-extension-expressions)
688 "Regular expression matching files we know how to expand.
689 Created from `speedbar-supported-extension-expression' with the
690 function `speedbar-extension-list-to-regex'")
692 (defun speedbar-add-supported-extension (extension)
693 "Add EXTENSION as a new supported extension for speedbar tagging.
694 This should start with a `.' if it is not a complete file name, and
695 the dot should NOT be quoted in with \\. Other regular expression
696 matchers are allowed however. EXTENSION may be a single string or a
698 (interactive "sExtionsion: ")
699 (if (not (listp extension)) (setq extension (list extension)))
701 (if (member (car extension) speedbar-supported-extension-expressions)
703 (setq speedbar-supported-extension-expressions
704 (cons (car extension) speedbar-supported-extension-expressions)))
705 (setq extension (cdr extension)))
706 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
707 speedbar-supported-extension-expressions)))
709 (defun speedbar-add-ignored-path-regexp (path-expression)
710 "Add PATH-EXPRESSION as a new ignored path for speedbar tracking.
711 This function will modify `speedbar-ignored-path-regexp' and add
712 PATH-EXPRESSION to `speedbar-ignored-path-expressions'."
713 (interactive "sPath regex: ")
714 (if (not (listp path-expression))
715 (setq path-expression (list path-expression)))
716 (while path-expression
717 (if (member (car path-expression) speedbar-ignored-path-expressions)
719 (setq speedbar-ignored-path-expressions
720 (cons (car path-expression) speedbar-ignored-path-expressions)))
721 (setq path-expression (cdr path-expression)))
722 (setq speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
723 speedbar-ignored-path-expressions)))
725 ;; If we don't have custom, then we set it here by hand.
726 (if (not (fboundp 'custom-declare-variable))
727 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
728 speedbar-supported-extension-expressions)
729 speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
730 speedbar-ignored-path-expressions)))
732 (defvar speedbar-update-flag (and
733 (or (fboundp 'run-with-idle-timer)
734 (fboundp 'start-itimer)
735 (boundp 'post-command-idle-hook))
737 "*Non-nil means to automatically update the display.
738 When this is nil then speedbar will not follow the attached frame's path.
739 When speedbar is active, use:
741 \\<speedbar-key-map> `\\[speedbar-toggle-updates]'
743 to toggle this value.")
745 (defvar speedbar-syntax-table nil
746 "Syntax-table used on the speedbar.")
748 (if speedbar-syntax-table
750 (setq speedbar-syntax-table (make-syntax-table))
751 ;; turn off paren matching around here.
752 (modify-syntax-entry ?\' " " speedbar-syntax-table)
753 (modify-syntax-entry ?\" " " speedbar-syntax-table)
754 (modify-syntax-entry ?( " " speedbar-syntax-table)
755 (modify-syntax-entry ?) " " speedbar-syntax-table)
756 (modify-syntax-entry ?{ " " speedbar-syntax-table)
757 (modify-syntax-entry ?} " " speedbar-syntax-table)
758 (modify-syntax-entry ?[ " " speedbar-syntax-table)
759 (modify-syntax-entry ?] " " speedbar-syntax-table))
761 (defvar speedbar-key-map nil
762 "Keymap used in speedbar buffer.")
766 (setq speedbar-key-map (make-keymap))
767 (suppress-keymap speedbar-key-map t)
770 (define-key speedbar-key-map "g" 'speedbar-refresh)
771 (define-key speedbar-key-map "t" 'speedbar-toggle-updates)
772 (define-key speedbar-key-map "q" 'speedbar-close-frame)
773 (define-key speedbar-key-map "Q" 'delete-frame)
776 (define-key speedbar-key-map "n" 'speedbar-next)
777 (define-key speedbar-key-map "p" 'speedbar-prev)
778 (define-key speedbar-key-map "\M-n" 'speedbar-restricted-next)
779 (define-key speedbar-key-map "\M-p" 'speedbar-restricted-prev)
780 (define-key speedbar-key-map "\C-\M-n" 'speedbar-forward-list)
781 (define-key speedbar-key-map "\C-\M-p" 'speedbar-backward-list)
782 (define-key speedbar-key-map " " 'speedbar-scroll-up)
783 (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
785 ;; Short cuts I happen to find useful
786 (define-key speedbar-key-map "r"
787 (lambda () (interactive)
788 (speedbar-change-initial-expansion-list
789 speedbar-previously-used-expansion-list-name)))
790 (define-key speedbar-key-map "b"
791 (lambda () (interactive)
792 (speedbar-change-initial-expansion-list "quick buffers")))
793 (define-key speedbar-key-map "f"
794 (lambda () (interactive)
795 (speedbar-change-initial-expansion-list "files")))
798 (substitute-key-definition 'switch-to-buffer
799 'speedbar-switch-buffer-attached-frame
800 speedbar-key-map global-map)
804 ;; mouse bindings so we can manipulate the items on each line
805 (define-key speedbar-key-map 'button2 'speedbar-click)
806 (define-key speedbar-key-map '(shift button2) 'speedbar-power-click)
807 ;; Info doc fix from Bob Weiner
808 (if (featurep 'infodoc)
810 (define-key speedbar-key-map 'button3 'speedbar-xemacs-popup-kludge))
811 (define-key speedbar-key-map '(meta button3) 'speedbar-mouse-item-info)
814 ;; mouse bindings so we can manipulate the items on each line
815 (define-key speedbar-key-map [down-mouse-1] 'speedbar-double-click)
816 (define-key speedbar-key-map [mouse-2] 'speedbar-click)
817 ;; This is the power click for new frames, or refreshing a cache
818 (define-key speedbar-key-map [S-mouse-2] 'speedbar-power-click)
819 ;; This adds a small unecessary visual effect
820 ;;(define-key speedbar-key-map [down-mouse-2] 'speedbar-quick-mouse)
821 (define-key speedbar-key-map [M-mouse-2] 'speedbar-mouse-item-info)
823 (define-key speedbar-key-map [down-mouse-3] 'speedbar-emacs-popup-kludge)
825 ;; This lets the user scroll as if we had a scrollbar... well maybe not
826 (define-key speedbar-key-map [mode-line mouse-2] 'speedbar-mouse-hscroll)
827 ;; another handy place users might click to get our menu.
828 (define-key speedbar-key-map [mode-line down-mouse-1]
829 'speedbar-emacs-popup-kludge)
831 ;; We can't switch buffers with the buffer mouse menu. Lets hack it.
832 (define-key speedbar-key-map [C-down-mouse-1] 'speedbar-hack-buffer-menu)
834 ;; Lastly, we want to track the mouse. Play here
835 (define-key speedbar-key-map [mouse-movement] 'speedbar-track-mouse)
838 (defun speedbar-make-specialized-keymap ()
839 "Create a keymap for use w/ a speedbar major or minor display mode.
840 This basically creates a sparse keymap, and makes it's parent be
842 (let ((k (make-sparse-keymap)))
843 (set-keymap-parent k speedbar-key-map)
846 (defvar speedbar-file-key-map nil
847 "Keymap used in speedbar buffer while files are displayed.")
849 (if speedbar-file-key-map
851 (setq speedbar-file-key-map (speedbar-make-specialized-keymap))
853 ;; Basic tree features
854 (define-key speedbar-file-key-map "e" 'speedbar-edit-line)
855 (define-key speedbar-file-key-map "\C-m" 'speedbar-edit-line)
856 (define-key speedbar-file-key-map "+" 'speedbar-expand-line)
857 (define-key speedbar-file-key-map "=" 'speedbar-expand-line)
858 (define-key speedbar-file-key-map "-" 'speedbar-contract-line)
860 ;; file based commands
861 (define-key speedbar-file-key-map "U" 'speedbar-up-directory)
862 (define-key speedbar-file-key-map "I" 'speedbar-item-info)
863 (define-key speedbar-file-key-map "B" 'speedbar-item-byte-compile)
864 (define-key speedbar-file-key-map "L" 'speedbar-item-load)
865 (define-key speedbar-file-key-map "C" 'speedbar-item-copy)
866 (define-key speedbar-file-key-map "D" 'speedbar-item-delete)
867 (define-key speedbar-file-key-map "O" 'speedbar-item-object-delete)
868 (define-key speedbar-file-key-map "R" 'speedbar-item-rename)
871 (defvar speedbar-easymenu-definition-base
873 ["Update" speedbar-refresh t]
874 ["Auto Update" speedbar-toggle-updates
875 :style toggle :selected speedbar-update-flag]
876 ,(if (and (or (fboundp 'defimage)
877 (fboundp 'make-image-specifier))
879 ["Use Images" speedbar-toggle-images
880 :style toggle :selected speedbar-use-images])
882 "Base part of the speedbar menu.")
884 (defvar speedbar-easymenu-definition-special
885 '(["Edit Item On Line" speedbar-edit-line t]
886 ["Show All Files" speedbar-toggle-show-all-files
887 :style toggle :selected speedbar-show-unknown-files]
888 ["Expand File Tags" speedbar-expand-line
889 (save-excursion (beginning-of-line)
890 (looking-at "[0-9]+: *.\\+. "))]
891 ["Flush Cache & Expand" speedbar-flush-expand-line
892 (save-excursion (beginning-of-line)
893 (looking-at "[0-9]+: *.\\+. "))]
894 ["Contract File Tags" speedbar-contract-line
895 (save-excursion (beginning-of-line)
896 (looking-at "[0-9]+: *.-. "))]
897 ; ["Sort Tags" speedbar-toggle-sorting
898 ; :style toggle :selected speedbar-sort-tags]
900 ["File/Tag Information" speedbar-item-info t]
901 ["Load Lisp File" speedbar-item-load
904 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
905 ["Byte Compile File" speedbar-item-byte-compile
908 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
909 ["Copy File" speedbar-item-copy
910 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
911 ["Rename File" speedbar-item-rename
912 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
913 ["Delete File" speedbar-item-delete
914 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
915 ["Delete Object" speedbar-item-object-delete
916 (save-excursion (beginning-of-line)
917 (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))]
919 "Additional menu items while in file-mode.")
921 (defvar speedbar-easymenu-definition-trailer
923 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
924 (list ["Customize..." speedbar-customize t]))
926 ["Close" speedbar-close-frame t]
927 ["Quit" delete-frame t] ))
928 "Menu items appearing at the end of the speedbar menu.")
930 (defvar speedbar-desired-buffer nil
931 "Non-nil when speedbar is showing buttons specific a special mode.
932 In this case it is the originating buffer.")
933 (defvar speedbar-buffer nil
934 "The buffer displaying the speedbar.")
935 (defvar speedbar-frame nil
936 "The frame displaying speedbar.")
937 (defvar speedbar-cached-frame nil
938 "The frame that was last created, then removed from the display.")
939 (defvar speedbar-full-text-cache nil
940 "The last open directory is saved in its entirety for ultra-fast switching.")
941 (defvar speedbar-timer nil
942 "The speedbar timer used for updating the buffer.")
943 (defvar speedbar-attached-frame nil
944 "The frame which started speedbar mode.
945 This is the frame from which all data displayed in the speedbar is
946 gathered, and in which files and such are displayed.")
948 (defvar speedbar-last-selected-file nil
949 "The last file which was selected in speedbar buffer.")
951 (defvar speedbar-shown-directories nil
952 "Maintain list of directories simultaneously open in the current speedbar.")
954 (defvar speedbar-directory-contents-alist nil
955 "An association list of directories and their contents.
956 Each sublist was returned by `speedbar-file-lists'. This list is
957 maintained to speed up the refresh rate when switching between
960 (defvar speedbar-power-click nil
961 "Never set this by hand. Value is t when S-mouse activity occurs.")
966 (if (fboundp 'frame-parameter)
968 (defalias 'speedbar-frame-parameter 'frame-parameter)
970 (defun speedbar-frame-parameter (frame parameter)
971 "Return FRAME's PARAMETER value."
972 (cdr (assoc parameter (frame-parameters frame)))))
974 (if (fboundp 'make-overlay)
976 (defalias 'speedbar-make-overlay 'make-overlay)
977 (defalias 'speedbar-overlay-put 'overlay-put)
978 (defalias 'speedbar-delete-overlay 'delete-overlay)
979 (defalias 'speedbar-overlay-start 'overlay-start)
980 (defalias 'speedbar-overlay-end 'overlay-end)
981 (defalias 'speedbar-mode-line-update 'force-mode-line-update))
982 (defalias 'speedbar-make-overlay 'make-extent)
983 (defalias 'speedbar-overlay-put 'set-extent-property)
984 (defalias 'speedbar-delete-overlay 'delete-extent)
985 (defalias 'speedbar-overlay-start 'extent-start)
986 (defalias 'speedbar-overlay-end 'extent-end)
987 (defalias 'speedbar-mode-line-update 'redraw-modeline))
989 ;;; Mode definitions/ user commands
993 (defalias 'speedbar 'speedbar-frame-mode)
995 (defun speedbar-frame-mode (&optional arg)
996 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
997 nil means toggle. Once the speedbar frame is activated, a buffer in
998 `speedbar-mode' will be displayed. Currently, only one speedbar is
1000 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
1001 `speedbar-before-delete-hook' is called before the frame is deleted."
1003 ;; toggle frame on and off.
1004 (if (not arg) (if (and (frame-live-p speedbar-frame)
1005 (frame-visible-p speedbar-frame))
1006 (setq arg -1) (setq arg 1)))
1007 ;; turn the frame off on neg number
1008 (if (and (numberp arg) (< arg 0))
1010 (run-hooks 'speedbar-before-delete-hook)
1011 (if (and speedbar-frame (frame-live-p speedbar-frame))
1013 (setq speedbar-cached-frame speedbar-frame)
1014 (make-frame-invisible speedbar-frame)))
1015 (setq speedbar-frame nil)
1016 (speedbar-set-timer nil)
1017 ;; Used to delete the buffer. This has the annoying affect of
1018 ;; preventing whatever took its place from ever appearing
1019 ;; as the default after a C-x b was typed
1020 ;;(if (bufferp speedbar-buffer)
1021 ;; (kill-buffer speedbar-buffer))
1023 ;; Set this as our currently attached frame
1024 (setq speedbar-attached-frame (selected-frame))
1025 (run-hooks 'speedbar-before-popup-hook)
1026 ;; Get the frame to work in
1027 (if (frame-live-p speedbar-cached-frame)
1029 (setq speedbar-frame speedbar-cached-frame)
1030 (make-frame-visible speedbar-frame)
1031 ;; Get the buffer to play with
1033 (select-frame speedbar-frame)
1034 (if (not (eq (current-buffer) speedbar-buffer))
1035 (switch-to-buffer speedbar-buffer))
1036 (set-window-dedicated-p (selected-window) t)
1037 (raise-frame speedbar-frame)
1038 (speedbar-set-timer speedbar-update-speed)
1040 (if (frame-live-p speedbar-frame)
1041 (raise-frame speedbar-frame)
1042 (setq speedbar-frame
1043 (if speedbar-xemacsp
1044 ;; Only guess height if it is not specified.
1045 (if (member 'height speedbar-frame-plist)
1046 (make-frame speedbar-frame-plist)
1047 (make-frame (nconc (list 'height
1048 (speedbar-needed-height))
1049 speedbar-frame-plist)))
1050 (let* ((mh (speedbar-frame-parameter nil 'menu-bar-lines))
1051 (cfx (speedbar-frame-parameter nil 'left))
1052 (cfy (speedbar-frame-parameter nil 'top))
1053 (cfw (frame-pixel-width))
1055 ;; Only add a guessed height if one is not specified
1056 ;; in the input parameters.
1057 (if (assoc 'height speedbar-frame-parameters)
1058 speedbar-frame-parameters
1060 speedbar-frame-parameters
1061 (list (cons 'height (+ mh (frame-height)))))))
1063 (if (or (< emacs-major-version 20)
1064 (not (eq window-system 'x)))
1066 (let ((x-pointer-shape x-pointer-top-left-arrow)
1067 (x-sensitive-text-pointer-shape
1069 (make-frame params)))))
1070 ;; Position speedbar frame.
1071 (if (or (not window-system) (eq window-system 'pc)
1072 (assoc 'left speedbar-frame-parameters)
1073 (assoc 'top speedbar-frame-parameters))
1074 ;; Do no positioning if not on a windowing system,
1075 ;; or if left/top were specified in the parameters.
1078 (if (not (consp cfx))
1080 ;; If cfx is a list, that means we grow
1081 ;; from a specific edge of the display.
1082 ;; Convert that to the distance from the
1083 ;; left side of the display.
1084 (if (eq (car cfx) '-)
1085 ;; A - means distance from the right edge
1086 ;; of the display, or DW - cfx - framewidth
1087 (- (x-display-pixel-width) (car (cdr cfx))
1088 (frame-pixel-width))
1090 (modify-frame-parameters
1095 ;; Decide which side to put it
1096 ;; on. 200 is just a buffer
1097 ;; for the left edge of the
1098 ;; screen. The extra 10 is just
1099 ;; dressings for window decorations.
1100 (let ((sfw (frame-pixel-width frame)))
1101 (let ((left-guess (- cfx 10 sfw))
1102 (right-guess (+ cfx cfw 5)))
1103 (let ((left-margin left-guess)
1105 (- (x-display-pixel-width)
1106 right-guess 5 sfw)))
1107 (cond ((>= left-margin 0) left-guess)
1108 ((>= right-margin 0) right-guess)
1109 ;; otherwise choose side we overlap less
1110 ((> left-margin right-margin) 0)
1111 (t (- (x-display-pixel-width) sfw 5)))))))
1114 ;; reset the selection variable
1115 (setq speedbar-last-selected-file nil)
1116 ;; Put the buffer into the frame
1117 (save-window-excursion
1118 ;; Get the buffer to play with
1120 (select-frame speedbar-frame)
1121 (switch-to-buffer speedbar-buffer)
1122 (set-window-dedicated-p (selected-window) t))
1123 (if (and (or (null window-system) (eq window-system 'pc))
1124 (fboundp 'set-frame-name))
1126 (select-frame speedbar-frame)
1127 (set-frame-name "Speedbar")))
1128 (speedbar-set-timer speedbar-update-speed)))))
1131 (defun speedbar-get-focus ()
1132 "Change frame focus to or from the speedbar frame.
1133 If the selected frame is not speedbar, then speedbar frame is
1134 selected. If the speedbar frame is active, then select the attached frame."
1136 (if (eq (selected-frame) speedbar-frame)
1137 (if (frame-live-p speedbar-attached-frame)
1138 (select-frame speedbar-attached-frame))
1139 ;; If updates are off, then refresh the frame (they want it now...)
1140 (if (not speedbar-update-flag)
1141 (let ((speedbar-update-flag t))
1142 (speedbar-timer-fn)))
1143 ;; make sure we have a frame
1144 (if (not (frame-live-p speedbar-frame)) (speedbar-frame-mode 1))
1146 (select-frame speedbar-frame)
1150 (defun speedbar-close-frame ()
1151 "Turn off a currently active speedbar."
1153 (speedbar-frame-mode -1)
1154 (select-frame speedbar-attached-frame)
1157 (defun speedbar-switch-buffer-attached-frame (&optional buffer)
1158 "Switch to BUFFER in speedbar's attached frame, and raise that frame.
1159 This overrides the default behavior of `switch-to-buffer' which is
1160 broken because of the dedicated speedbar frame."
1162 ;; Assume we are in the speedbar frame.
1163 (speedbar-get-focus)
1164 ;; Now switch buffers
1166 (switch-to-buffer buffer)
1167 (call-interactively 'switch-to-buffer nil nil)))
1169 (defmacro speedbar-frame-width ()
1170 "Return the width of the speedbar frame in characters.
1171 nil if it doesn't exist."
1172 '(frame-width speedbar-frame))
1174 ;; XEmacs function only.
1175 (defun speedbar-needed-height (&optional frame)
1176 "The needed height for the tool bar FRAME (in characters)."
1177 (or frame (setq frame (selected-frame)))
1178 ;; The 1 is the missing modeline/minibuffer
1179 (+ 1 (/ (frame-pixel-height frame)
1180 (face-height 'default frame))))
1182 (defun speedbar-mode ()
1183 "Major mode for managing a display of directories and tags.
1184 \\<speedbar-key-map>
1185 The first line represents the default path of the speedbar frame.
1186 Each directory segment is a button which jumps speedbar's default
1187 directory to that path. Buttons are activated by clicking `\\[speedbar-click]'.
1188 In some situations using `\\[speedbar-power-click]' is a `power click' which will
1189 rescan cached items, or pop up new frames.
1191 Each line starting with <+> represents a directory. Click on the <+>
1192 to insert the directory listing into the current tree. Click on the
1193 <-> to retract that list. Click on the directory name to go to that
1194 directory as the default.
1196 Each line starting with [+] is a file. If the variable
1197 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1198 files which don't have imenu support, but are not expressly ignored.
1199 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1200 which is generated from `completion-ignored-extensions'.
1202 Files with a `*' character after their name are files checked out of a
1203 version control system. (currently only RCS is supported.) New
1204 version control systems can be added by examining the documentation
1205 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'
1207 Files with a `#' or `!' character after them are source files that
1208 have an object file associated with them. The `!' indicates that the
1209 files is out of date. You can control what source/object associations
1210 exist through the variable `speedbar-obj-alist'.
1212 Click on the [+] to display a list of tags from that file. Click on
1213 the [-] to retract the list. Click on the file name to edit the file
1214 in the attached frame.
1216 If you open tags, you might find a node starting with {+}, which is a
1217 category of tags. Click the {+} to expand the category. Jump-able
1218 tags start with >. Click the name of the tag to go to that position
1219 in the selected file.
1221 \\{speedbar-key-map}"
1224 (setq speedbar-buffer (set-buffer (get-buffer-create " SPEEDBAR")))
1225 (kill-all-local-variables)
1226 (setq major-mode 'speedbar-mode)
1227 (setq mode-name "Speedbar")
1228 (set-syntax-table speedbar-syntax-table)
1229 (setq font-lock-keywords nil) ;; no font-locking please
1230 (setq truncate-lines t)
1231 (make-local-variable 'frame-title-format)
1232 (setq frame-title-format "Speedbar")
1233 ;; Set this up special just for the speedbar buffer
1234 ;; Terminal minibuffer stuff does not require this.
1235 (if (and window-system (not (eq window-system 'pc))
1236 (null default-minibuffer-frame))
1238 (make-local-variable 'default-minibuffer-frame)
1239 (setq default-minibuffer-frame speedbar-attached-frame)))
1240 ;; Correct use of `temp-buffer-show-function': Bob Weiner
1241 (if (and (boundp 'temp-buffer-show-hook)
1242 (boundp 'temp-buffer-show-function))
1243 (progn (make-local-variable 'temp-buffer-show-hook)
1244 (setq temp-buffer-show-hook temp-buffer-show-function)))
1245 (make-local-variable 'temp-buffer-show-function)
1246 (setq temp-buffer-show-function 'speedbar-temp-buffer-show-function)
1247 (if speedbar-xemacsp
1249 ;; Argh! mouse-track-click-hook doesn't understand the
1250 ;; make-local-hook conventions.
1251 (make-local-variable 'mouse-track-click-hook)
1252 (add-hook 'mouse-track-click-hook
1253 (lambda (event count)
1254 (if (/= (event-button event) 1)
1255 nil ; Do normal operations.
1257 (speedbar-quick-mouse event))
1260 (speedbar-mouse-set-point event)
1261 (speedbar-do-function-pointer)
1262 (speedbar-quick-mouse event)))
1263 ;; Don't do normal operations.
1265 (make-local-hook 'kill-buffer-hook)
1266 (add-hook 'kill-buffer-hook (lambda () (let ((skilling (boundp 'skilling)))
1269 (if (eq (current-buffer)
1271 (speedbar-frame-mode -1)))))
1273 (toggle-read-only 1)
1274 (speedbar-set-mode-line-format)
1275 (if speedbar-xemacsp
1276 (set (make-local-variable 'mouse-motion-handler)
1277 'speedbar-track-mouse-xemacs)
1278 (if speedbar-track-mouse-flag
1279 (set (make-local-variable 'track-mouse) t)) ;this could be messy.
1280 (setq auto-show-mode nil)) ;no auto-show for Emacs
1281 (run-hooks 'speedbar-mode-hook))
1282 (speedbar-update-contents)
1285 (defmacro speedbar-with-attached-buffer (&rest forms)
1286 "Execute FORMS in the attached frame's special buffer.
1287 Optionally select that frame if necessary."
1288 `(save-selected-window
1289 (speedbar-set-timer speedbar-update-speed)
1290 (select-frame speedbar-attached-frame)
1292 (speedbar-maybee-jump-to-attached-frame)))
1294 (defun speedbar-message (fmt &rest args)
1295 "Like message, but for use in the speedbar frame.
1296 Argument FMT is the format string, and ARGS are the arguments for message."
1297 (save-selected-window
1298 (select-frame speedbar-attached-frame)
1299 (apply 'message fmt args)))
1301 (defun speedbar-y-or-n-p (prompt)
1302 "Like `y-or-n-p', but for use in the speedbar frame.
1303 Argument PROMPT is the prompt to use."
1304 (save-selected-window
1305 (if (and default-minibuffer-frame (not (eq default-minibuffer-frame
1306 speedbar-attached-frame)))
1307 (select-frame speedbar-attached-frame))
1310 (defun speedbar-show-info-under-mouse (&optional event)
1311 "Call the info function for the line under the mouse.
1312 Optional EVENT is currently not used."
1313 (let ((pos (mouse-position))) ; we ignore event until I use it later.
1314 (if (equal (car pos) speedbar-frame)
1316 (save-window-excursion
1317 (apply 'set-mouse-position pos)
1318 (speedbar-item-info))))))
1320 (defun speedbar-set-mode-line-format ()
1321 "Set the format of the mode line based on the current speedbar environment.
1322 This gives visual indications of what is up. It EXPECTS the speedbar
1323 frame and window to be the currently active frame and window."
1324 (if (and (frame-live-p speedbar-frame)
1325 (or (not speedbar-xemacsp)
1326 (specifier-instance has-modeline-p)))
1328 (set-buffer speedbar-buffer)
1329 (let* ((w (or (speedbar-frame-width) 20))
1332 (p3 (if speedbar-update-flag "SPEEDBAR" "SLOWBAR"))
1333 (blank (- w (length p1) (length p3) (length p5)
1334 (if line-number-mode 4 0)))
1336 (make-string (/ blank 2) ? )
1339 (make-string (+ (/ blank 2) (% blank 2)) ? )
1342 (if line-number-mode
1343 (list (concat p1 p2 p3) '(line-number-mode " %3l")
1345 (list (concat p1 p2 p3 p4 p5)))))
1346 (if (not (equal mode-line-format tf))
1348 (setq mode-line-format tf)
1349 (speedbar-mode-line-update)))))))
1351 (defun speedbar-temp-buffer-show-function (buffer)
1352 "Placed in the variable `temp-buffer-show-function' in `speedbar-mode'.
1353 If a user requests help using \\[help-command] <Key> the temp BUFFER will be
1354 redirected into a window on the attached frame."
1355 (if speedbar-attached-frame (select-frame speedbar-attached-frame))
1356 (pop-to-buffer buffer nil)
1358 ;; Fix for using this hook on some platforms: Bob Weiner
1359 (cond ((not speedbar-xemacsp)
1360 (run-hooks 'temp-buffer-show-hook))
1361 ((fboundp 'run-hook-with-args)
1362 (run-hook-with-args 'temp-buffer-show-hook buffer))
1363 ((and (boundp 'temp-buffer-show-hook)
1364 (listp temp-buffer-show-hook))
1365 (mapcar (function (lambda (hook) (funcall hook buffer)))
1366 temp-buffer-show-hook))))
1368 (defvar speedbar-previous-menu nil
1369 "The menu before the last `speedbar-reconfigure-keymaps' was called.")
1371 (defun speedbar-reconfigure-keymaps ()
1372 "Reconfigure the menu-bar in a speedbar frame.
1373 Different menu items are displayed depending on the current display mode
1374 and the existence of packages."
1376 speedbar-easymenu-definition-base
1377 (if speedbar-shown-directories
1378 ;; file display mode version
1379 (speedbar-initial-menu)
1381 (select-frame speedbar-attached-frame)
1382 (if (local-variable-p
1383 'speedbar-easymenu-definition-special
1385 ;; If bound locally, we can use it
1386 speedbar-easymenu-definition-special)))
1387 ;; Dynamic menu stuff
1389 (list (cons "Displays"
1390 (let ((displays nil)
1391 (alist speedbar-initial-expansion-mode-alist))
1396 (capitalize (car (car alist)))
1398 'speedbar-change-initial-expansion-list
1402 (setq alist (cdr alist)))
1405 speedbar-easymenu-definition-trailer))
1406 (localmap (save-excursion
1407 (let ((cf (selected-frame)))
1409 (select-frame speedbar-attached-frame)
1410 (if (local-variable-p
1411 'speedbar-special-mode-key-map
1413 speedbar-special-mode-key-map)
1414 (select-frame cf))))))
1416 (set-buffer speedbar-buffer)
1417 (use-local-map (or localmap
1418 (speedbar-initial-keymap)
1419 ;; This creates a small keymap we can glom the
1420 ;; menu adjustments into.
1421 (speedbar-make-specialized-keymap)))
1422 ;; Delete the old menu if applicable.
1423 (if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu))
1424 (setq speedbar-previous-menu md)
1425 ;; Now add the new menu
1426 (if (not speedbar-xemacsp)
1427 (easy-menu-define speedbar-menu-map (current-local-map)
1429 (easy-menu-add md (current-local-map))
1430 (set-buffer-menubar (list md))))
1431 (run-hooks 'speedbar-reconfigure-keymaps-hook)))
1434 ;;; User Input stuff
1437 ;; XEmacs: this can be implemented using modeline keymaps, but there
1438 ;; is no use, as we have horizontal scrollbar (as the docstring
1440 (defun speedbar-mouse-hscroll (e)
1441 "Read a mouse event E from the mode line, and horizontally scroll.
1442 If the mouse is being clicked on the far left, or far right of the
1443 mode-line. This is only useful for non-XEmacs"
1445 (let* ((xp (car (nth 2 (car (cdr e)))))
1446 (cpw (/ (frame-pixel-width)
1448 (oc (1+ (/ xp cpw)))
1452 ((> oc (- (window-width) 3))
1454 (t (speedbar-message
1455 "Click on the edge of the modeline to scroll left/right")))
1456 ;;(speedbar-message "X: Pixel %d Char Pixels %d On char %d" xp cpw oc)
1459 (defun speedbar-customize ()
1460 "Customize speedbar using the Custom package."
1462 (let ((sf (selected-frame)))
1463 (select-frame speedbar-attached-frame)
1464 (customize-group 'speedbar)
1466 (speedbar-maybee-jump-to-attached-frame))
1468 (defun speedbar-track-mouse (event)
1469 "For motion EVENT, display info about the current line."
1471 (if (not speedbar-track-mouse-flag)
1474 (let ((char (nth 1 (car (cdr event)))))
1475 (if (not (numberp char))
1476 (speedbar-message nil)
1478 ;; (speedbar-message "%S" event)
1479 (speedbar-item-info)
1482 (defun speedbar-track-mouse-xemacs (event)
1483 "For motion EVENT, display info about the current line."
1484 (if (functionp (default-value 'mouse-motion-handler))
1485 (funcall (default-value 'mouse-motion-handler) event))
1486 (if speedbar-track-mouse-flag
1488 (save-window-excursion
1490 (progn (mouse-set-point event)
1491 ;; Prevent focus-related bugs.
1492 (if (eq major-mode 'speedbar-mode)
1493 (speedbar-item-info)))
1496 ;; In XEmacs, we make popup menus work on the item over mouse (as
1497 ;; opposed to where the point happens to be.) We attain this by
1498 ;; temporarily moving the point to that place.
1499 ;; Hrvoje Niksic <hniksic@srce.hr>
1500 (defun speedbar-xemacs-popup-kludge (event)
1501 "Pop up a menu related to the clicked on item.
1502 Must be bound to EVENT."
1504 (select-frame speedbar-frame)
1506 (goto-char (event-closest-point event))
1508 (forward-char (min 5 (- (save-excursion (end-of-line) (point))
1509 (save-excursion (beginning-of-line) (point)))))
1511 ;; Wait for menu to bail out. `popup-mode-menu' (and other popup
1512 ;; menu functions) return immediately.
1514 (while (not (misc-user-event-p (setq new (next-event))))
1515 (dispatch-event new))
1516 (dispatch-event new))))
1518 (defun speedbar-emacs-popup-kludge (e)
1519 "Pop up a menu related to the clicked on item.
1520 Must be bound to event E."
1524 ;; This gets the cursor where the user can see it.
1525 (if (not (bolp)) (forward-char -1))
1527 (if (< emacs-major-version 20)
1528 (mouse-major-mode-menu e)
1529 (mouse-major-mode-menu e nil))))
1531 (defun speedbar-hack-buffer-menu (e)
1532 "Control mouse 1 is buffer menu.
1533 This hack overrides it so that the right thing happens in the main
1534 Emacs frame, not in the speedbar frame.
1535 Argument E is the event causing this activity."
1537 (let ((fn (lookup-key global-map (if speedbar-xemacsp
1543 (set-window-dedicated-p (selected-window) nil)
1544 (call-interactively fn)
1545 (setq newbuff (current-buffer)))
1546 (switch-to-buffer speedbar-buffer)
1547 (set-window-dedicated-p (selected-window) t))
1548 (if (not (eq newbuff speedbar-buffer))
1549 (speedbar-with-attached-buffer
1550 (switch-to-buffer newbuff)))))
1552 (defun speedbar-next (arg)
1553 "Move to the next ARGth line in a speedbar buffer."
1555 (forward-line (or arg 1))
1556 (speedbar-item-info)
1557 (speedbar-position-cursor-on-line))
1559 (defun speedbar-prev (arg)
1560 "Move to the previous ARGth line in a speedbar buffer."
1562 (speedbar-next (if arg (- arg) -1)))
1564 (defun speedbar-restricted-move (arg)
1565 "Move to the next ARGth line in a speedbar buffer at the same depth.
1566 This means that movement is restricted to a subnode, and that siblings
1567 of intermediate nodes are skipped."
1568 (if (not (numberp arg)) (signal 'wrong-type-argument (list arg 'numberp)))
1569 ;; First find the extent for which we are allowed to move.
1570 (let ((depth (save-excursion (beginning-of-line)
1571 (if (looking-at "[0-9]+:")
1572 (string-to-int (match-string 0))
1574 (crement (if (< arg 0) 1 -1)) ; decrement or increment
1575 (lastmatch (point)))
1577 (forward-line (- crement))
1578 (let ((subdepth (save-excursion (beginning-of-line)
1579 (if (looking-at "[0-9]+:")
1580 (string-to-int (match-string 0))
1582 (cond ((or (< subdepth depth)
1583 (progn (end-of-line) (eobp))
1584 (progn (beginning-of-line) (bobp)))
1585 ;; We have reached the end of this block.
1586 (goto-char lastmatch)
1588 (error "End of sub-list"))
1590 (setq lastmatch (point)
1591 arg (+ arg crement))))))
1592 (speedbar-position-cursor-on-line)))
1594 (defun speedbar-restricted-next (arg)
1595 "Move to the next ARGth line in a speedbar buffer at the same depth.
1596 This means that movement is restricted to a subnode, and that siblings
1597 of intermediate nodes are skipped."
1599 (speedbar-restricted-move (or arg 1))
1600 (speedbar-item-info))
1603 (defun speedbar-restricted-prev (arg)
1604 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1605 This means that movement is restricted to a subnode, and that siblings
1606 of intermediate nodes are skipped."
1608 (speedbar-restricted-move (if arg (- arg) -1))
1609 (speedbar-item-info))
1611 (defun speedbar-navigate-list (arg)
1612 "Move across ARG groups of similarly typed items in speedbar.
1613 Stop on the first line of the next type of item, or on the last or first item
1614 if we reach a buffer boundary."
1617 (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ")
1618 (let ((str (regexp-quote (match-string 0))))
1619 (while (looking-at str)
1620 (speedbar-restricted-move arg)
1621 (beginning-of-line))))
1622 (speedbar-position-cursor-on-line))
1624 (defun speedbar-forward-list ()
1625 "Move forward over the current list.
1626 A LIST in speedbar is a group of similarly typed items, such as directories,
1627 files, or the directory button."
1629 (speedbar-navigate-list 1)
1630 (speedbar-item-info))
1632 (defun speedbar-backward-list ()
1633 "Move backward over the current list.
1634 A LIST in speedbar is a group of similarly typed items, such as directories,
1635 files, or the directory button."
1637 (speedbar-navigate-list -1)
1638 (speedbar-item-info))
1640 (defun speedbar-scroll-up (&optional arg)
1641 "Page down one screen-full of the speedbar, or ARG lines."
1644 (speedbar-position-cursor-on-line))
1646 (defun speedbar-scroll-down (&optional arg)
1647 "Page up one screen-full of the speedbar, or ARG lines."
1650 (speedbar-position-cursor-on-line))
1652 (defun speedbar-up-directory ()
1653 "Keyboard accelerator for moving the default directory up one.
1654 Assumes that the current buffer is the speedbar buffer"
1656 (setq default-directory (expand-file-name (concat default-directory "../")))
1657 (speedbar-update-contents))
1659 ;;; Speedbar file activity (aka creeping featurism)
1661 (defun speedbar-refresh ()
1662 "Refresh the current speedbar display, disposing of any cached data."
1664 (let ((dl speedbar-shown-directories)
1665 (dm (and (boundp 'deactivate-mark) deactivate-mark)))
1667 (adelete 'speedbar-directory-contents-alist (car dl))
1669 (if (<= 1 speedbar-verbosity-level)
1670 (speedbar-message "Refreshing speedbar..."))
1671 (speedbar-update-contents)
1672 (speedbar-stealthy-updates)
1673 ;; Reset the timer in case it got really hosed for some reason...
1674 (speedbar-set-timer speedbar-update-speed)
1675 (if (<= 1 speedbar-verbosity-level)
1676 (speedbar-message "Refreshing speedbar...done"))
1677 (if (boundp 'deactivate-mark) (setq deactivate-mark dm))))
1679 (defun speedbar-item-load ()
1680 "Load the item under the cursor or mouse if it is a Lisp file."
1682 (let ((f (speedbar-line-file)))
1683 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1684 (if (and (file-exists-p (concat f "c"))
1685 (speedbar-y-or-n-p (format "Load %sc? " f)))
1686 ;; If the compiled version exists, load that instead...
1687 (load-file (concat f "c"))
1689 (error "Not a loadable file"))))
1691 (defun speedbar-item-byte-compile ()
1692 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1694 (let ((f (speedbar-line-file))
1695 (sf (selected-frame)))
1696 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1698 (select-frame speedbar-attached-frame)
1699 (byte-compile-file f nil)
1701 (speedbar-reset-scanners)))
1704 (defun speedbar-mouse-item-info (event)
1705 "Provide information about what the user clicked on.
1706 This should be bound to a mouse EVENT."
1708 (mouse-set-point event)
1709 (speedbar-item-info))
1711 (defun speedbar-generic-item-info ()
1712 "Attempt to derive, and then display information about thils line item.
1713 File style information is displayed with `speedbar-item-info'."
1716 ;; Skip invisible number info.
1717 (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0)))
1718 ;; Skip items in "folder" type text characters.
1719 (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0)))
1721 (speedbar-message "Text: %s" (buffer-substring-no-properties
1722 (point) (progn (end-of-line) (point))))))
1724 (defun speedbar-item-info ()
1725 "Display info in the mini-buffer about the button the mouse is over.
1726 This function can be replaced in `speedbar-mode-functions-list' as
1727 `speedbar-item-info'"
1729 (let (message-log-max)
1730 (funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info)
1731 'speedbar-generic-item-info))))
1733 (defun speedbar-item-info-file-helper (&optional filename)
1734 "Display info about a file that is on the current line.
1735 nil if not applicable. If FILENAME, then use that instead of reading
1736 it from the speedbar buffer."
1737 (let* ((item (or filename (speedbar-line-file)))
1738 (attr (if item (file-attributes item) nil)))
1739 (if (and item attr) (speedbar-message "%s %-6d %s" (nth 8 attr)
1743 (defun speedbar-item-info-tag-helper ()
1744 "Display info about a tag that is on the current line.
1745 nil if not applicable."
1748 (if (re-search-forward " [-+=]?> \\([^\n]+\\)"
1749 (save-excursion(end-of-line)(point)) t)
1750 (let ((tag (match-string 1))
1751 (attr (speedbar-line-token))
1753 (if (and (featurep 'semantic) (semantic-token-p attr))
1754 (speedbar-message (semantic-summerize-nonterminal attr))
1755 (looking-at "\\([0-9]+\\):")
1756 (setq item (file-name-nondirectory (speedbar-line-path)))
1757 (speedbar-message "Tag: %s in %s" tag item)))
1758 (if (re-search-forward "{[+-]} \\([^\n]+\\)$"
1759 (save-excursion(end-of-line)(point)) t)
1760 (speedbar-message "Group of tags \"%s\"" (match-string 1))
1761 (if (re-search-forward " [+-]?[()|@] \\([^\n]+\\)$" nil t)
1762 (let* ((detailtext (match-string 1))
1763 (detail (or (speedbar-line-token) detailtext))
1764 (parent (save-excursion
1766 (let ((dep (if (looking-at "[0-9]+:")
1767 (1- (string-to-int (match-string 0)))
1769 (re-search-backward (concat "^"
1773 (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$")
1774 (speedbar-line-token)
1776 (if (and (featurep 'semantic) (semantic-token-p detail))
1778 (semantic-summerize-nonterminal detail parent))
1780 (speedbar-message "Detail: %s of tag %s" detail
1781 (if (and (featurep 'semantic)
1782 (semantic-token-p parent))
1783 (semantic-token-name parent)
1785 (speedbar-message "Detail: %s" detail))))
1788 (defun speedbar-files-item-info ()
1789 "Display info in the mini-buffer about the button the mouse is over."
1790 (if (not speedbar-shown-directories)
1791 (speedbar-generic-item-info)
1792 (or (speedbar-item-info-file-helper)
1793 (speedbar-item-info-tag-helper)
1794 (speedbar-generic-item-info))))
1796 (defun speedbar-item-copy ()
1797 "Copy the item under the cursor.
1798 Files can be copied to new names or places."
1800 (let ((f (speedbar-line-file)))
1801 (if (not f) (error "Not a file"))
1802 (if (file-directory-p f)
1803 (error "Cannot copy directory")
1804 (let* ((rt (read-file-name (format "Copy %s to: "
1805 (file-name-nondirectory f))
1806 (file-name-directory f)))
1807 (refresh (member (expand-file-name (file-name-directory rt))
1808 speedbar-shown-directories)))
1809 ;; Create the right file name part
1810 (if (file-directory-p rt)
1812 (concat (expand-file-name rt)
1813 (if (string-match "[/\\]$" rt) "" "/")
1814 (file-name-nondirectory f))))
1815 (if (or (not (file-exists-p rt))
1816 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
1818 (copy-file f rt t t)
1819 ;; refresh display if the new place is currently displayed.
1823 (if (not (speedbar-goto-this-file rt))
1824 (speedbar-goto-this-file f))))
1827 (defun speedbar-item-rename ()
1828 "Rename the item under the cursor or mouse.
1829 Files can be renamed to new names or moved to new directories."
1831 (let ((f (speedbar-line-file)))
1833 (let* ((rt (read-file-name (format "Rename %s to: "
1834 (file-name-nondirectory f))
1835 (file-name-directory f)))
1836 (refresh (member (expand-file-name (file-name-directory rt))
1837 speedbar-shown-directories)))
1838 ;; Create the right file name part
1839 (if (file-directory-p rt)
1841 (concat (expand-file-name rt)
1842 (if (string-match "[/\\]\\'" rt) "" "/")
1843 (file-name-nondirectory f))))
1844 (if (or (not (file-exists-p rt))
1845 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
1847 (rename-file f rt t)
1848 ;; refresh display if the new place is currently displayed.
1852 (speedbar-goto-this-file rt)
1854 (error "Not a file"))))
1856 (defun speedbar-item-delete ()
1857 "Delete the item under the cursor. Files are removed from disk."
1859 (let ((f (speedbar-line-file)))
1860 (if (not f) (error "Not a file"))
1861 (if (speedbar-y-or-n-p (format "Delete %s? " f))
1863 (if (file-directory-p f)
1864 (delete-directory f)
1866 (speedbar-message "Okie dokie..")
1873 (defun speedbar-item-object-delete ()
1874 "Delete the object associated from the item under the cursor.
1875 The file is removed from disk. The object is determined from the
1876 variable `speedbar-obj-alist'."
1878 (let* ((f (speedbar-line-file))
1880 (oa speedbar-obj-alist))
1881 (if (not f) (error "Not a file"))
1882 (while (and oa (not (string-match (car (car oa)) f)))
1884 (setq obj (concat (file-name-sans-extension f) (cdr (car oa))))
1885 (if (and oa (file-exists-p obj)
1886 (speedbar-y-or-n-p (format "Delete %s? " obj)))
1889 (speedbar-reset-scanners)))))
1891 (defun speedbar-enable-update ()
1892 "Enable automatic updating in speedbar via timers."
1894 (setq speedbar-update-flag t)
1895 (speedbar-set-mode-line-format)
1896 (speedbar-set-timer speedbar-update-speed))
1898 (defun speedbar-disable-update ()
1899 "Disable automatic updating and stop consuming resources."
1901 (setq speedbar-update-flag nil)
1902 (speedbar-set-mode-line-format)
1903 (speedbar-set-timer nil))
1905 (defun speedbar-toggle-updates ()
1906 "Toggle automatic update for the speedbar frame."
1908 (if speedbar-update-flag
1909 (speedbar-disable-update)
1910 (speedbar-enable-update)))
1912 (defun speedbar-toggle-images ()
1913 "Toggle automatic update for the speedbar frame."
1915 (setq speedbar-use-images (not speedbar-use-images))
1918 (defun speedbar-toggle-sorting ()
1919 "Toggle automatic update for the speedbar frame."
1921 (setq speedbar-sort-tags (not speedbar-sort-tags)))
1923 (defun speedbar-toggle-show-all-files ()
1924 "Toggle display of files speedbar can not tag."
1926 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files))
1929 ;;; Utility functions
1931 (defun speedbar-set-timer (timeout)
1932 "Apply a timer with TIMEOUT, or remove a timer if TIMOUT is nil.
1933 TIMEOUT is the number of seconds until the speedbar timer is called
1934 again. When TIMEOUT is nil, turn off all timeouts.
1935 This function will also enable or disable the `vc-checkin-hook' used
1936 to track file check ins, and will change the mode line to match
1937 `speedbar-update-flag'."
1942 (progn (delete-itimer speedbar-timer)
1943 (setq speedbar-timer nil)))
1945 (if (and speedbar-xemacsp
1946 (or (>= emacs-major-version 20)
1947 (>= emacs-minor-version 15)))
1948 (setq speedbar-timer (start-itimer "speedbar"
1953 (setq speedbar-timer (start-itimer "speedbar"
1958 ((fboundp 'run-with-idle-timer)
1960 (progn (cancel-timer speedbar-timer)
1961 (setq speedbar-timer nil)))
1963 (setq speedbar-timer
1964 (run-with-idle-timer timeout t 'speedbar-timer-fn))))
1965 ;; Emacs 19.30 (Thanks twice: ptype@dra.hmg.gb)
1966 ((fboundp 'post-command-idle-hook)
1968 (add-hook 'post-command-idle-hook 'speedbar-timer-fn)
1969 (remove-hook 'post-command-idle-hook 'speedbar-timer-fn)))
1970 ;; Older or other Emacsen with no timers. Set up so that its
1971 ;; obvious this emacs can't handle the updates
1973 (setq speedbar-update-flag nil)))
1974 ;; Apply a revert hook that will reset the scanners. We attach to revert
1975 ;; because most reverts occur during VC state change, and this lets our
1976 ;; VC scanner fix itself.
1978 (add-hook 'after-revert-hook 'speedbar-reset-scanners)
1979 (remove-hook 'after-revert-hook 'speedbar-reset-scanners)
1981 ;; change this if it changed for some reason
1982 (speedbar-set-mode-line-format))
1984 (defmacro speedbar-with-writable (&rest forms)
1985 "Allow the buffer to be writable and evaluate FORMS."
1986 (list 'let '((inhibit-read-only t))
1987 (cons 'progn forms)))
1988 (put 'speedbar-with-writable 'lisp-indent-function 0)
1990 (defun speedbar-select-window (buffer)
1991 "Select a window in which BUFFER is shown.
1992 If it is not shown, force it to appear in the default window."
1993 (let ((win (get-buffer-window buffer speedbar-attached-frame)))
1996 (set-window-buffer (selected-window) buffer))))
1998 (defun speedbar-insert-button (text face mouse function
1999 &optional token prevline)
2000 "Insert TEXT as the next logical speedbar button.
2001 FACE is the face to put on the button, MOUSE is the highlight face to use.
2002 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
2003 This function assumes that the current buffer is the speedbar buffer.
2004 If PREVLINE, then put this button on the previous line.
2006 This is a convenience function for special mode that create their own
2007 specialized speedbar displays."
2008 (goto-char (point-max))
2009 (if (/= (current-column) 0) (insert "\n"))
2010 (if prevline (progn (delete-char -1) (insert " "))) ;back up if desired...
2011 (let ((start (point)))
2013 (speedbar-make-button start (point) face mouse function token))
2014 (let ((start (point)))
2016 (put-text-property start (point) 'face nil)
2017 (put-text-property start (point) 'mouse-face nil)))
2019 (defun speedbar-make-button (start end face mouse function &optional token)
2020 "Create a button from START to END, with FACE as the display face.
2021 MOUSE is the mouse face. When this button is clicked on FUNCTION
2022 will be run with the TOKEN parameter (any Lisp object)"
2023 (put-text-property start end 'face face)
2024 (put-text-property start end 'mouse-face mouse)
2025 (put-text-property start end 'invisible nil)
2026 (if function (put-text-property start end 'speedbar-function function))
2027 (if token (put-text-property start end 'speedbar-token token))
2028 ;; So far the only text we have is less that 3 chars.
2029 (if (<= (- end start) 3)
2030 (speedbar-insert-image-button-maybe start (- end start)))
2033 ;;; Initial Expansion list management
2035 (defun speedbar-initial-expansion-list ()
2036 "Return the current default expansion list.
2037 This is based on `speedbar-initial-expansion-list-name' referencing
2038 `speedbar-initial-expansion-mode-alist'."
2039 ;; cdr1 - name, cdr2 - menu
2040 (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name
2041 speedbar-initial-expansion-mode-alist)))))
2043 (defun speedbar-initial-menu ()
2044 "Return the current default menu data.
2045 This is based on `speedbar-initial-expansion-list-name' referencing
2046 `speedbar-initial-expansion-mode-alist'."
2048 (car (cdr (assoc speedbar-initial-expansion-list-name
2049 speedbar-initial-expansion-mode-alist)))))
2051 (defun speedbar-initial-keymap ()
2052 "Return the current default menu data.
2053 This is based on `speedbar-initial-expansion-list-name' referencing
2054 `speedbar-initial-expansion-mode-alist'."
2056 (car (cdr (cdr (assoc speedbar-initial-expansion-list-name
2057 speedbar-initial-expansion-mode-alist))))))
2059 (defun speedbar-initial-stealthy-functions ()
2060 "Return a list of functions to call stealthily.
2061 This is based on `speedbar-initial-expansion-list-name' referencing
2062 `speedbar-stealthy-function-list'."
2063 (cdr (assoc speedbar-initial-expansion-list-name
2064 speedbar-stealthy-function-list)))
2066 (defun speedbar-add-expansion-list (new-list)
2067 "Add NEW-LIST to the list of expansion lists."
2068 (add-to-list 'speedbar-initial-expansion-mode-alist new-list))
2070 (defun speedbar-change-initial-expansion-list (new-default)
2071 "Change speedbar's default expansion list to NEW-DEFAULT."
2074 (completing-read (format "Speedbar Mode (default %s): "
2075 speedbar-previously-used-expansion-list-name)
2076 speedbar-initial-expansion-mode-alist
2078 speedbar-previously-used-expansion-list-name)))
2079 (setq speedbar-previously-used-expansion-list-name
2080 speedbar-initial-expansion-list-name
2081 speedbar-initial-expansion-list-name new-default)
2083 (speedbar-reconfigure-keymaps))
2085 (defun speedbar-fetch-replacement-function (function)
2086 "Return a current mode specific replacement for function, or nil.
2087 Scans `speedbar-mode-functions-list' first for the current mode, then
2089 (cdr (assoc function
2090 (cdr (assoc speedbar-initial-expansion-list-name
2091 speedbar-mode-functions-list)))))
2093 (defun speedbar-add-mode-functions-list (new-list)
2094 "Add NEW-LIST to the list of mode functions.
2095 See `speedbar-mode-functions-list' for details."
2096 (add-to-list 'speedbar-mode-functions-list new-list))
2099 ;;; Special speedbar display management
2101 (defun speedbar-maybe-add-localized-support (buffer)
2102 "Quick check function called on BUFFERs by the speedbar timer function.
2103 Maintains the value of local variables which control speedbars use
2104 of the special mode functions."
2105 (or speedbar-special-mode-expansion-list
2106 (speedbar-add-localized-speedbar-support buffer)))
2108 (defun speedbar-add-localized-speedbar-support (buffer)
2109 "Add localized speedbar support to BUFFER's mode if it is available."
2110 (interactive "bBuffer: ")
2111 (if (stringp buffer) (setq buffer (get-buffer buffer)))
2112 (if (not (buffer-live-p buffer))
2117 (let ((ms (symbol-name major-mode)) v)
2118 (if (not (string-match "-mode$" ms))
2119 nil ;; do nothing to broken mode
2120 (setq ms (substring ms 0 (match-beginning 0)))
2121 (setq v (intern-soft (concat ms "-speedbar-buttons")))
2122 (make-local-variable 'speedbar-special-mode-expansion-list)
2124 (setq speedbar-special-mode-expansion-list t)
2125 ;; If it is autoloaded, we need to load it now so that
2126 ;; we have access to the varialbe -speedbar-menu-items.
2127 ;; Is this XEmacs safe?
2128 (let ((sf (symbol-function v)))
2129 (if (and (listp sf) (eq (car sf) 'autoload))
2130 (load-library (car (cdr sf)))))
2131 (setq speedbar-special-mode-expansion-list (list v))
2132 (setq v (intern-soft (concat ms "-speedbar-key-map")))
2134 nil ;; don't add special keymap
2135 (make-local-variable 'speedbar-special-mode-key-map)
2136 (setq speedbar-special-mode-key-map
2138 (setq v (intern-soft (concat ms "-speedbar-menu-items")))
2140 nil ;; don't add special menus
2141 (make-local-variable 'speedbar-easymenu-definition-special)
2142 (setq speedbar-easymenu-definition-special
2146 (defun speedbar-remove-localized-speedbar-support (buffer)
2147 "Remove any traces that BUFFER supports speedbar in a specialized way."
2150 (kill-local-variable 'speedbar-special-mode-expansion-list)
2151 (kill-local-variable 'speedbar-special-mode-key-map)
2152 (kill-local-variable 'speedbar-easymenu-definition-special)))
2154 ;;; File button management
2156 (defun speedbar-file-lists (directory)
2157 "Create file lists for DIRECTORY.
2158 The car is the list of directories, the cdr is list of files not
2159 matching ignored headers. Cache any directory files found in
2160 `speedbar-directory-contents-alist' and use that cache before scanning
2162 (setq directory (expand-file-name directory))
2163 ;; If in powerclick mode, then the directory we are getting
2164 ;; should be rescanned.
2165 (if speedbar-power-click
2166 (adelete 'speedbar-directory-contents-alist directory))
2167 ;; find the directory, either in the cache, or build it.
2168 (or (cdr-safe (assoc directory speedbar-directory-contents-alist))
2169 (let ((default-directory directory)
2170 (dir (directory-files directory nil))
2175 (or (string-match speedbar-file-unshown-regexp (car dir))
2176 (string-match speedbar-directory-unshown-regexp (car dir))))
2177 (if (file-directory-p (car dir))
2178 (setq dirs (cons (car dir) dirs))
2179 (setq files (cons (car dir) files))))
2180 (setq dir (cdr dir)))
2181 (let ((nl (cons (nreverse dirs) (list (nreverse files)))))
2182 (aput 'speedbar-directory-contents-alist directory nl)
2186 (defun speedbar-directory-buttons (directory index)
2187 "Insert a single button group at point for DIRECTORY.
2188 Each directory path part is a different button. If part of the path
2189 matches the user directory ~, then it is replaced with a ~.
2190 INDEX is not used, but is required by the caller."
2191 (let* ((tilde (expand-file-name "~/"))
2192 (dd (expand-file-name directory))
2193 (junk (string-match (regexp-quote tilde) dd))
2195 (concat "~/" (substring dd (match-end 0)))
2198 (if (string-match "^~[/\\]?\\'" displayme) (setq displayme tilde))
2202 (while (re-search-forward "\\([^/\\]+\\)[/\\]" nil t)
2203 (speedbar-make-button (match-beginning 1) (match-end 1)
2204 'speedbar-directory-face
2205 'speedbar-highlight-face
2206 'speedbar-directory-buttons-follow
2207 (if (and (= (match-beginning 1) p)
2208 (not (char-equal (char-after (+ p 1)) ?:)))
2209 (expand-file-name "~/") ;the tilde
2210 (buffer-substring-no-properties
2212 ;; Nuke the beginning of the directory if it's too long...
2213 (cond ((eq speedbar-directory-button-trim-method 'span)
2215 (let ((ww (or (speedbar-frame-width) 20)))
2216 (move-to-column ww nil)
2217 (while (>= (current-column) ww)
2218 (re-search-backward "[/\\]" nil t)
2219 (if (<= (current-column) 2)
2221 (re-search-forward "[/\\]" nil t)
2222 (if (< (current-column) 4)
2223 (re-search-forward "[/\\]" nil t))
2225 (if (looking-at "[/\\]?$")
2228 (move-to-column ww nil)))))
2229 ((eq speedbar-directory-button-trim-method 'trim)
2231 (let ((ww (or (speedbar-frame-width) 20))
2232 (tl (current-column)))
2235 (move-to-column (- tl ww))
2236 (if (re-search-backward "[/\\]" nil t)
2238 (delete-region (point-min) (point))
2242 (if (string-match "\\`[/\\][^/\\]+[/\\]\\'" displayme)
2247 (speedbar-make-button p (point)
2248 'speedbar-directory-face
2249 'speedbar-highlight-face
2250 'speedbar-directory-buttons-follow
2253 (insert-char ?\n 1 nil)))
2255 (defun speedbar-make-tag-line (exp-button-type
2256 exp-button-char exp-button-function
2258 tag-button tag-button-function tag-button-data
2259 tag-button-face depth)
2260 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
2261 This is the button that expands or contracts a node (if applicable),
2262 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
2263 is the function to call if it's clicked on. Button types are
2264 'bracket, 'angle, 'curly, or nil. EXP-BUTTON-DATA is extra data
2265 attached to the text forming the expansion button.
2267 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
2268 function to call if clicked on, and TAG-BUTTON-DATA is the data to
2269 attach to the text field (such a tag positioning, etc).
2270 TAG-BUTTON-FACE is a face used for this type of tag.
2272 Lastly, DEPTH shows the depth of expansion.
2274 This function assumes that the cursor is in the speedbar window at the
2275 position to insert a new item, and that the new item will end with a CR"
2276 (let ((start (point))
2278 (insert (int-to-string depth) ":")
2280 (depthspacesize (* depth speedbar-indentation-width)))
2281 (put-text-property start end 'invisible t)
2282 (insert-char ? depthspacesize nil)
2283 (put-text-property (- (point) depthspacesize) (point) 'invisible nil)
2284 (let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]")
2285 ((eq exp-button-type 'angle) "<%c>")
2286 ((eq exp-button-type 'curly) "{%c}")
2288 (buttxt (format exp-button exp-button-char))
2290 (end (progn (insert buttxt) (point)))
2291 (bf (if exp-button-type 'speedbar-button-face nil))
2292 (mf (if exp-button-function 'speedbar-highlight-face nil))
2294 (speedbar-make-button start end bf mf exp-button-function exp-button-data)
2295 (if speedbar-hide-button-brackets-flag
2297 (put-text-property start (1+ start) 'invisible t)
2298 (put-text-property end (1- end) 'invisible t)))
2300 (insert-char ? 1 nil)
2301 (put-text-property (1- (point)) (point) 'invisible nil)
2302 (let ((start (point))
2303 (end (progn (insert tag-button) (point))))
2304 (insert-char ?\n 1 nil)
2305 (put-text-property (1- (point)) (point) 'invisible nil)
2306 (speedbar-make-button start end tag-button-face
2307 (if tag-button-function 'speedbar-highlight-face nil)
2308 tag-button-function tag-button-data))
2311 (defun speedbar-change-expand-button-char (char)
2312 "Change the expansion button character to CHAR for the current line."
2315 (if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line)
2317 (speedbar-with-writable
2318 (goto-char (match-beginning 1))
2320 (insert-char char 1 t)
2321 (put-text-property (point) (1- (point)) 'invisible nil)
2322 ;; make sure we fix the image on the text here.
2323 (speedbar-insert-image-button-maybe (- (point) 2) 3)))))
2326 ;;; Build button lists
2328 (defun speedbar-insert-files-at-point (files level)
2329 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2330 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2331 don't know how to manage them. The input parameter FILES is a cons
2332 cell of the form ( 'DIRLIST . 'FILELIST )"
2333 ;; Start inserting all the directories
2334 (let ((dirs (car files)))
2336 (speedbar-make-tag-line 'angle ?+ 'speedbar-dired (car dirs)
2337 (car dirs) 'speedbar-dir-follow nil
2338 'speedbar-directory-face level)
2339 (setq dirs (cdr dirs))))
2340 (let ((lst (car (cdr files)))
2341 (case-fold-search t))
2343 (let* ((known (string-match speedbar-file-regexp (car lst)))
2344 (expchar (if known ?+ ??))
2345 (fn (if known 'speedbar-tag-file nil)))
2346 (if (or speedbar-show-unknown-files (/= expchar ??))
2347 (speedbar-make-tag-line 'bracket expchar fn (car lst)
2348 (car lst) 'speedbar-find-file nil
2349 'speedbar-file-face level)))
2350 (setq lst (cdr lst)))))
2352 (defun speedbar-default-directory-list (directory index)
2353 "Insert files for DIRECTORY with level INDEX at point."
2354 (speedbar-insert-files-at-point
2355 (speedbar-file-lists directory) index)
2356 (speedbar-reset-scanners)
2358 ;; If the shown files variable has extra directories, then
2359 ;; it is our responsibility to redraw them all
2360 ;; Luckilly, the nature of inserting items into this list means
2361 ;; that by reversing it, we can easilly go in the right order
2362 (let ((sf (cdr (reverse speedbar-shown-directories))))
2363 (setq speedbar-shown-directories
2364 (list (expand-file-name default-directory)))
2365 ;; exand them all as we find them
2367 (if (speedbar-goto-this-file (car sf))
2370 (if (looking-at "[0-9]+:[ ]*<")
2372 (goto-char (match-end 0))
2373 (speedbar-do-function-pointer)))
2374 (setq sf (cdr sf)))))
2377 (defun speedbar-sort-tag-hierarchy (lst)
2378 "Sort all elements of tag hierarchy LST."
2379 (sort (copy-alist lst)
2380 (lambda (a b) (string< (car a) (car b)))))
2382 (defun speedbar-prefix-group-tag-hierarchy (lst)
2383 "Prefix group names for tag hierarchy LST."
2388 (short-group-list nil)
2389 (short-start-name nil)
2390 (short-end-name nil)
2391 (num-shorts-grouped 0)
2392 (bins (make-vector 256 nil))
2394 ;; Break out sub-lists
2396 (if (and (listp (cdr-safe (car-safe lst)))
2397 ;; This one is for bovine tokens
2398 (not (symbolp (car-safe (cdr-safe (car-safe lst))))))
2399 (setq newlst (cons (car lst) newlst))
2400 (setq sublst (cons (car lst) sublst)))
2401 (setq lst (cdr lst)))
2402 ;; Reverse newlst because it was made backwards.
2403 ;; Sublist doesn't need reversing because the act
2404 ;; of binning things will reverse it for us.
2405 (setq newlst (nreverse newlst))
2406 ;; Now, first find out how long our list is. Never let a
2407 ;; list get-shorter than our minimum.
2408 (if (<= (length sublst) speedbar-tag-split-minimum-length)
2409 (setq work-list (nreverse sublst))
2410 (setq diff-idx (length (try-completion "" sublst)))
2411 ;; Sort the whole list into bins.
2413 (let ((e (car sublst))
2414 (s (car (car sublst))))
2415 (cond ((<= (length s) diff-idx)
2416 ;; 0 storage bin for shorty.
2417 (aset bins 0 (cons e (aref bins 0))))
2419 ;; stuff into a bin based on ascii value at diff
2420 (aset bins (aref s diff-idx)
2421 (cons e (aref bins (aref s diff-idx)))))))
2422 (setq sublst (cdr sublst)))
2423 ;; Go through all our bins Stick singles into our
2424 ;; junk-list, everything else as sublsts in work-list.
2425 ;; If two neighboring lists are both small, make a grouped
2426 ;; group combinding those two sub-lists.
2428 (while (> 256 diff-idx)
2429 (let ((l (nreverse;; Reverse the list since they are stuck in
2431 (aref bins diff-idx))))
2433 (let ((tmp (cons (try-completion "" l) l)))
2434 (if (or (> (length l) speedbar-tag-regroup-maximum-length)
2435 (> (+ (length l) (length short-group-list))
2436 speedbar-tag-split-minimum-length))
2438 ;; We have reached a longer list, so we
2439 ;; must finish off a grouped group.
2441 ((and short-group-list
2442 (= (length short-group-list)
2443 num-shorts-grouped))
2444 ;; All singles? Junk list
2445 (setq junk-list (append short-group-list
2447 ((= num-shorts-grouped 1)
2448 ;; Only one short group? Just stick it in
2449 ;; there by itself. Make a group, and find
2451 (let ((subexpression (try-completion
2452 "" short-group-list)))
2453 (if (< (length subexpression)
2454 speedbar-tag-group-name-minimum-length)
2456 (concat short-start-name
2459 (car (car short-group-list))
2460 (length short-start-name))
2463 (cons (cons subexpression
2467 ;; Multiple groups to be named in a special
2468 ;; way by displaying the range over which we
2469 ;; have grouped them.
2471 (cons (cons (concat short-start-name
2474 (nreverse short-group-list))
2476 ;; Reset short group list information every time.
2477 (setq short-group-list nil
2478 short-start-name nil
2480 num-shorts-grouped 0)))
2481 ;; Ok, now that we cleaned up the short-group-list,
2482 ;; we can deal with this new list, to decide if it
2483 ;; should go on one of these sub-lists or not.
2484 (if (< (length l) speedbar-tag-regroup-maximum-length)
2485 (setq short-group-list (append short-group-list l)
2486 num-shorts-grouped (1+ num-shorts-grouped)
2487 short-end-name (car tmp)
2488 short-start-name (if short-start-name
2491 (setq work-list (cons tmp work-list))))))
2492 (setq diff-idx (1+ diff-idx))))
2493 ;; Did we run out of things? Drop our new list onto the end.
2495 ((and short-group-list (= (length short-group-list) num-shorts-grouped))
2496 ;; All singles? Junk list
2497 (setq junk-list (append short-group-list junk-list)))
2498 ((= num-shorts-grouped 1)
2499 ;; Only one short group? Just stick it in
2502 (cons (cons (try-completion "" short-group-list)
2506 ;; Multiple groups to be named in a special
2507 ;; way by displaying the range over which we
2508 ;; have grouped them.
2510 (cons (cons (concat short-start-name " to " short-end-name)
2513 ;; Reverse the work list nreversed when consing.
2514 (setq work-list (nreverse work-list))
2515 ;; Now, stick our new list onto the end of
2518 (append newlst work-list junk-list)
2519 (append newlst work-list))
2520 (append newlst junk-list))))
2522 (defun speedbar-trim-words-tag-hierarchy (lst)
2523 "Trim all words in a tag hierarchy.
2524 Base trimming information on word separators, and group names.
2525 Argument LST is the list of tags to trim."
2532 (if (listp (cdr-safe (car-safe lst)))
2533 (setq newlst (cons (car lst) newlst))
2534 (setq sublst (cons (car lst) sublst)))
2535 (setq lst (cdr lst)))
2536 ;; Get the prefix to trim by. Make sure that we don't trim
2537 ;; off silly pieces, only complete understandable words.
2538 (setq trim-prefix (try-completion "" sublst))
2539 (if (or (= (length sublst) 1)
2541 (not (string-match "\\(\\w+\\W+\\)+" trim-prefix)))
2542 (append (nreverse newlst) (nreverse sublst))
2543 (setq trim-prefix (substring trim-prefix (match-beginning 0)
2545 (setq trim-chars (length trim-prefix))
2548 (cons (substring (car (car sublst)) trim-chars)
2551 sublst (cdr sublst)))
2552 ;; Put the lists together
2553 (append (nreverse newlst) trimlst))))
2555 (defun speedbar-simple-group-tag-hierarchy (lst)
2556 "Create a simple 'Tags' group with orphaned tags.
2557 Argument LST is the list of tags to sort into groups."
2561 (if (listp (cdr-safe (car-safe lst)))
2562 (setq newlst (cons (car lst) newlst))
2563 (setq sublst (cons (car lst) sublst)))
2564 (setq lst (cdr lst)))
2567 (setq newlst (cons (cons "Tags" (nreverse sublst)) newlst))
2568 (nreverse newlst))))
2570 (defun speedbar-create-tag-hierarchy (lst)
2571 "Adjust the tag hierarchy in LST, and return it.
2572 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2574 (let* ((f (save-excursion
2576 (speedbar-line-path)))
2577 (methods (if (get-file-buffer f)
2578 (save-excursion (set-buffer (get-file-buffer f))
2579 speedbar-tag-hierarchy-method)
2580 speedbar-tag-hierarchy-method))
2581 (lst (if (fboundp 'copy-tree)
2585 (setq lst (funcall (car methods) lst)
2586 methods (cdr methods)))
2589 (defun speedbar-insert-generic-list (level lst expand-fun find-fun)
2590 "At LEVEL, insert a generic multi-level alist LST.
2591 Associations with lists get {+} tags (to expand into more nodes) and
2592 those with positions just get a > as the indicator. {+} buttons will
2593 have the function EXPAND-FUN and the token is the CDR list. The token
2594 name will have the function FIND-FUN and not token."
2595 ;; Remove imenu rescan button
2596 (if (string= (car (car lst)) "*Rescan*")
2597 (setq lst (cdr lst)))
2599 (setq lst (speedbar-create-tag-hierarchy lst))
2602 (cond ((null (car-safe lst)) nil) ;this would be a separator
2603 ((or (numberp (cdr-safe (car-safe lst)))
2604 (markerp (cdr-safe (car-safe lst))))
2605 (speedbar-make-tag-line nil nil nil nil ;no expand button data
2606 (car (car lst)) ;button name
2608 (cdr (car lst)) ;token is position
2611 ((listp (cdr-safe (car-safe lst)))
2612 (speedbar-make-tag-line 'curly ?+ expand-fun (cdr (car lst))
2613 (car (car lst)) ;button name
2614 nil nil 'speedbar-tag-face
2616 (t (speedbar-message "Ooops!")))
2617 (setq lst (cdr lst))))
2619 (defun speedbar-insert-imenu-list (indent lst)
2620 "At level INDENT, insert the imenu generated LST."
2621 (speedbar-insert-generic-list indent lst
2622 'speedbar-tag-expand
2623 'speedbar-tag-find))
2625 (defun speedbar-insert-etags-list (indent lst)
2626 "At level INDENT, insert the etags generated LST."
2627 (speedbar-insert-generic-list indent lst
2628 'speedbar-tag-expand
2629 'speedbar-tag-find))
2633 (defun speedbar-update-contents ()
2634 "Generically update the contents of the speedbar buffer."
2636 ;; Set the current special buffer
2637 (setq speedbar-desired-buffer nil)
2638 ;; Check for special modes
2639 (speedbar-maybe-add-localized-support (current-buffer))
2640 ;; Choose the correct method of doodling.
2641 (if (and speedbar-mode-specific-contents-flag
2642 (listp speedbar-special-mode-expansion-list)
2643 speedbar-special-mode-expansion-list
2645 'speedbar-special-mode-expansion-list
2647 ;;(eq (get major-mode 'mode-class 'special)))
2648 (speedbar-update-special-contents)
2649 (speedbar-update-directory-contents)))
2651 (defun speedbar-update-directory-contents ()
2652 "Update the contents of the speedbar buffer based on the current directory."
2653 (let ((cbd (expand-file-name default-directory))
2655 (funclst (speedbar-initial-expansion-list))
2656 (cache speedbar-full-text-cache)
2657 ;; disable stealth during update
2658 (speedbar-stealthy-function-list nil)
2661 ;; Because there is a bug I can't find just yet
2664 (set-buffer speedbar-buffer)
2665 ;; If we are updating contents to where we are, then this is
2666 ;; really a request to update existing contents, so we must be
2667 ;; careful with our text cache!
2668 (if (member cbd speedbar-shown-directories)
2671 ;; If the current directory is not the last element in the dir
2672 ;; list, then we ALSO need to zap the list of expanded directories
2673 (if (/= (length (member cbd speedbar-shown-directories)) 1)
2674 (setq speedbar-shown-directories (list cbd))))
2676 ;; Build cbd-parent, and see if THAT is in the current shown
2677 ;; directories. First, go through pains to get the parent directory
2678 (if (and speedbar-smart-directory-expand-flag
2680 (setq cbd-parent cbd)
2681 (if (string-match "[/\\]$" cbd-parent)
2682 (setq cbd-parent (substring cbd-parent 0
2683 (match-beginning 0))))
2684 (setq cbd-parent (file-name-directory cbd-parent)))
2685 (member cbd-parent speedbar-shown-directories))
2686 (setq expand-local t)
2688 ;; If this directory is NOT in the current list of available
2689 ;; paths, then use the cache, and set the cache to our new
2690 ;; value. Make sure to unhighlight the current file, or if we
2691 ;; come back to this directory, it might be a different file
2692 ;; and then we get a mess!
2693 (if (> (point-max) 1)
2695 (speedbar-clear-current-file)
2696 (setq speedbar-full-text-cache
2697 (cons speedbar-shown-directories (buffer-string)))))
2699 ;; Check if our new directory is in the list of directories
2700 ;; shown in the text-cache
2701 (if (member cbd (car cache))
2702 (setq speedbar-shown-directories (car cache)
2704 ;; default the shown directories to this list...
2705 (setq speedbar-shown-directories (list cbd)))
2707 (if (not expand-local) (setq speedbar-last-selected-file nil))
2708 (speedbar-with-writable
2709 (if (and expand-local
2710 ;; Find this directory as a speedbar node.
2711 (speedbar-path-line cbd))
2713 (speedbar-expand-line)
2716 (setq default-directory
2717 (nth (1- (length speedbar-shown-directories))
2718 speedbar-shown-directories))
2719 (insert (cdr cache)))
2722 (setq default-directory cbd)
2723 (funcall (car funclst) cbd 0)
2724 (setq funclst (cdr funclst))))))
2725 (goto-char (point-min)))))
2726 (speedbar-reconfigure-keymaps))
2728 (defun speedbar-update-special-contents ()
2729 "Used the mode-specific variable to fill in the speedbar buffer.
2730 This should only be used by modes classified as special."
2731 (let ((funclst speedbar-special-mode-expansion-list)
2732 (specialbuff (current-buffer)))
2734 (setq speedbar-desired-buffer specialbuff)
2735 (set-buffer speedbar-buffer)
2736 ;; If we are leaving a directory, cache it.
2737 (if (not speedbar-shown-directories)
2740 ;; Clean up directory maintenance stuff
2741 (speedbar-clear-current-file)
2742 (setq speedbar-full-text-cache
2743 (cons speedbar-shown-directories (buffer-string))
2744 speedbar-shown-directories nil))
2745 ;; Now fill in the buffer with our newly found specialized list.
2746 (speedbar-with-writable
2748 ;; We do not erase the buffer because these functions may
2749 ;; decide NOT to update themselves.
2750 (funcall (car funclst) specialbuff)
2751 (setq funclst (cdr funclst))))
2752 (goto-char (point-min))))
2753 (speedbar-reconfigure-keymaps))
2755 (defun speedbar-timer-fn ()
2756 "Run whenever Emacs is idle to update the speedbar item."
2757 (if (not (and (frame-live-p speedbar-frame)
2758 (frame-live-p speedbar-attached-frame)))
2759 (speedbar-set-timer nil)
2760 ;; Save all the match data so that we don't mess up executing fns
2762 ;; Only do stuff if the frame is visible, not an icon, and if
2763 ;; it is currently flagged to do something.
2764 (if (and speedbar-update-flag
2765 (frame-visible-p speedbar-frame)
2766 (not (eq (frame-visible-p speedbar-frame) 'icon)))
2767 (let ((af (selected-frame)))
2768 (save-window-excursion
2769 (select-frame speedbar-attached-frame)
2770 ;; make sure we at least choose a window to
2771 ;; get a good directory from
2772 (if (window-minibuffer-p (selected-window))
2774 ;; Check for special modes
2775 (speedbar-maybe-add-localized-support (current-buffer))
2776 ;; Update for special mode all the time!
2777 (if (and speedbar-mode-specific-contents-flag
2778 (listp speedbar-special-mode-expansion-list)
2779 speedbar-special-mode-expansion-list
2781 'speedbar-special-mode-expansion-list
2783 ;;(eq (get major-mode 'mode-class 'special)))
2785 (if (<= 2 speedbar-verbosity-level)
2787 "Updating speedbar to special mode: %s..."
2789 (speedbar-update-special-contents)
2790 (if (<= 2 speedbar-verbosity-level)
2793 "Updating speedbar to special mode: %s...done"
2795 (speedbar-message nil))))
2796 ;; Update all the contents if directories change!
2797 (if (or (member (expand-file-name default-directory)
2798 speedbar-shown-directories)
2799 (and speedbar-ignored-path-regexp
2801 speedbar-ignored-path-regexp
2802 (expand-file-name default-directory)))
2803 (member major-mode speedbar-ignored-modes)
2804 (eq af speedbar-frame)
2805 (not (buffer-file-name)))
2807 (if (<= 1 speedbar-verbosity-level)
2808 (speedbar-message "Updating speedbar to: %s..."
2810 (speedbar-update-directory-contents)
2811 (if (<= 1 speedbar-verbosity-level)
2813 (speedbar-message "Updating speedbar to: %s...done"
2815 (speedbar-message nil)))))
2817 ;; Now run stealthy updates of time-consuming items
2818 (speedbar-stealthy-updates)))
2819 ;; Now run the mouse tracking system
2820 (speedbar-show-info-under-mouse)))
2821 (run-hooks 'speedbar-timer-hook))
2824 ;;; Stealthy activities
2826 (defvar speedbar-stealthy-update-recurse nil
2827 "Recursion avoidance variable for stealthy update.")
2829 (defun speedbar-stealthy-updates ()
2830 "For a given speedbar, run all items in the stealthy function list.
2831 Each item returns t if it completes successfully, or nil if
2832 interrupted by the user."
2833 (if (not speedbar-stealthy-update-recurse)
2834 (let ((l (speedbar-initial-stealthy-functions))
2835 (speedbar-stealthy-update-recurse t))
2837 (speedbar-with-writable
2838 (while (and l (funcall (car l)))
2841 ;;(speedbar-message "Exit with %S" (car l))
2844 (defun speedbar-reset-scanners ()
2845 "Reset any variables used by functions in the stealthy list as state.
2846 If new functions are added, their state needs to be updated here."
2847 (setq speedbar-vc-to-do-point t
2848 speedbar-obj-to-do-point t)
2849 (run-hooks 'speedbar-scanner-reset-hook)
2852 (defun speedbar-find-selected-file (file)
2853 "Goto the line where FILE is."
2854 (goto-char (point-min))
2856 (while (and (setq m (re-search-forward
2857 (concat " \\(" (file-name-nondirectory file)
2858 "\\)\\(" speedbar-indicator-regex "\\)?\n")
2864 (goto-char (match-beginning 0))
2867 (looking-at "[0-9]+:")
2868 (string-to-number (match-string 0)))))
2869 (match-string 1))))))
2872 (goto-char (match-beginning 1))
2873 (match-string 1)))))
2875 (defun speedbar-clear-current-file ()
2876 "Locate the file thought to be current, and remove its highlighting."
2878 (set-buffer speedbar-buffer)
2879 (if speedbar-last-selected-file
2880 (speedbar-with-writable
2881 (if (speedbar-find-selected-file speedbar-last-selected-file)
2882 (put-text-property (match-beginning 1)
2885 'speedbar-file-face))))))
2887 (defun speedbar-update-current-file ()
2888 "Find the current file, and update our visuals to indicate its name.
2889 This is specific to file names. If the file name doesn't show up, but
2890 it should be in the list, then the directory cache needs to be
2892 (let* ((lastf (selected-frame))
2893 (newcfd (save-excursion
2894 (select-frame speedbar-attached-frame)
2895 (let ((rf (if (buffer-file-name)
2898 (select-frame lastf)
2900 (newcf (if newcfd newcfd))
2901 (lastb (current-buffer))
2902 (sucf-recursive (boundp 'sucf-recursive))
2903 (case-fold-search t))
2905 ;; check here, that way we won't refresh to newcf until
2906 ;; its been written, thus saving ourselves some time
2907 (file-exists-p newcf)
2908 (not (string= newcf speedbar-last-selected-file)))
2910 ;; It is important to select the frame, otherwise the window
2911 ;; we want the cursor to move in will not be updated by the
2912 ;; search-forward command.
2913 (select-frame speedbar-frame)
2914 ;; Remove the old file...
2915 (speedbar-clear-current-file)
2916 ;; now highlight the new one.
2917 (set-buffer speedbar-buffer)
2918 (speedbar-with-writable
2919 (if (speedbar-find-selected-file newcf)
2920 ;; put the property on it
2921 (put-text-property (match-beginning 1)
2924 'speedbar-selected-face)
2925 ;; Oops, it's not in the list. Should it be?
2926 (if (and (string-match speedbar-file-regexp newcf)
2927 (string= (file-name-directory newcfd)
2928 (expand-file-name default-directory)))
2929 ;; yes, it is (we will ignore unknowns for now...)
2932 (if (speedbar-find-selected-file newcf)
2933 ;; put the property on it
2934 (put-text-property (match-beginning 1)
2937 'speedbar-selected-face)))
2938 ;; if it's not in there now, whatever...
2940 (setq speedbar-last-selected-file newcf))
2941 (if (not sucf-recursive)
2943 (speedbar-center-buffer-smartly)
2944 (speedbar-position-cursor-on-line)
2947 (select-frame lastf)
2949 ;; return that we are done with this activity.
2952 (defun speedbar-add-indicator (indicator-string &optional replace-this)
2953 "Add INDICATOR-STRING to the end of this speedbar line.
2954 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2955 an the existing indicator is removed. If there is already an
2956 indicator, then do not add a space."
2958 ;; The nature of the beast: Assume we are in "the right place"
2960 (skip-chars-backward (concat " " speedbar-vc-indicator
2961 (car speedbar-obj-indicator)
2962 (cdr speedbar-obj-indicator)))
2963 (if (and (not (looking-at speedbar-indicator-regex))
2964 (not (string= indicator-string " ")))
2965 (insert speedbar-indicator-separator))
2966 (speedbar-with-writable
2968 (if (and replace-this
2969 (re-search-forward replace-this (save-excursion (end-of-line)
2972 (delete-region (match-beginning 0) (match-end 0))))
2974 (if (not (string= " " indicator-string))
2975 (insert indicator-string))))
2977 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2978 ;; Steven L Baur <steve@xemacs.org> said this was important:
2979 (eval-when-compile (or (featurep 'xemacs)
2980 (condition-case () (require 'efs)
2981 (error (require 'ange-ftp)))))
2983 (defun speedbar-check-vc ()
2984 "Scan all files in a directory, and for each see if it's checked out.
2985 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2986 to add more types of version control systems."
2987 ;; Check for to-do to be reset. If reset but no RCS is available
2988 ;; then set to nil (do nothing) otherwise, start at the beginning
2990 (set-buffer speedbar-buffer)
2991 (if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t)
2992 (speedbar-vc-check-dir-p default-directory)
2993 (not (or (and (featurep 'ange-ftp)
2995 (car (if speedbar-xemacsp
2996 ange-ftp-path-format
2997 ange-ftp-name-format))
2998 (expand-file-name default-directory)))
2999 ;; efs support: Bob Weiner
3000 (and (featurep 'efs)
3002 (car efs-path-regexp)
3003 (expand-file-name default-directory))))))
3004 (setq speedbar-vc-to-do-point 0))
3005 (if (numberp speedbar-vc-to-do-point)
3007 (goto-char speedbar-vc-to-do-point)
3008 (while (and (not (input-pending-p))
3009 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
3011 (setq speedbar-vc-to-do-point (point))
3012 (if (speedbar-check-vc-this-line (match-string 1))
3013 (speedbar-add-indicator speedbar-vc-indicator
3014 (regexp-quote speedbar-vc-indicator))
3015 (speedbar-add-indicator " "
3016 (regexp-quote speedbar-vc-indicator))))
3017 (if (input-pending-p)
3018 ;; return that we are incomplete
3020 ;; we are done, set to-do to nil
3021 (setq speedbar-vc-to-do-point nil)
3026 (defun speedbar-check-vc-this-line (depth)
3027 "Return t if the file on this line is check of of a version control system.
3028 Parameter DEPTH is a string with the current depth of indentation of
3029 the file being checked."
3030 (let* ((d (string-to-int depth))
3031 (f (speedbar-line-path d))
3032 (fn (buffer-substring-no-properties
3033 ;; Skip-chars: thanks ptype@dra.hmg.gb
3035 (skip-chars-forward "^ "
3036 (save-excursion (end-of-line)
3039 (fulln (concat f fn)))
3040 (if (<= 2 speedbar-verbosity-level)
3041 (speedbar-message "Speedbar vc check...%s" fulln))
3042 (and (file-writable-p fulln)
3043 (speedbar-this-file-in-vc f fn))))
3045 (defun speedbar-vc-check-dir-p (path)
3046 "Return t if we should bother checking PATH for version control files.
3047 This can be overloaded to add new types of version control systems."
3050 (file-exists-p (concat path "RCS/"))
3052 (file-exists-p (concat path "SCCS/"))
3053 ;; Remote SCCS project
3054 (let ((proj-dir (getenv "PROJECTDIR")))
3056 (file-exists-p (concat proj-dir "/SCCS"))
3059 (run-hook-with-args 'speedbar-vc-path-enable-hook path)
3062 (defun speedbar-this-file-in-vc (path name)
3063 "Check to see if the file in PATH with NAME is in a version control system.
3064 You can add new VC systems by overriding this function. You can
3065 optimize this function by overriding it and only doing those checks
3066 that will occur on your system."
3069 (file-exists-p (concat path "RCS/" name ",v"))
3070 (file-exists-p (concat path "RCS/" name))
3071 ;; Local SCCS file name
3072 (file-exists-p (concat path "SCCS/s." name))
3073 ;; Remote SCCS file name
3074 (let ((proj-dir (getenv "PROJECTDIR")))
3076 (file-exists-p (concat proj-dir "/SCCS/s." name))
3079 (run-hook-with-args 'speedbar-vc-in-control-hook path name)
3082 ;; Objet File scanning
3083 (defun speedbar-check-objects ()
3084 "Scan all files in a directory, and for each see if there is an object.
3085 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
3086 to add more object types."
3087 ;; Check for to-do to be reset. If reset but no RCS is available
3088 ;; then set to nil (do nothing) otherwise, start at the beginning
3090 (set-buffer speedbar-buffer)
3091 (if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t))
3092 (setq speedbar-obj-to-do-point 0))
3093 (if (numberp speedbar-obj-to-do-point)
3095 (goto-char speedbar-obj-to-do-point)
3096 (while (and (not (input-pending-p))
3097 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
3099 (setq speedbar-obj-to-do-point (point))
3100 (let ((ind (speedbar-check-obj-this-line (match-string 1))))
3101 (if (not ind) (setq ind " "))
3102 (speedbar-add-indicator ind (concat
3103 (car speedbar-obj-indicator)
3105 (cdr speedbar-obj-indicator)))))
3106 (if (input-pending-p)
3107 ;; return that we are incomplete
3109 ;; we are done, set to-do to nil
3110 (setq speedbar-obj-to-do-point nil)
3115 (defun speedbar-check-obj-this-line (depth)
3116 "Return t if the file on this line has an associated object.
3117 Parameter DEPTH is a string with the current depth of indentation of
3118 the file being checked."
3119 (let* ((d (string-to-int depth))
3120 (f (speedbar-line-path d))
3121 (fn (buffer-substring-no-properties
3122 ;; Skip-chars: thanks ptype@dra.hmg.gb
3124 (skip-chars-forward "^ "
3125 (save-excursion (end-of-line)
3128 (fulln (concat f fn)))
3129 (if (<= 2 speedbar-verbosity-level)
3130 (speedbar-message "Speedbar obj check...%s" fulln))
3131 (let ((oa speedbar-obj-alist))
3132 (while (and oa (not (string-match (car (car oa)) fulln)))
3134 (if (not (and oa (file-exists-p (concat (file-name-sans-extension fulln)
3137 ;; Find out if the object is out of date or not.
3138 (let ((date1 (nth 5 (file-attributes fulln)))
3139 (date2 (nth 5 (file-attributes (concat
3140 (file-name-sans-extension fulln)
3142 (if (or (< (car date1) (car date2))
3143 (and (= (car date1) (car date2))
3144 (< (nth 1 date1) (nth 1 date2))))
3145 (car speedbar-obj-indicator)
3146 (cdr speedbar-obj-indicator)))))))
3148 ;;; Clicking Activity
3150 (defun speedbar-mouse-set-point (e)
3151 "Set POINT based on event E.
3152 Handle clicking on images in XEmacs."
3153 (if (and (fboundp 'event-over-glyph-p) (event-over-glyph-p e))
3154 ;; We are in XEmacs, and clicked on a picture
3155 (let ((ext (event-glyph-extent e)))
3156 ;; This position is back inside the extent where the
3157 ;; junk we pushed into the property list lives.
3158 (if (extent-end-position ext)
3159 (goto-char (1- (extent-end-position ext)))
3160 (mouse-set-point e)))
3161 ;; We are not in XEmacs, OR we didn't click on a picture.
3162 (mouse-set-point e)))
3164 (defun speedbar-quick-mouse (e)
3165 "Since mouse events are strange, this will keep the mouse nicely positioned.
3166 This should be bound to mouse event E."
3168 (speedbar-mouse-set-point e)
3169 (speedbar-position-cursor-on-line)
3172 (defun speedbar-position-cursor-on-line ()
3173 "Position the cursor on a line."
3174 (let ((oldpos (point)))
3176 (if (looking-at "[0-9]+:\\s-*..?.? ")
3177 (goto-char (1- (match-end 0)))
3178 (goto-char oldpos))))
3180 (defun speedbar-power-click (e)
3181 "Activate any speedbar button as a power click.
3182 A power click will dispose of cached data (if available) or bring a buffer
3183 up into a different window.
3184 This should be bound to mouse event E."
3186 (let ((speedbar-power-click t))
3187 (speedbar-click e)))
3189 (defun speedbar-click (e)
3190 "Activate any speedbar buttons where the mouse is clicked.
3191 This must be bound to a mouse event. A button is any location of text
3192 with a mouse face that has a text property called `speedbar-function'.
3193 This should be bound to mouse event E."
3195 (speedbar-mouse-set-point e)
3196 (speedbar-do-function-pointer)
3197 (speedbar-quick-mouse e))
3199 (defun speedbar-double-click (e)
3200 "Activate any speedbar buttons where the mouse is clicked.
3201 This must be bound to a mouse event. A button is any location of text
3202 with a mouse face that has a text property called `speedbar-function'.
3203 This should be bound to mouse event E."
3205 ;; Emacs only. XEmacs handles this via `mouse-track-click-hook'.
3206 (cond ((eq (car e) 'down-mouse-1)
3207 (speedbar-mouse-set-point e))
3208 ((eq (car e) 'mouse-1)
3209 (speedbar-quick-mouse e))
3210 ((or (eq (car e) 'double-down-mouse-1)
3211 (eq (car e) 'triple-down-mouse-1))
3212 (speedbar-mouse-set-point e)
3213 (speedbar-do-function-pointer)
3214 (speedbar-quick-mouse e))))
3216 (defun speedbar-do-function-pointer ()
3217 "Look under the cursor and examine the text properties.
3218 From this extract the file/tag name, token, indentation level and call
3219 a function if appropriate"
3220 (let* ((fn (get-text-property (point) 'speedbar-function))
3221 (tok (get-text-property (point) 'speedbar-token))
3222 ;; The 1-,+ is safe because scaning starts AFTER the point
3223 ;; specified. This lets the search include the character the
3225 (tp (previous-single-property-change
3226 (1+ (point)) 'speedbar-function))
3227 (np (next-single-property-change
3228 (point) 'speedbar-function))
3229 (txt (buffer-substring-no-properties (or tp (point-min))
3230 (or np (point-max))))
3231 (dent (save-excursion (beginning-of-line)
3233 (if (looking-at "[0-9]+")
3234 (buffer-substring-no-properties
3235 (match-beginning 0) (match-end 0))
3237 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3238 (and fn (funcall fn txt tok dent)))
3239 (speedbar-position-cursor-on-line))
3241 ;;; Reading info from the speedbar buffer
3243 (defun speedbar-line-text (&optional p)
3244 "Retrieve the text after prefix junk for the current line.
3245 Optional argument P is where to start the search from."
3247 (if p (goto-char p))
3249 (if (looking-at (concat
3250 "\\([0-9]+\\): *[[<{][-+?][]>}] \\([^ \n]+\\)\\("
3251 speedbar-indicator-regex "\\)?"))
3255 (defun speedbar-line-token (&optional p)
3256 "Retrieve the token information after the prefix junk for the current line.
3257 Optional argument P is where to start the search from."
3259 (if p (goto-char p))
3261 (if (looking-at (concat
3262 "\\([0-9]+\\): *[[<{]?[-+?=][]>}@()|] \\([^ \n]+\\)\\("
3263 speedbar-indicator-regex "\\)?"))
3265 (goto-char (match-beginning 2))
3266 (get-text-property (point) 'speedbar-token))
3269 (defun speedbar-line-file (&optional p)
3270 "Retrieve the file or whatever from the line at P point.
3271 The return value is a string representing the file. If it is a
3272 directory, then it is the directory name."
3274 (let ((f (speedbar-line-text p)))
3276 (let* ((depth (string-to-int (match-string 1)))
3277 (path (speedbar-line-path depth)))
3281 (defun speedbar-goto-this-file (file)
3282 "If FILE is displayed, goto this line and return t.
3283 Otherwise do not move and return nil."
3284 (let ((path (substring (file-name-directory (expand-file-name file))
3285 (length (expand-file-name default-directory))))
3288 (goto-char (point-min))
3289 ;; scan all the directories
3290 (while (and path (not (eq path t)))
3291 (if (string-match "^[/\\]?\\([^/\\]+\\)" path)
3292 (let ((pp (match-string 1 path)))
3293 (if (save-match-data
3294 (re-search-forward (concat "> " (regexp-quote pp) "$")
3296 (setq path (substring path (match-end 1)))
3299 ;; find the file part
3300 (if (or (not path) (string= (file-name-nondirectory file) ""))
3301 ;; only had a dir part
3304 (speedbar-position-cursor-on-line)
3306 (goto-char dest) nil)
3307 ;; find the file part
3308 (let ((nd (file-name-nondirectory file)))
3309 (if (re-search-forward
3310 (concat "] \\(" (regexp-quote nd)
3311 "\\)\\(" speedbar-indicator-regex "\\)$")
3314 (speedbar-position-cursor-on-line)
3319 (defun speedbar-line-path (&optional depth)
3320 "Retrieve the pathname associated with the current line.
3321 This may require traversing backwards from DEPTH and combining the default
3322 directory with these items. This function is replaceable in
3323 `speedbar-mode-functions-list' as `speedbar-line-path'"
3324 (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-path)))
3325 (if rf (funcall rf depth) default-directory)))
3327 (defun speedbar-files-line-path (&optional depth)
3328 "Retrieve the pathname associated with the current line.
3329 This may require traversing backwards from DEPTH and combining the default
3330 directory with these items."
3336 (looking-at "^\\([0-9]+\\):")
3337 (setq depth (string-to-int (match-string 1)))))
3339 (setq depth (1- depth))
3340 (while (/= depth -1)
3341 (if (not (re-search-backward (format "^%d:" depth) nil t))
3342 (error "Error building path of tag")
3343 (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)$")
3344 (setq path (concat (buffer-substring-no-properties
3345 (match-beginning 1) (match-end 1))
3348 ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)$")
3349 ;; This is the start of our path.
3350 (setq path (buffer-substring-no-properties
3351 (match-beginning 1) (match-end 1))))))
3352 (setq depth (1- depth)))
3354 (string-match (concat speedbar-indicator-regex "$")
3356 (setq path (substring path 0 (match-beginning 0))))
3357 (concat default-directory path)))))
3359 (defun speedbar-path-line (path)
3360 "Position the cursor on the line specified by PATH."
3362 (if (string-match "[/\\]$" path)
3363 (setq path (substring path 0 (match-beginning 0))))
3364 (let ((nomatch t) (depth 0)
3365 (fname (file-name-nondirectory path))
3366 (pname (file-name-directory path)))
3367 (if (not (member pname speedbar-shown-directories))
3368 (error "Internal Error: File %s not shown in speedbar" path))
3369 (goto-char (point-min))
3372 (concat "[]>] \\(" (regexp-quote fname)
3373 "\\)\\(" speedbar-indicator-regex "\\)?$")
3376 (looking-at "\\([0-9]+\\):")
3377 (setq depth (string-to-int (match-string 0))
3378 nomatch (not (string= pname (speedbar-line-path depth))))
3383 (defun speedbar-edit-line ()
3384 "Edit whatever tag or file is on the current speedbar line."
3388 ;; If this fails, then it is a non-standard click, and as such,
3389 ;; perfectly allowed.
3390 (if (re-search-forward "[]>?}] [^ ]"
3391 (save-excursion (end-of-line) (point))
3393 (speedbar-do-function-pointer)
3395 (speedbar-do-function-pointer)))
3397 (defun speedbar-expand-line (&optional arg)
3398 "Expand the line under the cursor.
3399 With universal argument ARG, flush cached data."
3402 (let ((speedbar-power-click arg))
3405 (re-search-forward ":\\s-*.\\+. "
3406 (save-excursion (end-of-line) (point)))
3408 (speedbar-do-function-pointer))
3409 (error (speedbar-position-cursor-on-line)))))
3411 (defun speedbar-flush-expand-line ()
3412 "Expand the line under the cursor and flush any cached information."
3414 (speedbar-expand-line 1))
3416 (defun speedbar-contract-line ()
3417 "Contract the line under the cursor."
3422 (re-search-forward ":\\s-*.-. "
3423 (save-excursion (end-of-line) (point)))
3425 (speedbar-do-function-pointer))
3426 (error (speedbar-position-cursor-on-line))))
3428 (if speedbar-xemacsp
3429 (defalias 'speedbar-mouse-event-p 'button-press-event-p)
3430 (defun speedbar-mouse-event-p (event)
3431 "Return t if the event is a mouse related event"
3432 ;; And Emacs does it this way
3433 (if (and (listp event)
3434 (member (event-basic-type event)
3435 '(mouse-1 mouse-2 mouse-3)))
3439 (defun speedbar-maybee-jump-to-attached-frame ()
3440 "Jump to the attached frame ONLY if this was not a mouse event."
3441 (if (or (not (speedbar-mouse-event-p last-input-event))
3442 speedbar-activity-change-focus-flag)
3444 (select-frame speedbar-attached-frame)
3447 (defun speedbar-find-file (text token indent)
3448 "Speedbar click handler for filenames.
3449 TEXT, the file will be displayed in the attached frame.
3450 TOKEN is unused, but required by the click handler. INDENT is the
3451 current indentation level."
3452 (let ((cdd (speedbar-line-path indent)))
3453 (speedbar-find-file-in-frame (concat cdd text))
3454 (speedbar-stealthy-updates)
3455 (run-hooks 'speedbar-visiting-file-hook)
3456 ;; Reset the timer with a new timeout when cliking a file
3457 ;; in case the user was navigating directories, we can cancel
3458 ;; that other timer.
3459 (speedbar-set-timer speedbar-update-speed))
3460 (speedbar-maybee-jump-to-attached-frame))
3462 (defun speedbar-dir-follow (text token indent)
3463 "Speedbar click handler for directory names.
3464 Clicking a directory will cause the speedbar to list files in the
3465 the subdirectory TEXT. TOKEN is an unused requirement. The
3466 subdirectory chosen will be at INDENT level."
3467 (setq default-directory
3468 (concat (expand-file-name (concat (speedbar-line-path indent) text))
3470 ;; Because we leave speedbar as the current buffer,
3471 ;; update contents will change directory without
3472 ;; having to touch the attached frame. Turn off smart expand just
3474 (let ((speedbar-smart-directory-expand-flag nil))
3475 (speedbar-update-contents))
3476 (speedbar-set-timer speedbar-navigating-speed)
3477 (setq speedbar-last-selected-file nil)
3478 (speedbar-stealthy-updates))
3480 (defun speedbar-delete-subblock (indent)
3481 "Delete text from point to indentation level INDENT or greater.
3482 Handles end-of-sublist smartly."
3483 (speedbar-with-writable
3485 (end-of-line) (forward-char 1)
3486 (let ((start (point)))
3487 (while (and (looking-at "^\\([0-9]+\\):")
3488 (> (string-to-int (match-string 1)) indent)
3491 (beginning-of-line))
3492 (delete-region start (point))))))
3494 (defun speedbar-dired (text token indent)
3495 "Speedbar click handler for directory expand button.
3496 Clicking this button expands or contracts a directory. TEXT is the
3497 button clicked which has either a + or -. TOKEN is the directory to be
3498 expanded. INDENT is the current indentation level."
3499 (cond ((string-match "+" text) ;we have to expand this dir
3500 (setq speedbar-shown-directories
3501 (cons (expand-file-name
3502 (concat (speedbar-line-path indent) token "/"))
3503 speedbar-shown-directories))
3504 (speedbar-change-expand-button-char ?-)
3505 (speedbar-reset-scanners)
3507 (end-of-line) (forward-char 1)
3508 (speedbar-with-writable
3509 (speedbar-default-directory-list
3510 (concat (speedbar-line-path indent) token "/")
3512 ((string-match "-" text) ;we have to contract this node
3513 (speedbar-reset-scanners)
3514 (let ((oldl speedbar-shown-directories)
3516 (td (expand-file-name
3517 (concat (speedbar-line-path indent) token))))
3519 (if (not (string-match (concat "^" (regexp-quote td)) (car oldl)))
3520 (setq newl (cons (car oldl) newl)))
3521 (setq oldl (cdr oldl)))
3522 (setq speedbar-shown-directories (nreverse newl)))
3523 (speedbar-change-expand-button-char ?+)
3524 (speedbar-delete-subblock indent)
3526 (t (error "Ooops... not sure what to do")))
3527 (speedbar-center-buffer-smartly)
3528 (setq speedbar-last-selected-file nil)
3529 (save-excursion (speedbar-stealthy-updates)))
3531 (defun speedbar-directory-buttons-follow (text token indent)
3532 "Speedbar click handler for default directory buttons.
3533 TEXT is the button clicked on. TOKEN is the directory to follow.
3534 INDENT is the current indentation level and is unused."
3535 (if (string-match "^[A-z]:$" token)
3536 (setq default-directory (concat token (char-to-string directory-sep-char)))
3537 (setq default-directory token))
3538 ;; Because we leave speedbar as the current buffer,
3539 ;; update contents will change directory without
3540 ;; having to touch the attached frame.
3541 (speedbar-update-contents)
3542 (speedbar-set-timer speedbar-navigating-speed))
3544 (defun speedbar-tag-file (text token indent)
3545 "The cursor is on a selected line. Expand the tags in the specified file.
3546 The parameter TEXT and TOKEN are required, where TEXT is the button
3547 clicked, and TOKEN is the file to expand. INDENT is the current
3549 (cond ((string-match "+" text) ;we have to expand this file
3550 (let* ((fn (expand-file-name (concat (speedbar-line-path indent)
3553 (lst (speedbar-fetch-dynamic-tags fn)))
3554 ;; if no list, then remove expando button
3556 (speedbar-change-expand-button-char ??)
3557 (speedbar-change-expand-button-char ?-)
3558 (speedbar-with-writable
3560 (end-of-line) (forward-char 1)
3561 (funcall (car lst) indent (cdr lst)))))))
3562 ((string-match "-" text) ;we have to contract this node
3563 (speedbar-change-expand-button-char ?+)
3564 (speedbar-delete-subblock indent))
3565 (t (error "Ooops... not sure what to do")))
3566 (speedbar-center-buffer-smartly))
3568 (defun speedbar-tag-find (text token indent)
3569 "For the tag TEXT in a file TOKEN, goto that position.
3570 INDENT is the current indentation level."
3571 (let ((file (speedbar-line-path indent)))
3572 (speedbar-find-file-in-frame file)
3573 (save-excursion (speedbar-stealthy-updates))
3574 ;; Reset the timer with a new timeout when cliking a file
3575 ;; in case the user was navigating directories, we can cancel
3576 ;; that other timer.
3577 (speedbar-set-timer speedbar-update-speed)
3579 (run-hooks 'speedbar-visiting-tag-hook)
3581 (speedbar-maybee-jump-to-attached-frame)
3584 (defun speedbar-tag-expand (text token indent)
3585 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3586 Etags does not support this feature. TEXT will be the button
3587 string. TOKEN will be the list, and INDENT is the current indentation
3589 (cond ((string-match "+" text) ;we have to expand this file
3590 (speedbar-change-expand-button-char ?-)
3591 (speedbar-with-writable
3593 (end-of-line) (forward-char 1)
3594 (speedbar-insert-generic-list indent token 'speedbar-tag-expand
3595 'speedbar-tag-find))))
3596 ((string-match "-" text) ;we have to contract this node
3597 (speedbar-change-expand-button-char ?+)
3598 (speedbar-delete-subblock indent))
3599 (t (error "Ooops... not sure what to do")))
3600 (speedbar-center-buffer-smartly))
3602 ;;; Loading files into the attached frame.
3604 (defun speedbar-find-file-in-frame (file)
3605 "This will load FILE into the speedbar attached frame.
3606 If the file is being displayed in a different frame already, then raise that
3608 (let* ((buff (find-file-noselect file))
3609 (bwin (get-buffer-window buff 0)))
3612 (select-window bwin)
3613 (raise-frame (window-frame bwin)))
3614 (if speedbar-power-click
3615 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3616 (select-frame speedbar-attached-frame)
3617 (switch-to-buffer buff))))
3620 ;;; Centering Utility
3622 (defun speedbar-center-buffer-smartly ()
3623 "Recenter a speedbar buffer so the current indentation level is all visible.
3624 This assumes that the cursor is on a file, or tag of a file which the user is
3626 (if (<= (count-lines (point-min) (point-max))
3627 (1- (window-height (selected-window))))
3628 ;; whole buffer fits
3630 (goto-char (point-min))
3634 (let (depth start end exp p)
3637 (setq depth (if (looking-at "[0-9]+")
3638 (string-to-int (buffer-substring-no-properties
3639 (match-beginning 0) (match-end 0)))
3641 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3644 (if (re-search-backward exp nil t)
3645 (setq start (point))
3646 (setq start (point-min)))
3647 (save-excursion ;Not sure about this part.
3650 (while (and (not (re-search-forward exp nil t))
3652 (setq depth (1- depth))
3653 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3656 (setq end (point-max)))))
3657 ;; Now work out the details of centering
3658 (let ((nl (count-lines start end))
3660 (if (> nl (window-height (selected-window)))
3661 ;; We can't fit it all, so just center on cursor
3662 (progn (goto-char start)
3664 ;; we can fit everything on the screen, but...
3665 (if (and (pos-visible-in-window-p start (selected-window))
3666 (pos-visible-in-window-p end (selected-window)))
3669 ;; we need to do something...
3671 (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
3672 (lte (count-lines start (point-max))))
3673 (if (and (< (+ newcent lte) (window-height (selected-window)))
3674 (> (- (window-height (selected-window)) lte 1)
3676 (setq newcent (- (window-height (selected-window))
3678 (recenter newcent))))
3682 ;;; Tag Management -- List of expanders:
3684 (defun speedbar-fetch-dynamic-tags (file)
3685 "Return a list of tags generated dynamically from FILE.
3686 This uses the entries in `speedbar-dynamic-tags-function-list'
3687 to find the proper tags. It is up to each of those individual
3688 functions to do caching and flushing if appropriate."
3690 (set-buffer (find-file-noselect file))
3691 ;; If there is a buffer-local value of
3692 ;; speedbar-dynamic-tags-function-list, it will now be available.
3693 (let ((dtf speedbar-dynamic-tags-function-list)
3695 (while (and (eq ret t) dtf)
3697 (if (fboundp (car (car dtf)))
3698 (funcall (car (car dtf)) (buffer-file-name))
3701 (setq dtf (cdr dtf))))
3703 ;; No valid tag list, return nil
3705 ;; We have some tags. Return the list with the insert fn
3707 (cons (cdr (car dtf)) ret)))))
3709 ;;; Tag Management -- Imenu
3711 (if (not speedbar-use-imenu-flag)
3715 (eval-when-compile (if (locate-library "imenu") (require 'imenu)))
3717 (defun speedbar-fetch-dynamic-imenu (file)
3718 "Load FILE into a buffer, and generate tags using Imenu.
3719 Returns the tag list, or t for an error."
3720 ;; Load this AND compile it in
3722 (if speedbar-power-click (setq imenu--index-alist nil))
3724 (let ((index-alist (imenu--make-index-alist t)))
3725 (if speedbar-sort-tags
3726 (sort (copy-alist index-alist)
3727 (lambda (a b) (string< (car a) (car b))))
3732 ;;; Tag Management -- etags (old XEmacs compatibility part)
3734 (defvar speedbar-fetch-etags-parse-list
3735 '(;; Note that java has the same parse-group as c
3736 ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\)\\'" .
3737 speedbar-parse-c-or-c++tag)
3738 ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
3739 "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
3740 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3741 ; speedbar-parse-fortran77-tag)
3742 ("\\.tex\\'" . speedbar-parse-tex-string)
3744 "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?")
3746 "Associations of file extensions and expressions for extracting tags.
3747 To add a new file type, you would want to add a new association to the
3748 list, where the car is the file match, and the cdr is the way to
3749 extract an element from the tags output. If the output is complex,
3750 use a function symbol instead of regexp. The function should expect
3751 to be at the beginning of a line in the etags buffer.
3753 This variable is ignored if `speedbar-use-imenu-flag' is non-nil.")
3755 (defvar speedbar-fetch-etags-command "etags"
3756 "*Command used to create an etags file.
3758 This variable is ignored if `speedbar-use-imenu-flag' is t")
3760 (defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-")
3761 "*List of arguments to use with `speedbar-fetch-etags-command'.
3762 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3763 modify this list conveniently.
3765 This variable is ignored if `speedbar-use-imenu-flag' is t")
3767 (defun speedbar-toggle-etags (flag)
3768 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3769 FLAG then becomes a member of etags command line arguments. If flag
3770 is \"sort\", then toggle the value of `speedbar-sort-tags'. If its
3771 value is \"show\" then toggle the value of
3772 `speedbar-show-unknown-files'.
3774 This function is a convenience function for XEmacs menu created by
3775 Farzin Guilak <farzin@protocol.com>"
3778 ((equal flag "sort")
3779 (setq speedbar-sort-tags (not speedbar-sort-tags)))
3780 ((equal flag "show")
3781 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files)))
3782 ((or (equal flag "-C")
3785 (if (member flag speedbar-fetch-etags-arguments)
3786 (setq speedbar-fetch-etags-arguments
3787 (delete flag speedbar-fetch-etags-arguments))
3788 (add-to-list 'speedbar-fetch-etags-arguments flag)))
3791 (defun speedbar-fetch-dynamic-etags (file)
3792 "For FILE, run etags and create a list of symbols extracted.
3793 Each symbol will be associated with its line position in FILE."
3794 (let ((newlist nil))
3797 (if (get-buffer "*etags tmp*")
3798 (kill-buffer "*etags tmp*")) ;kill to clean it up
3799 (if (<= 1 speedbar-verbosity-level)
3800 (speedbar-message "Fetching etags..."))
3801 (set-buffer (get-buffer-create "*etags tmp*"))
3802 (apply 'call-process speedbar-fetch-etags-command nil
3803 (current-buffer) nil
3804 (append speedbar-fetch-etags-arguments (list file)))
3805 (goto-char (point-min))
3806 (if (<= 1 speedbar-verbosity-level)
3807 (speedbar-message "Fetching etags..."))
3809 (let ((exprlst speedbar-fetch-etags-parse-list)
3811 (while (and (not ans) exprlst)
3812 (if (string-match (car (car exprlst)) file)
3813 (setq ans (car exprlst)))
3814 (setq exprlst (cdr exprlst)))
3818 (set-buffer (get-buffer-create "*etags tmp*"))
3819 (while (not (save-excursion (end-of-line) (eobp)))
3821 (setq tnl (speedbar-extract-one-symbol expr)))
3822 (if tnl (setq newlist (cons tnl newlist)))
3825 "Sorry, no support for a file of that extension"))))
3827 (if speedbar-sort-tags
3828 (sort newlist (lambda (a b) (string< (car a) (car b))))
3829 (reverse newlist))))
3831 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3832 ;; sure it's needed with the different sorting method.
3834 ;(defun speedbar-clean-etags()
3835 ; "Removes spaces before the ^? character, and removes `#define',
3836 ;return types, etc. preceding tags. This ensures that the sort operation
3837 ;works on the tags, not the return types."
3839 ; (goto-char (point-min))
3841 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3842 ; (replace-match "\C-?" nil nil))
3843 ; (goto-char (point-min))
3845 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3846 ; (delete-region (match-beginning 1) (match-end 1)))))
3848 (defun speedbar-extract-one-symbol (expr)
3849 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3850 The line should contain output from etags. Parse the output using the
3851 regular expression EXPR"
3852 (let* ((sym (if (stringp expr)
3854 (re-search-forward expr (save-excursion
3857 (buffer-substring-no-properties (match-beginning 1)
3860 (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)"
3866 (1+ (string-to-int (buffer-substring-no-properties
3874 (defun speedbar-parse-c-or-c++tag ()
3875 "Parse a c or c++ tag, which tends to be a little complex."
3877 (let ((bound (save-excursion (end-of-line) (point))))
3878 (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t)
3879 (buffer-substring-no-properties (match-beginning 1)
3881 ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t)
3882 (buffer-substring-no-properties (match-beginning 1)
3884 ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t)
3885 (buffer-substring-no-properties (match-beginning 1)
3890 (defun speedbar-parse-tex-string ()
3891 "Parse a Tex string. Only find data which is relevant."
3893 (let ((bound (save-excursion (end-of-line) (point))))
3894 (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t)
3895 (buffer-substring-no-properties (match-beginning 0)
3900 ;;; BUFFER DISPLAY mode.
3902 (defvar speedbar-buffers-key-map nil
3903 "Keymap used when in the buffers display mode.")
3905 (if speedbar-buffers-key-map
3907 (setq speedbar-buffers-key-map (speedbar-make-specialized-keymap))
3909 ;; Basic tree features
3910 (define-key speedbar-buffers-key-map "e" 'speedbar-edit-line)
3911 (define-key speedbar-buffers-key-map "\C-m" 'speedbar-edit-line)
3912 (define-key speedbar-buffers-key-map "+" 'speedbar-expand-line)
3913 (define-key speedbar-buffers-key-map "=" 'speedbar-expand-line)
3914 (define-key speedbar-buffers-key-map "-" 'speedbar-contract-line)
3916 ;; Buffer specific keybindings
3917 (define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer)
3918 (define-key speedbar-buffers-key-map "r" 'speedbar-buffer-revert-buffer)
3922 (defvar speedbar-buffer-easymenu-definition
3923 '(["Jump to buffer" speedbar-edit-line t]
3924 ["Expand File Tags" speedbar-expand-line
3925 (save-excursion (beginning-of-line)
3926 (looking-at "[0-9]+: *.\\+. "))]
3927 ["Flush Cache & Expand" speedbar-flush-expand-line
3928 (save-excursion (beginning-of-line)
3929 (looking-at "[0-9]+: *.\\+. "))]
3930 ["Contract File Tags" speedbar-contract-line
3931 (save-excursion (beginning-of-line)
3932 (looking-at "[0-9]+: *.-. "))]
3933 ["Kill Buffer" speedbar-buffer-kill-buffer
3934 (save-excursion (beginning-of-line)
3935 (looking-at "[0-9]+: *.-. "))]
3936 ["Revert Buffer" speedbar-buffer-revert-buffer
3937 (save-excursion (beginning-of-line)
3938 (looking-at "[0-9]+: *.-. "))]
3940 "Menu item elements shown when displaying a buffer list.")
3942 (defun speedbar-buffer-buttons (directory zero)
3943 "Create speedbar buttons based on the buffers currently loaded.
3944 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3945 (speedbar-buffer-buttons-engine nil))
3947 (defun speedbar-buffer-buttons-temp (directory zero)
3948 "Create speedbar buttons based on the buffers currently loaded.
3949 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3950 (speedbar-buffer-buttons-engine t))
3952 (defun speedbar-buffer-buttons-engine (temp)
3953 "Create speedbar buffer buttons.
3954 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3955 (insert "Active Buffers:\n")
3956 (let ((bl (buffer-list)))
3958 (if (string-match "^[ *]" (buffer-name (car bl)))
3960 (let* ((known (string-match speedbar-file-regexp
3961 (buffer-name (car bl))))
3962 (expchar (if known ?+ ??))
3963 (fn (if known 'speedbar-tag-file nil))
3964 (fname (save-excursion (set-buffer (car bl))
3965 (buffer-file-name))))
3966 (speedbar-make-tag-line 'bracket expchar fn
3967 (if fname (file-name-nondirectory fname))
3968 (buffer-name (car bl))
3969 'speedbar-buffer-click temp
3970 'speedbar-file-face 0)))
3972 (setq bl (buffer-list))
3973 (insert "Scratch Buffers:\n")
3975 (if (not (string-match "^\\*" (buffer-name (car bl))))
3977 (if (eq (car bl) speedbar-buffer)
3979 (speedbar-make-tag-line 'bracket ?? nil nil
3980 (buffer-name (car bl))
3981 'speedbar-buffer-click temp
3982 'speedbar-file-face 0)))
3984 (setq bl (buffer-list))
3985 (insert "Hidden Buffers:\n")
3987 (if (not (string-match "^ " (buffer-name (car bl))))
3989 (if (eq (car bl) speedbar-buffer)
3991 (speedbar-make-tag-line 'bracket ?? nil nil
3992 (buffer-name (car bl))
3993 'speedbar-buffer-click temp
3994 'speedbar-file-face 0)))
3995 (setq bl (cdr bl)))))
3997 (defun speedbar-buffers-item-info ()
3998 "Display information about the current buffer on the current line."
3999 (or (speedbar-item-info-tag-helper)
4000 (let* ((item (speedbar-line-text))
4001 (buffer (if item (get-buffer item) nil)))
4003 (speedbar-message "%s%s %S %d %s"
4004 (if (buffer-modified-p buffer) "* " "")
4006 (save-excursion (set-buffer buffer) major-mode)
4007 (save-excursion (set-buffer buffer)
4009 (or (buffer-file-name buffer) "<No file>"))))))
4011 (defun speedbar-buffers-line-path (&optional depth)
4012 "Fetch the full path to the file (buffer) specified on the current line.
4013 Optional argument DEPTH specifies the current depth of the back search."
4015 ;; Buffers are always at level 0
4016 (if (not (re-search-backward "^0:" nil t))
4018 (let* ((bn (speedbar-line-text))
4019 (buffer (if bn (get-buffer bn))))
4020 (if buffer (file-name-directory (buffer-file-name buffer))))))
4022 (defun speedbar-buffer-click (text token indent)
4023 "When the users clicks on a buffer-button in speedbar.
4024 TEXT is the buffer's name, TOKEN and INDENT are unused."
4025 (if speedbar-power-click
4026 (let ((pop-up-frames t)) (select-window (display-buffer text)))
4027 (select-frame speedbar-attached-frame)
4028 (switch-to-buffer text)
4029 (if token (speedbar-change-initial-expansion-list
4030 speedbar-previously-used-expansion-list-name))))
4032 (defun speedbar-buffer-kill-buffer ()
4033 "Kill the buffer the cursor is on in the speedbar buffer."
4037 ;; If this fails, then it is a non-standard click, and as such,
4038 ;; perfectly allowed.
4039 (if (re-search-forward "[]>?}] [^ ]"
4040 (save-excursion (end-of-line) (point))
4044 (buffer-substring (point) (save-excursion
4047 (if (and (get-buffer text)
4048 (speedbar-y-or-n-p (format "Kill buffer %s? " text)))
4050 (speedbar-refresh))))))
4052 (defun speedbar-buffer-revert-buffer ()
4053 "Revert the buffer the cursor is on in the speedbar buffer."
4057 ;; If this fails, then it is a non-standard click, and as such,
4058 ;; perfectly allowed
4059 (if (re-search-forward "[]>?}] [^ ]"
4060 (save-excursion (end-of-line) (point))
4064 (buffer-substring (point) (save-excursion
4067 (if (get-buffer text)
4070 (revert-buffer t)))))))
4073 ;;; Useful hook values and such.
4075 (defvar speedbar-highlight-one-tag-line nil
4076 "Overlay used for highlighting the most recently jumped to tag line.")
4078 (defun speedbar-highlight-one-tag-line ()
4079 "Highlight the current line, unhighlighting a previously jumped to line."
4080 (speedbar-unhighlight-one-tag-line)
4081 (setq speedbar-highlight-one-tag-line
4082 (speedbar-make-overlay (save-excursion (beginning-of-line) (point))
4083 (save-excursion (end-of-line)
4086 (speedbar-overlay-put speedbar-highlight-one-tag-line 'face
4087 'speedbar-highlight-face)
4088 (add-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line)
4091 (defun speedbar-unhighlight-one-tag-line ()
4092 "Unhighlight the currently highlight line."
4093 (if speedbar-highlight-one-tag-line
4095 (speedbar-delete-overlay speedbar-highlight-one-tag-line)
4096 (setq speedbar-highlight-one-tag-line nil)))
4097 (remove-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line))
4099 (defun speedbar-recenter-to-top ()
4100 "Recenter the current buffer so POINT is on the top of the window."
4103 (defun speedbar-recenter ()
4104 "Recenter the current buffer so POINT is in the center of the window."
4105 (recenter (/ (window-height (selected-window)) 2)))
4108 ;;; Color loading section.
4110 (defface speedbar-button-face '((((class color) (background light))
4111 (:foreground "green4"))
4112 (((class color) (background dark))
4113 (:foreground "green3")))
4114 "Face used for +/- buttons."
4115 :group 'speedbar-faces)
4117 (defface speedbar-file-face '((((class color) (background light))
4118 (:foreground "cyan4"))
4119 (((class color) (background dark))
4120 (:foreground "cyan"))
4122 "Face used for file names."
4123 :group 'speedbar-faces)
4125 (defface speedbar-directory-face '((((class color) (background light))
4126 (:foreground "blue4"))
4127 (((class color) (background dark))
4128 (:foreground "light blue")))
4129 "Faced used for directory names."
4130 :group 'speedbar-faces)
4131 (defface speedbar-tag-face '((((class color) (background light))
4132 (:foreground "brown"))
4133 (((class color) (background dark))
4134 (:foreground "yellow")))
4135 "Face used for displaying tags."
4136 :group 'speedbar-faces)
4138 (defface speedbar-selected-face '((((class color) (background light))
4139 (:foreground "red" :underline t))
4140 (((class color) (background dark))
4141 (:foreground "red" :underline t))
4143 "Face used to underline the file in the active window."
4144 :group 'speedbar-faces)
4146 (defface speedbar-highlight-face '((((class color) (background light))
4147 (:background "green"))
4148 (((class color) (background dark))
4149 (:background "sea green"))
4150 (((class grayscale monochrome)
4152 (:background "black"))
4153 (((class grayscale monochrome)
4155 (:background "white")))
4156 "Face used for highlighting buttons with the mouse."
4157 :group 'speedbar-faces)
4160 ;;; Image loading and inlining
4163 ;;; Some images if defimage is available:
4166 (if (fboundp 'defimage)
4167 (defalias 'defimage-speedbar 'defimage)
4169 (if (not (fboundp 'make-glyph))
4171 (defmacro defimage-speedbar (variable imagespec docstring)
4172 "Don't bother loading up an image...
4173 Argument VARIABLE is the varible to define.
4174 Argument IMAGESPEC is the list defining the image to create.
4175 Argument DOCSTRING is the documentation for VARIABLE."
4176 `(defvar ,variable nil ,docstring))
4179 (defun speedbar-find-image-on-load-path (image)
4180 "Find the image file IMAGE on the load path."
4183 (while (and l (not r))
4184 (if (file-exists-p (concat (car l) "/" image))
4185 (setq r (concat (car l) "/" image)))
4189 (defun speedbar-convert-emacs21-imagespec-to-xemacs (spec)
4190 "Convert the Emacs21 Image SPEC into an XEmacs image spec."
4191 (let* ((sl (car spec))
4194 (vector itype ':file (speedbar-find-image-on-load-path ifile))))
4196 (defmacro defimage-speedbar (variable imagespec docstring)
4197 "Devine VARIABLE as an image if `defimage' is not available..
4198 IMAGESPEC is the image data, and DOCSTRING is documentation for the image."
4200 ;; The Emacs21 version of defimage looks just like the XEmacs image
4201 ;; specifier, except that it needs a :type keyword. If we line
4202 ;; stuff up right, we can use this cheat to support XEmacs specifiers.
4205 (make-image-specifier
4206 (speedbar-convert-emacs21-imagespec-to-xemacs (quote ,imagespec)))
4213 (defimage-speedbar speedbar-directory-+
4214 ((:type xpm :file "sb-dir+.xpm" :ascent center))
4215 "Image used for closed directories with stuff in them.")
4217 (defimage-speedbar speedbar-directory--
4218 ((:type xpm :file "sb-dir-.xpm" :ascent center))
4219 "Image used for open directories with stuff in them.")
4221 (defimage-speedbar speedbar-file-+
4222 ((:type xpm :file "sb-file+.xpm" :ascent center))
4223 "Image used for closed files with stuff in them.")
4225 (defimage-speedbar speedbar-file--
4226 ((:type xpm :file "sb-file-.xpm" :ascent center))
4227 "Image used for open files with stuff in them.")
4229 (defimage-speedbar speedbar-file-
4230 ((:type xpm :file "sb-file.xpm" :ascent center))
4231 "Image used for files that can't be opened.")
4233 (defimage-speedbar speedbar-tag-
4234 ((:type xpm :file "sb-tag.xpm" :ascent center))
4235 "Image used for tags.")
4237 (defimage-speedbar speedbar-tag-+
4238 ((:type xpm :file "sb-tag+.xpm" :ascent center))
4239 "Image used for closed tag groups.")
4241 (defimage-speedbar speedbar-tag--
4242 ((:type xpm :file "sb-tag-.xpm" :ascent center))
4243 "Image used for open tag groups.")
4245 (defimage-speedbar speedbar-tag-gt
4246 ((:type xpm :file "sb-tag-gt.xpm" :ascent center))
4247 "Image used for open tag groups.")
4249 (defimage-speedbar speedbar-tag-v
4250 ((:type xpm :file "sb-tag-v.xpm" :ascent center))
4251 "Image used for open tag groups.")
4253 (defimage-speedbar speedbar-tag-type
4254 ((:type xpm :file "sb-tag-type.xpm" :ascent center))
4255 "Image used for open tag groups.")
4257 (defimage-speedbar speedbar-mail
4258 ((:type xpm :file "sb-mail.xpm" :ascent center))
4259 "Image used for open tag groups.")
4261 (defvar speedbar-expand-image-button-alist
4262 '(("<+>" . speedbar-directory-+)
4263 ("<->" . speedbar-directory--)
4264 ("[+]" . speedbar-file-+)
4265 ("[-]" . speedbar-file--)
4266 ("[?]" . speedbar-file-)
4267 ("{+}" . speedbar-tag-+)
4268 ("{-}" . speedbar-tag--)
4269 ("<M>" . speedbar-mail)
4270 (" =>" . speedbar-tag-)
4271 (" +>" . speedbar-tag-gt)
4272 (" ->" . speedbar-tag-v)
4273 (">" . speedbar-tag-)
4274 ("@" . speedbar-tag-type)
4275 (" @" . speedbar-tag-type)
4277 "List of text and image associations.")
4279 (defun speedbar-insert-image-button-maybe (start length)
4280 "Insert an image button based on text starting at START for LENGTH chars.
4281 If buttontext is unknown, just insert that text.
4282 If we have an image associated with it, use that image."
4283 (if speedbar-use-images
4284 (let* ((bt (buffer-substring start (+ length start)))
4285 (a (assoc bt speedbar-expand-image-button-alist)))
4286 ;; Regular images (created with `insert-image' are intangible
4287 ;; which (I suppose) make them more compatible with XEmacs 21.
4288 ;; Unfortunatly, there is a giant pile o code dependent on the
4289 ;; underlying text. This means if we leave it tangible, then I
4290 ;; don't have to change said giant piles o code.
4291 (if (and a (symbol-value (cdr a)))
4292 (if (fboundp 'set-extent-property)
4293 (add-text-properties (+ start (length bt)) start
4294 (list 'end-glyph (symbol-value (cdr a))
4295 'rear-nonsticky (list 'display)
4298 (add-text-properties start (+ start (length bt))
4299 (list 'display (symbol-value (cdr a))
4300 'rear-nonsticky (list 'display))))
4301 ;(message "Bad text [%s]" (buffer-substring start (+ start length)))
4305 ;; some edebug hooks
4306 (add-hook 'edebug-setup-hook
4308 (def-edebug-spec speedbar-with-writable def-body)))
4311 ;;; speedbar ends here
4313 ;; run load-time hooks
4314 (run-hooks 'speedbar-load-hook)