1 ;;; speedbar --- quick access to files and tags in a frame
3 ;;; Copyright (C) 1996, 97, 98 Free Software Foundation
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Keywords: file, tags, tools
8 ;; X-RCS: $Id: speedbar.el,v 1.16 1998/09/18 09:21:27 schwab Exp zappo $
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; The speedbar provides a frame in which files, and locations in
30 ;; files are displayed. These items can be clicked on with mouse-2
31 ;; in order to make the last active frame display that file location.
35 ;; If speedbar came to you as a part of Emacs, simply type
36 ;; `M-x speedbar', and it will be autoloaded for you.
38 ;; If speedbar is not a part of your distribution, then add
39 ;; this to your .emacs file:
41 ;; (autoload 'speedbar-frame-mode "speedbar" "Popup a speedbar frame" t)
42 ;; (autoload 'speedbar-get-focus "speedbar" "Jump to speedbar frame" t)
44 ;; If you want to choose it from a menu, such as "Tools", you can do this:
47 ;; (define-key-after (lookup-key global-map [menu-bar tools])
48 ;; [speedbar] '("Speedbar" . speedbar-frame-mode) [calendar])
51 ;; (add-menu-button '("Tools")
52 ;; ["Speedbar" speedbar-frame-mode
54 ;; :selected (and (boundp 'speedbar-frame)
55 ;; (frame-live-p speedbar-frame)
56 ;; (frame-visible-p speedbar-frame))]
59 ;; If you want to access speedbar using only the keyboard, do this:
61 ;; (global-set-key [(f4)] 'speedbar-get-focus)
63 ;; This will let you hit f4 (or whatever key you choose) to jump
64 ;; focus to the speedbar frame. Pressing it again will bring you back
65 ;; to the attached frame. Pressing RET or e to jump to a file
66 ;; or tag will move you back to the attached frame. The command
67 ;; `speedbar-get-focus' will also create a speedbar frame if it does
70 ;; Customizing Speedbar:
72 ;; Once a speedbar frame is active, it takes advantage of idle time
73 ;; to keep its contents updated. The contents is usually a list of
74 ;; files in the directory of the currently active buffer. When
75 ;; applicable, tags in the active file can be expanded.
77 ;; To add new supported files types into speedbar, use the function
78 ;; `speedbar-add-supported-extension' If speedbar complains that the
79 ;; file type is not supported, that means there is no built in
80 ;; support from imenu, and the etags part wasn't set up correctly. You
81 ;; may add elements to `speedbar-supported-extension-expressions' as long
82 ;; as it is done before speedbar is loaded.
84 ;; To prevent speedbar from following you into certain directories
85 ;; use the function `speedbar-add-ignored-path-regexp' too add a new
86 ;; regular expression matching a type of path. You may add list
87 ;; elements to `speedbar-ignored-path-expressions' as long as it is
88 ;; done before speedbar is loaded.
90 ;; To add new file types to imenu, see the documentation in the
91 ;; file imenu.el that comes with Emacs. To add new file types which
92 ;; etags supports, you need to modify the variable
93 ;; `speedbar-fetch-etags-parse-list'.
95 ;; If the updates are going too slow for you, modify the variable
96 ;; `speedbar-update-speed' to a longer idle time before updates.
98 ;; If you navigate directories, you will probably notice that you
99 ;; will navigate to a directory which is eventually replaced after
100 ;; you go back to editing a file (unless you pull up a new file.)
101 ;; The delay time before this happens is in
102 ;; `speedbar-navigating-speed', and defaults to 10 seconds.
104 ;; To enable mouse tracking with information in the minibuffer of
105 ;; the attached frame, use the variable `speedbar-track-mouse-flag'.
107 ;; Tag layout can be modified through `speedbar-tag-hierarchy-method',
108 ;; which controls how tags are layed out. It is actually a list of
109 ;; functions that filter the data. The default groups large tag lists
110 ;; into sub-lists. A long flat list can be used instead if needed.
111 ;; Other filters could be easily added.
113 ;; Users of XEmacs previous to 20 may want to change the default
114 ;; timeouts for `speedbar-update-speed' to something longer as XEmacs
115 ;; doesn't have idle timers, the speedbar timer keeps going off
116 ;; arbitrarily while you're typing. It's quite pesky.
118 ;; Users of really old emacsen without the needed timers will not
119 ;; have speedbar updating automatically. Use "r" to refresh the
120 ;; display after changing directories. Remember, do not interrupt the
121 ;; stealthy updates or your display may not be completely refreshed.
123 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
124 ;; well. Use the imenu keywords from tex-mode.el for better results.
126 ;; This file requires the library package assoc (association lists)
127 ;; and the package custom (for easy configuration of speedbar)
128 ;; http://www.dina.kvl.dk/~abraham/custom/
130 ;;; Developing for speedbar
132 ;; Adding a speedbar specialized display mode:
134 ;; Speedbar can be configured to create a special display for certain
135 ;; modes that do not display tradition file/tag data. Rmail, Info,
136 ;; and the debugger are examples. These modes can, however, benefit
137 ;; from a speedbar style display in their own way.
139 ;; If your `major-mode' is `foo-mode', the only requirement is to
140 ;; create a function called `foo-speedbar-buttons' which takes one
141 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
142 ;; In `foo-speedbar-buttons' there are several functions that make
143 ;; building a speedbar display easy. See the documentation for
144 ;; `speedbar-with-writable' (needed because the buffer is usually
145 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
146 ;; `speedbar-insert-generic-list'. If you use
147 ;; `speedbar-insert-generic-list', also read the doc for
148 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
149 ;; The function `speedbar-with-attached-buffer' brings you back to the
150 ;; buffer speedbar is displaying for.
152 ;; For those functions that make buttons, the "function" should be a
153 ;; symbol that is the function to call when clicked on. The "token"
154 ;; is extra data you can pass along. The "function" must take three
155 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
156 ;; button clicked on. TOKEN is the data passed in when you create the
157 ;; button. INDENT is an indentation level, or 0. You can store
158 ;; indentation levels with `speedbar-make-tag-line' which creates a
159 ;; line with an expander (eg. [+]) and a text button.
161 ;; Some useful functions when writing expand functions, and click
162 ;; functions are `speedbar-change-expand-button-char',
163 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
164 ;; The variable `speedbar-power-click' is set to t in your functions
165 ;; when the user shift-clicks. This indications anything from
166 ;; refreshing cached data to making a buffer appear in a new frame.
168 ;; If you wish to add to the default speedbar menu for the case of
169 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
170 ;; should be a list compatible with the `easymenu' package. It will
171 ;; be spliced into the main menu. (Available with click-mouse-3). If
172 ;; you wish to have extra key bindings in your special mode, create a
173 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
174 ;; or `make-sparse-keymap', use the function
175 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
176 ;; speedbar's default bindings with low overhead.
178 ;; Adding a speedbar top-level display mode:
180 ;; Unlike the specialized modes, there are no name requirements,
181 ;; however the methods for writing a button display, menu, and keymap
182 ;; are the same. Once you create these items, you can call the
183 ;; function `speedbar-add-expansion-list'. It takes one parameter
184 ;; which is a list element of the form (NAME MENU KEYMAP &rest
185 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
186 ;; Displays menu item. MENU is a symbol containing the menu items to
187 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
188 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
192 ;; - More functions to create buttons and options
193 ;; - Timeout directories we haven't visited in a while.
194 ;; - Remeber tags when refreshing the display. (Refresh tags too?)
195 ;; - More 'special mode support.
200 (defvar speedbar-xemacsp (string-match "XEmacs" emacs-version)
201 "Non-nil if we are running in the XEmacs environment.")
202 (defvar speedbar-xemacs20p (and speedbar-xemacsp
203 (= emacs-major-version 20)))
205 ;; From custom web page for compatibility between versions of custom:
210 (if (and (featurep 'custom) (fboundp 'custom-declare-variable)
211 ;; Some XEmacsen w/ custom don't have :set keyword.
212 ;; This protects them against custom.
213 (fboundp 'custom-initialize-set))
214 nil ;; We've got what we needed
215 ;; We have the old custom-library, hack around it!
216 (defmacro defgroup (&rest args)
218 (defmacro defface (var values doc &rest args)
220 (defvar (, var) (quote (, var)))
221 ;; To make colors for your faces you need to set your .Xdefaults
222 ;; or set them up ahead of time in your .emacs file.
225 (defmacro defcustom (var value doc &rest args)
226 (` (defvar (, var) (, value) (, doc))))))
228 ;; customization stuff
229 (defgroup speedbar nil
230 "File and tag browser frame."
236 (defgroup speedbar-faces nil
237 "Faces used in speedbar."
242 (defgroup speedbar-vc nil
243 "Version control display in speedbar."
248 (defvar speedbar-initial-expansion-mode-alist
249 '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
250 speedbar-buffer-buttons)
251 ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
252 speedbar-buffer-buttons-temp)
253 ;; Files last, means first in the Displays menu
254 ("files" speedbar-easymenu-definition-special speedbar-file-key-map
255 speedbar-directory-buttons speedbar-default-directory-list)
257 "List of named expansion elements for filling the speedbar frame.
258 These expansion lists are only valid for regular files. Special modes
259 still get to override this list on a mode-by-mode basis. This list of
260 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
261 representing the types of things to be displayed. MENU is an easymenu
262 structure used when in this mode. KEYMAP is a local keymap to install
263 over the regular speedbar keymap. FN1 ... are functions that will be
264 called in order. These functions will always get the default
265 directory to use passed in as the first parameter, and a 0 as the
266 second parameter. The 0 indicates the uppermost indentation level.
267 They must assume that the cursor is at the position where they start
270 (defvar speedbar-initial-expansion-list-name "files"
271 "A symbol name representing the expansion list to use.
272 The expansion list `speedbar-initial-expansion-mode-alist' contains
273 the names and associated functions to use for buttons in speedbar.")
275 (defvar speedbar-previously-used-expansion-list-name "files"
276 "Save the last expansion list method.
277 This is used for returning to a previous expansion list method when
278 the user is done with the current expansion list.")
280 (defvar speedbar-stealthy-function-list
282 speedbar-update-current-file speedbar-check-vc speedbar-check-objects)
284 "List of functions to periodically call stealthily.
285 This list is of the form:
286 '( (\"NAME\" FUNCTION ...)
288 where NAME is the name of the major display mode these functions are
289 for, and the remaining elements FUNCTION are functions to call in order.
290 Each function must return nil if interrupted, or t if completed.
291 Stealthy functions which have a single operation should always return
292 t. Functions which take a long time should maintain a state (where
293 they are in their speedbar related calculations) and permit
294 interruption. See `speedbar-check-vc' as a good example.")
296 (defcustom speedbar-mode-specific-contents-flag t
297 "*Non-nil means speedbar will show special mode contents.
298 This permits some modes to create customized contents for the speedbar
303 (defvar speedbar-special-mode-expansion-list nil
304 "Default function list for creating specialized button lists.
305 This list is set by modes that wish to have special speedbar displays.
306 The list is of function names. Each function is called with one
307 parameter BUFFER, the originating buffer. The current buffer is the
310 (defvar speedbar-special-mode-key-map nil
311 "Default keymap used when identifying a specialized display mode.
312 This keymap is local to each buffer that wants to define special keybindings
313 effective when it's display is shown.")
315 (defcustom speedbar-visiting-file-hook nil
316 "Hooks run when speedbar visits a file in the selected frame."
320 (defcustom speedbar-visiting-tag-hook nil
321 "Hooks run when speedbar visits a tag in the selected frame."
325 (defcustom speedbar-load-hook nil
326 "Hooks run when speedbar is loaded."
330 (defcustom speedbar-show-unknown-files nil
331 "*Non-nil show files we can't expand with a ? in the expand button.
332 nil means don't show the file in the list."
336 (defcustom speedbar-update-speed
338 (if speedbar-xemacs20p
339 2 ; 1 is too obrusive in XEmacs
340 5) ; when no idleness, need long delay
342 "*Idle time in seconds needed before speedbar will update itself.
343 Updates occur to allow speedbar to display directory information
344 relevant to the buffer you are currently editing."
348 ;; When I moved to a repeating timer, I had the horrible missfortune
349 ;; of loosing the ability for adaptive speed choice. This update
350 ;; speed currently causes long delays when it should have been turned off.
351 (defcustom speedbar-navigating-speed speedbar-update-speed
352 "*Idle time to wait after navigation commands in speedbar are executed.
353 Navigation commands included expanding/contracting nodes, and moving
354 between different directories."
358 (defcustom speedbar-frame-parameters '((minibuffer . nil)
363 "*Parameters to use when creating the speedbar frame in Emacs.
364 Parameters not listed here which will be added automatically are
365 `height' which will be initialized to the height of the frame speedbar
368 :type '(repeat (sexp :tag "Parameter:")))
370 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
371 (defcustom speedbar-frame-plist
372 '(minibuffer nil width 20 border-width 0
373 internal-border-width 0 unsplittable t
374 default-toolbar-visible-p nil has-modeline-p nil
375 menubar-visible-p nil
376 ;; I don't see the particular value of these three, but...
377 text-pointer-glyph [cursor-font :data "top_left_arrow"]
378 nontext-pointer-glyph [cursor-font :data "top_left_arrow"]
379 selection-pointer-glyph [cursor-font :data "hand2"])
380 "*Parameters to use when creating the speedbar frame in XEmacs.
381 Parameters not listed here which will be added automatically are
382 `height' which will be initialized to the height of the frame speedbar
385 :type '(repeat (group :inline t
386 (symbol :tag "Property")
387 (sexp :tag "Value"))))
389 (defcustom speedbar-use-imenu-flag (stringp (locate-library "imenu"))
390 "*Non-nil means use imenu for file parsing. nil to use etags.
391 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
392 use etags instead. Etags support is not as robust as imenu support."
397 (defcustom speedbar-track-mouse-flag t
398 "*Non-nil means to display info about the line under the mouse."
402 (defcustom speedbar-sort-tags nil
403 "*If Non-nil, sort tags in the speedbar display. *Obsolete*."
407 (defcustom speedbar-tag-hierarchy-method
408 '(prefix-group trim-words)
409 "*List of methods which speedbar will use to organize tags into groups.
410 Groups are defined as expandable meta-tags. Imenu supports such
411 things in some languages, such as separating variables from functions.
412 Available methods are:
413 sort - Sort tags. (sometimes unnecessary)
414 trim-words - Trim all tags by a common prefix, broken @ word sections.
415 prefix-group - Try to guess groups by prefix.
416 simple-group - If imenu already returned some meta groups, stick all
417 tags that are not in a group into a sub-group."
421 (const :tag "Sort the tags." sort)
422 (const :tag "Trim words to common prefix." trim-words)
423 (const :tag "Create groups from common prefixes." prefix-group)
424 (const :tag "Group loose tags into their own group." simple-group))
427 (defcustom speedbar-tag-split-minimum-length 20
428 "*Minimum length before we stop trying to create sub-lists in tags.
429 This is used by all tag-hierarchy methods that break large lists into
434 (defcustom speedbar-tag-regroup-maximum-length 10
435 "*Maximum length of submenus that are regrouped.
436 If the regrouping option is used, then if two or more short subgroups
437 are next to each other, then they are combined until this number of
442 (defcustom speedbar-activity-change-focus-flag nil
443 "*Non-nil means the selected frame will change based on activity.
444 Thus, if a file is selected for edit, the buffer will appear in the
445 selected frame and the focus will change to that frame."
449 (defcustom speedbar-directory-button-trim-method 'span
450 "*Indicates how the directory button will be displayed.
452 'span - span large directories over multiple lines.
453 'trim - trim large directories to only show the last few.
456 :type '(radio (const :tag "Span large directories over mutiple lines."
458 (const :tag "Trim large directories to only show the last few."
460 (const :tag "No trimming." nil)))
462 (defcustom speedbar-smart-directory-expand-flag t
463 "*Non-nil means speedbar should use smart expansion.
464 Smart expansion only affects when speedbar wants to display a
465 directory for a file in the attached frame. When smart expansion is
466 enabled, new directories which are children of a displayed directory
467 are expanded in the current framework. If nil, then the current
468 hierarchy would be replaced with the new directory."
472 (defvar speedbar-hide-button-brackets-flag nil
473 "*Non-nil means speedbar will hide the brackets around the + or -.")
475 (defcustom speedbar-before-popup-hook nil
476 "*Hooks called before popping up the speedbar frame."
480 (defcustom speedbar-before-delete-hook nil
481 "*Hooks called before deleting the speedbar frame."
485 (defcustom speedbar-mode-hook nil
486 "*Hooks called after creating a speedbar buffer."
490 (defcustom speedbar-timer-hook nil
491 "*Hooks called after running the speedbar timer function."
495 (defcustom speedbar-verbosity-level 1
496 "*Verbosity level of the speedbar. 0 means say nothing.
497 1 means medium level verbosity. 2 and higher are higher levels of
502 (defvar speedbar-indicator-separator " "
503 "String separating file text from indicator characters.")
505 (defcustom speedbar-vc-do-check t
506 "*Non-nil check all files in speedbar to see if they have been checked out.
507 Any file checked out is marked with `speedbar-vc-indicator'"
511 (defvar speedbar-vc-indicator "*"
512 "Text used to mark files which are currently checked out.
513 Currently only RCS is supported. Other version control systems can be
514 added by examining the function `speedbar-this-file-in-vc' and
515 `speedbar-vc-check-dir-p'")
517 (defcustom speedbar-vc-path-enable-hook nil
518 "*Return non-nil if the current path should be checked for Version Control.
519 Functions in this hook must accept one parameter which is the path
524 (defcustom speedbar-vc-in-control-hook nil
525 "*Return non-nil if the specified file is under Version Control.
526 Functions in this hook must accept two parameters. The PATH of the
527 current file, and the FILENAME of the file being checked."
531 (defvar speedbar-vc-to-do-point nil
532 "Local variable maintaining the current version control check position.")
534 (defcustom speedbar-obj-do-check t
535 "*Non-nil check all files in speedbar to see if they have an object file.
536 Any file checked out is marked with `speedbar-obj-indicator', and the
537 marking is based on `speedbar-obj-alist'"
541 (defvar speedbar-obj-to-do-point nil
542 "Local variable maintaining the current version control check position.")
544 (defvar speedbar-obj-indicator '("#" . "!")
545 "Text used to mark files that have a corresponding hidden object file.
546 The car is for an up-to-date object. The cdr is for an out of date object.
547 The expression `speedbar-obj-alist' defines who gets tagged.")
549 (defvar speedbar-obj-alist
550 '(("\\.\\([cpC]\\|cpp\\|cc\\)$" . ".o")
552 ("\\.java$" . ".class")
553 ("\\.f\\(or\\|90\\|77\\)?$" . ".o")
555 ("\\.texi$" . ".info"))
556 "Alist of file extensions, and their corresponding object file type.")
558 (defvar speedbar-indicator-regex
559 (concat (regexp-quote speedbar-indicator-separator)
561 (regexp-quote speedbar-vc-indicator)
563 (regexp-quote (car speedbar-obj-indicator))
565 (regexp-quote (cdr speedbar-obj-indicator))
567 "Regular expression used when identifying files.
568 Permits stripping of indicator characters from a line.")
570 (defcustom speedbar-scanner-reset-hook nil
571 "*Hook called whenever generic scanners are reset.
572 Set this to implement your own scanning / rescan safe functions with
577 (defvar speedbar-ignored-modes nil
578 "*List of major modes which speedbar will not switch directories for.")
580 (defun speedbar-extension-list-to-regex (extlist)
581 "Takes EXTLIST, a list of extensions and transforms it into regexp.
582 All the preceding `.' are stripped for an optimized expression starting
583 with `.' followed by extensions, followed by full-filenames."
584 (let ((regex1 nil) (regex2 nil))
586 (if (= (string-to-char (car extlist)) ?.)
587 (setq regex1 (concat regex1 (if regex1 "\\|" "")
588 (substring (car extlist) 1)))
589 (setq regex2 (concat regex2 (if regex2 "\\|" "") (car extlist))))
590 (setq extlist (cdr extlist)))
591 ;; concat all the sub-exressions together, making sure all types
592 ;; of parts exist during concatination.
594 (if regex1 (concat "\\(\\.\\(" regex1 "\\)\\)") "")
595 (if (and regex1 regex2) "\\|" "")
596 (if regex2 (concat "\\(" regex2 "\\)") "")
599 (defvar speedbar-ignored-path-regexp nil
600 "Regular expression matching paths speedbar will not switch to.
601 Created from `speedbar-ignored-path-expressions' with the function
602 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
603 Use the function `speedbar-add-ignored-path-regexp', or customize the
604 variable `speedbar-ignored-path-expressions' to modify this variable.")
606 (defcustom speedbar-ignored-path-expressions
608 "*List of regular expressions matching directories speedbar will ignore.
609 They should included paths to directories which are notoriously very
610 large and take a long time to load in. Use the function
611 `speedbar-add-ignored-path-regexp' to add new items to this list after
612 speedbar is loaded. You may place anything you like in this list
613 before speedbar has been loaded."
615 :type '(repeat (regexp :tag "Path Regexp"))
616 :set (lambda (sym val)
617 (setq speedbar-ignored-path-expressions val
618 speedbar-ignored-path-regexp
619 (speedbar-extension-list-to-regex val))))
621 (defcustom speedbar-directory-unshown-regexp "^\\(CVS\\|RCS\\|SCCS\\)\\'"
622 "*Regular expression matching directories not to show in speedbar.
623 They should include commonly existing directories which are not
624 useful, such as version control."
628 (defvar speedbar-file-unshown-regexp
629 (let ((nstr "") (noext completion-ignored-extensions))
631 (setq nstr (concat nstr (regexp-quote (car noext)) "\\'"
632 (if (cdr noext) "\\|" ""))
634 ;; backup refdir lockfile
635 (concat nstr "\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
636 "*Regexp matching files we don't want displayed in a speedbar buffer.
637 It is generated from the variable `completion-ignored-extensions'")
639 ;; this is dangerous to customize, because the defaults will probably
640 ;; change in the future.
641 (defcustom speedbar-supported-extension-expressions
642 (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
643 ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?")
644 (if speedbar-use-imenu-flag
645 '(".ada" ".pl" ".tcl" ".m" ".scm" ".pm" ".py"
646 ;; html is not supported by default, but an imenu tags package
647 ;; is available. Also, html files are nice to be able to see.
649 "Makefile\\(\\.in\\)?")))
650 "*List of regular expressions which will match files supported by tagging.
651 Do not prefix the `.' char with a double \\ to quote it, as the period
652 will be stripped by a simplified optimizer when compiled into a
653 singular expression. This variable will be turned into
654 `speedbar-file-regexp' for use with speedbar. You should use the
655 function `speedbar-add-supported-extension' to add a new extension at
656 runtime, or use the configuration dialog to set it in your .emacs
659 :type '(repeat (regexp :tag "Extension Regexp"))
660 :set (lambda (sym val)
661 (setq speedbar-supported-extension-expressions val
662 speedbar-file-regexp (speedbar-extension-list-to-regex val)))
665 (defvar speedbar-file-regexp
666 (speedbar-extension-list-to-regex speedbar-supported-extension-expressions)
667 "Regular expression matching files we know how to expand.
668 Created from `speedbar-supported-extension-expression' with the
669 function `speedbar-extension-list-to-regex'")
671 (defun speedbar-add-supported-extension (extension)
672 "Add EXTENSION as a new supported extension for speedbar tagging.
673 This should start with a `.' if it is not a complete file name, and
674 the dot should NOT be quoted in with \\. Other regular expression
675 matchers are allowed however. EXTENSION may be a single string or a
677 (interactive "sExtionsion: ")
678 (if (not (listp extension)) (setq extension (list extension)))
680 (if (member (car extension) speedbar-supported-extension-expressions)
682 (setq speedbar-supported-extension-expressions
683 (cons (car extension) speedbar-supported-extension-expressions)))
684 (setq extension (cdr extension)))
685 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
686 speedbar-supported-extension-expressions)))
688 (defun speedbar-add-ignored-path-regexp (path-expression)
689 "Add PATH-EXPRESSION as a new ignored path for speedbar tracking.
690 This function will modify `speedbar-ignored-path-regexp' and add
691 PATH-EXPRESSION to `speedbar-ignored-path-expressions'."
692 (interactive "sPath regex: ")
693 (if (not (listp path-expression))
694 (setq path-expression (list path-expression)))
695 (while path-expression
696 (if (member (car path-expression) speedbar-ignored-path-expressions)
698 (setq speedbar-ignored-path-expressions
699 (cons (car path-expression) speedbar-ignored-path-expressions)))
700 (setq path-expression (cdr path-expression)))
701 (setq speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
702 speedbar-ignored-path-expressions)))
704 ;; If we don't have custom, then we set it here by hand.
705 (if (not (fboundp 'custom-declare-variable))
706 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
707 speedbar-supported-extension-expressions)
708 speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
709 speedbar-ignored-path-expressions)))
711 (defvar speedbar-update-flag (and
712 (or (fboundp 'run-with-idle-timer)
713 (fboundp 'start-itimer)
714 (boundp 'post-command-idle-hook))
716 "*Non-nil means to automatically update the display.
717 When this is nil then speedbar will not follow the attached frame's path.
718 When speedbar is active, use:
720 \\<speedbar-key-map> `\\[speedbar-toggle-updates]'
722 to toggle this value.")
724 (defvar speedbar-syntax-table nil
725 "Syntax-table used on the speedbar.")
727 (if speedbar-syntax-table
729 (setq speedbar-syntax-table (make-syntax-table))
730 ;; turn off paren matching around here.
731 (modify-syntax-entry ?\' " " speedbar-syntax-table)
732 (modify-syntax-entry ?\" " " speedbar-syntax-table)
733 (modify-syntax-entry ?( " " speedbar-syntax-table)
734 (modify-syntax-entry ?) " " speedbar-syntax-table)
735 (modify-syntax-entry ?[ " " speedbar-syntax-table)
736 (modify-syntax-entry ?] " " speedbar-syntax-table))
738 (defvar speedbar-key-map nil
739 "Keymap used in speedbar buffer.")
743 (setq speedbar-key-map (make-keymap))
744 (suppress-keymap speedbar-key-map t)
747 (define-key speedbar-key-map "g" 'speedbar-refresh)
748 (define-key speedbar-key-map "t" 'speedbar-toggle-updates)
749 (define-key speedbar-key-map "q" 'speedbar-close-frame)
750 (define-key speedbar-key-map "Q" 'delete-frame)
753 (define-key speedbar-key-map "n" 'speedbar-next)
754 (define-key speedbar-key-map "p" 'speedbar-prev)
755 (define-key speedbar-key-map "\M-n" 'speedbar-restricted-next)
756 (define-key speedbar-key-map "\M-p" 'speedbar-restricted-prev)
757 (define-key speedbar-key-map "\C-\M-n" 'speedbar-forward-list)
758 (define-key speedbar-key-map "\C-\M-p" 'speedbar-backward-list)
759 (define-key speedbar-key-map " " 'speedbar-scroll-up)
760 (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
762 ;; Short cuts I happen to find useful
763 (define-key speedbar-key-map "r"
764 (lambda () (interactive)
765 (speedbar-change-initial-expansion-list
766 speedbar-previously-used-expansion-list-name)))
767 (define-key speedbar-key-map "b"
768 (lambda () (interactive)
769 (speedbar-change-initial-expansion-list "quick buffers")))
770 (define-key speedbar-key-map "f"
771 (lambda () (interactive)
772 (speedbar-change-initial-expansion-list "files")))
775 (substitute-key-definition 'switch-to-buffer
776 'speedbar-switch-buffer-attached-frame
777 speedbar-key-map global-map)
781 ;; mouse bindings so we can manipulate the items on each line
782 (define-key speedbar-key-map 'button2 'speedbar-click)
783 (define-key speedbar-key-map '(shift button2) 'speedbar-power-click)
784 ;; Info doc fix from Bob Weiner
785 (if (featurep 'infodoc)
787 (define-key speedbar-key-map 'button3 'speedbar-xemacs-popup-kludge))
788 (define-key speedbar-key-map '(meta button3) 'speedbar-mouse-item-info)
791 ;; mouse bindings so we can manipulate the items on each line
792 (define-key speedbar-key-map [down-mouse-1] 'speedbar-double-click)
793 (define-key speedbar-key-map [mouse-2] 'speedbar-click)
794 ;; This is the power click for new frames, or refreshing a cache
795 (define-key speedbar-key-map [S-mouse-2] 'speedbar-power-click)
796 ;; This adds a small unecessary visual effect
797 ;;(define-key speedbar-key-map [down-mouse-2] 'speedbar-quick-mouse)
798 (define-key speedbar-key-map [M-mouse-2] 'speedbar-mouse-item-info)
800 (define-key speedbar-key-map [down-mouse-3] 'speedbar-emacs-popup-kludge)
802 ;; This lets the user scroll as if we had a scrollbar... well maybe not
803 (define-key speedbar-key-map [mode-line mouse-2] 'speedbar-mouse-hscroll)
804 ;; another handy place users might click to get our menu.
805 (define-key speedbar-key-map [mode-line down-mouse-1]
806 'speedbar-emacs-popup-kludge)
808 ;; We can't switch buffers with the buffer mouse menu. Lets hack it.
809 (define-key speedbar-key-map [C-down-mouse-1] 'speedbar-hack-buffer-menu)
811 ;; Lastly, we want to track the mouse. Play here
812 (define-key speedbar-key-map [mouse-movement] 'speedbar-track-mouse)
815 (defun speedbar-make-specialized-keymap ()
816 "Create a keymap for use w/ a speedbar major or minor display mode.
817 This basically creates a sparse keymap, and makes it's parent be
819 (let ((k (make-sparse-keymap)))
820 (set-keymap-parent k speedbar-key-map)
823 (defvar speedbar-file-key-map nil
824 "Keymap used in speedbar buffer while files are displayed.")
826 (if speedbar-file-key-map
828 (setq speedbar-file-key-map (speedbar-make-specialized-keymap))
830 ;; Basic tree features
831 (define-key speedbar-file-key-map "e" 'speedbar-edit-line)
832 (define-key speedbar-file-key-map "\C-m" 'speedbar-edit-line)
833 (define-key speedbar-file-key-map "+" 'speedbar-expand-line)
834 (define-key speedbar-file-key-map "-" 'speedbar-contract-line)
836 ;; file based commands
837 (define-key speedbar-file-key-map "U" 'speedbar-up-directory)
838 (define-key speedbar-file-key-map "I" 'speedbar-item-info)
839 (define-key speedbar-file-key-map "B" 'speedbar-item-byte-compile)
840 (define-key speedbar-file-key-map "L" 'speedbar-item-load)
841 (define-key speedbar-file-key-map "C" 'speedbar-item-copy)
842 (define-key speedbar-file-key-map "D" 'speedbar-item-delete)
843 (define-key speedbar-file-key-map "O" 'speedbar-item-object-delete)
844 (define-key speedbar-file-key-map "R" 'speedbar-item-rename)
847 (defvar speedbar-easymenu-definition-base
849 ["Update" speedbar-refresh t]
850 ["Auto Update" speedbar-toggle-updates
851 :style toggle :selected speedbar-update-flag]
853 "Base part of the speedbar menu.")
855 (defvar speedbar-easymenu-definition-special
856 '(["Edit Item On Line" speedbar-edit-line t]
857 ["Show All Files" speedbar-toggle-show-all-files
858 :style toggle :selected speedbar-show-unknown-files]
859 ["Expand File Tags" speedbar-expand-line
860 (save-excursion (beginning-of-line)
861 (looking-at "[0-9]+: *.\\+. "))]
862 ["Contract File Tags" speedbar-contract-line
863 (save-excursion (beginning-of-line)
864 (looking-at "[0-9]+: *.-. "))]
865 ; ["Sort Tags" speedbar-toggle-sorting
866 ; :style toggle :selected speedbar-sort-tags]
868 ["File/Tag Information" speedbar-item-info t]
869 ["Load Lisp File" speedbar-item-load
872 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
873 ["Byte Compile File" speedbar-item-byte-compile
876 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
877 ["Copy File" speedbar-item-copy
878 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
879 ["Rename File" speedbar-item-rename
880 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
881 ["Delete File" speedbar-item-delete
882 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
883 ["Delete Object" speedbar-item-object-delete
884 (save-excursion (beginning-of-line)
885 (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))]
887 "Additional menu items while in file-mode.")
889 (defvar speedbar-easymenu-definition-trailer
891 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
892 ["Customize..." speedbar-customize t])
893 ["Close" speedbar-close-frame t]
894 ["Quit" delete-frame t] )
895 "Menu items appearing at the end of the speedbar menu.")
897 (defvar speedbar-desired-buffer nil
898 "Non-nil when speedbar is showing buttons specific a special mode.
899 In this case it is the originating buffer.")
900 (defvar speedbar-buffer nil
901 "The buffer displaying the speedbar.")
902 (defvar speedbar-frame nil
903 "The frame displaying speedbar.")
904 (defvar speedbar-cached-frame nil
905 "The frame that was last created, then removed from the display.")
906 (defvar speedbar-full-text-cache nil
907 "The last open directory is saved in its entirety for ultra-fast switching.")
908 (defvar speedbar-timer nil
909 "The speedbar timer used for updating the buffer.")
910 (defvar speedbar-attached-frame nil
911 "The frame which started speedbar mode.
912 This is the frame from which all data displayed in the speedbar is
913 gathered, and in which files and such are displayed.")
915 (defvar speedbar-last-selected-file nil
916 "The last file which was selected in speedbar buffer.")
918 (defvar speedbar-shown-directories nil
919 "Maintain list of directories simultaneously open in the current speedbar.")
921 (defvar speedbar-directory-contents-alist nil
922 "An association list of directories and their contents.
923 Each sublist was returned by `speedbar-file-lists'. This list is
924 maintained to speed up the refresh rate when switching between
927 (defvar speedbar-power-click nil
928 "Never set this by hand. Value is t when S-mouse activity occurs.")
931 ;;; Mode definitions/ user commands
935 (defalias 'speedbar 'speedbar-frame-mode)
937 (defun speedbar-frame-mode (&optional arg)
938 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
939 nil means toggle. Once the speedbar frame is activated, a buffer in
940 `speedbar-mode' will be displayed. Currently, only one speedbar is
942 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
943 `speedbar-before-delete-hook' is called before the frame is deleted."
945 ;; toggle frame on and off.
946 (if (not arg) (if (and (frame-live-p speedbar-frame)
947 (frame-visible-p speedbar-frame))
948 (setq arg -1) (setq arg 1)))
949 ;; turn the frame off on neg number
950 (if (and (numberp arg) (< arg 0))
952 (run-hooks 'speedbar-before-delete-hook)
953 (if (and speedbar-frame (frame-live-p speedbar-frame))
955 (setq speedbar-cached-frame speedbar-frame)
956 (make-frame-invisible speedbar-frame)))
957 (setq speedbar-frame nil)
958 (speedbar-set-timer nil)
959 ;; Used to delete the buffer. This has the annoying affect of
960 ;; preventing whatever took its place from ever appearing
961 ;; as the default after a C-x b was typed
962 ;;(if (bufferp speedbar-buffer)
963 ;; (kill-buffer speedbar-buffer))
965 ;; Set this as our currently attached frame
966 (setq speedbar-attached-frame (selected-frame))
967 (run-hooks 'speedbar-before-popup-hook)
968 ;; Get the frame to work in
969 (if (frame-live-p speedbar-cached-frame)
971 (setq speedbar-frame speedbar-cached-frame)
972 (make-frame-visible speedbar-frame)
973 ;; Get the buffer to play with
975 (select-frame speedbar-frame)
976 (if (not (eq (current-buffer) speedbar-buffer))
977 (switch-to-buffer speedbar-buffer))
978 (set-window-dedicated-p (selected-window) t)
979 (raise-frame speedbar-frame)
980 (speedbar-set-timer speedbar-update-speed)
982 (if (frame-live-p speedbar-frame)
983 (raise-frame speedbar-frame)
986 (make-frame (nconc (list 'height
987 (speedbar-needed-height))
988 speedbar-frame-plist))
989 (let* ((mh (frame-parameter nil 'menu-bar-lines))
990 (cfx (frame-parameter nil 'left))
991 (cfy (frame-parameter nil 'top))
992 (cfw (frame-pixel-width))
995 speedbar-frame-parameters
996 (list (cons 'height (+ mh (frame-height))))))
998 (if (or (< emacs-major-version 20)
999 (not (eq window-system 'x)))
1001 (let ((x-pointer-shape x-pointer-top-left-arrow)
1002 (x-sensitive-text-pointer-shape
1004 (make-frame params)))))
1005 (if (listp cfx) (setq cfx (eval cfx)))
1006 (if (listp cfy) (setq cfx (eval cfy)))
1007 (if (and window-system (not (eq window-system 'pc)))
1008 (set-frame-position frame
1009 ;; Decide which side to put it
1010 ;; on. 200 is just a buffer
1011 ;; for the left edge of the
1012 ;; screen. The extra 10 is just
1013 ;; dressings for window decorations.
1016 (- cfx (frame-pixel-width frame)
1020 ;; reset the selection variable
1021 (setq speedbar-last-selected-file nil)
1022 ;; Put the buffer into the frame
1023 (save-window-excursion
1024 ;; Get the buffer to play with
1026 (select-frame speedbar-frame)
1027 (switch-to-buffer speedbar-buffer)
1028 (set-window-dedicated-p (selected-window) t))
1029 (if (and (or (null window-system) (eq window-system 'pc))
1030 (fboundp 'set-frame-name))
1032 (select-frame speedbar-frame)
1033 (set-frame-name "Speedbar")))
1034 (speedbar-set-timer speedbar-update-speed)))))
1037 (defun speedbar-get-focus ()
1038 "Change frame focus to or from the speedbar frame.
1039 If the selected frame is not speedbar, then speedbar frame is
1040 selected. If the speedbar frame is active, then select the attached frame."
1042 (if (eq (selected-frame) speedbar-frame)
1043 (if (frame-live-p speedbar-attached-frame)
1044 (select-frame speedbar-attached-frame))
1045 ;; If updates are off, then refresh the frame (they want it now...)
1046 (if (not speedbar-update-flag)
1047 (let ((speedbar-update-flag t))
1048 (speedbar-timer-fn)))
1049 ;; make sure we have a frame
1050 (if (not (frame-live-p speedbar-frame)) (speedbar-frame-mode 1))
1052 (select-frame speedbar-frame)
1056 (defun speedbar-close-frame ()
1057 "Turn off a currently active speedbar."
1059 (speedbar-frame-mode -1)
1060 (select-frame speedbar-attached-frame)
1063 (defun speedbar-switch-buffer-attached-frame (&optional buffer)
1064 "Switch to BUFFER in speedbar's attached frame, and raise that frame.
1065 This overrides the default behavior of `switch-to-buffer' which is
1066 broken because of the dedicated speedbar frame."
1068 ;; Assume we are in the speedbar frame.
1069 (speedbar-get-focus)
1070 ;; Now switch buffers
1072 (switch-to-buffer buffer)
1073 (call-interactively 'switch-to-buffer nil nil)))
1075 (defmacro speedbar-frame-width ()
1076 "Return the width of the speedbar frame in characters.
1077 nil if it doesn't exist."
1078 '(frame-width speedbar-frame))
1080 ;; XEmacs function only.
1081 (defun speedbar-needed-height (&optional frame)
1082 "The needed height for the tool bar FRAME (in characters)."
1083 (or frame (setq frame (selected-frame)))
1084 ;; The 1 is the missing modeline/minibuffer
1085 (+ 1 (/ (frame-pixel-height frame)
1086 (face-height 'default frame))))
1088 (defun speedbar-mode ()
1089 "Major mode for managing a display of directories and tags.
1090 \\<speedbar-key-map>
1091 The first line represents the default path of the speedbar frame.
1092 Each directory segment is a button which jumps speedbar's default
1093 directory to that path. Buttons are activated by clicking `\\[speedbar-click]'.
1094 In some situations using `\\[speedbar-power-click]' is a `power click' which will
1095 rescan cached items, or pop up new frames.
1097 Each line starting with <+> represents a directory. Click on the <+>
1098 to insert the directory listing into the current tree. Click on the
1099 <-> to retract that list. Click on the directory name to go to that
1100 directory as the default.
1102 Each line starting with [+] is a file. If the variable
1103 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1104 files which don't have imenu support, but are not expressly ignored.
1105 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1106 which is generated from `completion-ignored-extensions'.
1108 Files with a `*' character after their name are files checked out of a
1109 version control system. (currently only RCS is supported.) New
1110 version control systems can be added by examining the documentation
1111 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'
1113 Files with a `#' or `!' character after them are source files that
1114 have an object file associated with them. The `!' indicates that the
1115 files is out of date. You can control what source/object associations
1116 exist through the variable `speedbar-obj-alist'.
1118 Click on the [+] to display a list of tags from that file. Click on
1119 the [-] to retract the list. Click on the file name to edit the file
1120 in the attached frame.
1122 If you open tags, you might find a node starting with {+}, which is a
1123 category of tags. Click the {+} to expand the category. Jump-able
1124 tags start with >. Click the name of the tag to go to that position
1125 in the selected file.
1127 \\{speedbar-key-map}"
1130 (setq speedbar-buffer (set-buffer (get-buffer-create " SPEEDBAR")))
1131 (kill-all-local-variables)
1132 (setq major-mode 'speedbar-mode)
1133 (setq mode-name "Speedbar")
1134 (set-syntax-table speedbar-syntax-table)
1135 (setq font-lock-keywords nil) ;; no font-locking please
1136 (setq truncate-lines t)
1137 (make-local-variable 'frame-title-format)
1138 (setq frame-title-format "Speedbar")
1139 ;; Set this up special just for the speedbar buffer
1140 ;; Terminal minibuffer stuff does not require this.
1141 (if (and window-system (not (eq window-system 'pc))
1142 (null default-minibuffer-frame))
1144 (make-local-variable 'default-minibuffer-frame)
1145 (setq default-minibuffer-frame speedbar-attached-frame)))
1146 ;; Correct use of `temp-buffer-show-function': Bob Weiner
1147 (if (and (boundp 'temp-buffer-show-hook)
1148 (boundp 'temp-buffer-show-function))
1149 (progn (make-local-variable 'temp-buffer-show-hook)
1150 (setq temp-buffer-show-hook temp-buffer-show-function)))
1151 (make-local-variable 'temp-buffer-show-function)
1152 (setq temp-buffer-show-function 'speedbar-temp-buffer-show-function)
1153 (if speedbar-xemacsp
1155 ;; Argh! mouse-track-click-hook doesn't understand the
1156 ;; make-local-hook conventions.
1157 (make-local-variable 'mouse-track-click-hook)
1158 (add-hook 'mouse-track-click-hook
1159 (lambda (event count)
1160 (if (/= (event-button event) 1)
1161 nil ; Do normal operations.
1163 (speedbar-quick-mouse event))
1166 (mouse-set-point event)
1167 (speedbar-do-function-pointer)
1168 (speedbar-quick-mouse event)))
1169 ;; Don't do normal operations.
1171 (make-local-hook 'kill-buffer-hook)
1172 (add-hook 'kill-buffer-hook (lambda () (let ((skilling (boundp 'skilling)))
1175 (if (eq (current-buffer)
1177 (speedbar-frame-mode -1)))))
1179 (toggle-read-only 1)
1180 (speedbar-set-mode-line-format)
1181 (if speedbar-xemacsp
1183 (make-local-variable 'mouse-motion-handler)
1184 (setq mouse-motion-handler 'speedbar-track-mouse-xemacs))
1185 (if speedbar-track-mouse-flag
1187 (make-local-variable 'track-mouse)
1188 (setq track-mouse t))) ;this could be messy.
1189 (setq auto-show-mode nil)) ;no auto-show for Emacs
1190 (run-hooks 'speedbar-mode-hook))
1191 (speedbar-update-contents)
1194 (defun speedbar-show-info-under-mouse (&optional event)
1195 "Call the info function for the line under the mouse.
1196 Optional EVENT is currently not used."
1197 (let ((pos (mouse-position))) ; we ignore event until I use it later.
1198 (if (equal (car pos) speedbar-frame)
1200 (save-window-excursion
1201 (apply 'set-mouse-position pos)
1202 (speedbar-item-info))))))
1204 (defun speedbar-set-mode-line-format ()
1205 "Set the format of the mode line based on the current speedbar environment.
1206 This gives visual indications of what is up. It EXPECTS the speedbar
1207 frame and window to be the currently active frame and window."
1208 (if (and (frame-live-p speedbar-frame)
1209 (or (not speedbar-xemacsp)
1210 (specifier-instance has-modeline-p)))
1212 (set-buffer speedbar-buffer)
1213 (let* ((w (or (speedbar-frame-width) 20))
1216 (p3 (if speedbar-update-flag "SPEEDBAR" "SLOWBAR"))
1217 (blank (- w (length p1) (length p3) (length p5)
1218 (if line-number-mode 4 0)))
1220 (make-string (/ blank 2) ? )
1223 (make-string (+ (/ blank 2) (% blank 2)) ? )
1226 (if line-number-mode
1227 (list (concat p1 p2 p3) '(line-number-mode " %3l")
1229 (list (concat p1 p2 p3 p4 p5)))))
1230 (if (not (equal mode-line-format tf))
1232 (setq mode-line-format tf)
1233 (force-mode-line-update)))))))
1235 (defun speedbar-temp-buffer-show-function (buffer)
1236 "Placed in the variable `temp-buffer-show-function' in `speedbar-mode'.
1237 If a user requests help using \\[help-command] <Key> the temp BUFFER will be
1238 redirected into a window on the attached frame."
1239 (if speedbar-attached-frame (select-frame speedbar-attached-frame))
1240 (pop-to-buffer buffer nil)
1242 ;; Fix for using this hook on some platforms: Bob Weiner
1243 (cond ((not speedbar-xemacsp)
1244 (run-hooks 'temp-buffer-show-hook))
1245 ((fboundp 'run-hook-with-args)
1246 (run-hook-with-args 'temp-buffer-show-hook buffer))
1247 ((and (boundp 'temp-buffer-show-hook)
1248 (listp temp-buffer-show-hook))
1249 (mapcar (function (lambda (hook) (funcall hook buffer)))
1250 temp-buffer-show-hook))))
1252 (defvar speedbar-previous-menu nil
1253 "The menu before the last `speedbar-reconfigure-keymaps' was called.")
1255 (defun speedbar-reconfigure-keymaps ()
1256 "Reconfigure the menu-bar in a speedbar frame.
1257 Different menu items are displayed depending on the current display mode
1258 and the existence of packages."
1260 speedbar-easymenu-definition-base
1261 (if speedbar-shown-directories
1262 ;; file display mode version
1263 (speedbar-initial-menu)
1265 (select-frame speedbar-attached-frame)
1266 (if (local-variable-p
1267 'speedbar-easymenu-definition-special
1269 ;; If bound locally, we can use it
1270 speedbar-easymenu-definition-special)))
1271 ;; Dynamic menu stuff
1273 (list (cons "Displays"
1274 (let ((displays nil)
1275 (alist speedbar-initial-expansion-mode-alist))
1280 (capitalize (car (car alist)))
1282 'speedbar-change-initial-expansion-list
1286 (setq alist (cdr alist)))
1289 speedbar-easymenu-definition-trailer))
1290 (localmap (save-excursion
1291 (let ((cf (selected-frame)))
1293 (select-frame speedbar-attached-frame)
1294 (if (local-variable-p
1295 'speedbar-special-mode-key-map
1297 speedbar-special-mode-key-map)
1298 (select-frame cf))))))
1300 (set-buffer speedbar-buffer)
1301 (use-local-map (or localmap
1302 (speedbar-initial-keymap)
1303 ;; This creates a small keymap we can glom the
1304 ;; menu adjustments into.
1305 (speedbar-make-specialized-keymap)))
1306 ;; Delete the old menu if applicable.
1307 (if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu))
1308 (setq speedbar-previous-menu md)
1309 ;; Now add the new menu
1310 (if (not speedbar-xemacsp)
1311 (easy-menu-define speedbar-menu-map (current-local-map)
1313 (easy-menu-add md (current-local-map))
1314 (set-buffer-menubar (list md))))))
1317 ;;; User Input stuff
1320 ;; XEmacs: this can be implemented using modeline keymaps, but there
1321 ;; is no use, as we have horizontal scrollbar (as the docstring
1323 (defun speedbar-mouse-hscroll (e)
1324 "Read a mouse event E from the mode line, and horizontally scroll.
1325 If the mouse is being clicked on the far left, or far right of the
1326 mode-line. This is only useful for non-XEmacs"
1328 (let* ((xp (car (nth 2 (car (cdr e)))))
1329 (cpw (/ (frame-pixel-width)
1331 (oc (1+ (/ xp cpw)))
1335 ((> oc (- (window-width) 3))
1337 (t (message "Click on the edge of the modeline to scroll left/right")))
1338 ;;(message "X: Pixel %d Char Pixels %d On char %d" xp cpw oc)
1341 (defun speedbar-customize ()
1342 "Customize speedbar using the Custom package."
1344 (let ((sf (selected-frame)))
1345 (select-frame speedbar-attached-frame)
1346 (customize-group 'speedbar)
1348 (speedbar-maybee-jump-to-attached-frame))
1350 (defun speedbar-track-mouse (event)
1351 "For motion EVENT, display info about the current line."
1353 (if (not speedbar-track-mouse-flag)
1356 (let ((char (nth 1 (car (cdr event)))))
1357 (if (not (numberp char))
1360 ;; (message "%S" event)
1361 (speedbar-item-info)
1364 (defun speedbar-track-mouse-xemacs (event)
1365 "For motion EVENT, display info about the current line."
1366 (if (functionp (default-value 'mouse-motion-handler))
1367 (funcall (default-value 'mouse-motion-handler) event))
1368 (if speedbar-track-mouse-flag
1370 (save-window-excursion
1372 (progn (mouse-set-point event)
1373 ;; Prevent focus-related bugs.
1374 (if (eq major-mode 'speedbar-mode)
1375 (speedbar-item-info)))
1378 ;; In XEmacs, we make popup menus work on the item over mouse (as
1379 ;; opposed to where the point happens to be.) We attain this by
1380 ;; temporarily moving the point to that place.
1381 ;; Hrvoje Niksic <hniksic@srce.hr>
1382 (defun speedbar-xemacs-popup-kludge (event)
1383 "Pop up a menu related to the clicked on item.
1384 Must be bound to EVENT."
1386 (select-frame speedbar-frame)
1388 (goto-char (event-closest-point event))
1390 (forward-char (min 5 (- (save-excursion (end-of-line) (point))
1391 (save-excursion (beginning-of-line) (point)))))
1393 ;; Wait for menu to bail out. `popup-mode-menu' (and other popup
1394 ;; menu functions) return immediately.
1396 (while (not (misc-user-event-p (setq new (next-event))))
1397 (dispatch-event new))
1398 (dispatch-event new))))
1400 (defun speedbar-emacs-popup-kludge (e)
1401 "Pop up a menu related to the clicked on item.
1402 Must be bound to event E."
1406 ;; This gets the cursor where the user can see it.
1407 (if (not (bolp)) (forward-char -1))
1409 (if (< emacs-major-version 20)
1410 (mouse-major-mode-menu e)
1411 (mouse-major-mode-menu e nil))))
1413 (defun speedbar-hack-buffer-menu (e)
1414 "Control mouse 1 is buffer menu.
1415 This hack overrides it so that the right thing happens in the main
1416 Emacs frame, not in the speedbar frame.
1417 Argument E is the event causing this activity."
1419 (let ((fn (lookup-key global-map (if speedbar-xemacsp
1425 (set-window-dedicated-p (selected-window) nil)
1426 (call-interactively fn)
1427 (setq newbuff (current-buffer)))
1428 (switch-to-buffer " SPEEDBAR")
1429 (set-window-dedicated-p (selected-window) t))
1430 (speedbar-with-attached-buffer
1431 (switch-to-buffer newbuff))))
1433 (defun speedbar-next (arg)
1434 "Move to the next ARGth line in a speedbar buffer."
1436 (forward-line (or arg 1))
1437 (speedbar-item-info)
1438 (speedbar-position-cursor-on-line))
1440 (defun speedbar-prev (arg)
1441 "Move to the previous ARGth line in a speedbar buffer."
1443 (speedbar-next (if arg (- arg) -1)))
1445 (defun speedbar-restricted-move (arg)
1446 "Move to the next ARGth line in a speedbar buffer at the same depth.
1447 This means that movement is restricted to a subnode, and that siblings
1448 of intermediate nodes are skipped."
1449 (if (not (numberp arg)) (signal 'wrong-type-argument (list arg 'numberp)))
1450 ;; First find the extent for which we are allowed to move.
1451 (let ((depth (save-excursion (beginning-of-line)
1452 (if (looking-at "[0-9]+:")
1453 (string-to-int (match-string 0))
1455 (crement (if (< arg 0) 1 -1)) ; decrement or increment
1456 (lastmatch (point)))
1458 (forward-line (- crement))
1459 (let ((subdepth (save-excursion (beginning-of-line)
1460 (if (looking-at "[0-9]+:")
1461 (string-to-int (match-string 0))
1463 (cond ((or (< subdepth depth)
1464 (progn (end-of-line) (eobp))
1465 (progn (beginning-of-line) (bobp)))
1466 ;; We have reached the end of this block.
1467 (goto-char lastmatch)
1469 (error "End of sub-list"))
1471 (setq lastmatch (point)
1472 arg (+ arg crement))))))
1473 (speedbar-position-cursor-on-line)))
1475 (defun speedbar-restricted-next (arg)
1476 "Move to the next ARGth line in a speedbar buffer at the same depth.
1477 This means that movement is restricted to a subnode, and that siblings
1478 of intermediate nodes are skipped."
1480 (speedbar-restricted-move (or arg 1))
1481 (speedbar-item-info))
1484 (defun speedbar-restricted-prev (arg)
1485 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1486 This means that movement is restricted to a subnode, and that siblings
1487 of intermediate nodes are skipped."
1489 (speedbar-restricted-move (if arg (- arg) -1))
1490 (speedbar-item-info))
1492 (defun speedbar-navigate-list (arg)
1493 "Move across ARG groups of similarly typed items in speedbar.
1494 Stop on the first line of the next type of item, or on the last or first item
1495 if we reach a buffer boundary."
1498 (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ")
1499 (let ((str (regexp-quote (match-string 0))))
1500 (while (looking-at str)
1501 (speedbar-restricted-move arg)
1502 (beginning-of-line))))
1503 (speedbar-position-cursor-on-line))
1505 (defun speedbar-forward-list ()
1506 "Move forward over the current list.
1507 A LIST in speedbar is a group of similarly typed items, such as directories,
1508 files, or the directory button."
1510 (speedbar-navigate-list 1)
1511 (speedbar-item-info))
1513 (defun speedbar-backward-list ()
1514 "Move backward over the current list.
1515 A LIST in speedbar is a group of similarly typed items, such as directories,
1516 files, or the directory button."
1518 (speedbar-navigate-list -1)
1519 (speedbar-item-info))
1521 (defun speedbar-scroll-up (&optional arg)
1522 "Page down one screen-full of the speedbar, or ARG lines."
1525 (speedbar-position-cursor-on-line))
1527 (defun speedbar-scroll-down (&optional arg)
1528 "Page up one screen-full of the speedbar, or ARG lines."
1531 (speedbar-position-cursor-on-line))
1533 (defun speedbar-up-directory ()
1534 "Keyboard accelerator for moving the default directory up one.
1535 Assumes that the current buffer is the speedbar buffer"
1537 (setq default-directory (expand-file-name (concat default-directory "../")))
1538 (speedbar-update-contents))
1540 ;;; Speedbar file activity (aka creeping featurism)
1542 (defun speedbar-refresh ()
1543 "Refresh the current speedbar display, disposing of any cached data."
1545 (let ((dl speedbar-shown-directories)
1546 (dm (and (boundp 'deactivate-mark) deactivate-mark)))
1548 (adelete 'speedbar-directory-contents-alist (car dl))
1550 (if (<= 1 speedbar-verbosity-level)
1551 (message "Refreshing speedbar..."))
1552 (speedbar-update-contents)
1553 (speedbar-stealthy-updates)
1554 ;; Reset the timer in case it got really hosed for some reason...
1555 (speedbar-set-timer speedbar-update-speed)
1556 (if (<= 1 speedbar-verbosity-level)
1557 (message "Refreshing speedbar...done"))
1558 (if (boundp 'deactivate-mark) (setq deactivate-mark dm))))
1560 (defun speedbar-item-load ()
1561 "Load the item under the cursor or mouse if it is a Lisp file."
1563 (let ((f (speedbar-line-file)))
1564 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1565 (if (and (file-exists-p (concat f "c"))
1566 (y-or-n-p (format "Load %sc? " f)))
1567 ;; If the compiled version exists, load that instead...
1568 (load-file (concat f "c"))
1570 (error "Not a loadable file"))))
1572 (defun speedbar-item-byte-compile ()
1573 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1575 (let ((f (speedbar-line-file))
1576 (sf (selected-frame)))
1577 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1579 (select-frame speedbar-attached-frame)
1580 (byte-compile-file f nil)
1582 (speedbar-reset-scanners)))
1585 (defun speedbar-mouse-item-info (event)
1586 "Provide information about what the user clicked on.
1587 This should be bound to a mouse EVENT."
1589 (mouse-set-point event)
1590 (speedbar-item-info))
1592 (defun speedbar-generic-item-info ()
1593 "Attempt to derive, and then display information about thils line item.
1594 File style information is displayed with `speedbar-item-info'."
1597 ;; Skip invisible number info.
1598 (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0)))
1599 ;; Skip items in "folder" type text characters.
1600 (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0)))
1602 (message "Text: %s" (buffer-substring-no-properties
1603 (point) (progn (end-of-line) (point))))))
1605 (defun speedbar-item-info ()
1606 "Display info in the mini-buffer about the button the mouse is over."
1608 (if (not speedbar-shown-directories)
1609 (speedbar-generic-item-info)
1610 (let* ((item (speedbar-line-file))
1611 (attr (if item (file-attributes item) nil)))
1612 (if (and item attr) (message "%s %-6d %s" (nth 8 attr) (nth 7 attr) item)
1615 (if (not (looking-at "\\([0-9]+\\):"))
1616 (speedbar-generic-item-info)
1617 (setq item (speedbar-line-path (string-to-int (match-string 1))))
1618 (if (re-search-forward "> \\([^ ]+\\)$"
1619 (save-excursion(end-of-line)(point)) t)
1621 (setq attr (get-text-property (match-beginning 1)
1623 (message "Tag: %s in %s @ %s"
1624 (match-string 1) item
1626 (if (markerp attr) (marker-position attr) attr)
1628 (if (re-search-forward "{[+-]} \\([^\n]+\\)$"
1629 (save-excursion(end-of-line)(point)) t)
1630 (message "Group of tags \"%s\"" (match-string 1))
1631 (speedbar-generic-item-info)))))))))
1633 (defun speedbar-item-copy ()
1634 "Copy the item under the cursor.
1635 Files can be copied to new names or places."
1637 (let ((f (speedbar-line-file)))
1638 (if (not f) (error "Not a file"))
1639 (if (file-directory-p f)
1640 (error "Cannot copy directory")
1641 (let* ((rt (read-file-name (format "Copy %s to: "
1642 (file-name-nondirectory f))
1643 (file-name-directory f)))
1644 (refresh (member (expand-file-name (file-name-directory rt))
1645 speedbar-shown-directories)))
1646 ;; Create the right file name part
1647 (if (file-directory-p rt)
1649 (concat (expand-file-name rt)
1650 (if (string-match "/$" rt) "" "/")
1651 (file-name-nondirectory f))))
1652 (if (or (not (file-exists-p rt))
1653 (y-or-n-p (format "Overwrite %s with %s? " rt f)))
1655 (copy-file f rt t t)
1656 ;; refresh display if the new place is currently displayed.
1660 (if (not (speedbar-goto-this-file rt))
1661 (speedbar-goto-this-file f))))
1664 (defun speedbar-item-rename ()
1665 "Rename the item under the cursor or mouse.
1666 Files can be renamed to new names or moved to new directories."
1668 (let ((f (speedbar-line-file)))
1670 (let* ((rt (read-file-name (format "Rename %s to: "
1671 (file-name-nondirectory f))
1672 (file-name-directory f)))
1673 (refresh (member (expand-file-name (file-name-directory rt))
1674 speedbar-shown-directories)))
1675 ;; Create the right file name part
1676 (if (file-directory-p rt)
1678 (concat (expand-file-name rt)
1679 (if (string-match "/\\'" rt) "" "/")
1680 (file-name-nondirectory f))))
1681 (if (or (not (file-exists-p rt))
1682 (y-or-n-p (format "Overwrite %s with %s? " rt f)))
1684 (rename-file f rt t)
1685 ;; refresh display if the new place is currently displayed.
1689 (speedbar-goto-this-file rt)
1691 (error "Not a file"))))
1693 (defun speedbar-item-delete ()
1694 "Delete the item under the cursor. Files are removed from disk."
1696 (let ((f (speedbar-line-file)))
1697 (if (not f) (error "Not a file"))
1698 (if (y-or-n-p (format "Delete %s? " f))
1700 (if (file-directory-p f)
1701 (delete-directory f)
1703 (message "Okie dokie..")
1710 (defun speedbar-item-object-delete ()
1711 "Delete the object associated from the item under the cursor.
1712 The file is removed from disk. The object is determined from the
1713 variable `speedbar-obj-alist'."
1715 (let* ((f (speedbar-line-file))
1717 (oa speedbar-obj-alist))
1718 (if (not f) (error "Not a file"))
1719 (while (and oa (not (string-match (car (car oa)) f)))
1721 (setq obj (concat (file-name-sans-extension f) (cdr (car oa))))
1722 (if (and oa (file-exists-p obj)
1723 (y-or-n-p (format "Delete %s? " obj)))
1726 (speedbar-reset-scanners)))))
1728 (defun speedbar-enable-update ()
1729 "Enable automatic updating in speedbar via timers."
1731 (setq speedbar-update-flag t)
1732 (speedbar-set-mode-line-format)
1733 (speedbar-set-timer speedbar-update-speed))
1735 (defun speedbar-disable-update ()
1736 "Disable automatic updating and stop consuming resources."
1738 (setq speedbar-update-flag nil)
1739 (speedbar-set-mode-line-format)
1740 (speedbar-set-timer nil))
1742 (defun speedbar-toggle-updates ()
1743 "Toggle automatic update for the speedbar frame."
1745 (if speedbar-update-flag
1746 (speedbar-disable-update)
1747 (speedbar-enable-update)))
1749 (defun speedbar-toggle-sorting ()
1750 "Toggle automatic update for the speedbar frame."
1752 (setq speedbar-sort-tags (not speedbar-sort-tags)))
1754 (defun speedbar-toggle-show-all-files ()
1755 "Toggle display of files speedbar can not tag."
1757 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files))
1760 ;;; Utility functions
1762 (defun speedbar-set-timer (timeout)
1763 "Apply a timer with TIMEOUT, or remove a timer if TIMOUT is nil.
1764 TIMEOUT is the number of seconds until the speedbar timer is called
1765 again. When TIMEOUT is nil, turn off all timeouts.
1766 This function will also enable or disable the `vc-checkin-hook' used
1767 to track file check ins, and will change the mode line to match
1768 `speedbar-update-flag'."
1773 (progn (delete-itimer speedbar-timer)
1774 (setq speedbar-timer nil)))
1776 (if (and speedbar-xemacsp
1777 (or (>= emacs-major-version 20)
1778 (>= emacs-minor-version 15)))
1779 (setq speedbar-timer (start-itimer "speedbar"
1784 (setq speedbar-timer (start-itimer "speedbar"
1789 ((fboundp 'run-with-idle-timer)
1791 (progn (cancel-timer speedbar-timer)
1792 (setq speedbar-timer nil)))
1794 (setq speedbar-timer
1795 (run-with-idle-timer timeout t 'speedbar-timer-fn))))
1796 ;; Emacs 19.30 (Thanks twice: ptype@dra.hmg.gb)
1797 ((fboundp 'post-command-idle-hook)
1799 (add-hook 'post-command-idle-hook 'speedbar-timer-fn)
1800 (remove-hook 'post-command-idle-hook 'speedbar-timer-fn)))
1801 ;; Older or other Emacsen with no timers. Set up so that its
1802 ;; obvious this emacs can't handle the updates
1804 (setq speedbar-update-flag nil)))
1805 ;; Apply a revert hook that will reset the scanners. We attach to revert
1806 ;; because most reverts occur during VC state change, and this lets our
1807 ;; VC scanner fix itself.
1809 (add-hook 'after-revert-hook 'speedbar-reset-scanners)
1810 (remove-hook 'after-revert-hook 'speedbar-reset-scanners)
1812 ;; change this if it changed for some reason
1813 (speedbar-set-mode-line-format))
1815 (defmacro speedbar-with-writable (&rest forms)
1816 "Allow the buffer to be writable and evaluate FORMS."
1817 (list 'let '((inhibit-read-only t))
1818 (cons 'progn forms)))
1819 (put 'speedbar-with-writable 'lisp-indent-function 0)
1821 (defun speedbar-select-window (buffer)
1822 "Select a window in which BUFFER is shown.
1823 If it is not shown, force it to appear in the default window."
1824 (let ((win (get-buffer-window buffer speedbar-attached-frame)))
1827 (set-window-buffer (selected-window) buffer))))
1829 (defmacro speedbar-with-attached-buffer (&rest forms)
1830 "Execute FORMS in the attached frame's special buffer.
1831 Optionally select that frame if necessary."
1832 ;; Reset the timer with a new timeout when cliking a file
1833 ;; in case the user was navigating directories, we can cancel
1834 ;; that other timer.
1837 '(speedbar-set-timer speedbar-update-speed)
1839 'let '((cf (selected-frame)))
1840 '(select-frame speedbar-attached-frame)
1841 '(speedbar-select-window speedbar-desired-buffer)
1844 '(speedbar-maybee-jump-to-attached-frame)
1847 (defun speedbar-insert-button (text face mouse function
1848 &optional token prevline)
1849 "Insert TEXT as the next logical speedbar button.
1850 FACE is the face to put on the button, MOUSE is the highlight face to use.
1851 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1852 This function assumes that the current buffer is the speedbar buffer.
1853 If PREVLINE, then put this button on the previous line.
1855 This is a convenience function for special mode that create their own
1856 specialized speedbar displays."
1857 (goto-char (point-max))
1858 (if (/= (current-column) 0) (insert "\n"))
1859 (if prevline (progn (delete-char -1) (insert " "))) ;back up if desired...
1860 (let ((start (point)))
1862 (speedbar-make-button start (point) face mouse function token))
1863 (let ((start (point)))
1865 (put-text-property start (point) 'face nil)
1866 (put-text-property start (point) 'mouse-face nil)))
1868 (defun speedbar-make-button (start end face mouse function &optional token)
1869 "Create a button from START to END, with FACE as the display face.
1870 MOUSE is the mouse face. When this button is clicked on FUNCTION
1871 will be run with the TOKEN parameter (any Lisp object)"
1872 (put-text-property start end 'face face)
1873 (put-text-property start end 'mouse-face mouse)
1874 (put-text-property start end 'invisible nil)
1875 (if function (put-text-property start end 'speedbar-function function))
1876 (if token (put-text-property start end 'speedbar-token token))
1879 ;;; Initial Expansion list management
1881 (defun speedbar-initial-expansion-list ()
1882 "Return the current default expansion list.
1883 This is based on `speedbar-initial-expansion-list-name' referencing
1884 `speedbar-initial-expansion-mode-alist'."
1885 ;; cdr1 - name, cdr2 - menu
1886 (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name
1887 speedbar-initial-expansion-mode-alist)))))
1889 (defun speedbar-initial-menu ()
1890 "Return the current default menu data.
1891 This is based on `speedbar-initial-expansion-list-name' referencing
1892 `speedbar-initial-expansion-mode-alist'."
1894 (car (cdr (assoc speedbar-initial-expansion-list-name
1895 speedbar-initial-expansion-mode-alist)))))
1897 (defun speedbar-initial-keymap ()
1898 "Return the current default menu data.
1899 This is based on `speedbar-initial-expansion-list-name' referencing
1900 `speedbar-initial-expansion-mode-alist'."
1902 (car (cdr (cdr (assoc speedbar-initial-expansion-list-name
1903 speedbar-initial-expansion-mode-alist))))))
1905 (defun speedbar-initial-stealthy-functions ()
1906 "Return a list of functions to call stealthily.
1907 This is based on `speedbar-initial-expansion-list-name' referencing
1908 `speedbar-stealthy-function-list'."
1909 (cdr (assoc speedbar-initial-expansion-list-name
1910 speedbar-stealthy-function-list)))
1912 (defun speedbar-add-expansion-list (new-list)
1913 "Add NEW-LIST to the list of expansion lists."
1914 (add-to-list 'speedbar-initial-expansion-mode-alist new-list))
1916 (defun speedbar-change-initial-expansion-list (new-default)
1917 "Change speedbar's default expansion list to NEW-DEFAULT."
1920 (completing-read (format "Speedbar Mode (default %s): "
1921 speedbar-previously-used-expansion-list-name)
1922 speedbar-initial-expansion-mode-alist
1924 speedbar-previously-used-expansion-list-name)))
1925 (setq speedbar-previously-used-expansion-list-name
1926 speedbar-initial-expansion-list-name
1927 speedbar-initial-expansion-list-name new-default)
1929 (speedbar-reconfigure-keymaps))
1932 ;;; Special speedbar display management
1934 (defun speedbar-maybe-add-localized-support (buffer)
1935 "Quick check function called on BUFFERs by the speedbar timer function.
1936 Maintains the value of local variables which control speedbars use
1937 of the special mode functions."
1938 (or speedbar-special-mode-expansion-list
1939 (speedbar-add-localized-speedbar-support buffer)))
1941 (defun speedbar-add-localized-speedbar-support (buffer)
1942 "Add localized speedbar support to BUFFER's mode if it is available."
1943 (interactive "bBuffer: ")
1944 (if (stringp buffer) (setq buffer (get-buffer buffer)))
1945 (if (not (buffer-live-p buffer))
1950 (let ((ms (symbol-name major-mode)) v)
1951 (if (not (string-match "-mode$" ms))
1952 nil ;; do nothing to broken mode
1953 (setq ms (substring ms 0 (match-beginning 0)))
1954 (setq v (intern-soft (concat ms "-speedbar-buttons")))
1955 (make-local-variable 'speedbar-special-mode-expansion-list)
1957 (setq speedbar-special-mode-expansion-list t)
1958 ;; If it is autoloaded, we need to load it now so that
1959 ;; we have access to the varialbe -speedbar-menu-items.
1960 ;; Is this XEmacs safe?
1961 (let ((sf (symbol-function v)))
1962 (if (and (listp sf) (eq (car sf) 'autoload))
1963 (load-library (car (cdr sf)))))
1964 (setq speedbar-special-mode-expansion-list (list v))
1965 (setq v (intern-soft (concat ms "-speedbar-key-map")))
1967 nil ;; don't add special keymap
1968 (make-local-variable 'speedbar-special-mode-key-map)
1969 (setq speedbar-special-mode-key-map
1971 (setq v (intern-soft (concat ms "-speedbar-menu-items")))
1973 nil ;; don't add special menus
1974 (make-local-variable 'speedbar-easymenu-definition-special)
1975 (setq speedbar-easymenu-definition-special
1979 (defun speedbar-remove-localized-speedbar-support (buffer)
1980 "Remove any traces that BUFFER supports speedbar in a specialized way."
1983 (kill-local-variable 'speedbar-special-mode-expansion-list)
1984 (kill-local-variable 'speedbar-special-mode-key-map)
1985 (kill-local-variable 'speedbar-easymenu-definition-special)))
1987 ;;; File button management
1989 (defun speedbar-file-lists (directory)
1990 "Create file lists for DIRECTORY.
1991 The car is the list of directories, the cdr is list of files not
1992 matching ignored headers. Cache any directory files found in
1993 `speedbar-directory-contents-alist' and use that cache before scanning
1995 (setq directory (expand-file-name directory))
1996 ;; If in powerclick mode, then the directory we are getting
1997 ;; should be rescanned.
1998 (if speedbar-power-click
1999 (adelete 'speedbar-directory-contents-alist directory))
2000 ;; find the directory, either in the cache, or build it.
2001 (or (cdr-safe (assoc directory speedbar-directory-contents-alist))
2002 (let ((default-directory directory)
2003 (dir (directory-files directory nil))
2008 (or (string-match speedbar-file-unshown-regexp (car dir))
2009 (string-match speedbar-directory-unshown-regexp (car dir))))
2010 (if (file-directory-p (car dir))
2011 (setq dirs (cons (car dir) dirs))
2012 (setq files (cons (car dir) files))))
2013 (setq dir (cdr dir)))
2014 (let ((nl (cons (nreverse dirs) (list (nreverse files)))))
2015 (aput 'speedbar-directory-contents-alist directory nl)
2019 (defun speedbar-directory-buttons (directory index)
2020 "Insert a single button group at point for DIRECTORY.
2021 Each directory path part is a different button. If part of the path
2022 matches the user directory ~, then it is replaced with a ~.
2023 INDEX is not used, but is required by the caller."
2024 (let* ((tilde (expand-file-name "~"))
2025 (dd (expand-file-name directory))
2026 (junk (string-match (regexp-quote tilde) dd))
2028 (concat "~" (substring dd (match-end 0)))
2031 (if (string-match "^~/?\\'" displayme) (setq displayme (concat tilde "/")))
2035 (while (re-search-forward "\\([^/]+\\)/" nil t)
2036 (speedbar-make-button (match-beginning 1) (match-end 1)
2037 'speedbar-directory-face
2038 'speedbar-highlight-face
2039 'speedbar-directory-buttons-follow
2040 (if (= (match-beginning 1) p)
2041 (expand-file-name "~/") ;the tilde
2042 (buffer-substring-no-properties
2044 ;; Nuke the beginning of the directory if it's too long...
2045 (cond ((eq speedbar-directory-button-trim-method 'span)
2047 (let ((ww (or (speedbar-frame-width) 20)))
2048 (move-to-column ww nil)
2049 (while (>= (current-column) ww)
2050 (re-search-backward "/" nil t)
2051 (if (<= (current-column) 2)
2053 (re-search-forward "/" nil t)
2054 (if (< (current-column) 4)
2055 (re-search-forward "/" nil t))
2057 (if (looking-at "/?$")
2060 (move-to-column ww nil)))))
2061 ((eq speedbar-directory-button-trim-method 'trim)
2063 (let ((ww (or (speedbar-frame-width) 20))
2064 (tl (current-column)))
2067 (move-to-column (- tl ww))
2068 (if (re-search-backward "/" nil t)
2070 (delete-region (point-min) (point))
2074 (if (string-match "\\`/[^/]+/\\'" displayme)
2079 (speedbar-make-button p (point)
2080 'speedbar-directory-face
2081 'speedbar-highlight-face
2082 'speedbar-directory-buttons-follow
2085 (insert-char ?\n 1 nil)))
2087 (defun speedbar-make-tag-line (exp-button-type
2088 exp-button-char exp-button-function
2090 tag-button tag-button-function tag-button-data
2091 tag-button-face depth)
2092 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
2093 This is the button that expands or contracts a node (if applicable),
2094 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
2095 is the function to call if it's clicked on. Button types are
2096 'bracket, 'angle, 'curly, or nil. EXP-BUTTON-DATA is extra data
2097 attached to the text forming the expansion button.
2099 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
2100 function to call if clicked on, and TAG-BUTTON-DATA is the data to
2101 attach to the text field (such a tag positioning, etc).
2102 TAG-BUTTON-FACE is a face used for this type of tag.
2104 Lastly, DEPTH shows the depth of expansion.
2106 This function assumes that the cursor is in the speedbar window at the
2107 position to insert a new item, and that the new item will end with a CR"
2108 (let ((start (point))
2110 (insert (int-to-string depth) ":")
2112 (put-text-property start end 'invisible t)
2114 (insert-char ? depth nil)
2115 (put-text-property (- (point) depth) (point) 'invisible nil)
2116 (let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]")
2117 ((eq exp-button-type 'angle) "<%c>")
2118 ((eq exp-button-type 'curly) "{%c}")
2120 (buttxt (format exp-button exp-button-char))
2122 (end (progn (insert buttxt) (point)))
2123 (bf (if exp-button-type 'speedbar-button-face nil))
2124 (mf (if exp-button-function 'speedbar-highlight-face nil))
2126 (speedbar-make-button start end bf mf exp-button-function exp-button-data)
2127 (if speedbar-hide-button-brackets-flag
2129 (put-text-property start (1+ start) 'invisible t)
2130 (put-text-property end (1- end) 'invisible t)))
2132 (insert-char ? 1 nil)
2133 (put-text-property (1- (point)) (point) 'invisible nil)
2134 (let ((start (point))
2135 (end (progn (insert tag-button) (point))))
2136 (insert-char ?\n 1 nil)
2137 (put-text-property (1- (point)) (point) 'invisible nil)
2138 (speedbar-make-button start end tag-button-face
2139 (if tag-button-function 'speedbar-highlight-face nil)
2140 tag-button-function tag-button-data))
2143 (defun speedbar-change-expand-button-char (char)
2144 "Change the expansion button character to CHAR for the current line."
2147 (if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line)
2149 (speedbar-with-writable
2150 (goto-char (match-beginning 1))
2152 (insert-char char 1 t)
2153 (put-text-property (point) (1- (point)) 'invisible nil)))))
2156 ;;; Build button lists
2158 (defun speedbar-insert-files-at-point (files level)
2159 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2160 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2161 don't know how to manage them. The input parameter FILES is a cons
2162 cell of the form ( 'DIRLIST . 'FILELIST )"
2163 ;; Start inserting all the directories
2164 (let ((dirs (car files)))
2166 (speedbar-make-tag-line 'angle ?+ 'speedbar-dired (car dirs)
2167 (car dirs) 'speedbar-dir-follow nil
2168 'speedbar-directory-face level)
2169 (setq dirs (cdr dirs))))
2170 (let ((lst (car (cdr files)))
2171 (case-fold-search t))
2173 (let* ((known (string-match speedbar-file-regexp (car lst)))
2174 (expchar (if known ?+ ??))
2175 (fn (if known 'speedbar-tag-file nil)))
2176 (if (or speedbar-show-unknown-files (/= expchar ??))
2177 (speedbar-make-tag-line 'bracket expchar fn (car lst)
2178 (car lst) 'speedbar-find-file nil
2179 'speedbar-file-face level)))
2180 (setq lst (cdr lst)))))
2182 (defun speedbar-default-directory-list (directory index)
2183 "Insert files for DIRECTORY with level INDEX at point."
2184 (speedbar-insert-files-at-point
2185 (speedbar-file-lists directory) index)
2186 (speedbar-reset-scanners)
2188 ;; If the shown files variable has extra directories, then
2189 ;; it is our responsibility to redraw them all
2190 ;; Luckilly, the nature of inserting items into this list means
2191 ;; that by reversing it, we can easilly go in the right order
2192 (let ((sf (cdr (reverse speedbar-shown-directories))))
2193 (setq speedbar-shown-directories
2194 (list (expand-file-name default-directory)))
2195 ;; exand them all as we find them
2197 (if (speedbar-goto-this-file (car sf))
2200 (if (looking-at "[0-9]+:[ ]*<")
2202 (goto-char (match-end 0))
2203 (speedbar-do-function-pointer)))
2204 (setq sf (cdr sf)))))
2207 (defun speedbar-apply-one-tag-hierarchy-method (lst method)
2208 "Adjust the tag hierarchy LST by METHOD."
2211 (sort (copy-alist lst)
2212 (lambda (a b) (string< (car a) (car b)))))
2213 ((eq method 'prefix-group)
2218 (short-group-list nil)
2219 (short-start-name nil)
2220 (short-end-name nil)
2221 (num-shorts-grouped 0)
2222 (bins (make-vector 256 nil))
2224 ;; Break out sub-lists
2226 (if (listp (cdr-safe (car-safe lst)))
2227 (setq newlst (cons (car lst) newlst))
2228 (setq sublst (cons (car lst) sublst)))
2229 (setq lst (cdr lst)))
2230 ;; Now, first find out how long our list is. Never let a
2231 ;; list get-shorter than our minimum.
2232 (if (<= (length sublst) speedbar-tag-split-minimum-length)
2233 (setq work-list (nreverse sublst))
2234 (setq diff-idx (length (try-completion "" sublst)))
2235 ;; Sort the whole list into bins.
2237 (let ((e (car sublst))
2238 (s (car (car sublst))))
2239 (cond ((<= (length s) diff-idx)
2240 ;; 0 storage bin for shorty.
2241 (aset bins 0 (cons e (aref bins 0))))
2243 ;; stuff into a bin based on ascii value at diff
2244 (aset bins (aref s diff-idx)
2245 (cons e (aref bins (aref s diff-idx)))))))
2246 (setq sublst (cdr sublst)))
2247 ;; Go through all our bins Stick singles into our
2248 ;; junk-list, everything else as sublsts in work-list.
2249 ;; If two neighboring lists are both small, make a grouped
2250 ;; group combinding those two sub-lists.
2252 (while (> 256 diff-idx)
2253 (let ((l (aref bins diff-idx)))
2255 (let ((tmp (cons (try-completion "" l) l)))
2256 (if (or (> (length l) speedbar-tag-regroup-maximum-length)
2257 (> (+ (length l) (length short-group-list))
2258 speedbar-tag-split-minimum-length))
2260 ;; We have reached a longer list, so we
2261 ;; must finish off a grouped group.
2263 ((and short-group-list
2264 (= (length short-group-list)
2265 num-shorts-grouped))
2266 ;; All singles? Junk list
2267 (setq junk-list (append short-group-list
2269 ((= num-shorts-grouped 1)
2270 ;; Only one short group? Just stick it in
2273 (cons (cons (try-completion
2274 "" short-group-list)
2275 (nreverse short-group-list))
2278 ;; Multiple groups to be named in a special
2279 ;; way by displaying the range over which we
2280 ;; have grouped them.
2282 (cons (cons (concat short-start-name
2285 (nreverse short-group-list))
2287 ;; Reset short group list information every time.
2288 (setq short-group-list nil
2289 short-start-name nil
2291 num-shorts-grouped 0)))
2292 ;; Ok, now that we cleaned up the short-group-list,
2293 ;; we can deal with this new list, to decide if it
2294 ;; should go on one of these sub-lists or not.
2295 (if (< (length l) speedbar-tag-regroup-maximum-length)
2296 (setq short-group-list (append short-group-list l)
2297 num-shorts-grouped (1+ num-shorts-grouped)
2298 short-end-name (car tmp)
2299 short-start-name (if short-start-name
2302 (setq work-list (cons tmp work-list))))))
2303 (setq diff-idx (1+ diff-idx))))
2304 ;; Did we run out of things? Drop our new list onto the end.
2306 ((and short-group-list (= (length short-group-list) num-shorts-grouped))
2307 ;; All singles? Junk list
2308 (setq junk-list (append short-group-list junk-list)))
2309 ((= num-shorts-grouped 1)
2310 ;; Only one short group? Just stick it in
2313 (cons (cons (try-completion "" short-group-list)
2314 (nreverse short-group-list))
2317 ;; Multiple groups to be named in a special
2318 ;; way by displaying the range over which we
2319 ;; have grouped them.
2321 (cons (cons (concat short-start-name " to " short-end-name)
2322 (nreverse short-group-list))
2324 ;; Now, stick our new list onto the end of
2327 (append (nreverse newlst)
2328 (nreverse work-list)
2330 (append (nreverse newlst)
2331 (nreverse work-list)))
2332 (append (nreverse newlst) junk-list))))
2333 ((eq method 'trim-words)
2340 (if (listp (cdr-safe (car-safe lst)))
2341 (setq newlst (cons (car lst) newlst))
2342 (setq sublst (cons (car lst) sublst)))
2343 (setq lst (cdr lst)))
2344 ;; Get the prefix to trim by. Make sure that we don't trim
2345 ;; off silly pieces, only complete understandable words.
2346 (setq trim-prefix (try-completion "" sublst))
2347 (if (or (= (length sublst) 1)
2349 (not (string-match "\\(\\w+\\W+\\)+" trim-prefix)))
2350 (append (nreverse newlst) (nreverse sublst))
2351 (setq trim-prefix (substring trim-prefix (match-beginning 0)
2353 (setq trim-chars (length trim-prefix))
2356 (cons (substring (car (car sublst)) trim-chars)
2359 sublst (cdr sublst)))
2360 ;; Put the lists together
2361 (append (nreverse newlst) trimlst))))
2362 ((eq method 'simple-group)
2366 (if (listp (cdr-safe (car-safe lst)))
2367 (setq newlst (cons (car lst) newlst))
2368 (setq sublst (cons (car lst) sublst)))
2369 (setq lst (cdr lst)))
2372 (setq newlst (cons (cons "Tags" (nreverse sublst)) newlst))
2373 (nreverse newlst))))
2376 (defun speedbar-create-tag-hierarchy (lst)
2377 "Adjust the tag hierarchy in LST, and return it.
2378 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2379 the list. See it's value for details."
2380 (let ((methods speedbar-tag-hierarchy-method))
2382 (setq lst (speedbar-apply-one-tag-hierarchy-method lst (car methods))
2383 methods (cdr methods)))
2386 (defun speedbar-insert-generic-list (level lst expand-fun find-fun)
2387 "At LEVEL, insert a generic multi-level alist LST.
2388 Associations with lists get {+} tags (to expand into more nodes) and
2389 those with positions just get a > as the indicator. {+} buttons will
2390 have the function EXPAND-FUN and the token is the CDR list. The token
2391 name will have the function FIND-FUN and not token."
2392 ;; Remove imenu rescan button
2393 (if (string= (car (car lst)) "*Rescan*")
2394 (setq lst (cdr lst)))
2396 (setq lst (speedbar-create-tag-hierarchy lst))
2399 (cond ((null (car-safe lst)) nil) ;this would be a separator
2400 ((or (numberp (cdr-safe (car-safe lst)))
2401 (markerp (cdr-safe (car-safe lst))))
2402 (speedbar-make-tag-line nil nil nil nil ;no expand button data
2403 (car (car lst)) ;button name
2405 (cdr (car lst)) ;token is position
2408 ((listp (cdr-safe (car-safe lst)))
2409 (speedbar-make-tag-line 'curly ?+ expand-fun (cdr (car lst))
2410 (car (car lst)) ;button name
2411 nil nil 'speedbar-tag-face
2413 (t (message "Ooops!")))
2414 (setq lst (cdr lst))))
2418 (defun speedbar-update-contents ()
2419 "Generically update the contents of the speedbar buffer."
2421 ;; Set the current special buffer
2422 (setq speedbar-desired-buffer nil)
2423 ;; Check for special modes
2424 (speedbar-maybe-add-localized-support (current-buffer))
2425 ;; Choose the correct method of doodling.
2426 (if (and speedbar-mode-specific-contents-flag
2427 (listp speedbar-special-mode-expansion-list)
2428 speedbar-special-mode-expansion-list
2430 'speedbar-special-mode-expansion-list
2432 ;;(eq (get major-mode 'mode-class 'special)))
2433 (speedbar-update-special-contents)
2434 (speedbar-update-directory-contents)))
2436 (defun speedbar-update-directory-contents ()
2437 "Update the contents of the speedbar buffer based on the current directory."
2438 (let ((cbd (expand-file-name default-directory))
2440 (funclst (speedbar-initial-expansion-list))
2441 (cache speedbar-full-text-cache)
2442 ;; disable stealth during update
2443 (speedbar-stealthy-function-list nil)
2446 ;; Because there is a bug I can't find just yet
2449 (set-buffer speedbar-buffer)
2450 ;; If we are updating contents to where we are, then this is
2451 ;; really a request to update existing contents, so we must be
2452 ;; careful with our text cache!
2453 (if (member cbd speedbar-shown-directories)
2456 ;; If the current directory is not the last element in the dir
2457 ;; list, then we ALSO need to zap the list of expanded directories
2458 (if (/= (length (member cbd speedbar-shown-directories)) 1)
2459 (setq speedbar-shown-directories (list cbd))))
2461 ;; Build cbd-parent, and see if THAT is in the current shown
2462 ;; directories. First, go through pains to get the parent directory
2463 (if (and speedbar-smart-directory-expand-flag
2465 (setq cbd-parent cbd)
2466 (if (string-match "/$" cbd-parent)
2467 (setq cbd-parent (substring cbd-parent 0
2468 (match-beginning 0))))
2469 (setq cbd-parent (file-name-directory cbd-parent)))
2470 (member cbd-parent speedbar-shown-directories))
2471 (setq expand-local t)
2473 ;; If this directory is NOT in the current list of available
2474 ;; paths, then use the cache, and set the cache to our new
2475 ;; value. Make sure to unhighlight the current file, or if we
2476 ;; come back to this directory, it might be a different file
2477 ;; and then we get a mess!
2478 (if (> (point-max) 1)
2480 (speedbar-clear-current-file)
2481 (setq speedbar-full-text-cache
2482 (cons speedbar-shown-directories (buffer-string)))))
2484 ;; Check if our new directory is in the list of directories
2485 ;; shown in the text-cache
2486 (if (member cbd (car cache))
2487 (setq speedbar-shown-directories (car cache)
2489 ;; default the shown directories to this list...
2490 (setq speedbar-shown-directories (list cbd)))
2492 (if (not expand-local) (setq speedbar-last-selected-file nil))
2493 (speedbar-with-writable
2494 (if (and expand-local
2495 ;; Find this directory as a speedbar node.
2496 (speedbar-path-line cbd))
2498 (speedbar-expand-line)
2501 (setq default-directory
2502 (nth (1- (length speedbar-shown-directories))
2503 speedbar-shown-directories))
2504 (insert (cdr cache)))
2507 (setq default-directory cbd)
2508 (funcall (car funclst) cbd 0)
2509 (setq funclst (cdr funclst))))))
2510 (goto-char (point-min)))))
2511 (speedbar-reconfigure-keymaps))
2513 (defun speedbar-update-special-contents ()
2514 "Used the mode-specific variable to fill in the speedbar buffer.
2515 This should only be used by modes classified as special."
2516 (let ((funclst speedbar-special-mode-expansion-list)
2517 (specialbuff (current-buffer)))
2519 (setq speedbar-desired-buffer specialbuff)
2520 (set-buffer speedbar-buffer)
2521 ;; If we are leaving a directory, cache it.
2522 (if (not speedbar-shown-directories)
2525 ;; Clean up directory maintenance stuff
2526 (speedbar-clear-current-file)
2527 (setq speedbar-full-text-cache
2528 (cons speedbar-shown-directories (buffer-string))
2529 speedbar-shown-directories nil))
2530 ;; Now fill in the buffer with our newly found specialized list.
2531 (speedbar-with-writable
2533 ;; We do not erase the buffer because these functions may
2534 ;; decide NOT to update themselves.
2535 (funcall (car funclst) specialbuff)
2536 (setq funclst (cdr funclst))))
2537 (goto-char (point-min))))
2538 (speedbar-reconfigure-keymaps))
2540 (defun speedbar-timer-fn ()
2541 "Run whenever Emacs is idle to update the speedbar item."
2542 (if (not (and (frame-live-p speedbar-frame)
2543 (frame-live-p speedbar-attached-frame)))
2544 (speedbar-set-timer nil)
2545 ;; Save all the match data so that we don't mess up executing fns
2547 ;; Only do stuff if the frame is visible, not an icon, and if
2548 ;; it is currently flagged to do something.
2549 (if (and speedbar-update-flag
2550 (frame-visible-p speedbar-frame)
2551 (not (eq (frame-visible-p speedbar-frame) 'icon)))
2552 (let ((af (selected-frame)))
2553 (save-window-excursion
2554 (select-frame speedbar-attached-frame)
2555 ;; make sure we at least choose a window to
2556 ;; get a good directory from
2557 (if (window-minibuffer-p (selected-window))
2559 ;; Check for special modes
2560 (speedbar-maybe-add-localized-support (current-buffer))
2561 ;; Update for special mode all the time!
2562 (if (and speedbar-mode-specific-contents-flag
2563 (listp speedbar-special-mode-expansion-list)
2564 speedbar-special-mode-expansion-list
2566 'speedbar-special-mode-expansion-list
2568 ;;(eq (get major-mode 'mode-class 'special)))
2570 (if (<= 2 speedbar-verbosity-level)
2571 (message "Updating speedbar to special mode: %s..."
2573 (speedbar-update-special-contents)
2574 (if (<= 2 speedbar-verbosity-level)
2576 (message "Updating speedbar to special mode: %s...done"
2579 ;; Update all the contents if directories change!
2580 (if (or (member (expand-file-name default-directory)
2581 speedbar-shown-directories)
2582 (and speedbar-ignored-path-regexp
2584 speedbar-ignored-path-regexp
2585 (expand-file-name default-directory)))
2586 (member major-mode speedbar-ignored-modes)
2587 (eq af speedbar-frame)
2588 (not (buffer-file-name)))
2590 (if (<= 1 speedbar-verbosity-level)
2591 (message "Updating speedbar to: %s..."
2593 (speedbar-update-directory-contents)
2594 (if (<= 1 speedbar-verbosity-level)
2596 (message "Updating speedbar to: %s...done"
2600 ;; Now run stealthy updates of time-consuming items
2601 (speedbar-stealthy-updates)))
2602 ;; Now run the mouse tracking system
2603 (speedbar-show-info-under-mouse)))
2604 (run-hooks 'speedbar-timer-hook))
2607 ;;; Stealthy activities
2609 (defvar speedbar-stealthy-update-recurse nil
2610 "Recursion avoidance variable for stealthy update.")
2612 (defun speedbar-stealthy-updates ()
2613 "For a given speedbar, run all items in the stealthy function list.
2614 Each item returns t if it completes successfully, or nil if
2615 interrupted by the user."
2616 (if (not speedbar-stealthy-update-recurse)
2617 (let ((l (speedbar-initial-stealthy-functions))
2618 (speedbar-stealthy-update-recurse t))
2620 (speedbar-with-writable
2621 (while (and l (funcall (car l)))
2624 ;;(message "Exit with %S" (car l))
2627 (defun speedbar-reset-scanners ()
2628 "Reset any variables used by functions in the stealthy list as state.
2629 If new functions are added, their state needs to be updated here."
2630 (setq speedbar-vc-to-do-point t
2631 speedbar-obj-to-do-point t)
2632 (run-hooks 'speedbar-scanner-reset-hook)
2635 (defun speedbar-find-selected-file (file)
2636 "Goto the line where FILE is."
2637 (goto-char (point-min))
2639 (while (and (setq m (re-search-forward
2640 (concat " \\(" (file-name-nondirectory file)
2641 "\\)\\(" speedbar-indicator-regex "\\)?\n")
2647 (goto-char (match-beginning 0))
2650 (looking-at "[0-9]+:")
2651 (string-to-number (match-string 0)))))
2652 (match-string 1))))))
2655 (goto-char (match-beginning 1))
2656 (match-string 1)))))
2658 (defun speedbar-clear-current-file ()
2659 "Locate the file thought to be current, and remove its highlighting."
2661 (set-buffer speedbar-buffer)
2662 (if speedbar-last-selected-file
2663 (speedbar-with-writable
2664 (if (speedbar-find-selected-file speedbar-last-selected-file)
2665 (put-text-property (match-beginning 1)
2668 'speedbar-file-face))))))
2670 (defun speedbar-update-current-file ()
2671 "Find the current file, and update our visuals to indicate its name.
2672 This is specific to file names. If the file name doesn't show up, but
2673 it should be in the list, then the directory cache needs to be
2675 (let* ((lastf (selected-frame))
2676 (newcfd (save-excursion
2677 (select-frame speedbar-attached-frame)
2678 (let ((rf (if (buffer-file-name)
2681 (select-frame lastf)
2683 (newcf (if newcfd newcfd))
2684 (lastb (current-buffer))
2685 (sucf-recursive (boundp 'sucf-recursive))
2686 (case-fold-search t))
2688 ;; check here, that way we won't refresh to newcf until
2689 ;; its been written, thus saving ourselves some time
2690 (file-exists-p newcf)
2691 (not (string= newcf speedbar-last-selected-file)))
2693 ;; It is important to select the frame, otherwise the window
2694 ;; we want the cursor to move in will not be updated by the
2695 ;; search-forward command.
2696 (select-frame speedbar-frame)
2697 ;; Remove the old file...
2698 (speedbar-clear-current-file)
2699 ;; now highlight the new one.
2700 (set-buffer speedbar-buffer)
2701 (speedbar-with-writable
2702 (if (speedbar-find-selected-file newcf)
2703 ;; put the property on it
2704 (put-text-property (match-beginning 1)
2707 'speedbar-selected-face)
2708 ;; Oops, it's not in the list. Should it be?
2709 (if (and (string-match speedbar-file-regexp newcf)
2710 (string= (file-name-directory newcfd)
2711 (expand-file-name default-directory)))
2712 ;; yes, it is (we will ignore unknowns for now...)
2715 (if (speedbar-find-selected-file newcf)
2716 ;; put the property on it
2717 (put-text-property (match-beginning 1)
2720 'speedbar-selected-face)))
2721 ;; if it's not in there now, whatever...
2723 (setq speedbar-last-selected-file newcf))
2724 (if (not sucf-recursive)
2726 (speedbar-center-buffer-smartly)
2727 (speedbar-position-cursor-on-line)
2730 (select-frame lastf)
2732 ;; return that we are done with this activity.
2735 (defun speedbar-add-indicator (indicator-string &optional replace-this)
2736 "Add INDICATOR-STRING to the end of this speedbar line.
2737 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2738 an the existing indicator is removed. If there is already an
2739 indicator, then do not add a space."
2741 ;; The nature of the beast: Assume we are in "the right place"
2743 (skip-chars-backward (concat " " speedbar-vc-indicator
2744 (car speedbar-obj-indicator)
2745 (cdr speedbar-obj-indicator)))
2746 (if (and (not (looking-at speedbar-indicator-regex))
2747 (not (string= indicator-string " ")))
2748 (insert speedbar-indicator-separator))
2749 (speedbar-with-writable
2751 (if (and replace-this
2752 (re-search-forward replace-this (save-excursion (end-of-line)
2755 (delete-region (match-beginning 0) (match-end 0))))
2757 (if (not (string= " " indicator-string))
2758 (insert indicator-string))))
2760 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2761 ;; Steven L Baur <steve@xemacs.org> said this was important:
2762 (eval-when-compile (or (featurep 'xemacs)
2763 (condition-case () (require 'efs)
2764 (error (require 'ange-ftp)))))
2766 (defun speedbar-check-vc ()
2767 "Scan all files in a directory, and for each see if it's checked out.
2768 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2769 to add more types of version control systems."
2770 ;; Check for to-do to be reset. If reset but no RCS is available
2771 ;; then set to nil (do nothing) otherwise, start at the beginning
2773 (set-buffer speedbar-buffer)
2774 (if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t)
2775 (speedbar-vc-check-dir-p default-directory)
2776 (not (or (and (featurep 'ange-ftp)
2778 (car (if speedbar-xemacsp
2779 ange-ftp-path-format
2780 ange-ftp-name-format))
2781 (expand-file-name default-directory)))
2782 ;; efs support: Bob Weiner
2783 (and (featurep 'efs)
2785 (car efs-path-regexp)
2786 (expand-file-name default-directory))))))
2787 (setq speedbar-vc-to-do-point 0))
2788 (if (numberp speedbar-vc-to-do-point)
2790 (goto-char speedbar-vc-to-do-point)
2791 (while (and (not (input-pending-p))
2792 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
2794 (setq speedbar-vc-to-do-point (point))
2795 (if (speedbar-check-vc-this-line (match-string 1))
2796 (speedbar-add-indicator speedbar-vc-indicator
2797 (regexp-quote speedbar-vc-indicator))
2798 (speedbar-add-indicator " "
2799 (regexp-quote speedbar-vc-indicator))))
2800 (if (input-pending-p)
2801 ;; return that we are incomplete
2803 ;; we are done, set to-do to nil
2804 (setq speedbar-vc-to-do-point nil)
2809 (defun speedbar-check-vc-this-line (depth)
2810 "Return t if the file on this line is check of of a version control system.
2811 Parameter DEPTH is a string with the current depth of indentation of
2812 the file being checked."
2813 (let* ((d (string-to-int depth))
2814 (f (speedbar-line-path d))
2815 (fn (buffer-substring-no-properties
2816 ;; Skip-chars: thanks ptype@dra.hmg.gb
2818 (skip-chars-forward "^ "
2819 (save-excursion (end-of-line)
2822 (fulln (concat f fn)))
2823 (if (<= 2 speedbar-verbosity-level)
2824 (message "Speedbar vc check...%s" fulln))
2825 (and (file-writable-p fulln)
2826 (speedbar-this-file-in-vc f fn))))
2828 (defun speedbar-vc-check-dir-p (path)
2829 "Return t if we should bother checking PATH for version control files.
2830 This can be overloaded to add new types of version control systems."
2833 (file-exists-p (concat path "RCS/"))
2835 (file-exists-p (concat path "SCCS/"))
2836 ;; Remote SCCS project
2837 (let ((proj-dir (getenv "PROJECTDIR")))
2839 (file-exists-p (concat proj-dir "/SCCS"))
2842 (run-hook-with-args 'speedbar-vc-path-enable-hook path)
2845 (defun speedbar-this-file-in-vc (path name)
2846 "Check to see if the file in PATH with NAME is in a version control system.
2847 You can add new VC systems by overriding this function. You can
2848 optimize this function by overriding it and only doing those checks
2849 that will occur on your system."
2852 (file-exists-p (concat path "RCS/" name ",v"))
2853 (file-exists-p (concat path "RCS/" name))
2854 ;; Local SCCS file name
2855 (file-exists-p (concat path "SCCS/p." name))
2856 ;; Remote SCCS file name
2857 (let ((proj-dir (getenv "PROJECTDIR")))
2859 (file-exists-p (concat proj-dir "/SCCS/p." name))
2862 (run-hook-with-args 'speedbar-vc-in-control-hook path name)
2865 ;; Objet File scanning
2866 (defun speedbar-check-objects ()
2867 "Scan all files in a directory, and for each see if there is an object.
2868 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2869 to add more object types."
2870 ;; Check for to-do to be reset. If reset but no RCS is available
2871 ;; then set to nil (do nothing) otherwise, start at the beginning
2873 (set-buffer speedbar-buffer)
2874 (if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t))
2875 (setq speedbar-obj-to-do-point 0))
2876 (if (numberp speedbar-obj-to-do-point)
2878 (goto-char speedbar-obj-to-do-point)
2879 (while (and (not (input-pending-p))
2880 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
2882 (setq speedbar-obj-to-do-point (point))
2883 (let ((ind (speedbar-check-obj-this-line (match-string 1))))
2884 (if (not ind) (setq ind " "))
2885 (speedbar-add-indicator ind (concat
2886 (car speedbar-obj-indicator)
2888 (cdr speedbar-obj-indicator)))))
2889 (if (input-pending-p)
2890 ;; return that we are incomplete
2892 ;; we are done, set to-do to nil
2893 (setq speedbar-obj-to-do-point nil)
2898 (defun speedbar-check-obj-this-line (depth)
2899 "Return t if the file on this line has an associated object.
2900 Parameter DEPTH is a string with the current depth of indentation of
2901 the file being checked."
2902 (let* ((d (string-to-int depth))
2903 (f (speedbar-line-path d))
2904 (fn (buffer-substring-no-properties
2905 ;; Skip-chars: thanks ptype@dra.hmg.gb
2907 (skip-chars-forward "^ "
2908 (save-excursion (end-of-line)
2911 (fulln (concat f fn)))
2912 (if (<= 2 speedbar-verbosity-level)
2913 (message "Speedbar obj check...%s" fulln))
2914 (let ((oa speedbar-obj-alist))
2915 (while (and oa (not (string-match (car (car oa)) fulln)))
2917 (if (not (and oa (file-exists-p (concat (file-name-sans-extension fulln)
2920 ;; Find out if the object is out of date or not.
2921 (let ((date1 (nth 5 (file-attributes fulln)))
2922 (date2 (nth 5 (file-attributes (concat
2923 (file-name-sans-extension fulln)
2925 (if (or (< (car date1) (car date2))
2926 (and (= (car date1) (car date2))
2927 (< (nth 1 date1) (nth 1 date2))))
2928 (car speedbar-obj-indicator)
2929 (cdr speedbar-obj-indicator)))))))
2931 ;;; Clicking Activity
2933 (defun speedbar-quick-mouse (e)
2934 "Since mouse events are strange, this will keep the mouse nicely positioned.
2935 This should be bound to mouse event E."
2938 (speedbar-position-cursor-on-line)
2941 (defun speedbar-position-cursor-on-line ()
2942 "Position the cursor on a line."
2943 (let ((oldpos (point)))
2945 (if (looking-at "[0-9]+:\\s-*..?.? ")
2946 (goto-char (1- (match-end 0)))
2947 (goto-char oldpos))))
2949 (defun speedbar-power-click (e)
2950 "Activate any speedbar button as a power click.
2951 This should be bound to mouse event E."
2953 (let ((speedbar-power-click t))
2954 (speedbar-click e)))
2956 (defun speedbar-click (e)
2957 "Activate any speedbar buttons where the mouse is clicked.
2958 This must be bound to a mouse event. A button is any location of text
2959 with a mouse face that has a text property called `speedbar-function'.
2960 This should be bound to mouse event E."
2963 (speedbar-do-function-pointer)
2964 (speedbar-quick-mouse e))
2966 (defun speedbar-double-click (e)
2967 "Activate any speedbar buttons where the mouse is clicked.
2968 This must be bound to a mouse event. A button is any location of text
2969 with a mouse face that has a text property called `speedbar-function'.
2970 This should be bound to mouse event E."
2972 ;; Emacs only. XEmacs handles this via `mouse-track-click-hook'.
2973 (cond ((eq (car e) 'down-mouse-1)
2974 (mouse-set-point e))
2975 ((eq (car e) 'mouse-1)
2976 (speedbar-quick-mouse e))
2977 ((or (eq (car e) 'double-down-mouse-1)
2978 (eq (car e) 'triple-down-mouse-1))
2980 (speedbar-do-function-pointer)
2981 (speedbar-quick-mouse e))))
2983 (defun speedbar-do-function-pointer ()
2984 "Look under the cursor and examine the text properties.
2985 From this extract the file/tag name, token, indentation level and call
2986 a function if appropriate"
2987 (let* ((fn (get-text-property (point) 'speedbar-function))
2988 (tok (get-text-property (point) 'speedbar-token))
2989 ;; The 1-,+ is safe because scaning starts AFTER the point
2990 ;; specified. This lets the search include the character the
2992 (tp (previous-single-property-change
2993 (1+ (point)) 'speedbar-function))
2994 (np (next-single-property-change
2995 (point) 'speedbar-function))
2996 (txt (buffer-substring-no-properties (or tp (point-min))
2997 (or np (point-max))))
2998 (dent (save-excursion (beginning-of-line)
3000 (if (looking-at "[0-9]+")
3001 (buffer-substring-no-properties
3002 (match-beginning 0) (match-end 0))
3004 ;;(message "%S:%S:%S:%s" fn tok txt dent)
3005 (and fn (funcall fn txt tok dent)))
3006 (speedbar-position-cursor-on-line))
3008 ;;; Reading info from the speedbar buffer
3010 (defun speedbar-line-file (&optional p)
3011 "Retrieve the file or whatever from the line at P point.
3012 The return value is a string representing the file. If it is a
3013 directory, then it is the directory name."
3017 (if (looking-at (concat
3018 "\\([0-9]+\\): *[[<][-+?][]>] \\([^ \n]+\\)\\("
3019 speedbar-indicator-regex "\\)?"))
3020 (let* ((depth (string-to-int (match-string 1)))
3021 (path (speedbar-line-path depth))
3022 (f (match-string 2)))
3026 (defun speedbar-goto-this-file (file)
3027 "If FILE is displayed, goto this line and return t.
3028 Otherwise do not move and return nil."
3029 (let ((path (substring (file-name-directory (expand-file-name file))
3030 (length (expand-file-name default-directory))))
3033 (goto-char (point-min))
3034 ;; scan all the directories
3035 (while (and path (not (eq path t)))
3036 (if (string-match "^/?\\([^/]+\\)" path)
3037 (let ((pp (match-string 1 path)))
3038 (if (save-match-data
3039 (re-search-forward (concat "> " (regexp-quote pp) "$")
3041 (setq path (substring path (match-end 1)))
3044 ;; find the file part
3045 (if (or (not path) (string= (file-name-nondirectory file) ""))
3046 ;; only had a dir part
3049 (speedbar-position-cursor-on-line)
3051 (goto-char dest) nil)
3052 ;; find the file part
3053 (let ((nd (file-name-nondirectory file)))
3054 (if (re-search-forward
3055 (concat "] \\(" (regexp-quote nd)
3056 "\\)\\(" speedbar-indicator-regex "\\)$")
3059 (speedbar-position-cursor-on-line)
3064 (defun speedbar-line-path (depth)
3065 "Retrieve the pathname associated with the current line.
3066 This may require traversing backwards from DEPTH and combining the default
3067 directory with these items."
3069 ((string= speedbar-initial-expansion-list-name "files")
3073 (setq depth (1- depth))
3074 (while (/= depth -1)
3075 (if (not (re-search-backward (format "^%d:" depth) nil t))
3076 (error "Error building path of tag")
3077 (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)$")
3078 (setq path (concat (buffer-substring-no-properties
3079 (match-beginning 1) (match-end 1))
3082 ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)$")
3083 ;; This is the start of our path.
3084 (setq path (buffer-substring-no-properties
3085 (match-beginning 1) (match-end 1))))))
3086 (setq depth (1- depth)))
3088 (string-match (concat speedbar-indicator-regex "$")
3090 (setq path (substring path 0 (match-beginning 0))))
3091 (concat default-directory path)))))
3093 ;; If we aren't in file mode, then return an empty string to make
3094 ;; sure that we can still get some stuff done.
3097 (defun speedbar-path-line (path)
3098 "Position the cursor on the line specified by PATH."
3100 (if (string-match "/$" path)
3101 (setq path (substring path 0 (match-beginning 0))))
3102 (let ((nomatch t) (depth 0)
3103 (fname (file-name-nondirectory path))
3104 (pname (file-name-directory path)))
3105 (if (not (member pname speedbar-shown-directories))
3106 (error "Internal Error: File %s not shown in speedbar" path))
3107 (goto-char (point-min))
3110 (concat "[]>] \\(" (regexp-quote fname)
3111 "\\)\\(" speedbar-indicator-regex "\\)?$")
3114 (looking-at "\\([0-9]+\\):")
3115 (setq depth (string-to-int (match-string 0))
3116 nomatch (not (string= pname (speedbar-line-path depth))))
3121 (defun speedbar-edit-line ()
3122 "Edit whatever tag or file is on the current speedbar line."
3126 ;; If this fails, then it is a non-standard click, and as such,
3127 ;; perfectly allowed.
3128 (if (re-search-forward "[]>?}] [^ ]"
3129 (save-excursion (end-of-line) (point))
3131 (speedbar-do-function-pointer)
3133 (speedbar-do-function-pointer)))
3135 (defun speedbar-expand-line ()
3136 "Expand the line under the cursor."
3139 (re-search-forward ":\\s-*.\\+. " (save-excursion (end-of-line) (point)))
3141 (speedbar-do-function-pointer))
3143 (defun speedbar-contract-line ()
3144 "Contract the line under the cursor."
3147 (re-search-forward ":\\s-*.-. " (save-excursion (end-of-line) (point)))
3149 (speedbar-do-function-pointer))
3151 (if speedbar-xemacsp
3152 (defalias 'speedbar-mouse-event-p 'button-press-event-p)
3153 (defun speedbar-mouse-event-p (event)
3154 "Return t if the event is a mouse related event"
3155 ;; And Emacs does it this way
3156 (if (and (listp event)
3157 (member (event-basic-type event)
3158 '(mouse-1 mouse-2 mouse-3)))
3162 (defun speedbar-maybee-jump-to-attached-frame ()
3163 "Jump to the attached frame ONLY if this was not a mouse event."
3164 (if (or (not (speedbar-mouse-event-p last-input-event))
3165 speedbar-activity-change-focus-flag)
3167 (select-frame speedbar-attached-frame)
3170 (defun speedbar-find-file (text token indent)
3171 "Speedbar click handler for filenames.
3172 TEXT, the file will be displayed in the attached frame.
3173 TOKEN is unused, but required by the click handler. INDENT is the
3174 current indentation level."
3175 (let ((cdd (speedbar-line-path indent)))
3176 (speedbar-find-file-in-frame (concat cdd text))
3177 (speedbar-stealthy-updates)
3178 (run-hooks 'speedbar-visiting-file-hook)
3179 ;; Reset the timer with a new timeout when cliking a file
3180 ;; in case the user was navigating directories, we can cancel
3181 ;; that other timer.
3182 (speedbar-set-timer speedbar-update-speed))
3183 (speedbar-maybee-jump-to-attached-frame))
3185 (defun speedbar-dir-follow (text token indent)
3186 "Speedbar click handler for directory names.
3187 Clicking a directory will cause the speedbar to list files in the
3188 the subdirectory TEXT. TOKEN is an unused requirement. The
3189 subdirectory chosen will be at INDENT level."
3190 (setq default-directory
3191 (concat (expand-file-name (concat (speedbar-line-path indent) text))
3193 ;; Because we leave speedbar as the current buffer,
3194 ;; update contents will change directory without
3195 ;; having to touch the attached frame. Turn off smart expand just
3197 (let ((speedbar-smart-directory-expand-flag nil))
3198 (speedbar-update-contents))
3199 (speedbar-set-timer speedbar-navigating-speed)
3200 (setq speedbar-last-selected-file nil)
3201 (speedbar-stealthy-updates))
3203 (defun speedbar-delete-subblock (indent)
3204 "Delete text from point to indentation level INDENT or greater.
3205 Handles end-of-sublist smartly."
3206 (speedbar-with-writable
3208 (end-of-line) (forward-char 1)
3209 (let ((start (point)))
3210 (while (and (looking-at "^\\([0-9]+\\):")
3211 (> (string-to-int (match-string 1)) indent)
3214 (beginning-of-line))
3215 (delete-region start (point))))))
3217 (defun speedbar-dired (text token indent)
3218 "Speedbar click handler for directory expand button.
3219 Clicking this button expands or contracts a directory. TEXT is the
3220 button clicked which has either a + or -. TOKEN is the directory to be
3221 expanded. INDENT is the current indentation level."
3222 (cond ((string-match "+" text) ;we have to expand this dir
3223 (setq speedbar-shown-directories
3224 (cons (expand-file-name
3225 (concat (speedbar-line-path indent) token "/"))
3226 speedbar-shown-directories))
3227 (speedbar-change-expand-button-char ?-)
3228 (speedbar-reset-scanners)
3230 (end-of-line) (forward-char 1)
3231 (speedbar-with-writable
3232 (speedbar-default-directory-list
3233 (concat (speedbar-line-path indent) token "/")
3235 ((string-match "-" text) ;we have to contract this node
3236 (speedbar-reset-scanners)
3237 (let ((oldl speedbar-shown-directories)
3239 (td (expand-file-name
3240 (concat (speedbar-line-path indent) token))))
3242 (if (not (string-match (concat "^" (regexp-quote td)) (car oldl)))
3243 (setq newl (cons (car oldl) newl)))
3244 (setq oldl (cdr oldl)))
3245 (setq speedbar-shown-directories newl))
3246 (speedbar-change-expand-button-char ?+)
3247 (speedbar-delete-subblock indent)
3249 (t (error "Ooops... not sure what to do")))
3250 (speedbar-center-buffer-smartly)
3251 (setq speedbar-last-selected-file nil)
3252 (save-excursion (speedbar-stealthy-updates)))
3254 (defun speedbar-directory-buttons-follow (text token indent)
3255 "Speedbar click handler for default directory buttons.
3256 TEXT is the button clicked on. TOKEN is the directory to follow.
3257 INDENT is the current indentation level and is unused."
3258 (if (string-match "^[A-z]:$" token)
3259 (setq default-directory (concat token (char-to-string directory-sep-char)))
3260 (setq default-directory token))
3261 ;; Because we leave speedbar as the current buffer,
3262 ;; update contents will change directory without
3263 ;; having to touch the attached frame.
3264 (speedbar-update-contents)
3265 (speedbar-set-timer speedbar-navigating-speed))
3267 (defun speedbar-tag-file (text token indent)
3268 "The cursor is on a selected line. Expand the tags in the specified file.
3269 The parameter TEXT and TOKEN are required, where TEXT is the button
3270 clicked, and TOKEN is the file to expand. INDENT is the current
3272 (cond ((string-match "+" text) ;we have to expand this file
3273 (let* ((fn (expand-file-name (concat (speedbar-line-path indent)
3275 (lst (if speedbar-use-imenu-flag
3276 (let ((tim (speedbar-fetch-dynamic-imenu fn)))
3278 (speedbar-fetch-dynamic-etags fn)
3280 (speedbar-fetch-dynamic-etags fn))))
3281 ;; if no list, then remove expando button
3283 (speedbar-change-expand-button-char ??)
3284 (speedbar-change-expand-button-char ?-)
3285 (speedbar-with-writable
3287 (end-of-line) (forward-char 1)
3288 (speedbar-insert-generic-list indent
3289 lst 'speedbar-tag-expand
3290 'speedbar-tag-find))))))
3291 ((string-match "-" text) ;we have to contract this node
3292 (speedbar-change-expand-button-char ?+)
3293 (speedbar-delete-subblock indent))
3294 (t (error "Ooops... not sure what to do")))
3295 (speedbar-center-buffer-smartly))
3297 (defun speedbar-tag-find (text token indent)
3298 "For the tag TEXT in a file TOKEN, goto that position.
3299 INDENT is the current indentation level."
3300 (let ((file (speedbar-line-path indent)))
3301 (speedbar-find-file-in-frame file)
3302 (save-excursion (speedbar-stealthy-updates))
3303 ;; Reset the timer with a new timeout when cliking a file
3304 ;; in case the user was navigating directories, we can cancel
3305 ;; that other timer.
3306 (speedbar-set-timer speedbar-update-speed)
3308 (run-hooks 'speedbar-visiting-tag-hook)
3310 (speedbar-maybee-jump-to-attached-frame)
3313 (defun speedbar-tag-expand (text token indent)
3314 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3315 Etags does not support this feature. TEXT will be the button
3316 string. TOKEN will be the list, and INDENT is the current indentation
3318 (cond ((string-match "+" text) ;we have to expand this file
3319 (speedbar-change-expand-button-char ?-)
3320 (speedbar-with-writable
3322 (end-of-line) (forward-char 1)
3323 (speedbar-insert-generic-list indent token 'speedbar-tag-expand
3324 'speedbar-tag-find))))
3325 ((string-match "-" text) ;we have to contract this node
3326 (speedbar-change-expand-button-char ?+)
3327 (speedbar-delete-subblock indent))
3328 (t (error "Ooops... not sure what to do")))
3329 (speedbar-center-buffer-smartly))
3331 ;;; Loading files into the attached frame.
3333 (defun speedbar-find-file-in-frame (file)
3334 "This will load FILE into the speedbar attached frame.
3335 If the file is being displayed in a different frame already, then raise that
3337 (let* ((buff (find-file-noselect file))
3338 (bwin (get-buffer-window buff 0)))
3341 (select-window bwin)
3342 (raise-frame (window-frame bwin)))
3343 (if speedbar-power-click
3344 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3345 (select-frame speedbar-attached-frame)
3346 (switch-to-buffer buff))))
3349 ;;; Centering Utility
3351 (defun speedbar-center-buffer-smartly ()
3352 "Recenter a speedbar buffer so the current indentation level is all visible.
3353 This assumes that the cursor is on a file, or tag of a file which the user is
3355 (if (<= (count-lines (point-min) (point-max))
3356 (1- (window-height (selected-window))))
3357 ;; whole buffer fits
3359 (goto-char (point-min))
3363 (let (depth start end exp p)
3366 (setq depth (if (looking-at "[0-9]+")
3367 (string-to-int (buffer-substring-no-properties
3368 (match-beginning 0) (match-end 0)))
3370 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3373 (if (re-search-backward exp nil t)
3374 (setq start (point))
3375 (setq start (point-min)))
3376 (save-excursion ;Not sure about this part.
3379 (while (and (not (re-search-forward exp nil t))
3381 (setq depth (1- depth))
3382 (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
3385 (setq end (point-max)))))
3386 ;; Now work out the details of centering
3387 (let ((nl (count-lines start end))
3389 (if (> nl (window-height (selected-window)))
3390 ;; We can't fit it all, so just center on cursor
3391 (progn (goto-char start)
3393 ;; we can fit everything on the screen, but...
3394 (if (and (pos-visible-in-window-p start (selected-window))
3395 (pos-visible-in-window-p end (selected-window)))
3398 ;; we need to do something...
3400 (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
3401 (lte (count-lines start (point-max))))
3402 (if (and (< (+ newcent lte) (window-height (selected-window)))
3403 (> (- (window-height (selected-window)) lte 1)
3405 (setq newcent (- (window-height (selected-window))
3407 (recenter newcent))))
3411 ;;; Tag Management -- Imenu
3413 (if (not speedbar-use-imenu-flag)
3417 (eval-when-compile (if (locate-library "imenu") (require 'imenu)))
3419 (defun speedbar-fetch-dynamic-imenu (file)
3420 "Load FILE into a buffer, and generate tags using Imenu.
3421 Returns the tag list, or t for an error."
3422 ;; Load this AND compile it in
3425 (set-buffer (find-file-noselect file))
3426 (if speedbar-power-click (setq imenu--index-alist nil))
3428 (let ((index-alist (imenu--make-index-alist t)))
3429 (if speedbar-sort-tags
3430 (sort (copy-alist index-alist)
3431 (lambda (a b) (string< (car a) (car b))))
3436 ;;; Tag Management -- etags (old XEmacs compatibility part)
3438 (defvar speedbar-fetch-etags-parse-list
3439 '(;; Note that java has the same parse-group as c
3440 ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\)\\'" .
3441 speedbar-parse-c-or-c++tag)
3442 ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
3443 "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
3444 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3445 ; speedbar-parse-fortran77-tag)
3446 ("\\.tex\\'" . speedbar-parse-tex-string)
3448 "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?")
3450 "Associations of file extensions and expressions for extracting tags.
3451 To add a new file type, you would want to add a new association to the
3452 list, where the car is the file match, and the cdr is the way to
3453 extract an element from the tags output. If the output is complex,
3454 use a function symbol instead of regexp. The function should expect
3455 to be at the beginning of a line in the etags buffer.
3457 This variable is ignored if `speedbar-use-imenu-flag' is non-nil.")
3459 (defvar speedbar-fetch-etags-command "etags"
3460 "*Command used to create an etags file.
3462 This variable is ignored if `speedbar-use-imenu-flag' is t")
3464 (defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-")
3465 "*List of arguments to use with `speedbar-fetch-etags-command'.
3466 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3467 modify this list conveniently.
3469 This variable is ignored if `speedbar-use-imenu-flag' is t")
3471 (defun speedbar-toggle-etags (flag)
3472 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3473 FLAG then becomes a member of etags command line arguments. If flag
3474 is \"sort\", then toggle the value of `speedbar-sort-tags'. If its
3475 value is \"show\" then toggle the value of
3476 `speedbar-show-unknown-files'.
3478 This function is a convenience function for XEmacs menu created by
3479 Farzin Guilak <farzin@protocol.com>"
3482 ((equal flag "sort")
3483 (setq speedbar-sort-tags (not speedbar-sort-tags)))
3484 ((equal flag "show")
3485 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files)))
3486 ((or (equal flag "-C")
3489 (if (member flag speedbar-fetch-etags-arguments)
3490 (setq speedbar-fetch-etags-arguments
3491 (delete flag speedbar-fetch-etags-arguments))
3492 (add-to-list 'speedbar-fetch-etags-arguments flag)))
3495 (defun speedbar-fetch-dynamic-etags (file)
3496 "For FILE, run etags and create a list of symbols extracted.
3497 Each symbol will be associated with its line position in FILE."
3498 (let ((newlist nil))
3501 (if (get-buffer "*etags tmp*")
3502 (kill-buffer "*etags tmp*")) ;kill to clean it up
3503 (if (<= 1 speedbar-verbosity-level) (message "Fetching etags..."))
3504 (set-buffer (get-buffer-create "*etags tmp*"))
3505 (apply 'call-process speedbar-fetch-etags-command nil
3506 (current-buffer) nil
3507 (append speedbar-fetch-etags-arguments (list file)))
3508 (goto-char (point-min))
3509 (if (<= 1 speedbar-verbosity-level) (message "Fetching etags..."))
3511 (let ((exprlst speedbar-fetch-etags-parse-list)
3513 (while (and (not ans) exprlst)
3514 (if (string-match (car (car exprlst)) file)
3515 (setq ans (car exprlst)))
3516 (setq exprlst (cdr exprlst)))
3520 (while (not (save-excursion (end-of-line) (eobp)))
3522 (setq tnl (speedbar-extract-one-symbol expr)))
3523 (if tnl (setq newlist (cons tnl newlist)))
3525 (message "Sorry, no support for a file of that extension"))))
3527 (if speedbar-sort-tags
3528 (sort newlist (lambda (a b) (string< (car a) (car b))))
3529 (reverse newlist))))
3531 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3532 ;; sure it's needed with the different sorting method.
3534 ;(defun speedbar-clean-etags()
3535 ; "Removes spaces before the ^? character, and removes `#define',
3536 ;return types, etc. preceding tags. This ensures that the sort operation
3537 ;works on the tags, not the return types."
3539 ; (goto-char (point-min))
3541 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3542 ; (replace-match "\C-?" nil nil))
3543 ; (goto-char (point-min))
3545 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3546 ; (delete-region (match-beginning 1) (match-end 1)))))
3548 (defun speedbar-extract-one-symbol (expr)
3549 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3550 The line should contain output from etags. Parse the output using the
3551 regular expression EXPR"
3552 (let* ((sym (if (stringp expr)
3554 (re-search-forward expr (save-excursion
3557 (buffer-substring-no-properties (match-beginning 1)
3560 (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)"
3566 (1+ (string-to-int (buffer-substring-no-properties
3574 (defun speedbar-parse-c-or-c++tag ()
3575 "Parse a c or c++ tag, which tends to be a little complex."
3577 (let ((bound (save-excursion (end-of-line) (point))))
3578 (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t)
3579 (buffer-substring-no-properties (match-beginning 1)
3581 ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t)
3582 (buffer-substring-no-properties (match-beginning 1)
3584 ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t)
3585 (buffer-substring-no-properties (match-beginning 1)
3590 (defun speedbar-parse-tex-string ()
3591 "Parse a Tex string. Only find data which is relevant."
3593 (let ((bound (save-excursion (end-of-line) (point))))
3594 (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t)
3595 (buffer-substring-no-properties (match-beginning 0)
3600 ;;; BUFFER DISPLAY mode.
3602 (defvar speedbar-buffers-key-map nil
3603 "Keymap used when in the buffers display mode.")
3605 (if speedbar-buffers-key-map
3607 (setq speedbar-buffers-key-map (speedbar-make-specialized-keymap))
3609 ;; Basic tree features
3610 (define-key speedbar-buffers-key-map "e" 'speedbar-edit-line)
3611 (define-key speedbar-buffers-key-map "\C-m" 'speedbar-edit-line)
3612 (define-key speedbar-buffers-key-map "+" 'speedbar-expand-line)
3613 (define-key speedbar-buffers-key-map "-" 'speedbar-contract-line)
3615 ;; Buffer specific keybindings
3616 (define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer)
3617 (define-key speedbar-buffers-key-map "r" 'speedbar-buffer-revert-buffer)
3621 (defvar speedbar-buffer-easymenu-definition
3622 '(["Jump to buffer" speedbar-edit-line t]
3623 ["Expand File Tags" speedbar-expand-line
3624 (save-excursion (beginning-of-line)
3625 (looking-at "[0-9]+: *.\\+. "))]
3626 ["Contract File Tags" speedbar-contract-line
3627 (save-excursion (beginning-of-line)
3628 (looking-at "[0-9]+: *.-. "))]
3630 "Menu item elements shown when displaying a buffer list.")
3632 (defun speedbar-buffer-buttons (directory zero)
3633 "Create speedbar buttons based on the buffers currently loaded.
3634 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3635 (speedbar-buffer-buttons-engine nil))
3637 (defun speedbar-buffer-buttons-temp (directory zero)
3638 "Create speedbar buttons based on the buffers currently loaded.
3639 DIRECTORY is the path to the currently active buffer, and ZERO is 0."
3640 (speedbar-buffer-buttons-engine t))
3642 (defun speedbar-buffer-buttons-engine (temp)
3643 "Create speedbar buffer buttons.
3644 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3645 (insert "Active Buffers:\n")
3646 (let ((bl (buffer-list)))
3648 (if (string-match "^[ *]" (buffer-name (car bl)))
3650 (let* ((known (string-match speedbar-file-regexp
3651 (buffer-name (car bl))))
3652 (expchar (if known ?+ ??))
3653 (fn (if known 'speedbar-tag-file nil))
3654 (fname (save-excursion (set-buffer (car bl))
3655 (buffer-file-name))))
3656 (speedbar-make-tag-line 'bracket expchar fn fname
3657 (buffer-name (car bl))
3658 'speedbar-buffer-click temp
3659 'speedbar-file-face 0)))
3661 (setq bl (buffer-list))
3662 (insert "Scratch Buffers:\n")
3664 (if (not (string-match "^\\*" (buffer-name (car bl))))
3666 (if (eq (car bl) speedbar-buffer)
3668 (speedbar-make-tag-line 'bracket ?? nil nil
3669 (buffer-name (car bl))
3670 'speedbar-buffer-click temp
3671 'speedbar-file-face 0)))
3673 (setq bl (buffer-list))
3674 (insert "Hidden Buffers:\n")
3676 (if (not (string-match "^ " (buffer-name (car bl))))
3678 (if (eq (car bl) speedbar-buffer)
3680 (speedbar-make-tag-line 'bracket ?? nil nil
3681 (buffer-name (car bl))
3682 'speedbar-buffer-click temp
3683 'speedbar-file-face 0)))
3684 (setq bl (cdr bl)))))
3686 (defun speedbar-buffer-click (text token indent)
3687 "When the users clicks on a buffer-button in speedbar.
3688 TEXT is the buffer's name, TOKEN and INDENT are unused."
3689 (if speedbar-power-click
3690 (let ((pop-up-frames t)) (select-window (display-buffer text)))
3691 (select-frame speedbar-attached-frame)
3692 (switch-to-buffer text)
3693 (if token (speedbar-change-initial-expansion-list
3694 speedbar-previously-used-expansion-list-name))))
3696 (defun speedbar-buffer-kill-buffer ()
3697 "Kill the buffer the cursor is on in the speedbar buffer."
3701 ;; If this fails, then it is a non-standard click, and as such,
3702 ;; perfectly allowed.
3703 (if (re-search-forward "[]>?}] [^ ]"
3704 (save-excursion (end-of-line) (point))
3708 (buffer-substring (point) (save-excursion
3711 (if (and (get-buffer text)
3712 (y-or-n-p (format "Kill buffer %s? " text)))
3714 (speedbar-refresh))))))
3716 (defun speedbar-buffer-revert-buffer ()
3717 "Revert the buffer the cursor is on in the speedbar buffer."
3721 ;; If this fails, then it is a non-standard click, and as such,
3722 ;; perfectly allowed
3723 (if (re-search-forward "[]>?}] [^ ]"
3724 (save-excursion (end-of-line) (point))
3728 (buffer-substring (point) (save-excursion
3731 (if (get-buffer text)
3734 (revert-buffer t)))))))
3738 ;;; Color loading section This is messy *Blech!*
3740 (defface speedbar-button-face '((((class color) (background light))
3741 (:foreground "green4"))
3742 (((class color) (background dark))
3743 (:foreground "green3")))
3744 "Face used for +/- buttons."
3745 :group 'speedbar-faces)
3747 (defface speedbar-file-face '((((class color) (background light))
3748 (:foreground "cyan4"))
3749 (((class color) (background dark))
3750 (:foreground "cyan"))
3752 "Face used for file names."
3753 :group 'speedbar-faces)
3755 (defface speedbar-directory-face '((((class color) (background light))
3756 (:foreground "blue4"))
3757 (((class color) (background dark))
3758 (:foreground "light blue")))
3759 "Faced used for directory names."
3760 :group 'speedbar-faces)
3761 (defface speedbar-tag-face '((((class color) (background light))
3762 (:foreground "brown"))
3763 (((class color) (background dark))
3764 (:foreground "yellow")))
3765 "Face used for displaying tags."
3766 :group 'speedbar-faces)
3768 (defface speedbar-selected-face '((((class color) (background light))
3769 (:foreground "red" :underline t))
3770 (((class color) (background dark))
3771 (:foreground "red" :underline t))
3773 "Face used to underline the file in the active window."
3774 :group 'speedbar-faces)
3776 (defface speedbar-highlight-face '((((class color) (background light))
3777 (:background "green"))
3778 (((class color) (background dark))
3779 (:background "sea green"))
3780 (((class grayscale monochrome)
3782 (:background "black"))
3783 (((class grayscale monochrome)
3785 (:background "white")))
3786 "Face used for highlighting buttons with the mouse."
3787 :group 'speedbar-faces)
3789 ;; some edebug hooks
3790 (add-hook 'edebug-setup-hook
3792 (def-edebug-spec speedbar-with-writable def-body)))
3795 ;;; speedbar ends here
3797 ;; run load-time hooks
3798 (run-hooks 'speedbar-load-hook)