master 414f8d02c1a: New user option 'tab-line-tabs-buffer-group-function'

[Juri Linkov]

branch: master
commit 414f8d02c1a361fa780e55fcf0f260fe00a9a62d
Author: Juri Linkov <juri@linkov.net>
Commit: Juri Linkov <juri@linkov.net>

    New user option 'tab-line-tabs-buffer-group-function'
    
    * lisp/tab-line.el (tab-line-tabs-buffer-group-function):
    Turn defvar into defcustom with the default value
    'tab-line-tabs-buffer-group-by-mode'.
    (tab-line-tabs-buffer-group-by-mode): New function with body from
    'tab-line-tabs-buffer-group-name'.
    (tab-line-tabs-buffer-group-by-project): New function.
    (tab-line-tabs-buffer-groups): Use fallback name "No group" instead of 
"All".
---
 etc/NEWS         |  5 +++++
 lisp/tab-line.el | 55 ++++++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 47 insertions(+), 13 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index ed5db3a01a3..da809096d94 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -364,6 +364,11 @@ By default it contains a keybinding 'C-TAB' to switch tabs,
 but only when 'C-TAB' is not bound globally.  You can unbind it
 if it conflicts with 'C-TAB' in other modes.
 
+---
+*** New user option 'tab-line-tabs-buffer-group-function'.
+It provides two choices to group tab buffers by major mode
+and by project name.
+
 +++
 ** New optional argument for modifying directory-local variables.
 The commands 'add-dir-local-variable', 'delete-dir-local-variable' and
diff --git a/lisp/tab-line.el b/lisp/tab-line.el
index fd18e7b7909..54e9ee16243 100644
--- a/lisp/tab-line.el
+++ b/lisp/tab-line.el
@@ -342,8 +342,7 @@ returns a list of buffers associated with the selected 
window.
 When `tab-line-tabs-mode-buffers', return a list of buffers
 with the same major mode as the current buffer.
 When `tab-line-tabs-buffer-groups', return a list of buffers
-grouped either by `tab-line-tabs-buffer-group-function', when set,
-or by `tab-line-tabs-buffer-groups'."
+grouped by `tab-line-tabs-buffer-group-function'."
   :type '(choice (const :tag "Window buffers"
                         tab-line-tabs-window-buffers)
                  (const :tag "Same mode buffers"
@@ -377,10 +376,29 @@ Used only for `tab-line-tabs-mode-buffers' and 
`tab-line-tabs-buffer-groups'.")
                                            (derived-mode-p mode)))
                              (funcall tab-line-tabs-buffer-list-function)))))
 
-(defvar tab-line-tabs-buffer-group-function nil
+(defcustom tab-line-tabs-buffer-group-function
+  #'tab-line-tabs-buffer-group-by-mode
   "Function to add a buffer to the appropriate group of tabs.
 Takes a buffer as arg and should return a group name as a string.
-If the return value is nil, the buffer should be filtered out.")
+If the return value is nil, the buffer has no group, so \"No group\"
+is displayed instead of a group name and the buffer is not grouped
+together with other buffers.
+If the value is `tab-line-tabs-buffer-group-by-mode',
+use mode-to-group mappings in `tab-line-tabs-buffer-groups'
+to group by major mode.  If the value is
+`tab-line-tabs-buffer-group-by-project' use the project name
+as a group name."
+  :type '(choice (const :tag "Group by mode"
+                        tab-line-tabs-buffer-group-by-mode)
+                 (const :tag "Group by project name"
+                        tab-line-tabs-buffer-group-by-project)
+                 (function :tag "Custom function"))
+  :initialize 'custom-initialize-default
+  :set (lambda (sym val)
+         (set-default sym val)
+         (force-mode-line-update))
+  :group 'tab-line
+  :version "30.1")
 
 (defvar tab-line-tabs-buffer-group-sort-function nil
   "Function to sort buffers in a group.")
@@ -395,16 +413,27 @@ If the major mode's name matches REGEXP, it belongs to 
GROUPNAME.
 The default is for each major mode to have a separate group
 named the same as the mode.")
 
+(defun tab-line-tabs-buffer-group-by-mode (&optional buffer)
+  "Group tab buffers by major mode."
+  (let ((mode (if buffer (with-current-buffer buffer
+                           (format-mode-line mode-name))
+                (format-mode-line mode-name))))
+    (or (cdr (seq-find (lambda (group)
+                         (string-match-p (car group) mode))
+                       tab-line-tabs-buffer-groups))
+        mode)))
+
+(declare-function project-name "project" (project))
+(defun tab-line-tabs-buffer-group-by-project (&optional buffer)
+  "Group tab buffers by project name."
+  (with-current-buffer buffer
+    (if-let ((project (project-current)))
+        (project-name project)
+      "No project")))
+
 (defun tab-line-tabs-buffer-group-name (&optional buffer)
   (if (functionp tab-line-tabs-buffer-group-function)
-      (funcall tab-line-tabs-buffer-group-function buffer)
-    (let ((mode (if buffer (with-current-buffer buffer
-                             (format-mode-line mode-name))
-                  (format-mode-line mode-name))))
-      (or (cdr (seq-find (lambda (group)
-                           (string-match-p (car group) mode))
-                         tab-line-tabs-buffer-groups))
-          mode))))
+      (funcall tab-line-tabs-buffer-group-function buffer)))
 
 (defun tab-line-tabs-buffer-groups ()
   "Return a list of tabs that should be displayed in the tab line.
@@ -436,7 +465,7 @@ generate the group name."
 
     (let* ((window-parameter (window-parameter nil 'tab-line-group))
            (group-name (tab-line-tabs-buffer-group-name (current-buffer)))
-           (group (prog1 (or window-parameter group-name "All")
+           (group (prog1 (or window-parameter group-name "No group")
                     (when (equal window-parameter group-name)
                       (set-window-parameter nil 'tab-line-group nil))))
            (group-tab `(tab