;;; gutter-items.el --- Gutter content for XEmacs.
;; Copyright (C) 1999 Free Software Foundation, Inc.
-;; Copyright (C) 1999 Andy Piper.
+;; Copyright (C) 1999, 2000 Andy Piper.
;; Maintainer: XEmacs Development Team
;; Keywords: frames, extensions, internal, dumped
"Input from the gutters."
:group 'environment)
-(defcustom gutter-visible-p
- (specifier-instance default-gutter-visible-p)
- "Whether the default gutter is globally visible. This option can be
-customized through the options menu."
- :group 'display
- :type 'boolean
- :set #'(lambda (var val)
- (set-specifier default-gutter-visible-p val)
- (setq gutter-visible-p val)))
-
+;; Although these customizations appear bogus, they are neccessary in
+;; order to be able to save options through the options menu.
(defcustom default-gutter-position
(default-gutter-position)
"The location of the default gutter. It can be 'top, 'bottom, 'left or
-'right. This option can be customized through the options menu."
- :group 'display
- :type '(choice (const :tag "top" 'top)
- (const :tag "bottom" 'bottom)
- (const :tag "left" 'left)
- (const :tag "right" 'right))
+'right. This option should be customized through the options menu.
+To set the gutter position explicitly use `set-default-gutter-position'"
+ :group 'gutter
+ :type '(choice (const :tag "top" top)
+ (const :tag "bottom" bottom)
+ (const :tag "left" left)
+ (const :tag "right" right))
:set #'(lambda (var val)
(set-default-gutter-position val)
(setq default-gutter-position val)))
+;;; Gutter helper functions
+
+;; called by Fset_default_gutter_position()
+(defvar default-gutter-position-changed-hook nil
+ "Function or functions to be called when the gutter position is changed.
+The value of this variable may be buffer-local.")
+
+;; called by set-gutter-element-visible-p
+(defvar gutter-element-visibility-changed-hook nil
+ "Function or functions to be called when the visibility of an
+element in the gutter changes. The value of this variable may be
+buffer-local. The gutter element symbol is passed as an argument to
+the hook, as is the visibility flag.")
+
+(defun set-gutter-element (gutter-specifier prop val &optional locale tag-set)
+ "Set GUTTER-SPECIFIER gutter element PROP to VAL in optional LOCALE.
+This is a convenience function for setting gutter elements."
+ (map-extents #'(lambda (extent arg)
+ (set-extent-property extent 'duplicable t)) val)
+ (modify-specifier-instances gutter-specifier #'plist-put (list prop val)
+ 'force nil locale tag-set))
+
+(defun remove-gutter-element (gutter-specifier prop &optional locale tag-set)
+ "Remove gutter element PROP from GUTTER-SPECIFIER in optional LOCALE.
+This is a convenience function for removing gutter elements."
+ (modify-specifier-instances gutter-specifier #'plist-remprop (list prop)
+ 'force nil locale tag-set))
+
+(defun set-gutter-element-visible-p (gutter-visible-specifier-p
+ prop &optional visible-p
+ locale tag-set)
+ "Change the visibility of gutter elements.
+Set the visibility of element PROP to VISIBLE-P for
+GUTTER-SPECIFIER-VISIBLE-P in optional LOCALE.
+This is a convenience function for hiding and showing gutter elements."
+ (modify-specifier-instances
+ gutter-visible-specifier-p #'(lambda (spec prop visible-p)
+ (if (consp spec)
+ (if visible-p
+ (if (memq prop spec) spec
+ (cons prop spec))
+ (delq prop spec))
+ (if visible-p (list prop))))
+ (list prop visible-p)
+ 'force nil locale tag-set)
+ (run-hook-with-args 'gutter-element-visibility-changed-hook prop visible-p))
+
+(defun gutter-element-visible-p (gutter-visible-specifier-p
+ prop &optional domain)
+ "Determine whether a gutter element is visible.
+Given GUTTER-VISIBLE-SPECIFIER-P and gutter element PROP, return
+non-nil if it is visible in optional DOMAIN."
+ (let ((spec (specifier-instance gutter-visible-specifier-p domain)))
+ (or (and (listp spec) (memq 'buffers-tab spec))
+ spec)))
+
+(defun init-gutter ()
+ "Initialize the gutter."
+ ;; do nothing as yet.
+ )
+
;;; The Buffers tab
(defgroup buffers-tab nil
Do not set this. Use `glyph-image-instance' and
`set-image-instance-property' to change the properties of the tab.")
+(defcustom gutter-buffers-tab-visible-p
+ (gutter-element-visible-p default-gutter-visible-p 'buffers-tab)
+ "Whether the buffers tab is globally visible.
+This option should be set through the options menu."
+ :group 'buffers-tab
+ :type 'boolean
+ :set #'(lambda (var val)
+ (set-gutter-element-visible-p default-gutter-visible-p 'buffers-tab val)
+ (setq gutter-buffers-tab-visible-p val)))
+
+(defvar gutter-buffers-tab-orientation 'top
+ "Where the buffers tab currently is. Do not set this.")
+
+(defvar gutter-buffers-tab-extent nil)
+
(defcustom buffers-tab-max-size 6
"*Maximum number of entries which may appear on the \"Buffers\" tab.
If this is 10, then only the ten most-recently-selected buffers will be
shown. If this is nil, then all buffers will be shown. Setting this to
a large number or nil will slow down tab responsiveness."
:type '(choice (const :tag "Show all" nil)
- (integer 10))
+ (integer 6))
:group 'buffers-tab)
(defcustom buffers-tab-switch-to-buffer-function 'buffers-tab-switch-to-buffer
function)
:group 'buffers-tab)
-(defcustom buffers-tab-format-buffer-line-function 'format-buffers-menu-line
+(defcustom buffers-tab-selection-function 'select-buffers-tab-buffers-by-mode
+ "*If non-nil, a function specifying the buffers to select from the
+buffers tab. This is passed two buffers and should return non-nil if
+the second buffer should be selected. The default value
+`select-buffers-tab-buffers-by-mode' groups buffers by major mode and
+by `buffers-tab-grouping-regexp'."
+
+ :type '(choice (const :tag "None" nil)
+ function)
+ :group 'buffers-tab)
+
+(defcustom buffers-tab-sort-function nil
+ "*If non-nil, a function specifying the buffers to select from the
+buffers tab. This is passed the buffer list and returns the list in the
+order desired for the tab widget. The default value `nil' leaves the
+list in `buffer-list' order (usual most-recently-selected-first)."
+
+ :type '(choice (const :tag "None" nil)
+ function)
+ :group 'buffers-tab)
+
+(make-face 'buffers-tab "Face for displaying the buffers tab.")
+(set-face-parent 'buffers-tab 'default)
+
+(defcustom buffers-tab-face 'buffers-tab
+ "*Face to use for displaying the buffers tab."
+ :type 'face
+ :group 'buffers-tab)
+
+(defcustom buffers-tab-grouping-regexp
+ '("^\\(gnus-\\|message-mode\\|mime/viewer-mode\\)"
+ "^\\(emacs-lisp-\\|lisp-\\)")
+ "*If non-nil, a list of regular expressions for buffer grouping.
+Each regular expression is applied to the current major-mode symbol
+name and mode-name, if it matches then any other buffers that match
+the same regular expression be added to the current group."
+ :type '(choice (const :tag "None" nil)
+ sexp)
+ :group 'buffers-tab)
+
+(defcustom buffers-tab-format-buffer-line-function 'format-buffers-tab-line
"*The function to call to return a string to represent a buffer in the
-buffers tab. The function is passed a buffer and should return a string.
-The default value `format-buffers-menu-line' just returns the name of
-the buffer. Also check out `slow-format-buffers-menu-line' which
-returns a whole bunch of info about a buffer."
+buffers tab. The function is passed a buffer and should return a
+string. The default value `format-buffers-tab-line' just returns the
+name of the buffer, optionally truncated to
+`buffers-tab-max-buffer-line-length'. Also check out
+`slow-format-buffers-menu-line' which returns a whole bunch of info
+about a buffer."
:type 'function
:group 'buffers-tab)
+(defvar buffers-tab-default-buffer-line-length
+ (make-specifier-and-init 'generic '((global ((default) . 25))) t)
+ "*Maximum length of text which may appear in a \"Buffers\" tab.
+This is a specifier, use set-specifier to modify it.")
+
+(defcustom buffers-tab-max-buffer-line-length
+ (specifier-instance buffers-tab-default-buffer-line-length)
+ "*Maximum length of text which may appear in a \"Buffers\" tab.
+Buffer names over this length will be truncated with elipses.
+If this is 0, then the full buffer name will be shown."
+ :type '(choice (const :tag "Show all" 0)
+ (integer 25))
+ :group 'buffers-tab
+ :set #'(lambda (var val)
+ (set-specifier buffers-tab-default-buffer-line-length val)
+ (setq buffers-tab-max-buffer-line-length val)))
+
(defun buffers-tab-switch-to-buffer (buffer)
"For use as a value for `buffers-tab-switch-to-buffer-function'."
- (switch-to-buffer buffer t))
+ (unless (eq (window-buffer) buffer)
+ (if (> (length (windows-of-buffer buffer)) 0)
+ (select-window (car (windows-of-buffer buffer)) t)
+ (switch-to-buffer buffer t))))
+
+(defun select-buffers-tab-buffers-by-mode (buf1 buf2)
+ "For use as a value of `buffers-tab-selection-function'.
+This selects buffers by major mode `buffers-tab-grouping-regexp'."
+ (let ((mode1 (symbol-name (symbol-value-in-buffer 'major-mode buf1)))
+ (mode2 (symbol-name (symbol-value-in-buffer 'major-mode buf2)))
+ (modenm1 (symbol-value-in-buffer 'mode-name buf1))
+ (modenm2 (symbol-value-in-buffer 'mode-name buf2)))
+ (cond ((or (eq mode1 mode2)
+ (eq modenm1 modenm2)
+ (and (string-match "^[^-]+-" mode1)
+ (string-match
+ (concat "^" (regexp-quote
+ (substring mode1 0 (match-end 0))))
+ mode2))
+ (and buffers-tab-grouping-regexp
+ (find-if #'(lambda (x)
+ (or
+ (and (string-match x mode1)
+ (string-match x mode2))
+ (and (string-match x modenm1)
+ (string-match x modenm2))))
+ buffers-tab-grouping-regexp)))
+ t)
+ (t nil))))
+
+(defun format-buffers-tab-line (buffer)
+ "For use as a value of `buffers-tab-format-buffer-line-function'.
+This just returns the buffer's name, optionally truncated."
+ (let ((len (specifier-instance buffers-tab-default-buffer-line-length)))
+ (if (and (> len 0)
+ (> (length (buffer-name buffer)) len))
+ (if (string-match ".*<.>$" (buffer-name buffer))
+ (concat (substring (buffer-name buffer)
+ 0 (- len 6)) "..."
+ (substring (buffer-name buffer) -3))
+ (concat (substring (buffer-name buffer)
+ 0 (- len 3)) "..."))
+ (buffer-name buffer))))
(defsubst build-buffers-tab-internal (buffers)
- (let (line)
+ (let ((selected t))
(mapcar
#'(lambda (buffer)
- (setq line (funcall buffers-tab-format-buffer-line-function
- buffer))
- (vector line (list buffers-tab-switch-to-buffer-function
- (buffer-name buffer))))
+ (prog1
+ (vector
+ (funcall buffers-tab-format-buffer-line-function
+ buffer)
+ (list buffers-tab-switch-to-buffer-function
+ (buffer-name buffer))
+ :selected selected)
+ (when selected (setq selected nil))))
buffers)))
-(defun buffers-tab-items ()
+;;; #### SJT I'd really like this function to have just two hooks: (1) the
+;;; buffer filter list and (2) a sort function list. Both should be lists
+;;; of functions. Each filter takes two arguments: a buffer and a model
+;;; buffer. (The model buffer argument allows selecting according to the
+;;; mode or directory of that buffer.) The filter returns t if the buffer
+;;; should be listed and nil otherwise. Effectively the filter amounts to
+;;; the conjuction of the filter list. (Optionally the filter could take a
+;;; frame instead of a buffer or generalize to a locale as in a specifier?)
+;;; The filtering is done this way to preserve the ordering imposed by
+;;; `buffer-list'. In addition, the in-deletion argument will be used the
+;;; same way as in the current design.
+;;; The list is checked for length and pruned according to least-recently-
+;;; selected. (Optionally there could be some kind of sort function here,
+;;; too.)
+;;; Finally the list is sorted to gutter display order, and the tab data
+;;; structure is created and returned.
+;;; #### Docstring isn't very well expressed.
+(defun buffers-tab-items (&optional in-deletion frame force-selection)
"This is the tab filter for the top-level buffers \"Buffers\" tab.
It dynamically creates a list of buffers to use as the contents of the tab.
Only the most-recently-used few buffers will be listed on the tab, for
efficiency reasons. You can control how many buffers will be shown by
setting `buffers-tab-max-size'. You can control the text of the tab
items by redefining the function `format-buffers-menu-line'."
- (let ((buffers (delete-if buffers-tab-omit-function (buffer-list))))
- (and (integerp buffers-tab-max-size)
- (> buffers-tab-max-size 1)
- (> (length buffers) buffers-tab-max-size)
- ;; shorten list of buffers
- (setcdr (nthcdr buffers-tab-max-size buffers) nil))
- (setq buffers (build-buffers-tab-internal buffers))
- buffers))
+ (save-match-data
+ (let* ((buffers (delete-if buffers-tab-omit-function (buffer-list frame)))
+ (first-buf (car buffers)))
+ ;; maybe force the selected window
+ (when (and force-selection
+ (not in-deletion)
+ (not (eq first-buf (window-buffer (selected-window frame)))))
+ (setq buffers (cons (window-buffer (selected-window frame))
+ (delq first-buf buffers))))
+ ;; if we're in deletion ignore the current buffer
+ (when in-deletion
+ (setq buffers (delq (current-buffer) buffers))
+ (setq first-buf (car buffers)))
+ ;; select buffers in group (default is by mode)
+ (when buffers-tab-selection-function
+ (delete-if-not #'(lambda (buf)
+ (funcall buffers-tab-selection-function
+ first-buf buf)) buffers))
+ ;; maybe shorten list of buffers
+ (and (integerp buffers-tab-max-size)
+ (> buffers-tab-max-size 1)
+ (> (length buffers) buffers-tab-max-size)
+ (setcdr (nthcdr buffers-tab-max-size buffers) nil))
+ ;; sort buffers in group (default is most-recently-selected)
+ (when buffers-tab-sort-function
+ (setq buffers (funcall buffers-tab-sort-function buffers)))
+ ;; convert list of buffers to list of structures used by tab widget
+ (setq buffers (build-buffers-tab-internal buffers))
+ buffers)))
(defun add-tab-to-gutter ()
"Put a tab control in the gutter area to hold the most recent buffers."
- (let ((gutter-string ""))
+ (setq gutter-buffers-tab-orientation (default-gutter-position))
+ (let ((gutter-string "\n"))
+ (unless gutter-buffers-tab-extent
+ (setq gutter-buffers-tab-extent (make-extent 0 1 gutter-string)))
(set-extent-begin-glyph
- (make-extent 0 0 gutter-string)
+ gutter-buffers-tab-extent
(setq gutter-buffers-tab
(make-glyph
- (vector 'tab-control :descriptor "Buffers"
- :properties (list :items (buffers-tab-items))))))
- ;; This looks better than a 3d border
- (set-specifier default-gutter-border-width 0 'global 'mswindows)
- (set-specifier default-gutter gutter-string 'global 'mswindows)))
+ (vector 'tab-control :descriptor "Buffers" :face buffers-tab-face
+ :orientation gutter-buffers-tab-orientation
+ (if (or (eq gutter-buffers-tab-orientation 'top)
+ (eq gutter-buffers-tab-orientation 'bottom))
+ :pixel-width :pixel-height)
+ (if (or (eq gutter-buffers-tab-orientation 'top)
+ (eq gutter-buffers-tab-orientation 'bottom))
+ '(gutter-pixel-width) '(gutter-pixel-height))
+ :properties (list :items (buffers-tab-items nil nil t))))))
+
+ ;; Nuke all existing tabs
+ (remove-gutter-element top-gutter 'buffers-tab)
+ (remove-gutter-element bottom-gutter 'buffers-tab)
+ (remove-gutter-element left-gutter 'buffers-tab)
+ (remove-gutter-element right-gutter 'buffers-tab)
+ ;; Put tabs into all devices that will be able to display them
+ (mapcar
+ #'(lambda (x)
+ (when (valid-image-instantiator-format-p 'tab-control x)
+ (cond ((eq gutter-buffers-tab-orientation 'top)
+ ;; This looks better than a 3d border
+ (set-specifier top-gutter-border-width 0 'global x)
+ (set-gutter-element top-gutter 'buffers-tab
+ gutter-string 'global x))
+ ((eq gutter-buffers-tab-orientation 'bottom)
+ (set-specifier bottom-gutter-border-width 0 'global x)
+ (set-gutter-element bottom-gutter 'buffers-tab
+ gutter-string 'global x))
+ ((eq gutter-buffers-tab-orientation 'left)
+ (set-specifier left-gutter-border-width 0 'global x)
+ (set-gutter-element left-gutter 'buffers-tab
+ gutter-string 'global x)
+ (set-specifier left-gutter-width
+ (glyph-width gutter-buffers-tab)
+ 'global x))
+ ((eq gutter-buffers-tab-orientation 'right)
+ (set-specifier right-gutter-border-width 0 'global x)
+ (set-gutter-element right-gutter 'buffers-tab
+ gutter-string 'global x)
+ (set-specifier right-gutter-width
+ (glyph-width gutter-buffers-tab)
+ 'global x))
+ )))
+ (console-type-list))))
-(defun update-tab-in-gutter (&optional notused)
+(defun update-tab-in-gutter (&optional frame-or-buffer force-selection)
"Update the tab control in the gutter area."
- (when (valid-image-instantiator-format-p 'tab-control)
- (set-image-instance-property (glyph-image-instance gutter-buffers-tab)
- :items
- (buffers-tab-items))
- (resize-subwindow (glyph-image-instance gutter-buffers-tab)
- (gutter-pixel-width) nil)))
-
-(add-tab-to-gutter)
-(add-hook 'switch-to-buffer-hooks 'update-tab-in-gutter)
-(add-hook 'create-frame-hook 'update-tab-in-gutter)
+ (let ((locale (if (framep frame-or-buffer) frame-or-buffer)))
+ ;; dedicated frames don't get tabs
+ (unless (and (framep locale)
+ (window-dedicated-p (frame-selected-window locale)))
+ (when (specifier-instance default-gutter-visible-p locale)
+ (unless (and gutter-buffers-tab
+ (eq (default-gutter-position)
+ gutter-buffers-tab-orientation))
+ (add-tab-to-gutter))
+ (when (valid-image-instantiator-format-p 'tab-control locale)
+ (let ((inst (glyph-image-instance
+ gutter-buffers-tab
+ (when (framep frame-or-buffer)
+ (last-nonminibuf-window frame-or-buffer)))))
+ (set-image-instance-property inst :items
+ (buffers-tab-items
+ nil locale force-selection))))))))
+
+(defun remove-buffer-from-gutter-tab ()
+ "Remove the current buffer from the tab control in the gutter area."
+ (when (and (valid-image-instantiator-format-p 'tab-control)
+ (specifier-instance default-gutter-visible-p))
+ (let ((inst (glyph-image-instance gutter-buffers-tab))
+ (buffers (buffers-tab-items t)))
+ (unless buffers
+ (setq buffers (build-buffers-tab-internal
+ (list
+ (get-buffer-create "*scratch*")))))
+ (set-image-instance-property inst :items buffers))))
+
+;; A myriad of different update hooks all doing slightly different things
+(add-hook 'kill-buffer-hook 'remove-buffer-from-gutter-tab)
+(add-hook 'create-frame-hook
+ #'(lambda (frame)
+ (when gutter-buffers-tab (update-tab-in-gutter frame t))))
+(add-hook 'record-buffer-hook 'update-tab-in-gutter)
+(add-hook 'default-gutter-position-changed
+ #'(lambda (arg)
+ (when gutter-buffers-tab (update-tab-in-gutter arg))))
+(add-hook 'gutter-element-visibility-changed-hook
+ #'(lambda (prop visible-p)
+ (when (and (eq prop 'buffers-tab) visible-p)
+ (update-tab-in-gutter))))
+
+;;
+;; progress display
+;; ripped off from message display
+;;
+(defcustom progress-display-use-echo-area nil
+ "*Whether progress gauge display should display in the echo area.
+If NIL then progress gauges will be displayed with whatever native widgets
+are available on the current console. If non-NIL then progress display will be
+textual and displayed in the echo area."
+ :type 'boolean
+ :group 'gutter)
+
+(defvar progress-stack nil
+ "An alist of label/string pairs representing active progress gauges.
+The first element in the list is currently displayed in the gutter area.
+Do not modify this directly--use the `progress-display' or
+`display-progress-display'/`clear-progress-display' functions.")
+
+(defvar progress-glyph-height 32
+ "Height of the gutter area for progress messages.")
+
+(defvar progress-display-stop-callback 'progress-display-quit-function
+ "Function to call to stop the progress operation.")
+
+(defvar progress-display-popup-period 0.5
+ "The time that the progress gauge should remain up after completion")
+
+(defun progress-display-quit-function ()
+ "Default function to call for the stop button in a progress gauge.
+This just removes the progress gauge and calls quit."
+ (interactive)
+ (clear-progress-display)
+ (keyboard-quit))
+
+;; private variables
+(defvar progress-gauge-glyph
+ (make-glyph
+ (vector 'progress-gauge
+ :pixel-height (- progress-glyph-height 8)
+ :pixel-width 250
+ :descriptor "Progress")))
+
+(defvar progress-text-glyph
+ (make-glyph [string :data ""]))
+
+(defvar progress-layout-glyph
+ (make-glyph
+ (vector
+ 'layout :orientation 'vertical :justify 'left
+ :items (list
+ progress-text-glyph
+ (make-glyph
+ (vector
+ 'layout :pixel-height progress-glyph-height
+ :orientation 'horizontal
+ :items (list
+ progress-gauge-glyph
+ (vector
+ 'button :pixel-height (- progress-glyph-height 8)
+ :descriptor " Stop "
+ :callback '(funcall progress-display-stop-callback)))))))))
+
+(defvar progress-abort-glyph
+ (make-glyph
+ (vector 'layout :orientation 'vertical :justify 'left
+ :items (list progress-text-glyph
+ (make-glyph
+ (vector 'layout
+ :pixel-height progress-glyph-height
+ :orientation 'horizontal))))))
+
+(defvar progress-extent-text "\n")
+(defvar progress-extent nil)
+
+(defun progress-displayed-p (&optional return-string frame)
+ "Return a non-nil value if a progress gauge is presently displayed in the
+gutter area. If optional argument RETURN-STRING is non-nil,
+return a string containing the message, otherwise just return t."
+ (let ((buffer (get-buffer-create " *Gutter Area*")))
+ (and (< (point-min buffer) (point-max buffer))
+ (if return-string
+ (buffer-substring nil nil buffer)
+ t))))
+
+;;; Returns the string which remains in the echo area, or nil if none.
+;;; If label is nil, the whole message stack is cleared.
+(defun clear-progress-display (&optional label frame no-restore)
+ "Remove any progress gauge with LABEL from the progress gauge-stack,
+erasing it from the gutter area if it's currently displayed there.
+If a message remains at the head of the progress-stack and NO-RESTORE
+is nil, it will be displayed. The string which remains in the gutter
+area will be returned, or nil if the progress-stack is now empty.
+If LABEL is nil, the entire progress-stack is cleared.
+
+Unless you need the return value or you need to specify a label,
+you should just use (progress nil)."
+ (if (or (not (valid-image-instantiator-format-p 'progress-gauge frame))
+ progress-display-use-echo-area)
+ (clear-message label frame nil no-restore)
+ (or frame (setq frame (selected-frame)))
+ (remove-progress-display label frame)
+ (let ((inhibit-read-only t)
+ (zmacs-region-stays zmacs-region-stays)) ; preserve from change
+ (erase-buffer (get-buffer-create " *Gutter Area*")))
+ (if no-restore
+ nil ; just preparing to put another msg up
+ (if progress-stack
+ (let ((oldmsg (cdr (car progress-stack))))
+ (raw-append-progress-display oldmsg frame)
+ oldmsg)
+ ;; nothing to display so get rid of the gauge
+ (set-specifier bottom-gutter-border-width 0 frame)
+ (set-gutter-element-visible-p bottom-gutter-visible-p
+ 'progress nil frame)))))
+
+(defun progress-display-clear-when-idle (&optional label)
+ (add-hook 'pre-idle-hook
+ (defun progress-display-clear-pre-idle-hook ()
+ (clear-progress-display label)
+ (remove-hook 'pre-idle-hook
+ 'progress-display-clear-pre-idle-hook))))
+
+(defun remove-progress-display (&optional label frame)
+ ;; If label is nil, we want to remove all matching progress gauges.
+ (while (and progress-stack
+ (or (null label) ; null label means clear whole stack
+ (eq label (car (car progress-stack)))))
+ (setq progress-stack (cdr progress-stack)))
+ (let ((s progress-stack))
+ (while (cdr s)
+ (let ((msg (car (cdr s))))
+ (if (eq label (car msg))
+ (progn
+ (setcdr s (cdr (cdr s))))
+ (setq s (cdr s)))))))
+
+(defun append-progress-display (label message &optional value frame)
+ (or frame (setq frame (selected-frame)))
+ ;; Add a new entry to the message-stack, or modify an existing one
+ (let* ((top (car progress-stack))
+ (tmsg (cdr top)))
+ (if (eq label (car top))
+ (progn
+ (setcdr top message)
+ (if (equal tmsg message)
+ (set-image-instance-property
+ (glyph-image-instance progress-gauge-glyph)
+ :percent value)
+ (raw-append-progress-display message value frame))
+ (redisplay-gutter-area))
+ (push (cons label message) progress-stack)
+ (raw-append-progress-display message value frame))
+ (dispatch-non-command-events)
+ ;; either get command events or sit waiting for them
+ (if (not (eq value 100))
+ (when (input-pending-p)
+ (dispatch-event (next-command-event)))
+ (sit-for progress-display-popup-period nil)
+ (clear-progress-display label))))
+
+(defun abort-progress-display (label message &optional frame)
+ (if (or (not (valid-image-instantiator-format-p 'progress-gauge frame))
+ progress-display-use-echo-area)
+ (display-message label (concat message "aborted.") frame)
+ (or frame (setq frame (selected-frame)))
+ ;; Add a new entry to the message-stack, or modify an existing one
+ (let* ((top (car progress-stack))
+ (inhibit-read-only t)
+ (zmacs-region-stays zmacs-region-stays))
+ (if (eq label (car top))
+ (setcdr top message)
+ (push (cons label message) progress-stack))
+ (unless (equal message "")
+ (insert-string message (get-buffer-create " *Gutter Area*"))
+ ;; Do what the device is able to cope with.
+ ;; do some funky display here.
+ (unless progress-extent
+ (setq progress-extent (make-extent 0 1 progress-extent-text)))
+ (let ((bglyph (extent-begin-glyph progress-extent)))
+ (set-extent-begin-glyph progress-extent progress-abort-glyph)
+ ;; fixup the gutter specifiers
+ (set-gutter-element bottom-gutter
+ 'progress progress-extent-text frame)
+ (set-specifier bottom-gutter-border-width 2 frame)
+ (set-image-instance-property
+ (glyph-image-instance progress-text-glyph) :data message)
+ (set-specifier bottom-gutter-height 'autodetect frame)
+ (set-gutter-element-visible-p bottom-gutter-visible-p
+ 'progress t frame)
+ ;; we have to do this so redisplay is up-to-date and so
+ ;; redisplay-gutter-area performs optimally.
+ (redisplay-gutter-area)
+ (sit-for progress-display-popup-period nil)
+ (clear-progress-display label)
+ (set-extent-begin-glyph progress-extent bglyph)
+ )))))
+
+(defun raw-append-progress-display (message &optional value frame)
+ (unless (equal message "")
+ (let ((inhibit-read-only t)
+ (zmacs-region-stays zmacs-region-stays)
+ (val (or value 0)))
+ (insert-string message (get-buffer-create " *Gutter Area*"))
+ ;; do some funky display here.
+ (unless progress-extent
+ (setq progress-extent (make-extent 0 1 progress-extent-text))
+ (set-extent-begin-glyph progress-extent progress-layout-glyph))
+ ;; fixup the gutter specifiers
+ (set-gutter-element bottom-gutter 'progress progress-extent-text frame)
+ (set-specifier bottom-gutter-border-width 2 frame)
+ (set-image-instance-property
+ (glyph-image-instance progress-gauge-glyph) :percent val)
+ (set-image-instance-property
+ (glyph-image-instance progress-text-glyph) :data message)
+ (if (and (eq (specifier-instance bottom-gutter-height frame)
+ 'autodetect)
+ (gutter-element-visible-p bottom-gutter-visible-p
+ 'progress frame))
+ (progn
+ ;; if the gauge is already visible then just draw the gutter
+ ;; checking for user events
+ (redisplay-gutter-area)
+ (dispatch-non-command-events)
+ (when (input-pending-p)
+ (dispatch-event (next-command-event))))
+ ;; otherwise make the gutter visible and redraw the frame
+ (set-specifier bottom-gutter-height 'autodetect frame)
+ (set-gutter-element-visible-p bottom-gutter-visible-p
+ 'progress t frame)
+ ;; we have to do this so redisplay is up-to-date and so
+ ;; redisplay-gutter-area performs optimally. This may also
+ ;; make sure the frame geometry looks ok.
+ (dispatch-non-command-events)
+ (redisplay-frame)
+ ))))
+
+(defun display-progress-display (label message &optional value frame)
+ "Display a progress gauge and message in the bottom gutter area.
+ First argument LABEL is an identifier for this message. MESSAGE is
+the string to display. Use `clear-progress-display' to remove a labelled
+message."
+ (cond ((eq value 'abort)
+ (abort-progress-display label message frame))
+ ((or (not (valid-image-instantiator-format-p 'progress-gauge frame))
+ progress-display-use-echo-area)
+ (display-message label
+ (concat message (if (eq value 100) "done."
+ (make-string (/ value 5) ?.)))
+ frame))
+ (t
+ (append-progress-display label message value frame))))
+
+(defun current-progress-display (&optional frame)
+ "Return the current progress gauge in the gutter area, or nil.
+The FRAME argument is currently unused."
+ (cdr (car progress-stack)))
+
+;;; may eventually be frame-dependent
+(defun current-progress-display-label (&optional frame)
+ (car (car progress-stack)))
+
+(defun progress-display (fmt &optional value &rest args)
+ "Print a progress gauge and message in the bottom gutter area of the frame.
+The arguments are the same as to `format'.
+
+If the only argument is nil, clear any existing progress gauge."
+ (save-excursion
+ (if (and (null fmt) (null args))
+ (prog1 nil
+ (clear-progress-display nil))
+ (let ((str (apply 'format fmt args)))
+ (display-progress-display 'progress str value)
+ str))))
+
+(defun lprogress-display (label fmt &optional value &rest args)
+ "Print a progress gauge and message in the bottom gutter area of the frame.
+First argument LABEL is an identifier for this progress gauge. The rest of the
+arguments are the same as to `format'."
+ ;; #### sometimes the buffer gets changed temporarily. I don't know
+ ;; why this is, so protect against it.
+ (save-excursion
+ (if (and (null fmt) (null args))
+ (prog1 nil
+ (clear-progress-display label nil))
+ (let ((str (apply 'format fmt args)))
+ (display-progress-display label str value)
+ str))))
(provide 'gutter-items)
;;; gutter-items.el ends here.
projects / chise / xemacs-chise.git.1 / blobdiff