1 ;;; speedbar --- quick access to files and tags in a frame
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 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, or (at your option)
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; see the file COPYING. If not, write to the
30 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
31 ;; Boston, MA 02110-1301, USA.
35 ;; The speedbar provides a frame in which files, and locations in
36 ;; files are displayed. These items can be clicked on with mouse-2 in
37 ;; to display that file location.
39 ;;; Customizing and Developing for speedbar
41 ;; Please see the speedbar manual for informaion.
45 ;; Users of really old emacsen without the need timer functions
46 ;; will not have speedbar updating automatically. Use "g" to refresh
47 ;; the display after changing directories. Remember, do not interrupt
48 ;; the stealthy updates or your display may not be completely
51 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
52 ;; well. Use the imenu keywords from tex-mode.el for better results.
54 ;; This file requires the library package assoc (association lists)
55 ;; assoc should be available in all modern versions of Emacs.
56 ;; The custom package is optional (for easy configuration of speedbar)
57 ;; http://www.dina.kvl.dk/~abraham/custom/
58 ;; custom is available in all versions of Emacs version 20 or better.
60 ;;; Developing for speedbar
62 ;; Adding a speedbar specialized display mode:
64 ;; Speedbar can be configured to create a special display for certain
65 ;; modes that do not display traditional file/tag data. Rmail, Info,
66 ;; and the debugger are examples. These modes can, however, benefit
67 ;; from a speedbar style display in their own way.
69 ;; If your `major-mode' is `foo-mode', the only requirement is to
70 ;; create a function called `foo-speedbar-buttons' which takes one
71 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
72 ;; In `foo-speedbar-buttons' there are several functions that make
73 ;; building a speedbar display easy. See the documentation for
74 ;; `speedbar-with-writable' (needed because the buffer is usually
75 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
76 ;; `speedbar-insert-generic-list'. If you use
77 ;; `speedbar-insert-generic-list', also read the doc for
78 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
79 ;; The macro `speedbar-with-attached-buffer' brings you back to the
80 ;; buffer speedbar is displaying for.
82 ;; For those functions that make buttons, the "function" should be a
83 ;; symbol that is the function to call when clicked on. The "token"
84 ;; is extra data you can pass along. The "function" must take three
85 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
86 ;; button clicked on. TOKEN is the data passed in when you create the
87 ;; button. INDENT is an indentation level, or 0. You can store
88 ;; indentation levels with `speedbar-make-tag-line' which creates a
89 ;; line with an expander (eg. [+]) and a text button.
91 ;; Some useful functions when writing expand functions, and click
92 ;; functions are `speedbar-change-expand-button-char',
93 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
94 ;; The variable `speedbar-power-click' is set to t in your functions
95 ;; when the user shift-clicks. This is an indication of anything from
96 ;; refreshing cached data to making a buffer appear in a new frame.
98 ;; If you wish to add to the default speedbar menu for the case of
99 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
100 ;; should be a list compatible with the `easymenu' package. It will
101 ;; be spliced into the main menu. (Available with click-mouse-3). If
102 ;; you wish to have extra key bindings in your special mode, create a
103 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
104 ;; or `make-sparse-keymap', use the function
105 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
106 ;; speedbar's default bindings with low overhead.
108 ;; Adding a speedbar top-level display mode:
110 ;; Unlike the specialized modes, there are no name requirements,
111 ;; however the methods for writing a button display, menu, and keymap
112 ;; are the same. Once you create these items, you can call the
113 ;; function `speedbar-add-expansion-list'. It takes one parameter
114 ;; which is a list element of the form (NAME MENU KEYMAP &rest
115 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
116 ;; Displays menu item. MENU is a symbol containing the menu items to
117 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
118 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
120 ;; Another tweakable variable is `speedbar-stealthy-function-list'
121 ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
122 ;; name matching `speedbar-add-expansion-list'. (It does not need to
123 ;; exist.). This provides additional display info which might be
124 ;; time-consuming to calculate.
125 ;; Lastly, `speedbar-mode-functions-list' allows you to set special
126 ;; function overrides.
129 ;; - Timeout directories we haven't visited in a while.
136 ;; customization stuff
137 (defgroup speedbar nil
138 "File and tag browser frame."
145 (defgroup speedbar-faces nil
146 "Faces used in speedbar."
151 (defgroup speedbar-vc nil
152 "Version control display in speedbar."
158 ;; Note: `inversion-test' requires parts of the CEDET package that are
159 ;; not included with Emacs.
161 ;; (defun speedbar-require-version (major minor &optional beta)
162 ;; "Non-nil if this version of SPEEDBAR does not satisfy a specific version.
165 ;; (MAJOR MINOR &optional BETA)
167 ;; Values MAJOR and MINOR must be integers. BETA can be an integer, or
168 ;; excluded if a released version is required.
170 ;; It is assumed that if the current version is newer than that specified,
171 ;; everything passes. Exceptions occur when known incompatibilities are
173 ;; (inversion-test 'speedbar
174 ;; (concat major "." minor
175 ;; (when beta (concat "beta" beta)))))
177 (defvar speedbar-initial-expansion-mode-alist
178 '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
179 speedbar-buffer-buttons
)
180 ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
181 speedbar-buffer-buttons-temp
)
182 ;; Files last, means first in the Displays menu
183 ("files" speedbar-easymenu-definition-special speedbar-file-key-map
184 speedbar-directory-buttons speedbar-default-directory-list
)
186 "List of named expansion elements for filling the speedbar frame.
187 These expansion lists are only valid for regular files. Special modes
188 still get to override this list on a mode-by-mode basis. This list of
189 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
190 representing the types of things to be displayed. MENU is an easymenu
191 structure used when in this mode. KEYMAP is a local keymap to install
192 over the regular speedbar keymap. FN1 ... are functions that will be
193 called in order. These functions will always get the default
194 directory to use passed in as the first parameter, and a 0 as the
195 second parameter. The 0 indicates the uppermost indentation level.
196 They must assume that the cursor is at the position where they start
199 (defvar speedbar-initial-expansion-list-name
"files"
200 "A symbol name representing the expansion list to use.
201 The expansion list `speedbar-initial-expansion-mode-alist' contains
202 the names and associated functions to use for buttons in speedbar.")
204 (defvar speedbar-previously-used-expansion-list-name
"files"
205 "Save the last expansion list method.
206 This is used for returning to a previous expansion list method when
207 the user is done with the current expansion list.")
209 (defvar speedbar-stealthy-function-list
211 speedbar-update-current-file
212 speedbar-check-read-only
214 speedbar-check-objects
)
216 "List of functions to periodically call stealthily.
217 This list is of the form:
218 '( (\"NAME\" FUNCTION ...)
220 where NAME is the name of the major display mode these functions are
221 for, and the remaining elements FUNCTION are functions to call in order.
222 Each function must return nil if interrupted, or t if completed.
223 Stealthy functions which have a single operation should always return
224 t. Functions which take a long time should maintain a state (where
225 they are in their speedbar related calculations) and permit
226 interruption. See `speedbar-check-vc' as a good example.")
228 (defvar speedbar-mode-functions-list
229 '(("files" (speedbar-item-info . speedbar-files-item-info
)
230 (speedbar-line-directory . speedbar-files-line-directory
))
231 ("buffers" (speedbar-item-info . speedbar-buffers-item-info
)
232 (speedbar-line-directory . speedbar-buffers-line-directory
))
233 ("quick buffers" (speedbar-item-info . speedbar-buffers-item-info
)
234 (speedbar-line-directory . speedbar-buffers-line-directory
))
236 "List of function tables to use for different major display modes.
237 It is not necessary to define any functions for a specialized mode.
238 This just provides a simple way of adding lots of customizations.
239 Each sublist is of the form:
240 (\"NAME\" (FUNCTIONSYMBOL . REPLACEMENTFUNCTION) ...)
241 Where NAME is the name of the specialized mode. The rest of the list
242 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
243 of a function you would like to replace, and REPLACEMENTFUNCTION,
244 which is a function you can call instead. Not all functions can be
245 replaced this way. Replaceable functions must provide that
246 functionality individually.")
248 (defcustom speedbar-mode-specific-contents-flag t
249 "*Non-nil means speedbar will show special mode contents.
250 This permits some modes to create customized contents for the speedbar
255 (defcustom speedbar-query-confirmation-method
'all
256 "*Query control for file operations.
257 The 'always flag means to always query before file operations.
258 The 'none-but-delete flag means to not query before any file
259 operations, except before a file deletion."
261 :type
'(radio (const :tag
"Always Query before some file operations."
263 (const :tag
"Never Query before file operations, except for deletions."
265 ;;;; (const :tag "Never Every Query."
269 (defvar speedbar-special-mode-expansion-list nil
270 "Default function list for creating specialized button lists.
271 This list is set by modes that wish to have special speedbar displays.
272 The list is of function names. Each function is called with one
273 parameter BUFFER, the originating buffer. The current buffer is the
276 (defvar speedbar-special-mode-key-map nil
277 "Default keymap used when identifying a specialized display mode.
278 This keymap is local to each buffer that wants to define special keybindings
279 effective when its display is shown.")
281 (defcustom speedbar-before-visiting-file-hook
'(push-mark)
282 "*Hooks run before speedbar visits a file in the selected frame.
283 The default buffer is the buffer in the selected window in the attached frame."
287 (defcustom speedbar-visiting-file-hook nil
288 "*Hooks run when speedbar visits a file in the selected frame."
292 (defcustom speedbar-before-visiting-tag-hook
'(push-mark)
293 "*Hooks run before speedbar visits a tag in the selected frame.
294 The default buffer is the buffer in the selected window in the attached frame."
298 (defcustom speedbar-visiting-tag-hook
'(speedbar-highlight-one-tag-line)
299 "*Hooks run when speedbar visits a tag in the selected frame."
302 :options
'(speedbar-highlight-one-tag-line
303 speedbar-recenter-to-top
307 (defcustom speedbar-load-hook nil
308 "*Hooks run when speedbar is loaded."
312 (defcustom speedbar-reconfigure-keymaps-hook nil
313 "*Hooks run when the keymaps are regenerated."
317 (defcustom speedbar-show-unknown-files nil
318 "*Non-nil show files we can't expand with a ? in the expand button.
319 A nil value means don't show the file in the list."
323 ;;; EVENTUALLY REMOVE THESE
325 ;; When I moved to a repeating timer, I had the horrible missfortune
326 ;; of loosing the ability for adaptive speed choice. This update
327 ;; speed currently causes long delays when it should have been turned off.
328 (defvar speedbar-update-speed dframe-update-speed
329 "*Obsoleted variable. Use `dframe-update-speed'.")
331 (defvar speedbar-navigating-speed dframe-update-speed
332 "*Obsoleted variable. Use `dframe-update-speed'.")
335 (defcustom speedbar-frame-parameters
'((minibuffer . nil
)
343 "*Parameters to use when creating the speedbar frame in Emacs.
344 Any parameter supported by a frame may be added. The parameter `height'
345 will be initialized to the height of the frame speedbar is
346 attached to and added to this list before the new frame is initialized."
348 :type
'(repeat (cons :format
"%v"
349 (symbol :tag
"Parameter")
350 (sexp :tag
"Value"))))
352 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
353 (defcustom speedbar-frame-plist
354 '(minibuffer nil width
20 border-width
0
355 internal-border-width
0 unsplittable t
356 default-toolbar-visible-p nil has-modeline-p nil
357 menubar-visible-p nil
358 default-gutter-visible-p nil
360 "*Parameters to use when creating the speedbar frame in XEmacs.
361 Parameters not listed here which will be added automatically are
362 `height' which will be initialized to the height of the frame speedbar
365 :type
'(repeat (group :inline t
366 (symbol :tag
"Property")
367 (sexp :tag
"Value"))))
369 (defcustom speedbar-use-imenu-flag
(fboundp 'imenu
)
370 "*Non-nil means use imenu for file parsing. nil to use etags.
371 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
372 use etags instead. Etags support is not as robust as imenu support."
373 :tag
"Use Imenu for tags"
377 (defvar speedbar-dynamic-tags-function-list
378 '((speedbar-fetch-dynamic-imenu . speedbar-insert-imenu-list
)
379 (speedbar-fetch-dynamic-etags . speedbar-insert-etags-list
))
380 "Set to a list of functions which will return and insert a list of tags.
381 Each element is of the form ( FETCH . INSERT ) where FETCH
382 is a function which takes one parameter (the file to tag) and returns a
383 list of tags. The tag list can be of any form as long as the
384 corresponding insert method can handle it. If it returns t, then an
385 error occurred, and the next fetch routine is tried.
386 INSERT is a function which takes an INDENTation level, and a LIST of
387 tags to insert. It will then create the speedbar buttons.")
389 (defcustom speedbar-use-tool-tips-flag
(and (not (featurep 'xemacs
))
390 (>= emacs-major-version
21))
391 "*Non-nil means to use tool tips if they are avaialble.
392 When tooltips are not available, mouse-tracking and minibuffer
393 display is used instead."
397 (defcustom speedbar-track-mouse-flag
(not speedbar-use-tool-tips-flag
)
398 "*Non-nil means to display info about the line under the mouse."
402 (defcustom speedbar-default-position
'left-right
403 "*Default position of the speedbar frame.
404 Possible values are 'left, 'right or 'left-right.
405 If value is 'left-right, the most suitable location is
406 determined automatically."
408 :type
'(radio (const :tag
"Automatic" left-right
)
409 (const :tag
"Left" left
)
410 (const :tag
"Right" right
)))
412 (defcustom speedbar-sort-tags nil
413 "*If non-nil, sort tags in the speedbar display. *Obsolete*.
414 Use `semantic-tag-hierarchy-method' instead."
418 (defcustom speedbar-tag-hierarchy-method
419 '(speedbar-prefix-group-tag-hierarchy
420 speedbar-trim-words-tag-hierarchy
)
421 "*List of hooks which speedbar will use to organize tags into groups.
422 Groups are defined as expandable meta-tags. Imenu supports
423 such things in some languages, such as separating variables from
424 functions. Each hook takes one argument LST, and may destructively
425 create a new list of the same form. LST is a list of elements of the
428 where each ELT is of the form
429 (TAG-NAME-STRING . NUMBER-OR-MARKER)
431 (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
434 :options
'(speedbar-prefix-group-tag-hierarchy
435 speedbar-trim-words-tag-hierarchy
436 speedbar-simple-group-tag-hierarchy
437 speedbar-sort-tag-hierarchy
)
440 (defcustom speedbar-tag-group-name-minimum-length
4
441 "*The minimum length of a prefix group name before expanding.
442 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
443 and one such groups common characters is less than this number of
444 characters, then the group name will be changed to the form of:
448 This way we won't get silly looking listings."
452 (defcustom speedbar-tag-split-minimum-length
20
453 "*Minimum length before we stop trying to create sub-lists in tags.
454 This is used by all tag-hierarchy methods that break large lists into
459 (defcustom speedbar-tag-regroup-maximum-length
10
460 "*Maximum length of submenus that are regrouped.
461 If the regrouping option is used, then if two or more short subgroups
462 are next to each other, then they are combined until this number of
467 (defcustom speedbar-directory-button-trim-method
'span
468 "*Indicates how the directory button will be displayed.
470 'span - span large directories over multiple lines.
471 'trim - trim large directories to only show the last few.
474 :type
'(radio (const :tag
"Span large directories over mutiple lines."
476 (const :tag
"Trim large directories to only show the last few."
478 (const :tag
"No trimming." nil
)))
480 (defcustom speedbar-smart-directory-expand-flag t
481 "*Non-nil means speedbar should use smart expansion.
482 Smart expansion only affects when speedbar wants to display a
483 directory for a file in the attached frame. When smart expansion is
484 enabled, new directories which are children of a displayed directory
485 are expanded in the current framework. If nil, then the current
486 hierarchy would be replaced with the new directory."
490 (defcustom speedbar-indentation-width
1
491 "*When sub-nodes are expanded, the number of spaces used for indentation."
495 (defcustom speedbar-hide-button-brackets-flag nil
496 "*Non-nil means speedbar will hide the brackets around the + or -."
500 (defcustom speedbar-before-popup-hook nil
501 "*Hooks called before popping up the speedbar frame."
505 (defcustom speedbar-after-create-hook
'(speedbar-frame-reposition-smartly)
506 "*Hooks called after popping up the speedbar frame."
510 (defcustom speedbar-before-delete-hook nil
511 "*Hooks called before deleting the speedbar frame."
515 (defcustom speedbar-mode-hook nil
516 "*Hooks called after creating a speedbar buffer."
520 (defcustom speedbar-timer-hook nil
521 "*Hooks called after running the speedbar timer function."
525 (defcustom speedbar-verbosity-level
1
526 "*Verbosity level of the speedbar. 0 means say nothing.
527 1 means medium level verbosity. 2 and higher are higher levels of
532 (defvar speedbar-indicator-separator
" "
533 "String separating file text from indicator characters.")
535 (defcustom speedbar-vc-do-check t
536 "*Non-nil check all files in speedbar to see if they have been checked out.
537 Any file checked out is marked with `speedbar-vc-indicator'."
541 (defvar speedbar-vc-indicator
"*"
542 "Text used to mark files which are currently checked out.
543 Other version control systems can be added by examining the function
544 `speedbar-vc-directory-enable-hook' and `speedbar-vc-in-control-hook'.")
546 (defcustom speedbar-vc-directory-enable-hook nil
547 "*Return non-nil if the current directory should be checked for Version Control.
548 Functions in this hook must accept one parameter which is the directory
553 (defcustom speedbar-vc-in-control-hook nil
554 "*Return non-nil if the specified file is under Version Control.
555 Functions in this hook must accept two parameters. The DIRECTORY of the
556 current file, and the FILENAME of the file being checked."
560 (defvar speedbar-vc-to-do-point nil
561 "Local variable maintaining the current version control check position.")
563 (defcustom speedbar-obj-do-check t
564 "*Non-nil check all files in speedbar to see if they have an object file.
565 Any file checked out is marked with `speedbar-obj-indicator', and the
566 marking is based on `speedbar-obj-alist'"
570 (defvar speedbar-obj-to-do-point nil
571 "Local variable maintaining the current version control check position.")
573 (defvar speedbar-obj-indicator
'("#" .
"!")
574 "Text used to mark files that have a corresponding hidden object file.
575 The car is for an up-to-date object. The cdr is for an out of date object.
576 The expression `speedbar-obj-alist' defines who gets tagged.")
578 (defvar speedbar-obj-alist
579 '(("\\.\\([cpC]\\|cpp\\|cc\\|cxx\\)$" .
".o")
581 ("\\.java$" .
".class")
582 ("\\.f\\(or\\|90\\|77\\)?$" .
".o")
584 ("\\.texi$" .
".info"))
585 "Alist of file extensions, and their corresponding object file type.")
587 (defvar speedbar-ro-to-do-point nil
588 "Local variable maintaining the current read only check position.")
590 (defvar speedbar-object-read-only-indicator
"%"
591 "Indicator to append onto a line if that item is Read Only.")
593 ;; Note: Look for addition place to add indicator lists that
594 ;; use skip-chars instead of a regular expression.
595 (defvar speedbar-indicator-regex
596 (concat (regexp-quote speedbar-indicator-separator
)
598 (regexp-quote speedbar-vc-indicator
)
600 (regexp-quote (car speedbar-obj-indicator
))
602 (regexp-quote (cdr speedbar-obj-indicator
))
604 (regexp-quote speedbar-object-read-only-indicator
)
606 "Regular expression used when identifying files.
607 Permits stripping of indicator characters from a line.")
609 (defcustom speedbar-scanner-reset-hook nil
610 "*Hook called whenever generic scanners are reset.
611 Set this to implement your own scanning / rescan safe functions with
616 (defvar speedbar-ignored-modes
'(fundamental-mode)
617 "*List of major modes which speedbar will not switch directories for.")
619 (defun speedbar-extension-list-to-regex (extlist)
620 "Takes EXTLIST, a list of extensions and transforms it into regexp.
621 All the preceding `.' are stripped for an optimized expression starting
622 with `.' followed by extensions, followed by full-filenames."
623 (let ((regex1 nil
) (regex2 nil
))
625 (if (= (string-to-char (car extlist
)) ?.
)
626 (setq regex1
(concat regex1
(if regex1
"\\|" "")
627 (substring (car extlist
) 1)))
628 (setq regex2
(concat regex2
(if regex2
"\\|" "") (car extlist
))))
629 (setq extlist
(cdr extlist
)))
630 ;; concat all the sub-exressions together, making sure all types
631 ;; of parts exist during concatination.
633 (if regex1
(concat "\\(\\.\\(" regex1
"\\)\\)") "")
634 (if (and regex1 regex2
) "\\|" "")
635 (if regex2
(concat "\\(" regex2
"\\)") "")
638 (defvar speedbar-ignored-directory-regexp nil
639 "Regular expression matching directorys speedbar will not switch to.
640 Created from `speedbar-ignored-directory-expressions' with the function
641 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
642 Use the function `speedbar-add-ignored-directory-regexp', or customize the
643 variable `speedbar-ignored-directory-expressions' to modify this variable.")
645 (define-obsolete-variable-alias 'speedbar-ignored-path-expressions
646 'speedbar-ignored-directory-expressions
)
648 (defcustom speedbar-ignored-directory-expressions
649 '("[/\\]logs?[/\\]\\'")
650 "*List of regular expressions matching directories speedbar will ignore.
651 They should included directorys to directories which are notoriously very
652 large and take a long time to load in. Use the function
653 `speedbar-add-ignored-directory-regexp' to add new items to this list after
654 speedbar is loaded. You may place anything you like in this list
655 before speedbar has been loaded."
657 :type
'(repeat (regexp :tag
"Directory Regexp"))
658 :set
(lambda (sym val
)
659 (setq speedbar-ignored-directory-expressions val
660 speedbar-ignored-directory-regexp
661 (speedbar-extension-list-to-regex val
))))
663 (defcustom speedbar-directory-unshown-regexp
"^\\(\\..*\\)\\'"
664 "*Regular expression matching directories not to show in speedbar.
665 They should include commonly existing directories which are not
666 useful. It is no longer necessary to include include version-control
667 directories here; see \\[vc-directory-exclusion-list\\]."
671 (defvar speedbar-file-unshown-regexp
672 (let ((nstr "") (noext completion-ignored-extensions
))
674 (setq nstr
(concat nstr
(regexp-quote (car noext
)) "\\'"
675 (if (cdr noext
) "\\|" ""))
677 ;; backup refdir lockfile
678 (concat nstr
"\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#"))
679 "*Regexp matching files we don't want displayed in a speedbar buffer.
680 It is generated from the variable `completion-ignored-extensions'")
682 (defvar speedbar-file-regexp nil
683 "Regular expression matching files we know how to expand.
684 Created from `speedbar-supported-extension-expressions' with the
685 function `speedbar-extension-list-to-regex'")
687 ;; this is dangerous to customize, because the defaults will probably
688 ;; change in the future.
689 (defcustom speedbar-supported-extension-expressions
690 (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
691 ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?")
692 (if speedbar-use-imenu-flag
693 '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py" ".g"
694 ;; html is not supported by default, but an imenu tags package
695 ;; is available. Also, html files are nice to be able to see.
697 ".ma?k" "[Mm]akefile\\(\\.in\\)?")))
698 "*List of regular expressions which will match files supported by tagging.
699 Do not prefix the `.' char with a double \\ to quote it, as the period
700 will be stripped by a simplified optimizer when compiled into a
701 singular expression. This variable will be turned into
702 `speedbar-file-regexp' for use with speedbar. You should use the
703 function `speedbar-add-supported-extension' to add a new extension at
704 runtime, or use the configuration dialog to set it in your .emacs
706 If you add an extension to this list, and it does not appear, you may
707 need to also modify `completion-ignored-extension' which will also help
710 :type
'(repeat (regexp :tag
"Extension Regexp"))
711 :set
(lambda (sym val
)
712 (set 'speedbar-supported-extension-expressions val
)
713 (set 'speedbar-file-regexp
(speedbar-extension-list-to-regex val
))))
715 (setq speedbar-file-regexp
716 (speedbar-extension-list-to-regex speedbar-supported-extension-expressions
))
718 (defun speedbar-add-supported-extension (extension)
719 "Add EXTENSION as a new supported extension for speedbar tagging.
720 This should start with a `.' if it is not a complete file name, and
721 the dot should NOT be quoted in with \\. Other regular expression
722 matchers are allowed however. EXTENSION may be a single string or a
724 (interactive "sExtension: ")
725 (if (not (listp extension
)) (setq extension
(list extension
)))
727 (if (member (car extension
) speedbar-supported-extension-expressions
)
729 (setq speedbar-supported-extension-expressions
730 (cons (car extension
) speedbar-supported-extension-expressions
)))
731 (setq extension
(cdr extension
)))
732 (setq speedbar-file-regexp
(speedbar-extension-list-to-regex
733 speedbar-supported-extension-expressions
)))
735 (defun speedbar-add-ignored-directory-regexp (directory-expression)
736 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
737 This function will modify `speedbar-ignored-directory-regexp' and add
738 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
739 (interactive "sDirectory regex: ")
740 (if (not (listp directory-expression
))
741 (setq directory-expression
(list directory-expression
)))
742 (while directory-expression
743 (if (member (car directory-expression
) speedbar-ignored-directory-expressions
)
745 (setq speedbar-ignored-directory-expressions
746 (cons (car directory-expression
) speedbar-ignored-directory-expressions
)))
747 (setq directory-expression
(cdr directory-expression
)))
748 (setq speedbar-ignored-directory-regexp
(speedbar-extension-list-to-regex
749 speedbar-ignored-directory-expressions
)))
751 ;; If we don't have custom, then we set it here by hand.
752 (if (not (fboundp 'custom-declare-variable
))
753 (setq speedbar-file-regexp
(speedbar-extension-list-to-regex
754 speedbar-supported-extension-expressions
)
755 speedbar-ignored-directory-regexp
(speedbar-extension-list-to-regex
756 speedbar-ignored-directory-expressions
)))
758 (defvar speedbar-update-flag dframe-have-timer-flag
759 "*Non-nil means to automatically update the display.
760 When this is nil then speedbar will not follow the attached frame's directory.
761 When speedbar is active, use:
763 \\<speedbar-key-map> `\\[speedbar-toggle-updates]'
765 to toggle this value.")
767 (defvar speedbar-update-flag-disable nil
768 "Permanently disable changing of the update flag.")
770 (defvar speedbar-syntax-table nil
771 "Syntax-table used on the speedbar.")
773 (if speedbar-syntax-table
775 (setq speedbar-syntax-table
(make-syntax-table))
776 ;; turn off paren matching around here.
777 (modify-syntax-entry ?
\' " " speedbar-syntax-table
)
778 (modify-syntax-entry ?
\" " " speedbar-syntax-table
)
779 (modify-syntax-entry ?
( " " speedbar-syntax-table
)
780 (modify-syntax-entry ?
) " " speedbar-syntax-table
)
781 (modify-syntax-entry ?
{ " " speedbar-syntax-table
)
782 (modify-syntax-entry ?
} " " speedbar-syntax-table
)
783 (modify-syntax-entry ?
[ " " speedbar-syntax-table
)
784 (modify-syntax-entry ?
] " " speedbar-syntax-table
))
786 (defvar speedbar-key-map nil
787 "Keymap used in speedbar buffer.")
791 (setq speedbar-key-map
(make-keymap))
792 (suppress-keymap speedbar-key-map t
)
795 (define-key speedbar-key-map
"t" 'speedbar-toggle-updates
)
796 (define-key speedbar-key-map
"g" 'speedbar-refresh
)
799 (define-key speedbar-key-map
"n" 'speedbar-next
)
800 (define-key speedbar-key-map
"p" 'speedbar-prev
)
801 (define-key speedbar-key-map
"\M-n" 'speedbar-restricted-next
)
802 (define-key speedbar-key-map
"\M-p" 'speedbar-restricted-prev
)
803 (define-key speedbar-key-map
"\C-\M-n" 'speedbar-forward-list
)
804 (define-key speedbar-key-map
"\C-\M-p" 'speedbar-backward-list
)
805 ;; These commands never seemed useful.
806 ;; (define-key speedbar-key-map " " 'speedbar-scroll-up)
807 ;; (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
809 ;; Short cuts I happen to find useful
810 (define-key speedbar-key-map
"r"
811 (lambda () (interactive)
812 (speedbar-change-initial-expansion-list
813 speedbar-previously-used-expansion-list-name
)))
814 (define-key speedbar-key-map
"b"
815 (lambda () (interactive)
816 (speedbar-change-initial-expansion-list "quick buffers")))
817 (define-key speedbar-key-map
"f"
818 (lambda () (interactive)
819 (speedbar-change-initial-expansion-list "files")))
821 (dframe-update-keymap speedbar-key-map
)
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
828 (let ((k (make-sparse-keymap)))
829 (set-keymap-parent k speedbar-key-map
)
832 (defvar speedbar-file-key-map nil
833 "Keymap used in speedbar buffer while files are displayed.")
835 (if speedbar-file-key-map
837 (setq speedbar-file-key-map
(speedbar-make-specialized-keymap))
839 ;; Basic tree features
840 (define-key speedbar-file-key-map
"e" 'speedbar-edit-line
)
841 (define-key speedbar-file-key-map
"\C-m" 'speedbar-edit-line
)
842 (define-key speedbar-file-key-map
"+" 'speedbar-expand-line
)
843 (define-key speedbar-file-key-map
"=" 'speedbar-expand-line
)
844 (define-key speedbar-file-key-map
"-" 'speedbar-contract-line
)
846 (define-key speedbar-file-key-map
"[" 'speedbar-expand-line-descendants
)
847 (define-key speedbar-file-key-map
"]" 'speedbar-contract-line-descendants
)
849 (define-key speedbar-file-key-map
" " 'speedbar-toggle-line-expansion
)
851 ;; file based commands
852 (define-key speedbar-file-key-map
"U" 'speedbar-up-directory
)
853 (define-key speedbar-file-key-map
"I" 'speedbar-item-info
)
854 (define-key speedbar-file-key-map
"B" 'speedbar-item-byte-compile
)
855 (define-key speedbar-file-key-map
"L" 'speedbar-item-load
)
856 (define-key speedbar-file-key-map
"C" 'speedbar-item-copy
)
857 (define-key speedbar-file-key-map
"D" 'speedbar-item-delete
)
858 (define-key speedbar-file-key-map
"O" 'speedbar-item-object-delete
)
859 (define-key speedbar-file-key-map
"R" 'speedbar-item-rename
)
860 (define-key speedbar-file-key-map
"M" 'speedbar-create-directory
)
863 (defvar speedbar-easymenu-definition-base
866 ["Update" speedbar-refresh t
]
867 ["Auto Update" speedbar-toggle-updates
868 :active
(not speedbar-update-flag-disable
)
869 :style toggle
:selected speedbar-update-flag
])
870 (if (and (or (fboundp 'defimage
)
871 (fboundp 'make-image-specifier
))
872 (if (fboundp 'display-graphic-p
)
876 ["Use Images" speedbar-toggle-images
877 :style toggle
:selected speedbar-use-images
]))
879 "Base part of the speedbar menu.")
881 (defvar speedbar-easymenu-definition-special
882 '(["Edit Item On Line" speedbar-edit-line t
]
883 ["Show All Files" speedbar-toggle-show-all-files
884 :style toggle
:selected speedbar-show-unknown-files
]
885 ["Expand File Tags" speedbar-expand-line
886 (save-excursion (beginning-of-line)
887 (looking-at "[0-9]+: *.\\+. "))]
888 ["Flush Cache & Expand" speedbar-flush-expand-line
889 (save-excursion (beginning-of-line)
890 (looking-at "[0-9]+: *.\\+. "))]
891 ["Expand All Descendants" speedbar-expand-line-descendants
892 (save-excursion (beginning-of-line)
893 (looking-at "[0-9]+: *.\\+. ")) ]
894 ["Contract File Tags" speedbar-contract-line
895 (save-excursion (beginning-of-line)
896 (looking-at "[0-9]+: *.-. "))]
897 ; ["Sort Tags" speedbar-toggle-sorting
898 ; :style toggle :selected speedbar-sort-tags]
900 ["File/Tag Information" speedbar-item-info t
]
901 ["Load Lisp File" speedbar-item-load
904 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
905 ["Byte Compile File" speedbar-item-byte-compile
908 (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))]
909 ["Copy File" speedbar-item-copy
910 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
911 ["Rename File" speedbar-item-rename
912 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
913 ["Create Directory" speedbar-create-directory
914 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
915 ["Delete File" speedbar-item-delete
916 (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
917 ["Delete Object" speedbar-item-object-delete
918 (save-excursion (beginning-of-line)
919 (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))]
921 "Additional menu items while in file-mode.")
923 (defvar speedbar-easymenu-definition-trailer
925 (if (and (featurep 'custom
) (fboundp 'custom-declare-variable
))
926 (list ["Customize..." speedbar-customize t
]))
928 ["Close" dframe-close-frame t
]
929 ["Quit" delete-frame t
] ))
930 "Menu items appearing at the end of the speedbar menu.")
932 (defvar speedbar-desired-buffer nil
933 "Non-nil when speedbar is showing buttons specific to a special mode.
934 In this case it is the originating buffer.")
935 (defvar speedbar-buffer nil
936 "The buffer displaying the speedbar.")
937 (defvar speedbar-frame nil
938 "The frame displaying speedbar.")
939 (defvar speedbar-cached-frame nil
940 "The frame that was last created, then removed from the display.")
941 (defvar speedbar-full-text-cache nil
942 "The last open directory is saved in its entirety for ultra-fast switching.")
944 (defvar speedbar-last-selected-file nil
945 "The last file which was selected in speedbar buffer.")
947 (defvar speedbar-shown-directories nil
948 "Maintain list of directories simultaneously open in the current speedbar.")
950 (defvar speedbar-directory-contents-alist nil
951 "An association list of directories and their contents.
952 Each sublist was returned by `speedbar-file-lists'. This list is
953 maintained to speed up the refresh rate when switching between
956 (defvar speedbar-power-click nil
957 "Never set this by hand. Value is t when S-mouse activity occurs.")
962 (defalias 'speedbar-make-overlay
963 (if (featurep 'xemacs
) 'make-extent
'make-overlay
))
965 (defalias 'speedbar-overlay-put
966 (if (featurep 'xemacs
) 'set-extent-property
'overlay-put
))
968 (defalias 'speedbar-delete-overlay
969 (if (featurep 'xemacs
) 'delete-extent
'delete-overlay
))
971 (defalias 'speedbar-mode-line-update
972 (if (featurep 'xemacs
) 'redraw-modeline
'force-mode-line-update
))
974 ;;; Mode definitions/ user commands
978 (defalias 'speedbar
'speedbar-frame-mode
)
980 (defun speedbar-frame-mode (&optional arg
)
981 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
982 A nil ARG means toggle. Once the speedbar frame is activated, a buffer in
983 `speedbar-mode' will be displayed. Currently, only one speedbar is
985 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
986 `speedbar-before-delete-hook' is called before the frame is deleted."
988 ;; Get the buffer to play with
989 (if (not (buffer-live-p speedbar-buffer
))
991 (setq speedbar-buffer
(get-buffer-create " SPEEDBAR"))
992 (set-buffer speedbar-buffer
)
994 ;; Do the frame thing
995 (dframe-frame-mode arg
997 'speedbar-cached-frame
1000 #'speedbar-frame-mode
1001 (if (featurep 'xemacs
)
1002 (append speedbar-frame-plist
1003 ;; This is a hack to get speedbar to iconfiy
1004 ;; with the selected frame.
1005 (list 'parent
(selected-frame)))
1006 speedbar-frame-parameters
)
1007 speedbar-before-delete-hook
1008 speedbar-before-popup-hook
1009 speedbar-after-create-hook
)
1010 ;; Start up the timer
1011 (if (not speedbar-frame
)
1012 (speedbar-set-timer nil
)
1013 (speedbar-reconfigure-keymaps)
1014 (speedbar-update-contents)
1015 (speedbar-set-timer dframe-update-speed
)
1017 ;; Frame modifications
1018 (set (make-local-variable 'dframe-delete-frame-function
)
1019 'speedbar-handle-delete-frame
)
1021 (set (make-local-variable 'automatic-hscrolling
) nil
) ; Emacs 21
1022 ;; reset the selection variable
1023 (setq speedbar-last-selected-file nil
))
1025 (defun speedbar-frame-reposition-smartly ()
1026 "Reposition the speedbar frame to be next to the attached frame."
1027 (cond ((and (featurep 'xemacs
)
1028 (or (member 'left speedbar-frame-plist
)
1029 (member 'top speedbar-frame-plist
)))
1030 (dframe-reposition-frame
1032 (dframe-attached-frame speedbar-frame
)
1033 (cons (car (cdr (member 'left speedbar-frame-plist
)))
1034 (car (cdr (member 'top speedbar-frame-plist
)))))
1036 ((and (not (featurep 'xemacs
))
1037 (or (assoc 'left speedbar-frame-parameters
)
1038 (assoc 'top speedbar-frame-parameters
)))
1039 ;; if left/top were specified in the parameters, pass them
1040 ;; down to the reposition function
1041 (dframe-reposition-frame
1043 (dframe-attached-frame speedbar-frame
)
1044 (cons (cdr (assoc 'left speedbar-frame-parameters
))
1045 (cdr (assoc 'top speedbar-frame-parameters
))))
1048 (dframe-reposition-frame speedbar-frame
1049 (dframe-attached-frame speedbar-frame
)
1050 speedbar-default-position
))))
1052 (defsubst speedbar-current-frame
()
1053 "Return the frame to use for speedbar based on current context."
1054 (dframe-current-frame 'speedbar-frame
'speedbar-mode
))
1056 (defun speedbar-handle-delete-frame (e)
1057 "Handle a delete frame event E.
1058 If the deleted frame is the frame SPEEDBAR is attached to,
1059 we need to delete speedbar also."
1060 (when (and speedbar-frame
1061 (eq (car (car (cdr e
))) ;; frame to be deleted
1062 dframe-attached-frame
))
1063 (delete-frame speedbar-frame
)))
1066 (defun speedbar-get-focus ()
1067 "Change frame focus to or from the speedbar frame.
1068 If the selected frame is not speedbar, then speedbar frame is
1069 selected. If the speedbar frame is active, then select the attached frame."
1071 (speedbar-reset-scanners)
1072 (dframe-get-focus 'speedbar-frame
'speedbar-frame-mode
1073 (lambda () (let ((speedbar-update-flag t
))
1074 (speedbar-timer-fn)))))
1076 (defsubst speedbar-frame-width
()
1077 "Return the width of the speedbar frame in characters.
1078 Return nil if it doesn't exist."
1079 (frame-width speedbar-frame
))
1081 (defun speedbar-mode ()
1082 "Major mode for managing a display of directories and tags.
1083 \\<speedbar-key-map>
1084 The first line represents the default directory of the speedbar frame.
1085 Each directory segment is a button which jumps speedbar's default
1086 directory to that directory. Buttons are activated by clicking `\\[speedbar-click]'.
1087 In some situations using `\\[dframe-power-click]' is a `power click' which will
1088 rescan cached items, or pop up new frames.
1090 Each line starting with <+> represents a directory. Click on the <+>
1091 to insert the directory listing into the current tree. Click on the
1092 <-> to retract that list. Click on the directory name to go to that
1093 directory as the default.
1095 Each line starting with [+] is a file. If the variable
1096 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1097 files which don't have imenu support, but are not expressly ignored.
1098 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1099 which is generated from `completion-ignored-extensions'.
1101 Files with a `*' character after their name are files checked out of a
1102 version control system. (Currently only RCS is supported.) New
1103 version control systems can be added by examining the documentation
1104 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1106 Files with a `#' or `!' character after them are source files that
1107 have an object file associated with them. The `!' indicates that the
1108 files is out of date. You can control what source/object associations
1109 exist through the variable `speedbar-obj-alist'.
1111 Click on the [+] to display a list of tags from that file. Click on
1112 the [-] to retract the list. Click on the file name to edit the file
1113 in the attached frame.
1115 If you open tags, you might find a node starting with {+}, which is a
1116 category of tags. Click the {+} to expand the category. Jump-able
1117 tags start with >. Click the name of the tag to go to that position
1118 in the selected file.
1120 \\{speedbar-key-map}"
1123 (kill-all-local-variables)
1124 (setq major-mode
'speedbar-mode
)
1125 (setq mode-name
"Speedbar")
1126 (set-syntax-table speedbar-syntax-table
)
1127 (setq font-lock-keywords nil
) ;; no font-locking please
1128 (setq truncate-lines t
)
1129 (make-local-variable 'frame-title-format
)
1130 (setq frame-title-format
(concat "Speedbar " speedbar-version
))
1131 (setq case-fold-search nil
)
1132 (toggle-read-only 1)
1133 (speedbar-set-mode-line-format)
1134 ;; Add in our dframe hooks.
1135 (if speedbar-track-mouse-flag
1136 (setq dframe-track-mouse-function
#'speedbar-track-mouse
))
1137 (setq dframe-help-echo-function
#'speedbar-item-info
1138 dframe-mouse-click-function
#'speedbar-click
1139 dframe-mouse-position-function
#'speedbar-position-cursor-on-line
)
1140 (run-hooks 'speedbar-mode-hook
))
1143 (defmacro speedbar-message
(fmt &rest args
)
1144 "Like message, but for use in the speedbar frame.
1145 Argument FMT is the format string, and ARGS are the arguments for message."
1146 `(dframe-message ,fmt
,@args
))
1148 (defsubst speedbar-y-or-n-p
(prompt &optional deleting
)
1149 "Like `y-or-n-p', but for use in the speedbar frame.
1150 Argument PROMPT is the prompt to use.
1151 Optional argument DELETING means this is a query that will delete something.
1152 The variable `speedbar-query-confirmation-method' can cause this to
1153 return true without a query."
1154 (or (and (not deleting
)
1155 (eq speedbar-query-confirmation-method
'none-but-delete
))
1156 (dframe-y-or-n-p prompt
)))
1158 (defsubst speedbar-select-attached-frame
()
1159 "Select the frame attached to this speedbar."
1160 (dframe-select-attached-frame (speedbar-current-frame)))
1162 ;; Backwards compatibility
1163 (defalias 'speedbar-with-attached-buffer
'dframe-with-attached-buffer
)
1164 (defalias 'speedbar-maybee-jump-to-attached-frame
'dframe-maybee-jump-to-attached-frame
)
1166 (defun speedbar-set-mode-line-format ()
1167 "Set the format of the mode line based on the current speedbar environment.
1168 This gives visual indications of what is up. It EXPECTS the speedbar
1169 frame and window to be the currently active frame and window."
1170 (if (and (frame-live-p (speedbar-current-frame))
1171 (or (not (featurep 'xemacs
))
1173 (specifier-instance has-modeline-p
)))
1176 (set-buffer speedbar-buffer
)
1177 (let* ((w (or (speedbar-frame-width) 20))
1180 (p3 (if speedbar-update-flag
"#" "!"))
1181 (p35 (capitalize speedbar-initial-expansion-list-name
))
1182 (blank (- w
(length p1
) (length p3
) (length p5
) (length p35
)
1183 (if line-number-mode
5 1)))
1185 (make-string (/ blank
2) ?
)
1188 (make-string (+ (/ blank
2) (% blank
2)) ?
)
1191 (if line-number-mode
1192 (list (concat p1 p2 p3
" " p35
) '(line-number-mode " %3l")
1194 (list (concat p1 p2 p3 p4 p5
)))))
1195 (if (not (equal mode-line-format tf
))
1197 (setq mode-line-format tf
)
1198 (speedbar-mode-line-update)))))))
1200 (defvar speedbar-previous-menu nil
1201 "The menu before the last `speedbar-reconfigure-keymaps' was called.")
1203 (defun speedbar-reconfigure-keymaps ()
1204 "Reconfigure the menu-bar in a speedbar frame.
1205 Different menu items are displayed depending on the current display mode
1206 and the existence of packages."
1208 speedbar-easymenu-definition-base
1209 (if speedbar-shown-directories
1210 ;; file display mode version
1211 (speedbar-initial-menu)
1213 (dframe-select-attached-frame speedbar-frame
)
1214 (eval (nth 1 (assoc speedbar-initial-expansion-list-name
1215 speedbar-initial-expansion-mode-alist
)))))
1216 ;; Dynamic menu stuff
1218 (list (cons "Displays"
1219 (let ((displays nil
)
1220 (alist speedbar-initial-expansion-mode-alist
))
1225 (capitalize (car (car alist
)))
1227 'speedbar-change-initial-expansion-list
1231 `(string= ,(car (car alist
))
1232 speedbar-initial-expansion-list-name
)
1235 (setq alist
(cdr alist
)))
1238 speedbar-easymenu-definition-trailer
))
1239 (localmap (save-excursion
1240 (let ((cf (selected-frame)))
1242 (dframe-select-attached-frame speedbar-frame
)
1243 (if (local-variable-p
1244 'speedbar-special-mode-key-map
1246 speedbar-special-mode-key-map
)
1247 (select-frame cf
))))))
1249 (set-buffer speedbar-buffer
)
1250 (use-local-map (or localmap
1251 (speedbar-initial-keymap)
1252 ;; This creates a small keymap we can glom the
1253 ;; menu adjustments into.
1254 (speedbar-make-specialized-keymap)))
1255 ;; Delete the old menu if applicable.
1256 (if speedbar-previous-menu
(easy-menu-remove speedbar-previous-menu
))
1257 (setq speedbar-previous-menu md
)
1258 ;; Now add the new menu
1259 (if (not (featurep 'xemacs
))
1260 (easy-menu-define speedbar-menu-map
(current-local-map)
1262 (easy-menu-add md
(current-local-map))
1264 (if (fboundp 'set-buffer-menubar
)
1265 (set-buffer-menubar (list md
)))))
1267 (run-hooks 'speedbar-reconfigure-keymaps-hook
)))
1270 ;;; User Input stuff
1272 (defun speedbar-customize ()
1273 "Customize speedbar using the Custom package."
1275 (let ((sf (selected-frame)))
1276 (dframe-select-attached-frame speedbar-frame
)
1277 (customize-group 'speedbar
)
1279 (dframe-maybee-jump-to-attached-frame))
1281 (defun speedbar-track-mouse (event)
1282 "For motion EVENT, display info about the current line."
1283 (if (not speedbar-track-mouse-flag
)
1286 (save-window-excursion
1289 (mouse-set-point event
)
1290 (if (eq major-mode
'speedbar-mode
)
1291 ;; XEmacs may let us get in here in other mode buffers.
1292 (speedbar-item-info)))
1293 (t (speedbar-message nil
)))))))
1295 (defun speedbar-show-info-under-mouse ()
1296 "Call the info function for the line under the mouse.
1297 Optional EVENT is currently not used."
1298 (let ((pos (mouse-position))) ; we ignore event until I use it later.
1299 (if (equal (car pos
) speedbar-frame
)
1301 (save-window-excursion
1302 (apply 'set-mouse-position pos
)
1303 (speedbar-item-info))))))
1305 (defun speedbar-next (arg)
1306 "Move to the next ARGth line in a speedbar buffer."
1308 (forward-line (or arg
1))
1309 (speedbar-item-info)
1310 (speedbar-position-cursor-on-line))
1312 (defun speedbar-prev (arg)
1313 "Move to the previous ARGth line in a speedbar buffer."
1315 (speedbar-next (if arg
(- arg
) -
1)))
1317 (defun speedbar-restricted-move (arg)
1318 "Move to the next ARGth line in a speedbar buffer at the same depth.
1319 This means that movement is restricted to a subnode, and that siblings
1320 of intermediate nodes are skipped."
1321 (if (not (numberp arg
)) (signal 'wrong-type-argument
(list arg
'numberp
)))
1322 ;; First find the extent for which we are allowed to move.
1323 (let ((depth (save-excursion (beginning-of-line)
1324 (if (looking-at "[0-9]+:")
1325 (string-to-number (match-string 0))
1327 (crement (if (< arg
0) 1 -
1)) ; decrement or increment
1328 (lastmatch (point)))
1330 (forward-line (- crement
))
1331 (let ((subdepth (save-excursion (beginning-of-line)
1332 (if (looking-at "[0-9]+:")
1333 (string-to-number (match-string 0))
1335 (cond ((or (< subdepth depth
)
1336 (progn (end-of-line) (eobp))
1337 (progn (beginning-of-line) (bobp)))
1338 ;; We have reached the end of this block.
1339 (goto-char lastmatch
)
1341 (error "End of sub-list"))
1343 (setq lastmatch
(point)
1344 arg
(+ arg crement
))))))
1345 (speedbar-position-cursor-on-line)))
1347 (defun speedbar-restricted-next (arg)
1348 "Move to the next ARGth line in a speedbar buffer at the same depth.
1349 This means that movement is restricted to a subnode, and that siblings
1350 of intermediate nodes are skipped."
1352 (speedbar-restricted-move (or arg
1))
1353 (speedbar-item-info))
1355 (defun speedbar-restricted-prev (arg)
1356 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1357 This means that movement is restricted to a subnode, and that siblings
1358 of intermediate nodes are skipped."
1360 (speedbar-restricted-move (if arg
(- arg
) -
1))
1361 (speedbar-item-info))
1363 (defun speedbar-navigate-list (arg)
1364 "Move across ARG groups of similarly typed items in speedbar.
1365 Stop on the first line of the next type of item, or on the last or first item
1366 if we reach a buffer boundary."
1369 (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ")
1370 (let ((str (regexp-quote (match-string 0))))
1371 (while (looking-at str
)
1372 (speedbar-restricted-move arg
)
1373 (beginning-of-line))))
1374 (speedbar-position-cursor-on-line))
1376 (defun speedbar-forward-list ()
1377 "Move forward over the current list.
1378 A LIST in speedbar is a group of similarly typed items, such as directories,
1379 files, or the directory button."
1381 (speedbar-navigate-list 1)
1382 (speedbar-item-info))
1384 (defun speedbar-backward-list ()
1385 "Move backward over the current list.
1386 A LIST in speedbar is a group of similarly typed items, such as directories,
1387 files, or the directory button."
1389 (speedbar-navigate-list -
1)
1390 (speedbar-item-info))
1392 (defun speedbar-scroll-up (&optional arg
)
1393 "Page down one screen-full of the speedbar, or ARG lines."
1396 (speedbar-position-cursor-on-line))
1398 (defun speedbar-scroll-down (&optional arg
)
1399 "Page up one screen-full of the speedbar, or ARG lines."
1402 (speedbar-position-cursor-on-line))
1404 (defun speedbar-up-directory ()
1405 "Keyboard accelerator for moving the default directory up one.
1406 Assumes that the current buffer is the speedbar buffer."
1408 (setq default-directory
(expand-file-name (concat default-directory
"../")))
1409 (speedbar-update-contents))
1411 ;;; Speedbar file activity (aka creeping featurism)
1413 (defun speedbar-refresh (&optional arg
)
1414 "Refresh the current speedbar display, disposing of any cached data.
1415 Argument ARG represents to force a refresh past any caches that may exist."
1417 (let ((dl speedbar-shown-directories
)
1418 (dframe-power-click arg
)
1420 ;; We need to hack something so this works in detached frames.
1422 (adelete 'speedbar-directory-contents-alist
(car dl
))
1424 (if (<= 1 speedbar-verbosity-level
)
1425 (speedbar-message "Refreshing speedbar..."))
1426 (speedbar-update-contents)
1427 (speedbar-stealthy-updates)
1428 ;; Reset the timer in case it got really hosed for some reason...
1429 (speedbar-set-timer dframe-update-speed
)
1430 (if (<= 1 speedbar-verbosity-level
)
1431 (speedbar-message "Refreshing speedbar...done"))))
1433 (defun speedbar-item-load ()
1434 "Load the item under the cursor or mouse if it is a Lisp file."
1436 (let ((f (speedbar-line-file)))
1437 (if (and (file-exists-p f
) (string-match "\\.el\\'" f
))
1438 (if (and (file-exists-p (concat f
"c"))
1439 (speedbar-y-or-n-p (format "Load %sc? " f
)))
1440 ;; If the compiled version exists, load that instead...
1441 (load-file (concat f
"c"))
1443 (error "Not a loadable file"))))
1445 (defun speedbar-item-byte-compile ()
1446 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1448 (let ((f (speedbar-line-file))
1449 (sf (selected-frame)))
1450 (if (and (file-exists-p f
) (string-match "\\.el\\'" f
))
1452 (dframe-select-attached-frame speedbar-frame
)
1453 (byte-compile-file f nil
)
1455 (speedbar-reset-scanners)))
1458 (defun speedbar-mouse-item-info (event)
1459 "Provide information about what the user clicked on.
1460 This should be bound to a mouse EVENT."
1462 (mouse-set-point event
)
1463 (speedbar-item-info))
1465 (defun speedbar-generic-item-info ()
1466 "Attempt to derive, and then display information about this line item.
1467 File style information is displayed with `speedbar-item-info'."
1470 ;; Skip invisible number info.
1471 (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0)))
1472 ;; Skip items in "folder" type text characters.
1473 (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0)))
1475 (speedbar-message "Text: %s" (buffer-substring-no-properties
1476 (point) (progn (end-of-line) (point))))))
1478 (defun speedbar-item-info ()
1479 "Display info in the mini-buffer about the button the mouse is over.
1480 This function can be replaced in `speedbar-mode-functions-list' as
1481 `speedbar-item-info'."
1483 (let (message-log-max)
1484 (funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info
)
1485 'speedbar-generic-item-info
))))
1487 (defun speedbar-item-info-file-helper (&optional filename
)
1488 "Display info about a file that is on the current line.
1489 Return nil if not applicable. If FILENAME, then use that
1490 instead of reading it from the speedbar buffer."
1491 (let* ((item (or filename
(speedbar-line-file)))
1492 (attr (if item
(file-attributes item
) nil
)))
1493 (if (and item attr
) (speedbar-message "%s %-6d %s" (nth 8 attr
)
1497 (defun speedbar-item-info-tag-helper ()
1498 "Display info about a tag that is on the current line.
1499 Return nil if not applicable."
1502 (if (re-search-forward " [-+=]?> \\([^\n]+\\)"
1503 (save-excursion(end-of-line)(point)) t
)
1504 (let* ((tag (match-string 1))
1505 (attr (speedbar-line-token))
1507 (semantic-tagged (if (fboundp 'semantic-tag-p
)
1508 (semantic-tag-p attr
))))
1512 (when (and (semantic-tag-overlay attr
)
1513 (semantic-tag-buffer attr
))
1514 (set-buffer (semantic-tag-buffer attr
)))
1516 (funcall semantic-sb-info-format-tag-function attr
)
1518 (looking-at "\\([0-9]+\\):")
1519 (setq item
(file-name-nondirectory (speedbar-line-directory)))
1520 (speedbar-message "Tag: %s in %s" tag item
)))
1521 (if (re-search-forward "{[+-]} \\([^\n]+\\)$"
1522 (save-excursion(end-of-line)(point)) t
)
1523 (speedbar-message "Group of tags \"%s\"" (match-string 1))
1524 (if (re-search-forward " [+-]?[()|@] \\([^\n]+\\)$" nil t
)
1525 (let* ((detailtext (match-string 1))
1526 (detail (or (speedbar-line-token) detailtext
))
1527 (parent (save-excursion
1529 (let ((dep (if (looking-at "[0-9]+:")
1530 (1- (string-to-number (match-string 0)))
1532 (re-search-backward (concat "^"
1536 (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$")
1537 (speedbar-line-token)
1539 (if (featurep 'semantic
)
1541 (if (semantic-tag-p detail
)
1543 (funcall semantic-sb-info-format-tag-function detail parent
))
1545 (speedbar-message "Detail: %s of tag %s" detail
1546 (if (semantic-tag-p parent
)
1547 (semantic-format-tag-name parent nil t
)
1549 (speedbar-message "Detail: %s" detail
))))
1550 ;; Not using `semantic':
1552 (speedbar-message "Detail: %s of tag %s" detail parent
)
1553 (speedbar-message "Detail: %s" detail
))))
1556 (defun speedbar-files-item-info ()
1557 "Display info in the mini-buffer about the button the mouse is over."
1558 (if (not speedbar-shown-directories
)
1559 (speedbar-generic-item-info)
1560 (or (speedbar-item-info-file-helper)
1561 (speedbar-item-info-tag-helper)
1562 (speedbar-generic-item-info))))
1564 (defun speedbar-item-copy ()
1565 "Copy the item under the cursor.
1566 Files can be copied to new names or places."
1568 (let ((f (speedbar-line-file)))
1569 (if (not f
) (error "Not a file"))
1570 (if (file-directory-p f
)
1571 (error "Cannot copy directory")
1572 (let* ((rt (read-file-name (format "Copy %s to: "
1573 (file-name-nondirectory f
))
1574 (file-name-directory f
)))
1575 (refresh (member (expand-file-name (file-name-directory rt
))
1576 speedbar-shown-directories
)))
1577 ;; Create the right file name part
1578 (if (file-directory-p rt
)
1580 (concat (expand-file-name rt
)
1581 (if (string-match "[/\\]$" rt
) "" "/")
1582 (file-name-nondirectory f
))))
1583 (if (or (not (file-exists-p rt
))
1584 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f
)
1587 (copy-file f rt t t
)
1588 ;; refresh display if the new place is currently displayed.
1592 (if (not (speedbar-goto-this-file rt
))
1593 (speedbar-goto-this-file f
))))
1596 (defun speedbar-item-rename ()
1597 "Rename the item under the cursor or mouse.
1598 Files can be renamed to new names or moved to new directories."
1600 (let ((f (speedbar-line-file)))
1602 (let* ((rt (read-file-name (format "Rename %s to: "
1603 (file-name-nondirectory f
))
1604 (file-name-directory f
)))
1605 (refresh (member (expand-file-name (file-name-directory rt
))
1606 speedbar-shown-directories
)))
1607 ;; Create the right file name part
1608 (if (file-directory-p rt
)
1610 (concat (expand-file-name rt
)
1611 (if (string-match "[/\\]\\'" rt
) "" "/")
1612 (file-name-nondirectory f
))))
1613 (if (or (not (file-exists-p rt
))
1614 (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f
)
1617 (rename-file f rt t
)
1618 ;; refresh display if the new place is currently displayed.
1622 (speedbar-goto-this-file rt
)
1624 (error "Not a file"))))
1626 (defun speedbar-create-directory ()
1627 "Create a directory in speedbar."
1629 (let ((f (speedbar-line-file)))
1631 (let* ((basedir (file-name-directory f
))
1632 (nd (read-file-name "Create directory: "
1634 ;; Make the directory
1635 (make-directory nd t
)
1637 (speedbar-goto-this-file nd
)
1639 (error "Not a file"))))
1641 (defun speedbar-item-delete ()
1642 "Delete the item under the cursor. Files are removed from disk."
1644 (let ((f (speedbar-line-file)))
1645 (if (not f
) (error "Not a file"))
1646 (if (speedbar-y-or-n-p (format "Delete %s? " f
) t
)
1648 (if (file-directory-p f
)
1649 (delete-directory f
)
1651 (speedbar-message "Okie dokie..")
1658 (defun speedbar-item-object-delete ()
1659 "Delete the object associated from the item under the cursor.
1660 The file is removed from disk. The object is determined from the
1661 variable `speedbar-obj-alist'."
1663 (let* ((f (speedbar-line-file))
1665 (oa speedbar-obj-alist
))
1666 (if (not f
) (error "Not a file"))
1667 (while (and oa
(not (string-match (car (car oa
)) f
)))
1669 (setq obj
(concat (file-name-sans-extension f
) (cdr (car oa
))))
1670 (if (and oa
(file-exists-p obj
)
1671 (speedbar-y-or-n-p (format "Delete %s? " obj
) t
))
1674 (speedbar-reset-scanners)))))
1676 (defun speedbar-enable-update ()
1677 "Enable automatic updating in speedbar via timers."
1679 (setq speedbar-update-flag t
)
1680 (speedbar-set-mode-line-format)
1681 (speedbar-set-timer dframe-update-speed
))
1683 (defun speedbar-disable-update ()
1684 "Disable automatic updating and stop consuming resources."
1686 (setq speedbar-update-flag nil
)
1687 (speedbar-set-mode-line-format)
1688 (speedbar-set-timer nil
))
1690 (defun speedbar-toggle-updates ()
1691 "Toggle automatic update for the speedbar frame."
1693 (if speedbar-update-flag
1694 (speedbar-disable-update)
1695 (speedbar-enable-update)))
1697 (defun speedbar-toggle-images ()
1698 "Toggle use of images in the speedbar frame.
1699 Images are not available in Emacs 20 or earlier."
1701 (setq speedbar-use-images
(not speedbar-use-images
))
1704 (defun speedbar-toggle-sorting ()
1705 "Toggle tag sorting."
1707 (setq speedbar-sort-tags
(not speedbar-sort-tags
)))
1709 (defun speedbar-toggle-show-all-files ()
1710 "Toggle display of files speedbar can not tag."
1712 (setq speedbar-show-unknown-files
(not speedbar-show-unknown-files
))
1715 (defmacro speedbar-with-writable
(&rest forms
)
1716 "Allow the buffer to be writable and evaluate FORMS."
1717 (list 'let
'((inhibit-read-only t
))
1718 (cons 'progn forms
)))
1719 (put 'speedbar-with-writable
'lisp-indent-function
0)
1721 (defun speedbar-insert-button (text face mouse function
1722 &optional token prevline
)
1723 "Insert TEXT as the next logical speedbar button.
1724 FACE is the face to put on the button, MOUSE is the highlight face to use.
1725 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1726 This function assumes that the current buffer is the speedbar buffer.
1727 If PREVLINE, then put this button on the previous line.
1729 This is a convenience function for special modes that create their own
1730 specialized speedbar displays."
1731 (goto-char (point-max))
1732 (let ((start (point)))
1733 (if (/= (current-column) 0) (insert "\n"))
1734 (put-text-property start
(point) 'invisible nil
))
1735 (if prevline
(progn (delete-char -
1)
1736 (insert " ") ;back up if desired...
1737 (put-text-property (1- (point)) (point) 'invisible nil
)))
1738 (let ((start (point)))
1740 (speedbar-make-button start
(point) face mouse function token
))
1741 (let ((start (point)))
1743 (add-text-properties
1744 start
(point) '(face nil invisible nil mouse-face nil
))))
1746 (defun speedbar-insert-separator (text)
1747 "Insert a separation label of TEXT.
1748 Separators are not active, have no labels, depth, or actions."
1749 (if speedbar-use-images
1750 (let ((start (point)))
1752 (speedbar-insert-image-button-maybe start
2)))
1753 (let ((start (point)))
1755 (speedbar-make-button start
(point)
1756 'speedbar-separator-face
1759 (defun speedbar-make-button (start end face mouse function
&optional token
)
1760 "Create a button from START to END, with FACE as the display face.
1761 MOUSE is the mouse face. When this button is clicked on FUNCTION
1762 will be run with the TOKEN parameter (any Lisp object). If FACE
1763 is t use the text properties of the string that is passed as an
1766 (put-text-property start end
'face face
))
1767 (add-text-properties
1768 start end
`(mouse-face ,mouse invisible nil
1769 speedbar-text
,(buffer-substring-no-properties start end
)))
1770 (if speedbar-use-tool-tips-flag
1771 (put-text-property start end
'help-echo
#'dframe-help-echo
))
1772 (if function
(put-text-property start end
'speedbar-function function
))
1773 (if token
(put-text-property start end
'speedbar-token token
))
1774 ;; So far the only text we have is less that 3 chars.
1775 (if (<= (- end start
) 3)
1776 (speedbar-insert-image-button-maybe start
(- end start
)))
1779 ;;; Initial Expansion list management
1781 (defun speedbar-initial-expansion-list ()
1782 "Return the current default expansion list.
1783 This is based on `speedbar-initial-expansion-list-name' referencing
1784 `speedbar-initial-expansion-mode-alist'."
1785 ;; cdr1 - name, cdr2 - menu
1786 (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name
1787 speedbar-initial-expansion-mode-alist
)))))
1789 (defun speedbar-initial-menu ()
1790 "Return the current default menu data.
1791 This is based on `speedbar-initial-expansion-list-name' referencing
1792 `speedbar-initial-expansion-mode-alist'."
1794 (car (cdr (assoc speedbar-initial-expansion-list-name
1795 speedbar-initial-expansion-mode-alist
)))))
1797 (defun speedbar-initial-keymap ()
1798 "Return the current default menu data.
1799 This is based on `speedbar-initial-expansion-list-name' referencing
1800 `speedbar-initial-expansion-mode-alist'."
1802 (car (cdr (cdr (assoc speedbar-initial-expansion-list-name
1803 speedbar-initial-expansion-mode-alist
))))))
1805 (defun speedbar-initial-stealthy-functions ()
1806 "Return a list of functions to call stealthily.
1807 This is based on `speedbar-initial-expansion-list-name' referencing
1808 `speedbar-stealthy-function-list'."
1809 (cdr (assoc speedbar-initial-expansion-list-name
1810 speedbar-stealthy-function-list
)))
1812 (defun speedbar-add-expansion-list (new-list)
1813 "Add NEW-LIST to the list of expansion lists."
1814 (add-to-list 'speedbar-initial-expansion-mode-alist new-list
))
1816 (defun speedbar-change-initial-expansion-list (new-default)
1817 "Change speedbar's default expansion list to NEW-DEFAULT."
1820 (completing-read (format "Speedbar Mode (default %s): "
1821 speedbar-previously-used-expansion-list-name
)
1822 speedbar-initial-expansion-mode-alist
1824 speedbar-previously-used-expansion-list-name
)))
1825 (setq speedbar-previously-used-expansion-list-name
1826 speedbar-initial-expansion-list-name
1827 speedbar-initial-expansion-list-name new-default
)
1828 (if (and (speedbar-current-frame) (frame-live-p (speedbar-current-frame)))
1831 (speedbar-reconfigure-keymaps))))
1833 (defun speedbar-fetch-replacement-function (function)
1834 "Return a current mode specific replacement for function, or nil.
1835 Scans `speedbar-mode-functions-list' first for the current mode, then
1837 (cdr (assoc function
1838 (cdr (assoc speedbar-initial-expansion-list-name
1839 speedbar-mode-functions-list
)))))
1841 (defun speedbar-add-mode-functions-list (new-list)
1842 "Add NEW-LIST to the list of mode functions.
1843 See `speedbar-mode-functions-list' for details."
1844 (add-to-list 'speedbar-mode-functions-list new-list
))
1847 ;;; Special speedbar display management
1849 (defun speedbar-maybe-add-localized-support (buffer)
1850 "Quick check function called on BUFFERs by the speedbar timer function.
1851 Maintains the value of local variables which control speedbars use
1852 of the special mode functions."
1853 (or speedbar-special-mode-expansion-list
1854 (speedbar-add-localized-speedbar-support buffer
)))
1856 (defun speedbar-add-localized-speedbar-support (buffer)
1857 "Add localized speedbar support to BUFFER's mode if it is available."
1858 (interactive "bBuffer: ")
1859 (if (stringp buffer
) (setq buffer
(get-buffer buffer
)))
1860 (if (not (buffer-live-p buffer
))
1865 (let ((ms (symbol-name major-mode
)) v
)
1866 (if (not (string-match "-mode$" ms
))
1867 nil
;; do nothing to broken mode
1868 (setq ms
(substring ms
0 (match-beginning 0)))
1869 (setq v
(intern-soft (concat ms
"-speedbar-buttons")))
1870 (make-local-variable 'speedbar-special-mode-expansion-list
)
1872 (setq speedbar-special-mode-expansion-list t
)
1873 ;; If it is autoloaded, we need to load it now so that
1874 ;; we have access to the varialbe -speedbar-menu-items.
1875 ;; Is this XEmacs safe?
1876 (let ((sf (symbol-function v
)))
1877 (if (and (listp sf
) (eq (car sf
) 'autoload
))
1878 (load-library (car (cdr sf
)))))
1879 (setq speedbar-special-mode-expansion-list
(list v
))
1880 (setq v
(intern-soft (concat ms
"-speedbar-key-map")))
1882 nil
;; don't add special keymap
1883 (make-local-variable 'speedbar-special-mode-key-map
)
1884 (setq speedbar-special-mode-key-map
1886 (setq v
(intern-soft (concat ms
"-speedbar-menu-items")))
1888 nil
;; don't add special menus
1889 (make-local-variable 'speedbar-easymenu-definition-special
)
1890 (setq speedbar-easymenu-definition-special
1894 (defun speedbar-remove-localized-speedbar-support (buffer)
1895 "Remove any traces that BUFFER supports speedbar in a specialized way."
1898 (kill-local-variable 'speedbar-special-mode-expansion-list
)
1899 (kill-local-variable 'speedbar-special-mode-key-map
)
1900 (kill-local-variable 'speedbar-easymenu-definition-special
)))
1902 ;;; File button management
1904 (defun speedbar-file-lists (directory)
1905 "Create file lists for DIRECTORY.
1906 The car is the list of directories, the cdr is list of files not
1907 matching ignored headers. Cache any directory files found in
1908 `speedbar-directory-contents-alist' and use that cache before scanning
1910 (setq directory
(expand-file-name directory
))
1911 ;; If in powerclick mode, then the directory we are getting
1912 ;; should be rescanned.
1913 (if dframe-power-click
1914 (adelete 'speedbar-directory-contents-alist directory
))
1915 ;; find the directory, either in the cache, or build it.
1916 (or (cdr-safe (assoc directory speedbar-directory-contents-alist
))
1917 (let ((default-directory directory
)
1918 (dir (directory-files directory nil
))
1923 (or (string-match speedbar-file-unshown-regexp
(car dir
))
1924 (member (car dir
) vc-directory-exclusion-list
)
1925 (string-match speedbar-directory-unshown-regexp
(car dir
))))
1926 (if (file-directory-p (car dir
))
1927 (setq dirs
(cons (car dir
) dirs
))
1928 (setq files
(cons (car dir
) files
))))
1929 (setq dir
(cdr dir
)))
1930 (let ((nl (cons (nreverse dirs
) (list (nreverse files
)))))
1931 (aput 'speedbar-directory-contents-alist directory nl
)
1935 (defun speedbar-directory-buttons (directory index
)
1936 "Insert a single button group at point for DIRECTORY.
1937 Each directory directory part is a different button. If part of the directory
1938 matches the user directory ~, then it is replaced with a ~.
1939 INDEX is not used, but is required by the caller."
1940 (let* ((tilde (expand-file-name "~/"))
1941 (dd (expand-file-name directory
))
1942 (junk (string-match (regexp-quote tilde
) dd
))
1944 (concat "~/" (substring dd
(match-end 0)))
1947 (if (string-match "^~[/\\]?\\'" displayme
) (setq displayme tilde
))
1951 (while (re-search-forward "\\([^/\\]+\\)[/\\]" nil t
)
1952 (speedbar-make-button (match-beginning 1) (match-end 1)
1953 'speedbar-directory-face
1954 'speedbar-highlight-face
1955 'speedbar-directory-buttons-follow
1956 (if (and (= (match-beginning 1) p
)
1957 (not (char-equal (char-after (+ p
1)) ?
:)))
1958 (expand-file-name "~/") ;the tilde
1959 (buffer-substring-no-properties
1961 ;; Nuke the beginning of the directory if it's too long...
1962 (cond ((eq speedbar-directory-button-trim-method
'span
)
1964 (let ((ww (or (speedbar-frame-width) 20)))
1965 (move-to-column ww nil
)
1966 (while (>= (current-column) ww
)
1967 (re-search-backward "[/\\]" nil t
)
1968 (if (<= (current-column) 2)
1970 (re-search-forward "[/\\]" nil t
)
1971 (if (< (current-column) 4)
1972 (re-search-forward "[/\\]" nil t
))
1974 (if (looking-at "[/\\]?$")
1977 (move-to-column ww nil
)))))
1978 ((eq speedbar-directory-button-trim-method
'trim
)
1980 (let ((ww (or (speedbar-frame-width) 20))
1981 (tl (current-column)))
1984 (move-to-column (- tl ww
))
1985 (if (re-search-backward "[/\\]" nil t
)
1987 (delete-region (point-min) (point))
1991 (if (string-match "\\`[/\\][^/\\]+[/\\]\\'" displayme
)
1996 (speedbar-make-button p
(point)
1997 'speedbar-directory-face
1998 'speedbar-highlight-face
1999 'speedbar-directory-buttons-follow
2002 (insert-char ?
\n 1 nil
)))
2004 (defun speedbar-make-tag-line (exp-button-type
2005 exp-button-char exp-button-function
2007 tag-button tag-button-function tag-button-data
2008 tag-button-face depth
)
2009 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
2010 This is the button that expands or contracts a node (if applicable),
2011 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
2012 is the function to call if it's clicked on. Button types are
2013 'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil.
2014 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
2017 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
2018 function to call if clicked on, and TAG-BUTTON-DATA is the data to
2019 attach to the text field (such a tag positioning, etc).
2020 TAG-BUTTON-FACE is a face used for this type of tag.
2022 Lastly, DEPTH shows the depth of expansion.
2024 This function assumes that the cursor is in the speedbar window at the
2025 position to insert a new item, and that the new item will end with a CR."
2026 (let ((start (point))
2028 (insert (int-to-string depth
) ":")
2030 (depthspacesize (* depth speedbar-indentation-width
)))
2031 (put-text-property start end
'invisible t
)
2032 (insert-char ? depthspacesize nil
)
2033 (put-text-property (- (point) depthspacesize
) (point) 'invisible nil
)
2034 (let* ((exp-button (cond ((eq exp-button-type
'bracket
) "[%c]")
2035 ((eq exp-button-type
'angle
) "<%c>")
2036 ((eq exp-button-type
'curly
) "{%c}")
2037 ((eq exp-button-type
'expandtag
) " %c>")
2038 ((eq exp-button-type
'statictag
) " =>")
2040 (buttxt (format exp-button exp-button-char
))
2042 (end (progn (insert buttxt
) (point)))
2043 (bf (if (and exp-button-type
(not (eq exp-button-type
'statictag
)))
2044 'speedbar-button-face nil
))
2045 (mf (if exp-button-function
'speedbar-highlight-face nil
))
2047 (speedbar-make-button start end bf mf exp-button-function exp-button-data
)
2048 (if speedbar-hide-button-brackets-flag
2050 (put-text-property start
(1+ start
) 'invisible t
)
2051 (put-text-property end
(1- end
) 'invisible t
)))
2053 (insert-char ?
1 nil
)
2054 (put-text-property (1- (point)) (point) 'invisible nil
)
2055 (let ((start (point))
2056 (end (progn (insert tag-button
) (point))))
2057 (insert-char ?
\n 1 nil
)
2058 (put-text-property (1- (point)) (point) 'invisible nil
)
2059 (speedbar-make-button start end tag-button-face
2060 (if tag-button-function
'speedbar-highlight-face nil
)
2061 tag-button-function tag-button-data
))
2064 (defun speedbar-change-expand-button-char (char)
2065 "Change the expansion button character to CHAR for the current line."
2068 (if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line)
2070 (speedbar-with-writable
2071 (goto-char (match-end 1))
2072 (insert-char char
1 t
)
2075 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2076 ;; make sure we fix the image on the text here.
2077 (speedbar-insert-image-button-maybe (- (point) 1) 3)))))
2080 ;;; Build button lists
2082 (defun speedbar-insert-files-at-point (files level
)
2083 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2084 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2085 don't know how to manage them. The input parameter FILES is a cons
2086 cell of the form ( 'DIRLIST . 'FILELIST )."
2087 ;; Start inserting all the directories
2088 (let ((dirs (car files
)))
2090 (speedbar-make-tag-line 'angle ?
+ 'speedbar-dired
(car dirs
)
2091 (car dirs
) 'speedbar-dir-follow nil
2092 'speedbar-directory-face level
)
2093 (setq dirs
(cdr dirs
))))
2094 (let ((lst (car (cdr files
)))
2095 (case-fold-search t
))
2097 (let* ((known (string-match speedbar-file-regexp
(car lst
)))
2098 (expchar (if known ?
+ ??
))
2099 (fn (if known
'speedbar-tag-file nil
)))
2100 (if (or speedbar-show-unknown-files
(/= expchar ??
))
2101 (speedbar-make-tag-line 'bracket expchar fn
(car lst
)
2102 (car lst
) 'speedbar-find-file nil
2103 'speedbar-file-face level
)))
2104 (setq lst
(cdr lst
)))))
2106 (defun speedbar-default-directory-list (directory index
)
2107 "Insert files for DIRECTORY with level INDEX at point."
2108 (speedbar-insert-files-at-point
2109 (speedbar-file-lists directory
) index
)
2110 (speedbar-reset-scanners)
2112 ;; If the shown files variable has extra directories, then
2113 ;; it is our responsibility to redraw them all
2114 ;; Luckilly, the nature of inserting items into this list means
2115 ;; that by reversing it, we can easilly go in the right order
2116 (let ((sf (cdr (reverse speedbar-shown-directories
))))
2117 (setq speedbar-shown-directories
2118 (list (expand-file-name default-directory
)))
2119 ;; exand them all as we find them
2121 (if (speedbar-goto-this-file (car sf
))
2124 (if (looking-at "[0-9]+:[ ]*<")
2126 (goto-char (match-end 0))
2127 (speedbar-do-function-pointer)))))
2130 ;;; Generic List support
2132 ;; Generic lists are hierarchies of tags which we may need to permute
2133 ;; in order to make it look nice.
2135 ;; A generic list is of the form:
2136 ;; ( ("name" . marker-or-number) <-- one tag at this level
2137 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2138 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2139 (defun speedbar-generic-list-group-p (sublst)
2140 "Non-nil if SUBLST is a group.
2141 Groups may optionally contain a position."
2142 (and (stringp (car-safe sublst
))
2143 (or (and (listp (cdr-safe sublst
))
2144 (or (speedbar-generic-list-tag-p (car-safe (cdr-safe sublst
)))
2145 (speedbar-generic-list-group-p (car-safe (cdr-safe sublst
))
2147 (and (number-or-marker-p (car-safe (cdr-safe sublst
)))
2148 (listp (cdr-safe (cdr-safe sublst
)))
2149 (speedbar-generic-list-tag-p
2150 (car-safe (cdr-safe (cdr-safe sublst
)))))
2153 (defun speedbar-generic-list-positioned-group-p (sublst)
2154 "Non-nil of SUBLST is a group with a position."
2155 (and (stringp (car-safe sublst
))
2156 (number-or-marker-p (car-safe (cdr-safe sublst
)))
2157 (listp (cdr-safe (cdr-safe sublst
)))
2158 (let ((rest (car-safe (cdr-safe (cdr-safe sublst
)))))
2159 (or (speedbar-generic-list-tag-p rest
)
2160 (speedbar-generic-list-group-p rest
)
2161 (speedbar-generic-list-positioned-group-p rest
)
2164 (defun speedbar-generic-list-tag-p (sublst)
2165 "Non-nil if SUBLST is a tag."
2166 (and (stringp (car-safe sublst
))
2167 (or (and (number-or-marker-p (cdr-safe sublst
))
2168 (not (cdr-safe (cdr-safe sublst
))))
2169 ;; For semantic/bovine items, this is needed
2170 (symbolp (car-safe (cdr-safe sublst
))))
2173 (defun speedbar-sort-tag-hierarchy (lst)
2174 "Sort all elements of tag hierarchy LST."
2175 (sort (copy-alist lst
)
2176 (lambda (a b
) (string< (car a
) (car b
)))))
2178 (defun speedbar-try-completion (string alist
)
2179 "A wrapper for `try-completion'.
2180 Passes STRING and ALIST to `try-completion' if ALIST
2182 (if (and (consp alist
)
2183 (listp (car alist
)) (stringp (car (car alist
))))
2184 (try-completion string alist
)
2187 (defun speedbar-prefix-group-tag-hierarchy (lst)
2188 "Prefix group names for tag hierarchy LST."
2193 (short-group-list nil
)
2194 (short-start-name nil
)
2195 (short-end-name nil
)
2196 (num-shorts-grouped 0)
2197 (bins (make-vector 256 nil
))
2199 (if (<= (length lst
) speedbar-tag-regroup-maximum-length
)
2200 ;; Do nothing. Too short to bother with.
2202 ;; Break out sub-lists
2204 (if (speedbar-generic-list-group-p (car-safe lst
))
2205 (setq newlst
(cons (car lst
) newlst
))
2206 (setq sublst
(cons (car lst
) sublst
)))
2207 (setq lst
(cdr lst
)))
2208 ;; Reverse newlst because it was made backwards.
2209 ;; Sublist doesn't need reversing because the act
2210 ;; of binning things will reverse it for us.
2211 (setq newlst
(nreverse newlst
)
2213 ;; Now, first find out how long our list is. Never let a
2214 ;; list get-shorter than our minimum.
2215 (if (<= (length sublst
) speedbar-tag-split-minimum-length
)
2216 (setq work-list sublst
)
2217 (setq diff-idx
(length (speedbar-try-completion "" sublst
)))
2218 ;; Sort the whole list into bins.
2220 (let ((e (car sublst
))
2221 (s (car (car sublst
))))
2222 (cond ((<= (length s
) diff-idx
)
2223 ;; 0 storage bin for shorty.
2224 (aset bins
0 (cons e
(aref bins
0))))
2226 ;; stuff into a bin based on ascii value at diff
2227 (aset bins
(aref s diff-idx
)
2228 (cons e
(aref bins
(aref s diff-idx
)))))))
2229 (setq sublst
(cdr sublst
)))
2230 ;; Go through all our bins Stick singles into our
2231 ;; junk-list, everything else as sublsts in work-list.
2232 ;; If two neighboring lists are both small, make a grouped
2233 ;; group combinding those two sub-lists.
2235 (while (> 256 diff-idx
)
2236 ;; The bins contents are currently in forward order.
2237 (let ((l (aref bins diff-idx
)))
2239 (let ((tmp (cons (speedbar-try-completion "" l
) l
)))
2240 (if (or (> (length l
) speedbar-tag-regroup-maximum-length
)
2241 (> (+ (length l
) (length short-group-list
))
2242 speedbar-tag-split-minimum-length
))
2244 ;; We have reached a longer list, so we
2245 ;; must finish off a grouped group.
2247 ((and short-group-list
2248 (= (length short-group-list
)
2249 num-shorts-grouped
))
2250 ;; All singles? Junk list
2251 (setq junk-list
(append (nreverse short-group-list
)
2253 ((= num-shorts-grouped
1)
2254 ;; Only one short group? Just stick it in
2255 ;; there by itself. Make a group, and find
2257 (let ((subexpression (speedbar-try-completion
2258 "" short-group-list
)))
2259 (if (< (length subexpression
)
2260 speedbar-tag-group-name-minimum-length
)
2262 (concat short-start-name
2265 (car (car short-group-list
))
2266 (length short-start-name
))
2269 (cons (cons subexpression
2273 ;; Multiple groups to be named in a special
2274 ;; way by displaying the range over which we
2275 ;; have grouped them.
2277 (cons (cons (concat short-start-name
2282 ;; Reset short group list information every time.
2283 (setq short-group-list nil
2284 short-start-name nil
2286 num-shorts-grouped
0)))
2287 ;; Ok, now that we cleaned up the short-group-list,
2288 ;; we can deal with this new list, to decide if it
2289 ;; should go on one of these sub-lists or not.
2290 (if (< (length l
) speedbar-tag-regroup-maximum-length
)
2291 (setq short-group-list
(append l short-group-list
)
2292 num-shorts-grouped
(1+ num-shorts-grouped
)
2293 short-end-name
(car tmp
)
2294 short-start-name
(if short-start-name
2297 (setq work-list
(cons tmp work-list
))))))
2298 (setq diff-idx
(1+ diff-idx
))))
2299 ;; Did we run out of things? Drop our new list onto the end.
2301 ((and short-group-list
(= (length short-group-list
) num-shorts-grouped
))
2302 ;; All singles? Junk list
2303 (setq junk-list
(append short-group-list junk-list
)))
2304 ((= num-shorts-grouped
1)
2305 ;; Only one short group? Just stick it in
2308 (cons (cons (speedbar-try-completion "" short-group-list
)
2312 ;; Multiple groups to be named in a special
2313 ;; way by displaying the range over which we
2314 ;; have grouped them.
2316 (cons (cons (concat short-start-name
" to " short-end-name
)
2319 ;; Reverse the work list nreversed when consing.
2320 (setq work-list
(nreverse work-list
))
2321 ;; Now, stick our new list onto the end of
2324 (append newlst work-list junk-list
)
2325 (append newlst work-list
))
2326 (append newlst junk-list
)))))
2328 (defun speedbar-trim-words-tag-hierarchy (lst)
2329 "Trim all words in a tag hierarchy.
2330 Base trimming information on word separators, and group names.
2331 Argument LST is the list of tags to trim."
2338 (if (speedbar-generic-list-group-p (car-safe lst
))
2339 (setq newlst
(cons (car lst
) newlst
))
2340 (setq sublst
(cons (car lst
) sublst
)))
2341 (setq lst
(cdr lst
)))
2342 ;; Get the prefix to trim by. Make sure that we don't trim
2343 ;; off silly pieces, only complete understandable words.
2344 (setq trim-prefix
(speedbar-try-completion "" sublst
)
2345 newlst
(nreverse newlst
))
2346 (if (or (= (length sublst
) 1)
2348 (not (string-match "\\(\\w+\\W+\\)+" trim-prefix
)))
2349 (append newlst
(nreverse sublst
))
2350 (setq trim-prefix
(substring trim-prefix
(match-beginning 0)
2352 (setq trim-chars
(length trim-prefix
))
2355 (cons (substring (car (car sublst
)) trim-chars
)
2358 sublst
(cdr sublst
)))
2359 ;; Put the lists together
2360 (append newlst trimlst
))))
2362 (defun speedbar-simple-group-tag-hierarchy (lst)
2363 "Create a simple 'Tags' group with orphaned tags.
2364 Argument LST is the list of tags to sort into groups."
2368 (if (speedbar-generic-list-group-p (car-safe lst
))
2369 (setq newlst
(cons (car lst
) newlst
))
2370 (setq sublst
(cons (car lst
) sublst
)))
2371 (setq lst
(cdr lst
)))
2374 (setq newlst
(cons (cons "Tags" (nreverse sublst
)) newlst
))
2375 (nreverse newlst
))))
2377 (defun speedbar-create-tag-hierarchy (lst)
2378 "Adjust the tag hierarchy in LST, and return it.
2379 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2381 (let* ((f (save-excursion
2383 (or (speedbar-line-file)
2384 (speedbar-line-directory))))
2385 (methods (if (get-file-buffer f
)
2386 (save-excursion (set-buffer (get-file-buffer f
))
2387 speedbar-tag-hierarchy-method
)
2388 speedbar-tag-hierarchy-method
))
2389 (lst (if (fboundp 'copy-tree
)
2393 (setq lst
(funcall (car methods
) lst
)
2394 methods
(cdr methods
)))
2397 (defvar speedbar-generic-list-group-expand-button-type
'curly
2398 "The type of button created for groups of tags.
2399 Good values for this are `curly' and `expandtag'.
2400 Make buffer local for your mode.")
2402 (defvar speedbar-generic-list-tag-button-type nil
2403 "The type of button created for tags in generic lists.
2404 Good values for this are nil and `statictag'.
2405 Make buffer local for your mode.")
2407 (defun speedbar-insert-generic-list (level lst expand-fun find-fun
)
2408 "At LEVEL, insert a generic multi-level alist LST.
2409 Associations with lists get {+} tags (to expand into more nodes) and
2410 those with positions just get a > as the indicator. {+} buttons will
2411 have the function EXPAND-FUN and the token is the CDR list. The token
2412 name will have the function FIND-FUN and not token."
2413 ;; Remove imenu rescan button
2414 (if (string= (car (car lst
)) "*Rescan*")
2415 (setq lst
(cdr lst
)))
2416 ;; Get, and set up variables that define how we treat these tags.
2417 (let ((f (save-excursion (forward-line -
1)
2418 (or (speedbar-line-file)
2419 (speedbar-line-directory))))
2420 expand-button tag-button
)
2422 (if (get-file-buffer f
)
2423 (set-buffer (get-file-buffer f
)))
2424 (setq expand-button speedbar-generic-list-group-expand-button-type
2425 tag-button speedbar-generic-list-tag-button-type
))
2427 (setq lst
(speedbar-create-tag-hierarchy lst
))
2430 (cond ((null (car-safe lst
)) nil
) ;this would be a separator
2431 ((speedbar-generic-list-tag-p (car lst
))
2432 (speedbar-make-tag-line tag-button
2433 nil nil nil
;no expand button data
2434 (car (car lst
)) ;button name
2436 (cdr (car lst
)) ;token is position
2439 ((speedbar-generic-list-positioned-group-p (car lst
))
2440 (speedbar-make-tag-line expand-button
2441 ?
+ expand-fun
(cdr (cdr (car lst
)))
2442 (car (car lst
)) ;button name
2444 (car (cdr (car lst
))) ;token is posn
2447 ((speedbar-generic-list-group-p (car lst
))
2448 (speedbar-make-tag-line expand-button
2449 ?
+ expand-fun
(cdr (car lst
))
2450 (car (car lst
)) ;button name
2451 nil nil
'speedbar-tag-face
2453 (t (speedbar-message "speedbar-insert-generic-list: malformed list!")
2455 (setq lst
(cdr lst
)))))
2457 (defun speedbar-insert-imenu-list (indent lst
)
2458 "At level INDENT, insert the imenu generated LST."
2459 (speedbar-insert-generic-list indent lst
2460 'speedbar-tag-expand
2461 'speedbar-tag-find
))
2463 (defun speedbar-insert-etags-list (indent lst
)
2464 "At level INDENT, insert the etags generated LST."
2465 (speedbar-insert-generic-list indent lst
2466 'speedbar-tag-expand
2467 'speedbar-tag-find
))
2471 (defun speedbar-update-contents ()
2472 "Generically update the contents of the speedbar buffer."
2474 ;; Set the current special buffer
2475 (setq speedbar-desired-buffer nil
)
2477 ;; Check for special modes
2478 (speedbar-maybe-add-localized-support (current-buffer))
2480 ;; Choose the correct method of doodling.
2481 (if (and speedbar-mode-specific-contents-flag
2482 (consp speedbar-special-mode-expansion-list
)
2484 'speedbar-special-mode-expansion-list
2486 ;;(eq (get major-mode 'mode-class 'special)))
2487 (speedbar-update-special-contents)
2488 (speedbar-update-directory-contents)))
2490 (defun speedbar-update-localized-contents ()
2491 "Update the contents of the speedbar buffer for the current situation."
2492 ;; Due to the historical growth of speedbar, we need to do something
2493 ;; special for "files" mode. Too bad.
2494 (let ((name speedbar-initial-expansion-list-name
)
2495 (funclst (speedbar-initial-expansion-list))
2497 (if (string= name
"files")
2498 ;; Do all the files type work. It still goes through the
2499 ;; expansion list stuff. :(
2500 (if (or (member (expand-file-name default-directory
)
2501 speedbar-shown-directories
)
2502 (and speedbar-ignored-directory-regexp
2504 speedbar-ignored-directory-regexp
2505 (expand-file-name default-directory
))))
2507 (if (<= 1 speedbar-verbosity-level
)
2508 (speedbar-message "Updating speedbar to: %s..."
2510 (speedbar-update-directory-contents)
2511 (if (<= 1 speedbar-verbosity-level
)
2513 (speedbar-message "Updating speedbar to: %s...done"
2515 (speedbar-message nil
))))
2516 ;; Else, we can do a short cut. No text cache.
2517 (let ((cbd (expand-file-name default-directory
)))
2518 (set-buffer speedbar-buffer
)
2519 (speedbar-with-writable
2520 (let* ((window (get-buffer-window speedbar-buffer
0))
2521 (p (window-point window
))
2522 (start (window-start window
)))
2524 (dolist (func funclst
)
2525 (setq default-directory cbd
)
2526 (funcall func cbd
0))
2527 (speedbar-reconfigure-keymaps)
2528 (set-window-point window p
)
2529 (set-window-start window start
)))))))
2531 (defun speedbar-update-directory-contents ()
2532 "Update the contents of the speedbar buffer based on the current directory."
2533 (let ((cbd (expand-file-name default-directory
))
2535 (funclst (speedbar-initial-expansion-list))
2536 (cache speedbar-full-text-cache
)
2537 ;; disable stealth during update
2538 (speedbar-stealthy-function-list nil
)
2541 ;; Because there is a bug I can't find just yet
2543 (set-buffer speedbar-buffer
)
2544 ;; If we are updating contents to where we are, then this is
2545 ;; really a request to update existing contents, so we must be
2546 ;; careful with our text cache!
2547 (if (member cbd speedbar-shown-directories
)
2550 ;; If the current directory is not the last element in the dir
2551 ;; list, then we ALSO need to zap the list of expanded directories
2552 (if (/= (length (member cbd speedbar-shown-directories
)) 1)
2553 (setq speedbar-shown-directories
(list cbd
))))
2555 ;; Build cbd-parent, and see if THAT is in the current shown
2556 ;; directories. First, go through pains to get the parent directory
2557 (if (and speedbar-smart-directory-expand-flag
2559 (setq cbd-parent cbd
)
2560 (if (string-match "[/\\]$" cbd-parent
)
2561 (setq cbd-parent
(substring cbd-parent
0
2562 (match-beginning 0))))
2563 (setq cbd-parent
(file-name-directory cbd-parent
)))
2564 (member cbd-parent speedbar-shown-directories
))
2565 (setq expand-local t
)
2567 ;; If this directory is NOT in the current list of available
2568 ;; directorys, then use the cache, and set the cache to our new
2569 ;; value. Make sure to unhighlight the current file, or if we
2570 ;; come back to this directory, it might be a different file
2571 ;; and then we get a mess!
2572 (if (> (point-max) 1)
2574 (speedbar-clear-current-file)
2575 (setq speedbar-full-text-cache
2576 (cons speedbar-shown-directories
(buffer-string)))))
2578 ;; Check if our new directory is in the list of directories
2579 ;; shown in the text-cache
2580 (if (member cbd
(car cache
))
2581 (setq speedbar-shown-directories
(car cache
)
2583 ;; default the shown directories to this list...
2584 (setq speedbar-shown-directories
(list cbd
)))
2586 (if (not expand-local
) (setq speedbar-last-selected-file nil
))
2587 (speedbar-with-writable
2588 (if (and expand-local
2589 ;; Find this directory as a speedbar node.
2590 (speedbar-directory-line cbd
))
2592 (speedbar-expand-line)
2593 (let* ((window (get-buffer-window speedbar-buffer
0))
2594 (p (window-point window
))
2595 (start (window-start window
)))
2598 (setq default-directory
2599 (nth (1- (length speedbar-shown-directories
))
2600 speedbar-shown-directories
))
2601 (insert (cdr cache
)))
2603 (dolist (func funclst
)
2604 (setq default-directory cbd
)
2605 (funcall func cbd
0))))
2606 (set-window-point window p
)
2607 (set-window-start window start
)))))
2608 (speedbar-reconfigure-keymaps))
2610 (defun speedbar-update-special-contents ()
2611 "Use the mode-specific variable to fill in the speedbar buffer.
2612 This should only be used by modes classified as special."
2613 (let ((funclst speedbar-special-mode-expansion-list
)
2614 (specialbuff (current-buffer)))
2616 (setq speedbar-desired-buffer specialbuff
)
2617 (set-buffer speedbar-buffer
)
2618 ;; If we are leaving a directory, cache it.
2619 (if (not speedbar-shown-directories
)
2622 ;; Clean up directory maintenance stuff
2623 (speedbar-clear-current-file)
2624 (setq speedbar-full-text-cache
2625 (cons speedbar-shown-directories
(buffer-string))
2626 speedbar-shown-directories nil
))
2627 ;; Now fill in the buffer with our newly found specialized list.
2628 (speedbar-with-writable
2629 (dolist (func funclst
)
2630 ;; We do not erase the buffer because these functions may
2631 ;; decide NOT to update themselves.
2632 (funcall func specialbuff
)))))
2633 (speedbar-reconfigure-keymaps))
2635 (defun speedbar-set-timer (timeout)
2636 "Set up the speedbar timer with TIMEOUT.
2637 Uses `dframe-set-timer'.
2638 Also resets scanner functions."
2639 (dframe-set-timer timeout
'speedbar-timer-fn
'speedbar-update-flag
)
2640 ;; Apply a revert hook that will reset the scanners. We attach to revert
2641 ;; because most reverts occur during VC state change, and this lets our
2642 ;; VC scanner fix itself.
2644 (add-hook 'after-revert-hook
'speedbar-reset-scanners
)
2645 (remove-hook 'after-revert-hook
'speedbar-reset-scanners
))
2646 ;; change this if it changed for some reason
2647 (speedbar-set-mode-line-format))
2649 (defun speedbar-timer-fn ()
2650 "Run whenever Emacs is idle to update the speedbar item."
2651 (if (or (not (speedbar-current-frame))
2652 (not (frame-live-p (speedbar-current-frame))))
2653 (speedbar-set-timer nil
)
2654 ;; Save all the match data so that we don't mess up executing fns
2656 ;; Only do stuff if the frame is visible, not an icon, and if
2657 ;; it is currently flagged to do something.
2658 (if (and speedbar-update-flag
2659 (speedbar-current-frame)
2660 (frame-visible-p (speedbar-current-frame))
2661 (not (eq (frame-visible-p (speedbar-current-frame)) 'icon
)))
2662 (let ((af (selected-frame)))
2663 (dframe-select-attached-frame speedbar-frame
)
2664 ;; make sure we at least choose a window to
2665 ;; get a good directory from
2666 (if (window-minibuffer-p (selected-window))
2668 ;; Check for special modes
2669 (speedbar-maybe-add-localized-support (current-buffer))
2670 ;; Update for special mode all the time!
2671 (if (and speedbar-mode-specific-contents-flag
2672 (consp speedbar-special-mode-expansion-list
)
2674 'speedbar-special-mode-expansion-list
2676 ;;(eq (get major-mode 'mode-class 'special)))
2678 (if (<= 2 speedbar-verbosity-level
)
2680 "Updating speedbar to special mode: %s..."
2682 (speedbar-update-special-contents)
2683 (if (<= 2 speedbar-verbosity-level
)
2686 "Updating speedbar to special mode: %s...done"
2688 (speedbar-message nil
))))
2690 ;; Update all the contents if directories change!
2691 (unless (and (or (member major-mode speedbar-ignored-modes
)
2692 (eq af
(speedbar-current-frame))
2693 (not (buffer-file-name)))
2694 ;; Always update for GUD.
2695 (not (string-equal "GUD"
2696 speedbar-initial-expansion-list-name
)))
2697 (speedbar-update-localized-contents)))
2699 ;; Now run stealthy updates of time-consuming items
2700 (speedbar-stealthy-updates)))))
2701 (run-hooks 'speedbar-timer-hook
))
2704 ;;; Stealthy activities
2706 (defvar speedbar-stealthy-update-recurse nil
2707 "Recursion avoidance variable for stealthy update.")
2709 (defun speedbar-stealthy-updates ()
2710 "For a given speedbar, run all items in the stealthy function list.
2711 Each item returns t if it completes successfully, or nil if
2712 interrupted by the user."
2713 (if (not speedbar-stealthy-update-recurse
)
2714 (let ((l (speedbar-initial-stealthy-functions))
2715 (speedbar-stealthy-update-recurse t
))
2717 (speedbar-with-writable
2718 (while (and l
(funcall (car l
)))
2721 ;;(speedbar-message "Exit with %S" (car l))
2724 (defun speedbar-reset-scanners ()
2725 "Reset any variables used by functions in the stealthy list as state.
2726 If new functions are added, their state needs to be updated here."
2727 (setq speedbar-vc-to-do-point t
2728 speedbar-obj-to-do-point t
2729 speedbar-ro-to-do-point t
)
2730 (run-hooks 'speedbar-scanner-reset-hook
)
2733 (defun speedbar-find-selected-file (file)
2734 "Go to the line where FILE is."
2736 (set-buffer speedbar-buffer
)
2738 (goto-char (point-min))
2740 (while (and (setq m
(re-search-forward
2741 (concat " \\(" (regexp-quote (file-name-nondirectory file
))
2742 "\\)\\(" speedbar-indicator-regex
"\\)?\n")
2746 (speedbar-line-directory
2748 (goto-char (match-beginning 0))
2751 (looking-at "[0-9]+:")
2752 (string-to-number (match-string 0)))))
2753 (match-string 1))))))
2756 (goto-char (match-beginning 1))
2757 (match-string 1)))))
2759 (defun speedbar-clear-current-file ()
2760 "Locate the file thought to be current, and remove its highlighting."
2762 ;;(set-buffer speedbar-buffer)
2763 (if speedbar-last-selected-file
2764 (speedbar-with-writable
2765 (if (speedbar-find-selected-file speedbar-last-selected-file
)
2766 (put-text-property (match-beginning 1)
2769 'speedbar-file-face
))))))
2771 (defun speedbar-update-current-file ()
2772 "Find the current file, and update our visuals to indicate its name.
2773 This is specific to file names. If the file name doesn't show up, but
2774 it should be in the list, then the directory cache needs to be
2776 (let* ((lastf (selected-frame))
2777 (newcfd (save-excursion
2778 (dframe-select-attached-frame speedbar-frame
)
2779 (let ((rf (if (buffer-file-name)
2782 (select-frame lastf
)
2784 (newcf (if newcfd newcfd
))
2785 (lastb (current-buffer))
2786 (sucf-recursive (boundp 'sucf-recursive
))
2787 (case-fold-search t
))
2789 ;; check here, that way we won't refresh to newcf until
2790 ;; its been written, thus saving ourselves some time
2791 (file-exists-p newcf
)
2792 (not (string= newcf speedbar-last-selected-file
)))
2794 ;; It is important to select the frame, otherwise the window
2795 ;; we want the cursor to move in will not be updated by the
2796 ;; search-forward command.
2797 (select-frame (speedbar-current-frame))
2798 ;; Remove the old file...
2799 (speedbar-clear-current-file)
2800 ;; now highlight the new one.
2801 ;; (set-buffer speedbar-buffer)
2802 (speedbar-with-writable
2803 (if (speedbar-find-selected-file newcf
)
2804 ;; put the property on it
2805 (put-text-property (match-beginning 1)
2808 'speedbar-selected-face
)
2809 ;; Oops, it's not in the list. Should it be?
2810 (if (and (string-match speedbar-file-regexp newcf
)
2811 (string= (file-name-directory newcfd
)
2812 (expand-file-name default-directory
)))
2813 ;; yes, it is (we will ignore unknowns for now...)
2816 (if (speedbar-find-selected-file newcf
)
2817 ;; put the property on it
2818 (put-text-property (match-beginning 1)
2821 'speedbar-selected-face
)))
2822 ;; if it's not in there now, whatever...
2824 (setq speedbar-last-selected-file newcf
))
2825 (if (not sucf-recursive
)
2828 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2829 ;;doesn't need to be in. We don't want to recenter when we are
2832 ;;(speedbar-center-buffer-smartly)
2834 (speedbar-position-cursor-on-line)
2837 (select-frame lastf
)
2839 ;; return that we are done with this activity.
2842 (defun speedbar-add-indicator (indicator-string &optional replace-this
)
2843 "Add INDICATOR-STRING to the end of this speedbar line.
2844 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2845 the existing indicator is removed. If there is already an
2846 indicator, then do not add a space."
2848 ;; The nature of the beast: Assume we are in "the right place"
2850 (skip-chars-backward (concat " " speedbar-vc-indicator
2851 speedbar-object-read-only-indicator
2852 (car speedbar-obj-indicator
)
2853 (cdr speedbar-obj-indicator
)))
2854 (if (and (not (looking-at speedbar-indicator-regex
))
2855 (not (string= indicator-string
" ")))
2856 (insert speedbar-indicator-separator
))
2857 (speedbar-with-writable
2859 (if (and replace-this
2860 (re-search-forward replace-this
(save-excursion (end-of-line)
2863 (delete-region (match-beginning 0) (match-end 0))))
2865 (if (not (string= " " indicator-string
))
2866 (let ((start (point)))
2867 (insert indicator-string
)
2868 (speedbar-insert-image-button-maybe start
(length indicator-string
))
2871 (defun speedbar-check-read-only ()
2872 "Scan all the files in a directory, and for each see if it is read only."
2873 ;; Check for to-do to be reset. If reset but no RCS is available
2874 ;; then set to nil (do nothing) otherwise, start at the beginning
2876 (if speedbar-buffer
(set-buffer speedbar-buffer
))
2877 (if (eq speedbar-ro-to-do-point t
)
2878 (setq speedbar-ro-to-do-point
0))
2879 (if (numberp speedbar-ro-to-do-point
)
2881 (goto-char speedbar-ro-to-do-point
)
2882 (while (and (not (input-pending-p))
2883 (re-search-forward "^\\([0-9]+\\):\\s-*[[<][+-\?][]>] "
2885 (setq speedbar-ro-to-do-point
(point))
2886 (let ((f (speedbar-line-file)))
2888 (if (not (file-writable-p f
))
2889 (speedbar-add-indicator
2890 speedbar-object-read-only-indicator
2891 (regexp-quote speedbar-object-read-only-indicator
))
2892 (speedbar-add-indicator
2894 speedbar-object-read-only-indicator
))))))
2895 (if (input-pending-p)
2896 ;; return that we are incomplete
2898 ;; we are done, set to-do to nil
2899 (setq speedbar-ro-to-do-point nil
)
2904 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2905 ;; Steven L Baur <steve@xemacs.org> said this was important:
2906 (eval-when-compile (or (featurep 'xemacs
)
2907 (condition-case () (require 'efs
)
2908 (error (require 'ange-ftp
)))))
2910 (defun speedbar-check-vc ()
2911 "Scan all files in a directory, and for each see if it's checked out.
2912 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2913 to add more types of version control systems."
2914 ;; Check for to-do to be reset. If reset but no RCS is available
2915 ;; then set to nil (do nothing) otherwise, start at the beginning
2917 (if speedbar-buffer
(set-buffer speedbar-buffer
))
2918 (if (and speedbar-vc-do-check
(eq speedbar-vc-to-do-point t
)
2919 (speedbar-vc-check-dir-p default-directory
)
2920 (not (or (and (featurep 'ange-ftp
)
2923 (if (featurep 'xemacs
)
2924 'ange-ftp-directory-format
2925 'ange-ftp-name-format
)))
2926 (expand-file-name default-directory
)))
2927 ;; efs support: Bob Weiner
2928 (and (featurep 'efs
)
2930 (let ((reg (symbol-value 'efs-directory-regexp
)))
2934 (expand-file-name default-directory
))))))
2935 (setq speedbar-vc-to-do-point
0))
2936 (if (numberp speedbar-vc-to-do-point
)
2938 (goto-char speedbar-vc-to-do-point
)
2939 (while (and (not (input-pending-p))
2940 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-?]\\] "
2942 (setq speedbar-vc-to-do-point
(point))
2943 (if (speedbar-check-vc-this-line (match-string 1))
2944 (speedbar-add-indicator speedbar-vc-indicator
2945 (regexp-quote speedbar-vc-indicator
))
2946 (speedbar-add-indicator " "
2947 (regexp-quote speedbar-vc-indicator
))))
2948 (if (input-pending-p)
2949 ;; return that we are incomplete
2951 ;; we are done, set to-do to nil
2952 (setq speedbar-vc-to-do-point nil
)
2957 (defun speedbar-check-vc-this-line (depth)
2958 "Return t if the file on this line is check of of a version control system.
2959 Parameter DEPTH is a string with the current depth of indentation of
2960 the file being checked."
2961 (let* ((d (string-to-number depth
))
2962 (f (speedbar-line-directory d
))
2963 (fn (buffer-substring-no-properties
2964 ;; Skip-chars: thanks ptype@dra.hmg.gb
2966 (skip-chars-forward "^ "
2967 (save-excursion (end-of-line)
2970 (fulln (concat f fn
)))
2971 (if (<= 2 speedbar-verbosity-level
)
2972 (speedbar-message "Speedbar vc check...%s" fulln
))
2973 (and (file-writable-p fulln
)
2974 (speedbar-this-file-in-vc f fn
))))
2976 (defun speedbar-vc-check-dir-p (directory)
2977 "Return t if we should bother checking DIRECTORY for version control files.
2978 This can be overloaded to add new types of version control systems."
2980 (catch t
(dolist (vcd vc-directory-exclusion-list
)
2981 (if (file-exists-p (concat directory vcd
)) (throw t t
))) nil
)
2983 (run-hook-with-args-until-success 'speedbar-vc-directory-enable-hook
2987 (defun speedbar-this-file-in-vc (directory name
)
2988 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2989 Automatically recognizes all VCs supported by VC mode. You can
2990 optimize this function by overriding it and only doing those checks
2991 that will occur on your system."
2993 (vc-backend (concat directory
"/" name
))
2995 (run-hook-with-args 'speedbar-vc-in-control-hook directory name
)
2998 ;; Objet File scanning
2999 (defun speedbar-check-objects ()
3000 "Scan all files in a directory, and for each see if there is an object.
3001 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
3002 to add more object types."
3003 ;; Check for to-do to be reset. If reset but no RCS is available
3004 ;; then set to nil (do nothing) otherwise, start at the beginning
3006 (if speedbar-buffer
(set-buffer speedbar-buffer
))
3007 (if (and speedbar-obj-do-check
(eq speedbar-obj-to-do-point t
))
3008 (setq speedbar-obj-to-do-point
0))
3009 (if (numberp speedbar-obj-to-do-point
)
3011 (goto-char speedbar-obj-to-do-point
)
3012 (while (and (not (input-pending-p))
3013 (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
3015 (setq speedbar-obj-to-do-point
(point))
3016 (let ((ind (speedbar-check-obj-this-line (match-string 1))))
3017 (if (not ind
) (setq ind
" "))
3018 (speedbar-add-indicator ind
(concat
3019 (car speedbar-obj-indicator
)
3021 (cdr speedbar-obj-indicator
)))))
3022 (if (input-pending-p)
3023 ;; return that we are incomplete
3025 ;; we are done, set to-do to nil
3026 (setq speedbar-obj-to-do-point nil
)
3031 (defun speedbar-check-obj-this-line (depth)
3032 "Return t if the file on this line has an associated object.
3033 Parameter DEPTH is a string with the current depth of indentation of
3034 the file being checked."
3035 (let* ((d (string-to-number depth
))
3036 (f (speedbar-line-directory d
))
3037 (fn (buffer-substring-no-properties
3038 ;; Skip-chars: thanks ptype@dra.hmg.gb
3040 (skip-chars-forward "^ "
3041 (save-excursion (end-of-line)
3044 (fulln (concat f fn
)))
3045 (if (<= 2 speedbar-verbosity-level
)
3046 (speedbar-message "Speedbar obj check...%s" fulln
))
3047 (let ((oa speedbar-obj-alist
))
3048 (while (and oa
(not (string-match (car (car oa
)) fulln
)))
3050 (if (not (and oa
(file-exists-p (concat (file-name-sans-extension fulln
)
3053 ;; Find out if the object is out of date or not.
3054 (let ((date1 (nth 5 (file-attributes fulln
)))
3055 (date2 (nth 5 (file-attributes (concat
3056 (file-name-sans-extension fulln
)
3058 (if (or (< (car date1
) (car date2
))
3059 (and (= (car date1
) (car date2
))
3060 (< (nth 1 date1
) (nth 1 date2
))))
3061 (car speedbar-obj-indicator
)
3062 (cdr speedbar-obj-indicator
)))))))
3064 ;;; Clicking Activity
3066 (defun speedbar-position-cursor-on-line ()
3067 "Position the cursor on a line."
3068 (let ((oldpos (point)))
3070 (if (looking-at "[0-9]+:\\s-*..?.? ")
3071 (goto-char (1- (match-end 0)))
3072 (goto-char oldpos
))))
3074 (defun speedbar-click (e)
3075 "Activate any speedbar buttons where the mouse is clicked.
3076 This must be bound to a mouse event. A button is any location of text
3077 with a mouse face that has a text property called `speedbar-function'.
3078 Argument E is the click event."
3079 ;; Backward compatibility let statement.
3080 (let ((speedbar-power-click dframe-power-click
))
3081 (speedbar-do-function-pointer))
3082 (dframe-quick-mouse e
))
3084 (defun speedbar-do-function-pointer ()
3085 "Look under the cursor and examine the text properties.
3086 From this extract the file/tag name, token, indentation level and call
3087 a function if appropriate."
3088 (let* ((speedbar-frame (speedbar-current-frame))
3089 (fn (get-text-property (point) 'speedbar-function
))
3090 (tok (get-text-property (point) 'speedbar-token
))
3091 ;; The 1-,+ is safe because scaning starts AFTER the point
3092 ;; specified. This lets the search include the character the
3094 (tp (previous-single-property-change
3095 (1+ (point)) 'speedbar-function
))
3096 (np (next-single-property-change
3097 (point) 'speedbar-function
))
3098 (txt (buffer-substring-no-properties (or tp
(point-min))
3099 (or np
(point-max))))
3100 (dent (save-excursion (beginning-of-line)
3102 (if (looking-at "[0-9]+")
3103 (buffer-substring-no-properties
3104 (match-beginning 0) (match-end 0))
3106 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3107 (and fn
(funcall fn txt tok dent
)))
3108 (speedbar-position-cursor-on-line))
3110 ;;; Reading info from the speedbar buffer
3112 (defun speedbar-line-text (&optional p
)
3113 "Retrieve the text after prefix junk for the current line.
3114 Optional argument P is where to start the search from."
3116 (if p
(goto-char p
))
3118 (if (looking-at (concat
3119 "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)"))
3120 (get-text-property (match-beginning 2) 'speedbar-text
)
3123 (defun speedbar-line-token (&optional p
)
3124 "Retrieve the token information after the prefix junk for the current line.
3125 Optional argument P is where to start the search from."
3127 (if p
(goto-char p
))
3129 (if (looking-at (concat
3130 "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)\\("
3131 speedbar-indicator-regex
"\\)?"))
3133 (goto-char (match-beginning 2))
3134 (get-text-property (point) 'speedbar-token
))
3137 (defun speedbar-line-file (&optional p
)
3138 "Retrieve the file or whatever from the line at point P.
3139 The return value is a string representing the file. If it is a
3140 directory, then it is the directory name."
3144 (let ((f (speedbar-line-text p
)))
3146 (let* ((depth (string-to-number (match-string 1)))
3147 (directory (speedbar-line-directory depth
)))
3148 (if (file-exists-p (concat directory f
))
3149 (concat directory f
)
3153 (defun speedbar-goto-this-file (file)
3154 "If FILE is displayed, go to this line and return t.
3155 Otherwise do not move and return nil."
3156 (let ((directory (substring (file-name-directory (expand-file-name file
))
3157 (length (expand-file-name default-directory
))))
3160 (goto-char (point-min))
3161 ;; scan all the directories
3162 (while (and directory
(not (eq directory t
)))
3163 (if (string-match "^[/\\]?\\([^/\\]+\\)" directory
)
3164 (let ((pp (match-string 1 directory
)))
3165 (if (save-match-data
3166 (re-search-forward (concat "> " (regexp-quote pp
) "$")
3168 (setq directory
(substring directory
(match-end 1)))
3169 (setq directory nil
)))
3170 (setq directory t
)))
3171 ;; find the file part
3172 (if (or (not directory
) (string= (file-name-nondirectory file
) ""))
3173 ;; only had a dir part
3176 (speedbar-position-cursor-on-line)
3178 (goto-char dest
) nil
)
3179 ;; find the file part
3180 (let ((nd (file-name-nondirectory file
)))
3181 (if (re-search-forward
3182 (concat "] \\(" (regexp-quote nd
)
3183 "\\)\\(" speedbar-indicator-regex
"\\)$")
3186 (speedbar-position-cursor-on-line)
3191 (defun speedbar-line-directory (&optional depth
)
3192 "Retrieve the directory name associated with the current line.
3193 This may require traversing backwards from DEPTH and combining the default
3194 directory with these items. This function is replaceable in
3195 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3198 (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-directory
)))
3199 (if rf
(funcall rf depth
) default-directory
))))
3201 (defun speedbar-files-line-directory (&optional depth
)
3202 "Retrieve the directoryname associated with the current line.
3203 This may require traversing backwards from DEPTH and combining the default
3204 directory with these items."
3210 (looking-at "^\\([0-9]+\\):")
3211 (setq depth
(string-to-number (match-string 1)))))
3212 (let ((directory nil
))
3213 (setq depth
(1- depth
))
3214 (while (/= depth -
1)
3215 (if (not (re-search-backward (format "^%d:" depth
) nil t
))
3216 (error "Error building filename of tag")
3217 (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)")
3218 (setq directory
(concat (speedbar-line-text)
3221 ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)")
3222 ;; This is the start of our directory.
3223 (setq directory
(speedbar-line-text)))))
3224 (setq depth
(1- depth
)))
3226 (string-match (concat speedbar-indicator-regex
"$")
3228 (setq directory
(substring directory
0 (match-beginning 0))))
3229 (concat default-directory directory
)))))
3231 (defun speedbar-directory-line (directory)
3232 "Position the cursor on the line specified by DIRECTORY."
3234 (if (string-match "[/\\]$" directory
)
3235 (setq directory
(substring directory
0 (match-beginning 0))))
3236 (let ((nomatch t
) (depth 0)
3237 (fname (file-name-nondirectory directory
))
3238 (pname (file-name-directory directory
)))
3239 (if (not (member pname speedbar-shown-directories
))
3240 (error "Internal Error: File %s not shown in speedbar" directory
))
3241 (goto-char (point-min))
3244 (concat "[]>] \\(" (regexp-quote fname
)
3245 "\\)\\(" speedbar-indicator-regex
"\\)?$")
3248 (looking-at "\\([0-9]+\\):")
3249 (setq depth
(string-to-number (match-string 0))
3250 nomatch
(not (string= pname
(speedbar-line-directory depth
))))
3255 (defun speedbar-edit-line ()
3256 "Edit whatever tag or file is on the current speedbar line."
3260 ;; If this fails, then it is a non-standard click, and as such,
3261 ;; perfectly allowed.
3262 (if (re-search-forward "[]>?}] [^ ]"
3263 (save-excursion (end-of-line) (point))
3267 (speedbar-do-function-pointer))
3269 (speedbar-do-function-pointer)))
3271 (defun speedbar-expand-line (&optional arg
)
3272 "Expand the line under the cursor.
3273 With universal argument ARG, flush cached data."
3276 (let* ((dframe-power-click arg
)
3277 (speedbar-power-click arg
))
3280 (re-search-forward ":\\s-*.\\+. "
3281 (save-excursion (end-of-line) (point)))
3283 (speedbar-do-function-pointer))
3284 (error (speedbar-position-cursor-on-line)))))
3286 (defun speedbar-flush-expand-line ()
3287 "Expand the line under the cursor and flush any cached information."
3289 (speedbar-expand-line 1))
3291 (defun speedbar-contract-line ()
3292 "Contract the line under the cursor."
3297 (re-search-forward ":\\s-*.-. "
3298 (save-excursion (end-of-line) (point)))
3300 (speedbar-do-function-pointer))
3301 (error (speedbar-position-cursor-on-line))))
3303 (defun speedbar-toggle-line-expansion ()
3304 "Contract or expand the line under the cursor."
3309 (re-search-forward ":\\s-*.[-+]. "
3310 (save-excursion (end-of-line) (point)))
3312 (speedbar-do-function-pointer))
3313 (error (speedbar-position-cursor-on-line))))
3315 (defun speedbar-expand-line-descendants (&optional arg
)
3316 "Expand the line under the cursor and all descendants.
3317 Optional argument ARG indicates that any cache should be flushed."
3319 (speedbar-expand-line arg
)
3320 ;; Now, inside the area expaded here, expand all subnodes of
3321 ;; the same descendant type.
3323 (speedbar-next 1) ;; Move into the list.
3328 (speedbar-expand-line-descendants arg
)
3329 (speedbar-restricted-next 1))
3330 (error (setq err t
))))))
3333 (defun speedbar-contract-line-descendants ()
3334 "Expand the line under the cursor and all descendants."
3336 (speedbar-contract-line)
3337 ;; Don't need to do anything else since all descendants are
3338 ;; hidden by default anyway. Yay! It's easy.
3341 (defun speedbar-find-file (text token indent
)
3342 "Speedbar click handler for filenames.
3343 TEXT, the file will be displayed in the attached frame.
3344 TOKEN is unused, but required by the click handler. INDENT is the
3345 current indentation level."
3346 (let ((cdd (speedbar-line-directory indent
)))
3347 ;; Run before visiting file hook here.
3348 (let ((f (selected-frame)))
3349 (dframe-select-attached-frame speedbar-frame
)
3350 (run-hooks 'speedbar-before-visiting-file-hook
)
3352 (speedbar-find-file-in-frame (concat cdd text
))
3353 (speedbar-stealthy-updates)
3354 (run-hooks 'speedbar-visiting-file-hook
)
3355 ;; Reset the timer with a new timeout when cliking a file
3356 ;; in case the user was navigating directories, we can cancel
3357 ;; that other timer.
3358 (speedbar-set-timer dframe-update-speed
))
3359 (dframe-maybee-jump-to-attached-frame))
3361 (defun speedbar-dir-follow (text token indent
)
3362 "Speedbar click handler for directory names.
3363 Clicking a directory will cause the speedbar to list files in
3364 the subdirectory TEXT. TOKEN is an unused requirement. The
3365 subdirectory chosen will be at INDENT level."
3366 (setq default-directory
3367 (concat (expand-file-name (concat (speedbar-line-directory indent
) text
))
3369 ;; Because we leave speedbar as the current buffer,
3370 ;; update contents will change directory without
3371 ;; having to touch the attached frame. Turn off smart expand just
3373 (let ((speedbar-smart-directory-expand-flag nil
))
3374 (speedbar-update-contents))
3375 (speedbar-set-timer speedbar-navigating-speed
)
3376 (setq speedbar-last-selected-file nil
)
3377 (speedbar-stealthy-updates))
3379 (defun speedbar-delete-subblock (indent)
3380 "Delete text from point to indentation level INDENT or greater.
3381 Handles end-of-sublist smartly."
3382 (speedbar-with-writable
3384 (end-of-line) (forward-char 1)
3385 (let ((start (point)))
3386 (while (and (looking-at "^\\([0-9]+\\):")
3387 (> (string-to-number (match-string 1)) indent
)
3390 (beginning-of-line))
3391 (delete-region start
(point))))))
3393 (defun speedbar-dired (text token indent
)
3394 "Speedbar click handler for directory expand button.
3395 Clicking this button expands or contracts a directory. TEXT is the
3396 button clicked which has either a + or -. TOKEN is the directory to be
3397 expanded. INDENT is the current indentation level."
3398 (cond ((string-match "+" text
) ;we have to expand this dir
3399 (setq speedbar-shown-directories
3400 (cons (expand-file-name
3401 (concat (speedbar-line-directory indent
) token
"/"))
3402 speedbar-shown-directories
))
3403 (speedbar-change-expand-button-char ?-
)
3404 (speedbar-reset-scanners)
3406 (end-of-line) (forward-char 1)
3407 (speedbar-with-writable
3408 (speedbar-default-directory-list
3409 (concat (speedbar-line-directory indent
) token
"/")
3411 ((string-match "-" text
) ;we have to contract this node
3412 (speedbar-reset-scanners)
3413 (let ((oldl speedbar-shown-directories
)
3415 (td (expand-file-name
3416 (concat (speedbar-line-directory indent
) token
))))
3418 (if (not (string-match (concat "^" (regexp-quote td
)) (car oldl
)))
3419 (setq newl
(cons (car oldl
) newl
)))
3420 (setq oldl
(cdr oldl
)))
3421 (setq speedbar-shown-directories
(nreverse newl
)))
3422 (speedbar-change-expand-button-char ?
+)
3423 (speedbar-delete-subblock indent
)
3425 (t (error "Ooops... not sure what to do")))
3426 (speedbar-center-buffer-smartly)
3427 (save-excursion (speedbar-stealthy-updates)))
3429 (defun speedbar-directory-buttons-follow (text token indent
)
3430 "Speedbar click handler for default directory buttons.
3431 TEXT is the button clicked on. TOKEN is the directory to follow.
3432 INDENT is the current indentation level and is unused."
3433 (if (string-match "^[A-z]:$" token
)
3434 (setq default-directory
(concat token
"/"))
3435 (setq default-directory token
))
3436 ;; Because we leave speedbar as the current buffer,
3437 ;; update contents will change directory without
3438 ;; having to touch the attached frame.
3439 (speedbar-update-contents)
3440 (speedbar-set-timer speedbar-navigating-speed
))
3442 (defun speedbar-tag-file (text token indent
)
3443 "The cursor is on a selected line. Expand the tags in the specified file.
3444 The parameter TEXT and TOKEN are required, where TEXT is the button
3445 clicked, and TOKEN is the file to expand. INDENT is the current
3447 (cond ((string-match "+" text
) ;we have to expand this file
3448 (let* ((fn (expand-file-name (concat (speedbar-line-directory indent
)
3451 (lst (speedbar-fetch-dynamic-tags fn
)))
3452 ;; if no list, then remove expando button
3454 (speedbar-change-expand-button-char ??
)
3455 (speedbar-change-expand-button-char ?-
)
3456 (speedbar-with-writable
3458 (end-of-line) (forward-char 1)
3459 (funcall (car lst
) indent
(cdr lst
)))))))
3460 ((string-match "-" text
) ;we have to contract this node
3461 (speedbar-change-expand-button-char ?
+)
3462 (speedbar-delete-subblock indent
))
3463 (t (error "Ooops... not sure what to do")))
3464 (speedbar-center-buffer-smartly))
3466 (defun speedbar-tag-find (text token indent
)
3467 "For the tag TEXT in a file TOKEN, go to that position.
3468 INDENT is the current indentation level."
3469 (let ((file (speedbar-line-directory indent
)))
3470 (let ((f (selected-frame)))
3471 (dframe-select-attached-frame speedbar-frame
)
3472 (run-hooks 'speedbar-before-visiting-tag-hook
)
3474 (speedbar-find-file-in-frame file
)
3475 (save-excursion (speedbar-stealthy-updates))
3476 ;; Reset the timer with a new timeout when cliking a file
3477 ;; in case the user was navigating directories, we can cancel
3478 ;; that other timer.
3479 (speedbar-set-timer dframe-update-speed
)
3481 (run-hooks 'speedbar-visiting-tag-hook
)
3482 (dframe-maybee-jump-to-attached-frame)
3485 (defun speedbar-tag-expand (text token indent
)
3486 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3487 Etags does not support this feature. TEXT will be the button
3488 string. TOKEN will be the list, and INDENT is the current indentation
3490 (cond ((string-match "+" text
) ;we have to expand this file
3491 (speedbar-change-expand-button-char ?-
)
3492 (speedbar-with-writable
3494 (end-of-line) (forward-char 1)
3495 (speedbar-insert-generic-list indent token
'speedbar-tag-expand
3496 'speedbar-tag-find
))))
3497 ((string-match "-" text
) ;we have to contract this node
3498 (speedbar-change-expand-button-char ?
+)
3499 (speedbar-delete-subblock indent
))
3500 (t (error "Ooops... not sure what to do")))
3501 (speedbar-center-buffer-smartly))
3503 ;;; Loading files into the attached frame.
3505 (defcustom speedbar-select-frame-method
'attached
3506 "*Specify how to select a frame for displaying a file.
3507 A value of 'attached means to use the attached frame (the frame
3508 that speedbar was started from.) A number such as 1 or -1 means to
3509 pass that number to `other-frame' while selecting a frame from speedbar."
3513 (defun speedbar-find-file-in-frame (file)
3514 "This will load FILE into the speedbar attached frame.
3515 If the file is being displayed in a different frame already, then raise that
3517 (let* ((buff (find-file-noselect file
))
3518 (bwin (get-buffer-window buff
0)))
3521 (select-window bwin
)
3522 (raise-frame (window-frame bwin
)))
3523 (if dframe-power-click
3524 (let ((pop-up-frames t
)) (select-window (display-buffer buff
)))
3525 (if (numberp speedbar-select-frame-method
)
3526 (other-frame speedbar-select-frame-method
)
3527 (dframe-select-attached-frame speedbar-frame
))
3528 (switch-to-buffer buff
))))
3531 ;;; Centering Utility
3533 (defun speedbar-center-buffer-smartly ()
3534 "Recenter a speedbar buffer so the current indentation level is all visible.
3535 This assumes that the cursor is on a file, or tag of a file which the user is
3538 (save-selected-window
3540 (select-window (get-buffer-window speedbar-buffer t
))
3542 (set-buffer speedbar-buffer
)
3544 (if (<= (count-lines (point-min) (point-max))
3545 (1- (window-height (selected-window))))
3546 ;; whole buffer fits
3549 (goto-char (point-min))
3553 (let (depth start end exp p
)
3556 (setq depth
(if (looking-at "[0-9]+")
3557 (string-to-number (buffer-substring-no-properties
3558 (match-beginning 0) (match-end 0)))
3560 (setq exp
(format "^%d:" depth
)))
3563 (if (re-search-backward exp nil t
)
3564 (setq start
(point))
3565 (setq start
(point-min)))
3566 (save-excursion ;Not sure about this part.
3569 (while (and (not (re-search-forward exp nil t
))
3571 (setq depth
(1- depth
))
3572 (setq exp
(format "^%d:" depth
)))
3575 (setq end
(point-max)))))
3576 ;; Now work out the details of centering
3577 (let ((nl (count-lines start end
))
3578 (wl (1- (window-height (selected-window))))
3581 ;; We can't fit it all, so just center on cursor
3582 (progn (goto-char start
)
3584 ;; we can fit everything on the screen, but...
3585 (if (and (pos-visible-in-window-p start
(selected-window))
3586 (pos-visible-in-window-p end
(selected-window)))
3589 ;; we need to do something...
3591 (let ((newcent (/ (- (window-height (selected-window)) nl
) 2))
3592 (lte (count-lines start
(point-max))))
3593 (if (and (< (+ newcent lte
) (window-height (selected-window)))
3594 (> (- (window-height (selected-window)) lte
1)
3596 (setq newcent
(- (window-height (selected-window))
3598 (recenter newcent
))))
3601 ;;; Tag Management -- List of expanders:
3603 (defun speedbar-fetch-dynamic-tags (file)
3604 "Return a list of tags generated dynamically from FILE.
3605 This uses the entries in `speedbar-dynamic-tags-function-list'
3606 to find the proper tags. It is up to each of those individual
3607 functions to do caching and flushing if appropriate."
3609 ;; If a file is in memory, switch to that buffer. This allows
3610 ;; us to use the local variable. If the file is on disk, we
3611 ;; can try a few of the defaults that can get tags without
3612 ;; opening the file.
3613 (if (get-file-buffer file
)
3614 (set-buffer (get-file-buffer file
)))
3615 ;; If there is a buffer-local value of
3616 ;; speedbar-dynamic-tags-function-list, it will now be available.
3617 (let ((dtf speedbar-dynamic-tags-function-list
)
3619 (while (and (eq ret t
) dtf
)
3621 (if (fboundp (car (car dtf
)))
3622 (funcall (car (car dtf
)) file
)
3625 (setq dtf
(cdr dtf
))))
3627 ;; No valid tag list, return nil
3629 ;; We have some tags. Return the list with the insert fn
3631 (cons (cdr (car dtf
)) ret
)))))
3633 ;;; Tag Management -- Imenu
3635 (if (not speedbar-use-imenu-flag
)
3639 (eval-when-compile (condition-case nil
(require 'imenu
) (error nil
)))
3641 (defun speedbar-fetch-dynamic-imenu (file)
3642 "Load FILE into a buffer, and generate tags using Imenu.
3643 Returns the tag list, or t for an error."
3644 ;; Load this AND compile it in
3646 (set-buffer (find-file-noselect file
))
3647 (if dframe-power-click
(setq imenu--index-alist nil
))
3649 (let ((index-alist (imenu--make-index-alist t
)))
3650 (if speedbar-sort-tags
3651 (sort (copy-alist index-alist
)
3652 (lambda (a b
) (string< (car a
) (car b
))))
3657 ;;; Tag Management -- etags (old XEmacs compatibility part)
3659 (defvar speedbar-fetch-etags-parse-list
3660 '(;; Note that java has the same parse-group as c
3661 ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\|cxx\\|hxx\\)\\'" .
3662 speedbar-parse-c-or-c
++tag
)
3663 ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
3664 "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
3665 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3666 ; speedbar-parse-fortran77-tag)
3667 ("\\.tex\\'" . speedbar-parse-tex-string
)
3669 "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?")
3671 "Associations of file extensions and expressions for extracting tags.
3672 To add a new file type, you would want to add a new association to the
3673 list, where the car is the file match, and the cdr is the way to
3674 extract an element from the tags output. If the output is complex,
3675 use a function symbol instead of regexp. The function should expect
3676 to be at the beginning of a line in the etags buffer.
3678 This variable is ignored if `speedbar-use-imenu-flag' is non-nil.")
3680 (defvar speedbar-fetch-etags-command
"etags"
3681 "*Command used to create an etags file.
3683 This variable is ignored if `speedbar-use-imenu-flag' is t.")
3685 (defvar speedbar-fetch-etags-arguments
'("-D" "-I" "-o" "-")
3686 "*List of arguments to use with `speedbar-fetch-etags-command'.
3687 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3688 modify this list conveniently.
3690 This variable is ignored if `speedbar-use-imenu-flag' is t.")
3692 (defun speedbar-toggle-etags (flag)
3693 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3694 FLAG then becomes a member of etags command line arguments. If flag
3695 is \"sort\", then toggle the value of `speedbar-sort-tags'. If its
3696 value is \"show\" then toggle the value of
3697 `speedbar-show-unknown-files'.
3699 This function is a convenience function for XEmacs menu created by
3700 Farzin Guilak <farzin@protocol.com>."
3703 ((equal flag
"sort")
3704 (setq speedbar-sort-tags
(not speedbar-sort-tags
)))
3705 ((equal flag
"show")
3706 (setq speedbar-show-unknown-files
(not speedbar-show-unknown-files
)))
3707 ((or (equal flag
"-C")
3710 (if (member flag speedbar-fetch-etags-arguments
)
3711 (setq speedbar-fetch-etags-arguments
3712 (delete flag speedbar-fetch-etags-arguments
))
3713 (add-to-list 'speedbar-fetch-etags-arguments flag
)))
3716 (defun speedbar-fetch-dynamic-etags (file)
3717 "For FILE, run etags and create a list of symbols extracted.
3718 Each symbol will be associated with its line position in FILE."
3719 (let ((newlist nil
))
3722 (if (get-buffer "*etags tmp*")
3723 (kill-buffer "*etags tmp*")) ;kill to clean it up
3724 (if (<= 1 speedbar-verbosity-level
)
3725 (speedbar-message "Fetching etags..."))
3726 (set-buffer (get-buffer-create "*etags tmp*"))
3727 (apply 'call-process speedbar-fetch-etags-command nil
3728 (current-buffer) nil
3729 (append speedbar-fetch-etags-arguments
(list file
)))
3730 (goto-char (point-min))
3731 (if (<= 1 speedbar-verbosity-level
)
3732 (speedbar-message "Fetching etags..."))
3734 (let ((exprlst speedbar-fetch-etags-parse-list
)
3736 (while (and (not ans
) exprlst
)
3737 (if (string-match (car (car exprlst
)) file
)
3738 (setq ans
(car exprlst
)))
3739 (setq exprlst
(cdr exprlst
)))
3743 (set-buffer (get-buffer-create "*etags tmp*"))
3744 (while (not (save-excursion (end-of-line) (eobp)))
3746 (setq tnl
(speedbar-extract-one-symbol expr
)))
3747 (if tnl
(setq newlist
(cons tnl newlist
)))
3750 "Sorry, no support for a file of that extension"))))
3752 (if speedbar-sort-tags
3753 (sort newlist
(lambda (a b
) (string< (car a
) (car b
))))
3754 (reverse newlist
))))
3756 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3757 ;; sure it's needed with the different sorting method.
3759 ;(defun speedbar-clean-etags()
3760 ; "Removes spaces before the ^? character, and removes `#define',
3761 ;return types, etc. preceding tags. This ensures that the sort operation
3762 ;works on the tags, not the return types."
3764 ; (goto-char (point-min))
3766 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3767 ; (replace-match "\C-?" nil nil))
3768 ; (goto-char (point-min))
3770 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3771 ; (delete-region (match-beginning 1) (match-end 1)))))
3773 (defun speedbar-extract-one-symbol (expr)
3774 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3775 The line should contain output from etags. Parse the output using the
3776 regular expression EXPR."
3777 (let* ((sym (if (stringp expr
)
3779 (re-search-forward expr
(save-excursion
3782 (buffer-substring-no-properties (match-beginning 1)
3785 (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)"
3791 (1+ (string-to-number (buffer-substring-no-properties
3799 (defun speedbar-parse-c-or-c++tag
()
3800 "Parse a C or C++ tag, which tends to be a little complex."
3802 (let ((bound (save-excursion (end-of-line) (point))))
3803 (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t
)
3804 (buffer-substring-no-properties (match-beginning 1)
3806 ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t
)
3807 (buffer-substring-no-properties (match-beginning 1)
3809 ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t
)
3810 (buffer-substring-no-properties (match-beginning 1)
3815 (defun speedbar-parse-tex-string ()
3816 "Parse a Tex string. Only find data which is relevant."
3818 (let ((bound (save-excursion (end-of-line) (point))))
3819 (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t
)
3820 (buffer-substring-no-properties (match-beginning 0)
3825 ;;; BUFFER DISPLAY mode.
3827 (defvar speedbar-buffers-key-map nil
3828 "Keymap used when in the buffers display mode.")
3830 (if speedbar-buffers-key-map
3832 (setq speedbar-buffers-key-map
(speedbar-make-specialized-keymap))
3834 ;; Basic tree features
3835 (define-key speedbar-buffers-key-map
"e" 'speedbar-edit-line
)
3836 (define-key speedbar-buffers-key-map
"\C-m" 'speedbar-edit-line
)
3837 (define-key speedbar-buffers-key-map
"+" 'speedbar-expand-line
)
3838 (define-key speedbar-buffers-key-map
"=" 'speedbar-expand-line
)
3839 (define-key speedbar-buffers-key-map
"-" 'speedbar-contract-line
)
3840 (define-key speedbar-buffers-key-map
" " 'speedbar-toggle-line-expansion
)
3842 ;; Buffer specific keybindings
3843 (define-key speedbar-buffers-key-map
"k" 'speedbar-buffer-kill-buffer
)
3844 (define-key speedbar-buffers-key-map
"r" 'speedbar-buffer-revert-buffer
)
3848 (defvar speedbar-buffer-easymenu-definition
3849 '(["Jump to buffer" speedbar-edit-line t
]
3850 ["Expand File Tags" speedbar-expand-line
3851 (save-excursion (beginning-of-line)
3852 (looking-at "[0-9]+: *.\\+. "))]
3853 ["Flush Cache & Expand" speedbar-flush-expand-line
3854 (save-excursion (beginning-of-line)
3855 (looking-at "[0-9]+: *.\\+. "))]
3856 ["Contract File Tags" speedbar-contract-line
3857 (save-excursion (beginning-of-line)
3858 (looking-at "[0-9]+: *.-. "))]
3860 ["Kill Buffer" speedbar-buffer-kill-buffer
3861 (save-excursion (beginning-of-line)
3862 (looking-at "[0-9]+: *.[-+?]. "))]
3863 ["Revert Buffer" speedbar-buffer-revert-buffer
3864 (save-excursion (beginning-of-line)
3865 (looking-at "[0-9]+: *.[-+?]. "))]
3867 "Menu item elements shown when displaying a buffer list.")
3869 (defun speedbar-buffer-buttons (directory zero
)
3870 "Create speedbar buttons based on the buffers currently loaded.
3871 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3872 (speedbar-buffer-buttons-engine nil
))
3874 (defun speedbar-buffer-buttons-temp (directory zero
)
3875 "Create speedbar buttons based on the buffers currently loaded.
3876 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3877 (speedbar-buffer-buttons-engine t
))
3879 (defun speedbar-buffer-buttons-engine (temp)
3880 "Create speedbar buffer buttons.
3881 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3882 (speedbar-insert-separator "Active Buffers:")
3883 (let ((bl (buffer-list))
3884 (case-fold-search t
))
3886 (if (string-match "^[ *]" (buffer-name (car bl
)))
3888 (let* ((known (string-match speedbar-file-regexp
3889 (buffer-name (car bl
))))
3890 (expchar (if known ?
+ ??
))
3891 (fn (if known
'speedbar-tag-file nil
))
3892 (fname (save-excursion (set-buffer (car bl
))
3893 (buffer-file-name))))
3894 (speedbar-make-tag-line 'bracket expchar fn
3895 (if fname
(file-name-nondirectory fname
))
3896 (buffer-name (car bl
))
3897 'speedbar-buffer-click temp
3898 'speedbar-file-face
0)
3899 (speedbar-buffers-tail-notes (car bl
))))
3901 (setq bl
(buffer-list))
3902 (speedbar-insert-separator "Scratch Buffers:")
3904 (if (not (string-match "^\\*" (buffer-name (car bl
))))
3906 (if (eq (car bl
) speedbar-buffer
)
3908 (speedbar-make-tag-line 'bracket ?? nil nil
3909 (buffer-name (car bl
))
3910 'speedbar-buffer-click temp
3911 'speedbar-file-face
0)
3912 (speedbar-buffers-tail-notes (car bl
))))
3914 (setq bl
(buffer-list))
3915 ;;(speedbar-insert-separator "Hidden Buffers:")
3917 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3919 ;; (if (eq (car bl) speedbar-buffer)
3921 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3922 ;; (buffer-name (car bl))
3923 ;; 'speedbar-buffer-click temp
3924 ;; 'speedbar-file-face 0)
3925 ;; (speedbar-buffers-tail-notes (car bl))))
3926 ;; (setq bl (cdr bl)))
3929 (defun speedbar-buffers-tail-notes (buffer)
3930 "Add a note to the end of the last tag line.
3931 Argument BUFFER is the buffer being tested."
3935 (setq mod
(buffer-modified-p)
3936 ro buffer-read-only
))
3937 (if ro
(speedbar-insert-button "%" nil nil nil nil t
))))
3939 (defun speedbar-buffers-item-info ()
3940 "Display information about the current buffer on the current line."
3941 (or (speedbar-item-info-tag-helper)
3942 (let* ((item (speedbar-line-text))
3943 (buffer (if item
(get-buffer item
) nil
)))
3945 (speedbar-message "%s%s %S %d %s"
3946 (if (buffer-modified-p buffer
) "* " "")
3948 (save-excursion (set-buffer buffer
) major-mode
)
3949 (save-excursion (set-buffer buffer
)
3951 (or (buffer-file-name buffer
) "<No file>"))))))
3953 (defun speedbar-buffers-line-directory (&optional depth
)
3954 "Fetch the full directory to the file (buffer) specified on the current line.
3955 Optional argument DEPTH specifies the current depth of the back search."
3958 (let ((start (point)))
3959 ;; Buffers are always at level 0
3960 (if (not (re-search-backward "^0:" nil t
))
3962 (let* ((bn (speedbar-line-text))
3963 (buffer (if bn
(get-buffer bn
))))
3968 (or (save-excursion (set-buffer buffer
)
3971 (buffer-file-name buffer
))))))))
3973 (defun speedbar-buffer-click (text token indent
)
3974 "When the users clicks on a buffer-button in speedbar.
3975 TEXT is the buffer's name, TOKEN and INDENT are unused."
3976 (if dframe-power-click
3977 (let ((pop-up-frames t
)) (select-window (display-buffer text
)))
3978 (dframe-select-attached-frame speedbar-frame
)
3979 (switch-to-buffer text
)
3980 (if token
(speedbar-change-initial-expansion-list
3981 speedbar-previously-used-expansion-list-name
))))
3983 (defun speedbar-buffer-kill-buffer ()
3984 "Kill the buffer the cursor is on in the speedbar buffer."
3987 (let ((text (speedbar-line-text)))
3988 (if (and (get-buffer text
)
3989 (speedbar-y-or-n-p (format "Kill buffer %s? " text
)))
3991 (speedbar-refresh)))))
3993 (defun speedbar-buffer-revert-buffer ()
3994 "Revert the buffer the cursor is on in the speedbar buffer."
3998 ;; If this fails, then it is a non-standard click, and as such,
3999 ;; perfectly allowed
4000 (if (re-search-forward "[]>?}] [^ ]"
4001 (save-excursion (end-of-line) (point))
4005 (buffer-substring (point) (save-excursion
4008 (if (get-buffer text
)
4011 (revert-buffer t
)))))))
4014 ;;; Useful hook values and such.
4016 (defvar speedbar-highlight-one-tag-line nil
4017 "Overlay used for highlighting the most recently jumped to tag line.")
4019 (defun speedbar-highlight-one-tag-line ()
4020 "Highlight the current line, unhighlighting a previously jumped to line."
4021 (speedbar-unhighlight-one-tag-line)
4022 (setq speedbar-highlight-one-tag-line
4023 (speedbar-make-overlay (save-excursion (beginning-of-line) (point))
4024 (save-excursion (end-of-line)
4027 (speedbar-overlay-put speedbar-highlight-one-tag-line
'face
4028 'speedbar-highlight-face
)
4029 (add-hook 'pre-command-hook
'speedbar-unhighlight-one-tag-line
)
4032 (defun speedbar-unhighlight-one-tag-line ()
4033 "Unhighlight the currently highlighted line."
4034 (if speedbar-highlight-one-tag-line
4036 (speedbar-delete-overlay speedbar-highlight-one-tag-line
)
4037 (setq speedbar-highlight-one-tag-line nil
)))
4038 (remove-hook 'pre-command-hook
'speedbar-unhighlight-one-tag-line
))
4040 (defun speedbar-recenter-to-top ()
4041 "Recenter the current buffer so POINT is on the top of the window."
4044 (defun speedbar-recenter ()
4045 "Recenter the current buffer so POINT is in the center of the window."
4046 (recenter (/ (window-height (selected-window)) 2)))
4049 ;;; Color loading section.
4051 (defface speedbar-button-face
'((((class color
) (background light
))
4052 (:foreground
"green4"))
4053 (((class color
) (background dark
))
4054 (:foreground
"green3")))
4055 "Face used for +/- buttons."
4056 :group
'speedbar-faces
)
4058 (defface speedbar-file-face
'((((class color
) (background light
))
4059 (:foreground
"cyan4"))
4060 (((class color
) (background dark
))
4061 (:foreground
"cyan"))
4063 "Face used for file names."
4064 :group
'speedbar-faces
)
4066 (defface speedbar-directory-face
'((((class color
) (background light
))
4067 (:foreground
"blue4"))
4068 (((class color
) (background dark
))
4069 (:foreground
"light blue")))
4070 "Face used for directory names."
4071 :group
'speedbar-faces
)
4072 (defface speedbar-tag-face
'((((class color
) (background light
))
4073 (:foreground
"brown"))
4074 (((class color
) (background dark
))
4075 (:foreground
"yellow")))
4076 "Face used for displaying tags."
4077 :group
'speedbar-faces
)
4079 (defface speedbar-selected-face
'((((class color
) (background light
))
4080 (:foreground
"red" :underline t
))
4081 (((class color
) (background dark
))
4082 (:foreground
"red" :underline t
))
4084 "Face used to underline the file in the active window."
4085 :group
'speedbar-faces
)
4087 (defface speedbar-highlight-face
'((((class color
) (background light
))
4088 (:background
"green"))
4089 (((class color
) (background dark
))
4090 (:background
"sea green"))
4091 (((class grayscale monochrome
)
4093 (:background
"black"))
4094 (((class grayscale monochrome
)
4096 (:background
"white")))
4097 "Face used for highlighting buttons with the mouse."
4098 :group
'speedbar-faces
)
4100 (defface speedbar-separator-face
'((((class color
) (background light
))
4104 (((class color
) (background dark
))
4108 (((class grayscale monochrome
)
4110 (:background
"black"
4113 (((class grayscale monochrome
)
4115 (:background
"white"
4117 :overline
"black")))
4118 "Face used for separator labes in a display."
4119 :group
'speedbar-faces
)
4121 ;; some edebug hooks
4122 (add-hook 'edebug-setup-hook
4124 (def-edebug-spec speedbar-with-writable def-body
)))
4126 ;; Fix a font lock problem for some versions of Emacs
4127 (if (boundp 'font-lock-global-modes
)
4128 (if (listp font-lock-global-modes
)
4129 (add-to-list 'font-lock-global-modes
'(not speedbar-mode
))
4134 ;;; Obsolete variables and functions
4136 (define-obsolete-variable-alias
4137 'speedbar-ignored-path-regexp
'speedbar-ignored-directory-regexp
)
4139 (define-obsolete-function-alias 'speedbar-add-ignored-path-regexp
4140 'speedbar-add-ignored-directory-regexp
)
4142 (define-obsolete-function-alias 'speedbar-line-path
4143 'speedbar-line-directory
)
4145 (define-obsolete-function-alias 'speedbar-buffers-line-path
4146 'speedbar-buffers-line-directory
)
4148 (define-obsolete-function-alias 'speedbar-path-line
4149 'speedbar-directory-line
)
4151 (define-obsolete-function-alias 'speedbar-buffers-line-path
4152 'speedbar-buffers-line-directory
)
4156 ;; run load-time hooks
4157 (run-hooks 'speedbar-load-hook
)
4159 ;; arch-tag: 4477e6d1-f78c-48b9-a503-387d3c9767d5
4160 ;;; speedbar ends here