| 1 | ;;; speedbar --- quick access to files and tags in a frame |
| 2 | |
| 3 | ;;; Copyright (C) 1996, 97, 98, 99, 00 Free Software Foundation |
| 4 | |
| 5 | ;; Author: Eric M. Ludlam <zappo@gnu.org> |
| 6 | ;; Version: 0.11 |
| 7 | ;; Keywords: file, tags, tools |
| 8 | |
| 9 | ;; This file is part of GNU Emacs. |
| 10 | |
| 11 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 12 | ;; it under the terms of the GNU General Public License as published by |
| 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
| 14 | ;; any later version. |
| 15 | |
| 16 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | ;; GNU General Public License for more details. |
| 20 | |
| 21 | ;; You should have received a copy of the GNU General Public License |
| 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 24 | ;; Boston, MA 02111-1307, USA. |
| 25 | |
| 26 | ;;; Commentary: |
| 27 | ;; |
| 28 | ;; The speedbar provides a frame in which files, and locations in |
| 29 | ;; files are displayed. These items can be clicked on with mouse-2 |
| 30 | ;; in order to make the last active frame display that file location. |
| 31 | ;; |
| 32 | ;; Starting Speedbar: |
| 33 | ;; |
| 34 | ;; Simply type `M-x speedbar', and it will be autoloaded for you. |
| 35 | |
| 36 | ;; If you want to choose it from a menu, such as "Tools", you can do this: |
| 37 | ;; |
| 38 | ;; (define-key-after (lookup-key global-map [menu-bar tools]) |
| 39 | ;; [speedbar] '("Speedbar" . speedbar-frame-mode) [calendar]) |
| 40 | ;; |
| 41 | ;; If you want to access speedbar using only the keyboard, do this: |
| 42 | ;; |
| 43 | ;; (global-set-key [f4] 'speedbar-get-focus) |
| 44 | ;; |
| 45 | ;; This will let you hit f4 (or whatever key you choose) to jump |
| 46 | ;; focus to the speedbar frame. Pressing it again will bring you back |
| 47 | ;; to the attached frame. Pressing RET or e to jump to a file |
| 48 | ;; or tag will move you back to the attached frame. The command |
| 49 | ;; `speedbar-get-focus' will also create a speedbar frame if it does |
| 50 | ;; not exist. |
| 51 | ;; |
| 52 | ;; Customizing Speedbar: |
| 53 | ;; |
| 54 | ;; Once a speedbar frame is active, it takes advantage of idle time |
| 55 | ;; to keep its contents updated. The contents is usually a list of |
| 56 | ;; files in the directory of the currently active buffer. When |
| 57 | ;; applicable, tags in the active file can be expanded. |
| 58 | ;; |
| 59 | ;; To add new supported files types into speedbar, use the function |
| 60 | ;; `speedbar-add-supported-extension' If speedbar complains that the |
| 61 | ;; file type is not supported, that means there is no built in |
| 62 | ;; support from imenu, and the etags part wasn't set up correctly. You |
| 63 | ;; may add elements to `speedbar-supported-extension-expressions' as long |
| 64 | ;; as it is done before speedbar is loaded. |
| 65 | ;; |
| 66 | ;; To prevent speedbar from following you into certain directories |
| 67 | ;; use the function `speedbar-add-ignored-path-regexp' too add a new |
| 68 | ;; regular expression matching a type of path. You may add list |
| 69 | ;; elements to `speedbar-ignored-path-expressions' as long as it is |
| 70 | ;; done before speedbar is loaded. |
| 71 | ;; |
| 72 | ;; To add new file types to imenu, see the documentation in the |
| 73 | ;; file imenu.el that comes with Emacs. To add new file types which |
| 74 | ;; etags supports, you need to modify the variable |
| 75 | ;; `speedbar-fetch-etags-parse-list'. |
| 76 | ;; |
| 77 | ;; If the updates are going too slow for you, modify the variable |
| 78 | ;; `speedbar-update-speed' to a longer idle time before updates. |
| 79 | ;; |
| 80 | ;; If you navigate directories, you will probably notice that you |
| 81 | ;; will navigate to a directory which is eventually replaced after |
| 82 | ;; you go back to editing a file (unless you pull up a new file.) |
| 83 | ;; The delay time before this happens is in |
| 84 | ;; `speedbar-navigating-speed', and defaults to 10 seconds. |
| 85 | ;; |
| 86 | ;; To enable mouse tracking with information in the minibuffer of |
| 87 | ;; the attached frame, use the variable `speedbar-track-mouse-flag'. |
| 88 | ;; |
| 89 | ;; Tag layout can be modified through `speedbar-tag-hierarchy-method', |
| 90 | ;; which controls how tags are layed out. It is actually a list of |
| 91 | ;; functions that filter the data. The default groups large tag lists |
| 92 | ;; into sub-lists. A long flat list can be used instead if needed. |
| 93 | ;; Other filters could be easily added. |
| 94 | ;; |
| 95 | ;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very |
| 96 | ;; well. Use the imenu keywords from tex-mode.el for better results. |
| 97 | ;; |
| 98 | ;; This file requires the library package assoc (association lists) |
| 99 | ;; |
| 100 | ;;; Developing for speedbar |
| 101 | ;; |
| 102 | ;; Adding a speedbar specialized display mode: |
| 103 | ;; |
| 104 | ;; Speedbar can be configured to create a special display for certain |
| 105 | ;; modes that do not display tradition file/tag data. Rmail, Info, |
| 106 | ;; and the debugger are examples. These modes can, however, benefit |
| 107 | ;; from a speedbar style display in their own way. |
| 108 | ;; |
| 109 | ;; If your `major-mode' is `foo-mode', the only requirement is to |
| 110 | ;; create a function called `foo-speedbar-buttons' which takes one |
| 111 | ;; argument, BUFFER. BUFFER will be the buffer speedbar wants filled. |
| 112 | ;; In `foo-speedbar-buttons' there are several functions that make |
| 113 | ;; building a speedbar display easy. See the documentation for |
| 114 | ;; `speedbar-with-writable' (needed because the buffer is usually |
| 115 | ;; read-only) `speedbar-make-tag-line', `speedbar-insert-button', and |
| 116 | ;; `speedbar-insert-generic-list'. If you use |
| 117 | ;; `speedbar-insert-generic-list', also read the doc for |
| 118 | ;; `speedbar-tag-hierarchy-method' in case you wish to override it. |
| 119 | ;; The function `speedbar-with-attached-buffer' brings you back to the |
| 120 | ;; buffer speedbar is displaying for. |
| 121 | ;; |
| 122 | ;; For those functions that make buttons, the "function" should be a |
| 123 | ;; symbol that is the function to call when clicked on. The "token" |
| 124 | ;; is extra data you can pass along. The "function" must take three |
| 125 | ;; parameters. They are (TEXT TOKEN INDENT). TEXT is the text of the |
| 126 | ;; button clicked on. TOKEN is the data passed in when you create the |
| 127 | ;; button. INDENT is an indentation level, or 0. You can store |
| 128 | ;; indentation levels with `speedbar-make-tag-line' which creates a |
| 129 | ;; line with an expander (eg. [+]) and a text button. |
| 130 | ;; |
| 131 | ;; Some useful functions when writing expand functions, and click |
| 132 | ;; functions are `speedbar-change-expand-button-char', |
| 133 | ;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'. |
| 134 | ;; The variable `speedbar-power-click' is set to t in your functions |
| 135 | ;; when the user shift-clicks. This indications anything from |
| 136 | ;; refreshing cached data to making a buffer appear in a new frame. |
| 137 | ;; |
| 138 | ;; If you wish to add to the default speedbar menu for the case of |
| 139 | ;; `foo-mode', create a variable `foo-speedbar-menu-items'. This |
| 140 | ;; should be a list compatible with the `easymenu' package. It will |
| 141 | ;; be spliced into the main menu. (Available with click-mouse-3). If |
| 142 | ;; you wish to have extra key bindings in your special mode, create a |
| 143 | ;; variable `foo-speedbar-key-map'. Instead of using `make-keymap', |
| 144 | ;; or `make-sparse-keymap', use the function |
| 145 | ;; `speedbar-make-specialized-keymap'. This lets you inherit all of |
| 146 | ;; speedbar's default bindings with low overhead. |
| 147 | ;; |
| 148 | ;; Adding a speedbar top-level display mode: |
| 149 | ;; |
| 150 | ;; Unlike the specialized modes, there are no name requirements, |
| 151 | ;; however the methods for writing a button display, menu, and keymap |
| 152 | ;; are the same. Once you create these items, you can call the |
| 153 | ;; function `speedbar-add-expansion-list'. It takes one parameter |
| 154 | ;; which is a list element of the form (NAME MENU KEYMAP &rest |
| 155 | ;; BUTTON-FUNCTIONS). NAME is a string that will show up in the |
| 156 | ;; Displays menu item. MENU is a symbol containing the menu items to |
| 157 | ;; splice in. KEYMAP is a symbol holding the keymap to use, and |
| 158 | ;; BUTTON-FUNCTIONS are the function names to call, in order, to create |
| 159 | ;; the display. |
| 160 | ;; Another tweekable variable is `speedbar-stealthy-function-list' |
| 161 | ;; which is of the form (NAME &rest FUNCTION ...). NAME is the string |
| 162 | ;; name matching `speedbar-add-expansion-list'. (It does not need to |
| 163 | ;; exist.). This provides additional display info which might be |
| 164 | ;; time-consuming to calculate. |
| 165 | ;; Lastly, `speedbar-mode-functions-list' allows you to set special |
| 166 | ;; function overrides. At the moment very few functions are |
| 167 | ;; over ridable, but more will be added as the need is discovered. |
| 168 | |
| 169 | ;;; TODO: |
| 170 | ;; - More functions to create buttons and options |
| 171 | ;; - Timeout directories we haven't visited in a while. |
| 172 | |
| 173 | (require 'assoc) |
| 174 | (require 'easymenu) |
| 175 | |
| 176 | (condition-case nil |
| 177 | (require 'image) |
| 178 | (error nil)) |
| 179 | |
| 180 | (defvar speedbar-xemacsp (string-match "XEmacs" emacs-version) |
| 181 | "Non-nil if we are running in the XEmacs environment.") |
| 182 | (defvar speedbar-xemacs20p (and speedbar-xemacsp |
| 183 | (>= emacs-major-version 20))) |
| 184 | |
| 185 | ;; customization stuff |
| 186 | (defgroup speedbar nil |
| 187 | "File and tag browser frame." |
| 188 | :group 'tags |
| 189 | :group 'tools |
| 190 | :group 'convenience |
| 191 | :version "20.3") |
| 192 | |
| 193 | (defgroup speedbar-faces nil |
| 194 | "Faces used in speedbar." |
| 195 | :prefix "speedbar-" |
| 196 | :group 'speedbar |
| 197 | :group 'faces) |
| 198 | |
| 199 | (defgroup speedbar-vc nil |
| 200 | "Version control display in speedbar." |
| 201 | :prefix "speedbar-" |
| 202 | :group 'speedbar) |
| 203 | |
| 204 | ;;; Code: |
| 205 | (defvar speedbar-initial-expansion-mode-alist |
| 206 | '(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map |
| 207 | speedbar-buffer-buttons) |
| 208 | ("quick buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map |
| 209 | speedbar-buffer-buttons-temp) |
| 210 | ;; Files last, means first in the Displays menu |
| 211 | ("files" speedbar-easymenu-definition-special speedbar-file-key-map |
| 212 | speedbar-directory-buttons speedbar-default-directory-list) |
| 213 | ) |
| 214 | "List of named expansion elements for filling the speedbar frame. |
| 215 | These expansion lists are only valid for regular files. Special modes |
| 216 | still get to override this list on a mode-by-mode basis. This list of |
| 217 | lists is of the form (NAME MENU KEYMAP FN1 FN2 ...). NAME is a string |
| 218 | representing the types of things to be displayed. MENU is an easymenu |
| 219 | structure used when in this mode. KEYMAP is a local keymap to install |
| 220 | over the regular speedbar keymap. FN1 ... are functions that will be |
| 221 | called in order. These functions will always get the default |
| 222 | directory to use passed in as the first parameter, and a 0 as the |
| 223 | second parameter. The 0 indicates the uppermost indentation level. |
| 224 | They must assume that the cursor is at the position where they start |
| 225 | inserting buttons.") |
| 226 | |
| 227 | (defvar speedbar-initial-expansion-list-name "files" |
| 228 | "A symbol name representing the expansion list to use. |
| 229 | The expansion list `speedbar-initial-expansion-mode-alist' contains |
| 230 | the names and associated functions to use for buttons in speedbar.") |
| 231 | |
| 232 | (defvar speedbar-previously-used-expansion-list-name "files" |
| 233 | "Save the last expansion list method. |
| 234 | This is used for returning to a previous expansion list method when |
| 235 | the user is done with the current expansion list.") |
| 236 | |
| 237 | (defvar speedbar-stealthy-function-list |
| 238 | '(("files" |
| 239 | speedbar-update-current-file speedbar-check-vc speedbar-check-objects) |
| 240 | ) |
| 241 | "List of functions to periodically call stealthily. |
| 242 | This list is of the form: |
| 243 | '( (\"NAME\" FUNCTION ...) |
| 244 | ...) |
| 245 | where NAME is the name of the major display mode these functions are |
| 246 | for, and the remaining elements FUNCTION are functions to call in order. |
| 247 | Each function must return nil if interrupted, or t if completed. |
| 248 | Stealthy functions which have a single operation should always return |
| 249 | t. Functions which take a long time should maintain a state (where |
| 250 | they are in their speedbar related calculations) and permit |
| 251 | interruption. See `speedbar-check-vc' as a good example.") |
| 252 | |
| 253 | (defvar speedbar-mode-functions-list |
| 254 | '(("files" (speedbar-item-info . speedbar-files-item-info) |
| 255 | (speedbar-line-path . speedbar-files-line-path)) |
| 256 | ("buffers" (speedbar-item-info . speedbar-buffers-item-info) |
| 257 | (speedbar-line-path . speedbar-buffers-line-path)) |
| 258 | ("quick buffers" (speedbar-item-info . speedbar-buffers-item-info) |
| 259 | (speedbar-line-path . speedbar-buffers-line-path)) |
| 260 | ) |
| 261 | "List of function tables to use for different major display modes. |
| 262 | It is not necessary to define any functions for a specialized mode. |
| 263 | This just provides a simple way of adding lots of customizations. |
| 264 | Each sublist is of the form: |
| 265 | (\"NAME\" (FUNCTIONSYMBOL . REPLACEMENTFUNCTION) ...) |
| 266 | Where NAME is the name of the specialized mode. The rest of the list |
| 267 | is a set of dotted pairs of the form FUNCTIONSYMBOL, which is the name |
| 268 | of a function you would like to replace, and REPLACEMENTFUNCTION, |
| 269 | which is a function you can call instead. Not all functions can be |
| 270 | replaced this way. Replaceable functions must provide that |
| 271 | functionality individually.") |
| 272 | |
| 273 | (defcustom speedbar-mode-specific-contents-flag t |
| 274 | "*Non-nil means speedbar will show special mode contents. |
| 275 | This permits some modes to create customized contents for the speedbar |
| 276 | frame." |
| 277 | :group 'speedbar |
| 278 | :type 'boolean) |
| 279 | |
| 280 | (defvar speedbar-special-mode-expansion-list nil |
| 281 | "Default function list for creating specialized button lists. |
| 282 | This list is set by modes that wish to have special speedbar displays. |
| 283 | The list is of function names. Each function is called with one |
| 284 | parameter BUFFER, the originating buffer. The current buffer is the |
| 285 | speedbar buffer.") |
| 286 | |
| 287 | (defvar speedbar-special-mode-key-map nil |
| 288 | "Default keymap used when identifying a specialized display mode. |
| 289 | This keymap is local to each buffer that wants to define special keybindings |
| 290 | effective when it's display is shown.") |
| 291 | |
| 292 | (defcustom speedbar-visiting-file-hook nil |
| 293 | "Hooks run when speedbar visits a file in the selected frame." |
| 294 | :group 'speedbar |
| 295 | :type 'hook) |
| 296 | |
| 297 | (defcustom speedbar-visiting-tag-hook '(speedbar-highlight-one-tag-line) |
| 298 | "Hooks run when speedbar visits a tag in the selected frame." |
| 299 | :group 'speedbar |
| 300 | :type 'hook |
| 301 | :options '(speedbar-highlight-one-tag-line |
| 302 | speedbar-recenter-to-top |
| 303 | speedbar-recenter |
| 304 | )) |
| 305 | |
| 306 | (defcustom speedbar-load-hook nil |
| 307 | "Hooks run when speedbar is loaded." |
| 308 | :group 'speedbar |
| 309 | :type 'hook) |
| 310 | |
| 311 | (defcustom speedbar-reconfigure-keymaps-hook nil |
| 312 | "Hooks run when the keymaps are regenerated." |
| 313 | :group 'speedbar |
| 314 | :type 'hook) |
| 315 | |
| 316 | (defcustom speedbar-show-unknown-files nil |
| 317 | "*Non-nil show files we can't expand with a ? in the expand button. |
| 318 | nil means don't show the file in the list." |
| 319 | :group 'speedbar |
| 320 | :type 'boolean) |
| 321 | |
| 322 | (defcustom speedbar-update-speed |
| 323 | (if speedbar-xemacsp |
| 324 | (if speedbar-xemacs20p |
| 325 | 2 ; 1 is too obrusive in XEmacs |
| 326 | 5) ; when no idleness, need long delay |
| 327 | 1) |
| 328 | "*Idle time in seconds needed before speedbar will update itself. |
| 329 | Updates occur to allow speedbar to display directory information |
| 330 | relevant to the buffer you are currently editing." |
| 331 | :group 'speedbar |
| 332 | :type 'integer) |
| 333 | |
| 334 | ;; When I moved to a repeating timer, I had the horrible missfortune |
| 335 | ;; of loosing the ability for adaptive speed choice. This update |
| 336 | ;; speed currently causes long delays when it should have been turned off. |
| 337 | (defcustom speedbar-navigating-speed speedbar-update-speed |
| 338 | "*Idle time to wait after navigation commands in speedbar are executed. |
| 339 | Navigation commands included expanding/contracting nodes, and moving |
| 340 | between different directories." |
| 341 | :group 'speedbar |
| 342 | :type 'integer) |
| 343 | |
| 344 | (defcustom speedbar-frame-parameters '((minibuffer . nil) |
| 345 | (width . 20) |
| 346 | (border-width . 0) |
| 347 | (menu-bar-lines . 0) |
| 348 | (unsplittable . t)) |
| 349 | "*Parameters to use when creating the speedbar frame in Emacs. |
| 350 | Any parameter supported by a frame may be added. The parameter `height' |
| 351 | will be initialized to the height of the frame speedbar is |
| 352 | attached to and added to this list before the new frame is initialized." |
| 353 | :group 'speedbar |
| 354 | :type '(repeat (sexp :tag "Parameter:"))) |
| 355 | |
| 356 | ;; These values by Hrvoje Niksic <hniksic@srce.hr> |
| 357 | (defcustom speedbar-frame-plist |
| 358 | '(minibuffer nil width 20 border-width 0 |
| 359 | internal-border-width 0 unsplittable t |
| 360 | default-toolbar-visible-p nil has-modeline-p nil |
| 361 | menubar-visible-p nil) |
| 362 | "*Parameters to use when creating the speedbar frame in XEmacs. |
| 363 | Parameters not listed here which will be added automatically are |
| 364 | `height' which will be initialized to the height of the frame speedbar |
| 365 | is attached to." |
| 366 | :group 'speedbar |
| 367 | :type '(repeat (group :inline t |
| 368 | (symbol :tag "Property") |
| 369 | (sexp :tag "Value")))) |
| 370 | |
| 371 | (defcustom speedbar-use-imenu-flag (stringp (locate-library "imenu")) |
| 372 | "*Non-nil means use imenu for file parsing. nil to use etags. |
| 373 | XEmacs prior to 20.4 doesn't support imenu, therefore the default is to |
| 374 | use etags instead. Etags support is not as robust as imenu support." |
| 375 | :tag "Use Imenu for tags" |
| 376 | :group 'speedbar |
| 377 | :type 'boolean) |
| 378 | |
| 379 | (defvar speedbar-dynamic-tags-function-list |
| 380 | '((speedbar-fetch-dynamic-imenu . speedbar-insert-imenu-list) |
| 381 | (speedbar-fetch-dynamic-etags . speedbar-insert-etags-list)) |
| 382 | "Set to a functions which will return and insert a list of tags. |
| 383 | Each element is of the form ( FETCH . INSERT ) where FETCH |
| 384 | is a funciotn which takes one parameter (the file to tag) and returns a |
| 385 | list of tags. The tag list can be of any form as long as the |
| 386 | corresponding insert method can handle it. If it returns t, then an |
| 387 | error occured, and the next fetch routine is tried. |
| 388 | INSERT is a function which takes an INDENTation level, and a LIST of |
| 389 | tags to insert. It will then create the speedbar buttons.") |
| 390 | |
| 391 | (defcustom speedbar-track-mouse-flag t |
| 392 | "*Non-nil means to display info about the line under the mouse." |
| 393 | :group 'speedbar |
| 394 | :type 'boolean) |
| 395 | |
| 396 | (defcustom speedbar-sort-tags nil |
| 397 | "*If Non-nil, sort tags in the speedbar display. *Obsolete*." |
| 398 | :group 'speedbar |
| 399 | :type 'boolean) |
| 400 | |
| 401 | (defcustom speedbar-tag-hierarchy-method |
| 402 | '(speedbar-prefix-group-tag-hierarchy |
| 403 | speedbar-trim-words-tag-hierarchy) |
| 404 | "*List of hooks which speedbar will use to organize tags into groups. |
| 405 | Groups are defined as expandable meta-tags. Imenu supports |
| 406 | such things in some languages, such as separating variables from |
| 407 | functions. Each hook takes one argument LST, and may destructivly |
| 408 | create a new list of the same form. LST is a list of elements of the |
| 409 | form: |
| 410 | (ELT1 ELT2 ... ELTn) |
| 411 | where each ELT is of the form |
| 412 | (TAG-NAME-STRING . NUMBER-OR-MARKER) |
| 413 | or |
| 414 | (GROUP-NAME-STRING ELT1 EL2... ELTn)" |
| 415 | :group 'speedbar |
| 416 | :type 'hook |
| 417 | :options '(speedbar-sort-tag-hierarchy |
| 418 | speedbar-trim-words-tag-hierarchy |
| 419 | speedbar-prefix-group-tag-hierarchy |
| 420 | speedbar-simple-group-tag-hierarchy) |
| 421 | ) |
| 422 | |
| 423 | (defcustom speedbar-tag-group-name-minimum-length 4 |
| 424 | "*The minimum length of a prefix group name before expanding. |
| 425 | Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group' |
| 426 | and one such groups common characters is less than this number of |
| 427 | characters, then the group name will be changed to the form of: |
| 428 | worda to wordb |
| 429 | instead of just |
| 430 | word |
| 431 | This way we won't get silly looking listings." |
| 432 | :group 'speedbar |
| 433 | :type 'integer) |
| 434 | |
| 435 | (defcustom speedbar-tag-split-minimum-length 20 |
| 436 | "*Minimum length before we stop trying to create sub-lists in tags. |
| 437 | This is used by all tag-hierarchy methods that break large lists into |
| 438 | sub-lists." |
| 439 | :group 'speedbar |
| 440 | :type 'integer) |
| 441 | |
| 442 | (defcustom speedbar-tag-regroup-maximum-length 10 |
| 443 | "*Maximum length of submenus that are regrouped. |
| 444 | If the regrouping option is used, then if two or more short subgroups |
| 445 | are next to each other, then they are combined until this number of |
| 446 | items is reached." |
| 447 | :group 'speedbar |
| 448 | :type 'integer) |
| 449 | |
| 450 | (defcustom speedbar-activity-change-focus-flag nil |
| 451 | "*Non-nil means the selected frame will change based on activity. |
| 452 | Thus, if a file is selected for edit, the buffer will appear in the |
| 453 | selected frame and the focus will change to that frame." |
| 454 | :group 'speedbar |
| 455 | :type 'boolean) |
| 456 | |
| 457 | (defcustom speedbar-directory-button-trim-method 'span |
| 458 | "*Indicates how the directory button will be displayed. |
| 459 | Possible values are: |
| 460 | 'span - span large directories over multiple lines. |
| 461 | 'trim - trim large directories to only show the last few. |
| 462 | nil - no trimming." |
| 463 | :group 'speedbar |
| 464 | :type '(radio (const :tag "Span large directories over mutiple lines." |
| 465 | span) |
| 466 | (const :tag "Trim large directories to only show the last few." |
| 467 | trim) |
| 468 | (const :tag "No trimming." nil))) |
| 469 | |
| 470 | (defcustom speedbar-smart-directory-expand-flag t |
| 471 | "*Non-nil means speedbar should use smart expansion. |
| 472 | Smart expansion only affects when speedbar wants to display a |
| 473 | directory for a file in the attached frame. When smart expansion is |
| 474 | enabled, new directories which are children of a displayed directory |
| 475 | are expanded in the current framework. If nil, then the current |
| 476 | hierarchy would be replaced with the new directory." |
| 477 | :group 'speedbar |
| 478 | :type 'boolean) |
| 479 | |
| 480 | (defcustom speedbar-indentation-width 1 |
| 481 | "*When sub-nodes are expanded, the number of spaces used for indentation." |
| 482 | :group 'speedbar |
| 483 | :type 'integer) |
| 484 | |
| 485 | (defcustom speedbar-hide-button-brackets-flag nil |
| 486 | "*Non-nil means speedbar will hide the brackets around the + or -." |
| 487 | :group 'speedbar |
| 488 | :type 'boolean) |
| 489 | |
| 490 | (defcustom speedbar-use-images (and (or (fboundp 'defimage) |
| 491 | (fboundp 'make-image-specifier)) |
| 492 | (if (fboundp 'display-graphic-p) |
| 493 | (display-graphic-p) |
| 494 | window-system)) |
| 495 | "*Non nil if speedbar should display icons." |
| 496 | :group 'speedbar |
| 497 | :type 'boolean) |
| 498 | |
| 499 | (defcustom speedbar-before-popup-hook nil |
| 500 | "*Hooks called before popping up the speedbar frame." |
| 501 | :group 'speedbar |
| 502 | :type 'hook) |
| 503 | |
| 504 | (defcustom speedbar-before-delete-hook nil |
| 505 | "*Hooks called before deleting the speedbar frame." |
| 506 | :group 'speedbar |
| 507 | :type 'hook) |
| 508 | |
| 509 | (defcustom speedbar-mode-hook nil |
| 510 | "*Hooks called after creating a speedbar buffer." |
| 511 | :group 'speedbar |
| 512 | :type 'hook) |
| 513 | |
| 514 | (defcustom speedbar-timer-hook nil |
| 515 | "*Hooks called after running the speedbar timer function." |
| 516 | :group 'speedbar |
| 517 | :type 'hook) |
| 518 | |
| 519 | (defcustom speedbar-verbosity-level 1 |
| 520 | "*Verbosity level of the speedbar. 0 means say nothing. |
| 521 | 1 means medium level verbosity. 2 and higher are higher levels of |
| 522 | verbosity." |
| 523 | :group 'speedbar |
| 524 | :type 'integer) |
| 525 | |
| 526 | (defvar speedbar-indicator-separator " " |
| 527 | "String separating file text from indicator characters.") |
| 528 | |
| 529 | (defcustom speedbar-vc-do-check t |
| 530 | "*Non-nil check all files in speedbar to see if they have been checked out. |
| 531 | Any file checked out is marked with `speedbar-vc-indicator'" |
| 532 | :group 'speedbar-vc |
| 533 | :type 'boolean) |
| 534 | |
| 535 | (defvar speedbar-vc-indicator "*" |
| 536 | "Text used to mark files which are currently checked out. |
| 537 | Other version control systems can be added by examining the function |
| 538 | `speedbar-vc-path-enable-hook' and `speedbar-vc-in-control-hook'.") |
| 539 | |
| 540 | (defcustom speedbar-vc-path-enable-hook nil |
| 541 | "*Return non-nil if the current path should be checked for Version Control. |
| 542 | Functions in this hook must accept one parameter which is the path |
| 543 | being checked." |
| 544 | :group 'speedbar-vc |
| 545 | :type 'hook) |
| 546 | |
| 547 | (defcustom speedbar-vc-in-control-hook nil |
| 548 | "*Return non-nil if the specified file is under Version Control. |
| 549 | Functions in this hook must accept two parameters. The PATH of the |
| 550 | current file, and the FILENAME of the file being checked." |
| 551 | :group 'speedbar-vc |
| 552 | :type 'hook) |
| 553 | |
| 554 | (defvar speedbar-vc-to-do-point nil |
| 555 | "Local variable maintaining the current version control check position.") |
| 556 | |
| 557 | (defcustom speedbar-obj-do-check t |
| 558 | "*Non-nil check all files in speedbar to see if they have an object file. |
| 559 | Any file checked out is marked with `speedbar-obj-indicator', and the |
| 560 | marking is based on `speedbar-obj-alist'" |
| 561 | :group 'speedbar-vc |
| 562 | :type 'boolean) |
| 563 | |
| 564 | (defvar speedbar-obj-to-do-point nil |
| 565 | "Local variable maintaining the current version control check position.") |
| 566 | |
| 567 | (defvar speedbar-obj-indicator '("#" . "!") |
| 568 | "Text used to mark files that have a corresponding hidden object file. |
| 569 | The car is for an up-to-date object. The cdr is for an out of date object. |
| 570 | The expression `speedbar-obj-alist' defines who gets tagged.") |
| 571 | |
| 572 | (defvar speedbar-obj-alist |
| 573 | '(("\\.\\([cpC]\\|cpp\\|cc\\)$" . ".o") |
| 574 | ("\\.el$" . ".elc") |
| 575 | ("\\.java$" . ".class") |
| 576 | ("\\.f\\(or\\|90\\|77\\)?$" . ".o") |
| 577 | ("\\.tex$" . ".dvi") |
| 578 | ("\\.texi$" . ".info")) |
| 579 | "Alist of file extensions, and their corresponding object file type.") |
| 580 | |
| 581 | (defvar speedbar-indicator-regex |
| 582 | (concat (regexp-quote speedbar-indicator-separator) |
| 583 | "\\(" |
| 584 | (regexp-quote speedbar-vc-indicator) |
| 585 | "\\|" |
| 586 | (regexp-quote (car speedbar-obj-indicator)) |
| 587 | "\\|" |
| 588 | (regexp-quote (cdr speedbar-obj-indicator)) |
| 589 | "\\)*") |
| 590 | "Regular expression used when identifying files. |
| 591 | Permits stripping of indicator characters from a line.") |
| 592 | |
| 593 | (defcustom speedbar-scanner-reset-hook nil |
| 594 | "*Hook called whenever generic scanners are reset. |
| 595 | Set this to implement your own scanning / rescan safe functions with |
| 596 | state data." |
| 597 | :group 'speedbar |
| 598 | :type 'hook) |
| 599 | |
| 600 | (defvar speedbar-ignored-modes nil |
| 601 | "*List of major modes which speedbar will not switch directories for.") |
| 602 | |
| 603 | (defun speedbar-extension-list-to-regex (extlist) |
| 604 | "Takes EXTLIST, a list of extensions and transforms it into regexp. |
| 605 | All the preceding `.' are stripped for an optimized expression starting |
| 606 | with `.' followed by extensions, followed by full-filenames." |
| 607 | (let ((regex1 nil) (regex2 nil)) |
| 608 | (while extlist |
| 609 | (if (= (string-to-char (car extlist)) ?.) |
| 610 | (setq regex1 (concat regex1 (if regex1 "\\|" "") |
| 611 | (substring (car extlist) 1))) |
| 612 | (setq regex2 (concat regex2 (if regex2 "\\|" "") (car extlist)))) |
| 613 | (setq extlist (cdr extlist))) |
| 614 | ;; concat all the sub-exressions together, making sure all types |
| 615 | ;; of parts exist during concatination. |
| 616 | (concat "\\(" |
| 617 | (if regex1 (concat "\\(\\.\\(" regex1 "\\)\\)") "") |
| 618 | (if (and regex1 regex2) "\\|" "") |
| 619 | (if regex2 (concat "\\(" regex2 "\\)") "") |
| 620 | "\\)$"))) |
| 621 | |
| 622 | (defvar speedbar-ignored-path-regexp nil |
| 623 | "Regular expression matching paths speedbar will not switch to. |
| 624 | Created from `speedbar-ignored-path-expressions' with the function |
| 625 | `speedbar-extension-list-to-regex' (A misnamed function in this case.) |
| 626 | Use the function `speedbar-add-ignored-path-regexp', or customize the |
| 627 | variable `speedbar-ignored-path-expressions' to modify this variable.") |
| 628 | |
| 629 | (defcustom speedbar-ignored-path-expressions |
| 630 | '("[/\\]logs?[/\\]\\'") |
| 631 | "*List of regular expressions matching directories speedbar will ignore. |
| 632 | They should included paths to directories which are notoriously very |
| 633 | large and take a long time to load in. Use the function |
| 634 | `speedbar-add-ignored-path-regexp' to add new items to this list after |
| 635 | speedbar is loaded. You may place anything you like in this list |
| 636 | before speedbar has been loaded." |
| 637 | :group 'speedbar |
| 638 | :type '(repeat (regexp :tag "Path Regexp")) |
| 639 | :set (lambda (sym val) |
| 640 | (setq speedbar-ignored-path-expressions val |
| 641 | speedbar-ignored-path-regexp |
| 642 | (speedbar-extension-list-to-regex val)))) |
| 643 | |
| 644 | (defcustom speedbar-directory-unshown-regexp "^\\(CVS\\|RCS\\|SCCS\\)\\'" |
| 645 | "*Regular expression matching directories not to show in speedbar. |
| 646 | They should include commonly existing directories which are not |
| 647 | useful, such as version control." |
| 648 | :group 'speedbar |
| 649 | :type 'string) |
| 650 | |
| 651 | (defvar speedbar-file-unshown-regexp |
| 652 | (let ((nstr "") (noext completion-ignored-extensions)) |
| 653 | (while noext |
| 654 | (setq nstr (concat nstr (regexp-quote (car noext)) "\\'" |
| 655 | (if (cdr noext) "\\|" "")) |
| 656 | noext (cdr noext))) |
| 657 | ;; backup refdir lockfile |
| 658 | (concat nstr "\\|#[^#]+#$\\|\\.\\.?\\'\\|\\.#")) |
| 659 | "*Regexp matching files we don't want displayed in a speedbar buffer. |
| 660 | It is generated from the variable `completion-ignored-extensions'") |
| 661 | |
| 662 | ;; this is dangerous to customize, because the defaults will probably |
| 663 | ;; change in the future. |
| 664 | (defcustom speedbar-supported-extension-expressions |
| 665 | (append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?" |
| 666 | ".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?") |
| 667 | (if speedbar-use-imenu-flag |
| 668 | '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py" |
| 669 | ;; html is not supported by default, but an imenu tags package |
| 670 | ;; is available. Also, html files are nice to be able to see. |
| 671 | ".s?html" |
| 672 | "[Mm]akefile\\(\\.in\\)?"))) |
| 673 | "*List of regular expressions which will match files supported by tagging. |
| 674 | Do not prefix the `.' char with a double \\ to quote it, as the period |
| 675 | will be stripped by a simplified optimizer when compiled into a |
| 676 | singular expression. This variable will be turned into |
| 677 | `speedbar-file-regexp' for use with speedbar. You should use the |
| 678 | function `speedbar-add-supported-extension' to add a new extension at |
| 679 | runtime, or use the configuration dialog to set it in your .emacs |
| 680 | file." |
| 681 | :group 'speedbar |
| 682 | :type '(repeat (regexp :tag "Extension Regexp")) |
| 683 | :set (lambda (sym val) |
| 684 | (setq speedbar-supported-extension-expressions val |
| 685 | speedbar-file-regexp (speedbar-extension-list-to-regex val))) |
| 686 | ) |
| 687 | |
| 688 | (defvar speedbar-file-regexp |
| 689 | (speedbar-extension-list-to-regex speedbar-supported-extension-expressions) |
| 690 | "Regular expression matching files we know how to expand. |
| 691 | Created from `speedbar-supported-extension-expression' with the |
| 692 | function `speedbar-extension-list-to-regex'") |
| 693 | |
| 694 | (defun speedbar-add-supported-extension (extension) |
| 695 | "Add EXTENSION as a new supported extension for speedbar tagging. |
| 696 | This should start with a `.' if it is not a complete file name, and |
| 697 | the dot should NOT be quoted in with \\. Other regular expression |
| 698 | matchers are allowed however. EXTENSION may be a single string or a |
| 699 | list of strings." |
| 700 | (interactive "sExtionsion: ") |
| 701 | (if (not (listp extension)) (setq extension (list extension))) |
| 702 | (while extension |
| 703 | (if (member (car extension) speedbar-supported-extension-expressions) |
| 704 | nil |
| 705 | (setq speedbar-supported-extension-expressions |
| 706 | (cons (car extension) speedbar-supported-extension-expressions))) |
| 707 | (setq extension (cdr extension))) |
| 708 | (setq speedbar-file-regexp (speedbar-extension-list-to-regex |
| 709 | speedbar-supported-extension-expressions))) |
| 710 | |
| 711 | (defun speedbar-add-ignored-path-regexp (path-expression) |
| 712 | "Add PATH-EXPRESSION as a new ignored path for speedbar tracking. |
| 713 | This function will modify `speedbar-ignored-path-regexp' and add |
| 714 | PATH-EXPRESSION to `speedbar-ignored-path-expressions'." |
| 715 | (interactive "sPath regex: ") |
| 716 | (if (not (listp path-expression)) |
| 717 | (setq path-expression (list path-expression))) |
| 718 | (while path-expression |
| 719 | (if (member (car path-expression) speedbar-ignored-path-expressions) |
| 720 | nil |
| 721 | (setq speedbar-ignored-path-expressions |
| 722 | (cons (car path-expression) speedbar-ignored-path-expressions))) |
| 723 | (setq path-expression (cdr path-expression))) |
| 724 | (setq speedbar-ignored-path-regexp (speedbar-extension-list-to-regex |
| 725 | speedbar-ignored-path-expressions))) |
| 726 | |
| 727 | ;; If we don't have custom, then we set it here by hand. |
| 728 | (if (not (fboundp 'custom-declare-variable)) |
| 729 | (setq speedbar-file-regexp (speedbar-extension-list-to-regex |
| 730 | speedbar-supported-extension-expressions) |
| 731 | speedbar-ignored-path-regexp (speedbar-extension-list-to-regex |
| 732 | speedbar-ignored-path-expressions))) |
| 733 | |
| 734 | (defvar speedbar-update-flag (and |
| 735 | (or (fboundp 'run-with-idle-timer) |
| 736 | (fboundp 'start-itimer) |
| 737 | (boundp 'post-command-idle-hook)) |
| 738 | (if (fboundp 'display-graphic-p) |
| 739 | (display-graphic-p) |
| 740 | window-system)) |
| 741 | "*Non-nil means to automatically update the display. |
| 742 | When this is nil then speedbar will not follow the attached frame's path. |
| 743 | When speedbar is active, use: |
| 744 | |
| 745 | \\<speedbar-key-map> `\\[speedbar-toggle-updates]' |
| 746 | |
| 747 | to toggle this value.") |
| 748 | |
| 749 | (defvar speedbar-syntax-table nil |
| 750 | "Syntax-table used on the speedbar.") |
| 751 | |
| 752 | (if speedbar-syntax-table |
| 753 | nil |
| 754 | (setq speedbar-syntax-table (make-syntax-table)) |
| 755 | ;; turn off paren matching around here. |
| 756 | (modify-syntax-entry ?\' " " speedbar-syntax-table) |
| 757 | (modify-syntax-entry ?\" " " speedbar-syntax-table) |
| 758 | (modify-syntax-entry ?( " " speedbar-syntax-table) |
| 759 | (modify-syntax-entry ?) " " speedbar-syntax-table) |
| 760 | (modify-syntax-entry ?{ " " speedbar-syntax-table) |
| 761 | (modify-syntax-entry ?} " " speedbar-syntax-table) |
| 762 | (modify-syntax-entry ?[ " " speedbar-syntax-table) |
| 763 | (modify-syntax-entry ?] " " speedbar-syntax-table)) |
| 764 | |
| 765 | (defvar speedbar-key-map nil |
| 766 | "Keymap used in speedbar buffer.") |
| 767 | |
| 768 | (if speedbar-key-map |
| 769 | nil |
| 770 | (setq speedbar-key-map (make-keymap)) |
| 771 | (suppress-keymap speedbar-key-map t) |
| 772 | |
| 773 | ;; control |
| 774 | (define-key speedbar-key-map "g" 'speedbar-refresh) |
| 775 | (define-key speedbar-key-map "t" 'speedbar-toggle-updates) |
| 776 | (define-key speedbar-key-map "q" 'speedbar-close-frame) |
| 777 | (define-key speedbar-key-map "Q" 'delete-frame) |
| 778 | |
| 779 | ;; navigation |
| 780 | (define-key speedbar-key-map "n" 'speedbar-next) |
| 781 | (define-key speedbar-key-map "p" 'speedbar-prev) |
| 782 | (define-key speedbar-key-map "\M-n" 'speedbar-restricted-next) |
| 783 | (define-key speedbar-key-map "\M-p" 'speedbar-restricted-prev) |
| 784 | (define-key speedbar-key-map "\C-\M-n" 'speedbar-forward-list) |
| 785 | (define-key speedbar-key-map "\C-\M-p" 'speedbar-backward-list) |
| 786 | (define-key speedbar-key-map " " 'speedbar-scroll-up) |
| 787 | (define-key speedbar-key-map [delete] 'speedbar-scroll-down) |
| 788 | |
| 789 | ;; Short cuts I happen to find useful |
| 790 | (define-key speedbar-key-map "r" |
| 791 | (lambda () (interactive) |
| 792 | (speedbar-change-initial-expansion-list |
| 793 | speedbar-previously-used-expansion-list-name))) |
| 794 | (define-key speedbar-key-map "b" |
| 795 | (lambda () (interactive) |
| 796 | (speedbar-change-initial-expansion-list "quick buffers"))) |
| 797 | (define-key speedbar-key-map "f" |
| 798 | (lambda () (interactive) |
| 799 | (speedbar-change-initial-expansion-list "files"))) |
| 800 | |
| 801 | ;; Overrides |
| 802 | (substitute-key-definition 'switch-to-buffer |
| 803 | 'speedbar-switch-buffer-attached-frame |
| 804 | speedbar-key-map global-map) |
| 805 | |
| 806 | (if speedbar-xemacsp |
| 807 | (progn |
| 808 | ;; mouse bindings so we can manipulate the items on each line |
| 809 | (define-key speedbar-key-map 'button2 'speedbar-click) |
| 810 | (define-key speedbar-key-map '(shift button2) 'speedbar-power-click) |
| 811 | ;; Info doc fix from Bob Weiner |
| 812 | (if (featurep 'infodoc) |
| 813 | nil |
| 814 | (define-key speedbar-key-map 'button3 'speedbar-xemacs-popup-kludge)) |
| 815 | (define-key speedbar-key-map '(meta button3) 'speedbar-mouse-item-info) |
| 816 | ) |
| 817 | |
| 818 | ;; mouse bindings so we can manipulate the items on each line |
| 819 | (define-key speedbar-key-map [down-mouse-1] 'speedbar-double-click) |
| 820 | (define-key speedbar-key-map [mouse-2] 'speedbar-click) |
| 821 | ;; This is the power click for new frames, or refreshing a cache |
| 822 | (define-key speedbar-key-map [S-mouse-2] 'speedbar-power-click) |
| 823 | ;; This adds a small unecessary visual effect |
| 824 | ;;(define-key speedbar-key-map [down-mouse-2] 'speedbar-quick-mouse) |
| 825 | (define-key speedbar-key-map [M-mouse-2] 'speedbar-mouse-item-info) |
| 826 | |
| 827 | (define-key speedbar-key-map [down-mouse-3] 'speedbar-emacs-popup-kludge) |
| 828 | |
| 829 | ;; This lets the user scroll as if we had a scrollbar... well maybe not |
| 830 | (define-key speedbar-key-map [mode-line mouse-2] 'speedbar-mouse-hscroll) |
| 831 | ;; another handy place users might click to get our menu. |
| 832 | (define-key speedbar-key-map [mode-line down-mouse-1] |
| 833 | 'speedbar-emacs-popup-kludge) |
| 834 | |
| 835 | ;; We can't switch buffers with the buffer mouse menu. Lets hack it. |
| 836 | (define-key speedbar-key-map [C-down-mouse-1] 'speedbar-hack-buffer-menu) |
| 837 | |
| 838 | ;; Lastly, we want to track the mouse. Play here |
| 839 | (define-key speedbar-key-map [mouse-movement] 'speedbar-track-mouse) |
| 840 | )) |
| 841 | |
| 842 | (defun speedbar-make-specialized-keymap () |
| 843 | "Create a keymap for use w/ a speedbar major or minor display mode. |
| 844 | This basically creates a sparse keymap, and makes it's parent be |
| 845 | `speedbar-key-map'." |
| 846 | (let ((k (make-sparse-keymap))) |
| 847 | (set-keymap-parent k speedbar-key-map) |
| 848 | k)) |
| 849 | |
| 850 | (defvar speedbar-file-key-map nil |
| 851 | "Keymap used in speedbar buffer while files are displayed.") |
| 852 | |
| 853 | (if speedbar-file-key-map |
| 854 | nil |
| 855 | (setq speedbar-file-key-map (speedbar-make-specialized-keymap)) |
| 856 | |
| 857 | ;; Basic tree features |
| 858 | (define-key speedbar-file-key-map "e" 'speedbar-edit-line) |
| 859 | (define-key speedbar-file-key-map "\C-m" 'speedbar-edit-line) |
| 860 | (define-key speedbar-file-key-map "+" 'speedbar-expand-line) |
| 861 | (define-key speedbar-file-key-map "=" 'speedbar-expand-line) |
| 862 | (define-key speedbar-file-key-map "-" 'speedbar-contract-line) |
| 863 | |
| 864 | ;; file based commands |
| 865 | (define-key speedbar-file-key-map "U" 'speedbar-up-directory) |
| 866 | (define-key speedbar-file-key-map "I" 'speedbar-item-info) |
| 867 | (define-key speedbar-file-key-map "B" 'speedbar-item-byte-compile) |
| 868 | (define-key speedbar-file-key-map "L" 'speedbar-item-load) |
| 869 | (define-key speedbar-file-key-map "C" 'speedbar-item-copy) |
| 870 | (define-key speedbar-file-key-map "D" 'speedbar-item-delete) |
| 871 | (define-key speedbar-file-key-map "O" 'speedbar-item-object-delete) |
| 872 | (define-key speedbar-file-key-map "R" 'speedbar-item-rename) |
| 873 | ) |
| 874 | |
| 875 | (defvar speedbar-easymenu-definition-base |
| 876 | (append |
| 877 | '("Speedbar" |
| 878 | ["Update" speedbar-refresh t] |
| 879 | ["Auto Update" speedbar-toggle-updates |
| 880 | :style toggle :selected speedbar-update-flag]) |
| 881 | (if (and (or (fboundp 'defimage) |
| 882 | (fboundp 'make-image-specifier)) |
| 883 | (if (fboundp 'display-graphic-p) |
| 884 | (display-graphic-p) |
| 885 | window-system)) |
| 886 | (list |
| 887 | ["Use Images" speedbar-toggle-images |
| 888 | :style toggle :selected speedbar-use-images])) |
| 889 | ) |
| 890 | "Base part of the speedbar menu.") |
| 891 | |
| 892 | (defvar speedbar-easymenu-definition-special |
| 893 | '(["Edit Item On Line" speedbar-edit-line t] |
| 894 | ["Show All Files" speedbar-toggle-show-all-files |
| 895 | :style toggle :selected speedbar-show-unknown-files] |
| 896 | ["Expand File Tags" speedbar-expand-line |
| 897 | (save-excursion (beginning-of-line) |
| 898 | (looking-at "[0-9]+: *.\\+. "))] |
| 899 | ["Flush Cache & Expand" speedbar-flush-expand-line |
| 900 | (save-excursion (beginning-of-line) |
| 901 | (looking-at "[0-9]+: *.\\+. "))] |
| 902 | ["Contract File Tags" speedbar-contract-line |
| 903 | (save-excursion (beginning-of-line) |
| 904 | (looking-at "[0-9]+: *.-. "))] |
| 905 | ; ["Sort Tags" speedbar-toggle-sorting |
| 906 | ; :style toggle :selected speedbar-sort-tags] |
| 907 | "----" |
| 908 | ["File/Tag Information" speedbar-item-info t] |
| 909 | ["Load Lisp File" speedbar-item-load |
| 910 | (save-excursion |
| 911 | (beginning-of-line) |
| 912 | (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))] |
| 913 | ["Byte Compile File" speedbar-item-byte-compile |
| 914 | (save-excursion |
| 915 | (beginning-of-line) |
| 916 | (looking-at "[0-9]+: *\\[[+-]\\] .+\\(\\.el\\)\\( \\|$\\)"))] |
| 917 | ["Copy File" speedbar-item-copy |
| 918 | (save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))] |
| 919 | ["Rename File" speedbar-item-rename |
| 920 | (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))] |
| 921 | ["Delete File" speedbar-item-delete |
| 922 | (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))] |
| 923 | ["Delete Object" speedbar-item-object-delete |
| 924 | (save-excursion (beginning-of-line) |
| 925 | (looking-at "[0-9]+: *\\[[+-]\\] [^ \n]+ \\*?[!#]$"))] |
| 926 | ) |
| 927 | "Additional menu items while in file-mode.") |
| 928 | |
| 929 | (defvar speedbar-easymenu-definition-trailer |
| 930 | (append |
| 931 | (if (and (featurep 'custom) (fboundp 'custom-declare-variable)) |
| 932 | (list ["Customize..." speedbar-customize t])) |
| 933 | (list |
| 934 | ["Close" speedbar-close-frame t] |
| 935 | ["Quit" delete-frame t] )) |
| 936 | "Menu items appearing at the end of the speedbar menu.") |
| 937 | |
| 938 | (defvar speedbar-desired-buffer nil |
| 939 | "Non-nil when speedbar is showing buttons specific a special mode. |
| 940 | In this case it is the originating buffer.") |
| 941 | (defvar speedbar-buffer nil |
| 942 | "The buffer displaying the speedbar.") |
| 943 | (defvar speedbar-frame nil |
| 944 | "The frame displaying speedbar.") |
| 945 | (defvar speedbar-cached-frame nil |
| 946 | "The frame that was last created, then removed from the display.") |
| 947 | (defvar speedbar-full-text-cache nil |
| 948 | "The last open directory is saved in its entirety for ultra-fast switching.") |
| 949 | (defvar speedbar-timer nil |
| 950 | "The speedbar timer used for updating the buffer.") |
| 951 | (defvar speedbar-attached-frame nil |
| 952 | "The frame which started speedbar mode. |
| 953 | This is the frame from which all data displayed in the speedbar is |
| 954 | gathered, and in which files and such are displayed.") |
| 955 | |
| 956 | (defvar speedbar-last-selected-file nil |
| 957 | "The last file which was selected in speedbar buffer.") |
| 958 | |
| 959 | (defvar speedbar-shown-directories nil |
| 960 | "Maintain list of directories simultaneously open in the current speedbar.") |
| 961 | |
| 962 | (defvar speedbar-directory-contents-alist nil |
| 963 | "An association list of directories and their contents. |
| 964 | Each sublist was returned by `speedbar-file-lists'. This list is |
| 965 | maintained to speed up the refresh rate when switching between |
| 966 | directories.") |
| 967 | |
| 968 | (defvar speedbar-power-click nil |
| 969 | "Never set this by hand. Value is t when S-mouse activity occurs.") |
| 970 | |
| 971 | \f |
| 972 | ;;; Compatibility |
| 973 | ;; |
| 974 | (if (fboundp 'frame-parameter) |
| 975 | |
| 976 | (defalias 'speedbar-frame-parameter 'frame-parameter) |
| 977 | |
| 978 | (defun speedbar-frame-parameter (frame parameter) |
| 979 | "Return FRAME's PARAMETER value." |
| 980 | (cdr (assoc parameter (frame-parameters frame))))) |
| 981 | |
| 982 | (if (fboundp 'make-overlay) |
| 983 | (progn |
| 984 | (defalias 'speedbar-make-overlay 'make-overlay) |
| 985 | (defalias 'speedbar-overlay-put 'overlay-put) |
| 986 | (defalias 'speedbar-delete-overlay 'delete-overlay) |
| 987 | (defalias 'speedbar-overlay-start 'overlay-start) |
| 988 | (defalias 'speedbar-overlay-end 'overlay-end) |
| 989 | (defalias 'speedbar-mode-line-update 'force-mode-line-update)) |
| 990 | (defalias 'speedbar-make-overlay 'make-extent) |
| 991 | (defalias 'speedbar-overlay-put 'set-extent-property) |
| 992 | (defalias 'speedbar-delete-overlay 'delete-extent) |
| 993 | (defalias 'speedbar-overlay-start 'extent-start) |
| 994 | (defalias 'speedbar-overlay-end 'extent-end) |
| 995 | (defalias 'speedbar-mode-line-update 'redraw-modeline)) |
| 996 | \f |
| 997 | ;;; Mode definitions/ user commands |
| 998 | ;; |
| 999 | |
| 1000 | ;;;###autoload |
| 1001 | (defalias 'speedbar 'speedbar-frame-mode) |
| 1002 | ;;;###autoload |
| 1003 | (defun speedbar-frame-mode (&optional arg) |
| 1004 | "Enable or disable speedbar. Positive ARG means turn on, negative turn off. |
| 1005 | nil means toggle. Once the speedbar frame is activated, a buffer in |
| 1006 | `speedbar-mode' will be displayed. Currently, only one speedbar is |
| 1007 | supported at a time. |
| 1008 | `speedbar-before-popup-hook' is called before popping up the speedbar frame. |
| 1009 | `speedbar-before-delete-hook' is called before the frame is deleted." |
| 1010 | (interactive "P") |
| 1011 | ;; toggle frame on and off. |
| 1012 | (if (not arg) (if (and (frame-live-p speedbar-frame) |
| 1013 | (frame-visible-p speedbar-frame)) |
| 1014 | (setq arg -1) (setq arg 1))) |
| 1015 | ;; turn the frame off on neg number |
| 1016 | (if (and (numberp arg) (< arg 0)) |
| 1017 | (progn |
| 1018 | (run-hooks 'speedbar-before-delete-hook) |
| 1019 | (if (and speedbar-frame (frame-live-p speedbar-frame)) |
| 1020 | (progn |
| 1021 | (setq speedbar-cached-frame speedbar-frame) |
| 1022 | (make-frame-invisible speedbar-frame))) |
| 1023 | (setq speedbar-frame nil) |
| 1024 | (speedbar-set-timer nil) |
| 1025 | ;; Used to delete the buffer. This has the annoying affect of |
| 1026 | ;; preventing whatever took its place from ever appearing |
| 1027 | ;; as the default after a C-x b was typed |
| 1028 | ;;(if (bufferp speedbar-buffer) |
| 1029 | ;; (kill-buffer speedbar-buffer)) |
| 1030 | ) |
| 1031 | ;; Set this as our currently attached frame |
| 1032 | (setq speedbar-attached-frame (selected-frame)) |
| 1033 | (run-hooks 'speedbar-before-popup-hook) |
| 1034 | ;; Get the frame to work in |
| 1035 | (if (frame-live-p speedbar-cached-frame) |
| 1036 | (progn |
| 1037 | (setq speedbar-frame speedbar-cached-frame) |
| 1038 | (make-frame-visible speedbar-frame) |
| 1039 | ;; Get the buffer to play with |
| 1040 | (speedbar-mode) |
| 1041 | (select-frame speedbar-frame) |
| 1042 | (if (not (eq (current-buffer) speedbar-buffer)) |
| 1043 | (switch-to-buffer speedbar-buffer)) |
| 1044 | (set-window-dedicated-p (selected-window) t) |
| 1045 | (raise-frame speedbar-frame) |
| 1046 | (speedbar-set-timer speedbar-update-speed) |
| 1047 | ) |
| 1048 | (if (frame-live-p speedbar-frame) |
| 1049 | (raise-frame speedbar-frame) |
| 1050 | (setq speedbar-frame |
| 1051 | (if speedbar-xemacsp |
| 1052 | ;; Only guess height if it is not specified. |
| 1053 | (if (member 'height speedbar-frame-plist) |
| 1054 | (make-frame speedbar-frame-plist) |
| 1055 | (make-frame (nconc (list 'height |
| 1056 | (speedbar-needed-height)) |
| 1057 | speedbar-frame-plist))) |
| 1058 | (let* ((mh (speedbar-frame-parameter nil 'menu-bar-lines)) |
| 1059 | (cfx (speedbar-frame-parameter nil 'left)) |
| 1060 | (cfy (speedbar-frame-parameter nil 'top)) |
| 1061 | (cfw (frame-pixel-width)) |
| 1062 | (params |
| 1063 | ;; Only add a guessed height if one is not specified |
| 1064 | ;; in the input parameters. |
| 1065 | (if (assoc 'height speedbar-frame-parameters) |
| 1066 | speedbar-frame-parameters |
| 1067 | (append |
| 1068 | speedbar-frame-parameters |
| 1069 | (list (cons 'height (+ mh (frame-height))))))) |
| 1070 | (frame |
| 1071 | (if (or (< emacs-major-version 20) |
| 1072 | (not (eq window-system 'x))) |
| 1073 | (make-frame params) |
| 1074 | (let ((x-pointer-shape x-pointer-top-left-arrow) |
| 1075 | (x-sensitive-text-pointer-shape |
| 1076 | x-pointer-hand2)) |
| 1077 | (make-frame params))))) |
| 1078 | ;; Position speedbar frame. |
| 1079 | (if (or (not window-system) (eq window-system 'pc) |
| 1080 | (assoc 'left speedbar-frame-parameters) |
| 1081 | (assoc 'top speedbar-frame-parameters)) |
| 1082 | ;; Do no positioning if not on a windowing system, |
| 1083 | ;; or if left/top were specified in the parameters. |
| 1084 | frame |
| 1085 | (let ((cfx |
| 1086 | (if (not (consp cfx)) |
| 1087 | cfx |
| 1088 | ;; If cfx is a list, that means we grow |
| 1089 | ;; from a specific edge of the display. |
| 1090 | ;; Convert that to the distance from the |
| 1091 | ;; left side of the display. |
| 1092 | (if (eq (car cfx) '-) |
| 1093 | ;; A - means distance from the right edge |
| 1094 | ;; of the display, or DW - cfx - framewidth |
| 1095 | (- (x-display-pixel-width) (car (cdr cfx)) |
| 1096 | (frame-pixel-width)) |
| 1097 | (car (cdr cfx)))))) |
| 1098 | (modify-frame-parameters |
| 1099 | frame |
| 1100 | (list |
| 1101 | (cons |
| 1102 | 'left |
| 1103 | ;; Decide which side to put it |
| 1104 | ;; on. 200 is just a buffer |
| 1105 | ;; for the left edge of the |
| 1106 | ;; screen. The extra 10 is just |
| 1107 | ;; dressings for window decorations. |
| 1108 | (let ((sfw (frame-pixel-width frame))) |
| 1109 | (let ((left-guess (- cfx 10 sfw)) |
| 1110 | (right-guess (+ cfx cfw 5))) |
| 1111 | (let ((left-margin left-guess) |
| 1112 | (right-margin |
| 1113 | (- (x-display-pixel-width) |
| 1114 | right-guess 5 sfw))) |
| 1115 | (cond ((>= left-margin 0) left-guess) |
| 1116 | ((>= right-margin 0) right-guess) |
| 1117 | ;; otherwise choose side we overlap less |
| 1118 | ((> left-margin right-margin) 0) |
| 1119 | (t (- (x-display-pixel-width) sfw 5))))))) |
| 1120 | (cons 'top cfy))) |
| 1121 | frame))))) |
| 1122 | ;; reset the selection variable |
| 1123 | (setq speedbar-last-selected-file nil) |
| 1124 | ;; Put the buffer into the frame |
| 1125 | (save-window-excursion |
| 1126 | ;; Get the buffer to play with |
| 1127 | (speedbar-mode) |
| 1128 | (select-frame speedbar-frame) |
| 1129 | (switch-to-buffer speedbar-buffer) |
| 1130 | (set-window-dedicated-p (selected-window) t)) |
| 1131 | (if (and (or (null window-system) (eq window-system 'pc)) |
| 1132 | (fboundp 'set-frame-name)) |
| 1133 | (progn |
| 1134 | (select-frame speedbar-frame) |
| 1135 | (set-frame-name "Speedbar"))) |
| 1136 | (speedbar-set-timer speedbar-update-speed))))) |
| 1137 | |
| 1138 | ;;;###autoload |
| 1139 | (defun speedbar-get-focus () |
| 1140 | "Change frame focus to or from the speedbar frame. |
| 1141 | If the selected frame is not speedbar, then speedbar frame is |
| 1142 | selected. If the speedbar frame is active, then select the attached frame." |
| 1143 | (interactive) |
| 1144 | (if (eq (selected-frame) speedbar-frame) |
| 1145 | (if (frame-live-p speedbar-attached-frame) |
| 1146 | (select-frame speedbar-attached-frame)) |
| 1147 | ;; If updates are off, then refresh the frame (they want it now...) |
| 1148 | (if (not speedbar-update-flag) |
| 1149 | (let ((speedbar-update-flag t)) |
| 1150 | (speedbar-timer-fn))) |
| 1151 | ;; make sure we have a frame |
| 1152 | (if (not (frame-live-p speedbar-frame)) (speedbar-frame-mode 1)) |
| 1153 | ;; go there |
| 1154 | (select-frame speedbar-frame) |
| 1155 | ) |
| 1156 | (other-frame 0)) |
| 1157 | |
| 1158 | (defun speedbar-close-frame () |
| 1159 | "Turn off a currently active speedbar." |
| 1160 | (interactive) |
| 1161 | (speedbar-frame-mode -1) |
| 1162 | (select-frame speedbar-attached-frame) |
| 1163 | (other-frame 0)) |
| 1164 | |
| 1165 | (defun speedbar-switch-buffer-attached-frame (&optional buffer) |
| 1166 | "Switch to BUFFER in speedbar's attached frame, and raise that frame. |
| 1167 | This overrides the default behavior of `switch-to-buffer' which is |
| 1168 | broken because of the dedicated speedbar frame." |
| 1169 | (interactive) |
| 1170 | ;; Assume we are in the speedbar frame. |
| 1171 | (speedbar-get-focus) |
| 1172 | ;; Now switch buffers |
| 1173 | (if buffer |
| 1174 | (switch-to-buffer buffer) |
| 1175 | (call-interactively 'switch-to-buffer nil nil))) |
| 1176 | |
| 1177 | (defmacro speedbar-frame-width () |
| 1178 | "Return the width of the speedbar frame in characters. |
| 1179 | nil if it doesn't exist." |
| 1180 | '(frame-width speedbar-frame)) |
| 1181 | |
| 1182 | ;; XEmacs function only. |
| 1183 | (defun speedbar-needed-height (&optional frame) |
| 1184 | "The needed height for the tool bar FRAME (in characters)." |
| 1185 | (or frame (setq frame (selected-frame))) |
| 1186 | ;; The 1 is the missing modeline/minibuffer |
| 1187 | (+ 1 (/ (frame-pixel-height frame) |
| 1188 | (face-height 'default frame)))) |
| 1189 | |
| 1190 | (defun speedbar-mode () |
| 1191 | "Major mode for managing a display of directories and tags. |
| 1192 | \\<speedbar-key-map> |
| 1193 | The first line represents the default path of the speedbar frame. |
| 1194 | Each directory segment is a button which jumps speedbar's default |
| 1195 | directory to that path. Buttons are activated by clicking `\\[speedbar-click]'. |
| 1196 | In some situations using `\\[speedbar-power-click]' is a `power click' which will |
| 1197 | rescan cached items, or pop up new frames. |
| 1198 | |
| 1199 | Each line starting with <+> represents a directory. Click on the <+> |
| 1200 | to insert the directory listing into the current tree. Click on the |
| 1201 | <-> to retract that list. Click on the directory name to go to that |
| 1202 | directory as the default. |
| 1203 | |
| 1204 | Each line starting with [+] is a file. If the variable |
| 1205 | `speedbar-show-unknown-files' is t, the lines starting with [?] are |
| 1206 | files which don't have imenu support, but are not expressly ignored. |
| 1207 | Files are completely ignored if they match `speedbar-file-unshown-regexp' |
| 1208 | which is generated from `completion-ignored-extensions'. |
| 1209 | |
| 1210 | Files with a `*' character after their name are files checked out of a |
| 1211 | version control system. (currently only RCS is supported.) New |
| 1212 | version control systems can be added by examining the documentation |
| 1213 | for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' |
| 1214 | |
| 1215 | Files with a `#' or `!' character after them are source files that |
| 1216 | have an object file associated with them. The `!' indicates that the |
| 1217 | files is out of date. You can control what source/object associations |
| 1218 | exist through the variable `speedbar-obj-alist'. |
| 1219 | |
| 1220 | Click on the [+] to display a list of tags from that file. Click on |
| 1221 | the [-] to retract the list. Click on the file name to edit the file |
| 1222 | in the attached frame. |
| 1223 | |
| 1224 | If you open tags, you might find a node starting with {+}, which is a |
| 1225 | category of tags. Click the {+} to expand the category. Jump-able |
| 1226 | tags start with >. Click the name of the tag to go to that position |
| 1227 | in the selected file. |
| 1228 | |
| 1229 | \\{speedbar-key-map}" |
| 1230 | ;; NOT interactive |
| 1231 | (save-excursion |
| 1232 | (setq speedbar-buffer (set-buffer (get-buffer-create " SPEEDBAR"))) |
| 1233 | (kill-all-local-variables) |
| 1234 | (setq major-mode 'speedbar-mode) |
| 1235 | (setq mode-name "Speedbar") |
| 1236 | (set-syntax-table speedbar-syntax-table) |
| 1237 | (setq font-lock-keywords nil) ;; no font-locking please |
| 1238 | (setq truncate-lines t) |
| 1239 | (make-local-variable 'frame-title-format) |
| 1240 | (setq frame-title-format "Speedbar") |
| 1241 | ;; Set this up special just for the speedbar buffer |
| 1242 | ;; Terminal minibuffer stuff does not require this. |
| 1243 | (if (and window-system (not (eq window-system 'pc)) |
| 1244 | (null default-minibuffer-frame)) |
| 1245 | (progn |
| 1246 | (make-local-variable 'default-minibuffer-frame) |
| 1247 | (setq default-minibuffer-frame speedbar-attached-frame))) |
| 1248 | ;; Correct use of `temp-buffer-show-function': Bob Weiner |
| 1249 | (if (and (boundp 'temp-buffer-show-hook) |
| 1250 | (boundp 'temp-buffer-show-function)) |
| 1251 | (progn (make-local-variable 'temp-buffer-show-hook) |
| 1252 | (setq temp-buffer-show-hook temp-buffer-show-function))) |
| 1253 | (make-local-variable 'temp-buffer-show-function) |
| 1254 | (setq temp-buffer-show-function 'speedbar-temp-buffer-show-function) |
| 1255 | (if speedbar-xemacsp |
| 1256 | (progn |
| 1257 | ;; Argh! mouse-track-click-hook doesn't understand the |
| 1258 | ;; make-local-hook conventions. |
| 1259 | (make-local-variable 'mouse-track-click-hook) |
| 1260 | (add-hook 'mouse-track-click-hook |
| 1261 | (lambda (event count) |
| 1262 | (if (/= (event-button event) 1) |
| 1263 | nil ; Do normal operations. |
| 1264 | (cond ((eq count 1) |
| 1265 | (speedbar-quick-mouse event)) |
| 1266 | ((or (eq count 2) |
| 1267 | (eq count 3)) |
| 1268 | (speedbar-mouse-set-point event) |
| 1269 | (speedbar-do-function-pointer) |
| 1270 | (speedbar-quick-mouse event))) |
| 1271 | ;; Don't do normal operations. |
| 1272 | t))))) |
| 1273 | (make-local-hook 'kill-buffer-hook) |
| 1274 | (add-hook 'kill-buffer-hook (lambda () (let ((skilling (boundp 'skilling))) |
| 1275 | (if skilling |
| 1276 | nil |
| 1277 | (if (eq (current-buffer) |
| 1278 | speedbar-buffer) |
| 1279 | (speedbar-frame-mode -1))))) |
| 1280 | t t) |
| 1281 | (toggle-read-only 1) |
| 1282 | (speedbar-set-mode-line-format) |
| 1283 | (if speedbar-xemacsp |
| 1284 | (set (make-local-variable 'mouse-motion-handler) |
| 1285 | 'speedbar-track-mouse-xemacs) |
| 1286 | (if speedbar-track-mouse-flag |
| 1287 | (set (make-local-variable 'track-mouse) t)) ;this could be messy. |
| 1288 | (setq auto-show-mode nil)) ;no auto-show for Emacs |
| 1289 | (run-hooks 'speedbar-mode-hook)) |
| 1290 | (speedbar-update-contents) |
| 1291 | speedbar-buffer) |
| 1292 | |
| 1293 | (defmacro speedbar-with-attached-buffer (&rest forms) |
| 1294 | "Execute FORMS in the attached frame's special buffer. |
| 1295 | Optionally select that frame if necessary." |
| 1296 | `(save-selected-window |
| 1297 | (speedbar-set-timer speedbar-update-speed) |
| 1298 | (select-frame speedbar-attached-frame) |
| 1299 | ,@forms |
| 1300 | (speedbar-maybee-jump-to-attached-frame))) |
| 1301 | |
| 1302 | (defun speedbar-message (fmt &rest args) |
| 1303 | "Like message, but for use in the speedbar frame. |
| 1304 | Argument FMT is the format string, and ARGS are the arguments for message." |
| 1305 | (save-selected-window |
| 1306 | (select-frame speedbar-attached-frame) |
| 1307 | (apply 'message fmt args))) |
| 1308 | |
| 1309 | (defun speedbar-y-or-n-p (prompt) |
| 1310 | "Like `y-or-n-p', but for use in the speedbar frame. |
| 1311 | Argument PROMPT is the prompt to use." |
| 1312 | (save-selected-window |
| 1313 | (if (and default-minibuffer-frame (not (eq default-minibuffer-frame |
| 1314 | speedbar-attached-frame))) |
| 1315 | (select-frame speedbar-attached-frame)) |
| 1316 | (y-or-n-p prompt))) |
| 1317 | |
| 1318 | (defun speedbar-show-info-under-mouse (&optional event) |
| 1319 | "Call the info function for the line under the mouse. |
| 1320 | Optional EVENT is currently not used." |
| 1321 | (let ((pos (mouse-position))) ; we ignore event until I use it later. |
| 1322 | (if (equal (car pos) speedbar-frame) |
| 1323 | (save-excursion |
| 1324 | (save-window-excursion |
| 1325 | (apply 'set-mouse-position pos) |
| 1326 | (speedbar-item-info)))))) |
| 1327 | |
| 1328 | (defun speedbar-set-mode-line-format () |
| 1329 | "Set the format of the mode line based on the current speedbar environment. |
| 1330 | This gives visual indications of what is up. It EXPECTS the speedbar |
| 1331 | frame and window to be the currently active frame and window." |
| 1332 | (if (and (frame-live-p speedbar-frame) |
| 1333 | (or (not speedbar-xemacsp) |
| 1334 | (specifier-instance has-modeline-p))) |
| 1335 | (save-excursion |
| 1336 | (set-buffer speedbar-buffer) |
| 1337 | (let* ((w (or (speedbar-frame-width) 20)) |
| 1338 | (p1 "<<") |
| 1339 | (p5 ">>") |
| 1340 | (p3 (if speedbar-update-flag "SPEEDBAR" "SLOWBAR")) |
| 1341 | (blank (- w (length p1) (length p3) (length p5) |
| 1342 | (if line-number-mode 4 0))) |
| 1343 | (p2 (if (> blank 0) |
| 1344 | (make-string (/ blank 2) ? ) |
| 1345 | "")) |
| 1346 | (p4 (if (> blank 0) |
| 1347 | (make-string (+ (/ blank 2) (% blank 2)) ? ) |
| 1348 | "")) |
| 1349 | (tf |
| 1350 | (if line-number-mode |
| 1351 | (list (concat p1 p2 p3) '(line-number-mode " %3l") |
| 1352 | (concat p4 p5)) |
| 1353 | (list (concat p1 p2 p3 p4 p5))))) |
| 1354 | (if (not (equal mode-line-format tf)) |
| 1355 | (progn |
| 1356 | (setq mode-line-format tf) |
| 1357 | (speedbar-mode-line-update))))))) |
| 1358 | |
| 1359 | (defun speedbar-temp-buffer-show-function (buffer) |
| 1360 | "Placed in the variable `temp-buffer-show-function' in `speedbar-mode'. |
| 1361 | If a user requests help using \\[help-command] <Key> the temp BUFFER will be |
| 1362 | redirected into a window on the attached frame." |
| 1363 | (if speedbar-attached-frame (select-frame speedbar-attached-frame)) |
| 1364 | (pop-to-buffer buffer nil) |
| 1365 | (other-window -1) |
| 1366 | ;; Fix for using this hook on some platforms: Bob Weiner |
| 1367 | (cond ((not speedbar-xemacsp) |
| 1368 | (run-hooks 'temp-buffer-show-hook)) |
| 1369 | ((fboundp 'run-hook-with-args) |
| 1370 | (run-hook-with-args 'temp-buffer-show-hook buffer)) |
| 1371 | ((and (boundp 'temp-buffer-show-hook) |
| 1372 | (listp temp-buffer-show-hook)) |
| 1373 | (mapcar (function (lambda (hook) (funcall hook buffer))) |
| 1374 | temp-buffer-show-hook)))) |
| 1375 | |
| 1376 | (defvar speedbar-previous-menu nil |
| 1377 | "The menu before the last `speedbar-reconfigure-keymaps' was called.") |
| 1378 | |
| 1379 | (defun speedbar-reconfigure-keymaps () |
| 1380 | "Reconfigure the menu-bar in a speedbar frame. |
| 1381 | Different menu items are displayed depending on the current display mode |
| 1382 | and the existence of packages." |
| 1383 | (let ((md (append |
| 1384 | speedbar-easymenu-definition-base |
| 1385 | (if speedbar-shown-directories |
| 1386 | ;; file display mode version |
| 1387 | (speedbar-initial-menu) |
| 1388 | (save-excursion |
| 1389 | (select-frame speedbar-attached-frame) |
| 1390 | (if (local-variable-p |
| 1391 | 'speedbar-easymenu-definition-special |
| 1392 | (current-buffer)) |
| 1393 | ;; If bound locally, we can use it |
| 1394 | speedbar-easymenu-definition-special))) |
| 1395 | ;; Dynamic menu stuff |
| 1396 | '("-") |
| 1397 | (list (cons "Displays" |
| 1398 | (let ((displays nil) |
| 1399 | (alist speedbar-initial-expansion-mode-alist)) |
| 1400 | (while alist |
| 1401 | (setq displays |
| 1402 | (cons |
| 1403 | (vector |
| 1404 | (capitalize (car (car alist))) |
| 1405 | (list |
| 1406 | 'speedbar-change-initial-expansion-list |
| 1407 | (car (car alist))) |
| 1408 | t) |
| 1409 | displays)) |
| 1410 | (setq alist (cdr alist))) |
| 1411 | displays))) |
| 1412 | ;; The trailer |
| 1413 | speedbar-easymenu-definition-trailer)) |
| 1414 | (localmap (save-excursion |
| 1415 | (let ((cf (selected-frame))) |
| 1416 | (prog2 |
| 1417 | (select-frame speedbar-attached-frame) |
| 1418 | (if (local-variable-p |
| 1419 | 'speedbar-special-mode-key-map |
| 1420 | (current-buffer)) |
| 1421 | speedbar-special-mode-key-map) |
| 1422 | (select-frame cf)))))) |
| 1423 | (save-excursion |
| 1424 | (set-buffer speedbar-buffer) |
| 1425 | (use-local-map (or localmap |
| 1426 | (speedbar-initial-keymap) |
| 1427 | ;; This creates a small keymap we can glom the |
| 1428 | ;; menu adjustments into. |
| 1429 | (speedbar-make-specialized-keymap))) |
| 1430 | ;; Delete the old menu if applicable. |
| 1431 | (if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu)) |
| 1432 | (setq speedbar-previous-menu md) |
| 1433 | ;; Now add the new menu |
| 1434 | (if (not speedbar-xemacsp) |
| 1435 | (easy-menu-define speedbar-menu-map (current-local-map) |
| 1436 | "Speedbar menu" md) |
| 1437 | (easy-menu-add md (current-local-map)) |
| 1438 | (set-buffer-menubar (list md)))) |
| 1439 | (run-hooks 'speedbar-reconfigure-keymaps-hook))) |
| 1440 | |
| 1441 | \f |
| 1442 | ;;; User Input stuff |
| 1443 | ;; |
| 1444 | |
| 1445 | ;; XEmacs: this can be implemented using modeline keymaps, but there |
| 1446 | ;; is no use, as we have horizontal scrollbar (as the docstring |
| 1447 | ;; hints.) |
| 1448 | (defun speedbar-mouse-hscroll (e) |
| 1449 | "Read a mouse event E from the mode line, and horizontally scroll. |
| 1450 | If the mouse is being clicked on the far left, or far right of the |
| 1451 | mode-line. This is only useful for non-XEmacs" |
| 1452 | (interactive "e") |
| 1453 | (let* ((xp (car (nth 2 (car (cdr e))))) |
| 1454 | (cpw (/ (frame-pixel-width) |
| 1455 | (frame-width))) |
| 1456 | (oc (1+ (/ xp cpw))) |
| 1457 | ) |
| 1458 | (cond ((< oc 3) |
| 1459 | (scroll-left 2)) |
| 1460 | ((> oc (- (window-width) 3)) |
| 1461 | (scroll-right 2)) |
| 1462 | (t (speedbar-message |
| 1463 | "Click on the edge of the modeline to scroll left/right"))) |
| 1464 | ;;(speedbar-message "X: Pixel %d Char Pixels %d On char %d" xp cpw oc) |
| 1465 | )) |
| 1466 | |
| 1467 | (defun speedbar-customize () |
| 1468 | "Customize speedbar using the Custom package." |
| 1469 | (interactive) |
| 1470 | (let ((sf (selected-frame))) |
| 1471 | (select-frame speedbar-attached-frame) |
| 1472 | (customize-group 'speedbar) |
| 1473 | (select-frame sf)) |
| 1474 | (speedbar-maybee-jump-to-attached-frame)) |
| 1475 | |
| 1476 | (defun speedbar-track-mouse (event) |
| 1477 | "For motion EVENT, display info about the current line." |
| 1478 | (interactive "e") |
| 1479 | (if (not speedbar-track-mouse-flag) |
| 1480 | nil |
| 1481 | (save-excursion |
| 1482 | (let ((char (nth 1 (car (cdr event))))) |
| 1483 | (if (not (numberp char)) |
| 1484 | (speedbar-message nil) |
| 1485 | (goto-char char) |
| 1486 | ;; (speedbar-message "%S" event) |
| 1487 | (speedbar-item-info) |
| 1488 | ))))) |
| 1489 | |
| 1490 | (defun speedbar-track-mouse-xemacs (event) |
| 1491 | "For motion EVENT, display info about the current line." |
| 1492 | (if (functionp (default-value 'mouse-motion-handler)) |
| 1493 | (funcall (default-value 'mouse-motion-handler) event)) |
| 1494 | (if speedbar-track-mouse-flag |
| 1495 | (save-excursion |
| 1496 | (save-window-excursion |
| 1497 | (condition-case () |
| 1498 | (progn (mouse-set-point event) |
| 1499 | ;; Prevent focus-related bugs. |
| 1500 | (if (eq major-mode 'speedbar-mode) |
| 1501 | (speedbar-item-info))) |
| 1502 | (error nil)))))) |
| 1503 | |
| 1504 | ;; In XEmacs, we make popup menus work on the item over mouse (as |
| 1505 | ;; opposed to where the point happens to be.) We attain this by |
| 1506 | ;; temporarily moving the point to that place. |
| 1507 | ;; Hrvoje Niksic <hniksic@srce.hr> |
| 1508 | (defun speedbar-xemacs-popup-kludge (event) |
| 1509 | "Pop up a menu related to the clicked on item. |
| 1510 | Must be bound to EVENT." |
| 1511 | (interactive "e") |
| 1512 | (select-frame speedbar-frame) |
| 1513 | (save-excursion |
| 1514 | (goto-char (event-closest-point event)) |
| 1515 | (beginning-of-line) |
| 1516 | (forward-char (min 5 (- (save-excursion (end-of-line) (point)) |
| 1517 | (save-excursion (beginning-of-line) (point))))) |
| 1518 | (popup-mode-menu) |
| 1519 | ;; Wait for menu to bail out. `popup-mode-menu' (and other popup |
| 1520 | ;; menu functions) return immediately. |
| 1521 | (let (new) |
| 1522 | (while (not (misc-user-event-p (setq new (next-event)))) |
| 1523 | (dispatch-event new)) |
| 1524 | (dispatch-event new)))) |
| 1525 | |
| 1526 | (defun speedbar-emacs-popup-kludge (e) |
| 1527 | "Pop up a menu related to the clicked on item. |
| 1528 | Must be bound to event E." |
| 1529 | (interactive "e") |
| 1530 | (save-excursion |
| 1531 | (mouse-set-point e) |
| 1532 | ;; This gets the cursor where the user can see it. |
| 1533 | (if (not (bolp)) (forward-char -1)) |
| 1534 | (sit-for 0) |
| 1535 | (if (< emacs-major-version 20) |
| 1536 | (mouse-major-mode-menu e) |
| 1537 | (mouse-major-mode-menu e nil)))) |
| 1538 | |
| 1539 | (defun speedbar-hack-buffer-menu (e) |
| 1540 | "Control mouse 1 is buffer menu. |
| 1541 | This hack overrides it so that the right thing happens in the main |
| 1542 | Emacs frame, not in the speedbar frame. |
| 1543 | Argument E is the event causing this activity." |
| 1544 | (interactive "e") |
| 1545 | (let ((fn (lookup-key global-map (if speedbar-xemacsp |
| 1546 | '(control button1) |
| 1547 | [C-down-mouse-1]))) |
| 1548 | (newbuff nil)) |
| 1549 | (unwind-protect |
| 1550 | (save-excursion |
| 1551 | (set-window-dedicated-p (selected-window) nil) |
| 1552 | (call-interactively fn) |
| 1553 | (setq newbuff (current-buffer))) |
| 1554 | (switch-to-buffer speedbar-buffer) |
| 1555 | (set-window-dedicated-p (selected-window) t)) |
| 1556 | (if (not (eq newbuff speedbar-buffer)) |
| 1557 | (speedbar-with-attached-buffer |
| 1558 | (switch-to-buffer newbuff))))) |
| 1559 | |
| 1560 | (defun speedbar-next (arg) |
| 1561 | "Move to the next ARGth line in a speedbar buffer." |
| 1562 | (interactive "p") |
| 1563 | (forward-line (or arg 1)) |
| 1564 | (speedbar-item-info) |
| 1565 | (speedbar-position-cursor-on-line)) |
| 1566 | |
| 1567 | (defun speedbar-prev (arg) |
| 1568 | "Move to the previous ARGth line in a speedbar buffer." |
| 1569 | (interactive "p") |
| 1570 | (speedbar-next (if arg (- arg) -1))) |
| 1571 | |
| 1572 | (defun speedbar-restricted-move (arg) |
| 1573 | "Move to the next ARGth line in a speedbar buffer at the same depth. |
| 1574 | This means that movement is restricted to a subnode, and that siblings |
| 1575 | of intermediate nodes are skipped." |
| 1576 | (if (not (numberp arg)) (signal 'wrong-type-argument (list arg 'numberp))) |
| 1577 | ;; First find the extent for which we are allowed to move. |
| 1578 | (let ((depth (save-excursion (beginning-of-line) |
| 1579 | (if (looking-at "[0-9]+:") |
| 1580 | (string-to-int (match-string 0)) |
| 1581 | 0))) |
| 1582 | (crement (if (< arg 0) 1 -1)) ; decrement or increment |
| 1583 | (lastmatch (point))) |
| 1584 | (while (/= arg 0) |
| 1585 | (forward-line (- crement)) |
| 1586 | (let ((subdepth (save-excursion (beginning-of-line) |
| 1587 | (if (looking-at "[0-9]+:") |
| 1588 | (string-to-int (match-string 0)) |
| 1589 | 0)))) |
| 1590 | (cond ((or (< subdepth depth) |
| 1591 | (progn (end-of-line) (eobp)) |
| 1592 | (progn (beginning-of-line) (bobp))) |
| 1593 | ;; We have reached the end of this block. |
| 1594 | (goto-char lastmatch) |
| 1595 | (setq arg 0) |
| 1596 | (error "End of sub-list")) |
| 1597 | ((= subdepth depth) |
| 1598 | (setq lastmatch (point) |
| 1599 | arg (+ arg crement)))))) |
| 1600 | (speedbar-position-cursor-on-line))) |
| 1601 | |
| 1602 | (defun speedbar-restricted-next (arg) |
| 1603 | "Move to the next ARGth line in a speedbar buffer at the same depth. |
| 1604 | This means that movement is restricted to a subnode, and that siblings |
| 1605 | of intermediate nodes are skipped." |
| 1606 | (interactive "p") |
| 1607 | (speedbar-restricted-move (or arg 1)) |
| 1608 | (speedbar-item-info)) |
| 1609 | |
| 1610 | |
| 1611 | (defun speedbar-restricted-prev (arg) |
| 1612 | "Move to the previous ARGth line in a speedbar buffer at the same depth. |
| 1613 | This means that movement is restricted to a subnode, and that siblings |
| 1614 | of intermediate nodes are skipped." |
| 1615 | (interactive "p") |
| 1616 | (speedbar-restricted-move (if arg (- arg) -1)) |
| 1617 | (speedbar-item-info)) |
| 1618 | |
| 1619 | (defun speedbar-navigate-list (arg) |
| 1620 | "Move across ARG groups of similarly typed items in speedbar. |
| 1621 | Stop on the first line of the next type of item, or on the last or first item |
| 1622 | if we reach a buffer boundary." |
| 1623 | (interactive "p") |
| 1624 | (beginning-of-line) |
| 1625 | (if (looking-at "[0-9]+: *[[<{][-+?][]>}] ") |
| 1626 | (let ((str (regexp-quote (match-string 0)))) |
| 1627 | (while (looking-at str) |
| 1628 | (speedbar-restricted-move arg) |
| 1629 | (beginning-of-line)))) |
| 1630 | (speedbar-position-cursor-on-line)) |
| 1631 | |
| 1632 | (defun speedbar-forward-list () |
| 1633 | "Move forward over the current list. |
| 1634 | A LIST in speedbar is a group of similarly typed items, such as directories, |
| 1635 | files, or the directory button." |
| 1636 | (interactive) |
| 1637 | (speedbar-navigate-list 1) |
| 1638 | (speedbar-item-info)) |
| 1639 | |
| 1640 | (defun speedbar-backward-list () |
| 1641 | "Move backward over the current list. |
| 1642 | A LIST in speedbar is a group of similarly typed items, such as directories, |
| 1643 | files, or the directory button." |
| 1644 | (interactive) |
| 1645 | (speedbar-navigate-list -1) |
| 1646 | (speedbar-item-info)) |
| 1647 | |
| 1648 | (defun speedbar-scroll-up (&optional arg) |
| 1649 | "Page down one screen-full of the speedbar, or ARG lines." |
| 1650 | (interactive "P") |
| 1651 | (scroll-up arg) |
| 1652 | (speedbar-position-cursor-on-line)) |
| 1653 | |
| 1654 | (defun speedbar-scroll-down (&optional arg) |
| 1655 | "Page up one screen-full of the speedbar, or ARG lines." |
| 1656 | (interactive "P") |
| 1657 | (scroll-down arg) |
| 1658 | (speedbar-position-cursor-on-line)) |
| 1659 | |
| 1660 | (defun speedbar-up-directory () |
| 1661 | "Keyboard accelerator for moving the default directory up one. |
| 1662 | Assumes that the current buffer is the speedbar buffer" |
| 1663 | (interactive) |
| 1664 | (setq default-directory (expand-file-name (concat default-directory "../"))) |
| 1665 | (speedbar-update-contents)) |
| 1666 | \f |
| 1667 | ;;; Speedbar file activity (aka creeping featurism) |
| 1668 | ;; |
| 1669 | (defun speedbar-refresh () |
| 1670 | "Refresh the current speedbar display, disposing of any cached data." |
| 1671 | (interactive) |
| 1672 | (let ((dl speedbar-shown-directories) |
| 1673 | (dm (and (boundp 'deactivate-mark) deactivate-mark))) |
| 1674 | (while dl |
| 1675 | (adelete 'speedbar-directory-contents-alist (car dl)) |
| 1676 | (setq dl (cdr dl))) |
| 1677 | (if (<= 1 speedbar-verbosity-level) |
| 1678 | (speedbar-message "Refreshing speedbar...")) |
| 1679 | (speedbar-update-contents) |
| 1680 | (speedbar-stealthy-updates) |
| 1681 | ;; Reset the timer in case it got really hosed for some reason... |
| 1682 | (speedbar-set-timer speedbar-update-speed) |
| 1683 | (if (<= 1 speedbar-verbosity-level) |
| 1684 | (speedbar-message "Refreshing speedbar...done")) |
| 1685 | (if (boundp 'deactivate-mark) (setq deactivate-mark dm)))) |
| 1686 | |
| 1687 | (defun speedbar-item-load () |
| 1688 | "Load the item under the cursor or mouse if it is a Lisp file." |
| 1689 | (interactive) |
| 1690 | (let ((f (speedbar-line-file))) |
| 1691 | (if (and (file-exists-p f) (string-match "\\.el\\'" f)) |
| 1692 | (if (and (file-exists-p (concat f "c")) |
| 1693 | (speedbar-y-or-n-p (format "Load %sc? " f))) |
| 1694 | ;; If the compiled version exists, load that instead... |
| 1695 | (load-file (concat f "c")) |
| 1696 | (load-file f)) |
| 1697 | (error "Not a loadable file")))) |
| 1698 | |
| 1699 | (defun speedbar-item-byte-compile () |
| 1700 | "Byte compile the item under the cursor or mouse if it is a Lisp file." |
| 1701 | (interactive) |
| 1702 | (let ((f (speedbar-line-file)) |
| 1703 | (sf (selected-frame))) |
| 1704 | (if (and (file-exists-p f) (string-match "\\.el\\'" f)) |
| 1705 | (progn |
| 1706 | (select-frame speedbar-attached-frame) |
| 1707 | (byte-compile-file f nil) |
| 1708 | (select-frame sf) |
| 1709 | (speedbar-reset-scanners))) |
| 1710 | )) |
| 1711 | |
| 1712 | (defun speedbar-mouse-item-info (event) |
| 1713 | "Provide information about what the user clicked on. |
| 1714 | This should be bound to a mouse EVENT." |
| 1715 | (interactive "e") |
| 1716 | (mouse-set-point event) |
| 1717 | (speedbar-item-info)) |
| 1718 | |
| 1719 | (defun speedbar-generic-item-info () |
| 1720 | "Attempt to derive, and then display information about thils line item. |
| 1721 | File style information is displayed with `speedbar-item-info'." |
| 1722 | (save-excursion |
| 1723 | (beginning-of-line) |
| 1724 | ;; Skip invisible number info. |
| 1725 | (if (looking-at "\\([0-9]+\\):") (goto-char (match-end 0))) |
| 1726 | ;; Skip items in "folder" type text characters. |
| 1727 | (if (looking-at "\\s-*[[<({].[]>)}] ") (goto-char (match-end 0))) |
| 1728 | ;; Get the text |
| 1729 | (speedbar-message "Text: %s" (buffer-substring-no-properties |
| 1730 | (point) (progn (end-of-line) (point)))))) |
| 1731 | |
| 1732 | (defun speedbar-item-info () |
| 1733 | "Display info in the mini-buffer about the button the mouse is over. |
| 1734 | This function can be replaced in `speedbar-mode-functions-list' as |
| 1735 | `speedbar-item-info'" |
| 1736 | (interactive) |
| 1737 | (let (message-log-max) |
| 1738 | (funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info) |
| 1739 | 'speedbar-generic-item-info)))) |
| 1740 | |
| 1741 | (defun speedbar-item-info-file-helper (&optional filename) |
| 1742 | "Display info about a file that is on the current line. |
| 1743 | nil if not applicable. If FILENAME, then use that instead of reading |
| 1744 | it from the speedbar buffer." |
| 1745 | (let* ((item (or filename (speedbar-line-file))) |
| 1746 | (attr (if item (file-attributes item) nil))) |
| 1747 | (if (and item attr) (speedbar-message "%s %-6d %s" (nth 8 attr) |
| 1748 | (nth 7 attr) item) |
| 1749 | nil))) |
| 1750 | |
| 1751 | (defun speedbar-item-info-tag-helper () |
| 1752 | "Display info about a tag that is on the current line. |
| 1753 | nil if not applicable." |
| 1754 | (save-excursion |
| 1755 | (beginning-of-line) |
| 1756 | (if (re-search-forward " [-+=]?> \\([^\n]+\\)" |
| 1757 | (save-excursion(end-of-line)(point)) t) |
| 1758 | (let ((tag (match-string 1)) |
| 1759 | (attr (speedbar-line-token)) |
| 1760 | (item nil)) |
| 1761 | (if (and (featurep 'semantic) (semantic-token-p attr)) |
| 1762 | (speedbar-message (semantic-summerize-nonterminal attr)) |
| 1763 | (looking-at "\\([0-9]+\\):") |
| 1764 | (setq item (file-name-nondirectory (speedbar-line-path))) |
| 1765 | (speedbar-message "Tag: %s in %s" tag item))) |
| 1766 | (if (re-search-forward "{[+-]} \\([^\n]+\\)$" |
| 1767 | (save-excursion(end-of-line)(point)) t) |
| 1768 | (speedbar-message "Group of tags \"%s\"" (match-string 1)) |
| 1769 | (if (re-search-forward " [+-]?[()|@] \\([^\n]+\\)$" nil t) |
| 1770 | (let* ((detailtext (match-string 1)) |
| 1771 | (detail (or (speedbar-line-token) detailtext)) |
| 1772 | (parent (save-excursion |
| 1773 | (beginning-of-line) |
| 1774 | (let ((dep (if (looking-at "[0-9]+:") |
| 1775 | (1- (string-to-int (match-string 0))) |
| 1776 | 0))) |
| 1777 | (re-search-backward (concat "^" |
| 1778 | (int-to-string dep) |
| 1779 | ":") |
| 1780 | nil t)) |
| 1781 | (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$") |
| 1782 | (speedbar-line-token) |
| 1783 | nil)))) |
| 1784 | (if (and (featurep 'semantic) (semantic-token-p detail)) |
| 1785 | (speedbar-message |
| 1786 | (semantic-summerize-nonterminal detail parent)) |
| 1787 | (if parent |
| 1788 | (speedbar-message "Detail: %s of tag %s" detail |
| 1789 | (if (and (featurep 'semantic) |
| 1790 | (semantic-token-p parent)) |
| 1791 | (semantic-token-name parent) |
| 1792 | parent)) |
| 1793 | (speedbar-message "Detail: %s" detail)))) |
| 1794 | nil))))) |
| 1795 | |
| 1796 | (defun speedbar-files-item-info () |
| 1797 | "Display info in the mini-buffer about the button the mouse is over." |
| 1798 | (if (not speedbar-shown-directories) |
| 1799 | (speedbar-generic-item-info) |
| 1800 | (or (speedbar-item-info-file-helper) |
| 1801 | (speedbar-item-info-tag-helper) |
| 1802 | (speedbar-generic-item-info)))) |
| 1803 | |
| 1804 | (defun speedbar-item-copy () |
| 1805 | "Copy the item under the cursor. |
| 1806 | Files can be copied to new names or places." |
| 1807 | (interactive) |
| 1808 | (let ((f (speedbar-line-file))) |
| 1809 | (if (not f) (error "Not a file")) |
| 1810 | (if (file-directory-p f) |
| 1811 | (error "Cannot copy directory") |
| 1812 | (let* ((rt (read-file-name (format "Copy %s to: " |
| 1813 | (file-name-nondirectory f)) |
| 1814 | (file-name-directory f))) |
| 1815 | (refresh (member (expand-file-name (file-name-directory rt)) |
| 1816 | speedbar-shown-directories))) |
| 1817 | ;; Create the right file name part |
| 1818 | (if (file-directory-p rt) |
| 1819 | (setq rt |
| 1820 | (concat (expand-file-name rt) |
| 1821 | (if (string-match "[/\\]$" rt) "" "/") |
| 1822 | (file-name-nondirectory f)))) |
| 1823 | (if (or (not (file-exists-p rt)) |
| 1824 | (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f))) |
| 1825 | (progn |
| 1826 | (copy-file f rt t t) |
| 1827 | ;; refresh display if the new place is currently displayed. |
| 1828 | (if refresh |
| 1829 | (progn |
| 1830 | (speedbar-refresh) |
| 1831 | (if (not (speedbar-goto-this-file rt)) |
| 1832 | (speedbar-goto-this-file f)))) |
| 1833 | )))))) |
| 1834 | |
| 1835 | (defun speedbar-item-rename () |
| 1836 | "Rename the item under the cursor or mouse. |
| 1837 | Files can be renamed to new names or moved to new directories." |
| 1838 | (interactive) |
| 1839 | (let ((f (speedbar-line-file))) |
| 1840 | (if f |
| 1841 | (let* ((rt (read-file-name (format "Rename %s to: " |
| 1842 | (file-name-nondirectory f)) |
| 1843 | (file-name-directory f))) |
| 1844 | (refresh (member (expand-file-name (file-name-directory rt)) |
| 1845 | speedbar-shown-directories))) |
| 1846 | ;; Create the right file name part |
| 1847 | (if (file-directory-p rt) |
| 1848 | (setq rt |
| 1849 | (concat (expand-file-name rt) |
| 1850 | (if (string-match "[/\\]\\'" rt) "" "/") |
| 1851 | (file-name-nondirectory f)))) |
| 1852 | (if (or (not (file-exists-p rt)) |
| 1853 | (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f))) |
| 1854 | (progn |
| 1855 | (rename-file f rt t) |
| 1856 | ;; refresh display if the new place is currently displayed. |
| 1857 | (if refresh |
| 1858 | (progn |
| 1859 | (speedbar-refresh) |
| 1860 | (speedbar-goto-this-file rt) |
| 1861 | ))))) |
| 1862 | (error "Not a file")))) |
| 1863 | |
| 1864 | (defun speedbar-item-delete () |
| 1865 | "Delete the item under the cursor. Files are removed from disk." |
| 1866 | (interactive) |
| 1867 | (let ((f (speedbar-line-file))) |
| 1868 | (if (not f) (error "Not a file")) |
| 1869 | (if (speedbar-y-or-n-p (format "Delete %s? " f)) |
| 1870 | (progn |
| 1871 | (if (file-directory-p f) |
| 1872 | (delete-directory f) |
| 1873 | (delete-file f)) |
| 1874 | (speedbar-message "Okie dokie..") |
| 1875 | (let ((p (point))) |
| 1876 | (speedbar-refresh) |
| 1877 | (goto-char p)) |
| 1878 | )) |
| 1879 | )) |
| 1880 | |
| 1881 | (defun speedbar-item-object-delete () |
| 1882 | "Delete the object associated from the item under the cursor. |
| 1883 | The file is removed from disk. The object is determined from the |
| 1884 | variable `speedbar-obj-alist'." |
| 1885 | (interactive) |
| 1886 | (let* ((f (speedbar-line-file)) |
| 1887 | (obj nil) |
| 1888 | (oa speedbar-obj-alist)) |
| 1889 | (if (not f) (error "Not a file")) |
| 1890 | (while (and oa (not (string-match (car (car oa)) f))) |
| 1891 | (setq oa (cdr oa))) |
| 1892 | (setq obj (concat (file-name-sans-extension f) (cdr (car oa)))) |
| 1893 | (if (and oa (file-exists-p obj) |
| 1894 | (speedbar-y-or-n-p (format "Delete %s? " obj))) |
| 1895 | (progn |
| 1896 | (delete-file obj) |
| 1897 | (speedbar-reset-scanners))))) |
| 1898 | |
| 1899 | (defun speedbar-enable-update () |
| 1900 | "Enable automatic updating in speedbar via timers." |
| 1901 | (interactive) |
| 1902 | (setq speedbar-update-flag t) |
| 1903 | (speedbar-set-mode-line-format) |
| 1904 | (speedbar-set-timer speedbar-update-speed)) |
| 1905 | |
| 1906 | (defun speedbar-disable-update () |
| 1907 | "Disable automatic updating and stop consuming resources." |
| 1908 | (interactive) |
| 1909 | (setq speedbar-update-flag nil) |
| 1910 | (speedbar-set-mode-line-format) |
| 1911 | (speedbar-set-timer nil)) |
| 1912 | |
| 1913 | (defun speedbar-toggle-updates () |
| 1914 | "Toggle automatic update for the speedbar frame." |
| 1915 | (interactive) |
| 1916 | (if speedbar-update-flag |
| 1917 | (speedbar-disable-update) |
| 1918 | (speedbar-enable-update))) |
| 1919 | |
| 1920 | (defun speedbar-toggle-images () |
| 1921 | "Toggle automatic update for the speedbar frame." |
| 1922 | (interactive) |
| 1923 | (setq speedbar-use-images (not speedbar-use-images)) |
| 1924 | (speedbar-refresh)) |
| 1925 | |
| 1926 | (defun speedbar-toggle-sorting () |
| 1927 | "Toggle automatic update for the speedbar frame." |
| 1928 | (interactive) |
| 1929 | (setq speedbar-sort-tags (not speedbar-sort-tags))) |
| 1930 | |
| 1931 | (defun speedbar-toggle-show-all-files () |
| 1932 | "Toggle display of files speedbar can not tag." |
| 1933 | (interactive) |
| 1934 | (setq speedbar-show-unknown-files (not speedbar-show-unknown-files)) |
| 1935 | (speedbar-refresh)) |
| 1936 | \f |
| 1937 | ;;; Utility functions |
| 1938 | ;; |
| 1939 | (defun speedbar-set-timer (timeout) |
| 1940 | "Apply a timer with TIMEOUT, or remove a timer if TIMOUT is nil. |
| 1941 | TIMEOUT is the number of seconds until the speedbar timer is called |
| 1942 | again. When TIMEOUT is nil, turn off all timeouts. |
| 1943 | This function will also enable or disable the `vc-checkin-hook' used |
| 1944 | to track file check ins, and will change the mode line to match |
| 1945 | `speedbar-update-flag'." |
| 1946 | (cond |
| 1947 | ;; XEmacs |
| 1948 | (speedbar-xemacsp |
| 1949 | (if speedbar-timer |
| 1950 | (progn (delete-itimer speedbar-timer) |
| 1951 | (setq speedbar-timer nil))) |
| 1952 | (if timeout |
| 1953 | (if (and speedbar-xemacsp |
| 1954 | (or (>= emacs-major-version 20) |
| 1955 | (>= emacs-minor-version 15))) |
| 1956 | (setq speedbar-timer (start-itimer "speedbar" |
| 1957 | 'speedbar-timer-fn |
| 1958 | timeout |
| 1959 | timeout |
| 1960 | t)) |
| 1961 | (setq speedbar-timer (start-itimer "speedbar" |
| 1962 | 'speedbar-timer-fn |
| 1963 | timeout |
| 1964 | nil))))) |
| 1965 | ;; Post 19.31 Emacs |
| 1966 | ((fboundp 'run-with-idle-timer) |
| 1967 | (if speedbar-timer |
| 1968 | (progn (cancel-timer speedbar-timer) |
| 1969 | (setq speedbar-timer nil))) |
| 1970 | (if timeout |
| 1971 | (setq speedbar-timer |
| 1972 | (run-with-idle-timer timeout t 'speedbar-timer-fn)))) |
| 1973 | ;; Emacs 19.30 (Thanks twice: ptype@dra.hmg.gb) |
| 1974 | ((fboundp 'post-command-idle-hook) |
| 1975 | (if timeout |
| 1976 | (add-hook 'post-command-idle-hook 'speedbar-timer-fn) |
| 1977 | (remove-hook 'post-command-idle-hook 'speedbar-timer-fn))) |
| 1978 | ;; Older or other Emacsen with no timers. Set up so that its |
| 1979 | ;; obvious this emacs can't handle the updates |
| 1980 | (t |
| 1981 | (setq speedbar-update-flag nil))) |
| 1982 | ;; Apply a revert hook that will reset the scanners. We attach to revert |
| 1983 | ;; because most reverts occur during VC state change, and this lets our |
| 1984 | ;; VC scanner fix itself. |
| 1985 | (if timeout |
| 1986 | (add-hook 'after-revert-hook 'speedbar-reset-scanners) |
| 1987 | (remove-hook 'after-revert-hook 'speedbar-reset-scanners) |
| 1988 | ) |
| 1989 | ;; change this if it changed for some reason |
| 1990 | (speedbar-set-mode-line-format)) |
| 1991 | |
| 1992 | (defmacro speedbar-with-writable (&rest forms) |
| 1993 | "Allow the buffer to be writable and evaluate FORMS." |
| 1994 | (list 'let '((inhibit-read-only t)) |
| 1995 | (cons 'progn forms))) |
| 1996 | (put 'speedbar-with-writable 'lisp-indent-function 0) |
| 1997 | |
| 1998 | (defun speedbar-select-window (buffer) |
| 1999 | "Select a window in which BUFFER is shown. |
| 2000 | If it is not shown, force it to appear in the default window." |
| 2001 | (let ((win (get-buffer-window buffer speedbar-attached-frame))) |
| 2002 | (if win |
| 2003 | (select-window win) |
| 2004 | (set-window-buffer (selected-window) buffer)))) |
| 2005 | |
| 2006 | (defun speedbar-insert-button (text face mouse function |
| 2007 | &optional token prevline) |
| 2008 | "Insert TEXT as the next logical speedbar button. |
| 2009 | FACE is the face to put on the button, MOUSE is the highlight face to use. |
| 2010 | When the user clicks on TEXT, FUNCTION is called with the TOKEN parameter. |
| 2011 | This function assumes that the current buffer is the speedbar buffer. |
| 2012 | If PREVLINE, then put this button on the previous line. |
| 2013 | |
| 2014 | This is a convenience function for special mode that create their own |
| 2015 | specialized speedbar displays." |
| 2016 | (goto-char (point-max)) |
| 2017 | (let ((start (point))) |
| 2018 | (if (/= (current-column) 0) (insert "\n")) |
| 2019 | (put-text-property start (point) 'invisible nil)) |
| 2020 | (if prevline (progn (delete-char -1) |
| 2021 | (insert " ") ;back up if desired... |
| 2022 | (put-text-property (1- (point)) (point) 'invisible nil))) |
| 2023 | (let ((start (point))) |
| 2024 | (insert text) |
| 2025 | (speedbar-make-button start (point) face mouse function token)) |
| 2026 | (let ((start (point))) |
| 2027 | (insert "\n") |
| 2028 | (put-text-property start (point) 'face nil) |
| 2029 | (put-text-property start (point) 'invisible nil) |
| 2030 | (put-text-property start (point) 'mouse-face nil))) |
| 2031 | |
| 2032 | (defun speedbar-make-button (start end face mouse function &optional token) |
| 2033 | "Create a button from START to END, with FACE as the display face. |
| 2034 | MOUSE is the mouse face. When this button is clicked on FUNCTION |
| 2035 | will be run with the TOKEN parameter (any Lisp object)" |
| 2036 | (put-text-property start end 'face face) |
| 2037 | (put-text-property start end 'mouse-face mouse) |
| 2038 | (put-text-property start end 'invisible nil) |
| 2039 | (if function (put-text-property start end 'speedbar-function function)) |
| 2040 | (if token (put-text-property start end 'speedbar-token token)) |
| 2041 | ;; So far the only text we have is less that 3 chars. |
| 2042 | (if (<= (- end start) 3) |
| 2043 | (speedbar-insert-image-button-maybe start (- end start))) |
| 2044 | ) |
| 2045 | \f |
| 2046 | ;;; Initial Expansion list management |
| 2047 | ;; |
| 2048 | (defun speedbar-initial-expansion-list () |
| 2049 | "Return the current default expansion list. |
| 2050 | This is based on `speedbar-initial-expansion-list-name' referencing |
| 2051 | `speedbar-initial-expansion-mode-alist'." |
| 2052 | ;; cdr1 - name, cdr2 - menu |
| 2053 | (cdr (cdr (cdr (assoc speedbar-initial-expansion-list-name |
| 2054 | speedbar-initial-expansion-mode-alist))))) |
| 2055 | |
| 2056 | (defun speedbar-initial-menu () |
| 2057 | "Return the current default menu data. |
| 2058 | This is based on `speedbar-initial-expansion-list-name' referencing |
| 2059 | `speedbar-initial-expansion-mode-alist'." |
| 2060 | (symbol-value |
| 2061 | (car (cdr (assoc speedbar-initial-expansion-list-name |
| 2062 | speedbar-initial-expansion-mode-alist))))) |
| 2063 | |
| 2064 | (defun speedbar-initial-keymap () |
| 2065 | "Return the current default menu data. |
| 2066 | This is based on `speedbar-initial-expansion-list-name' referencing |
| 2067 | `speedbar-initial-expansion-mode-alist'." |
| 2068 | (symbol-value |
| 2069 | (car (cdr (cdr (assoc speedbar-initial-expansion-list-name |
| 2070 | speedbar-initial-expansion-mode-alist)))))) |
| 2071 | |
| 2072 | (defun speedbar-initial-stealthy-functions () |
| 2073 | "Return a list of functions to call stealthily. |
| 2074 | This is based on `speedbar-initial-expansion-list-name' referencing |
| 2075 | `speedbar-stealthy-function-list'." |
| 2076 | (cdr (assoc speedbar-initial-expansion-list-name |
| 2077 | speedbar-stealthy-function-list))) |
| 2078 | |
| 2079 | (defun speedbar-add-expansion-list (new-list) |
| 2080 | "Add NEW-LIST to the list of expansion lists." |
| 2081 | (add-to-list 'speedbar-initial-expansion-mode-alist new-list)) |
| 2082 | |
| 2083 | (defun speedbar-change-initial-expansion-list (new-default) |
| 2084 | "Change speedbar's default expansion list to NEW-DEFAULT." |
| 2085 | (interactive |
| 2086 | (list |
| 2087 | (completing-read (format "Speedbar Mode (default %s): " |
| 2088 | speedbar-previously-used-expansion-list-name) |
| 2089 | speedbar-initial-expansion-mode-alist |
| 2090 | nil t "" nil |
| 2091 | speedbar-previously-used-expansion-list-name))) |
| 2092 | (setq speedbar-previously-used-expansion-list-name |
| 2093 | speedbar-initial-expansion-list-name |
| 2094 | speedbar-initial-expansion-list-name new-default) |
| 2095 | (speedbar-refresh) |
| 2096 | (speedbar-reconfigure-keymaps)) |
| 2097 | |
| 2098 | (defun speedbar-fetch-replacement-function (function) |
| 2099 | "Return a current mode specific replacement for function, or nil. |
| 2100 | Scans `speedbar-mode-functions-list' first for the current mode, then |
| 2101 | for FUNCTION." |
| 2102 | (cdr (assoc function |
| 2103 | (cdr (assoc speedbar-initial-expansion-list-name |
| 2104 | speedbar-mode-functions-list))))) |
| 2105 | |
| 2106 | (defun speedbar-add-mode-functions-list (new-list) |
| 2107 | "Add NEW-LIST to the list of mode functions. |
| 2108 | See `speedbar-mode-functions-list' for details." |
| 2109 | (add-to-list 'speedbar-mode-functions-list new-list)) |
| 2110 | |
| 2111 | \f |
| 2112 | ;;; Special speedbar display management |
| 2113 | ;; |
| 2114 | (defun speedbar-maybe-add-localized-support (buffer) |
| 2115 | "Quick check function called on BUFFERs by the speedbar timer function. |
| 2116 | Maintains the value of local variables which control speedbars use |
| 2117 | of the special mode functions." |
| 2118 | (or speedbar-special-mode-expansion-list |
| 2119 | (speedbar-add-localized-speedbar-support buffer))) |
| 2120 | |
| 2121 | (defun speedbar-add-localized-speedbar-support (buffer) |
| 2122 | "Add localized speedbar support to BUFFER's mode if it is available." |
| 2123 | (interactive "bBuffer: ") |
| 2124 | (if (stringp buffer) (setq buffer (get-buffer buffer))) |
| 2125 | (if (not (buffer-live-p buffer)) |
| 2126 | nil |
| 2127 | (save-excursion |
| 2128 | (set-buffer buffer) |
| 2129 | (save-match-data |
| 2130 | (let ((ms (symbol-name major-mode)) v) |
| 2131 | (if (not (string-match "-mode$" ms)) |
| 2132 | nil ;; do nothing to broken mode |
| 2133 | (setq ms (substring ms 0 (match-beginning 0))) |
| 2134 | (setq v (intern-soft (concat ms "-speedbar-buttons"))) |
| 2135 | (make-local-variable 'speedbar-special-mode-expansion-list) |
| 2136 | (if (not v) |
| 2137 | (setq speedbar-special-mode-expansion-list t) |
| 2138 | ;; If it is autoloaded, we need to load it now so that |
| 2139 | ;; we have access to the varialbe -speedbar-menu-items. |
| 2140 | ;; Is this XEmacs safe? |
| 2141 | (let ((sf (symbol-function v))) |
| 2142 | (if (and (listp sf) (eq (car sf) 'autoload)) |
| 2143 | (load-library (car (cdr sf))))) |
| 2144 | (setq speedbar-special-mode-expansion-list (list v)) |
| 2145 | (setq v (intern-soft (concat ms "-speedbar-key-map"))) |
| 2146 | (if (not v) |
| 2147 | nil ;; don't add special keymap |
| 2148 | (make-local-variable 'speedbar-special-mode-key-map) |
| 2149 | (setq speedbar-special-mode-key-map |
| 2150 | (symbol-value v))) |
| 2151 | (setq v (intern-soft (concat ms "-speedbar-menu-items"))) |
| 2152 | (if (not v) |
| 2153 | nil ;; don't add special menus |
| 2154 | (make-local-variable 'speedbar-easymenu-definition-special) |
| 2155 | (setq speedbar-easymenu-definition-special |
| 2156 | (symbol-value v))) |
| 2157 | ))))))) |
| 2158 | |
| 2159 | (defun speedbar-remove-localized-speedbar-support (buffer) |
| 2160 | "Remove any traces that BUFFER supports speedbar in a specialized way." |
| 2161 | (save-excursion |
| 2162 | (set-buffer buffer) |
| 2163 | (kill-local-variable 'speedbar-special-mode-expansion-list) |
| 2164 | (kill-local-variable 'speedbar-special-mode-key-map) |
| 2165 | (kill-local-variable 'speedbar-easymenu-definition-special))) |
| 2166 | \f |
| 2167 | ;;; File button management |
| 2168 | ;; |
| 2169 | (defun speedbar-file-lists (directory) |
| 2170 | "Create file lists for DIRECTORY. |
| 2171 | The car is the list of directories, the cdr is list of files not |
| 2172 | matching ignored headers. Cache any directory files found in |
| 2173 | `speedbar-directory-contents-alist' and use that cache before scanning |
| 2174 | the file-system" |
| 2175 | (setq directory (expand-file-name directory)) |
| 2176 | ;; If in powerclick mode, then the directory we are getting |
| 2177 | ;; should be rescanned. |
| 2178 | (if speedbar-power-click |
| 2179 | (adelete 'speedbar-directory-contents-alist directory)) |
| 2180 | ;; find the directory, either in the cache, or build it. |
| 2181 | (or (cdr-safe (assoc directory speedbar-directory-contents-alist)) |
| 2182 | (let ((default-directory directory) |
| 2183 | (dir (directory-files directory nil)) |
| 2184 | (dirs nil) |
| 2185 | (files nil)) |
| 2186 | (while dir |
| 2187 | (if (not |
| 2188 | (or (string-match speedbar-file-unshown-regexp (car dir)) |
| 2189 | (string-match speedbar-directory-unshown-regexp (car dir)))) |
| 2190 | (if (file-directory-p (car dir)) |
| 2191 | (setq dirs (cons (car dir) dirs)) |
| 2192 | (setq files (cons (car dir) files)))) |
| 2193 | (setq dir (cdr dir))) |
| 2194 | (let ((nl (cons (nreverse dirs) (list (nreverse files))))) |
| 2195 | (aput 'speedbar-directory-contents-alist directory nl) |
| 2196 | nl)) |
| 2197 | )) |
| 2198 | |
| 2199 | (defun speedbar-directory-buttons (directory index) |
| 2200 | "Insert a single button group at point for DIRECTORY. |
| 2201 | Each directory path part is a different button. If part of the path |
| 2202 | matches the user directory ~, then it is replaced with a ~. |
| 2203 | INDEX is not used, but is required by the caller." |
| 2204 | (let* ((tilde (expand-file-name "~/")) |
| 2205 | (dd (expand-file-name directory)) |
| 2206 | (junk (string-match (regexp-quote tilde) dd)) |
| 2207 | (displayme (if junk |
| 2208 | (concat "~/" (substring dd (match-end 0))) |
| 2209 | dd)) |
| 2210 | (p (point))) |
| 2211 | (if (string-match "^~[/\\]?\\'" displayme) (setq displayme tilde)) |
| 2212 | (insert displayme) |
| 2213 | (save-excursion |
| 2214 | (goto-char p) |
| 2215 | (while (re-search-forward "\\([^/\\]+\\)[/\\]" nil t) |
| 2216 | (speedbar-make-button (match-beginning 1) (match-end 1) |
| 2217 | 'speedbar-directory-face |
| 2218 | 'speedbar-highlight-face |
| 2219 | 'speedbar-directory-buttons-follow |
| 2220 | (if (and (= (match-beginning 1) p) |
| 2221 | (not (char-equal (char-after (+ p 1)) ?:))) |
| 2222 | (expand-file-name "~/") ;the tilde |
| 2223 | (buffer-substring-no-properties |
| 2224 | p (match-end 0))))) |
| 2225 | ;; Nuke the beginning of the directory if it's too long... |
| 2226 | (cond ((eq speedbar-directory-button-trim-method 'span) |
| 2227 | (beginning-of-line) |
| 2228 | (let ((ww (or (speedbar-frame-width) 20))) |
| 2229 | (move-to-column ww nil) |
| 2230 | (while (>= (current-column) ww) |
| 2231 | (re-search-backward "[/\\]" nil t) |
| 2232 | (if (<= (current-column) 2) |
| 2233 | (progn |
| 2234 | (re-search-forward "[/\\]" nil t) |
| 2235 | (if (< (current-column) 4) |
| 2236 | (re-search-forward "[/\\]" nil t)) |
| 2237 | (forward-char -1))) |
| 2238 | (if (looking-at "[/\\]?$") |
| 2239 | (beginning-of-line) |
| 2240 | (insert "/...\n ") |
| 2241 | (move-to-column ww nil))))) |
| 2242 | ((eq speedbar-directory-button-trim-method 'trim) |
| 2243 | (end-of-line) |
| 2244 | (let ((ww (or (speedbar-frame-width) 20)) |
| 2245 | (tl (current-column))) |
| 2246 | (if (< ww tl) |
| 2247 | (progn |
| 2248 | (move-to-column (- tl ww)) |
| 2249 | (if (re-search-backward "[/\\]" nil t) |
| 2250 | (progn |
| 2251 | (delete-region (point-min) (point)) |
| 2252 | (insert "$") |
| 2253 | ))))))) |
| 2254 | ) |
| 2255 | (if (string-match "\\`[/\\][^/\\]+[/\\]\\'" displayme) |
| 2256 | (progn |
| 2257 | (insert " ") |
| 2258 | (let ((p (point))) |
| 2259 | (insert "<root>") |
| 2260 | (speedbar-make-button p (point) |
| 2261 | 'speedbar-directory-face |
| 2262 | 'speedbar-highlight-face |
| 2263 | 'speedbar-directory-buttons-follow |
| 2264 | "/")))) |
| 2265 | (end-of-line) |
| 2266 | (insert-char ?\n 1 nil))) |
| 2267 | |
| 2268 | (defun speedbar-make-tag-line (exp-button-type |
| 2269 | exp-button-char exp-button-function |
| 2270 | exp-button-data |
| 2271 | tag-button tag-button-function tag-button-data |
| 2272 | tag-button-face depth) |
| 2273 | "Create a tag line with EXP-BUTTON-TYPE for the small expansion button. |
| 2274 | This is the button that expands or contracts a node (if applicable), |
| 2275 | and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION |
| 2276 | is the function to call if it's clicked on. Button types are |
| 2277 | 'bracket, 'angle, 'curly, or nil. EXP-BUTTON-DATA is extra data |
| 2278 | attached to the text forming the expansion button. |
| 2279 | |
| 2280 | Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the |
| 2281 | function to call if clicked on, and TAG-BUTTON-DATA is the data to |
| 2282 | attach to the text field (such a tag positioning, etc). |
| 2283 | TAG-BUTTON-FACE is a face used for this type of tag. |
| 2284 | |
| 2285 | Lastly, DEPTH shows the depth of expansion. |
| 2286 | |
| 2287 | This function assumes that the cursor is in the speedbar window at the |
| 2288 | position to insert a new item, and that the new item will end with a CR" |
| 2289 | (let ((start (point)) |
| 2290 | (end (progn |
| 2291 | (insert (int-to-string depth) ":") |
| 2292 | (point))) |
| 2293 | (depthspacesize (* depth speedbar-indentation-width))) |
| 2294 | (put-text-property start end 'invisible t) |
| 2295 | (insert-char ? depthspacesize nil) |
| 2296 | (put-text-property (- (point) depthspacesize) (point) 'invisible nil) |
| 2297 | (let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]") |
| 2298 | ((eq exp-button-type 'angle) "<%c>") |
| 2299 | ((eq exp-button-type 'curly) "{%c}") |
| 2300 | (t ">"))) |
| 2301 | (buttxt (format exp-button exp-button-char)) |
| 2302 | (start (point)) |
| 2303 | (end (progn (insert buttxt) (point))) |
| 2304 | (bf (if exp-button-type 'speedbar-button-face nil)) |
| 2305 | (mf (if exp-button-function 'speedbar-highlight-face nil)) |
| 2306 | ) |
| 2307 | (speedbar-make-button start end bf mf exp-button-function exp-button-data) |
| 2308 | (if speedbar-hide-button-brackets-flag |
| 2309 | (progn |
| 2310 | (put-text-property start (1+ start) 'invisible t) |
| 2311 | (put-text-property end (1- end) 'invisible t))) |
| 2312 | ) |
| 2313 | (insert-char ? 1 nil) |
| 2314 | (put-text-property (1- (point)) (point) 'invisible nil) |
| 2315 | (let ((start (point)) |
| 2316 | (end (progn (insert tag-button) (point)))) |
| 2317 | (insert-char ?\n 1 nil) |
| 2318 | (put-text-property (1- (point)) (point) 'invisible nil) |
| 2319 | (speedbar-make-button start end tag-button-face |
| 2320 | (if tag-button-function 'speedbar-highlight-face nil) |
| 2321 | tag-button-function tag-button-data)) |
| 2322 | )) |
| 2323 | |
| 2324 | (defun speedbar-change-expand-button-char (char) |
| 2325 | "Change the expansion button character to CHAR for the current line." |
| 2326 | (save-excursion |
| 2327 | (beginning-of-line) |
| 2328 | (if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line) |
| 2329 | (point)) t) |
| 2330 | (speedbar-with-writable |
| 2331 | (goto-char (match-beginning 1)) |
| 2332 | (delete-char 1) |
| 2333 | (insert-char char 1 t) |
| 2334 | (put-text-property (point) (1- (point)) 'invisible nil) |
| 2335 | ;; make sure we fix the image on the text here. |
| 2336 | (speedbar-insert-image-button-maybe (- (point) 2) 3))))) |
| 2337 | |
| 2338 | \f |
| 2339 | ;;; Build button lists |
| 2340 | ;; |
| 2341 | (defun speedbar-insert-files-at-point (files level) |
| 2342 | "Insert list of FILES starting at point, and indenting all files to LEVEL. |
| 2343 | Tag expandable items with a +, otherwise a ?. Don't highlight ? as we |
| 2344 | don't know how to manage them. The input parameter FILES is a cons |
| 2345 | cell of the form ( 'DIRLIST . 'FILELIST )" |
| 2346 | ;; Start inserting all the directories |
| 2347 | (let ((dirs (car files))) |
| 2348 | (while dirs |
| 2349 | (speedbar-make-tag-line 'angle ?+ 'speedbar-dired (car dirs) |
| 2350 | (car dirs) 'speedbar-dir-follow nil |
| 2351 | 'speedbar-directory-face level) |
| 2352 | (setq dirs (cdr dirs)))) |
| 2353 | (let ((lst (car (cdr files))) |
| 2354 | (case-fold-search t)) |
| 2355 | (while lst |
| 2356 | (let* ((known (string-match speedbar-file-regexp (car lst))) |
| 2357 | (expchar (if known ?+ ??)) |
| 2358 | (fn (if known 'speedbar-tag-file nil))) |
| 2359 | (if (or speedbar-show-unknown-files (/= expchar ??)) |
| 2360 | (speedbar-make-tag-line 'bracket expchar fn (car lst) |
| 2361 | (car lst) 'speedbar-find-file nil |
| 2362 | 'speedbar-file-face level))) |
| 2363 | (setq lst (cdr lst))))) |
| 2364 | |
| 2365 | (defun speedbar-default-directory-list (directory index) |
| 2366 | "Insert files for DIRECTORY with level INDEX at point." |
| 2367 | (speedbar-insert-files-at-point |
| 2368 | (speedbar-file-lists directory) index) |
| 2369 | (speedbar-reset-scanners) |
| 2370 | (if (= index 0) |
| 2371 | ;; If the shown files variable has extra directories, then |
| 2372 | ;; it is our responsibility to redraw them all |
| 2373 | ;; Luckilly, the nature of inserting items into this list means |
| 2374 | ;; that by reversing it, we can easilly go in the right order |
| 2375 | (let ((sf (cdr (reverse speedbar-shown-directories)))) |
| 2376 | (setq speedbar-shown-directories |
| 2377 | (list (expand-file-name default-directory))) |
| 2378 | ;; exand them all as we find them |
| 2379 | (while sf |
| 2380 | (if (speedbar-goto-this-file (car sf)) |
| 2381 | (progn |
| 2382 | (beginning-of-line) |
| 2383 | (if (looking-at "[0-9]+:[ ]*<") |
| 2384 | (progn |
| 2385 | (goto-char (match-end 0)) |
| 2386 | (speedbar-do-function-pointer))) |
| 2387 | (setq sf (cdr sf))))) |
| 2388 | ))) |
| 2389 | |
| 2390 | (defun speedbar-sort-tag-hierarchy (lst) |
| 2391 | "Sort all elements of tag hierarchy LST." |
| 2392 | (sort (copy-alist lst) |
| 2393 | (lambda (a b) (string< (car a) (car b))))) |
| 2394 | |
| 2395 | (defun speedbar-prefix-group-tag-hierarchy (lst) |
| 2396 | "Prefix group names for tag hierarchy LST." |
| 2397 | (let ((newlst nil) |
| 2398 | (sublst nil) |
| 2399 | (work-list nil) |
| 2400 | (junk-list nil) |
| 2401 | (short-group-list nil) |
| 2402 | (short-start-name nil) |
| 2403 | (short-end-name nil) |
| 2404 | (num-shorts-grouped 0) |
| 2405 | (bins (make-vector 256 nil)) |
| 2406 | (diff-idx 0)) |
| 2407 | ;; Break out sub-lists |
| 2408 | (while lst |
| 2409 | (if (and (listp (cdr-safe (car-safe lst))) |
| 2410 | ;; This one is for bovine tokens |
| 2411 | (not (symbolp (car-safe (cdr-safe (car-safe lst)))))) |
| 2412 | (setq newlst (cons (car lst) newlst)) |
| 2413 | (setq sublst (cons (car lst) sublst))) |
| 2414 | (setq lst (cdr lst))) |
| 2415 | ;; Reverse newlst because it was made backwards. |
| 2416 | ;; Sublist doesn't need reversing because the act |
| 2417 | ;; of binning things will reverse it for us. |
| 2418 | (setq newlst (nreverse newlst)) |
| 2419 | ;; Now, first find out how long our list is. Never let a |
| 2420 | ;; list get-shorter than our minimum. |
| 2421 | (if (<= (length sublst) speedbar-tag-split-minimum-length) |
| 2422 | (setq work-list (nreverse sublst)) |
| 2423 | (setq diff-idx (length (try-completion "" sublst))) |
| 2424 | ;; Sort the whole list into bins. |
| 2425 | (while sublst |
| 2426 | (let ((e (car sublst)) |
| 2427 | (s (car (car sublst)))) |
| 2428 | (cond ((<= (length s) diff-idx) |
| 2429 | ;; 0 storage bin for shorty. |
| 2430 | (aset bins 0 (cons e (aref bins 0)))) |
| 2431 | (t |
| 2432 | ;; stuff into a bin based on ascii value at diff |
| 2433 | (aset bins (aref s diff-idx) |
| 2434 | (cons e (aref bins (aref s diff-idx))))))) |
| 2435 | (setq sublst (cdr sublst))) |
| 2436 | ;; Go through all our bins Stick singles into our |
| 2437 | ;; junk-list, everything else as sublsts in work-list. |
| 2438 | ;; If two neighboring lists are both small, make a grouped |
| 2439 | ;; group combinding those two sub-lists. |
| 2440 | (setq diff-idx 0) |
| 2441 | (while (> 256 diff-idx) |
| 2442 | (let ((l (nreverse;; Reverse the list since they are stuck in |
| 2443 | ;; backwards. |
| 2444 | (aref bins diff-idx)))) |
| 2445 | (if l |
| 2446 | (let ((tmp (cons (try-completion "" l) l))) |
| 2447 | (if (or (> (length l) speedbar-tag-regroup-maximum-length) |
| 2448 | (> (+ (length l) (length short-group-list)) |
| 2449 | speedbar-tag-split-minimum-length)) |
| 2450 | (progn |
| 2451 | ;; We have reached a longer list, so we |
| 2452 | ;; must finish off a grouped group. |
| 2453 | (cond |
| 2454 | ((and short-group-list |
| 2455 | (= (length short-group-list) |
| 2456 | num-shorts-grouped)) |
| 2457 | ;; All singles? Junk list |
| 2458 | (setq junk-list (append short-group-list |
| 2459 | junk-list))) |
| 2460 | ((= num-shorts-grouped 1) |
| 2461 | ;; Only one short group? Just stick it in |
| 2462 | ;; there by itself. Make a group, and find |
| 2463 | ;; a subexpression |
| 2464 | (let ((subexpression (try-completion |
| 2465 | "" short-group-list))) |
| 2466 | (if (< (length subexpression) |
| 2467 | speedbar-tag-group-name-minimum-length) |
| 2468 | (setq subexpression |
| 2469 | (concat short-start-name |
| 2470 | " (" |
| 2471 | (substring |
| 2472 | (car (car short-group-list)) |
| 2473 | (length short-start-name)) |
| 2474 | ")"))) |
| 2475 | (setq work-list |
| 2476 | (cons (cons subexpression |
| 2477 | short-group-list) |
| 2478 | work-list)))) |
| 2479 | (short-group-list |
| 2480 | ;; Multiple groups to be named in a special |
| 2481 | ;; way by displaying the range over which we |
| 2482 | ;; have grouped them. |
| 2483 | (setq work-list |
| 2484 | (cons (cons (concat short-start-name |
| 2485 | " to " |
| 2486 | short-end-name) |
| 2487 | (nreverse short-group-list)) |
| 2488 | work-list)))) |
| 2489 | ;; Reset short group list information every time. |
| 2490 | (setq short-group-list nil |
| 2491 | short-start-name nil |
| 2492 | short-end-name nil |
| 2493 | num-shorts-grouped 0))) |
| 2494 | ;; Ok, now that we cleaned up the short-group-list, |
| 2495 | ;; we can deal with this new list, to decide if it |
| 2496 | ;; should go on one of these sub-lists or not. |
| 2497 | (if (< (length l) speedbar-tag-regroup-maximum-length) |
| 2498 | (setq short-group-list (append short-group-list l) |
| 2499 | num-shorts-grouped (1+ num-shorts-grouped) |
| 2500 | short-end-name (car tmp) |
| 2501 | short-start-name (if short-start-name |
| 2502 | short-start-name |
| 2503 | (car tmp))) |
| 2504 | (setq work-list (cons tmp work-list)))))) |
| 2505 | (setq diff-idx (1+ diff-idx)))) |
| 2506 | ;; Did we run out of things? Drop our new list onto the end. |
| 2507 | (cond |
| 2508 | ((and short-group-list (= (length short-group-list) num-shorts-grouped)) |
| 2509 | ;; All singles? Junk list |
| 2510 | (setq junk-list (append short-group-list junk-list))) |
| 2511 | ((= num-shorts-grouped 1) |
| 2512 | ;; Only one short group? Just stick it in |
| 2513 | ;; there by itself. |
| 2514 | (setq work-list |
| 2515 | (cons (cons (try-completion "" short-group-list) |
| 2516 | short-group-list) |
| 2517 | work-list))) |
| 2518 | (short-group-list |
| 2519 | ;; Multiple groups to be named in a special |
| 2520 | ;; way by displaying the range over which we |
| 2521 | ;; have grouped them. |
| 2522 | (setq work-list |
| 2523 | (cons (cons (concat short-start-name " to " short-end-name) |
| 2524 | short-group-list) |
| 2525 | work-list)))) |
| 2526 | ;; Reverse the work list nreversed when consing. |
| 2527 | (setq work-list (nreverse work-list)) |
| 2528 | ;; Now, stick our new list onto the end of |
| 2529 | (if work-list |
| 2530 | (if junk-list |
| 2531 | (append newlst work-list junk-list) |
| 2532 | (append newlst work-list)) |
| 2533 | (append newlst junk-list)))) |
| 2534 | |
| 2535 | (defun speedbar-trim-words-tag-hierarchy (lst) |
| 2536 | "Trim all words in a tag hierarchy. |
| 2537 | Base trimming information on word separators, and group names. |
| 2538 | Argument LST is the list of tags to trim." |
| 2539 | (let ((newlst nil) |
| 2540 | (sublst nil) |
| 2541 | (trim-prefix nil) |
| 2542 | (trim-chars 0) |
| 2543 | (trimlst nil)) |
| 2544 | (while lst |
| 2545 | (if (listp (cdr-safe (car-safe lst))) |
| 2546 | (setq newlst (cons (car lst) newlst)) |
| 2547 | (setq sublst (cons (car lst) sublst))) |
| 2548 | (setq lst (cdr lst))) |
| 2549 | ;; Get the prefix to trim by. Make sure that we don't trim |
| 2550 | ;; off silly pieces, only complete understandable words. |
| 2551 | (setq trim-prefix (try-completion "" sublst)) |
| 2552 | (if (or (= (length sublst) 1) |
| 2553 | (not trim-prefix) |
| 2554 | (not (string-match "\\(\\w+\\W+\\)+" trim-prefix))) |
| 2555 | (append (nreverse newlst) (nreverse sublst)) |
| 2556 | (setq trim-prefix (substring trim-prefix (match-beginning 0) |
| 2557 | (match-end 0))) |
| 2558 | (setq trim-chars (length trim-prefix)) |
| 2559 | (while sublst |
| 2560 | (setq trimlst (cons |
| 2561 | (cons (substring (car (car sublst)) trim-chars) |
| 2562 | (cdr (car sublst))) |
| 2563 | trimlst) |
| 2564 | sublst (cdr sublst))) |
| 2565 | ;; Put the lists together |
| 2566 | (append (nreverse newlst) trimlst)))) |
| 2567 | |
| 2568 | (defun speedbar-simple-group-tag-hierarchy (lst) |
| 2569 | "Create a simple 'Tags' group with orphaned tags. |
| 2570 | Argument LST is the list of tags to sort into groups." |
| 2571 | (let ((newlst nil) |
| 2572 | (sublst nil)) |
| 2573 | (while lst |
| 2574 | (if (listp (cdr-safe (car-safe lst))) |
| 2575 | (setq newlst (cons (car lst) newlst)) |
| 2576 | (setq sublst (cons (car lst) sublst))) |
| 2577 | (setq lst (cdr lst))) |
| 2578 | (if (not newlst) |
| 2579 | (nreverse sublst) |
| 2580 | (setq newlst (cons (cons "Tags" (nreverse sublst)) newlst)) |
| 2581 | (nreverse newlst)))) |
| 2582 | |
| 2583 | (defun speedbar-create-tag-hierarchy (lst) |
| 2584 | "Adjust the tag hierarchy in LST, and return it. |
| 2585 | This uses `speedbar-tag-hierarchy-method' to determine how to adjust |
| 2586 | the list." |
| 2587 | (let* ((f (save-excursion |
| 2588 | (forward-line -1) |
| 2589 | (speedbar-line-path))) |
| 2590 | (methods (if (get-file-buffer f) |
| 2591 | (save-excursion (set-buffer (get-file-buffer f)) |
| 2592 | speedbar-tag-hierarchy-method) |
| 2593 | speedbar-tag-hierarchy-method)) |
| 2594 | (lst (if (fboundp 'copy-tree) |
| 2595 | (copy-tree lst) |
| 2596 | lst))) |
| 2597 | (while methods |
| 2598 | (setq lst (funcall (car methods) lst) |
| 2599 | methods (cdr methods))) |
| 2600 | lst)) |
| 2601 | |
| 2602 | (defun speedbar-insert-generic-list (level lst expand-fun find-fun) |
| 2603 | "At LEVEL, insert a generic multi-level alist LST. |
| 2604 | Associations with lists get {+} tags (to expand into more nodes) and |
| 2605 | those with positions just get a > as the indicator. {+} buttons will |
| 2606 | have the function EXPAND-FUN and the token is the CDR list. The token |
| 2607 | name will have the function FIND-FUN and not token." |
| 2608 | ;; Remove imenu rescan button |
| 2609 | (if (string= (car (car lst)) "*Rescan*") |
| 2610 | (setq lst (cdr lst))) |
| 2611 | ;; Adjust the list. |
| 2612 | (setq lst (speedbar-create-tag-hierarchy lst)) |
| 2613 | ;; insert the parts |
| 2614 | (while lst |
| 2615 | (cond ((null (car-safe lst)) nil) ;this would be a separator |
| 2616 | ((or (numberp (cdr-safe (car-safe lst))) |
| 2617 | (markerp (cdr-safe (car-safe lst)))) |
| 2618 | (speedbar-make-tag-line nil nil nil nil ;no expand button data |
| 2619 | (car (car lst)) ;button name |
| 2620 | find-fun ;function |
| 2621 | (cdr (car lst)) ;token is position |
| 2622 | 'speedbar-tag-face |
| 2623 | (1+ level))) |
| 2624 | ((listp (cdr-safe (car-safe lst))) |
| 2625 | (speedbar-make-tag-line 'curly ?+ expand-fun (cdr (car lst)) |
| 2626 | (car (car lst)) ;button name |
| 2627 | nil nil 'speedbar-tag-face |
| 2628 | (1+ level))) |
| 2629 | (t (speedbar-message "Ooops!"))) |
| 2630 | (setq lst (cdr lst)))) |
| 2631 | |
| 2632 | (defun speedbar-insert-imenu-list (indent lst) |
| 2633 | "At level INDENT, insert the imenu generated LST." |
| 2634 | (speedbar-insert-generic-list indent lst |
| 2635 | 'speedbar-tag-expand |
| 2636 | 'speedbar-tag-find)) |
| 2637 | |
| 2638 | (defun speedbar-insert-etags-list (indent lst) |
| 2639 | "At level INDENT, insert the etags generated LST." |
| 2640 | (speedbar-insert-generic-list indent lst |
| 2641 | 'speedbar-tag-expand |
| 2642 | 'speedbar-tag-find)) |
| 2643 | \f |
| 2644 | ;;; Timed functions |
| 2645 | ;; |
| 2646 | (defun speedbar-update-contents () |
| 2647 | "Generically update the contents of the speedbar buffer." |
| 2648 | (interactive) |
| 2649 | ;; Set the current special buffer |
| 2650 | (setq speedbar-desired-buffer nil) |
| 2651 | ;; Check for special modes |
| 2652 | (speedbar-maybe-add-localized-support (current-buffer)) |
| 2653 | ;; Choose the correct method of doodling. |
| 2654 | (if (and speedbar-mode-specific-contents-flag |
| 2655 | (listp speedbar-special-mode-expansion-list) |
| 2656 | speedbar-special-mode-expansion-list |
| 2657 | (local-variable-p |
| 2658 | 'speedbar-special-mode-expansion-list |
| 2659 | (current-buffer))) |
| 2660 | ;;(eq (get major-mode 'mode-class 'special))) |
| 2661 | (speedbar-update-special-contents) |
| 2662 | (speedbar-update-directory-contents))) |
| 2663 | |
| 2664 | (defun speedbar-update-directory-contents () |
| 2665 | "Update the contents of the speedbar buffer based on the current directory." |
| 2666 | (let ((cbd (expand-file-name default-directory)) |
| 2667 | cbd-parent |
| 2668 | (funclst (speedbar-initial-expansion-list)) |
| 2669 | (cache speedbar-full-text-cache) |
| 2670 | ;; disable stealth during update |
| 2671 | (speedbar-stealthy-function-list nil) |
| 2672 | (use-cache nil) |
| 2673 | (expand-local nil) |
| 2674 | ;; Because there is a bug I can't find just yet |
| 2675 | (inhibit-quit nil)) |
| 2676 | (save-excursion |
| 2677 | (set-buffer speedbar-buffer) |
| 2678 | ;; If we are updating contents to where we are, then this is |
| 2679 | ;; really a request to update existing contents, so we must be |
| 2680 | ;; careful with our text cache! |
| 2681 | (if (member cbd speedbar-shown-directories) |
| 2682 | (progn |
| 2683 | (setq cache nil) |
| 2684 | ;; If the current directory is not the last element in the dir |
| 2685 | ;; list, then we ALSO need to zap the list of expanded directories |
| 2686 | (if (/= (length (member cbd speedbar-shown-directories)) 1) |
| 2687 | (setq speedbar-shown-directories (list cbd)))) |
| 2688 | |
| 2689 | ;; Build cbd-parent, and see if THAT is in the current shown |
| 2690 | ;; directories. First, go through pains to get the parent directory |
| 2691 | (if (and speedbar-smart-directory-expand-flag |
| 2692 | (save-match-data |
| 2693 | (setq cbd-parent cbd) |
| 2694 | (if (string-match "[/\\]$" cbd-parent) |
| 2695 | (setq cbd-parent (substring cbd-parent 0 |
| 2696 | (match-beginning 0)))) |
| 2697 | (setq cbd-parent (file-name-directory cbd-parent))) |
| 2698 | (member cbd-parent speedbar-shown-directories)) |
| 2699 | (setq expand-local t) |
| 2700 | |
| 2701 | ;; If this directory is NOT in the current list of available |
| 2702 | ;; paths, then use the cache, and set the cache to our new |
| 2703 | ;; value. Make sure to unhighlight the current file, or if we |
| 2704 | ;; come back to this directory, it might be a different file |
| 2705 | ;; and then we get a mess! |
| 2706 | (if (> (point-max) 1) |
| 2707 | (progn |
| 2708 | (speedbar-clear-current-file) |
| 2709 | (setq speedbar-full-text-cache |
| 2710 | (cons speedbar-shown-directories (buffer-string))))) |
| 2711 | |
| 2712 | ;; Check if our new directory is in the list of directories |
| 2713 | ;; shown in the text-cache |
| 2714 | (if (member cbd (car cache)) |
| 2715 | (setq speedbar-shown-directories (car cache) |
| 2716 | use-cache t) |
| 2717 | ;; default the shown directories to this list... |
| 2718 | (setq speedbar-shown-directories (list cbd))) |
| 2719 | )) |
| 2720 | (if (not expand-local) (setq speedbar-last-selected-file nil)) |
| 2721 | (speedbar-with-writable |
| 2722 | (if (and expand-local |
| 2723 | ;; Find this directory as a speedbar node. |
| 2724 | (speedbar-path-line cbd)) |
| 2725 | ;; Open it. |
| 2726 | (speedbar-expand-line) |
| 2727 | (erase-buffer) |
| 2728 | (cond (use-cache |
| 2729 | (setq default-directory |
| 2730 | (nth (1- (length speedbar-shown-directories)) |
| 2731 | speedbar-shown-directories)) |
| 2732 | (insert (cdr cache))) |
| 2733 | (t |
| 2734 | (while funclst |
| 2735 | (setq default-directory cbd) |
| 2736 | (funcall (car funclst) cbd 0) |
| 2737 | (setq funclst (cdr funclst)))))) |
| 2738 | (goto-char (point-min))))) |
| 2739 | (speedbar-reconfigure-keymaps)) |
| 2740 | |
| 2741 | (defun speedbar-update-special-contents () |
| 2742 | "Used the mode-specific variable to fill in the speedbar buffer. |
| 2743 | This should only be used by modes classified as special." |
| 2744 | (let ((funclst speedbar-special-mode-expansion-list) |
| 2745 | (specialbuff (current-buffer))) |
| 2746 | (save-excursion |
| 2747 | (setq speedbar-desired-buffer specialbuff) |
| 2748 | (set-buffer speedbar-buffer) |
| 2749 | ;; If we are leaving a directory, cache it. |
| 2750 | (if (not speedbar-shown-directories) |
| 2751 | ;; Do nothing |
| 2752 | nil |
| 2753 | ;; Clean up directory maintenance stuff |
| 2754 | (speedbar-clear-current-file) |
| 2755 | (setq speedbar-full-text-cache |
| 2756 | (cons speedbar-shown-directories (buffer-string)) |
| 2757 | speedbar-shown-directories nil)) |
| 2758 | ;; Now fill in the buffer with our newly found specialized list. |
| 2759 | (speedbar-with-writable |
| 2760 | (while funclst |
| 2761 | ;; We do not erase the buffer because these functions may |
| 2762 | ;; decide NOT to update themselves. |
| 2763 | (funcall (car funclst) specialbuff) |
| 2764 | (setq funclst (cdr funclst)))) |
| 2765 | (goto-char (point-min)))) |
| 2766 | (speedbar-reconfigure-keymaps)) |
| 2767 | |
| 2768 | (defun speedbar-timer-fn () |
| 2769 | "Run whenever Emacs is idle to update the speedbar item." |
| 2770 | (if (not (and (frame-live-p speedbar-frame) |
| 2771 | (frame-live-p speedbar-attached-frame))) |
| 2772 | (speedbar-set-timer nil) |
| 2773 | ;; Save all the match data so that we don't mess up executing fns |
| 2774 | (save-match-data |
| 2775 | ;; Only do stuff if the frame is visible, not an icon, and if |
| 2776 | ;; it is currently flagged to do something. |
| 2777 | (if (and speedbar-update-flag |
| 2778 | (frame-visible-p speedbar-frame) |
| 2779 | (not (eq (frame-visible-p speedbar-frame) 'icon))) |
| 2780 | (let ((af (selected-frame))) |
| 2781 | (save-window-excursion |
| 2782 | (select-frame speedbar-attached-frame) |
| 2783 | ;; make sure we at least choose a window to |
| 2784 | ;; get a good directory from |
| 2785 | (if (window-minibuffer-p (selected-window)) |
| 2786 | nil |
| 2787 | ;; Check for special modes |
| 2788 | (speedbar-maybe-add-localized-support (current-buffer)) |
| 2789 | ;; Update for special mode all the time! |
| 2790 | (if (and speedbar-mode-specific-contents-flag |
| 2791 | (listp speedbar-special-mode-expansion-list) |
| 2792 | speedbar-special-mode-expansion-list |
| 2793 | (local-variable-p |
| 2794 | 'speedbar-special-mode-expansion-list |
| 2795 | (current-buffer))) |
| 2796 | ;;(eq (get major-mode 'mode-class 'special))) |
| 2797 | (progn |
| 2798 | (if (<= 2 speedbar-verbosity-level) |
| 2799 | (speedbar-message |
| 2800 | "Updating speedbar to special mode: %s..." |
| 2801 | major-mode)) |
| 2802 | (speedbar-update-special-contents) |
| 2803 | (if (<= 2 speedbar-verbosity-level) |
| 2804 | (progn |
| 2805 | (speedbar-message |
| 2806 | "Updating speedbar to special mode: %s...done" |
| 2807 | major-mode) |
| 2808 | (speedbar-message nil)))) |
| 2809 | ;; Update all the contents if directories change! |
| 2810 | (if (or (member (expand-file-name default-directory) |
| 2811 | speedbar-shown-directories) |
| 2812 | (and speedbar-ignored-path-regexp |
| 2813 | (string-match |
| 2814 | speedbar-ignored-path-regexp |
| 2815 | (expand-file-name default-directory))) |
| 2816 | (member major-mode speedbar-ignored-modes) |
| 2817 | (eq af speedbar-frame) |
| 2818 | (not (buffer-file-name))) |
| 2819 | nil |
| 2820 | (if (<= 1 speedbar-verbosity-level) |
| 2821 | (speedbar-message "Updating speedbar to: %s..." |
| 2822 | default-directory)) |
| 2823 | (speedbar-update-directory-contents) |
| 2824 | (if (<= 1 speedbar-verbosity-level) |
| 2825 | (progn |
| 2826 | (speedbar-message "Updating speedbar to: %s...done" |
| 2827 | default-directory) |
| 2828 | (speedbar-message nil))))) |
| 2829 | (select-frame af))) |
| 2830 | ;; Now run stealthy updates of time-consuming items |
| 2831 | (speedbar-stealthy-updates))) |
| 2832 | ;; Now run the mouse tracking system |
| 2833 | (speedbar-show-info-under-mouse))) |
| 2834 | (run-hooks 'speedbar-timer-hook)) |
| 2835 | |
| 2836 | \f |
| 2837 | ;;; Stealthy activities |
| 2838 | ;; |
| 2839 | (defvar speedbar-stealthy-update-recurse nil |
| 2840 | "Recursion avoidance variable for stealthy update.") |
| 2841 | |
| 2842 | (defun speedbar-stealthy-updates () |
| 2843 | "For a given speedbar, run all items in the stealthy function list. |
| 2844 | Each item returns t if it completes successfully, or nil if |
| 2845 | interrupted by the user." |
| 2846 | (if (not speedbar-stealthy-update-recurse) |
| 2847 | (let ((l (speedbar-initial-stealthy-functions)) |
| 2848 | (speedbar-stealthy-update-recurse t)) |
| 2849 | (unwind-protect |
| 2850 | (speedbar-with-writable |
| 2851 | (while (and l (funcall (car l))) |
| 2852 | ;;(sit-for 0) |
| 2853 | (setq l (cdr l)))) |
| 2854 | ;;(speedbar-message "Exit with %S" (car l)) |
| 2855 | )))) |
| 2856 | |
| 2857 | (defun speedbar-reset-scanners () |
| 2858 | "Reset any variables used by functions in the stealthy list as state. |
| 2859 | If new functions are added, their state needs to be updated here." |
| 2860 | (setq speedbar-vc-to-do-point t |
| 2861 | speedbar-obj-to-do-point t) |
| 2862 | (run-hooks 'speedbar-scanner-reset-hook) |
| 2863 | ) |
| 2864 | |
| 2865 | (defun speedbar-find-selected-file (file) |
| 2866 | "Goto the line where FILE is." |
| 2867 | (goto-char (point-min)) |
| 2868 | (let ((m nil)) |
| 2869 | (while (and (setq m (re-search-forward |
| 2870 | (concat " \\(" (file-name-nondirectory file) |
| 2871 | "\\)\\(" speedbar-indicator-regex "\\)?\n") |
| 2872 | nil t)) |
| 2873 | (not (string= file |
| 2874 | (concat |
| 2875 | (speedbar-line-path |
| 2876 | (save-excursion |
| 2877 | (goto-char (match-beginning 0)) |
| 2878 | (beginning-of-line) |
| 2879 | (save-match-data |
| 2880 | (looking-at "[0-9]+:") |
| 2881 | (string-to-number (match-string 0))))) |
| 2882 | (match-string 1)))))) |
| 2883 | (if m |
| 2884 | (progn |
| 2885 | (goto-char (match-beginning 1)) |
| 2886 | (match-string 1))))) |
| 2887 | |
| 2888 | (defun speedbar-clear-current-file () |
| 2889 | "Locate the file thought to be current, and remove its highlighting." |
| 2890 | (save-excursion |
| 2891 | (set-buffer speedbar-buffer) |
| 2892 | (if speedbar-last-selected-file |
| 2893 | (speedbar-with-writable |
| 2894 | (if (speedbar-find-selected-file speedbar-last-selected-file) |
| 2895 | (put-text-property (match-beginning 1) |
| 2896 | (match-end 1) |
| 2897 | 'face |
| 2898 | 'speedbar-file-face)))))) |
| 2899 | |
| 2900 | (defun speedbar-update-current-file () |
| 2901 | "Find the current file, and update our visuals to indicate its name. |
| 2902 | This is specific to file names. If the file name doesn't show up, but |
| 2903 | it should be in the list, then the directory cache needs to be |
| 2904 | updated." |
| 2905 | (let* ((lastf (selected-frame)) |
| 2906 | (newcfd (save-excursion |
| 2907 | (select-frame speedbar-attached-frame) |
| 2908 | (let ((rf (if (buffer-file-name) |
| 2909 | (buffer-file-name) |
| 2910 | nil))) |
| 2911 | (select-frame lastf) |
| 2912 | rf))) |
| 2913 | (newcf (if newcfd newcfd)) |
| 2914 | (lastb (current-buffer)) |
| 2915 | (sucf-recursive (boundp 'sucf-recursive)) |
| 2916 | (case-fold-search t)) |
| 2917 | (if (and newcf |
| 2918 | ;; check here, that way we won't refresh to newcf until |
| 2919 | ;; its been written, thus saving ourselves some time |
| 2920 | (file-exists-p newcf) |
| 2921 | (not (string= newcf speedbar-last-selected-file))) |
| 2922 | (progn |
| 2923 | ;; It is important to select the frame, otherwise the window |
| 2924 | ;; we want the cursor to move in will not be updated by the |
| 2925 | ;; search-forward command. |
| 2926 | (select-frame speedbar-frame) |
| 2927 | ;; Remove the old file... |
| 2928 | (speedbar-clear-current-file) |
| 2929 | ;; now highlight the new one. |
| 2930 | (set-buffer speedbar-buffer) |
| 2931 | (speedbar-with-writable |
| 2932 | (if (speedbar-find-selected-file newcf) |
| 2933 | ;; put the property on it |
| 2934 | (put-text-property (match-beginning 1) |
| 2935 | (match-end 1) |
| 2936 | 'face |
| 2937 | 'speedbar-selected-face) |
| 2938 | ;; Oops, it's not in the list. Should it be? |
| 2939 | (if (and (string-match speedbar-file-regexp newcf) |
| 2940 | (string= (file-name-directory newcfd) |
| 2941 | (expand-file-name default-directory))) |
| 2942 | ;; yes, it is (we will ignore unknowns for now...) |
| 2943 | (progn |
| 2944 | (speedbar-refresh) |
| 2945 | (if (speedbar-find-selected-file newcf) |
| 2946 | ;; put the property on it |
| 2947 | (put-text-property (match-beginning 1) |
| 2948 | (match-end 1) |
| 2949 | 'face |
| 2950 | 'speedbar-selected-face))) |
| 2951 | ;; if it's not in there now, whatever... |
| 2952 | )) |
| 2953 | (setq speedbar-last-selected-file newcf)) |
| 2954 | (if (not sucf-recursive) |
| 2955 | (progn |
| 2956 | (speedbar-center-buffer-smartly) |
| 2957 | (speedbar-position-cursor-on-line) |
| 2958 | )) |
| 2959 | (set-buffer lastb) |
| 2960 | (select-frame lastf) |
| 2961 | ))) |
| 2962 | ;; return that we are done with this activity. |
| 2963 | t) |
| 2964 | |
| 2965 | (defun speedbar-add-indicator (indicator-string &optional replace-this) |
| 2966 | "Add INDICATOR-STRING to the end of this speedbar line. |
| 2967 | If INDICATOR-STRING is space, and REPLACE-THIS is a character, then |
| 2968 | an the existing indicator is removed. If there is already an |
| 2969 | indicator, then do not add a space." |
| 2970 | (beginning-of-line) |
| 2971 | ;; The nature of the beast: Assume we are in "the right place" |
| 2972 | (end-of-line) |
| 2973 | (skip-chars-backward (concat " " speedbar-vc-indicator |
| 2974 | (car speedbar-obj-indicator) |
| 2975 | (cdr speedbar-obj-indicator))) |
| 2976 | (if (and (not (looking-at speedbar-indicator-regex)) |
| 2977 | (not (string= indicator-string " "))) |
| 2978 | (insert speedbar-indicator-separator)) |
| 2979 | (speedbar-with-writable |
| 2980 | (save-excursion |
| 2981 | (if (and replace-this |
| 2982 | (re-search-forward replace-this (save-excursion (end-of-line) |
| 2983 | (point)) |
| 2984 | t)) |
| 2985 | (delete-region (match-beginning 0) (match-end 0)))) |
| 2986 | (end-of-line) |
| 2987 | (if (not (string= " " indicator-string)) |
| 2988 | (insert indicator-string)))) |
| 2989 | |
| 2990 | ;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings. |
| 2991 | ;; Steven L Baur <steve@xemacs.org> said this was important: |
| 2992 | (eval-when-compile (or (featurep 'xemacs) |
| 2993 | (condition-case () (require 'efs) |
| 2994 | (error (require 'ange-ftp))))) |
| 2995 | |
| 2996 | (defun speedbar-check-vc () |
| 2997 | "Scan all files in a directory, and for each see if it's checked out. |
| 2998 | See `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p' for how |
| 2999 | to add more types of version control systems." |
| 3000 | ;; Check for to-do to be reset. If reset but no RCS is available |
| 3001 | ;; then set to nil (do nothing) otherwise, start at the beginning |
| 3002 | (save-excursion |
| 3003 | (set-buffer speedbar-buffer) |
| 3004 | (if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t) |
| 3005 | (speedbar-vc-check-dir-p default-directory) |
| 3006 | (not (or (and (featurep 'ange-ftp) |
| 3007 | (string-match |
| 3008 | (car (if speedbar-xemacsp |
| 3009 | ange-ftp-path-format |
| 3010 | ange-ftp-name-format)) |
| 3011 | (expand-file-name default-directory))) |
| 3012 | ;; efs support: Bob Weiner |
| 3013 | (and (featurep 'efs) |
| 3014 | (string-match |
| 3015 | (car efs-path-regexp) |
| 3016 | (expand-file-name default-directory)))))) |
| 3017 | (setq speedbar-vc-to-do-point 0)) |
| 3018 | (if (numberp speedbar-vc-to-do-point) |
| 3019 | (progn |
| 3020 | (goto-char speedbar-vc-to-do-point) |
| 3021 | (while (and (not (input-pending-p)) |
| 3022 | (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] " |
| 3023 | nil t)) |
| 3024 | (setq speedbar-vc-to-do-point (point)) |
| 3025 | (if (speedbar-check-vc-this-line (match-string 1)) |
| 3026 | (speedbar-add-indicator speedbar-vc-indicator |
| 3027 | (regexp-quote speedbar-vc-indicator)) |
| 3028 | (speedbar-add-indicator " " |
| 3029 | (regexp-quote speedbar-vc-indicator)))) |
| 3030 | (if (input-pending-p) |
| 3031 | ;; return that we are incomplete |
| 3032 | nil |
| 3033 | ;; we are done, set to-do to nil |
| 3034 | (setq speedbar-vc-to-do-point nil) |
| 3035 | ;; and return t |
| 3036 | t)) |
| 3037 | t))) |
| 3038 | |
| 3039 | (defun speedbar-check-vc-this-line (depth) |
| 3040 | "Return t if the file on this line is check of of a version control system. |
| 3041 | Parameter DEPTH is a string with the current depth of indentation of |
| 3042 | the file being checked." |
| 3043 | (let* ((d (string-to-int depth)) |
| 3044 | (f (speedbar-line-path d)) |
| 3045 | (fn (buffer-substring-no-properties |
| 3046 | ;; Skip-chars: thanks ptype@dra.hmg.gb |
| 3047 | (point) (progn |
| 3048 | (skip-chars-forward "^ " |
| 3049 | (save-excursion (end-of-line) |
| 3050 | (point))) |
| 3051 | (point)))) |
| 3052 | (fulln (concat f fn))) |
| 3053 | (if (<= 2 speedbar-verbosity-level) |
| 3054 | (speedbar-message "Speedbar vc check...%s" fulln)) |
| 3055 | (and (file-writable-p fulln) |
| 3056 | (speedbar-this-file-in-vc f fn)))) |
| 3057 | |
| 3058 | (defun speedbar-vc-check-dir-p (path) |
| 3059 | "Return t if we should bother checking PATH for version control files. |
| 3060 | This can be overloaded to add new types of version control systems." |
| 3061 | (or |
| 3062 | ;; Local RCS |
| 3063 | (file-exists-p (concat path "RCS/")) |
| 3064 | ;; Local SCCS |
| 3065 | (file-exists-p (concat path "SCCS/")) |
| 3066 | ;; Remote SCCS project |
| 3067 | (let ((proj-dir (getenv "PROJECTDIR"))) |
| 3068 | (if proj-dir |
| 3069 | (file-exists-p (concat proj-dir "/SCCS")) |
| 3070 | nil)) |
| 3071 | ;; User extension |
| 3072 | (run-hook-with-args 'speedbar-vc-path-enable-hook path) |
| 3073 | )) |
| 3074 | |
| 3075 | (defun speedbar-this-file-in-vc (path name) |
| 3076 | "Check to see if the file in PATH with NAME is in a version control system. |
| 3077 | You can add new VC systems by overriding this function. You can |
| 3078 | optimize this function by overriding it and only doing those checks |
| 3079 | that will occur on your system." |
| 3080 | (or |
| 3081 | ;; RCS file name |
| 3082 | (file-exists-p (concat path "RCS/" name ",v")) |
| 3083 | (file-exists-p (concat path "RCS/" name)) |
| 3084 | ;; Local SCCS file name |
| 3085 | (file-exists-p (concat path "SCCS/s." name)) |
| 3086 | ;; Remote SCCS file name |
| 3087 | (let ((proj-dir (getenv "PROJECTDIR"))) |
| 3088 | (if proj-dir |
| 3089 | (file-exists-p (concat proj-dir "/SCCS/s." name)) |
| 3090 | nil)) |
| 3091 | ;; User extension |
| 3092 | (run-hook-with-args 'speedbar-vc-in-control-hook path name) |
| 3093 | )) |
| 3094 | |
| 3095 | ;; Objet File scanning |
| 3096 | (defun speedbar-check-objects () |
| 3097 | "Scan all files in a directory, and for each see if there is an object. |
| 3098 | See `speedbar-check-obj-this-line' and `speedbar-obj-alist' for how |
| 3099 | to add more object types." |
| 3100 | ;; Check for to-do to be reset. If reset but no RCS is available |
| 3101 | ;; then set to nil (do nothing) otherwise, start at the beginning |
| 3102 | (save-excursion |
| 3103 | (set-buffer speedbar-buffer) |
| 3104 | (if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t)) |
| 3105 | (setq speedbar-obj-to-do-point 0)) |
| 3106 | (if (numberp speedbar-obj-to-do-point) |
| 3107 | (progn |
| 3108 | (goto-char speedbar-obj-to-do-point) |
| 3109 | (while (and (not (input-pending-p)) |
| 3110 | (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] " |
| 3111 | nil t)) |
| 3112 | (setq speedbar-obj-to-do-point (point)) |
| 3113 | (let ((ind (speedbar-check-obj-this-line (match-string 1)))) |
| 3114 | (if (not ind) (setq ind " ")) |
| 3115 | (speedbar-add-indicator ind (concat |
| 3116 | (car speedbar-obj-indicator) |
| 3117 | "\\|" |
| 3118 | (cdr speedbar-obj-indicator))))) |
| 3119 | (if (input-pending-p) |
| 3120 | ;; return that we are incomplete |
| 3121 | nil |
| 3122 | ;; we are done, set to-do to nil |
| 3123 | (setq speedbar-obj-to-do-point nil) |
| 3124 | ;; and return t |
| 3125 | t)) |
| 3126 | t))) |
| 3127 | |
| 3128 | (defun speedbar-check-obj-this-line (depth) |
| 3129 | "Return t if the file on this line has an associated object. |
| 3130 | Parameter DEPTH is a string with the current depth of indentation of |
| 3131 | the file being checked." |
| 3132 | (let* ((d (string-to-int depth)) |
| 3133 | (f (speedbar-line-path d)) |
| 3134 | (fn (buffer-substring-no-properties |
| 3135 | ;; Skip-chars: thanks ptype@dra.hmg.gb |
| 3136 | (point) (progn |
| 3137 | (skip-chars-forward "^ " |
| 3138 | (save-excursion (end-of-line) |
| 3139 | (point))) |
| 3140 | (point)))) |
| 3141 | (fulln (concat f fn))) |
| 3142 | (if (<= 2 speedbar-verbosity-level) |
| 3143 | (speedbar-message "Speedbar obj check...%s" fulln)) |
| 3144 | (let ((oa speedbar-obj-alist)) |
| 3145 | (while (and oa (not (string-match (car (car oa)) fulln))) |
| 3146 | (setq oa (cdr oa))) |
| 3147 | (if (not (and oa (file-exists-p (concat (file-name-sans-extension fulln) |
| 3148 | (cdr (car oa)))))) |
| 3149 | nil |
| 3150 | ;; Find out if the object is out of date or not. |
| 3151 | (let ((date1 (nth 5 (file-attributes fulln))) |
| 3152 | (date2 (nth 5 (file-attributes (concat |
| 3153 | (file-name-sans-extension fulln) |
| 3154 | (cdr (car oa))))))) |
| 3155 | (if (or (< (car date1) (car date2)) |
| 3156 | (and (= (car date1) (car date2)) |
| 3157 | (< (nth 1 date1) (nth 1 date2)))) |
| 3158 | (car speedbar-obj-indicator) |
| 3159 | (cdr speedbar-obj-indicator))))))) |
| 3160 | \f |
| 3161 | ;;; Clicking Activity |
| 3162 | ;; |
| 3163 | (defun speedbar-mouse-set-point (e) |
| 3164 | "Set POINT based on event E. |
| 3165 | Handle clicking on images in XEmacs." |
| 3166 | (if (and (fboundp 'event-over-glyph-p) (event-over-glyph-p e)) |
| 3167 | ;; We are in XEmacs, and clicked on a picture |
| 3168 | (let ((ext (event-glyph-extent e))) |
| 3169 | ;; This position is back inside the extent where the |
| 3170 | ;; junk we pushed into the property list lives. |
| 3171 | (if (extent-end-position ext) |
| 3172 | (goto-char (1- (extent-end-position ext))) |
| 3173 | (mouse-set-point e))) |
| 3174 | ;; We are not in XEmacs, OR we didn't click on a picture. |
| 3175 | (mouse-set-point e))) |
| 3176 | |
| 3177 | (defun speedbar-quick-mouse (e) |
| 3178 | "Since mouse events are strange, this will keep the mouse nicely positioned. |
| 3179 | This should be bound to mouse event E." |
| 3180 | (interactive "e") |
| 3181 | (speedbar-mouse-set-point e) |
| 3182 | (speedbar-position-cursor-on-line) |
| 3183 | ) |
| 3184 | |
| 3185 | (defun speedbar-position-cursor-on-line () |
| 3186 | "Position the cursor on a line." |
| 3187 | (let ((oldpos (point))) |
| 3188 | (beginning-of-line) |
| 3189 | (if (looking-at "[0-9]+:\\s-*..?.? ") |
| 3190 | (goto-char (1- (match-end 0))) |
| 3191 | (goto-char oldpos)))) |
| 3192 | |
| 3193 | (defun speedbar-power-click (e) |
| 3194 | "Activate any speedbar button as a power click. |
| 3195 | A power click will dispose of cached data (if available) or bring a buffer |
| 3196 | up into a different window. |
| 3197 | This should be bound to mouse event E." |
| 3198 | (interactive "e") |
| 3199 | (let ((speedbar-power-click t)) |
| 3200 | (speedbar-click e))) |
| 3201 | |
| 3202 | (defun speedbar-click (e) |
| 3203 | "Activate any speedbar buttons where the mouse is clicked. |
| 3204 | This must be bound to a mouse event. A button is any location of text |
| 3205 | with a mouse face that has a text property called `speedbar-function'. |
| 3206 | This should be bound to mouse event E." |
| 3207 | (interactive "e") |
| 3208 | (speedbar-mouse-set-point e) |
| 3209 | (speedbar-do-function-pointer) |
| 3210 | (speedbar-quick-mouse e)) |
| 3211 | |
| 3212 | (defun speedbar-double-click (e) |
| 3213 | "Activate any speedbar buttons where the mouse is clicked. |
| 3214 | This must be bound to a mouse event. A button is any location of text |
| 3215 | with a mouse face that has a text property called `speedbar-function'. |
| 3216 | This should be bound to mouse event E." |
| 3217 | (interactive "e") |
| 3218 | ;; Emacs only. XEmacs handles this via `mouse-track-click-hook'. |
| 3219 | (cond ((eq (car e) 'down-mouse-1) |
| 3220 | (speedbar-mouse-set-point e)) |
| 3221 | ((eq (car e) 'mouse-1) |
| 3222 | (speedbar-quick-mouse e)) |
| 3223 | ((or (eq (car e) 'double-down-mouse-1) |
| 3224 | (eq (car e) 'triple-down-mouse-1)) |
| 3225 | (speedbar-mouse-set-point e) |
| 3226 | (speedbar-do-function-pointer) |
| 3227 | (speedbar-quick-mouse e)))) |
| 3228 | |
| 3229 | (defun speedbar-do-function-pointer () |
| 3230 | "Look under the cursor and examine the text properties. |
| 3231 | From this extract the file/tag name, token, indentation level and call |
| 3232 | a function if appropriate" |
| 3233 | (let* ((fn (get-text-property (point) 'speedbar-function)) |
| 3234 | (tok (get-text-property (point) 'speedbar-token)) |
| 3235 | ;; The 1-,+ is safe because scaning starts AFTER the point |
| 3236 | ;; specified. This lets the search include the character the |
| 3237 | ;; cursor is on. |
| 3238 | (tp (previous-single-property-change |
| 3239 | (1+ (point)) 'speedbar-function)) |
| 3240 | (np (next-single-property-change |
| 3241 | (point) 'speedbar-function)) |
| 3242 | (txt (buffer-substring-no-properties (or tp (point-min)) |
| 3243 | (or np (point-max)))) |
| 3244 | (dent (save-excursion (beginning-of-line) |
| 3245 | (string-to-number |
| 3246 | (if (looking-at "[0-9]+") |
| 3247 | (buffer-substring-no-properties |
| 3248 | (match-beginning 0) (match-end 0)) |
| 3249 | "0"))))) |
| 3250 | ;;(speedbar-message "%S:%S:%S:%s" fn tok txt dent) |
| 3251 | (and fn (funcall fn txt tok dent))) |
| 3252 | (speedbar-position-cursor-on-line)) |
| 3253 | \f |
| 3254 | ;;; Reading info from the speedbar buffer |
| 3255 | ;; |
| 3256 | (defun speedbar-line-text (&optional p) |
| 3257 | "Retrieve the text after prefix junk for the current line. |
| 3258 | Optional argument P is where to start the search from." |
| 3259 | (save-excursion |
| 3260 | (if p (goto-char p)) |
| 3261 | (beginning-of-line) |
| 3262 | (if (looking-at (concat |
| 3263 | "\\([0-9]+\\): *[[<{][-+?][]>}] \\([^ \n]+\\)\\(" |
| 3264 | speedbar-indicator-regex "\\)?")) |
| 3265 | (match-string 2) |
| 3266 | nil))) |
| 3267 | |
| 3268 | (defun speedbar-line-token (&optional p) |
| 3269 | "Retrieve the token information after the prefix junk for the current line. |
| 3270 | Optional argument P is where to start the search from." |
| 3271 | (save-excursion |
| 3272 | (if p (goto-char p)) |
| 3273 | (beginning-of-line) |
| 3274 | (if (looking-at (concat |
| 3275 | "\\([0-9]+\\): *[[<{]?[-+?=][]>}@()|] \\([^ \n]+\\)\\(" |
| 3276 | speedbar-indicator-regex "\\)?")) |
| 3277 | (progn |
| 3278 | (goto-char (match-beginning 2)) |
| 3279 | (get-text-property (point) 'speedbar-token)) |
| 3280 | nil))) |
| 3281 | |
| 3282 | (defun speedbar-line-file (&optional p) |
| 3283 | "Retrieve the file or whatever from the line at P point. |
| 3284 | The return value is a string representing the file. If it is a |
| 3285 | directory, then it is the directory name." |
| 3286 | (save-match-data |
| 3287 | (let ((f (speedbar-line-text p))) |
| 3288 | (if f |
| 3289 | (let* ((depth (string-to-int (match-string 1))) |
| 3290 | (path (speedbar-line-path depth))) |
| 3291 | (concat path f)) |
| 3292 | nil)))) |
| 3293 | |
| 3294 | (defun speedbar-goto-this-file (file) |
| 3295 | "If FILE is displayed, goto this line and return t. |
| 3296 | Otherwise do not move and return nil." |
| 3297 | (let ((path (substring (file-name-directory (expand-file-name file)) |
| 3298 | (length (expand-file-name default-directory)))) |
| 3299 | (dest (point))) |
| 3300 | (save-match-data |
| 3301 | (goto-char (point-min)) |
| 3302 | ;; scan all the directories |
| 3303 | (while (and path (not (eq path t))) |
| 3304 | (if (string-match "^[/\\]?\\([^/\\]+\\)" path) |
| 3305 | (let ((pp (match-string 1 path))) |
| 3306 | (if (save-match-data |
| 3307 | (re-search-forward (concat "> " (regexp-quote pp) "$") |
| 3308 | nil t)) |
| 3309 | (setq path (substring path (match-end 1))) |
| 3310 | (setq path nil))) |
| 3311 | (setq path t))) |
| 3312 | ;; find the file part |
| 3313 | (if (or (not path) (string= (file-name-nondirectory file) "")) |
| 3314 | ;; only had a dir part |
| 3315 | (if path |
| 3316 | (progn |
| 3317 | (speedbar-position-cursor-on-line) |
| 3318 | t) |
| 3319 | (goto-char dest) nil) |
| 3320 | ;; find the file part |
| 3321 | (let ((nd (file-name-nondirectory file))) |
| 3322 | (if (re-search-forward |
| 3323 | (concat "] \\(" (regexp-quote nd) |
| 3324 | "\\)\\(" speedbar-indicator-regex "\\)$") |
| 3325 | nil t) |
| 3326 | (progn |
| 3327 | (speedbar-position-cursor-on-line) |
| 3328 | t) |
| 3329 | (goto-char dest) |
| 3330 | nil)))))) |
| 3331 | |
| 3332 | (defun speedbar-line-path (&optional depth) |
| 3333 | "Retrieve the pathname associated with the current line. |
| 3334 | This may require traversing backwards from DEPTH and combining the default |
| 3335 | directory with these items. This function is replaceable in |
| 3336 | `speedbar-mode-functions-list' as `speedbar-line-path'" |
| 3337 | (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-path))) |
| 3338 | (if rf (funcall rf depth) default-directory))) |
| 3339 | |
| 3340 | (defun speedbar-files-line-path (&optional depth) |
| 3341 | "Retrieve the pathname associated with the current line. |
| 3342 | This may require traversing backwards from DEPTH and combining the default |
| 3343 | directory with these items." |
| 3344 | (save-excursion |
| 3345 | (save-match-data |
| 3346 | (if (not depth) |
| 3347 | (progn |
| 3348 | (beginning-of-line) |
| 3349 | (looking-at "^\\([0-9]+\\):") |
| 3350 | (setq depth (string-to-int (match-string 1))))) |
| 3351 | (let ((path nil)) |
| 3352 | (setq depth (1- depth)) |
| 3353 | (while (/= depth -1) |
| 3354 | (if (not (re-search-backward (format "^%d:" depth) nil t)) |
| 3355 | (error "Error building path of tag") |
| 3356 | (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)$") |
| 3357 | (setq path (concat (buffer-substring-no-properties |
| 3358 | (match-beginning 1) (match-end 1)) |
| 3359 | "/" |
| 3360 | path))) |
| 3361 | ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)$") |
| 3362 | ;; This is the start of our path. |
| 3363 | (setq path (buffer-substring-no-properties |
| 3364 | (match-beginning 1) (match-end 1)))))) |
| 3365 | (setq depth (1- depth))) |
| 3366 | (if (and path |
| 3367 | (string-match (concat speedbar-indicator-regex "$") |
| 3368 | path)) |
| 3369 | (setq path (substring path 0 (match-beginning 0)))) |
| 3370 | (concat default-directory path))))) |
| 3371 | |
| 3372 | (defun speedbar-path-line (path) |
| 3373 | "Position the cursor on the line specified by PATH." |
| 3374 | (save-match-data |
| 3375 | (if (string-match "[/\\]$" path) |
| 3376 | (setq path (substring path 0 (match-beginning 0)))) |
| 3377 | (let ((nomatch t) (depth 0) |
| 3378 | (fname (file-name-nondirectory path)) |
| 3379 | (pname (file-name-directory path))) |
| 3380 | (if (not (member pname speedbar-shown-directories)) |
| 3381 | (error "Internal Error: File %s not shown in speedbar" path)) |
| 3382 | (goto-char (point-min)) |
| 3383 | (while (and nomatch |
| 3384 | (re-search-forward |
| 3385 | (concat "[]>] \\(" (regexp-quote fname) |
| 3386 | "\\)\\(" speedbar-indicator-regex "\\)?$") |
| 3387 | nil t)) |
| 3388 | (beginning-of-line) |
| 3389 | (looking-at "\\([0-9]+\\):") |
| 3390 | (setq depth (string-to-int (match-string 0)) |
| 3391 | nomatch (not (string= pname (speedbar-line-path depth)))) |
| 3392 | (end-of-line)) |
| 3393 | (beginning-of-line) |
| 3394 | (not nomatch)))) |
| 3395 | |
| 3396 | (defun speedbar-edit-line () |
| 3397 | "Edit whatever tag or file is on the current speedbar line." |
| 3398 | (interactive) |
| 3399 | (or (save-excursion |
| 3400 | (beginning-of-line) |
| 3401 | ;; If this fails, then it is a non-standard click, and as such, |
| 3402 | ;; perfectly allowed. |
| 3403 | (if (re-search-forward "[]>?}] [^ ]" |
| 3404 | (save-excursion (end-of-line) (point)) |
| 3405 | t) |
| 3406 | (speedbar-do-function-pointer) |
| 3407 | nil)) |
| 3408 | (speedbar-do-function-pointer))) |
| 3409 | |
| 3410 | (defun speedbar-expand-line (&optional arg) |
| 3411 | "Expand the line under the cursor. |
| 3412 | With universal argument ARG, flush cached data." |
| 3413 | (interactive "P") |
| 3414 | (beginning-of-line) |
| 3415 | (let ((speedbar-power-click arg)) |
| 3416 | (condition-case nil |
| 3417 | (progn |
| 3418 | (re-search-forward ":\\s-*.\\+. " |
| 3419 | (save-excursion (end-of-line) (point))) |
| 3420 | (forward-char -2) |
| 3421 | (speedbar-do-function-pointer)) |
| 3422 | (error (speedbar-position-cursor-on-line))))) |
| 3423 | |
| 3424 | (defun speedbar-flush-expand-line () |
| 3425 | "Expand the line under the cursor and flush any cached information." |
| 3426 | (interactive) |
| 3427 | (speedbar-expand-line 1)) |
| 3428 | |
| 3429 | (defun speedbar-contract-line () |
| 3430 | "Contract the line under the cursor." |
| 3431 | (interactive) |
| 3432 | (beginning-of-line) |
| 3433 | (condition-case nil |
| 3434 | (progn |
| 3435 | (re-search-forward ":\\s-*.-. " |
| 3436 | (save-excursion (end-of-line) (point))) |
| 3437 | (forward-char -2) |
| 3438 | (speedbar-do-function-pointer)) |
| 3439 | (error (speedbar-position-cursor-on-line)))) |
| 3440 | |
| 3441 | (if speedbar-xemacsp |
| 3442 | (defalias 'speedbar-mouse-event-p 'button-press-event-p) |
| 3443 | (defun speedbar-mouse-event-p (event) |
| 3444 | "Return t if the event is a mouse related event" |
| 3445 | ;; And Emacs does it this way |
| 3446 | (if (and (listp event) |
| 3447 | (member (event-basic-type event) |
| 3448 | '(mouse-1 mouse-2 mouse-3))) |
| 3449 | t |
| 3450 | nil))) |
| 3451 | |
| 3452 | (defun speedbar-maybee-jump-to-attached-frame () |
| 3453 | "Jump to the attached frame ONLY if this was not a mouse event." |
| 3454 | (if (or (not (speedbar-mouse-event-p last-input-event)) |
| 3455 | speedbar-activity-change-focus-flag) |
| 3456 | (progn |
| 3457 | (select-frame speedbar-attached-frame) |
| 3458 | (other-frame 0)))) |
| 3459 | |
| 3460 | (defun speedbar-find-file (text token indent) |
| 3461 | "Speedbar click handler for filenames. |
| 3462 | TEXT, the file will be displayed in the attached frame. |
| 3463 | TOKEN is unused, but required by the click handler. INDENT is the |
| 3464 | current indentation level." |
| 3465 | (let ((cdd (speedbar-line-path indent))) |
| 3466 | (speedbar-find-file-in-frame (concat cdd text)) |
| 3467 | (speedbar-stealthy-updates) |
| 3468 | (run-hooks 'speedbar-visiting-file-hook) |
| 3469 | ;; Reset the timer with a new timeout when cliking a file |
| 3470 | ;; in case the user was navigating directories, we can cancel |
| 3471 | ;; that other timer. |
| 3472 | (speedbar-set-timer speedbar-update-speed)) |
| 3473 | (speedbar-maybee-jump-to-attached-frame)) |
| 3474 | |
| 3475 | (defun speedbar-dir-follow (text token indent) |
| 3476 | "Speedbar click handler for directory names. |
| 3477 | Clicking a directory will cause the speedbar to list files in the |
| 3478 | the subdirectory TEXT. TOKEN is an unused requirement. The |
| 3479 | subdirectory chosen will be at INDENT level." |
| 3480 | (setq default-directory |
| 3481 | (concat (expand-file-name (concat (speedbar-line-path indent) text)) |
| 3482 | "/")) |
| 3483 | ;; Because we leave speedbar as the current buffer, |
| 3484 | ;; update contents will change directory without |
| 3485 | ;; having to touch the attached frame. Turn off smart expand just |
| 3486 | ;; in case. |
| 3487 | (let ((speedbar-smart-directory-expand-flag nil)) |
| 3488 | (speedbar-update-contents)) |
| 3489 | (speedbar-set-timer speedbar-navigating-speed) |
| 3490 | (setq speedbar-last-selected-file nil) |
| 3491 | (speedbar-stealthy-updates)) |
| 3492 | |
| 3493 | (defun speedbar-delete-subblock (indent) |
| 3494 | "Delete text from point to indentation level INDENT or greater. |
| 3495 | Handles end-of-sublist smartly." |
| 3496 | (speedbar-with-writable |
| 3497 | (save-excursion |
| 3498 | (end-of-line) (forward-char 1) |
| 3499 | (let ((start (point))) |
| 3500 | (while (and (looking-at "^\\([0-9]+\\):") |
| 3501 | (> (string-to-int (match-string 1)) indent) |
| 3502 | (not (eobp))) |
| 3503 | (forward-line 1) |
| 3504 | (beginning-of-line)) |
| 3505 | (delete-region start (point)))))) |
| 3506 | |
| 3507 | (defun speedbar-dired (text token indent) |
| 3508 | "Speedbar click handler for directory expand button. |
| 3509 | Clicking this button expands or contracts a directory. TEXT is the |
| 3510 | button clicked which has either a + or -. TOKEN is the directory to be |
| 3511 | expanded. INDENT is the current indentation level." |
| 3512 | (cond ((string-match "+" text) ;we have to expand this dir |
| 3513 | (setq speedbar-shown-directories |
| 3514 | (cons (expand-file-name |
| 3515 | (concat (speedbar-line-path indent) token "/")) |
| 3516 | speedbar-shown-directories)) |
| 3517 | (speedbar-change-expand-button-char ?-) |
| 3518 | (speedbar-reset-scanners) |
| 3519 | (save-excursion |
| 3520 | (end-of-line) (forward-char 1) |
| 3521 | (speedbar-with-writable |
| 3522 | (speedbar-default-directory-list |
| 3523 | (concat (speedbar-line-path indent) token "/") |
| 3524 | (1+ indent))))) |
| 3525 | ((string-match "-" text) ;we have to contract this node |
| 3526 | (speedbar-reset-scanners) |
| 3527 | (let ((oldl speedbar-shown-directories) |
| 3528 | (newl nil) |
| 3529 | (td (expand-file-name |
| 3530 | (concat (speedbar-line-path indent) token)))) |
| 3531 | (while oldl |
| 3532 | (if (not (string-match (concat "^" (regexp-quote td)) (car oldl))) |
| 3533 | (setq newl (cons (car oldl) newl))) |
| 3534 | (setq oldl (cdr oldl))) |
| 3535 | (setq speedbar-shown-directories (nreverse newl))) |
| 3536 | (speedbar-change-expand-button-char ?+) |
| 3537 | (speedbar-delete-subblock indent) |
| 3538 | ) |
| 3539 | (t (error "Ooops... not sure what to do"))) |
| 3540 | (speedbar-center-buffer-smartly) |
| 3541 | (setq speedbar-last-selected-file nil) |
| 3542 | (save-excursion (speedbar-stealthy-updates))) |
| 3543 | |
| 3544 | (defun speedbar-directory-buttons-follow (text token indent) |
| 3545 | "Speedbar click handler for default directory buttons. |
| 3546 | TEXT is the button clicked on. TOKEN is the directory to follow. |
| 3547 | INDENT is the current indentation level and is unused." |
| 3548 | (if (string-match "^[A-z]:$" token) |
| 3549 | (setq default-directory (concat token (char-to-string directory-sep-char))) |
| 3550 | (setq default-directory token)) |
| 3551 | ;; Because we leave speedbar as the current buffer, |
| 3552 | ;; update contents will change directory without |
| 3553 | ;; having to touch the attached frame. |
| 3554 | (speedbar-update-contents) |
| 3555 | (speedbar-set-timer speedbar-navigating-speed)) |
| 3556 | |
| 3557 | (defun speedbar-tag-file (text token indent) |
| 3558 | "The cursor is on a selected line. Expand the tags in the specified file. |
| 3559 | The parameter TEXT and TOKEN are required, where TEXT is the button |
| 3560 | clicked, and TOKEN is the file to expand. INDENT is the current |
| 3561 | indentation level." |
| 3562 | (cond ((string-match "+" text) ;we have to expand this file |
| 3563 | (let* ((fn (expand-file-name (concat (speedbar-line-path indent) |
| 3564 | token))) |
| 3565 | (mode nil) |
| 3566 | (lst (speedbar-fetch-dynamic-tags fn))) |
| 3567 | ;; if no list, then remove expando button |
| 3568 | (if (not lst) |
| 3569 | (speedbar-change-expand-button-char ??) |
| 3570 | (speedbar-change-expand-button-char ?-) |
| 3571 | (speedbar-with-writable |
| 3572 | (save-excursion |
| 3573 | (end-of-line) (forward-char 1) |
| 3574 | (funcall (car lst) indent (cdr lst))))))) |
| 3575 | ((string-match "-" text) ;we have to contract this node |
| 3576 | (speedbar-change-expand-button-char ?+) |
| 3577 | (speedbar-delete-subblock indent)) |
| 3578 | (t (error "Ooops... not sure what to do"))) |
| 3579 | (speedbar-center-buffer-smartly)) |
| 3580 | |
| 3581 | (defun speedbar-tag-find (text token indent) |
| 3582 | "For the tag TEXT in a file TOKEN, goto that position. |
| 3583 | INDENT is the current indentation level." |
| 3584 | (let ((file (speedbar-line-path indent))) |
| 3585 | (speedbar-find-file-in-frame file) |
| 3586 | (save-excursion (speedbar-stealthy-updates)) |
| 3587 | ;; Reset the timer with a new timeout when cliking a file |
| 3588 | ;; in case the user was navigating directories, we can cancel |
| 3589 | ;; that other timer. |
| 3590 | (speedbar-set-timer speedbar-update-speed) |
| 3591 | (goto-char token) |
| 3592 | (run-hooks 'speedbar-visiting-tag-hook) |
| 3593 | ;;(recenter) |
| 3594 | (speedbar-maybee-jump-to-attached-frame) |
| 3595 | )) |
| 3596 | |
| 3597 | (defun speedbar-tag-expand (text token indent) |
| 3598 | "Expand a tag sublist. Imenu will return sub-lists of specialized tag types. |
| 3599 | Etags does not support this feature. TEXT will be the button |
| 3600 | string. TOKEN will be the list, and INDENT is the current indentation |
| 3601 | level." |
| 3602 | (cond ((string-match "+" text) ;we have to expand this file |
| 3603 | (speedbar-change-expand-button-char ?-) |
| 3604 | (speedbar-with-writable |
| 3605 | (save-excursion |
| 3606 | (end-of-line) (forward-char 1) |
| 3607 | (speedbar-insert-generic-list indent token 'speedbar-tag-expand |
| 3608 | 'speedbar-tag-find)))) |
| 3609 | ((string-match "-" text) ;we have to contract this node |
| 3610 | (speedbar-change-expand-button-char ?+) |
| 3611 | (speedbar-delete-subblock indent)) |
| 3612 | (t (error "Ooops... not sure what to do"))) |
| 3613 | (speedbar-center-buffer-smartly)) |
| 3614 | \f |
| 3615 | ;;; Loading files into the attached frame. |
| 3616 | ;; |
| 3617 | (defun speedbar-find-file-in-frame (file) |
| 3618 | "This will load FILE into the speedbar attached frame. |
| 3619 | If the file is being displayed in a different frame already, then raise that |
| 3620 | frame instead." |
| 3621 | (let* ((buff (find-file-noselect file)) |
| 3622 | (bwin (get-buffer-window buff 0))) |
| 3623 | (if bwin |
| 3624 | (progn |
| 3625 | (select-window bwin) |
| 3626 | (raise-frame (window-frame bwin))) |
| 3627 | (if speedbar-power-click |
| 3628 | (let ((pop-up-frames t)) (select-window (display-buffer buff))) |
| 3629 | (select-frame speedbar-attached-frame) |
| 3630 | (switch-to-buffer buff)))) |
| 3631 | ) |
| 3632 | |
| 3633 | ;;; Centering Utility |
| 3634 | ;; |
| 3635 | (defun speedbar-center-buffer-smartly () |
| 3636 | "Recenter a speedbar buffer so the current indentation level is all visible. |
| 3637 | This assumes that the cursor is on a file, or tag of a file which the user is |
| 3638 | interested in." |
| 3639 | (if (<= (count-lines (point-min) (point-max)) |
| 3640 | (1- (window-height (selected-window)))) |
| 3641 | ;; whole buffer fits |
| 3642 | (let ((cp (point))) |
| 3643 | (goto-char (point-min)) |
| 3644 | (recenter 0) |
| 3645 | (goto-char cp)) |
| 3646 | ;; too big |
| 3647 | (let (depth start end exp p) |
| 3648 | (save-excursion |
| 3649 | (beginning-of-line) |
| 3650 | (setq depth (if (looking-at "[0-9]+") |
| 3651 | (string-to-int (buffer-substring-no-properties |
| 3652 | (match-beginning 0) (match-end 0))) |
| 3653 | 0)) |
| 3654 | (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth))) |
| 3655 | (save-excursion |
| 3656 | (end-of-line) |
| 3657 | (if (re-search-backward exp nil t) |
| 3658 | (setq start (point)) |
| 3659 | (setq start (point-min))) |
| 3660 | (save-excursion ;Not sure about this part. |
| 3661 | (end-of-line) |
| 3662 | (setq p (point)) |
| 3663 | (while (and (not (re-search-forward exp nil t)) |
| 3664 | (>= depth 0)) |
| 3665 | (setq depth (1- depth)) |
| 3666 | (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth))) |
| 3667 | (if (/= (point) p) |
| 3668 | (setq end (point)) |
| 3669 | (setq end (point-max))))) |
| 3670 | ;; Now work out the details of centering |
| 3671 | (let ((nl (count-lines start end)) |
| 3672 | (cp (point))) |
| 3673 | (if (> nl (window-height (selected-window))) |
| 3674 | ;; We can't fit it all, so just center on cursor |
| 3675 | (progn (goto-char start) |
| 3676 | (recenter 1)) |
| 3677 | ;; we can fit everything on the screen, but... |
| 3678 | (if (and (pos-visible-in-window-p start (selected-window)) |
| 3679 | (pos-visible-in-window-p end (selected-window))) |
| 3680 | ;; we are all set! |
| 3681 | nil |
| 3682 | ;; we need to do something... |
| 3683 | (goto-char start) |
| 3684 | (let ((newcent (/ (- (window-height (selected-window)) nl) 2)) |
| 3685 | (lte (count-lines start (point-max)))) |
| 3686 | (if (and (< (+ newcent lte) (window-height (selected-window))) |
| 3687 | (> (- (window-height (selected-window)) lte 1) |
| 3688 | newcent)) |
| 3689 | (setq newcent (- (window-height (selected-window)) |
| 3690 | lte 1))) |
| 3691 | (recenter newcent)))) |
| 3692 | (goto-char cp))))) |
| 3693 | |
| 3694 | \f |
| 3695 | ;;; Tag Management -- List of expanders: |
| 3696 | ;; |
| 3697 | (defun speedbar-fetch-dynamic-tags (file) |
| 3698 | "Return a list of tags generated dynamically from FILE. |
| 3699 | This uses the entries in `speedbar-dynamic-tags-function-list' |
| 3700 | to find the proper tags. It is up to each of those individual |
| 3701 | functions to do caching and flushing if appropriate." |
| 3702 | (save-excursion |
| 3703 | (set-buffer (find-file-noselect file)) |
| 3704 | ;; If there is a buffer-local value of |
| 3705 | ;; speedbar-dynamic-tags-function-list, it will now be available. |
| 3706 | (let ((dtf speedbar-dynamic-tags-function-list) |
| 3707 | (ret t)) |
| 3708 | (while (and (eq ret t) dtf) |
| 3709 | (setq ret |
| 3710 | (if (fboundp (car (car dtf))) |
| 3711 | (funcall (car (car dtf)) (buffer-file-name)) |
| 3712 | t)) |
| 3713 | (if (eq ret t) |
| 3714 | (setq dtf (cdr dtf)))) |
| 3715 | (if (eq ret t) |
| 3716 | ;; No valid tag list, return nil |
| 3717 | nil |
| 3718 | ;; We have some tags. Return the list with the insert fn |
| 3719 | ;; prepended |
| 3720 | (cons (cdr (car dtf)) ret))))) |
| 3721 | |
| 3722 | ;;; Tag Management -- Imenu |
| 3723 | ;; |
| 3724 | (if (not speedbar-use-imenu-flag) |
| 3725 | |
| 3726 | nil |
| 3727 | |
| 3728 | (eval-when-compile (if (locate-library "imenu") (require 'imenu))) |
| 3729 | |
| 3730 | (defun speedbar-fetch-dynamic-imenu (file) |
| 3731 | "Load FILE into a buffer, and generate tags using Imenu. |
| 3732 | Returns the tag list, or t for an error." |
| 3733 | ;; Load this AND compile it in |
| 3734 | (require 'imenu) |
| 3735 | (if speedbar-power-click (setq imenu--index-alist nil)) |
| 3736 | (condition-case nil |
| 3737 | (let ((index-alist (imenu--make-index-alist t))) |
| 3738 | (if speedbar-sort-tags |
| 3739 | (sort (copy-alist index-alist) |
| 3740 | (lambda (a b) (string< (car a) (car b)))) |
| 3741 | index-alist)) |
| 3742 | (error t))) |
| 3743 | ) |
| 3744 | \f |
| 3745 | ;;; Tag Management -- etags (old XEmacs compatibility part) |
| 3746 | ;; |
| 3747 | (defvar speedbar-fetch-etags-parse-list |
| 3748 | '(;; Note that java has the same parse-group as c |
| 3749 | ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\)\\'" . |
| 3750 | speedbar-parse-c-or-c++tag) |
| 3751 | ("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" . |
| 3752 | "def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?") |
| 3753 | ; ("\\.\\([fF]\\|for\\|FOR\\|77\\|90\\)\\'" . |
| 3754 | ; speedbar-parse-fortran77-tag) |
| 3755 | ("\\.tex\\'" . speedbar-parse-tex-string) |
| 3756 | ("\\.p\\'" . |
| 3757 | "\\(\\(FUNCTION\\|function\\|PROCEDURE\\|procedure\\)\\s-+\\([a-zA-Z0-9_.:]+\\)\\)\\s-*(?^?") |
| 3758 | ) |
| 3759 | "Associations of file extensions and expressions for extracting tags. |
| 3760 | To add a new file type, you would want to add a new association to the |
| 3761 | list, where the car is the file match, and the cdr is the way to |
| 3762 | extract an element from the tags output. If the output is complex, |
| 3763 | use a function symbol instead of regexp. The function should expect |
| 3764 | to be at the beginning of a line in the etags buffer. |
| 3765 | |
| 3766 | This variable is ignored if `speedbar-use-imenu-flag' is non-nil.") |
| 3767 | |
| 3768 | (defvar speedbar-fetch-etags-command "etags" |
| 3769 | "*Command used to create an etags file. |
| 3770 | |
| 3771 | This variable is ignored if `speedbar-use-imenu-flag' is t") |
| 3772 | |
| 3773 | (defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-") |
| 3774 | "*List of arguments to use with `speedbar-fetch-etags-command'. |
| 3775 | This creates an etags output buffer. Use `speedbar-toggle-etags' to |
| 3776 | modify this list conveniently. |
| 3777 | |
| 3778 | This variable is ignored if `speedbar-use-imenu-flag' is t") |
| 3779 | |
| 3780 | (defun speedbar-toggle-etags (flag) |
| 3781 | "Toggle FLAG in `speedbar-fetch-etags-arguments'. |
| 3782 | FLAG then becomes a member of etags command line arguments. If flag |
| 3783 | is \"sort\", then toggle the value of `speedbar-sort-tags'. If its |
| 3784 | value is \"show\" then toggle the value of |
| 3785 | `speedbar-show-unknown-files'. |
| 3786 | |
| 3787 | This function is a convenience function for XEmacs menu created by |
| 3788 | Farzin Guilak <farzin@protocol.com>" |
| 3789 | (interactive) |
| 3790 | (cond |
| 3791 | ((equal flag "sort") |
| 3792 | (setq speedbar-sort-tags (not speedbar-sort-tags))) |
| 3793 | ((equal flag "show") |
| 3794 | (setq speedbar-show-unknown-files (not speedbar-show-unknown-files))) |
| 3795 | ((or (equal flag "-C") |
| 3796 | (equal flag "-S") |
| 3797 | (equal flag "-D")) |
| 3798 | (if (member flag speedbar-fetch-etags-arguments) |
| 3799 | (setq speedbar-fetch-etags-arguments |
| 3800 | (delete flag speedbar-fetch-etags-arguments)) |
| 3801 | (add-to-list 'speedbar-fetch-etags-arguments flag))) |
| 3802 | (t nil))) |
| 3803 | |
| 3804 | (defun speedbar-fetch-dynamic-etags (file) |
| 3805 | "For FILE, run etags and create a list of symbols extracted. |
| 3806 | Each symbol will be associated with its line position in FILE." |
| 3807 | (let ((newlist nil)) |
| 3808 | (unwind-protect |
| 3809 | (save-excursion |
| 3810 | (if (get-buffer "*etags tmp*") |
| 3811 | (kill-buffer "*etags tmp*")) ;kill to clean it up |
| 3812 | (if (<= 1 speedbar-verbosity-level) |
| 3813 | (speedbar-message "Fetching etags...")) |
| 3814 | (set-buffer (get-buffer-create "*etags tmp*")) |
| 3815 | (apply 'call-process speedbar-fetch-etags-command nil |
| 3816 | (current-buffer) nil |
| 3817 | (append speedbar-fetch-etags-arguments (list file))) |
| 3818 | (goto-char (point-min)) |
| 3819 | (if (<= 1 speedbar-verbosity-level) |
| 3820 | (speedbar-message "Fetching etags...")) |
| 3821 | (let ((expr |
| 3822 | (let ((exprlst speedbar-fetch-etags-parse-list) |
| 3823 | (ans nil)) |
| 3824 | (while (and (not ans) exprlst) |
| 3825 | (if (string-match (car (car exprlst)) file) |
| 3826 | (setq ans (car exprlst))) |
| 3827 | (setq exprlst (cdr exprlst))) |
| 3828 | (cdr ans)))) |
| 3829 | (if expr |
| 3830 | (let (tnl) |
| 3831 | (set-buffer (get-buffer-create "*etags tmp*")) |
| 3832 | (while (not (save-excursion (end-of-line) (eobp))) |
| 3833 | (save-excursion |
| 3834 | (setq tnl (speedbar-extract-one-symbol expr))) |
| 3835 | (if tnl (setq newlist (cons tnl newlist))) |
| 3836 | (forward-line 1))) |
| 3837 | (speedbar-message |
| 3838 | "Sorry, no support for a file of that extension")))) |
| 3839 | ) |
| 3840 | (if speedbar-sort-tags |
| 3841 | (sort newlist (lambda (a b) (string< (car a) (car b)))) |
| 3842 | (reverse newlist)))) |
| 3843 | |
| 3844 | ;; This bit donated by Farzin Guilak <farzin@protocol.com> but I'm not |
| 3845 | ;; sure it's needed with the different sorting method. |
| 3846 | ;; |
| 3847 | ;(defun speedbar-clean-etags() |
| 3848 | ; "Removes spaces before the ^? character, and removes `#define', |
| 3849 | ;return types, etc. preceding tags. This ensures that the sort operation |
| 3850 | ;works on the tags, not the return types." |
| 3851 | ; (save-excursion |
| 3852 | ; (goto-char (point-min)) |
| 3853 | ; (while |
| 3854 | ; (re-search-forward "(?[ \t](?\C-?" nil t) |
| 3855 | ; (replace-match "\C-?" nil nil)) |
| 3856 | ; (goto-char (point-min)) |
| 3857 | ; (while |
| 3858 | ; (re-search-forward "\\(.*[ \t]+\\)\\([^ \t\n]+.*\C-?\\)" nil t) |
| 3859 | ; (delete-region (match-beginning 1) (match-end 1))))) |
| 3860 | |
| 3861 | (defun speedbar-extract-one-symbol (expr) |
| 3862 | "At point, return nil, or one alist in the form: (SYMBOL . POSITION) |
| 3863 | The line should contain output from etags. Parse the output using the |
| 3864 | regular expression EXPR" |
| 3865 | (let* ((sym (if (stringp expr) |
| 3866 | (if (save-excursion |
| 3867 | (re-search-forward expr (save-excursion |
| 3868 | (end-of-line) |
| 3869 | (point)) t)) |
| 3870 | (buffer-substring-no-properties (match-beginning 1) |
| 3871 | (match-end 1))) |
| 3872 | (funcall expr))) |
| 3873 | (pos (let ((j (re-search-forward "[\C-?\C-a]\\([0-9]+\\),\\([0-9]+\\)" |
| 3874 | (save-excursion |
| 3875 | (end-of-line) |
| 3876 | (point)) |
| 3877 | t))) |
| 3878 | (if (and j sym) |
| 3879 | (1+ (string-to-int (buffer-substring-no-properties |
| 3880 | (match-beginning 2) |
| 3881 | (match-end 2)))) |
| 3882 | 0)))) |
| 3883 | (if (/= pos 0) |
| 3884 | (cons sym pos) |
| 3885 | nil))) |
| 3886 | |
| 3887 | (defun speedbar-parse-c-or-c++tag () |
| 3888 | "Parse a c or c++ tag, which tends to be a little complex." |
| 3889 | (save-excursion |
| 3890 | (let ((bound (save-excursion (end-of-line) (point)))) |
| 3891 | (cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t) |
| 3892 | (buffer-substring-no-properties (match-beginning 1) |
| 3893 | (match-end 1))) |
| 3894 | ((re-search-forward "\\<\\([^ \t]+\\)\\s-+new(" bound t) |
| 3895 | (buffer-substring-no-properties (match-beginning 1) |
| 3896 | (match-end 1))) |
| 3897 | ((re-search-forward "\\<\\([^ \t(]+\\)\\s-*(\C-?" bound t) |
| 3898 | (buffer-substring-no-properties (match-beginning 1) |
| 3899 | (match-end 1))) |
| 3900 | (t nil)) |
| 3901 | ))) |
| 3902 | |
| 3903 | (defun speedbar-parse-tex-string () |
| 3904 | "Parse a Tex string. Only find data which is relevant." |
| 3905 | (save-excursion |
| 3906 | (let ((bound (save-excursion (end-of-line) (point)))) |
| 3907 | (cond ((re-search-forward "\\(\\(sub\\)*section\\|chapter\\|cite\\)\\s-*{[^\C-?}]*}?" bound t) |
| 3908 | (buffer-substring-no-properties (match-beginning 0) |
| 3909 | (match-end 0))) |
| 3910 | (t nil))))) |
| 3911 | |
| 3912 | \f |
| 3913 | ;;; BUFFER DISPLAY mode. |
| 3914 | ;; |
| 3915 | (defvar speedbar-buffers-key-map nil |
| 3916 | "Keymap used when in the buffers display mode.") |
| 3917 | |
| 3918 | (if speedbar-buffers-key-map |
| 3919 | nil |
| 3920 | (setq speedbar-buffers-key-map (speedbar-make-specialized-keymap)) |
| 3921 | |
| 3922 | ;; Basic tree features |
| 3923 | (define-key speedbar-buffers-key-map "e" 'speedbar-edit-line) |
| 3924 | (define-key speedbar-buffers-key-map "\C-m" 'speedbar-edit-line) |
| 3925 | (define-key speedbar-buffers-key-map "+" 'speedbar-expand-line) |
| 3926 | (define-key speedbar-buffers-key-map "=" 'speedbar-expand-line) |
| 3927 | (define-key speedbar-buffers-key-map "-" 'speedbar-contract-line) |
| 3928 | |
| 3929 | ;; Buffer specific keybindings |
| 3930 | (define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer) |
| 3931 | (define-key speedbar-buffers-key-map "r" 'speedbar-buffer-revert-buffer) |
| 3932 | |
| 3933 | ) |
| 3934 | |
| 3935 | (defvar speedbar-buffer-easymenu-definition |
| 3936 | '(["Jump to buffer" speedbar-edit-line t] |
| 3937 | ["Expand File Tags" speedbar-expand-line |
| 3938 | (save-excursion (beginning-of-line) |
| 3939 | (looking-at "[0-9]+: *.\\+. "))] |
| 3940 | ["Flush Cache & Expand" speedbar-flush-expand-line |
| 3941 | (save-excursion (beginning-of-line) |
| 3942 | (looking-at "[0-9]+: *.\\+. "))] |
| 3943 | ["Contract File Tags" speedbar-contract-line |
| 3944 | (save-excursion (beginning-of-line) |
| 3945 | (looking-at "[0-9]+: *.-. "))] |
| 3946 | ["Kill Buffer" speedbar-buffer-kill-buffer |
| 3947 | (save-excursion (beginning-of-line) |
| 3948 | (looking-at "[0-9]+: *.-. "))] |
| 3949 | ["Revert Buffer" speedbar-buffer-revert-buffer |
| 3950 | (save-excursion (beginning-of-line) |
| 3951 | (looking-at "[0-9]+: *.-. "))] |
| 3952 | ) |
| 3953 | "Menu item elements shown when displaying a buffer list.") |
| 3954 | |
| 3955 | (defun speedbar-buffer-buttons (directory zero) |
| 3956 | "Create speedbar buttons based on the buffers currently loaded. |
| 3957 | DIRECTORY is the path to the currently active buffer, and ZERO is 0." |
| 3958 | (speedbar-buffer-buttons-engine nil)) |
| 3959 | |
| 3960 | (defun speedbar-buffer-buttons-temp (directory zero) |
| 3961 | "Create speedbar buttons based on the buffers currently loaded. |
| 3962 | DIRECTORY is the path to the currently active buffer, and ZERO is 0." |
| 3963 | (speedbar-buffer-buttons-engine t)) |
| 3964 | |
| 3965 | (defun speedbar-buffer-buttons-engine (temp) |
| 3966 | "Create speedbar buffer buttons. |
| 3967 | If TEMP is non-nil, then clicking on a buffer restores the previous display." |
| 3968 | (insert "Active Buffers:\n") |
| 3969 | (let ((bl (buffer-list))) |
| 3970 | (while bl |
| 3971 | (if (string-match "^[ *]" (buffer-name (car bl))) |
| 3972 | nil |
| 3973 | (let* ((known (string-match speedbar-file-regexp |
| 3974 | (buffer-name (car bl)))) |
| 3975 | (expchar (if known ?+ ??)) |
| 3976 | (fn (if known 'speedbar-tag-file nil)) |
| 3977 | (fname (save-excursion (set-buffer (car bl)) |
| 3978 | (buffer-file-name)))) |
| 3979 | (speedbar-make-tag-line 'bracket expchar fn |
| 3980 | (if fname (file-name-nondirectory fname)) |
| 3981 | (buffer-name (car bl)) |
| 3982 | 'speedbar-buffer-click temp |
| 3983 | 'speedbar-file-face 0))) |
| 3984 | (setq bl (cdr bl))) |
| 3985 | (setq bl (buffer-list)) |
| 3986 | (insert "Scratch Buffers:\n") |
| 3987 | (while bl |
| 3988 | (if (not (string-match "^\\*" (buffer-name (car bl)))) |
| 3989 | nil |
| 3990 | (if (eq (car bl) speedbar-buffer) |
| 3991 | nil |
| 3992 | (speedbar-make-tag-line 'bracket ?? nil nil |
| 3993 | (buffer-name (car bl)) |
| 3994 | 'speedbar-buffer-click temp |
| 3995 | 'speedbar-file-face 0))) |
| 3996 | (setq bl (cdr bl))) |
| 3997 | (setq bl (buffer-list)) |
| 3998 | (insert "Hidden Buffers:\n") |
| 3999 | (while bl |
| 4000 | (if (not (string-match "^ " (buffer-name (car bl)))) |
| 4001 | nil |
| 4002 | (if (eq (car bl) speedbar-buffer) |
| 4003 | nil |
| 4004 | (speedbar-make-tag-line 'bracket ?? nil nil |
| 4005 | (buffer-name (car bl)) |
| 4006 | 'speedbar-buffer-click temp |
| 4007 | 'speedbar-file-face 0))) |
| 4008 | (setq bl (cdr bl))))) |
| 4009 | |
| 4010 | (defun speedbar-buffers-item-info () |
| 4011 | "Display information about the current buffer on the current line." |
| 4012 | (or (speedbar-item-info-tag-helper) |
| 4013 | (let* ((item (speedbar-line-text)) |
| 4014 | (buffer (if item (get-buffer item) nil))) |
| 4015 | (and buffer |
| 4016 | (speedbar-message "%s%s %S %d %s" |
| 4017 | (if (buffer-modified-p buffer) "* " "") |
| 4018 | item |
| 4019 | (save-excursion (set-buffer buffer) major-mode) |
| 4020 | (save-excursion (set-buffer buffer) |
| 4021 | (buffer-size)) |
| 4022 | (or (buffer-file-name buffer) "<No file>")))))) |
| 4023 | |
| 4024 | (defun speedbar-buffers-line-path (&optional depth) |
| 4025 | "Fetch the full path to the file (buffer) specified on the current line. |
| 4026 | Optional argument DEPTH specifies the current depth of the back search." |
| 4027 | (end-of-line) |
| 4028 | ;; Buffers are always at level 0 |
| 4029 | (if (not (re-search-backward "^0:" nil t)) |
| 4030 | nil |
| 4031 | (let* ((bn (speedbar-line-text)) |
| 4032 | (buffer (if bn (get-buffer bn)))) |
| 4033 | (if buffer (file-name-directory (buffer-file-name buffer)))))) |
| 4034 | |
| 4035 | (defun speedbar-buffer-click (text token indent) |
| 4036 | "When the users clicks on a buffer-button in speedbar. |
| 4037 | TEXT is the buffer's name, TOKEN and INDENT are unused." |
| 4038 | (if speedbar-power-click |
| 4039 | (let ((pop-up-frames t)) (select-window (display-buffer text))) |
| 4040 | (select-frame speedbar-attached-frame) |
| 4041 | (switch-to-buffer text) |
| 4042 | (if token (speedbar-change-initial-expansion-list |
| 4043 | speedbar-previously-used-expansion-list-name)))) |
| 4044 | |
| 4045 | (defun speedbar-buffer-kill-buffer () |
| 4046 | "Kill the buffer the cursor is on in the speedbar buffer." |
| 4047 | (interactive) |
| 4048 | (or (save-excursion |
| 4049 | (beginning-of-line) |
| 4050 | ;; If this fails, then it is a non-standard click, and as such, |
| 4051 | ;; perfectly allowed. |
| 4052 | (if (re-search-forward "[]>?}] [^ ]" |
| 4053 | (save-excursion (end-of-line) (point)) |
| 4054 | t) |
| 4055 | (let ((text (progn |
| 4056 | (forward-char -1) |
| 4057 | (buffer-substring (point) (save-excursion |
| 4058 | (end-of-line) |
| 4059 | (point)))))) |
| 4060 | (if (and (get-buffer text) |
| 4061 | (speedbar-y-or-n-p (format "Kill buffer %s? " text))) |
| 4062 | (kill-buffer text)) |
| 4063 | (speedbar-refresh)))))) |
| 4064 | |
| 4065 | (defun speedbar-buffer-revert-buffer () |
| 4066 | "Revert the buffer the cursor is on in the speedbar buffer." |
| 4067 | (interactive) |
| 4068 | (save-excursion |
| 4069 | (beginning-of-line) |
| 4070 | ;; If this fails, then it is a non-standard click, and as such, |
| 4071 | ;; perfectly allowed |
| 4072 | (if (re-search-forward "[]>?}] [^ ]" |
| 4073 | (save-excursion (end-of-line) (point)) |
| 4074 | t) |
| 4075 | (let ((text (progn |
| 4076 | (forward-char -1) |
| 4077 | (buffer-substring (point) (save-excursion |
| 4078 | (end-of-line) |
| 4079 | (point)))))) |
| 4080 | (if (get-buffer text) |
| 4081 | (progn |
| 4082 | (set-buffer text) |
| 4083 | (revert-buffer t))))))) |
| 4084 | |
| 4085 | \f |
| 4086 | ;;; Useful hook values and such. |
| 4087 | ;; |
| 4088 | (defvar speedbar-highlight-one-tag-line nil |
| 4089 | "Overlay used for highlighting the most recently jumped to tag line.") |
| 4090 | |
| 4091 | (defun speedbar-highlight-one-tag-line () |
| 4092 | "Highlight the current line, unhighlighting a previously jumped to line." |
| 4093 | (speedbar-unhighlight-one-tag-line) |
| 4094 | (setq speedbar-highlight-one-tag-line |
| 4095 | (speedbar-make-overlay (save-excursion (beginning-of-line) (point)) |
| 4096 | (save-excursion (end-of-line) |
| 4097 | (forward-char 1) |
| 4098 | (point)))) |
| 4099 | (speedbar-overlay-put speedbar-highlight-one-tag-line 'face |
| 4100 | 'speedbar-highlight-face) |
| 4101 | (add-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line) |
| 4102 | ) |
| 4103 | |
| 4104 | (defun speedbar-unhighlight-one-tag-line () |
| 4105 | "Unhighlight the currently highlight line." |
| 4106 | (if speedbar-highlight-one-tag-line |
| 4107 | (progn |
| 4108 | (speedbar-delete-overlay speedbar-highlight-one-tag-line) |
| 4109 | (setq speedbar-highlight-one-tag-line nil))) |
| 4110 | (remove-hook 'pre-command-hook 'speedbar-unhighlight-one-tag-line)) |
| 4111 | |
| 4112 | (defun speedbar-recenter-to-top () |
| 4113 | "Recenter the current buffer so POINT is on the top of the window." |
| 4114 | (recenter 1)) |
| 4115 | |
| 4116 | (defun speedbar-recenter () |
| 4117 | "Recenter the current buffer so POINT is in the center of the window." |
| 4118 | (recenter (/ (window-height (selected-window)) 2))) |
| 4119 | |
| 4120 | \f |
| 4121 | ;;; Color loading section. |
| 4122 | ;; |
| 4123 | (defface speedbar-button-face '((((class color) (background light)) |
| 4124 | (:foreground "green4")) |
| 4125 | (((class color) (background dark)) |
| 4126 | (:foreground "green3"))) |
| 4127 | "Face used for +/- buttons." |
| 4128 | :group 'speedbar-faces) |
| 4129 | |
| 4130 | (defface speedbar-file-face '((((class color) (background light)) |
| 4131 | (:foreground "cyan4")) |
| 4132 | (((class color) (background dark)) |
| 4133 | (:foreground "cyan")) |
| 4134 | (t (:bold t))) |
| 4135 | "Face used for file names." |
| 4136 | :group 'speedbar-faces) |
| 4137 | |
| 4138 | (defface speedbar-directory-face '((((class color) (background light)) |
| 4139 | (:foreground "blue4")) |
| 4140 | (((class color) (background dark)) |
| 4141 | (:foreground "light blue"))) |
| 4142 | "Faced used for directory names." |
| 4143 | :group 'speedbar-faces) |
| 4144 | (defface speedbar-tag-face '((((class color) (background light)) |
| 4145 | (:foreground "brown")) |
| 4146 | (((class color) (background dark)) |
| 4147 | (:foreground "yellow"))) |
| 4148 | "Face used for displaying tags." |
| 4149 | :group 'speedbar-faces) |
| 4150 | |
| 4151 | (defface speedbar-selected-face '((((class color) (background light)) |
| 4152 | (:foreground "red" :underline t)) |
| 4153 | (((class color) (background dark)) |
| 4154 | (:foreground "red" :underline t)) |
| 4155 | (t (:underline t))) |
| 4156 | "Face used to underline the file in the active window." |
| 4157 | :group 'speedbar-faces) |
| 4158 | |
| 4159 | (defface speedbar-highlight-face '((((class color) (background light)) |
| 4160 | (:background "green")) |
| 4161 | (((class color) (background dark)) |
| 4162 | (:background "sea green")) |
| 4163 | (((class grayscale monochrome) |
| 4164 | (background light)) |
| 4165 | (:background "black")) |
| 4166 | (((class grayscale monochrome) |
| 4167 | (background dark)) |
| 4168 | (:background "white"))) |
| 4169 | "Face used for highlighting buttons with the mouse." |
| 4170 | :group 'speedbar-faces) |
| 4171 | |
| 4172 | \f |
| 4173 | ;;; Image loading and inlining |
| 4174 | ;; |
| 4175 | |
| 4176 | ;;; Some images if defimage is available: |
| 4177 | (eval-when-compile |
| 4178 | |
| 4179 | (if (fboundp 'defimage) |
| 4180 | (defalias 'defimage-speedbar 'defimage) |
| 4181 | |
| 4182 | (if (not (fboundp 'make-glyph)) |
| 4183 | |
| 4184 | (defmacro defimage-speedbar (variable imagespec docstring) |
| 4185 | "Don't bother loading up an image... |
| 4186 | Argument VARIABLE is the varible to define. |
| 4187 | Argument IMAGESPEC is the list defining the image to create. |
| 4188 | Argument DOCSTRING is the documentation for VARIABLE." |
| 4189 | `(defvar ,variable nil ,docstring)) |
| 4190 | |
| 4191 | ;; ELSE |
| 4192 | (defun speedbar-find-image-on-load-path (image) |
| 4193 | "Find the image file IMAGE on the load path." |
| 4194 | (let ((l load-path) |
| 4195 | (r nil)) |
| 4196 | (while (and l (not r)) |
| 4197 | (if (file-exists-p (concat (car l) "/" image)) |
| 4198 | (setq r (concat (car l) "/" image))) |
| 4199 | (setq l (cdr l))) |
| 4200 | r)) |
| 4201 | |
| 4202 | (defun speedbar-convert-emacs21-imagespec-to-xemacs (spec) |
| 4203 | "Convert the Emacs21 Image SPEC into an XEmacs image spec." |
| 4204 | (let* ((sl (car spec)) |
| 4205 | (itype (nth 1 sl)) |
| 4206 | (ifile (nth 3 sl))) |
| 4207 | (vector itype ':file (speedbar-find-image-on-load-path ifile)))) |
| 4208 | |
| 4209 | (defmacro defimage-speedbar (variable imagespec docstring) |
| 4210 | "Devine VARIABLE as an image if `defimage' is not available.. |
| 4211 | IMAGESPEC is the image data, and DOCSTRING is documentation for the image." |
| 4212 | `(defvar ,variable |
| 4213 | ;; The Emacs21 version of defimage looks just like the XEmacs image |
| 4214 | ;; specifier, except that it needs a :type keyword. If we line |
| 4215 | ;; stuff up right, we can use this cheat to support XEmacs specifiers. |
| 4216 | (condition-case nil |
| 4217 | (make-glyph |
| 4218 | (make-image-specifier |
| 4219 | (speedbar-convert-emacs21-imagespec-to-xemacs (quote ,imagespec))) |
| 4220 | 'buffer) |
| 4221 | (error nil)) |
| 4222 | ,docstring)) |
| 4223 | |
| 4224 | ))) |
| 4225 | |
| 4226 | (defimage-speedbar speedbar-directory-plus |
| 4227 | ((:type xpm :file "sb-dir-plus.xpm" :ascent center)) |
| 4228 | "Image used for closed directories with stuff in them.") |
| 4229 | |
| 4230 | (defimage-speedbar speedbar-directory-minus |
| 4231 | ((:type xpm :file "sb-dir-minus.xpm" :ascent center)) |
| 4232 | "Image used for open directories with stuff in them.") |
| 4233 | |
| 4234 | (defimage-speedbar speedbar-page-plus |
| 4235 | ((:type xpm :file "sb-pg-plus.xpm" :ascent center)) |
| 4236 | "Image used for closed files with stuff in them.") |
| 4237 | |
| 4238 | (defimage-speedbar speedbar-page-minus |
| 4239 | ((:type xpm :file "sb-pg-minus.xpm" :ascent center)) |
| 4240 | "Image used for open files with stuff in them.") |
| 4241 | |
| 4242 | (defimage-speedbar speedbar-page |
| 4243 | ((:type xpm :file "sb-pg.xpm" :ascent center)) |
| 4244 | "Image used for files that can't be opened.") |
| 4245 | |
| 4246 | (defimage-speedbar speedbar-tag |
| 4247 | ((:type xpm :file "sb-tag.xpm" :ascent center)) |
| 4248 | "Image used for tags.") |
| 4249 | |
| 4250 | (defimage-speedbar speedbar-tag-plus |
| 4251 | ((:type xpm :file "sb-tag-plus.xpm" :ascent center)) |
| 4252 | "Image used for closed tag groups.") |
| 4253 | |
| 4254 | (defimage-speedbar speedbar-tag-minus |
| 4255 | ((:type xpm :file "sb-tag-minus.xpm" :ascent center)) |
| 4256 | "Image used for open tag groups.") |
| 4257 | |
| 4258 | (defimage-speedbar speedbar-tag-gt |
| 4259 | ((:type xpm :file "sb-tag-gt.xpm" :ascent center)) |
| 4260 | "Image used for open tag groups.") |
| 4261 | |
| 4262 | (defimage-speedbar speedbar-tag-v |
| 4263 | ((:type xpm :file "sb-tag-v.xpm" :ascent center)) |
| 4264 | "Image used for open tag groups.") |
| 4265 | |
| 4266 | (defimage-speedbar speedbar-tag-type |
| 4267 | ((:type xpm :file "sb-tag-type.xpm" :ascent center)) |
| 4268 | "Image used for open tag groups.") |
| 4269 | |
| 4270 | (defimage-speedbar speedbar-mail |
| 4271 | ((:type xpm :file "sb-mail.xpm" :ascent center)) |
| 4272 | "Image used for open tag groups.") |
| 4273 | |
| 4274 | (defvar speedbar-expand-image-button-alist |
| 4275 | '(("<+>" . speedbar-directory-plus) |
| 4276 | ("<->" . speedbar-directory-minus) |
| 4277 | ("[+]" . speedbar-page-plus) |
| 4278 | ("[-]" . speedbar-page-minus) |
| 4279 | ("[?]" . speedbar-page) |
| 4280 | ("{+}" . speedbar-tag-plus) |
| 4281 | ("{-}" . speedbar-tag-minus) |
| 4282 | ("<M>" . speedbar-mail) |
| 4283 | (" =>" . speedbar-tag) |
| 4284 | (" +>" . speedbar-tag-gt) |
| 4285 | (" ->" . speedbar-tag-v) |
| 4286 | (">" . speedbar-tag) |
| 4287 | ("@" . speedbar-tag-type) |
| 4288 | (" @" . speedbar-tag-type) |
| 4289 | ) |
| 4290 | "List of text and image associations.") |
| 4291 | |
| 4292 | (defun speedbar-insert-image-button-maybe (start length) |
| 4293 | "Insert an image button based on text starting at START for LENGTH chars. |
| 4294 | If buttontext is unknown, just insert that text. |
| 4295 | If we have an image associated with it, use that image." |
| 4296 | (if speedbar-use-images |
| 4297 | (let* ((bt (buffer-substring start (+ length start))) |
| 4298 | (a (assoc bt speedbar-expand-image-button-alist))) |
| 4299 | ;; Regular images (created with `insert-image' are intangible |
| 4300 | ;; which (I suppose) make them more compatible with XEmacs 21. |
| 4301 | ;; Unfortunatly, there is a giant pile o code dependent on the |
| 4302 | ;; underlying text. This means if we leave it tangible, then I |
| 4303 | ;; don't have to change said giant piles o code. |
| 4304 | (if (and a (symbol-value (cdr a))) |
| 4305 | (if (fboundp 'set-extent-property) |
| 4306 | (add-text-properties (+ start (length bt)) start |
| 4307 | (list 'end-glyph (symbol-value (cdr a)) |
| 4308 | 'rear-nonsticky (list 'display) |
| 4309 | 'invisible t |
| 4310 | 'detachable t)) |
| 4311 | (add-text-properties start (+ start (length bt)) |
| 4312 | (list 'display (symbol-value (cdr a)) |
| 4313 | 'rear-nonsticky (list 'display)))) |
| 4314 | ;(message "Bad text [%s]" (buffer-substring start (+ start length))) |
| 4315 | )))) |
| 4316 | |
| 4317 | |
| 4318 | ;; some edebug hooks |
| 4319 | (add-hook 'edebug-setup-hook |
| 4320 | (lambda () |
| 4321 | (def-edebug-spec speedbar-with-writable def-body))) |
| 4322 | |
| 4323 | (provide 'speedbar) |
| 4324 | ;;; speedbar ends here |
| 4325 | |
| 4326 | ;; run load-time hooks |
| 4327 | (run-hooks 'speedbar-load-hook) |