| blob | 48829d4023fcd4f72c69d54cc772368acec6fbc3 |
1 ;;; speedbar --- quick access to files and tags in a frame
3 ;; Copyright (C) 1996-2018 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
6 ;; Keywords: file, tags, tools
11 "This version of speedbar is incompatible with this version.
12 Due to massive API changes (removing the use of the word PATH)
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software: you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation, either version 3 of the License, or
20 ;; (at your option) any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
30 ;;; Commentary:
31 ;;
32 ;; The speedbar provides a frame in which files, and locations in
33 ;; files are displayed. These items can be clicked on with mouse-2 in
34 ;; to display that file location.
35 ;;
36 ;;; Customizing and Developing for speedbar
37 ;;
38 ;; Please see the speedbar manual for information.
39 ;;
40 ;;; Notes:
41 ;;
42 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
43 ;; well. Use the imenu keywords from tex-mode.el for better results.
44 ;;
45 ;;; Developing for speedbar
46 ;;
47 ;; Adding a speedbar specialized display mode:
48 ;;
49 ;; Speedbar can be configured to create a special display for certain
50 ;; modes that do not display traditional file/tag data. Rmail, Info,
51 ;; and the debugger are examples. These modes can, however, benefit
52 ;; from a speedbar style display in their own way.
53 ;;
54 ;; If your `major-mode' is `foo-mode', the only requirement is to
55 ;; create a function called `foo-speedbar-buttons' which takes one
56 ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled.
57 ;; In `foo-speedbar-buttons' there are several functions that make
58 ;; building a speedbar display easy. See the documentation for
59 ;; `speedbar-with-writable' (needed because the buffer is usually
60 ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and
61 ;; `speedbar-insert-generic-list'. If you use
62 ;; `speedbar-insert-generic-list', also read the doc for
63 ;; `speedbar-tag-hierarchy-method' in case you wish to override it.
64 ;; The macro `dframe-with-attached-buffer' brings you back to the
65 ;; buffer speedbar is displaying for.
66 ;;
67 ;; For those functions that make buttons, the "function" should be a
68 ;; symbol that is the function to call when clicked on. The "token"
69 ;; is extra data you can pass along. The "function" must take three
70 ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the
71 ;; button clicked on. TOKEN is the data passed in when you create the
72 ;; button. INDENT is an indentation level, or 0. You can store
73 ;; indentation levels with `speedbar-make-tag-line' which creates a
74 ;; line with an expander (eg. [+]) and a text button.
75 ;;
76 ;; Some useful functions when writing expand functions, and click
77 ;; functions are `speedbar-change-expand-button-char',
78 ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
79 ;; The variable `speedbar-power-click' is set to t in your functions
80 ;; when the user shift-clicks. This is an indication of anything from
81 ;; refreshing cached data to making a buffer appear in a new frame.
82 ;;
83 ;; If you wish to add to the default speedbar menu for the case of
84 ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This
85 ;; should be a list compatible with the `easymenu' package. It will
86 ;; be spliced into the main menu. (Available with click-mouse-3). If
87 ;; you wish to have extra key bindings in your special mode, create a
88 ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap',
89 ;; or `make-sparse-keymap', use the function
90 ;; `speedbar-make-specialized-keymap'. This lets you inherit all of
91 ;; speedbar's default bindings with low overhead.
92 ;;
93 ;; Adding a speedbar top-level display mode:
94 ;;
95 ;; Unlike the specialized modes, there are no name requirements,
96 ;; however the methods for writing a button display, menu, and keymap
97 ;; are the same. Once you create these items, you can call the
98 ;; function `speedbar-add-expansion-list'. It takes one parameter
99 ;; which is a list element of the form (NAME MENU KEYMAP &rest
100 ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the
101 ;; Displays menu item. MENU is a symbol containing the menu items to
102 ;; splice in. KEYMAP is a symbol holding the keymap to use, and
103 ;; BUTTON-FUNCTIONS are the function names to call, in order, to create
104 ;; the display.
105 ;; Another tweakable variable is `speedbar-stealthy-function-list'
106 ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
107 ;; name matching `speedbar-add-expansion-list'. (It does not need to
108 ;; exist.). This provides additional display info which might be
109 ;; time-consuming to calculate.
110 ;; Lastly, `speedbar-mode-functions-list' allows you to set special
111 ;; function overrides.
113 ;;; TODO:
114 ;; - Timeout directories we haven't visited in a while.
120 ;; customization stuff
122 "File and tag browser frame."
128 ; :version "20.3"
129 )
132 "Faces used in speedbar."
139 "Version control display in speedbar."
144 ;;; Code:
146 ;; Note: `inversion-test' requires parts of the CEDET package that are
147 ;; not included with Emacs.
148 ;;
149 ;; (defun speedbar-require-version (major minor &optional beta)
150 ;; "Non-nil if this version of SPEEDBAR does not satisfy a specific version.
151 ;; Arguments can be:
152 ;;
153 ;; (MAJOR MINOR &optional BETA)
154 ;;
155 ;; Values MAJOR and MINOR must be integers. BETA can be an integer, or
156 ;; excluded if a released version is required.
157 ;;
158 ;; It is assumed that if the current version is newer than that specified,
159 ;; everything passes. Exceptions occur when known incompatibilities are
160 ;; introduced."
161 ;; (inversion-test 'speedbar
162 ;; (concat major "." minor
163 ;; (when beta (concat "beta" beta)))))
167 speedbar-buffer-buttons)
169 speedbar-buffer-buttons-temp)
170 ;; Files last, means first in the Displays menu
172 speedbar-directory-buttons speedbar-default-directory-list)
173 )
174 "List of named expansion elements for filling the speedbar frame.
175 These expansion lists are only valid for regular files. Special modes
176 still get to override this list on a mode-by-mode basis. This list of
177 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
178 representing the types of things to be displayed. MENU is an easymenu
179 structure used when in this mode. KEYMAP is a local keymap to install
180 over the regular speedbar keymap. FN1 ... are functions that will be
181 called in order. These functions will always get the default
182 directory to use passed in as the first parameter, and a 0 as the
183 second parameter. The 0 indicates the uppermost indentation level.
184 They must assume that the cursor is at the position where they start
188 "A symbol name representing the expansion list to use.
189 The expansion list `speedbar-initial-expansion-mode-alist' contains
193 "Save the last expansion list method.
194 This is used for returning to a previous expansion list method when
199 speedbar-update-current-file
200 speedbar-check-read-only
201 speedbar-check-vc
202 speedbar-check-objects)
203 )
204 "List of functions to periodically call stealthily.
205 This list is of the form:
207 ...)
208 where NAME is the name of the major display mode these functions are
209 for, and the remaining elements FUNCTION are functions to call in order.
210 Each function must return nil if interrupted, or t if completed.
211 Stealthy functions which have a single operation should always return t.
212 Functions which take a long time should maintain a state (where they
213 are in their speedbar related calculations) and permit interruption.
223 )
224 "List of function tables to use for different major display modes.
225 It is not necessary to define any functions for a specialized mode.
226 This just provides a simple way of adding lots of customizations.
227 Each sublist is of the form:
229 Where NAME is the name of the specialized mode. The rest of the list
230 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
231 of a function you would like to replace, and REPLACEMENTFUNCTION,
232 which is a function you can call instead. Not all functions can be
233 replaced this way. Replaceable functions must provide that
237 "Non-nil means speedbar will show special mode contents.
238 This permits some modes to create customized contents for the speedbar
239 frame."
244 "Query control for file operations.
245 The `all' flag means to always query before file operations.
246 The `none-but-delete' flag means to not query before any file
247 operations, except before a file deletion."
250 all)
252 none-but-delete)
253 ;;;; (const :tag "Never Every Query."
254 ;;;; none)
255 ))
258 "Default function list for creating specialized button lists.
259 This list is set by modes that wish to have special speedbar displays.
260 The list is of function names. Each function is called with one
261 parameter BUFFER, the originating buffer. The current buffer is the
265 "Default keymap used when identifying a specialized display mode.
266 This keymap is local to each buffer that wants to define special keybindings
270 "Hooks run before speedbar visits a file in the selected frame.
271 The default buffer is the buffer in the selected window in the attached frame."
276 "Hooks run when speedbar visits a file in the selected frame."
281 "Hooks run before speedbar visits a tag in the selected frame.
282 The default buffer is the buffer in the selected window in the attached frame."
287 "Hooks run when speedbar visits a tag in the selected frame."
291 speedbar-recenter-to-top
292 speedbar-recenter
293 ))
296 "Hooks run when speedbar is loaded."
301 "Hooks run when the keymaps are regenerated."
306 "Non-nil show files we can't expand with a ? in the expand button.
307 A nil value means don't show the file in the list."
311 ;;; EVENTUALLY REMOVE THESE
313 ;; When I moved to a repeating timer, I had the horrible misfortune
314 ;; of losing the ability for adaptive speed choice. This update
315 ;; speed currently causes long delays when it should have been turned off.
318 'dframe-update-speed
323 'dframe-update-speed
325 ;;; END REMOVE THESE
334 )
335 "Parameters to use when creating the speedbar frame in Emacs.
336 Any parameter supported by a frame may be added. The parameter `height'
337 will be initialized to the height of the frame speedbar is
338 attached to and added to this list before the new frame is initialized."
344 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
347 internal-border-width 0 unsplittable t
348 default-toolbar-visible-p nil has-modeline-p nil
349 menubar-visible-p nil
350 default-gutter-visible-p nil
351 )
352 "Parameters to use when creating the speedbar frame in XEmacs.
353 Parameters not listed here which will be added automatically are
354 `height' which will be initialized to the height of the frame speedbar
355 is attached to."
362 "Non-nil means use imenu for file parsing, nil to use etags.
363 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
364 use etags instead. Etags support is not as robust as imenu support."
372 "Set to a list of functions which will return and insert a list of tags.
373 Each element is of the form ( FETCH . INSERT ) where FETCH
374 is a function which takes one parameter (the file to tag) and returns a
375 list of tags. The tag list can be of any form as long as the
376 corresponding insert method can handle it. If it returns t, then an
377 error occurred, and the next fetch routine is tried.
378 INSERT is a function which takes an INDENTation level, and a LIST of
382 "Non-nil means to use tool tips if they are available.
383 When tooltips are not available, mouse-tracking and minibuffer
384 display is used instead."
389 "Non-nil means to display info about the line under the mouse."
394 "Default position of the speedbar frame.
395 Possible values are `left', `right' or `left-right'.
396 If value is `left-right', the most suitable location is
397 determined automatically."
404 "If non-nil, sort tags in the speedbar display. *Obsolete*.
405 Use `semantic-tag-hierarchy-method' instead."
411 speedbar-trim-words-tag-hierarchy)
412 "List of hooks which speedbar will use to organize tags into groups.
413 Groups are defined as expandable meta-tags. Imenu supports
414 such things in some languages, such as separating variables from
415 functions. Each hook takes one argument LST, and may destructively
416 create a new list of the same form. LST is a list of elements of the
417 form:
418 (ELT1 ELT2 ... ELTn)
419 where each ELT is of the form
420 (TAG-NAME-STRING . NUMBER-OR-MARKER)
421 or
422 (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
426 speedbar-trim-words-tag-hierarchy
427 speedbar-simple-group-tag-hierarchy
428 speedbar-sort-tag-hierarchy)
429 )
432 "The minimum length of a prefix group name before expanding.
433 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
434 and one such groups common characters is less than this number of
435 characters, then the group name will be changed to the form of:
436 worda to wordb
437 instead of just
438 word
439 This way we won't get silly looking listings."
444 "Minimum length before we stop trying to create sub-lists in tags.
445 This is used by all tag-hierarchy methods that break large lists into
446 sub-lists."
451 "Maximum length of submenus that are regrouped.
452 If the regrouping option is used, then if two or more short subgroups
453 are next to each other, then they are combined until this number of
454 items is reached."
459 "Indicates how the directory button will be displayed.
460 Possible values are:
461 `span' - span large directories over multiple lines.
462 `trim' - trim large directories to only show the last few.
463 nil - no trimming."
466 span)
468 trim)
472 "Non-nil means speedbar should use smart expansion.
473 Smart expansion only affects when speedbar wants to display a
474 directory for a file in the attached frame. When smart expansion is
475 enabled, new directories which are children of a displayed directory
476 are expanded in the current framework. If nil, then the current
477 hierarchy would be replaced with the new directory."
482 "When sub-nodes are expanded, the number of spaces used for indentation."
487 "Non-nil means speedbar will hide the brackets around the + or -."
492 "Hooks called before popping up the speedbar frame."
497 "Hooks called after popping up the speedbar frame."
502 "Hooks called before deleting the speedbar frame."
507 "Hook run after creating a speedbar buffer."
512 "Hooks called after running the speedbar timer function."
517 "Verbosity level of the speedbar.
518 0 means say nothing.
519 1 means medium level verbosity.
520 2 and higher are higher levels of verbosity."
528 "Non-nil check all files in speedbar to see if they have been checked out.
529 Any file checked out is marked with `speedbar-vc-indicator'."
534 "Text used to mark files which are currently checked out.
535 Other version control systems can be added by examining the function
539 "Return non-nil if the current directory should be checked for Version Control.
540 Functions in this hook must accept one parameter which is the directory
541 being checked."
546 "Return non-nil if the specified file is under Version Control.
547 Functions in this hook must accept two parameters. The DIRECTORY of the
548 current file, and the FILENAME of the file being checked."
556 "Non-nil check all files in speedbar to see if they have an object file.
557 Any file checked out is marked with `speedbar-obj-indicator', and the
558 marking is based on `speedbar-obj-alist'"
566 "Text used to mark files that have a corresponding hidden object file.
567 The car is for an up-to-date object. The cdr is for an out of date object.
585 ;; Note: Look for addition place to add indicator lists that
586 ;; use skip-chars instead of a regular expression.
598 "Regular expression used when identifying files.
602 "Hook called whenever generic scanners are reset.
603 Set this to implement your own scanning / rescan safe functions with
604 state data."
609 "List of major modes which speedbar will not switch directories for."
615 "Takes EXTLIST, a list of extensions and transforms it into regexp.
616 All the preceding `.' are stripped for an optimized expression starting
617 with `.' followed by extensions, followed by full-filenames."
625 ;; Concatenate all the subexpressions together, making sure all types
626 ;; of parts exist during concatenation.
634 "Regular expression matching directories speedbar will not switch to.
635 Created from `speedbar-ignored-directory-expressions' with the function
636 `speedbar-extension-list-to-regex' (a misnamed function in this case.)
637 Use the function `speedbar-add-ignored-directory-regexp', or customize the
642 "List of regular expressions matching directories speedbar will ignore.
643 They should included directories which are notoriously very large
644 and take a long time to load in. Use the function
645 `speedbar-add-ignored-directory-regexp' to add new items to this list after
646 speedbar is loaded. You may place anything you like in this list
647 before speedbar has been loaded."
652 speedbar-ignored-directory-regexp
656 "Regular expression matching directories not to show in speedbar.
657 They should include commonly existing directories which are not
658 useful. It is no longer necessary to include version-control
659 directories here; see `vc-directory-exclusion-list'."
669 ;; backup refdir lockfile
671 "Regexp matching files we don't want displayed in a speedbar buffer.
672 It is generated from the variable `completion-ignored-extensions'."
677 "Regular expression matching files we know how to expand.
678 Created from `speedbar-supported-extension-expressions' with the
681 ;; this is dangerous to customize, because the defaults will probably
682 ;; change in the future.
688 ;; html is not supported by default, but an imenu tags package
689 ;; is available. Also, html files are nice to be able to see.
690 ".s?html"
692 "List of regular expressions which will match files supported by tagging.
694 will be stripped by a simplified optimizer when compiled into a
695 singular expression. This variable will be turned into
696 `speedbar-file-regexp' for use with speedbar. You should use the
697 function `speedbar-add-supported-extension' to add a new extension at
698 runtime, or use the configuration dialog to set it in your init file.
699 If you add an extension to this list, and it does not appear, you may
700 need to also modify `completion-ignored-extension' which will also help
701 file completion."
712 "Add EXTENSION as a new supported extension for speedbar tagging.
713 This should start with a `.' if it is not a complete file name, and
715 matchers are allowed however. EXTENSION may be a single string or a
716 list of strings."
721 nil
726 speedbar-supported-extension-expressions)))
729 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
730 This function will modify `speedbar-ignored-directory-regexp' and add
731 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
737 nil
742 speedbar-ignored-directory-expressions)))
745 "Non-nil means to automatically update the display.
746 When this is nil then speedbar will not follow the attached frame's directory.
747 If you want to change this while speedbar is active, either use
763 ;; Turn off paren matching around here.
772 st)
781 ;; Control.
785 ;; Navigation.
792 ;; These commands never seemed useful.
793 ;; (define-key map " " 'speedbar-scroll-up)
794 ;; (define-key map [delete] 'speedbar-scroll-down)
796 ;; Short cuts I happen to find useful.
800 speedbar-previously-used-expansion-list-name)))
809 map)
813 "Create a keymap for use with a speedbar major or minor display mode.
814 This basically creates a sparse keymap, and makes its parent be
815 `speedbar-mode-map'."
818 k))
823 ;; Basic tree features.
835 ;; File based commands.
845 map)
859 window-system))
863 )
882 ; ["Sort Tags" speedbar-toggle-sorting
883 ; :style toggle :selected speedbar-sort-tags]
884 "----"
905 )
918 "Non-nil when speedbar is showing buttons specific to a special mode.
936 "An association list of directories and their contents.
937 Each sublist was returned by `speedbar-file-lists'. This list is
938 maintained to speed up the refresh rate when switching between
944 \f
945 ;;; Compatibility
946 ;;
958 \f
959 ;;; Mode definitions/ user commands
960 ;;
962 ;;;###autoload
964 ;;;###autoload
966 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
967 A nil ARG means toggle. Once the speedbar frame is activated, a buffer in
968 `speedbar-mode' will be displayed. Currently, only one speedbar is
969 supported at a time.
970 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
971 `speedbar-before-delete-hook' is called before the frame is deleted."
973 ;; Get the buffer to play with
979 ;; Do the frame thing
981 'speedbar-frame
982 'speedbar-cached-frame
983 'speedbar-buffer
984 "Speedbar"
985 #'speedbar-frame-mode
988 ;; This is a hack to get speedbar to iconify
989 ;; with the selected frame.
991 speedbar-frame-parameters)
992 'speedbar-before-delete-hook
993 'speedbar-before-popup-hook
995 ;; Start up the timer
1001 )
1002 ;; Frame modifications
1005 ;; hscroll
1007 ;; reset the selection variable
1011 "Reposition the speedbar frame to be next to the attached frame."
1016 speedbar-frame
1020 )
1024 ;; if left/top were specified in the parameters, pass them
1025 ;; down to the reposition function
1027 speedbar-frame
1031 )
1035 speedbar-default-position))))
1038 "Return the frame to use for speedbar based on current context."
1042 "Handle a delete frame event E.
1043 If the deleted frame is the frame speedbar is attached to,
1044 we need to delete speedbar also."
1047 dframe-attached-frame))
1050 ;;;###autoload
1052 "Change frame focus to or from the speedbar frame.
1053 If the selected frame is not speedbar, then speedbar frame is
1054 selected. If the speedbar frame is active, then select the attached frame."
1062 "Return the width of the speedbar frame in characters.
1063 Return nil if it doesn't exist."
1067 "Major mode for managing a display of directories and tags.
1069 The first line represents the default directory of the speedbar frame.
1070 Each directory segment is a button which jumps speedbar's default
1073 rescan cached items, or pop up new frames.
1075 Each line starting with <+> represents a directory. Click on the <+>
1076 to insert the directory listing into the current tree. Click on the
1077 <-> to retract that list. Click on the directory name to go to that
1078 directory as the default.
1080 Each line starting with [+] is a file. If the variable
1081 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1082 files which don't have imenu support, but are not expressly ignored.
1083 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1084 which is generated from `completion-ignored-extensions'.
1086 Files with a `*' character after their name are files checked out of a
1087 version control system. (Currently only RCS is supported.) New
1088 version control systems can be added by examining the documentation
1089 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1091 Files with a `#' or `!' character after them are source files that
1092 have an object file associated with them. The `!' indicates that the
1093 files is out of date. You can control what source/object associations
1094 exist through the variable `speedbar-obj-alist'.
1096 Click on the [+] to display a list of tags from that file. Click on
1097 the [-] to retract the list. Click on the file name to edit the file
1098 in the attached frame.
1100 If you open tags, you might find a node starting with {+}, which is a
1101 category of tags. Click the {+} to expand the category. Jump-able
1102 tags start with >. Click the name of the tag to go to that position
1103 in the selected file.
1111 case-fold-search nil
1112 buffer-read-only t)
1114 ;; Add in our dframe hooks.
1118 dframe-mouse-click-function #'speedbar-click
1120 speedbar-buffer)
1125 "Like `y-or-n-p', but for use in the speedbar frame.
1126 Argument PROMPT is the prompt to use.
1127 Optional argument DELETING means this is a query that will delete something.
1128 The variable `speedbar-query-confirmation-method' can cause this to
1129 return true without a query."
1135 "Select the frame attached to this speedbar."
1138 ;; Backwards compatibility
1145 "Set the format of the mode line based on the current speedbar environment.
1146 This gives visual indications of what is up. It EXPECTS the speedbar
1147 frame and window to be the currently active frame and window."
1152 speedbar-buffer)
1181 "Reconfigure the menu-bar in a speedbar frame.
1182 Different menu items are displayed depending on the current display mode
1183 and the existence of packages."
1185 speedbar-easymenu-definition-base
1187 ;; file display mode version
1192 speedbar-initial-expansion-mode-alist)))))
1193 ;; Dynamic menu stuff
1204 'speedbar-change-initial-expansion-list
1207 :selected
1209 speedbar-initial-expansion-list-name)
1210 )
1211 displays))
1213 displays)))
1214 ;; The trailer
1215 speedbar-easymenu-definition-trailer))
1221 'speedbar-special-mode-key-map
1223 speedbar-special-mode-key-map)
1228 ;; This creates a small keymap we can glom the
1229 ;; menu adjustments into.
1231 ;; Delete the old menu if applicable.
1234 ;; Now add the new menu
1239 ;; XEmacs-specific:
1245 \f
1246 ;;; User Input stuff
1247 ;;
1249 "Customize speedbar using the Custom package."
1258 "For motion EVENT, display info about the current line."
1260 nil
1267 ;; XEmacs may let us get in here in other mode buffers.
1272 "Call the info function for the line under the mouse."
1281 "Move to the next ARGth line in a speedbar buffer."
1288 "Move to the previous ARGth line in a speedbar buffer."
1293 "Move to the next ARGth line in a speedbar buffer at the same depth.
1294 This means that movement is restricted to a subnode, and that siblings
1295 of intermediate nodes are skipped."
1297 ;; First find the extent for which we are allowed to move.
1313 ;; We have reached the end of this block.
1323 "Move to the next ARGth line in a speedbar buffer at the same depth.
1324 This means that movement is restricted to a subnode, and that siblings
1325 of intermediate nodes are skipped."
1331 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1332 This means that movement is restricted to a subnode, and that siblings
1333 of intermediate nodes are skipped."
1339 "Move across ARG groups of similarly typed items in speedbar.
1340 Stop on the first line of the next type of item, or on the last or first item
1341 if we reach a buffer boundary."
1352 "Move forward over the current list.
1353 A LIST in speedbar is a group of similarly typed items, such as directories,
1354 files, or the directory button."
1360 "Move backward over the current list.
1361 A LIST in speedbar is a group of similarly typed items, such as directories,
1362 files, or the directory button."
1368 "Page down one screen-full of the speedbar, or ARG lines."
1374 "Page up one screen-full of the speedbar, or ARG lines."
1380 "Keyboard accelerator for moving the default directory up one.
1381 Assumes that the current buffer is the speedbar buffer."
1385 \f
1386 ;;; Speedbar file activity (aka creeping featurism)
1387 ;;
1389 "Refresh the current speedbar display, disposing of any cached data.
1390 Argument ARG represents to force a refresh past any caches that may exist."
1394 deactivate-mark)
1395 ;; We need to hack something so this works in detached frames.
1399 speedbar-directory-contents-alist)))
1404 ;; Reset the timer in case it got really hosed for some reason...
1410 "Load the item under the cursor or mouse if it is a Lisp file."
1416 ;; If the compiled version exists, load that instead...
1422 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1432 ))
1435 "Provide information about what the user clicked on.
1436 This should be bound to a mouse EVENT."
1442 "Attempt to derive, and then display information about this line item.
1443 File style information is displayed with `speedbar-item-info'."
1446 ;; Skip invisible number info.
1448 ;; Skip items in "folder" type text characters.
1450 ;; Get the text
1455 "Display info in the minibuffer about the button the mouse is over.
1456 This function can be replaced in `speedbar-mode-functions-list' as
1457 `speedbar-item-info'."
1464 "Display info about a file that is on the current line.
1465 Return nil if not applicable. If FILENAME, then use that
1466 instead of reading it from the speedbar buffer."
1471 nil)))
1474 "Display info about a tag that is on the current line.
1475 Return nil if not applicable."
1492 )))
1509 nil t))
1512 nil))))
1522 parent))
1524 ;; Not using `semantic':
1528 nil)))))
1531 "Display info in the minibuffer about the button the mouse is over."
1539 "Copy the item under the cursor.
1540 Files can be copied to new names or places."
1550 speedbar-shown-directories)))
1551 ;; Create the right file name part
1559 t))
1562 ;; refresh display if the new place is currently displayed.
1568 ))))))
1571 "Rename the item under the cursor or mouse.
1572 Files can be renamed to new names or moved to new directories."
1580 speedbar-shown-directories)))
1581 ;; Create the right file name part
1589 t))
1592 ;; refresh display if the new place is currently displayed.
1597 )))))
1601 "Create a directory in speedbar."
1607 basedir)))
1608 ;; Make the directory
1612 )
1616 "Delete the item under the cursor. Files are removed from disk."
1629 ))
1630 ))
1633 "Delete the object associated from the item under the cursor.
1634 The file is removed from disk. The object is determined from the
1635 variable `speedbar-obj-alist'."
1651 "Enable automatic updating in speedbar via timers."
1658 "Disable automatic updating and stop consuming resources."
1665 "Toggle automatic update for the speedbar frame."
1672 "Toggle use of images in the speedbar frame."
1678 "Toggle tag sorting."
1683 "Toggle display of files speedbar can not tag."
1689 "Allow the buffer to be writable and evaluate FORMS."
1696 "Insert TEXT as the next logical speedbar button.
1697 FACE is the face to put on the button, MOUSE is the highlight face to use.
1698 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1699 This function assumes that the current buffer is the speedbar buffer.
1700 If PREVLINE, then put this button on the previous line.
1702 This is a convenience function for special modes that create their own
1703 specialized speedbar displays."
1720 "Insert a separation label of TEXT.
1721 Separators are not active, have no labels, depth, or actions."
1729 'speedbar-separator-face
1730 nil nil nil)))
1733 "Create a button from START to END, with FACE as the display face.
1734 MOUSE is the mouse face. When this button is clicked on FUNCTION
1735 will be run with the TOKEN parameter (any Lisp object). If FACE
1736 is t use the text properties of the string that is passed as an
1737 argument."
1747 ;; So far the only text we have is less that 3 chars.
1750 )
1751 \f
1752 ;;; Initial Expansion list management
1753 ;;
1755 "Return the current default expansion list.
1756 This is based on `speedbar-initial-expansion-list-name' referencing
1757 `speedbar-initial-expansion-mode-alist'."
1758 ;; cdr1 - name, cdr2 - menu
1760 speedbar-initial-expansion-mode-alist)))))
1763 "Return the current default menu data.
1764 This is based on `speedbar-initial-expansion-list-name' referencing
1765 `speedbar-initial-expansion-mode-alist'."
1768 speedbar-initial-expansion-mode-alist)))))
1771 "Return the current default menu data.
1772 This is based on `speedbar-initial-expansion-list-name' referencing
1773 `speedbar-initial-expansion-mode-alist'."
1776 speedbar-initial-expansion-mode-alist))))))
1779 "Return a list of functions to call stealthily.
1780 This is based on `speedbar-initial-expansion-list-name' referencing
1781 `speedbar-stealthy-function-list'."
1783 speedbar-stealthy-function-list)))
1786 "Add NEW-LIST to the list of expansion lists."
1790 "Change speedbar's default expansion list to NEW-DEFAULT."
1794 speedbar-previously-used-expansion-list-name)
1795 speedbar-initial-expansion-mode-alist
1796 nil t "" nil
1797 speedbar-previously-used-expansion-list-name)))
1799 speedbar-initial-expansion-list-name
1800 speedbar-initial-expansion-list-name new-default)
1807 "Return a current mode-specific replacement for function, or nil.
1808 Scans `speedbar-mode-functions-list' first for the current mode, then
1809 for FUNCTION."
1812 speedbar-mode-functions-list)))))
1815 "Add NEW-LIST to the list of mode functions.
1816 See `speedbar-mode-functions-list' for details."
1819 \f
1820 ;;; Special speedbar display management
1821 ;;
1823 "Quick check function called on BUFFERs by the speedbar timer function.
1824 Maintains the value of local variables which control speedbar's use
1825 of the special mode functions."
1830 "Add localized speedbar support to BUFFER's mode if it is available."
1834 nil
1839 nil ;; do nothing to broken mode
1845 ;; If it is autoloaded, we need to load it now so that
1846 ;; we have access to the variable -speedbar-menu-items.
1847 ;; Is this XEmacs safe?
1852 nil ;; don't add special keymap
1858 nil ;; don't add special menus
1862 )))))))
1865 "Remove any traces that BUFFER supports speedbar in a specialized way."
1870 \f
1871 ;;; File button management
1872 ;;
1874 "Create file lists for DIRECTORY.
1875 The car is the list of directories, the cdr is list of files not
1876 matching ignored headers. Cache any directory files found in
1877 `speedbar-directory-contents-alist' and use that cache before scanning
1878 the file-system."
1880 ;; find the directory, either in the cache, or build it.
1900 speedbar-directory-contents-alist))
1901 nl))
1902 ))
1905 "Insert a single button group at point for DIRECTORY.
1906 Each directory part is a different button. If part of the directory
1907 matches the user directory ~, then it is replaced with a ~.
1908 INDEX is not used, but is required by the caller."
1914 dd))
1922 'speedbar-directory-face
1923 'speedbar-highlight-face
1924 'speedbar-directory-buttons-follow
1930 ;; Nuke the beginning of the directory if it's too long...
1958 )))))))
1959 )
1966 'speedbar-directory-face
1967 'speedbar-highlight-face
1968 'speedbar-directory-buttons-follow
1974 exp-button-char exp-button-function
1975 exp-button-data
1976 tag-button tag-button-function tag-button-data
1977 tag-button-face depth)
1978 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
1979 This is the button that expands or contracts a node (if applicable),
1980 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
1981 is the function to call if it's clicked on. Button types are
1982 `bracket', `angle', `curly', `expandtag', `statictag', t, or nil.
1983 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
1984 button.
1986 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
1987 function to call if clicked on, and TAG-BUTTON-DATA is the data to
1988 attach to the text field (such a tag positioning, etc).
1989 TAG-BUTTON-FACE is a face used for this type of tag.
1991 Lastly, DEPTH shows the depth of expansion.
1993 This function assumes that the cursor is in the speedbar window at the
1994 position to insert a new item, and that the new item will end with a CR."
2015 )
2021 )
2030 tag-button-function tag-button-data))
2031 ))
2034 "Change the expansion button character to CHAR for the current line."
2043 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2044 ;; make sure we fix the image on the text here.
2047 \f
2048 ;;; Build button lists
2049 ;;
2051 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2052 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2053 don't know how to manage them. The input parameter FILES is a cons
2054 cell of the form (DIRLIST . FILELIST)."
2055 ;; Start inserting all the directories
2075 "Insert files for DIRECTORY with level INDEX at point."
2080 ;; If the shown files variable has extra directories, then
2081 ;; it is our responsibility to redraw them all
2082 ;; Luckily, the nature of inserting items into this list means
2083 ;; that by reversing it, we can easily go in the right order
2087 ;; Expand them all as we find them.
2097 )))
2098 ;;; Generic List support
2099 ;;
2100 ;; Generic lists are hierarchies of tags which we may need to permute
2101 ;; in order to make it look nice.
2102 ;;
2103 ;; A generic list is of the form:
2104 ;; ( ("name" . marker-or-number) <-- one tag at this level
2105 ;; ("name" marker-or-number goto-fun . args) <-- one tag at this level
2106 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2107 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2109 "Non-nil if SUBLST is a group.
2110 Groups may optionally contain a position."
2115 )))
2120 )))
2123 "Non-nil if SUBLST is a group with a position."
2131 ))))
2134 "Non-nil if SUBLST is a tag."
2140 ;; For semantic/bovine items, this is needed
2142 ))
2145 "Sort all elements of tag hierarchy LST."
2150 "A wrapper for `try-completion'.
2151 Passes STRING and ALIST to `try-completion' if ALIST
2152 passes some tests."
2156 nil))
2159 "Prefix group names for tag hierarchy LST."
2171 ;; Do nothing. Too short to bother with.
2172 lst
2173 ;; Break out sub-lists
2179 ;; Reverse newlst because it was made backwards.
2180 ;; Sublist doesn't need reversing because the act
2181 ;; of binning things will reverse it for us.
2183 sublst sublst)
2184 ;; Now, first find out how long our list is. Never let a
2185 ;; list get-shorter than our minimum.
2189 ;; Sort the whole list into bins.
2194 ;; 0 storage bin for shorty.
2197 ;; stuff into a bin based on ascii value at diff
2201 ;; Go through all our bins Stick singles into our
2202 ;; junk-list, everything else as sublsts in work-list.
2203 ;; If two neighboring lists are both small, make a grouped
2204 ;; group combining those two sub-lists.
2207 ;; The bins contents are currently in forward order.
2213 speedbar-tag-split-minimum-length))
2215 ;; We have reached a longer list, so we
2216 ;; must finish off a grouped group.
2220 num-shorts-grouped))
2221 ;; All singles? Junk list
2223 junk-list)))
2225 ;; Only one short group? Just stick it in
2226 ;; there by itself. Make a group, and find
2227 ;; a subexpression
2231 speedbar-tag-group-name-minimum-length)
2234 " ("
2241 short-group-list)
2242 work-list ))))
2244 ;; Multiple groups to be named in a special
2245 ;; way by displaying the range over which we
2246 ;; have grouped them.
2249 " to "
2250 short-end-name)
2251 short-group-list)
2252 work-list))))
2253 ;; Reset short group list information every time.
2255 short-start-name nil
2256 short-end-name nil
2258 ;; Ok, now that we cleaned up the short-group-list,
2259 ;; we can deal with this new list, to decide if it
2260 ;; should go on one of these sub-lists or not.
2266 short-start-name
2270 ;; Did we run out of things? Drop our new list onto the end.
2273 ;; All singles? Junk list
2276 ;; Only one short group? Just stick it in
2277 ;; there by itself.
2280 short-group-list)
2281 work-list)))
2283 ;; Multiple groups to be named in a special
2284 ;; way by displaying the range over which we
2285 ;; have grouped them.
2288 short-group-list)
2289 work-list))))
2290 ;; Reverse the work list nreversed when consing.
2292 ;; Now, stick our new list onto the end of
2300 "Trim all words in a tag hierarchy.
2301 Base trimming information on word separators, and group names.
2302 Argument LST is the list of tags to trim."
2313 ;; Get the prefix to trim by. Make sure that we don't trim
2314 ;; off silly pieces, only complete understandable words.
2328 trimlst)
2330 ;; Put the lists together
2334 "Create a simple `Tags' group with orphaned tags.
2335 Argument LST is the list of tags to sort into groups."
2349 "Adjust the tag hierarchy in LST, and return it.
2350 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2351 the list."
2358 speedbar-tag-hierarchy-method)
2359 speedbar-tag-hierarchy-method))
2362 lst)))
2366 lst))
2369 "The type of button created for groups of tags.
2370 Good values for this are `curly' and `expandtag'.
2374 "The type of button created for tags in generic lists.
2375 Good values for this are nil and `statictag'.
2379 "At LEVEL, insert a generic multi-level alist LST.
2380 Associations with lists get {+} tags (to expand into more nodes) and
2381 those with positions just get a > as the indicator. {+} buttons will
2382 have the function EXPAND-FUN and the token is the cdr list. The token
2383 name will have the function FIND-FUN and not token."
2384 ;; Remove imenu rescan button
2387 ;; Get, and set up variables that define how we treat these tags.
2391 expand-button tag-button)
2396 tag-button speedbar-generic-list-tag-button-type))
2397 ;; Adjust the list.
2399 ;; insert the parts
2404 nil nil nil ;no expand button data
2406 find-fun ;function
2408 'speedbar-tag-face
2414 find-fun ;function
2416 'speedbar-tag-face
2422 nil nil 'speedbar-tag-face
2425 ))
2429 "At level INDENT, insert the imenu generated LST."
2431 'speedbar-tag-expand
2435 "At level INDENT, insert the etags generated LST."
2437 'speedbar-tag-expand
2439 \f
2440 ;;; Timed functions
2441 ;;
2443 "Generically update the contents of the speedbar buffer."
2445 ;; Set the current special buffer
2448 ;; Check for special modes
2451 ;; Choose the correct method of doodling.
2455 'speedbar-special-mode-expansion-list
2457 ;;(eq (get major-mode 'mode-class 'special)))
2462 "Update the contents of the speedbar buffer for the current situation."
2463 ;; Due to the historical growth of speedbar, we need to do something
2464 ;; special for "files" mode. Too bad.
2467 )
2469 ;; Do all the files type work. It still goes through the
2470 ;; expansion list stuff. :(
2472 speedbar-shown-directories)
2475 speedbar-ignored-directory-regexp
2477 nil
2480 default-directory))
2485 default-directory)
2487 ;; Else, we can do a short cut. No text cache.
2503 "Update the contents of the speedbar buffer based on the current directory."
2505 cbd-parent
2508 ;; disable stealth during update
2512 ;; Because there is a bug I can't find just yet
2515 ;; If we are updating contents to where we are, then this is
2516 ;; really a request to update existing contents, so we must be
2517 ;; careful with our text cache!
2521 ;; If the current directory is not the last element in the dir
2522 ;; list, then we ALSO need to zap the list of expanded directories
2526 ;; Build cbd-parent, and see if THAT is in the current shown
2527 ;; directories. First, go through pains to get the parent directory
2538 ;; If this directory is NOT in the current list of available
2539 ;; directories, then use the cache, and set the cache to our new
2540 ;; value. Make sure to unhighlight the current file, or if we
2541 ;; come back to this directory, it might be a different file
2542 ;; and then we get a mess!
2549 ;; Check if our new directory is in the list of directories
2550 ;; shown in the text-cache
2553 use-cache t)
2554 ;; default the shown directories to this list...
2556 ))
2560 ;; Find this directory as a speedbar node.
2562 ;; Open it.
2571 speedbar-shown-directories))
2582 "Use the mode-specific variable to fill in the speedbar buffer.
2583 This should only be used by modes classified as special."
2588 ;; If we are leaving a directory, cache it.
2590 ;; Do nothing
2591 nil
2592 ;; Clean up directory maintenance stuff
2596 speedbar-shown-directories nil))
2597 ;; Now fill in the buffer with our newly found specialized list.
2600 ;; We do not erase the buffer because these functions may
2601 ;; decide NOT to update themselves.
2606 "Set up the speedbar timer with TIMEOUT.
2607 Uses `dframe-set-timer'.
2608 Also resets scanner functions."
2610 ;; Apply a revert hook that will reset the scanners. We attach to revert
2611 ;; because most reverts occur during VC state change, and this lets our
2612 ;; VC scanner fix itself.
2616 ;; change this if it changed for some reason
2620 "Run whenever Emacs is idle to update the speedbar item."
2624 ;; Save all the match data so that we don't mess up executing fns
2626 ;; Only do stuff if the frame is visible, not an icon, and if
2627 ;; it is currently flagged to do something.
2634 ;; make sure we at least choose a window to
2635 ;; get a good directory from
2637 nil
2638 ;; Check for special modes
2640 ;; Update for special mode all the time!
2644 'speedbar-special-mode-expansion-list
2646 ;;(eq (get major-mode 'mode-class 'special)))
2650 "Updating speedbar to special mode: %s..."
2651 major-mode))
2656 "Updating speedbar to special mode: %s...done"
2657 major-mode)
2660 ;; Update all the contents if directories change!
2664 ;; Always update for GUD.
2666 speedbar-initial-expansion-list-name)))
2669 ;; Now run stealthy updates of time-consuming items
2673 \f
2674 ;;; Stealthy activities
2675 ;;
2680 "For a given speedbar, run all items in the stealthy function list.
2681 Each item returns t if it completes successfully, or nil if
2682 interrupted by the user."
2689 ;;(sit-for 0)
2691 ;;(dframe-message "Exit with %S" (car l))
2692 ))))
2695 "Reset any variables used by functions in the stealthy list as state.
2696 If new functions are added, their state needs to be updated here."
2698 speedbar-obj-to-do-point t
2699 speedbar-ro-to-do-point t)
2701 )
2704 "Go to the line where FILE is."
2713 nil t))
2730 "Locate the file thought to be current, and remove its highlighting."
2732 ;;(set-buffer speedbar-buffer)
2738 'face
2742 "Find the current file, and update our visuals to indicate its name.
2743 This is specific to file names. If the file name doesn't show up, but
2744 it should be in the list, then the directory cache needs to be updated."
2750 nil)))
2752 rf)))
2758 ;; check here, that way we won't refresh to newcf until
2759 ;; its been written, thus saving ourselves some time
2763 ;; It is important to select the frame, otherwise the window
2764 ;; we want the cursor to move in will not be updated by the
2765 ;; search-forward command.
2767 ;; Remove the old file...
2769 ;; now highlight the new one.
2770 ;; (set-buffer speedbar-buffer)
2773 ;; put the property on it
2776 'face
2778 ;; Oops, it's not in the list. Should it be?
2782 ;; yes, it is (we will ignore unknowns for now...)
2786 ;; put the property on it
2789 'face
2791 ;; if it's not in there now, whatever...
2792 ))
2797 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2798 ;;doesn't need to be in. We don't want to recenter when we are
2799 ;;updating files.
2801 ;;(speedbar-center-buffer-smartly)
2804 ))
2807 )))
2808 ;; return that we are done with this activity.
2809 t)
2812 "Add INDICATOR-STRING to the end of this speedbar line.
2813 If INDICATOR-STRING is space, and REPLACE-THIS is a character,
2814 then the existing indicator is removed. If there is already an
2815 indicator, then do not add a space."
2817 ;; The nature of the beast: Assume we are in "the right place"
2820 speedbar-object-read-only-indicator
2836 ))))
2839 "Scan all the files in a directory, and for each see if it is read only."
2840 ;; Check for to-do to be reset. If reset but no RCS is available
2841 ;; then set to nil (do nothing) otherwise, start at the beginning
2851 nil t))
2857 speedbar-object-read-only-indicator
2861 speedbar-object-read-only-indicator))))))
2863 ;; return that we are incomplete
2864 nil
2865 ;; we are done, set to-do to nil
2867 ;; and return t
2868 t))
2869 t)))
2872 "Scan all files in a directory, and for each see if it's checked out.
2873 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2874 to add more types of version control systems."
2875 ;; Check for to-do to be reset. If reset but no RCS is available
2876 ;; then set to nil (do nothing) otherwise, start at the beginning
2885 'ange-ftp-directory-format
2888 ;; efs support: Bob Weiner
2893 reg
2902 nil t))
2910 ;; return that we are incomplete
2911 nil
2912 ;; we are done, set to-do to nil
2914 ;; and return t
2915 t))
2916 t)))
2919 "Return t if the file on this line is checked out of a version control system.
2920 Parameter DEPTH is a string with the current depth of indentation of
2921 the file being checked."
2925 ;; Skip-chars: thanks ptype@dra.hmg.gb
2936 "Return t if we should bother checking DIRECTORY for version control files.
2937 This can be overloaded to add new types of version control systems."
2941 ;; User extension
2943 directory)
2944 ))
2947 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2948 Automatically recognizes all VCs supported by VC mode. You can
2949 optimize this function by overriding it and only doing those checks
2950 that will occur on your system."
2953 ;; User extension
2955 ))
2957 ;; Object File scanning
2959 "Scan all files in a directory, and for each see if there is an object.
2960 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2961 to add more object types."
2962 ;; Check for to-do to be reset. If reset but no RCS is available
2963 ;; then set to nil (do nothing) otherwise, start at the beginning
2973 nil t))
2982 ;; return that we are incomplete
2983 nil
2984 ;; we are done, set to-do to nil
2986 ;; and return t
2987 t))
2988 t)))
2991 "Return t if the file on this line has an associated object.
2992 Parameter DEPTH is a string with the current depth of indentation of
2993 the file being checked."
2997 ;; Skip-chars: thanks ptype@dra.hmg.gb
3009 nil
3010 ;; Find out if the object is out of date or not.
3020 \f
3021 ;;; Clicking Activity
3022 ;;
3024 "Position the cursor on a line."
3032 "Activate any speedbar buttons where the mouse is clicked.
3033 This must be bound to a mouse event. A button is any location of text
3034 with a mouse face that has a text property called `speedbar-function'.
3035 Argument E is the click event."
3036 ;; Backward compatibility let statement.
3042 "Look under the cursor and examine the text properties.
3043 From this extract the file/tag name, token, indentation level and call
3044 a function if appropriate."
3048 ;; The 1-,+ is safe because scanning starts AFTER the point
3049 ;; specified. This lets the search include the character the
3050 ;; cursor is on.
3063 ;;(dframe-message "%S:%S:%S:%s" fn tok txt dent)
3066 \f
3067 ;;; Reading info from the speedbar buffer
3068 ;;
3070 "Retrieve the text after prefix junk for the current line.
3071 Optional argument P is where to start the search from."
3078 nil)))
3081 "Retrieve the token information after the prefix junk for the current line.
3082 Optional argument P is where to start the search from."
3092 nil)))
3095 "Retrieve the file or whatever from the line at point P.
3096 The return value is a string representing the file. If it is a
3097 directory, then it is the directory name."
3107 nil))
3108 nil)))))
3111 "If FILE is displayed, go to this line and return t.
3112 Otherwise do not move and return nil."
3118 ;; scan all the directories
3124 nil t))
3128 ;; find the file part
3130 ;; only had a dir part
3134 t)
3136 ;; find the file part
3141 nil t)
3144 t)
3146 nil))))))
3149 "Retrieve the directory name associated with the current line.
3150 This may require traversing backwards from DEPTH and combining the default
3151 directory with these items. This function is replaceable in
3152 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3159 "Retrieve the directory associated with the current line.
3160 This may require traversing backwards from DEPTH and combining the default
3161 directory with these items."
3176 "/"
3177 directory)))
3179 ;; This is the start of our directory.
3184 directory))
3189 "Position the cursor on the line specified by DIRECTORY."
3203 nil t))
3213 "Edit whatever tag or file is on the current speedbar line."
3217 ;; If this fails, then it is a non-standard click, and as such,
3218 ;; perfectly allowed.
3221 t)
3225 nil))
3229 "Expand the line under the cursor.
3230 With universal argument ARG, flush cached data."
3244 "Expand the line under the cursor and flush any cached information."
3249 "Contract the line under the cursor."
3261 "Contract or expand the line under the cursor."
3273 "Expand the line under the cursor and all descendants.
3274 Optional argument ARG indicates that any cache should be flushed."
3277 ;; Now, inside the area expanded here, expand all subnodes of
3278 ;; the same descendant type.
3288 )
3291 "Expand the line under the cursor and all descendants."
3294 ;; Don't need to do anything else since all descendants are
3295 ;; hidden by default anyway. Yay! It's easy.
3296 )
3299 "Speedbar click handler for filenames.
3300 TEXT, the file will be displayed in the attached frame.
3301 TOKEN is unused, but required by the click handler. INDENT is the
3302 current indentation level."
3304 ;; Run before visiting file hook here.
3312 ;; Reset the timer with a new timeout when clicking a file
3313 ;; in case the user was navigating directories, we can cancel
3314 ;; that other timer.
3319 "Speedbar click handler for directory names.
3320 Clicking a directory will cause the speedbar to list files in
3321 the subdirectory TEXT. TOKEN is an unused requirement. The
3322 subdirectory chosen will be at INDENT level."
3326 ;; Because we leave speedbar as the current buffer,
3327 ;; update contents will change directory without
3328 ;; having to touch the attached frame. Turn off smart expand just
3329 ;; in case.
3337 "Delete text from point to indentation level INDENT or greater.
3338 Handles end-of-sublist smartly."
3351 "Speedbar click handler for directory expand button.
3352 Clicking this button expands or contracts a directory. TEXT is the
3353 button clicked which has either a + or -. TOKEN is the directory to be
3354 expanded. INDENT is the current indentation level."
3359 speedbar-shown-directories))
3381 )
3387 "Speedbar click handler for default directory buttons.
3388 TEXT is the button clicked on. TOKEN is the directory to follow.
3389 INDENT is the current indentation level and is unused."
3393 ;; Because we leave speedbar as the current buffer,
3394 ;; update contents will change directory without
3395 ;; having to touch the attached frame.
3400 "The cursor is on a selected line. Expand the tags in the specified file.
3401 The parameter TEXT and TOKEN are required, where TEXT is the button
3402 clicked, and TOKEN is the file to expand. INDENT is the current
3403 indentation level."
3406 token)))
3408 ;; if no list, then remove expando button
3423 "For the tag TEXT in a file TOKEN, go to that position.
3424 INDENT is the current indentation level."
3432 ;; Reset the timer with a new timeout when clicking a file
3433 ;; in case the user was navigating directories, we can cancel
3434 ;; that other timer.
3439 ))
3442 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3443 Etags does not support this feature. TEXT will be the button string.
3444 TOKEN will be the list, and INDENT is the current indentation level."
3457 \f
3458 ;;; Loading files into the attached frame.
3459 ;;
3461 "Specify how to select a frame for displaying a file.
3462 A number such as 1 or -1 means to pass that number to `other-frame'
3463 while selecting a frame from speedbar. Any other value means to use
3464 the attached frame (the frame that speedbar was started from)."
3469 "This will load FILE into the speedbar attached frame.
3470 If the file is being displayed in a different frame already, then raise that
3471 frame instead."
3484 )
3486 ;;; Centering Utility
3487 ;;
3489 "Recenter a speedbar buffer so the current indentation level is all visible.
3490 This assumes that the cursor is on a file, or tag of a file which the user is
3491 interested in."
3501 ;; whole buffer fits
3507 ;; too big
3531 ;; Now work out the details of centering
3536 ;; We can't fit it all, so just center on cursor
3539 ;; we can fit everything on the screen, but...
3542 ;; we are all set!
3543 nil
3544 ;; we need to do something...
3550 newcent))
3555 \f
3556 ;;; Tag Management -- List of expanders:
3557 ;;
3559 "Return a list of tags generated dynamically from FILE.
3560 This uses the entries in `speedbar-dynamic-tags-function-list'
3561 to find the proper tags. It is up to each of those individual
3562 functions to do caching and flushing if appropriate."
3564 ;; If a file is in memory, switch to that buffer. This allows
3565 ;; us to use the local variable. If the file is on disk, we
3566 ;; can try a few of the defaults that can get tags without
3567 ;; opening the file.
3570 ;; If there is a buffer-local value of
3571 ;; speedbar-dynamic-tags-function-list, it will now be available.
3578 t))
3582 ;; No valid tag list, return nil
3583 nil
3584 ;; We have some tags. Return the list with the insert fn
3585 ;; prepended
3588 ;;; Tag Management -- Imenu
3589 ;;
3592 nil
3598 "Load FILE into a buffer, and generate tags using Imenu.
3599 Returns the tag list, or t for an error."
3600 ;; Load this AND compile it in
3609 index-alist))
3611 )
3612 \f
3613 ;;; Tag Management -- etags (old XEmacs compatibility part)
3614 ;;
3621 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3622 ; speedbar-parse-fortran77-tag)
3626 )
3627 "Associations of file extensions and expressions for extracting tags.
3628 To add a new file type, you would want to add a new association to the
3629 list, where the car is the file match, and the cdr is the way to
3630 extract an element from the tags output. If the output is complex,
3631 use a function symbol instead of regexp. The function should expect
3632 to be at the beginning of a line in the etags buffer.
3637 "Command used to create an etags file.
3638 This variable is ignored if `speedbar-use-imenu-flag' is t."
3643 "List of arguments to use with `speedbar-fetch-etags-command'.
3644 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3645 modify this list conveniently.
3646 This variable is ignored if `speedbar-use-imenu-flag' is t."
3652 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3653 FLAG then becomes a member of etags command line arguments. If flag
3656 `speedbar-show-unknown-files'.
3658 This function is a convenience function for XEmacs menu created by
3659 Farzin Guilak <farzin@protocol.com>."
3676 "For FILE, run etags and create a list of symbols extracted.
3677 Each symbol will be associated with its line position in FILE."
3710 )
3715 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3716 ;; sure it's needed with the different sorting method.
3717 ;;
3718 ;(defun speedbar-clean-etags()
3719 ; "Removes spaces before the ^? character, and removes `#define',
3720 ;return types, etc. preceding tags. This ensures that the sort operation
3721 ;works on the tags, not the return types."
3722 ; (save-excursion
3723 ; (goto-char (point-min))
3724 ; (while
3725 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3726 ; (replace-match "\C-?" nil nil))
3727 ; (goto-char (point-min))
3728 ; (while
3729 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3730 ; (delete-region (match-beginning 1) (match-end 1)))))
3733 "At point, return nil, or one alist in the form (SYMBOL . POSITION).
3734 The line should contain output from etags. Parse the output using the
3735 regular expression EXPR."
3751 nil)))
3754 "Parse a C or C++ tag, which tends to be a little complex."
3767 )))
3770 "Parse a Tex string. Only find data which is relevant."
3778 \f
3779 ;;; BUFFER DISPLAY mode.
3780 ;;
3785 nil
3788 ;; Basic tree features
3796 ;; Buffer specific keybindings
3800 )
3813 "----"
3820 )
3824 "Create speedbar buttons based on the buffers currently loaded.
3825 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3829 "Create speedbar buttons based on the buffers currently loaded.
3830 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3834 "Create speedbar buffer buttons.
3835 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3841 nil
3851 'speedbar-buffer-click temp
3859 nil
3861 nil
3864 'speedbar-buffer-click temp
3869 ;;(speedbar-insert-separator "Hidden Buffers:")
3870 ;;(while bl
3871 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3872 ;; nil
3873 ;; (if (eq (car bl) speedbar-buffer)
3874 ;; nil
3875 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3876 ;; (buffer-name (car bl))
3877 ;; 'speedbar-buffer-click temp
3878 ;; 'speedbar-file-face 0)
3879 ;; (speedbar-buffers-tail-notes (car bl))))
3880 ;; (setq bl (cdr bl)))
3881 ))
3884 "Add a note to the end of the last tag line.
3885 Argument BUFFER is the buffer being tested."
3890 "Display information about the current buffer on the current line."
3897 item
3903 "Fetch the directory of the file (buffer) specified on the current line.
3904 Optional argument DEPTH specifies the current depth of the back search."
3908 ;; Buffers are always at level 0
3910 nil
3920 "When the users clicks on a buffer-button in speedbar.
3921 TEXT is the buffer's name, TOKEN and INDENT are unused."
3927 speedbar-previously-used-expansion-list-name))))
3930 "Kill the buffer the cursor is on in the speedbar buffer."
3940 "Revert the buffer the cursor is on in the speedbar buffer."
3944 ;; If this fails, then it is a non-standard click, and as such,
3945 ;; perfectly allowed
3955 \f
3956 ;;; Useful hook values and such.
3957 ;;
3962 "Highlight the current line, unhighlighting a previously jumped to line."
3972 "Unhighlight the currently highlighted line."
3980 "Recenter the current buffer so point is on the top of the window."
3984 "Recenter the current buffer so point is in the center of the window."
3987 \f
3988 ;;; Color loading section.
3989 ;;
3994 "Speedbar face for +/- buttons."
4002 "Speedbar face for file names."
4009 "Speedbar face for directory names."
4016 "Speedbar face for tags."
4024 "Speedbar face for the file in the active window."
4031 "Speedbar face for highlighting buttons with the mouse."
4052 "Speedbar face for separator labels in a display."
4055 ;; some edebug hooks
4060 ;; Fix a font lock problem for some versions of Emacs
4062 font-lock-global-modes
4068 font-lock-global-modes)))))
4069 \f
4072 ;; run load-time hooks
4075 ;;; speedbar ends here