Mercurial > hg > xemacs-beta
view lisp/gutter-items.el @ 665:fdefd0186b75
[xemacs-hg @ 2001-09-20 06:28:42 by ben]
The great integral types renaming.
The purpose of this is to rationalize the names used for various
integral types, so that they match their intended uses and follow
consist conventions, and eliminate types that were not semantically
different from each other.
The conventions are:
-- All integral types that measure quantities of anything are
signed. Some people disagree vociferously with this, but their
arguments are mostly theoretical, and are vastly outweighed by
the practical headaches of mixing signed and unsigned values,
and more importantly by the far increased likelihood of
inadvertent bugs: Because of the broken "viral" nature of
unsigned quantities in C (operations involving mixed
signed/unsigned are done unsigned, when exactly the opposite is
nearly always wanted), even a single error in declaring a
quantity unsigned that should be signed, or even the even more
subtle error of comparing signed and unsigned values and
forgetting the necessary cast, can be catastrophic, as
comparisons will yield wrong results. -Wsign-compare is turned
on specifically to catch this, but this tends to result in a
great number of warnings when mixing signed and unsigned, and
the casts are annoying. More has been written on this
elsewhere.
-- All such quantity types just mentioned boil down to EMACS_INT,
which is 32 bits on 32-bit machines and 64 bits on 64-bit
machines. This is guaranteed to be the same size as Lisp
objects of type `int', and (as far as I can tell) of size_t
(unsigned!) and ssize_t. The only type below that is not an
EMACS_INT is Hashcode, which is an unsigned value of the same
size as EMACS_INT.
-- Type names should be relatively short (no more than 10
characters or so), with the first letter capitalized and no
underscores if they can at all be avoided.
-- "count" == a zero-based measurement of some quantity. Includes
sizes, offsets, and indexes.
-- "bpos" == a one-based measurement of a position in a buffer.
"Charbpos" and "Bytebpos" count text in the buffer, rather than
bytes in memory; thus Bytebpos does not directly correspond to
the memory representation. Use "Membpos" for this.
-- "Char" refers to internal-format characters, not to the C type
"char", which is really a byte.
-- For the actual name changes, see the script below.
I ran the following script to do the conversion. (NOTE: This script
is idempotent. You can safely run it multiple times and it will
not screw up previous results -- in fact, it will do nothing if
nothing has changed. Thus, it can be run repeatedly as necessary
to handle patches coming in from old workspaces, or old branches.)
There are two tags, just before and just after the change:
`pre-integral-type-rename' and `post-integral-type-rename'. When
merging code from the main trunk into a branch, the best thing to
do is first merge up to `pre-integral-type-rename', then apply the
script and associated changes, then merge from
`post-integral-type-change' to the present. (Alternatively, just do
the merging in one operation; but you may then have a lot of
conflicts needing to be resolved by hand.)
Script `fixtypes.sh' follows:
----------------------------------- cut ------------------------------------
files="*.[ch] s/*.h m/*.h config.h.in ../configure.in Makefile.in.in ../lib-src/*.[ch] ../lwlib/*.[ch]"
gr Memory_Count Bytecount $files
gr Lstream_Data_Count Bytecount $files
gr Element_Count Elemcount $files
gr Hash_Code Hashcode $files
gr extcount bytecount $files
gr bufpos charbpos $files
gr bytind bytebpos $files
gr memind membpos $files
gr bufbyte intbyte $files
gr Extcount Bytecount $files
gr Bufpos Charbpos $files
gr Bytind Bytebpos $files
gr Memind Membpos $files
gr Bufbyte Intbyte $files
gr EXTCOUNT BYTECOUNT $files
gr BUFPOS CHARBPOS $files
gr BYTIND BYTEBPOS $files
gr MEMIND MEMBPOS $files
gr BUFBYTE INTBYTE $files
gr MEMORY_COUNT BYTECOUNT $files
gr LSTREAM_DATA_COUNT BYTECOUNT $files
gr ELEMENT_COUNT ELEMCOUNT $files
gr HASH_CODE HASHCODE $files
----------------------------------- cut ------------------------------------
`fixtypes.sh' is a Bourne-shell script; it uses 'gr':
----------------------------------- cut ------------------------------------
#!/bin/sh
# Usage is like this:
# gr FROM TO FILES ...
# globally replace FROM with TO in FILES. FROM and TO are regular expressions.
# backup files are stored in the `backup' directory.
from="$1"
to="$2"
shift 2
echo ${1+"$@"} | xargs global-replace "s/$from/$to/g"
----------------------------------- cut ------------------------------------
`gr' in turn uses a Perl script to do its real work,
`global-replace', which follows:
----------------------------------- cut ------------------------------------
: #-*- Perl -*-
### global-modify --- modify the contents of a file by a Perl expression
## Copyright (C) 1999 Martin Buchholz.
## Copyright (C) 2001 Ben Wing.
## Authors: Martin Buchholz <martin@xemacs.org>, Ben Wing <ben@xemacs.org>
## Maintainer: Ben Wing <ben@xemacs.org>
## Current Version: 1.0, May 5, 2001
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with XEmacs; see the file COPYING. If not, write to the Free
# Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
eval 'exec perl -w -S $0 ${1+"$@"}'
if 0;
use strict;
use FileHandle;
use Carp;
use Getopt::Long;
use File::Basename;
(my $myName = $0) =~ s@.*/@@; my $usage="
Usage: $myName [--help] [--backup-dir=DIR] [--line-mode] [--hunk-mode]
PERLEXPR FILE ...
Globally modify a file, either line by line or in one big hunk.
Typical usage is like this:
[with GNU print, GNU xargs: guaranteed to handle spaces, quotes, etc.
in file names]
find . -name '*.[ch]' -print0 | xargs -0 $0 's/\bCONST\b/const/g'\n
[with non-GNU print, xargs]
find . -name '*.[ch]' -print | xargs $0 's/\bCONST\b/const/g'\n
The file is read in, either line by line (with --line-mode specified)
or in one big hunk (with --hunk-mode specified; it's the default), and
the Perl expression is then evalled with \$_ set to the line or hunk of
text, including the terminating newline if there is one. It should
destructively modify the value there, storing the changed result in \$_.
Files in which any modifications are made are backed up to the directory
specified using --backup-dir, or to `backup' by default. To disable this,
use --backup-dir= with no argument.
Hunk mode is the default because it is MUCH MUCH faster than line-by-line.
Use line-by-line only when it matters, e.g. you want to do a replacement
only once per line (the default without the `g' argument). Conversely,
when using hunk mode, *ALWAYS* use `g'; otherwise, you will only make one
replacement in the entire file!
";
my %options = ();
$Getopt::Long::ignorecase = 0;
&GetOptions (
\%options,
'help', 'backup-dir=s', 'line-mode', 'hunk-mode',
);
die $usage if $options{"help"} or @ARGV <= 1;
my $code = shift;
die $usage if grep (-d || ! -w, @ARGV);
sub SafeOpen {
open ((my $fh = new FileHandle), $_[0]);
confess "Can't open $_[0]: $!" if ! defined $fh;
return $fh;
}
sub SafeClose {
close $_[0] or confess "Can't close $_[0]: $!";
}
sub FileContents {
my $fh = SafeOpen ("< $_[0]");
my $olddollarslash = $/;
local $/ = undef;
my $contents = <$fh>;
$/ = $olddollarslash;
return $contents;
}
sub WriteStringToFile {
my $fh = SafeOpen ("> $_[0]");
binmode $fh;
print $fh $_[1] or confess "$_[0]: $!\n";
SafeClose $fh;
}
foreach my $file (@ARGV) {
my $changed_p = 0;
my $new_contents = "";
if ($options{"line-mode"}) {
my $fh = SafeOpen $file;
while (<$fh>) {
my $save_line = $_;
eval $code;
$changed_p = 1 if $save_line ne $_;
$new_contents .= $_;
}
} else {
my $orig_contents = $_ = FileContents $file;
eval $code;
if ($_ ne $orig_contents) {
$changed_p = 1;
$new_contents = $_;
}
}
if ($changed_p) {
my $backdir = $options{"backup-dir"};
$backdir = "backup" if !defined ($backdir);
if ($backdir) {
my ($name, $path, $suffix) = fileparse ($file, "");
my $backfulldir = $path . $backdir;
my $backfile = "$backfulldir/$name";
mkdir $backfulldir, 0755 unless -d $backfulldir;
print "modifying $file (original saved in $backfile)\n";
rename $file, $backfile;
}
WriteStringToFile ($file, $new_contents);
}
}
----------------------------------- cut ------------------------------------
In addition to those programs, I needed to fix up a few other
things, particularly relating to the duplicate definitions of
types, now that some types merged with others. Specifically:
1. in lisp.h, removed duplicate declarations of Bytecount. The
changed code should now look like this: (In each code snippet
below, the first and last lines are the same as the original, as
are all lines outside of those lines. That allows you to locate
the section to be replaced, and replace the stuff in that
section, verifying that there isn't anything new added that
would need to be kept.)
--------------------------------- snip -------------------------------------
/* Counts of bytes or chars */
typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;
/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef unsigned long Hashcode;
/* ------------------------ dynamic arrays ------------------- */
--------------------------------- snip -------------------------------------
2. in lstream.h, removed duplicate declaration of Bytecount.
Rewrote the comment about this type. The changed code should
now look like this:
--------------------------------- snip -------------------------------------
#endif
/* The have been some arguments over the what the type should be that
specifies a count of bytes in a data block to be written out or read in,
using Lstream_read(), Lstream_write(), and related functions.
Originally it was long, which worked fine; Martin "corrected" these to
size_t and ssize_t on the grounds that this is theoretically cleaner and
is in keeping with the C standards. Unfortunately, this practice is
horribly error-prone due to design flaws in the way that mixed
signed/unsigned arithmetic happens. In fact, by doing this change,
Martin introduced a subtle but fatal error that caused the operation of
sending large mail messages to the SMTP server under Windows to fail.
By putting all values back to be signed, avoiding any signed/unsigned
mixing, the bug immediately went away. The type then in use was
Lstream_Data_Count, so that it be reverted cleanly if a vote came to
that. Now it is Bytecount.
Some earlier comments about why the type must be signed: This MUST BE
SIGNED, since it also is used in functions that return the number of
bytes actually read to or written from in an operation, and these
functions can return -1 to signal error.
Note that the standard Unix read() and write() functions define the
count going in as a size_t, which is UNSIGNED, and the count going
out as an ssize_t, which is SIGNED. This is a horrible design
flaw. Not only is it highly likely to lead to logic errors when a
-1 gets interpreted as a large positive number, but operations are
bound to fail in all sorts of horrible ways when a number in the
upper-half of the size_t range is passed in -- this number is
unrepresentable as an ssize_t, so code that checks to see how many
bytes are actually written (which is mandatory if you are dealing
with certain types of devices) will get completely screwed up.
--ben
*/
typedef enum lstream_buffering
--------------------------------- snip -------------------------------------
3. in dumper.c, there are four places, all inside of switch()
statements, where XD_BYTECOUNT appears twice as a case tag. In
each case, the two case blocks contain identical code, and you
should *REMOVE THE SECOND* and leave the first.
| author | ben |
|---|---|
| date | Thu, 20 Sep 2001 06:31:11 +0000 |
| parents | 7039e6323819 |
| children | 943eaba38521 |
line wrap: on
line source
;;; gutter-items.el --- Gutter content for XEmacs. ;; Copyright (C) 1999 Free Software Foundation, Inc. ;; Copyright (C) 1999, 2000 Andy Piper. ;; Copyright (C) 2000 Ben Wing. ;; Maintainer: XEmacs Development Team ;; Keywords: frames, extensions, internal, dumped ;; This file is part of XEmacs. ;; XEmacs is free software; you can redistribute it and/or modify it ;; under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. ;; XEmacs is distributed in the hope that it will be useful, but ;; WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ;; General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with Xmacs; see the file COPYING. If not, write to the ;; Free Software Foundation, 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;; Some of this is taken from the buffer-menu stuff in menubar-items.el ;;; The Buffers tab (defgroup buffers-tab nil "Customization of `Buffers' tab." :group 'gutter) (defvar gutter-buffers-tab nil "A tab widget in the gutter for displaying buffers. Do not set this. Use `set-glyph-image' 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))) (defcustom gutter-buffers-tab-enabled t "*Whether to enable support for buffers tab in the gutter. This is different to `gutter-buffers-tab-visible-p' which still runs hooks even when the gutter is invisible." :group 'buffers-tab :type 'boolean) (defvar gutter-buffers-tab-orientation 'top "Where the buffers tab currently is. Do not set this.") (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 6)) :group 'buffers-tab) (defcustom buffers-tab-switch-to-buffer-function 'buffers-tab-switch-to-buffer "*The function to call to select a buffer from the buffers tab. `switch-to-buffer' is a good choice, as is `pop-to-buffer'." :type '(radio (function-item switch-to-buffer) (function-item pop-to-buffer) (function :tag "Other")) :group 'buffers-tab) (defcustom buffers-tab-omit-function 'buffers-menu-omit-invisible-buffers "*If non-nil, a function specifying the buffers to omit from the buffers tab. This is passed a buffer and should return non-nil if the buffer should be omitted. The default value `buffers-menu-omit-invisible-buffers' omits buffers that are normally considered \"invisible\" (those whose name begins with a space)." :type '(choice (const :tag "None" nil) function) :group 'buffers-tab) (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-filter-functions (list buffers-tab-selection-function) "*If non-nil, a list of functions specifying the buffers to select from the buffers tab. Each function in the list is passed two buffers, the buffer to potentially select and the context buffer, and should return non-nil if the first buffer should be selected. The default value groups buffers by major mode and by `buffers-tab-grouping-regexp'." :type '(choice (const :tag "None" nil) sexp) :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-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'." (unless (eq (window-buffer) buffer) ;; this used to add the norecord flag to both calls below. ;; this is bogus because it is a pervasive assumption in XEmacs ;; that the current buffer is at the front of the buffers list. ;; for example, select an item and then do M-C-l ;; (switch-to-other-buffer). Things get way confused. (if (> (length (windows-of-buffer buffer)) 0) (select-window (car (windows-of-buffer buffer))) (switch-to-buffer buffer)))) (defun select-buffers-tab-buffers-by-mode (buffer-to-select buf1) "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 buffer-to-select))) (modenm1 (symbol-value-in-buffer 'mode-name buf1)) (modenm2 (symbol-value-in-buffer 'mode-name buffer-to-select))) (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 ((selected t)) (mapcar #'(lambda (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))) ;;; #### SJT would like this function to have a sort function list. I ;;; don't see how this could work given that sorting is not ;;; cumulative --andyp. (defun buffers-tab-items (&optional in-deletion frame force-selection) "Return a list of tab instantiators based on the current buffers list. This function is used as the tab filter for the top-level buffers \"Buffers\" tab. It dynamically creates a list of tab instantiators to use as the contents of the tab. The contents and order of the list is controlled by `buffers-tab-filter-functions' which by default groups buffers according to major mode and removes invisible buffers. 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'." (save-match-data ;; NB it is too late if we run the omit function as part of the ;; filter functions because we need to know which buffer is the ;; context buffer before they get run. (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))) ;; filter buffers (when buffers-tab-filter-functions (setq buffers (delete-if #'null (mapcar #'(lambda (buf) (let ((tmp-buf buf)) (mapc #'(lambda (fun) (unless (funcall fun buf first-buf) (setq tmp-buf nil))) buffers-tab-filter-functions) tmp-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 (1- 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." (setq gutter-buffers-tab-orientation (default-gutter-position)) (let* ((gutter-string (copy-sequence "\n")) (gutter-buffers-tab-extent (make-extent 0 1 gutter-string))) (set-extent-begin-glyph gutter-buffers-tab-extent (setq gutter-buffers-tab (make-glyph))) ;; 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)) ((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)) ))) (console-type-list)))) (defun update-tab-in-gutter (frame &optional force-selection) "Update the tab control in the gutter area." ;; dedicated frames don't get tabs (unless (or (window-dedicated-p (frame-selected-window frame)) (frame-property frame 'popup)) (when (specifier-instance default-gutter-visible-p frame) (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 frame) (let ((items (buffers-tab-items nil frame force-selection))) (when items (set-glyph-image gutter-buffers-tab (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)) :items items) frame) ;; set-glyph-image will not make the gutter dirty (set-gutter-dirty-p gutter-buffers-tab-orientation))))))) ;; A myriad of different update hooks all doing slightly different things (add-one-shot-hook 'after-init-hook #'(lambda () ;; don't add the hooks if the user really doesn't want them (when gutter-buffers-tab-enabled (add-hook 'create-frame-hook #'(lambda (frame) (when gutter-buffers-tab (update-tab-in-gutter frame t)))) (add-hook 'buffer-list-changed-hook 'update-tab-in-gutter) (add-hook 'default-gutter-position-changed-hook #'(lambda () (when gutter-buffers-tab (mapc #'update-tab-in-gutter (frame-list))))) (add-hook 'gutter-element-visibility-changed-hook #'(lambda (prop visible-p) (when (and (eq prop 'buffers-tab) visible-p) (mapc #'update-tab-in-gutter (frame-list))))) (update-tab-in-gutter (selected-frame) t)))) ;; ;; progress display ;; ripped off from message display ;; (defcustom progress-feedback-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-glyph-height 24 "Height of the progress gauge glyph.") (defvar progress-feedback-popup-period 0.5 "The time that the progress gauge should remain up after completion") (defcustom progress-feedback-style 'large "*Control the appearance of the progress gauge. If 'large, the default, then the progress-feedback text is displayed above the gauge itself. If 'small then the gauge and text are arranged side-by-side." :group 'gutter :type '(choice (const :tag "large" large) (const :tag "small" small))) ;; private variables (defvar progress-text-instantiator [string :data ""]) (defvar progress-layout-glyph (make-glyph)) (defvar progress-layout-instantiator nil) (defvar progress-gauge-instantiator [progress-gauge :value 0 :pixel-height (eval progress-glyph-height) :pixel-width 250 :descriptor "Progress"]) (defun set-progress-feedback-instantiator (&optional locale) (cond ((eq progress-feedback-style 'small) (setq progress-glyph-height 16) (setq progress-layout-instantiator `[layout :orientation horizontal :margin-width 4 :items (,progress-gauge-instantiator [button :pixel-height (eval progress-glyph-height) ;; 'quit is special and acts "asynchronously". :descriptor "Stop" :callback 'quit] ,progress-text-instantiator)]) (set-glyph-image progress-layout-glyph progress-layout-instantiator locale)) (t (setq progress-glyph-height 24) (setq progress-layout-instantiator `[layout :orientation vertical :justify left :margin-width 4 :items (,progress-text-instantiator [layout :orientation horizontal :items (,progress-gauge-instantiator [button :pixel-height (eval progress-glyph-height) :descriptor " Stop " ;; 'quit is special and acts "asynchronously". :callback 'quit])])]) (set-glyph-image progress-layout-glyph progress-layout-instantiator locale)))) (defvar progress-abort-glyph (make-glyph)) (defun set-progress-abort-instantiator (&optional locale) (set-glyph-image progress-abort-glyph `[layout :orientation vertical :justify left :items (,progress-text-instantiator [layout :margin-width 4 :pixel-height progress-glyph-height :orientation horizontal])] locale)) (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-feedback' or `display-progress-feedback'/`clear-progress-feedback' functions.") (defun progress-feedback-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-feedback (&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-feedback-use-echo-area) (clear-message label frame nil no-restore) (or frame (setq frame (selected-frame))) (remove-progress-feedback label frame) (let ((inhibit-read-only t)) (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-feedback oldmsg nil 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-feedback-clear-when-idle (&optional label) (add-one-shot-hook 'pre-idle-hook `(lambda () (clear-progress-feedback ',label)))) (defun remove-progress-feedback (&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 progress-feedback-dispatch-non-command-events () ;; don't allow errors to hose things (condition-case t ;; (sit-for 0) is too agressive and cause more display than we ;; want. (dispatch-non-command-events) nil)) (defun append-progress-feedback (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) (progn (set-instantiator-property progress-gauge-instantiator :value value) (set-progress-feedback-instantiator (frame-selected-window frame))) (raw-append-progress-feedback message value frame)) (redisplay-gutter-area)) (push (cons label message) progress-stack) (raw-append-progress-feedback message value frame)) (progress-feedback-dispatch-non-command-events) ;; either get command events or sit waiting for them (when (eq value 100) ; (sit-for progress-feedback-popup-period nil) (clear-progress-feedback label)))) (defun abort-progress-feedback (label message &optional frame) (if (or (not (valid-image-instantiator-format-p 'progress-gauge frame)) progress-feedback-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)) (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*")) (let* ((gutter-string (copy-sequence "\n")) (ext (make-extent 0 1 gutter-string))) ;; do some funky display here. (set-extent-begin-glyph ext progress-abort-glyph) ;; fixup the gutter specifiers (set-gutter-element bottom-gutter 'progress gutter-string frame) (set-specifier bottom-gutter-border-width 2 frame) (set-instantiator-property progress-text-instantiator :data message) (set-progress-abort-instantiator (frame-selected-window 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. (redisplay-gutter-area) (sit-for progress-feedback-popup-period nil) (clear-progress-feedback label frame) (set-extent-begin-glyph ext progress-layout-glyph) (set-gutter-element bottom-gutter 'progress gutter-string frame) ))))) (defun raw-append-progress-feedback (message &optional value frame) (unless (equal message "") (let* ((inhibit-read-only t) (val (or value 0)) (gutter-string (copy-sequence "\n")) (ext (make-extent 0 1 gutter-string))) (insert-string message (get-buffer-create " *Gutter Area*")) ;; do some funky display here. (set-extent-begin-glyph ext progress-layout-glyph) ;; fixup the gutter specifiers (set-gutter-element bottom-gutter 'progress gutter-string frame) (set-specifier bottom-gutter-border-width 2 frame) (set-instantiator-property progress-gauge-instantiator :value val) (set-progress-feedback-instantiator (frame-selected-window frame)) (set-instantiator-property progress-text-instantiator :data message) (set-progress-feedback-instantiator (frame-selected-window frame)) (if (and (eq (specifier-instance bottom-gutter-height frame) 'autodetect) (gutter-element-visible-p bottom-gutter-visible-p 'progress frame)) ;; if the gauge is already visible then just draw the gutter ;; checking for user events (progn (redisplay-gutter-area) (progress-feedback-dispatch-non-command-events)) ;; 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. (progress-feedback-dispatch-non-command-events) (redisplay-frame frame) )))) (defun display-progress-feedback (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-feedback' to remove a labelled message." (cond ((eq value 'abort) (abort-progress-feedback label message frame)) ((or (not (valid-image-instantiator-format-p 'progress-gauge frame)) progress-feedback-use-echo-area) (display-message label (concat message (if (eq value 100) "done." (make-string (/ value 5) ?.))) frame)) (t (append-progress-feedback label message value frame)))) (defun current-progress-feedback (&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-feedback-label (&optional frame) (car (car progress-stack))) (defun progress-feedback (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-feedback nil)) (let ((str (apply 'format fmt args))) (display-progress-feedback 'progress str value) str)))) (defun progress-feedback-with-label (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-feedback label nil)) (let ((str (apply 'format fmt args))) (display-progress-feedback label str value) str)))) (provide 'gutter-items) ;;; gutter-items.el ends here.