* bug#68765: 30.0.50; Adding window-tool-bar package.
@ 2024-01-27 23:36 Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-02-10 8:19 ` Eli Zaretskii
` (2 more replies)
0 siblings, 3 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-01-27 23:36 UTC (permalink / raw)
To: 68765
[-- Attachment #1: Type: text/plain, Size: 1222 bytes --]
This is a follow-up from bug#68334 where there was interest in adding
support into Emacs core for tool bars in windows.
(https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334#52) I have
attached three changes I authored to accomplish this, two small changes
to tool-bar and tab-line, and then a code drop of my window-tool-bar.el
package. I have not yet put in documentation in NEWS or the manual
about window-tool-bar and was hoping to get a code review done first.
I think it would be good to have window-tool-bar.el also be a package so
that I can keep supporting Emacs 29 as well. I am happy to have this
put on GNU ELPA and would appreciate help in getting that completed.
I am open to renaming the package and public functions if that's
desired. I like the name "window-tool-bar-mode" as it clearly relates
to tool-bar-mode.
After these patches are accepted, I'd also like to clean up the existing
tool bar maps for built in minor modes. This would allow me to address
Eli's request to have a usable tool bar for M-x gdb
(https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334#23).
For tracking purposes, I signed copyright paperwork back in 2020, so
that shouldn't be an issue. Thanks.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Enable-multiple-modes-to-appear-in-tab-line.patch --]
[-- Type: text/x-diff; name=0001-Enable-multiple-modes-to-appear-in-tab-line.patch, Size: 5255 bytes --]
From 7f344ed1590b81323e24cdedf77477ae57cb49f9 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 09:49:03 -0800
Subject: [PATCH 1/3] Enable multiple modes to appear in tab line
This adds space for window-tool-bar-mode, which will be added in an
upcoming commit.
* lisp/tab-line.el (tab-line-format-template): Add separator space.
(tab-line-display-order): New user variable to control display order.
(tab-line--runtime-display-order, tab-line--cookie): New internal
variables.
(tab-line-set-display): New function for modes to call to enable only
their content.
(tab-line-mode): Call `tab-line-set-display'.
---
lisp/tab-line.el | 89 +++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 80 insertions(+), 9 deletions(-)
diff --git a/lisp/tab-line.el b/lisp/tab-line.el
index cc60f94c9c5..c7283641cbd 100644
--- a/lisp/tab-line.el
+++ b/lisp/tab-line.el
@@ -573,7 +573,8 @@ tab-line-format-template
(when (and (eq tab-line-tabs-function #'tab-line-tabs-window-buffers)
tab-line-new-button-show
tab-line-new-button)
- (list tab-line-new-button)))))
+ (list tab-line-new-button))
+ (list " "))))
(defun tab-line-tab-face-inactive-alternating (tab tabs face _buffer-p selected-p)
"Return FACE for TAB in TABS with alternation.
@@ -997,18 +998,88 @@ tab-line-event-start
(event-start event)))
\f
+;;; Tab line display ordering
+(defcustom tab-line-display-order
+ (copy-tree '(tab-line-mode window-tool-bar-mode))
+ "The order to display content in the tab-line.
+
+This is a list of symbols. By convention, the symbols correspond
+to the mode name that enables / disables content. Any symbol not
+listed here will automatically be put at the end of the tab line.
+
+See `tab-line-set-display' for the Lisp interface to add and
+remove content."
+ :type '(repeat symbol)
+ :group 'tab-line
+ :version "30.1")
+
+(defvar tab-line--runtime-display-order
+ nil
+ "Symbols that contain content but are not in `tab-line-display-order'.
+This list ensures that content stays in a stable position in the
+tab line.")
+
+(defconst tab-line--cookie
+ '(tab-line-set-display nil)
+ "Cookie used by `tab-line-set-display'.
+This is used to tell if the tab line is being set based on
+`tab-line-display-order' or was overridden by the user.")
+
+(defun tab-line-set-display (sym value)
+ "Lisp interface to add or remove content from the tab line.
+
+After calling this, if there is no content in the tab line, it
+will be automatically hidden.
+
+SYM is a symbol, usually the symbol corresponding to the mode
+showing content such as `tab-line-mode'.
+
+VALUE is the content to display and will be added to
+`tab-line-format' at an appropriate index based on
+`tab-line-display-order'. If you want to remove content because
+the mode is being disabled, set this to nil."
+ ;; Preserve tab-line-format if altered outside of this function.
+ (when (or (null tab-line-format)
+ ;; Assume that user modifications will not use this
+ ;; cookie.
+ (equal (car tab-line-format) tab-line--cookie))
+ (let (pos)
+ (setf pos (seq-position tab-line-display-order sym))
+ (unless pos
+ (when-let ((append-pos (seq-position tab-line--runtime-display-order sym)))
+ (setf pos (+ (length tab-line-display-order)
+ append-pos))))
+ (unless pos
+ (warn "Symbol %S not found in `tab-line-display-order'. Putting at end."
+ sym)
+ (setf pos (+ (length tab-line-display-order)
+ (length tab-line--runtime-display-order))
+ tab-line--runtime-display-order
+ (append tab-line--runtime-display-order
+ (list sym))))
+
+ (let ((desired-length (+ pos 2)) ;Plus 1 additional for the cookie,
+ (current-length (length tab-line-format)))
+ (when (> desired-length current-length)
+ (setf tab-line-format
+ (append tab-line-format
+ (make-list (- desired-length current-length) nil))
+ ;; If tab-line-format was nil, then the cookie needs to be set.
+ (car tab-line-format) tab-line--cookie)))
+
+ (setf (nth (1+ pos) tab-line-format) value))
+
+ ;; If the entire display has been disabled, tab line would display
+ ;; as empty. Explicitly hide the tab line in this case.
+ (when (seq-every-p #'null (cdr tab-line-format))
+ (setf tab-line-format nil))))
+\f
;;;###autoload
(define-minor-mode tab-line-mode
"Toggle display of tab line in the windows displaying the current buffer."
:lighter nil
- (let ((default-value '(:eval (tab-line-format))))
- (if tab-line-mode
- ;; Preserve the existing tab-line set outside of this mode
- (unless tab-line-format
- (setq tab-line-format default-value))
- ;; Reset only values set by this mode
- (when (equal tab-line-format default-value)
- (setq tab-line-format nil)))))
+ (tab-line-set-display 'tab-line-mode
+ (if tab-line-mode '(:eval (tab-line-format)) nil)))
(defcustom tab-line-exclude-modes
'(completion-list-mode)
--
2.39.2
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Add-user-option-to-only-display-default-tool-bar.patch --]
[-- Type: text/x-diff; name=0002-Add-user-option-to-only-display-default-tool-bar.patch, Size: 2068 bytes --]
From ba90ed7f057ea627bd2168d47223396a7bc36c20 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 10:08:30 -0800
Subject: [PATCH 2/3] Add user option to only display default tool bar
This works well with `window-tool-bar-mode', to be added in upcoming
commit. Then the default tool bar is displayed frame-wide and
mode-specific tool bars are displayed in the window that mode is
active in.
* lisp/tool-bar.el (tool-bar-always-show-default): New user option.
(tool-bar--cache-key, tool-bar-make-keymap-1): Return default tool bar
when option is set.
---
lisp/tool-bar.el | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
index 96b61c7b229..685e4dfbb86 100644
--- a/lisp/tool-bar.el
+++ b/lisp/tool-bar.el
@@ -100,7 +100,9 @@ secondary-tool-bar-map
(defconst tool-bar-keymap-cache (make-hash-table :test #'equal))
(defsubst tool-bar--cache-key ()
- (cons (frame-terminal) (sxhash-eq tool-bar-map)))
+ (cons (frame-terminal)
+ (sxhash-eq (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
(defsubst tool-bar--secondary-cache-key ()
(cons (frame-terminal) (sxhash-eq secondary-tool-bar-map)))
@@ -191,7 +193,9 @@ tool-bar-make-keymap-1
bind))
(plist-put plist :image image)))
bind))
- (or map tool-bar-map)))
+ (or map
+ (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
;;;###autoload
(defun tool-bar-add-item (icon def key &rest props)
@@ -377,6 +381,15 @@ tool-bar-setup
(modify-all-frames-parameters
(list (cons 'tool-bar-position val))))))
+(defcustom tool-bar-always-show-default nil
+ "If non-nil, do not show mode-specific tool bars.
+This works well when using `global-window-tool-bar-mode' to
+display the mode-specific tool bars attached to each window."
+ :type 'boolean
+ :group 'frames
+ :group 'mouse
+ :version "30.1")
+
\f
;; Modifier bar mode.
--
2.39.2
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #4: 0003-Adding-window-tool-bar-package.patch --]
[-- Type: text/x-diff; name=0003-Adding-window-tool-bar-package.patch, Size: 21242 bytes --]
From 24ed752ec0bfdded24cba4892426c2c9710126cf Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 15:44:12 -0800
Subject: [PATCH 3/3] Adding window-tool-bar package
---
lisp/window-tool-bar.el | 488 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 488 insertions(+)
create mode 100644 lisp/window-tool-bar.el
diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
new file mode 100644
index 00000000000..3950fe12f1a
--- /dev/null
+++ b/lisp/window-tool-bar.el
@@ -0,0 +1,488 @@
+;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
+;; Author: Jared Finder <jared@finder.org>
+;; Created: Nov 21, 2023
+;; Version: 0.2
+;; Keywords: mouse
+;; URL: http://github.com/chaosemer/window-tool-bar
+;; Package-Requires: ((emacs "29.1"))
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs 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 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This package puts a tool bar in each window. This allows you to see
+;; multiple tool bars simultaneously directly next to the buffer it
+;; acts on which feels much more intuitive. Emacs "browsing" modes
+;; generally have sensible tool bars, for example: *info*, *help*, and
+;; *eww* have them.
+;;
+;; It does this while being mindful of screen real estate. Most modes
+;; do not provide a custom tool bar, and this package does not show the
+;; default tool bar. This means that for most buffers there will be no
+;; space taken up. Furthermore, you can put this tool bar in the mode
+;; line or tab line if you want to share it with existing content.
+;;
+;; To get the default behavior, run (global-window-tool-bar-mode 1) or
+;; enable via M-x customize-group RET window-tool-bar RET. This uses
+;; the per-window tab line to show the tool bar.
+;;
+;; If you want to share space with an existing tab line, mode line, or
+;; header line, add (:eval (window-tool-bar-string)) to
+;; `tab-line-format', `mode-line-format', or `header-line-format'.
+
+;;; Known issues:
+;;
+;; On GNU Emacs 29.1, terminals dragging to resize windows will error
+;; with message "<tab-line> <mouse-movement> is undefined". This is a
+;; bug in GNU Emacs,
+;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
+;;
+;; On GNU Emacs 29, performance in terminals is lower than on
+;; graphical frames. This is due to a workaround, see "Workaround for
+;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
+
+;;; Todo:
+;;
+;; Not all features planned are implemented yet. Eventually I would
+;; like to also generally make tool bars better.
+;;
+;; Targeting 0.3:
+;; * Properly support reamining less frequently used tool bar item specs. From
+;; `parse_tool_bar_item':
+;; * :visible
+;; * :filter
+;; * :button
+;; * :wrap
+;; * Add display customization similar to `tool-bar-style'.
+;;
+;; Targeting 1.0:
+;;
+;; * Clean up Emacs tool bars
+;; * Default: Remove default tool-bar entirely
+;; * grep, vc: Remove default tool-bar inherited
+;; * info: Remove Next / Prev / Up, which is already in the header
+;; * smerge: Add tool bar for next/prev
+;;
+;; Post 1.0 work:
+;;
+;; * Show keyboard shortcut on help text.
+;;
+;; * Add a bit more documentation.
+;; * Add customization option: ignore-default-tool-bar-map
+;; * Make tab-line dragging resize the window
+
+;;; Code:
+
+(require 'mwheel)
+(require 'tab-line)
+(require 'tool-bar)
+\f
+;;; Benchmarking code
+;;
+;; Refreshing the tool bar is computationally simple, but generates a
+;; lot of garbage. So this benchmarking focuses on garbage
+;; generation. Since it has to run after most commands, generating
+;; significantly more garbage will cause noticeable performance
+;; degration.
+;;
+;; The refresh has two steps:
+;;
+;; Step 1: Look up the <tool-bar> map.
+;; Step 2: Generate a Lisp string using text properties for the tool
+;; bar string.
+;;
+;; Additionally, we keep track of the percentage of commands that
+;; acutally created a refresh.
+(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
+ "Absolute delta of memory use counters during step 1.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
+ "Absolute delta of memory use counters during step 2.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--refresh-done-count 0
+ "Number of tool bar string refreshes run.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-skipped-count'.")
+(defvar window-tool-bar--refresh-skipped-count 0
+ "Number of tool bar string refreshes that were skipped.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-done-count'.")
+
+(defun window-tool-bar--memory-use-avg-step1 ()
+ "Return average memory use delta during step 1."
+ (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
+ window-tool-bar--memory-use-delta-step1))
+
+(defun window-tool-bar--memory-use-avg-step2 ()
+ "Return average memory use delta during step 2."
+ (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
+ window-tool-bar--memory-use-delta-step2))
+
+(declare-function time-stamp-string "time-stamp")
+
+(defun window-tool-bar-show-memory-use ()
+ "Pop up a window showing the memory use metrics."
+ (interactive)
+ (require 'time-stamp)
+ (save-selected-window
+ (pop-to-buffer "*WTB Memory Report*")
+ (unless (eq major-mode 'special-mode)
+ (special-mode))
+
+ (goto-char (point-max))
+ (let ((inhibit-read-only t))
+ (insert (propertize (concat "Function: window-tool-bar-string "
+ (time-stamp-string))
+ 'face 'underline 'font-lock-face 'underline)
+ "\n\n")
+ (window-tool-bar--insert-memory-use
+ "Step 1" (window-tool-bar--memory-use-avg-step1))
+ (window-tool-bar--insert-memory-use
+ "Step 2" (window-tool-bar--memory-use-avg-step2))
+ (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
+ (format "Refresh executed percent %.2f\n"
+ (/ window-tool-bar--refresh-done-count
+ (+ window-tool-bar--refresh-done-count
+ window-tool-bar--refresh-skipped-count)
+ 1.0))
+ "\n"))))
+
+(defun window-tool-bar--insert-memory-use (label avg-memory-use)
+ "Insert memory use into current buffer.
+
+LABEL: A prefix string to be in front of the data.
+AVG-MEMORY-USE: A list of averages, with the same meaning as
+ `memory-use-counts'."
+ (let* ((label-len (length label))
+ (padding (make-string label-len ?\s)))
+ (insert (format "%s %8.2f Conses\n" label (elt avg-memory-use 0)))
+ (insert (format "%s %8.2f Floats\n" padding (elt avg-memory-use 1)))
+ (insert (format "%s %8.2f Vector cells\n" padding (elt avg-memory-use 2)))
+ (insert (format "%s %8.2f Symbols\n" padding (elt avg-memory-use 3)))
+ (insert (format "%s %8.2f String chars\n" padding (elt avg-memory-use 4)))
+ (insert (format "%s %8.2f Intervals\n" padding (elt avg-memory-use 5)))
+ (insert (format "%s %8.2f Strings\n" padding (elt avg-memory-use 6)))))
+\f
+(defgroup window-tool-bar nil
+ "Tool bars per-window."
+ :group 'convenience
+ :prefix "window-tool-bar-")
+
+(defvar-keymap window-tool-bar--button-keymap
+ :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
+ "<follow-link>" 'mouse-face
+ ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
+ ;; bar is not a place the point can travel to.
+ "<tab-line> <mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
+
+ ;; Mouse down events do nothing. A binding is needed so isearch
+ ;; does not exit when the tab bar is clicked.
+ "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
+(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
+
+;; Register bindings that stay in isearch. Technically, these
+;; commands don't pop up a menu but they act very similar in that they
+;; end up calling an actual command via `call-interactively'.
+(push 'window-tool-bar--call-button isearch-menu-bar-commands)
+(push 'window-tool-bar--ignore isearch-menu-bar-commands)
+
+(defvar-local window-tool-bar-string--cache nil
+ "Cache for previous result of `window-tool-bar-string'.")
+
+;;;###autoload
+(defun window-tool-bar-string ()
+ "Return a (propertized) string for the tool bar.
+
+This is for when you want more customizations than
+`window-tool-bar-mode' provides. Commonly added to the variable
+`tab-line-format', `header-line-format', or `mode-line-format'"
+ (if (or (null window-tool-bar-string--cache)
+ (window-tool-bar--last-command-triggers-refresh-p))
+ (let* ((mem0 (memory-use-counts))
+ (toolbar-menu (window-tool-bar--get-keymap))
+ (mem1 (memory-use-counts))
+ (result (mapconcat #'window-tool-bar--keymap-entry-to-string
+ (cdr toolbar-menu) ;Skip 'keymap
+ ;; Without spaces between the text, hovering
+ ;; highlights all adjacent buttons.
+ (if (window-tool-bar--use-images)
+ (propertize " " 'invisible t)
+ " ")))
+ (mem2 (memory-use-counts)))
+ (cl-mapl (lambda (l-init l0 l1)
+ (cl-incf (car l-init) (- (car l1) (car l0))))
+ window-tool-bar--memory-use-delta-step1 mem0 mem1)
+ (cl-mapl (lambda (l-init l1 l2)
+ (cl-incf (car l-init) (- (car l2) (car l1))))
+ window-tool-bar--memory-use-delta-step2 mem1 mem2)
+
+ (setf window-tool-bar-string--cache
+ (concat
+ ;; The tool bar face by default puts boxes around the
+ ;; buttons. However, this box is not displayed if the
+ ;; box starts at the leftmost pixel of the tab-line.
+ ;; Add a single space in this case so the box displays
+ ;; correctly.
+ (when (display-supports-face-attributes-p
+ '(:box (line-width 1)))
+ (propertize " " 'display '(space :width (1))))
+ result))
+ (cl-incf window-tool-bar--refresh-done-count))
+ (cl-incf window-tool-bar--refresh-skipped-count))
+
+ window-tool-bar-string--cache)
+
+(defconst window-tool-bar--graphical-separator
+ (let ((str (make-string 3 ?\s)))
+ (set-text-properties 0 1 '(display (space :width (4))) str)
+ (set-text-properties 1 2
+ '(display (space :width (1))
+ face (:inverse-video t))
+ str)
+ (set-text-properties 2 3 '(display (space :width (4))) str)
+ str))
+
+(defun window-tool-bar--keymap-entry-to-string (menu-item)
+ "Convert MENU-ITEM into a (propertized) string representation.
+
+MENU-ITEM: Menu item to convert. See info node (elisp)Tool Bar."
+ (pcase menu-item
+ ;; Separators
+ ((or `(,_ "--")
+ `(,_ menu-item ,(and (pred stringp)
+ (pred (string-prefix-p "--")))))
+ (if (window-tool-bar--use-images)
+ window-tool-bar--graphical-separator
+ "|"))
+
+ ;; Menu item, turn into propertized string button
+ (`(,key menu-item ,name-expr ,binding . ,plist)
+ (when binding ; If no binding exists, then button is hidden.
+ (let* ((name (eval name-expr))
+ (str (upcase-initials (or (plist-get plist :label)
+ (string-trim-right name "\\.+"))))
+ (len (length str))
+ (enable-form (plist-get plist :enable))
+ (enabled (or (not enable-form)
+ (eval enable-form))))
+ (if enabled
+ (add-text-properties 0 len
+ '(mouse-face window-tool-bar-button-hover
+ keymap window-tool-bar--button-keymap
+ face window-tool-bar-button)
+ str)
+ (put-text-property 0 len
+ 'face
+ 'window-tool-bar-button-disabled
+ str))
+ (when-let ((spec (and (window-tool-bar--use-images)
+ (plist-get menu-item :image))))
+ (put-text-property 0 len
+ 'display
+ (append spec
+ (if enabled '(:margin 2 :ascent center)
+ '(:margin 2 :ascent center
+ :conversion disabled)))
+ str))
+ (put-text-property 0 len
+ 'help-echo
+ (or (plist-get plist :help) name)
+ str)
+ (put-text-property 0 len 'tool-bar-key key str)
+ str)))))
+
+(defun window-tool-bar--call-button ()
+ "Call the button that was clicked on in the tab line."
+ (interactive)
+ (when (mouse-event-p last-command-event)
+ (let ((posn (event-start last-command-event)))
+ ;; Commands need to execute with the right buffer and window
+ ;; selected. The selection needs to be permanent for isearch.
+ (select-window (posn-window posn))
+ (let* ((str (posn-string posn))
+ (key (get-text-property (cdr str) 'tool-bar-key (car str)))
+ (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
+ (call-interactively cmd)))))
+
+(defun window-tool-bar--ignore ()
+ "Do nothing. This command exists for isearch."
+ (interactive)
+ nil)
+
+(defvar window-tool-bar--ignored-event-types
+ (let ((list (list 'mouse-movement 'pinch
+ 'wheel-down 'wheel-up 'wheel-left 'wheel-right
+ mouse-wheel-down-event mouse-wheel-up-event
+ mouse-wheel-left-event mouse-wheel-right-event
+ (bound-and-true-p mouse-wheel-down-alternate-event)
+ (bound-and-true-p mouse-wheel-up-alternate-event)
+ (bound-and-true-p mouse-wheel-left-alternate-event)
+ (bound-and-true-p mouse-wheel-right-alternate-event))))
+ (delete-dups (delete nil list)))
+ "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
+
+(defun window-tool-bar--last-command-triggers-refresh-p ()
+ "Test if the recent command or event should trigger a tool bar refresh."
+ (let ((type (event-basic-type last-command-event)))
+ (and
+ ;; Assume that key presses and button presses are the only user
+ ;; interactions that can alter the tool bar. Specifically, this
+ ;; excludes mouse movement, mouse wheel scroll, and pinch.
+ (not (member type window-tool-bar--ignored-event-types))
+ ;; Assume that any command that triggers shift select can't alter
+ ;; the tool bar. This excludes pure navigation commands.
+ (not (window-tool-bar--command-triggers-shift-select-p last-command))
+ ;; Assume that self-insert-command won't alter the tool bar.
+ ;; This is the most commonly executed command.
+ (not (eq last-command 'self-insert-command)))))
+
+(defun window-tool-bar--command-triggers-shift-select-p (command)
+ "Test if COMMAND would trigger shift select."
+ (let* ((form (interactive-form command))
+ (spec (car-safe (cdr-safe form))))
+ (and (eq (car-safe form) 'interactive)
+ (stringp spec)
+ (seq-position spec ?^))))
+
+;;;###autoload
+(define-minor-mode window-tool-bar-mode
+ "Toggle display of the tool bar in the tab line of the current buffer."
+ :lighter nil
+ (let ((should-display (and window-tool-bar-mode
+ (not (eq tool-bar-map
+ (default-value 'tool-bar-map))))))
+ (if (fboundp 'tab-line-set-display)
+ ;; Newly added function for Emacs 30.
+ (tab-line-set-display 'window-tool-bar-mode
+ (and should-display
+ '(:eval (window-tool-bar-string))))
+ ;; Legacy path for Emacs 29.
+ (setq tab-line-format
+ (and should-display
+ '(:eval (window-tool-bar-string)))))))
+
+;;;###autoload
+(define-globalized-minor-mode global-window-tool-bar-mode
+ window-tool-bar-mode window-tool-bar--turn-on
+ :group 'window-tool-bar
+ (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
+ (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
+
+(defvar window-tool-bar--allow-images t
+ "Internal debug flag to force text mode.")
+
+(defun window-tool-bar--use-images ()
+ "Internal function.
+Respects `window-tool-bar--allow-images' as well as frame
+capabilities."
+ (and window-tool-bar--allow-images
+ (display-images-p)))
+\f
+;;; Display styling:
+(defface window-tool-bar-button
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88) (supports :box t))
+ :box (:line-width -1 :style released-button)
+ :background "grey85")
+ ;; If the box is not supported, dim the button background a bit.
+ (((class color) (min-colors 88))
+ :background "grey70")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is not hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-hover
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey95")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-disabled
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey50"
+ :foreground "grey70")
+ (t
+ :inverse-video t
+ :background "brightblack"))
+ "Face used for buttons when the button is disabled."
+ :group 'window-tool-bar)
+\f
+;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
+(defun window-tool-bar--get-keymap ()
+ "Return the tool bar keymap."
+ (let ((tool-bar-always-show-default nil))
+ (if (and (version< emacs-version "30")
+ (not (window-tool-bar--use-images)))
+ ;; This code path is a less efficient workaround.
+ (window-tool-bar--make-keymap-1)
+ (keymap-global-lookup "<tool-bar>"))))
+
+(declare-function image-mask-p "image.c" (spec &optional frame))
+
+(defun window-tool-bar--make-keymap-1 ()
+ "Patched copy of `tool-bar-make-keymap-1'."
+ (mapcar (lambda (bind)
+ (let (image-exp plist)
+ (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
+ ;; For the format of menu-items, see node
+ ;; `Extended Menu Items' in the Elisp manual.
+ (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (setq image-exp (plist-get plist :image))
+ (consp image-exp)
+ (not (eq (car image-exp) 'image))
+ (fboundp (car image-exp)))
+ (let ((image (and (display-images-p)
+ (eval image-exp))))
+ (unless (and image (image-mask-p image))
+ (setq image (append image '(:mask heuristic))))
+ (setq bind (copy-sequence bind)
+ plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (plist-put plist :image image)))
+ bind))
+ tool-bar-map))
+
+(defun window-tool-bar--turn-on ()
+ "Internal function called by `global-window-tool-bar-mode'."
+ (when global-window-tool-bar-mode
+ (window-tool-bar-mode 1)))
+
+(provide 'window-tool-bar)
+
+;;; window-tool-bar.el ends here
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-01-27 23:36 bug#68765: 30.0.50; Adding window-tool-bar package Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-02-10 8:19 ` Eli Zaretskii
2024-02-10 17:25 ` Juri Linkov
2024-02-11 20:51 ` Philip Kaludercic
2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-02-10 8:19 UTC (permalink / raw)
To: Jared Finder, Juri Linkov, Philip Kaludercic, Stefan Monnier; +Cc: 68765
> Date: Sat, 27 Jan 2024 15:36:56 -0800
> From: Jared Finder via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>
> This is a follow-up from bug#68334 where there was interest in adding
> support into Emacs core for tool bars in windows.
> (https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334#52) I have
> attached three changes I authored to accomplish this, two small changes
> to tool-bar and tab-line, and then a code drop of my window-tool-bar.el
> package. I have not yet put in documentation in NEWS or the manual
> about window-tool-bar and was hoping to get a code review done first.
Thanks, please find some review comments below.
> Subject: [PATCH 1/3] Enable multiple modes to appear in tab line
>
> This adds space for window-tool-bar-mode, which will be added in an
> upcoming commit.
>
> * lisp/tab-line.el (tab-line-format-template): Add separator space.
> (tab-line-display-order): New user variable to control display order.
> (tab-line--runtime-display-order, tab-line--cookie): New internal
> variables.
> (tab-line-set-display): New function for modes to call to enable only
> their content.
> (tab-line-mode): Call `tab-line-set-display'.
Juri, would you please review this part of the changeset?
> Subject: [PATCH 2/3] Add user option to only display default tool bar
>
> This works well with `window-tool-bar-mode', to be added in upcoming
> commit. Then the default tool bar is displayed frame-wide and
> mode-specific tool bars are displayed in the window that mode is
> active in.
>
> * lisp/tool-bar.el (tool-bar-always-show-default): New user option.
> (tool-bar--cache-key, tool-bar-make-keymap-1): Return default tool bar
> when option is set.
> ---
> lisp/tool-bar.el | 17 +++++++++++++++--
> 1 file changed, 15 insertions(+), 2 deletions(-)
>
> diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
> index 96b61c7b229..685e4dfbb86 100644
> --- a/lisp/tool-bar.el
> +++ b/lisp/tool-bar.el
> @@ -100,7 +100,9 @@ secondary-tool-bar-map
> (defconst tool-bar-keymap-cache (make-hash-table :test #'equal))
>
> (defsubst tool-bar--cache-key ()
> - (cons (frame-terminal) (sxhash-eq tool-bar-map)))
> + (cons (frame-terminal)
> + (sxhash-eq (if tool-bar-always-show-default (default-value 'tool-bar-map)
> + tool-bar-map))))
>
> (defsubst tool-bar--secondary-cache-key ()
> (cons (frame-terminal) (sxhash-eq secondary-tool-bar-map)))
> @@ -191,7 +193,9 @@ tool-bar-make-keymap-1
> bind))
> (plist-put plist :image image)))
> bind))
> - (or map tool-bar-map)))
> + (or map
> + (if tool-bar-always-show-default (default-value 'tool-bar-map)
> + tool-bar-map))))
>
> ;;;###autoload
> (defun tool-bar-add-item (icon def key &rest props)
> @@ -377,6 +381,15 @@ tool-bar-setup
> (modify-all-frames-parameters
> (list (cons 'tool-bar-position val))))))
>
> +(defcustom tool-bar-always-show-default nil
> + "If non-nil, do not show mode-specific tool bars.
Double negation alert!
> I think it would be good to have window-tool-bar.el also be a package so
> that I can keep supporting Emacs 29 as well. I am happy to have this
> put on GNU ELPA and would appreciate help in getting that completed.
> [...]
> From 24ed752ec0bfdded24cba4892426c2c9710126cf Mon Sep 17 00:00:00 2001
> From: Jared Finder <jared@finder.org>
> Date: Fri, 26 Jan 2024 15:44:12 -0800
>
> ---
> lisp/window-tool-bar.el | 488 ++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 488 insertions(+)
> create mode 100644 lisp/window-tool-bar.el
Philip and Stefan, would you please review this additional package,
which AFAIU is being proposed as a cofre package for ELPA?
> +This works well when using `global-window-tool-bar-mode' to
> +display the mode-specific tool bars attached to each window."
I don't think I understand what you mean by "mode-specific tool bars".
The doc string doesn't explain that, so it is not clear enough, IMO.
> +(defun window-tool-bar-show-memory-use ()
> + "Pop up a window showing the memory use metrics."
I'm not sure I understand why this package needs to be interested in
memory usage. It sounds like a separate feature.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-02-10 8:19 ` Eli Zaretskii
@ 2024-02-10 17:25 ` Juri Linkov
2024-02-26 22:38 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Juri Linkov @ 2024-02-10 17:25 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: Philip Kaludercic, Jared Finder, Stefan Monnier, 68765
>> * lisp/tab-line.el (tab-line-format-template): Add separator space.
>> (tab-line-display-order): New user variable to control display order.
>> (tab-line--runtime-display-order, tab-line--cookie): New internal
>> variables.
>> (tab-line-set-display): New function for modes to call to enable only
>> their content.
>> (tab-line-mode): Call `tab-line-set-display'.
>
> Juri, would you please review this part of the changeset?
I'm not sure if this provides a clean interface.
Have you tried to show both window-tool-bar and tab-line tabs
on the same tab-line? Do you think this combination is usable?
Or maybe better just repurpose the tab-line in window-tool-bar.el
exclusively for window-local tool-bar?
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-01-27 23:36 bug#68765: 30.0.50; Adding window-tool-bar package Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-02-10 8:19 ` Eli Zaretskii
@ 2024-02-11 20:51 ` Philip Kaludercic
2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2 siblings, 0 replies; 45+ messages in thread
From: Philip Kaludercic @ 2024-02-11 20:51 UTC (permalink / raw)
To: Jared Finder; +Cc: 68765
Here are a few comments from a quick skim:
> diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
> new file mode 100644
> index 00000000000..3950fe12f1a
> --- /dev/null
> +++ b/lisp/window-tool-bar.el
> @@ -0,0 +1,488 @@
> +;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
> +
> +;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
Leave an empty line here, looks more conventional.
> +;; Author: Jared Finder <jared@finder.org>
> +;; Created: Nov 21, 2023
> +;; Version: 0.2
> +;; Keywords: mouse
> +;; URL: http://github.com/chaosemer/window-tool-bar
If the idea is for this to be a core package, that is developed in the
core, then I don't know if you want to keep this URL.
> +;; Package-Requires: ((emacs "29.1"))
> +
> +;; This file is part of GNU Emacs.
> +
> +;; GNU Emacs 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 3 of the License, or
> +;; (at your option) any later version.
> +
> +;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
> +
> +;;; Commentary:
> +;;
> +;; This package puts a tool bar in each window. This allows you to see
> +;; multiple tool bars simultaneously directly next to the buffer it
> +;; acts on which feels much more intuitive. Emacs "browsing" modes
> +;; generally have sensible tool bars, for example: *info*, *help*, and
> +;; *eww* have them.
> +;;
> +;; It does this while being mindful of screen real estate. Most modes
> +;; do not provide a custom tool bar, and this package does not show the
> +;; default tool bar. This means that for most buffers there will be no
> +;; space taken up. Furthermore, you can put this tool bar in the mode
> +;; line or tab line if you want to share it with existing content.
> +;;
> +;; To get the default behavior, run (global-window-tool-bar-mode 1) or
> +;; enable via M-x customize-group RET window-tool-bar RET. This uses
> +;; the per-window tab line to show the tool bar.
> +;;
> +;; If you want to share space with an existing tab line, mode line, or
> +;; header line, add (:eval (window-tool-bar-string)) to
> +;; `tab-line-format', `mode-line-format', or `header-line-format'.
> +
> +;;; Known issues:
> +;;
> +;; On GNU Emacs 29.1, terminals dragging to resize windows will error
> +;; with message "<tab-line> <mouse-movement> is undefined". This is a
> +;; bug in GNU Emacs,
> +;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
> +;;
> +;; On GNU Emacs 29, performance in terminals is lower than on
> +;; graphical frames. This is due to a workaround, see "Workaround for
> +;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
> +
> +;;; Todo:
> +;;
> +;; Not all features planned are implemented yet. Eventually I would
> +;; like to also generally make tool bars better.
> +;;
> +;; Targeting 0.3:
> +;; * Properly support reamining less frequently used tool bar item specs. From
> +;; `parse_tool_bar_item':
> +;; * :visible
> +;; * :filter
> +;; * :button
> +;; * :wrap
> +;; * Add display customization similar to `tool-bar-style'.
> +;;
> +;; Targeting 1.0:
> +;;
> +;; * Clean up Emacs tool bars
> +;; * Default: Remove default tool-bar entirely
> +;; * grep, vc: Remove default tool-bar inherited
> +;; * info: Remove Next / Prev / Up, which is already in the header
> +;; * smerge: Add tool bar for next/prev
> +;;
> +;; Post 1.0 work:
> +;;
> +;; * Show keyboard shortcut on help text.
> +;;
> +;; * Add a bit more documentation.
> +;; * Add customization option: ignore-default-tool-bar-map
> +;; * Make tab-line dragging resize the window
> +
> +;;; Code:
> +
> +(require 'mwheel)
> +(require 'tab-line)
> +(require 'tool-bar)
> +\f
> +;;; Benchmarking code
> +;;
> +;; Refreshing the tool bar is computationally simple, but generates a
> +;; lot of garbage. So this benchmarking focuses on garbage
> +;; generation. Since it has to run after most commands, generating
> +;; significantly more garbage will cause noticeable performance
> +;; degration.
> +;;
> +;; The refresh has two steps:
> +;;
> +;; Step 1: Look up the <tool-bar> map.
> +;; Step 2: Generate a Lisp string using text properties for the tool
> +;; bar string.
> +;;
> +;; Additionally, we keep track of the percentage of commands that
> +;; acutally created a refresh.
> +(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
> + "Absolute delta of memory use counters during step 1.
> +This is a list in the same structure as `memory-use-counts'.")
> +(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
> + "Absolute delta of memory use counters during step 2.
> +This is a list in the same structure as `memory-use-counts'.")
> +(defvar window-tool-bar--refresh-done-count 0
> + "Number of tool bar string refreshes run.
> +The total number of requests is the sum of this and
> +`window-tool-bar--refresh-skipped-count'.")
> +(defvar window-tool-bar--refresh-skipped-count 0
> + "Number of tool bar string refreshes that were skipped.
> +The total number of requests is the sum of this and
> +`window-tool-bar--refresh-done-count'.")
> +
> +(defun window-tool-bar--memory-use-avg-step1 ()
> + "Return average memory use delta during step 1."
> + (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
You can also use (float elt) to avoid the 1.0 at the end.
> + window-tool-bar--memory-use-delta-step1))
> +
> +(defun window-tool-bar--memory-use-avg-step2 ()
> + "Return average memory use delta during step 2."
> + (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
> + window-tool-bar--memory-use-delta-step2))
> +
> +(declare-function time-stamp-string "time-stamp")
> +
> +(defun window-tool-bar-show-memory-use ()
> + "Pop up a window showing the memory use metrics."
> + (interactive)
> + (require 'time-stamp)
> + (save-selected-window
> + (pop-to-buffer "*WTB Memory Report*")
I think you should rewrite this as
(with-current-buffer (get-buffer "...")
;; ...
(pop-to-buffer (current-buffer))
> + (unless (eq major-mode 'special-mode)
> + (special-mode))
> +
> + (goto-char (point-max))
> + (let ((inhibit-read-only t))
> + (insert (propertize (concat "Function: window-tool-bar-string "
> + (time-stamp-string))
> + 'face 'underline 'font-lock-face 'underline)
> + "\n\n")
> + (window-tool-bar--insert-memory-use
> + "Step 1" (window-tool-bar--memory-use-avg-step1))
> + (window-tool-bar--insert-memory-use
> + "Step 2" (window-tool-bar--memory-use-avg-step2))
> + (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
> + (format "Refresh executed percent %.2f\n"
> + (/ window-tool-bar--refresh-done-count
> + (+ window-tool-bar--refresh-done-count
> + window-tool-bar--refresh-skipped-count)
> + 1.0))
> + "\n"))))
> +
> +(defun window-tool-bar--insert-memory-use (label avg-memory-use)
> + "Insert memory use into current buffer.
> +
> +LABEL: A prefix string to be in front of the data.
> +AVG-MEMORY-USE: A list of averages, with the same meaning as
> + `memory-use-counts'."
> + (let* ((label-len (length label))
> + (padding (make-string label-len ?\s)))
> + (insert (format "%s %8.2f Conses\n" label (elt avg-memory-use 0)))
> + (insert (format "%s %8.2f Floats\n" padding (elt avg-memory-use 1)))
> + (insert (format "%s %8.2f Vector cells\n" padding (elt avg-memory-use 2)))
> + (insert (format "%s %8.2f Symbols\n" padding (elt avg-memory-use 3)))
> + (insert (format "%s %8.2f String chars\n" padding (elt avg-memory-use 4)))
> + (insert (format "%s %8.2f Intervals\n" padding (elt avg-memory-use 5)))
> + (insert (format "%s %8.2f Strings\n" padding (elt avg-memory-use 6)))))
You should be able to make this slightly more readable by looping over a
list like '("Conses" "Floats" ...), e.g. using cl-loop
(cl-loop for section = '("Conses" "Floats")
for usage = avg-memory-use
do (insert (format "%s %8.2f %s\n" padding usage section)))
> +\f
> +(defgroup window-tool-bar nil
> + "Tool bars per-window."
> + :group 'convenience
> + :prefix "window-tool-bar-")
> +
> +(defvar-keymap window-tool-bar--button-keymap
> + :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
> + "<follow-link>" 'mouse-face
> + ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
> + ;; bar is not a place the point can travel to.
> + "<tab-line> <mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <mouse-2>" #'window-tool-bar--call-button
> + "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
> + "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
> +
> + ;; Mouse down events do nothing. A binding is needed so isearch
> + ;; does not exit when the tab bar is clicked.
> + "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
> + "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
> + "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
> +(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
> +
> +;; Register bindings that stay in isearch. Technically, these
> +;; commands don't pop up a menu but they act very similar in that they
> +;; end up calling an actual command via `call-interactively'.
> +(push 'window-tool-bar--call-button isearch-menu-bar-commands)
> +(push 'window-tool-bar--ignore isearch-menu-bar-commands)
> +
> +(defvar-local window-tool-bar-string--cache nil
> + "Cache for previous result of `window-tool-bar-string'.")
> +
> +;;;###autoload
> +(defun window-tool-bar-string ()
> + "Return a (propertized) string for the tool bar.
> +
> +This is for when you want more customizations than
> +`window-tool-bar-mode' provides. Commonly added to the variable
> +`tab-line-format', `header-line-format', or `mode-line-format'"
> + (if (or (null window-tool-bar-string--cache)
> + (window-tool-bar--last-command-triggers-refresh-p))
> + (let* ((mem0 (memory-use-counts))
> + (toolbar-menu (window-tool-bar--get-keymap))
> + (mem1 (memory-use-counts))
> + (result (mapconcat #'window-tool-bar--keymap-entry-to-string
> + (cdr toolbar-menu) ;Skip 'keymap
> + ;; Without spaces between the text, hovering
> + ;; highlights all adjacent buttons.
> + (if (window-tool-bar--use-images)
> + (propertize " " 'invisible t)
> + " ")))
> + (mem2 (memory-use-counts)))
> + (cl-mapl (lambda (l-init l0 l1)
> + (cl-incf (car l-init) (- (car l1) (car l0))))
> + window-tool-bar--memory-use-delta-step1 mem0 mem1)
> + (cl-mapl (lambda (l-init l1 l2)
> + (cl-incf (car l-init) (- (car l2) (car l1))))
> + window-tool-bar--memory-use-delta-step2 mem1 mem2)
> +
> + (setf window-tool-bar-string--cache
> + (concat
> + ;; The tool bar face by default puts boxes around the
> + ;; buttons. However, this box is not displayed if the
> + ;; box starts at the leftmost pixel of the tab-line.
> + ;; Add a single space in this case so the box displays
> + ;; correctly.
> + (when (display-supports-face-attributes-p
> + '(:box (line-width 1)))
> + (propertize " " 'display '(space :width (1))))
> + result))
> + (cl-incf window-tool-bar--refresh-done-count))
> + (cl-incf window-tool-bar--refresh-skipped-count))
> +
> + window-tool-bar-string--cache)
> +
> +(defconst window-tool-bar--graphical-separator
> + (let ((str (make-string 3 ?\s)))
> + (set-text-properties 0 1 '(display (space :width (4))) str)
> + (set-text-properties 1 2
> + '(display (space :width (1))
> + face (:inverse-video t))
> + str)
> + (set-text-properties 2 3 '(display (space :width (4))) str)
> + str))
> +
> +(defun window-tool-bar--keymap-entry-to-string (menu-item)
> + "Convert MENU-ITEM into a (propertized) string representation.
> +
> +MENU-ITEM: Menu item to convert. See info node (elisp)Tool Bar."
^
quote this in `...'
for the hyperlink to work.
> + (pcase menu-item
> + ;; Separators
> + ((or `(,_ "--")
> + `(,_ menu-item ,(and (pred stringp)
> + (pred (string-prefix-p "--")))))
> + (if (window-tool-bar--use-images)
> + window-tool-bar--graphical-separator
> + "|"))
> +
> + ;; Menu item, turn into propertized string button
> + (`(,key menu-item ,name-expr ,binding . ,plist)
> + (when binding ; If no binding exists, then button is hidden.
> + (let* ((name (eval name-expr))
> + (str (upcase-initials (or (plist-get plist :label)
> + (string-trim-right name "\\.+"))))
> + (len (length str))
> + (enable-form (plist-get plist :enable))
> + (enabled (or (not enable-form)
> + (eval enable-form))))
> + (if enabled
> + (add-text-properties 0 len
> + '(mouse-face window-tool-bar-button-hover
> + keymap window-tool-bar--button-keymap
> + face window-tool-bar-button)
> + str)
> + (put-text-property 0 len
> + 'face
> + 'window-tool-bar-button-disabled
> + str))
> + (when-let ((spec (and (window-tool-bar--use-images)
> + (plist-get menu-item :image))))
> + (put-text-property 0 len
> + 'display
> + (append spec
> + (if enabled '(:margin 2 :ascent center)
> + '(:margin 2 :ascent center
> + :conversion disabled)))
> + str))
> + (put-text-property 0 len
> + 'help-echo
> + (or (plist-get plist :help) name)
> + str)
> + (put-text-property 0 len 'tool-bar-key key str)
> + str)))))
> +
> +(defun window-tool-bar--call-button ()
> + "Call the button that was clicked on in the tab line."
> + (interactive)
> + (when (mouse-event-p last-command-event)
> + (let ((posn (event-start last-command-event)))
> + ;; Commands need to execute with the right buffer and window
> + ;; selected. The selection needs to be permanent for isearch.
> + (select-window (posn-window posn))
> + (let* ((str (posn-string posn))
> + (key (get-text-property (cdr str) 'tool-bar-key (car str)))
> + (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
> + (call-interactively cmd)))))
> +
> +(defun window-tool-bar--ignore ()
> + "Do nothing. This command exists for isearch."
> + (interactive)
> + nil)
> +
> +(defvar window-tool-bar--ignored-event-types
> + (let ((list (list 'mouse-movement 'pinch
> + 'wheel-down 'wheel-up 'wheel-left 'wheel-right
> + mouse-wheel-down-event mouse-wheel-up-event
> + mouse-wheel-left-event mouse-wheel-right-event
> + (bound-and-true-p mouse-wheel-down-alternate-event)
> + (bound-and-true-p mouse-wheel-up-alternate-event)
> + (bound-and-true-p mouse-wheel-left-alternate-event)
> + (bound-and-true-p mouse-wheel-right-alternate-event))))
> + (delete-dups (delete nil list)))
> + "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
> +
> +(defun window-tool-bar--last-command-triggers-refresh-p ()
> + "Test if the recent command or event should trigger a tool bar refresh."
> + (let ((type (event-basic-type last-command-event)))
> + (and
> + ;; Assume that key presses and button presses are the only user
> + ;; interactions that can alter the tool bar. Specifically, this
> + ;; excludes mouse movement, mouse wheel scroll, and pinch.
> + (not (member type window-tool-bar--ignored-event-types))
> + ;; Assume that any command that triggers shift select can't alter
> + ;; the tool bar. This excludes pure navigation commands.
> + (not (window-tool-bar--command-triggers-shift-select-p last-command))
> + ;; Assume that self-insert-command won't alter the tool bar.
> + ;; This is the most commonly executed command.
> + (not (eq last-command 'self-insert-command)))))
> +
> +(defun window-tool-bar--command-triggers-shift-select-p (command)
> + "Test if COMMAND would trigger shift select."
> + (let* ((form (interactive-form command))
> + (spec (car-safe (cdr-safe form))))
> + (and (eq (car-safe form) 'interactive)
> + (stringp spec)
> + (seq-position spec ?^))))
> +
> +;;;###autoload
> +(define-minor-mode window-tool-bar-mode
> + "Toggle display of the tool bar in the tab line of the current buffer."
> + :lighter nil
> + (let ((should-display (and window-tool-bar-mode
> + (not (eq tool-bar-map
> + (default-value 'tool-bar-map))))))
> + (if (fboundp 'tab-line-set-display)
> + ;; Newly added function for Emacs 30.
> + (tab-line-set-display 'window-tool-bar-mode
> + (and should-display
> + '(:eval (window-tool-bar-string))))
> + ;; Legacy path for Emacs 29.
> + (setq tab-line-format
> + (and should-display
> + '(:eval (window-tool-bar-string)))))))
> +
> +;;;###autoload
> +(define-globalized-minor-mode global-window-tool-bar-mode
> + window-tool-bar-mode window-tool-bar--turn-on
> + :group 'window-tool-bar
> + (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
> + (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
> +
> +(defvar window-tool-bar--allow-images t
> + "Internal debug flag to force text mode.")
> +
> +(defun window-tool-bar--use-images ()
> + "Internal function.
> +Respects `window-tool-bar--allow-images' as well as frame
> +capabilities."
> + (and window-tool-bar--allow-images
> + (display-images-p)))
> +\f
> +;;; Display styling:
> +(defface window-tool-bar-button
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88) (supports :box t))
> + :box (:line-width -1 :style released-button)
> + :background "grey85")
> + ;; If the box is not supported, dim the button background a bit.
> + (((class color) (min-colors 88))
> + :background "grey70")
> + (t
> + :inverse-video t))
> + "Face used for buttons when the mouse is not hovering over the button."
> + :group 'window-tool-bar)
> +
> +(defface window-tool-bar-button-hover
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88))
> + :box (:line-width -1 :style released-button)
> + :background "grey95")
> + (t
> + :inverse-video t))
> + "Face used for buttons when the mouse is hovering over the button."
> + :group 'window-tool-bar)
> +
> +(defface window-tool-bar-button-disabled
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88))
> + :box (:line-width -1 :style released-button)
> + :background "grey50"
> + :foreground "grey70")
> + (t
> + :inverse-video t
> + :background "brightblack"))
> + "Face used for buttons when the button is disabled."
> + :group 'window-tool-bar)
> +\f
> +;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
> +(defun window-tool-bar--get-keymap ()
> + "Return the tool bar keymap."
> + (let ((tool-bar-always-show-default nil))
> + (if (and (version< emacs-version "30")
> + (not (window-tool-bar--use-images)))
> + ;; This code path is a less efficient workaround.
> + (window-tool-bar--make-keymap-1)
> + (keymap-global-lookup "<tool-bar>"))))
> +
> +(declare-function image-mask-p "image.c" (spec &optional frame))
> +
> +(defun window-tool-bar--make-keymap-1 ()
> + "Patched copy of `tool-bar-make-keymap-1'."
> + (mapcar (lambda (bind)
> + (let (image-exp plist)
> + (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
> + ;; For the format of menu-items, see node
> + ;; `Extended Menu Items' in the Elisp manual.
> + (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
> + bind))
> + (setq image-exp (plist-get plist :image))
> + (consp image-exp)
> + (not (eq (car image-exp) 'image))
> + (fboundp (car image-exp)))
> + (let ((image (and (display-images-p)
> + (eval image-exp))))
> + (unless (and image (image-mask-p image))
> + (setq image (append image '(:mask heuristic))))
> + (setq bind (copy-sequence bind)
> + plist (nthcdr (if (consp (nth 4 bind)) 5 4)
> + bind))
> + (plist-put plist :image image)))
> + bind))
> + tool-bar-map))
> +
> +(defun window-tool-bar--turn-on ()
> + "Internal function called by `global-window-tool-bar-mode'."
> + (when global-window-tool-bar-mode
> + (window-tool-bar-mode 1)))
> +
> +(provide 'window-tool-bar)
> +
> +;;; window-tool-bar.el ends here
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-02-10 17:25 ` Juri Linkov
@ 2024-02-26 22:38 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-26 15:34 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-02-26 22:38 UTC (permalink / raw)
To: Juri Linkov; +Cc: Eli Zaretskii, 68765, Philip Kaludercic, Stefan Monnier
On 2024-02-10 09:25, Juri Linkov wrote:
>>> * lisp/tab-line.el (tab-line-format-template): Add separator space.
>>> (tab-line-display-order): New user variable to control display order.
>>> (tab-line--runtime-display-order, tab-line--cookie): New internal
>>> variables.
>>> (tab-line-set-display): New function for modes to call to enable only
>>> their content.
>>> (tab-line-mode): Call `tab-line-set-display'.
>>
>> Juri, would you please review this part of the changeset?
>
> I'm not sure if this provides a clean interface.
> Have you tried to show both window-tool-bar and tab-line tabs
> on the same tab-line? Do you think this combination is usable?
> Or maybe better just repurpose the tab-line in window-tool-bar.el
> exclusively for window-local tool-bar?
The implementation I provided works fine for me with both
window-tool-bar-mode and tab-line-mode enabled as long as there are not
too many tabs. I could see further adding a way to specify the max
width tabs are able to take up if you think that's necessary.
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-01-27 23:36 bug#68765: 30.0.50; Adding window-tool-bar package Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-02-10 8:19 ` Eli Zaretskii
2024-02-11 20:51 ` Philip Kaludercic
@ 2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-26 15:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-27 10:00 ` Philip Kaludercic
2 siblings, 2 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-02-27 3:02 UTC (permalink / raw)
To: Philip Kaludercic, Eli Zaretskii; +Cc: 68765
[-- Attachment #1: Type: text/plain, Size: 881 bytes --]
On 2024-02-11 12:51, Philip Kaludercic wrote:
> Here are a few comments from a quick skim:
Comments addressed. New patches for 0002 and 0003 added. I also
addressed Eli's comments from
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68765#10 as well.
The following comment was not addressed:
>> +(defun window-tool-bar-show-memory-use ()
>> + "Pop up a window showing the memory use metrics."
>> + (interactive)
>> + (require 'time-stamp)
>> + (save-selected-window
>> + (pop-to-buffer "*WTB Memory Report*")
>
> I think you should rewrite this as
>
> (with-current-buffer (get-buffer "...")
> ;; ...
> (pop-to-buffer (current-buffer))
I couldn't make this change and keep the current behavior that is
important to me:
1. The window with focus should not change.
2. The buffer should get scrolled to the bottom to displayed the newly
inserted text.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-Add-user-option-to-only-display-default-tool-bar.patch --]
[-- Type: text/x-diff; name=0002-Add-user-option-to-only-display-default-tool-bar.patch, Size: 2059 bytes --]
From 622c11c6f314355b0e742fcbcbcc8ae51661bca0 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 10:08:30 -0800
Subject: [PATCH 2/3] Add user option to only display default tool bar
This works well with `window-tool-bar-mode', to be added in upcoming
commit. Then the default tool bar is displayed frame-wide and
mode-specific tool bars are displayed in the window that mode is
active in.
* lisp/tool-bar.el (tool-bar-always-show-default): New user option.
(tool-bar--cache-key, tool-bar-make-keymap-1): Return default tool bar
when option is set.
---
lisp/tool-bar.el | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
index 96b61c7b229..52d60b32412 100644
--- a/lisp/tool-bar.el
+++ b/lisp/tool-bar.el
@@ -100,7 +100,9 @@ secondary-tool-bar-map
(defconst tool-bar-keymap-cache (make-hash-table :test #'equal))
(defsubst tool-bar--cache-key ()
- (cons (frame-terminal) (sxhash-eq tool-bar-map)))
+ (cons (frame-terminal)
+ (sxhash-eq (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
(defsubst tool-bar--secondary-cache-key ()
(cons (frame-terminal) (sxhash-eq secondary-tool-bar-map)))
@@ -191,7 +193,9 @@ tool-bar-make-keymap-1
bind))
(plist-put plist :image image)))
bind))
- (or map tool-bar-map)))
+ (or map
+ (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
;;;###autoload
(defun tool-bar-add-item (icon def key &rest props)
@@ -377,6 +381,15 @@ tool-bar-setup
(modify-all-frames-parameters
(list (cons 'tool-bar-position val))))))
+(defcustom tool-bar-always-show-default nil
+ "If non-nil, `tool-bar-mode' only shows the default tool bar.
+This works well when also using `global-window-tool-bar-mode' to
+display buffer-specific tool bars."
+ :type 'boolean
+ :group 'frames
+ :group 'mouse
+ :version "30.1")
+
\f
;; Modifier bar mode.
--
2.39.2
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0003-Adding-window-tool-bar-package.patch --]
[-- Type: text/x-diff; name=0003-Adding-window-tool-bar-package.patch, Size: 21493 bytes --]
From baf4c81df3e4e82576a8084ae029d56b45750553 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 15:44:12 -0800
Subject: [PATCH 3/3] Adding window-tool-bar package
---
lisp/window-tool-bar.el | 489 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 489 insertions(+)
create mode 100644 lisp/window-tool-bar.el
diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
new file mode 100644
index 00000000000..eefd6109f7d
--- /dev/null
+++ b/lisp/window-tool-bar.el
@@ -0,0 +1,489 @@
+;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
+
+;; Author: Jared Finder <jared@finder.org>
+;; Created: Nov 21, 2023
+;; Version: 0.2
+;; Keywords: mouse
+;; Package-Requires: ((emacs "29.1"))
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs 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 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This package puts a tool bar in each window. This allows you to see
+;; multiple tool bars simultaneously directly next to the buffer it
+;; acts on which feels much more intuitive. Emacs "browsing" modes
+;; generally have sensible tool bars, for example: *info*, *help*, and
+;; *eww* have them.
+;;
+;; It does this while being mindful of screen real estate. Most modes
+;; do not provide a custom tool bar, and this package does not show the
+;; default tool bar. This means that for most buffers there will be no
+;; space taken up. Furthermore, you can put this tool bar in the mode
+;; line or tab line if you want to share it with existing content.
+;;
+;; To get the default behavior, run (global-window-tool-bar-mode 1) or
+;; enable via M-x customize-group RET window-tool-bar RET. This uses
+;; the per-window tab line to show the tool bar.
+;;
+;; If you want to share space with an existing tab line, mode line, or
+;; header line, add (:eval (window-tool-bar-string)) to
+;; `tab-line-format', `mode-line-format', or `header-line-format'.
+
+;;; Known issues:
+;;
+;; On GNU Emacs 29.1, terminals dragging to resize windows will error
+;; with message "<tab-line> <mouse-movement> is undefined". This is a
+;; bug in GNU Emacs,
+;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
+;;
+;; On GNU Emacs 29, performance in terminals is lower than on
+;; graphical frames. This is due to a workaround, see "Workaround for
+;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
+
+;;; Todo:
+;;
+;; Not all features planned are implemented yet. Eventually I would
+;; like to also generally make tool bars better.
+;;
+;; Targeting 0.3:
+;; * Properly support reamining less frequently used tool bar item specs. From
+;; `parse_tool_bar_item':
+;; * :visible
+;; * :filter
+;; * :button
+;; * :wrap
+;; * Add display customization similar to `tool-bar-style'.
+;;
+;; Targeting 1.0:
+;;
+;; * Clean up Emacs tool bars
+;; * Default: Remove default tool-bar entirely
+;; * grep, vc: Remove default tool-bar inherited
+;; * info: Remove Next / Prev / Up, which is already in the header
+;; * smerge: Add tool bar for next/prev
+;;
+;; Post 1.0 work:
+;;
+;; * Show keyboard shortcut on help text.
+;;
+;; * Add a bit more documentation.
+;; * Add customization option: ignore-default-tool-bar-map
+;; * Make tab-line dragging resize the window
+
+;;; Code:
+
+(require 'mwheel)
+(require 'tab-line)
+(require 'tool-bar)
+\f
+;;; Benchmarking code
+;;
+;; Refreshing the tool bar is computationally simple, but generates a
+;; lot of garbage. So this benchmarking focuses on garbage
+;; generation. Since it has to run after most commands, generating
+;; significantly more garbage will cause noticeable performance
+;; degration.
+;;
+;; The refresh has two steps:
+;;
+;; Step 1: Look up the <tool-bar> map.
+;; Step 2: Generate a Lisp string using text properties for the tool
+;; bar string.
+;;
+;; Additionally, we keep track of the percentage of commands that
+;; acutally created a refresh.
+(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
+ "Absolute delta of memory use counters during step 1.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
+ "Absolute delta of memory use counters during step 2.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--refresh-done-count 0
+ "Number of tool bar string refreshes run.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-skipped-count'.")
+(defvar window-tool-bar--refresh-skipped-count 0
+ "Number of tool bar string refreshes that were skipped.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-done-count'.")
+
+(defun window-tool-bar--memory-use-avg-step1 ()
+ "Return average memory use delta during step 1."
+ (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
+ window-tool-bar--memory-use-delta-step1))
+
+(defun window-tool-bar--memory-use-avg-step2 ()
+ "Return average memory use delta during step 2."
+ (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
+ window-tool-bar--memory-use-delta-step2))
+
+(declare-function time-stamp-string "time-stamp")
+
+(defun window-tool-bar-debug-show-memory-use ()
+ "Development-only command to show memory used by `window-tool-bar-string'."
+ (interactive)
+ (require 'time-stamp)
+ (save-selected-window
+ (pop-to-buffer "*WTB Memory Report*")
+ (unless (eq major-mode 'special-mode)
+ (special-mode))
+
+ (goto-char (point-max))
+ (let ((inhibit-read-only t))
+ (insert (propertize (concat "Function: window-tool-bar-string "
+ (time-stamp-string))
+ 'face 'underline 'font-lock-face 'underline)
+ "\n\n")
+ (window-tool-bar--insert-memory-use
+ "Step 1" (window-tool-bar--memory-use-avg-step1))
+ (window-tool-bar--insert-memory-use
+ "Step 2" (window-tool-bar--memory-use-avg-step2))
+ (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
+ (format "Refresh executed percent %.2f\n"
+ (/ window-tool-bar--refresh-done-count
+ (+ window-tool-bar--refresh-done-count
+ window-tool-bar--refresh-skipped-count)
+ 1.0))
+ "\n"))))
+
+(defun window-tool-bar--insert-memory-use (label avg-memory-use)
+ "Insert memory use into current buffer.
+
+LABEL: A prefix string to be in front of the data.
+AVG-MEMORY-USE: A list of averages, with the same meaning as
+ `memory-use-counts'."
+ (let* ((label-len (length label))
+ (padding (make-string label-len ?\s)))
+ (cl-loop for usage in avg-memory-use
+ for usage-label in '("Conses" "Floats" "Vector cells" "Symbols"
+ "String chars" "Intervals" "Strings")
+ for idx from 0
+ do (insert (format "%s %8.2f %s\n"
+ (if (= idx 0) label padding)
+ usage
+ usage-label)))))
+\f
+(defgroup window-tool-bar nil
+ "Tool bars per-window."
+ :group 'convenience
+ :prefix "window-tool-bar-")
+
+(defvar-keymap window-tool-bar--button-keymap
+ :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
+ "<follow-link>" 'mouse-face
+ ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
+ ;; bar is not a place the point can travel to.
+ "<tab-line> <mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
+
+ ;; Mouse down events do nothing. A binding is needed so isearch
+ ;; does not exit when the tab bar is clicked.
+ "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
+(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
+
+;; Register bindings that stay in isearch. Technically, these
+;; commands don't pop up a menu but they act very similar in that they
+;; end up calling an actual command via `call-interactively'.
+(push 'window-tool-bar--call-button isearch-menu-bar-commands)
+(push 'window-tool-bar--ignore isearch-menu-bar-commands)
+
+(defvar-local window-tool-bar-string--cache nil
+ "Cache for previous result of `window-tool-bar-string'.")
+
+;;;###autoload
+(defun window-tool-bar-string ()
+ "Return a (propertized) string for the tool bar.
+
+This is for when you want more customizations than
+`window-tool-bar-mode' provides. Commonly added to the variable
+`tab-line-format', `header-line-format', or `mode-line-format'"
+ (if (or (null window-tool-bar-string--cache)
+ (window-tool-bar--last-command-triggers-refresh-p))
+ (let* ((mem0 (memory-use-counts))
+ (toolbar-menu (window-tool-bar--get-keymap))
+ (mem1 (memory-use-counts))
+ (result (mapconcat #'window-tool-bar--keymap-entry-to-string
+ (cdr toolbar-menu) ;Skip 'keymap
+ ;; Without spaces between the text, hovering
+ ;; highlights all adjacent buttons.
+ (if (window-tool-bar--use-images)
+ (propertize " " 'invisible t)
+ " ")))
+ (mem2 (memory-use-counts)))
+ (cl-mapl (lambda (l-init l0 l1)
+ (cl-incf (car l-init) (- (car l1) (car l0))))
+ window-tool-bar--memory-use-delta-step1 mem0 mem1)
+ (cl-mapl (lambda (l-init l1 l2)
+ (cl-incf (car l-init) (- (car l2) (car l1))))
+ window-tool-bar--memory-use-delta-step2 mem1 mem2)
+
+ (setf window-tool-bar-string--cache
+ (concat
+ ;; The tool bar face by default puts boxes around the
+ ;; buttons. However, this box is not displayed if the
+ ;; box starts at the leftmost pixel of the tab-line.
+ ;; Add a single space in this case so the box displays
+ ;; correctly.
+ (when (display-supports-face-attributes-p
+ '(:box (line-width 1)))
+ (propertize " " 'display '(space :width (1))))
+ result))
+ (cl-incf window-tool-bar--refresh-done-count))
+ (cl-incf window-tool-bar--refresh-skipped-count))
+
+ window-tool-bar-string--cache)
+
+(defconst window-tool-bar--graphical-separator
+ (let ((str (make-string 3 ?\s)))
+ (set-text-properties 0 1 '(display (space :width (4))) str)
+ (set-text-properties 1 2
+ '(display (space :width (1))
+ face (:inverse-video t))
+ str)
+ (set-text-properties 2 3 '(display (space :width (4))) str)
+ str))
+
+(defun window-tool-bar--keymap-entry-to-string (menu-item)
+ "Convert MENU-ITEM into a (propertized) string representation.
+
+MENU-ITEM: Menu item to convert. See info node (elisp)Tool Bar."
+ (pcase menu-item
+ ;; Separators
+ ((or `(,_ "--")
+ `(,_ menu-item ,(and (pred stringp)
+ (pred (string-prefix-p "--")))))
+ (if (window-tool-bar--use-images)
+ window-tool-bar--graphical-separator
+ "|"))
+
+ ;; Menu item, turn into propertized string button
+ (`(,key menu-item ,name-expr ,binding . ,plist)
+ (when binding ; If no binding exists, then button is hidden.
+ (let* ((name (eval name-expr))
+ (str (upcase-initials (or (plist-get plist :label)
+ (string-trim-right name "\\.+"))))
+ (len (length str))
+ (enable-form (plist-get plist :enable))
+ (enabled (or (not enable-form)
+ (eval enable-form))))
+ (if enabled
+ (add-text-properties 0 len
+ '(mouse-face window-tool-bar-button-hover
+ keymap window-tool-bar--button-keymap
+ face window-tool-bar-button)
+ str)
+ (put-text-property 0 len
+ 'face
+ 'window-tool-bar-button-disabled
+ str))
+ (when-let ((spec (and (window-tool-bar--use-images)
+ (plist-get menu-item :image))))
+ (put-text-property 0 len
+ 'display
+ (append spec
+ (if enabled '(:margin 2 :ascent center)
+ '(:margin 2 :ascent center
+ :conversion disabled)))
+ str))
+ (put-text-property 0 len
+ 'help-echo
+ (or (plist-get plist :help) name)
+ str)
+ (put-text-property 0 len 'tool-bar-key key str)
+ str)))))
+
+(defun window-tool-bar--call-button ()
+ "Call the button that was clicked on in the tab line."
+ (interactive)
+ (when (mouse-event-p last-command-event)
+ (let ((posn (event-start last-command-event)))
+ ;; Commands need to execute with the right buffer and window
+ ;; selected. The selection needs to be permanent for isearch.
+ (select-window (posn-window posn))
+ (let* ((str (posn-string posn))
+ (key (get-text-property (cdr str) 'tool-bar-key (car str)))
+ (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
+ (call-interactively cmd)))))
+
+(defun window-tool-bar--ignore ()
+ "Do nothing. This command exists for isearch."
+ (interactive)
+ nil)
+
+(defvar window-tool-bar--ignored-event-types
+ (let ((list (list 'mouse-movement 'pinch
+ 'wheel-down 'wheel-up 'wheel-left 'wheel-right
+ mouse-wheel-down-event mouse-wheel-up-event
+ mouse-wheel-left-event mouse-wheel-right-event
+ (bound-and-true-p mouse-wheel-down-alternate-event)
+ (bound-and-true-p mouse-wheel-up-alternate-event)
+ (bound-and-true-p mouse-wheel-left-alternate-event)
+ (bound-and-true-p mouse-wheel-right-alternate-event))))
+ (delete-dups (delete nil list)))
+ "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
+
+(defun window-tool-bar--last-command-triggers-refresh-p ()
+ "Test if the recent command or event should trigger a tool bar refresh."
+ (let ((type (event-basic-type last-command-event)))
+ (and
+ ;; Assume that key presses and button presses are the only user
+ ;; interactions that can alter the tool bar. Specifically, this
+ ;; excludes mouse movement, mouse wheel scroll, and pinch.
+ (not (member type window-tool-bar--ignored-event-types))
+ ;; Assume that any command that triggers shift select can't alter
+ ;; the tool bar. This excludes pure navigation commands.
+ (not (window-tool-bar--command-triggers-shift-select-p last-command))
+ ;; Assume that self-insert-command won't alter the tool bar.
+ ;; This is the most commonly executed command.
+ (not (eq last-command 'self-insert-command)))))
+
+(defun window-tool-bar--command-triggers-shift-select-p (command)
+ "Test if COMMAND would trigger shift select."
+ (let* ((form (interactive-form command))
+ (spec (car-safe (cdr-safe form))))
+ (and (eq (car-safe form) 'interactive)
+ (stringp spec)
+ (seq-position spec ?^))))
+
+;;;###autoload
+(define-minor-mode window-tool-bar-mode
+ "Toggle display of the tool bar in the tab line of the current buffer."
+ :lighter nil
+ (let ((should-display (and window-tool-bar-mode
+ (not (eq tool-bar-map
+ (default-value 'tool-bar-map))))))
+ (if (fboundp 'tab-line-set-display)
+ ;; Newly added function for Emacs 30.
+ (tab-line-set-display 'window-tool-bar-mode
+ (and should-display
+ '(:eval (window-tool-bar-string))))
+ ;; Legacy path for Emacs 29.
+ (setq tab-line-format
+ (and should-display
+ '(:eval (window-tool-bar-string)))))))
+
+;;;###autoload
+(define-globalized-minor-mode global-window-tool-bar-mode
+ window-tool-bar-mode window-tool-bar--turn-on
+ :group 'window-tool-bar
+ (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
+ (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
+
+(defvar window-tool-bar--allow-images t
+ "Internal debug flag to force text mode.")
+
+(defun window-tool-bar--use-images ()
+ "Internal function.
+Respects `window-tool-bar--allow-images' as well as frame
+capabilities."
+ (and window-tool-bar--allow-images
+ (display-images-p)))
+\f
+;;; Display styling:
+(defface window-tool-bar-button
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88) (supports :box t))
+ :box (:line-width -1 :style released-button)
+ :background "grey85")
+ ;; If the box is not supported, dim the button background a bit.
+ (((class color) (min-colors 88))
+ :background "grey70")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is not hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-hover
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey95")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-disabled
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey50"
+ :foreground "grey70")
+ (t
+ :inverse-video t
+ :background "brightblack"))
+ "Face used for buttons when the button is disabled."
+ :group 'window-tool-bar)
+\f
+;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
+(defun window-tool-bar--get-keymap ()
+ "Return the tool bar keymap."
+ (let ((tool-bar-always-show-default nil))
+ (if (and (version< emacs-version "30")
+ (not (window-tool-bar--use-images)))
+ ;; This code path is a less efficient workaround.
+ (window-tool-bar--make-keymap-1)
+ (keymap-global-lookup "<tool-bar>"))))
+
+(declare-function image-mask-p "image.c" (spec &optional frame))
+
+(defun window-tool-bar--make-keymap-1 ()
+ "Patched copy of `tool-bar-make-keymap-1'."
+ (mapcar (lambda (bind)
+ (let (image-exp plist)
+ (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
+ ;; For the format of menu-items, see node
+ ;; `Extended Menu Items' in the Elisp manual.
+ (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (setq image-exp (plist-get plist :image))
+ (consp image-exp)
+ (not (eq (car image-exp) 'image))
+ (fboundp (car image-exp)))
+ (let ((image (and (display-images-p)
+ (eval image-exp))))
+ (unless (and image (image-mask-p image))
+ (setq image (append image '(:mask heuristic))))
+ (setq bind (copy-sequence bind)
+ plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (plist-put plist :image image)))
+ bind))
+ tool-bar-map))
+
+(defun window-tool-bar--turn-on ()
+ "Internal function called by `global-window-tool-bar-mode'."
+ (when global-window-tool-bar-mode
+ (window-tool-bar-mode 1)))
+
+(provide 'window-tool-bar)
+
+;;; window-tool-bar.el ends here
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-03-26 15:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-13 7:43 ` Eli Zaretskii
2024-04-27 10:00 ` Philip Kaludercic
1 sibling, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-03-26 15:33 UTC (permalink / raw)
To: Philip Kaludercic, Eli Zaretskii; +Cc: 68765
It's been four weeks and I've seen no reply to these updated patches.
Are you able to review?
On 2024-02-26 19:02, Jared Finder wrote:
> On 2024-02-11 12:51, Philip Kaludercic wrote:
>> Here are a few comments from a quick skim:
>
> Comments addressed. New patches for 0002 and 0003 added. I also
> addressed Eli's comments from
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68765#10 as well.
>
> The following comment was not addressed:
>
>>> +(defun window-tool-bar-show-memory-use ()
>>> + "Pop up a window showing the memory use metrics."
>>> + (interactive)
>>> + (require 'time-stamp)
>>> + (save-selected-window
>>> + (pop-to-buffer "*WTB Memory Report*")
>>
>> I think you should rewrite this as
>>
>> (with-current-buffer (get-buffer "...")
>> ;; ...
>> (pop-to-buffer (current-buffer))
>
> I couldn't make this change and keep the current behavior that is
> important to me:
>
> 1. The window with focus should not change.
> 2. The buffer should get scrolled to the bottom to displayed the newly
> inserted text.
>
> -- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-02-26 22:38 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-03-26 15:34 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-27 7:04 ` Juri Linkov
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-03-26 15:34 UTC (permalink / raw)
To: Juri Linkov; +Cc: Eli Zaretskii, 68765, Philip Kaludercic, Stefan Monnier
It's been four weeks and I've seen no reply to this comment. Are there
any other concerns?
-- MJF
On 2024-02-26 14:38, Jared Finder wrote:
> On 2024-02-10 09:25, Juri Linkov wrote:
>>>> * lisp/tab-line.el (tab-line-format-template): Add separator space.
>>>> (tab-line-display-order): New user variable to control display
>>>> order.
>>>> (tab-line--runtime-display-order, tab-line--cookie): New internal
>>>> variables.
>>>> (tab-line-set-display): New function for modes to call to enable
>>>> only
>>>> their content.
>>>> (tab-line-mode): Call `tab-line-set-display'.
>>>
>>> Juri, would you please review this part of the changeset?
>>
>> I'm not sure if this provides a clean interface.
>> Have you tried to show both window-tool-bar and tab-line tabs
>> on the same tab-line? Do you think this combination is usable?
>> Or maybe better just repurpose the tab-line in window-tool-bar.el
>> exclusively for window-local tool-bar?
>
> The implementation I provided works fine for me with both
> window-tool-bar-mode and tab-line-mode enabled as long as there are not
> too many tabs. I could see further adding a way to specify the max
> width tabs are able to take up if you think that's necessary.
>
> -- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-03-26 15:34 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-03-27 7:04 ` Juri Linkov
2024-05-02 6:03 ` Juri Linkov
0 siblings, 1 reply; 45+ messages in thread
From: Juri Linkov @ 2024-03-27 7:04 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765, Philip Kaludercic, Stefan Monnier
>>> I'm not sure if this provides a clean interface.
>>> Have you tried to show both window-tool-bar and tab-line tabs
>>> on the same tab-line? Do you think this combination is usable?
>>> Or maybe better just repurpose the tab-line in window-tool-bar.el
>>> exclusively for window-local tool-bar?
>> The implementation I provided works fine for me with both
>> window-tool-bar-mode and tab-line-mode enabled as long as there are not
>> too many tabs. I could see further adding a way to specify the max width
>> tabs are able to take up if you think that's necessary.
>
> It's been four weeks and I've seen no reply to this comment. Are there any
> other concerns?
Sorry, I didn't know that you expected that I should review your patch -
I was silent because your last patch has no changes in tab-line.el,
so I have no more objections in this regard.
As for combining of tabs and the tool-bar on the tab-line,
I don't think this is feasible to achieve a consistent solution.
So users have to choose only one feature at a time:
whether buffer tabs in the tab-line or the window-local tool-bar.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-03-26 15:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-04-13 7:43 ` Eli Zaretskii
2024-04-27 8:25 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-04-13 7:43 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765
Ping! How should we make progress with this issue?
> Date: Tue, 26 Mar 2024 08:33:22 -0700
> From: Jared Finder <jared@finder.org>
> Cc: 68765@debbugs.gnu.org
>
> It's been four weeks and I've seen no reply to these updated patches.
> Are you able to review?
>
> On 2024-02-26 19:02, Jared Finder wrote:
> > On 2024-02-11 12:51, Philip Kaludercic wrote:
> >> Here are a few comments from a quick skim:
> >
> > Comments addressed. New patches for 0002 and 0003 added. I also
> > addressed Eli's comments from
> > https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68765#10 as well.
> >
> > The following comment was not addressed:
> >
> >>> +(defun window-tool-bar-show-memory-use ()
> >>> + "Pop up a window showing the memory use metrics."
> >>> + (interactive)
> >>> + (require 'time-stamp)
> >>> + (save-selected-window
> >>> + (pop-to-buffer "*WTB Memory Report*")
> >>
> >> I think you should rewrite this as
> >>
> >> (with-current-buffer (get-buffer "...")
> >> ;; ...
> >> (pop-to-buffer (current-buffer))
> >
> > I couldn't make this change and keep the current behavior that is
> > important to me:
> >
> > 1. The window with focus should not change.
> > 2. The buffer should get scrolled to the bottom to displayed the newly
> > inserted text.
> >
> > -- MJF
>
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-04-13 7:43 ` Eli Zaretskii
@ 2024-04-27 8:25 ` Eli Zaretskii
0 siblings, 0 replies; 45+ messages in thread
From: Eli Zaretskii @ 2024-04-27 8:25 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, jared, 68765
Ping! Ping! Philip and Jared, are there any issues left to resolve
here, or should this be installed?
> Cc: philipk@posteo.net, 68765@debbugs.gnu.org
> Date: Sat, 13 Apr 2024 10:43:41 +0300
> From: Eli Zaretskii <eliz@gnu.org>
>
> Ping! How should we make progress with this issue?
>
> > Date: Tue, 26 Mar 2024 08:33:22 -0700
> > From: Jared Finder <jared@finder.org>
> > Cc: 68765@debbugs.gnu.org
> >
> > It's been four weeks and I've seen no reply to these updated patches.
> > Are you able to review?
> >
> > On 2024-02-26 19:02, Jared Finder wrote:
> > > On 2024-02-11 12:51, Philip Kaludercic wrote:
> > >> Here are a few comments from a quick skim:
> > >
> > > Comments addressed. New patches for 0002 and 0003 added. I also
> > > addressed Eli's comments from
> > > https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68765#10 as well.
> > >
> > > The following comment was not addressed:
> > >
> > >>> +(defun window-tool-bar-show-memory-use ()
> > >>> + "Pop up a window showing the memory use metrics."
> > >>> + (interactive)
> > >>> + (require 'time-stamp)
> > >>> + (save-selected-window
> > >>> + (pop-to-buffer "*WTB Memory Report*")
> > >>
> > >> I think you should rewrite this as
> > >>
> > >> (with-current-buffer (get-buffer "...")
> > >> ;; ...
> > >> (pop-to-buffer (current-buffer))
> > >
> > > I couldn't make this change and keep the current behavior that is
> > > important to me:
> > >
> > > 1. The window with focus should not change.
> > > 2. The buffer should get scrolled to the bottom to displayed the newly
> > > inserted text.
> > >
> > > -- MJF
> >
>
>
>
>
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-26 15:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-04-27 10:00 ` Philip Kaludercic
2024-04-28 4:44 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 1 reply; 45+ messages in thread
From: Philip Kaludercic @ 2024-04-27 10:00 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765
Eli Zaretskii <eliz@gnu.org> writes:
> Ping! Ping! Philip and Jared, are there any issues left to resolve
> here, or should this be installed?
Sorry for the delay, I'm going to comment below.
[...]
Jared Finder <jared@finder.org> writes:
> It's been four weeks and I've seen no reply to these updated patches.
> Are you able to review?
Likewise, my apologies, the messages got lost in my backlog that I am
currently trying to make up.
Jared Finder <jared@finder.org> writes:
> Comments addressed. New patches for 0002 and 0003 added. I also
> addressed Eli's comments from
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68765#10 as well.
>
> The following comment was not addressed:
>
>>> +(defun window-tool-bar-show-memory-use ()
>>> + "Pop up a window showing the memory use metrics."
>>> + (interactive)
>>> + (require 'time-stamp)
>>> + (save-selected-window
>>> + (pop-to-buffer "*WTB Memory Report*")
>> I think you should rewrite this as
>> (with-current-buffer (get-buffer "...")
>> ;; ...
>> (pop-to-buffer (current-buffer))
>
> I couldn't make this change and keep the current behavior that is
> important to me:
>
> 1. The window with focus should not change.
> 2. The buffer should get scrolled to the bottom to displayed the newly
> inserted text.
Ok.
> -- MJF
>
> From 622c11c6f314355b0e742fcbcbcc8ae51661bca0 Mon Sep 17 00:00:00 2001
> From: Jared Finder <jared@finder.org>
> Date: Fri, 26 Jan 2024 10:08:30 -0800
> Subject: [PATCH 2/3] Add user option to only display default tool bar
>
> This works well with `window-tool-bar-mode', to be added in upcoming
> commit. Then the default tool bar is displayed frame-wide and
> mode-specific tool bars are displayed in the window that mode is
> active in.
>
> * lisp/tool-bar.el (tool-bar-always-show-default): New user option.
> (tool-bar--cache-key, tool-bar-make-keymap-1): Return default tool bar
> when option is set.
> ---
> lisp/tool-bar.el | 17 +++++++++++++++--
> 1 file changed, 15 insertions(+), 2 deletions(-)
>
> diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
> index 96b61c7b229..52d60b32412 100644
> --- a/lisp/tool-bar.el
> +++ b/lisp/tool-bar.el
> @@ -100,7 +100,9 @@ secondary-tool-bar-map
> (defconst tool-bar-keymap-cache (make-hash-table :test #'equal))
>
> (defsubst tool-bar--cache-key ()
> - (cons (frame-terminal) (sxhash-eq tool-bar-map)))
> + (cons (frame-terminal)
> + (sxhash-eq (if tool-bar-always-show-default (default-value 'tool-bar-map)
> + tool-bar-map))))
>
> (defsubst tool-bar--secondary-cache-key ()
> (cons (frame-terminal) (sxhash-eq secondary-tool-bar-map)))
> @@ -191,7 +193,9 @@ tool-bar-make-keymap-1
> bind))
> (plist-put plist :image image)))
> bind))
> - (or map tool-bar-map)))
> + (or map
> + (if tool-bar-always-show-default (default-value 'tool-bar-map)
> + tool-bar-map))))
>
> ;;;###autoload
> (defun tool-bar-add-item (icon def key &rest props)
> @@ -377,6 +381,15 @@ tool-bar-setup
> (modify-all-frames-parameters
> (list (cons 'tool-bar-position val))))))
>
> +(defcustom tool-bar-always-show-default nil
> + "If non-nil, `tool-bar-mode' only shows the default tool bar.
> +This works well when also using `global-window-tool-bar-mode' to
> +display buffer-specific tool bars."
> + :type 'boolean
> + :group 'frames
> + :group 'mouse
> + :version "30.1")
> +
> \f
No comments from me here.
> ;; Modifier bar mode.
> --
> 2.39.2
>
>
> From baf4c81df3e4e82576a8084ae029d56b45750553 Mon Sep 17 00:00:00 2001
> From: Jared Finder <jared@finder.org>
> Date: Fri, 26 Jan 2024 15:44:12 -0800
> Subject: [PATCH 3/3] Adding window-tool-bar package
>
> ---
> lisp/window-tool-bar.el | 489 ++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 489 insertions(+)
> create mode 100644 lisp/window-tool-bar.el
>
> diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
> new file mode 100644
> index 00000000000..eefd6109f7d
> --- /dev/null
> +++ b/lisp/window-tool-bar.el
> @@ -0,0 +1,489 @@
> +;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
> +
> +;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
> +
> +;; Author: Jared Finder <jared@finder.org>
> +;; Created: Nov 21, 2023
> +;; Version: 0.2
> +;; Keywords: mouse
> +;; Package-Requires: ((emacs "29.1"))
If the plan is for this to be a core-package, then you should add a
comment like
;; This is a GNU ELPA :core package. Avoid adding functionality
;; that is not available in the version of Emacs recorded above or any
;; of the package dependencies.
> +
> +;; This file is part of GNU Emacs.
> +
> +;; GNU Emacs 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 3 of the License, or
> +;; (at your option) any later version.
> +
> +;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
> +
> +;;; Commentary:
> +;;
> +;; This package puts a tool bar in each window. This allows you to see
> +;; multiple tool bars simultaneously directly next to the buffer it
> +;; acts on which feels much more intuitive. Emacs "browsing" modes
> +;; generally have sensible tool bars, for example: *info*, *help*, and
> +;; *eww* have them.
> +;;
> +;; It does this while being mindful of screen real estate. Most modes
> +;; do not provide a custom tool bar, and this package does not show the
> +;; default tool bar. This means that for most buffers there will be no
> +;; space taken up. Furthermore, you can put this tool bar in the mode
> +;; line or tab line if you want to share it with existing content.
> +;;
> +;; To get the default behavior, run (global-window-tool-bar-mode 1) or
> +;; enable via M-x customize-group RET window-tool-bar RET. This uses
> +;; the per-window tab line to show the tool bar.
> +;;
> +;; If you want to share space with an existing tab line, mode line, or
> +;; header line, add (:eval (window-tool-bar-string)) to
> +;; `tab-line-format', `mode-line-format', or `header-line-format'.
> +
> +;;; Known issues:
> +;;
> +;; On GNU Emacs 29.1, terminals dragging to resize windows will error
> +;; with message "<tab-line> <mouse-movement> is undefined". This is a
> +;; bug in GNU Emacs,
> +;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
> +;;
> +;; On GNU Emacs 29, performance in terminals is lower than on
> +;; graphical frames. This is due to a workaround, see "Workaround for
> +;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
> +
> +;;; Todo:
> +;;
> +;; Not all features planned are implemented yet. Eventually I would
> +;; like to also generally make tool bars better.
> +;;
> +;; Targeting 0.3:
> +;; * Properly support reamining less frequently used tool bar item specs. From
> +;; `parse_tool_bar_item':
> +;; * :visible
> +;; * :filter
> +;; * :button
> +;; * :wrap
> +;; * Add display customization similar to `tool-bar-style'.
> +;;
> +;; Targeting 1.0:
> +;;
> +;; * Clean up Emacs tool bars
> +;; * Default: Remove default tool-bar entirely
> +;; * grep, vc: Remove default tool-bar inherited
> +;; * info: Remove Next / Prev / Up, which is already in the header
> +;; * smerge: Add tool bar for next/prev
> +;;
> +;; Post 1.0 work:
> +;;
> +;; * Show keyboard shortcut on help text.
> +;;
> +;; * Add a bit more documentation.
> +;; * Add customization option: ignore-default-tool-bar-map
> +;; * Make tab-line dragging resize the window
> +
> +;;; Code:
> +
> +(require 'mwheel)
> +(require 'tab-line)
> +(require 'tool-bar)
> +\f
> +;;; Benchmarking code
> +;;
> +;; Refreshing the tool bar is computationally simple, but generates a
> +;; lot of garbage. So this benchmarking focuses on garbage
> +;; generation. Since it has to run after most commands, generating
> +;; significantly more garbage will cause noticeable performance
> +;; degration.
> +;;
> +;; The refresh has two steps:
> +;;
> +;; Step 1: Look up the <tool-bar> map.
> +;; Step 2: Generate a Lisp string using text properties for the tool
> +;; bar string.
> +;;
> +;; Additionally, we keep track of the percentage of commands that
> +;; acutally created a refresh.
> +(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
> + "Absolute delta of memory use counters during step 1.
> +This is a list in the same structure as `memory-use-counts'.")
> +(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
> + "Absolute delta of memory use counters during step 2.
> +This is a list in the same structure as `memory-use-counts'.")
> +(defvar window-tool-bar--refresh-done-count 0
> + "Number of tool bar string refreshes run.
> +The total number of requests is the sum of this and
> +`window-tool-bar--refresh-skipped-count'.")
> +(defvar window-tool-bar--refresh-skipped-count 0
> + "Number of tool bar string refreshes that were skipped.
> +The total number of requests is the sum of this and
> +`window-tool-bar--refresh-done-count'.")
> +
> +(defun window-tool-bar--memory-use-avg-step1 ()
> + "Return average memory use delta during step 1."
> + (mapcar (lambda (elt) (/ elt window-tool-bar--refresh-done-count 1.0))
> + window-tool-bar--memory-use-delta-step1))
> +
> +(defun window-tool-bar--memory-use-avg-step2 ()
> + "Return average memory use delta during step 2."
> + (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
> + window-tool-bar--memory-use-delta-step2))
> +
> +(declare-function time-stamp-string "time-stamp")
> +
> +(defun window-tool-bar-debug-show-memory-use ()
> + "Development-only command to show memory used by `window-tool-bar-string'."
> + (interactive)
> + (require 'time-stamp)
> + (save-selected-window
> + (pop-to-buffer "*WTB Memory Report*")
> + (unless (eq major-mode 'special-mode)
You should explain what is going on here, and why you are checking
major-mode instead of using derived-mode-p.
> + (special-mode))
> +
> + (goto-char (point-max))
> + (let ((inhibit-read-only t))
> + (insert (propertize (concat "Function: window-tool-bar-string "
> + (time-stamp-string))
> + 'face 'underline 'font-lock-face 'underline)
> + "\n\n")
> + (window-tool-bar--insert-memory-use
> + "Step 1" (window-tool-bar--memory-use-avg-step1))
> + (window-tool-bar--insert-memory-use
> + "Step 2" (window-tool-bar--memory-use-avg-step2))
> + (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
> + (format "Refresh executed percent %.2f\n"
> + (/ window-tool-bar--refresh-done-count
> + (+ window-tool-bar--refresh-done-count
> + window-tool-bar--refresh-skipped-count)
> + 1.0))
I don't know if there is any significant difference between (/ a b 1.0)
and (/ a (float b)), but interesting they have the same number of
bytecode instructions and funcalls:
(disassemble (byte-compile (lambda (a b) (/ a b 1.0))))
byte code:
doc: ...
args: (arg1 arg2)
0 constant /
1 stack-ref 2
2 stack-ref 2
3 constant 1.0
4 call 3
5 return
(disassemble (byte-compile (lambda (a b) (/ a (float b)))))
byte code:
doc: ...
args: (arg1 arg2)
0 stack-ref 1
1 constant float
2 stack-ref 2
3 call 1
4 quo
5 return
> + "\n"))))
> +
> +(defun window-tool-bar--insert-memory-use (label avg-memory-use)
> + "Insert memory use into current buffer.
> +
> +LABEL: A prefix string to be in front of the data.
> +AVG-MEMORY-USE: A list of averages, with the same meaning as
> + `memory-use-counts'."
The formatting is somewhat unconventional and can easily be broken using M-q.
> + (let* ((label-len (length label))
> + (padding (make-string label-len ?\s)))
> + (cl-loop for usage in avg-memory-use
> + for usage-label in '("Conses" "Floats" "Vector cells" "Symbols"
> + "String chars" "Intervals" "Strings")
> + for idx from 0
> + do (insert (format "%s %8.2f %s\n"
> + (if (= idx 0) label padding)
> + usage
> + usage-label)))))
> +\f
> +(defgroup window-tool-bar nil
> + "Tool bars per-window."
> + :group 'convenience
> + :prefix "window-tool-bar-")
> +
> +(defvar-keymap window-tool-bar--button-keymap
> + :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
> + "<follow-link>" 'mouse-face
> + ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
> + ;; bar is not a place the point can travel to.
> + "<tab-line> <mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
> + "<tab-line> <mouse-2>" #'window-tool-bar--call-button
> + "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
> + "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
> +
> + ;; Mouse down events do nothing. A binding is needed so isearch
> + ;; does not exit when the tab bar is clicked.
> + "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
> + "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
> + "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
> + "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
> +(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
> +
> +;; Register bindings that stay in isearch. Technically, these
> +;; commands don't pop up a menu but they act very similar in that they
> +;; end up calling an actual command via `call-interactively'.
> +(push 'window-tool-bar--call-button isearch-menu-bar-commands)
> +(push 'window-tool-bar--ignore isearch-menu-bar-commands)
> +
> +(defvar-local window-tool-bar-string--cache nil
> + "Cache for previous result of `window-tool-bar-string'.")
> +
> +;;;###autoload
> +(defun window-tool-bar-string ()
> + "Return a (propertized) string for the tool bar.
> +
> +This is for when you want more customizations than
> +`window-tool-bar-mode' provides. Commonly added to the variable
> +`tab-line-format', `header-line-format', or `mode-line-format'"
> + (if (or (null window-tool-bar-string--cache)
> + (window-tool-bar--last-command-triggers-refresh-p))
> + (let* ((mem0 (memory-use-counts))
> + (toolbar-menu (window-tool-bar--get-keymap))
> + (mem1 (memory-use-counts))
> + (result (mapconcat #'window-tool-bar--keymap-entry-to-string
> + (cdr toolbar-menu) ;Skip 'keymap
> + ;; Without spaces between the text, hovering
> + ;; highlights all adjacent buttons.
> + (if (window-tool-bar--use-images)
> + (propertize " " 'invisible t)
> + " ")))
> + (mem2 (memory-use-counts)))
> + (cl-mapl (lambda (l-init l0 l1)
> + (cl-incf (car l-init) (- (car l1) (car l0))))
> + window-tool-bar--memory-use-delta-step1 mem0 mem1)
> + (cl-mapl (lambda (l-init l1 l2)
> + (cl-incf (car l-init) (- (car l2) (car l1))))
> + window-tool-bar--memory-use-delta-step2 mem1 mem2)
> +
> + (setf window-tool-bar-string--cache
> + (concat
> + ;; The tool bar face by default puts boxes around the
> + ;; buttons. However, this box is not displayed if the
> + ;; box starts at the leftmost pixel of the tab-line.
> + ;; Add a single space in this case so the box displays
> + ;; correctly.
> + (when (display-supports-face-attributes-p
I'd use `and' here, instead of `when', since the evaluation result is of
interest.
> + '(:box (line-width 1)))
> + (propertize " " 'display '(space :width (1))))
> + result))
> + (cl-incf window-tool-bar--refresh-done-count))
> + (cl-incf window-tool-bar--refresh-skipped-count))
> +
> + window-tool-bar-string--cache)
> +
> +(defconst window-tool-bar--graphical-separator
> + (let ((str (make-string 3 ?\s)))
> + (set-text-properties 0 1 '(display (space :width (4))) str)
> + (set-text-properties 1 2
> + '(display (space :width (1))
> + face (:inverse-video t))
> + str)
> + (set-text-properties 2 3 '(display (space :width (4))) str)
> + str))
This should be equivalent to
(concat
(propertize " " 'display '(space :width (4)))
(propertize " " 'display '(space :width (1)) 'face '(:inverse-video t))
(propertize " " 'display '(space :width (4))))
right?
> +
> +(defun window-tool-bar--keymap-entry-to-string (menu-item)
> + "Convert MENU-ITEM into a (propertized) string representation.
> +
> +MENU-ITEM: Menu item to convert. See info node (elisp)Tool Bar."
> + (pcase menu-item
pcase or pcase-exhaustive?
> + ;; Separators
> + ((or `(,_ "--")
> + `(,_ menu-item ,(and (pred stringp)
> + (pred (string-prefix-p "--")))))
> + (if (window-tool-bar--use-images)
> + window-tool-bar--graphical-separator
> + "|"))
> +
> + ;; Menu item, turn into propertized string button
> + (`(,key menu-item ,name-expr ,binding . ,plist)
> + (when binding ; If no binding exists, then button is hidden.
> + (let* ((name (eval name-expr))
> + (str (upcase-initials (or (plist-get plist :label)
> + (string-trim-right name "\\.+"))))
> + (len (length str))
> + (enable-form (plist-get plist :enable))
> + (enabled (or (not enable-form)
> + (eval enable-form))))
> + (if enabled
> + (add-text-properties 0 len
> + '(mouse-face window-tool-bar-button-hover
> + keymap window-tool-bar--button-keymap
> + face window-tool-bar-button)
> + str)
> + (put-text-property 0 len
> + 'face
> + 'window-tool-bar-button-disabled
> + str))
> + (when-let ((spec (and (window-tool-bar--use-images)
> + (plist-get menu-item :image))))
> + (put-text-property 0 len
> + 'display
> + (append spec
> + (if enabled '(:margin 2 :ascent center)
> + '(:margin 2 :ascent center
> + :conversion disabled)))
> + str))
> + (put-text-property 0 len
> + 'help-echo
> + (or (plist-get plist :help) name)
> + str)
> + (put-text-property 0 len 'tool-bar-key key str)
> + str)))))
> +
> +(defun window-tool-bar--call-button ()
> + "Call the button that was clicked on in the tab line."
> + (interactive)
> + (when (mouse-event-p last-command-event)
> + (let ((posn (event-start last-command-event)))
> + ;; Commands need to execute with the right buffer and window
> + ;; selected. The selection needs to be permanent for isearch.
> + (select-window (posn-window posn))
> + (let* ((str (posn-string posn))
> + (key (get-text-property (cdr str) 'tool-bar-key (car str)))
> + (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
> + (call-interactively cmd)))))
> +
> +(defun window-tool-bar--ignore ()
> + "Do nothing. This command exists for isearch."
Can you elaborate? Why not just use the existing ignore? Or
defaliasing it?
> + (interactive)
> + nil)
> +
> +(defvar window-tool-bar--ignored-event-types
> + (let ((list (list 'mouse-movement 'pinch
> + 'wheel-down 'wheel-up 'wheel-left 'wheel-right
> + mouse-wheel-down-event mouse-wheel-up-event
> + mouse-wheel-left-event mouse-wheel-right-event
> + (bound-and-true-p mouse-wheel-down-alternate-event)
> + (bound-and-true-p mouse-wheel-up-alternate-event)
> + (bound-and-true-p mouse-wheel-left-alternate-event)
> + (bound-and-true-p mouse-wheel-right-alternate-event))))
> + (delete-dups (delete nil list)))
> + "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
> +
> +(defun window-tool-bar--last-command-triggers-refresh-p ()
> + "Test if the recent command or event should trigger a tool bar refresh."
> + (let ((type (event-basic-type last-command-event)))
> + (and
> + ;; Assume that key presses and button presses are the only user
> + ;; interactions that can alter the tool bar. Specifically, this
> + ;; excludes mouse movement, mouse wheel scroll, and pinch.
> + (not (member type window-tool-bar--ignored-event-types))
> + ;; Assume that any command that triggers shift select can't alter
> + ;; the tool bar. This excludes pure navigation commands.
> + (not (window-tool-bar--command-triggers-shift-select-p last-command))
> + ;; Assume that self-insert-command won't alter the tool bar.
> + ;; This is the most commonly executed command.
> + (not (eq last-command 'self-insert-command)))))
> +
> +(defun window-tool-bar--command-triggers-shift-select-p (command)
> + "Test if COMMAND would trigger shift select."
> + (let* ((form (interactive-form command))
> + (spec (car-safe (cdr-safe form))))
> + (and (eq (car-safe form) 'interactive)
> + (stringp spec)
> + (seq-position spec ?^))))
> +
> +;;;###autoload
> +(define-minor-mode window-tool-bar-mode
> + "Toggle display of the tool bar in the tab line of the current buffer."
> + :lighter nil
There is no lighter by default, I prefer writing :global nil, to make it
explicit to the reader that this is a local minor mode.
> + (let ((should-display (and window-tool-bar-mode
> + (not (eq tool-bar-map
> + (default-value 'tool-bar-map))))))
> + (if (fboundp 'tab-line-set-display)
> + ;; Newly added function for Emacs 30.
> + (tab-line-set-display 'window-tool-bar-mode
> + (and should-display
> + '(:eval (window-tool-bar-string))))
> + ;; Legacy path for Emacs 29.
> + (setq tab-line-format
> + (and should-display
> + '(:eval (window-tool-bar-string)))))))
> +
> +;;;###autoload
> +(define-globalized-minor-mode global-window-tool-bar-mode
> + window-tool-bar-mode window-tool-bar--turn-on
> + :group 'window-tool-bar
> + (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
> + (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
> +
> +(defvar window-tool-bar--allow-images t
> + "Internal debug flag to force text mode.")
> +
> +(defun window-tool-bar--use-images ()
> + "Internal function.
> +Respects `window-tool-bar--allow-images' as well as frame
> +capabilities."
> + (and window-tool-bar--allow-images
> + (display-images-p)))
> +\f
> +;;; Display styling:
> +(defface window-tool-bar-button
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88) (supports :box t))
> + :box (:line-width -1 :style released-button)
> + :background "grey85")
> + ;; If the box is not supported, dim the button background a bit.
> + (((class color) (min-colors 88))
> + :background "grey70")
> + (t
> + :inverse-video t))
> + "Face used for buttons when the mouse is not hovering over the button."
> + :group 'window-tool-bar)
> +
> +(defface window-tool-bar-button-hover
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88))
> + :box (:line-width -1 :style released-button)
> + :background "grey95")
> + (t
> + :inverse-video t))
> + "Face used for buttons when the mouse is hovering over the button."
> + :group 'window-tool-bar)
> +
> +(defface window-tool-bar-button-disabled
> + '((default
> + :inherit tab-line)
> + (((class color) (min-colors 88))
> + :box (:line-width -1 :style released-button)
> + :background "grey50"
> + :foreground "grey70")
> + (t
> + :inverse-video t
> + :background "brightblack"))
> + "Face used for buttons when the button is disabled."
> + :group 'window-tool-bar)
> +\f
> +;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
> +(defun window-tool-bar--get-keymap ()
> + "Return the tool bar keymap."
> + (let ((tool-bar-always-show-default nil))
> + (if (and (version< emacs-version "30")
> + (not (window-tool-bar--use-images)))
> + ;; This code path is a less efficient workaround.
> + (window-tool-bar--make-keymap-1)
> + (keymap-global-lookup "<tool-bar>"))))
> +
> +(declare-function image-mask-p "image.c" (spec &optional frame))
> +
> +(defun window-tool-bar--make-keymap-1 ()
> + "Patched copy of `tool-bar-make-keymap-1'."
> + (mapcar (lambda (bind)
> + (let (image-exp plist)
> + (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
> + ;; For the format of menu-items, see node
> + ;; `Extended Menu Items' in the Elisp manual.
> + (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
> + bind))
> + (setq image-exp (plist-get plist :image))
> + (consp image-exp)
> + (not (eq (car image-exp) 'image))
> + (fboundp (car image-exp)))
> + (let ((image (and (display-images-p)
> + (eval image-exp))))
> + (unless (and image (image-mask-p image))
> + (setq image (append image '(:mask heuristic))))
> + (setq bind (copy-sequence bind)
> + plist (nthcdr (if (consp (nth 4 bind)) 5 4)
> + bind))
> + (plist-put plist :image image)))
> + bind))
> + tool-bar-map))
> +
> +(defun window-tool-bar--turn-on ()
> + "Internal function called by `global-window-tool-bar-mode'."
> + (when global-window-tool-bar-mode
> + (window-tool-bar-mode 1)))
> +
> +(provide 'window-tool-bar)
> +
> +;;; window-tool-bar.el ends here
Hope this was of use.
--
Philip Kaludercic on peregrine
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-04-27 10:00 ` Philip Kaludercic
@ 2024-04-28 4:44 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 0 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-04-28 4:44 UTC (permalink / raw)
To: Philip Kaludercic; +Cc: Eli Zaretskii, 68765
[-- Attachment #1: Type: text/plain, Size: 3952 bytes --]
On 2024-04-27 03:00, Philip Kaludercic wrote:
> Eli Zaretskii <eliz@gnu.org> writes:
>
>> Ping! Ping! Philip and Jared, are there any issues left to resolve
>> here, or should this be installed?
>
> Sorry for the delay, I'm going to comment below.
I addressed all feedback provided. Updated patch for just 0003 attached
since that's where all the feedback was. Let me know if this looks
good.
>
... partial patch elided ...
>> +(defun window-tool-bar-debug-show-memory-use ()
>> + "Development-only command to show memory used by
>> `window-tool-bar-string'."
>> + (interactive)
>> + (require 'time-stamp)
>> + (save-selected-window
>> + (pop-to-buffer "*WTB Memory Report*")
>> + (unless (eq major-mode 'special-mode)
>
> You should explain what is going on here, and why you are checking
> major-mode instead of using derived-mode-p.
I changed this to call derived-mode-p. The intent is to put the buffer
into special-mode and also avoid unnecessarily calling special-mode.
>> + (special-mode))
>> +
... partial patch elided ...
>> + (insert (format "Refresh count %d\n"
>> window-tool-bar--refresh-done-count)
>> + (format "Refresh executed percent %.2f\n"
>> + (/ window-tool-bar--refresh-done-count
>> + (+ window-tool-bar--refresh-done-count
>> + window-tool-bar--refresh-skipped-count)
>> + 1.0))
>
> I don't know if there is any significant difference between (/ a b 1.0)
> and (/ a (float b)), but interesting they have the same number of
> bytecode instructions and funcalls:
I changed this and other places where I was dividing by 1.0 to force
floating point division to instead do (float a) on the first parameter.
It sounds like that's more idiomatic.
>> + "\n"))))
>> +
>> +(defun window-tool-bar--insert-memory-use (label avg-memory-use)
>> + "Insert memory use into current buffer.
>> +
>> +LABEL: A prefix string to be in front of the data.
>> +AVG-MEMORY-USE: A list of averages, with the same meaning as
>> + `memory-use-counts'."
>
> The formatting is somewhat unconventional and can easily be broken
> using M-q.
Addressed here and other places I used this convention.
>> +(defun window-tool-bar--ignore ()
>> + "Do nothing. This command exists for isearch."
>
> Can you elaborate? Why not just use the existing ignore? Or
> defaliasing it?
There's a lot of detailed comments around usage of this command, see
comments around window-tool-bar--button-keymap. I also added a bit more
context to the docstring here. In brief, this command exists so that
isearch does not exit when you click on isearch tool bar buttons. This
is needed for window tool bar buttons since they are called by Emacs'
usual mouse event bindings, unlike toolkit tool bars.
I can't use ignore because it does not have the special registration
with isearch, specifically ignore is not a member of
isearch-menu-bar-commands. I did not feel safe changing all existing
uses of ignore.
>> + (let ((type (event-basic-type last-command-event)))
... partial patch elided ...
>> +;;;###autoload
>> +(define-minor-mode window-tool-bar-mode
>> + "Toggle display of the tool bar in the tab line of the current
>> buffer."
>> + :lighter nil
>
> There is no lighter by default, I prefer writing :global nil, to make
> it
> explicit to the reader that this is a local minor mode.
Thanks, changed.
Can you update define-minor-mode's docstring to guide others in the
right direction? I only passed :lighter nil because that was the
example given by define-minor-mode's docstring, "If you provide BODY,
then you must provide at least one keyword argument (e.g. `:lighter
nil')".
>> + (let ((should-display (and window-tool-bar-mode
... partial patch elided ...
>> +;;; window-tool-bar.el ends here
>
> Hope this was of use.
Thank you for the thorough review!
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0003-Adding-window-tool-bar-package.patch --]
[-- Type: text/x-diff; name=0003-Adding-window-tool-bar-package.patch, Size: 21545 bytes --]
From 0216c9be4bd27e84b05181df05de1ea55efa4137 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 15:44:12 -0800
Subject: [PATCH 3/3] Adding window-tool-bar package
---
lisp/window-tool-bar.el | 489 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 489 insertions(+)
create mode 100644 lisp/window-tool-bar.el
diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
new file mode 100644
index 00000000000..f3410576da8
--- /dev/null
+++ b/lisp/window-tool-bar.el
@@ -0,0 +1,489 @@
+;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
+
+;; Author: Jared Finder <jared@finder.org>
+;; Created: Nov 21, 2023
+;; Version: 0.2
+;; Keywords: mouse
+;; Package-Requires: ((emacs "29.1"))
+
+;; This is a GNU ELPA :core package. Avoid adding functionality that
+;; is not available in the version of Emacs recorded above or any of
+;; the package dependencies.
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs 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 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This package puts a tool bar in each window. This allows you to see
+;; multiple tool bars simultaneously directly next to the buffer it
+;; acts on which feels much more intuitive. Emacs "browsing" modes
+;; generally have sensible tool bars, for example: *info*, *help*, and
+;; *eww* have them.
+;;
+;; It does this while being mindful of screen real estate. Most modes
+;; do not provide a custom tool bar, and this package does not show the
+;; default tool bar. This means that for most buffers there will be no
+;; space taken up. Furthermore, you can put this tool bar in the mode
+;; line or tab line if you want to share it with existing content.
+;;
+;; To get the default behavior, run (global-window-tool-bar-mode 1) or
+;; enable via M-x customize-group RET window-tool-bar RET. This uses
+;; the per-window tab line to show the tool bar.
+;;
+;; If you want to share space with an existing tab line, mode line, or
+;; header line, add (:eval (window-tool-bar-string)) to
+;; `tab-line-format', `mode-line-format', or `header-line-format'.
+
+;;; Known issues:
+;;
+;; On GNU Emacs 29.1, terminals dragging to resize windows will error
+;; with message "<tab-line> <mouse-movement> is undefined". This is a
+;; bug in GNU Emacs,
+;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
+;;
+;; On GNU Emacs 29, performance in terminals is lower than on
+;; graphical frames. This is due to a workaround, see "Workaround for
+;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
+
+;;; Todo:
+;;
+;; Not all features planned are implemented yet. Eventually I would
+;; like to also generally make tool bars better.
+;;
+;; Targeting 0.3:
+;; * Properly support reamining less frequently used tool bar item specs. From
+;; `parse_tool_bar_item':
+;; * :visible
+;; * :filter
+;; * :button
+;; * :wrap
+;; * Add display customization similar to `tool-bar-style'.
+;;
+;; Targeting 1.0:
+;;
+;; * Clean up Emacs tool bars
+;; * Default: Remove default tool-bar entirely
+;; * grep, vc: Remove default tool-bar inherited
+;; * info: Remove Next / Prev / Up, which is already in the header
+;; * smerge: Add tool bar for next/prev
+;;
+;; Post 1.0 work:
+;;
+;; * Show keyboard shortcut on help text.
+;;
+;; * Add a bit more documentation.
+;; * Add customization option: ignore-default-tool-bar-map
+;; * Make tab-line dragging resize the window
+
+;;; Code:
+
+(require 'mwheel)
+(require 'tab-line)
+(require 'tool-bar)
+\f
+;;; Benchmarking code
+;;
+;; Refreshing the tool bar is computationally simple, but generates a
+;; lot of garbage. So this benchmarking focuses on garbage
+;; generation. Since it has to run after most commands, generating
+;; significantly more garbage will cause noticeable performance
+;; degration.
+;;
+;; The refresh has two steps:
+;;
+;; Step 1: Look up the <tool-bar> map.
+;; Step 2: Generate a Lisp string using text properties for the tool
+;; bar string.
+;;
+;; Additionally, we keep track of the percentage of commands that
+;; acutally created a refresh.
+(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
+ "Absolute delta of memory use counters during step 1.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
+ "Absolute delta of memory use counters during step 2.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--refresh-done-count 0
+ "Number of tool bar string refreshes run.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-skipped-count'.")
+(defvar window-tool-bar--refresh-skipped-count 0
+ "Number of tool bar string refreshes that were skipped.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-done-count'.")
+
+(defun window-tool-bar--memory-use-avg-step1 ()
+ "Return average memory use delta during step 1."
+ (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
+ window-tool-bar--memory-use-delta-step1))
+
+(defun window-tool-bar--memory-use-avg-step2 ()
+ "Return average memory use delta during step 2."
+ (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
+ window-tool-bar--memory-use-delta-step2))
+
+(declare-function time-stamp-string "time-stamp")
+
+(defun window-tool-bar-debug-show-memory-use ()
+ "Development-only command to show memory used by `window-tool-bar-string'."
+ (interactive)
+ (require 'time-stamp)
+ (save-selected-window
+ (pop-to-buffer "*WTB Memory Report*")
+ (unless (derived-mode-p 'special-mode)
+ (special-mode))
+
+ (goto-char (point-max))
+ (let ((inhibit-read-only t))
+ (insert (propertize (concat "Function: window-tool-bar-string "
+ (time-stamp-string))
+ 'face 'underline 'font-lock-face 'underline)
+ "\n\n")
+ (window-tool-bar--insert-memory-use
+ "Step 1" (window-tool-bar--memory-use-avg-step1))
+ (window-tool-bar--insert-memory-use
+ "Step 2" (window-tool-bar--memory-use-avg-step2))
+ (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
+ (format "Refresh executed percent %.2f\n"
+ (/ (float window-tool-bar--refresh-done-count)
+ (+ window-tool-bar--refresh-done-count
+ window-tool-bar--refresh-skipped-count)))
+ "\n"))))
+
+(defun window-tool-bar--insert-memory-use (label avg-memory-use)
+ "Insert memory use into current buffer.
+
+LABEL is a prefix string to be in front of the data.
+AVG-MEMORY-USE is a list of averages, with the same meaning as
+`memory-use-counts'."
+ (let* ((label-len (length label))
+ (padding (make-string label-len ?\s)))
+ (cl-loop for usage in avg-memory-use
+ for usage-label in '("Conses" "Floats" "Vector cells" "Symbols"
+ "String chars" "Intervals" "Strings")
+ for idx from 0
+ do (insert (format "%s %8.2f %s\n"
+ (if (= idx 0) label padding)
+ usage
+ usage-label)))))
+\f
+(defgroup window-tool-bar nil
+ "Tool bars per-window."
+ :group 'convenience
+ :prefix "window-tool-bar-")
+
+(defvar-keymap window-tool-bar--button-keymap
+ :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
+ "<follow-link>" 'mouse-face
+ ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
+ ;; bar is not a place the point can travel to.
+ "<tab-line> <mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
+
+ ;; Mouse down events do nothing. A binding is needed so isearch
+ ;; does not exit when the tab bar is clicked.
+ "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
+(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
+
+;; Register bindings that stay in isearch. Technically, these
+;; commands don't pop up a menu but they act very similar in that they
+;; are caused by mouse input and may call commands via
+;; `call-interactively'.
+(push 'window-tool-bar--call-button isearch-menu-bar-commands)
+(push 'window-tool-bar--ignore isearch-menu-bar-commands)
+
+(defvar-local window-tool-bar-string--cache nil
+ "Cache for previous result of `window-tool-bar-string'.")
+
+;;;###autoload
+(defun window-tool-bar-string ()
+ "Return a (propertized) string for the tool bar.
+
+This is for when you want more customizations than
+`window-tool-bar-mode' provides. Commonly added to the variable
+`tab-line-format', `header-line-format', or `mode-line-format'"
+ (if (or (null window-tool-bar-string--cache)
+ (window-tool-bar--last-command-triggers-refresh-p))
+ (let* ((mem0 (memory-use-counts))
+ (toolbar-menu (window-tool-bar--get-keymap))
+ (mem1 (memory-use-counts))
+ (result (mapconcat #'window-tool-bar--keymap-entry-to-string
+ (cdr toolbar-menu) ;Skip 'keymap
+ ;; Without spaces between the text, hovering
+ ;; highlights all adjacent buttons.
+ (if (window-tool-bar--use-images)
+ (propertize " " 'invisible t)
+ " ")))
+ (mem2 (memory-use-counts)))
+ (cl-mapl (lambda (l-init l0 l1)
+ (cl-incf (car l-init) (- (car l1) (car l0))))
+ window-tool-bar--memory-use-delta-step1 mem0 mem1)
+ (cl-mapl (lambda (l-init l1 l2)
+ (cl-incf (car l-init) (- (car l2) (car l1))))
+ window-tool-bar--memory-use-delta-step2 mem1 mem2)
+
+ (setf window-tool-bar-string--cache
+ (concat
+ ;; The tool bar face by default puts boxes around the
+ ;; buttons. However, this box is not displayed if the
+ ;; box starts at the leftmost pixel of the tab-line.
+ ;; Add a single space in this case so the box displays
+ ;; correctly.
+ (and (display-supports-face-attributes-p
+ '(:box (line-width 1)))
+ (propertize " " 'display '(space :width (1))))
+ result))
+ (cl-incf window-tool-bar--refresh-done-count))
+ (cl-incf window-tool-bar--refresh-skipped-count))
+
+ window-tool-bar-string--cache)
+
+(defconst window-tool-bar--graphical-separator
+ (concat
+ (propertize " " 'display '(space :width (4)))
+ (propertize " " 'display '(space :width (1) face (:inverse-video t)))
+ (propertize " " 'display '(space :width (4)))))
+
+(defun window-tool-bar--keymap-entry-to-string (menu-item)
+ "Convert MENU-ITEM into a (propertized) string representation.
+
+MENU-ITEM is a menu item to convert. See info node (elisp)Tool Bar."
+ (pcase-exhaustive menu-item
+ ;; Separators
+ ((or `(,_ "--")
+ `(,_ menu-item ,(and (pred stringp)
+ (pred (string-prefix-p "--")))))
+ (if (window-tool-bar--use-images)
+ window-tool-bar--graphical-separator
+ "|"))
+
+ ;; Menu item, turn into propertized string button
+ (`(,key menu-item ,name-expr ,binding . ,plist)
+ (when binding ; If no binding exists, then button is hidden.
+ (let* ((name (eval name-expr))
+ (str (upcase-initials (or (plist-get plist :label)
+ (string-trim-right name "\\.+"))))
+ (len (length str))
+ (enable-form (plist-get plist :enable))
+ (enabled (or (not enable-form)
+ (eval enable-form))))
+ (if enabled
+ (add-text-properties 0 len
+ '(mouse-face window-tool-bar-button-hover
+ keymap window-tool-bar--button-keymap
+ face window-tool-bar-button)
+ str)
+ (put-text-property 0 len
+ 'face
+ 'window-tool-bar-button-disabled
+ str))
+ (when-let ((spec (and (window-tool-bar--use-images)
+ (plist-get menu-item :image))))
+ (put-text-property 0 len
+ 'display
+ (append spec
+ (if enabled '(:margin 2 :ascent center)
+ '(:margin 2 :ascent center
+ :conversion disabled)))
+ str))
+ (put-text-property 0 len
+ 'help-echo
+ (or (plist-get plist :help) name)
+ str)
+ (put-text-property 0 len 'tool-bar-key key str)
+ str)))))
+
+(defun window-tool-bar--call-button ()
+ "Call the button that was clicked on in the tab line."
+ (interactive)
+ (when (mouse-event-p last-command-event)
+ (let ((posn (event-start last-command-event)))
+ ;; Commands need to execute with the right buffer and window
+ ;; selected. The selection needs to be permanent for isearch.
+ (select-window (posn-window posn))
+ (let* ((str (posn-string posn))
+ (key (get-text-property (cdr str) 'tool-bar-key (car str)))
+ (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
+ (call-interactively cmd)))))
+
+(defun window-tool-bar--ignore ()
+ "Internal command so isearch does not exit on button-down events."
+ (interactive)
+ nil)
+
+(defvar window-tool-bar--ignored-event-types
+ (let ((list (list 'mouse-movement 'pinch
+ 'wheel-down 'wheel-up 'wheel-left 'wheel-right
+ mouse-wheel-down-event mouse-wheel-up-event
+ mouse-wheel-left-event mouse-wheel-right-event
+ (bound-and-true-p mouse-wheel-down-alternate-event)
+ (bound-and-true-p mouse-wheel-up-alternate-event)
+ (bound-and-true-p mouse-wheel-left-alternate-event)
+ (bound-and-true-p mouse-wheel-right-alternate-event))))
+ (delete-dups (delete nil list)))
+ "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
+
+(defun window-tool-bar--last-command-triggers-refresh-p ()
+ "Test if the recent command or event should trigger a tool bar refresh."
+ (let ((type (event-basic-type last-command-event)))
+ (and
+ ;; Assume that key presses and button presses are the only user
+ ;; interactions that can alter the tool bar. Specifically, this
+ ;; excludes mouse movement, mouse wheel scroll, and pinch.
+ (not (member type window-tool-bar--ignored-event-types))
+ ;; Assume that any command that triggers shift select can't alter
+ ;; the tool bar. This excludes pure navigation commands.
+ (not (window-tool-bar--command-triggers-shift-select-p last-command))
+ ;; Assume that self-insert-command won't alter the tool bar.
+ ;; This is the most commonly executed command.
+ (not (eq last-command 'self-insert-command)))))
+
+(defun window-tool-bar--command-triggers-shift-select-p (command)
+ "Test if COMMAND would trigger shift select."
+ (let* ((form (interactive-form command))
+ (spec (car-safe (cdr-safe form))))
+ (and (eq (car-safe form) 'interactive)
+ (stringp spec)
+ (seq-position spec ?^))))
+
+;;;###autoload
+(define-minor-mode window-tool-bar-mode
+ "Toggle display of the tool bar in the tab line of the current buffer."
+ :global nil
+ (let ((should-display (and window-tool-bar-mode
+ (not (eq tool-bar-map
+ (default-value 'tool-bar-map))))))
+ (if (fboundp 'tab-line-set-display)
+ ;; Newly added function for Emacs 30.
+ (tab-line-set-display 'window-tool-bar-mode
+ (and should-display
+ '(:eval (window-tool-bar-string))))
+ ;; Legacy path for Emacs 29.
+ (setq tab-line-format
+ (and should-display
+ '(:eval (window-tool-bar-string)))))))
+
+;;;###autoload
+(define-globalized-minor-mode global-window-tool-bar-mode
+ window-tool-bar-mode window-tool-bar--turn-on
+ :group 'window-tool-bar
+ (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
+ (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
+
+(defvar window-tool-bar--allow-images t
+ "Internal debug flag to force text mode.")
+
+(defun window-tool-bar--use-images ()
+ "Internal function.
+Respects `window-tool-bar--allow-images' as well as frame
+capabilities."
+ (and window-tool-bar--allow-images
+ (display-images-p)))
+\f
+;;; Display styling:
+(defface window-tool-bar-button
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88) (supports :box t))
+ :box (:line-width -1 :style released-button)
+ :background "grey85")
+ ;; If the box is not supported, dim the button background a bit.
+ (((class color) (min-colors 88))
+ :background "grey70")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is not hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-hover
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey95")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-disabled
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey50"
+ :foreground "grey70")
+ (t
+ :inverse-video t
+ :background "brightblack"))
+ "Face used for buttons when the button is disabled."
+ :group 'window-tool-bar)
+\f
+;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
+(defun window-tool-bar--get-keymap ()
+ "Return the tool bar keymap."
+ (let ((tool-bar-always-show-default nil))
+ (if (and (version< emacs-version "30")
+ (not (window-tool-bar--use-images)))
+ ;; This code path is a less efficient workaround.
+ (window-tool-bar--make-keymap-1)
+ (keymap-global-lookup "<tool-bar>"))))
+
+(declare-function image-mask-p "image.c" (spec &optional frame))
+
+(defun window-tool-bar--make-keymap-1 ()
+ "Patched copy of `tool-bar-make-keymap-1'."
+ (mapcar (lambda (bind)
+ (let (image-exp plist)
+ (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
+ ;; For the format of menu-items, see node
+ ;; `Extended Menu Items' in the Elisp manual.
+ (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (setq image-exp (plist-get plist :image))
+ (consp image-exp)
+ (not (eq (car image-exp) 'image))
+ (fboundp (car image-exp)))
+ (let ((image (and (display-images-p)
+ (eval image-exp))))
+ (unless (and image (image-mask-p image))
+ (setq image (append image '(:mask heuristic))))
+ (setq bind (copy-sequence bind)
+ plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (plist-put plist :image image)))
+ bind))
+ tool-bar-map))
+
+(defun window-tool-bar--turn-on ()
+ "Internal function called by `global-window-tool-bar-mode'."
+ (when global-window-tool-bar-mode
+ (window-tool-bar-mode 1)))
+
+(provide 'window-tool-bar)
+
+;;; window-tool-bar.el ends here
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-03-27 7:04 ` Juri Linkov
@ 2024-05-02 6:03 ` Juri Linkov
2024-05-09 8:00 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Juri Linkov @ 2024-05-02 6:03 UTC (permalink / raw)
To: Jared Finder; +Cc: Philip Kaludercic, Eli Zaretskii, 68765, Stefan Monnier
>> It's been four weeks and I've seen no reply to this comment. Are there any
>> other concerns?
>
> Sorry, I didn't know that you expected that I should review your patch -
> I was silent because your last patch has no changes in tab-line.el,
> so I have no more objections in this regard.
The reason why no changes are required in tab-line.el is
because this feature is not exclusively for the tab line,
so window-tool-bar.el should also handle the case
when the tool bar is combined with the header line.
For example, in Info mode the users might prefer to show
the Info tool bar icons and Next/Prev/Up
on the same header line.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-02 6:03 ` Juri Linkov
@ 2024-05-09 8:00 ` Eli Zaretskii
2024-05-10 4:24 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-09 8:00 UTC (permalink / raw)
To: Juri Linkov; +Cc: philipk, jared, 68765, monnier
> From: Juri Linkov <juri@linkov.net>
> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org, Philip Kaludercic
> <philipk@posteo.net>, Stefan Monnier <monnier@iro.umontreal.ca>
> Date: Thu, 02 May 2024 09:03:20 +0300
>
> >> It's been four weeks and I've seen no reply to this comment. Are there any
> >> other concerns?
> >
> > Sorry, I didn't know that you expected that I should review your patch -
> > I was silent because your last patch has no changes in tab-line.el,
> > so I have no more objections in this regard.
>
> The reason why no changes are required in tab-line.el is
> because this feature is not exclusively for the tab line,
> so window-tool-bar.el should also handle the case
> when the tool bar is combined with the header line.
> For example, in Info mode the users might prefer to show
> the Info tool bar icons and Next/Prev/Up
> on the same header line.
If there's an agreement about this issue, could you, Jared, please
post the final patch reflecting the agreements?
If there's no agreement, what are the issues that prevent it?
Thanks.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-09 8:00 ` Eli Zaretskii
@ 2024-05-10 4:24 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-11 4:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-10 4:24 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, Juri Linkov
On 2024-05-09 01:00, Eli Zaretskii wrote:
>> From: Juri Linkov <juri@linkov.net>
>> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org, Philip
>> Kaludercic
>> <philipk@posteo.net>, Stefan Monnier <monnier@iro.umontreal.ca>
>> Date: Thu, 02 May 2024 09:03:20 +0300
>>
>> >> It's been four weeks and I've seen no reply to this comment. Are there any
>> >> other concerns?
>> >
>> > Sorry, I didn't know that you expected that I should review your patch -
>> > I was silent because your last patch has no changes in tab-line.el,
>> > so I have no more objections in this regard.
>>
>> The reason why no changes are required in tab-line.el is
>> because this feature is not exclusively for the tab line,
>> so window-tool-bar.el should also handle the case
>> when the tool bar is combined with the header line.
>> For example, in Info mode the users might prefer to show
>> the Info tool bar icons and Next/Prev/Up
>> on the same header line.
>
> If there's an agreement about this issue, could you, Jared, please
> post the final patch reflecting the agreements?
>
> If there's no agreement, what are the issues that prevent it?
I'm unclear on what changes Juri would like to window-tool-bar.el.
Sorry for the really long reply, I just want to make sure things are
extra clear so I can proceed.
First, let me share some additional information. window-tool-bar.el
currently provides two ways for a user to put the tool bar buttons into
tab line / header line / mode line:
The command window-tool-bar-mode for simple enablement.
The function window-tool-bar-string can be added as (:eval
(window-tool-bar-string)) to tab-line-format, header-line-format, or
mode-line-format programmatically for more advanced placement.
I think the above interface is the right thing to have from a user
perspective. Then the most straightforward thing would be to make M-x
window-tool-bar-mode behave similar to M-x tab-line-mode: it would
always put the tool bar on the tab line, and only make changes if
nothing else changed tab-line-format.
Additionally, I would make a very small change then to tab-line.el to
display a message to the user if M-x tab-line-mode does not actually
changing anything to avoid user confusion as this now can happen by
running commands (M-x window-tool-bar-mode RET M-x tab-line-mode RET,
for example). I would add similar messaging to window-tool-bar as well.
Does this sound like a good plan?
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-10 4:24 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-11 4:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-12 16:34 ` Juri Linkov
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-11 4:33 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, Juri Linkov
My prior reply got blocked as spam. Sending again.
On 2024-05-09 01:00, Eli Zaretskii wrote:
>> From: Juri Linkov <juri@linkov.net>
>> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org, Philip
>> Kaludercic
>> <philipk@posteo.net>, Stefan Monnier <monnier@iro.umontreal.ca>
>> Date: Thu, 02 May 2024 09:03:20 +0300
>>
>> >> It's been four weeks and I've seen no reply to this comment. Are there any
>> >> other concerns?
>> >
>> > Sorry, I didn't know that you expected that I should review your patch -
>> > I was silent because your last patch has no changes in tab-line.el,
>> > so I have no more objections in this regard.
>>
>> The reason why no changes are required in tab-line.el is
>> because this feature is not exclusively for the tab line,
>> so window-tool-bar.el should also handle the case
>> when the tool bar is combined with the header line.
>> For example, in Info mode the users might prefer to show
>> the Info tool bar icons and Next/Prev/Up
>> on the same header line.
>
> If there's an agreement about this issue, could you, Jared, please
> post the final patch reflecting the agreements?
>
> If there's no agreement, what are the issues that prevent it?
I'm unclear on what changes Juri would like to window-tool-bar.el.
Sorry for the really long reply, I just want to make sure things are
extra clear so I can proceed.
First, let me share some additional information. window-tool-bar.el
currently provides two ways for a user to put the tool bar buttons into
tab line / header line / mode line:
The command window-tool-bar-mode for simple enablement.
The function window-tool-bar-string can be added as (:eval
(window-tool-bar-string)) to tab-line-format, header-line-format, or
mode-line-format programmatically for more advanced placement.
I think the above interface is the right thing to have from a user
perspective. Then the most straightforward thing would be to make M-x
window-tool-bar-mode behave similar to M-x tab-line-mode: it would
always put the tool bar on the tab line, and only make changes if
nothing else changed tab-line-format.
Additionally, I would make a very small change then to tab-line.el to
display a message to the user if M-x tab-line-mode does not actually
changing anything to avoid user confusion as this now can happen by
running commands (M-x window-tool-bar-mode RET M-x tab-line-mode RET,
for example). I would add similar messaging to window-tool-bar as well.
Does this sound like a good plan?
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-11 4:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-12 16:34 ` Juri Linkov
2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Juri Linkov @ 2024-05-12 16:34 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, Eli Zaretskii, 68765, monnier
>>> >> It's been four weeks and I've seen no reply to this comment. Are
>>> >> there any other concerns?
>>> >
>>> > Sorry, I didn't know that you expected that I should review your patch -
>>> > I was silent because your last patch has no changes in tab-line.el,
>>> > so I have no more objections in this regard.
>>> The reason why no changes are required in tab-line.el is
>>> because this feature is not exclusively for the tab line,
>>> so window-tool-bar.el should also handle the case
>>> when the tool bar is combined with the header line.
>>> For example, in Info mode the users might prefer to show
>>> the Info tool bar icons and Next/Prev/Up
>>> on the same header line.
>> If there's an agreement about this issue, could you, Jared, please
>> post the final patch reflecting the agreements?
>> If there's no agreement, what are the issues that prevent it?
>
> I'm unclear on what changes Juri would like to window-tool-bar.el. Sorry
> for the really long reply, I just want to make sure things are extra clear
> so I can proceed.
>
> First, let me share some additional information. window-tool-bar.el
> currently provides two ways for a user to put the tool bar buttons into tab
> line / header line / mode line:
>
> The command window-tool-bar-mode for simple enablement.
> The function window-tool-bar-string can be added as (:eval
> (window-tool-bar-string)) to tab-line-format, header-line-format, or
> mode-line-format programmatically for more advanced placement.
>
> I think the above interface is the right thing to have from a user
> perspective. Then the most straightforward thing would be to make M-x
> window-tool-bar-mode behave similar to M-x tab-line-mode: it would always
> put the tool bar on the tab line, and only make changes if nothing else
> changed tab-line-format.
>
> Additionally, I would make a very small change then to tab-line.el to
> display a message to the user if M-x tab-line-mode does not actually
> changing anything to avoid user confusion as this now can happen by running
> commands (M-x window-tool-bar-mode RET M-x tab-line-mode RET, for example).
> I would add similar messaging to window-tool-bar as well.
>
> Does this sound like a good plan?
Thanks, looks like a good thing to do.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-12 16:34 ` Juri Linkov
@ 2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-14 6:01 ` Juri Linkov
` (2 more replies)
0 siblings, 3 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-14 4:14 UTC (permalink / raw)
To: Juri Linkov; +Cc: philipk, Eli Zaretskii, 68765, monnier
[-- Attachment #1: Type: text/plain, Size: 637 bytes --]
On 2024-05-12 09:34, Juri Linkov wrote:
>>> If there's an agreement about this issue, could you, Jared, please
>>> post the final patch reflecting the agreements?
>>> If there's no agreement, what are the issues that prevent it?
... details elided ...
>> Does this sound like a good plan?
>
> Thanks, looks like a good thing to do.
Thank you! Final version of all three commits attached. These address
all comments raised on this thread.
I think after these patches are applied, the remaining work to resolve
this would be having the ELPA package added and me updating NEWS and the
manual. I can start on the updates.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Inform-user-when-tab-line-mode-command-makes-no-chan.patch --]
[-- Type: text/x-diff; name=0001-Inform-user-when-tab-line-mode-command-makes-no-chan.patch, Size: 1454 bytes --]
From 0ec19748c5d973a93ed00336fcc955ec5e8d9397 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Sun, 12 May 2024 20:35:50 -0700
Subject: [PATCH 1/3] Inform user when tab-line-mode command makes no change
* lisp/tab-line.el (tab-line-mode): Display message when command is
run on already altered tab-line-format.
---
lisp/tab-line.el | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/lisp/tab-line.el b/lisp/tab-line.el
index 6898ba53e02..316c87fb3ad 100644
--- a/lisp/tab-line.el
+++ b/lisp/tab-line.el
@@ -1124,11 +1124,17 @@ tab-line-mode
(let ((default-value '(:eval (tab-line-format))))
(if tab-line-mode
;; Preserve the existing tab-line set outside of this mode
- (unless tab-line-format
- (setq tab-line-format default-value))
+ (if (null tab-line-format)
+ (setq tab-line-format default-value)
+ (message
+ "tab-line-format set outside of tab-line-mode, currently `%S'"
+ tab-line-format))
;; Reset only values set by this mode
- (when (equal tab-line-format default-value)
- (setq tab-line-format nil)))))
+ (if (equal tab-line-format default-value)
+ (setq tab-line-format nil)
+ (message
+ "tab-line-format set outside of tab-line-mode, currently `%S'"
+ tab-line-format)))))
(defcustom tab-line-exclude-modes
'(completion-list-mode)
--
2.39.2
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Add-user-option-to-only-display-default-tool-bar.patch --]
[-- Type: text/x-diff; name=0002-Add-user-option-to-only-display-default-tool-bar.patch, Size: 2059 bytes --]
From 232ec47d1d9e8f5b1ac07db1251e89c1feb73e85 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 10:08:30 -0800
Subject: [PATCH 2/3] Add user option to only display default tool bar
This works well with `window-tool-bar-mode', to be added in upcoming
commit. Then the default tool bar is displayed frame-wide and
mode-specific tool bars are displayed in the window that mode is
active in.
* lisp/tool-bar.el (tool-bar-always-show-default): New user option.
(tool-bar--cache-key, tool-bar-make-keymap-1): Return default tool bar
when option is set.
---
lisp/tool-bar.el | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
index 0f645338674..01c65c42324 100644
--- a/lisp/tool-bar.el
+++ b/lisp/tool-bar.el
@@ -100,7 +100,9 @@ secondary-tool-bar-map
(defconst tool-bar-keymap-cache (make-hash-table :test #'equal))
(defsubst tool-bar--cache-key ()
- (cons (frame-terminal) (sxhash-eq tool-bar-map)))
+ (cons (frame-terminal)
+ (sxhash-eq (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
(defsubst tool-bar--secondary-cache-key ()
(cons (frame-terminal) (sxhash-eq secondary-tool-bar-map)))
@@ -191,7 +193,9 @@ tool-bar-make-keymap-1
bind))
(plist-put plist :image image)))
bind))
- (or map tool-bar-map)))
+ (or map
+ (if tool-bar-always-show-default (default-value 'tool-bar-map)
+ tool-bar-map))))
;;;###autoload
(defun tool-bar-add-item (icon def key &rest props)
@@ -378,6 +382,15 @@ tool-bar-setup
(modify-all-frames-parameters
(list (cons 'tool-bar-position val))))))
+(defcustom tool-bar-always-show-default nil
+ "If non-nil, `tool-bar-mode' only shows the default tool bar.
+This works well when also using `global-window-tool-bar-mode' to
+display buffer-specific tool bars."
+ :type 'boolean
+ :group 'frames
+ :group 'mouse
+ :version "30.1")
+
\f
;; Modifier bar mode.
--
2.39.2
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #4: 0003-Adding-window-tool-bar-package.patch --]
[-- Type: text/x-diff; name=0003-Adding-window-tool-bar-package.patch, Size: 21567 bytes --]
From 56753e05f7c49593d92391b7e6a9eb1c72724d3c Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Fri, 26 Jan 2024 15:44:12 -0800
Subject: [PATCH 3/3] Adding window-tool-bar package
---
lisp/window-tool-bar.el | 491 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 491 insertions(+)
create mode 100644 lisp/window-tool-bar.el
diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
new file mode 100644
index 00000000000..640deccdd61
--- /dev/null
+++ b/lisp/window-tool-bar.el
@@ -0,0 +1,491 @@
+;;; window-tool-bar.el --- Add tool bars inside windows -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
+
+;; Author: Jared Finder <jared@finder.org>
+;; Created: Nov 21, 2023
+;; Version: 0.2
+;; Keywords: mouse
+;; Package-Requires: ((emacs "29.1"))
+
+;; This is a GNU ELPA :core package. Avoid adding functionality that
+;; is not available in the version of Emacs recorded above or any of
+;; the package dependencies.
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs 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 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This package puts a tool bar in each window. This allows you to see
+;; multiple tool bars simultaneously directly next to the buffer it
+;; acts on which feels much more intuitive. Emacs "browsing" modes
+;; generally have sensible tool bars, for example: *info*, *help*, and
+;; *eww* have them.
+;;
+;; It does this while being mindful of screen real estate. Most modes
+;; do not provide a custom tool bar, and this package does not show the
+;; default tool bar. This means that for most buffers there will be no
+;; space taken up. Furthermore, you can put this tool bar in the mode
+;; line or tab line if you want to share it with existing content.
+;;
+;; To get the default behavior, run (global-window-tool-bar-mode 1) or
+;; enable via M-x customize-group RET window-tool-bar RET. This uses
+;; the per-window tab line to show the tool bar.
+;;
+;; If you want to share space with an existing tab line, mode line, or
+;; header line, add (:eval (window-tool-bar-string)) to
+;; `tab-line-format', `mode-line-format', or `header-line-format'.
+
+;;; Known issues:
+;;
+;; On GNU Emacs 29.1, terminals dragging to resize windows will error
+;; with message "<tab-line> <mouse-movement> is undefined". This is a
+;; bug in GNU Emacs,
+;; <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=67457>.
+;;
+;; On GNU Emacs 29, performance in terminals is lower than on
+;; graphical frames. This is due to a workaround, see "Workaround for
+;; https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334", below.
+
+;;; Todo:
+;;
+;; Not all features planned are implemented yet. Eventually I would
+;; like to also generally make tool bars better.
+;;
+;; Targeting 0.3:
+;; * Properly support reamining less frequently used tool bar item specs. From
+;; `parse_tool_bar_item':
+;; * :visible
+;; * :filter
+;; * :button
+;; * :wrap
+;; * Add display customization similar to `tool-bar-style'.
+;;
+;; Targeting 1.0:
+;;
+;; * Clean up Emacs tool bars
+;; * Default: Remove default tool-bar entirely
+;; * grep, vc: Remove default tool-bar inherited
+;; * info: Remove Next / Prev / Up, which is already in the header
+;; * smerge: Add tool bar for next/prev
+;;
+;; Post 1.0 work:
+;;
+;; * Show keyboard shortcut on help text.
+;;
+;; * Add a bit more documentation.
+;; * Add customization option: ignore-default-tool-bar-map
+;; * Make tab-line dragging resize the window
+
+;;; Code:
+
+(require 'mwheel)
+(require 'tab-line)
+(require 'tool-bar)
+\f
+;;; Benchmarking code
+;;
+;; Refreshing the tool bar is computationally simple, but generates a
+;; lot of garbage. So this benchmarking focuses on garbage
+;; generation. Since it has to run after most commands, generating
+;; significantly more garbage will cause noticeable performance
+;; degration.
+;;
+;; The refresh has two steps:
+;;
+;; Step 1: Look up the <tool-bar> map.
+;; Step 2: Generate a Lisp string using text properties for the tool
+;; bar string.
+;;
+;; Additionally, we keep track of the percentage of commands that
+;; acutally created a refresh.
+(defvar window-tool-bar--memory-use-delta-step1 (make-list 7 0)
+ "Absolute delta of memory use counters during step 1.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--memory-use-delta-step2 (make-list 7 0)
+ "Absolute delta of memory use counters during step 2.
+This is a list in the same structure as `memory-use-counts'.")
+(defvar window-tool-bar--refresh-done-count 0
+ "Number of tool bar string refreshes run.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-skipped-count'.")
+(defvar window-tool-bar--refresh-skipped-count 0
+ "Number of tool bar string refreshes that were skipped.
+The total number of requests is the sum of this and
+`window-tool-bar--refresh-done-count'.")
+
+(defun window-tool-bar--memory-use-avg-step1 ()
+ "Return average memory use delta during step 1."
+ (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
+ window-tool-bar--memory-use-delta-step1))
+
+(defun window-tool-bar--memory-use-avg-step2 ()
+ "Return average memory use delta during step 2."
+ (mapcar (lambda (elt) (/ (float elt) window-tool-bar--refresh-done-count))
+ window-tool-bar--memory-use-delta-step2))
+
+(declare-function time-stamp-string "time-stamp")
+
+(defun window-tool-bar-debug-show-memory-use ()
+ "Development-only command to show memory used by `window-tool-bar-string'."
+ (interactive)
+ (require 'time-stamp)
+ (save-selected-window
+ (pop-to-buffer "*WTB Memory Report*")
+ (unless (derived-mode-p 'special-mode)
+ (special-mode))
+
+ (goto-char (point-max))
+ (let ((inhibit-read-only t))
+ (insert (propertize (concat "Function: window-tool-bar-string "
+ (time-stamp-string))
+ 'face 'underline 'font-lock-face 'underline)
+ "\n\n")
+ (window-tool-bar--insert-memory-use
+ "Step 1" (window-tool-bar--memory-use-avg-step1))
+ (window-tool-bar--insert-memory-use
+ "Step 2" (window-tool-bar--memory-use-avg-step2))
+ (insert (format "Refresh count %d\n" window-tool-bar--refresh-done-count)
+ (format "Refresh executed percent %.2f\n"
+ (/ (float window-tool-bar--refresh-done-count)
+ (+ window-tool-bar--refresh-done-count
+ window-tool-bar--refresh-skipped-count)))
+ "\n"))))
+
+(defun window-tool-bar--insert-memory-use (label avg-memory-use)
+ "Insert memory use into current buffer.
+
+LABEL is a prefix string to be in front of the data.
+AVG-MEMORY-USE is a list of averages, with the same meaning as
+`memory-use-counts'."
+ (let* ((label-len (length label))
+ (padding (make-string label-len ?\s)))
+ (cl-loop for usage in avg-memory-use
+ for usage-label in '("Conses" "Floats" "Vector cells" "Symbols"
+ "String chars" "Intervals" "Strings")
+ for idx from 0
+ do (insert (format "%s %8.2f %s\n"
+ (if (= idx 0) label padding)
+ usage
+ usage-label)))))
+\f
+(defgroup window-tool-bar nil
+ "Tool bars per-window."
+ :group 'convenience
+ :prefix "window-tool-bar-")
+
+(defvar-keymap window-tool-bar--button-keymap
+ :doc "Keymap used by `window-tool-bar--keymap-entry-to-string'."
+ "<follow-link>" 'mouse-face
+ ;; Follow link on all clicks of mouse-1 and mouse-2 since the tool
+ ;; bar is not a place the point can travel to.
+ "<tab-line> <mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-1>" #'window-tool-bar--call-button
+ "<tab-line> <mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <double-mouse-2>" #'window-tool-bar--call-button
+ "<tab-line> <triple-mouse-2>" #'window-tool-bar--call-button
+
+ ;; Mouse down events do nothing. A binding is needed so isearch
+ ;; does not exit when the tab bar is clicked.
+ "<tab-line> <down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-1>" #'window-tool-bar--ignore
+ "<tab-line> <down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <double-down-mouse-2>" #'window-tool-bar--ignore
+ "<tab-line> <triple-down-mouse-2>" #'window-tool-bar--ignore)
+(fset 'window-tool-bar--button-keymap window-tool-bar--button-keymap) ; So it can be a keymap property
+
+;; Register bindings that stay in isearch. Technically, these
+;; commands don't pop up a menu but they act very similar in that they
+;; are caused by mouse input and may call commands via
+;; `call-interactively'.
+(push 'window-tool-bar--call-button isearch-menu-bar-commands)
+(push 'window-tool-bar--ignore isearch-menu-bar-commands)
+
+(defvar-local window-tool-bar-string--cache nil
+ "Cache for previous result of `window-tool-bar-string'.")
+
+;;;###autoload
+(defun window-tool-bar-string ()
+ "Return a (propertized) string for the tool bar.
+
+This is for when you want more customizations than
+`window-tool-bar-mode' provides. Commonly added to the variable
+`tab-line-format', `header-line-format', or `mode-line-format'"
+ (if (or (null window-tool-bar-string--cache)
+ (window-tool-bar--last-command-triggers-refresh-p))
+ (let* ((mem0 (memory-use-counts))
+ (toolbar-menu (window-tool-bar--get-keymap))
+ (mem1 (memory-use-counts))
+ (result (mapconcat #'window-tool-bar--keymap-entry-to-string
+ (cdr toolbar-menu) ;Skip 'keymap
+ ;; Without spaces between the text, hovering
+ ;; highlights all adjacent buttons.
+ (if (window-tool-bar--use-images)
+ (propertize " " 'invisible t)
+ " ")))
+ (mem2 (memory-use-counts)))
+ (cl-mapl (lambda (l-init l0 l1)
+ (cl-incf (car l-init) (- (car l1) (car l0))))
+ window-tool-bar--memory-use-delta-step1 mem0 mem1)
+ (cl-mapl (lambda (l-init l1 l2)
+ (cl-incf (car l-init) (- (car l2) (car l1))))
+ window-tool-bar--memory-use-delta-step2 mem1 mem2)
+
+ (setf window-tool-bar-string--cache
+ (concat
+ ;; The tool bar face by default puts boxes around the
+ ;; buttons. However, this box is not displayed if the
+ ;; box starts at the leftmost pixel of the tab-line.
+ ;; Add a single space in this case so the box displays
+ ;; correctly.
+ (and (display-supports-face-attributes-p
+ '(:box (line-width 1)))
+ (propertize " " 'display '(space :width (1))))
+ result))
+ (cl-incf window-tool-bar--refresh-done-count))
+ (cl-incf window-tool-bar--refresh-skipped-count))
+
+ window-tool-bar-string--cache)
+
+(defconst window-tool-bar--graphical-separator
+ (concat
+ (propertize " " 'display '(space :width (4)))
+ (propertize " " 'display '(space :width (1) face (:inverse-video t)))
+ (propertize " " 'display '(space :width (4)))))
+
+(defun window-tool-bar--keymap-entry-to-string (menu-item)
+ "Convert MENU-ITEM into a (propertized) string representation.
+
+MENU-ITEM is a menu item to convert. See info node (elisp)Tool Bar."
+ (pcase-exhaustive menu-item
+ ;; Separators
+ ((or `(,_ "--")
+ `(,_ menu-item ,(and (pred stringp)
+ (pred (string-prefix-p "--")))))
+ (if (window-tool-bar--use-images)
+ window-tool-bar--graphical-separator
+ "|"))
+
+ ;; Menu item, turn into propertized string button
+ (`(,key menu-item ,name-expr ,binding . ,plist)
+ (when binding ; If no binding exists, then button is hidden.
+ (let* ((name (eval name-expr))
+ (str (upcase-initials (or (plist-get plist :label)
+ (string-trim-right name "\\.+"))))
+ (len (length str))
+ (enable-form (plist-get plist :enable))
+ (enabled (or (not enable-form)
+ (eval enable-form))))
+ (if enabled
+ (add-text-properties 0 len
+ '(mouse-face window-tool-bar-button-hover
+ keymap window-tool-bar--button-keymap
+ face window-tool-bar-button)
+ str)
+ (put-text-property 0 len
+ 'face
+ 'window-tool-bar-button-disabled
+ str))
+ (when-let ((spec (and (window-tool-bar--use-images)
+ (plist-get menu-item :image))))
+ (put-text-property 0 len
+ 'display
+ (append spec
+ (if enabled '(:margin 2 :ascent center)
+ '(:margin 2 :ascent center
+ :conversion disabled)))
+ str))
+ (put-text-property 0 len
+ 'help-echo
+ (or (plist-get plist :help) name)
+ str)
+ (put-text-property 0 len 'tool-bar-key key str)
+ str)))))
+
+(defun window-tool-bar--call-button ()
+ "Call the button that was clicked on in the tab line."
+ (interactive)
+ (when (mouse-event-p last-command-event)
+ (let ((posn (event-start last-command-event)))
+ ;; Commands need to execute with the right buffer and window
+ ;; selected. The selection needs to be permanent for isearch.
+ (select-window (posn-window posn))
+ (let* ((str (posn-string posn))
+ (key (get-text-property (cdr str) 'tool-bar-key (car str)))
+ (cmd (lookup-key (window-tool-bar--get-keymap) (vector key))))
+ (call-interactively cmd)))))
+
+(defun window-tool-bar--ignore ()
+ "Internal command so isearch does not exit on button-down events."
+ (interactive)
+ nil)
+
+(defvar window-tool-bar--ignored-event-types
+ (let ((list (list 'mouse-movement 'pinch
+ 'wheel-down 'wheel-up 'wheel-left 'wheel-right
+ mouse-wheel-down-event mouse-wheel-up-event
+ mouse-wheel-left-event mouse-wheel-right-event
+ (bound-and-true-p mouse-wheel-down-alternate-event)
+ (bound-and-true-p mouse-wheel-up-alternate-event)
+ (bound-and-true-p mouse-wheel-left-alternate-event)
+ (bound-and-true-p mouse-wheel-right-alternate-event))))
+ (delete-dups (delete nil list)))
+ "Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
+
+(defun window-tool-bar--last-command-triggers-refresh-p ()
+ "Test if the recent command or event should trigger a tool bar refresh."
+ (let ((type (event-basic-type last-command-event)))
+ (and
+ ;; Assume that key presses and button presses are the only user
+ ;; interactions that can alter the tool bar. Specifically, this
+ ;; excludes mouse movement, mouse wheel scroll, and pinch.
+ (not (member type window-tool-bar--ignored-event-types))
+ ;; Assume that any command that triggers shift select can't alter
+ ;; the tool bar. This excludes pure navigation commands.
+ (not (window-tool-bar--command-triggers-shift-select-p last-command))
+ ;; Assume that self-insert-command won't alter the tool bar.
+ ;; This is the most commonly executed command.
+ (not (eq last-command 'self-insert-command)))))
+
+(defun window-tool-bar--command-triggers-shift-select-p (command)
+ "Test if COMMAND would trigger shift select."
+ (let* ((form (interactive-form command))
+ (spec (car-safe (cdr-safe form))))
+ (and (eq (car-safe form) 'interactive)
+ (stringp spec)
+ (seq-position spec ?^))))
+
+;;;###autoload
+(define-minor-mode window-tool-bar-mode
+ "Toggle display of the tool bar in the tab line of the current buffer."
+ :global nil
+ (let ((should-display (and window-tool-bar-mode
+ (not (eq tool-bar-map
+ (default-value 'tool-bar-map)))))
+ (default-value '(:eval (window-tool-bar-string))))
+
+ ;; Preserve existing tab-line set outside of this mode
+ (if (or (null tab-line-format)
+ (equal tab-line-format default-value))
+ (if should-display
+ (setq tab-line-format default-value)
+ (setq tab-line-format nil))
+ (message
+ "tab-line-format set outside of window-tool-bar-mode, currently `%S'"
+ tab-line-format))))
+
+;;;###autoload
+(define-globalized-minor-mode global-window-tool-bar-mode
+ window-tool-bar-mode window-tool-bar--turn-on
+ :group 'window-tool-bar
+ (add-hook 'isearch-mode-hook #'window-tool-bar--turn-on)
+ (add-hook 'isearch-mode-end-hook #'window-tool-bar--turn-on))
+
+(defvar window-tool-bar--allow-images t
+ "Internal debug flag to force text mode.")
+
+(defun window-tool-bar--use-images ()
+ "Internal function.
+Respects `window-tool-bar--allow-images' as well as frame
+capabilities."
+ (and window-tool-bar--allow-images
+ (display-images-p)))
+\f
+;;; Display styling:
+(defface window-tool-bar-button
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88) (supports :box t))
+ :box (:line-width -1 :style released-button)
+ :background "grey85")
+ ;; If the box is not supported, dim the button background a bit.
+ (((class color) (min-colors 88))
+ :background "grey70")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is not hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-hover
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey95")
+ (t
+ :inverse-video t))
+ "Face used for buttons when the mouse is hovering over the button."
+ :group 'window-tool-bar)
+
+(defface window-tool-bar-button-disabled
+ '((default
+ :inherit tab-line)
+ (((class color) (min-colors 88))
+ :box (:line-width -1 :style released-button)
+ :background "grey50"
+ :foreground "grey70")
+ (t
+ :inverse-video t
+ :background "brightblack"))
+ "Face used for buttons when the button is disabled."
+ :group 'window-tool-bar)
+\f
+;;; Workaround for https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68334.
+(defun window-tool-bar--get-keymap ()
+ "Return the tool bar keymap."
+ (let ((tool-bar-always-show-default nil))
+ (if (and (version< emacs-version "30")
+ (not (window-tool-bar--use-images)))
+ ;; This code path is a less efficient workaround.
+ (window-tool-bar--make-keymap-1)
+ (keymap-global-lookup "<tool-bar>"))))
+
+(declare-function image-mask-p "image.c" (spec &optional frame))
+
+(defun window-tool-bar--make-keymap-1 ()
+ "Patched copy of `tool-bar-make-keymap-1'."
+ (mapcar (lambda (bind)
+ (let (image-exp plist)
+ (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
+ ;; For the format of menu-items, see node
+ ;; `Extended Menu Items' in the Elisp manual.
+ (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (setq image-exp (plist-get plist :image))
+ (consp image-exp)
+ (not (eq (car image-exp) 'image))
+ (fboundp (car image-exp)))
+ (let ((image (and (display-images-p)
+ (eval image-exp))))
+ (unless (and image (image-mask-p image))
+ (setq image (append image '(:mask heuristic))))
+ (setq bind (copy-sequence bind)
+ plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (plist-put plist :image image)))
+ bind))
+ tool-bar-map))
+
+(defun window-tool-bar--turn-on ()
+ "Internal function called by `global-window-tool-bar-mode'."
+ (when global-window-tool-bar-mode
+ (window-tool-bar-mode 1)))
+
+(provide 'window-tool-bar)
+
+;;; window-tool-bar.el ends here
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-14 6:01 ` Juri Linkov
2024-05-18 9:50 ` Eli Zaretskii
2024-05-20 17:14 ` Juri Linkov
2024-05-18 9:45 ` Eli Zaretskii
2024-05-18 9:48 ` Eli Zaretskii
2 siblings, 2 replies; 45+ messages in thread
From: Juri Linkov @ 2024-05-14 6:01 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, Eli Zaretskii, 68765, monnier
>>> Does this sound like a good plan?
>> Thanks, looks like a good thing to do.
>
> Thank you! Final version of all three commits attached. These address all
> comments raised on this thread.
>
> I think after these patches are applied, the remaining work to resolve this
> would be having the ELPA package added and me updating NEWS and the manual.
> I can start on the updates.
Thanks, the changes in tab-line.el look nice.
I hope your other patches for tool-bar.el and window-tool-bar.el
will get the green light as well.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-14 6:01 ` Juri Linkov
@ 2024-05-18 9:45 ` Eli Zaretskii
2024-05-18 9:48 ` Eli Zaretskii
2 siblings, 0 replies; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-18 9:45 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Mon, 13 May 2024 21:14:16 -0700
> From: Jared Finder <jared@finder.org>
> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> > Thanks, looks like a good thing to do.
>
> Thank you! Final version of all three commits attached. These address
> all comments raised on this thread.
>
> I think after these patches are applied, the remaining work to resolve
> this would be having the ELPA package added and me updating NEWS and the
> manual. I can start on the updates.
Fine by me, please go ahead.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-14 6:01 ` Juri Linkov
2024-05-18 9:45 ` Eli Zaretskii
@ 2024-05-18 9:48 ` Eli Zaretskii
2024-05-19 3:58 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-18 9:48 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Mon, 13 May 2024 21:14:16 -0700
> From: Jared Finder <jared@finder.org>
> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> > Thanks, looks like a good thing to do.
>
> Thank you! Final version of all three commits attached. These address
> all comments raised on this thread.
>
> I think after these patches are applied, the remaining work to resolve
> this would be having the ELPA package added and me updating NEWS and the
> manual. I can start on the updates.
I installed the patches on the master branch.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-14 6:01 ` Juri Linkov
@ 2024-05-18 9:50 ` Eli Zaretskii
2024-05-19 3:55 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-20 17:14 ` Juri Linkov
1 sibling, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-18 9:50 UTC (permalink / raw)
To: jared, Juri Linkov; +Cc: philipk, 68765, monnier
> From: Juri Linkov <juri@linkov.net>
> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org,
> philipk@posteo.net, monnier@iro.umontreal.ca
> Date: Tue, 14 May 2024 09:01:17 +0300
>
> >>> Does this sound like a good plan?
> >> Thanks, looks like a good thing to do.
> >
> > Thank you! Final version of all three commits attached. These address all
> > comments raised on this thread.
> >
> > I think after these patches are applied, the remaining work to resolve this
> > would be having the ELPA package added and me updating NEWS and the manual.
> > I can start on the updates.
>
> Thanks, the changes in tab-line.el look nice.
>
> I hope your other patches for tool-bar.el and window-tool-bar.el
> will get the green light as well.
Byte-compiling emits some warnings:
In toplevel form:
window-tool-bar.el:341:21: Warning: `mouse-wheel-down-event' is an obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
window-tool-bar.el:341:44: Warning: `mouse-wheel-up-event' is an obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
window-tool-bar.el:342:21: Warning: `mouse-wheel-left-event' is an obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
window-tool-bar.el:342:44: Warning: `mouse-wheel-right-event' is an obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
Jared, could you please take care of these?
Thanks.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-18 9:50 ` Eli Zaretskii
@ 2024-05-19 3:55 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 6:43 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-19 3:55 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, Juri Linkov
[-- Attachment #1: Type: text/plain, Size: 785 bytes --]
On 2024-05-18 02:50, Eli Zaretskii wrote:
>
> Byte-compiling emits some warnings:
>
> In toplevel form:
> window-tool-bar.el:341:21: Warning: `mouse-wheel-down-event' is an
> obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> window-tool-bar.el:341:44: Warning: `mouse-wheel-up-event' is an
> obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> window-tool-bar.el:342:21: Warning: `mouse-wheel-left-event' is an
> obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> window-tool-bar.el:342:44: Warning: `mouse-wheel-right-event' is an
> obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
>
> Jared, could you please take care of these?
>
> Thanks.
The attached patch fixes those warnings.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-byte-compiler-warnings.patch --]
[-- Type: text/x-diff; name=0001-Fix-byte-compiler-warnings.patch, Size: 2386 bytes --]
From f8b0f612fbb5ffbf7a8ff29f2b252203ff83dcda Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Sat, 18 May 2024 20:51:09 -0700
Subject: [PATCH] Fix byte compiler warnings
* lisp/window-tool-bar.el (window-tool-bar--static-if)
(window-tool-bar--ignored-event-types): Avoid byte compiler
seeing variables obsolete in Emacs 30 and up.
---
lisp/window-tool-bar.el | 25 ++++++++++++++++++++++---
1 file changed, 22 insertions(+), 3 deletions(-)
diff --git a/lisp/window-tool-bar.el b/lisp/window-tool-bar.el
index 640deccdd61..395aa3aa9cc 100644
--- a/lisp/window-tool-bar.el
+++ b/lisp/window-tool-bar.el
@@ -335,15 +335,34 @@ window-tool-bar--ignore
(interactive)
nil)
+;; static-if was added in Emacs 30, but this packages supports earlier
+;; versions.
+(defmacro window-tool-bar--static-if (condition then-form &rest else-forms)
+ "A conditional compilation macro.
+Evaluate CONDITION at macro-expansion time. If it is non-nil,
+expand the macro to THEN-FORM. Otherwise expand it to ELSE-FORMS
+enclosed in a `progn' form. ELSE-FORMS may be empty."
+ (declare (indent 2)
+ (debug (sexp sexp &rest sexp)))
+ (if (eval condition lexical-binding)
+ then-form
+ (cons 'progn else-forms)))
+
(defvar window-tool-bar--ignored-event-types
- (let ((list (list 'mouse-movement 'pinch
- 'wheel-down 'wheel-up 'wheel-left 'wheel-right
+ (let ((list (append
+ '(mouse-movement pinch
+ wheel-down wheel-up wheel-left wheel-right)
+ ;; Prior to emacs 30, wheel events could also surface as
+ ;; mouse-<NUM> buttons.
+ (window-tool-bar--static-if (version< emacs-version "30")
+ (list
mouse-wheel-down-event mouse-wheel-up-event
mouse-wheel-left-event mouse-wheel-right-event
(bound-and-true-p mouse-wheel-down-alternate-event)
(bound-and-true-p mouse-wheel-up-alternate-event)
(bound-and-true-p mouse-wheel-left-alternate-event)
- (bound-and-true-p mouse-wheel-right-alternate-event))))
+ (bound-and-true-p mouse-wheel-right-alternate-event))
+ nil))))
(delete-dups (delete nil list)))
"Cache for `window-tool-bar--last-command-triggers-refresh-p'.")
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-18 9:48 ` Eli Zaretskii
@ 2024-05-19 3:58 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 6:48 ` Eli Zaretskii
2024-05-19 14:41 ` Philip Kaludercic
0 siblings, 2 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-19 3:58 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, juri
On 2024-05-18 02:48, Eli Zaretskii wrote:
>> Date: Mon, 13 May 2024 21:14:16 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org,
>> philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> > Thanks, looks like a good thing to do.
>>
>> Thank you! Final version of all three commits attached. These
>> address
>> all comments raised on this thread.
>>
>> I think after these patches are applied, the remaining work to resolve
>> this would be having the ELPA package added and me updating NEWS and
>> the
>> manual. I can start on the updates.
>
> I installed the patches on the master branch.
Thank you!
Is there anything else that needs to be done to get this package on
ELPA? I'd like to use this package on older Emacsen as well.
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-19 3:55 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-19 6:43 ` Eli Zaretskii
0 siblings, 0 replies; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-19 6:43 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Sat, 18 May 2024 20:55:38 -0700
> From: Jared Finder <jared@finder.org>
> Cc: Juri Linkov <juri@linkov.net>, 68765@debbugs.gnu.org,
> philipk@posteo.net, monnier@iro.umontreal.ca
>
> On 2024-05-18 02:50, Eli Zaretskii wrote:
> >
> > Byte-compiling emits some warnings:
> >
> > In toplevel form:
> > window-tool-bar.el:341:21: Warning: `mouse-wheel-down-event' is an
> > obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> > window-tool-bar.el:341:44: Warning: `mouse-wheel-up-event' is an
> > obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> > window-tool-bar.el:342:21: Warning: `mouse-wheel-left-event' is an
> > obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> > window-tool-bar.el:342:44: Warning: `mouse-wheel-right-event' is an
> > obsolete variable (as of 30.1); use `mouse-wheel-buttons' instead.
> >
> > Jared, could you please take care of these?
> >
> > Thanks.
>
> The attached patch fixes those warnings.
Thanks, installed.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-19 3:58 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-19 6:48 ` Eli Zaretskii
2024-05-23 4:19 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 14:41 ` Philip Kaludercic
1 sibling, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-19 6:48 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Sat, 18 May 2024 20:58:05 -0700
> From: Jared Finder <jared@finder.org>
> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> On 2024-05-18 02:48, Eli Zaretskii wrote:
> >> I think after these patches are applied, the remaining work to resolve
> >> this would be having the ELPA package added and me updating NEWS and
> >> the
> >> manual. I can start on the updates.
> >
> > I installed the patches on the master branch.
>
> Thank you!
>
> Is there anything else that needs to be done to get this package on
> ELPA? I'd like to use this package on older Emacsen as well.
Philip will tell, but what I meant was to ask you to work on updates
for NEWS and the manual.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-19 3:58 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 6:48 ` Eli Zaretskii
@ 2024-05-19 14:41 ` Philip Kaludercic
2024-05-20 3:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 1 reply; 45+ messages in thread
From: Philip Kaludercic @ 2024-05-19 14:41 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765, monnier, juri
[-- Attachment #1: Type: text/plain, Size: 970 bytes --]
Jared Finder <jared@finder.org> writes:
> On 2024-05-18 02:48, Eli Zaretskii wrote:
>>> Date: Mon, 13 May 2024 21:14:16 -0700
>>> From: Jared Finder <jared@finder.org>
>>> Cc: Eli Zaretskii <eliz@gnu.org>, 68765@debbugs.gnu.org,
>>> philipk@posteo.net,
>>> monnier@iro.umontreal.ca
>>> > Thanks, looks like a good thing to do.
>>> Thank you! Final version of all three commits attached. These
>>> address
>>> all comments raised on this thread.
>>> I think after these patches are applied, the remaining work to
>>> resolve
>>> this would be having the ELPA package added and me updating NEWS
>>> and the
>>> manual. I can start on the updates.
>> I installed the patches on the master branch.
>
> Thank you!
>
> Is there anything else that needs to be done to get this package on
> ELPA? I'd like to use this package on older Emacsen as well.
It just has to be added to ELPA, but that is a one-line patch to
elpa.git. Here is the tarball I generated locally:
[-- Attachment #2: window-tool-bar.tar --]
[-- Type: application/x-tar, Size: 30720 bytes --]
[-- Attachment #3: Type: text/plain, Size: 1021 bytes --]
Can you confirm that it looks alright and works on older systems (use
M-x package-install-file)?
> -- MJF
>
Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Sat, 18 May 2024 20:58:05 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> On 2024-05-18 02:48, Eli Zaretskii wrote:
>> >> I think after these patches are applied, the remaining work to resolve
>> >> this would be having the ELPA package added and me updating NEWS and
>> >> the
>> >> manual. I can start on the updates.
>> >
>> > I installed the patches on the master branch.
>>
>> Thank you!
>>
>> Is there anything else that needs to be done to get this package on
>> ELPA? I'd like to use this package on older Emacsen as well.
>
> Philip will tell, but what I meant was to ask you to work on updates
> for NEWS and the manual.
Where will the package be documented? Should anything be added to the
ELPA package?
--
Philip Kaludercic on icterid
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-19 14:41 ` Philip Kaludercic
@ 2024-05-20 3:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-20 6:39 ` Philip Kaludercic
2024-05-20 9:19 ` Philip Kaludercic
0 siblings, 2 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-20 3:25 UTC (permalink / raw)
To: Philip Kaludercic; +Cc: Eli Zaretskii, 68765, monnier, juri
On 2024-05-19 07:41, Philip Kaludercic wrote:
> Jared Finder <jared@finder.org> writes:
>>
>> Is there anything else that needs to be done to get this package on
>> ELPA? I'd like to use this package on older Emacsen as well.
>
> It just has to be added to ELPA, but that is a one-line patch to
> elpa.git. Here is the tarball I generated locally:
>
>
>
> Can you confirm that it looks alright and works on older systems (use
> M-x package-install-file)?
Confirmed, just tested it! It worked fine on Emacs 29.1 the package's
minimum supported version.
>>>
>>> Is there anything else that needs to be done to get this package on
>>> ELPA? I'd like to use this package on older Emacsen as well.
>>
>> Philip will tell, but what I meant was to ask you to work on updates
>> for NEWS and the manual.
>
> Where will the package be documented? Should anything be added to the
> ELPA package?
I was hoping documentation could just stay in the core Emacs manual.
window-tool-bar is a core package and I was hoping to document it next
to existing documentation on the existing (frame) tool bar. Does that
seem reasonable?
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-20 3:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-20 6:39 ` Philip Kaludercic
2024-05-20 9:19 ` Philip Kaludercic
1 sibling, 0 replies; 45+ messages in thread
From: Philip Kaludercic @ 2024-05-20 6:39 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765, monnier, juri
Jared Finder <jared@finder.org> writes:
> On 2024-05-19 07:41, Philip Kaludercic wrote:
>> Jared Finder <jared@finder.org> writes:
>>> Is there anything else that needs to be done to get this package on
>>> ELPA? I'd like to use this package on older Emacsen as well.
>> It just has to be added to ELPA, but that is a one-line patch to
>> elpa.git. Here is the tarball I generated locally:
>> Can you confirm that it looks alright and works on older systems
>> (use
>> M-x package-install-file)?
>
> Confirmed, just tested it! It worked fine on Emacs 29.1 the package's
> minimum supported version.
1+
>>>> Is there anything else that needs to be done to get this package
>>>> on
>>>> ELPA? I'd like to use this package on older Emacsen as well.
>>> Philip will tell, but what I meant was to ask you to work on
>>> updates
>>> for NEWS and the manual.
>> Where will the package be documented? Should anything be added to
>> the
>> ELPA package?
>
> I was hoping documentation could just stay in the core Emacs manual.
> window-tool-bar is a core package and I was hoping to document it next
> to existing documentation on the existing (frame) tool bar. Does that
> seem reasonable?
Sure, in that case the core should just link to the specific Info node.
As soon as the manual is updated on the gnu.org website I'd also add a
HTTP link for people previewing the package to be able to see as well.
Otherwise, I'll add the package to ELPA now, and I hope it will appear
on the site in a few hours.
> -- MJF
>
--
Philip Kaludercic on peregrine
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-20 3:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-20 6:39 ` Philip Kaludercic
@ 2024-05-20 9:19 ` Philip Kaludercic
2024-05-21 4:18 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 1 reply; 45+ messages in thread
From: Philip Kaludercic @ 2024-05-20 9:19 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765, monnier, juri
Jared Finder <jared@finder.org> writes:
> On 2024-05-19 07:41, Philip Kaludercic wrote:
>> Jared Finder <jared@finder.org> writes:
>>> Is there anything else that needs to be done to get this package on
>>> ELPA? I'd like to use this package on older Emacsen as well.
>> It just has to be added to ELPA, but that is a one-line patch to
>> elpa.git. Here is the tarball I generated locally:
>> Can you confirm that it looks alright and works on older systems
>> (use
>> M-x package-install-file)?
>
> Confirmed, just tested it! It worked fine on Emacs 29.1 the package's
> minimum supported version.
Regarding that point, I didn't follow the thread in detail, but why is
29.1 the minimum version? package-lint indicates that it should be
compatible with 27.1, but it might be missing something.
--
Philip Kaludercic on peregrine
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-14 6:01 ` Juri Linkov
2024-05-18 9:50 ` Eli Zaretskii
@ 2024-05-20 17:14 ` Juri Linkov
2024-05-21 2:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 1 reply; 45+ messages in thread
From: Juri Linkov @ 2024-05-20 17:14 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, Eli Zaretskii, monnier, 68765
>> I think after these patches are applied, the remaining work to resolve this
>> would be having the ELPA package added and me updating NEWS and the manual.
>> I can start on the updates.
>
> Thanks, the changes in tab-line.el look nice.
Oh, for some reason now a lot of messages are displayed while restoring
the desktop where tab-line-mode is saved for every buffer:
tab-line-format set outside of tab-line-mode, currently ‘(:eval (tab-line-format))’
...
tab-line-format set outside of tab-line-mode, currently ‘(:eval (tab-line-format))’ [2 times]
...
tab-line-format set outside of tab-line-mode, currently ‘(:eval (tab-line-format))’
...
tab-line-format set outside of tab-line-mode, currently ‘(:eval (tab-line-format))’ [8 times]
...
tab-line-format set outside of tab-line-mode, currently ‘(:eval (tab-line-format))’ [35 times]
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-20 17:14 ` Juri Linkov
@ 2024-05-21 2:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-21 6:12 ` Juri Linkov
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-21 2:25 UTC (permalink / raw)
To: Juri Linkov; +Cc: philipk, Eli Zaretskii, monnier, 68765
[-- Attachment #1: Type: text/plain, Size: 1000 bytes --]
On 2024-05-20 10:14, Juri Linkov wrote:
>>> I think after these patches are applied, the remaining work to
>>> resolve this
>>> would be having the ELPA package added and me updating NEWS and the
>>> manual.
>>> I can start on the updates.
>>
>> Thanks, the changes in tab-line.el look nice.
>
> Oh, for some reason now a lot of messages are displayed while restoring
> the desktop where tab-line-mode is saved for every buffer:
>
> tab-line-format set outside of tab-line-mode, currently ‘(:eval
> (tab-line-format))’
> ...
> tab-line-format set outside of tab-line-mode, currently ‘(:eval
> (tab-line-format))’ [2 times]
> ...
> tab-line-format set outside of tab-line-mode, currently ‘(:eval
> (tab-line-format))’
> ...
> tab-line-format set outside of tab-line-mode, currently ‘(:eval
> (tab-line-format))’ [8 times]
> ...
> tab-line-format set outside of tab-line-mode, currently ‘(:eval
> (tab-line-format))’ [35 times]
Sorry about that. Fix attached.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Do-not-message-for-repeated-enable-disable-of-mode.patch --]
[-- Type: text/x-diff; name=0001-Do-not-message-for-repeated-enable-disable-of-mode.patch, Size: 1833 bytes --]
From 7b1638f27b130ed7088a7e6dee9e67396bab84b7 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Mon, 20 May 2024 19:21:29 -0700
Subject: [PATCH] Do not message for repeated enable/disable of mode
tab-line-mode should not inform the user of an unexpected change
when enabling the mode if already enabled. For example, when
running (tab-line-mode 1) repeatedly.
* lisp/tab-line.el (tab-line-mode): Modify case when user is
informed.
---
lisp/tab-line.el | 19 +++++++------------
1 file changed, 7 insertions(+), 12 deletions(-)
diff --git a/lisp/tab-line.el b/lisp/tab-line.el
index 316c87fb3ad..fa52ccd81aa 100644
--- a/lisp/tab-line.el
+++ b/lisp/tab-line.el
@@ -1122,19 +1122,14 @@ tab-line-mode
"Toggle display of tab line in the windows displaying the current buffer."
:lighter nil
(let ((default-value '(:eval (tab-line-format))))
- (if tab-line-mode
- ;; Preserve the existing tab-line set outside of this mode
- (if (null tab-line-format)
+ ;; Preserve the existing tab-line set outside of this mode
+ (if (or (null tab-line-format)
+ (equal tab-line-format default-value))
+ (if tab-line-mode
(setq tab-line-format default-value)
- (message
- "tab-line-format set outside of tab-line-mode, currently `%S'"
- tab-line-format))
- ;; Reset only values set by this mode
- (if (equal tab-line-format default-value)
- (setq tab-line-format nil)
- (message
- "tab-line-format set outside of tab-line-mode, currently `%S'"
- tab-line-format)))))
+ (setq tab-line-format nil))
+ (message "tab-line-format set outside of tab-line-mode, currently `%S'"
+ tab-line-format))))
(defcustom tab-line-exclude-modes
'(completion-list-mode)
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-20 9:19 ` Philip Kaludercic
@ 2024-05-21 4:18 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-21 13:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-22 16:16 ` Philip Kaludercic
0 siblings, 2 replies; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-21 4:18 UTC (permalink / raw)
To: Philip Kaludercic; +Cc: Eli Zaretskii, 68765, monnier, juri
On 2024-05-20 02:19, Philip Kaludercic wrote:
> Jared Finder <jared@finder.org> writes:
>> On 2024-05-19 07:41, Philip Kaludercic wrote:
>>> Jared Finder <jared@finder.org> writes:
>>>> Is there anything else that needs to be done to get this package on
>>>> ELPA? I'd like to use this package on older Emacsen as well.
>>> It just has to be added to ELPA, but that is a one-line patch to
>>> elpa.git. Here is the tarball I generated locally:
>>> Can you confirm that it looks alright and works on older systems
>>> (use
>>> M-x package-install-file)?
>>
>> Confirmed, just tested it! It worked fine on Emacs 29.1 the package's
>> minimum supported version.
>
> Regarding that point, I didn't follow the thread in detail, but why is
> 29.1 the minimum version? package-lint indicates that it should be
> compatible with 27.1, but it might be missing something.
Only because that was the version I used regularly when I started
writing this. I plan to extend support to earlier Emacs versions in a
future version of this package. I'm just waiting on squaring away this
first step before working on any updates. :)
On 2024-05-19 23:39, Philip Kaludercic wrote:
> Jared Finder <jared@finder.org> writes:
>> On 2024-05-19 07:41, Philip Kaludercic wrote:
>>> Where will the package be documented? Should anything be added to
>>> the
>>> ELPA package?
>>
>> I was hoping documentation could just stay in the core Emacs manual.
>> window-tool-bar is a core package and I was hoping to document it next
>> to existing documentation on the existing (frame) tool bar. Does that
>> seem reasonable?
>
> Sure, in that case the core should just link to the specific Info node.
> As soon as the manual is updated on the gnu.org website I'd also add a
> HTTP link for people previewing the package to be able to see as well.
I'm not quite sure what change you're looking for here. Let's assume
I've added an info node "(emacs)Window Tool Bar" that is also a function
index for global-window-tool-bar-mode, where do you think I should
mention this link?
> Otherwise, I'll add the package to ELPA now, and I hope it will appear
> on the site in a few hours.
Yup, I see it! Thanks!
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-21 2:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-21 6:12 ` Juri Linkov
0 siblings, 0 replies; 45+ messages in thread
From: Juri Linkov @ 2024-05-21 6:12 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, Eli Zaretskii, monnier, 68765
>> tab-line-format set outside of tab-line-mode, currently ‘(:eval
>> (tab-line-format))’ [35 times]
>
> Sorry about that. Fix attached.
Thanks, I confirm that the problem is fixed completely,
so your patch is pushed now.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-21 4:18 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-21 13:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-22 16:16 ` Philip Kaludercic
1 sibling, 0 replies; 45+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-21 13:40 UTC (permalink / raw)
To: Jared Finder; +Cc: Philip Kaludercic, 68765, Eli Zaretskii, juri
>> Regarding that point, I didn't follow the thread in detail, but why is
>> 29.1 the minimum version? package-lint indicates that it should be
>> compatible with 27.1, but it might be missing something.
> Only because that was the version I used regularly when I started writing
> this. I plan to extend support to earlier Emacs versions in a future
> version of this package. I'm just waiting on squaring away this first step
> before working on any updates. :)
I think `Package-Requires:` and other such version dependencies should
state "I know it won't work" or "I have no intention to fix bugs" for
versions that do not satisfy the dependencies.
Not "I currently don't know if it works or not".
You can separately state which version(s) you recommend and/or have tested.
Stefan
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-21 4:18 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-21 13:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-22 16:16 ` Philip Kaludercic
1 sibling, 0 replies; 45+ messages in thread
From: Philip Kaludercic @ 2024-05-22 16:16 UTC (permalink / raw)
To: Jared Finder; +Cc: Eli Zaretskii, 68765, monnier, juri
Jared Finder <jared@finder.org> writes:
> On 2024-05-20 02:19, Philip Kaludercic wrote:
>> Jared Finder <jared@finder.org> writes:
>>> On 2024-05-19 07:41, Philip Kaludercic wrote:
>>>> Jared Finder <jared@finder.org> writes:
>>>>> Is there anything else that needs to be done to get this package on
>>>>> ELPA? I'd like to use this package on older Emacsen as well.
>>>> It just has to be added to ELPA, but that is a one-line patch to
>>>> elpa.git. Here is the tarball I generated locally:
>>>> Can you confirm that it looks alright and works on older systems
>>>> (use
>>>> M-x package-install-file)?
>>> Confirmed, just tested it! It worked fine on Emacs 29.1 the
>>> package's
>>> minimum supported version.
>> Regarding that point, I didn't follow the thread in detail, but why
>> is
>> 29.1 the minimum version? package-lint indicates that it should be
>> compatible with 27.1, but it might be missing something.
>
> Only because that was the version I used regularly when I started
> writing this. I plan to extend support to earlier Emacs versions in a
> future version of this package. I'm just waiting on squaring away
> this first step before working on any updates. :)
If you need some special new functionality, you can make use of the
Compat package, which as of Emacs 30 has a bundled shim making it easier
to use it in core packages.
> On 2024-05-19 23:39, Philip Kaludercic wrote:
>> Jared Finder <jared@finder.org> writes:
>>> On 2024-05-19 07:41, Philip Kaludercic wrote:
>>>> Where will the package be documented? Should anything be added to
>>>> the
>>>> ELPA package?
>>> I was hoping documentation could just stay in the core Emacs
>>> manual.
>>> window-tool-bar is a core package and I was hoping to document it next
>>> to existing documentation on the existing (frame) tool bar. Does that
>>> seem reasonable?
>> Sure, in that case the core should just link to the specific Info
>> node.
>> As soon as the manual is updated on the gnu.org website I'd also add a
>> HTTP link for people previewing the package to be able to see as well.
>
> I'm not quite sure what change you're looking for here. Let's assume
> I've added an info node "(emacs)Window Tool Bar" that is also a
> function index for global-window-tool-bar-mode, where do you think I
> should mention this link?
In the commentary section of the package.
>> Otherwise, I'll add the package to ELPA now, and I hope it will appear
>> on the site in a few hours.
>
> Yup, I see it! Thanks!
>
> -- MJF
>
--
Philip Kaludercic on peregrine
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-19 6:48 ` Eli Zaretskii
@ 2024-05-23 4:19 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-23 6:52 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-23 4:19 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, juri
[-- Attachment #1: Type: text/plain, Size: 1053 bytes --]
On 2024-05-18 23:48, Eli Zaretskii wrote:
>> Date: Sat, 18 May 2024 20:58:05 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> On 2024-05-18 02:48, Eli Zaretskii wrote:
>> >> I think after these patches are applied, the remaining work to resolve
>> >> this would be having the ELPA package added and me updating NEWS and
>> >> the
>> >> manual. I can start on the updates.
>> >
>> > I installed the patches on the master branch.
>>
>> Thank you!
>>
>> Is there anything else that needs to be done to get this package on
>> ELPA? I'd like to use this package on older Emacsen as well.
>
> Philip will tell, but what I meant was to ask you to work on updates
> for NEWS and the manual.
Patch attached. I'm still not comfortable with all the texinfo
conventions, so please review that I'm using things like @code
correctly.
Also, I couldn't figure out how to get the Top node menus to auto
update, so I just manually put in new nodes.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Adding-documentation-for-window-tool-bar.patch --]
[-- Type: text/x-diff; name=0001-Adding-documentation-for-window-tool-bar.patch, Size: 13078 bytes --]
From c7930bc626e70430f91d3cd6eb2536949d2884a1 Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Mon, 20 May 2024 21:59:14 -0700
Subject: [PATCH] Adding documentation for window-tool-bar
* doc/emacs/emacs.texi (Top):
* doc/emacs/frames.texi (Tool Bars):
* doc/emacs/glossary.texi (Glossary):
* doc/emacs/modes.texi (Minor Modes): Mention Window Tool Bar
and add xref.
* doc/emacs/windows.texi (Windows, Tab Line): New documentation.
* doc/lispref/elisp.texi (Top):
* doc/lispref/modes.texi (Mode Line Format, Mode Line Basics)
(Mode Line Data): Mention Tab Lines and add xref.
(Tab Lines): New documentation.
* etc/NEWS: Mention newly added variable
'tool-bar-always-show-default' and new package 'window-tool-bar'
---
doc/emacs/emacs.texi | 1 +
doc/emacs/frames.texi | 14 +++++++----
doc/emacs/glossary.texi | 10 ++++----
doc/emacs/modes.texi | 4 ++++
doc/emacs/windows.texi | 39 ++++++++++++++++++++++++++++++
doc/lispref/elisp.texi | 1 +
doc/lispref/modes.texi | 53 ++++++++++++++++++++++++++++++-----------
etc/NEWS | 14 +++++++++++
8 files changed, 114 insertions(+), 22 deletions(-)
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi
index 7d77f13ab21..8246041fb95 100644
--- a/doc/emacs/emacs.texi
+++ b/doc/emacs/emacs.texi
@@ -529,6 +529,7 @@ Top
* Temporary Displays:: Displaying non-editable buffers.
* Window Convenience:: Convenience functions for window handling.
* Tab Line:: Window tab line.
+* Window Tool Bar:: A tool bar that is attached to windows.
Displaying a Buffer in a Window
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 6c62fde4ffb..8028a516e66 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1295,16 +1295,22 @@ Menu Bars
@node Tool Bars
@section Tool Bars
@cindex tool bar mode
+@cindex tool bar, attached to frame
@cindex mode, Tool Bar
@cindex icons, toolbar
- On graphical displays, Emacs puts a @dfn{tool bar} at the top of
-each frame, just below the menu bar. This is a row of icons which you
-can click on with the mouse to invoke various commands.
+ On graphical displays, Emacs puts a @dfn{tool bar} at the top of each
+frame, just below the menu bar. This is a row of icons which you can
+click on with the mouse to invoke various commands. Emacs can also
+optionally display a tool bar at the top of each window (@pxref{Window
+Tool Bar}).
+@vindex tool-bar-always-show-default
The global (default) tool bar contains general commands. Some major
modes define their own tool bars; whenever a buffer with such a major
-mode is current, the mode's tool bar replaces the global tool bar.
+mode is current, the mode's tool bar replaces the global tool bar. To
+prevent this replacement from happening, customize the variable
+@code{tool-bar-always-show-default}.
@findex tool-bar-mode
@vindex tool-bar-mode
diff --git a/doc/emacs/glossary.texi b/doc/emacs/glossary.texi
index 344e4831f36..b30e1d789fc 100644
--- a/doc/emacs/glossary.texi
+++ b/doc/emacs/glossary.texi
@@ -1436,10 +1436,12 @@ Glossary
for your favorite set of faces (q.v.).
@item Tool Bar
-The tool bar is a line (sometimes multiple lines) of icons at the top
-of an Emacs frame. Clicking on one of these icons executes a command.
-You can think of this as a graphical relative of the menu bar (q.v.).
-@xref{Tool Bars}.
+The tool bar is a line (sometimes multiple lines) of icons at the top of
+an Emacs frame. Clicking on one of these icons executes a command. You
+can think of this as a graphical relative of the menu bar (q.v.).
+@xref{Tool Bars}. There is also a window tool bar that behaves
+similarly, but is at the top of an Emacs window. @xref{Window Tool
+Bar}.
@anchor{Glossary---Tooltips}
@item Tooltips
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi
index 2776dc72a27..253042b28a3 100644
--- a/doc/emacs/modes.texi
+++ b/doc/emacs/modes.texi
@@ -295,6 +295,10 @@ Minor Modes
but the tool bar is only displayed on graphical terminals. @xref{Tool
Bars}.
+@item
+Window Tool Bar mode gives windows a tool bar when it is different from
+the default tool bar. @xref{Window Tool Bar}.
+
@item
Tab Bar mode gives each frame a tab bar. @xref{Tab Bars}.
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index ad2225b5922..1c0aaeb1c92 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -22,6 +22,7 @@ Windows
* Displaying Buffers:: How Emacs picks a window for displaying a buffer.
* Window Convenience:: Convenience functions for window handling.
* Tab Line:: Window tab line.
+* Window Tool Bar:: A tool bar that is attached to windows.
@end menu
@node Basic Window
@@ -689,3 +690,41 @@ Tab Line
switch between window configurations containing several windows with buffers,
tabs on the Tab Line at the top of each window are used to switch
between buffers in the window.
+
+
+@node Window Tool Bar
+@cindex mode, Window Tool Bar
+@cindex tool bar, attached to window
+
+@findex global-window-tool-bar-mode
+@vindex global-window-tool-bar-mode
+ The command @code{global-window-tool-bar-mode} toggles the display of
+a tool bar at the top of all windows. (You can also customize the
+variable @code{global-window-tool-bar-mode}.) To conserve space, a
+window tool bar is only shown if the tool bar for a buffer is different
+from the global (default) tool bar. The most common way a buffer has a
+different tool bar is due to its major mode, so you can think of the
+window tool bar as showing a major mode's tool bar if it exists.
+
+@findex window-tool-bar-mode
+If you want to toggle the display of a tool bar in just a single window,
+run the command @code{window-tool-bar-mode}. This is also useful to put
+in a hook. For example if you want the window tool bar to appear for
+all buffers that do not represent files and have a custom tool bar, you
+could add the following code to your init file (@pxref{Init File}):
+
+@example
+(add-hook 'special-mode-hook 'window-tool-bar-mode)
+@end example
+
+Emacs can also display a tool bar at the top of frames (@pxref{Tool
+Bars}). When showing a tool bar at the top of frames as well as
+windows, you may want to have the frame tool bar not change based on the
+current buffer's major mode. This can be done by customizing the
+variable @code{tool-bar-always-show-default}.
+
+Note that the window tool bar displays in the same space as the tab
+line, so only one of these can be display at a time unless you customize
+the value of @code{tab-line-format} in Lisp. In this case, add
+@code{(:eval (window-tool-bar-strng))} to @code{tab-line-format}.
+@xref{Mode Line Format,,, elisp, The Emacs Lisp Reference Manual}.
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 339272d1f05..1059d0dcf61 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -925,6 +925,7 @@ Top
* %-Constructs:: Putting information into a mode line.
* Properties in Mode:: Using text properties in the mode line.
* Header Lines:: Like a mode line, but at the top.
+* Tab Lines:: A line that is above the header line.
* Emulating Mode Line:: Formatting text as the mode line would.
Font Lock Mode
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index cf67b319924..6ee1d869fb8 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -2074,14 +2074,14 @@ Mode Line Format
line at the bottom, which displays status information about the buffer
displayed in the window. The mode line contains information about the
buffer, such as its name, associated file, depth of recursive editing,
-and major and minor modes. A window can also have a @dfn{header
-line}, which is much like the mode line but appears at the top of the
-window.
+and major and minor modes. A window can also have a @dfn{header line}
+and a @dfn{tab line}, which are much like the mode line but they appear
+at the top of the window.
- This section describes how to control the contents of the mode line
-and header line. We include it in this chapter because much of the
-information displayed in the mode line relates to the enabled major and
-minor modes.
+ This section describes how to control the contents of the mode line,
+header line, and tab line. We include it in this chapter because much
+of the information displayed in the mode line relates to the enabled
+major and minor modes.
@menu
* Base: Mode Line Basics. Basic ideas of mode line control.
@@ -2091,6 +2091,7 @@ Mode Line Format
* %-Constructs:: Putting information into a mode line.
* Properties in Mode:: Using text properties in the mode line.
* Header Lines:: Like a mode line, but at the top.
+* Tab Lines:: A line that is above the header line.
* Emulating Mode Line:: Formatting text as the mode line would.
@end menu
@@ -2101,11 +2102,13 @@ Mode Line Basics
variable @code{mode-line-format} (@pxref{Mode Line Top}). This variable
holds a @dfn{mode line construct}: a template that controls what is
displayed on the buffer's mode line. The value of
-@code{header-line-format} specifies the buffer's header line in the same
-way. All windows for the same buffer use the same
-@code{mode-line-format} and @code{header-line-format} unless a
-@code{mode-line-format} or @code{header-line-format} parameter has been
-specified for that window (@pxref{Window Parameters}).
+@code{header-line-format} and @code{tab-line-format} specifies the
+buffer's header line and tab line in the same way. All windows for the
+same buffer use the same @code{mode-line-format},
+@code{header-line-format}, and @code{tab-line-format} unless a
+@code{mode-line-format}, @code{header-line-format}, or
+@code{tab-line-format} parameter has been specified for that window
+(@pxref{Window Parameters}).
For efficiency, Emacs does not continuously recompute each window's
mode line and header line. It does so when circumstances appear to call
@@ -2167,8 +2170,8 @@ Mode Line Data
@dfn{mode line construct}, made up of lists, strings, symbols, and
numbers kept in buffer-local variables. Each data type has a specific
meaning for the mode line appearance, as described below. The same data
-structure is used for constructing frame titles (@pxref{Frame Titles})
-and header lines (@pxref{Header Lines}).
+structure is used for constructing frame titles (@pxref{Frame Titles}),
+header lines (@pxref{Header Lines}), and tab lines (@pxref{Tab Lines}).
A mode line construct may be as simple as a fixed string of text,
but it usually specifies how to combine fixed strings with variables'
@@ -2816,6 +2819,28 @@ Header Lines
header line at once; if it has a mode line, then it does not display a
header line.
+@node Tab Lines
+@subsection Window Tab Lines
+@cindex tab line (of a window)
+@cindex window tab line
+
+ A window can have a @dfn{tab line} at the top. If both the tab line
+and header line are visible, the tab line appears above the header line.
+The tab line feature works just like the mode line feature, except that
+it's controlled by @code{tab-line-format}:
+
+@defvar tab-line-format
+This variable, local in every buffer, specifies how to display the tab
+line, for windows displaying the buffer. The format of the value is the
+same as for @code{mode-line-format} (@pxref{Mode Line Data}). It is
+normally @code{nil}, so that ordinary buffers have no tab line.
+@end defvar
+
+@defun window-tab-line-height &optional window
+This function returns the height in pixels of @var{window}'s tab line.
+@var{window} must be a live window, and defaults to the selected window.
+@end defun
+
@node Emulating Mode Line
@subsection Emulating Mode Line Formatting
diff --git a/etc/NEWS b/etc/NEWS
index d72ef5b5bef..7b829f5002c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -240,6 +240,12 @@ window systems other than Nextstep.
When this minor mode is enabled, buttons representing modifier keys
are displayed along the tool bar.
++++
+** New user option 'tool-bar-always-show-default'.
+This can be set so that the tool bar at the top of a frame does not show
+buffer local customization of the tool bar. This is convenient when
+using the newly added 'global-window-tool-bar-mode'.
+
+++
** "d" in the mode line now indicates that the window is dedicated.
Windows have always been able to be dedicated to a specific buffer;
@@ -1877,6 +1883,14 @@ than regular expressions, but less complexity than context-free
grammars. The Info manual "(elisp) Parsing Expression Grammars" has
documentation and examples.
++++
+** New package Window-Tool-Bar.
+This provides a new minor mode, 'window-tool-bar-mode'. When this minor
+mode is enabled, a tool bar is displayed at the top of a window if the
+buffer in the window has a buffer local tool bar, commonly from its
+major mode. The global minor mode 'global-window-tool-bar-mode' enables
+this minor mode in all buffers.
+
\f
* Incompatible Lisp Changes in Emacs 30.1
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-23 4:19 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-23 6:52 ` Eli Zaretskii
2024-05-25 15:49 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-23 6:52 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Wed, 22 May 2024 21:19:05 -0700
> From: Jared Finder <jared@finder.org>
> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> +@node Window Tool Bar
> +@cindex mode, Window Tool Bar
Index entries should preferably use only lower-case letters, to avoid
problems with sorting index entries in different locales.
In addition, I would rephrase the above index entry to say just
@cindex window tool bar
> +@findex global-window-tool-bar-mode
> +@vindex global-window-tool-bar-mode
This will create two identical index entries (since we produce a
single Index from all the index entries). So leave just one of the
two.
> + The command @code{global-window-tool-bar-mode} toggles the display of
> +a tool bar at the top of all windows. (You can also customize the
> +variable @code{global-window-tool-bar-mode}.) To conserve space, a
> +window tool bar is only shown if the tool bar for a buffer is different
> +from the global (default) tool bar. The most common way a buffer has a
> +different tool bar is due to its major mode, so you can think of the
> +window tool bar as showing a major mode's tool bar if it exists.
This paragraph left me puzzled. By default, the frame-global tool bar
follows the major mode of the selected buffer's window. This is not
going to change even under global-window-tool-bar-mode, is it? If so,
when will the window-specific tool bar be displayed -- only in
non-selected windows whose buffers have a major mode different from
that of the selected-window's buffer? If so, this should be
explicitly explained in the manual, I think.
Also, does this mean the window-specific tool bar will appear and
disappear depending on which window is selected? Wouldn't that cause
annoying "flickering" of display?
> +@findex window-tool-bar-mode
> +If you want to toggle the display of a tool bar in just a single window,
> +run the command @code{window-tool-bar-mode}. This is also useful to put
> +in a hook. For example if you want the window tool bar to appear for
> +all buffers that do not represent files and have a custom tool bar, you
> +could add the following code to your init file (@pxref{Init File}):
Are these window tool bars also limited to windows whose buffers'
major mode is different from the selected window? In any case, this
aspect, whether identical to global-window-tool-bar-mode or different
from it, should be explicitly documented.
Last, but not least: please mention the bug number in the commit log
message.
Thanks.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-23 6:52 ` Eli Zaretskii
@ 2024-05-25 15:49 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-25 17:03 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-25 15:49 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, juri
[-- Attachment #1: Type: text/plain, Size: 3628 bytes --]
On 2024-05-22 23:52, Eli Zaretskii wrote:
>> Date: Wed, 22 May 2024 21:19:05 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> +@node Window Tool Bar
>> +@cindex mode, Window Tool Bar
>
> Index entries should preferably use only lower-case letters, to avoid
> problems with sorting index entries in different locales.
>
> In addition, I would rephrase the above index entry to say just
>
> @cindex window tool bar
I don't think that fits in with the existing convention. The convention
appears to be "use mode, Capital Case Name" for specific modes and
"mode, lower case" for concepts. There's 76 other examples of "@cindex
mode," in the Emacs manual already, the majority of which follow that
convention.
The only examples I could find not following the convention are: "mode,
archive", "mode, tar", "mode, display-fill-column-indicator".
>
>> +@findex global-window-tool-bar-mode
>> +@vindex global-window-tool-bar-mode
>
> This will create two identical index entries (since we produce a
> single Index from all the index entries). So leave just one of the
> two.
Makes sense. Will do.
>> + The command @code{global-window-tool-bar-mode} toggles the display
>> of
>> +a tool bar at the top of all windows. (You can also customize the
>> +variable @code{global-window-tool-bar-mode}.) To conserve space, a
>> +window tool bar is only shown if the tool bar for a buffer is
>> different
>> +from the global (default) tool bar. The most common way a buffer has
>> a
>> +different tool bar is due to its major mode, so you can think of the
>> +window tool bar as showing a major mode's tool bar if it exists.
>
> This paragraph left me puzzled. By default, the frame-global tool bar
> follows the major mode of the selected buffer's window. This is not
> going to change even under global-window-tool-bar-mode, is it? If so,
> when will the window-specific tool bar be displayed -- only in
> non-selected windows whose buffers have a major mode different from
> that of the selected-window's buffer? If so, this should be
> explicitly explained in the manual, I think.
>
> Also, does this mean the window-specific tool bar will appear and
> disappear depending on which window is selected? Wouldn't that cause
> annoying "flickering" of display?
I will try to redescribe it. I have a typo in the existing description.
Change "all windows" to "each window". The idea is that each window
gets its own tool bar *inside the window*, specifically on the window's
tab line. Ideally I think I would just show a picture (see attached
image), but I see very few pictures in any of the Emacs manuals and none
of them show up in the HTML output at
https://www.gnu.org/software/emacs/manual/, only in the PDF.
>> +@findex window-tool-bar-mode
>> +If you want to toggle the display of a tool bar in just a single
>> window,
>> +run the command @code{window-tool-bar-mode}. This is also useful to
>> put
>> +in a hook. For example if you want the window tool bar to appear for
>> +all buffers that do not represent files and have a custom tool bar,
>> you
>> +could add the following code to your init file (@pxref{Init File}):
>
> Are these window tool bars also limited to windows whose buffers'
> major mode is different from the selected window? In any case, this
> aspect, whether identical to global-window-tool-bar-mode or different
> from it, should be explicitly documented.
>
> Last, but not least: please mention the bug number in the commit log
> message.
Will do.
-- MJF
[-- Attachment #2: screenshot.png --]
[-- Type: image/png, Size: 249775 bytes --]
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-25 15:49 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-25 17:03 ` Eli Zaretskii
2024-05-25 19:54 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-25 17:03 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Sat, 25 May 2024 08:49:22 -0700
> From: Jared Finder <jared@finder.org>
> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> >> +@node Window Tool Bar
> >> +@cindex mode, Window Tool Bar
> >
> > Index entries should preferably use only lower-case letters, to avoid
> > problems with sorting index entries in different locales.
> >
> > In addition, I would rephrase the above index entry to say just
> >
> > @cindex window tool bar
>
> I don't think that fits in with the existing convention. The convention
> appears to be "use mode, Capital Case Name" for specific modes and
> "mode, lower case" for concepts. There's 76 other examples of "@cindex
> mode," in the Emacs manual already, the majority of which follow that
> convention.
>
> The only examples I could find not following the convention are: "mode,
> archive", "mode, tar", "mode, display-fill-column-indicator".
Nevertheless, I stand by what I wrote. The examples which you quote,
whether they are a few or not, are mistakes: letter-case affects
sorting of index entries in locale-dependent way, so index entries
that us capital letters will appear in a different order in different
locales, which is not a good thing.
> I will try to redescribe it. I have a typo in the existing description.
> Change "all windows" to "each window". The idea is that each window
> gets its own tool bar *inside the window*, specifically on the window's
> tab line. Ideally I think I would just show a picture (see attached
> image), but I see very few pictures in any of the Emacs manuals and none
> of them show up in the HTML output at
> https://www.gnu.org/software/emacs/manual/, only in the PDF.
I don't think there were images in our manuals in previous versions,
which is why they don't appear in HTML.
Pictures have a disadvantage in that they cannot be displayed on TTY
frames, so a picture that cannot be replaced by some "ASCII art"
generally means the reader on a TTY frame will be at a disadvantage.
I will wait for the next version to see if my questions are now
answered or we need to discuss them further.
Thanks.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-25 17:03 ` Eli Zaretskii
@ 2024-05-25 19:54 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-26 9:44 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-25 19:54 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, juri
[-- Attachment #1: Type: text/plain, Size: 2571 bytes --]
On 2024-05-25 10:03, Eli Zaretskii wrote:
>> Date: Sat, 25 May 2024 08:49:22 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> >> +@node Window Tool Bar
>> >> +@cindex mode, Window Tool Bar
>> >
>> > Index entries should preferably use only lower-case letters, to avoid
>> > problems with sorting index entries in different locales.
>> >
>> > In addition, I would rephrase the above index entry to say just
>> >
>> > @cindex window tool bar
>>
>> I don't think that fits in with the existing convention. The
>> convention
>> appears to be "use mode, Capital Case Name" for specific modes and
>> "mode, lower case" for concepts. There's 76 other examples of
>> "@cindex
>> mode," in the Emacs manual already, the majority of which follow that
>> convention.
>>
>> The only examples I could find not following the convention are:
>> "mode,
>> archive", "mode, tar", "mode, display-fill-column-indicator".
>
> Nevertheless, I stand by what I wrote. The examples which you quote,
> whether they are a few or not, are mistakes: letter-case affects
> sorting of index entries in locale-dependent way, so index entries
> that us capital letters will appear in a different order in different
> locales, which is not a good thing.
Ok, I tried to fit into the existing convention but not use upper case
letters with "@cindex mode, window tool bar". Let me know if that's not
appropriate.
>> I will try to redescribe it. I have a typo in the existing
>> description.
>> Change "all windows" to "each window". The idea is that each window
>> gets its own tool bar *inside the window*, specifically on the
>> window's
>> tab line. Ideally I think I would just show a picture (see attached
>> image), but I see very few pictures in any of the Emacs manuals and
>> none
>> of them show up in the HTML output at
>> https://www.gnu.org/software/emacs/manual/, only in the PDF.
>
> I don't think there were images in our manuals in previous versions,
> which is why they don't appear in HTML.
>
> Pictures have a disadvantage in that they cannot be displayed on TTY
> frames, so a picture that cannot be replaced by some "ASCII art"
> generally means the reader on a TTY frame will be at a disadvantage.
That's what I was concerned about. Please let me know if this updated
text is clear enough.
> I will wait for the next version to see if my questions are now
> answered or we need to discuss them further.
New patch attached. Feedback welcome.
-- MJF
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Adding-documentation-for-window-tool-bar-bug-68765.patch --]
[-- Type: text/x-diff; name=0001-Adding-documentation-for-window-tool-bar-bug-68765.patch, Size: 13208 bytes --]
From de54c4026158520244d0418c221e4e29694ee6fb Mon Sep 17 00:00:00 2001
From: Jared Finder <jared@finder.org>
Date: Mon, 20 May 2024 21:59:14 -0700
Subject: [PATCH] Adding documentation for window-tool-bar (bug#68765)
* doc/emacs/emacs.texi (Top):
* doc/emacs/frames.texi (Tool Bars):
* doc/emacs/glossary.texi (Glossary):
* doc/emacs/modes.texi (Minor Modes): Mention Window Tool Bar
and add xref.
* doc/emacs/windows.texi (Windows, Tab Line): New documentation.
* doc/lispref/elisp.texi (Top):
* doc/lispref/modes.texi (Mode Line Format, Mode Line Basics)
(Mode Line Data): Mention Tab Lines and add xref.
(Tab Lines): New documentation.
* etc/NEWS: Mention newly added variable
'tool-bar-always-show-default' and new package 'window-tool-bar'
---
doc/emacs/emacs.texi | 1 +
doc/emacs/frames.texi | 14 +++++++----
doc/emacs/glossary.texi | 10 ++++----
doc/emacs/modes.texi | 4 ++++
doc/emacs/windows.texi | 42 ++++++++++++++++++++++++++++++++
doc/lispref/elisp.texi | 1 +
doc/lispref/modes.texi | 53 ++++++++++++++++++++++++++++++-----------
etc/NEWS | 14 +++++++++++
8 files changed, 117 insertions(+), 22 deletions(-)
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi
index 7d77f13ab21..8246041fb95 100644
--- a/doc/emacs/emacs.texi
+++ b/doc/emacs/emacs.texi
@@ -529,6 +529,7 @@ Top
* Temporary Displays:: Displaying non-editable buffers.
* Window Convenience:: Convenience functions for window handling.
* Tab Line:: Window tab line.
+* Window Tool Bar:: A tool bar that is attached to windows.
Displaying a Buffer in a Window
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 6c62fde4ffb..8028a516e66 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1295,16 +1295,22 @@ Menu Bars
@node Tool Bars
@section Tool Bars
@cindex tool bar mode
+@cindex tool bar, attached to frame
@cindex mode, Tool Bar
@cindex icons, toolbar
- On graphical displays, Emacs puts a @dfn{tool bar} at the top of
-each frame, just below the menu bar. This is a row of icons which you
-can click on with the mouse to invoke various commands.
+ On graphical displays, Emacs puts a @dfn{tool bar} at the top of each
+frame, just below the menu bar. This is a row of icons which you can
+click on with the mouse to invoke various commands. Emacs can also
+optionally display a tool bar at the top of each window (@pxref{Window
+Tool Bar}).
+@vindex tool-bar-always-show-default
The global (default) tool bar contains general commands. Some major
modes define their own tool bars; whenever a buffer with such a major
-mode is current, the mode's tool bar replaces the global tool bar.
+mode is current, the mode's tool bar replaces the global tool bar. To
+prevent this replacement from happening, customize the variable
+@code{tool-bar-always-show-default}.
@findex tool-bar-mode
@vindex tool-bar-mode
diff --git a/doc/emacs/glossary.texi b/doc/emacs/glossary.texi
index 344e4831f36..b30e1d789fc 100644
--- a/doc/emacs/glossary.texi
+++ b/doc/emacs/glossary.texi
@@ -1436,10 +1436,12 @@ Glossary
for your favorite set of faces (q.v.).
@item Tool Bar
-The tool bar is a line (sometimes multiple lines) of icons at the top
-of an Emacs frame. Clicking on one of these icons executes a command.
-You can think of this as a graphical relative of the menu bar (q.v.).
-@xref{Tool Bars}.
+The tool bar is a line (sometimes multiple lines) of icons at the top of
+an Emacs frame. Clicking on one of these icons executes a command. You
+can think of this as a graphical relative of the menu bar (q.v.).
+@xref{Tool Bars}. There is also a window tool bar that behaves
+similarly, but is at the top of an Emacs window. @xref{Window Tool
+Bar}.
@anchor{Glossary---Tooltips}
@item Tooltips
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi
index 2776dc72a27..253042b28a3 100644
--- a/doc/emacs/modes.texi
+++ b/doc/emacs/modes.texi
@@ -295,6 +295,10 @@ Minor Modes
but the tool bar is only displayed on graphical terminals. @xref{Tool
Bars}.
+@item
+Window Tool Bar mode gives windows a tool bar when it is different from
+the default tool bar. @xref{Window Tool Bar}.
+
@item
Tab Bar mode gives each frame a tab bar. @xref{Tab Bars}.
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index ad2225b5922..b7193593557 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -22,6 +22,7 @@ Windows
* Displaying Buffers:: How Emacs picks a window for displaying a buffer.
* Window Convenience:: Convenience functions for window handling.
* Tab Line:: Window tab line.
+* Window Tool Bar:: A tool bar that is attached to windows.
@end menu
@node Basic Window
@@ -689,3 +690,44 @@ Tab Line
switch between window configurations containing several windows with buffers,
tabs on the Tab Line at the top of each window are used to switch
between buffers in the window.
+
+
+@node Window Tool Bar
+@cindex window tool bar
+@cindex mode, window tool bar
+@cindex tool bar, attached to window
+
+@findex global-window-tool-bar-mode
+ The command @code{global-window-tool-bar-mode} toggles the display of
+a tool bar at the top of each window. When enabled, multiple windows
+can display their own tool bar simultaneously. To conserve space, a
+window tool bar is only shown if the tool bar for that window's current
+buffer is different from the global (default) tool bar. The most common
+way a buffer has a different tool bar is due to its major mode, so you
+can think of the window tool bar as showing a major mode's tool bar if
+it exists.
+
+@findex window-tool-bar-mode
+If you want to toggle the display of a window tool bar for only some
+buffers, run the command @code{window-tool-bar-mode}. The window tool
+bar will then only appear at the top of any window displaying that
+buffer. This is useful to put in a hook. For example, if you want the
+window tool bar to appear only for buffers that do not represent files
+and have a custom tool bar, you could add the following code to your
+init file (@pxref{Init File}):
+
+@example
+(add-hook 'special-mode-hook 'window-tool-bar-mode)
+@end example
+
+Emacs can also display a single tool bar at the top of frames
+(@pxref{Tool Bars}). When showing a tool bar at the top of frames as
+well as windows, you may want to have the frame tool bar not change
+based on the current buffer's major mode. This can be done by
+customizing the variable @code{tool-bar-always-show-default}.
+
+Note that the window tool bar displays in the same space as the tab
+line, so only one of these can be display at a time unless you customize
+the value of @code{tab-line-format} in Lisp. In this case, add
+@code{(:eval (window-tool-bar-strng))} to @code{tab-line-format}.
+@xref{Mode Line Format,,, elisp, The Emacs Lisp Reference Manual}.
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 339272d1f05..1059d0dcf61 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -925,6 +925,7 @@ Top
* %-Constructs:: Putting information into a mode line.
* Properties in Mode:: Using text properties in the mode line.
* Header Lines:: Like a mode line, but at the top.
+* Tab Lines:: A line that is above the header line.
* Emulating Mode Line:: Formatting text as the mode line would.
Font Lock Mode
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index cf67b319924..6ee1d869fb8 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -2074,14 +2074,14 @@ Mode Line Format
line at the bottom, which displays status information about the buffer
displayed in the window. The mode line contains information about the
buffer, such as its name, associated file, depth of recursive editing,
-and major and minor modes. A window can also have a @dfn{header
-line}, which is much like the mode line but appears at the top of the
-window.
+and major and minor modes. A window can also have a @dfn{header line}
+and a @dfn{tab line}, which are much like the mode line but they appear
+at the top of the window.
- This section describes how to control the contents of the mode line
-and header line. We include it in this chapter because much of the
-information displayed in the mode line relates to the enabled major and
-minor modes.
+ This section describes how to control the contents of the mode line,
+header line, and tab line. We include it in this chapter because much
+of the information displayed in the mode line relates to the enabled
+major and minor modes.
@menu
* Base: Mode Line Basics. Basic ideas of mode line control.
@@ -2091,6 +2091,7 @@ Mode Line Format
* %-Constructs:: Putting information into a mode line.
* Properties in Mode:: Using text properties in the mode line.
* Header Lines:: Like a mode line, but at the top.
+* Tab Lines:: A line that is above the header line.
* Emulating Mode Line:: Formatting text as the mode line would.
@end menu
@@ -2101,11 +2102,13 @@ Mode Line Basics
variable @code{mode-line-format} (@pxref{Mode Line Top}). This variable
holds a @dfn{mode line construct}: a template that controls what is
displayed on the buffer's mode line. The value of
-@code{header-line-format} specifies the buffer's header line in the same
-way. All windows for the same buffer use the same
-@code{mode-line-format} and @code{header-line-format} unless a
-@code{mode-line-format} or @code{header-line-format} parameter has been
-specified for that window (@pxref{Window Parameters}).
+@code{header-line-format} and @code{tab-line-format} specifies the
+buffer's header line and tab line in the same way. All windows for the
+same buffer use the same @code{mode-line-format},
+@code{header-line-format}, and @code{tab-line-format} unless a
+@code{mode-line-format}, @code{header-line-format}, or
+@code{tab-line-format} parameter has been specified for that window
+(@pxref{Window Parameters}).
For efficiency, Emacs does not continuously recompute each window's
mode line and header line. It does so when circumstances appear to call
@@ -2167,8 +2170,8 @@ Mode Line Data
@dfn{mode line construct}, made up of lists, strings, symbols, and
numbers kept in buffer-local variables. Each data type has a specific
meaning for the mode line appearance, as described below. The same data
-structure is used for constructing frame titles (@pxref{Frame Titles})
-and header lines (@pxref{Header Lines}).
+structure is used for constructing frame titles (@pxref{Frame Titles}),
+header lines (@pxref{Header Lines}), and tab lines (@pxref{Tab Lines}).
A mode line construct may be as simple as a fixed string of text,
but it usually specifies how to combine fixed strings with variables'
@@ -2816,6 +2819,28 @@ Header Lines
header line at once; if it has a mode line, then it does not display a
header line.
+@node Tab Lines
+@subsection Window Tab Lines
+@cindex tab line (of a window)
+@cindex window tab line
+
+ A window can have a @dfn{tab line} at the top. If both the tab line
+and header line are visible, the tab line appears above the header line.
+The tab line feature works just like the mode line feature, except that
+it's controlled by @code{tab-line-format}:
+
+@defvar tab-line-format
+This variable, local in every buffer, specifies how to display the tab
+line, for windows displaying the buffer. The format of the value is the
+same as for @code{mode-line-format} (@pxref{Mode Line Data}). It is
+normally @code{nil}, so that ordinary buffers have no tab line.
+@end defvar
+
+@defun window-tab-line-height &optional window
+This function returns the height in pixels of @var{window}'s tab line.
+@var{window} must be a live window, and defaults to the selected window.
+@end defun
+
@node Emulating Mode Line
@subsection Emulating Mode Line Formatting
diff --git a/etc/NEWS b/etc/NEWS
index d72ef5b5bef..7b829f5002c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -240,6 +240,12 @@ window systems other than Nextstep.
When this minor mode is enabled, buttons representing modifier keys
are displayed along the tool bar.
++++
+** New user option 'tool-bar-always-show-default'.
+This can be set so that the tool bar at the top of a frame does not show
+buffer local customization of the tool bar. This is convenient when
+using the newly added 'global-window-tool-bar-mode'.
+
+++
** "d" in the mode line now indicates that the window is dedicated.
Windows have always been able to be dedicated to a specific buffer;
@@ -1877,6 +1883,14 @@ than regular expressions, but less complexity than context-free
grammars. The Info manual "(elisp) Parsing Expression Grammars" has
documentation and examples.
++++
+** New package Window-Tool-Bar.
+This provides a new minor mode, 'window-tool-bar-mode'. When this minor
+mode is enabled, a tool bar is displayed at the top of a window if the
+buffer in the window has a buffer local tool bar, commonly from its
+major mode. The global minor mode 'global-window-tool-bar-mode' enables
+this minor mode in all buffers.
+
\f
* Incompatible Lisp Changes in Emacs 30.1
--
2.39.2
^ permalink raw reply related [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-25 19:54 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-26 9:44 ` Eli Zaretskii
2024-05-26 16:20 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-26 9:44 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Sat, 25 May 2024 12:54:30 -0700
> From: Jared Finder <jared@finder.org>
> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> Ok, I tried to fit into the existing convention but not use upper case
> letters with "@cindex mode, window tool bar". Let me know if that's not
> appropriate.
LGTM, thanks.
> That's what I was concerned about. Please let me know if this updated
> text is clear enough.
>
> > I will wait for the next version to see if my questions are now
> > answered or we need to discuss them further.
>
> New patch attached. Feedback welcome.
Thanks, some comments below.
> +@findex global-window-tool-bar-mode
> + The command @code{global-window-tool-bar-mode} toggles the display of
> +a tool bar at the top of each window. When enabled, multiple windows
> +can display their own tool bar simultaneously. To conserve space, a
> +window tool bar is only shown if the tool bar for that window's current
> +buffer is different from the global (default) tool bar. The most common
> +way a buffer has a different tool bar is due to its major mode, so you
> +can think of the window tool bar as showing a major mode's tool bar if
> +it exists.
So, let me understand what happens under this global mode. By
default, the frame's tool bar changes according to the major mode of
the buffer shown in the frame's selected window. As a very frequent
example, entering the minibuffer from a buffer whose mode is, say,
Dired or Rmail or Info, changes the tool bar. When that happens, some
windows which previously didn't display their tool bar because it was
identical to the frame's tool bar will now display their tool bars.
Right? And when you exit the minibuffer, those window-specific tool
bars will again disappear, right? Wouldn't that cause annoying
flickering of the display? (I know that setting
tool-bar-always-show-default non-nil can prevent that, but I'm asking
about the default behavior.)
Btw, what exactly is the meaning of "the tool bar of the window is
different from the global tool bar"? How are tool bars compared? For
example, a button on the tool bar can have the :visible attribute,
which will cause the icon not to appear under some conditions -- will
a tool bar with that icon on display be considered "different" from a
tool bar where the icon is not shown due to :visible conditions?
> +@findex window-tool-bar-mode
> +If you want to toggle the display of a window tool bar for only some
> +buffers, run the command @code{window-tool-bar-mode}.
I guess this should say that window-tool-bar-mode should be run in the
buffer(s) where the window tool bar is desired?
> +bar will then only appear at the top of any window displaying that
> +buffer. This is useful to put in a hook.
"in a mode hook", I suppose?
> +Note that the window tool bar displays in the same space as the tab
> +line, so only one of these can be display at a time unless you customize
> +the value of @code{tab-line-format} in Lisp. In this case, add
> +@code{(:eval (window-tool-bar-strng))} to @code{tab-line-format}.
^^^^^
A typo?
> + A window can have a @dfn{tab line} at the top. If both the tab line
> +and header line are visible, the tab line appears above the header line.
> +The tab line feature works just like the mode line feature, except that
> +it's controlled by @code{tab-line-format}:
> +
> +@defvar tab-line-format
> +This variable, local in every buffer, specifies how to display the tab
> +line, for windows displaying the buffer. The format of the value is the
> +same as for @code{mode-line-format} (@pxref{Mode Line Data}). It is
> +normally @code{nil}, so that ordinary buffers have no tab line.
> +@end defvar
I wonder whether it's a good idea to tell that tab line works "the
same as mode line", since the purpose is very different, and the
default value of tab-line-format is very different from the default of
mode-line-format. At the very least I think we should tell that
tab-line-format should cause the tab line appear as a row of buttons,
clicking on which should change the buffer shown in the window.
> ++++
> +** New user option 'tool-bar-always-show-default'.
> +This can be set so that the tool bar at the top of a frame does not show
> +buffer local customization of the tool bar. This is convenient when
> +using the newly added 'global-window-tool-bar-mode'.
This should tell the values of the option and their effect.
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-26 9:44 ` Eli Zaretskii
@ 2024-05-26 16:20 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-26 18:40 ` Eli Zaretskii
0 siblings, 1 reply; 45+ messages in thread
From: Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-05-26 16:20 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: philipk, 68765, monnier, juri
On 2024-05-26 02:44, Eli Zaretskii wrote:
>> Date: Sat, 25 May 2024 12:54:30 -0700
>> From: Jared Finder <jared@finder.org>
>> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
>> monnier@iro.umontreal.ca
>>
>> Ok, I tried to fit into the existing convention but not use upper case
>> letters with "@cindex mode, window tool bar". Let me know if that's
>> not
>> appropriate.
>
> LGTM, thanks.
>
>> That's what I was concerned about. Please let me know if this updated
>> text is clear enough.
>>
>> > I will wait for the next version to see if my questions are now
>> > answered or we need to discuss them further.
>>
>> New patch attached. Feedback welcome.
>
> Thanks, some comments below.
The questions around current behavior may be clarified by describing how
the internals work.
There's a new function, window-tool-bar-string, which converts the
binding of <tool-bar> to a propertized string containing clickable
buttons for the tool bar. This function depends on the current buffer
but that doesn't result in flickering, see the next paragraph.
window-tool-bar-mode toggles the buffer local value of tab-line-format
between nil, which shows no tab line, and (:eval
(window-tool-bar-string)), which shows tool bar buttons in the tab line.
When "evaluating" tab-line-format for display Emacs already temporarily
sets the current buffer, so this evaluation only shows that buffer's
tool bar, ignoring whatever the user's current buffer is.
And finally, window-tool-bar-mode will keep tab-line-format as nil if
the binding of <tool-bar> is the same as the global binding because
setting tab-line-format to non-nil causes the tab line to take up a row,
even if the result is just an empty string.
Answers also for the questions below follow.
>> +@findex global-window-tool-bar-mode
>> + The command @code{global-window-tool-bar-mode} toggles the display
>> of
>> +a tool bar at the top of each window. When enabled, multiple windows
>> +can display their own tool bar simultaneously. To conserve space, a
>> +window tool bar is only shown if the tool bar for that window's
>> current
>> +buffer is different from the global (default) tool bar. The most
>> common
>> +way a buffer has a different tool bar is due to its major mode, so
>> you
>> +can think of the window tool bar as showing a major mode's tool bar
>> if
>> +it exists.
>
> So, let me understand what happens under this global mode. By
> default, the frame's tool bar changes according to the major mode of
> the buffer shown in the frame's selected window. As a very frequent
> example, entering the minibuffer from a buffer whose mode is, say,
> Dired or Rmail or Info, changes the tool bar. When that happens, some
> windows which previously didn't display their tool bar because it was
> identical to the frame's tool bar will now display their tool bars.
> Right? And when you exit the minibuffer, those window-specific tool
> bars will again disappear, right? Wouldn't that cause annoying
> flickering of the display? (I know that setting
> tool-bar-always-show-default non-nil can prevent that, but I'm asking
> about the default behavior.)
No, this is not the behavior. The window tool bar displays that
buffer's binding of <tool-bar>. The window tool bar is displayed in the
tab line of each window and doesn't pay attention to what the current
buffer or window is.
> Btw, what exactly is the meaning of "the tool bar of the window is
> different from the global tool bar"? How are tool bars compared? For
> example, a button on the tool bar can have the :visible attribute,
> which will cause the icon not to appear under some conditions -- will
> a tool bar with that icon on display be considered "different" from a
> tool bar where the icon is not shown due to :visible conditions?
It's specifically using the following test:
(eq tool-bar-map
(default-value 'tool-bar-map))
This is because the binding for <tool-bar> is actually :filter
tool-bar-make-keymap which generates a keymap based on tool-bar-map.
Other comments all addressed in an upcoming patch except this one:
>> + A window can have a @dfn{tab line} at the top. If both the tab
>> line
>> +and header line are visible, the tab line appears above the header
>> line.
>> +The tab line feature works just like the mode line feature, except
>> that
>> +it's controlled by @code{tab-line-format}:
>> +
>> +@defvar tab-line-format
>> +This variable, local in every buffer, specifies how to display the
>> tab
>> +line, for windows displaying the buffer. The format of the value is
>> the
>> +same as for @code{mode-line-format} (@pxref{Mode Line Data}). It is
>> +normally @code{nil}, so that ordinary buffers have no tab line.
>> +@end defvar
>
> I wonder whether it's a good idea to tell that tab line works "the
> same as mode line", since the purpose is very different, and the
> default value of tab-line-format is very different from the default of
> mode-line-format. At the very least I think we should tell that
> tab-line-format should cause the tab line appear as a row of buttons,
> clicking on which should change the buffer shown in the window.
Perhaps there's some sort of convention we can describe that talks about
the difference between header-line-format and tab-line-format? I'd like
to copy back any changes to header-line-format which I based this text
off of.
It seems to me that really the only difference is conventional. I'm
thinking something along the lines of "header line is usually modified
by major modes to add additional info (examples: EWW, Info) and the tab
line is usually modified by minor modes to add IDE-styled buttons
(examples: tab line mode, window tool bar mode)".
Does that sound right to you? I'd make the text more specific in its
description, I just want to confirm the general intent.
-- MJF
^ permalink raw reply [flat|nested] 45+ messages in thread
* bug#68765: 30.0.50; Adding window-tool-bar package.
2024-05-26 16:20 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-05-26 18:40 ` Eli Zaretskii
0 siblings, 0 replies; 45+ messages in thread
From: Eli Zaretskii @ 2024-05-26 18:40 UTC (permalink / raw)
To: Jared Finder; +Cc: philipk, 68765, monnier, juri
> Date: Sun, 26 May 2024 09:20:56 -0700
> From: Jared Finder <jared@finder.org>
> Cc: juri@linkov.net, 68765@debbugs.gnu.org, philipk@posteo.net,
> monnier@iro.umontreal.ca
>
> >> +@findex global-window-tool-bar-mode
> >> + The command @code{global-window-tool-bar-mode} toggles the display
> >> of
> >> +a tool bar at the top of each window. When enabled, multiple windows
> >> +can display their own tool bar simultaneously. To conserve space, a
> >> +window tool bar is only shown if the tool bar for that window's
> >> current
> >> +buffer is different from the global (default) tool bar. The most
> >> common
> >> +way a buffer has a different tool bar is due to its major mode, so
> >> you
> >> +can think of the window tool bar as showing a major mode's tool bar
> >> if
> >> +it exists.
> >
> > So, let me understand what happens under this global mode. By
> > default, the frame's tool bar changes according to the major mode of
> > the buffer shown in the frame's selected window. As a very frequent
> > example, entering the minibuffer from a buffer whose mode is, say,
> > Dired or Rmail or Info, changes the tool bar. When that happens, some
> > windows which previously didn't display their tool bar because it was
> > identical to the frame's tool bar will now display their tool bars.
> > Right? And when you exit the minibuffer, those window-specific tool
> > bars will again disappear, right? Wouldn't that cause annoying
> > flickering of the display? (I know that setting
> > tool-bar-always-show-default non-nil can prevent that, but I'm asking
> > about the default behavior.)
>
> No, this is not the behavior. The window tool bar displays that
> buffer's binding of <tool-bar>. The window tool bar is displayed in the
> tab line of each window and doesn't pay attention to what the current
> buffer or window is.
But this means that the following text:
>> To conserve space,
>> a window tool bar is only shown if the tool bar for that window's
>> current buffer is different from the global (default) tool bar
is at least inaccurate. Specifically, if the frame's global tool bar
changes as result of some command, the identity of the tool bars of
windows to that of the frame is not re-examined. So if some window
decided that its tool bar is not to be displayed, it will remain
undisplayed until that window shows a different buffer or its buffer
changes its major mode. Is that correct? If not, why not?
Or maybe I don't understand well enough what you mean by "The window
tool bar is displayed in the tab line of each window and doesn't pay
attention to what the current buffer or window is." You are using
here terminology that is confusing: there's no "current window" in
Emacs, only the "selected window", and it is unclear whether by
"current buffer" you mean the global current buffer (the one returned
by the function current-buffer) or the buffer shown in a window (since
you also say "the window's current buffer", another term that we do
not use).
> > Btw, what exactly is the meaning of "the tool bar of the window is
> > different from the global tool bar"? How are tool bars compared? For
> > example, a button on the tool bar can have the :visible attribute,
> > which will cause the icon not to appear under some conditions -- will
> > a tool bar with that icon on display be considered "different" from a
> > tool bar where the icon is not shown due to :visible conditions?
>
> It's specifically using the following test:
>
> (eq tool-bar-map
> (default-value 'tool-bar-map))
So a frame's tool bar can completely change its look due to :visible,
and Emacs will still consider it "equal" to the tool bar of some
window where those :visible conditions yield a completely different
look? Does that make sense?
I'm beginning to think that the feature whereby we don't display the
window's tool bar under some conditions "to conserve space" is more
confusing and hard to document than is useful, and perhaps we should
simply show the window's tool bar unconditionally?
> > I wonder whether it's a good idea to tell that tab line works "the
> > same as mode line", since the purpose is very different, and the
> > default value of tab-line-format is very different from the default of
> > mode-line-format. At the very least I think we should tell that
> > tab-line-format should cause the tab line appear as a row of buttons,
> > clicking on which should change the buffer shown in the window.
>
> Perhaps there's some sort of convention we can describe that talks about
> the difference between header-line-format and tab-line-format? I'd like
> to copy back any changes to header-line-format which I based this text
> off of.
>
> It seems to me that really the only difference is conventional. I'm
> thinking something along the lines of "header line is usually modified
> by major modes to add additional info (examples: EWW, Info) and the tab
> line is usually modified by minor modes to add IDE-styled buttons
> (examples: tab line mode, window tool bar mode)".
>
> Does that sound right to you?
It doesn't address my concerns. My concerns are that the purpose of
tab-line and window's tool bar is conceptually very different from
that of the mode line and the header line. Technically, they are all
controlled by a FOO-format variable that has the same rules and
syntax, but that's an implementation detail. For example, it would
make no sense at all to use something similar to the default
mode-line-format for the tab-line or the window tool bar, would it?
So what I would like us to say in the manual is that the value of
window-tool-bar-format and of tab-line-format should produce what is
expected from these lines: a row of tabs for tab-line and a row of
icons for the tool bar. The reader should understand that having a
tab-line-format whose value is "%b %f", for example, makes no sense,
although it will work. (In general, most or all %-elements of mode
line and header line make no sense in tab-line and tool bar. It is
hardly an accident that tab-line-format's value is just (:eval FUNC),
in stark contrast to the value of mode-line-format and
header-line-format in modes in which it is non-nil.)
Did I succeed to explain my concerns?
^ permalink raw reply [flat|nested] 45+ messages in thread
end of thread, other threads:[~2024-05-26 18:40 UTC | newest]
Thread overview: 45+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-01-27 23:36 bug#68765: 30.0.50; Adding window-tool-bar package Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-02-10 8:19 ` Eli Zaretskii
2024-02-10 17:25 ` Juri Linkov
2024-02-26 22:38 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-26 15:34 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-27 7:04 ` Juri Linkov
2024-05-02 6:03 ` Juri Linkov
2024-05-09 8:00 ` Eli Zaretskii
2024-05-10 4:24 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-11 4:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-12 16:34 ` Juri Linkov
2024-05-14 4:14 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-14 6:01 ` Juri Linkov
2024-05-18 9:50 ` Eli Zaretskii
2024-05-19 3:55 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 6:43 ` Eli Zaretskii
2024-05-20 17:14 ` Juri Linkov
2024-05-21 2:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-21 6:12 ` Juri Linkov
2024-05-18 9:45 ` Eli Zaretskii
2024-05-18 9:48 ` Eli Zaretskii
2024-05-19 3:58 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-19 6:48 ` Eli Zaretskii
2024-05-23 4:19 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-23 6:52 ` Eli Zaretskii
2024-05-25 15:49 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-25 17:03 ` Eli Zaretskii
2024-05-25 19:54 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-26 9:44 ` Eli Zaretskii
2024-05-26 16:20 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-26 18:40 ` Eli Zaretskii
2024-05-19 14:41 ` Philip Kaludercic
2024-05-20 3:25 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-20 6:39 ` Philip Kaludercic
2024-05-20 9:19 ` Philip Kaludercic
2024-05-21 4:18 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-21 13:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-05-22 16:16 ` Philip Kaludercic
2024-02-11 20:51 ` Philip Kaludercic
2024-02-27 3:02 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-03-26 15:33 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-13 7:43 ` Eli Zaretskii
2024-04-27 8:25 ` Eli Zaretskii
2024-04-27 10:00 ` Philip Kaludercic
2024-04-28 4:44 ` Jared Finder via Bug reports for GNU Emacs, the Swiss army knife of text editors
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.