;;; speedbar --- quick access to files and tags in a frame
-;;; Copyright (C) 1996, 97, 98, 99, 2000, 01 Free Software Foundation
+;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
-;; Version: 0.11a
;; Keywords: file, tags, tools
+(defvar speedbar-version "1.0"
+ "The current version of speedbar.")
+(defvar speedbar-incompatible-version "0.14beta4"
+ "This version of speedbar is incompatible with this version.
+Due to massive API changes (removing the use of the word PATH)
+this version is not backward compatible to 0.14 or earlier.")
+
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; The speedbar provides a frame in which files, and locations in
-;; files are displayed. These items can be clicked on with mouse-2
-;; in order to make the last active frame display that file location.
-;;
-;; Starting Speedbar:
-;;
-;; Simply type `M-x speedbar', and it will be autoloaded for you.
-
-;; If you want to choose it from a menu, such as "Tools", you can do this:
-;;
-;; (define-key-after (lookup-key global-map [menu-bar tools])
-;; [speedbar] '("Speedbar" . speedbar-frame-mode) [calendar])
-;;
-;; If you want to access speedbar using only the keyboard, do this:
-;;
-;; (global-set-key [f4] 'speedbar-get-focus)
-;;
-;; This will let you hit f4 (or whatever key you choose) to jump
-;; focus to the speedbar frame. Pressing it again will bring you back
-;; to the attached frame. Pressing RET or e to jump to a file
-;; or tag will move you back to the attached frame. The command
-;; `speedbar-get-focus' will also create a speedbar frame if it does
-;; not exist.
-;;
-;; Customizing Speedbar:
-;;
-;; Once a speedbar frame is active, it takes advantage of idle time
-;; to keep its contents updated. The contents is usually a list of
-;; files in the directory of the currently active buffer. When
-;; applicable, tags in the active file can be expanded.
-;;
-;; To add new supported files types into speedbar, use the function
-;; `speedbar-add-supported-extension' If speedbar complains that the
-;; file type is not supported, that means there is no built in
-;; support from imenu, and the etags part wasn't set up correctly. You
-;; may add elements to `speedbar-supported-extension-expressions' as long
-;; as it is done before speedbar is loaded.
+;; files are displayed. These items can be clicked on with mouse-2 in
+;; to display that file location.
;;
-;; To prevent speedbar from following you into certain directories
-;; use the function `speedbar-add-ignored-path-regexp' too add a new
-;; regular expression matching a type of path. You may add list
-;; elements to `speedbar-ignored-path-expressions' as long as it is
-;; done before speedbar is loaded.
+;;; Customizing and Developing for speedbar
;;
-;; To add new file types to imenu, see the documentation in the
-;; file imenu.el that comes with Emacs. To add new file types which
-;; etags supports, you need to modify the variable
-;; `speedbar-fetch-etags-parse-list'.
+;; Please see the speedbar manual for informaion.
;;
-;; If the updates are going too slow for you, modify the variable
-;; `speedbar-update-speed' to a longer idle time before updates.
+;;; Notes:
;;
-;; If you navigate directories, you will probably notice that you
-;; will navigate to a directory which is eventually replaced after
-;; you go back to editing a file (unless you pull up a new file.)
-;; The delay time before this happens is in
-;; `speedbar-navigating-speed', and defaults to 10 seconds.
-;;
-;; To enable mouse tracking with information in the minibuffer of
-;; the attached frame, use the variable `speedbar-track-mouse-flag'.
-;;
-;; Tag layout can be modified through `speedbar-tag-hierarchy-method',
-;; which controls how tags are layed out. It is actually a list of
-;; functions that filter the data. The default groups large tag lists
-;; into sub-lists. A long flat list can be used instead if needed.
-;; Other filters could be easily added.
+;; Users of really old emacsen without the need timer functions
+;; will not have speedbar updating automatically. Use "g" to refresh
+;; the display after changing directories. Remember, do not interrupt
+;; the stealthy updates or your display may not be completely
+;; refreshed.
;;
;; AUC-TEX users: The imenu tags for AUC-TEX mode don't work very
;; well. Use the imenu keywords from tex-mode.el for better results.
;;
;; This file requires the library package assoc (association lists)
+;; assoc should be available in all modern versions of Emacs.
+;; The custom package is optional (for easy configuration of speedbar)
+;; http://www.dina.kvl.dk/~abraham/custom/
+;; custom is available in all versions of Emacs version 20 or better.
;;
;;; Developing for speedbar
;;
;; Adding a speedbar specialized display mode:
;;
;; Speedbar can be configured to create a special display for certain
-;; modes that do not display tradition file/tag data. Rmail, Info,
+;; modes that do not display traditional file/tag data. Rmail, Info,
;; and the debugger are examples. These modes can, however, benefit
;; from a speedbar style display in their own way.
;;
;; `speedbar-insert-generic-list'. If you use
;; `speedbar-insert-generic-list', also read the doc for
;; `speedbar-tag-hierarchy-method' in case you wish to override it.
-;; The function `speedbar-with-attached-buffer' brings you back to the
+;; The macro `speedbar-with-attached-buffer' brings you back to the
;; buffer speedbar is displaying for.
;;
;; For those functions that make buttons, the "function" should be a
;; functions are `speedbar-change-expand-button-char',
;; `speedbar-delete-subblock', and `speedbar-center-buffer-smartly'.
;; The variable `speedbar-power-click' is set to t in your functions
-;; when the user shift-clicks. This indications anything from
+;; when the user shift-clicks. This is an indication of anything from
;; refreshing cached data to making a buffer appear in a new frame.
;;
;; If you wish to add to the default speedbar menu for the case of
;; splice in. KEYMAP is a symbol holding the keymap to use, and
;; BUTTON-FUNCTIONS are the function names to call, in order, to create
;; the display.
-;; Another tweekable variable is `speedbar-stealthy-function-list'
+;; Another tweakable variable is `speedbar-stealthy-function-list'
;; which is of the form (NAME &rest FUNCTION ...). NAME is the string
;; name matching `speedbar-add-expansion-list'. (It does not need to
;; exist.). This provides additional display info which might be
;; time-consuming to calculate.
;; Lastly, `speedbar-mode-functions-list' allows you to set special
-;; function overrides. At the moment very few functions are
-;; over ridable, but more will be added as the need is discovered.
+;; function overrides.
;;; TODO:
-;; - More functions to create buttons and options
;; - Timeout directories we haven't visited in a while.
(require 'assoc)
(require 'easymenu)
-
-(condition-case nil
- (require 'image)
- (error nil))
-
-(defvar speedbar-xemacsp (string-match "XEmacs" emacs-version)
- "Non-nil if we are running in the XEmacs environment.")
-(defvar speedbar-xemacs20p (and speedbar-xemacsp
- (>= emacs-major-version 20)))
+(require 'dframe)
+(require 'sb-image)
;; customization stuff
(defgroup speedbar nil
"File and tag browser frame."
- :group 'tags
+ :group 'etags
:group 'tools
:group 'convenience
- :version "20.3")
+; :version "20.3"
+ )
(defgroup speedbar-faces nil
"Faces used in speedbar."
:group 'speedbar)
;;; Code:
+
+;; Note: `inversion-test' requires parts of the CEDET package that are
+;; not included with Emacs.
+;;
+;; (defun speedbar-require-version (major minor &optional beta)
+;; "Non-nil if this version of SPEEDBAR does not satisfy a specific version.
+;; Arguments can be:
+;;
+;; (MAJOR MINOR &optional BETA)
+;;
+;; Values MAJOR and MINOR must be integers. BETA can be an integer, or
+;; excluded if a released version is required.
+;;
+;; It is assumed that if the current version is newer than that specified,
+;; everything passes. Exceptions occur when known incompatibilities are
+;; introduced."
+;; (inversion-test 'speedbar
+;; (concat major "." minor
+;; (when beta (concat "beta" beta)))))
+
(defvar speedbar-initial-expansion-mode-alist
'(("buffers" speedbar-buffer-easymenu-definition speedbar-buffers-key-map
speedbar-buffer-buttons)
(defvar speedbar-stealthy-function-list
'(("files"
- speedbar-update-current-file speedbar-check-vc speedbar-check-objects)
+ speedbar-update-current-file
+ speedbar-check-read-only
+ speedbar-check-vc
+ speedbar-check-objects)
)
"List of functions to periodically call stealthily.
This list is of the form:
(defvar speedbar-mode-functions-list
'(("files" (speedbar-item-info . speedbar-files-item-info)
- (speedbar-line-path . speedbar-files-line-path))
+ (speedbar-line-directory . speedbar-files-line-directory))
("buffers" (speedbar-item-info . speedbar-buffers-item-info)
- (speedbar-line-path . speedbar-buffers-line-path))
+ (speedbar-line-directory . speedbar-buffers-line-directory))
("quick buffers" (speedbar-item-info . speedbar-buffers-item-info)
- (speedbar-line-path . speedbar-buffers-line-path))
+ (speedbar-line-directory . speedbar-buffers-line-directory))
)
"List of function tables to use for different major display modes.
It is not necessary to define any functions for a specialized mode.
:group 'speedbar
:type 'boolean)
+(defcustom speedbar-query-confirmation-method 'all
+ "*Query control for file operations.
+The 'always flag means to always query before file operations.
+The 'none-but-delete flag means to not query before any file
+operations, except before a file deletion."
+ :group 'speedbar
+ :type '(radio (const :tag "Always Query before some file operations."
+ all)
+ (const :tag "Never Query before file operations, except for deletions."
+ none-but-delete)
+;;;; (const :tag "Never Every Query."
+;;;; none)
+ ))
+
(defvar speedbar-special-mode-expansion-list nil
"Default function list for creating specialized button lists.
This list is set by modes that wish to have special speedbar displays.
(defvar speedbar-special-mode-key-map nil
"Default keymap used when identifying a specialized display mode.
This keymap is local to each buffer that wants to define special keybindings
-effective when it's display is shown.")
+effective when its display is shown.")
+
+(defcustom speedbar-before-visiting-file-hook '(push-mark)
+ "*Hooks run before speedbar visits a file in the selected frame.
+The default buffer is the buffer in the selected window in the attached frame."
+ :group 'speedbar
+ :type 'hook)
(defcustom speedbar-visiting-file-hook nil
- "Hooks run when speedbar visits a file in the selected frame."
+ "*Hooks run when speedbar visits a file in the selected frame."
+ :group 'speedbar
+ :type 'hook)
+
+(defcustom speedbar-before-visiting-tag-hook '(push-mark)
+ "*Hooks run before speedbar visits a tag in the selected frame.
+The default buffer is the buffer in the selected window in the attached frame."
:group 'speedbar
:type 'hook)
(defcustom speedbar-visiting-tag-hook '(speedbar-highlight-one-tag-line)
- "Hooks run when speedbar visits a tag in the selected frame."
+ "*Hooks run when speedbar visits a tag in the selected frame."
:group 'speedbar
:type 'hook
- :version "21.1"
:options '(speedbar-highlight-one-tag-line
speedbar-recenter-to-top
speedbar-recenter
))
(defcustom speedbar-load-hook nil
- "Hooks run when speedbar is loaded."
+ "*Hooks run when speedbar is loaded."
:group 'speedbar
:type 'hook)
(defcustom speedbar-reconfigure-keymaps-hook nil
- "Hooks run when the keymaps are regenerated."
+ "*Hooks run when the keymaps are regenerated."
:group 'speedbar
- :version "21.1"
:type 'hook)
(defcustom speedbar-show-unknown-files nil
:group 'speedbar
:type 'boolean)
-(defcustom speedbar-update-speed
- (if speedbar-xemacsp
- (if speedbar-xemacs20p
- 2 ; 1 is too obrusive in XEmacs
- 5) ; when no idleness, need long delay
- 1)
- "*Idle time in seconds needed before speedbar will update itself.
-Updates occur to allow speedbar to display directory information
-relevant to the buffer you are currently editing."
- :group 'speedbar
- :type 'integer)
+;;; EVENTUALLY REMOVE THESE
;; When I moved to a repeating timer, I had the horrible missfortune
;; of loosing the ability for adaptive speed choice. This update
;; speed currently causes long delays when it should have been turned off.
-(defcustom speedbar-navigating-speed speedbar-update-speed
- "*Idle time to wait after navigation commands in speedbar are executed.
-Navigation commands included expanding/contracting nodes, and moving
-between different directories."
- :group 'speedbar
- :type 'integer)
+(defvar speedbar-update-speed dframe-update-speed
+ "*Obsoleted variable. Use `dframe-update-speed'.")
+
+(defvar speedbar-navigating-speed dframe-update-speed
+ "*Obsoleted variable. Use `dframe-update-speed'.")
+;;; END REMOVE THESE
(defcustom speedbar-frame-parameters '((minibuffer . nil)
(width . 20)
(border-width . 0)
(menu-bar-lines . 0)
(tool-bar-lines . 0)
- (unsplittable . t))
+ (unsplittable . t)
+ (left-fringe . 0)
+ )
"*Parameters to use when creating the speedbar frame in Emacs.
Any parameter supported by a frame may be added. The parameter `height'
will be initialized to the height of the frame speedbar is
attached to and added to this list before the new frame is initialized."
:group 'speedbar
- :type '(repeat (sexp :tag "Parameter:")))
+ :type '(repeat (cons :format "%v"
+ (symbol :tag "Parameter")
+ (sexp :tag "Value"))))
;; These values by Hrvoje Niksic <hniksic@srce.hr>
(defcustom speedbar-frame-plist
'(minibuffer nil width 20 border-width 0
internal-border-width 0 unsplittable t
default-toolbar-visible-p nil has-modeline-p nil
- menubar-visible-p nil)
+ menubar-visible-p nil
+ default-gutter-visible-p nil
+ )
"*Parameters to use when creating the speedbar frame in XEmacs.
Parameters not listed here which will be added automatically are
`height' which will be initialized to the height of the frame speedbar
(symbol :tag "Property")
(sexp :tag "Value"))))
-(defcustom speedbar-use-imenu-flag (stringp (locate-library "imenu"))
+(defcustom speedbar-use-imenu-flag (fboundp 'imenu)
"*Non-nil means use imenu for file parsing. nil to use etags.
XEmacs prior to 20.4 doesn't support imenu, therefore the default is to
use etags instead. Etags support is not as robust as imenu support."
(defvar speedbar-dynamic-tags-function-list
'((speedbar-fetch-dynamic-imenu . speedbar-insert-imenu-list)
(speedbar-fetch-dynamic-etags . speedbar-insert-etags-list))
- "Set to a functions which will return and insert a list of tags.
+ "Set to a list of functions which will return and insert a list of tags.
Each element is of the form ( FETCH . INSERT ) where FETCH
-is a funciotn which takes one parameter (the file to tag) and returns a
+is a function which takes one parameter (the file to tag) and returns a
list of tags. The tag list can be of any form as long as the
corresponding insert method can handle it. If it returns t, then an
-error occured, and the next fetch routine is tried.
+error occurred, and the next fetch routine is tried.
INSERT is a function which takes an INDENTation level, and a LIST of
tags to insert. It will then create the speedbar buttons.")
-(defcustom speedbar-track-mouse-flag t
+(defcustom speedbar-use-tool-tips-flag (and (not (featurep 'xemacs))
+ (>= emacs-major-version 21))
+ "*Non-nil means to use tool tips if they are avaialble.
+When tooltips are not available, mouse-tracking and minibuffer
+display is used instead."
+ :group 'speedbar
+ :type 'boolean)
+
+(defcustom speedbar-track-mouse-flag (not speedbar-use-tool-tips-flag)
"*Non-nil means to display info about the line under the mouse."
:group 'speedbar
:type 'boolean)
+(defcustom speedbar-default-position 'left-right
+ "*Default position of the speedbar frame.
+Possible values are 'left, 'right or 'left-right.
+If value is 'left-right, the most suitable location is
+determined automatically."
+ :group 'speedbar
+ :type '(radio (const :tag "Automatic" left-right)
+ (const :tag "Left" left)
+ (const :tag "Right" right)))
+
(defcustom speedbar-sort-tags nil
- "*If Non-nil, sort tags in the speedbar display. *Obsolete*."
+ "*If non-nil, sort tags in the speedbar display. *Obsolete*.
+Use `semantic-tag-hierarchy-method' instead."
:group 'speedbar
:type 'boolean)
"*List of hooks which speedbar will use to organize tags into groups.
Groups are defined as expandable meta-tags. Imenu supports
such things in some languages, such as separating variables from
-functions. Each hook takes one argument LST, and may destructivly
+functions. Each hook takes one argument LST, and may destructively
create a new list of the same form. LST is a list of elements of the
form:
(ELT1 ELT2 ... ELTn)
where each ELT is of the form
(TAG-NAME-STRING . NUMBER-OR-MARKER)
or
- (GROUP-NAME-STRING ELT1 EL2... ELTn)"
+ (GROUP-NAME-STRING ELT1 ELT2... ELTn)"
:group 'speedbar
:type 'hook
- :options '(speedbar-sort-tag-hierarchy
+ :options '(speedbar-prefix-group-tag-hierarchy
speedbar-trim-words-tag-hierarchy
- speedbar-prefix-group-tag-hierarchy
- speedbar-simple-group-tag-hierarchy)
+ speedbar-simple-group-tag-hierarchy
+ speedbar-sort-tag-hierarchy)
)
(defcustom speedbar-tag-group-name-minimum-length 4
:group 'speedbar
:type 'integer)
-(defcustom speedbar-activity-change-focus-flag nil
- "*Non-nil means the selected frame will change based on activity.
-Thus, if a file is selected for edit, the buffer will appear in the
-selected frame and the focus will change to that frame."
- :group 'speedbar
- :type 'boolean)
-
(defcustom speedbar-directory-button-trim-method 'span
"*Indicates how the directory button will be displayed.
Possible values are:
(defcustom speedbar-indentation-width 1
"*When sub-nodes are expanded, the number of spaces used for indentation."
:group 'speedbar
- :version "21.1"
:type 'integer)
(defcustom speedbar-hide-button-brackets-flag nil
"*Non-nil means speedbar will hide the brackets around the + or -."
:group 'speedbar
- :version "21.1"
- :type 'boolean)
-
-(defcustom speedbar-use-images (and (or (fboundp 'defimage)
- (fboundp 'make-image-specifier))
- (if (fboundp 'display-graphic-p)
- (display-graphic-p)
- window-system))
- "*Non nil if speedbar should display icons."
- :group 'speedbar
- :version "21.1"
:type 'boolean)
(defcustom speedbar-before-popup-hook nil
:group 'speedbar
:type 'hook)
+(defcustom speedbar-after-create-hook '(speedbar-frame-reposition-smartly)
+ "*Hooks called after popping up the speedbar frame."
+ :group 'speedbar
+ :type 'hook)
+
(defcustom speedbar-before-delete-hook nil
"*Hooks called before deleting the speedbar frame."
:group 'speedbar
(defcustom speedbar-vc-do-check t
"*Non-nil check all files in speedbar to see if they have been checked out.
-Any file checked out is marked with `speedbar-vc-indicator'"
+Any file checked out is marked with `speedbar-vc-indicator'."
:group 'speedbar-vc
:type 'boolean)
(defvar speedbar-vc-indicator "*"
"Text used to mark files which are currently checked out.
Other version control systems can be added by examining the function
-`speedbar-vc-path-enable-hook' and `speedbar-vc-in-control-hook'.")
+`speedbar-vc-directory-enable-hook' and `speedbar-vc-in-control-hook'.")
-(defcustom speedbar-vc-path-enable-hook nil
- "*Return non-nil if the current path should be checked for Version Control.
-Functions in this hook must accept one parameter which is the path
+(defcustom speedbar-vc-directory-enable-hook nil
+ "*Return non-nil if the current directory should be checked for Version Control.
+Functions in this hook must accept one parameter which is the directory
being checked."
:group 'speedbar-vc
:type 'hook)
(defcustom speedbar-vc-in-control-hook nil
"*Return non-nil if the specified file is under Version Control.
-Functions in this hook must accept two parameters. The PATH of the
+Functions in this hook must accept two parameters. The DIRECTORY of the
current file, and the FILENAME of the file being checked."
:group 'speedbar-vc
:type 'hook)
(defcustom speedbar-obj-do-check t
"*Non-nil check all files in speedbar to see if they have an object file.
Any file checked out is marked with `speedbar-obj-indicator', and the
-marking is based on `speedbar-obj-alist'"
+marking is based on `speedbar-obj-alist'"
:group 'speedbar-vc
:type 'boolean)
The expression `speedbar-obj-alist' defines who gets tagged.")
(defvar speedbar-obj-alist
- '(("\\.\\([cpC]\\|cpp\\|cc\\)$" . ".o")
+ '(("\\.\\([cpC]\\|cpp\\|cc\\|cxx\\)$" . ".o")
("\\.el$" . ".elc")
("\\.java$" . ".class")
("\\.f\\(or\\|90\\|77\\)?$" . ".o")
("\\.texi$" . ".info"))
"Alist of file extensions, and their corresponding object file type.")
+(defvar speedbar-ro-to-do-point nil
+ "Local variable maintaining the current read only check position.")
+
+(defvar speedbar-object-read-only-indicator "%"
+ "Indicator to append onto a line if that item is Read Only.")
+
+;; Note: Look for addition place to add indicator lists that
+;; use skip-chars instead of a regular expression.
(defvar speedbar-indicator-regex
(concat (regexp-quote speedbar-indicator-separator)
"\\("
(regexp-quote (car speedbar-obj-indicator))
"\\|"
(regexp-quote (cdr speedbar-obj-indicator))
+ "\\|"
+ (regexp-quote speedbar-object-read-only-indicator)
"\\)*")
"Regular expression used when identifying files.
Permits stripping of indicator characters from a line.")
:group 'speedbar
:type 'hook)
-(defvar speedbar-ignored-modes nil
+(defvar speedbar-ignored-modes '(fundamental-mode)
"*List of major modes which speedbar will not switch directories for.")
(defun speedbar-extension-list-to-regex (extlist)
(if regex2 (concat "\\(" regex2 "\\)") "")
"\\)$")))
-(defvar speedbar-ignored-path-regexp nil
- "Regular expression matching paths speedbar will not switch to.
-Created from `speedbar-ignored-path-expressions' with the function
+(defvar speedbar-ignored-directory-regexp nil
+ "Regular expression matching directorys speedbar will not switch to.
+Created from `speedbar-ignored-directory-expressions' with the function
`speedbar-extension-list-to-regex' (A misnamed function in this case.)
-Use the function `speedbar-add-ignored-path-regexp', or customize the
-variable `speedbar-ignored-path-expressions' to modify this variable.")
+Use the function `speedbar-add-ignored-directory-regexp', or customize the
+variable `speedbar-ignored-directory-expressions' to modify this variable.")
-(defcustom speedbar-ignored-path-expressions
+(defcustom speedbar-ignored-directory-expressions
'("[/\\]logs?[/\\]\\'")
"*List of regular expressions matching directories speedbar will ignore.
-They should included paths to directories which are notoriously very
+They should included directorys to directories which are notoriously very
large and take a long time to load in. Use the function
-`speedbar-add-ignored-path-regexp' to add new items to this list after
+`speedbar-add-ignored-directory-regexp' to add new items to this list after
speedbar is loaded. You may place anything you like in this list
before speedbar has been loaded."
:group 'speedbar
- :type '(repeat (regexp :tag "Path Regexp"))
+ :type '(repeat (regexp :tag "Directory Regexp"))
:set (lambda (sym val)
- (setq speedbar-ignored-path-expressions val
- speedbar-ignored-path-regexp
+ (setq speedbar-ignored-directory-expressions val
+ speedbar-ignored-directory-regexp
(speedbar-extension-list-to-regex val))))
-(defcustom speedbar-directory-unshown-regexp "^\\(CVS\\|RCS\\|SCCS\\)\\'"
+(defcustom speedbar-directory-unshown-regexp "^\\(CVS\\|RCS\\|SCCS\\|\\..*\\)\\'"
"*Regular expression matching directories not to show in speedbar.
They should include commonly existing directories which are not
useful, such as version control."
"*Regexp matching files we don't want displayed in a speedbar buffer.
It is generated from the variable `completion-ignored-extensions'")
+(defvar speedbar-file-regexp nil
+ "Regular expression matching files we know how to expand.
+Created from `speedbar-supported-extension-expressions' with the
+function `speedbar-extension-list-to-regex'")
+
;; this is dangerous to customize, because the defaults will probably
;; change in the future.
(defcustom speedbar-supported-extension-expressions
(append '(".[ch]\\(\\+\\+\\|pp\\|c\\|h\\|xx\\)?" ".tex\\(i\\(nfo\\)?\\)?"
".el" ".emacs" ".l" ".lsp" ".p" ".java" ".f\\(90\\|77\\|or\\)?")
(if speedbar-use-imenu-flag
- '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py"
+ '(".ada" ".p[lm]" ".tcl" ".m" ".scm" ".pm" ".py" ".g"
;; html is not supported by default, but an imenu tags package
;; is available. Also, html files are nice to be able to see.
".s?html"
- "[Mm]akefile\\(\\.in\\)?")))
+ ".ma?k" "[Mm]akefile\\(\\.in\\)?")))
"*List of regular expressions which will match files supported by tagging.
Do not prefix the `.' char with a double \\ to quote it, as the period
will be stripped by a simplified optimizer when compiled into a
`speedbar-file-regexp' for use with speedbar. You should use the
function `speedbar-add-supported-extension' to add a new extension at
runtime, or use the configuration dialog to set it in your .emacs
-file."
+file.
+If you add an extension to this list, and it does not appear, you may
+need to also modify `completion-ignored-extension' which will also help
+file completion."
:group 'speedbar
- :version "21.1"
:type '(repeat (regexp :tag "Extension Regexp"))
:set (lambda (sym val)
- (setq speedbar-supported-extension-expressions val
- speedbar-file-regexp (speedbar-extension-list-to-regex val)))
- )
+ (set 'speedbar-supported-extension-expressions val)
+ (set 'speedbar-file-regexp (speedbar-extension-list-to-regex val))))
-(defvar speedbar-file-regexp
- (speedbar-extension-list-to-regex speedbar-supported-extension-expressions)
- "Regular expression matching files we know how to expand.
-Created from `speedbar-supported-extension-expression' with the
-function `speedbar-extension-list-to-regex'")
+(setq speedbar-file-regexp
+ (speedbar-extension-list-to-regex speedbar-supported-extension-expressions))
(defun speedbar-add-supported-extension (extension)
"Add EXTENSION as a new supported extension for speedbar tagging.
the dot should NOT be quoted in with \\. Other regular expression
matchers are allowed however. EXTENSION may be a single string or a
list of strings."
- (interactive "sExtionsion: ")
+ (interactive "sExtension: ")
(if (not (listp extension)) (setq extension (list extension)))
(while extension
(if (member (car extension) speedbar-supported-extension-expressions)
(setq speedbar-file-regexp (speedbar-extension-list-to-regex
speedbar-supported-extension-expressions)))
-(defun speedbar-add-ignored-path-regexp (path-expression)
- "Add PATH-EXPRESSION as a new ignored path for speedbar tracking.
-This function will modify `speedbar-ignored-path-regexp' and add
-PATH-EXPRESSION to `speedbar-ignored-path-expressions'."
- (interactive "sPath regex: ")
- (if (not (listp path-expression))
- (setq path-expression (list path-expression)))
- (while path-expression
- (if (member (car path-expression) speedbar-ignored-path-expressions)
+(defun speedbar-add-ignored-directory-regexp (directory-expression)
+ "Add DIRECTORY-EXPRESSION as a new ignored directory for speedbar tracking.
+This function will modify `speedbar-ignored-directory-regexp' and add
+DIRECTORY-EXPRESSION to `speedbar-ignored-directory-expressions'."
+ (interactive "sDirectory regex: ")
+ (if (not (listp directory-expression))
+ (setq directory-expression (list directory-expression)))
+ (while directory-expression
+ (if (member (car directory-expression) speedbar-ignored-directory-expressions)
nil
- (setq speedbar-ignored-path-expressions
- (cons (car path-expression) speedbar-ignored-path-expressions)))
- (setq path-expression (cdr path-expression)))
- (setq speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
- speedbar-ignored-path-expressions)))
+ (setq speedbar-ignored-directory-expressions
+ (cons (car directory-expression) speedbar-ignored-directory-expressions)))
+ (setq directory-expression (cdr directory-expression)))
+ (setq speedbar-ignored-directory-regexp (speedbar-extension-list-to-regex
+ speedbar-ignored-directory-expressions)))
;; If we don't have custom, then we set it here by hand.
(if (not (fboundp 'custom-declare-variable))
(setq speedbar-file-regexp (speedbar-extension-list-to-regex
speedbar-supported-extension-expressions)
- speedbar-ignored-path-regexp (speedbar-extension-list-to-regex
- speedbar-ignored-path-expressions)))
-
-(defvar speedbar-update-flag (and
- (or (fboundp 'run-with-idle-timer)
- (fboundp 'start-itimer)
- (boundp 'post-command-idle-hook))
- (if (fboundp 'display-graphic-p)
- (display-graphic-p)
- window-system))
+ speedbar-ignored-directory-regexp (speedbar-extension-list-to-regex
+ speedbar-ignored-directory-expressions)))
+
+(defvar speedbar-update-flag dframe-have-timer-flag
"*Non-nil means to automatically update the display.
-When this is nil then speedbar will not follow the attached frame's path.
+When this is nil then speedbar will not follow the attached frame's directory.
When speedbar is active, use:
\\<speedbar-key-map> `\\[speedbar-toggle-updates]'
to toggle this value.")
+(defvar speedbar-update-flag-disable nil
+ "Permanently disable changing of the update flag.")
+
(defvar speedbar-syntax-table nil
"Syntax-table used on the speedbar.")
(suppress-keymap speedbar-key-map t)
;; control
- (define-key speedbar-key-map "g" 'speedbar-refresh)
(define-key speedbar-key-map "t" 'speedbar-toggle-updates)
- (define-key speedbar-key-map "q" 'speedbar-close-frame)
- (define-key speedbar-key-map "Q" 'delete-frame)
+ (define-key speedbar-key-map "g" 'speedbar-refresh)
;; navigation
(define-key speedbar-key-map "n" 'speedbar-next)
(define-key speedbar-key-map "\M-p" 'speedbar-restricted-prev)
(define-key speedbar-key-map "\C-\M-n" 'speedbar-forward-list)
(define-key speedbar-key-map "\C-\M-p" 'speedbar-backward-list)
- (define-key speedbar-key-map " " 'speedbar-scroll-up)
- (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
+;; These commands never seemed useful.
+;; (define-key speedbar-key-map " " 'speedbar-scroll-up)
+;; (define-key speedbar-key-map [delete] 'speedbar-scroll-down)
;; Short cuts I happen to find useful
(define-key speedbar-key-map "r"
(lambda () (interactive)
(speedbar-change-initial-expansion-list "files")))
- ;; Overrides
- (substitute-key-definition 'switch-to-buffer
- 'speedbar-switch-buffer-attached-frame
- speedbar-key-map global-map)
-
- (if speedbar-xemacsp
- (progn
- ;; mouse bindings so we can manipulate the items on each line
- (define-key speedbar-key-map 'button2 'speedbar-click)
- (define-key speedbar-key-map '(shift button2) 'speedbar-power-click)
- ;; Info doc fix from Bob Weiner
- (if (featurep 'infodoc)
- nil
- (define-key speedbar-key-map 'button3 'speedbar-xemacs-popup-kludge))
- (define-key speedbar-key-map '(meta button3) 'speedbar-mouse-item-info)
- )
-
- ;; mouse bindings so we can manipulate the items on each line
- (define-key speedbar-key-map [down-mouse-1] 'speedbar-double-click)
- (define-key speedbar-key-map [mouse-2] 'speedbar-click)
- ;; This is the power click for new frames, or refreshing a cache
- (define-key speedbar-key-map [S-mouse-2] 'speedbar-power-click)
- ;; This adds a small unecessary visual effect
- ;;(define-key speedbar-key-map [down-mouse-2] 'speedbar-quick-mouse)
- (define-key speedbar-key-map [M-mouse-2] 'speedbar-mouse-item-info)
-
- (define-key speedbar-key-map [down-mouse-3] 'speedbar-emacs-popup-kludge)
-
- ;; This lets the user scroll as if we had a scrollbar... well maybe not
- (define-key speedbar-key-map [mode-line mouse-2] 'speedbar-mouse-hscroll)
- ;; another handy place users might click to get our menu.
- (define-key speedbar-key-map [mode-line down-mouse-1]
- 'speedbar-emacs-popup-kludge)
-
- ;; We can't switch buffers with the buffer mouse menu. Lets hack it.
- (define-key speedbar-key-map [C-down-mouse-1] 'speedbar-hack-buffer-menu)
-
- ;; Lastly, we want to track the mouse. Play here
- (define-key speedbar-key-map [mouse-movement] 'speedbar-track-mouse)
- ))
+ (dframe-update-keymap speedbar-key-map)
+)
(defun speedbar-make-specialized-keymap ()
- "Create a keymap for use w/ a speedbar major or minor display mode.
+ "Create a keymap for use with a speedbar major or minor display mode.
This basically creates a sparse keymap, and makes it's parent be
`speedbar-key-map'."
(let ((k (make-sparse-keymap)))
(define-key speedbar-file-key-map "=" 'speedbar-expand-line)
(define-key speedbar-file-key-map "-" 'speedbar-contract-line)
+ (define-key speedbar-file-key-map "[" 'speedbar-expand-line-descendants)
+ (define-key speedbar-file-key-map "]" 'speedbar-contract-line-descendants)
+
+ (define-key speedbar-file-key-map " " 'speedbar-toggle-line-expansion)
+
;; file based commands
(define-key speedbar-file-key-map "U" 'speedbar-up-directory)
(define-key speedbar-file-key-map "I" 'speedbar-item-info)
(define-key speedbar-file-key-map "D" 'speedbar-item-delete)
(define-key speedbar-file-key-map "O" 'speedbar-item-object-delete)
(define-key speedbar-file-key-map "R" 'speedbar-item-rename)
+ (define-key speedbar-file-key-map "M" 'speedbar-create-directory)
)
(defvar speedbar-easymenu-definition-base
'("Speedbar"
["Update" speedbar-refresh t]
["Auto Update" speedbar-toggle-updates
+ :active (not speedbar-update-flag-disable)
:style toggle :selected speedbar-update-flag])
(if (and (or (fboundp 'defimage)
(fboundp 'make-image-specifier))
["Flush Cache & Expand" speedbar-flush-expand-line
(save-excursion (beginning-of-line)
(looking-at "[0-9]+: *.\\+. "))]
+ ["Expand All Descendants" speedbar-expand-line-descendants
+ (save-excursion (beginning-of-line)
+ (looking-at "[0-9]+: *.\\+. ")) ]
["Contract File Tags" speedbar-contract-line
(save-excursion (beginning-of-line)
(looking-at "[0-9]+: *.-. "))]
(save-excursion (beginning-of-line) (looking-at "[0-9]+: *\\["))]
["Rename File" speedbar-item-rename
(save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
+ ["Create Directory" speedbar-create-directory
+ (save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
["Delete File" speedbar-item-delete
(save-excursion (beginning-of-line) (looking-at "[0-9]+: *[[<]"))]
["Delete Object" speedbar-item-object-delete
(if (and (featurep 'custom) (fboundp 'custom-declare-variable))
(list ["Customize..." speedbar-customize t]))
(list
- ["Close" speedbar-close-frame t]
+ ["Detach" speedbar-detach (and speedbar-frame
+ (eq (selected-frame) speedbar-frame)) ]
+ ["Close" dframe-close-frame t]
["Quit" delete-frame t] ))
"Menu items appearing at the end of the speedbar menu.")
(defvar speedbar-desired-buffer nil
- "Non-nil when speedbar is showing buttons specific a special mode.
+ "Non-nil when speedbar is showing buttons specific to a special mode.
In this case it is the originating buffer.")
(defvar speedbar-buffer nil
"The buffer displaying the speedbar.")
"The frame that was last created, then removed from the display.")
(defvar speedbar-full-text-cache nil
"The last open directory is saved in its entirety for ultra-fast switching.")
-(defvar speedbar-timer nil
- "The speedbar timer used for updating the buffer.")
-(defvar speedbar-attached-frame nil
- "The frame which started speedbar mode.
-This is the frame from which all data displayed in the speedbar is
-gathered, and in which files and such are displayed.")
(defvar speedbar-last-selected-file nil
"The last file which was selected in speedbar buffer.")
\f
;;; Compatibility
;;
-(if (fboundp 'frame-parameter)
+(defalias 'speedbar-make-overlay
+ (if (featurep 'xemacs) 'make-extent 'make-overlay))
- (defalias 'speedbar-frame-parameter 'frame-parameter)
-
- (defun speedbar-frame-parameter (frame parameter)
- "Return FRAME's PARAMETER value."
- (cdr (assoc parameter (frame-parameters frame)))))
-
-(if (fboundp 'make-overlay)
- (progn
- (defalias 'speedbar-make-overlay 'make-overlay)
- (defalias 'speedbar-overlay-put 'overlay-put)
- (defalias 'speedbar-delete-overlay 'delete-overlay)
- (defalias 'speedbar-overlay-start 'overlay-start)
- (defalias 'speedbar-overlay-end 'overlay-end)
- (defalias 'speedbar-mode-line-update 'force-mode-line-update))
- (defalias 'speedbar-make-overlay 'make-extent)
- (defalias 'speedbar-overlay-put 'set-extent-property)
- (defalias 'speedbar-delete-overlay 'delete-extent)
- (defalias 'speedbar-overlay-start 'extent-start)
- (defalias 'speedbar-overlay-end 'extent-end)
- (defalias 'speedbar-mode-line-update 'redraw-modeline))
+(defalias 'speedbar-overlay-put
+ (if (featurep 'xemacs) 'set-extent-property 'overlay-put))
+
+(defalias 'speedbar-delete-overlay
+ (if (featurep 'xemacs) 'delete-extent 'delete-overlay))
+
+(defalias 'speedbar-mode-line-update
+ (if (featurep 'xemacs) 'redraw-modeline 'force-mode-line-update))
\f
;;; Mode definitions/ user commands
;;
`speedbar-before-popup-hook' is called before popping up the speedbar frame.
`speedbar-before-delete-hook' is called before the frame is deleted."
(interactive "P")
- ;; toggle frame on and off.
- (if (not arg) (if (and (frame-live-p speedbar-frame)
- (frame-visible-p speedbar-frame))
- (setq arg -1) (setq arg 1)))
- ;; turn the frame off on neg number
- (if (and (numberp arg) (< arg 0))
- (progn
- (run-hooks 'speedbar-before-delete-hook)
- (if (and speedbar-frame (frame-live-p speedbar-frame))
- (progn
- (setq speedbar-cached-frame speedbar-frame)
- (make-frame-invisible speedbar-frame)))
- (setq speedbar-frame nil)
- (speedbar-set-timer nil)
- ;; Used to delete the buffer. This has the annoying affect of
- ;; preventing whatever took its place from ever appearing
- ;; as the default after a C-x b was typed
- ;;(if (bufferp speedbar-buffer)
- ;; (kill-buffer speedbar-buffer))
- )
- ;; Set this as our currently attached frame
- (setq speedbar-attached-frame (selected-frame))
- (run-hooks 'speedbar-before-popup-hook)
- ;; Get the frame to work in
- (if (frame-live-p speedbar-cached-frame)
- (progn
- (setq speedbar-frame speedbar-cached-frame)
- (make-frame-visible speedbar-frame)
- ;; Get the buffer to play with
- (speedbar-mode)
- (select-frame speedbar-frame)
- (if (not (eq (current-buffer) speedbar-buffer))
- (switch-to-buffer speedbar-buffer))
- (set-window-dedicated-p (selected-window) t)
- (raise-frame speedbar-frame)
- (speedbar-set-timer speedbar-update-speed)
- )
- (if (frame-live-p speedbar-frame)
- (raise-frame speedbar-frame)
- (setq speedbar-frame
- (if speedbar-xemacsp
- ;; Only guess height if it is not specified.
- (if (member 'height speedbar-frame-plist)
- (make-frame speedbar-frame-plist)
- (make-frame (nconc (list 'height
- (speedbar-needed-height))
- speedbar-frame-plist)))
- (let* ((mh (speedbar-frame-parameter nil 'menu-bar-lines))
- (cfx (speedbar-frame-parameter nil 'left))
- (cfy (speedbar-frame-parameter nil 'top))
- (cfw (frame-pixel-width))
- (params
- ;; Only add a guessed height if one is not specified
- ;; in the input parameters.
- (if (assoc 'height speedbar-frame-parameters)
- speedbar-frame-parameters
- (append
- speedbar-frame-parameters
- (list (cons 'height (+ mh (frame-height)))))))
- (frame
- (if (or (< emacs-major-version 20)
- (not (eq window-system 'x)))
- (make-frame params)
- (let ((x-pointer-shape x-pointer-top-left-arrow)
- (x-sensitive-text-pointer-shape
- x-pointer-hand2))
- (make-frame params)))))
- ;; Position speedbar frame.
- (if (or (not window-system) (eq window-system 'pc)
- (assoc 'left speedbar-frame-parameters)
- (assoc 'top speedbar-frame-parameters))
- ;; Do no positioning if not on a windowing system,
- ;; or if left/top were specified in the parameters.
- frame
- (let ((cfx
- (if (not (consp cfx))
- cfx
- ;; If cfx is a list, that means we grow
- ;; from a specific edge of the display.
- ;; Convert that to the distance from the
- ;; left side of the display.
- (if (eq (car cfx) '-)
- ;; A - means distance from the right edge
- ;; of the display, or DW - cfx - framewidth
- (- (x-display-pixel-width) (car (cdr cfx))
- (frame-pixel-width))
- (car (cdr cfx))))))
- (modify-frame-parameters
- frame
- (list
- (cons
- 'left
- ;; Decide which side to put it
- ;; on. 200 is just a buffer
- ;; for the left edge of the
- ;; screen. The extra 10 is just
- ;; dressings for window decorations.
- (let ((sfw (frame-pixel-width frame)))
- (let ((left-guess (- cfx 10 sfw))
- (right-guess (+ cfx cfw 5)))
- (let ((left-margin left-guess)
- (right-margin
- (- (x-display-pixel-width)
- right-guess 5 sfw)))
- (cond ((>= left-margin 0) left-guess)
- ((>= right-margin 0) right-guess)
- ;; otherwise choose side we overlap less
- ((> left-margin right-margin) 0)
- (t (- (x-display-pixel-width) sfw 5)))))))
- (cons 'top cfy)))
- frame)))))
- ;; reset the selection variable
- (setq speedbar-last-selected-file nil)
- ;; Put the buffer into the frame
- (save-window-excursion
- ;; Get the buffer to play with
- (speedbar-mode)
- (select-frame speedbar-frame)
- (switch-to-buffer speedbar-buffer)
- (set-window-dedicated-p (selected-window) t))
- (if (and (or (null window-system) (eq window-system 'pc))
- (fboundp 'set-frame-name))
- (progn
- (select-frame speedbar-frame)
- (set-frame-name "Speedbar")))
- (speedbar-set-timer speedbar-update-speed)))))
+ ;; Get the buffer to play with
+ (if (not (buffer-live-p speedbar-buffer))
+ (save-excursion
+ (setq speedbar-buffer (get-buffer-create " SPEEDBAR"))
+ (set-buffer speedbar-buffer)
+ (speedbar-mode)))
+ ;; Do the frame thing
+ (dframe-frame-mode arg
+ 'speedbar-frame
+ 'speedbar-cached-frame
+ 'speedbar-buffer
+ "Speedbar"
+ #'speedbar-frame-mode
+ (if dframe-xemacsp
+ (append speedbar-frame-plist
+ ;; This is a hack to get speedbar to iconfiy
+ ;; with the selected frame.
+ (list 'parent (selected-frame)))
+ speedbar-frame-parameters)
+ speedbar-before-delete-hook
+ speedbar-before-popup-hook
+ speedbar-after-create-hook)
+ ;; Start up the timer
+ (if (not speedbar-frame)
+ (speedbar-set-timer nil)
+ (speedbar-reconfigure-keymaps)
+ (speedbar-update-contents)
+ (speedbar-set-timer dframe-update-speed)
+ )
+ ;; Frame modifications
+ (set (make-local-variable 'dframe-delete-frame-function)
+ 'speedbar-handle-delete-frame)
+ ;; hscroll
+ (set (make-local-variable 'automatic-hscrolling) nil) ; Emacs 21
+ ;; reset the selection variable
+ (setq speedbar-last-selected-file nil))
+
+(defun speedbar-frame-reposition-smartly ()
+ "Reposition the speedbar frame to be next to the attached frame."
+ (cond ((and dframe-xemacsp
+ (or (member 'left speedbar-frame-plist)
+ (member 'top speedbar-frame-plist)))
+ (dframe-reposition-frame
+ speedbar-frame
+ (dframe-attached-frame speedbar-frame)
+ (cons (car (cdr (member 'left speedbar-frame-plist)))
+ (car (cdr (member 'top speedbar-frame-plist)))))
+ )
+ ((and (not dframe-xemacsp)
+ (or (assoc 'left speedbar-frame-parameters)
+ (assoc 'top speedbar-frame-parameters)))
+ ;; if left/top were specified in the parameters, pass them
+ ;; down to the reposition function
+ (dframe-reposition-frame
+ speedbar-frame
+ (dframe-attached-frame speedbar-frame)
+ (cons (cdr (assoc 'left speedbar-frame-parameters))
+ (cdr (assoc 'top speedbar-frame-parameters))))
+ )
+ (t
+ (dframe-reposition-frame speedbar-frame
+ (dframe-attached-frame speedbar-frame)
+ speedbar-default-position))))
+
+(defun speedbar-detach ()
+ "Detach the current Speedbar from auto-updating.
+Doing this allows the creation of a second speedbar."
+ (interactive)
+ (let ((buffer speedbar-buffer))
+ (dframe-detach 'speedbar-frame 'speedbar-cached-frame 'speedbar-buffer)
+ (save-excursion
+ (set-buffer buffer)
+ ;; Permanently disable auto-updating in this speedbar buffer.
+ (set (make-local-variable 'speedbar-update-flag) nil)
+ (set (make-local-variable 'speedbar-update-flag-disable) t)
+ ;; Make local copies of all the different variables to prevent
+ ;; funny stuff later...
+ )))
+
+(defsubst speedbar-current-frame ()
+ "Return the frame to use for speedbar based on current context."
+ (dframe-current-frame 'speedbar-frame 'speedbar-mode))
+
+(defun speedbar-handle-delete-frame (e)
+ "Handle a delete frame event E.
+If the deleted frame is the frame SPEEDBAR is attached to,
+we need to delete speedbar also."
+ (let ((frame-to-be-deleted (car (car (cdr e)))))
+ (if (eq frame-to-be-deleted dframe-attached-frame)
+ (delete-frame speedbar-frame)))
+ )
;;;###autoload
(defun speedbar-get-focus ()
If the selected frame is not speedbar, then speedbar frame is
selected. If the speedbar frame is active, then select the attached frame."
(interactive)
- (if (eq (selected-frame) speedbar-frame)
- (if (frame-live-p speedbar-attached-frame)
- (select-frame speedbar-attached-frame))
- ;; If updates are off, then refresh the frame (they want it now...)
- (if (not speedbar-update-flag)
- (let ((speedbar-update-flag t))
- (speedbar-timer-fn)))
- ;; make sure we have a frame
- (if (not (frame-live-p speedbar-frame)) (speedbar-frame-mode 1))
- ;; go there
- (select-frame speedbar-frame)
- )
- (other-frame 0))
+ (speedbar-reset-scanners)
+ (dframe-get-focus 'speedbar-frame 'speedbar-frame-mode
+ (lambda () (let ((speedbar-update-flag t))
+ (speedbar-timer-fn)))))
-(defun speedbar-close-frame ()
- "Turn off a currently active speedbar."
- (interactive)
- (speedbar-frame-mode -1)
- (select-frame speedbar-attached-frame)
- (other-frame 0))
-
-(defun speedbar-switch-buffer-attached-frame (&optional buffer)
- "Switch to BUFFER in speedbar's attached frame, and raise that frame.
-This overrides the default behavior of `switch-to-buffer' which is
-broken because of the dedicated speedbar frame."
- (interactive)
- ;; Assume we are in the speedbar frame.
- (speedbar-get-focus)
- ;; Now switch buffers
- (if buffer
- (switch-to-buffer buffer)
- (call-interactively 'switch-to-buffer nil nil)))
-
-(defmacro speedbar-frame-width ()
+(defsubst speedbar-frame-width ()
"Return the width of the speedbar frame in characters.
nil if it doesn't exist."
- '(frame-width speedbar-frame))
-
-;; XEmacs function only.
-(defun speedbar-needed-height (&optional frame)
- "The needed height for the tool bar FRAME (in characters)."
- (or frame (setq frame (selected-frame)))
- ;; The 1 is the missing modeline/minibuffer
- (+ 1 (/ (frame-pixel-height frame)
- (face-height 'default frame))))
+ (frame-width speedbar-frame))
(defun speedbar-mode ()
"Major mode for managing a display of directories and tags.
\\<speedbar-key-map>
-The first line represents the default path of the speedbar frame.
+The first line represents the default directory of the speedbar frame.
Each directory segment is a button which jumps speedbar's default
-directory to that path. Buttons are activated by clicking `\\[speedbar-click]'.
-In some situations using `\\[speedbar-power-click]' is a `power click' which will
+directory to that directory. Buttons are activated by clicking `\\[speedbar-click]'.
+In some situations using `\\[dframe-power-click]' is a `power click' which will
rescan cached items, or pop up new frames.
Each line starting with <+> represents a directory. Click on the <+>
which is generated from `completion-ignored-extensions'.
Files with a `*' character after their name are files checked out of a
-version control system. (currently only RCS is supported.) New
+version control system. (Currently only RCS is supported.) New
version control systems can be added by examining the documentation
-for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'
+for `speedbar-this-file-in-vc' and `speedbar-vc-check-dir-p'.
Files with a `#' or `!' character after them are source files that
have an object file associated with them. The `!' indicates that the
-files is out of date. You can control what source/object associations
+files is out of date. You can control what source/object associations
exist through the variable `speedbar-obj-alist'.
Click on the [+] to display a list of tags from that file. Click on
\\{speedbar-key-map}"
;; NOT interactive
(save-excursion
- (setq speedbar-buffer (set-buffer (get-buffer-create " SPEEDBAR")))
(kill-all-local-variables)
(setq major-mode 'speedbar-mode)
(setq mode-name "Speedbar")
(setq font-lock-keywords nil) ;; no font-locking please
(setq truncate-lines t)
(make-local-variable 'frame-title-format)
- (setq frame-title-format "Speedbar")
- ;; Set this up special just for the speedbar buffer
- ;; Terminal minibuffer stuff does not require this.
- (if (and window-system (not (eq window-system 'pc))
- (null default-minibuffer-frame))
- (progn
- (make-local-variable 'default-minibuffer-frame)
- (setq default-minibuffer-frame speedbar-attached-frame)))
- ;; Correct use of `temp-buffer-show-function': Bob Weiner
- (if (and (boundp 'temp-buffer-show-hook)
- (boundp 'temp-buffer-show-function))
- (progn (make-local-variable 'temp-buffer-show-hook)
- (setq temp-buffer-show-hook temp-buffer-show-function)))
- (make-local-variable 'temp-buffer-show-function)
- (setq temp-buffer-show-function 'speedbar-temp-buffer-show-function)
- (if speedbar-xemacsp
- (progn
- ;; Argh! mouse-track-click-hook doesn't understand the
- ;; make-local-hook conventions.
- (make-local-variable 'mouse-track-click-hook)
- (add-hook 'mouse-track-click-hook
- (lambda (event count)
- (if (/= (event-button event) 1)
- nil ; Do normal operations.
- (cond ((eq count 1)
- (speedbar-quick-mouse event))
- ((or (eq count 2)
- (eq count 3))
- (speedbar-mouse-set-point event)
- (speedbar-do-function-pointer)
- (speedbar-quick-mouse event)))
- ;; Don't do normal operations.
- t)))))
- (make-local-hook 'kill-buffer-hook)
- (add-hook 'kill-buffer-hook (lambda () (let ((skilling (boundp 'skilling)))
- (if skilling
- nil
- (if (eq (current-buffer)
- speedbar-buffer)
- (speedbar-frame-mode -1)))))
- t t)
+ (setq frame-title-format (concat "Speedbar " speedbar-version))
+ (setq case-fold-search nil)
(toggle-read-only 1)
(speedbar-set-mode-line-format)
- (if speedbar-xemacsp
- (set (make-local-variable 'mouse-motion-handler)
- 'speedbar-track-mouse-xemacs)
- (if speedbar-track-mouse-flag
- (set (make-local-variable 'track-mouse) t)) ;this could be messy.
- (setq auto-show-mode nil)) ;no auto-show for Emacs
+ ;; Add in our dframe hooks.
+ (if speedbar-track-mouse-flag
+ (setq dframe-track-mouse-function #'speedbar-track-mouse))
+ (setq dframe-help-echo-function #'speedbar-item-info
+ dframe-mouse-click-function #'speedbar-click
+ dframe-mouse-position-function #'speedbar-position-cursor-on-line)
(run-hooks 'speedbar-mode-hook))
- (speedbar-update-contents)
speedbar-buffer)
-(defmacro speedbar-with-attached-buffer (&rest forms)
- "Execute FORMS in the attached frame's special buffer.
-Optionally select that frame if necessary."
- `(save-selected-window
- (speedbar-set-timer speedbar-update-speed)
- (select-frame speedbar-attached-frame)
- ,@forms
- (speedbar-maybee-jump-to-attached-frame)))
-
-(defun speedbar-message (fmt &rest args)
+(defmacro speedbar-message (fmt &rest args)
"Like message, but for use in the speedbar frame.
Argument FMT is the format string, and ARGS are the arguments for message."
- (save-selected-window
- (select-frame speedbar-attached-frame)
- (apply 'message fmt args)))
+ `(dframe-message ,fmt ,@args))
-(defun speedbar-y-or-n-p (prompt)
+(defsubst speedbar-y-or-n-p (prompt &optional deleting)
"Like `y-or-n-p', but for use in the speedbar frame.
-Argument PROMPT is the prompt to use."
- (save-selected-window
- (if (and default-minibuffer-frame (not (eq default-minibuffer-frame
- speedbar-attached-frame)))
- (select-frame speedbar-attached-frame))
- (y-or-n-p prompt)))
-
-(defun speedbar-show-info-under-mouse (&optional event)
- "Call the info function for the line under the mouse.
-Optional EVENT is currently not used."
- (let ((pos (mouse-position))) ; we ignore event until I use it later.
- (if (equal (car pos) speedbar-frame)
- (save-excursion
- (save-window-excursion
- (apply 'set-mouse-position pos)
- (speedbar-item-info))))))
-
+Argument PROMPT is the prompt to use.
+Optional argument DELETING means this is a query that will delete something.
+The variable `speedbar-query-confirmation-method' can cause this to
+return true without a query."
+ (or (and (not deleting)
+ (eq speedbar-query-confirmation-method 'none-but-delete))
+ (dframe-y-or-n-p prompt)))
+
+(defsubst speedbar-select-attached-frame ()
+ "Select the frame attached to this speedbar."
+ (dframe-select-attached-frame (speedbar-current-frame)))
+
+;; Backwards compatibility
+(defalias 'speedbar-with-attached-buffer 'dframe-with-attached-buffer)
+(defalias 'speedbar-maybee-jump-to-attached-frame 'dframe-maybee-jump-to-attached-frame)
+
(defun speedbar-set-mode-line-format ()
"Set the format of the mode line based on the current speedbar environment.
This gives visual indications of what is up. It EXPECTS the speedbar
frame and window to be the currently active frame and window."
- (if (and (frame-live-p speedbar-frame)
- (or (not speedbar-xemacsp)
- (specifier-instance has-modeline-p)))
+ (if (and (frame-live-p (speedbar-current-frame))
+ (or (not dframe-xemacsp)
+ (with-no-warnings
+ (specifier-instance has-modeline-p)))
+ speedbar-buffer)
(save-excursion
(set-buffer speedbar-buffer)
(let* ((w (or (speedbar-frame-width) 20))
(p1 "<<")
(p5 ">>")
- (p3 (if speedbar-update-flag "SPEEDBAR" "SLOWBAR"))
- (blank (- w (length p1) (length p3) (length p5)
- (if line-number-mode 4 0)))
+ (p3 (if speedbar-update-flag "#" "!"))
+ (p35 (capitalize speedbar-initial-expansion-list-name))
+ (blank (- w (length p1) (length p3) (length p5) (length p35)
+ (if line-number-mode 5 1)))
(p2 (if (> blank 0)
(make-string (/ blank 2) ? )
""))
""))
(tf
(if line-number-mode
- (list (concat p1 p2 p3) '(line-number-mode " %3l")
+ (list (concat p1 p2 p3 " " p35) '(line-number-mode " %3l")
(concat p4 p5))
(list (concat p1 p2 p3 p4 p5)))))
(if (not (equal mode-line-format tf))
(setq mode-line-format tf)
(speedbar-mode-line-update)))))))
-(defun speedbar-temp-buffer-show-function (buffer)
- "Placed in the variable `temp-buffer-show-function' in `speedbar-mode'.
-If a user requests help using \\[help-command] <Key> the temp BUFFER will be
-redirected into a window on the attached frame."
- (if speedbar-attached-frame (select-frame speedbar-attached-frame))
- (pop-to-buffer buffer nil)
- (other-window -1)
- ;; Fix for using this hook on some platforms: Bob Weiner
- (cond ((not speedbar-xemacsp)
- (run-hooks 'temp-buffer-show-hook))
- ((fboundp 'run-hook-with-args)
- (run-hook-with-args 'temp-buffer-show-hook buffer))
- ((and (boundp 'temp-buffer-show-hook)
- (listp temp-buffer-show-hook))
- (mapcar (function (lambda (hook) (funcall hook buffer)))
- temp-buffer-show-hook))))
-
(defvar speedbar-previous-menu nil
"The menu before the last `speedbar-reconfigure-keymaps' was called.")
;; file display mode version
(speedbar-initial-menu)
(save-excursion
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(if (local-variable-p
'speedbar-easymenu-definition-special
(current-buffer))
(list
'speedbar-change-initial-expansion-list
(car (car alist)))
- t)
+ :style 'radio
+ :selected
+ `(string= ,(car (car alist))
+ speedbar-initial-expansion-list-name)
+ )
displays))
(setq alist (cdr alist)))
displays)))
(localmap (save-excursion
(let ((cf (selected-frame)))
(prog2
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(if (local-variable-p
'speedbar-special-mode-key-map
(current-buffer))
(if speedbar-previous-menu (easy-menu-remove speedbar-previous-menu))
(setq speedbar-previous-menu md)
;; Now add the new menu
- (if (not speedbar-xemacsp)
+ (if (not dframe-xemacsp)
(easy-menu-define speedbar-menu-map (current-local-map)
"Speedbar menu" md)
(easy-menu-add md (current-local-map))
- (set-buffer-menubar (list md))))
+ ;; XEmacs-specific:
+ (if (fboundp 'set-buffer-menubar)
+ (set-buffer-menubar (list md)))))
+
(run-hooks 'speedbar-reconfigure-keymaps-hook)))
\f
;;; User Input stuff
;;
-
-;; XEmacs: this can be implemented using modeline keymaps, but there
-;; is no use, as we have horizontal scrollbar (as the docstring
-;; hints.)
-(defun speedbar-mouse-hscroll (e)
- "Read a mouse event E from the mode line, and horizontally scroll.
-If the mouse is being clicked on the far left, or far right of the
-mode-line. This is only useful for non-XEmacs"
- (interactive "e")
- (let* ((xp (car (nth 2 (car (cdr e)))))
- (cpw (/ (frame-pixel-width)
- (frame-width)))
- (oc (1+ (/ xp cpw)))
- )
- (cond ((< oc 3)
- (scroll-left 2))
- ((> oc (- (window-width) 3))
- (scroll-right 2))
- (t (speedbar-message
- "Click on the edge of the modeline to scroll left/right")))
- ;;(speedbar-message "X: Pixel %d Char Pixels %d On char %d" xp cpw oc)
- ))
-
(defun speedbar-customize ()
"Customize speedbar using the Custom package."
(interactive)
(let ((sf (selected-frame)))
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(customize-group 'speedbar)
(select-frame sf))
- (speedbar-maybee-jump-to-attached-frame))
+ (dframe-maybee-jump-to-attached-frame))
(defun speedbar-track-mouse (event)
"For motion EVENT, display info about the current line."
- (interactive "e")
(if (not speedbar-track-mouse-flag)
nil
(save-excursion
- (let ((char (nth 1 (car (cdr event)))))
- (if (not (numberp char))
- (speedbar-message nil)
- (goto-char char)
- ;; (speedbar-message "%S" event)
- (speedbar-item-info)
- )))))
-
-(defun speedbar-track-mouse-xemacs (event)
- "For motion EVENT, display info about the current line."
- (if (functionp (default-value 'mouse-motion-handler))
- (funcall (default-value 'mouse-motion-handler) event))
- (if speedbar-track-mouse-flag
- (save-excursion
- (save-window-excursion
- (condition-case ()
- (progn (mouse-set-point event)
- ;; Prevent focus-related bugs.
- (if (eq major-mode 'speedbar-mode)
- (speedbar-item-info)))
- (error nil))))))
-
-;; In XEmacs, we make popup menus work on the item over mouse (as
-;; opposed to where the point happens to be.) We attain this by
-;; temporarily moving the point to that place.
-;; Hrvoje Niksic <hniksic@srce.hr>
-(defun speedbar-xemacs-popup-kludge (event)
- "Pop up a menu related to the clicked on item.
-Must be bound to EVENT."
- (interactive "e")
- (select-frame speedbar-frame)
- (save-excursion
- (goto-char (event-closest-point event))
- (beginning-of-line)
- (forward-char (min 5 (- (save-excursion (end-of-line) (point))
- (save-excursion (beginning-of-line) (point)))))
- (popup-mode-menu)
- ;; Wait for menu to bail out. `popup-mode-menu' (and other popup
- ;; menu functions) return immediately.
- (let (new)
- (while (not (misc-user-event-p (setq new (next-event))))
- (dispatch-event new))
- (dispatch-event new))))
-
-(defun speedbar-emacs-popup-kludge (e)
- "Pop up a menu related to the clicked on item.
-Must be bound to event E."
- (interactive "e")
- (save-excursion
- (mouse-set-point e)
- ;; This gets the cursor where the user can see it.
- (if (not (bolp)) (forward-char -1))
- (sit-for 0)
- (if (< emacs-major-version 20)
- (mouse-major-mode-menu e)
- (mouse-major-mode-menu e nil))))
-
-(defun speedbar-hack-buffer-menu (e)
- "Control mouse 1 is buffer menu.
-This hack overrides it so that the right thing happens in the main
-Emacs frame, not in the speedbar frame.
-Argument E is the event causing this activity."
- (interactive "e")
- (let ((fn (lookup-key global-map (if speedbar-xemacsp
- '(control button1)
- [C-down-mouse-1])))
- (newbuff nil))
- (unwind-protect
+ (save-window-excursion
+ (condition-case nil
+ (progn
+ (mouse-set-point event)
+ (if (eq major-mode 'speedbar-mode)
+ ;; XEmacs may let us get in here in other mode buffers.
+ (speedbar-item-info)))
+ (t (speedbar-message nil)))))))
+
+(defun speedbar-show-info-under-mouse ()
+ "Call the info function for the line under the mouse.
+Optional EVENT is currently not used."
+ (let ((pos (mouse-position))) ; we ignore event until I use it later.
+ (if (equal (car pos) speedbar-frame)
(save-excursion
- (set-window-dedicated-p (selected-window) nil)
- (call-interactively fn)
- (setq newbuff (current-buffer)))
- (switch-to-buffer speedbar-buffer)
- (set-window-dedicated-p (selected-window) t))
- (if (not (eq newbuff speedbar-buffer))
- (speedbar-with-attached-buffer
- (switch-to-buffer newbuff)))))
+ (save-window-excursion
+ (apply 'set-mouse-position pos)
+ (speedbar-item-info))))))
(defun speedbar-next (arg)
"Move to the next ARGth line in a speedbar buffer."
;; First find the extent for which we are allowed to move.
(let ((depth (save-excursion (beginning-of-line)
(if (looking-at "[0-9]+:")
- (string-to-int (match-string 0))
+ (string-to-number (match-string 0))
0)))
- (crement (if (< arg 0) 1 -1)) ; decrement or increment
+ (crement (if (< arg 0) 1 -1)) ; decrement or increment
(lastmatch (point)))
(while (/= arg 0)
(forward-line (- crement))
(let ((subdepth (save-excursion (beginning-of-line)
- (if (looking-at "[0-9]+:")
- (string-to-int (match-string 0))
- 0))))
+ (if (looking-at "[0-9]+:")
+ (string-to-number (match-string 0))
+ 0))))
(cond ((or (< subdepth depth)
(progn (end-of-line) (eobp))
(progn (beginning-of-line) (bobp)))
(speedbar-restricted-move (or arg 1))
(speedbar-item-info))
-
(defun speedbar-restricted-prev (arg)
"Move to the previous ARGth line in a speedbar buffer at the same depth.
This means that movement is restricted to a subnode, and that siblings
(defun speedbar-up-directory ()
"Keyboard accelerator for moving the default directory up one.
-Assumes that the current buffer is the speedbar buffer"
+Assumes that the current buffer is the speedbar buffer."
(interactive)
(setq default-directory (expand-file-name (concat default-directory "../")))
(speedbar-update-contents))
\f
;;; Speedbar file activity (aka creeping featurism)
;;
-(defun speedbar-refresh ()
- "Refresh the current speedbar display, disposing of any cached data."
- (interactive)
+(defun speedbar-refresh (&optional arg)
+ "Refresh the current speedbar display, disposing of any cached data.
+Argument ARG represents to force a refresh past any caches that may exist."
+ (interactive "P")
(let ((dl speedbar-shown-directories)
- (dm (and (boundp 'deactivate-mark) deactivate-mark)))
+ (dframe-power-click arg)
+ deactivate-mark)
+ ;; We need to hack something so this works in detached frames.
(while dl
(adelete 'speedbar-directory-contents-alist (car dl))
(setq dl (cdr dl)))
(speedbar-update-contents)
(speedbar-stealthy-updates)
;; Reset the timer in case it got really hosed for some reason...
- (speedbar-set-timer speedbar-update-speed)
+ (speedbar-set-timer dframe-update-speed)
(if (<= 1 speedbar-verbosity-level)
- (speedbar-message "Refreshing speedbar...done"))
- (if (boundp 'deactivate-mark) (setq deactivate-mark dm))))
+ (speedbar-message "Refreshing speedbar...done"))))
(defun speedbar-item-load ()
"Load the item under the cursor or mouse if it is a Lisp file."
(sf (selected-frame)))
(if (and (file-exists-p f) (string-match "\\.el\\'" f))
(progn
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(byte-compile-file f nil)
(select-frame sf)
(speedbar-reset-scanners)))
(speedbar-item-info))
(defun speedbar-generic-item-info ()
- "Attempt to derive, and then display information about thils line item.
+ "Attempt to derive, and then display information about this line item.
File style information is displayed with `speedbar-item-info'."
(save-excursion
(beginning-of-line)
(defun speedbar-item-info ()
"Display info in the mini-buffer about the button the mouse is over.
This function can be replaced in `speedbar-mode-functions-list' as
-`speedbar-item-info'"
+`speedbar-item-info'."
(interactive)
(let (message-log-max)
(funcall (or (speedbar-fetch-replacement-function 'speedbar-item-info)
(beginning-of-line)
(if (re-search-forward " [-+=]?> \\([^\n]+\\)"
(save-excursion(end-of-line)(point)) t)
- (let ((tag (match-string 1))
+ (let* ((tag (match-string 1))
(attr (speedbar-line-token))
- (item nil))
- (if (and (featurep 'semantic) (semantic-token-p attr))
- (speedbar-message (semantic-summerize-nonterminal attr))
+ (item nil)
+ (semantic-tagged (if (fboundp 'semantic-tag-p)
+ (semantic-tag-p attr))))
+ (if semantic-tagged
+ (with-no-warnings
+ (save-excursion
+ (when (and (semantic-tag-overlay attr)
+ (semantic-tag-buffer attr))
+ (set-buffer (semantic-tag-buffer attr)))
+ (speedbar-message
+ (funcall semantic-sb-info-format-tag-function attr)
+ )))
(looking-at "\\([0-9]+\\):")
- (setq item (file-name-nondirectory (speedbar-line-path)))
+ (setq item (file-name-nondirectory (speedbar-line-directory)))
(speedbar-message "Tag: %s in %s" tag item)))
(if (re-search-forward "{[+-]} \\([^\n]+\\)$"
(save-excursion(end-of-line)(point)) t)
(if (re-search-forward " [+-]?[()|@] \\([^\n]+\\)$" nil t)
(let* ((detailtext (match-string 1))
(detail (or (speedbar-line-token) detailtext))
- (parent (save-excursion
- (beginning-of-line)
- (let ((dep (if (looking-at "[0-9]+:")
- (1- (string-to-int (match-string 0)))
- 0)))
- (re-search-backward (concat "^"
- (int-to-string dep)
- ":")
- nil t))
- (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$")
- (speedbar-line-token)
- nil))))
- (if (and (featurep 'semantic) (semantic-token-p detail))
- (speedbar-message
- (semantic-summerize-nonterminal detail parent))
+ (parent (save-excursion
+ (beginning-of-line)
+ (let ((dep (if (looking-at "[0-9]+:")
+ (1- (string-to-number (match-string 0)))
+ 0)))
+ (re-search-backward (concat "^"
+ (int-to-string dep)
+ ":")
+ nil t))
+ (if (looking-at "[0-9]+: +[-+=>]> \\([^\n]+\\)$")
+ (speedbar-line-token)
+ nil))))
+ (if (featurep 'semantic)
+ (with-no-warnings
+ (if (semantic-tag-p detail)
+ (speedbar-message
+ (funcall semantic-sb-info-format-tag-function detail parent))
+ (if parent
+ (speedbar-message "Detail: %s of tag %s" detail
+ (if (semantic-tag-p parent)
+ (semantic-format-tag-name parent nil t)
+ parent))
+ (speedbar-message "Detail: %s" detail))))
+ ;; Not using `semantic':
(if parent
- (speedbar-message "Detail: %s of tag %s" detail
- (if (and (featurep 'semantic)
- (semantic-token-p parent))
- (semantic-token-name parent)
- parent))
+ (speedbar-message "Detail: %s of tag %s" detail parent)
(speedbar-message "Detail: %s" detail))))
nil)))))
(if (string-match "[/\\]$" rt) "" "/")
(file-name-nondirectory f))))
(if (or (not (file-exists-p rt))
- (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
+ (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)
+ t))
(progn
(copy-file f rt t t)
;; refresh display if the new place is currently displayed.
(if (string-match "[/\\]\\'" rt) "" "/")
(file-name-nondirectory f))))
(if (or (not (file-exists-p rt))
- (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)))
+ (speedbar-y-or-n-p (format "Overwrite %s with %s? " rt f)
+ t))
(progn
(rename-file f rt t)
;; refresh display if the new place is currently displayed.
)))))
(error "Not a file"))))
+(defun speedbar-create-directory ()
+ "Create a directory in speedbar."
+ (interactive)
+ (let ((f (speedbar-line-file)))
+ (if f
+ (let* ((basedir (file-name-directory f))
+ (nd (read-file-name "Create directory: "
+ basedir)))
+ ;; Make the directory
+ (make-directory nd t)
+ (speedbar-refresh)
+ (speedbar-goto-this-file nd)
+ )
+ (error "Not a file"))))
+
(defun speedbar-item-delete ()
"Delete the item under the cursor. Files are removed from disk."
(interactive)
(let ((f (speedbar-line-file)))
(if (not f) (error "Not a file"))
- (if (speedbar-y-or-n-p (format "Delete %s? " f))
+ (if (speedbar-y-or-n-p (format "Delete %s? " f) t)
(progn
(if (file-directory-p f)
(delete-directory f)
(setq oa (cdr oa)))
(setq obj (concat (file-name-sans-extension f) (cdr (car oa))))
(if (and oa (file-exists-p obj)
- (speedbar-y-or-n-p (format "Delete %s? " obj)))
+ (speedbar-y-or-n-p (format "Delete %s? " obj) t))
(progn
(delete-file obj)
(speedbar-reset-scanners)))))
(interactive)
(setq speedbar-update-flag t)
(speedbar-set-mode-line-format)
- (speedbar-set-timer speedbar-update-speed))
+ (speedbar-set-timer dframe-update-speed))
(defun speedbar-disable-update ()
"Disable automatic updating and stop consuming resources."
(speedbar-enable-update)))
(defun speedbar-toggle-images ()
- "Toggle automatic update for the speedbar frame."
+ "Toggle use of images in the speedbar frame.
+Images are not available in Emacs 20 or earlier."
(interactive)
(setq speedbar-use-images (not speedbar-use-images))
(speedbar-refresh))
(defun speedbar-toggle-sorting ()
- "Toggle automatic update for the speedbar frame."
+ "Toggle tag sorting."
(interactive)
(setq speedbar-sort-tags (not speedbar-sort-tags)))
(interactive)
(setq speedbar-show-unknown-files (not speedbar-show-unknown-files))
(speedbar-refresh))
-\f
-;;; Utility functions
-;;
-(defun speedbar-set-timer (timeout)
- "Apply a timer with TIMEOUT, or remove a timer if TIMOUT is nil.
-TIMEOUT is the number of seconds until the speedbar timer is called
-again. When TIMEOUT is nil, turn off all timeouts.
-This function will also enable or disable the `vc-checkin-hook' used
-to track file check ins, and will change the mode line to match
-`speedbar-update-flag'."
- (cond
- ;; XEmacs
- (speedbar-xemacsp
- (if speedbar-timer
- (progn (delete-itimer speedbar-timer)
- (setq speedbar-timer nil)))
- (if timeout
- (if (and speedbar-xemacsp
- (or (>= emacs-major-version 20)
- (>= emacs-minor-version 15)))
- (setq speedbar-timer (start-itimer "speedbar"
- 'speedbar-timer-fn
- timeout
- timeout
- t))
- (setq speedbar-timer (start-itimer "speedbar"
- 'speedbar-timer-fn
- timeout
- nil)))))
- ;; Post 19.31 Emacs
- ((fboundp 'run-with-idle-timer)
- (if speedbar-timer
- (progn (cancel-timer speedbar-timer)
- (setq speedbar-timer nil)))
- (if timeout
- (setq speedbar-timer
- (run-with-idle-timer timeout t 'speedbar-timer-fn))))
- ;; Emacs 19.30 (Thanks twice: ptype@dra.hmg.gb)
- ((fboundp 'post-command-idle-hook)
- (if timeout
- (add-hook 'post-command-idle-hook 'speedbar-timer-fn)
- (remove-hook 'post-command-idle-hook 'speedbar-timer-fn)))
- ;; Older or other Emacsen with no timers. Set up so that its
- ;; obvious this emacs can't handle the updates
- (t
- (setq speedbar-update-flag nil)))
- ;; Apply a revert hook that will reset the scanners. We attach to revert
- ;; because most reverts occur during VC state change, and this lets our
- ;; VC scanner fix itself.
- (if timeout
- (add-hook 'after-revert-hook 'speedbar-reset-scanners)
- (remove-hook 'after-revert-hook 'speedbar-reset-scanners)
- )
- ;; change this if it changed for some reason
- (speedbar-set-mode-line-format))
(defmacro speedbar-with-writable (&rest forms)
"Allow the buffer to be writable and evaluate FORMS."
(cons 'progn forms)))
(put 'speedbar-with-writable 'lisp-indent-function 0)
-(defun speedbar-select-window (buffer)
- "Select a window in which BUFFER is shown.
-If it is not shown, force it to appear in the default window."
- (let ((win (get-buffer-window buffer speedbar-attached-frame)))
- (if win
- (select-window win)
- (set-window-buffer (selected-window) buffer))))
-
(defun speedbar-insert-button (text face mouse function
&optional token prevline)
"Insert TEXT as the next logical speedbar button.
This function assumes that the current buffer is the speedbar buffer.
If PREVLINE, then put this button on the previous line.
-This is a convenience function for special mode that create their own
+This is a convenience function for special modes that create their own
specialized speedbar displays."
(goto-char (point-max))
(let ((start (point)))
(speedbar-make-button start (point) face mouse function token))
(let ((start (point)))
(insert "\n")
- (put-text-property start (point) 'face nil)
- (put-text-property start (point) 'invisible nil)
- (put-text-property start (point) 'mouse-face nil)))
+ (add-text-properties
+ start (point) '(face nil invisible nil mouse-face nil))))
+
+(defun speedbar-insert-separator (text)
+ "Insert a separation label of TEXT.
+Separators are not active, have no labels, depth, or actions."
+ (if speedbar-use-images
+ (let ((start (point)))
+ (insert "//")
+ (speedbar-insert-image-button-maybe start 2)))
+ (let ((start (point)))
+ (insert text "\n")
+ (speedbar-make-button start (point)
+ 'speedbar-separator-face
+ nil nil nil)))
(defun speedbar-make-button (start end face mouse function &optional token)
"Create a button from START to END, with FACE as the display face.
MOUSE is the mouse face. When this button is clicked on FUNCTION
-will be run with the TOKEN parameter (any Lisp object)"
- (put-text-property start end 'face face)
- (put-text-property start end 'mouse-face mouse)
- (put-text-property start end 'invisible nil)
+will be run with the TOKEN parameter (any Lisp object). If FACE
+is t use the text properties of the string that is passed as an
+argument."
+ (unless (eq face t)
+ (put-text-property start end 'face face))
+ (add-text-properties
+ start end `(mouse-face ,mouse invisible nil
+ speedbar-text ,(buffer-substring-no-properties start end)))
+ (if speedbar-use-tool-tips-flag
+ (put-text-property start end 'help-echo #'dframe-help-echo))
(if function (put-text-property start end 'speedbar-function function))
(if token (put-text-property start end 'speedbar-token token))
;; So far the only text we have is less that 3 chars.
(setq speedbar-previously-used-expansion-list-name
speedbar-initial-expansion-list-name
speedbar-initial-expansion-list-name new-default)
- (speedbar-refresh)
- (speedbar-reconfigure-keymaps))
+ (if (and (speedbar-current-frame) (frame-live-p (speedbar-current-frame)))
+ (progn
+ (speedbar-refresh)
+ (speedbar-reconfigure-keymaps))))
(defun speedbar-fetch-replacement-function (function)
"Return a current mode specific replacement for function, or nil.
The car is the list of directories, the cdr is list of files not
matching ignored headers. Cache any directory files found in
`speedbar-directory-contents-alist' and use that cache before scanning
-the file-system"
+the file-system."
(setq directory (expand-file-name directory))
;; If in powerclick mode, then the directory we are getting
;; should be rescanned.
- (if speedbar-power-click
+ (if dframe-power-click
(adelete 'speedbar-directory-contents-alist directory))
;; find the directory, either in the cache, or build it.
(or (cdr-safe (assoc directory speedbar-directory-contents-alist))
(defun speedbar-directory-buttons (directory index)
"Insert a single button group at point for DIRECTORY.
-Each directory path part is a different button. If part of the path
+Each directory directory part is a different button. If part of the directory
matches the user directory ~, then it is replaced with a ~.
INDEX is not used, but is required by the caller."
(let* ((tilde (expand-file-name "~/"))
This is the button that expands or contracts a node (if applicable),
and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION
is the function to call if it's clicked on. Button types are
-'bracket, 'angle, 'curly, or nil. EXP-BUTTON-DATA is extra data
-attached to the text forming the expansion button.
+'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil.
+EXP-BUTTON-DATA is extra data attached to the text forming the expansion
+button.
Next, TAG-BUTTON is the text of the tag. TAG-BUTTON-FUNCTION is the
function to call if clicked on, and TAG-BUTTON-DATA is the data to
Lastly, DEPTH shows the depth of expansion.
This function assumes that the cursor is in the speedbar window at the
-position to insert a new item, and that the new item will end with a CR"
+position to insert a new item, and that the new item will end with a CR."
(let ((start (point))
(end (progn
(insert (int-to-string depth) ":")
(let* ((exp-button (cond ((eq exp-button-type 'bracket) "[%c]")
((eq exp-button-type 'angle) "<%c>")
((eq exp-button-type 'curly) "{%c}")
+ ((eq exp-button-type 'expandtag) " %c>")
+ ((eq exp-button-type 'statictag) " =>")
(t ">")))
(buttxt (format exp-button exp-button-char))
(start (point))
(end (progn (insert buttxt) (point)))
- (bf (if exp-button-type 'speedbar-button-face nil))
+ (bf (if (and exp-button-type (not (eq exp-button-type 'statictag)))
+ 'speedbar-button-face nil))
(mf (if exp-button-function 'speedbar-highlight-face nil))
)
(speedbar-make-button start end bf mf exp-button-function exp-button-data)
(if (re-search-forward ":\\s-*.\\([-+?]\\)" (save-excursion (end-of-line)
(point)) t)
(speedbar-with-writable
- (goto-char (match-beginning 1))
- (delete-char 1)
+ (goto-char (match-end 1))
(insert-char char 1 t)
- (put-text-property (point) (1- (point)) 'invisible nil)
+ (forward-char -1)
+ (delete-char -1)
+ ;;(put-text-property (point) (1- (point)) 'invisible nil)
;; make sure we fix the image on the text here.
- (speedbar-insert-image-button-maybe (- (point) 2) 3)))))
+ (speedbar-insert-image-button-maybe (- (point) 1) 3)))))
\f
;;; Build button lists
"Insert list of FILES starting at point, and indenting all files to LEVEL.
Tag expandable items with a +, otherwise a ?. Don't highlight ? as we
don't know how to manage them. The input parameter FILES is a cons
-cell of the form ( 'DIRLIST . 'FILELIST )"
+cell of the form ( 'DIRLIST . 'FILELIST )."
;; Start inserting all the directories
(let ((dirs (car files)))
(while dirs
(defun speedbar-default-directory-list (directory index)
"Insert files for DIRECTORY with level INDEX at point."
- (speedbar-insert-files-at-point
+ (speedbar-insert-files-at-point
(speedbar-file-lists directory) index)
(speedbar-reset-scanners)
(if (= index 0)
(if (looking-at "[0-9]+:[ ]*<")
(progn
(goto-char (match-end 0))
- (speedbar-do-function-pointer)))
- (setq sf (cdr sf)))))
+ (speedbar-do-function-pointer)))))
+ (setq sf (cdr sf)))
)))
+;;; Generic List support
+;;
+;; Generic lists are hierarchies of tags which we may need to permute
+;; in order to make it look nice.
+;;
+;; A generic list is of the form:
+;; ( ("name" . marker-or-number) <-- one tag at this level
+;; ("name" ("name" . mon) ("name" . mon) ) <-- one group of tags
+;; ("name" mon ("name" . mon) ) <-- group w/ a position and tags
+(defun speedbar-generic-list-group-p (sublst)
+ "Non-nil if SUBLST is a group.
+Groups may optionally contain a position."
+ (and (stringp (car-safe sublst))
+ (or (and (listp (cdr-safe sublst))
+ (or (speedbar-generic-list-tag-p (car-safe (cdr-safe sublst)))
+ (speedbar-generic-list-group-p (car-safe (cdr-safe sublst))
+ )))
+ (and (number-or-marker-p (car-safe (cdr-safe sublst)))
+ (listp (cdr-safe (cdr-safe sublst)))
+ (speedbar-generic-list-tag-p
+ (car-safe (cdr-safe (cdr-safe sublst)))))
+ )))
+
+(defun speedbar-generic-list-positioned-group-p (sublst)
+ "Non-nil of SUBLST is a group with a position."
+ (and (stringp (car-safe sublst))
+ (number-or-marker-p (car-safe (cdr-safe sublst)))
+ (listp (cdr-safe (cdr-safe sublst)))
+ (let ((rest (car-safe (cdr-safe (cdr-safe sublst)))))
+ (or (speedbar-generic-list-tag-p rest)
+ (speedbar-generic-list-group-p rest)
+ (speedbar-generic-list-positioned-group-p rest)
+ ))))
+
+(defun speedbar-generic-list-tag-p (sublst)
+ "Non nil if SUBLST is a tag."
+ (and (stringp (car-safe sublst))
+ (or (and (number-or-marker-p (cdr-safe sublst))
+ (not (cdr-safe (cdr-safe sublst))))
+ ;; For semantic/bovine items, this is needed
+ (symbolp (car-safe (cdr-safe sublst))))
+ ))
(defun speedbar-sort-tag-hierarchy (lst)
"Sort all elements of tag hierarchy LST."
(sort (copy-alist lst)
(lambda (a b) (string< (car a) (car b)))))
+(defun speedbar-try-completion (string alist)
+ "A wrapper for `try-completion'.
+Passes STRING and ALIST to `try-completion' if ALIST
+passes some tests."
+ (if (and (consp alist)
+ (listp (car alist)) (stringp (car (car alist))))
+ (try-completion string alist)
+ nil))
+
(defun speedbar-prefix-group-tag-hierarchy (lst)
"Prefix group names for tag hierarchy LST."
(let ((newlst nil)
(num-shorts-grouped 0)
(bins (make-vector 256 nil))
(diff-idx 0))
- ;; Break out sub-lists
- (while lst
- (if (and (listp (cdr-safe (car-safe lst)))
- ;; This one is for bovine tokens
- (not (symbolp (car-safe (cdr-safe (car-safe lst))))))
- (setq newlst (cons (car lst) newlst))
- (setq sublst (cons (car lst) sublst)))
- (setq lst (cdr lst)))
- ;; Reverse newlst because it was made backwards.
- ;; Sublist doesn't need reversing because the act
- ;; of binning things will reverse it for us.
- (setq newlst (nreverse newlst))
- ;; Now, first find out how long our list is. Never let a
- ;; list get-shorter than our minimum.
- (if (<= (length sublst) speedbar-tag-split-minimum-length)
- (setq work-list (nreverse sublst))
- (setq diff-idx (length (try-completion "" sublst)))
- ;; Sort the whole list into bins.
- (while sublst
- (let ((e (car sublst))
- (s (car (car sublst))))
- (cond ((<= (length s) diff-idx)
- ;; 0 storage bin for shorty.
- (aset bins 0 (cons e (aref bins 0))))
- (t
- ;; stuff into a bin based on ascii value at diff
- (aset bins (aref s diff-idx)
- (cons e (aref bins (aref s diff-idx)))))))
- (setq sublst (cdr sublst)))
- ;; Go through all our bins Stick singles into our
- ;; junk-list, everything else as sublsts in work-list.
- ;; If two neighboring lists are both small, make a grouped
- ;; group combinding those two sub-lists.
- (setq diff-idx 0)
- (while (> 256 diff-idx)
- (let ((l (nreverse;; Reverse the list since they are stuck in
- ;; backwards.
- (aref bins diff-idx))))
- (if l
- (let ((tmp (cons (try-completion "" l) l)))
- (if (or (> (length l) speedbar-tag-regroup-maximum-length)
- (> (+ (length l) (length short-group-list))
- speedbar-tag-split-minimum-length))
- (progn
- ;; We have reached a longer list, so we
- ;; must finish off a grouped group.
- (cond
- ((and short-group-list
- (= (length short-group-list)
- num-shorts-grouped))
- ;; All singles? Junk list
- (setq junk-list (append short-group-list
- junk-list)))
- ((= num-shorts-grouped 1)
- ;; Only one short group? Just stick it in
- ;; there by itself. Make a group, and find
- ;; a subexpression
- (let ((subexpression (try-completion
- "" short-group-list)))
- (if (< (length subexpression)
- speedbar-tag-group-name-minimum-length)
- (setq subexpression
- (concat short-start-name
- " ("
- (substring
- (car (car short-group-list))
- (length short-start-name))
- ")")))
+ (if (<= (length lst) speedbar-tag-regroup-maximum-length)
+ ;; Do nothing. Too short to bother with.
+ lst
+ ;; Break out sub-lists
+ (while lst
+ (if (speedbar-generic-list-group-p (car-safe lst))
+ (setq newlst (cons (car lst) newlst))
+ (setq sublst (cons (car lst) sublst)))
+ (setq lst (cdr lst)))
+ ;; Reverse newlst because it was made backwards.
+ ;; Sublist doesn't need reversing because the act
+ ;; of binning things will reverse it for us.
+ (setq newlst (nreverse newlst)
+ sublst sublst)
+ ;; Now, first find out how long our list is. Never let a
+ ;; list get-shorter than our minimum.
+ (if (<= (length sublst) speedbar-tag-split-minimum-length)
+ (setq work-list sublst)
+ (setq diff-idx (length (speedbar-try-completion "" sublst)))
+ ;; Sort the whole list into bins.
+ (while sublst
+ (let ((e (car sublst))
+ (s (car (car sublst))))
+ (cond ((<= (length s) diff-idx)
+ ;; 0 storage bin for shorty.
+ (aset bins 0 (cons e (aref bins 0))))
+ (t
+ ;; stuff into a bin based on ascii value at diff
+ (aset bins (aref s diff-idx)
+ (cons e (aref bins (aref s diff-idx)))))))
+ (setq sublst (cdr sublst)))
+ ;; Go through all our bins Stick singles into our
+ ;; junk-list, everything else as sublsts in work-list.
+ ;; If two neighboring lists are both small, make a grouped
+ ;; group combinding those two sub-lists.
+ (setq diff-idx 0)
+ (while (> 256 diff-idx)
+ ;; The bins contents are currently in forward order.
+ (let ((l (aref bins diff-idx)))
+ (if l
+ (let ((tmp (cons (speedbar-try-completion "" l) l)))
+ (if (or (> (length l) speedbar-tag-regroup-maximum-length)
+ (> (+ (length l) (length short-group-list))
+ speedbar-tag-split-minimum-length))
+ (progn
+ ;; We have reached a longer list, so we
+ ;; must finish off a grouped group.
+ (cond
+ ((and short-group-list
+ (= (length short-group-list)
+ num-shorts-grouped))
+ ;; All singles? Junk list
+ (setq junk-list (append (nreverse short-group-list)
+ junk-list)))
+ ((= num-shorts-grouped 1)
+ ;; Only one short group? Just stick it in
+ ;; there by itself. Make a group, and find
+ ;; a subexpression
+ (let ((subexpression (speedbar-try-completion
+ "" short-group-list)))
+ (if (< (length subexpression)
+ speedbar-tag-group-name-minimum-length)
+ (setq subexpression
+ (concat short-start-name
+ " ("
+ (substring
+ (car (car short-group-list))
+ (length short-start-name))
+ ")")))
+ (setq work-list
+ (cons (cons subexpression
+ short-group-list)
+ work-list ))))
+ (short-group-list
+ ;; Multiple groups to be named in a special
+ ;; way by displaying the range over which we
+ ;; have grouped them.
(setq work-list
- (cons (cons subexpression
+ (cons (cons (concat short-start-name
+ " to "
+ short-end-name)
short-group-list)
work-list))))
- (short-group-list
- ;; Multiple groups to be named in a special
- ;; way by displaying the range over which we
- ;; have grouped them.
- (setq work-list
- (cons (cons (concat short-start-name
- " to "
- short-end-name)
- (nreverse short-group-list))
- work-list))))
- ;; Reset short group list information every time.
- (setq short-group-list nil
- short-start-name nil
- short-end-name nil
- num-shorts-grouped 0)))
- ;; Ok, now that we cleaned up the short-group-list,
- ;; we can deal with this new list, to decide if it
- ;; should go on one of these sub-lists or not.
- (if (< (length l) speedbar-tag-regroup-maximum-length)
- (setq short-group-list (append short-group-list l)
- num-shorts-grouped (1+ num-shorts-grouped)
- short-end-name (car tmp)
- short-start-name (if short-start-name
- short-start-name
- (car tmp)))
- (setq work-list (cons tmp work-list))))))
- (setq diff-idx (1+ diff-idx))))
- ;; Did we run out of things? Drop our new list onto the end.
- (cond
- ((and short-group-list (= (length short-group-list) num-shorts-grouped))
- ;; All singles? Junk list
- (setq junk-list (append short-group-list junk-list)))
- ((= num-shorts-grouped 1)
- ;; Only one short group? Just stick it in
- ;; there by itself.
- (setq work-list
- (cons (cons (try-completion "" short-group-list)
- short-group-list)
- work-list)))
- (short-group-list
- ;; Multiple groups to be named in a special
- ;; way by displaying the range over which we
- ;; have grouped them.
- (setq work-list
- (cons (cons (concat short-start-name " to " short-end-name)
- short-group-list)
- work-list))))
- ;; Reverse the work list nreversed when consing.
- (setq work-list (nreverse work-list))
- ;; Now, stick our new list onto the end of
- (if work-list
- (if junk-list
- (append newlst work-list junk-list)
- (append newlst work-list))
- (append newlst junk-list))))
+ ;; Reset short group list information every time.
+ (setq short-group-list nil
+ short-start-name nil
+ short-end-name nil
+ num-shorts-grouped 0)))
+ ;; Ok, now that we cleaned up the short-group-list,
+ ;; we can deal with this new list, to decide if it
+ ;; should go on one of these sub-lists or not.
+ (if (< (length l) speedbar-tag-regroup-maximum-length)
+ (setq short-group-list (append l short-group-list)
+ num-shorts-grouped (1+ num-shorts-grouped)
+ short-end-name (car tmp)
+ short-start-name (if short-start-name
+ short-start-name
+ (car tmp)))
+ (setq work-list (cons tmp work-list))))))
+ (setq diff-idx (1+ diff-idx))))
+ ;; Did we run out of things? Drop our new list onto the end.
+ (cond
+ ((and short-group-list (= (length short-group-list) num-shorts-grouped))
+ ;; All singles? Junk list
+ (setq junk-list (append short-group-list junk-list)))
+ ((= num-shorts-grouped 1)
+ ;; Only one short group? Just stick it in
+ ;; there by itself.
+ (setq work-list
+ (cons (cons (speedbar-try-completion "" short-group-list)
+ short-group-list)
+ work-list)))
+ (short-group-list
+ ;; Multiple groups to be named in a special
+ ;; way by displaying the range over which we
+ ;; have grouped them.
+ (setq work-list
+ (cons (cons (concat short-start-name " to " short-end-name)
+ short-group-list)
+ work-list))))
+ ;; Reverse the work list nreversed when consing.
+ (setq work-list (nreverse work-list))
+ ;; Now, stick our new list onto the end of
+ (if work-list
+ (if junk-list
+ (append newlst work-list junk-list)
+ (append newlst work-list))
+ (append newlst junk-list)))))
(defun speedbar-trim-words-tag-hierarchy (lst)
"Trim all words in a tag hierarchy.
(trim-chars 0)
(trimlst nil))
(while lst
- (if (listp (cdr-safe (car-safe lst)))
+ (if (speedbar-generic-list-group-p (car-safe lst))
(setq newlst (cons (car lst) newlst))
(setq sublst (cons (car lst) sublst)))
(setq lst (cdr lst)))
;; Get the prefix to trim by. Make sure that we don't trim
;; off silly pieces, only complete understandable words.
- (setq trim-prefix (try-completion "" sublst))
+ (setq trim-prefix (speedbar-try-completion "" sublst)
+ newlst (nreverse newlst))
(if (or (= (length sublst) 1)
(not trim-prefix)
(not (string-match "\\(\\w+\\W+\\)+" trim-prefix)))
- (append (nreverse newlst) (nreverse sublst))
+ (append newlst (nreverse sublst))
(setq trim-prefix (substring trim-prefix (match-beginning 0)
(match-end 0)))
(setq trim-chars (length trim-prefix))
trimlst)
sublst (cdr sublst)))
;; Put the lists together
- (append (nreverse newlst) trimlst))))
+ (append newlst trimlst))))
(defun speedbar-simple-group-tag-hierarchy (lst)
"Create a simple 'Tags' group with orphaned tags.
(let ((newlst nil)
(sublst nil))
(while lst
- (if (listp (cdr-safe (car-safe lst)))
+ (if (speedbar-generic-list-group-p (car-safe lst))
(setq newlst (cons (car lst) newlst))
(setq sublst (cons (car lst) sublst)))
(setq lst (cdr lst)))
the list."
(let* ((f (save-excursion
(forward-line -1)
- (speedbar-line-path)))
+ (or (speedbar-line-file)
+ (speedbar-line-directory))))
(methods (if (get-file-buffer f)
(save-excursion (set-buffer (get-file-buffer f))
speedbar-tag-hierarchy-method)
methods (cdr methods)))
lst))
+(defvar speedbar-generic-list-group-expand-button-type 'curly
+ "The type of button created for groups of tags.
+Good values for this are `curly' and `expandtag'.
+Make buffer local for your mode.")
+
+(defvar speedbar-generic-list-tag-button-type nil
+ "The type of button created for tags in generic lists.
+Good values for this are nil and `statictag'.
+Make buffer local for your mode.")
+
(defun speedbar-insert-generic-list (level lst expand-fun find-fun)
"At LEVEL, insert a generic multi-level alist LST.
Associations with lists get {+} tags (to expand into more nodes) and
;; Remove imenu rescan button
(if (string= (car (car lst)) "*Rescan*")
(setq lst (cdr lst)))
- ;; Adjust the list.
- (setq lst (speedbar-create-tag-hierarchy lst))
- ;; insert the parts
- (while lst
- (cond ((null (car-safe lst)) nil) ;this would be a separator
- ((or (numberp (cdr-safe (car-safe lst)))
- (markerp (cdr-safe (car-safe lst))))
- (speedbar-make-tag-line nil nil nil nil ;no expand button data
- (car (car lst)) ;button name
- find-fun ;function
- (cdr (car lst)) ;token is position
- 'speedbar-tag-face
- (1+ level)))
- ((listp (cdr-safe (car-safe lst)))
- (speedbar-make-tag-line 'curly ?+ expand-fun (cdr (car lst))
- (car (car lst)) ;button name
- nil nil 'speedbar-tag-face
- (1+ level)))
- (t (speedbar-message "Ooops!")))
- (setq lst (cdr lst))))
+ ;; Get, and set up variables that define how we treat these tags.
+ (let ((f (save-excursion (forward-line -1)
+ (or (speedbar-line-file)
+ (speedbar-line-directory))))
+ expand-button tag-button)
+ (save-excursion
+ (if (get-file-buffer f)
+ (set-buffer (get-file-buffer f)))
+ (setq expand-button speedbar-generic-list-group-expand-button-type
+ tag-button speedbar-generic-list-tag-button-type))
+ ;; Adjust the list.
+ (setq lst (speedbar-create-tag-hierarchy lst))
+ ;; insert the parts
+ (while lst
+ (cond ((null (car-safe lst)) nil) ;this would be a separator
+ ((speedbar-generic-list-tag-p (car lst))
+ (speedbar-make-tag-line tag-button
+ nil nil nil ;no expand button data
+ (car (car lst)) ;button name
+ find-fun ;function
+ (cdr (car lst)) ;token is position
+ 'speedbar-tag-face
+ (1+ level)))
+ ((speedbar-generic-list-positioned-group-p (car lst))
+ (speedbar-make-tag-line expand-button
+ ?+ expand-fun (cdr (cdr (car lst)))
+ (car (car lst)) ;button name
+ find-fun ;function
+ (car (cdr (car lst))) ;token is posn
+ 'speedbar-tag-face
+ (1+ level)))
+ ((speedbar-generic-list-group-p (car lst))
+ (speedbar-make-tag-line expand-button
+ ?+ expand-fun (cdr (car lst))
+ (car (car lst)) ;button name
+ nil nil 'speedbar-tag-face
+ (1+ level)))
+ (t (speedbar-message "speedbar-insert-generic-list: malformed list!")
+ ))
+ (setq lst (cdr lst)))))
(defun speedbar-insert-imenu-list (indent lst)
"At level INDENT, insert the imenu generated LST."
(interactive)
;; Set the current special buffer
(setq speedbar-desired-buffer nil)
+
;; Check for special modes
(speedbar-maybe-add-localized-support (current-buffer))
+
;; Choose the correct method of doodling.
(if (and speedbar-mode-specific-contents-flag
- (listp speedbar-special-mode-expansion-list)
- speedbar-special-mode-expansion-list
+ (consp speedbar-special-mode-expansion-list)
(local-variable-p
'speedbar-special-mode-expansion-list
(current-buffer)))
(speedbar-update-special-contents)
(speedbar-update-directory-contents)))
+(defun speedbar-update-localized-contents ()
+ "Update the contents of the speedbar buffer for the current situation."
+ ;; Due to the historical growth of speedbar, we need to do something
+ ;; special for "files" mode. Too bad.
+ (let ((name speedbar-initial-expansion-list-name)
+ (funclst (speedbar-initial-expansion-list))
+ )
+ (if (string= name "files")
+ ;; Do all the files type work. It still goes through the
+ ;; expansion list stuff. :(
+ (if (or (member (expand-file-name default-directory)
+ speedbar-shown-directories)
+ (and speedbar-ignored-directory-regexp
+ (string-match
+ speedbar-ignored-directory-regexp
+ (expand-file-name default-directory))))
+ nil
+ (if (<= 1 speedbar-verbosity-level)
+ (speedbar-message "Updating speedbar to: %s..."
+ default-directory))
+ (speedbar-update-directory-contents)
+ (if (<= 1 speedbar-verbosity-level)
+ (progn
+ (speedbar-message "Updating speedbar to: %s...done"
+ default-directory)
+ (speedbar-message nil))))
+ ;; Else, we can do a short cut. No text cache.
+ (let ((cbd (expand-file-name default-directory))
+ )
+ (set-buffer speedbar-buffer)
+ (speedbar-with-writable
+ (let* ((window (get-buffer-window speedbar-buffer 0))
+ (p (window-point window))
+ (start (window-start window)))
+ (erase-buffer)
+ (dolist (func funclst)
+ (setq default-directory cbd)
+ (funcall func cbd 0))
+ (speedbar-reconfigure-keymaps)
+ (set-window-point window p)
+ (set-window-start window start)))
+ ))))
+
(defun speedbar-update-directory-contents ()
"Update the contents of the speedbar buffer based on the current directory."
- (let ((cbd (expand-file-name default-directory))
- cbd-parent
- (funclst (speedbar-initial-expansion-list))
- (cache speedbar-full-text-cache)
- ;; disable stealth during update
- (speedbar-stealthy-function-list nil)
- (use-cache nil)
- (expand-local nil)
- ;; Because there is a bug I can't find just yet
- (inhibit-quit nil))
- (save-excursion
+ (let ((cbd (expand-file-name default-directory))
+ cbd-parent
+ (funclst (speedbar-initial-expansion-list))
+ (cache speedbar-full-text-cache)
+ ;; disable stealth during update
+ (speedbar-stealthy-function-list nil)
+ (use-cache nil)
+ (expand-local nil)
+ ;; Because there is a bug I can't find just yet
+ (inhibit-quit nil))
(set-buffer speedbar-buffer)
;; If we are updating contents to where we are, then this is
;; really a request to update existing contents, so we must be
(setq expand-local t)
;; If this directory is NOT in the current list of available
- ;; paths, then use the cache, and set the cache to our new
+ ;; directorys, then use the cache, and set the cache to our new
;; value. Make sure to unhighlight the current file, or if we
;; come back to this directory, it might be a different file
;; and then we get a mess!
(speedbar-with-writable
(if (and expand-local
;; Find this directory as a speedbar node.
- (speedbar-path-line cbd))
+ (speedbar-directory-line cbd))
;; Open it.
(speedbar-expand-line)
- (erase-buffer)
- (cond (use-cache
- (setq default-directory
- (nth (1- (length speedbar-shown-directories))
- speedbar-shown-directories))
- (insert (cdr cache)))
- (t
- (while funclst
- (setq default-directory cbd)
- (funcall (car funclst) cbd 0)
- (setq funclst (cdr funclst))))))
- (goto-char (point-min)))))
+ (let* ((window (get-buffer-window speedbar-buffer 0))
+ (p (window-point window))
+ (start (window-start window)))
+ (erase-buffer)
+ (cond (use-cache
+ (setq default-directory
+ (nth (1- (length speedbar-shown-directories))
+ speedbar-shown-directories))
+ (insert (cdr cache)))
+ (t
+ (dolist (func funclst)
+ (setq default-directory cbd)
+ (funcall func cbd 0))))
+ (set-window-point window p)
+ (set-window-start window start)))))
(speedbar-reconfigure-keymaps))
(defun speedbar-update-special-contents ()
- "Used the mode-specific variable to fill in the speedbar buffer.
+ "Use the mode-specific variable to fill in the speedbar buffer.
This should only be used by modes classified as special."
(let ((funclst speedbar-special-mode-expansion-list)
(specialbuff (current-buffer)))
speedbar-shown-directories nil))
;; Now fill in the buffer with our newly found specialized list.
(speedbar-with-writable
- (while funclst
- ;; We do not erase the buffer because these functions may
- ;; decide NOT to update themselves.
- (funcall (car funclst) specialbuff)
- (setq funclst (cdr funclst))))
- (goto-char (point-min))))
+ (dolist (func funclst)
+ ;; We do not erase the buffer because these functions may
+ ;; decide NOT to update themselves.
+ (funcall func specialbuff)))))
(speedbar-reconfigure-keymaps))
+(defun speedbar-set-timer (timeout)
+ "Set up the speedbar timer with TIMEOUT.
+Uses `dframe-set-timer'.
+Also resets scanner functions."
+ (dframe-set-timer timeout 'speedbar-timer-fn 'speedbar-update-flag)
+ ;; Apply a revert hook that will reset the scanners. We attach to revert
+ ;; because most reverts occur during VC state change, and this lets our
+ ;; VC scanner fix itself.
+ (if timeout
+ (add-hook 'after-revert-hook 'speedbar-reset-scanners)
+ (remove-hook 'after-revert-hook 'speedbar-reset-scanners))
+ ;; change this if it changed for some reason
+ (speedbar-set-mode-line-format))
+
(defun speedbar-timer-fn ()
"Run whenever Emacs is idle to update the speedbar item."
- (if (not (and (frame-live-p speedbar-frame)
- (frame-live-p speedbar-attached-frame)))
+ (if (or (not (speedbar-current-frame))
+ (not (frame-live-p (speedbar-current-frame))))
(speedbar-set-timer nil)
;; Save all the match data so that we don't mess up executing fns
(save-match-data
;; Only do stuff if the frame is visible, not an icon, and if
;; it is currently flagged to do something.
(if (and speedbar-update-flag
- (frame-visible-p speedbar-frame)
- (not (eq (frame-visible-p speedbar-frame) 'icon)))
+ (speedbar-current-frame)
+ (frame-visible-p (speedbar-current-frame))
+ (not (eq (frame-visible-p (speedbar-current-frame)) 'icon)))
(let ((af (selected-frame)))
(save-window-excursion
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
;; make sure we at least choose a window to
;; get a good directory from
(if (window-minibuffer-p (selected-window))
(speedbar-maybe-add-localized-support (current-buffer))
;; Update for special mode all the time!
(if (and speedbar-mode-specific-contents-flag
- (listp speedbar-special-mode-expansion-list)
- speedbar-special-mode-expansion-list
+ (consp speedbar-special-mode-expansion-list)
(local-variable-p
'speedbar-special-mode-expansion-list
(current-buffer)))
major-mode)
(speedbar-message nil))))
;; Update all the contents if directories change!
- (if (or (member (expand-file-name default-directory)
- speedbar-shown-directories)
- (and speedbar-ignored-path-regexp
- (string-match
- speedbar-ignored-path-regexp
- (expand-file-name default-directory)))
- (member major-mode speedbar-ignored-modes)
- (eq af speedbar-frame)
+ (if (or (member major-mode speedbar-ignored-modes)
+ (eq af (speedbar-current-frame))
(not (buffer-file-name)))
nil
- (if (<= 1 speedbar-verbosity-level)
- (speedbar-message "Updating speedbar to: %s..."
- default-directory))
- (speedbar-update-directory-contents)
- (if (<= 1 speedbar-verbosity-level)
- (progn
- (speedbar-message "Updating speedbar to: %s...done"
- default-directory)
- (speedbar-message nil)))))
+ (speedbar-update-localized-contents)
+ ))
(select-frame af)))
;; Now run stealthy updates of time-consuming items
- (speedbar-stealthy-updates)))
- ;; Now run the mouse tracking system
- (speedbar-show-info-under-mouse)))
+ (speedbar-stealthy-updates)))))
(run-hooks 'speedbar-timer-hook))
\f
"Reset any variables used by functions in the stealthy list as state.
If new functions are added, their state needs to be updated here."
(setq speedbar-vc-to-do-point t
- speedbar-obj-to-do-point t)
+ speedbar-obj-to-do-point t
+ speedbar-ro-to-do-point t)
(run-hooks 'speedbar-scanner-reset-hook)
)
(defun speedbar-find-selected-file (file)
- "Goto the line where FILE is."
+ "Go to the line where FILE is."
+
+ (set-buffer speedbar-buffer)
+
(goto-char (point-min))
(let ((m nil))
(while (and (setq m (re-search-forward
nil t))
(not (string= file
(concat
- (speedbar-line-path
+ (speedbar-line-directory
(save-excursion
(goto-char (match-beginning 0))
(beginning-of-line)
(defun speedbar-clear-current-file ()
"Locate the file thought to be current, and remove its highlighting."
(save-excursion
- (set-buffer speedbar-buffer)
+ ;;(set-buffer speedbar-buffer)
(if speedbar-last-selected-file
(speedbar-with-writable
(if (speedbar-find-selected-file speedbar-last-selected-file)
updated."
(let* ((lastf (selected-frame))
(newcfd (save-excursion
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(let ((rf (if (buffer-file-name)
(buffer-file-name)
nil)))
;; It is important to select the frame, otherwise the window
;; we want the cursor to move in will not be updated by the
;; search-forward command.
- (select-frame speedbar-frame)
+ (select-frame (speedbar-current-frame))
;; Remove the old file...
(speedbar-clear-current-file)
;; now highlight the new one.
- (set-buffer speedbar-buffer)
+ ;; (set-buffer speedbar-buffer)
(speedbar-with-writable
(if (speedbar-find-selected-file newcf)
;; put the property on it
(setq speedbar-last-selected-file newcf))
(if (not sucf-recursive)
(progn
- (speedbar-center-buffer-smartly)
+
+ ;;Sat Dec 15 2001 12:40 AM (burton@openprivacy.org): this
+ ;;doesn't need to be in. We don't want to recenter when we are
+ ;;updating files.
+
+ ;;(speedbar-center-buffer-smartly)
+
(speedbar-position-cursor-on-line)
))
(set-buffer lastb)
(defun speedbar-add-indicator (indicator-string &optional replace-this)
"Add INDICATOR-STRING to the end of this speedbar line.
If INDICATOR-STRING is space, and REPLACE-THIS is a character, then
-an the existing indicator is removed. If there is already an
+the existing indicator is removed. If there is already an
indicator, then do not add a space."
(beginning-of-line)
;; The nature of the beast: Assume we are in "the right place"
(end-of-line)
(skip-chars-backward (concat " " speedbar-vc-indicator
+ speedbar-object-read-only-indicator
(car speedbar-obj-indicator)
(cdr speedbar-obj-indicator)))
(if (and (not (looking-at speedbar-indicator-regex))
(delete-region (match-beginning 0) (match-end 0))))
(end-of-line)
(if (not (string= " " indicator-string))
- (insert indicator-string))))
+ (let ((start (point)))
+ (insert indicator-string)
+ (speedbar-insert-image-button-maybe start (length indicator-string))
+ ))))
+
+(defun speedbar-check-read-only ()
+ "Scan all the files in a directory, and for each see if it is read only."
+ ;; Check for to-do to be reset. If reset but no RCS is available
+ ;; then set to nil (do nothing) otherwise, start at the beginning
+ (save-excursion
+ (if speedbar-buffer (set-buffer speedbar-buffer))
+ (if (eq speedbar-ro-to-do-point t)
+ (setq speedbar-ro-to-do-point 0))
+ (if (numberp speedbar-ro-to-do-point)
+ (progn
+ (goto-char speedbar-ro-to-do-point)
+ (while (and (not (input-pending-p))
+ (re-search-forward "^\\([0-9]+\\):\\s-*[[<][+-\?][]>] "
+ nil t))
+ (setq speedbar-ro-to-do-point (point))
+ (let ((f (speedbar-line-file)))
+ (if f
+ (if (not (file-writable-p f))
+ (speedbar-add-indicator
+ speedbar-object-read-only-indicator
+ (regexp-quote speedbar-object-read-only-indicator))
+ (speedbar-add-indicator
+ " " (regexp-quote
+ speedbar-object-read-only-indicator))))))
+ (if (input-pending-p)
+ ;; return that we are incomplete
+ nil
+ ;; we are done, set to-do to nil
+ (setq speedbar-ro-to-do-point nil)
+ ;; and return t
+ t))
+ t)))
;; Load efs/ange-ftp only if compiling to remove byte-compiler warnings.
;; Steven L Baur <steve@xemacs.org> said this was important:
;; Check for to-do to be reset. If reset but no RCS is available
;; then set to nil (do nothing) otherwise, start at the beginning
(save-excursion
- (set-buffer speedbar-buffer)
+ (if speedbar-buffer (set-buffer speedbar-buffer))
(if (and speedbar-vc-do-check (eq speedbar-vc-to-do-point t)
(speedbar-vc-check-dir-p default-directory)
(not (or (and (featurep 'ange-ftp)
(string-match
- (car (if speedbar-xemacsp
- ange-ftp-path-format
- ange-ftp-name-format))
+ (car (symbol-value
+ (if dframe-xemacsp
+ 'ange-ftp-directory-format
+ 'ange-ftp-name-format)))
(expand-file-name default-directory)))
;; efs support: Bob Weiner
(and (featurep 'efs)
(string-match
- (car efs-path-regexp)
+ (let ((reg (symbol-value 'efs-directory-regexp)))
+ (if (stringp reg)
+ reg
+ (car reg)))
(expand-file-name default-directory))))))
(setq speedbar-vc-to-do-point 0))
(if (numberp speedbar-vc-to-do-point)
(progn
(goto-char speedbar-vc-to-do-point)
(while (and (not (input-pending-p))
- (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-]\\] "
+ (re-search-forward "^\\([0-9]+\\):\\s-*\\[[+-?]\\] "
nil t))
(setq speedbar-vc-to-do-point (point))
(if (speedbar-check-vc-this-line (match-string 1))
"Return t if the file on this line is check of of a version control system.
Parameter DEPTH is a string with the current depth of indentation of
the file being checked."
- (let* ((d (string-to-int depth))
- (f (speedbar-line-path d))
+ (let* ((d (string-to-number depth))
+ (f (speedbar-line-directory d))
(fn (buffer-substring-no-properties
;; Skip-chars: thanks ptype@dra.hmg.gb
(point) (progn
(and (file-writable-p fulln)
(speedbar-this-file-in-vc f fn))))
-(defun speedbar-vc-check-dir-p (path)
- "Return t if we should bother checking PATH for version control files.
+(defun speedbar-vc-check-dir-p (directory)
+ "Return t if we should bother checking DIRECTORY for version control files.
This can be overloaded to add new types of version control systems."
(or
+ ;; Local CVS available in Emacs 21
+ (and (fboundp 'vc-state)
+ (file-exists-p (concat directory "CVS/")))
;; Local RCS
- (file-exists-p (concat path "RCS/"))
+ (file-exists-p (concat directory "RCS/"))
;; Local SCCS
- (file-exists-p (concat path "SCCS/"))
+ (file-exists-p (concat directory "SCCS/"))
;; Remote SCCS project
(let ((proj-dir (getenv "PROJECTDIR")))
(if proj-dir
(file-exists-p (concat proj-dir "/SCCS"))
nil))
;; User extension
- (run-hook-with-args 'speedbar-vc-path-enable-hook path)
+ (run-hook-with-args-until-success 'speedbar-vc-directory-enable-hook
+ directory)
))
-(defun speedbar-this-file-in-vc (path name)
- "Check to see if the file in PATH with NAME is in a version control system.
+(defun speedbar-this-file-in-vc (directory name)
+ "Check to see if the file in DIRECTORY with NAME is in a version control system.
You can add new VC systems by overriding this function. You can
optimize this function by overriding it and only doing those checks
that will occur on your system."
(or
- ;; RCS file name
- (file-exists-p (concat path "RCS/" name ",v"))
- (file-exists-p (concat path "RCS/" name))
- ;; Local SCCS file name
- (file-exists-p (concat path "SCCS/s." name))
- ;; Remote SCCS file name
- (let ((proj-dir (getenv "PROJECTDIR")))
- (if proj-dir
- (file-exists-p (concat proj-dir "/SCCS/s." name))
- nil))
+ (if (fboundp 'vc-state)
+ ;; Emacs 21 handles VC state in a nice way.
+ (condition-case nil
+ (let ((state (vc-state (concat directory name))))
+ (not (or (eq 'up-to-date state)
+ (null state))))
+ ;; An error means not in a VC system
+ (error nil))
+ (or
+ ;; RCS file name
+ (file-exists-p (concat directory "RCS/" name ",v"))
+ (file-exists-p (concat directory "RCS/" name))
+ ;; Local SCCS file name
+ (file-exists-p (concat directory "SCCS/s." name))
+ ;; Remote SCCS file name
+ (let ((proj-dir (getenv "PROJECTDIR")))
+ (if proj-dir
+ (file-exists-p (concat proj-dir "/SCCS/s." name))
+ nil))))
;; User extension
- (run-hook-with-args 'speedbar-vc-in-control-hook path name)
+ (run-hook-with-args 'speedbar-vc-in-control-hook directory name)
))
;; Objet File scanning
;; Check for to-do to be reset. If reset but no RCS is available
;; then set to nil (do nothing) otherwise, start at the beginning
(save-excursion
- (set-buffer speedbar-buffer)
+ (if speedbar-buffer (set-buffer speedbar-buffer))
(if (and speedbar-obj-do-check (eq speedbar-obj-to-do-point t))
(setq speedbar-obj-to-do-point 0))
(if (numberp speedbar-obj-to-do-point)
"Return t if the file on this line has an associated object.
Parameter DEPTH is a string with the current depth of indentation of
the file being checked."
- (let* ((d (string-to-int depth))
- (f (speedbar-line-path d))
+ (let* ((d (string-to-number depth))
+ (f (speedbar-line-directory d))
(fn (buffer-substring-no-properties
;; Skip-chars: thanks ptype@dra.hmg.gb
(point) (progn
\f
;;; Clicking Activity
;;
-(defun speedbar-mouse-set-point (e)
- "Set POINT based on event E.
-Handle clicking on images in XEmacs."
- (if (and (fboundp 'event-over-glyph-p) (event-over-glyph-p e))
- ;; We are in XEmacs, and clicked on a picture
- (let ((ext (event-glyph-extent e)))
- ;; This position is back inside the extent where the
- ;; junk we pushed into the property list lives.
- (if (extent-end-position ext)
- (goto-char (1- (extent-end-position ext)))
- (mouse-set-point e)))
- ;; We are not in XEmacs, OR we didn't click on a picture.
- (mouse-set-point e)))
-
-(defun speedbar-quick-mouse (e)
- "Since mouse events are strange, this will keep the mouse nicely positioned.
-This should be bound to mouse event E."
- (interactive "e")
- (speedbar-mouse-set-point e)
- (speedbar-position-cursor-on-line)
- )
-
(defun speedbar-position-cursor-on-line ()
"Position the cursor on a line."
(let ((oldpos (point)))
(goto-char (1- (match-end 0)))
(goto-char oldpos))))
-(defun speedbar-power-click (e)
- "Activate any speedbar button as a power click.
-A power click will dispose of cached data (if available) or bring a buffer
-up into a different window.
-This should be bound to mouse event E."
- (interactive "e")
- (let ((speedbar-power-click t))
- (speedbar-click e)))
-
(defun speedbar-click (e)
"Activate any speedbar buttons where the mouse is clicked.
This must be bound to a mouse event. A button is any location of text
with a mouse face that has a text property called `speedbar-function'.
-This should be bound to mouse event E."
- (interactive "e")
- (speedbar-mouse-set-point e)
- (speedbar-do-function-pointer)
- (speedbar-quick-mouse e))
-
-(defun speedbar-double-click (e)
- "Activate any speedbar buttons where the mouse is clicked.
-This must be bound to a mouse event. A button is any location of text
-with a mouse face that has a text property called `speedbar-function'.
-This should be bound to mouse event E."
- (interactive "e")
- ;; Emacs only. XEmacs handles this via `mouse-track-click-hook'.
- (cond ((eq (car e) 'down-mouse-1)
- (speedbar-mouse-set-point e))
- ((eq (car e) 'mouse-1)
- (speedbar-quick-mouse e))
- ((or (eq (car e) 'double-down-mouse-1)
- (eq (car e) 'triple-down-mouse-1))
- (speedbar-mouse-set-point e)
- (speedbar-do-function-pointer)
- (speedbar-quick-mouse e))))
+Argument E is the click event."
+ ;; Backward compatibility let statement.
+ (let ((speedbar-power-click dframe-power-click))
+ (speedbar-do-function-pointer))
+ (dframe-quick-mouse e))
(defun speedbar-do-function-pointer ()
"Look under the cursor and examine the text properties.
From this extract the file/tag name, token, indentation level and call
-a function if appropriate"
- (let* ((fn (get-text-property (point) 'speedbar-function))
+a function if appropriate."
+ (let* ((speedbar-frame (speedbar-current-frame))
+ (fn (get-text-property (point) 'speedbar-function))
(tok (get-text-property (point) 'speedbar-token))
;; The 1-,+ is safe because scaning starts AFTER the point
;; specified. This lets the search include the character the
(if p (goto-char p))
(beginning-of-line)
(if (looking-at (concat
- "\\([0-9]+\\): *[[<{][-+?][]>}] \\([^ \n]+\\)\\("
- speedbar-indicator-regex "\\)?"))
- (match-string 2)
+ "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)"))
+ (get-text-property (match-beginning 2) 'speedbar-text)
nil)))
(defun speedbar-line-token (&optional p)
(if p (goto-char p))
(beginning-of-line)
(if (looking-at (concat
- "\\([0-9]+\\): *[[<{]?[-+?=][]>}@()|] \\([^ \n]+\\)\\("
+ "\\([0-9]+\\): *[[<{]?[-+?= ][]>}@()|] \\([^ \n]+\\)\\("
speedbar-indicator-regex "\\)?"))
(progn
(goto-char (match-beginning 2))
nil)))
(defun speedbar-line-file (&optional p)
- "Retrieve the file or whatever from the line at P point.
+ "Retrieve the file or whatever from the line at point P.
The return value is a string representing the file. If it is a
directory, then it is the directory name."
(save-match-data
- (let ((f (speedbar-line-text p)))
- (if f
- (let* ((depth (string-to-int (match-string 1)))
- (path (speedbar-line-path depth)))
- (if (file-exists-p (concat path f))
- (concat path f)
- nil))
- nil))))
+ (save-restriction
+ (widen)
+ (let ((f (speedbar-line-text p)))
+ (if f
+ (let* ((depth (string-to-number (match-string 1)))
+ (directory (speedbar-line-directory depth)))
+ (if (file-exists-p (concat directory f))
+ (concat directory f)
+ nil))
+ nil)))))
(defun speedbar-goto-this-file (file)
- "If FILE is displayed, goto this line and return t.
+ "If FILE is displayed, go to this line and return t.
Otherwise do not move and return nil."
- (let ((path (substring (file-name-directory (expand-file-name file))
+ (let ((directory (substring (file-name-directory (expand-file-name file))
(length (expand-file-name default-directory))))
(dest (point)))
(save-match-data
(goto-char (point-min))
;; scan all the directories
- (while (and path (not (eq path t)))
- (if (string-match "^[/\\]?\\([^/\\]+\\)" path)
- (let ((pp (match-string 1 path)))
+ (while (and directory (not (eq directory t)))
+ (if (string-match "^[/\\]?\\([^/\\]+\\)" directory)
+ (let ((pp (match-string 1 directory)))
(if (save-match-data
(re-search-forward (concat "> " (regexp-quote pp) "$")
nil t))
- (setq path (substring path (match-end 1)))
- (setq path nil)))
- (setq path t)))
+ (setq directory (substring directory (match-end 1)))
+ (setq directory nil)))
+ (setq directory t)))
;; find the file part
- (if (or (not path) (string= (file-name-nondirectory file) ""))
+ (if (or (not directory) (string= (file-name-nondirectory file) ""))
;; only had a dir part
- (if path
+ (if directory
(progn
(speedbar-position-cursor-on-line)
t)
(goto-char dest)
nil))))))
-(defun speedbar-line-path (&optional depth)
- "Retrieve the pathname associated with the current line.
+(defun speedbar-line-directory (&optional depth)
+ "Retrieve the directory name associated with the current line.
This may require traversing backwards from DEPTH and combining the default
directory with these items. This function is replaceable in
-`speedbar-mode-functions-list' as `speedbar-line-path'"
- (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-path)))
- (if rf (funcall rf depth) default-directory)))
+`speedbar-mode-functions-list' as `speedbar-line-directory'."
+ (save-restriction
+ (widen)
+ (let ((rf (speedbar-fetch-replacement-function 'speedbar-line-directory)))
+ (if rf (funcall rf depth) default-directory))))
-(defun speedbar-files-line-path (&optional depth)
- "Retrieve the pathname associated with the current line.
+(defun speedbar-files-line-directory (&optional depth)
+ "Retrieve the directoryname associated with the current line.
This may require traversing backwards from DEPTH and combining the default
directory with these items."
(save-excursion
(progn
(beginning-of-line)
(looking-at "^\\([0-9]+\\):")
- (setq depth (string-to-int (match-string 1)))))
- (let ((path nil))
+ (setq depth (string-to-number (match-string 1)))))
+ (let ((directory nil))
(setq depth (1- depth))
(while (/= depth -1)
(if (not (re-search-backward (format "^%d:" depth) nil t))
- (error "Error building path of tag")
- (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)$")
- (setq path (concat (buffer-substring-no-properties
- (match-beginning 1) (match-end 1))
+ (error "Error building filename of tag")
+ (cond ((looking-at "[0-9]+:\\s-*<->\\s-+\\([^\n]+\\)")
+ (setq directory (concat (speedbar-line-text)
"/"
- path)))
- ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)$")
- ;; This is the start of our path.
- (setq path (buffer-substring-no-properties
- (match-beginning 1) (match-end 1))))))
+ directory)))
+ ((looking-at "[0-9]+:\\s-*[-]\\s-+\\([^\n]+\\)")
+ ;; This is the start of our directory.
+ (setq directory (speedbar-line-text)))))
(setq depth (1- depth)))
- (if (and path
+ (if (and directory
(string-match (concat speedbar-indicator-regex "$")
- path))
- (setq path (substring path 0 (match-beginning 0))))
- (concat default-directory path)))))
+ directory))
+ (setq directory (substring directory 0 (match-beginning 0))))
+ (concat default-directory directory)))))
-(defun speedbar-path-line (path)
- "Position the cursor on the line specified by PATH."
+(defun speedbar-directory-line (directory)
+ "Position the cursor on the line specified by DIRECTORY."
(save-match-data
- (if (string-match "[/\\]$" path)
- (setq path (substring path 0 (match-beginning 0))))
+ (if (string-match "[/\\]$" directory)
+ (setq directory (substring directory 0 (match-beginning 0))))
(let ((nomatch t) (depth 0)
- (fname (file-name-nondirectory path))
- (pname (file-name-directory path)))
+ (fname (file-name-nondirectory directory))
+ (pname (file-name-directory directory)))
(if (not (member pname speedbar-shown-directories))
- (error "Internal Error: File %s not shown in speedbar" path))
+ (error "Internal Error: File %s not shown in speedbar" directory))
(goto-char (point-min))
(while (and nomatch
(re-search-forward
nil t))
(beginning-of-line)
(looking-at "\\([0-9]+\\):")
- (setq depth (string-to-int (match-string 0))
- nomatch (not (string= pname (speedbar-line-path depth))))
+ (setq depth (string-to-number (match-string 0))
+ nomatch (not (string= pname (speedbar-line-directory depth))))
(end-of-line))
(beginning-of-line)
(not nomatch))))
(if (re-search-forward "[]>?}] [^ ]"
(save-excursion (end-of-line) (point))
t)
- (speedbar-do-function-pointer)
+ (progn
+ (forward-char -1)
+ (speedbar-do-function-pointer))
nil))
(speedbar-do-function-pointer)))
With universal argument ARG, flush cached data."
(interactive "P")
(beginning-of-line)
- (let ((speedbar-power-click arg))
+ (let* ((dframe-power-click arg)
+ (speedbar-power-click arg))
(condition-case nil
(progn
(re-search-forward ":\\s-*.\\+. "
(speedbar-do-function-pointer))
(error (speedbar-position-cursor-on-line))))
-(if speedbar-xemacsp
- (defalias 'speedbar-mouse-event-p 'button-press-event-p)
- (defun speedbar-mouse-event-p (event)
- "Return t if the event is a mouse related event"
- ;; And Emacs does it this way
- (if (and (listp event)
- (member (event-basic-type event)
- '(mouse-1 mouse-2 mouse-3)))
- t
- nil)))
-
-(defun speedbar-maybee-jump-to-attached-frame ()
- "Jump to the attached frame ONLY if this was not a mouse event."
- (if (or (not (speedbar-mouse-event-p last-input-event))
- speedbar-activity-change-focus-flag)
+(defun speedbar-toggle-line-expansion ()
+ "Contract or expand the line under the cursor."
+ (interactive)
+ (beginning-of-line)
+ (condition-case nil
(progn
- (select-frame speedbar-attached-frame)
- (other-frame 0))))
+ (re-search-forward ":\\s-*.[-+]. "
+ (save-excursion (end-of-line) (point)))
+ (forward-char -2)
+ (speedbar-do-function-pointer))
+ (error (speedbar-position-cursor-on-line))))
+
+(defun speedbar-expand-line-descendants (&optional arg)
+ "Expand the line under the cursor and all descendants.
+Optional argument ARG indicates that any cache should be flushed."
+ (interactive "P")
+ (speedbar-expand-line arg)
+ ;; Now, inside the area expaded here, expand all subnodes of
+ ;; the same descendant type.
+ (save-excursion
+ (speedbar-next 1) ;; Move into the list.
+ (let ((err nil))
+ (while (not err)
+ (condition-case nil
+ (progn
+ (speedbar-expand-line-descendants arg)
+ (speedbar-restricted-next 1))
+ (error (setq err t))))))
+ )
+
+(defun speedbar-contract-line-descendants ()
+ "Expand the line under the cursor and all descendants."
+ (interactive)
+ (speedbar-contract-line)
+ ;; Don't need to do anything else since all descendants are
+ ;; hidden by default anyway. Yay! It's easy.
+ )
(defun speedbar-find-file (text token indent)
"Speedbar click handler for filenames.
TEXT, the file will be displayed in the attached frame.
TOKEN is unused, but required by the click handler. INDENT is the
current indentation level."
- (let ((cdd (speedbar-line-path indent)))
+ (let ((cdd (speedbar-line-directory indent)))
+ ;; Run before visiting file hook here.
+ (let ((f (selected-frame)))
+ (dframe-select-attached-frame speedbar-frame)
+ (run-hooks 'speedbar-before-visiting-file-hook)
+ (select-frame f))
(speedbar-find-file-in-frame (concat cdd text))
(speedbar-stealthy-updates)
(run-hooks 'speedbar-visiting-file-hook)
;; Reset the timer with a new timeout when cliking a file
;; in case the user was navigating directories, we can cancel
;; that other timer.
- (speedbar-set-timer speedbar-update-speed))
- (speedbar-maybee-jump-to-attached-frame))
+ (speedbar-set-timer dframe-update-speed))
+ (dframe-maybee-jump-to-attached-frame))
(defun speedbar-dir-follow (text token indent)
"Speedbar click handler for directory names.
-Clicking a directory will cause the speedbar to list files in the
+Clicking a directory will cause the speedbar to list files in
the subdirectory TEXT. TOKEN is an unused requirement. The
subdirectory chosen will be at INDENT level."
(setq default-directory
- (concat (expand-file-name (concat (speedbar-line-path indent) text))
+ (concat (expand-file-name (concat (speedbar-line-directory indent) text))
"/"))
;; Because we leave speedbar as the current buffer,
;; update contents will change directory without
(end-of-line) (forward-char 1)
(let ((start (point)))
(while (and (looking-at "^\\([0-9]+\\):")
- (> (string-to-int (match-string 1)) indent)
+ (> (string-to-number (match-string 1)) indent)
(not (eobp)))
(forward-line 1)
(beginning-of-line))
(cond ((string-match "+" text) ;we have to expand this dir
(setq speedbar-shown-directories
(cons (expand-file-name
- (concat (speedbar-line-path indent) token "/"))
+ (concat (speedbar-line-directory indent) token "/"))
speedbar-shown-directories))
(speedbar-change-expand-button-char ?-)
(speedbar-reset-scanners)
(end-of-line) (forward-char 1)
(speedbar-with-writable
(speedbar-default-directory-list
- (concat (speedbar-line-path indent) token "/")
+ (concat (speedbar-line-directory indent) token "/")
(1+ indent)))))
((string-match "-" text) ;we have to contract this node
(speedbar-reset-scanners)
(let ((oldl speedbar-shown-directories)
(newl nil)
(td (expand-file-name
- (concat (speedbar-line-path indent) token))))
+ (concat (speedbar-line-directory indent) token))))
(while oldl
(if (not (string-match (concat "^" (regexp-quote td)) (car oldl)))
(setq newl (cons (car oldl) newl)))
)
(t (error "Ooops... not sure what to do")))
(speedbar-center-buffer-smartly)
- (setq speedbar-last-selected-file nil)
(save-excursion (speedbar-stealthy-updates)))
(defun speedbar-directory-buttons-follow (text token indent)
TEXT is the button clicked on. TOKEN is the directory to follow.
INDENT is the current indentation level and is unused."
(if (string-match "^[A-z]:$" token)
- (setq default-directory (concat token (char-to-string directory-sep-char)))
+ (setq default-directory (concat token "/"))
(setq default-directory token))
;; Because we leave speedbar as the current buffer,
;; update contents will change directory without
clicked, and TOKEN is the file to expand. INDENT is the current
indentation level."
(cond ((string-match "+" text) ;we have to expand this file
- (let* ((fn (expand-file-name (concat (speedbar-line-path indent)
+ (let* ((fn (expand-file-name (concat (speedbar-line-directory indent)
token)))
(mode nil)
(lst (speedbar-fetch-dynamic-tags fn)))
(speedbar-center-buffer-smartly))
(defun speedbar-tag-find (text token indent)
- "For the tag TEXT in a file TOKEN, goto that position.
+ "For the tag TEXT in a file TOKEN, go to that position.
INDENT is the current indentation level."
- (let ((file (speedbar-line-path indent)))
+ (let ((file (speedbar-line-directory indent)))
+ (let ((f (selected-frame)))
+ (dframe-select-attached-frame speedbar-frame)
+ (run-hooks 'speedbar-before-visiting-tag-hook)
+ (select-frame f))
(speedbar-find-file-in-frame file)
(save-excursion (speedbar-stealthy-updates))
;; Reset the timer with a new timeout when cliking a file
;; in case the user was navigating directories, we can cancel
;; that other timer.
- (speedbar-set-timer speedbar-update-speed)
+ (speedbar-set-timer dframe-update-speed)
(goto-char token)
(run-hooks 'speedbar-visiting-tag-hook)
- ;;(recenter)
- (speedbar-maybee-jump-to-attached-frame)
+ (dframe-maybee-jump-to-attached-frame)
))
(defun speedbar-tag-expand (text token indent)
\f
;;; Loading files into the attached frame.
;;
+(defcustom speedbar-select-frame-method 'attached
+ "*Specify how to select a frame for displaying a file.
+A value of 'attached means to use the attached frame (the frame
+that speedbar was started from.) A number such as 1 or -1 means to
+pass that number to `other-frame' while selecting a frame from speedbar."
+ :group 'speedbar
+ :type 'sexp)
+
(defun speedbar-find-file-in-frame (file)
"This will load FILE into the speedbar attached frame.
If the file is being displayed in a different frame already, then raise that
(progn
(select-window bwin)
(raise-frame (window-frame bwin)))
- (if speedbar-power-click
+ (if dframe-power-click
(let ((pop-up-frames t)) (select-window (display-buffer buff)))
- (select-frame speedbar-attached-frame)
+ (if (numberp speedbar-select-frame-method)
+ (other-frame speedbar-select-frame-method)
+ (dframe-select-attached-frame speedbar-frame))
(switch-to-buffer buff))))
)
"Recenter a speedbar buffer so the current indentation level is all visible.
This assumes that the cursor is on a file, or tag of a file which the user is
interested in."
- (if (<= (count-lines (point-min) (point-max))
- (1- (window-height (selected-window))))
- ;; whole buffer fits
- (let ((cp (point)))
- (goto-char (point-min))
- (recenter 0)
- (goto-char cp))
- ;; too big
- (let (depth start end exp p)
- (save-excursion
- (beginning-of-line)
- (setq depth (if (looking-at "[0-9]+")
- (string-to-int (buffer-substring-no-properties
- (match-beginning 0) (match-end 0)))
- 0))
- (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
- (save-excursion
- (end-of-line)
- (if (re-search-backward exp nil t)
- (setq start (point))
- (setq start (point-min)))
- (save-excursion ;Not sure about this part.
- (end-of-line)
- (setq p (point))
- (while (and (not (re-search-forward exp nil t))
- (>= depth 0))
- (setq depth (1- depth))
- (setq exp (format "^%d:\\s-*[[{<]\\([?+-]\\)[]>}]" depth)))
- (if (/= (point) p)
- (setq end (point))
- (setq end (point-max)))))
- ;; Now work out the details of centering
- (let ((nl (count-lines start end))
- (cp (point)))
- (if (> nl (window-height (selected-window)))
- ;; We can't fit it all, so just center on cursor
- (progn (goto-char start)
- (recenter 1))
- ;; we can fit everything on the screen, but...
- (if (and (pos-visible-in-window-p start (selected-window))
- (pos-visible-in-window-p end (selected-window)))
- ;; we are all set!
- nil
- ;; we need to do something...
- (goto-char start)
- (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
- (lte (count-lines start (point-max))))
- (if (and (< (+ newcent lte) (window-height (selected-window)))
- (> (- (window-height (selected-window)) lte 1)
- newcent))
- (setq newcent (- (window-height (selected-window))
- lte 1)))
- (recenter newcent))))
- (goto-char cp)))))
+ (save-selected-window
+
+ (select-window (get-buffer-window speedbar-buffer t))
+
+ (set-buffer speedbar-buffer)
+
+ (if (<= (count-lines (point-min) (point-max))
+ (1- (window-height (selected-window))))
+ ;; whole buffer fits
+ (let ((cp (point)))
+
+ (goto-char (point-min))
+ (recenter 0)
+ (goto-char cp))
+ ;; too big
+ (let (depth start end exp p)
+ (save-excursion
+ (beginning-of-line)
+ (setq depth (if (looking-at "[0-9]+")
+ (string-to-number (buffer-substring-no-properties
+ (match-beginning 0) (match-end 0)))
+ 0))
+ (setq exp (format "^%d:" depth)))
+ (save-excursion
+ (end-of-line)
+ (if (re-search-backward exp nil t)
+ (setq start (point))
+ (setq start (point-min)))
+ (save-excursion ;Not sure about this part.
+ (end-of-line)
+ (setq p (point))
+ (while (and (not (re-search-forward exp nil t))
+ (>= depth 0))
+ (setq depth (1- depth))
+ (setq exp (format "^%d:" depth)))
+ (if (/= (point) p)
+ (setq end (point))
+ (setq end (point-max)))))
+ ;; Now work out the details of centering
+ (let ((nl (count-lines start end))
+ (wl (1- (window-height (selected-window))))
+ (cp (point)))
+ (if (> nl wl)
+ ;; We can't fit it all, so just center on cursor
+ (progn (goto-char start)
+ (recenter 1))
+ ;; we can fit everything on the screen, but...
+ (if (and (pos-visible-in-window-p start (selected-window))
+ (pos-visible-in-window-p end (selected-window)))
+ ;; we are all set!
+ nil
+ ;; we need to do something...
+ (goto-char start)
+ (let ((newcent (/ (- (window-height (selected-window)) nl) 2))
+ (lte (count-lines start (point-max))))
+ (if (and (< (+ newcent lte) (window-height (selected-window)))
+ (> (- (window-height (selected-window)) lte 1)
+ newcent))
+ (setq newcent (- (window-height (selected-window))
+ lte 1)))
+ (recenter newcent))))
+ (goto-char cp))))))
\f
;;; Tag Management -- List of expanders:
;;
to find the proper tags. It is up to each of those individual
functions to do caching and flushing if appropriate."
(save-excursion
- (set-buffer (find-file-noselect file))
+ ;; If a file is in memory, switch to that buffer. This allows
+ ;; us to use the local variable. If the file is on disk, we
+ ;; can try a few of the defaults that can get tags without
+ ;; opening the file.
+ (if (get-file-buffer file)
+ (set-buffer (get-file-buffer file)))
;; If there is a buffer-local value of
;; speedbar-dynamic-tags-function-list, it will now be available.
(let ((dtf speedbar-dynamic-tags-function-list)
(while (and (eq ret t) dtf)
(setq ret
(if (fboundp (car (car dtf)))
- (funcall (car (car dtf)) (buffer-file-name))
+ (funcall (car (car dtf)) file)
t))
(if (eq ret t)
(setq dtf (cdr dtf))))
nil
-(eval-when-compile (if (locate-library "imenu") (require 'imenu)))
+(eval-when-compile (condition-case nil (require 'imenu) (error nil)))
(defun speedbar-fetch-dynamic-imenu (file)
"Load FILE into a buffer, and generate tags using Imenu.
Returns the tag list, or t for an error."
;; Load this AND compile it in
(require 'imenu)
- (if speedbar-power-click (setq imenu--index-alist nil))
+ (set-buffer (find-file-noselect file))
+ (if dframe-power-click (setq imenu--index-alist nil))
(condition-case nil
(let ((index-alist (imenu--make-index-alist t)))
(if speedbar-sort-tags
;;
(defvar speedbar-fetch-etags-parse-list
'(;; Note that java has the same parse-group as c
- ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\)\\'" .
+ ("\\.\\([cChH]\\|c\\+\\+\\|cpp\\|cc\\|hh\\|java\\|cxx\\|hxx\\)\\'" .
speedbar-parse-c-or-c++tag)
("^\\.emacs$\\|.\\(el\\|l\\|lsp\\)\\'" .
"def[^i]+\\s-+\\(\\(\\w\\|[-_]\\)+\\)\\s-*\C-?")
(defvar speedbar-fetch-etags-command "etags"
"*Command used to create an etags file.
-This variable is ignored if `speedbar-use-imenu-flag' is t")
+This variable is ignored if `speedbar-use-imenu-flag' is t.")
(defvar speedbar-fetch-etags-arguments '("-D" "-I" "-o" "-")
"*List of arguments to use with `speedbar-fetch-etags-command'.
This creates an etags output buffer. Use `speedbar-toggle-etags' to
modify this list conveniently.
-This variable is ignored if `speedbar-use-imenu-flag' is t")
+This variable is ignored if `speedbar-use-imenu-flag' is t.")
(defun speedbar-toggle-etags (flag)
"Toggle FLAG in `speedbar-fetch-etags-arguments'.
`speedbar-show-unknown-files'.
This function is a convenience function for XEmacs menu created by
-Farzin Guilak <farzin@protocol.com>"
+Farzin Guilak <farzin@protocol.com>."
(interactive)
(cond
((equal flag "sort")
(defun speedbar-extract-one-symbol (expr)
"At point, return nil, or one alist in the form: (SYMBOL . POSITION)
The line should contain output from etags. Parse the output using the
-regular expression EXPR"
+regular expression EXPR."
(let* ((sym (if (stringp expr)
(if (save-excursion
(re-search-forward expr (save-excursion
(point))
t)))
(if (and j sym)
- (1+ (string-to-int (buffer-substring-no-properties
+ (1+ (string-to-number (buffer-substring-no-properties
(match-beginning 2)
(match-end 2))))
0))))
nil)))
(defun speedbar-parse-c-or-c++tag ()
- "Parse a c or c++ tag, which tends to be a little complex."
+ "Parse a C or C++ tag, which tends to be a little complex."
(save-excursion
(let ((bound (save-excursion (end-of-line) (point))))
(cond ((re-search-forward "\C-?\\([^\C-a]+\\)\C-a" bound t)
(define-key speedbar-buffers-key-map "+" 'speedbar-expand-line)
(define-key speedbar-buffers-key-map "=" 'speedbar-expand-line)
(define-key speedbar-buffers-key-map "-" 'speedbar-contract-line)
+ (define-key speedbar-buffers-key-map " " 'speedbar-toggle-line-expansion)
;; Buffer specific keybindings
(define-key speedbar-buffers-key-map "k" 'speedbar-buffer-kill-buffer)
["Contract File Tags" speedbar-contract-line
(save-excursion (beginning-of-line)
(looking-at "[0-9]+: *.-. "))]
+ "----"
["Kill Buffer" speedbar-buffer-kill-buffer
(save-excursion (beginning-of-line)
- (looking-at "[0-9]+: *.-. "))]
+ (looking-at "[0-9]+: *.[-+?]. "))]
["Revert Buffer" speedbar-buffer-revert-buffer
(save-excursion (beginning-of-line)
- (looking-at "[0-9]+: *.-. "))]
+ (looking-at "[0-9]+: *.[-+?]. "))]
)
"Menu item elements shown when displaying a buffer list.")
(defun speedbar-buffer-buttons (directory zero)
"Create speedbar buttons based on the buffers currently loaded.
-DIRECTORY is the path to the currently active buffer, and ZERO is 0."
+DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
(speedbar-buffer-buttons-engine nil))
(defun speedbar-buffer-buttons-temp (directory zero)
"Create speedbar buttons based on the buffers currently loaded.
-DIRECTORY is the path to the currently active buffer, and ZERO is 0."
+DIRECTORY is the directory to the currently active buffer, and ZERO is 0."
(speedbar-buffer-buttons-engine t))
(defun speedbar-buffer-buttons-engine (temp)
"Create speedbar buffer buttons.
If TEMP is non-nil, then clicking on a buffer restores the previous display."
- (insert "Active Buffers:\n")
- (let ((bl (buffer-list)))
+ (speedbar-insert-separator "Active Buffers:")
+ (let ((bl (buffer-list))
+ (case-fold-search t))
(while bl
(if (string-match "^[ *]" (buffer-name (car bl)))
nil
(if fname (file-name-nondirectory fname))
(buffer-name (car bl))
'speedbar-buffer-click temp
- 'speedbar-file-face 0)))
+ 'speedbar-file-face 0)
+ (speedbar-buffers-tail-notes (car bl))))
(setq bl (cdr bl)))
(setq bl (buffer-list))
- (insert "Scratch Buffers:\n")
+ (speedbar-insert-separator "Scratch Buffers:")
(while bl
(if (not (string-match "^\\*" (buffer-name (car bl))))
nil
(speedbar-make-tag-line 'bracket ?? nil nil
(buffer-name (car bl))
'speedbar-buffer-click temp
- 'speedbar-file-face 0)))
+ 'speedbar-file-face 0)
+ (speedbar-buffers-tail-notes (car bl))))
(setq bl (cdr bl)))
(setq bl (buffer-list))
- (insert "Hidden Buffers:\n")
- (while bl
- (if (not (string-match "^ " (buffer-name (car bl))))
- nil
- (if (eq (car bl) speedbar-buffer)
- nil
- (speedbar-make-tag-line 'bracket ?? nil nil
- (buffer-name (car bl))
- 'speedbar-buffer-click temp
- 'speedbar-file-face 0)))
- (setq bl (cdr bl)))))
+ ;;(speedbar-insert-separator "Hidden Buffers:")
+ ;;(while bl
+ ;; (if (not (string-match "^ " (buffer-name (car bl))))
+ ;; nil
+ ;; (if (eq (car bl) speedbar-buffer)
+ ;; nil
+ ;; (speedbar-make-tag-line 'bracket ?? nil nil
+ ;; (buffer-name (car bl))
+ ;; 'speedbar-buffer-click temp
+ ;; 'speedbar-file-face 0)
+ ;; (speedbar-buffers-tail-notes (car bl))))
+ ;; (setq bl (cdr bl)))
+ ))
+
+(defun speedbar-buffers-tail-notes (buffer)
+ "Add a note to the end of the last tag line.
+Argument BUFFER is the buffer being tested."
+ (let (mod ro)
+ (save-excursion
+ (set-buffer buffer)
+ (setq mod (buffer-modified-p)
+ ro buffer-read-only))
+ (if ro (speedbar-insert-button "%" nil nil nil nil t))))
(defun speedbar-buffers-item-info ()
"Display information about the current buffer on the current line."
(buffer-size))
(or (buffer-file-name buffer) "<No file>"))))))
-(defun speedbar-buffers-line-path (&optional depth)
- "Fetch the full path to the file (buffer) specified on the current line.
+(defun speedbar-buffers-line-directory (&optional depth)
+ "Fetch the full directory to the file (buffer) specified on the current line.
Optional argument DEPTH specifies the current depth of the back search."
(save-excursion
(end-of-line)
(if (save-excursion
(end-of-line)
(eq start (point)))
- (file-name-directory (buffer-file-name buffer))
+ (or (save-excursion (set-buffer buffer)
+ default-directory)
+ "")
(buffer-file-name buffer))))))))
(defun speedbar-buffer-click (text token indent)
"When the users clicks on a buffer-button in speedbar.
TEXT is the buffer's name, TOKEN and INDENT are unused."
- (if speedbar-power-click
+ (if dframe-power-click
(let ((pop-up-frames t)) (select-window (display-buffer text)))
- (select-frame speedbar-attached-frame)
+ (dframe-select-attached-frame speedbar-frame)
(switch-to-buffer text)
(if token (speedbar-change-initial-expansion-list
speedbar-previously-used-expansion-list-name))))
"Kill the buffer the cursor is on in the speedbar buffer."
(interactive)
(or (save-excursion
- (beginning-of-line)
- ;; If this fails, then it is a non-standard click, and as such,
- ;; perfectly allowed.
- (if (re-search-forward "[]>?}] [^ ]"
- (save-excursion (end-of-line) (point))
- t)
- (let ((text (progn
- (forward-char -1)
- (buffer-substring (point) (save-excursion
- (end-of-line)
- (point))))))
- (if (and (get-buffer text)
- (speedbar-y-or-n-p (format "Kill buffer %s? " text)))
- (kill-buffer text))
- (speedbar-refresh))))))
+ (let ((text (speedbar-line-text)))
+ (if (and (get-buffer text)
+ (speedbar-y-or-n-p (format "Kill buffer %s? " text)))
+ (kill-buffer text))
+ (speedbar-refresh)))))
(defun speedbar-buffer-revert-buffer ()
"Revert the buffer the cursor is on in the speedbar buffer."
)
(defun speedbar-unhighlight-one-tag-line ()
- "Unhighlight the currently highlight line."
+ "Unhighlight the currently highlighted line."
(if speedbar-highlight-one-tag-line
(progn
(speedbar-delete-overlay speedbar-highlight-one-tag-line)
(:foreground "blue4"))
(((class color) (background dark))
(:foreground "light blue")))
- "Faced used for directory names."
+ "Face used for directory names."
:group 'speedbar-faces)
(defface speedbar-tag-face '((((class color) (background light))
(:foreground "brown"))
"Face used for highlighting buttons with the mouse."
:group 'speedbar-faces)
+(defface speedbar-separator-face '((((class color) (background light))
+ (:background "blue"
+ :foreground "white"
+ :overline "gray"))
+ (((class color) (background dark))
+ (:background "blue"
+ :foreground "white"
+ :overline "gray"))
+ (((class grayscale monochrome)
+ (background light))
+ (:background "black"
+ :foreground "white"
+ :overline "white"))
+ (((class grayscale monochrome)
+ (background dark))
+ (:background "white"
+ :foreground "black"
+ :overline "black")))
+ "Face used for separator labes in a display."
+ :group 'speedbar-faces)
+
+;; some edebug hooks
+(add-hook 'edebug-setup-hook
+ (lambda ()
+ (def-edebug-spec speedbar-with-writable def-body)))
+
+;; Fix a font lock problem for some versions of Emacs
+(if (boundp 'font-lock-global-modes)
+ (if (listp font-lock-global-modes)
+ (add-to-list 'font-lock-global-modes '(not speedbar-mode))
+ )
+ )
+
\f
-;;; Image loading and inlining
-;;
+;;; Obsolete variables and functions
-;;; Some images if defimage is available:
-(eval-when-compile
+(define-obsolete-variable-alias
+ 'speedbar-ignored-path-regexp 'speedbar-ignored-directory-regexp)
-(if (fboundp 'defimage)
- (defalias 'defimage-speedbar 'defimage)
+(define-obsolete-variable-alias 'speedbar-ignored-path-expressions
+ 'speedbar-ignored-directory-expressions)
- (if (not (fboundp 'make-glyph))
-
-(defmacro defimage-speedbar (variable imagespec docstring)
- "Don't bother loading up an image...
-Argument VARIABLE is the varible to define.
-Argument IMAGESPEC is the list defining the image to create.
-Argument DOCSTRING is the documentation for VARIABLE."
- `(defvar ,variable nil ,docstring))
-
-;; ELSE
-(defun speedbar-find-image-on-load-path (image)
- "Find the image file IMAGE on the load path."
- (let ((l load-path)
- (r nil))
- (while (and l (not r))
- (if (file-exists-p (concat (car l) "/" image))
- (setq r (concat (car l) "/" image)))
- (setq l (cdr l)))
- r))
-
-(defun speedbar-convert-emacs21-imagespec-to-xemacs (spec)
- "Convert the Emacs21 Image SPEC into an XEmacs image spec."
- (let* ((sl (car spec))
- (itype (nth 1 sl))
- (ifile (nth 3 sl)))
- (vector itype ':file (speedbar-find-image-on-load-path ifile))))
-
-(defmacro defimage-speedbar (variable imagespec docstring)
- "Devine VARIABLE as an image if `defimage' is not available..
-IMAGESPEC is the image data, and DOCSTRING is documentation for the image."
- `(defvar ,variable
- ;; The Emacs21 version of defimage looks just like the XEmacs image
- ;; specifier, except that it needs a :type keyword. If we line
- ;; stuff up right, we can use this cheat to support XEmacs specifiers.
- (condition-case nil
- (make-glyph
- (make-image-specifier
- (speedbar-convert-emacs21-imagespec-to-xemacs (quote ,imagespec)))
- 'buffer)
- (error nil))
- ,docstring))
-
-)))
-
-(defimage-speedbar speedbar-directory-plus
- ((:type xpm :file "sb-dir-plus.xpm" :ascent center))
- "Image used for closed directories with stuff in them.")
-
-(defimage-speedbar speedbar-directory-minus
- ((:type xpm :file "sb-dir-minus.xpm" :ascent center))
- "Image used for open directories with stuff in them.")
-
-(defimage-speedbar speedbar-page-plus
- ((:type xpm :file "sb-pg-plus.xpm" :ascent center))
- "Image used for closed files with stuff in them.")
-
-(defimage-speedbar speedbar-page-minus
- ((:type xpm :file "sb-pg-minus.xpm" :ascent center))
- "Image used for open files with stuff in them.")
-
-(defimage-speedbar speedbar-page
- ((:type xpm :file "sb-pg.xpm" :ascent center))
- "Image used for files that can't be opened.")
-
-(defimage-speedbar speedbar-tag
- ((:type xpm :file "sb-tag.xpm" :ascent center))
- "Image used for tags.")
-
-(defimage-speedbar speedbar-tag-plus
- ((:type xpm :file "sb-tag-plus.xpm" :ascent center))
- "Image used for closed tag groups.")
-
-(defimage-speedbar speedbar-tag-minus
- ((:type xpm :file "sb-tag-minus.xpm" :ascent center))
- "Image used for open tag groups.")
-
-(defimage-speedbar speedbar-tag-gt
- ((:type xpm :file "sb-tag-gt.xpm" :ascent center))
- "Image used for open tag groups.")
-
-(defimage-speedbar speedbar-tag-v
- ((:type xpm :file "sb-tag-v.xpm" :ascent center))
- "Image used for open tag groups.")
-
-(defimage-speedbar speedbar-tag-type
- ((:type xpm :file "sb-tag-type.xpm" :ascent center))
- "Image used for open tag groups.")
-
-(defimage-speedbar speedbar-mail
- ((:type xpm :file "sb-mail.xpm" :ascent center))
- "Image used for open tag groups.")
-
-(defvar speedbar-expand-image-button-alist
- '(("<+>" . speedbar-directory-plus)
- ("<->" . speedbar-directory-minus)
- ("[+]" . speedbar-page-plus)
- ("[-]" . speedbar-page-minus)
- ("[?]" . speedbar-page)
- ("{+}" . speedbar-tag-plus)
- ("{-}" . speedbar-tag-minus)
- ("<M>" . speedbar-mail)
- (" =>" . speedbar-tag)
- (" +>" . speedbar-tag-gt)
- (" ->" . speedbar-tag-v)
- (">" . speedbar-tag)
- ("@" . speedbar-tag-type)
- (" @" . speedbar-tag-type)
- )
- "List of text and image associations.")
+(define-obsolete-function-alias 'speedbar-add-ignored-path-regexp
+ 'speedbar-add-ignored-directory-regexp)
-(defun speedbar-insert-image-button-maybe (start length)
- "Insert an image button based on text starting at START for LENGTH chars.
-If buttontext is unknown, just insert that text.
-If we have an image associated with it, use that image."
- (if speedbar-use-images
- (let* ((bt (buffer-substring start (+ length start)))
- (a (assoc bt speedbar-expand-image-button-alist)))
- ;; Regular images (created with `insert-image' are intangible
- ;; which (I suppose) make them more compatible with XEmacs 21.
- ;; Unfortunatly, there is a giant pile o code dependent on the
- ;; underlying text. This means if we leave it tangible, then I
- ;; don't have to change said giant piles o code.
- (if (and a (symbol-value (cdr a)))
- (if (featurep 'xemacs)
- (add-text-properties (+ start (length bt)) start
- (list 'end-glyph (symbol-value (cdr a))
- 'rear-nonsticky (list 'display)
- 'invisible t
- 'detachable t))
- (add-text-properties start (+ start (length bt))
- (list 'display (symbol-value (cdr a))
- 'rear-nonsticky (list 'display))))
- ;(message "Bad text [%s]" (buffer-substring start (+ start length)))
- ))))
+(define-obsolete-function-alias 'speedbar-line-path
+ 'speedbar-line-directory)
+(define-obsolete-function-alias 'speedbar-buffers-line-path
+ 'speedbar-buffers-line-directory)
-;; some edebug hooks
-(add-hook 'edebug-setup-hook
- (lambda ()
- (def-edebug-spec speedbar-with-writable def-body)))
+(define-obsolete-function-alias 'speedbar-path-line
+ 'speedbar-directory-line)
+
+(define-obsolete-function-alias 'speedbar-buffers-line-path
+ 'speedbar-buffers-line-directory)
(provide 'speedbar)
-;;; speedbar ends here
;; run load-time hooks
(run-hooks 'speedbar-load-hook)
+
+;; arch-tag: 4477e6d1-f78c-48b9-a503-387d3c9767d5
+;;; speedbar ends here