| blob | bb813808ed9232ce40d3c597da7fbf6d1e8e89d7 |
1 ;;; speedbar --- quick access to files and tags in a frame
3 ;;; Copyright (C) 1996, 97, 98, 99, 00, 01, 02, 03, 04, 05 Free Software Foundation
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 2, or (at your option)
20 ;; 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; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, USA.
32 ;;; Commentary:
33 ;;
34 ;; The speedbar provides a frame in which files, and locations in
35 ;; files are displayed. These items can be clicked on with mouse-2 in
36 ;; to display that file location.
37 ;;
38 ;;; Customizing and Developing for speedbar
39 ;;
40 ;; Please see the speedbar manual for informaion.
41 ;;
42 ;;; Notes:
43 ;;
44 ;; Users of really old emacsen without the need timer functions
45 ;; will not have speedbar updating automatically. Use "g" to refresh
46 ;; the display after changing directories. Remember, do not interrupt
47 ;; the stealthy updates or your display may not be completely
48 ;; refreshed.
49 ;;
50 ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
51 ;; well. Use the imenu keywords from tex-mode.el for better results.
52 ;;
53 ;; This file requires the library package assoc (association lists)
54 ;; assoc should be available in all modern versions of Emacs.
55 ;; The custom package is optional (for easy configuration of speedbar)
56 ;; http://www.dina.kvl.dk/~abraham/custom/
57 ;; custom is available in all versions of Emacs version 20 or better.
58 ;;
60 ;;; TODO:
61 ;; - Timeout directories we haven't visited in a while.
68 ;; customization stuff
70 "File and tag browser frame."
74 ; :version "20.3"
75 )
78 "Faces used in speedbar."
84 "Version control display in speedbar."
88 ;;; Code:
90 ;; Note: `inversion-test' requires parts of the CEDET package that are
91 ;; not included with Emacs.
92 ;;
93 ;; (defun speedbar-require-version (major minor &optional beta)
94 ;; "Non-nil if this version of SPEEDBAR does not satisfy a specific version.
95 ;; Arguments can be:
96 ;;
97 ;; (MAJOR MINOR &optional BETA)
98 ;;
99 ;; Values MAJOR and MINOR must be integers. BETA can be an integer, or
100 ;; excluded if a released version is required.
101 ;;
102 ;; It is assumed that if the current version is newer than that specified,
103 ;; everything passes. Exceptions occur when known incompatibilities are
104 ;; introduced."
105 ;; (inversion-test 'speedbar
106 ;; (concat major "." minor
107 ;; (when beta (concat "beta" beta)))))
111 speedbar-buffer-buttons)
113 speedbar-buffer-buttons-temp)
114 ;; Files last, means first in the Displays menu
116 speedbar-directory-buttons speedbar-default-directory-list)
117 )
118 "List of named expansion elements for filling the speedbar frame.
119 These expansion lists are only valid for regular files. Special modes
120 still get to override this list on a mode-by-mode basis. This list of
121 lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string
122 representing the types of things to be displayed. MENU is an easymenu
123 structure used when in this mode. KEYMAP is a local keymap to install
124 over the regular speedbar keymap. FN1 ... are functions that will be
125 called in order. These functions will always get the default
126 directory to use passed in as the first parameter, and a 0 as the
127 second parameter. The 0 indicates the uppermost indentation level.
128 They must assume that the cursor is at the position where they start
132 "A symbol name representing the expansion list to use.
133 The expansion list `speedbar-initial-expansion-mode-alist' contains
137 "Save the last expansion list method.
138 This is used for returning to a previous expansion list method when
143 speedbar-update-current-file
144 speedbar-check-read-only
145 speedbar-check-vc
146 speedbar-check-objects)
147 )
148 "List of functions to periodically call stealthily.
149 This list is of the form:
151 ...)
152 where NAME is the name of the major display mode these functions are
153 for, and the remaining elements FUNCTION are functions to call in order.
154 Each function must return nil if interrupted, or t if completed.
155 Stealthy functions which have a single operation should always return
156 t. Functions which take a long time should maintain a state (where
157 they are in their speedbar related calculations) and permit
167 )
168 "List of function tables to use for different major display modes.
169 It is not necessary to define any functions for a specialized mode.
170 This just provides a simple way of adding lots of customizations.
171 Each sublist is of the form:
173 Where NAME is the name of the specialized mode. The rest of the list
174 is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name
175 of a function you would like to replace, and REPLACEMENTFUNCTION,
176 which is a function you can call instead. Not all functions can be
177 replaced this way. Replaceable functions must provide that
181 "*Non-nil means speedbar will show special mode contents.
182 This permits some modes to create customized contents for the speedbar
183 frame."
188 "*Query control for file operations.
189 The 'always flag means to always query before file operations.
190 The 'none-but-delete flag means to not query before any file
191 operations, except before a file deletion."
194 all)
196 none-but-delete)
197 ;;;; (const :tag "Never Every Query."
198 ;;;; none)
199 ))
202 "Default function list for creating specialized button lists.
203 This list is set by modes that wish to have special speedbar displays.
204 The list is of function names. Each function is called with one
205 parameter BUFFER, the originating buffer. The current buffer is the
209 "Default keymap used when identifying a specialized display mode.
210 This keymap is local to each buffer that wants to define special keybindings
214 "*Hooks run before speedbar visits a file in the selected frame.
215 The default buffer is the buffer in the selected window in the attached frame."
220 "*Hooks run when speedbar visits a file in the selected frame."
225 "*Hooks run before speedbar visits a tag in the selected frame.
226 The default buffer is the buffer in the selected window in the attached frame."
231 "*Hooks run when speedbar visits a tag in the selected frame."
235 speedbar-recenter-to-top
236 speedbar-recenter
237 ))
240 "*Hooks run when speedbar is loaded."
245 "*Hooks run when the keymaps are regenerated."
250 "*Non-nil show files we can't expand with a ? in the expand button.
251 nil means don't show the file in the list."
255 ;;; EVENTUALLY REMOVE THESE
257 ;; When I moved to a repeating timer, I had the horrible missfortune
258 ;; of loosing the ability for adaptive speed choice. This update
259 ;; speed currently causes long delays when it should have been turned off.
265 ;;; END REMOVE THESE
274 )
275 "*Parameters to use when creating the speedbar frame in Emacs.
276 Any parameter supported by a frame may be added. The parameter `height'
277 will be initialized to the height of the frame speedbar is
278 attached to and added to this list before the new frame is initialized."
284 ;; These values by Hrvoje Niksic <hniksic@srce.hr>
287 internal-border-width 0 unsplittable t
288 default-toolbar-visible-p nil has-modeline-p nil
289 menubar-visible-p nil
290 default-gutter-visible-p nil
291 )
292 "*Parameters to use when creating the speedbar frame in XEmacs.
293 Parameters not listed here which will be added automatically are
294 `height' which will be initialized to the height of the frame speedbar
295 is attached to."
302 "*Non-nil means use imenu for file parsing. nil to use etags.
303 XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
304 use etags instead. Etags support is not as robust as imenu support."
312 "Set to a list of functions which will return and insert a list of tags.
313 Each element is of the form ( FETCH . INSERT ) where FETCH
314 is a function which takes one parameter (the file to tag) and returns a
315 list of tags. The tag list can be of any form as long as the
316 corresponding insert method can handle it. If it returns t, then an
317 error occurred, and the next fetch routine is tried.
318 INSERT is a function which takes an INDENTation level, and a LIST of
323 "*Non-nil means to use tool tips if they are avaialble.
324 When tooltips are not available, mouse-tracking and minibuffer
325 display is used instead."
330 "*Non-nil means to display info about the line under the mouse."
335 "*If non-nil, sort tags in the speedbar display. *Obsolete*.
336 Use `semantic-tag-hierarchy-method' instead."
342 speedbar-trim-words-tag-hierarchy)
343 "*List of hooks which speedbar will use to organize tags into groups.
344 Groups are defined as expandable meta-tags. Imenu supports
345 such things in some languages, such as separating variables from
346 functions. Each hook takes one argument LST, and may destructively
347 create a new list of the same form. LST is a list of elements of the
348 form:
349 (ELT1 ELT2 ... ELTn)
350 where each ELT is of the form
351 (TAG-NAME-STRING . NUMBER-OR-MARKER)
352 or
353 (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
357 speedbar-trim-words-tag-hierarchy
358 speedbar-simple-group-tag-hierarchy
359 speedbar-sort-tag-hierarchy)
360 )
363 "*The minimum length of a prefix group name before expanding.
364 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
365 and one such groups common characters is less than this number of
366 characters, then the group name will be changed to the form of:
367 worda to wordb
368 instead of just
369 word
370 This way we won't get silly looking listings."
375 "*Minimum length before we stop trying to create sub-lists in tags.
376 This is used by all tag-hierarchy methods that break large lists into
377 sub-lists."
382 "*Maximum length of submenus that are regrouped.
383 If the regrouping option is used, then if two or more short subgroups
384 are next to each other, then they are combined until this number of
385 items is reached."
390 "*Indicates how the directory button will be displayed.
391 Possible values are:
392 'span - span large directories over multiple lines.
393 'trim - trim large directories to only show the last few.
394 nil - no trimming."
397 span)
399 trim)
403 "*Non-nil means speedbar should use smart expansion.
404 Smart expansion only affects when speedbar wants to display a
405 directory for a file in the attached frame. When smart expansion is
406 enabled, new directories which are children of a displayed directory
407 are expanded in the current framework. If nil, then the current
408 hierarchy would be replaced with the new directory."
413 "*When sub-nodes are expanded, the number of spaces used for indentation."
418 "*Non-nil means speedbar will hide the brackets around the + or -."
423 "*Hooks called before popping up the speedbar frame."
428 "*Hooks called before popping up the speedbar frame."
433 "*Hooks called before deleting the speedbar frame."
438 "*Hooks called after creating a speedbar buffer."
443 "*Hooks called after running the speedbar timer function."
448 "*Verbosity level of the speedbar. 0 means say nothing.
449 1 means medium level verbosity. 2 and higher are higher levels of
450 verbosity."
458 "*Non-nil check all files in speedbar to see if they have been checked out.
459 Any file checked out is marked with `speedbar-vc-indicator'."
464 "Text used to mark files which are currently checked out.
465 Other version control systems can be added by examining the function
469 "*Return non-nil if the current directory should be checked for Version Control.
470 Functions in this hook must accept one parameter which is the directory
471 being checked."
476 "*Return non-nil if the specified file is under Version Control.
477 Functions in this hook must accept two parameters. The DIRECTORY of the
478 current file, and the FILENAME of the file being checked."
486 "*Non-nil check all files in speedbar to see if they have an object file.
487 Any file checked out is marked with `speedbar-obj-indicator', and the
488 marking is based on `speedbar-obj-alist'"
496 "Text used to mark files that have a corresponding hidden object file.
497 The car is for an up-to-date object. The cdr is for an out of date object.
515 ;; Note: Look for addition place to add indicator lists that
516 ;; use skip-chars instead of a regular expression.
528 "Regular expression used when identifying files.
532 "*Hook called whenever generic scanners are reset.
533 Set this to implement your own scanning / rescan safe functions with
534 state data."
542 "Takes EXTLIST, a list of extensions and transforms it into regexp.
543 All the preceding `.' are stripped for an optimized expression starting
544 with `.' followed by extensions, followed by full-filenames."
552 ;; concat all the sub-exressions together, making sure all types
553 ;; of parts exist during concatination.
561 "Regular expression matching directorys speedbar will not switch to.
562 Created from `speedbar-ignored-directory-expressions' with the function
563 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
564 Use the function `speedbar-add-ignored-directory-regexp', or customize the
569 "*List of regular expressions matching directories speedbar will ignore.
570 They should included directorys to directories which are notoriously very
571 large and take a long time to load in. Use the function
572 `speedbar-add-ignored-directory-regexp' to add new items to this list after
573 speedbar is loaded. You may place anything you like in this list
574 before speedbar has been loaded."
579 speedbar-ignored-directory-regexp
583 "*Regular expression matching directories not to show in speedbar.
584 They should include commonly existing directories which are not
585 useful, such as version control."
595 ;; backup refdir lockfile
597 "*Regexp matching files we don't want displayed in a speedbar buffer.
601 "Regular expression matching files we know how to expand.
602 Created from `speedbar-supported-extension-expressions' with the
605 ;; this is dangerous to customize, because the defaults will probably
606 ;; change in the future.
612 ;; html is not supported by default, but an imenu tags package
613 ;; is available. Also, html files are nice to be able to see.
614 ".s?html"
616 "*List of regular expressions which will match files supported by tagging.
618 will be stripped by a simplified optimizer when compiled into a
619 singular expression. This variable will be turned into
620 `speedbar-file-regexp' for use with speedbar. You should use the
621 function `speedbar-add-supported-extension' to add a new extension at
622 runtime, or use the configuration dialog to set it in your .emacs
623 file.
624 If you add an extension to this list, and it does not appear, you may
625 need to also modify `completion-ignored-extension' which will also help
626 file completion."
637 "Add EXTENSION as a new supported extension for speedbar tagging.
638 This should start with a `.' if it is not a complete file name, and
640 matchers are allowed however. EXTENSION may be a single string or a
641 list of strings."
646 nil
651 speedbar-supported-extension-expressions)))
654 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
655 This function will modify `speedbar-ignored-directory-regexp' and add
656 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
662 nil
667 speedbar-ignored-directory-expressions)))
669 ;; If we don't have custom, then we set it here by hand.
672 speedbar-supported-extension-expressions)
674 speedbar-ignored-directory-expressions)))
677 "*Non-nil means to automatically update the display.
678 When this is nil then speedbar will not follow the attached frame's directory.
679 When speedbar is active, use:
692 nil
694 ;; turn off paren matching around here.
708 nil
712 ;; control
716 ;; navigation
723 ;; These commands never seemed useful.
724 ;; (define-key speedbar-key-map " " 'speedbar-scroll-up)
725 ;; (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
727 ;; Short cuts I happen to find useful
731 speedbar-previously-used-expansion-list-name)))
740 )
743 "Create a keymap for use with a speedbar major or minor display mode.
744 This basically creates a sparse keymap, and makes it's parent be
745 `speedbar-key-map'."
748 k))
754 nil
757 ;; Basic tree features
769 ;; file based commands
779 )
792 window-system))
796 )
815 ; ["Sort Tags" speedbar-toggle-sorting
816 ; :style toggle :selected speedbar-sort-tags]
817 "----"
838 )
853 "Non-nil when speedbar is showing buttons specific to a special mode.
871 "An association list of directories and their contents.
872 Each sublist was returned by `speedbar-file-lists'. This list is
873 maintained to speed up the refresh rate when switching between
879 \f
880 ;;; Compatibility
881 ;;
893 \f
894 ;;; Mode definitions/ user commands
895 ;;
897 ;;;###autoload
899 ;;;###autoload
901 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
902 nil means toggle. Once the speedbar frame is activated, a buffer in
903 `speedbar-mode' will be displayed. Currently, only one speedbar is
904 supported at a time.
905 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
906 `speedbar-before-delete-hook' is called before the frame is deleted."
908 ;; Get the buffer to play with
914 ;; Do the frame thing
916 'speedbar-frame
917 'speedbar-cached-frame
918 'speedbar-buffer
919 "Speedbar"
920 #'speedbar-frame-mode
923 ;; This is a hack to get speedbar to iconfiy
924 ;; with the selected frame.
926 speedbar-frame-parameters)
927 speedbar-before-delete-hook
928 speedbar-before-popup-hook
929 speedbar-after-create-hook)
930 ;; Start up the timer
936 )
937 ;; Frame modifications
940 ;; hscroll
942 ;; reset the selection variable
946 "Reposition the speedbar frame to be next to the attached frame."
951 speedbar-frame
955 )
959 ;; if left/top were specified in the parameters, pass them
960 ;; down to the reposition function
962 speedbar-frame
966 )
973 "Detach the current Speedbar from auto-updating.
974 Doing this allows the creation of a second speedbar."
980 ;; Permanently disable auto-updating in this speedbar buffer.
983 ;; Make local copies of all the different variables to prevent
984 ;; funny stuff later...
985 )))
988 "Return the frame to use for speedbar based on current context."
992 "Handle a delete frame event E.
993 If the deleted frame is the frame SPEEDBAR is attached to,
994 we need to delete speedbar also."
998 )
1000 ;;;###autoload
1002 "Change frame focus to or from the speedbar frame.
1003 If the selected frame is not speedbar, then speedbar frame is
1004 selected. If the speedbar frame is active, then select the attached frame."
1012 "Return the width of the speedbar frame in characters.
1013 nil if it doesn't exist."
1017 "Major mode for managing a display of directories and tags.
1019 The first line represents the default directory of the speedbar frame.
1020 Each directory segment is a button which jumps speedbar's default
1023 rescan cached items, or pop up new frames.
1025 Each line starting with <+> represents a directory. Click on the <+>
1026 to insert the directory listing into the current tree. Click on the
1027 <-> to retract that list. Click on the directory name to go to that
1028 directory as the default.
1030 Each line starting with [+] is a file. If the variable
1031 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1032 files which don't have imenu support, but are not expressly ignored.
1033 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1034 which is generated from `completion-ignored-extensions'.
1036 Files with a `*' character after their name are files checked out of a
1037 version control system. (Currently only RCS is supported.) New
1038 version control systems can be added by examining the documentation
1039 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1041 Files with a `#' or `!' character after them are source files that
1042 have an object file associated with them. The `!' indicates that the
1043 files is out of date. You can control what source/object associations
1044 exist through the variable `speedbar-obj-alist'.
1046 Click on the [+] to display a list of tags from that file. Click on
1047 the [-] to retract the list. Click on the file name to edit the file
1048 in the attached frame.
1050 If you open tags, you might find a node starting with {+}, which is a
1051 category of tags. Click the {+} to expand the category. Jump-able
1052 tags start with >. Click the name of the tag to go to that position
1053 in the selected file.
1056 ;; NOT interactive
1069 ;; Add in our dframe hooks.
1073 dframe-mouse-click-function #'speedbar-click
1076 speedbar-buffer)
1079 "Like message, but for use in the speedbar frame.
1080 Argument FMT is the format string, and ARGS are the arguments for message."
1084 "Like `y-or-n-p', but for use in the speedbar frame.
1085 Argument PROMPT is the prompt to use.
1086 Optional argument DELETING means this is a query that will delete something.
1087 The variable `speedbar-query-confirmation-method' can cause this to
1088 return true without a query."
1094 "Select the frame attached to this speedbar."
1097 ;; Backwards compatibility
1102 "Set the format of the mode line based on the current speedbar environment.
1103 This gives visual indications of what is up. It EXPECTS the speedbar
1104 frame and window to be the currently active frame and window."
1138 "Reconfigure the menu-bar in a speedbar frame.
1139 Different menu items are displayed depending on the current display mode
1140 and the existence of packages."
1142 speedbar-easymenu-definition-base
1144 ;; file display mode version
1149 'speedbar-easymenu-definition-special
1151 ;; If bound locally, we can use it
1152 speedbar-easymenu-definition-special)))
1153 ;; Dynamic menu stuff
1164 'speedbar-change-initial-expansion-list
1167 :selected
1169 speedbar-initial-expansion-list-name)
1170 )
1171 displays))
1173 displays)))
1174 ;; The trailer
1175 speedbar-easymenu-definition-trailer))
1181 'speedbar-special-mode-key-map
1183 speedbar-special-mode-key-map)
1189 ;; This creates a small keymap we can glom the
1190 ;; menu adjustments into.
1192 ;; Delete the old menu if applicable.
1195 ;; Now add the new menu
1200 ;; XEmacs-specific:
1206 \f
1207 ;;; User Input stuff
1208 ;;
1210 "Customize speedbar using the Custom package."
1219 "For motion EVENT, display info about the current line."
1221 nil
1228 ;; XEmacs may let us get in here in other mode buffers.
1233 "Call the info function for the line under the mouse.
1234 Optional EVENT is currently not used."
1243 "Move to the next ARGth line in a speedbar buffer."
1250 "Move to the previous ARGth line in a speedbar buffer."
1255 "Move to the next ARGth line in a speedbar buffer at the same depth.
1256 This means that movement is restricted to a subnode, and that siblings
1257 of intermediate nodes are skipped."
1259 ;; First find the extent for which we are allowed to move.
1275 ;; We have reached the end of this block.
1285 "Move to the next ARGth line in a speedbar buffer at the same depth.
1286 This means that movement is restricted to a subnode, and that siblings
1287 of intermediate nodes are skipped."
1293 "Move to the previous 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."
1301 "Move across ARG groups of similarly typed items in speedbar.
1302 Stop on the first line of the next type of item, or on the last or first item
1303 if we reach a buffer boundary."
1314 "Move forward over the current list.
1315 A LIST in speedbar is a group of similarly typed items, such as directories,
1316 files, or the directory button."
1322 "Move backward over the current list.
1323 A LIST in speedbar is a group of similarly typed items, such as directories,
1324 files, or the directory button."
1330 "Page down one screen-full of the speedbar, or ARG lines."
1336 "Page up one screen-full of the speedbar, or ARG lines."
1342 "Keyboard accelerator for moving the default directory up one.
1343 Assumes that the current buffer is the speedbar buffer."
1347 \f
1348 ;;; Speedbar file activity (aka creeping featurism)
1349 ;;
1351 "Refresh the current speedbar display, disposing of any cached data.
1352 Argument ARG represents to force a refresh past any caches that may exist."
1356 deactivate-mark)
1357 ;; We need to hack something so this works in detached frames.
1365 ;; Reset the timer in case it got really hosed for some reason...
1371 "Load the item under the cursor or mouse if it is a Lisp file."
1377 ;; If the compiled version exists, load that instead...
1383 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1393 ))
1396 "Provide information about what the user clicked on.
1397 This should be bound to a mouse EVENT."
1403 "Attempt to derive, and then display information about this line item.
1404 File style information is displayed with `speedbar-item-info'."
1407 ;; Skip invisible number info.
1409 ;; Skip items in "folder" type text characters.
1411 ;; Get the text
1416 "Display info in the mini-buffer about the button the mouse is over.
1417 This function can be replaced in `speedbar-mode-functions-list' as
1418 `speedbar-item-info'."
1425 "Display info about a file that is on the current line.
1426 nil if not applicable. If FILENAME, then use that instead of reading
1427 it from the speedbar buffer."
1432 nil)))
1435 "Display info about a tag that is on the current line.
1436 nil if not applicable."
1454 )))
1472 nil t))
1475 nil))))
1485 parent))
1487 ;; Not using `semantic':
1491 nil)))))
1494 "Display info in the mini-buffer about the button the mouse is over."
1502 "Copy the item under the cursor.
1503 Files can be copied to new names or places."
1513 speedbar-shown-directories)))
1514 ;; Create the right file name part
1522 t))
1525 ;; refresh display if the new place is currently displayed.
1531 ))))))
1534 "Rename the item under the cursor or mouse.
1535 Files can be renamed to new names or moved to new directories."
1543 speedbar-shown-directories)))
1544 ;; Create the right file name part
1552 t))
1555 ;; refresh display if the new place is currently displayed.
1560 )))))
1564 "Create a directory in speedbar."
1570 basedir)))
1571 ;; Make the directory
1575 )
1579 "Delete the item under the cursor. Files are removed from disk."
1592 ))
1593 ))
1596 "Delete the object associated from the item under the cursor.
1597 The file is removed from disk. The object is determined from the
1598 variable `speedbar-obj-alist'."
1614 "Enable automatic updating in speedbar via timers."
1621 "Disable automatic updating and stop consuming resources."
1628 "Toggle automatic update for the speedbar frame."
1635 "Toggle use of images in the speedbar frame.
1636 Images are not available in Emacs 20 or earlier."
1642 "Toggle tag sorting."
1647 "Toggle display of files speedbar can not tag."
1653 "Allow the buffer to be writable and evaluate FORMS."
1660 "Insert TEXT as the next logical speedbar button.
1661 FACE is the face to put on the button, MOUSE is the highlight face to use.
1662 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1663 This function assumes that the current buffer is the speedbar buffer.
1664 If PREVLINE, then put this button on the previous line.
1666 This is a convenience function for special modes that create their own
1667 specialized speedbar displays."
1685 "Insert a separation label of TEXT.
1686 Separators are not active, have no labels, depth, or actions."
1694 'speedbar-separator-face
1695 nil nil nil)))
1698 "Create a button from START to END, with FACE as the display face.
1699 MOUSE is the mouse face. When this button is clicked on FUNCTION
1700 will be run with the TOKEN parameter (any Lisp object)"
1710 ;; So far the only text we have is less that 3 chars.
1713 )
1714 \f
1715 ;;; Initial Expansion list management
1716 ;;
1718 "Return the current default expansion list.
1719 This is based on `speedbar-initial-expansion-list-name' referencing
1720 `speedbar-initial-expansion-mode-alist'."
1721 ;; cdr1 - name, cdr2 - menu
1723 speedbar-initial-expansion-mode-alist)))))
1726 "Return the current default menu data.
1727 This is based on `speedbar-initial-expansion-list-name' referencing
1728 `speedbar-initial-expansion-mode-alist'."
1731 speedbar-initial-expansion-mode-alist)))))
1734 "Return the current default menu data.
1735 This is based on `speedbar-initial-expansion-list-name' referencing
1736 `speedbar-initial-expansion-mode-alist'."
1739 speedbar-initial-expansion-mode-alist))))))
1742 "Return a list of functions to call stealthily.
1743 This is based on `speedbar-initial-expansion-list-name' referencing
1744 `speedbar-stealthy-function-list'."
1746 speedbar-stealthy-function-list)))
1749 "Add NEW-LIST to the list of expansion lists."
1753 "Change speedbar's default expansion list to NEW-DEFAULT."
1757 speedbar-previously-used-expansion-list-name)
1758 speedbar-initial-expansion-mode-alist
1759 nil t "" nil
1760 speedbar-previously-used-expansion-list-name)))
1762 speedbar-initial-expansion-list-name
1763 speedbar-initial-expansion-list-name new-default)
1770 "Return a current mode specific replacement for function, or nil.
1771 Scans `speedbar-mode-functions-list' first for the current mode, then
1772 for FUNCTION."
1775 speedbar-mode-functions-list)))))
1778 "Add NEW-LIST to the list of mode functions.
1779 See `speedbar-mode-functions-list' for details."
1782 \f
1783 ;;; Special speedbar display management
1784 ;;
1786 "Quick check function called on BUFFERs by the speedbar timer function.
1787 Maintains the value of local variables which control speedbars use
1788 of the special mode functions."
1793 "Add localized speedbar support to BUFFER's mode if it is available."
1797 nil
1803 nil ;; do nothing to broken mode
1809 ;; If it is autoloaded, we need to load it now so that
1810 ;; we have access to the varialbe -speedbar-menu-items.
1811 ;; Is this XEmacs safe?
1818 nil ;; don't add special keymap
1824 nil ;; don't add special menus
1828 )))))))
1831 "Remove any traces that BUFFER supports speedbar in a specialized way."
1837 \f
1838 ;;; File button management
1839 ;;
1841 "Create file lists for DIRECTORY.
1842 The car is the list of directories, the cdr is list of files not
1843 matching ignored headers. Cache any directory files found in
1844 `speedbar-directory-contents-alist' and use that cache before scanning
1845 the file-system."
1847 ;; If in powerclick mode, then the directory we are getting
1848 ;; should be rescanned.
1851 ;; find the directory, either in the cache, or build it.
1867 nl))
1868 ))
1871 "Insert a single button group at point for DIRECTORY.
1872 Each directory directory part is a different button. If part of the directory
1873 matches the user directory ~, then it is replaced with a ~.
1874 INDEX is not used, but is required by the caller."
1880 dd))
1888 'speedbar-directory-face
1889 'speedbar-highlight-face
1890 'speedbar-directory-buttons-follow
1896 ;; Nuke the beginning of the directory if it's too long...
1924 )))))))
1925 )
1932 'speedbar-directory-face
1933 'speedbar-highlight-face
1934 'speedbar-directory-buttons-follow
1940 exp-button-char exp-button-function
1941 exp-button-data
1942 tag-button tag-button-function tag-button-data
1943 tag-button-face depth)
1944 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
1945 This is the button that expands or contracts a node (if applicable),
1946 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
1947 is the function to call if it's clicked on. Button types are
1948 'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil.
1949 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
1950 button.
1952 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
1953 function to call if clicked on, and TAG-BUTTON-DATA is the data to
1954 attach to the text field (such a tag positioning, etc).
1955 TAG-BUTTON-FACE is a face used for this type of tag.
1957 Lastly, DEPTH shows the depth of expansion.
1959 This function assumes that the cursor is in the speedbar window at the
1960 position to insert a new item, and that the new item will end with a CR."
1981 )
1987 )
1996 tag-button-function tag-button-data))
1997 ))
2000 "Change the expansion button character to CHAR for the current line."
2010 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2011 ;; make sure we fix the image on the text here.
2014 \f
2015 ;;; Build button lists
2016 ;;
2018 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2019 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2020 don't know how to manage them. The input parameter FILES is a cons
2021 cell of the form ( 'DIRLIST . 'FILELIST )."
2022 ;; Start inserting all the directories
2042 "Insert files for DIRECTORY with level INDEX at point."
2047 ;; If the shown files variable has extra directories, then
2048 ;; it is our responsibility to redraw them all
2049 ;; Luckilly, the nature of inserting items into this list means
2050 ;; that by reversing it, we can easilly go in the right order
2054 ;; exand them all as we find them
2064 )))
2065 ;;; Generic List support
2066 ;;
2067 ;; Generic lists are hierarchies of tags which we may need to permute
2068 ;; in order to make it look nice.
2069 ;;
2070 ;; A generic list is of the form:
2071 ;; ( ("name" . marker-or-number) <-- one tag at this level
2072 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2073 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2075 "Non-nil if SUBLST is a group.
2076 Groups may optionally contain a position."
2081 )))
2086 )))
2089 "Non-nil of SUBLST is a group with a position."
2097 ))))
2100 "Non nil if SUBLST is a tag."
2104 ;; For semantic/bovine items, this is needed
2106 ))
2109 "Sort all elements of tag hierarchy LST."
2114 "A wrapper for `try-completion'.
2115 Passes STRING and ALIST to `try-completion' if ALIST
2116 passes some tests."
2120 nil))
2123 "Prefix group names for tag hierarchy LST."
2135 ;; Do nothing. Too short to bother with.
2136 lst
2137 ;; Break out sub-lists
2143 ;; Reverse newlst because it was made backwards.
2144 ;; Sublist doesn't need reversing because the act
2145 ;; of binning things will reverse it for us.
2147 sublst sublst)
2148 ;; Now, first find out how long our list is. Never let a
2149 ;; list get-shorter than our minimum.
2153 ;; Sort the whole list into bins.
2158 ;; 0 storage bin for shorty.
2161 ;; stuff into a bin based on ascii value at diff
2165 ;; Go through all our bins Stick singles into our
2166 ;; junk-list, everything else as sublsts in work-list.
2167 ;; If two neighboring lists are both small, make a grouped
2168 ;; group combinding those two sub-lists.
2171 ;; The bins contents are currently in forward order.
2177 speedbar-tag-split-minimum-length))
2179 ;; We have reached a longer list, so we
2180 ;; must finish off a grouped group.
2184 num-shorts-grouped))
2185 ;; All singles? Junk list
2187 junk-list)))
2189 ;; Only one short group? Just stick it in
2190 ;; there by itself. Make a group, and find
2191 ;; a subexpression
2195 speedbar-tag-group-name-minimum-length)
2198 " ("
2205 short-group-list)
2206 work-list ))))
2208 ;; Multiple groups to be named in a special
2209 ;; way by displaying the range over which we
2210 ;; have grouped them.
2213 " to "
2214 short-end-name)
2215 short-group-list)
2216 work-list))))
2217 ;; Reset short group list information every time.
2219 short-start-name nil
2220 short-end-name nil
2222 ;; Ok, now that we cleaned up the short-group-list,
2223 ;; we can deal with this new list, to decide if it
2224 ;; should go on one of these sub-lists or not.
2230 short-start-name
2234 ;; Did we run out of things? Drop our new list onto the end.
2237 ;; All singles? Junk list
2240 ;; Only one short group? Just stick it in
2241 ;; there by itself.
2244 short-group-list)
2245 work-list)))
2247 ;; Multiple groups to be named in a special
2248 ;; way by displaying the range over which we
2249 ;; have grouped them.
2252 short-group-list)
2253 work-list))))
2254 ;; Reverse the work list nreversed when consing.
2256 ;; Now, stick our new list onto the end of
2264 "Trim all words in a tag hierarchy.
2265 Base trimming information on word separators, and group names.
2266 Argument LST is the list of tags to trim."
2277 ;; Get the prefix to trim by. Make sure that we don't trim
2278 ;; off silly pieces, only complete understandable words.
2292 trimlst)
2294 ;; Put the lists together
2298 "Create a simple 'Tags' group with orphaned tags.
2299 Argument LST is the list of tags to sort into groups."
2313 "Adjust the tag hierarchy in LST, and return it.
2314 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2315 the list."
2322 speedbar-tag-hierarchy-method)
2323 speedbar-tag-hierarchy-method))
2326 lst)))
2330 lst))
2333 "The type of button created for groups of tags.
2334 Good values for this are `curly' and `expandtag'.
2338 "The type of button created for tags in generic lists.
2339 Good values for this are nil and `statictag'.
2343 "At LEVEL, insert a generic multi-level alist LST.
2344 Associations with lists get {+} tags (to expand into more nodes) and
2345 those with positions just get a > as the indicator. {+} buttons will
2346 have the function EXPAND-FUN and the token is the CDR list. The token
2347 name will have the function FIND-FUN and not token."
2348 ;; Remove imenu rescan button
2351 ;; Get, and set up variables that define how we treat these tags.
2355 expand-button tag-button)
2360 tag-button speedbar-generic-list-tag-button-type))
2361 ;; Adjust the list.
2363 ;; insert the parts
2368 nil nil nil ;no expand button data
2370 find-fun ;function
2372 'speedbar-tag-face
2378 find-fun ;function
2380 'speedbar-tag-face
2386 nil nil 'speedbar-tag-face
2389 ))
2393 "At level INDENT, insert the imenu generated LST."
2395 'speedbar-tag-expand
2399 "At level INDENT, insert the etags generated LST."
2401 'speedbar-tag-expand
2403 \f
2404 ;;; Timed functions
2405 ;;
2407 "Generically update the contents of the speedbar buffer."
2409 ;; Set the current special buffer
2412 ;; Check for special modes
2415 ;; Choose the correct method of doodling.
2418 speedbar-special-mode-expansion-list
2420 'speedbar-special-mode-expansion-list
2422 ;;(eq (get major-mode 'mode-class 'special)))
2427 "Update the contents of the speedbar buffer for the current situation."
2428 ;; Due to the historical growth of speedbar, we need to do something
2429 ;; special for "files" mode. Too bad.
2432 )
2434 ;; Do all the files type work. It still goes through the
2435 ;; expansion list stuff. :(
2437 speedbar-shown-directories)
2440 speedbar-ignored-directory-regexp
2442 nil
2445 default-directory))
2450 default-directory)
2452 ;; Else, we can do a short cut. No text cache.
2454 )
2464 ))))
2467 "Update the contents of the speedbar buffer based on the current directory."
2472 cbd-parent
2475 ;; disable stealth during update
2479 ;; Because there is a bug I can't find just yet
2482 ;; If we are updating contents to where we are, then this is
2483 ;; really a request to update existing contents, so we must be
2484 ;; careful with our text cache!
2488 ;; If the current directory is not the last element in the dir
2489 ;; list, then we ALSO need to zap the list of expanded directories
2493 ;; Build cbd-parent, and see if THAT is in the current shown
2494 ;; directories. First, go through pains to get the parent directory
2505 ;; If this directory is NOT in the current list of available
2506 ;; directorys, then use the cache, and set the cache to our new
2507 ;; value. Make sure to unhighlight the current file, or if we
2508 ;; come back to this directory, it might be a different file
2509 ;; and then we get a mess!
2516 ;; Check if our new directory is in the list of directories
2517 ;; shown in the text-cache
2520 use-cache t)
2521 ;; default the shown directories to this list...
2523 ))
2527 ;; Find this directory as a speedbar node.
2529 ;; Open it.
2535 speedbar-shown-directories))
2546 "Use the mode-specific variable to fill in the speedbar buffer.
2547 This should only be used by modes classified as special."
2553 ;; If we are leaving a directory, cache it.
2555 ;; Do nothing
2556 nil
2557 ;; Clean up directory maintenance stuff
2561 speedbar-shown-directories nil))
2562 ;; Now fill in the buffer with our newly found specialized list.
2565 ;; We do not erase the buffer because these functions may
2566 ;; decide NOT to update themselves.
2574 "Set up the speedbar timer with TIMEOUT.
2575 Uses `dframe-set-timer'.
2576 Also resets scanner functions."
2578 ;; Apply a revert hook that will reset the scanners. We attach to revert
2579 ;; because most reverts occur during VC state change, and this lets our
2580 ;; VC scanner fix itself.
2584 ;; change this if it changed for some reason
2588 "Run whenever Emacs is idle to update the speedbar item."
2592 ;; Save all the match data so that we don't mess up executing fns
2594 ;; Only do stuff if the frame is visible, not an icon, and if
2595 ;; it is currently flagged to do something.
2603 ;; make sure we at least choose a window to
2604 ;; get a good directory from
2606 nil
2607 ;; Check for special modes
2609 ;; Update for special mode all the time!
2612 speedbar-special-mode-expansion-list
2614 'speedbar-special-mode-expansion-list
2616 ;;(eq (get major-mode 'mode-class 'special)))
2620 "Updating speedbar to special mode: %s..."
2621 major-mode))
2626 "Updating speedbar to special mode: %s...done"
2627 major-mode)
2629 ;; Update all the contents if directories change!
2633 nil
2635 ))
2637 ;; Now run stealthy updates of time-consuming items
2641 \f
2642 ;;; Stealthy activities
2643 ;;
2648 "For a given speedbar, run all items in the stealthy function list.
2649 Each item returns t if it completes successfully, or nil if
2650 interrupted by the user."
2657 ;;(sit-for 0)
2659 ;;(speedbar-message "Exit with %S" (car l))
2660 ))))
2663 "Reset any variables used by functions in the stealthy list as state.
2664 If new functions are added, their state needs to be updated here."
2666 speedbar-obj-to-do-point t
2667 speedbar-ro-to-do-point t)
2669 )
2672 "Go to the line where FILE is."
2681 nil t))
2698 "Locate the file thought to be current, and remove its highlighting."
2700 ;;(set-buffer speedbar-buffer)
2706 'face
2710 "Find the current file, and update our visuals to indicate its name.
2711 This is specific to file names. If the file name doesn't show up, but
2712 it should be in the list, then the directory cache needs to be
2713 updated."
2719 nil)))
2721 rf)))
2727 ;; check here, that way we won't refresh to newcf until
2728 ;; its been written, thus saving ourselves some time
2732 ;; It is important to select the frame, otherwise the window
2733 ;; we want the cursor to move in will not be updated by the
2734 ;; search-forward command.
2736 ;; Remove the old file...
2738 ;; now highlight the new one.
2739 ;; (set-buffer speedbar-buffer)
2742 ;; put the property on it
2745 'face
2747 ;; Oops, it's not in the list. Should it be?
2751 ;; yes, it is (we will ignore unknowns for now...)
2755 ;; put the property on it
2758 'face
2760 ;; if it's not in there now, whatever...
2761 ))
2766 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2767 ;;doesn't need to be in. We don't want to recenter when we are
2768 ;;updating files.
2770 ;;(speedbar-center-buffer-smartly)
2773 ))
2776 )))
2777 ;; return that we are done with this activity.
2778 t)
2781 "Add INDICATOR-STRING to the end of this speedbar line.
2782 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2783 the existing indicator is removed. If there is already an
2784 indicator, then do not add a space."
2786 ;; The nature of the beast: Assume we are in "the right place"
2789 speedbar-object-read-only-indicator
2800 t))
2807 ))))
2810 "Scan all the files in a directory, and for each see if it is read only."
2811 ;; Check for to-do to be reset. If reset but no RCS is available
2812 ;; then set to nil (do nothing) otherwise, start at the beginning
2822 nil t))
2828 speedbar-object-read-only-indicator
2832 speedbar-object-read-only-indicator))))))
2834 ;; return that we are incomplete
2835 nil
2836 ;; we are done, set to-do to nil
2838 ;; and return t
2839 t))
2840 t)))
2842 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2843 ;; Steven L Baur <steve@xemacs.org> said this was important:
2849 "Scan all files in a directory, and for each see if it's checked out.
2850 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2851 to add more types of version control systems."
2852 ;; Check for to-do to be reset. If reset but no RCS is available
2853 ;; then set to nil (do nothing) otherwise, start at the beginning
2862 'ange-ftp-directory-format
2865 ;; efs support: Bob Weiner
2870 reg
2879 nil t))
2887 ;; return that we are incomplete
2888 nil
2889 ;; we are done, set to-do to nil
2891 ;; and return t
2892 t))
2893 t)))
2896 "Return t if the file on this line is check of of a version control system.
2897 Parameter DEPTH is a string with the current depth of indentation of
2898 the file being checked."
2902 ;; Skip-chars: thanks ptype@dra.hmg.gb
2915 "Return t if we should bother checking DIRECTORY for version control files.
2916 This can be overloaded to add new types of version control systems."
2918 ;; Local CVS available in Emacs 21
2921 ;; Local RCS
2923 ;; Local SCCS
2925 ;; Remote SCCS project
2929 nil))
2930 ;; User extension
2932 directory)
2933 ))
2936 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2937 You can add new VC systems by overriding this function. You can
2938 optimize this function by overriding it and only doing those checks
2939 that will occur on your system."
2942 ;; Emacs 21 handles VC state in a nice way.
2947 ;; An error means not in a VC system
2950 ;; RCS file name
2953 ;; Local SCCS file name
2955 ;; Remote SCCS file name
2959 nil))))
2960 ;; User extension
2962 ))
2964 ;; Objet File scanning
2966 "Scan all files in a directory, and for each see if there is an object.
2967 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2968 to add more object types."
2969 ;; Check for to-do to be reset. If reset but no RCS is available
2970 ;; then set to nil (do nothing) otherwise, start at the beginning
2980 nil t))
2989 ;; return that we are incomplete
2990 nil
2991 ;; we are done, set to-do to nil
2993 ;; and return t
2994 t))
2995 t)))
2998 "Return t if the file on this line has an associated object.
2999 Parameter DEPTH is a string with the current depth of indentation of
3000 the file being checked."
3004 ;; Skip-chars: thanks ptype@dra.hmg.gb
3018 nil
3019 ;; Find out if the object is out of date or not.
3029 \f
3030 ;;; Clicking Activity
3031 ;;
3033 "Position the cursor on a line."
3041 "Activate any speedbar buttons where the mouse is clicked.
3042 This must be bound to a mouse event. A button is any location of text
3043 with a mouse face that has a text property called `speedbar-function'.
3044 Argument E is the click event."
3045 ;; Backward compatibility let statement.
3051 "Look under the cursor and examine the text properties.
3052 From this extract the file/tag name, token, indentation level and call
3053 a function if appropriate."
3057 ;; The 1-,+ is safe because scaning starts AFTER the point
3058 ;; specified. This lets the search include the character the
3059 ;; cursor is on.
3072 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3075 \f
3076 ;;; Reading info from the speedbar buffer
3077 ;;
3079 "Retrieve the text after prefix junk for the current line.
3080 Optional argument P is where to start the search from."
3087 nil)))
3090 "Retrieve the token information after the prefix junk for the current line.
3091 Optional argument P is where to start the search from."
3101 nil)))
3104 "Retrieve the file or whatever from the line at point P.
3105 The return value is a string representing the file. If it is a
3106 directory, then it is the directory name."
3116 nil))
3117 nil)))))
3120 "If FILE is displayed, go to this line and return t.
3121 Otherwise do not move and return nil."
3127 ;; scan all the directories
3133 nil t))
3137 ;; find the file part
3139 ;; only had a dir part
3143 t)
3145 ;; find the file part
3150 nil t)
3153 t)
3155 nil))))))
3158 "Retrieve the directory name associated with the current line.
3159 This may require traversing backwards from DEPTH and combining the default
3160 directory with these items. This function is replaceable in
3161 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3168 "Retrieve the directoryname associated with the current line.
3169 This may require traversing backwards from DEPTH and combining the default
3170 directory with these items."
3185 "/"
3186 directory)))
3188 ;; This is the start of our directory.
3193 directory))
3198 "Position the cursor on the line specified by DIRECTORY."
3212 nil t))
3222 "Edit whatever tag or file is on the current speedbar line."
3226 ;; If this fails, then it is a non-standard click, and as such,
3227 ;; perfectly allowed.
3230 t)
3234 nil))
3238 "Expand the line under the cursor.
3239 With universal argument ARG, flush cached data."
3253 "Expand the line under the cursor and flush any cached information."
3258 "Contract the line under the cursor."
3270 "Contract or expand the line under the cursor."
3282 "Expand the line under the cursor and all descendants.
3283 Optional argument ARG indicates that any cache should be flushed."
3286 ;; Now, inside the area expaded here, expand all subnodes of
3287 ;; the same descendant type.
3297 )
3300 "Expand the line under the cursor and all descendants."
3303 ;; Don't need to do anything else since all descendants are
3304 ;; hidden by default anyway. Yay! It's easy.
3305 )
3308 "Speedbar click handler for filenames.
3309 TEXT, the file will be displayed in the attached frame.
3310 TOKEN is unused, but required by the click handler. INDENT is the
3311 current indentation level."
3313 ;; Run before visiting file hook here.
3321 ;; Reset the timer with a new timeout when cliking a file
3322 ;; in case the user was navigating directories, we can cancel
3323 ;; that other timer.
3328 "Speedbar click handler for directory names.
3329 Clicking a directory will cause the speedbar to list files in
3330 the subdirectory TEXT. TOKEN is an unused requirement. The
3331 subdirectory chosen will be at INDENT level."
3335 ;; Because we leave speedbar as the current buffer,
3336 ;; update contents will change directory without
3337 ;; having to touch the attached frame. Turn off smart expand just
3338 ;; in case.
3346 "Delete text from point to indentation level INDENT or greater.
3347 Handles end-of-sublist smartly."
3360 "Speedbar click handler for directory expand button.
3361 Clicking this button expands or contracts a directory. TEXT is the
3362 button clicked which has either a + or -. TOKEN is the directory to be
3363 expanded. INDENT is the current indentation level."
3368 speedbar-shown-directories))
3390 )
3396 "Speedbar click handler for default directory buttons.
3397 TEXT is the button clicked on. TOKEN is the directory to follow.
3398 INDENT is the current indentation level and is unused."
3402 ;; Because we leave speedbar as the current buffer,
3403 ;; update contents will change directory without
3404 ;; having to touch the attached frame.
3409 "The cursor is on a selected line. Expand the tags in the specified file.
3410 The parameter TEXT and TOKEN are required, where TEXT is the button
3411 clicked, and TOKEN is the file to expand. INDENT is the current
3412 indentation level."
3415 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 cliking 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
3454 string. TOKEN will be the list, and INDENT is the current indentation
3455 level."
3468 \f
3469 ;;; Loading files into the attached frame.
3470 ;;
3472 "*Specify how to select a frame for displaying a file.
3473 A value of 'attached means to use the attached frame (the frame
3474 that speedbar was started from.) A number such as 1 or -1 means to
3475 pass that number to `other-frame' while selecting a frame from speedbar."
3480 "This will load FILE into the speedbar attached frame.
3481 If the file is being displayed in a different frame already, then raise that
3482 frame instead."
3495 )
3497 ;;; Centering Utility
3498 ;;
3500 "Recenter a speedbar buffer so the current indentation level is all visible.
3501 This assumes that the cursor is on a file, or tag of a file which the user is
3502 interested in."
3512 ;; whole buffer fits
3518 ;; too big
3542 ;; Now work out the details of centering
3547 ;; We can't fit it all, so just center on cursor
3550 ;; we can fit everything on the screen, but...
3553 ;; we are all set!
3554 nil
3555 ;; we need to do something...
3561 newcent))
3566 \f
3567 ;;; Tag Management -- List of expanders:
3568 ;;
3570 "Return a list of tags generated dynamically from FILE.
3571 This uses the entries in `speedbar-dynamic-tags-function-list'
3572 to find the proper tags. It is up to each of those individual
3573 functions to do caching and flushing if appropriate."
3575 ;; If a file is in memory, switch to that buffer. This allows
3576 ;; us to use the local variable. If the file is on disk, we
3577 ;; can try a few of the defaults that can get tags without
3578 ;; opening the file.
3581 ;; If there is a buffer-local value of
3582 ;; speedbar-dynamic-tags-function-list, it will now be available.
3589 t))
3593 ;; No valid tag list, return nil
3594 nil
3595 ;; We have some tags. Return the list with the insert fn
3596 ;; prepended
3599 ;;; Tag Management -- Imenu
3600 ;;
3603 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.
3652 "*List of arguments to use with `speedbar-fetch-etags-command'.
3653 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3654 modify this list conveniently.
3659 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3660 FLAG then becomes a member of etags command line arguments. If flag
3663 `speedbar-show-unknown-files'.
3665 This function is a convenience function for XEmacs menu created by
3666 Farzin Guilak <farzin@protocol.com>."
3683 "For FILE, run etags and create a list of symbols extracted.
3684 Each symbol will be associated with its line position in FILE."
3717 )
3722 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3723 ;; sure it's needed with the different sorting method.
3724 ;;
3725 ;(defun speedbar-clean-etags()
3726 ; "Removes spaces before the ^? character, and removes `#define',
3727 ;return types, etc. preceding tags. This ensures that the sort operation
3728 ;works on the tags, not the return types."
3729 ; (save-excursion
3730 ; (goto-char (point-min))
3731 ; (while
3732 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3733 ; (replace-match "\C-?" nil nil))
3734 ; (goto-char (point-min))
3735 ; (while
3736 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3737 ; (delete-region (match-beginning 1) (match-end 1)))))
3740 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3741 The line should contain output from etags. Parse the output using the
3742 regular expression EXPR."
3755 t)))
3763 nil)))
3766 "Parse a C or C++ tag, which tends to be a little complex."
3779 )))
3782 "Parse a Tex string. Only find data which is relevant."
3790 \f
3791 ;;; BUFFER DISPLAY mode.
3792 ;;
3797 nil
3800 ;; Basic tree features
3808 ;; Buffer specific keybindings
3812 )
3831 )
3835 "Create speedbar buttons based on the buffers currently loaded.
3836 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3840 "Create speedbar buttons based on the buffers currently loaded.
3841 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3845 "Create speedbar buffer buttons.
3846 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3852 nil
3862 'speedbar-buffer-click temp
3870 nil
3872 nil
3875 'speedbar-buffer-click temp
3880 ;;(speedbar-insert-separator "Hidden Buffers:")
3881 ;;(while bl
3882 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3883 ;; nil
3884 ;; (if (eq (car bl) speedbar-buffer)
3885 ;; nil
3886 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3887 ;; (buffer-name (car bl))
3888 ;; 'speedbar-buffer-click temp
3889 ;; 'speedbar-file-face 0)
3890 ;; (speedbar-buffers-tail-notes (car bl))))
3891 ;; (setq bl (cdr bl)))
3892 ))
3895 "Add a note to the end of the last tag line.
3896 Argument BUFFER is the buffer being tested."
3901 ro buffer-read-only))
3905 "Display information about the current buffer on the current line."
3912 item
3919 "Fetch the full directory to the file (buffer) specified on the current line.
3920 Optional argument DEPTH specifies the current depth of the back search."
3924 ;; Buffers are always at level 0
3926 nil
3934 default-directory)
3939 "When the users clicks on a buffer-button in speedbar.
3940 TEXT is the buffer's name, TOKEN and INDENT are unused."
3946 speedbar-previously-used-expansion-list-name))))
3949 "Kill the buffer the cursor is on in the speedbar buffer."
3959 "Revert the buffer the cursor is on in the speedbar buffer."
3963 ;; If this fails, then it is a non-standard click, and as such,
3964 ;; perfectly allowed
3967 t)
3978 \f
3979 ;;; Useful hook values and such.
3980 ;;
3985 "Highlight the current line, unhighlighting a previously jumped to line."
3995 )
3998 "Unhighlight the currently highlighted line."
4006 "Recenter the current buffer so POINT is on the top of the window."
4010 "Recenter the current buffer so POINT is in the center of the window."
4013 \f
4014 ;;; Color loading section.
4015 ;;
4020 "Face used for +/- buttons."
4028 "Face used for file names."
4035 "Face used for directory names."
4041 "Face used for displaying tags."
4049 "Face used to underline the file in the active window."
4062 "Face used for highlighting buttons with the mouse."
4083 "Face used for separator labes in a display."
4086 ;; some edebug hooks
4091 ;; Fix a font lock problem for some versions of Emacs
4095 )
4096 )
4098 \f
4099 ;;; Obsolete variables and functions
4124 ;; run load-time hooks
4127 ;; arch-tag: 4477e6d1-f78c-48b9-a503-387d3c9767d5
4128 ;;; speedbar ends here