1 ;;; speedbar --- quick access to files and tags in a frame
3 ;; Copyright (C) 1996-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Keywords: file, tags, tools
9 (defvar speedbar-version "1.0"
10 "The current version of speedbar.")
11 (defvar speedbar-incompatible-version "0.14beta4"
12 "This version of speedbar is incompatible with this version.
13 Due to massive API changes (removing the use of the word PATH)
14 this version is not backward compatible to 0.14 or earlier.")
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 ;; The speedbar provides a frame in which files, and locations in
34 ;; files are displayed. These items can be clicked on with mouse-2 in
35 ;; to display that file location.
37 ;;; Customizing and Developing for speedbar
39 ;; Please see the speedbar manual for informaion.
43 ;; Users of really old emacsen without the need timer functions
44 ;; will not have speedbar updating automatically. Use "g" to refresh
45 ;; the display after changing directories. Remember, do not interrupt
46 ;; the stealthy updates or your display may not be completely
49 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
50 ;; well. Use the imenu keywords from tex-mode.el for better results.
52 ;; This file requires the library package assoc (association lists)
53 ;; assoc should be available in all modern versions of Emacs.
54 ;; The custom package is optional (for easy configuration of speedbar)
55 ;; http://www.dina.kvl.dk/~abraham/custom/
56 ;; custom is available in all versions of Emacs version 20 or better.
58 ;;; Developing for speedbar
60 ;; Adding a speedbar specialized display mode:
62 ;; Speedbar can be configured to create a special display for certain
63 ;; modes that do not display traditional file/tag data. Rmail, Info,
64 ;; and the debugger are examples. These modes can, however, benefit
65 ;; from a speedbar style display in their own way.
67 ;; If your `major-mode' is `foo-mode', the only requirement is to
68 ;; create a function called `foo-speedbar-buttons' which takes one
69 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
70 ;; In `foo-speedbar-buttons' there are several functions that make
71 ;; building a speedbar display easy. See the documentation for
72 ;; `speedbar-with-writable' (needed because the buffer is usually
73 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
74 ;; `speedbar-insert-generic-list'. If you use
75 ;; `speedbar-insert-generic-list', also read the doc for
76 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
77 ;; The macro `speedbar-with-attached-buffer' brings you back to the
78 ;; buffer speedbar is displaying for.
80 ;; For those functions that make buttons, the "function" should be a
81 ;; symbol that is the function to call when clicked on. The "token"
82 ;; is extra data you can pass along. The "function" must take three
83 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
84 ;; button clicked on. TOKEN is the data passed in when you create the
85 ;; button. INDENT is an indentation level, or 0. You can store
86 ;; indentation levels with `speedbar-make-tag-line' which creates a
87 ;; line with an expander (eg. [+]) and a text button.
89 ;; Some useful functions when writing expand functions, and click
90 ;; functions are `speedbar-change-expand-button-char',
91 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
92 ;; The variable `speedbar-power-click' is set to t in your functions
93 ;; when the user shift-clicks. This is an indication of anything from
94 ;; refreshing cached data to making a buffer appear in a new frame.
96 ;; If you wish to add to the default speedbar menu for the case of
97 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
98 ;; should be a list compatible with the `easymenu' package. It will
99 ;; be spliced into the main menu. (Available with click-mouse-3). If
100 ;; you wish to have extra key bindings in your special mode, create a
101 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
102 ;; or `make-sparse-keymap', use the function
103 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
104 ;; speedbar's default bindings with low overhead.
106 ;; Adding a speedbar top-level display mode:
108 ;; Unlike the specialized modes, there are no name requirements,
109 ;; however the methods for writing a button display, menu, and keymap
110 ;; are the same. Once you create these items, you can call the
111 ;; function `speedbar-add-expansion-list'. It takes one parameter
112 ;; which is a list element of the form (NAME MENU KEYMAP &rest
113 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
114 ;; Displays menu item. MENU is a symbol containing the menu items to
115 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
116 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
118 ;; Another tweakable variable is `speedbar-stealthy-function-list'
119 ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
120 ;; name matching `speedbar-add-expansion-list'. (It does not need to
121 ;; exist.). This provides additional display info which might be
122 ;; time-consuming to calculate.
123 ;; Lastly, `speedbar-mode-functions-list' allows you to set special
124 ;; function overrides.
127 ;; - Timeout directories we haven't visited in a while.
134 ;; customization stuff
135 (defgroup speedbar nil
136 "File and tag browser frame."
143 (defgroup speedbar-faces nil
144 "Faces used in speedbar."
149 (defgroup speedbar-vc nil
150 "Version control display in speedbar."
156 ;; Note: `inversion-test' requires parts of the CEDET package that are
157 ;; not included with Emacs.
159 ;; (defun speedbar-require-version (major minor &optional beta)
160 ;; "Non-nil if this version of SPEEDBAR does not satisfy a specific version.
163 ;; (MAJOR MINOR &optional BETA)
165 ;; Values MAJOR and MINOR must be integers. BETA can be an integer, or
166 ;; excluded if a released version is required.
168 ;; It is assumed that if the current version is newer than that specified,
169 ;; everything passes. Exceptions occur when known incompatibilities are
171 ;; (inversion-test 'speedbar
172 ;; (concat major "." minor
173 ;; (when beta (concat "beta" beta)))))
175 (defvar speedbar-initial-expansion-mode-alist
176 '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
177 speedbar-buffer-buttons)
178 ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
179 speedbar-buffer-buttons-temp)
180 ;; Files last, means first in the Displays menu
181 ("files" speedbar-easymenu-definition-special speedbar-file-key-map
182 speedbar-directory-buttons speedbar-default-directory-list)
184 "List of named expansion elements for filling the speedbar frame.
185 These expansion lists are only valid for regular files. Special modes
186 still get to override this list on a mode-by-mode basis. This list of
187 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
188 representing the types of things to be displayed. MENU is an easymenu
189 structure used when in this mode. KEYMAP is a local keymap to install
190 over the regular speedbar keymap. FN1 ... are functions that will be
191 called in order. These functions will always get the default
192 directory to use passed in as the first parameter, and a 0 as the
193 second parameter. The 0 indicates the uppermost indentation level.
194 They must assume that the cursor is at the position where they start
197 (defvar speedbar-initial-expansion-list-name "files"
198 "A symbol name representing the expansion list to use.
199 The expansion list `speedbar-initial-expansion-mode-alist' contains
200 the names and associated functions to use for buttons in speedbar.")
202 (defvar speedbar-previously-used-expansion-list-name "files"
203 "Save the last expansion list method.
204 This is used for returning to a previous expansion list method when
205 the user is done with the current expansion list.")
207 (defvar speedbar-stealthy-function-list
209 speedbar-update-current-file
210 speedbar-check-read-only
212 speedbar-check-objects)
214 "List of functions to periodically call stealthily.
215 This list is of the form:
216 '( (\"NAME\" FUNCTION ...)
218 where NAME is the name of the major display mode these functions are
219 for, and the remaining elements FUNCTION are functions to call in order.
220 Each function must return nil if interrupted, or t if completed.
221 Stealthy functions which have a single operation should always return t.
222 Functions which take a long time should maintain a state (where they
223 are in their speedbar related calculations) and permit interruption.
224 See `speedbar-check-vc' as a good example.")
226 (defvar speedbar-mode-functions-list
227 '(("files" (speedbar-item-info . speedbar-files-item-info)
228 (speedbar-line-directory . speedbar-files-line-directory))
229 ("buffers" (speedbar-item-info . speedbar-buffers-item-info)
230 (speedbar-line-directory . speedbar-buffers-line-directory))
231 ("quick buffers" (speedbar-item-info . speedbar-buffers-item-info)
232 (speedbar-line-directory . speedbar-buffers-line-directory))
234 "List of function tables to use for different major display modes.
235 It is not necessary to define any functions for a specialized mode.
236 This just provides a simple way of adding lots of customizations.
237 Each sublist is of the form:
238 (\"NAME\" (FUNCTIONSYMBOL . REPLACEMENTFUNCTION) ...)
239 Where NAME is the name of the specialized mode. The rest of the list
240 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
241 of a function you would like to replace, and REPLACEMENTFUNCTION,
242 which is a function you can call instead. Not all functions can be
243 replaced this way. Replaceable functions must provide that
244 functionality individually.")
246 (defcustom speedbar-mode-specific-contents-flag t
247 "Non-nil means speedbar will show special mode contents.
248 This permits some modes to create customized contents for the speedbar
253 (defcustom speedbar-query-confirmation-method 'all
254 "Query control for file operations.
255 The 'always flag means to always query before file operations.
256 The 'none-but-delete flag means to not query before any file
257 operations, except before a file deletion."
259 :type '(radio (const :tag "Always Query before some file operations."
261 (const :tag "Never Query before file operations, except for deletions."
263 ;;;; (const :tag "Never Every Query."
267 (defvar speedbar-special-mode-expansion-list nil
268 "Default function list for creating specialized button lists.
269 This list is set by modes that wish to have special speedbar displays.
270 The list is of function names. Each function is called with one
271 parameter BUFFER, the originating buffer. The current buffer is the
274 (defvar speedbar-special-mode-key-map nil
275 "Default keymap used when identifying a specialized display mode.
276 This keymap is local to each buffer that wants to define special keybindings
277 effective when its display is shown.")
279 (defcustom speedbar-before-visiting-file-hook '(push-mark)
280 "Hooks run before speedbar visits a file in the selected frame.
281 The default buffer is the buffer in the selected window in the attached frame."
285 (defcustom speedbar-visiting-file-hook nil
286 "Hooks run when speedbar visits a file in the selected frame."
290 (defcustom speedbar-before-visiting-tag-hook '(push-mark)
291 "Hooks run before speedbar visits a tag in the selected frame.
292 The default buffer is the buffer in the selected window in the attached frame."
296 (defcustom speedbar-visiting-tag-hook '(speedbar-highlight-one-tag-line)
297 "Hooks run when speedbar visits a tag in the selected frame."
300 :options '(speedbar-highlight-one-tag-line
301 speedbar-recenter-to-top
305 (defcustom speedbar-load-hook nil
306 "Hooks run when speedbar is loaded."
310 (defcustom speedbar-reconfigure-keymaps-hook nil
311 "Hooks run when the keymaps are regenerated."
315 (defcustom speedbar-show-unknown-files nil
316 "Non-nil show files we can't expand with a ? in the expand button.
317 A nil value means don't show the file in the list."
321 ;;; EVENTUALLY REMOVE THESE
323 ;; When I moved to a repeating timer, I had the horrible misfortune
324 ;; of losing the ability for adaptive speed choice. This update
325 ;; speed currently causes long delays when it should have been turned off.
326 (defvar speedbar-update-speed dframe-update-speed)
327 (make-obsolete-variable 'speedbar-update-speed
329 "speedbar 1.0pre3 (Emacs 23.1)")
331 (defvar speedbar-navigating-speed dframe-update-speed)
332 (make-obsolete-variable 'speedbar-navigating-speed
334 "speedbar 1.0pre3 (Emacs 23.1)")
337 (defcustom speedbar-frame-parameters '((minibuffer . nil)
345 "Parameters to use when creating the speedbar frame in Emacs.
346 Any parameter supported by a frame may be added. The parameter `height'
347 will be initialized to the height of the frame speedbar is
348 attached to and added to this list before the new frame is initialized."
350 :type '(repeat (cons :format "%v"
351 (symbol :tag "Parameter")
352 (sexp :tag "Value"))))
354 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
355 (defcustom speedbar-frame-plist
356 '(minibuffer nil width 20 border-width 0
357 internal-border-width 0 unsplittable t
358 default-toolbar-visible-p nil has-modeline-p nil
359 menubar-visible-p nil
360 default-gutter-visible-p nil
362 "Parameters to use when creating the speedbar frame in XEmacs.
363 Parameters not listed here which will be added automatically are
364 `height' which will be initialized to the height of the frame speedbar
367 :type '(repeat (group :inline t
368 (symbol :tag "Property")
369 (sexp :tag "Value"))))
371 (defcustom speedbar-use-imenu-flag (fboundp 'imenu)
372 "Non-nil means use imenu for file parsing, nil to use etags.
373 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
374 use etags instead. Etags support is not as robust as imenu support."
375 :tag "Use Imenu for tags"
379 (defvar speedbar-dynamic-tags-function-list
380 '((speedbar-fetch-dynamic-imenu . speedbar-insert-imenu-list)
381 (speedbar-fetch-dynamic-etags . speedbar-insert-etags-list))
382 "Set to a list of functions which will return and insert a list of tags.
383 Each element is of the form ( FETCH . INSERT ) where FETCH
384 is a function which takes one parameter (the file to tag) and returns a
385 list of tags. The tag list can be of any form as long as the
386 corresponding insert method can handle it. If it returns t, then an
387 error occurred, and the next fetch routine is tried.
388 INSERT is a function which takes an INDENTation level, and a LIST of
389 tags to insert. It will then create the speedbar buttons.")
391 (defcustom speedbar-use-tool-tips-flag (fboundp 'tooltip-mode)
392 "Non-nil means to use tool tips if they are available.
393 When tooltips are not available, mouse-tracking and minibuffer
394 display is used instead."
398 (defcustom speedbar-track-mouse-flag (not speedbar-use-tool-tips-flag)
399 "Non-nil means to display info about the line under the mouse."
403 (defcustom speedbar-default-position 'left-right
404 "Default position of the speedbar frame.
405 Possible values are 'left, 'right or 'left-right.
406 If value is 'left-right, the most suitable location is
407 determined automatically."
409 :type '(radio (const :tag "Automatic" left-right)
410 (const :tag "Left" left)
411 (const :tag "Right" right)))
413 (defcustom speedbar-sort-tags nil
414 "If non-nil, sort tags in the speedbar display. *Obsolete*.
415 Use `semantic-tag-hierarchy-method' instead."
419 (defcustom speedbar-tag-hierarchy-method
420 '(speedbar-prefix-group-tag-hierarchy
421 speedbar-trim-words-tag-hierarchy)
422 "List of hooks which speedbar will use to organize tags into groups.
423 Groups are defined as expandable meta-tags. Imenu supports
424 such things in some languages, such as separating variables from
425 functions. Each hook takes one argument LST, and may destructively
426 create a new list of the same form. LST is a list of elements of the
429 where each ELT is of the form
430 (TAG-NAME-STRING . NUMBER-OR-MARKER)
432 (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
435 :options '(speedbar-prefix-group-tag-hierarchy
436 speedbar-trim-words-tag-hierarchy
437 speedbar-simple-group-tag-hierarchy
438 speedbar-sort-tag-hierarchy)
441 (defcustom speedbar-tag-group-name-minimum-length 4
442 "The minimum length of a prefix group name before expanding.
443 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
444 and one such groups common characters is less than this number of
445 characters, then the group name will be changed to the form of:
449 This way we won't get silly looking listings."
453 (defcustom speedbar-tag-split-minimum-length 20
454 "Minimum length before we stop trying to create sub-lists in tags.
455 This is used by all tag-hierarchy methods that break large lists into
460 (defcustom speedbar-tag-regroup-maximum-length 10
461 "Maximum length of submenus that are regrouped.
462 If the regrouping option is used, then if two or more short subgroups
463 are next to each other, then they are combined until this number of
468 (defcustom speedbar-directory-button-trim-method 'span
469 "Indicates how the directory button will be displayed.
471 'span - span large directories over multiple lines.
472 'trim - trim large directories to only show the last few.
475 :type '(radio (const :tag "Span large directories over mutiple lines."
477 (const :tag "Trim large directories to only show the last few."
479 (const :tag "No trimming." nil)))
481 (defcustom speedbar-smart-directory-expand-flag t
482 "Non-nil means speedbar should use smart expansion.
483 Smart expansion only affects when speedbar wants to display a
484 directory for a file in the attached frame. When smart expansion is
485 enabled, new directories which are children of a displayed directory
486 are expanded in the current framework. If nil, then the current
487 hierarchy would be replaced with the new directory."
491 (defcustom speedbar-indentation-width 1
492 "When sub-nodes are expanded, the number of spaces used for indentation."
496 (defcustom speedbar-hide-button-brackets-flag nil
497 "Non-nil means speedbar will hide the brackets around the + or -."
501 (defcustom speedbar-before-popup-hook nil
502 "Hooks called before popping up the speedbar frame."
506 (defcustom speedbar-after-create-hook '(speedbar-frame-reposition-smartly)
507 "Hooks called after popping up the speedbar frame."
511 (defcustom speedbar-before-delete-hook nil
512 "Hooks called before deleting the speedbar frame."
516 (defcustom speedbar-mode-hook nil
517 "Hook run after creating a speedbar buffer."
521 (defcustom speedbar-timer-hook nil
522 "Hooks called after running the speedbar timer function."
526 (defcustom speedbar-verbosity-level 1
527 "Verbosity level of the speedbar.
529 1 means medium level verbosity.
530 2 and higher are higher levels of verbosity."
534 (defvar speedbar-indicator-separator " "
535 "String separating file text from indicator characters.")
537 (defcustom speedbar-vc-do-check t
538 "Non-nil check all files in speedbar to see if they have been checked out.
539 Any file checked out is marked with `speedbar-vc-indicator'."
543 (defvar speedbar-vc-indicator "*"
544 "Text used to mark files which are currently checked out.
545 Other version control systems can be added by examining the function
546 `speedbar-vc-directory-enable-hook' and `speedbar-vc-in-control-hook'.")
548 (defcustom speedbar-vc-directory-enable-hook nil
549 "Return non-nil if the current directory should be checked for Version Control.
550 Functions in this hook must accept one parameter which is the directory
555 (defcustom speedbar-vc-in-control-hook nil
556 "Return non-nil if the specified file is under Version Control.
557 Functions in this hook must accept two parameters. The DIRECTORY of the
558 current file, and the FILENAME of the file being checked."
562 (defvar speedbar-vc-to-do-point nil
563 "Local variable maintaining the current version control check position.")
565 (defcustom speedbar-obj-do-check t
566 "Non-nil check all files in speedbar to see if they have an object file.
567 Any file checked out is marked with `speedbar-obj-indicator', and the
568 marking is based on `speedbar-obj-alist'"
572 (defvar speedbar-obj-to-do-point nil
573 "Local variable maintaining the current version control check position.")
575 (defvar speedbar-obj-indicator '("#" . "!")
576 "Text used to mark files that have a corresponding hidden object file.
577 The car is for an up-to-date object. The cdr is for an out of date object.
578 The expression `speedbar-obj-alist' defines who gets tagged.")
580 (defvar speedbar-obj-alist
581 '(("\\.\\([cpC]\\|cpp\\|cc\\|cxx\\)$" . ".o")
583 ("\\.java$" . ".class")
584 ("\\.f\\(or\\|90\\|77\\)?$" . ".o")
586 ("\\.texi$" . ".info"))
587 "Alist of file extensions, and their corresponding object file type.")
589 (defvar speedbar-ro-to-do-point nil
590 "Local variable maintaining the current read only check position.")
592 (defvar speedbar-object-read-only-indicator "%"
593 "Indicator to append onto a line if that item is Read Only.")
595 ;; Note: Look for addition place to add indicator lists that
596 ;; use skip-chars instead of a regular expression.
597 (defvar speedbar-indicator-regex
598 (concat (regexp-quote speedbar-indicator-separator)
600 (regexp-quote speedbar-vc-indicator)
602 (regexp-quote (car speedbar-obj-indicator))
604 (regexp-quote (cdr speedbar-obj-indicator))
606 (regexp-quote speedbar-object-read-only-indicator)
608 "Regular expression used when identifying files.
609 Permits stripping of indicator characters from a line.")
611 (defcustom speedbar-scanner-reset-hook nil
612 "Hook called whenever generic scanners are reset.
613 Set this to implement your own scanning / rescan safe functions with
618 (defvar speedbar-ignored-modes '(fundamental-mode)
619 "*List of major modes which speedbar will not switch directories for.")
621 (defun speedbar-extension-list-to-regex (extlist)
622 "Takes EXTLIST, a list of extensions and transforms it into regexp.
623 All the preceding `.' are stripped for an optimized expression starting
624 with `.' followed by extensions, followed by full-filenames."
625 (let ((regex1 nil) (regex2 nil))
627 (if (= (string-to-char (car extlist)) ?.)
628 (setq regex1 (concat regex1 (if regex1 "\\|" "")
629 (substring (car extlist) 1)))
630 (setq regex2 (concat regex2 (if regex2 "\\|" "") (car extlist))))
631 (setq extlist (cdr extlist)))
632 ;; concat all the sub-exressions together, making sure all types
633 ;; of parts exist during concatination.
635 (if regex1 (concat "\\(\\.\\(" regex1 "\\)\\)") "")
636 (if (and regex1 regex2) "\\|" "")
637 (if regex2 (concat "\\(" regex2 "\\)") "")
640 (defvar speedbar-ignored-directory-regexp nil
641 "Regular expression matching directories speedbar will not switch to.
642 Created from `speedbar-ignored-directory-expressions' with the function
643 `speedbar-extension-list-to-regex' (a misnamed function in this case.)
644 Use the function `speedbar-add-ignored-directory-regexp', or customize the
645 variable `speedbar-ignored-directory-expressions' to modify this variable.")
647 (define-obsolete-variable-alias 'speedbar-ignored-path-expressions
648 'speedbar-ignored-directory-expressions "22.1")
650 (defcustom speedbar-ignored-directory-expressions
651 '("[/\\]logs?[/\\]\\'")
652 "List of regular expressions matching directories speedbar will ignore.
653 They should included directories which are notoriously very large
654 and take a long time to load in. Use the function
655 `speedbar-add-ignored-directory-regexp' to add new items to this list after
656 speedbar is loaded. You may place anything you like in this list
657 before speedbar has been loaded."
659 :type '(repeat (regexp :tag "Directory Regexp"))
660 :set (lambda (sym val)
661 (setq speedbar-ignored-directory-expressions val
662 speedbar-ignored-directory-regexp
663 (speedbar-extension-list-to-regex val))))
665 (defcustom speedbar-directory-unshown-regexp "^\\(\\..*\\)\\'"
666 "Regular expression matching directories not to show in speedbar.
667 They should include commonly existing directories which are not
668 useful. It is no longer necessary to include version-control
669 directories here; see `vc-directory-exclusion-list'."
673 (defvar speedbar-file-unshown-regexp
674 (let ((nstr "") (noext completion-ignored-extensions))
676 (setq nstr (concat nstr (regexp-quote (car noext)) "\\'"
677 (if (cdr noext) "\\|" ""))
679 ;; backup refdir lockfile
680 (concat nstr "\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
681 "*Regexp matching files we don't want displayed in a speedbar buffer.
682 It is generated from the variable `completion-ignored-extensions'.")
684 (defvar speedbar-file-regexp nil
685 "Regular expression matching files we know how to expand.
686 Created from `speedbar-supported-extension-expressions' with the
687 function `speedbar-extension-list-to-regex'.")
689 ;; this is dangerous to customize, because the defaults will probably
690 ;; change in the future.
691 (defcustom speedbar-supported-extension-expressions
692 (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
693 ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".js" ".f\\(90\\|77\\|or\\)?")
694 (if speedbar-use-imenu-flag
695 '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py" ".g"
696 ;; html is not supported by default, but an imenu tags package
697 ;; is available. Also, html files are nice to be able to see.
699 ".ma?k" "[Mm]akefile\\(\\.in\\)?")))
700 "List of regular expressions which will match files supported by tagging.
701 Do not prefix the `.' char with a double \\ to quote it, as the period
702 will be stripped by a simplified optimizer when compiled into a
703 singular expression. This variable will be turned into
704 `speedbar-file-regexp' for use with speedbar. You should use the
705 function `speedbar-add-supported-extension' to add a new extension at
706 runtime, or use the configuration dialog to set it in your .emacs file.
707 If you add an extension to this list, and it does not appear, you may
708 need to also modify `completion-ignored-extension' which will also help
711 :type '(repeat (regexp :tag "Extension Regexp"))
712 :set (lambda (sym val)
713 (set 'speedbar-supported-extension-expressions val)
714 (set 'speedbar-file-regexp (speedbar-extension-list-to-regex val))))
716 (setq speedbar-file-regexp
717 (speedbar-extension-list-to-regex speedbar-supported-extension-expressions))
719 (defun speedbar-add-supported-extension (extension)
720 "Add EXTENSION as a new supported extension for speedbar tagging.
721 This should start with a `.' if it is not a complete file name, and
722 the dot should NOT be quoted in with \\. Other regular expression
723 matchers are allowed however. EXTENSION may be a single string or a
725 (interactive "sExtension: ")
726 (if (not (listp extension)) (setq extension (list extension)))
728 (if (member (car extension) speedbar-supported-extension-expressions)
730 (setq speedbar-supported-extension-expressions
731 (cons (car extension) speedbar-supported-extension-expressions)))
732 (setq extension (cdr extension)))
733 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
734 speedbar-supported-extension-expressions)))
736 (defun speedbar-add-ignored-directory-regexp (directory-expression)
737 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
738 This function will modify `speedbar-ignored-directory-regexp' and add
739 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
740 (interactive "sDirectory regex: ")
741 (if (not (listp directory-expression))
742 (setq directory-expression (list directory-expression)))
743 (while directory-expression
744 (if (member (car directory-expression) speedbar-ignored-directory-expressions)
746 (setq speedbar-ignored-directory-expressions
747 (cons (car directory-expression) speedbar-ignored-directory-expressions)))
748 (setq directory-expression (cdr directory-expression)))
749 (setq speedbar-ignored-directory-regexp (speedbar-extension-list-to-regex
750 speedbar-ignored-directory-expressions)))
752 ;; If we don't have custom, then we set it here by hand.
753 (if (not (fboundp 'custom-declare-variable))
754 (setq speedbar-file-regexp (speedbar-extension-list-to-regex
755 speedbar-supported-extension-expressions)
756 speedbar-ignored-directory-regexp (speedbar-extension-list-to-regex
757 speedbar-ignored-directory-expressions)))
759 (defvar speedbar-update-flag dframe-have-timer-flag
760 "*Non-nil means to automatically update the display.
761 When this is nil then speedbar will not follow the attached frame's directory.
762 When speedbar is active, use:
764 \\<speedbar-key-map> `\\[speedbar-toggle-updates]'
766 to toggle this value.")
768 (defvar speedbar-update-flag-disable nil
769 "Permanently disable changing of the update flag.")
771 (defvar speedbar-mode-syntax-table
772 (let ((st (make-syntax-table)))
773 ;; Turn off paren matching around here.
774 (modify-syntax-entry ?\' " " st)
775 (modify-syntax-entry ?\" " " st)
776 (modify-syntax-entry ?\( " " st)
777 (modify-syntax-entry ?\) " " st)
778 (modify-syntax-entry ?\{ " " st)
779 (modify-syntax-entry ?\} " " st)
780 (modify-syntax-entry ?\[ " " st)
781 (modify-syntax-entry ?\] " " st)
783 "Syntax-table used on the speedbar.")
784 (define-obsolete-variable-alias
785 'speedbar-syntax-table 'speedbar-mode-syntax-table "24.1")
788 (defvar speedbar-mode-map
789 (let ((map (make-keymap)))
790 (suppress-keymap map t)
793 (define-key map "t" 'speedbar-toggle-updates)
794 (define-key map "g" 'speedbar-refresh)
797 (define-key map "n" 'speedbar-next)
798 (define-key map "p" 'speedbar-prev)
799 (define-key map "\M-n" 'speedbar-restricted-next)
800 (define-key map "\M-p" 'speedbar-restricted-prev)
801 (define-key map "\C-\M-n" 'speedbar-forward-list)
802 (define-key map "\C-\M-p" 'speedbar-backward-list)
803 ;; These commands never seemed useful.
804 ;; (define-key map " " 'speedbar-scroll-up)
805 ;; (define-key map [delete] 'speedbar-scroll-down)
807 ;; Short cuts I happen to find useful.
809 (lambda () (interactive)
810 (speedbar-change-initial-expansion-list
811 speedbar-previously-used-expansion-list-name)))
813 (lambda () (interactive)
814 (speedbar-change-initial-expansion-list "quick buffers")))
816 (lambda () (interactive)
817 (speedbar-change-initial-expansion-list "files")))
819 (dframe-update-keymap map)
821 "Keymap used in speedbar buffer.")
822 (define-obsolete-variable-alias 'speedbar-key-map 'speedbar-mode-map "24.1")
824 (defun speedbar-make-specialized-keymap ()
825 "Create a keymap for use with a speedbar major or minor display mode.
826 This basically creates a sparse keymap, and makes its parent be
827 `speedbar-mode-map'."
828 (let ((k (make-sparse-keymap)))
829 (set-keymap-parent k speedbar-mode-map)
832 (defvar speedbar-file-key-map
833 (let ((map (speedbar-make-specialized-keymap)))
835 ;; Basic tree features.
836 (define-key map "e" 'speedbar-edit-line)
837 (define-key map "\C-m" 'speedbar-edit-line)
838 (define-key map "+" 'speedbar-expand-line)
839 (define-key map "=" 'speedbar-expand-line)
840 (define-key map "-" 'speedbar-contract-line)
842 (define-key map "[" 'speedbar-expand-line-descendants)
843 (define-key map "]" 'speedbar-contract-line-descendants)
845 (define-key map " " 'speedbar-toggle-line-expansion)
847 ;; File based commands.
848 (define-key map "U" 'speedbar-up-directory)
849 (define-key map "I" 'speedbar-item-info)
850 (define-key map "B" 'speedbar-item-byte-compile)
851 (define-key map "L" 'speedbar-item-load)
852 (define-key map "C" 'speedbar-item-copy)
853 (define-key map "D" 'speedbar-item-delete)
854 (define-key map "O" 'speedbar-item-object-delete)
855 (define-key map "R" 'speedbar-item-rename)
856 (define-key map "M" 'speedbar-create-directory)
858 "Keymap used in speedbar buffer while files are displayed.")
860 (defvar speedbar-easymenu-definition-base
863 ["Update" speedbar-refresh t]
864 ["Auto Update" speedbar-toggle-updates
865 :active (not speedbar-update-flag-disable)
866 :style toggle :selected speedbar-update-flag])
867 (if (and (or (fboundp 'defimage)
868 (fboundp 'make-image-specifier))
869 (if (fboundp 'display-graphic-p)
873 ["Use Images" speedbar-toggle-images
874 :style toggle :selected speedbar-use-images]))
876 "Base part of the speedbar menu.")
878 (defvar speedbar-easymenu-definition-special
879 '(["Edit Item On Line" speedbar-edit-line t]
880 ["Show All Files" speedbar-toggle-show-all-files
881 :style toggle :selected speedbar-show-unknown-files]
882 ["Expand File Tags" speedbar-expand-line
883 (save-excursion (beginning-of-line)
884 (looking-at "[0-9]+: *.\\+. "))]
885 ["Flush Cache & Expand" speedbar-flush-expand-line
886 (save-excursion (beginning-of-line)
887 (looking-at "[0-9]+: *.\\+. "))]
888 ["Expand All Descendants" speedbar-expand-line-descendants
889 (save-excursion (beginning-of-line)
890 (looking-at "[0-9]+: *.\\+. ")) ]
891 ["Contract File Tags" speedbar-contract-line
892 (save-excursion (beginning-of-line)
893 (looking-at "[0-9]+: *.-. "))]
894 ; ["Sort Tags" speedbar-toggle-sorting
895 ; :style toggle :selected speedbar-sort-tags]
897 ["File/Tag Information" speedbar-item-info t]
898 ["Load Lisp File" speedbar-item-load
901 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
902 ["Byte Compile File" speedbar-item-byte-compile
905 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
906 ["Copy File" speedbar-item-copy
907 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
908 ["Rename File" speedbar-item-rename
909 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
910 ["Create Directory" speedbar-create-directory
911 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
912 ["Delete File" speedbar-item-delete
913 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
914 ["Delete Object" speedbar-item-object-delete
915 (save-excursion (beginning-of-line)
916 (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))]
918 "Additional menu items while in file-mode.")
920 (defvar speedbar-easymenu-definition-trailer
922 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
923 (list ["Customize..." speedbar-customize t]))
925 ["Close" dframe-close-frame t]
926 ["Quit" delete-frame t] ))
927 "Menu items appearing at the end of the speedbar menu.")
929 (defvar speedbar-desired-buffer nil
930 "Non-nil when speedbar is showing buttons specific to a special mode.
931 In this case it is the originating buffer.")
932 (defvar speedbar-buffer nil
933 "The buffer displaying the speedbar.")
934 (defvar speedbar-frame nil
935 "The frame displaying speedbar.")
936 (defvar speedbar-cached-frame nil
937 "The frame that was last created, then removed from the display.")
938 (defvar speedbar-full-text-cache nil
939 "The last open directory is saved in its entirety for ultra-fast switching.")
941 (defvar speedbar-last-selected-file nil
942 "The last file which was selected in speedbar buffer.")
944 (defvar speedbar-shown-directories nil
945 "Maintain list of directories simultaneously open in the current speedbar.")
947 (defvar speedbar-directory-contents-alist nil
948 "An association list of directories and their contents.
949 Each sublist was returned by `speedbar-file-lists'. This list is
950 maintained to speed up the refresh rate when switching between
953 (defvar speedbar-power-click nil
954 "Never set this by hand. Value is t when S-mouse activity occurs.")
959 (defalias 'speedbar-make-overlay
960 (if (featurep 'xemacs) 'make-extent 'make-overlay))
962 (defalias 'speedbar-overlay-put
963 (if (featurep 'xemacs) 'set-extent-property 'overlay-put))
965 (defalias 'speedbar-delete-overlay
966 (if (featurep 'xemacs) 'delete-extent 'delete-overlay))
968 (defalias 'speedbar-mode-line-update
969 (if (featurep 'xemacs) 'redraw-modeline 'force-mode-line-update))
971 ;;; Mode definitions/ user commands
975 (defalias 'speedbar 'speedbar-frame-mode)
977 (defun speedbar-frame-mode (&optional arg)
978 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
979 A nil ARG means toggle. Once the speedbar frame is activated, a buffer in
980 `speedbar-mode' will be displayed. Currently, only one speedbar is
982 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
983 `speedbar-before-delete-hook' is called before the frame is deleted."
985 ;; Get the buffer to play with
986 (if (not (buffer-live-p speedbar-buffer))
988 (setq speedbar-buffer (get-buffer-create " SPEEDBAR"))
989 (set-buffer speedbar-buffer)
991 ;; Do the frame thing
992 (dframe-frame-mode arg
994 'speedbar-cached-frame
997 #'speedbar-frame-mode
998 (if (featurep 'xemacs)
999 (append speedbar-frame-plist
1000 ;; This is a hack to get speedbar to iconfiy
1001 ;; with the selected frame.
1002 (list 'parent (selected-frame)))
1003 speedbar-frame-parameters)
1004 speedbar-before-delete-hook
1005 speedbar-before-popup-hook
1006 speedbar-after-create-hook)
1007 ;; Start up the timer
1008 (if (not speedbar-frame)
1009 (speedbar-set-timer nil)
1010 (speedbar-reconfigure-keymaps)
1011 (speedbar-update-contents)
1012 (speedbar-set-timer dframe-update-speed)
1014 ;; Frame modifications
1015 (set (make-local-variable 'dframe-delete-frame-function)
1016 'speedbar-handle-delete-frame)
1018 (set (make-local-variable 'automatic-hscrolling) nil) ; Emacs 21
1019 ;; reset the selection variable
1020 (setq speedbar-last-selected-file nil))
1022 (defun speedbar-frame-reposition-smartly ()
1023 "Reposition the speedbar frame to be next to the attached frame."
1024 (cond ((and (featurep 'xemacs)
1025 (or (member 'left speedbar-frame-plist)
1026 (member 'top speedbar-frame-plist)))
1027 (dframe-reposition-frame
1029 (dframe-attached-frame speedbar-frame)
1030 (cons (car (cdr (member 'left speedbar-frame-plist)))
1031 (car (cdr (member 'top speedbar-frame-plist)))))
1033 ((and (not (featurep 'xemacs))
1034 (or (assoc 'left speedbar-frame-parameters)
1035 (assoc 'top speedbar-frame-parameters)))
1036 ;; if left/top were specified in the parameters, pass them
1037 ;; down to the reposition function
1038 (dframe-reposition-frame
1040 (dframe-attached-frame speedbar-frame)
1041 (cons (cdr (assoc 'left speedbar-frame-parameters))
1042 (cdr (assoc 'top speedbar-frame-parameters))))
1045 (dframe-reposition-frame speedbar-frame
1046 (dframe-attached-frame speedbar-frame)
1047 speedbar-default-position))))
1049 (defsubst speedbar-current-frame ()
1050 "Return the frame to use for speedbar based on current context."
1051 (dframe-current-frame 'speedbar-frame 'speedbar-mode))
1053 (defun speedbar-handle-delete-frame (e)
1054 "Handle a delete frame event E.
1055 If the deleted frame is the frame speedbar is attached to,
1056 we need to delete speedbar also."
1057 (when (and speedbar-frame
1058 (eq (car (car (cdr e))) ;; frame to be deleted
1059 dframe-attached-frame))
1060 (delete-frame speedbar-frame)))
1063 (defun speedbar-get-focus ()
1064 "Change frame focus to or from the speedbar frame.
1065 If the selected frame is not speedbar, then speedbar frame is
1066 selected. If the speedbar frame is active, then select the attached frame."
1068 (speedbar-reset-scanners)
1069 (dframe-get-focus 'speedbar-frame 'speedbar-frame-mode
1070 (lambda () (let ((speedbar-update-flag t))
1071 (speedbar-timer-fn)))))
1073 (defsubst speedbar-frame-width ()
1074 "Return the width of the speedbar frame in characters.
1075 Return nil if it doesn't exist."
1076 (frame-width speedbar-frame))
1078 (define-derived-mode speedbar-mode fundamental-mode "Speedbar"
1079 "Major mode for managing a display of directories and tags.
1080 \\<speedbar-key-map>
1081 The first line represents the default directory of the speedbar frame.
1082 Each directory segment is a button which jumps speedbar's default
1083 directory to that directory. Buttons are activated by clicking `\\[speedbar-click]'.
1084 In some situations using `\\[dframe-power-click]' is a `power click' which will
1085 rescan cached items, or pop up new frames.
1087 Each line starting with <+> represents a directory. Click on the <+>
1088 to insert the directory listing into the current tree. Click on the
1089 <-> to retract that list. Click on the directory name to go to that
1090 directory as the default.
1092 Each line starting with [+] is a file. If the variable
1093 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1094 files which don't have imenu support, but are not expressly ignored.
1095 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1096 which is generated from `completion-ignored-extensions'.
1098 Files with a `*' character after their name are files checked out of a
1099 version control system. (Currently only RCS is supported.) New
1100 version control systems can be added by examining the documentation
1101 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1103 Files with a `#' or `!' character after them are source files that
1104 have an object file associated with them. The `!' indicates that the
1105 files is out of date. You can control what source/object associations
1106 exist through the variable `speedbar-obj-alist'.
1108 Click on the [+] to display a list of tags from that file. Click on
1109 the [-] to retract the list. Click on the file name to edit the file
1110 in the attached frame.
1112 If you open tags, you might find a node starting with {+}, which is a
1113 category of tags. Click the {+} to expand the category. Jump-able
1114 tags start with >. Click the name of the tag to go to that position
1115 in the selected file.
1117 \\{speedbar-key-map}"
1119 (setq font-lock-keywords nil) ;; no font-locking please
1120 (setq truncate-lines t)
1121 (make-local-variable 'frame-title-format)
1122 (setq frame-title-format (concat "Speedbar " speedbar-version)
1123 case-fold-search nil
1125 (speedbar-set-mode-line-format)
1126 ;; Add in our dframe hooks.
1127 (if speedbar-track-mouse-flag
1128 (setq dframe-track-mouse-function #'speedbar-track-mouse))
1129 (setq dframe-help-echo-function #'speedbar-item-info
1130 dframe-mouse-click-function #'speedbar-click
1131 dframe-mouse-position-function #'speedbar-position-cursor-on-line))
1134 (defmacro speedbar-message (fmt &rest args)
1135 "Like `message', but for use in the speedbar frame.
1136 Argument FMT is the format string, and ARGS are the arguments for message."
1137 `(dframe-message ,fmt ,@args))
1139 (defsubst speedbar-y-or-n-p (prompt &optional deleting)
1140 "Like `y-or-n-p', but for use in the speedbar frame.
1141 Argument PROMPT is the prompt to use.
1142 Optional argument DELETING means this is a query that will delete something.
1143 The variable `speedbar-query-confirmation-method' can cause this to
1144 return true without a query."
1145 (or (and (not deleting)
1146 (eq speedbar-query-confirmation-method 'none-but-delete))
1147 (dframe-y-or-n-p prompt)))
1149 (defsubst speedbar-select-attached-frame ()
1150 "Select the frame attached to this speedbar."
1151 (dframe-select-attached-frame (speedbar-current-frame)))
1153 ;; Backwards compatibility
1154 (defalias 'speedbar-with-attached-buffer 'dframe-with-attached-buffer)
1155 (defalias 'speedbar-maybee-jump-to-attached-frame 'dframe-maybee-jump-to-attached-frame)
1157 (defun speedbar-set-mode-line-format ()
1158 "Set the format of the mode line based on the current speedbar environment.
1159 This gives visual indications of what is up. It EXPECTS the speedbar
1160 frame and window to be the currently active frame and window."
1161 (if (and (frame-live-p (speedbar-current-frame))
1162 (or (not (featurep 'xemacs))
1164 (specifier-instance has-modeline-p)))
1166 (with-current-buffer speedbar-buffer
1167 (let* ((w (or (speedbar-frame-width) 20))
1170 (p3 (if speedbar-update-flag "#" "!"))
1171 (p35 (capitalize speedbar-initial-expansion-list-name))
1172 (blank (- w (length p1) (length p3) (length p5) (length p35)
1173 (if line-number-mode 5 1)))
1175 (make-string (/ blank 2) ? )
1178 (make-string (+ (/ blank 2) (% blank 2)) ? )
1181 (if line-number-mode
1182 (list (concat p1 p2 p3 " " p35) '(line-number-mode " %3l")
1184 (list (concat p1 p2 p3 p4 p5)))))
1185 (if (not (equal mode-line-format tf))
1187 (setq mode-line-format tf)
1188 (speedbar-mode-line-update)))))))
1190 (defvar speedbar-previous-menu nil
1191 "The menu before the last `speedbar-reconfigure-keymaps' was called.")
1193 (defun speedbar-reconfigure-keymaps ()
1194 "Reconfigure the menu-bar in a speedbar frame.
1195 Different menu items are displayed depending on the current display mode
1196 and the existence of packages."
1198 speedbar-easymenu-definition-base
1199 (if speedbar-shown-directories
1200 ;; file display mode version
1201 (speedbar-initial-menu)
1203 (dframe-select-attached-frame speedbar-frame)
1204 (eval (nth 1 (assoc speedbar-initial-expansion-list-name
1205 speedbar-initial-expansion-mode-alist)))))
1206 ;; Dynamic menu stuff
1208 (list (cons "Displays"
1209 (let ((displays nil)
1210 (alist speedbar-initial-expansion-mode-alist))
1215 (capitalize (car (car alist)))
1217 'speedbar-change-initial-expansion-list
1221 `(string= ,(car (car alist))
1222 speedbar-initial-expansion-list-name)
1225 (setq alist (cdr alist)))
1228 speedbar-easymenu-definition-trailer))
1229 (localmap (save-excursion
1230 (let ((cf (selected-frame)))
1232 (dframe-select-attached-frame speedbar-frame)
1233 (if (local-variable-p
1234 'speedbar-special-mode-key-map
1236 speedbar-special-mode-key-map)
1237 (select-frame cf))))))
1238 (with-current-buffer speedbar-buffer
1239 (use-local-map (or localmap
1240 (speedbar-initial-keymap)
1241 ;; This creates a small keymap we can glom the
1242 ;; menu adjustments into.
1243 (speedbar-make-specialized-keymap)))
1244 ;; Delete the old menu if applicable.
1245 (if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu))
1246 (setq speedbar-previous-menu md)
1247 ;; Now add the new menu
1248 (if (not (featurep 'xemacs))
1249 (easy-menu-define speedbar-menu-map (current-local-map)
1251 (easy-menu-add md (current-local-map))
1253 (if (fboundp 'set-buffer-menubar)
1254 (set-buffer-menubar (list md)))))
1256 (run-hooks 'speedbar-reconfigure-keymaps-hook)))
1259 ;;; User Input stuff
1261 (defun speedbar-customize ()
1262 "Customize speedbar using the Custom package."
1264 (let ((sf (selected-frame)))
1265 (dframe-select-attached-frame speedbar-frame)
1266 (customize-group 'speedbar)
1268 (dframe-maybee-jump-to-attached-frame))
1270 (defun speedbar-track-mouse (event)
1271 "For motion EVENT, display info about the current line."
1272 (if (not speedbar-track-mouse-flag)
1275 (save-window-excursion
1278 (mouse-set-point event)
1279 (if (eq major-mode 'speedbar-mode)
1280 ;; XEmacs may let us get in here in other mode buffers.
1281 (speedbar-item-info)))
1282 (error (speedbar-message nil)))))))
1284 (defun speedbar-show-info-under-mouse ()
1285 "Call the info function for the line under the mouse."
1286 (let ((pos (mouse-position))) ; we ignore event until I use it later.
1287 (if (equal (car pos) speedbar-frame)
1289 (save-window-excursion
1290 (apply 'set-mouse-position pos)
1291 (speedbar-item-info))))))
1293 (defun speedbar-next (arg)
1294 "Move to the next ARGth line in a speedbar buffer."
1296 (forward-line (or arg 1))
1297 (speedbar-item-info)
1298 (speedbar-position-cursor-on-line))
1300 (defun speedbar-prev (arg)
1301 "Move to the previous ARGth line in a speedbar buffer."
1303 (speedbar-next (if arg (- arg) -1)))
1305 (defun speedbar-restricted-move (arg)
1306 "Move to the next ARGth line in a speedbar buffer at the same depth.
1307 This means that movement is restricted to a subnode, and that siblings
1308 of intermediate nodes are skipped."
1309 (if (not (numberp arg)) (signal 'wrong-type-argument (list 'numberp arg)))
1310 ;; First find the extent for which we are allowed to move.
1311 (let ((depth (save-excursion (beginning-of-line)
1312 (if (looking-at "[0-9]+:")
1313 (string-to-number (match-string 0))
1315 (crement (if (< arg 0) 1 -1)) ; decrement or increment
1316 (lastmatch (point)))
1318 (forward-line (- crement))
1319 (let ((subdepth (save-excursion (beginning-of-line)
1320 (if (looking-at "[0-9]+:")
1321 (string-to-number (match-string 0))
1323 (cond ((or (< subdepth depth)
1324 (progn (end-of-line) (eobp))
1325 (progn (beginning-of-line) (bobp)))
1326 ;; We have reached the end of this block.
1327 (goto-char lastmatch)
1329 (error "End of sub-list"))
1331 (setq lastmatch (point)
1332 arg (+ arg crement))))))
1333 (speedbar-position-cursor-on-line)))
1335 (defun speedbar-restricted-next (arg)
1336 "Move to the next ARGth line in a speedbar buffer at the same depth.
1337 This means that movement is restricted to a subnode, and that siblings
1338 of intermediate nodes are skipped."
1340 (speedbar-restricted-move (or arg 1))
1341 (speedbar-item-info))
1343 (defun speedbar-restricted-prev (arg)
1344 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1345 This means that movement is restricted to a subnode, and that siblings
1346 of intermediate nodes are skipped."
1348 (speedbar-restricted-move (if arg (- arg) -1))
1349 (speedbar-item-info))
1351 (defun speedbar-navigate-list (arg)
1352 "Move across ARG groups of similarly typed items in speedbar.
1353 Stop on the first line of the next type of item, or on the last or first item
1354 if we reach a buffer boundary."
1357 (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ")
1358 (let ((str (regexp-quote (match-string 0))))
1359 (while (looking-at str)
1360 (speedbar-restricted-move arg)
1361 (beginning-of-line))))
1362 (speedbar-position-cursor-on-line))
1364 (defun speedbar-forward-list ()
1365 "Move forward over the current list.
1366 A LIST in speedbar is a group of similarly typed items, such as directories,
1367 files, or the directory button."
1369 (speedbar-navigate-list 1)
1370 (speedbar-item-info))
1372 (defun speedbar-backward-list ()
1373 "Move backward over the current list.
1374 A LIST in speedbar is a group of similarly typed items, such as directories,
1375 files, or the directory button."
1377 (speedbar-navigate-list -1)
1378 (speedbar-item-info))
1380 (defun speedbar-scroll-up (&optional arg)
1381 "Page down one screen-full of the speedbar, or ARG lines."
1384 (speedbar-position-cursor-on-line))
1386 (defun speedbar-scroll-down (&optional arg)
1387 "Page up one screen-full of the speedbar, or ARG lines."
1390 (speedbar-position-cursor-on-line))
1392 (defun speedbar-up-directory ()
1393 "Keyboard accelerator for moving the default directory up one.
1394 Assumes that the current buffer is the speedbar buffer."
1396 (setq default-directory (expand-file-name (concat default-directory "../")))
1397 (speedbar-update-contents))
1399 ;;; Speedbar file activity (aka creeping featurism)
1401 (defun speedbar-refresh (&optional arg)
1402 "Refresh the current speedbar display, disposing of any cached data.
1403 Argument ARG represents to force a refresh past any caches that may exist."
1405 (let ((dl speedbar-shown-directories)
1406 (dframe-power-click arg)
1408 ;; We need to hack something so this works in detached frames.
1410 (adelete 'speedbar-directory-contents-alist (car dl))
1412 (if (<= 1 speedbar-verbosity-level)
1413 (speedbar-message "Refreshing speedbar..."))
1414 (speedbar-update-contents)
1415 (speedbar-stealthy-updates)
1416 ;; Reset the timer in case it got really hosed for some reason...
1417 (speedbar-set-timer dframe-update-speed)
1418 (if (<= 1 speedbar-verbosity-level)
1419 (speedbar-message "Refreshing speedbar...done"))))
1421 (defun speedbar-item-load ()
1422 "Load the item under the cursor or mouse if it is a Lisp file."
1424 (let ((f (speedbar-line-file)))
1425 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1426 (if (and (file-exists-p (concat f "c"))
1427 (speedbar-y-or-n-p (format "Load %sc? " f)))
1428 ;; If the compiled version exists, load that instead...
1429 (load-file (concat f "c"))
1431 (error "Not a loadable file"))))
1433 (defun speedbar-item-byte-compile ()
1434 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1436 (let ((f (speedbar-line-file))
1437 (sf (selected-frame)))
1438 (if (and (file-exists-p f) (string-match "\\.el\\'" f))
1440 (dframe-select-attached-frame speedbar-frame)
1441 (byte-compile-file f nil)
1443 (speedbar-reset-scanners)))
1446 (defun speedbar-mouse-item-info (event)
1447 "Provide information about what the user clicked on.
1448 This should be bound to a mouse EVENT."
1450 (mouse-set-point event)
1451 (speedbar-item-info))
1453 (defun speedbar-generic-item-info ()
1454 "Attempt to derive, and then display information about this line item.
1455 File style information is displayed with `speedbar-item-info'."
1458 ;; Skip invisible number info.
1459 (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0)))
1460 ;; Skip items in "folder" type text characters.
1461 (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0)))
1463 (speedbar-message "Text: %s" (buffer-substring-no-properties
1464 (point) (line-end-position)))))
1466 (defun speedbar-item-info ()
1467 "Display info in the minibuffer about the button the mouse is over.
1468 This function can be replaced in `speedbar-mode-functions-list' as
1469 `speedbar-item-info'."
1471 (let (message-log-max)
1472 (funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info)
1473 'speedbar-generic-item-info))))
1475 (defun speedbar-item-info-file-helper (&optional filename)
1476 "Display info about a file that is on the current line.
1477 Return nil if not applicable. If FILENAME, then use that
1478 instead of reading it from the speedbar buffer."
1479 (let* ((item (or filename (speedbar-line-file)))
1480 (attr (if item (file-attributes item) nil)))
1481 (if (and item attr) (speedbar-message "%s %-6d %s" (nth 8 attr)
1485 (defun speedbar-item-info-tag-helper ()
1486 "Display info about a tag that is on the current line.
1487 Return nil if not applicable."
1490 (if (re-search-forward " [-+=]?> \\([^\n]+\\)" (line-end-position) t)
1491 (let* ((tag (match-string 1))
1492 (attr (speedbar-line-token))
1494 (semantic-tagged (if (fboundp 'semantic-tag-p)
1495 (semantic-tag-p attr))))
1499 (when (and (semantic-tag-overlay attr)
1500 (semantic-tag-buffer attr))
1501 (set-buffer (semantic-tag-buffer attr)))
1503 (funcall semantic-sb-info-format-tag-function attr)
1505 (looking-at "\\([0-9]+\\):")
1506 (setq item (file-name-nondirectory (speedbar-line-directory)))
1507 (speedbar-message "Tag: %s in %s" tag item)))
1508 (if (re-search-forward "{[+-]} \\([^\n]+\\)$" (line-end-position) t)
1509 (speedbar-message "Group of tags \"%s\"" (match-string 1))
1510 (if (re-search-forward " [+-]?[()|@] \\([^\n]+\\)$" nil t)
1511 (let* ((detailtext (match-string 1))
1512 (detail (or (speedbar-line-token) detailtext))
1513 (parent (save-excursion
1515 (let ((dep (if (looking-at "[0-9]+:")
1516 (1- (string-to-number (match-string 0)))
1518 (re-search-backward (concat "^"
1522 (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$")
1523 (speedbar-line-token)
1525 (if (featurep 'semantic)
1527 (if (semantic-tag-p detail)
1529 (funcall semantic-sb-info-format-tag-function detail parent))
1531 (speedbar-message "Detail: %s of tag %s" detail
1532 (if (semantic-tag-p parent)
1533 (semantic-format-tag-name parent nil t)
1535 (speedbar-message "Detail: %s" detail))))
1536 ;; Not using `semantic':
1538 (speedbar-message "Detail: %s of tag %s" detail parent)
1539 (speedbar-message "Detail: %s" detail))))
1542 (defun speedbar-files-item-info ()
1543 "Display info in the minibuffer about the button the mouse is over."
1544 (if (not speedbar-shown-directories)
1545 (speedbar-generic-item-info)
1546 (or (speedbar-item-info-file-helper)
1547 (speedbar-item-info-tag-helper)
1548 (speedbar-generic-item-info))))
1550 (defun speedbar-item-copy ()
1551 "Copy the item under the cursor.
1552 Files can be copied to new names or places."
1554 (let ((f (speedbar-line-file)))
1555 (if (not f) (error "Not a file"))
1556 (if (file-directory-p f)
1557 (error "Cannot copy directory")
1558 (let* ((rt (read-file-name (format "Copy %s to: "
1559 (file-name-nondirectory f))
1560 (file-name-directory f)))
1561 (refresh (member (expand-file-name (file-name-directory rt))
1562 speedbar-shown-directories)))
1563 ;; Create the right file name part
1564 (if (file-directory-p rt)
1566 (concat (expand-file-name rt)
1567 (if (string-match "[/\\]$" rt) "" "/")
1568 (file-name-nondirectory f))))
1569 (if (or (not (file-exists-p rt))
1570 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)
1573 (copy-file f rt t t)
1574 ;; refresh display if the new place is currently displayed.
1578 (if (not (speedbar-goto-this-file rt))
1579 (speedbar-goto-this-file f))))
1582 (defun speedbar-item-rename ()
1583 "Rename the item under the cursor or mouse.
1584 Files can be renamed to new names or moved to new directories."
1586 (let ((f (speedbar-line-file)))
1588 (let* ((rt (read-file-name (format "Rename %s to: "
1589 (file-name-nondirectory f))
1590 (file-name-directory f)))
1591 (refresh (member (expand-file-name (file-name-directory rt))
1592 speedbar-shown-directories)))
1593 ;; Create the right file name part
1594 (if (file-directory-p rt)
1596 (concat (expand-file-name rt)
1597 (if (string-match "[/\\]\\'" rt) "" "/")
1598 (file-name-nondirectory f))))
1599 (if (or (not (file-exists-p rt))
1600 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)
1603 (rename-file f rt t)
1604 ;; refresh display if the new place is currently displayed.
1608 (speedbar-goto-this-file rt)
1610 (error "Not a file"))))
1612 (defun speedbar-create-directory ()
1613 "Create a directory in speedbar."
1615 (let ((f (speedbar-line-file)))
1617 (let* ((basedir (file-name-directory f))
1618 (nd (read-file-name "Create directory: "
1620 ;; Make the directory
1621 (make-directory nd t)
1623 (speedbar-goto-this-file nd)
1625 (error "Not a file"))))
1627 (defun speedbar-item-delete ()
1628 "Delete the item under the cursor. Files are removed from disk."
1630 (let ((f (speedbar-line-file)))
1631 (if (not f) (error "Not a file"))
1632 (if (speedbar-y-or-n-p (format "Delete %s? " f) t)
1634 (if (file-directory-p f)
1635 (delete-directory f t t)
1637 (speedbar-message "Okie dokie.")
1644 (defun speedbar-item-object-delete ()
1645 "Delete the object associated from the item under the cursor.
1646 The file is removed from disk. The object is determined from the
1647 variable `speedbar-obj-alist'."
1649 (let* ((f (speedbar-line-file))
1651 (oa speedbar-obj-alist))
1652 (if (not f) (error "Not a file"))
1653 (while (and oa (not (string-match (car (car oa)) f)))
1655 (setq obj (concat (file-name-sans-extension f) (cdr (car oa))))
1656 (if (and oa (file-exists-p obj)
1657 (speedbar-y-or-n-p (format "Delete %s? " obj) t))
1660 (speedbar-reset-scanners)))))
1662 (defun speedbar-enable-update ()
1663 "Enable automatic updating in speedbar via timers."
1665 (setq speedbar-update-flag t)
1666 (speedbar-set-mode-line-format)
1667 (speedbar-set-timer dframe-update-speed))
1669 (defun speedbar-disable-update ()
1670 "Disable automatic updating and stop consuming resources."
1672 (setq speedbar-update-flag nil)
1673 (speedbar-set-mode-line-format)
1674 (speedbar-set-timer nil))
1676 (defun speedbar-toggle-updates ()
1677 "Toggle automatic update for the speedbar frame."
1679 (if speedbar-update-flag
1680 (speedbar-disable-update)
1681 (speedbar-enable-update)))
1683 (defun speedbar-toggle-images ()
1684 "Toggle use of images in the speedbar frame."
1686 (setq speedbar-use-images (not speedbar-use-images))
1689 (defun speedbar-toggle-sorting ()
1690 "Toggle tag sorting."
1692 (setq speedbar-sort-tags (not speedbar-sort-tags)))
1694 (defun speedbar-toggle-show-all-files ()
1695 "Toggle display of files speedbar can not tag."
1697 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files))
1700 (defmacro speedbar-with-writable (&rest forms)
1701 "Allow the buffer to be writable and evaluate FORMS."
1702 (list 'let '((inhibit-read-only t))
1703 (cons 'progn forms)))
1704 (put 'speedbar-with-writable 'lisp-indent-function 0)
1706 (defun speedbar-insert-button (text face mouse function
1707 &optional token prevline)
1708 "Insert TEXT as the next logical speedbar button.
1709 FACE is the face to put on the button, MOUSE is the highlight face to use.
1710 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1711 This function assumes that the current buffer is the speedbar buffer.
1712 If PREVLINE, then put this button on the previous line.
1714 This is a convenience function for special modes that create their own
1715 specialized speedbar displays."
1716 (goto-char (point-max))
1717 (let ((start (point)))
1718 (if (/= (current-column) 0) (insert "\n"))
1719 (put-text-property start (point) 'invisible nil))
1720 (if prevline (progn (delete-char -1)
1721 (insert " ") ;back up if desired...
1722 (put-text-property (1- (point)) (point) 'invisible nil)))
1723 (let ((start (point)))
1725 (speedbar-make-button start (point) face mouse function token))
1726 (let ((start (point)))
1728 (add-text-properties
1729 start (point) '(face nil invisible nil mouse-face nil))))
1731 (defun speedbar-insert-separator (text)
1732 "Insert a separation label of TEXT.
1733 Separators are not active, have no labels, depth, or actions."
1734 (if speedbar-use-images
1735 (let ((start (point)))
1737 (speedbar-insert-image-button-maybe start 2)))
1738 (let ((start (point)))
1740 (speedbar-make-button start (point)
1741 'speedbar-separator-face
1744 (defun speedbar-make-button (start end face mouse function &optional token)
1745 "Create a button from START to END, with FACE as the display face.
1746 MOUSE is the mouse face. When this button is clicked on FUNCTION
1747 will be run with the TOKEN parameter (any Lisp object). If FACE
1748 is t use the text properties of the string that is passed as an
1751 (put-text-property start end 'face face))
1752 (add-text-properties
1753 start end `(mouse-face ,mouse invisible nil
1754 speedbar-text ,(buffer-substring-no-properties start end)))
1755 (if speedbar-use-tool-tips-flag
1756 (put-text-property start end 'help-echo #'dframe-help-echo))
1757 (if function (put-text-property start end 'speedbar-function function))
1758 (if token (put-text-property start end 'speedbar-token token))
1759 ;; So far the only text we have is less that 3 chars.
1760 (if (<= (- end start) 3)
1761 (speedbar-insert-image-button-maybe start (- end start)))
1764 ;;; Initial Expansion list management
1766 (defun speedbar-initial-expansion-list ()
1767 "Return the current default expansion list.
1768 This is based on `speedbar-initial-expansion-list-name' referencing
1769 `speedbar-initial-expansion-mode-alist'."
1770 ;; cdr1 - name, cdr2 - menu
1771 (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name
1772 speedbar-initial-expansion-mode-alist)))))
1774 (defun speedbar-initial-menu ()
1775 "Return the current default menu data.
1776 This is based on `speedbar-initial-expansion-list-name' referencing
1777 `speedbar-initial-expansion-mode-alist'."
1779 (car (cdr (assoc speedbar-initial-expansion-list-name
1780 speedbar-initial-expansion-mode-alist)))))
1782 (defun speedbar-initial-keymap ()
1783 "Return the current default menu data.
1784 This is based on `speedbar-initial-expansion-list-name' referencing
1785 `speedbar-initial-expansion-mode-alist'."
1787 (car (cdr (cdr (assoc speedbar-initial-expansion-list-name
1788 speedbar-initial-expansion-mode-alist))))))
1790 (defun speedbar-initial-stealthy-functions ()
1791 "Return a list of functions to call stealthily.
1792 This is based on `speedbar-initial-expansion-list-name' referencing
1793 `speedbar-stealthy-function-list'."
1794 (cdr (assoc speedbar-initial-expansion-list-name
1795 speedbar-stealthy-function-list)))
1797 (defun speedbar-add-expansion-list (new-list)
1798 "Add NEW-LIST to the list of expansion lists."
1799 (add-to-list 'speedbar-initial-expansion-mode-alist new-list))
1801 (defun speedbar-change-initial-expansion-list (new-default)
1802 "Change speedbar's default expansion list to NEW-DEFAULT."
1805 (completing-read (format "Speedbar Mode (default %s): "
1806 speedbar-previously-used-expansion-list-name)
1807 speedbar-initial-expansion-mode-alist
1809 speedbar-previously-used-expansion-list-name)))
1810 (setq speedbar-previously-used-expansion-list-name
1811 speedbar-initial-expansion-list-name
1812 speedbar-initial-expansion-list-name new-default)
1813 (if (and (speedbar-current-frame) (frame-live-p (speedbar-current-frame)))
1816 (speedbar-reconfigure-keymaps))))
1818 (defun speedbar-fetch-replacement-function (function)
1819 "Return a current mode-specific replacement for function, or nil.
1820 Scans `speedbar-mode-functions-list' first for the current mode, then
1822 (cdr (assoc function
1823 (cdr (assoc speedbar-initial-expansion-list-name
1824 speedbar-mode-functions-list)))))
1826 (defun speedbar-add-mode-functions-list (new-list)
1827 "Add NEW-LIST to the list of mode functions.
1828 See `speedbar-mode-functions-list' for details."
1829 (add-to-list 'speedbar-mode-functions-list new-list))
1832 ;;; Special speedbar display management
1834 (defun speedbar-maybe-add-localized-support (buffer)
1835 "Quick check function called on BUFFERs by the speedbar timer function.
1836 Maintains the value of local variables which control speedbar's use
1837 of the special mode functions."
1838 (or speedbar-special-mode-expansion-list
1839 (speedbar-add-localized-speedbar-support buffer)))
1841 (defun speedbar-add-localized-speedbar-support (buffer)
1842 "Add localized speedbar support to BUFFER's mode if it is available."
1843 (interactive "bBuffer: ")
1844 (if (stringp buffer) (setq buffer (get-buffer buffer)))
1845 (if (not (buffer-live-p buffer))
1847 (with-current-buffer buffer
1849 (let ((ms (symbol-name major-mode)) v)
1850 (if (not (string-match "-mode$" ms))
1851 nil ;; do nothing to broken mode
1852 (setq ms (substring ms 0 (match-beginning 0)))
1853 (setq v (intern-soft (concat ms "-speedbar-buttons")))
1854 (make-local-variable 'speedbar-special-mode-expansion-list)
1856 (setq speedbar-special-mode-expansion-list t)
1857 ;; If it is autoloaded, we need to load it now so that
1858 ;; we have access to the varialbe -speedbar-menu-items.
1859 ;; Is this XEmacs safe?
1860 (let ((sf (symbol-function v)))
1861 (if (and (listp sf) (eq (car sf) 'autoload))
1862 (load-library (car (cdr sf)))))
1863 (setq speedbar-special-mode-expansion-list (list v))
1864 (setq v (intern-soft (concat ms "-speedbar-key-map")))
1866 nil ;; don't add special keymap
1867 (make-local-variable 'speedbar-special-mode-key-map)
1868 (setq speedbar-special-mode-key-map
1870 (setq v (intern-soft (concat ms "-speedbar-menu-items")))
1872 nil ;; don't add special menus
1873 (make-local-variable 'speedbar-easymenu-definition-special)
1874 (setq speedbar-easymenu-definition-special
1878 (defun speedbar-remove-localized-speedbar-support (buffer)
1879 "Remove any traces that BUFFER supports speedbar in a specialized way."
1880 (with-current-buffer buffer
1881 (kill-local-variable 'speedbar-special-mode-expansion-list)
1882 (kill-local-variable 'speedbar-special-mode-key-map)
1883 (kill-local-variable 'speedbar-easymenu-definition-special)))
1885 ;;; File button management
1887 (defun speedbar-file-lists (directory)
1888 "Create file lists for DIRECTORY.
1889 The car is the list of directories, the cdr is list of files not
1890 matching ignored headers. Cache any directory files found in
1891 `speedbar-directory-contents-alist' and use that cache before scanning
1893 (setq directory (expand-file-name directory))
1894 ;; If in powerclick mode, then the directory we are getting
1895 ;; should be rescanned.
1896 (if dframe-power-click
1897 (adelete 'speedbar-directory-contents-alist directory))
1898 ;; find the directory, either in the cache, or build it.
1899 (or (cdr-safe (assoc directory speedbar-directory-contents-alist))
1900 (let ((default-directory directory)
1901 (dir (directory-files directory nil))
1906 (or (string-match speedbar-file-unshown-regexp (car dir))
1907 (member (car dir) vc-directory-exclusion-list)
1908 (string-match speedbar-directory-unshown-regexp (car dir))))
1909 (if (file-directory-p (car dir))
1910 (setq dirs (cons (car dir) dirs))
1911 (setq files (cons (car dir) files))))
1912 (setq dir (cdr dir)))
1913 (let ((nl (cons (nreverse dirs) (list (nreverse files)))))
1914 (aput 'speedbar-directory-contents-alist directory nl)
1918 (defun speedbar-directory-buttons (directory index)
1919 "Insert a single button group at point for DIRECTORY.
1920 Each directory part is a different button. If part of the directory
1921 matches the user directory ~, then it is replaced with a ~.
1922 INDEX is not used, but is required by the caller."
1923 (let* ((tilde (expand-file-name "~/"))
1924 (dd (expand-file-name directory))
1925 (junk (string-match (regexp-quote tilde) dd))
1927 (concat "~/" (substring dd (match-end 0)))
1930 (if (string-match "^~[/\\]?\\'" displayme) (setq displayme tilde))
1934 (while (re-search-forward "\\([^/\\]+\\)[/\\]" nil t)
1935 (speedbar-make-button (match-beginning 1) (match-end 1)
1936 'speedbar-directory-face
1937 'speedbar-highlight-face
1938 'speedbar-directory-buttons-follow
1939 (if (and (= (match-beginning 1) p)
1940 (not (char-equal (char-after (+ p 1)) ?:)))
1941 (expand-file-name "~/") ;the tilde
1942 (buffer-substring-no-properties
1944 ;; Nuke the beginning of the directory if it's too long...
1945 (cond ((eq speedbar-directory-button-trim-method 'span)
1947 (let ((ww (or (speedbar-frame-width) 20)))
1948 (move-to-column ww nil)
1949 (while (>= (current-column) ww)
1950 (re-search-backward "[/\\]" nil t)
1951 (if (<= (current-column) 2)
1953 (re-search-forward "[/\\]" nil t)
1954 (if (< (current-column) 4)
1955 (re-search-forward "[/\\]" nil t))
1957 (if (looking-at "[/\\]?$")
1960 (move-to-column ww nil)))))
1961 ((eq speedbar-directory-button-trim-method 'trim)
1963 (let ((ww (or (speedbar-frame-width) 20))
1964 (tl (current-column)))
1967 (move-to-column (- tl ww))
1968 (if (re-search-backward "[/\\]" nil t)
1970 (delete-region (point-min) (point))
1974 (if (string-match "\\`[/\\][^/\\]+[/\\]\\'" displayme)
1979 (speedbar-make-button p (point)
1980 'speedbar-directory-face
1981 'speedbar-highlight-face
1982 'speedbar-directory-buttons-follow
1985 (insert-char ?\n 1 nil)))
1987 (defun speedbar-make-tag-line (exp-button-type
1988 exp-button-char exp-button-function
1990 tag-button tag-button-function tag-button-data
1991 tag-button-face depth)
1992 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
1993 This is the button that expands or contracts a node (if applicable),
1994 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
1995 is the function to call if it's clicked on. Button types are
1996 'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil.
1997 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
2000 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
2001 function to call if clicked on, and TAG-BUTTON-DATA is the data to
2002 attach to the text field (such a tag positioning, etc).
2003 TAG-BUTTON-FACE is a face used for this type of tag.
2005 Lastly, DEPTH shows the depth of expansion.
2007 This function assumes that the cursor is in the speedbar window at the
2008 position to insert a new item, and that the new item will end with a CR."
2009 (let ((start (point))
2011 (insert (int-to-string depth) ":")
2013 (depthspacesize (* depth speedbar-indentation-width)))
2014 (put-text-property start end 'invisible t)
2015 (insert-char ? depthspacesize nil)
2016 (put-text-property (- (point) depthspacesize) (point) 'invisible nil)
2017 (let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]")
2018 ((eq exp-button-type 'angle) "<%c>")
2019 ((eq exp-button-type 'curly) "{%c}")
2020 ((eq exp-button-type 'expandtag) " %c>")
2021 ((eq exp-button-type 'statictag) " =>")
2023 (buttxt (format exp-button exp-button-char))
2025 (end (progn (insert buttxt) (point)))
2026 (bf (if (and exp-button-type (not (eq exp-button-type 'statictag)))
2027 'speedbar-button-face nil))
2028 (mf (if exp-button-function 'speedbar-highlight-face nil))
2030 (speedbar-make-button start end bf mf exp-button-function exp-button-data)
2031 (if speedbar-hide-button-brackets-flag
2033 (put-text-property start (1+ start) 'invisible t)
2034 (put-text-property end (1- end) 'invisible t)))
2036 (insert-char ? 1 nil)
2037 (put-text-property (1- (point)) (point) 'invisible nil)
2038 (let ((start (point))
2039 (end (progn (insert tag-button) (point))))
2040 (insert-char ?\n 1 nil)
2041 (put-text-property (1- (point)) (point) 'invisible nil)
2042 (speedbar-make-button start end tag-button-face
2043 (if tag-button-function 'speedbar-highlight-face nil)
2044 tag-button-function tag-button-data))
2047 (defun speedbar-change-expand-button-char (char)
2048 "Change the expansion button character to CHAR for the current line."
2051 (if (re-search-forward ":\\s-*.\\([-+?]\\)" (line-end-position) t)
2052 (speedbar-with-writable
2053 (goto-char (match-end 1))
2054 (insert-char char 1 t)
2057 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2058 ;; make sure we fix the image on the text here.
2059 (speedbar-insert-image-button-maybe (- (point) 1) 3)))))
2062 ;;; Build button lists
2064 (defun speedbar-insert-files-at-point (files level)
2065 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2066 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2067 don't know how to manage them. The input parameter FILES is a cons
2068 cell of the form ( 'DIRLIST . 'FILELIST )."
2069 ;; Start inserting all the directories
2070 (let ((dirs (car files)))
2072 (speedbar-make-tag-line 'angle ?+ 'speedbar-dired (car dirs)
2073 (car dirs) 'speedbar-dir-follow nil
2074 'speedbar-directory-face level)
2075 (setq dirs (cdr dirs))))
2076 (let ((lst (car (cdr files)))
2077 (case-fold-search t))
2079 (let* ((known (string-match speedbar-file-regexp (car lst)))
2080 (expchar (if known ?+ ??))
2081 (fn (if known 'speedbar-tag-file nil)))
2082 (if (or speedbar-show-unknown-files (/= expchar ??))
2083 (speedbar-make-tag-line 'bracket expchar fn (car lst)
2084 (car lst) 'speedbar-find-file nil
2085 'speedbar-file-face level)))
2086 (setq lst (cdr lst)))))
2088 (defun speedbar-default-directory-list (directory index)
2089 "Insert files for DIRECTORY with level INDEX at point."
2090 (speedbar-insert-files-at-point
2091 (speedbar-file-lists directory) index)
2092 (speedbar-reset-scanners)
2094 ;; If the shown files variable has extra directories, then
2095 ;; it is our responsibility to redraw them all
2096 ;; Luckilly, the nature of inserting items into this list means
2097 ;; that by reversing it, we can easilly go in the right order
2098 (let ((sf (cdr (reverse speedbar-shown-directories))))
2099 (setq speedbar-shown-directories
2100 (list (expand-file-name default-directory)))
2101 ;; exand them all as we find them
2103 (if (speedbar-goto-this-file (car sf))
2106 (if (looking-at "[0-9]+:[ ]*<")
2108 (goto-char (match-end 0))
2109 (speedbar-do-function-pointer)))))
2112 ;;; Generic List support
2114 ;; Generic lists are hierarchies of tags which we may need to permute
2115 ;; in order to make it look nice.
2117 ;; A generic list is of the form:
2118 ;; ( ("name" . marker-or-number) <-- one tag at this level
2119 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2120 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2121 (defun speedbar-generic-list-group-p (sublst)
2122 "Non-nil if SUBLST is a group.
2123 Groups may optionally contain a position."
2124 (and (stringp (car-safe sublst))
2125 (or (and (listp (cdr-safe sublst))
2126 (or (speedbar-generic-list-tag-p (car-safe (cdr-safe sublst)))
2127 (speedbar-generic-list-group-p (car-safe (cdr-safe sublst))
2129 (and (number-or-marker-p (car-safe (cdr-safe sublst)))
2130 (listp (cdr-safe (cdr-safe sublst)))
2131 (speedbar-generic-list-tag-p
2132 (car-safe (cdr-safe (cdr-safe sublst)))))
2135 (defun speedbar-generic-list-positioned-group-p (sublst)
2136 "Non-nil if SUBLST is a group with a position."
2137 (and (stringp (car-safe sublst))
2138 (number-or-marker-p (car-safe (cdr-safe sublst)))
2139 (listp (cdr-safe (cdr-safe sublst)))
2140 (let ((rest (car-safe (cdr-safe (cdr-safe sublst)))))
2141 (or (speedbar-generic-list-tag-p rest)
2142 (speedbar-generic-list-group-p rest)
2143 (speedbar-generic-list-positioned-group-p rest)
2146 (defun speedbar-generic-list-tag-p (sublst)
2147 "Non-nil if SUBLST is a tag."
2148 (and (stringp (car-safe sublst))
2149 (or (and (number-or-marker-p (cdr-safe sublst))
2150 (not (cdr-safe (cdr-safe sublst))))
2151 ;; For semantic/bovine items, this is needed
2152 (symbolp (car-safe (cdr-safe sublst))))
2155 (defun speedbar-sort-tag-hierarchy (lst)
2156 "Sort all elements of tag hierarchy LST."
2157 (sort (copy-alist lst)
2158 (lambda (a b) (string< (car a) (car b)))))
2160 (defun speedbar-try-completion (string alist)
2161 "A wrapper for `try-completion'.
2162 Passes STRING and ALIST to `try-completion' if ALIST
2164 (if (and (consp alist)
2165 (listp (car alist)) (stringp (car (car alist))))
2166 (try-completion string alist)
2169 (defun speedbar-prefix-group-tag-hierarchy (lst)
2170 "Prefix group names for tag hierarchy LST."
2175 (short-group-list nil)
2176 (short-start-name nil)
2177 (short-end-name nil)
2178 (num-shorts-grouped 0)
2179 (bins (make-vector 256 nil))
2181 (if (<= (length lst) speedbar-tag-regroup-maximum-length)
2182 ;; Do nothing. Too short to bother with.
2184 ;; Break out sub-lists
2186 (if (speedbar-generic-list-group-p (car-safe lst))
2187 (setq newlst (cons (car lst) newlst))
2188 (setq sublst (cons (car lst) sublst)))
2189 (setq lst (cdr lst)))
2190 ;; Reverse newlst because it was made backwards.
2191 ;; Sublist doesn't need reversing because the act
2192 ;; of binning things will reverse it for us.
2193 (setq newlst (nreverse newlst)
2195 ;; Now, first find out how long our list is. Never let a
2196 ;; list get-shorter than our minimum.
2197 (if (<= (length sublst) speedbar-tag-split-minimum-length)
2198 (setq work-list sublst)
2199 (setq diff-idx (length (speedbar-try-completion "" sublst)))
2200 ;; Sort the whole list into bins.
2202 (let ((e (car sublst))
2203 (s (car (car sublst))))
2204 (cond ((<= (length s) diff-idx)
2205 ;; 0 storage bin for shorty.
2206 (aset bins 0 (cons e (aref bins 0))))
2208 ;; stuff into a bin based on ascii value at diff
2209 (aset bins (aref s diff-idx)
2210 (cons e (aref bins (aref s diff-idx)))))))
2211 (setq sublst (cdr sublst)))
2212 ;; Go through all our bins Stick singles into our
2213 ;; junk-list, everything else as sublsts in work-list.
2214 ;; If two neighboring lists are both small, make a grouped
2215 ;; group combinding those two sub-lists.
2217 (while (> 256 diff-idx)
2218 ;; The bins contents are currently in forward order.
2219 (let ((l (aref bins diff-idx)))
2221 (let ((tmp (cons (speedbar-try-completion "" l) l)))
2222 (if (or (> (length l) speedbar-tag-regroup-maximum-length)
2223 (> (+ (length l) (length short-group-list))
2224 speedbar-tag-split-minimum-length))
2226 ;; We have reached a longer list, so we
2227 ;; must finish off a grouped group.
2229 ((and short-group-list
2230 (= (length short-group-list)
2231 num-shorts-grouped))
2232 ;; All singles? Junk list
2233 (setq junk-list (append (nreverse short-group-list)
2235 ((= num-shorts-grouped 1)
2236 ;; Only one short group? Just stick it in
2237 ;; there by itself. Make a group, and find
2239 (let ((subexpression (speedbar-try-completion
2240 "" short-group-list)))
2241 (if (< (length subexpression)
2242 speedbar-tag-group-name-minimum-length)
2244 (concat short-start-name
2247 (car (car short-group-list))
2248 (length short-start-name))
2251 (cons (cons subexpression
2255 ;; Multiple groups to be named in a special
2256 ;; way by displaying the range over which we
2257 ;; have grouped them.
2259 (cons (cons (concat short-start-name
2264 ;; Reset short group list information every time.
2265 (setq short-group-list nil
2266 short-start-name nil
2268 num-shorts-grouped 0)))
2269 ;; Ok, now that we cleaned up the short-group-list,
2270 ;; we can deal with this new list, to decide if it
2271 ;; should go on one of these sub-lists or not.
2272 (if (< (length l) speedbar-tag-regroup-maximum-length)
2273 (setq short-group-list (append l short-group-list)
2274 num-shorts-grouped (1+ num-shorts-grouped)
2275 short-end-name (car tmp)
2276 short-start-name (if short-start-name
2279 (setq work-list (cons tmp work-list))))))
2280 (setq diff-idx (1+ diff-idx))))
2281 ;; Did we run out of things? Drop our new list onto the end.
2283 ((and short-group-list (= (length short-group-list) num-shorts-grouped))
2284 ;; All singles? Junk list
2285 (setq junk-list (append short-group-list junk-list)))
2286 ((= num-shorts-grouped 1)
2287 ;; Only one short group? Just stick it in
2290 (cons (cons (speedbar-try-completion "" short-group-list)
2294 ;; Multiple groups to be named in a special
2295 ;; way by displaying the range over which we
2296 ;; have grouped them.
2298 (cons (cons (concat short-start-name " to " short-end-name)
2301 ;; Reverse the work list nreversed when consing.
2302 (setq work-list (nreverse work-list))
2303 ;; Now, stick our new list onto the end of
2306 (append newlst work-list junk-list)
2307 (append newlst work-list))
2308 (append newlst junk-list)))))
2310 (defun speedbar-trim-words-tag-hierarchy (lst)
2311 "Trim all words in a tag hierarchy.
2312 Base trimming information on word separators, and group names.
2313 Argument LST is the list of tags to trim."
2320 (if (speedbar-generic-list-group-p (car-safe lst))
2321 (setq newlst (cons (car lst) newlst))
2322 (setq sublst (cons (car lst) sublst)))
2323 (setq lst (cdr lst)))
2324 ;; Get the prefix to trim by. Make sure that we don't trim
2325 ;; off silly pieces, only complete understandable words.
2326 (setq trim-prefix (speedbar-try-completion "" sublst)
2327 newlst (nreverse newlst))
2328 (if (or (= (length sublst) 1)
2330 (not (string-match "\\(\\w+\\W+\\)+" trim-prefix)))
2331 (append newlst (nreverse sublst))
2332 (setq trim-prefix (substring trim-prefix (match-beginning 0)
2334 (setq trim-chars (length trim-prefix))
2337 (cons (substring (car (car sublst)) trim-chars)
2340 sublst (cdr sublst)))
2341 ;; Put the lists together
2342 (append newlst trimlst))))
2344 (defun speedbar-simple-group-tag-hierarchy (lst)
2345 "Create a simple 'Tags' group with orphaned tags.
2346 Argument LST is the list of tags to sort into groups."
2350 (if (speedbar-generic-list-group-p (car-safe lst))
2351 (setq newlst (cons (car lst) newlst))
2352 (setq sublst (cons (car lst) sublst)))
2353 (setq lst (cdr lst)))
2356 (setq newlst (cons (cons "Tags" (nreverse sublst)) newlst))
2357 (nreverse newlst))))
2359 (defun speedbar-create-tag-hierarchy (lst)
2360 "Adjust the tag hierarchy in LST, and return it.
2361 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2363 (let* ((f (save-excursion
2365 (or (speedbar-line-file)
2366 (speedbar-line-directory))))
2367 (methods (if (get-file-buffer f)
2368 (with-current-buffer (get-file-buffer f)
2369 speedbar-tag-hierarchy-method)
2370 speedbar-tag-hierarchy-method))
2371 (lst (if (fboundp 'copy-tree)
2375 (setq lst (funcall (car methods) lst)
2376 methods (cdr methods)))
2379 (defvar speedbar-generic-list-group-expand-button-type 'curly
2380 "The type of button created for groups of tags.
2381 Good values for this are `curly' and `expandtag'.
2382 Make buffer local for your mode.")
2384 (defvar speedbar-generic-list-tag-button-type nil
2385 "The type of button created for tags in generic lists.
2386 Good values for this are nil and `statictag'.
2387 Make buffer local for your mode.")
2389 (defun speedbar-insert-generic-list (level lst expand-fun find-fun)
2390 "At LEVEL, insert a generic multi-level alist LST.
2391 Associations with lists get {+} tags (to expand into more nodes) and
2392 those with positions just get a > as the indicator. {+} buttons will
2393 have the function EXPAND-FUN and the token is the cdr list. The token
2394 name will have the function FIND-FUN and not token."
2395 ;; Remove imenu rescan button
2396 (if (string= (car (car lst)) "*Rescan*")
2397 (setq lst (cdr lst)))
2398 ;; Get, and set up variables that define how we treat these tags.
2399 (let ((f (save-excursion (forward-line -1)
2400 (or (speedbar-line-file)
2401 (speedbar-line-directory))))
2402 expand-button tag-button)
2404 (if (get-file-buffer f)
2405 (set-buffer (get-file-buffer f)))
2406 (setq expand-button speedbar-generic-list-group-expand-button-type
2407 tag-button speedbar-generic-list-tag-button-type))
2409 (setq lst (speedbar-create-tag-hierarchy lst))
2412 (cond ((null (car-safe lst)) nil) ;this would be a separator
2413 ((speedbar-generic-list-tag-p (car lst))
2414 (speedbar-make-tag-line tag-button
2415 nil nil nil ;no expand button data
2416 (car (car lst)) ;button name
2418 (cdr (car lst)) ;token is position
2421 ((speedbar-generic-list-positioned-group-p (car lst))
2422 (speedbar-make-tag-line expand-button
2423 ?+ expand-fun (cdr (cdr (car lst)))
2424 (car (car lst)) ;button name
2426 (car (cdr (car lst))) ;token is posn
2429 ((speedbar-generic-list-group-p (car lst))
2430 (speedbar-make-tag-line expand-button
2431 ?+ expand-fun (cdr (car lst))
2432 (car (car lst)) ;button name
2433 nil nil 'speedbar-tag-face
2435 (t (speedbar-message "speedbar-insert-generic-list: malformed list!")
2437 (setq lst (cdr lst)))))
2439 (defun speedbar-insert-imenu-list (indent lst)
2440 "At level INDENT, insert the imenu generated LST."
2441 (speedbar-insert-generic-list indent lst
2442 'speedbar-tag-expand
2443 'speedbar-tag-find))
2445 (defun speedbar-insert-etags-list (indent lst)
2446 "At level INDENT, insert the etags generated LST."
2447 (speedbar-insert-generic-list indent lst
2448 'speedbar-tag-expand
2449 'speedbar-tag-find))
2453 (defun speedbar-update-contents ()
2454 "Generically update the contents of the speedbar buffer."
2456 ;; Set the current special buffer
2457 (setq speedbar-desired-buffer nil)
2459 ;; Check for special modes
2460 (speedbar-maybe-add-localized-support (current-buffer))
2462 ;; Choose the correct method of doodling.
2463 (if (and speedbar-mode-specific-contents-flag
2464 (consp speedbar-special-mode-expansion-list)
2466 'speedbar-special-mode-expansion-list
2468 ;;(eq (get major-mode 'mode-class 'special)))
2469 (speedbar-update-special-contents)
2470 (speedbar-update-directory-contents)))
2472 (defun speedbar-update-localized-contents ()
2473 "Update the contents of the speedbar buffer for the current situation."
2474 ;; Due to the historical growth of speedbar, we need to do something
2475 ;; special for "files" mode. Too bad.
2476 (let ((name speedbar-initial-expansion-list-name)
2477 (funclst (speedbar-initial-expansion-list))
2479 (if (string= name "files")
2480 ;; Do all the files type work. It still goes through the
2481 ;; expansion list stuff. :(
2482 (if (or (member (expand-file-name default-directory)
2483 speedbar-shown-directories)
2484 (and speedbar-ignored-directory-regexp
2486 speedbar-ignored-directory-regexp
2487 (expand-file-name default-directory))))
2489 (if (<= 1 speedbar-verbosity-level)
2490 (speedbar-message "Updating speedbar to: %s..."
2492 (speedbar-update-directory-contents)
2493 (if (<= 1 speedbar-verbosity-level)
2495 (speedbar-message "Updating speedbar to: %s...done"
2497 (speedbar-message nil))))
2498 ;; Else, we can do a short cut. No text cache.
2499 (let ((cbd (expand-file-name default-directory)))
2500 (set-buffer speedbar-buffer)
2501 (speedbar-with-writable
2502 (let* ((window (get-buffer-window speedbar-buffer 0))
2503 (p (window-point window))
2504 (start (window-start window)))
2506 (dolist (func funclst)
2507 (setq default-directory cbd)
2508 (funcall func cbd 0))
2509 (speedbar-reconfigure-keymaps)
2510 (set-window-point window p)
2511 (set-window-start window start)))))))
2513 (defun speedbar-update-directory-contents ()
2514 "Update the contents of the speedbar buffer based on the current directory."
2515 (let ((cbd (expand-file-name default-directory))
2517 (funclst (speedbar-initial-expansion-list))
2518 (cache speedbar-full-text-cache)
2519 ;; disable stealth during update
2520 (speedbar-stealthy-function-list nil)
2523 ;; Because there is a bug I can't find just yet
2525 (set-buffer speedbar-buffer)
2526 ;; If we are updating contents to where we are, then this is
2527 ;; really a request to update existing contents, so we must be
2528 ;; careful with our text cache!
2529 (if (member cbd speedbar-shown-directories)
2532 ;; If the current directory is not the last element in the dir
2533 ;; list, then we ALSO need to zap the list of expanded directories
2534 (if (/= (length (member cbd speedbar-shown-directories)) 1)
2535 (setq speedbar-shown-directories (list cbd))))
2537 ;; Build cbd-parent, and see if THAT is in the current shown
2538 ;; directories. First, go through pains to get the parent directory
2539 (if (and speedbar-smart-directory-expand-flag
2541 (setq cbd-parent cbd)
2542 (if (string-match "[/\\]$" cbd-parent)
2543 (setq cbd-parent (substring cbd-parent 0
2544 (match-beginning 0))))
2545 (setq cbd-parent (file-name-directory cbd-parent)))
2546 (member cbd-parent speedbar-shown-directories))
2547 (setq expand-local t)
2549 ;; If this directory is NOT in the current list of available
2550 ;; directories, then use the cache, and set the cache to our new
2551 ;; value. Make sure to unhighlight the current file, or if we
2552 ;; come back to this directory, it might be a different file
2553 ;; and then we get a mess!
2554 (if (> (point-max) 1)
2556 (speedbar-clear-current-file)
2557 (setq speedbar-full-text-cache
2558 (cons speedbar-shown-directories (buffer-string)))))
2560 ;; Check if our new directory is in the list of directories
2561 ;; shown in the text-cache
2562 (if (member cbd (car cache))
2563 (setq speedbar-shown-directories (car cache)
2565 ;; default the shown directories to this list...
2566 (setq speedbar-shown-directories (list cbd)))
2568 (if (not expand-local) (setq speedbar-last-selected-file nil))
2569 (speedbar-with-writable
2570 (if (and expand-local
2571 ;; Find this directory as a speedbar node.
2572 (speedbar-directory-line cbd))
2574 (speedbar-expand-line)
2575 (let* ((window (get-buffer-window speedbar-buffer 0))
2576 (p (window-point window))
2577 (start (window-start window)))
2580 (setq default-directory
2581 (nth (1- (length speedbar-shown-directories))
2582 speedbar-shown-directories))
2583 (insert (cdr cache)))
2585 (dolist (func funclst)
2586 (setq default-directory cbd)
2587 (funcall func cbd 0))))
2588 (set-window-point window p)
2589 (set-window-start window start)))))
2590 (speedbar-reconfigure-keymaps))
2592 (defun speedbar-update-special-contents ()
2593 "Use the mode-specific variable to fill in the speedbar buffer.
2594 This should only be used by modes classified as special."
2595 (let ((funclst speedbar-special-mode-expansion-list)
2596 (specialbuff (current-buffer)))
2597 (setq speedbar-desired-buffer specialbuff)
2598 (with-current-buffer speedbar-buffer
2599 ;; If we are leaving a directory, cache it.
2600 (if (not speedbar-shown-directories)
2603 ;; Clean up directory maintenance stuff
2604 (speedbar-clear-current-file)
2605 (setq speedbar-full-text-cache
2606 (cons speedbar-shown-directories (buffer-string))
2607 speedbar-shown-directories nil))
2608 ;; Now fill in the buffer with our newly found specialized list.
2609 (speedbar-with-writable
2610 (dolist (func funclst)
2611 ;; We do not erase the buffer because these functions may
2612 ;; decide NOT to update themselves.
2613 (funcall func specialbuff)))))
2614 (speedbar-reconfigure-keymaps))
2616 (defun speedbar-set-timer (timeout)
2617 "Set up the speedbar timer with TIMEOUT.
2618 Uses `dframe-set-timer'.
2619 Also resets scanner functions."
2620 (dframe-set-timer timeout 'speedbar-timer-fn 'speedbar-update-flag)
2621 ;; Apply a revert hook that will reset the scanners. We attach to revert
2622 ;; because most reverts occur during VC state change, and this lets our
2623 ;; VC scanner fix itself.
2625 (add-hook 'after-revert-hook 'speedbar-reset-scanners)
2626 (remove-hook 'after-revert-hook 'speedbar-reset-scanners))
2627 ;; change this if it changed for some reason
2628 (speedbar-set-mode-line-format))
2630 (defun speedbar-timer-fn ()
2631 "Run whenever Emacs is idle to update the speedbar item."
2632 (if (or (not (speedbar-current-frame))
2633 (not (frame-live-p (speedbar-current-frame))))
2634 (speedbar-set-timer nil)
2635 ;; Save all the match data so that we don't mess up executing fns
2637 ;; Only do stuff if the frame is visible, not an icon, and if
2638 ;; it is currently flagged to do something.
2639 (if (and speedbar-update-flag
2640 (speedbar-current-frame)
2641 (frame-visible-p (speedbar-current-frame))
2642 (not (eq (frame-visible-p (speedbar-current-frame)) 'icon)))
2643 (let ((af (selected-frame)))
2644 (dframe-select-attached-frame speedbar-frame)
2645 ;; make sure we at least choose a window to
2646 ;; get a good directory from
2647 (if (window-minibuffer-p (selected-window))
2649 ;; Check for special modes
2650 (speedbar-maybe-add-localized-support (current-buffer))
2651 ;; Update for special mode all the time!
2652 (if (and speedbar-mode-specific-contents-flag
2653 (consp speedbar-special-mode-expansion-list)
2655 'speedbar-special-mode-expansion-list
2657 ;;(eq (get major-mode 'mode-class 'special)))
2659 (if (<= 2 speedbar-verbosity-level)
2661 "Updating speedbar to special mode: %s..."
2663 (speedbar-update-special-contents)
2664 (if (<= 2 speedbar-verbosity-level)
2667 "Updating speedbar to special mode: %s...done"
2669 (speedbar-message nil))))
2671 ;; Update all the contents if directories change!
2672 (unless (and (or (member major-mode speedbar-ignored-modes)
2673 (eq af (speedbar-current-frame))
2674 (not (buffer-file-name)))
2675 ;; Always update for GUD.
2676 (not (string-equal "GUD"
2677 speedbar-initial-expansion-list-name)))
2678 (speedbar-update-localized-contents)))
2680 ;; Now run stealthy updates of time-consuming items
2681 (speedbar-stealthy-updates)))))
2682 (run-hooks 'speedbar-timer-hook))
2685 ;;; Stealthy activities
2687 (defvar speedbar-stealthy-update-recurse nil
2688 "Recursion avoidance variable for stealthy update.")
2690 (defun speedbar-stealthy-updates ()
2691 "For a given speedbar, run all items in the stealthy function list.
2692 Each item returns t if it completes successfully, or nil if
2693 interrupted by the user."
2694 (if (not speedbar-stealthy-update-recurse)
2695 (let ((l (speedbar-initial-stealthy-functions))
2696 (speedbar-stealthy-update-recurse t))
2698 (speedbar-with-writable
2699 (while (and l (funcall (car l)))
2702 ;;(speedbar-message "Exit with %S" (car l))
2705 (defun speedbar-reset-scanners ()
2706 "Reset any variables used by functions in the stealthy list as state.
2707 If new functions are added, their state needs to be updated here."
2708 (setq speedbar-vc-to-do-point t
2709 speedbar-obj-to-do-point t
2710 speedbar-ro-to-do-point t)
2711 (run-hooks 'speedbar-scanner-reset-hook)
2714 (defun speedbar-find-selected-file (file)
2715 "Go to the line where FILE is."
2717 (set-buffer speedbar-buffer)
2719 (goto-char (point-min))
2721 (while (and (setq m (re-search-forward
2722 (concat " \\(" (regexp-quote (file-name-nondirectory file))
2723 "\\)\\(" speedbar-indicator-regex "\\)?\n")
2727 (speedbar-line-directory
2729 (goto-char (match-beginning 0))
2732 (looking-at "[0-9]+:")
2733 (string-to-number (match-string 0)))))
2734 (match-string 1))))))
2737 (goto-char (match-beginning 1))
2738 (match-string 1)))))
2740 (defun speedbar-clear-current-file ()
2741 "Locate the file thought to be current, and remove its highlighting."
2743 ;;(set-buffer speedbar-buffer)
2744 (if speedbar-last-selected-file
2745 (speedbar-with-writable
2746 (if (speedbar-find-selected-file speedbar-last-selected-file)
2747 (put-text-property (match-beginning 1)
2750 'speedbar-file-face))))))
2752 (defun speedbar-update-current-file ()
2753 "Find the current file, and update our visuals to indicate its name.
2754 This is specific to file names. If the file name doesn't show up, but
2755 it should be in the list, then the directory cache needs to be updated."
2756 (let* ((lastf (selected-frame))
2757 (newcfd (save-excursion
2758 (dframe-select-attached-frame speedbar-frame)
2759 (let ((rf (if (buffer-file-name)
2762 (select-frame lastf)
2764 (newcf (if newcfd newcfd))
2765 (lastb (current-buffer))
2766 (sucf-recursive (boundp 'sucf-recursive))
2767 (case-fold-search t))
2769 ;; check here, that way we won't refresh to newcf until
2770 ;; its been written, thus saving ourselves some time
2771 (file-exists-p newcf)
2772 (not (string= newcf speedbar-last-selected-file)))
2774 ;; It is important to select the frame, otherwise the window
2775 ;; we want the cursor to move in will not be updated by the
2776 ;; search-forward command.
2777 (select-frame (speedbar-current-frame))
2778 ;; Remove the old file...
2779 (speedbar-clear-current-file)
2780 ;; now highlight the new one.
2781 ;; (set-buffer speedbar-buffer)
2782 (speedbar-with-writable
2783 (if (speedbar-find-selected-file newcf)
2784 ;; put the property on it
2785 (put-text-property (match-beginning 1)
2788 'speedbar-selected-face)
2789 ;; Oops, it's not in the list. Should it be?
2790 (if (and (string-match speedbar-file-regexp newcf)
2791 (string= (file-name-directory newcfd)
2792 (expand-file-name default-directory)))
2793 ;; yes, it is (we will ignore unknowns for now...)
2796 (if (speedbar-find-selected-file newcf)
2797 ;; put the property on it
2798 (put-text-property (match-beginning 1)
2801 'speedbar-selected-face)))
2802 ;; if it's not in there now, whatever...
2804 (setq speedbar-last-selected-file newcf))
2805 (if (not sucf-recursive)
2808 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2809 ;;doesn't need to be in. We don't want to recenter when we are
2812 ;;(speedbar-center-buffer-smartly)
2814 (speedbar-position-cursor-on-line)
2817 (select-frame lastf)
2819 ;; return that we are done with this activity.
2822 (defun speedbar-add-indicator (indicator-string &optional replace-this)
2823 "Add INDICATOR-STRING to the end of this speedbar line.
2824 If INDICATOR-STRING is space, and REPLACE-THIS is a character,
2825 then the existing indicator is removed. If there is already an
2826 indicator, then do not add a space."
2828 ;; The nature of the beast: Assume we are in "the right place"
2830 (skip-chars-backward (concat " " speedbar-vc-indicator
2831 speedbar-object-read-only-indicator
2832 (car speedbar-obj-indicator)
2833 (cdr speedbar-obj-indicator)))
2834 (if (and (not (looking-at speedbar-indicator-regex))
2835 (not (string= indicator-string " ")))
2836 (insert speedbar-indicator-separator))
2837 (speedbar-with-writable
2839 (if (and replace-this
2840 (re-search-forward replace-this (line-end-position) t))
2841 (delete-region (match-beginning 0) (match-end 0))))
2843 (if (not (string= " " indicator-string))
2844 (let ((start (point)))
2845 (insert indicator-string)
2846 (speedbar-insert-image-button-maybe start (length indicator-string))
2849 (defun speedbar-check-read-only ()
2850 "Scan all the files in a directory, and for each see if it is read only."
2851 ;; Check for to-do to be reset. If reset but no RCS is available
2852 ;; then set to nil (do nothing) otherwise, start at the beginning
2854 (if speedbar-buffer (set-buffer speedbar-buffer))
2855 (if (eq speedbar-ro-to-do-point t)
2856 (setq speedbar-ro-to-do-point 0))
2857 (if (numberp speedbar-ro-to-do-point)
2859 (goto-char speedbar-ro-to-do-point)
2860 (while (and (not (input-pending-p))
2861 (re-search-forward "^\\([0-9]+\\):\\s-*[[<][+-\?][]>] "
2863 (setq speedbar-ro-to-do-point (point))
2864 (let ((f (speedbar-line-file)))
2866 (if (not (file-writable-p f))
2867 (speedbar-add-indicator
2868 speedbar-object-read-only-indicator
2869 (regexp-quote speedbar-object-read-only-indicator))
2870 (speedbar-add-indicator
2872 speedbar-object-read-only-indicator))))))
2873 (if (input-pending-p)
2874 ;; return that we are incomplete
2876 ;; we are done, set to-do to nil
2877 (setq speedbar-ro-to-do-point nil)
2882 (defun speedbar-check-vc ()
2883 "Scan all files in a directory, and for each see if it's checked out.
2884 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2885 to add more types of version control systems."
2886 ;; Check for to-do to be reset. If reset but no RCS is available
2887 ;; then set to nil (do nothing) otherwise, start at the beginning
2889 (if speedbar-buffer (set-buffer speedbar-buffer))
2890 (if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t)
2891 (speedbar-vc-check-dir-p default-directory)
2892 (not (or (and (featurep 'ange-ftp)
2895 (if (featurep 'xemacs)
2896 'ange-ftp-directory-format
2897 'ange-ftp-name-format)))
2898 (expand-file-name default-directory)))
2899 ;; efs support: Bob Weiner
2900 (and (featurep 'efs)
2902 (let ((reg (symbol-value 'efs-directory-regexp)))
2906 (expand-file-name default-directory))))))
2907 (setq speedbar-vc-to-do-point 0))
2908 (if (numberp speedbar-vc-to-do-point)
2910 (goto-char speedbar-vc-to-do-point)
2911 (while (and (not (input-pending-p))
2912 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-?]\\] "
2914 (setq speedbar-vc-to-do-point (point))
2915 (if (speedbar-check-vc-this-line (match-string 1))
2916 (speedbar-add-indicator speedbar-vc-indicator
2917 (regexp-quote speedbar-vc-indicator))
2918 (speedbar-add-indicator " "
2919 (regexp-quote speedbar-vc-indicator))))
2920 (if (input-pending-p)
2921 ;; return that we are incomplete
2923 ;; we are done, set to-do to nil
2924 (setq speedbar-vc-to-do-point nil)
2929 (defun speedbar-check-vc-this-line (depth)
2930 "Return t if the file on this line is checked out of a version control system.
2931 Parameter DEPTH is a string with the current depth of indentation of
2932 the file being checked."
2933 (let* ((d (string-to-number depth))
2934 (f (speedbar-line-directory d))
2935 (fn (buffer-substring-no-properties
2936 ;; Skip-chars: thanks ptype@dra.hmg.gb
2938 (skip-chars-forward "^ " (line-end-position))
2940 (fulln (concat f fn)))
2941 (if (<= 2 speedbar-verbosity-level)
2942 (speedbar-message "Speedbar vc check...%s" fulln))
2943 (and (file-writable-p fulln)
2944 (speedbar-this-file-in-vc f fn))))
2946 (defun speedbar-vc-check-dir-p (directory)
2947 "Return t if we should bother checking DIRECTORY for version control files.
2948 This can be overloaded to add new types of version control systems."
2950 (catch t (dolist (vcd vc-directory-exclusion-list)
2951 (if (file-exists-p (concat directory vcd)) (throw t t))) nil)
2953 (run-hook-with-args-until-success 'speedbar-vc-directory-enable-hook
2957 (defun speedbar-this-file-in-vc (directory name)
2958 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2959 Automatically recognizes all VCs supported by VC mode. You can
2960 optimize this function by overriding it and only doing those checks
2961 that will occur on your system."
2963 (vc-backend (concat directory "/" name))
2965 (run-hook-with-args 'speedbar-vc-in-control-hook directory name)
2968 ;; Objet File scanning
2969 (defun speedbar-check-objects ()
2970 "Scan all files in a directory, and for each see if there is an object.
2971 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2972 to add more object types."
2973 ;; Check for to-do to be reset. If reset but no RCS is available
2974 ;; then set to nil (do nothing) otherwise, start at the beginning
2976 (if speedbar-buffer (set-buffer speedbar-buffer))
2977 (if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t))
2978 (setq speedbar-obj-to-do-point 0))
2979 (if (numberp speedbar-obj-to-do-point)
2981 (goto-char speedbar-obj-to-do-point)
2982 (while (and (not (input-pending-p))
2983 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
2985 (setq speedbar-obj-to-do-point (point))
2986 (let ((ind (speedbar-check-obj-this-line (match-string 1))))
2987 (if (not ind) (setq ind " "))
2988 (speedbar-add-indicator ind (concat
2989 (car speedbar-obj-indicator)
2991 (cdr speedbar-obj-indicator)))))
2992 (if (input-pending-p)
2993 ;; return that we are incomplete
2995 ;; we are done, set to-do to nil
2996 (setq speedbar-obj-to-do-point nil)
3001 (defun speedbar-check-obj-this-line (depth)
3002 "Return t if the file on this line has an associated object.
3003 Parameter DEPTH is a string with the current depth of indentation of
3004 the file being checked."
3005 (let* ((d (string-to-number depth))
3006 (f (speedbar-line-directory d))
3007 (fn (buffer-substring-no-properties
3008 ;; Skip-chars: thanks ptype@dra.hmg.gb
3010 (skip-chars-forward "^ " (line-end-position))
3012 (fulln (concat f fn)))
3013 (if (<= 2 speedbar-verbosity-level)
3014 (speedbar-message "Speedbar obj check...%s" fulln))
3015 (let ((oa speedbar-obj-alist))
3016 (while (and oa (not (string-match (car (car oa)) fulln)))
3018 (if (not (and oa (file-exists-p (concat (file-name-sans-extension fulln)
3021 ;; Find out if the object is out of date or not.
3022 (let ((date1 (nth 5 (file-attributes fulln)))
3023 (date2 (nth 5 (file-attributes (concat
3024 (file-name-sans-extension fulln)
3026 (if (or (< (car date1) (car date2))
3027 (and (= (car date1) (car date2))
3028 (< (nth 1 date1) (nth 1 date2))))
3029 (car speedbar-obj-indicator)
3030 (cdr speedbar-obj-indicator)))))))
3032 ;;; Clicking Activity
3034 (defun speedbar-position-cursor-on-line ()
3035 "Position the cursor on a line."
3036 (let ((oldpos (point)))
3038 (if (looking-at "[0-9]+:\\s-*..?.? ")
3039 (goto-char (1- (match-end 0)))
3040 (goto-char oldpos))))
3042 (defun speedbar-click (e)
3043 "Activate any speedbar buttons where the mouse is clicked.
3044 This must be bound to a mouse event. A button is any location of text
3045 with a mouse face that has a text property called `speedbar-function'.
3046 Argument E is the click event."
3047 ;; Backward compatibility let statement.
3048 (let ((speedbar-power-click dframe-power-click))
3049 (speedbar-do-function-pointer))
3050 (dframe-quick-mouse e))
3052 (defun speedbar-do-function-pointer ()
3053 "Look under the cursor and examine the text properties.
3054 From this extract the file/tag name, token, indentation level and call
3055 a function if appropriate."
3056 (let* ((speedbar-frame (speedbar-current-frame))
3057 (fn (get-text-property (point) 'speedbar-function))
3058 (tok (get-text-property (point) 'speedbar-token))
3059 ;; The 1-,+ is safe because scaning starts AFTER the point
3060 ;; specified. This lets the search include the character the
3062 (tp (previous-single-property-change
3063 (1+ (point)) 'speedbar-function))
3064 (np (next-single-property-change
3065 (point) 'speedbar-function))
3066 (txt (buffer-substring-no-properties (or tp (point-min))
3067 (or np (point-max))))
3068 (dent (save-excursion (beginning-of-line)
3070 (if (looking-at "[0-9]+")
3071 (buffer-substring-no-properties
3072 (match-beginning 0) (match-end 0))
3074 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3075 (and fn (funcall fn txt tok dent)))
3076 (speedbar-position-cursor-on-line))
3078 ;;; Reading info from the speedbar buffer
3080 (defun speedbar-line-text (&optional p)
3081 "Retrieve the text after prefix junk for the current line.
3082 Optional argument P is where to start the search from."
3084 (if p (goto-char p))
3086 (if (looking-at (concat
3087 "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)"))
3088 (get-text-property (match-beginning 2) 'speedbar-text)
3091 (defun speedbar-line-token (&optional p)
3092 "Retrieve the token information after the prefix junk for the current line.
3093 Optional argument P is where to start the search from."
3095 (if p (goto-char p))
3097 (if (looking-at (concat
3098 "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)\\("
3099 speedbar-indicator-regex "\\)?"))
3101 (goto-char (match-beginning 2))
3102 (get-text-property (point) 'speedbar-token))
3105 (defun speedbar-line-file (&optional p)
3106 "Retrieve the file or whatever from the line at point P.
3107 The return value is a string representing the file. If it is a
3108 directory, then it is the directory name."
3112 (let ((f (speedbar-line-text p)))
3114 (let* ((depth (string-to-number (match-string 1)))
3115 (directory (speedbar-line-directory depth)))
3116 (if (file-exists-p (concat directory f))
3117 (concat directory f)
3121 (defun speedbar-goto-this-file (file)
3122 "If FILE is displayed, go to this line and return t.
3123 Otherwise do not move and return nil."
3124 (let ((directory (substring (file-name-directory (expand-file-name file))
3125 (length (expand-file-name default-directory))))
3128 (goto-char (point-min))
3129 ;; scan all the directories
3130 (while (and directory (not (eq directory t)))
3131 (if (string-match "^[/\\]?\\([^/\\]+\\)" directory)
3132 (let ((pp (match-string 1 directory)))
3133 (if (save-match-data
3134 (re-search-forward (concat "> " (regexp-quote pp) "$")
3136 (setq directory (substring directory (match-end 1)))
3137 (setq directory nil)))
3138 (setq directory t)))
3139 ;; find the file part
3140 (if (or (not directory) (string= (file-name-nondirectory file) ""))
3141 ;; only had a dir part
3144 (speedbar-position-cursor-on-line)
3146 (goto-char dest) nil)
3147 ;; find the file part
3148 (let ((nd (file-name-nondirectory file)))
3149 (if (re-search-forward
3150 (concat "] \\(" (regexp-quote nd)
3151 "\\)\\(" speedbar-indicator-regex "\\)$")
3154 (speedbar-position-cursor-on-line)
3159 (defun speedbar-line-directory (&optional depth)
3160 "Retrieve the directory name associated with the current line.
3161 This may require traversing backwards from DEPTH and combining the default
3162 directory with these items. This function is replaceable in
3163 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3166 (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-directory)))
3167 (if rf (funcall rf depth) default-directory))))
3169 (defun speedbar-files-line-directory (&optional depth)
3170 "Retrieve the directory associated with the current line.
3171 This may require traversing backwards from DEPTH and combining the default
3172 directory with these items."
3178 (looking-at "^\\([0-9]+\\):")
3179 (setq depth (string-to-number (match-string 1)))))
3180 (let ((directory nil))
3181 (setq depth (1- depth))
3182 (while (/= depth -1)
3183 (if (not (re-search-backward (format "^%d:" depth) nil t))
3184 (error "Error building filename of tag")
3185 (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)")
3186 (setq directory (concat (speedbar-line-text)
3189 ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)")
3190 ;; This is the start of our directory.
3191 (setq directory (speedbar-line-text)))))
3192 (setq depth (1- depth)))
3194 (string-match (concat speedbar-indicator-regex "$")
3196 (setq directory (substring directory 0 (match-beginning 0))))
3197 (concat default-directory directory)))))
3199 (defun speedbar-directory-line (directory)
3200 "Position the cursor on the line specified by DIRECTORY."
3202 (if (string-match "[/\\]$" directory)
3203 (setq directory (substring directory 0 (match-beginning 0))))
3204 (let ((nomatch t) (depth 0)
3205 (fname (file-name-nondirectory directory))
3206 (pname (file-name-directory directory)))
3207 (if (not (member pname speedbar-shown-directories))
3208 (error "Internal Error: File %s not shown in speedbar" directory))
3209 (goto-char (point-min))
3212 (concat "[]>] \\(" (regexp-quote fname)
3213 "\\)\\(" speedbar-indicator-regex "\\)?$")
3216 (looking-at "\\([0-9]+\\):")
3217 (setq depth (string-to-number (match-string 0))
3218 nomatch (not (string= pname (speedbar-line-directory depth))))
3223 (defun speedbar-edit-line ()
3224 "Edit whatever tag or file is on the current speedbar line."
3228 ;; If this fails, then it is a non-standard click, and as such,
3229 ;; perfectly allowed.
3230 (if (re-search-forward "[]>?}] [^ ]"
3235 (speedbar-do-function-pointer))
3237 (speedbar-do-function-pointer)))
3239 (defun speedbar-expand-line (&optional arg)
3240 "Expand the line under the cursor.
3241 With universal argument ARG, flush cached data."
3244 (let* ((dframe-power-click arg)
3245 (speedbar-power-click arg))
3248 (re-search-forward ":\\s-*.\\+. "
3249 (line-end-position))
3251 (speedbar-do-function-pointer))
3252 (error (speedbar-position-cursor-on-line)))))
3254 (defun speedbar-flush-expand-line ()
3255 "Expand the line under the cursor and flush any cached information."
3257 (speedbar-expand-line 1))
3259 (defun speedbar-contract-line ()
3260 "Contract the line under the cursor."
3265 (re-search-forward ":\\s-*.-. "
3266 (line-end-position))
3268 (speedbar-do-function-pointer))
3269 (error (speedbar-position-cursor-on-line))))
3271 (defun speedbar-toggle-line-expansion ()
3272 "Contract or expand the line under the cursor."
3277 (re-search-forward ":\\s-*.[-+]. "
3278 (line-end-position))
3280 (speedbar-do-function-pointer))
3281 (error (speedbar-position-cursor-on-line))))
3283 (defun speedbar-expand-line-descendants (&optional arg)
3284 "Expand the line under the cursor and all descendants.
3285 Optional argument ARG indicates that any cache should be flushed."
3287 (speedbar-expand-line arg)
3288 ;; Now, inside the area expaded here, expand all subnodes of
3289 ;; the same descendant type.
3291 (speedbar-next 1) ;; Move into the list.
3296 (speedbar-expand-line-descendants arg)
3297 (speedbar-restricted-next 1))
3298 (error (setq err t))))))
3301 (defun speedbar-contract-line-descendants ()
3302 "Expand the line under the cursor and all descendants."
3304 (speedbar-contract-line)
3305 ;; Don't need to do anything else since all descendants are
3306 ;; hidden by default anyway. Yay! It's easy.
3309 (defun speedbar-find-file (text token indent)
3310 "Speedbar click handler for filenames.
3311 TEXT, the file will be displayed in the attached frame.
3312 TOKEN is unused, but required by the click handler. INDENT is the
3313 current indentation level."
3314 (let ((cdd (speedbar-line-directory indent)))
3315 ;; Run before visiting file hook here.
3316 (let ((f (selected-frame)))
3317 (dframe-select-attached-frame speedbar-frame)
3318 (run-hooks 'speedbar-before-visiting-file-hook)
3320 (speedbar-find-file-in-frame (concat cdd text))
3321 (speedbar-stealthy-updates)
3322 (run-hooks 'speedbar-visiting-file-hook)
3323 ;; Reset the timer with a new timeout when cliking a file
3324 ;; in case the user was navigating directories, we can cancel
3325 ;; that other timer.
3326 (speedbar-set-timer dframe-update-speed))
3327 (dframe-maybee-jump-to-attached-frame))
3329 (defun speedbar-dir-follow (text token indent)
3330 "Speedbar click handler for directory names.
3331 Clicking a directory will cause the speedbar to list files in
3332 the subdirectory TEXT. TOKEN is an unused requirement. The
3333 subdirectory chosen will be at INDENT level."
3334 (setq default-directory
3335 (concat (expand-file-name (concat (speedbar-line-directory indent) text))
3337 ;; Because we leave speedbar as the current buffer,
3338 ;; update contents will change directory without
3339 ;; having to touch the attached frame. Turn off smart expand just
3341 (let ((speedbar-smart-directory-expand-flag nil))
3342 (speedbar-update-contents))
3343 (speedbar-set-timer speedbar-navigating-speed)
3344 (setq speedbar-last-selected-file nil)
3345 (speedbar-stealthy-updates))
3347 (defun speedbar-delete-subblock (indent)
3348 "Delete text from point to indentation level INDENT or greater.
3349 Handles end-of-sublist smartly."
3350 (speedbar-with-writable
3352 (end-of-line) (forward-char 1)
3353 (let ((start (point)))
3354 (while (and (looking-at "^\\([0-9]+\\):")
3355 (> (string-to-number (match-string 1)) indent)
3358 (beginning-of-line))
3359 (delete-region start (point))))))
3361 (defun speedbar-dired (text token indent)
3362 "Speedbar click handler for directory expand button.
3363 Clicking this button expands or contracts a directory. TEXT is the
3364 button clicked which has either a + or -. TOKEN is the directory to be
3365 expanded. INDENT is the current indentation level."
3366 (cond ((string-match "+" text) ;we have to expand this dir
3367 (setq speedbar-shown-directories
3368 (cons (expand-file-name
3369 (concat (speedbar-line-directory indent) token "/"))
3370 speedbar-shown-directories))
3371 (speedbar-change-expand-button-char ?-)
3372 (speedbar-reset-scanners)
3374 (end-of-line) (forward-char 1)
3375 (speedbar-with-writable
3376 (speedbar-default-directory-list
3377 (concat (speedbar-line-directory indent) token "/")
3379 ((string-match "-" text) ;we have to contract this node
3380 (speedbar-reset-scanners)
3381 (let ((oldl speedbar-shown-directories)
3383 (td (expand-file-name
3384 (concat (speedbar-line-directory indent) token))))
3386 (if (not (string-match (concat "^" (regexp-quote td)) (car oldl)))
3387 (setq newl (cons (car oldl) newl)))
3388 (setq oldl (cdr oldl)))
3389 (setq speedbar-shown-directories (nreverse newl)))
3390 (speedbar-change-expand-button-char ?+)
3391 (speedbar-delete-subblock indent)
3393 (t (error "Ooops... not sure what to do")))
3394 (speedbar-center-buffer-smartly)
3395 (save-excursion (speedbar-stealthy-updates)))
3397 (defun speedbar-directory-buttons-follow (text token indent)
3398 "Speedbar click handler for default directory buttons.
3399 TEXT is the button clicked on. TOKEN is the directory to follow.
3400 INDENT is the current indentation level and is unused."
3401 (if (string-match "^[A-z]:$" token)
3402 (setq default-directory (concat token "/"))
3403 (setq default-directory token))
3404 ;; Because we leave speedbar as the current buffer,
3405 ;; update contents will change directory without
3406 ;; having to touch the attached frame.
3407 (speedbar-update-contents)
3408 (speedbar-set-timer speedbar-navigating-speed))
3410 (defun speedbar-tag-file (text token indent)
3411 "The cursor is on a selected line. Expand the tags in the specified file.
3412 The parameter TEXT and TOKEN are required, where TEXT is the button
3413 clicked, and TOKEN is the file to expand. INDENT is the current
3415 (cond ((string-match "+" text) ;we have to expand this file
3416 (let* ((fn (expand-file-name (concat (speedbar-line-directory indent)
3419 (lst (speedbar-fetch-dynamic-tags fn)))
3420 ;; if no list, then remove expando button
3422 (speedbar-change-expand-button-char ??)
3423 (speedbar-change-expand-button-char ?-)
3424 (speedbar-with-writable
3426 (end-of-line) (forward-char 1)
3427 (funcall (car lst) indent (cdr lst)))))))
3428 ((string-match "-" text) ;we have to contract this node
3429 (speedbar-change-expand-button-char ?+)
3430 (speedbar-delete-subblock indent))
3431 (t (error "Ooops... not sure what to do")))
3432 (speedbar-center-buffer-smartly))
3434 (defun speedbar-tag-find (text token indent)
3435 "For the tag TEXT in a file TOKEN, go to that position.
3436 INDENT is the current indentation level."
3437 (let ((file (speedbar-line-directory indent)))
3438 (let ((f (selected-frame)))
3439 (dframe-select-attached-frame speedbar-frame)
3440 (run-hooks 'speedbar-before-visiting-tag-hook)
3442 (speedbar-find-file-in-frame file)
3443 (save-excursion (speedbar-stealthy-updates))
3444 ;; Reset the timer with a new timeout when cliking a file
3445 ;; in case the user was navigating directories, we can cancel
3446 ;; that other timer.
3447 (speedbar-set-timer dframe-update-speed)
3449 (run-hooks 'speedbar-visiting-tag-hook)
3450 (dframe-maybee-jump-to-attached-frame)
3453 (defun speedbar-tag-expand (text token indent)
3454 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3455 Etags does not support this feature. TEXT will be the button string.
3456 TOKEN will be the list, and INDENT is the current indentation level."
3457 (cond ((string-match "+" text) ;we have to expand this file
3458 (speedbar-change-expand-button-char ?-)
3459 (speedbar-with-writable
3461 (end-of-line) (forward-char 1)
3462 (speedbar-insert-generic-list indent token 'speedbar-tag-expand
3463 'speedbar-tag-find))))
3464 ((string-match "-" text) ;we have to contract this node
3465 (speedbar-change-expand-button-char ?+)
3466 (speedbar-delete-subblock indent))
3467 (t (error "Ooops... not sure what to do")))
3468 (speedbar-center-buffer-smartly))
3470 ;;; Loading files into the attached frame.
3472 (defcustom speedbar-select-frame-method 'attached
3473 "Specify how to select a frame for displaying a file.
3474 A value of 'attached means to use the attached frame (the frame
3475 that speedbar was started from.) A number such as 1 or -1 means to
3476 pass that number to `other-frame' while selecting a frame from speedbar."
3480 (defun speedbar-find-file-in-frame (file)
3481 "This will load FILE into the speedbar attached frame.
3482 If the file is being displayed in a different frame already, then raise that
3484 (let* ((buff (find-file-noselect file))
3485 (bwin (get-buffer-window buff 0)))
3488 (select-window bwin)
3489 (raise-frame (window-frame bwin)))
3490 (if dframe-power-click
3491 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3492 (if (numberp speedbar-select-frame-method)
3493 (other-frame speedbar-select-frame-method)
3494 (dframe-select-attached-frame speedbar-frame))
3495 (switch-to-buffer buff))))
3498 ;;; Centering Utility
3500 (defun speedbar-center-buffer-smartly ()
3501 "Recenter a speedbar buffer so the current indentation level is all visible.
3502 This assumes that the cursor is on a file, or tag of a file which the user is
3505 (save-selected-window
3507 (select-window (get-buffer-window speedbar-buffer t))
3509 (set-buffer speedbar-buffer)
3511 (if (<= (count-lines (point-min) (point-max))
3512 (1- (window-height (selected-window))))
3513 ;; whole buffer fits
3516 (goto-char (point-min))
3520 (let (depth start end exp p)
3523 (setq depth (if (looking-at "[0-9]+")
3524 (string-to-number (buffer-substring-no-properties
3525 (match-beginning 0) (match-end 0)))
3527 (setq exp (format "^%d:" depth)))
3530 (if (re-search-backward exp nil t)
3531 (setq start (point))
3532 (setq start (point-min)))
3533 (save-excursion ;Not sure about this part.
3536 (while (and (not (re-search-forward exp nil t))
3538 (setq depth (1- depth))
3539 (setq exp (format "^%d:" depth)))
3542 (setq end (point-max)))))
3543 ;; Now work out the details of centering
3544 (let ((nl (count-lines start end))
3545 (wl (1- (window-height (selected-window))))
3548 ;; We can't fit it all, so just center on cursor
3549 (progn (goto-char start)
3551 ;; we can fit everything on the screen, but...
3552 (if (and (pos-visible-in-window-p start (selected-window))
3553 (pos-visible-in-window-p end (selected-window)))
3556 ;; we need to do something...
3558 (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
3559 (lte (count-lines start (point-max))))
3560 (if (and (< (+ newcent lte) (window-height (selected-window)))
3561 (> (- (window-height (selected-window)) lte 1)
3563 (setq newcent (- (window-height (selected-window))
3565 (recenter newcent))))
3568 ;;; Tag Management -- List of expanders:
3570 (defun speedbar-fetch-dynamic-tags (file)
3571 "Return a list of tags generated dynamically from FILE.
3572 This uses the entries in `speedbar-dynamic-tags-function-list'
3573 to find the proper tags. It is up to each of those individual
3574 functions to do caching and flushing if appropriate."
3576 ;; If a file is in memory, switch to that buffer. This allows
3577 ;; us to use the local variable. If the file is on disk, we
3578 ;; can try a few of the defaults that can get tags without
3579 ;; opening the file.
3580 (if (get-file-buffer file)
3581 (set-buffer (get-file-buffer file)))
3582 ;; If there is a buffer-local value of
3583 ;; speedbar-dynamic-tags-function-list, it will now be available.
3584 (let ((dtf speedbar-dynamic-tags-function-list)
3586 (while (and (eq ret t) dtf)
3588 (if (fboundp (car (car dtf)))
3589 (funcall (car (car dtf)) file)
3592 (setq dtf (cdr dtf))))
3594 ;; No valid tag list, return nil
3596 ;; We have some tags. Return the list with the insert fn
3598 (cons (cdr (car dtf)) ret)))))
3600 ;;; Tag Management -- Imenu
3602 (if (not speedbar-use-imenu-flag)
3606 (eval-when-compile (condition-case nil (require 'imenu) (error nil)))
3608 (defun speedbar-fetch-dynamic-imenu (file)
3609 "Load FILE into a buffer, and generate tags using Imenu.
3610 Returns the tag list, or t for an error."
3611 ;; Load this AND compile it in
3613 (set-buffer (find-file-noselect file))
3614 (if dframe-power-click (setq imenu--index-alist nil))
3616 (let ((index-alist (imenu--make-index-alist t)))
3617 (if speedbar-sort-tags
3618 (sort (copy-alist index-alist)
3619 (lambda (a b) (string< (car a) (car b))))
3624 ;;; Tag Management -- etags (old XEmacs compatibility part)
3626 (defvar speedbar-fetch-etags-parse-list
3627 '(;; Note that java has the same parse-group as c
3628 ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\|cxx\\|hxx\\)\\'" .
3629 speedbar-parse-c-or-c++tag)
3630 ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
3631 "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
3632 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3633 ; speedbar-parse-fortran77-tag)
3634 ("\\.tex\\'" . speedbar-parse-tex-string)
3636 "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?")
3638 "Associations of file extensions and expressions for extracting tags.
3639 To add a new file type, you would want to add a new association to the
3640 list, where the car is the file match, and the cdr is the way to
3641 extract an element from the tags output. If the output is complex,
3642 use a function symbol instead of regexp. The function should expect
3643 to be at the beginning of a line in the etags buffer.
3645 This variable is ignored if `speedbar-use-imenu-flag' is non-nil.")
3647 (defvar speedbar-fetch-etags-command "etags"
3648 "*Command used to create an etags file.
3650 This variable is ignored if `speedbar-use-imenu-flag' is t.")
3652 (defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-")
3653 "*List of arguments to use with `speedbar-fetch-etags-command'.
3654 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3655 modify this list conveniently.
3657 This variable is ignored if `speedbar-use-imenu-flag' is t.")
3659 (defun speedbar-toggle-etags (flag)
3660 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3661 FLAG then becomes a member of etags command line arguments. If flag
3662 is \"sort\", then toggle the value of `speedbar-sort-tags'. If its
3663 value is \"show\" then toggle the value of
3664 `speedbar-show-unknown-files'.
3666 This function is a convenience function for XEmacs menu created by
3667 Farzin Guilak <farzin@protocol.com>."
3670 ((equal flag "sort")
3671 (setq speedbar-sort-tags (not speedbar-sort-tags)))
3672 ((equal flag "show")
3673 (setq speedbar-show-unknown-files (not speedbar-show-unknown-files)))
3674 ((or (equal flag "-C")
3677 (if (member flag speedbar-fetch-etags-arguments)
3678 (setq speedbar-fetch-etags-arguments
3679 (delete flag speedbar-fetch-etags-arguments))
3680 (add-to-list 'speedbar-fetch-etags-arguments flag)))
3683 (defun speedbar-fetch-dynamic-etags (file)
3684 "For FILE, run etags and create a list of symbols extracted.
3685 Each symbol will be associated with its line position in FILE."
3686 (let ((newlist nil))
3689 (if (get-buffer "*etags tmp*")
3690 (kill-buffer "*etags tmp*")) ;kill to clean it up
3691 (if (<= 1 speedbar-verbosity-level)
3692 (speedbar-message "Fetching etags..."))
3693 (set-buffer (get-buffer-create "*etags tmp*"))
3694 (apply 'call-process speedbar-fetch-etags-command nil
3695 (current-buffer) nil
3696 (append speedbar-fetch-etags-arguments (list file)))
3697 (goto-char (point-min))
3698 (if (<= 1 speedbar-verbosity-level)
3699 (speedbar-message "Fetching etags..."))
3701 (let ((exprlst speedbar-fetch-etags-parse-list)
3703 (while (and (not ans) exprlst)
3704 (if (string-match (car (car exprlst)) file)
3705 (setq ans (car exprlst)))
3706 (setq exprlst (cdr exprlst)))
3710 (set-buffer (get-buffer-create "*etags tmp*"))
3711 (while (not (save-excursion (end-of-line) (eobp)))
3713 (setq tnl (speedbar-extract-one-symbol expr)))
3714 (if tnl (setq newlist (cons tnl newlist)))
3717 "Sorry, no support for a file of that extension"))))
3719 (if speedbar-sort-tags
3720 (sort newlist (lambda (a b) (string< (car a) (car b))))
3721 (reverse newlist))))
3723 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3724 ;; sure it's needed with the different sorting method.
3726 ;(defun speedbar-clean-etags()
3727 ; "Removes spaces before the ^? character, and removes `#define',
3728 ;return types, etc. preceding tags. This ensures that the sort operation
3729 ;works on the tags, not the return types."
3731 ; (goto-char (point-min))
3733 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3734 ; (replace-match "\C-?" nil nil))
3735 ; (goto-char (point-min))
3737 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3738 ; (delete-region (match-beginning 1) (match-end 1)))))
3740 (defun speedbar-extract-one-symbol (expr)
3741 "At point, return nil, or one alist in the form (SYMBOL . POSITION).
3742 The line should contain output from etags. Parse the output using the
3743 regular expression EXPR."
3744 (let* ((sym (if (stringp expr)
3746 (re-search-forward expr (line-end-position) t))
3747 (buffer-substring-no-properties (match-beginning 1)
3750 (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)"
3751 (line-end-position) t)))
3753 (1+ (string-to-number (buffer-substring-no-properties
3761 (defun speedbar-parse-c-or-c++tag ()
3762 "Parse a C or C++ tag, which tends to be a little complex."
3764 (let ((bound (line-end-position)))
3765 (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t)
3766 (buffer-substring-no-properties (match-beginning 1)
3768 ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t)
3769 (buffer-substring-no-properties (match-beginning 1)
3771 ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t)
3772 (buffer-substring-no-properties (match-beginning 1)
3777 (defun speedbar-parse-tex-string ()
3778 "Parse a Tex string. Only find data which is relevant."
3780 (let ((bound (line-end-position)))
3781 (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t)
3782 (buffer-substring-no-properties (match-beginning 0)
3787 ;;; BUFFER DISPLAY mode.
3789 (defvar speedbar-buffers-key-map nil
3790 "Keymap used when in the buffers display mode.")
3792 (if speedbar-buffers-key-map
3794 (setq speedbar-buffers-key-map (speedbar-make-specialized-keymap))
3796 ;; Basic tree features
3797 (define-key speedbar-buffers-key-map "e" 'speedbar-edit-line)
3798 (define-key speedbar-buffers-key-map "\C-m" 'speedbar-edit-line)
3799 (define-key speedbar-buffers-key-map "+" 'speedbar-expand-line)
3800 (define-key speedbar-buffers-key-map "=" 'speedbar-expand-line)
3801 (define-key speedbar-buffers-key-map "-" 'speedbar-contract-line)
3802 (define-key speedbar-buffers-key-map " " 'speedbar-toggle-line-expansion)
3804 ;; Buffer specific keybindings
3805 (define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer)
3806 (define-key speedbar-buffers-key-map "r" 'speedbar-buffer-revert-buffer)
3810 (defvar speedbar-buffer-easymenu-definition
3811 '(["Jump to buffer" speedbar-edit-line t]
3812 ["Expand File Tags" speedbar-expand-line
3813 (save-excursion (beginning-of-line)
3814 (looking-at "[0-9]+: *.\\+. "))]
3815 ["Flush Cache & Expand" speedbar-flush-expand-line
3816 (save-excursion (beginning-of-line)
3817 (looking-at "[0-9]+: *.\\+. "))]
3818 ["Contract File Tags" speedbar-contract-line
3819 (save-excursion (beginning-of-line)
3820 (looking-at "[0-9]+: *.-. "))]
3822 ["Kill Buffer" speedbar-buffer-kill-buffer
3823 (save-excursion (beginning-of-line)
3824 (looking-at "[0-9]+: *.[-+?]. "))]
3825 ["Revert Buffer" speedbar-buffer-revert-buffer
3826 (save-excursion (beginning-of-line)
3827 (looking-at "[0-9]+: *.[-+?]. "))]
3829 "Menu item elements shown when displaying a buffer list.")
3831 (defun speedbar-buffer-buttons (directory zero)
3832 "Create speedbar buttons based on the buffers currently loaded.
3833 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3834 (speedbar-buffer-buttons-engine nil))
3836 (defun speedbar-buffer-buttons-temp (directory zero)
3837 "Create speedbar buttons based on the buffers currently loaded.
3838 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3839 (speedbar-buffer-buttons-engine t))
3841 (defun speedbar-buffer-buttons-engine (temp)
3842 "Create speedbar buffer buttons.
3843 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3844 (speedbar-insert-separator "Active Buffers:")
3845 (let ((bl (buffer-list))
3846 (case-fold-search t))
3848 (if (string-match "^[ *]" (buffer-name (car bl)))
3850 (let* ((known (string-match speedbar-file-regexp
3851 (buffer-name (car bl))))
3852 (expchar (if known ?+ ??))
3853 (fn (if known 'speedbar-tag-file nil))
3854 (fname (with-current-buffer (car bl)
3855 (buffer-file-name))))
3856 (speedbar-make-tag-line 'bracket expchar fn
3857 (if fname (file-name-nondirectory fname))
3858 (buffer-name (car bl))
3859 'speedbar-buffer-click temp
3860 'speedbar-file-face 0)
3861 (speedbar-buffers-tail-notes (car bl))))
3863 (setq bl (buffer-list))
3864 (speedbar-insert-separator "Scratch Buffers:")
3866 (if (not (string-match "^\\*" (buffer-name (car bl))))
3868 (if (eq (car bl) speedbar-buffer)
3870 (speedbar-make-tag-line 'bracket ?? nil nil
3871 (buffer-name (car bl))
3872 'speedbar-buffer-click temp
3873 'speedbar-file-face 0)
3874 (speedbar-buffers-tail-notes (car bl))))
3876 (setq bl (buffer-list))
3877 ;;(speedbar-insert-separator "Hidden Buffers:")
3879 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3881 ;; (if (eq (car bl) speedbar-buffer)
3883 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3884 ;; (buffer-name (car bl))
3885 ;; 'speedbar-buffer-click temp
3886 ;; 'speedbar-file-face 0)
3887 ;; (speedbar-buffers-tail-notes (car bl))))
3888 ;; (setq bl (cdr bl)))
3891 (defun speedbar-buffers-tail-notes (buffer)
3892 "Add a note to the end of the last tag line.
3893 Argument BUFFER is the buffer being tested."
3895 (with-current-buffer buffer
3896 (setq mod (buffer-modified-p)
3897 ro buffer-read-only))
3898 (if ro (speedbar-insert-button "%" nil nil nil nil t))))
3900 (defun speedbar-buffers-item-info ()
3901 "Display information about the current buffer on the current line."
3902 (or (speedbar-item-info-tag-helper)
3903 (let* ((item (speedbar-line-text))
3904 (buffer (if item (get-buffer item) nil)))
3906 (speedbar-message "%s%s %S %d %s"
3907 (if (buffer-modified-p buffer) "* " "")
3909 (with-current-buffer buffer major-mode)
3910 (with-current-buffer buffer (buffer-size))
3911 (or (buffer-file-name buffer) "<No file>"))))))
3913 (defun speedbar-buffers-line-directory (&optional depth)
3914 "Fetch the directory of the file (buffer) specified on the current line.
3915 Optional argument DEPTH specifies the current depth of the back search."
3918 (let ((start (point)))
3919 ;; Buffers are always at level 0
3920 (if (not (re-search-backward "^0:" nil t))
3922 (let* ((bn (speedbar-line-text))
3923 (buffer (if bn (get-buffer bn))))
3925 (if (eq start (line-end-position))
3926 (or (with-current-buffer buffer default-directory)
3928 (buffer-file-name buffer))))))))
3930 (defun speedbar-buffer-click (text token indent)
3931 "When the users clicks on a buffer-button in speedbar.
3932 TEXT is the buffer's name, TOKEN and INDENT are unused."
3933 (if dframe-power-click
3934 (let ((pop-up-frames t)) (select-window (display-buffer text)))
3935 (dframe-select-attached-frame speedbar-frame)
3936 (switch-to-buffer text)
3937 (if token (speedbar-change-initial-expansion-list
3938 speedbar-previously-used-expansion-list-name))))
3940 (defun speedbar-buffer-kill-buffer ()
3941 "Kill the buffer the cursor is on in the speedbar buffer."
3944 (let ((text (speedbar-line-text)))
3945 (if (and (get-buffer text)
3946 (speedbar-y-or-n-p (format "Kill buffer %s? " text)))
3948 (speedbar-refresh)))))
3950 (defun speedbar-buffer-revert-buffer ()
3951 "Revert the buffer the cursor is on in the speedbar buffer."
3955 ;; If this fails, then it is a non-standard click, and as such,
3956 ;; perfectly allowed
3957 (if (re-search-forward "[]>?}] [^ ]" (line-end-position) t)
3960 (buffer-substring (point) (line-end-position)))))
3961 (if (get-buffer text)
3964 (revert-buffer t)))))))
3967 ;;; Useful hook values and such.
3969 (defvar speedbar-highlight-one-tag-line nil
3970 "Overlay used for highlighting the most recently jumped to tag line.")
3972 (defun speedbar-highlight-one-tag-line ()
3973 "Highlight the current line, unhighlighting a previously jumped to line."
3974 (speedbar-unhighlight-one-tag-line)
3975 (setq speedbar-highlight-one-tag-line
3976 (speedbar-make-overlay (line-beginning-position)
3977 (1+ (line-end-position))))
3978 (speedbar-overlay-put speedbar-highlight-one-tag-line 'face
3979 'speedbar-highlight-face)
3980 (add-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line))
3982 (defun speedbar-unhighlight-one-tag-line ()
3983 "Unhighlight the currently highlighted line."
3984 (if speedbar-highlight-one-tag-line
3986 (speedbar-delete-overlay speedbar-highlight-one-tag-line)
3987 (setq speedbar-highlight-one-tag-line nil)))
3988 (remove-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line))
3990 (defun speedbar-recenter-to-top ()
3991 "Recenter the current buffer so point is on the top of the window."
3994 (defun speedbar-recenter ()
3995 "Recenter the current buffer so point is in the center of the window."
3996 (recenter (/ (window-height (selected-window)) 2)))
3999 ;;; Color loading section.
4001 (defface speedbar-button-face '((((class color) (background light))
4002 (:foreground "green4"))
4003 (((class color) (background dark))
4004 (:foreground "green3")))
4005 "Face used for +/- buttons."
4006 :group 'speedbar-faces)
4008 (defface speedbar-file-face '((((class color) (background light))
4009 (:foreground "cyan4"))
4010 (((class color) (background dark))
4011 (:foreground "cyan"))
4013 "Face used for file names."
4014 :group 'speedbar-faces)
4016 (defface speedbar-directory-face '((((class color) (background light))
4017 (:foreground "blue4"))
4018 (((class color) (background dark))
4019 (:foreground "light blue")))
4020 "Face used for directory names."
4021 :group 'speedbar-faces)
4022 (defface speedbar-tag-face '((((class color) (background light))
4023 (:foreground "brown"))
4024 (((class color) (background dark))
4025 (:foreground "yellow")))
4026 "Face used for displaying tags."
4027 :group 'speedbar-faces)
4029 (defface speedbar-selected-face '((((class color) (background light))
4030 (:foreground "red" :underline t))
4031 (((class color) (background dark))
4032 (:foreground "red" :underline t))
4034 "Face used to underline the file in the active window."
4035 :group 'speedbar-faces)
4037 (defface speedbar-highlight-face '((((class color) (background light))
4038 (:background "green"))
4039 (((class color) (background dark))
4040 (:background "sea green"))
4041 (((class grayscale monochrome)
4043 (:background "black"))
4044 (((class grayscale monochrome)
4046 (:background "white")))
4047 "Face used for highlighting buttons with the mouse."
4048 :group 'speedbar-faces)
4050 (defface speedbar-separator-face '((((class color) (background light))
4054 (((class color) (background dark))
4058 (((class grayscale monochrome)
4060 (:background "black"
4063 (((class grayscale monochrome)
4065 (:background "white"
4067 :overline "black")))
4068 "Face used for separator labels in a display."
4069 :group 'speedbar-faces)
4071 ;; some edebug hooks
4072 (add-hook 'edebug-setup-hook
4074 (def-edebug-spec speedbar-with-writable def-body)))
4076 ;; Fix a font lock problem for some versions of Emacs
4077 (and (boundp 'font-lock-global-modes)
4078 font-lock-global-modes
4079 (if (eq font-lock-global-modes t)
4080 (setq font-lock-global-modes '(not speedbar-mode))
4081 (if (eq (car font-lock-global-modes) 'not)
4082 (add-to-list 'font-lock-global-modes 'speedbar-mode t)
4083 (setq font-lock-global-modes (delq 'speedbar-mode
4084 font-lock-global-modes)))))
4086 ;;; Obsolete variables and functions
4088 (define-obsolete-variable-alias
4089 'speedbar-ignored-path-regexp 'speedbar-ignored-directory-regexp "22.1")
4091 (define-obsolete-function-alias 'speedbar-add-ignored-path-regexp
4092 'speedbar-add-ignored-directory-regexp "22.1")
4094 (define-obsolete-function-alias 'speedbar-line-path
4095 'speedbar-line-directory "22.1")
4097 (define-obsolete-function-alias 'speedbar-buffers-line-path
4098 'speedbar-buffers-line-directory "22.1")
4100 (define-obsolete-function-alias 'speedbar-path-line
4101 'speedbar-directory-line "22.1")
4103 (define-obsolete-function-alias 'speedbar-buffers-line-path
4104 'speedbar-buffers-line-directory "22.1")
4108 ;; run load-time hooks
4109 (run-hooks 'speedbar-load-hook)
4111 ;;; speedbar ends here