| blob | a48f480a756a8e92864689731b682426e098d027 |
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 "*Default position of the speedbar frame.
336 Possible values are 'left, 'right or 'left-right.
337 If value is 'left-right, the most suitable location is
338 determined automatically."
345 "*If non-nil, sort tags in the speedbar display. *Obsolete*.
346 Use `semantic-tag-hierarchy-method' instead."
352 speedbar-trim-words-tag-hierarchy)
353 "*List of hooks which speedbar will use to organize tags into groups.
354 Groups are defined as expandable meta-tags. Imenu supports
355 such things in some languages, such as separating variables from
356 functions. Each hook takes one argument LST, and may destructively
357 create a new list of the same form. LST is a list of elements of the
358 form:
359 (ELT1 ELT2 ... ELTn)
360 where each ELT is of the form
361 (TAG-NAME-STRING . NUMBER-OR-MARKER)
362 or
363 (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
367 speedbar-trim-words-tag-hierarchy
368 speedbar-simple-group-tag-hierarchy
369 speedbar-sort-tag-hierarchy)
370 )
373 "*The minimum length of a prefix group name before expanding.
374 Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group'
375 and one such groups common characters is less than this number of
376 characters, then the group name will be changed to the form of:
377 worda to wordb
378 instead of just
379 word
380 This way we won't get silly looking listings."
385 "*Minimum length before we stop trying to create sub-lists in tags.
386 This is used by all tag-hierarchy methods that break large lists into
387 sub-lists."
392 "*Maximum length of submenus that are regrouped.
393 If the regrouping option is used, then if two or more short subgroups
394 are next to each other, then they are combined until this number of
395 items is reached."
400 "*Indicates how the directory button will be displayed.
401 Possible values are:
402 'span - span large directories over multiple lines.
403 'trim - trim large directories to only show the last few.
404 nil - no trimming."
407 span)
409 trim)
413 "*Non-nil means speedbar should use smart expansion.
414 Smart expansion only affects when speedbar wants to display a
415 directory for a file in the attached frame. When smart expansion is
416 enabled, new directories which are children of a displayed directory
417 are expanded in the current framework. If nil, then the current
418 hierarchy would be replaced with the new directory."
423 "*When sub-nodes are expanded, the number of spaces used for indentation."
428 "*Non-nil means speedbar will hide the brackets around the + or -."
433 "*Hooks called before popping up the speedbar frame."
438 "*Hooks called before popping up the speedbar frame."
443 "*Hooks called before deleting the speedbar frame."
448 "*Hooks called after creating a speedbar buffer."
453 "*Hooks called after running the speedbar timer function."
458 "*Verbosity level of the speedbar. 0 means say nothing.
459 1 means medium level verbosity. 2 and higher are higher levels of
460 verbosity."
468 "*Non-nil check all files in speedbar to see if they have been checked out.
469 Any file checked out is marked with `speedbar-vc-indicator'."
474 "Text used to mark files which are currently checked out.
475 Other version control systems can be added by examining the function
479 "*Return non-nil if the current directory should be checked for Version Control.
480 Functions in this hook must accept one parameter which is the directory
481 being checked."
486 "*Return non-nil if the specified file is under Version Control.
487 Functions in this hook must accept two parameters. The DIRECTORY of the
488 current file, and the FILENAME of the file being checked."
496 "*Non-nil check all files in speedbar to see if they have an object file.
497 Any file checked out is marked with `speedbar-obj-indicator', and the
498 marking is based on `speedbar-obj-alist'"
506 "Text used to mark files that have a corresponding hidden object file.
507 The car is for an up-to-date object. The cdr is for an out of date object.
525 ;; Note: Look for addition place to add indicator lists that
526 ;; use skip-chars instead of a regular expression.
538 "Regular expression used when identifying files.
542 "*Hook called whenever generic scanners are reset.
543 Set this to implement your own scanning / rescan safe functions with
544 state data."
552 "Takes EXTLIST, a list of extensions and transforms it into regexp.
553 All the preceding `.' are stripped for an optimized expression starting
554 with `.' followed by extensions, followed by full-filenames."
562 ;; concat all the sub-exressions together, making sure all types
563 ;; of parts exist during concatination.
571 "Regular expression matching directorys speedbar will not switch to.
572 Created from `speedbar-ignored-directory-expressions' with the function
573 `speedbar-extension-list-to-regex' (A misnamed function in this case.)
574 Use the function `speedbar-add-ignored-directory-regexp', or customize the
579 "*List of regular expressions matching directories speedbar will ignore.
580 They should included directorys to directories which are notoriously very
581 large and take a long time to load in. Use the function
582 `speedbar-add-ignored-directory-regexp' to add new items to this list after
583 speedbar is loaded. You may place anything you like in this list
584 before speedbar has been loaded."
589 speedbar-ignored-directory-regexp
593 "*Regular expression matching directories not to show in speedbar.
594 They should include commonly existing directories which are not
595 useful, such as version control."
605 ;; backup refdir lockfile
607 "*Regexp matching files we don't want displayed in a speedbar buffer.
611 "Regular expression matching files we know how to expand.
612 Created from `speedbar-supported-extension-expressions' with the
615 ;; this is dangerous to customize, because the defaults will probably
616 ;; change in the future.
622 ;; html is not supported by default, but an imenu tags package
623 ;; is available. Also, html files are nice to be able to see.
624 ".s?html"
626 "*List of regular expressions which will match files supported by tagging.
628 will be stripped by a simplified optimizer when compiled into a
629 singular expression. This variable will be turned into
630 `speedbar-file-regexp' for use with speedbar. You should use the
631 function `speedbar-add-supported-extension' to add a new extension at
632 runtime, or use the configuration dialog to set it in your .emacs
633 file.
634 If you add an extension to this list, and it does not appear, you may
635 need to also modify `completion-ignored-extension' which will also help
636 file completion."
647 "Add EXTENSION as a new supported extension for speedbar tagging.
648 This should start with a `.' if it is not a complete file name, and
650 matchers are allowed however. EXTENSION may be a single string or a
651 list of strings."
656 nil
661 speedbar-supported-extension-expressions)))
664 "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
665 This function will modify `speedbar-ignored-directory-regexp' and add
666 DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
672 nil
677 speedbar-ignored-directory-expressions)))
679 ;; If we don't have custom, then we set it here by hand.
682 speedbar-supported-extension-expressions)
684 speedbar-ignored-directory-expressions)))
687 "*Non-nil means to automatically update the display.
688 When this is nil then speedbar will not follow the attached frame's directory.
689 When speedbar is active, use:
702 nil
704 ;; turn off paren matching around here.
718 nil
722 ;; control
726 ;; navigation
733 ;; These commands never seemed useful.
734 ;; (define-key speedbar-key-map " " 'speedbar-scroll-up)
735 ;; (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
737 ;; Short cuts I happen to find useful
741 speedbar-previously-used-expansion-list-name)))
750 )
753 "Create a keymap for use with a speedbar major or minor display mode.
754 This basically creates a sparse keymap, and makes it's parent be
755 `speedbar-key-map'."
758 k))
764 nil
767 ;; Basic tree features
779 ;; file based commands
789 )
802 window-system))
806 )
825 ; ["Sort Tags" speedbar-toggle-sorting
826 ; :style toggle :selected speedbar-sort-tags]
827 "----"
848 )
863 "Non-nil when speedbar is showing buttons specific to a special mode.
881 "An association list of directories and their contents.
882 Each sublist was returned by `speedbar-file-lists'. This list is
883 maintained to speed up the refresh rate when switching between
889 \f
890 ;;; Compatibility
891 ;;
903 \f
904 ;;; Mode definitions/ user commands
905 ;;
907 ;;;###autoload
909 ;;;###autoload
911 "Enable or disable speedbar. Positive ARG means turn on, negative turn off.
912 nil means toggle. Once the speedbar frame is activated, a buffer in
913 `speedbar-mode' will be displayed. Currently, only one speedbar is
914 supported at a time.
915 `speedbar-before-popup-hook' is called before popping up the speedbar frame.
916 `speedbar-before-delete-hook' is called before the frame is deleted."
918 ;; Get the buffer to play with
924 ;; Do the frame thing
926 'speedbar-frame
927 'speedbar-cached-frame
928 'speedbar-buffer
929 "Speedbar"
930 #'speedbar-frame-mode
933 ;; This is a hack to get speedbar to iconfiy
934 ;; with the selected frame.
936 speedbar-frame-parameters)
937 speedbar-before-delete-hook
938 speedbar-before-popup-hook
939 speedbar-after-create-hook)
940 ;; Start up the timer
946 )
947 ;; Frame modifications
950 ;; hscroll
952 ;; reset the selection variable
956 "Reposition the speedbar frame to be next to the attached frame."
961 speedbar-frame
965 )
969 ;; if left/top were specified in the parameters, pass them
970 ;; down to the reposition function
972 speedbar-frame
976 )
980 speedbar-default-position))))
983 "Detach the current Speedbar from auto-updating.
984 Doing this allows the creation of a second speedbar."
990 ;; Permanently disable auto-updating in this speedbar buffer.
993 ;; Make local copies of all the different variables to prevent
994 ;; funny stuff later...
995 )))
998 "Return the frame to use for speedbar based on current context."
1002 "Handle a delete frame event E.
1003 If the deleted frame is the frame SPEEDBAR is attached to,
1004 we need to delete speedbar also."
1008 )
1010 ;;;###autoload
1012 "Change frame focus to or from the speedbar frame.
1013 If the selected frame is not speedbar, then speedbar frame is
1014 selected. If the speedbar frame is active, then select the attached frame."
1022 "Return the width of the speedbar frame in characters.
1023 nil if it doesn't exist."
1027 "Major mode for managing a display of directories and tags.
1029 The first line represents the default directory of the speedbar frame.
1030 Each directory segment is a button which jumps speedbar's default
1033 rescan cached items, or pop up new frames.
1035 Each line starting with <+> represents a directory. Click on the <+>
1036 to insert the directory listing into the current tree. Click on the
1037 <-> to retract that list. Click on the directory name to go to that
1038 directory as the default.
1040 Each line starting with [+] is a file. If the variable
1041 `speedbar-show-unknown-files' is t, the lines starting with [?] are
1042 files which don't have imenu support, but are not expressly ignored.
1043 Files are completely ignored if they match `speedbar-file-unshown-regexp'
1044 which is generated from `completion-ignored-extensions'.
1046 Files with a `*' character after their name are files checked out of a
1047 version control system. (Currently only RCS is supported.) New
1048 version control systems can be added by examining the documentation
1049 for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
1051 Files with a `#' or `!' character after them are source files that
1052 have an object file associated with them. The `!' indicates that the
1053 files is out of date. You can control what source/object associations
1054 exist through the variable `speedbar-obj-alist'.
1056 Click on the [+] to display a list of tags from that file. Click on
1057 the [-] to retract the list. Click on the file name to edit the file
1058 in the attached frame.
1060 If you open tags, you might find a node starting with {+}, which is a
1061 category of tags. Click the {+} to expand the category. Jump-able
1062 tags start with >. Click the name of the tag to go to that position
1063 in the selected file.
1066 ;; NOT interactive
1079 ;; Add in our dframe hooks.
1083 dframe-mouse-click-function #'speedbar-click
1086 speedbar-buffer)
1089 "Like message, but for use in the speedbar frame.
1090 Argument FMT is the format string, and ARGS are the arguments for message."
1094 "Like `y-or-n-p', but for use in the speedbar frame.
1095 Argument PROMPT is the prompt to use.
1096 Optional argument DELETING means this is a query that will delete something.
1097 The variable `speedbar-query-confirmation-method' can cause this to
1098 return true without a query."
1104 "Select the frame attached to this speedbar."
1107 ;; Backwards compatibility
1112 "Set the format of the mode line based on the current speedbar environment.
1113 This gives visual indications of what is up. It EXPECTS the speedbar
1114 frame and window to be the currently active frame and window."
1119 speedbar-buffer)
1149 "Reconfigure the menu-bar in a speedbar frame.
1150 Different menu items are displayed depending on the current display mode
1151 and the existence of packages."
1153 speedbar-easymenu-definition-base
1155 ;; file display mode version
1160 'speedbar-easymenu-definition-special
1162 ;; If bound locally, we can use it
1163 speedbar-easymenu-definition-special)))
1164 ;; Dynamic menu stuff
1175 'speedbar-change-initial-expansion-list
1178 :selected
1180 speedbar-initial-expansion-list-name)
1181 )
1182 displays))
1184 displays)))
1185 ;; The trailer
1186 speedbar-easymenu-definition-trailer))
1192 'speedbar-special-mode-key-map
1194 speedbar-special-mode-key-map)
1200 ;; This creates a small keymap we can glom the
1201 ;; menu adjustments into.
1203 ;; Delete the old menu if applicable.
1206 ;; Now add the new menu
1211 ;; XEmacs-specific:
1217 \f
1218 ;;; User Input stuff
1219 ;;
1221 "Customize speedbar using the Custom package."
1230 "For motion EVENT, display info about the current line."
1232 nil
1239 ;; XEmacs may let us get in here in other mode buffers.
1244 "Call the info function for the line under the mouse.
1245 Optional EVENT is currently not used."
1254 "Move to the next ARGth line in a speedbar buffer."
1261 "Move to the previous ARGth line in a speedbar buffer."
1266 "Move to the next ARGth line in a speedbar buffer at the same depth.
1267 This means that movement is restricted to a subnode, and that siblings
1268 of intermediate nodes are skipped."
1270 ;; First find the extent for which we are allowed to move.
1286 ;; We have reached the end of this block.
1296 "Move to the next ARGth line in a speedbar buffer at the same depth.
1297 This means that movement is restricted to a subnode, and that siblings
1298 of intermediate nodes are skipped."
1304 "Move to the previous ARGth line in a speedbar buffer at the same depth.
1305 This means that movement is restricted to a subnode, and that siblings
1306 of intermediate nodes are skipped."
1312 "Move across ARG groups of similarly typed items in speedbar.
1313 Stop on the first line of the next type of item, or on the last or first item
1314 if we reach a buffer boundary."
1325 "Move forward over the current list.
1326 A LIST in speedbar is a group of similarly typed items, such as directories,
1327 files, or the directory button."
1333 "Move backward over the current list.
1334 A LIST in speedbar is a group of similarly typed items, such as directories,
1335 files, or the directory button."
1341 "Page down one screen-full of the speedbar, or ARG lines."
1347 "Page up one screen-full of the speedbar, or ARG lines."
1353 "Keyboard accelerator for moving the default directory up one.
1354 Assumes that the current buffer is the speedbar buffer."
1358 \f
1359 ;;; Speedbar file activity (aka creeping featurism)
1360 ;;
1362 "Refresh the current speedbar display, disposing of any cached data.
1363 Argument ARG represents to force a refresh past any caches that may exist."
1367 deactivate-mark)
1368 ;; We need to hack something so this works in detached frames.
1376 ;; Reset the timer in case it got really hosed for some reason...
1382 "Load the item under the cursor or mouse if it is a Lisp file."
1388 ;; If the compiled version exists, load that instead...
1394 "Byte compile the item under the cursor or mouse if it is a Lisp file."
1404 ))
1407 "Provide information about what the user clicked on.
1408 This should be bound to a mouse EVENT."
1414 "Attempt to derive, and then display information about this line item.
1415 File style information is displayed with `speedbar-item-info'."
1418 ;; Skip invisible number info.
1420 ;; Skip items in "folder" type text characters.
1422 ;; Get the text
1427 "Display info in the mini-buffer about the button the mouse is over.
1428 This function can be replaced in `speedbar-mode-functions-list' as
1429 `speedbar-item-info'."
1436 "Display info about a file that is on the current line.
1437 nil if not applicable. If FILENAME, then use that instead of reading
1438 it from the speedbar buffer."
1443 nil)))
1446 "Display info about a tag that is on the current line.
1447 nil if not applicable."
1465 )))
1483 nil t))
1486 nil))))
1496 parent))
1498 ;; Not using `semantic':
1502 nil)))))
1505 "Display info in the mini-buffer about the button the mouse is over."
1513 "Copy the item under the cursor.
1514 Files can be copied to new names or places."
1524 speedbar-shown-directories)))
1525 ;; Create the right file name part
1533 t))
1536 ;; refresh display if the new place is currently displayed.
1542 ))))))
1545 "Rename the item under the cursor or mouse.
1546 Files can be renamed to new names or moved to new directories."
1554 speedbar-shown-directories)))
1555 ;; Create the right file name part
1563 t))
1566 ;; refresh display if the new place is currently displayed.
1571 )))))
1575 "Create a directory in speedbar."
1581 basedir)))
1582 ;; Make the directory
1586 )
1590 "Delete the item under the cursor. Files are removed from disk."
1603 ))
1604 ))
1607 "Delete the object associated from the item under the cursor.
1608 The file is removed from disk. The object is determined from the
1609 variable `speedbar-obj-alist'."
1625 "Enable automatic updating in speedbar via timers."
1632 "Disable automatic updating and stop consuming resources."
1639 "Toggle automatic update for the speedbar frame."
1646 "Toggle use of images in the speedbar frame.
1647 Images are not available in Emacs 20 or earlier."
1653 "Toggle tag sorting."
1658 "Toggle display of files speedbar can not tag."
1664 "Allow the buffer to be writable and evaluate FORMS."
1671 "Insert TEXT as the next logical speedbar button.
1672 FACE is the face to put on the button, MOUSE is the highlight face to use.
1673 When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter.
1674 This function assumes that the current buffer is the speedbar buffer.
1675 If PREVLINE, then put this button on the previous line.
1677 This is a convenience function for special modes that create their own
1678 specialized speedbar displays."
1695 "Insert a separation label of TEXT.
1696 Separators are not active, have no labels, depth, or actions."
1704 'speedbar-separator-face
1705 nil nil nil)))
1708 "Create a button from START to END, with FACE as the display face.
1709 MOUSE is the mouse face. When this button is clicked on FUNCTION
1710 will be run with the TOKEN parameter (any Lisp object)"
1718 ;; So far the only text we have is less that 3 chars.
1721 )
1722 \f
1723 ;;; Initial Expansion list management
1724 ;;
1726 "Return the current default expansion list.
1727 This is based on `speedbar-initial-expansion-list-name' referencing
1728 `speedbar-initial-expansion-mode-alist'."
1729 ;; cdr1 - name, cdr2 - menu
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 the current default menu data.
1743 This is based on `speedbar-initial-expansion-list-name' referencing
1744 `speedbar-initial-expansion-mode-alist'."
1747 speedbar-initial-expansion-mode-alist))))))
1750 "Return a list of functions to call stealthily.
1751 This is based on `speedbar-initial-expansion-list-name' referencing
1752 `speedbar-stealthy-function-list'."
1754 speedbar-stealthy-function-list)))
1757 "Add NEW-LIST to the list of expansion lists."
1761 "Change speedbar's default expansion list to NEW-DEFAULT."
1765 speedbar-previously-used-expansion-list-name)
1766 speedbar-initial-expansion-mode-alist
1767 nil t "" nil
1768 speedbar-previously-used-expansion-list-name)))
1770 speedbar-initial-expansion-list-name
1771 speedbar-initial-expansion-list-name new-default)
1778 "Return a current mode specific replacement for function, or nil.
1779 Scans `speedbar-mode-functions-list' first for the current mode, then
1780 for FUNCTION."
1783 speedbar-mode-functions-list)))))
1786 "Add NEW-LIST to the list of mode functions.
1787 See `speedbar-mode-functions-list' for details."
1790 \f
1791 ;;; Special speedbar display management
1792 ;;
1794 "Quick check function called on BUFFERs by the speedbar timer function.
1795 Maintains the value of local variables which control speedbars use
1796 of the special mode functions."
1801 "Add localized speedbar support to BUFFER's mode if it is available."
1805 nil
1811 nil ;; do nothing to broken mode
1817 ;; If it is autoloaded, we need to load it now so that
1818 ;; we have access to the varialbe -speedbar-menu-items.
1819 ;; Is this XEmacs safe?
1826 nil ;; don't add special keymap
1832 nil ;; don't add special menus
1836 )))))))
1839 "Remove any traces that BUFFER supports speedbar in a specialized way."
1845 \f
1846 ;;; File button management
1847 ;;
1849 "Create file lists for DIRECTORY.
1850 The car is the list of directories, the cdr is list of files not
1851 matching ignored headers. Cache any directory files found in
1852 `speedbar-directory-contents-alist' and use that cache before scanning
1853 the file-system."
1855 ;; If in powerclick mode, then the directory we are getting
1856 ;; should be rescanned.
1859 ;; find the directory, either in the cache, or build it.
1875 nl))
1876 ))
1879 "Insert a single button group at point for DIRECTORY.
1880 Each directory directory part is a different button. If part of the directory
1881 matches the user directory ~, then it is replaced with a ~.
1882 INDEX is not used, but is required by the caller."
1888 dd))
1896 'speedbar-directory-face
1897 'speedbar-highlight-face
1898 'speedbar-directory-buttons-follow
1904 ;; Nuke the beginning of the directory if it's too long...
1932 )))))))
1933 )
1940 'speedbar-directory-face
1941 'speedbar-highlight-face
1942 'speedbar-directory-buttons-follow
1948 exp-button-char exp-button-function
1949 exp-button-data
1950 tag-button tag-button-function tag-button-data
1951 tag-button-face depth)
1952 "Create a tag line with EXP-BUTTON-TYPE for the small expansion button.
1953 This is the button that expands or contracts a node (if applicable),
1954 and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
1955 is the function to call if it's clicked on. Button types are
1956 'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil.
1957 EXP-BUTTON-DATA is extra data attached to the text forming the expansion
1958 button.
1960 Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
1961 function to call if clicked on, and TAG-BUTTON-DATA is the data to
1962 attach to the text field (such a tag positioning, etc).
1963 TAG-BUTTON-FACE is a face used for this type of tag.
1965 Lastly, DEPTH shows the depth of expansion.
1967 This function assumes that the cursor is in the speedbar window at the
1968 position to insert a new item, and that the new item will end with a CR."
1989 )
1995 )
2004 tag-button-function tag-button-data))
2005 ))
2008 "Change the expansion button character to CHAR for the current line."
2018 ;;(put-text-property (point) (1- (point)) 'invisible nil)
2019 ;; make sure we fix the image on the text here.
2022 \f
2023 ;;; Build button lists
2024 ;;
2026 "Insert list of FILES starting at point, and indenting all files to LEVEL.
2027 Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
2028 don't know how to manage them. The input parameter FILES is a cons
2029 cell of the form ( 'DIRLIST . 'FILELIST )."
2030 ;; Start inserting all the directories
2050 "Insert files for DIRECTORY with level INDEX at point."
2055 ;; If the shown files variable has extra directories, then
2056 ;; it is our responsibility to redraw them all
2057 ;; Luckilly, the nature of inserting items into this list means
2058 ;; that by reversing it, we can easilly go in the right order
2062 ;; exand them all as we find them
2072 )))
2073 ;;; Generic List support
2074 ;;
2075 ;; Generic lists are hierarchies of tags which we may need to permute
2076 ;; in order to make it look nice.
2077 ;;
2078 ;; A generic list is of the form:
2079 ;; ( ("name" . marker-or-number) <-- one tag at this level
2080 ;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
2081 ;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
2083 "Non-nil if SUBLST is a group.
2084 Groups may optionally contain a position."
2089 )))
2094 )))
2097 "Non-nil of SUBLST is a group with a position."
2105 ))))
2108 "Non nil if SUBLST is a tag."
2112 ;; For semantic/bovine items, this is needed
2114 ))
2117 "Sort all elements of tag hierarchy LST."
2122 "A wrapper for `try-completion'.
2123 Passes STRING and ALIST to `try-completion' if ALIST
2124 passes some tests."
2128 nil))
2131 "Prefix group names for tag hierarchy LST."
2143 ;; Do nothing. Too short to bother with.
2144 lst
2145 ;; Break out sub-lists
2151 ;; Reverse newlst because it was made backwards.
2152 ;; Sublist doesn't need reversing because the act
2153 ;; of binning things will reverse it for us.
2155 sublst sublst)
2156 ;; Now, first find out how long our list is. Never let a
2157 ;; list get-shorter than our minimum.
2161 ;; Sort the whole list into bins.
2166 ;; 0 storage bin for shorty.
2169 ;; stuff into a bin based on ascii value at diff
2173 ;; Go through all our bins Stick singles into our
2174 ;; junk-list, everything else as sublsts in work-list.
2175 ;; If two neighboring lists are both small, make a grouped
2176 ;; group combinding those two sub-lists.
2179 ;; The bins contents are currently in forward order.
2185 speedbar-tag-split-minimum-length))
2187 ;; We have reached a longer list, so we
2188 ;; must finish off a grouped group.
2192 num-shorts-grouped))
2193 ;; All singles? Junk list
2195 junk-list)))
2197 ;; Only one short group? Just stick it in
2198 ;; there by itself. Make a group, and find
2199 ;; a subexpression
2203 speedbar-tag-group-name-minimum-length)
2206 " ("
2213 short-group-list)
2214 work-list ))))
2216 ;; Multiple groups to be named in a special
2217 ;; way by displaying the range over which we
2218 ;; have grouped them.
2221 " to "
2222 short-end-name)
2223 short-group-list)
2224 work-list))))
2225 ;; Reset short group list information every time.
2227 short-start-name nil
2228 short-end-name nil
2230 ;; Ok, now that we cleaned up the short-group-list,
2231 ;; we can deal with this new list, to decide if it
2232 ;; should go on one of these sub-lists or not.
2238 short-start-name
2242 ;; Did we run out of things? Drop our new list onto the end.
2245 ;; All singles? Junk list
2248 ;; Only one short group? Just stick it in
2249 ;; there by itself.
2252 short-group-list)
2253 work-list)))
2255 ;; Multiple groups to be named in a special
2256 ;; way by displaying the range over which we
2257 ;; have grouped them.
2260 short-group-list)
2261 work-list))))
2262 ;; Reverse the work list nreversed when consing.
2264 ;; Now, stick our new list onto the end of
2272 "Trim all words in a tag hierarchy.
2273 Base trimming information on word separators, and group names.
2274 Argument LST is the list of tags to trim."
2285 ;; Get the prefix to trim by. Make sure that we don't trim
2286 ;; off silly pieces, only complete understandable words.
2300 trimlst)
2302 ;; Put the lists together
2306 "Create a simple 'Tags' group with orphaned tags.
2307 Argument LST is the list of tags to sort into groups."
2321 "Adjust the tag hierarchy in LST, and return it.
2322 This uses `speedbar-tag-hierarchy-method' to determine how to adjust
2323 the list."
2330 speedbar-tag-hierarchy-method)
2331 speedbar-tag-hierarchy-method))
2334 lst)))
2338 lst))
2341 "The type of button created for groups of tags.
2342 Good values for this are `curly' and `expandtag'.
2346 "The type of button created for tags in generic lists.
2347 Good values for this are nil and `statictag'.
2351 "At LEVEL, insert a generic multi-level alist LST.
2352 Associations with lists get {+} tags (to expand into more nodes) and
2353 those with positions just get a > as the indicator. {+} buttons will
2354 have the function EXPAND-FUN and the token is the CDR list. The token
2355 name will have the function FIND-FUN and not token."
2356 ;; Remove imenu rescan button
2359 ;; Get, and set up variables that define how we treat these tags.
2363 expand-button tag-button)
2368 tag-button speedbar-generic-list-tag-button-type))
2369 ;; Adjust the list.
2371 ;; insert the parts
2376 nil nil nil ;no expand button data
2378 find-fun ;function
2380 'speedbar-tag-face
2386 find-fun ;function
2388 'speedbar-tag-face
2394 nil nil 'speedbar-tag-face
2397 ))
2401 "At level INDENT, insert the imenu generated LST."
2403 'speedbar-tag-expand
2407 "At level INDENT, insert the etags generated LST."
2409 'speedbar-tag-expand
2411 \f
2412 ;;; Timed functions
2413 ;;
2415 "Generically update the contents of the speedbar buffer."
2417 ;; Set the current special buffer
2420 ;; Check for special modes
2423 ;; Choose the correct method of doodling.
2426 speedbar-special-mode-expansion-list
2428 'speedbar-special-mode-expansion-list
2430 ;;(eq (get major-mode 'mode-class 'special)))
2435 "Update the contents of the speedbar buffer for the current situation."
2436 ;; Due to the historical growth of speedbar, we need to do something
2437 ;; special for "files" mode. Too bad.
2440 )
2442 ;; Do all the files type work. It still goes through the
2443 ;; expansion list stuff. :(
2445 speedbar-shown-directories)
2448 speedbar-ignored-directory-regexp
2450 nil
2453 default-directory))
2458 default-directory)
2460 ;; Else, we can do a short cut. No text cache.
2462 )
2471 ))))
2474 "Update the contents of the speedbar buffer based on the current directory."
2479 cbd-parent
2482 ;; disable stealth during update
2486 ;; Because there is a bug I can't find just yet
2489 ;; If we are updating contents to where we are, then this is
2490 ;; really a request to update existing contents, so we must be
2491 ;; careful with our text cache!
2495 ;; If the current directory is not the last element in the dir
2496 ;; list, then we ALSO need to zap the list of expanded directories
2500 ;; Build cbd-parent, and see if THAT is in the current shown
2501 ;; directories. First, go through pains to get the parent directory
2512 ;; If this directory is NOT in the current list of available
2513 ;; directorys, then use the cache, and set the cache to our new
2514 ;; value. Make sure to unhighlight the current file, or if we
2515 ;; come back to this directory, it might be a different file
2516 ;; and then we get a mess!
2523 ;; Check if our new directory is in the list of directories
2524 ;; shown in the text-cache
2527 use-cache t)
2528 ;; default the shown directories to this list...
2530 ))
2534 ;; Find this directory as a speedbar node.
2536 ;; Open it.
2542 speedbar-shown-directories))
2552 "Use the mode-specific variable to fill in the speedbar buffer.
2553 This should only be used by modes classified as special."
2559 ;; If we are leaving a directory, cache it.
2561 ;; Do nothing
2562 nil
2563 ;; Clean up directory maintenance stuff
2567 speedbar-shown-directories nil))
2568 ;; Now fill in the buffer with our newly found specialized list.
2571 ;; We do not erase the buffer because these functions may
2572 ;; decide NOT to update themselves.
2579 "Set up the speedbar timer with TIMEOUT.
2580 Uses `dframe-set-timer'.
2581 Also resets scanner functions."
2583 ;; Apply a revert hook that will reset the scanners. We attach to revert
2584 ;; because most reverts occur during VC state change, and this lets our
2585 ;; VC scanner fix itself.
2589 ;; change this if it changed for some reason
2593 "Run whenever Emacs is idle to update the speedbar item."
2597 ;; Save all the match data so that we don't mess up executing fns
2599 ;; Only do stuff if the frame is visible, not an icon, and if
2600 ;; it is currently flagged to do something.
2608 ;; make sure we at least choose a window to
2609 ;; get a good directory from
2611 nil
2612 ;; Check for special modes
2614 ;; Update for special mode all the time!
2617 speedbar-special-mode-expansion-list
2619 'speedbar-special-mode-expansion-list
2621 ;;(eq (get major-mode 'mode-class 'special)))
2625 "Updating speedbar to special mode: %s..."
2626 major-mode))
2631 "Updating speedbar to special mode: %s...done"
2632 major-mode)
2634 ;; Update all the contents if directories change!
2638 nil
2640 ))
2642 ;; Now run stealthy updates of time-consuming items
2646 \f
2647 ;;; Stealthy activities
2648 ;;
2653 "For a given speedbar, run all items in the stealthy function list.
2654 Each item returns t if it completes successfully, or nil if
2655 interrupted by the user."
2662 ;;(sit-for 0)
2664 ;;(speedbar-message "Exit with %S" (car l))
2665 ))))
2668 "Reset any variables used by functions in the stealthy list as state.
2669 If new functions are added, their state needs to be updated here."
2671 speedbar-obj-to-do-point t
2672 speedbar-ro-to-do-point t)
2674 )
2677 "Go to the line where FILE is."
2686 nil t))
2703 "Locate the file thought to be current, and remove its highlighting."
2705 ;;(set-buffer speedbar-buffer)
2711 'face
2715 "Find the current file, and update our visuals to indicate its name.
2716 This is specific to file names. If the file name doesn't show up, but
2717 it should be in the list, then the directory cache needs to be
2718 updated."
2724 nil)))
2726 rf)))
2732 ;; check here, that way we won't refresh to newcf until
2733 ;; its been written, thus saving ourselves some time
2737 ;; It is important to select the frame, otherwise the window
2738 ;; we want the cursor to move in will not be updated by the
2739 ;; search-forward command.
2741 ;; Remove the old file...
2743 ;; now highlight the new one.
2744 ;; (set-buffer speedbar-buffer)
2747 ;; put the property on it
2750 'face
2752 ;; Oops, it's not in the list. Should it be?
2756 ;; yes, it is (we will ignore unknowns for now...)
2760 ;; put the property on it
2763 'face
2765 ;; if it's not in there now, whatever...
2766 ))
2771 ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
2772 ;;doesn't need to be in. We don't want to recenter when we are
2773 ;;updating files.
2775 ;;(speedbar-center-buffer-smartly)
2778 ))
2781 )))
2782 ;; return that we are done with this activity.
2783 t)
2786 "Add INDICATOR-STRING to the end of this speedbar line.
2787 If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
2788 the existing indicator is removed. If there is already an
2789 indicator, then do not add a space."
2791 ;; The nature of the beast: Assume we are in "the right place"
2794 speedbar-object-read-only-indicator
2805 t))
2812 ))))
2815 "Scan all the files in a directory, and for each see if it is read only."
2816 ;; Check for to-do to be reset. If reset but no RCS is available
2817 ;; then set to nil (do nothing) otherwise, start at the beginning
2827 nil t))
2833 speedbar-object-read-only-indicator
2837 speedbar-object-read-only-indicator))))))
2839 ;; return that we are incomplete
2840 nil
2841 ;; we are done, set to-do to nil
2843 ;; and return t
2844 t))
2845 t)))
2847 ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
2848 ;; Steven L Baur <steve@xemacs.org> said this was important:
2854 "Scan all files in a directory, and for each see if it's checked out.
2855 See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how
2856 to add more types of version control systems."
2857 ;; Check for to-do to be reset. If reset but no RCS is available
2858 ;; then set to nil (do nothing) otherwise, start at the beginning
2867 'ange-ftp-directory-format
2870 ;; efs support: Bob Weiner
2875 reg
2884 nil t))
2892 ;; return that we are incomplete
2893 nil
2894 ;; we are done, set to-do to nil
2896 ;; and return t
2897 t))
2898 t)))
2901 "Return t if the file on this line is check of of a version control system.
2902 Parameter DEPTH is a string with the current depth of indentation of
2903 the file being checked."
2907 ;; Skip-chars: thanks ptype@dra.hmg.gb
2920 "Return t if we should bother checking DIRECTORY for version control files.
2921 This can be overloaded to add new types of version control systems."
2923 ;; Local CVS available in Emacs 21
2926 ;; Local RCS
2928 ;; Local SCCS
2930 ;; Remote SCCS project
2934 nil))
2935 ;; User extension
2937 directory)
2938 ))
2941 "Check to see if the file in DIRECTORY with NAME is in a version control system.
2942 You can add new VC systems by overriding this function. You can
2943 optimize this function by overriding it and only doing those checks
2944 that will occur on your system."
2947 ;; Emacs 21 handles VC state in a nice way.
2952 ;; An error means not in a VC system
2955 ;; RCS file name
2958 ;; Local SCCS file name
2960 ;; Remote SCCS file name
2964 nil))))
2965 ;; User extension
2967 ))
2969 ;; Objet File scanning
2971 "Scan all files in a directory, and for each see if there is an object.
2972 See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how
2973 to add more object types."
2974 ;; Check for to-do to be reset. If reset but no RCS is available
2975 ;; then set to nil (do nothing) otherwise, start at the beginning
2985 nil t))
2994 ;; return that we are incomplete
2995 nil
2996 ;; we are done, set to-do to nil
2998 ;; and return t
2999 t))
3000 t)))
3003 "Return t if the file on this line has an associated object.
3004 Parameter DEPTH is a string with the current depth of indentation of
3005 the file being checked."
3009 ;; Skip-chars: thanks ptype@dra.hmg.gb
3023 nil
3024 ;; Find out if the object is out of date or not.
3034 \f
3035 ;;; Clicking Activity
3036 ;;
3038 "Position the cursor on a line."
3046 "Activate any speedbar buttons where the mouse is clicked.
3047 This must be bound to a mouse event. A button is any location of text
3048 with a mouse face that has a text property called `speedbar-function'.
3049 Argument E is the click event."
3050 ;; Backward compatibility let statement.
3056 "Look under the cursor and examine the text properties.
3057 From this extract the file/tag name, token, indentation level and call
3058 a function if appropriate."
3062 ;; The 1-,+ is safe because scaning starts AFTER the point
3063 ;; specified. This lets the search include the character the
3064 ;; cursor is on.
3077 ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent)
3080 \f
3081 ;;; Reading info from the speedbar buffer
3082 ;;
3084 "Retrieve the text after prefix junk for the current line.
3085 Optional argument P is where to start the search from."
3092 nil)))
3095 "Retrieve the token information after the prefix junk for the current line.
3096 Optional argument P is where to start the search from."
3106 nil)))
3109 "Retrieve the file or whatever from the line at point P.
3110 The return value is a string representing the file. If it is a
3111 directory, then it is the directory name."
3121 nil))
3122 nil)))))
3125 "If FILE is displayed, go to this line and return t.
3126 Otherwise do not move and return nil."
3132 ;; scan all the directories
3138 nil t))
3142 ;; find the file part
3144 ;; only had a dir part
3148 t)
3150 ;; find the file part
3155 nil t)
3158 t)
3160 nil))))))
3163 "Retrieve the directory name associated with the current line.
3164 This may require traversing backwards from DEPTH and combining the default
3165 directory with these items. This function is replaceable in
3166 `speedbar-mode-functions-list' as `speedbar-line-directory'."
3173 "Retrieve the directoryname associated with the current line.
3174 This may require traversing backwards from DEPTH and combining the default
3175 directory with these items."
3190 "/"
3191 directory)))
3193 ;; This is the start of our directory.
3198 directory))
3203 "Position the cursor on the line specified by DIRECTORY."
3217 nil t))
3227 "Edit whatever tag or file is on the current speedbar line."
3231 ;; If this fails, then it is a non-standard click, and as such,
3232 ;; perfectly allowed.
3235 t)
3239 nil))
3243 "Expand the line under the cursor.
3244 With universal argument ARG, flush cached data."
3258 "Expand the line under the cursor and flush any cached information."
3263 "Contract the line under the cursor."
3275 "Contract or expand the line under the cursor."
3287 "Expand the line under the cursor and all descendants.
3288 Optional argument ARG indicates that any cache should be flushed."
3291 ;; Now, inside the area expaded here, expand all subnodes of
3292 ;; the same descendant type.
3302 )
3305 "Expand the line under the cursor and all descendants."
3308 ;; Don't need to do anything else since all descendants are
3309 ;; hidden by default anyway. Yay! It's easy.
3310 )
3313 "Speedbar click handler for filenames.
3314 TEXT, the file will be displayed in the attached frame.
3315 TOKEN is unused, but required by the click handler. INDENT is the
3316 current indentation level."
3318 ;; Run before visiting file hook here.
3326 ;; Reset the timer with a new timeout when cliking a file
3327 ;; in case the user was navigating directories, we can cancel
3328 ;; that other timer.
3333 "Speedbar click handler for directory names.
3334 Clicking a directory will cause the speedbar to list files in
3335 the subdirectory TEXT. TOKEN is an unused requirement. The
3336 subdirectory chosen will be at INDENT level."
3340 ;; Because we leave speedbar as the current buffer,
3341 ;; update contents will change directory without
3342 ;; having to touch the attached frame. Turn off smart expand just
3343 ;; in case.
3351 "Delete text from point to indentation level INDENT or greater.
3352 Handles end-of-sublist smartly."
3365 "Speedbar click handler for directory expand button.
3366 Clicking this button expands or contracts a directory. TEXT is the
3367 button clicked which has either a + or -. TOKEN is the directory to be
3368 expanded. INDENT is the current indentation level."
3373 speedbar-shown-directories))
3395 )
3401 "Speedbar click handler for default directory buttons.
3402 TEXT is the button clicked on. TOKEN is the directory to follow.
3403 INDENT is the current indentation level and is unused."
3407 ;; Because we leave speedbar as the current buffer,
3408 ;; update contents will change directory without
3409 ;; having to touch the attached frame.
3414 "The cursor is on a selected line. Expand the tags in the specified file.
3415 The parameter TEXT and TOKEN are required, where TEXT is the button
3416 clicked, and TOKEN is the file to expand. INDENT is the current
3417 indentation level."
3420 token)))
3423 ;; if no list, then remove expando button
3438 "For the tag TEXT in a file TOKEN, go to that position.
3439 INDENT is the current indentation level."
3447 ;; Reset the timer with a new timeout when cliking a file
3448 ;; in case the user was navigating directories, we can cancel
3449 ;; that other timer.
3454 ))
3457 "Expand a tag sublist. Imenu will return sub-lists of specialized tag types.
3458 Etags does not support this feature. TEXT will be the button
3459 string. TOKEN will be the list, and INDENT is the current indentation
3460 level."
3473 \f
3474 ;;; Loading files into the attached frame.
3475 ;;
3477 "*Specify how to select a frame for displaying a file.
3478 A value of 'attached means to use the attached frame (the frame
3479 that speedbar was started from.) A number such as 1 or -1 means to
3480 pass that number to `other-frame' while selecting a frame from speedbar."
3485 "This will load FILE into the speedbar attached frame.
3486 If the file is being displayed in a different frame already, then raise that
3487 frame instead."
3500 )
3502 ;;; Centering Utility
3503 ;;
3505 "Recenter a speedbar buffer so the current indentation level is all visible.
3506 This assumes that the cursor is on a file, or tag of a file which the user is
3507 interested in."
3517 ;; whole buffer fits
3523 ;; too big
3547 ;; Now work out the details of centering
3552 ;; We can't fit it all, so just center on cursor
3555 ;; we can fit everything on the screen, but...
3558 ;; we are all set!
3559 nil
3560 ;; we need to do something...
3566 newcent))
3571 \f
3572 ;;; Tag Management -- List of expanders:
3573 ;;
3575 "Return a list of tags generated dynamically from FILE.
3576 This uses the entries in `speedbar-dynamic-tags-function-list'
3577 to find the proper tags. It is up to each of those individual
3578 functions to do caching and flushing if appropriate."
3580 ;; If a file is in memory, switch to that buffer. This allows
3581 ;; us to use the local variable. If the file is on disk, we
3582 ;; can try a few of the defaults that can get tags without
3583 ;; opening the file.
3586 ;; If there is a buffer-local value of
3587 ;; speedbar-dynamic-tags-function-list, it will now be available.
3594 t))
3598 ;; No valid tag list, return nil
3599 nil
3600 ;; We have some tags. Return the list with the insert fn
3601 ;; prepended
3604 ;;; Tag Management -- Imenu
3605 ;;
3608 nil
3613 "Load FILE into a buffer, and generate tags using Imenu.
3614 Returns the tag list, or t for an error."
3615 ;; Load this AND compile it in
3624 index-alist))
3626 )
3627 \f
3628 ;;; Tag Management -- etags (old XEmacs compatibility part)
3629 ;;
3636 ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" .
3637 ; speedbar-parse-fortran77-tag)
3641 )
3642 "Associations of file extensions and expressions for extracting tags.
3643 To add a new file type, you would want to add a new association to the
3644 list, where the car is the file match, and the cdr is the way to
3645 extract an element from the tags output. If the output is complex,
3646 use a function symbol instead of regexp. The function should expect
3647 to be at the beginning of a line in the etags buffer.
3652 "*Command used to create an etags file.
3657 "*List of arguments to use with `speedbar-fetch-etags-command'.
3658 This creates an etags output buffer. Use `speedbar-toggle-etags' to
3659 modify this list conveniently.
3664 "Toggle FLAG in `speedbar-fetch-etags-arguments'.
3665 FLAG then becomes a member of etags command line arguments. If flag
3668 `speedbar-show-unknown-files'.
3670 This function is a convenience function for XEmacs menu created by
3671 Farzin Guilak <farzin@protocol.com>."
3688 "For FILE, run etags and create a list of symbols extracted.
3689 Each symbol will be associated with its line position in FILE."
3722 )
3727 ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not
3728 ;; sure it's needed with the different sorting method.
3729 ;;
3730 ;(defun speedbar-clean-etags()
3731 ; "Removes spaces before the ^? character, and removes `#define',
3732 ;return types, etc. preceding tags. This ensures that the sort operation
3733 ;works on the tags, not the return types."
3734 ; (save-excursion
3735 ; (goto-char (point-min))
3736 ; (while
3737 ; (re-search-forward "(?[ \t](?\C-?" nil t)
3738 ; (replace-match "\C-?" nil nil))
3739 ; (goto-char (point-min))
3740 ; (while
3741 ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t)
3742 ; (delete-region (match-beginning 1) (match-end 1)))))
3745 "At point, return nil, or one alist in the form: (SYMBOL . POSITION)
3746 The line should contain output from etags. Parse the output using the
3747 regular expression EXPR."
3760 t)))
3768 nil)))
3771 "Parse a C or C++ tag, which tends to be a little complex."
3784 )))
3787 "Parse a Tex string. Only find data which is relevant."
3795 \f
3796 ;;; BUFFER DISPLAY mode.
3797 ;;
3802 nil
3805 ;; Basic tree features
3813 ;; Buffer specific keybindings
3817 )
3830 "----"
3837 )
3841 "Create speedbar buttons based on the buffers currently loaded.
3842 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3846 "Create speedbar buttons based on the buffers currently loaded.
3847 DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
3851 "Create speedbar buffer buttons.
3852 If TEMP is non-nil, then clicking on a buffer restores the previous display."
3858 nil
3868 'speedbar-buffer-click temp
3876 nil
3878 nil
3881 'speedbar-buffer-click temp
3886 ;;(speedbar-insert-separator "Hidden Buffers:")
3887 ;;(while bl
3888 ;; (if (not (string-match "^ " (buffer-name (car bl))))
3889 ;; nil
3890 ;; (if (eq (car bl) speedbar-buffer)
3891 ;; nil
3892 ;; (speedbar-make-tag-line 'bracket ?? nil nil
3893 ;; (buffer-name (car bl))
3894 ;; 'speedbar-buffer-click temp
3895 ;; 'speedbar-file-face 0)
3896 ;; (speedbar-buffers-tail-notes (car bl))))
3897 ;; (setq bl (cdr bl)))
3898 ))
3901 "Add a note to the end of the last tag line.
3902 Argument BUFFER is the buffer being tested."
3907 ro buffer-read-only))
3911 "Display information about the current buffer on the current line."
3918 item
3925 "Fetch the full directory to the file (buffer) specified on the current line.
3926 Optional argument DEPTH specifies the current depth of the back search."
3930 ;; Buffers are always at level 0
3932 nil
3940 default-directory)
3945 "When the users clicks on a buffer-button in speedbar.
3946 TEXT is the buffer's name, TOKEN and INDENT are unused."
3952 speedbar-previously-used-expansion-list-name))))
3955 "Kill the buffer the cursor is on in the speedbar buffer."
3965 "Revert the buffer the cursor is on in the speedbar buffer."
3969 ;; If this fails, then it is a non-standard click, and as such,
3970 ;; perfectly allowed
3973 t)
3984 \f
3985 ;;; Useful hook values and such.
3986 ;;
3991 "Highlight the current line, unhighlighting a previously jumped to line."
4001 )
4004 "Unhighlight the currently highlighted line."
4012 "Recenter the current buffer so POINT is on the top of the window."
4016 "Recenter the current buffer so POINT is in the center of the window."
4019 \f
4020 ;;; Color loading section.
4021 ;;
4026 "Face used for +/- buttons."
4034 "Face used for file names."
4041 "Face used for directory names."
4047 "Face used for displaying tags."
4055 "Face used to underline the file in the active window."
4068 "Face used for highlighting buttons with the mouse."
4089 "Face used for separator labes in a display."
4092 ;; some edebug hooks
4097 ;; Fix a font lock problem for some versions of Emacs
4101 )
4102 )
4104 \f
4105 ;;; Obsolete variables and functions
4130 ;; run load-time hooks
4133 ;; arch-tag: 4477e6d1-f78c-48b9-a503-387d3c9767d5
4134 ;;; speedbar ends here