Mercurial > hg > xemacs-beta
view lisp/menubar.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 | a307f9a2021d |
line wrap: on
line source
;;; menubar.el --- Menubar support for XEmacs ;; Copyright (C) 1991-4, 1997-1998 Free Software Foundation, Inc. ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp. ;; Copyright (C) 1995, 1996 Ben Wing. ;; Maintainer: XEmacs Development Team ;; Keywords: internal, extensions, 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 XEmacs; see the file COPYING. If not, write to the ;; Free Software Foundation, 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;;; Synched up with: Not in FSF. (Completely divergent from FSF menu-bar.el) ;;; Commentary: ;; This file is dumped with XEmacs (when menubar support is compiled in). ;; Some stuff in FSF menu-bar.el is in menubar-items.el ;;; Code: (defgroup menu nil "Input from the menus." :group 'environment) (defvar default-menubar nil) ;; this function is considered "part of the lexicon" by many, ;; so we'll leave it here. (defun kill-this-buffer () ; for the menubar "Kill the current buffer." (interactive) (kill-buffer (current-buffer))) (defun set-menubar-dirty-flag () "Tell XEmacs that the menubar has to be updated. NOTE: XEmacs now recognizes when you set a different value for `current-menubar'. You *only* need to call this function if you destructively modify a part of the menubar and don't set `current-menubar'. Note that all the functions that modify a menu call this automatically." (setq-default current-menubar (default-value 'current-menubar))) ;; #### shouldn't this perhaps be `copy-tree'? (defun set-menubar (menubar) "Set the default menubar to be MENUBAR. See `current-menubar' for a description of the syntax of a menubar." (check-menu-syntax menubar t) (setq-default current-menubar (copy-sequence menubar))) (defun set-buffer-menubar (menubar) "Set the buffer-local menubar to be MENUBAR. See `current-menubar' for a description of the syntax of a menubar." (check-menu-syntax menubar t) (make-local-variable 'current-menubar) (setq current-menubar (copy-sequence menubar))) (defun check-menu-syntax (menu &optional menubar-p) ;; The C code does syntax checking on the value of `current-menubar', ;; but it's better to do it early, before things have gotten messed up. (if menubar-p nil (or (stringp (car menu)) (signal 'error (list "menu name (first element) must be a string" menu))) ;;(or (cdr menu) (signal 'error (list "menu is empty" menu))) (setq menu (cdr menu))) (let (menuitem item) (while (keywordp (setq item (car menu))) (or (memq item '(:config :included :filter :accelerator)) (signal 'error (list "menu keyword must be :config, :included, :accelerator or :filter" item))) (if (or (not (cdr menu)) (vectorp (nth 1 menu)) (keywordp (nth 1 menu))) (signal 'error (list "strange keyword value" item (nth 1 menu)))) (setq menu (nthcdr 2 menu))) (while menu (setq menuitem (car menu)) (cond ((stringp menuitem) (and (string-match "^\\(-+\\|=+\\):\\(.*\\)" menuitem) (setq item (match-string 2 menuitem)) (or (member item '(;; Motif-compatible "singleLine" "doubleLine" "singleDashedLine" "doubleDashedLine" "noLine" "shadowEtchedIn" "shadowEtchedOut" "shadowEtchedInDash" "shadowEtchedOutDash" ;; non-Motif (Lucid menubar widget only) "shadowDoubleEtchedIn" "shadowDoubleEtchedOut" "shadowDoubleEtchedInDash" "shadowDoubleEtchedOutDash" )) (signal 'error (list "bogus separator style in menu item" item))) )) ((null menuitem) (or menubar-p (signal 'error (list "nil is only permitted in the top level of menubars")))) ((consp menuitem) (check-menu-syntax menuitem)) ((vectorp menuitem) (let ((L (length menuitem)) plistp) (and (< L 2) (signal 'error (list "button descriptors must be at least 2 long" menuitem))) (setq plistp (or (>= L 5) (and (> L 2) (keywordp (aref menuitem 2))))) (if plistp (let ((i 2) selp style item) (while (< i L) (setq item (aref menuitem i)) (cond ((not (memq item '(:active :suffix :keys :style :full :included :selected :accelerator))) (signal 'error (list (if (keywordp item) "unknown menu item keyword" "not a keyword") item menuitem))) ((eq item :style) (setq style (aref menuitem (1+ i))) (or (memq style '(nil toggle radio button text)) (signal 'error (list "unknown style" style menuitem)))) ((eq item :selected) (setq selp t)) ) (setq i (+ i (if (eq item :full) 1 2)))) (if (and selp (not (memq style '(toggle button radio)))) (signal 'error (list ":selected only makes sense with :style toggle, radio, or button" menuitem))) ))) ) ;; (t (signal 'error (list "unrecognized menu descriptor" menuitem)))) (t (message "unrecognized menu descriptor %s" (prin1-to-string menuitem)))) (setq menu (cdr menu))))) ;;; menu manipulation functions (defun find-menu-item (menubar item-path-list &optional parent) "Search MENUBAR for item given by ITEM-PATH-LIST starting from PARENT. Returns (ITEM . PARENT), where PARENT is the immediate parent of the item found. If the item does not exist, the car of the returned value is nil. If some menu in the ITEM-PATH-LIST does not exist, an error is signalled." (check-argument-type 'listp item-path-list) (unless parent (setq item-path-list (mapcar 'normalize-menu-item-name item-path-list))) (if (not (consp menubar)) nil (let ((rest menubar) result) (when (stringp (car rest)) (setq rest (cdr rest))) (while (keywordp (car rest)) (setq rest (cddr rest))) (while rest (if (and (car rest) (equal (car item-path-list) (normalize-menu-item-name (cond ((vectorp (car rest)) (aref (car rest) 0)) ((stringp (car rest)) (car rest)) (t (caar rest)))))) (setq result (car rest) rest nil) (setq rest (cdr rest)))) (if (cdr item-path-list) (cond ((consp result) (find-menu-item (cdr result) (cdr item-path-list) result)) (result (signal 'error (list (gettext "not a submenu") result))) (t (signal 'error (list (gettext "no such submenu") (car item-path-list))))) (cons result parent))))) (defun add-menu-item-1 (leaf-p menu-path new-item before in-menu) ;; This code looks like it could be cleaned up some more ;; Do we really need 6 calls to find-menu-item? (when before (setq before (normalize-menu-item-name before))) (let* ((item-name (cond ((vectorp new-item) (aref new-item 0)) ((consp new-item) (car new-item)) (t nil))) (menubar (or in-menu current-menubar)) (menu (condition-case () (car (find-menu-item menubar menu-path)) (error nil))) (item-found (cond ((null item-name) nil) ((not (listp menu)) (signal 'error (list (gettext "not a submenu") menu-path))) (menu (find-menu-item (cdr menu) (list item-name))) (t (find-menu-item menubar (list item-name))) ))) (unless menubar (error "`current-menubar' is nil: can't add menus to it.")) (unless menu (let ((rest menu-path) (so-far menubar)) (while rest ;;; (setq menu (car (find-menu-item (cdr so-far) (list (car rest))))) (setq menu (if (eq so-far menubar) (car (find-menu-item so-far (list (car rest)))) (car (find-menu-item (cdr so-far) (list (car rest)))))) (unless menu (let ((rest2 so-far)) (while (and (cdr rest2) (car (cdr rest2))) (setq rest2 (cdr rest2))) (setcdr rest2 (nconc (list (setq menu (list (car rest)))) (cdr rest2))))) (setq so-far menu) (setq rest (cdr rest))))) (if (and item-found (car item-found)) ;; hack the item in place. (if menu ;; Isn't it very bad form to use nsubstitute for side effects? (nsubstitute new-item (car item-found) menu) (setq current-menubar (nsubstitute new-item (car item-found) current-menubar))) ;; OK, we have to add the whole thing... ;; if BEFORE is specified, try to add it there. (unless menu (setq menu current-menubar)) (when before (setq before (car (find-menu-item menu (list before))))) (let ((rest menu) (added-before nil)) (while rest (if (eq before (car (cdr rest))) (progn (setcdr rest (cons new-item (cdr rest))) (setq rest nil added-before t)) (setq rest (cdr rest)))) (when (not added-before) ;; adding before the first item on the menubar itself is harder (if (and (eq menu menubar) (eq before (car menu))) (setq menu (cons new-item menu) current-menubar menu) ;; otherwise, add the item to the end. (nconc menu (list new-item)))))) (set-menubar-dirty-flag) new-item)) (defun add-menu-button (menu-path menu-leaf &optional before in-menu) "Add a menu item to some menu, creating the menu first if necessary. If the named item exists already, it is changed. MENU-PATH identifies the menu under which the new menu item should be inserted. It is a list of strings; for example, (\"File\") names the top-level \"File\" menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\". MENU-LEAF is a menubar leaf node. See the documentation of `current-menubar'. BEFORE, if provided, is the name of a menu item before which this item should be added, if this item is not on the menu already. If the item is already present, it will not be moved. IN-MENU, if provided, means use that instead of `current-menubar' as the menu to change." ;; Note easymenu.el uses the fact that menu-leaf can be a submenu. (add-menu-item-1 t menu-path menu-leaf before in-menu)) ;; I actually liked the old name better, but the interface has changed too ;; drastically to keep it. --Stig (defun add-submenu (menu-path submenu &optional before in-menu) "Add a menu to the menubar or one of its submenus. If the named menu exists already, it is changed. MENU-PATH identifies the menu under which the new menu should be inserted. It is a list of strings; for example, (\"File\") names the top-level \"File\" menu. (\"File\" \"Foo\") names a hypothetical submenu of \"File\". If MENU-PATH is nil, then the menu will be added to the menubar itself. SUBMENU is the new menu to add. See the documentation of `current-menubar' for the syntax. BEFORE, if provided, is the name of a menu before which this menu should be added, if this menu is not on its parent already. If the menu is already present, it will not be moved. IN-MENU, if provided, means use that instead of `current-menubar' as the menu to change." (check-menu-syntax submenu nil) (add-menu-item-1 nil menu-path submenu before in-menu)) ;; purespace is no more, so this function is unnecessary ;(defun purecopy-menubar (x) ; ;; this calls purecopy on the strings, and the contents of the vectors, ; ;; but not on the vectors themselves, or the conses - those must be ; ;; writable. ; (cond ((vectorp x) ; (let ((i (length x))) ; (while (> i 0) ; (aset x (1- i) (purecopy (aref x (1- i)))) ; (setq i (1- i)))) ; x) ; ((consp x) ; (let ((rest x)) ; (while rest ; (setcar rest (purecopy-menubar (car rest))) ; (setq rest (cdr rest)))) ; x) ; (t ; (purecopy x)))) (defun delete-menu-item (path &optional from-menu) "Remove the named menu item from the menu hierarchy. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. The documentation of `add-submenu' describes menu paths. FROM-MENU, if provided, means use that instead of `current-menubar' as the menu to change." (let* ((pair (condition-case nil (find-menu-item (or from-menu current-menubar) path) (error nil))) (item (car pair)) (parent (or (cdr pair) current-menubar))) (if (not item) nil ;; the menubar is the only special case, because other menus begin ;; with their name. (if (eq parent current-menubar) (setq current-menubar (delq item parent)) (delq item parent)) (set-menubar-dirty-flag) item))) (defun relabel-menu-item (path new-name) "Change the string of the specified menu item. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\" under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the menu item called \"Item\" under the \"Foo\" submenu of \"Menu\". NEW-NAME is the string that the menu item will be printed as from now on." (check-type new-name string) (let* ((menubar current-menubar) (pair (find-menu-item menubar path)) (item (car pair)) (menu (cdr pair))) (or item (signal 'error (list (if menu (gettext "No such menu item") (gettext "No such menu")) path))) (if (and (consp item) (stringp (car item))) (setcar item new-name) (aset item 0 new-name)) (set-menubar-dirty-flag) item)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; ;; these are all bad style. Why in the world would we put evaluable forms ;; into the menubar if we didn't want people to use 'em? ;; x-font-menu.el is the only known offender right now and that ought to be ;; rehashed a bit. ;; (defun enable-menu-item-1 (path toggle-p on-p) (let (menu item) (if (and (vectorp path) (> (length path) 2)) ; limited syntax checking... (setq item path) (let* ((menubar current-menubar) (pair (find-menu-item menubar path))) (setq item (car pair) menu (cdr pair)) (or item (signal 'error (list (if menu "No such menu item" "No such menu") path))) (if (consp item) (error "%S is a menu, not a menu item" path)))) (if (or (> (length item) 4) (and (symbolp (aref item 2)) (= ?: (aref (symbol-name (aref item 2)) 0)))) ;; plist-like syntax (let ((i 2) (keyword (if toggle-p :selected :active)) (ok nil)) (while (< i (length item)) (cond ((eq (aref item i) keyword) (aset item (1+ i) on-p) (setq ok t))) (setq i (+ i 2))) (cond (ok nil) (toggle-p (signal 'error (list "not a toggle menu item" item))) (t ;; Need to copy the item to extend it, sigh... (let ((cons (memq item menu)) (new-item (vconcat item (list keyword on-p)))) (if cons (setcar cons (setq item new-item)) (if menu (error "couldn't find %S on its parent?" item) (error "no %S slot to set: %S" keyword item))))))) ;; positional syntax (if toggle-p (signal 'error (list "not a toggle menu item" item)) (aset item 2 on-p))) (set-menubar-dirty-flag) item)) (defun enable-menu-item (path) "Make the named menu item be selectable. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\" under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"." (enable-menu-item-1 path nil t)) (defun disable-menu-item (path) "Make the named menu item be unselectable. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\" under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"." (enable-menu-item-1 path nil nil)) (defun select-toggle-menu-item (path) "Make the named toggle- or radio-style menu item be in the `selected' state. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\" under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"." (enable-menu-item-1 path t t)) (defun deselect-toggle-menu-item (path) "Make the named toggle- or radio-style menu item be in the `unselected' state. PATH is a list of strings which identify the position of the menu item in the menu hierarchy. (\"File\" \"Save\") means the menu item called \"Save\" under the toplevel \"File\" menu. (\"Menu\" \"Foo\" \"Item\") means the menu item called \"Item\" under the \"Foo\" submenu of \"Menu\"." (enable-menu-item-1 path t nil)) ;;;;;;; popup menus (defvar global-popup-menu nil "The global popup menu. This is present in all modes. See the function `popup-menu' for a description of menu syntax.") (defvar mode-popup-menu nil "The mode-specific popup menu. Automatically buffer local. This is appended to the default items in `global-popup-menu'. See the function `popup-menu' for a description of menu syntax.") (make-variable-buffer-local 'mode-popup-menu) (defvar activate-popup-menu-hook nil "Function or functions run before a mode-specific popup menu is made visible. These functions are called with no arguments, and should interrogate and modify the value of `global-popup-menu' or `mode-popup-menu' as desired. Note: this hook is only run if you use `popup-mode-menu' for activating the global and mode-specific commands; if you have your own binding for button3, this hook won't be run.") (defvar last-popup-menu-event nil "The mouse event that invoked the last popup menu. NOTE: This is EXPERIMENTAL and may change at any time.") (defun popup-mode-menu (&optional event) "Pop up a menu of global and mode-specific commands. The menu is computed by combining `global-popup-menu' and `mode-popup-menu' with any items derived from the `context-menu' property of the extent where the button was clicked." (interactive "_e") (setq last-popup-menu-event (or (and event (button-event-p event) event) (let* ((mouse-pos (mouse-position)) (win (car mouse-pos)) (x (cadr mouse-pos)) (y (cddr mouse-pos)) (edges (window-pixel-edges win)) (winx (first edges)) (winy (second edges)) (x (+ x winx)) (y (+ y winy))) (make-event 'button-press `(button 3 x ,x y ,y channel ,(window-frame win) timestamp ,(current-event-timestamp (cdfw-console win))))))) (run-hooks 'activate-popup-menu-hook) (let* ((context-window (and event (event-window event))) (context-point (and event (event-point event))) (context-extents (and context-window context-point (extents-at context-point (window-buffer context-window) 'context-menu))) (context-menu-items (apply 'append (mapcar #'(lambda (extent) (extent-property extent 'context-menu)) context-extents)))) (popup-menu (progn ;; Merge global-popup-menu and mode-popup-menu (and mode-popup-menu (check-menu-syntax mode-popup-menu)) (let* ((mode-title (and (stringp (car mode-popup-menu)) (car mode-popup-menu))) (mode-items (if mode-title (cdr mode-popup-menu) mode-popup-menu)) (global-title (and (stringp (car global-popup-menu)) (car global-popup-menu))) (global-items (if global-title (cdr global-popup-menu) global-popup-menu)) mode-filters) ;; Strip keywords from local menu for attaching them at the top (while (and mode-items (keywordp (car mode-items))) ;; Push both keyword and its argument. (push (pop mode-items) mode-filters) (push (pop mode-items) mode-filters)) (setq mode-filters (nreverse mode-filters)) ;; If mode-filters contains a keyword already present in ;; `global-popup-menu', you will probably lose. (append (and popup-menu-titles (cond (mode-title (list mode-title)) (global-title (list global-title)) (t ""))) mode-filters context-menu-items (and context-menu-items mode-items '("---")) mode-items (and (or context-menu-items mode-items) global-items '("---" "---")) (and global-title (list global-title)) global-items )))) (while (popup-up-p) (dispatch-event (next-event))) )) (defun popup-buffer-menu (event) "Pop up a copy of the menubar Buffers menu where the mouse is clicked." (interactive "e") (let ((window (and (event-over-text-area-p event) (event-window event))) (bmenu nil)) (or window (error "Pointer must be in a normal window")) (select-window window) (if current-menubar (setq bmenu (assoc "%_Buffers" current-menubar))) (if (null bmenu) (setq bmenu (assoc "%_Buffers" default-menubar))) (if (null bmenu) (error "Can't find the Buffers menu")) (popup-menu bmenu))) (defun popup-menubar-menu (event) "Pop up a copy of menu that also appears in the menubar." (interactive "e") (let ((window (and (event-over-text-area-p event) (event-window event))) popup-menubar) (or window (error "Pointer must be in a normal window")) (select-window window) (and current-menubar (run-hooks 'activate-menubar-hook)) ;; #### Instead of having to copy this just to safely get rid of ;; any nil what we should really do is fix up the internal menubar ;; code to just ignore nil if generating a popup menu (setq popup-menubar (delete nil (copy-sequence (or current-menubar default-menubar)))) (popup-menu (cons "%_Menubar Menu" popup-menubar)) )) (defun menu-call-at-event (form &optional event default-behavior-fallback) "Call FORM while temporarily setting point to the position in EVENT. NOTE: This is EXPERIMENTAL and may change at any time. FORM is called the way forms in menu specs are: i.e. if a symbol, it's called with `call-interactively', otherwise with `eval'. EVENT defaults to `last-popup-menu-event', making this function especially useful in popup menus. The buffer and point are set temporarily within a `save-excursion'. If EVENT is not a mouse event, or was not over a buffer, nothing happens unless DEFAULT-BEHAVIOR-FALLBACK is non-nil, in which case the FORM is called normally." (or event (setq event last-popup-menu-event)) (let ((buf (event-buffer event)) (p (event-closest-point event))) (cond ((and buf p (> p 0)) (save-excursion (set-buffer buf) (goto-char p) (if (symbolp form) (call-interactively form) (eval form)))) (default-behavior-fallback (if (symbolp form) (call-interactively form) (eval form)))))) (global-set-key 'button3 'popup-mode-menu) ;; shift button3 and shift button2 are reserved for Hyperbole (global-set-key '(meta control button3) 'popup-buffer-menu) ;; The following command is way too dangerous with Custom. ;; (global-set-key '(meta shift button3) 'popup-menubar-menu) ;; Here's a test of the cool new menu features (from Stig). ;;(setq mode-popup-menu ;; '("Test Popup Menu" ;; :filter cdr ;; ["this item won't appear because of the menu filter" ding t] ;; "--:singleLine" ;; "singleLine" ;; "--:doubleLine" ;; "doubleLine" ;; "--:singleDashedLine" ;; "singleDashedLine" ;; "--:doubleDashedLine" ;; "doubleDashedLine" ;; "--:noLine" ;; "noLine" ;; "--:shadowEtchedIn" ;; "shadowEtchedIn" ;; "--:shadowEtchedOut" ;; "shadowEtchedOut" ;; "--:shadowDoubleEtchedIn" ;; "shadowDoubleEtchedIn" ;; "--:shadowDoubleEtchedOut" ;; "shadowDoubleEtchedOut" ;; "--:shadowEtchedInDash" ;; "shadowEtchedInDash" ;; "--:shadowEtchedOutDash" ;; "shadowEtchedOutDash" ;; "--:shadowDoubleEtchedInDash" ;; "shadowDoubleEtchedInDash" ;; "--:shadowDoubleEtchedOutDash" ;; "shadowDoubleEtchedOutDash" ;; )) (defun get-popup-menu-response (menu-desc &optional event) "Pop up the given menu and wait for a response. This blocks until the response is received, and returns the misc-user event that encapsulates the response. To execute it, you can do (funcall (event-function response) (event-object response)) If no response was received, nil is returned. MENU-DESC and EVENT are as in the call to `popup-menu'." ;; partially stolen from w3 (let ((echo-keystrokes 0) new-event) (popup-menu menu-desc event) (catch 'popup-done (while t (setq new-event (next-command-event new-event)) (cond ((misc-user-event-p new-event) (throw 'popup-done new-event)) ((not (popup-up-p)) (setq unread-command-events (cons new-event unread-command-events)) (throw 'popup-done nil)) ((button-release-event-p new-event);; don't beep twice nil) ((event-matches-key-specifier-p (quit-char)) (signal 'quit nil)) (t (beep) (message "please make a choice from the menu."))))))) (defun popup-menu-and-execute-in-window (menu-desc event) "Pop up the given menu and execute its response in EVENT's window. This blocks until the response is received, temporarily selects EVENT's window, and executes the command specified in the response. EVENT can also be a window. See `popup-menu' for the semantics of MENU-DESC." (let ((response (get-popup-menu-response menu-desc (and (eventp event) event)))) (and (misc-user-event-p response) (save-selected-window (select-window (if (windowp event) event (event-window event))) (funcall (event-function response) (event-object response)))))) ;; provide default bindings for menu accelerator map (and (boundp 'menu-accelerator-map) (keymapp menu-accelerator-map) (progn (define-key menu-accelerator-map "\e" 'menu-escape) (define-key menu-accelerator-map [left] 'menu-left) (define-key menu-accelerator-map [right] 'menu-right) (define-key menu-accelerator-map [up] 'menu-up) (define-key menu-accelerator-map [down] 'menu-down) (define-key menu-accelerator-map [return] 'menu-select) (define-key menu-accelerator-map [kp-down] 'menu-down) (define-key menu-accelerator-map [kp-up] 'menu-down) (define-key menu-accelerator-map [kp-left] 'menu-left) (define-key menu-accelerator-map [kp-right] 'menu-right) (define-key menu-accelerator-map [kp-enter] 'menu-select) (define-key menu-accelerator-map "\C-g" 'menu-quit))) (provide 'menubar) ;;; menubar.el ends here