| blob | 31134711830efba3b34793b6c7463cf579506dcb |
1 ;;; speedbar --- quick access to files and tags in a frame
3 ;; Copyright (C) 1996-2017 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 <http://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
645 "List of regular expressions matching directories speedbar will ignore.
646 They should included directories which are notoriously very large
647 and take a long time to load in. Use the function
648 `speedbar-add-ignored-directory-regexp' to add new items to this list after
649 speedbar is loaded. You may place anything you like in this list
650 before speedbar has been loaded."
655 speedbar-ignored-directory-regexp
659 "Regular expression matching directories not to show in speedbar.
660 They should include commonly existing directories which are not
661 useful. It is no longer necessary to include version-control
662 directories here; see `vc-directory-exclusion-list'."
672 ;; backup refdir lockfile
674 "Regexp matching files we don't want displayed in a speedbar buffer.
675 It is generated from the variable `completion-ignored-extensions'."
680 "Regular expression matching files we know how to expand.
681 Created from `speedbar-supported-extension-expressions' with the
684 ;; this is dangerous to customize, because the defaults will probably
685 ;; change in the future.
691 ;; html is not supported by default, but an imenu tags package
692 ;; is available. Also, html files are nice to be able to see.
693 ".s?html"
695 "List of regular expressions which will match files supported by tagging.
697 will be stripped by a simplified optimizer when compiled into a
698 singular expression. This variable will be turned into
699 `speedbar-file-regexp' for use with speedbar. You should use the
700 function `speedbar-add-supported-extension' to add a new extension at
701 runtime, or use the configuration dialog to set it in your init file.
702 If you add an extension to this list, and it does not appear, you may
703 need to also modify `completion-ignored-extension' which will also help
704 file completion."
715 "Add EXTENSION as a new supported extension for speedbar tagging.
716 This should start with a `.' if it is not a complete file name, and
718 matchers are allowed however. EXTENSION may be a single string or a
719 list of strings."
724 nil
729 speedbar-supported-extension-expressions)))
732 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
733 This function will modify `speedbar-ignored-directory-regexp' and add
734 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
740 nil
745 speedbar-ignored-directory-expressions)))
747 ;; If we don't have custom, then we set it here by hand.
750 speedbar-supported-extension-expressions)
752 speedbar-ignored-directory-expressions)))
755 "Non-nil means to automatically update the display.
756 When this is nil then speedbar will not follow the attached frame's directory.
757 If you want to change this while speedbar is active, either use
773 ;; Turn off paren matching around here.
782 st)
791 ;; Control.
795 ;; Navigation.
802 ;; These commands never seemed useful.
803 ;; (define-key map " " 'speedbar-scroll-up)
804 ;; (define-key map [delete] 'speedbar-scroll-down)
806 ;; Short cuts I happen to find useful.
810 speedbar-previously-used-expansion-list-name)))
819 map)
823 "Create a keymap for use with a speedbar major or minor display mode.
824 This basically creates a sparse keymap, and makes its parent be
825 `speedbar-mode-map'."
828 k))
833 ;; Basic tree features.
845 ;; File based commands.
855 map)
869 window-system))
873 )
892 ; ["Sort Tags" speedbar-toggle-sorting
893 ; :style toggle :selected speedbar-sort-tags]
894 "----"
915 )
928 "Non-nil when speedbar is showing buttons specific to a special mode.
946 "An association list of directories and their contents.
947 Each sublist was returned by `speedbar-file-lists'. This list is
948 maintained to speed up the refresh rate when switching between
954 \f
955 ;;; Compatibility
956 ;;
968 \f
969 ;;; Mode definitions/ user commands
970 ;;
972 ;;;###autoload
974 ;;;###autoload
976 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
977 A nil ARG means toggle. Once the speedbar frame is activated, a buffer in
978 `speedbar-mode' will be displayed. Currently, only one speedbar is
979 supported at a time.
980 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
981 `speedbar-before-delete-hook' is called before the frame is deleted."
983 ;; Get the buffer to play with
989 ;; Do the frame thing
991 'speedbar-frame
992 'speedbar-cached-frame
993 'speedbar-buffer
994 "Speedbar"
995 #'speedbar-frame-mode
998 ;; This is a hack to get speedbar to iconify
999 ;; with the selected frame.
1001 speedbar-frame-parameters)
1002 'speedbar-before-delete-hook
1003 'speedbar-before-popup-hook
1005 ;; Start up the timer
1011 )
1012 ;; Frame modifications
1015 ;; hscroll
1017 ;; reset the selection variable
1021 "Reposition the speedbar frame to be next to the attached frame."
1026 speedbar-frame
1030 )
1034 ;; if left/top were specified in the parameters, pass them
1035 ;; down to the reposition function
1037 speedbar-frame
1041 )
1045 speedbar-default-position))))
1048 "Return the frame to use for speedbar based on current context."
1052 "Handle a delete frame event E.
1053 If the deleted frame is the frame speedbar is attached to,
1054 we need to delete speedbar also."
1057 dframe-attached-frame))
1060 ;;;###autoload
1062 "Change frame focus to or from the speedbar frame.
1063 If the selected frame is not speedbar, then speedbar frame is
1064 selected. If the speedbar frame is active, then select the attached frame."
1072 "Return the width of the speedbar frame in characters.
1073 Return nil if it doesn't exist."
1077 "Major mode for managing a display of directories and tags.
1079 The first line represents the default directory of the speedbar frame.
1080 Each directory segment is a button which jumps speedbar's default
1083 rescan cached items, or pop up new frames.
1085 Each line starting with <+> represents a directory. Click on the <+>
1086 to insert the directory listing into the current tree. Click on the
1087 <-> to retract that list. Click on the directory name to go to that
1088 directory as the default.
1090 Each line starting with [+] is a file. If the variable
1091 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1092 files which don't have imenu support, but are not expressly ignored.
1093 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1094 which is generated from `completion-ignored-extensions'.
1096 Files with a `*' character after their name are files checked out of a
1097 version control system. (Currently only RCS is supported.) New
1098 version control systems can be added by examining the documentation
1099 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1101 Files with a `#' or `!' character after them are source files that
1102 have an object file associated with them. The `!' indicates that the
1103 files is out of date. You can control what source/object associations
1104 exist through the variable `speedbar-obj-alist'.
1106 Click on the [+] to display a list of tags from that file. Click on
1107 the [-] to retract the list. Click on the file name to edit the file
1108 in the attached frame.
1110 If you open tags, you might find a node starting with {+}, which is a
1111 category of tags. Click the {+} to expand the category. Jump-able
1112 tags start with >. Click the name of the tag to go to that position
1113 in the selected file.
1121 case-fold-search nil
1122 buffer-read-only t)
1124 ;; Add in our dframe hooks.
1128 dframe-mouse-click-function #'speedbar-click
1130 speedbar-buffer)
1135 "Like `y-or-n-p', but for use in the speedbar frame.
1136 Argument PROMPT is the prompt to use.
1137 Optional argument DELETING means this is a query that will delete something.
1138 The variable `speedbar-query-confirmation-method' can cause this to
1139 return true without a query."
1145 "Select the frame attached to this speedbar."
1148 ;; Backwards compatibility
1155 "Set the format of the mode line based on the current speedbar environment.
1156 This gives visual indications of what is up. It EXPECTS the speedbar
1157 frame and window to be the currently active frame and window."
1162 speedbar-buffer)
1191 "Reconfigure the menu-bar in a speedbar frame.
1192 Different menu items are displayed depending on the current display mode
1193 and the existence of packages."
1195 speedbar-easymenu-definition-base
1197 ;; file display mode version
1202 speedbar-initial-expansion-mode-alist)))))
1203 ;; Dynamic menu stuff
1214 'speedbar-change-initial-expansion-list
1217 :selected
1219 speedbar-initial-expansion-list-name)
1220 )
1221 displays))
1223 displays)))
1224 ;; The trailer
1225 speedbar-easymenu-definition-trailer))
1231 'speedbar-special-mode-key-map
1233 speedbar-special-mode-key-map)
1238 ;; This creates a small keymap we can glom the
1239 ;; menu adjustments into.
1241 ;; Delete the old menu if applicable.
1244 ;; Now add the new menu
1249 ;; XEmacs-specific:
1255 \f
1256 ;;; User Input stuff
1257 ;;
1259 "Customize speedbar using the Custom package."
1268 "For motion EVENT, display info about the current line."
1270 nil
1277 ;; XEmacs may let us get in here in other mode buffers.
1282 "Call the info function for the line under the mouse."
1291 "Move to the next ARGth line in a speedbar buffer."
1298 "Move to the previous ARGth line in a speedbar buffer."
1303 "Move to the next ARGth line in a speedbar buffer at the same depth.
1304 This means that movement is restricted to a subnode, and that siblings
1305 of intermediate nodes are skipped."
1307 ;; First find the extent for which we are allowed to move.
1323 ;; We have reached the end of this block.
1333 "Move to the next ARGth line in a speedbar buffer at the same depth.
1334 This means that movement is restricted to a subnode, and that siblings
1335 of intermediate nodes are skipped."
1341 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1342 This means that movement is restricted to a subnode, and that siblings
1343 of intermediate nodes are skipped."
1349 "Move across ARG groups of similarly typed items in speedbar.
1350 Stop on the first line of the next type of item, or on the last or first item
1351 if we reach a buffer boundary."
1362 "Move forward over the current list.
1363 A LIST in speedbar is a group of similarly typed items, such as directories,
1364 files, or the directory button."
1370 "Move backward over the current list.
1371 A LIST in speedbar is a group of similarly typed items, such as directories,
1372 files, or the directory button."
1378 "Page down one screen-full of the speedbar, or ARG lines."
1384 "Page up one screen-full of the speedbar, or ARG lines."
1390 "Keyboard accelerator for moving the default directory up one.
1391 Assumes that the current buffer is the speedbar buffer."
1395 \f
1396 ;;; Speedbar file activity (aka creeping featurism)
1397 ;;
1399 "Refresh the current speedbar display, disposing of any cached data.
1400 Argument ARG represents to force a refresh past any caches that may exist."
1404 deactivate-mark)
1405 ;; We need to hack something so this works in detached frames.
1409 speedbar-directory-contents-alist)))
1414 ;; Reset the timer in case it got really hosed for some reason...
1420 "Load the item under the cursor or mouse if it is a Lisp file."
1426 ;; If the compiled version exists, load that instead...
1432 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1442 ))
1445 "Provide information about what the user clicked on.
1446 This should be bound to a mouse EVENT."
1452 "Attempt to derive, and then display information about this line item.
1453 File style information is displayed with `speedbar-item-info'."
1456 ;; Skip invisible number info.
1458 ;; Skip items in "folder" type text characters.
1460 ;; Get the text
1465 "Display info in the minibuffer about the button the mouse is over.
1466 This function can be replaced in `speedbar-mode-functions-list' as
1467 `speedbar-item-info'."
1474 "Display info about a file that is on the current line.
1475 Return nil if not applicable. If FILENAME, then use that
1476 instead of reading it from the speedbar buffer."
1481 nil)))
1484 "Display info about a tag that is on the current line.
1485 Return nil if not applicable."
1502 )))
1519 nil t))
1522 nil))))
1532 parent))
1534 ;; Not using `semantic':
1538 nil)))))
1541 "Display info in the minibuffer about the button the mouse is over."
1549 "Copy the item under the cursor.
1550 Files can be copied to new names or places."
1560 speedbar-shown-directories)))
1561 ;; Create the right file name part
1569 t))
1572 ;; refresh display if the new place is currently displayed.
1578 ))))))
1581 "Rename the item under the cursor or mouse.
1582 Files can be renamed to new names or moved to new directories."
1590 speedbar-shown-directories)))
1591 ;; Create the right file name part
1599 t))
1602 ;; refresh display if the new place is currently displayed.
1607 )))))
1611 "Create a directory in speedbar."
1617 basedir)))
1618 ;; Make the directory
1622 )
1626 "Delete the item under the cursor. Files are removed from disk."
1639 ))
1640 ))
1643 "Delete the object associated from the item under the cursor.
1644 The file is removed from disk. The object is determined from the
1645 variable `speedbar-obj-alist'."
1661 "Enable automatic updating in speedbar via timers."
1668 "Disable automatic updating and stop consuming resources."
1675 "Toggle automatic update for the speedbar frame."
1682 "Toggle use of images in the speedbar frame."
1688 "Toggle tag sorting."
1693 "Toggle display of files speedbar can not tag."
1699 "Allow the buffer to be writable and evaluate FORMS."
1706 "Insert TEXT as the next logical speedbar button.
1707 FACE is the face to put on the button, MOUSE is the highlight face to use.
1708 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1709 This function assumes that the current buffer is the speedbar buffer.
1710 If PREVLINE, then put this button on the previous line.
1712 This is a convenience function for special modes that create their own
1713 specialized speedbar displays."
1730 "Insert a separation label of TEXT.
1731 Separators are not active, have no labels, depth, or actions."
1739 'speedbar-separator-face
1740 nil nil nil)))
1743 "Create a button from START to END, with FACE as the display face.
1744 MOUSE is the mouse face. When this button is clicked on FUNCTION
1745 will be run with the TOKEN parameter (any Lisp object). If FACE
1746 is t use the text properties of the string that is passed as an
1747 argument."
1757 ;; So far the only text we have is less that 3 chars.
1760 )
1761 \f
1762 ;;; Initial Expansion list management
1763 ;;
1765 "Return the current default expansion list.
1766 This is based on `speedbar-initial-expansion-list-name' referencing
1767 `speedbar-initial-expansion-mode-alist'."
1768 ;; cdr1 - name, cdr2 - menu
1770 speedbar-initial-expansion-mode-alist)))))
1773 "Return the current default menu data.
1774 This is based on `speedbar-initial-expansion-list-name' referencing
1775 `speedbar-initial-expansion-mode-alist'."
1778 speedbar-initial-expansion-mode-alist)))))
1781 "Return the current default menu data.
1782 This is based on `speedbar-initial-expansion-list-name' referencing
1783 `speedbar-initial-expansion-mode-alist'."
1786 speedbar-initial-expansion-mode-alist))))))
1789 "Return a list of functions to call stealthily.
1790 This is based on `speedbar-initial-expansion-list-name' referencing
1791 `speedbar-stealthy-function-list'."
1793 speedbar-stealthy-function-list)))
1796 "Add NEW-LIST to the list of expansion lists."
1800 "Change speedbar's default expansion list to NEW-DEFAULT."
1804 speedbar-previously-used-expansion-list-name)
1805 speedbar-initial-expansion-mode-alist
1806 nil t "" nil
1807 speedbar-previously-used-expansion-list-name)))
1809 speedbar-initial-expansion-list-name
1810 speedbar-initial-expansion-list-name new-default)
1817 "Return a current mode-specific replacement for function, or nil.
1818 Scans `speedbar-mode-functions-list' first for the current mode, then
1819 for FUNCTION."
1822 speedbar-mode-functions-list)))))
1825 "Add NEW-LIST to the list of mode functions.
1826 See `speedbar-mode-functions-list' for details."
1829 \f
1830 ;;; Special speedbar display management
1831 ;;
1833 "Quick check function called on BUFFERs by the speedbar timer function.
1834 Maintains the value of local variables which control speedbar's use
1835 of the special mode functions."
1840 "Add localized speedbar support to BUFFER's mode if it is available."
1844 nil
1849 nil ;; do nothing to broken mode
1855 ;; If it is autoloaded, we need to load it now so that
1856 ;; we have access to the variable -speedbar-menu-items.
1857 ;; Is this XEmacs safe?
1862 nil ;; don't add special keymap
1868 nil ;; don't add special menus
1872 )))))))
1875 "Remove any traces that BUFFER supports speedbar in a specialized way."
1880 \f
1881 ;;; File button management
1882 ;;
1884 "Create file lists for DIRECTORY.
1885 The car is the list of directories, the cdr is list of files not
1886 matching ignored headers. Cache any directory files found in
1887 `speedbar-directory-contents-alist' and use that cache before scanning
1888 the file-system."
1890 ;; find the directory, either in the cache, or build it.
1910 speedbar-directory-contents-alist))
1911 nl))
1912 ))
1915 "Insert a single button group at point for DIRECTORY.
1916 Each directory part is a different button. If part of the directory
1917 matches the user directory ~, then it is replaced with a ~.
1918 INDEX is not used, but is required by the caller."
1924 dd))
1932 'speedbar-directory-face
1933 'speedbar-highlight-face
1934 'speedbar-directory-buttons-follow
1940 ;; Nuke the beginning of the directory if it's too long...
1968 )))))))
1969 )
1976 'speedbar-directory-face
1977 'speedbar-highlight-face
1978 'speedbar-directory-buttons-follow
1984 exp-button-char exp-button-function
1985 exp-button-data
1986 tag-button tag-button-function tag-button-data
1987 tag-button-face depth)
1988 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
1989 This is the button that expands or contracts a node (if applicable),
1990 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
1991 is the function to call if it's clicked on. Button types are
1992 `bracket', `angle', `curly', `expandtag', `statictag', t, or nil.
1993 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
1994 button.
1996 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
1997 function to call if clicked on, and TAG-BUTTON-DATA is the data to
1998 attach to the text field (such a tag positioning, etc).
1999 TAG-BUTTON-FACE is a face used for this type of tag.
2001 Lastly, DEPTH shows the depth of expansion.
2003 This function assumes that the cursor is in the speedbar window at the
2004 position to insert a new item, and that the new item will end with a CR."
2025 )
2031 )
2040 tag-button-function tag-button-data))
2041 ))
2044 "Change the expansion button character to CHAR for the current line."
2053 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2054 ;; make sure we fix the image on the text here.
2057 \f
2058 ;;; Build button lists
2059 ;;
2061 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2062 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2063 don't know how to manage them. The input parameter FILES is a cons
2064 cell of the form (DIRLIST . FILELIST)."
2065 ;; Start inserting all the directories
2085 "Insert files for DIRECTORY with level INDEX at point."
2090 ;; If the shown files variable has extra directories, then
2091 ;; it is our responsibility to redraw them all
2092 ;; Luckily, the nature of inserting items into this list means
2093 ;; that by reversing it, we can easily go in the right order
2097 ;; Expand them all as we find them.
2107 )))
2108 ;;; Generic List support
2109 ;;
2110 ;; Generic lists are hierarchies of tags which we may need to permute
2111 ;; in order to make it look nice.
2112 ;;
2113 ;; A generic list is of the form:
2114 ;; ( ("name" . marker-or-number) <-- one tag at this level
2115 ;; ("name" marker-or-number goto-fun . args) <-- one tag at this level
2116 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2117 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2119 "Non-nil if SUBLST is a group.
2120 Groups may optionally contain a position."
2125 )))
2130 )))
2133 "Non-nil if SUBLST is a group with a position."
2141 ))))
2144 "Non-nil if SUBLST is a tag."
2150 ;; For semantic/bovine items, this is needed
2152 ))
2155 "Sort all elements of tag hierarchy LST."
2160 "A wrapper for `try-completion'.
2161 Passes STRING and ALIST to `try-completion' if ALIST
2162 passes some tests."
2166 nil))
2169 "Prefix group names for tag hierarchy LST."
2181 ;; Do nothing. Too short to bother with.
2182 lst
2183 ;; Break out sub-lists
2189 ;; Reverse newlst because it was made backwards.
2190 ;; Sublist doesn't need reversing because the act
2191 ;; of binning things will reverse it for us.
2193 sublst sublst)
2194 ;; Now, first find out how long our list is. Never let a
2195 ;; list get-shorter than our minimum.
2199 ;; Sort the whole list into bins.
2204 ;; 0 storage bin for shorty.
2207 ;; stuff into a bin based on ascii value at diff
2211 ;; Go through all our bins Stick singles into our
2212 ;; junk-list, everything else as sublsts in work-list.
2213 ;; If two neighboring lists are both small, make a grouped
2214 ;; group combining those two sub-lists.
2217 ;; The bins contents are currently in forward order.
2223 speedbar-tag-split-minimum-length))
2225 ;; We have reached a longer list, so we
2226 ;; must finish off a grouped group.
2230 num-shorts-grouped))
2231 ;; All singles? Junk list
2233 junk-list)))
2235 ;; Only one short group? Just stick it in
2236 ;; there by itself. Make a group, and find
2237 ;; a subexpression
2241 speedbar-tag-group-name-minimum-length)
2244 " ("
2251 short-group-list)
2252 work-list ))))
2254 ;; Multiple groups to be named in a special
2255 ;; way by displaying the range over which we
2256 ;; have grouped them.
2259 " to "
2260 short-end-name)
2261 short-group-list)
2262 work-list))))
2263 ;; Reset short group list information every time.
2265 short-start-name nil
2266 short-end-name nil
2268 ;; Ok, now that we cleaned up the short-group-list,
2269 ;; we can deal with this new list, to decide if it
2270 ;; should go on one of these sub-lists or not.
2276 short-start-name
2280 ;; Did we run out of things? Drop our new list onto the end.
2283 ;; All singles? Junk list
2286 ;; Only one short group? Just stick it in
2287 ;; there by itself.
2290 short-group-list)
2291 work-list)))
2293 ;; Multiple groups to be named in a special
2294 ;; way by displaying the range over which we
2295 ;; have grouped them.
2298 short-group-list)
2299 work-list))))
2300 ;; Reverse the work list nreversed when consing.
2302 ;; Now, stick our new list onto the end of
2310 "Trim all words in a tag hierarchy.
2311 Base trimming information on word separators, and group names.
2312 Argument LST is the list of tags to trim."
2323 ;; Get the prefix to trim by. Make sure that we don't trim
2324 ;; off silly pieces, only complete understandable words.
2338 trimlst)
2340 ;; Put the lists together
2344 "Create a simple `Tags' group with orphaned tags.
2345 Argument LST is the list of tags to sort into groups."
2359 "Adjust the tag hierarchy in LST, and return it.
2360 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2361 the list."
2368 speedbar-tag-hierarchy-method)
2369 speedbar-tag-hierarchy-method))
2372 lst)))
2376 lst))
2379 "The type of button created for groups of tags.
2380 Good values for this are `curly' and `expandtag'.
2384 "The type of button created for tags in generic lists.
2385 Good values for this are nil and `statictag'.
2389 "At LEVEL, insert a generic multi-level alist LST.
2390 Associations with lists get {+} tags (to expand into more nodes) and
2391 those with positions just get a > as the indicator. {+} buttons will
2392 have the function EXPAND-FUN and the token is the cdr list. The token
2393 name will have the function FIND-FUN and not token."
2394 ;; Remove imenu rescan button
2397 ;; Get, and set up variables that define how we treat these tags.
2401 expand-button tag-button)
2406 tag-button speedbar-generic-list-tag-button-type))
2407 ;; Adjust the list.
2409 ;; insert the parts
2414 nil nil nil ;no expand button data
2416 find-fun ;function
2418 'speedbar-tag-face
2424 find-fun ;function
2426 'speedbar-tag-face
2432 nil nil 'speedbar-tag-face
2435 ))
2439 "At level INDENT, insert the imenu generated LST."
2441 'speedbar-tag-expand
2445 "At level INDENT, insert the etags generated LST."
2447 'speedbar-tag-expand
2449 \f
2450 ;;; Timed functions
2451 ;;
2453 "Generically update the contents of the speedbar buffer."
2455 ;; Set the current special buffer
2458 ;; Check for special modes
2461 ;; Choose the correct method of doodling.
2465 'speedbar-special-mode-expansion-list
2467 ;;(eq (get major-mode 'mode-class 'special)))
2472 "Update the contents of the speedbar buffer for the current situation."
2473 ;; Due to the historical growth of speedbar, we need to do something
2474 ;; special for "files" mode. Too bad.
2477 )
2479 ;; Do all the files type work. It still goes through the
2480 ;; expansion list stuff. :(
2482 speedbar-shown-directories)
2485 speedbar-ignored-directory-regexp
2487 nil
2490 default-directory))
2495 default-directory)
2497 ;; Else, we can do a short cut. No text cache.
2513 "Update the contents of the speedbar buffer based on the current directory."
2515 cbd-parent
2518 ;; disable stealth during update
2522 ;; Because there is a bug I can't find just yet
2525 ;; If we are updating contents to where we are, then this is
2526 ;; really a request to update existing contents, so we must be
2527 ;; careful with our text cache!
2531 ;; If the current directory is not the last element in the dir
2532 ;; list, then we ALSO need to zap the list of expanded directories
2536 ;; Build cbd-parent, and see if THAT is in the current shown
2537 ;; directories. First, go through pains to get the parent directory
2548 ;; If this directory is NOT in the current list of available
2549 ;; directories, then use the cache, and set the cache to our new
2550 ;; value. Make sure to unhighlight the current file, or if we
2551 ;; come back to this directory, it might be a different file
2552 ;; and then we get a mess!
2559 ;; Check if our new directory is in the list of directories
2560 ;; shown in the text-cache
2563 use-cache t)
2564 ;; default the shown directories to this list...
2566 ))
2570 ;; Find this directory as a speedbar node.
2572 ;; Open it.
2581 speedbar-shown-directories))
2592 "Use the mode-specific variable to fill in the speedbar buffer.
2593 This should only be used by modes classified as special."
2598 ;; If we are leaving a directory, cache it.
2600 ;; Do nothing
2601 nil
2602 ;; Clean up directory maintenance stuff
2606 speedbar-shown-directories nil))
2607 ;; Now fill in the buffer with our newly found specialized list.
2610 ;; We do not erase the buffer because these functions may
2611 ;; decide NOT to update themselves.
2616 "Set up the speedbar timer with TIMEOUT.
2617 Uses `dframe-set-timer'.
2618 Also resets scanner functions."
2620 ;; Apply a revert hook that will reset the scanners. We attach to revert
2621 ;; because most reverts occur during VC state change, and this lets our
2622 ;; VC scanner fix itself.
2626 ;; change this if it changed for some reason
2630 "Run whenever Emacs is idle to update the speedbar item."
2634 ;; Save all the match data so that we don't mess up executing fns
2636 ;; Only do stuff if the frame is visible, not an icon, and if
2637 ;; it is currently flagged to do something.
2644 ;; make sure we at least choose a window to
2645 ;; get a good directory from
2647 nil
2648 ;; Check for special modes
2650 ;; Update for special mode all the time!
2654 'speedbar-special-mode-expansion-list
2656 ;;(eq (get major-mode 'mode-class 'special)))
2660 "Updating speedbar to special mode: %s..."
2661 major-mode))
2666 "Updating speedbar to special mode: %s...done"
2667 major-mode)
2670 ;; Update all the contents if directories change!
2674 ;; Always update for GUD.
2676 speedbar-initial-expansion-list-name)))
2679 ;; Now run stealthy updates of time-consuming items
2683 \f
2684 ;;; Stealthy activities
2685 ;;
2690 "For a given speedbar, run all items in the stealthy function list.
2691 Each item returns t if it completes successfully, or nil if
2692 interrupted by the user."
2699 ;;(sit-for 0)
2701 ;;(dframe-message "Exit with %S" (car l))
2702 ))))
2705 "Reset any variables used by functions in the stealthy list as state.
2706 If new functions are added, their state needs to be updated here."
2708 speedbar-obj-to-do-point t
2709 speedbar-ro-to-do-point t)
2711 )
2714 "Go to the line where FILE is."
2723 nil t))
2740 "Locate the file thought to be current, and remove its highlighting."
2742 ;;(set-buffer speedbar-buffer)
2748 'face
2752 "Find the current file, and update our visuals to indicate its name.
2753 This is specific to file names. If the file name doesn't show up, but
2754 it should be in the list, then the directory cache needs to be updated."
2760 nil)))
2762 rf)))
2768 ;; check here, that way we won't refresh to newcf until
2769 ;; its been written, thus saving ourselves some time
2773 ;; It is important to select the frame, otherwise the window
2774 ;; we want the cursor to move in will not be updated by the
2775 ;; search-forward command.
2777 ;; Remove the old file...
2779 ;; now highlight the new one.
2780 ;; (set-buffer speedbar-buffer)
2783 ;; put the property on it
2786 'face
2788 ;; Oops, it's not in the list. Should it be?
2792 ;; yes, it is (we will ignore unknowns for now...)
2796 ;; put the property on it
2799 'face
2801 ;; if it's not in there now, whatever...
2802 ))
2807 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2808 ;;doesn't need to be in. We don't want to recenter when we are
2809 ;;updating files.
2811 ;;(speedbar-center-buffer-smartly)
2814 ))
2817 )))
2818 ;; return that we are done with this activity.
2819 t)
2822 "Add INDICATOR-STRING to the end of this speedbar line.
2823 If INDICATOR-STRING is space, and REPLACE-THIS is a character,
2824 then the existing indicator is removed. If there is already an
2825 indicator, then do not add a space."
2827 ;; The nature of the beast: Assume we are in "the right place"
2830 speedbar-object-read-only-indicator
2846 ))))
2849 "Scan all the files in a directory, and for each see if it is read only."
2850 ;; Check for to-do to be reset. If reset but no RCS is available
2851 ;; then set to nil (do nothing) otherwise, start at the beginning
2861 nil t))
2867 speedbar-object-read-only-indicator
2871 speedbar-object-read-only-indicator))))))
2873 ;; return that we are incomplete
2874 nil
2875 ;; we are done, set to-do to nil
2877 ;; and return t
2878 t))
2879 t)))
2882 "Scan all files in a directory, and for each see if it's checked out.
2883 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2884 to add more types of version control systems."
2885 ;; Check for to-do to be reset. If reset but no RCS is available
2886 ;; then set to nil (do nothing) otherwise, start at the beginning
2895 'ange-ftp-directory-format
2898 ;; efs support: Bob Weiner
2903 reg
2912 nil t))
2920 ;; return that we are incomplete
2921 nil
2922 ;; we are done, set to-do to nil
2924 ;; and return t
2925 t))
2926 t)))
2929 "Return t if the file on this line is checked out of a version control system.
2930 Parameter DEPTH is a string with the current depth of indentation of
2931 the file being checked."
2935 ;; Skip-chars: thanks ptype@dra.hmg.gb
2946 "Return t if we should bother checking DIRECTORY for version control files.
2947 This can be overloaded to add new types of version control systems."
2951 ;; User extension
2953 directory)
2954 ))
2957 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2958 Automatically recognizes all VCs supported by VC mode. You can
2959 optimize this function by overriding it and only doing those checks
2960 that will occur on your system."
2963 ;; User extension
2965 ))
2967 ;; Object File scanning
2969 "Scan all files in a directory, and for each see if there is an object.
2970 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2971 to add more object types."
2972 ;; Check for to-do to be reset. If reset but no RCS is available
2973 ;; then set to nil (do nothing) otherwise, start at the beginning
2983 nil t))
2992 ;; return that we are incomplete
2993 nil
2994 ;; we are done, set to-do to nil
2996 ;; and return t
2997 t))
2998 t)))
3001 "Return t if the file on this line has an associated object.
3002 Parameter DEPTH is a string with the current depth of indentation of
3003 the file being checked."
3007 ;; Skip-chars: thanks ptype@dra.hmg.gb
3019 nil
3020 ;; Find out if the object is out of date or not.
3030 \f
3031 ;;; Clicking Activity
3032 ;;
3034 "Position the cursor on a line."
3042 "Activate any speedbar buttons where the mouse is clicked.
3043 This must be bound to a mouse event. A button is any location of text
3044 with a mouse face that has a text property called `speedbar-function'.
3045 Argument E is the click event."
3046 ;; Backward compatibility let statement.
3052 "Look under the cursor and examine the text properties.
3053 From this extract the file/tag name, token, indentation level and call
3054 a function if appropriate."
3058 ;; The 1-,+ is safe because scanning starts AFTER the point
3059 ;; specified. This lets the search include the character the
3060 ;; cursor is on.
3073 ;;(dframe-message "%S:%S:%S:%s" fn tok txt dent)
3076 \f
3077 ;;; Reading info from the speedbar buffer
3078 ;;
3080 "Retrieve the text after prefix junk for the current line.
3081 Optional argument P is where to start the search from."
3088 nil)))
3091 "Retrieve the token information after the prefix junk for the current line.
3092 Optional argument P is where to start the search from."
3102 nil)))
3105 "Retrieve the file or whatever from the line at point P.
3106 The return value is a string representing the file. If it is a
3107 directory, then it is the directory name."
3117 nil))
3118 nil)))))
3121 "If FILE is displayed, go to this line and return t.
3122 Otherwise do not move and return nil."
3128 ;; scan all the directories
3134 nil t))
3138 ;; find the file part
3140 ;; only had a dir part
3144 t)
3146 ;; find the file part
3151 nil t)
3154 t)
3156 nil))))))
3159 "Retrieve the directory name associated with the current line.
3160 This may require traversing backwards from DEPTH and combining the default
3161 directory with these items. This function is replaceable in
3162 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3169 "Retrieve the directory associated with the current line.
3170 This may require traversing backwards from DEPTH and combining the default
3171 directory with these items."
3186 "/"
3187 directory)))
3189 ;; This is the start of our directory.
3194 directory))
3199 "Position the cursor on the line specified by DIRECTORY."
3213 nil t))
3223 "Edit whatever tag or file is on the current speedbar line."
3227 ;; If this fails, then it is a non-standard click, and as such,
3228 ;; perfectly allowed.
3231 t)
3235 nil))
3239 "Expand the line under the cursor.
3240 With universal argument ARG, flush cached data."
3254 "Expand the line under the cursor and flush any cached information."
3259 "Contract the line under the cursor."
3271 "Contract or expand the line under the cursor."
3283 "Expand the line under the cursor and all descendants.
3284 Optional argument ARG indicates that any cache should be flushed."
3287 ;; Now, inside the area expanded here, expand all subnodes of
3288 ;; the same descendant type.
3298 )
3301 "Expand the line under the cursor and all descendants."
3304 ;; Don't need to do anything else since all descendants are
3305 ;; hidden by default anyway. Yay! It's easy.
3306 )
3309 "Speedbar click handler for filenames.
3310 TEXT, the file will be displayed in the attached frame.
3311 TOKEN is unused, but required by the click handler. INDENT is the
3312 current indentation level."
3314 ;; Run before visiting file hook here.
3322 ;; Reset the timer with a new timeout when clicking a file
3323 ;; in case the user was navigating directories, we can cancel
3324 ;; that other timer.
3329 "Speedbar click handler for directory names.
3330 Clicking a directory will cause the speedbar to list files in
3331 the subdirectory TEXT. TOKEN is an unused requirement. The
3332 subdirectory chosen will be at INDENT level."
3336 ;; Because we leave speedbar as the current buffer,
3337 ;; update contents will change directory without
3338 ;; having to touch the attached frame. Turn off smart expand just
3339 ;; in case.
3347 "Delete text from point to indentation level INDENT or greater.
3348 Handles end-of-sublist smartly."
3361 "Speedbar click handler for directory expand button.
3362 Clicking this button expands or contracts a directory. TEXT is the
3363 button clicked which has either a + or -. TOKEN is the directory to be
3364 expanded. INDENT is the current indentation level."
3369 speedbar-shown-directories))
3391 )
3397 "Speedbar click handler for default directory buttons.
3398 TEXT is the button clicked on. TOKEN is the directory to follow.
3399 INDENT is the current indentation level and is unused."
3403 ;; Because we leave speedbar as the current buffer,
3404 ;; update contents will change directory without
3405 ;; having to touch the attached frame.
3410 "The cursor is on a selected line. Expand the tags in the specified file.
3411 The parameter TEXT and TOKEN are required, where TEXT is the button
3412 clicked, and TOKEN is the file to expand. INDENT is the current
3413 indentation level."
3416 token)))
3418 ;; if no list, then remove expando button
3433 "For the tag TEXT in a file TOKEN, go to that position.
3434 INDENT is the current indentation level."
3442 ;; Reset the timer with a new timeout when clicking a file
3443 ;; in case the user was navigating directories, we can cancel
3444 ;; that other timer.
3449 ))
3452 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3453 Etags does not support this feature. TEXT will be the button string.
3454 TOKEN will be the list, and INDENT is the current indentation level."
3467 \f
3468 ;;; Loading files into the attached frame.
3469 ;;
3471 "Specify how to select a frame for displaying a file.
3472 A number such as 1 or -1 means to pass that number to `other-frame'
3473 while selecting a frame from speedbar. Any other value means to use
3474 the attached frame (the frame that speedbar was started from)."
3479 "This will load FILE into the speedbar attached frame.
3480 If the file is being displayed in a different frame already, then raise that
3481 frame instead."
3494 )
3496 ;;; Centering Utility
3497 ;;
3499 "Recenter a speedbar buffer so the current indentation level is all visible.
3500 This assumes that the cursor is on a file, or tag of a file which the user is
3501 interested in."
3511 ;; whole buffer fits
3517 ;; too big
3541 ;; Now work out the details of centering
3546 ;; We can't fit it all, so just center on cursor
3549 ;; we can fit everything on the screen, but...
3552 ;; we are all set!
3553 nil
3554 ;; we need to do something...
3560 newcent))
3565 \f
3566 ;;; Tag Management -- List of expanders:
3567 ;;
3569 "Return a list of tags generated dynamically from FILE.
3570 This uses the entries in `speedbar-dynamic-tags-function-list'
3571 to find the proper tags. It is up to each of those individual
3572 functions to do caching and flushing if appropriate."
3574 ;; If a file is in memory, switch to that buffer. This allows
3575 ;; us to use the local variable. If the file is on disk, we
3576 ;; can try a few of the defaults that can get tags without
3577 ;; opening the file.
3580 ;; If there is a buffer-local value of
3581 ;; speedbar-dynamic-tags-function-list, it will now be available.
3588 t))
3592 ;; No valid tag list, return nil
3593 nil
3594 ;; We have some tags. Return the list with the insert fn
3595 ;; prepended
3598 ;;; Tag Management -- Imenu
3599 ;;
3602 nil
3608 "Load FILE into a buffer, and generate tags using Imenu.
3609 Returns the tag list, or t for an error."
3610 ;; Load this AND compile it in
3619 index-alist))
3621 )
3622 \f
3623 ;;; Tag Management -- etags (old XEmacs compatibility part)
3624 ;;
3631 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3632 ; speedbar-parse-fortran77-tag)
3636 )
3637 "Associations of file extensions and expressions for extracting tags.
3638 To add a new file type, you would want to add a new association to the
3639 list, where the car is the file match, and the cdr is the way to
3640 extract an element from the tags output. If the output is complex,
3641 use a function symbol instead of regexp. The function should expect
3642 to be at the beginning of a line in the etags buffer.
3647 "Command used to create an etags file.
3648 This variable is ignored if `speedbar-use-imenu-flag' is t."
3653 "List of arguments to use with `speedbar-fetch-etags-command'.
3654 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3655 modify this list conveniently.
3656 This variable is ignored if `speedbar-use-imenu-flag' is t."
3662 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3663 FLAG then becomes a member of etags command line arguments. If flag
3666 `speedbar-show-unknown-files'.
3668 This function is a convenience function for XEmacs menu created by
3669 Farzin Guilak <farzin@protocol.com>."
3686 "For FILE, run etags and create a list of symbols extracted.
3687 Each symbol will be associated with its line position in FILE."
3720 )
3725 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3726 ;; sure it's needed with the different sorting method.
3727 ;;
3728 ;(defun speedbar-clean-etags()
3729 ; "Removes spaces before the ^? character, and removes `#define',
3730 ;return types, etc. preceding tags. This ensures that the sort operation
3731 ;works on the tags, not the return types."
3732 ; (save-excursion
3733 ; (goto-char (point-min))
3734 ; (while
3735 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3736 ; (replace-match "\C-?" nil nil))
3737 ; (goto-char (point-min))
3738 ; (while
3739 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3740 ; (delete-region (match-beginning 1) (match-end 1)))))
3743 "At point, return nil, or one alist in the form (SYMBOL . POSITION).
3744 The line should contain output from etags. Parse the output using the
3745 regular expression EXPR."
3761 nil)))
3764 "Parse a C or C++ tag, which tends to be a little complex."
3777 )))
3780 "Parse a Tex string. Only find data which is relevant."
3788 \f
3789 ;;; BUFFER DISPLAY mode.
3790 ;;
3795 nil
3798 ;; Basic tree features
3806 ;; Buffer specific keybindings
3810 )
3823 "----"
3830 )
3834 "Create speedbar buttons based on the buffers currently loaded.
3835 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3839 "Create speedbar buttons based on the buffers currently loaded.
3840 DIRECTORY is the directory of the currently active buffer, and ZERO is 0."
3844 "Create speedbar buffer buttons.
3845 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3851 nil
3861 'speedbar-buffer-click temp
3869 nil
3871 nil
3874 'speedbar-buffer-click temp
3879 ;;(speedbar-insert-separator "Hidden Buffers:")
3880 ;;(while bl
3881 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3882 ;; nil
3883 ;; (if (eq (car bl) speedbar-buffer)
3884 ;; nil
3885 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3886 ;; (buffer-name (car bl))
3887 ;; 'speedbar-buffer-click temp
3888 ;; 'speedbar-file-face 0)
3889 ;; (speedbar-buffers-tail-notes (car bl))))
3890 ;; (setq bl (cdr bl)))
3891 ))
3894 "Add a note to the end of the last tag line.
3895 Argument BUFFER is the buffer being tested."
3900 "Display information about the current buffer on the current line."
3907 item
3913 "Fetch the directory of the file (buffer) specified on the current line.
3914 Optional argument DEPTH specifies the current depth of the back search."
3918 ;; Buffers are always at level 0
3920 nil
3930 "When the users clicks on a buffer-button in speedbar.
3931 TEXT is the buffer's name, TOKEN and INDENT are unused."
3937 speedbar-previously-used-expansion-list-name))))
3940 "Kill the buffer the cursor is on in the speedbar buffer."
3950 "Revert the buffer the cursor is on in the speedbar buffer."
3954 ;; If this fails, then it is a non-standard click, and as such,
3955 ;; perfectly allowed
3965 \f
3966 ;;; Useful hook values and such.
3967 ;;
3972 "Highlight the current line, unhighlighting a previously jumped to line."
3982 "Unhighlight the currently highlighted line."
3990 "Recenter the current buffer so point is on the top of the window."
3994 "Recenter the current buffer so point is in the center of the window."
3997 \f
3998 ;;; Color loading section.
3999 ;;
4004 "Speedbar face for +/- buttons."
4012 "Speedbar face for file names."
4019 "Speedbar face for directory names."
4026 "Speedbar face for tags."
4034 "Speedbar face for the file in the active window."
4041 "Speedbar face for highlighting buttons with the mouse."
4062 "Speedbar face for separator labels in a display."
4065 ;; some edebug hooks
4070 ;; Fix a font lock problem for some versions of Emacs
4072 font-lock-global-modes
4078 font-lock-global-modes)))))
4079 \f
4080 ;;; Obsolete variables and functions
4102 ;; run load-time hooks
4105 ;;; speedbar ends here