branch: externals/denote
commit d5f8a6e11b43ccfa322fea2bd6624f06d35dd5f7
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Merge denote-rename-buffer.el into denote.el
This is part of the wider reorganisation of the project, as discussed
in issue 543: <https://github.com/protesilaos/denote/issues/543>.
---
README.org | 3 +
denote-rename-buffer.el | 173 ------------------------------------------------
denote.el | 129 ++++++++++++++++++++++++++++++++++++
3 files changed, 132 insertions(+), 173 deletions(-)
diff --git a/README.org b/README.org
index e8b07ef16c..1c18ed32e6 100644
--- a/README.org
+++ b/README.org
@@ -3538,6 +3538,9 @@ its standand attachments' facility).
:CUSTOM_ID: h:3ca4db16-8f26-4d7d-b748-bac48ae32d69
:END:
+[ As part of {{{development-version}}}, the code of =denote-rename-buffer.el=
+ is now part of =denote.el= as part of a wider reorganisation of the project.
]
+
#+findex: denote-rename-buffer-mode
The minor mode ~denote-rename-buffer-mode~ provides the means to
automatically rename the buffer of a Denote file upon visiting the
diff --git a/denote-rename-buffer.el b/denote-rename-buffer.el
deleted file mode 100644
index 95b59efa1c..0000000000
--- a/denote-rename-buffer.el
+++ /dev/null
@@ -1,173 +0,0 @@
-;;; denote-rename-buffer.el --- Rename Denote buffers to be shorter and easier
to read -*- lexical-binding: t -*-
-
-;; Copyright (C) 2023-2025 Free Software Foundation, Inc.
-
-;; Author: Protesilaos Stavrou <i...@protesilaos.com>
-;; Maintainer: Protesilaos Stavrou <i...@protesilaos.com>
-;; URL: https://github.com/protesilaos/denote
-
-;; This file is NOT part of GNU Emacs.
-
-;; This program is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation, either version 3 of the License, or
-;; (at your option) any later version.
-;;
-;; This program is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-;; GNU General Public License for more details.
-;;
-;; You should have received a copy of the GNU General Public License
-;; along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-;;; Commentary:
-;;
-;; Rename Denote buffers to be shorter and easier to read. Enable
-;; `denote-rename-buffer-mode' to automatically rename the buffer of a
-;; Denote file. The renaming function is specified in the user option
-;; `denote-rename-buffer-function'.
-
-;;; Code:
-
-(require 'denote)
-
-(defgroup denote-rename-buffer nil
- "Rename Denote buffers to be shorter and easier to read."
- :group 'denote
- :link '(info-link "(denote) Top")
- :link '(url-link :tag "Homepage" "https://protesilaos.com/emacs/denote";))
-
-(defvaralias 'denote-buffer-has-backlinks-string
'denote-rename-buffer-backlinks-indicator
- "Alias for `denote-rename-buffer-backlinks-indicator'.")
-
-(defcustom denote-rename-buffer-backlinks-indicator " <-->"
- "A string used to indicate that a buffer has backlinks pointing to it."
- :type 'string
- :package-version '(denote . "3.1.0")
- :group 'denote-rename-buffer)
-
-(defcustom denote-rename-buffer-format "[D] %t%b"
- "The format of the buffer name `denote-rename-buffer' should use.
-The value is a string that treats specially the following
-specifiers:
-
-- The %t is the Denote TITLE in the front matter or the file name.
-- The %T is the Denote TITLE in the file name.
-- The %i is the Denote IDENTIFIER of the file.
-- The %d is the same as %i (DATE mnemonic).
-- The %s is the Denote SIGNATURE of the file.
-- The %k is the Denote KEYWORDS of the file.
-- The %b inserts `denote-rename-buffer-backlinks-indicator'.
-- The %% is a literal percent sign.
-
-In addition, the following flags are available for each of the specifiers:
-
-- 0 :: Pad to the width, if given, with zeros instead of spaces.
-- - :: Pad to the width, if given, on the right instead of the left.
-- < :: Truncate to the width and precision, if given, on the left.
-- > :: Truncate to the width and precision, if given, on the right.
-- ^ :: Convert to upper case.
-- _ :: Convert to lower case.
-
-When combined all together, the above are written thus:
-
- %<flags><width><precision>SPECIFIER-CHARACTER
-
-Any other string it taken as-is. Users may want, for example, to
-include some text that makes Denote buffers stand out, such as
-a [D] prefix."
- :type 'string
- :package-version '(denote . "3.1.0")
- :group 'denote-rename-buffer)
-
-(defcustom denote-rename-buffer-function #'denote-rename-buffer
- "Symbol of function that is called to rename the Denote file buffer.
-The default `denote-rename-buffer' function uses the pattern
-described in `denote-rename-buffer-format'.
-
-Users can set this variable to an arbitrary function that does
-something else. The function is called without arguments from
-the `find-file-hook' and `denote-after-new-note-hook'.
-
-A nil value for this variable means that the title of the Denote
-buffer will be used, if available."
- :type '(choice
- (const :tag "Rename using the `denote-rename-buffer-format'"
denote-rename-buffer)
- (function :tag "Use a custom renaming function"))
- :package-version '(denote . "2.1.0")
- :group 'denote-rename-buffer)
-
-(defun denote-rename-buffer--format (buffer)
- "Parse the BUFFER through the `denote-rename-buffer-format'."
- (when-let* ((file (buffer-file-name buffer)))
- (let ((type (denote-filetype-heuristics file))
- (should-show-backlink-indicator (and ; only do search if format
contains "%b"
- (string-match-p "%b"
denote-rename-buffer-format)
- (denote--file-has-backlinks-p
file))))
- (string-trim
- (format-spec denote-rename-buffer-format
- (list (cons ?t (cond
- ((denote-retrieve-front-matter-title-value
file type))
- ((denote-retrieve-filename-title file))
- (t "")))
- (cons ?T (or (denote-retrieve-filename-title file)
""))
- (cons ?b (if should-show-backlink-indicator
denote-rename-buffer-backlinks-indicator ""))
- (cons ?i (or (denote-retrieve-filename-identifier
file) ""))
- (cons ?d (or (denote-retrieve-filename-identifier
file) ""))
- (cons ?s (or (denote-retrieve-filename-signature
file) ""))
- (cons ?k (or (denote-retrieve-filename-keywords
file) ""))
- (cons ?% "%"))
- 'delete)))))
-
-(defun denote-rename-buffer (&optional buffer)
- "Rename current buffer or optional BUFFER with `denote-rename-buffer-format'.
-The symbol of this function is the default value of the user
-option `denote-rename-buffer-function' and is thus used by the
-`denote-rename-buffer-mode'."
- (when-let* ((file (buffer-file-name buffer))
- ((denote-file-has-identifier-p file))
- (new-name (denote-rename-buffer--format (or buffer
(current-buffer))))
- ((not (string-blank-p new-name))))
- (rename-buffer new-name :unique)))
-
-(make-obsolete
- 'denote-rename-buffer-with-title
- 'denote-rename-buffer
- "2.1.0")
-
-(make-obsolete
- 'denote-rename-buffer-with-identifier
- 'denote-rename-buffer
- "2.1.0")
-
-(defun denote-rename-buffer--fallback (&optional buffer)
- "Fallback to rename BUFFER or `current-buffer'.
-This is called if `denote-rename-buffer-rename-function' is nil."
- (let ((denote-rename-buffer-format "%t"))
- (denote-rename-buffer buffer)))
-
-(defun denote-rename-buffer-rename-function-or-fallback ()
- "Call `denote-rename-buffer-function' or its fallback to rename with title.
-Add this to `find-file-hook' and `denote-after-new-note-hook'."
- (funcall (or denote-rename-buffer-function
#'denote-rename-buffer--fallback)))
-
-;;;###autoload
-(define-minor-mode denote-rename-buffer-mode
- "Automatically rename Denote buffers to be easier to read.
-A buffer is renamed upon visiting the underlying file. This
-means that existing buffers are not renamed until they are
-visited again in a new buffer (files are visited with the command
-`find-file' or related)."
- :global t
- (if denote-rename-buffer-mode
- (progn
- (add-hook 'denote-after-new-note-hook
#'denote-rename-buffer-rename-function-or-fallback)
- (add-hook 'denote-after-rename-file-hook
#'denote-rename-buffer-rename-function-or-fallback)
- (add-hook 'find-file-hook
#'denote-rename-buffer-rename-function-or-fallback))
- (remove-hook 'denote-after-new-note-hook
#'denote-rename-buffer-rename-function-or-fallback)
- (remove-hook 'denote-after-rename-file-hook
#'denote-rename-buffer-rename-function-or-fallback)
- (remove-hook 'find-file-hook
#'denote-rename-buffer-rename-function-or-fallback)))
-
-(provide 'denote-rename-buffer)
-;;; denote-rename-buffer.el ends here
diff --git a/denote.el b/denote.el
index b763415d5f..6432b3c500 100644
--- a/denote.el
+++ b/denote.el
@@ -5909,5 +5909,134 @@ option `denote-templates'."
(add-hook 'org-capture-after-finalize-hook #'denote-org-capture-rename-file) ;
Must be inserted first (executed last).
(add-hook 'org-capture-after-finalize-hook
#'denote-org-capture-delete-empty-file)
+;;;; The `denote-rename-buffer-mode'
+
+(defgroup denote-rename-buffer nil
+ "Rename Denote buffers to be shorter and easier to read."
+ :group 'denote
+ :link '(info-link "(denote) Top")
+ :link '(url-link :tag "Homepage" "https://protesilaos.com/emacs/denote";))
+
+(defvaralias 'denote-buffer-has-backlinks-string
'denote-rename-buffer-backlinks-indicator
+ "Alias for `denote-rename-buffer-backlinks-indicator'.")
+
+(defcustom denote-rename-buffer-backlinks-indicator " <-->"
+ "A string used to indicate that a buffer has backlinks pointing to it."
+ :type 'string
+ :package-version '(denote . "3.1.0")
+ :group 'denote-rename-buffer)
+
+(defcustom denote-rename-buffer-format "[D] %t%b"
+ "The format of the buffer name `denote-rename-buffer' should use.
+The value is a string that treats specially the following
+specifiers:
+
+- The %t is the Denote TITLE in the front matter or the file name.
+- The %T is the Denote TITLE in the file name.
+- The %i is the Denote IDENTIFIER of the file.
+- The %d is the same as %i (DATE mnemonic).
+- The %s is the Denote SIGNATURE of the file.
+- The %k is the Denote KEYWORDS of the file.
+- The %b inserts `denote-rename-buffer-backlinks-indicator'.
+- The %% is a literal percent sign.
+
+In addition, the following flags are available for each of the specifiers:
+
+- 0 :: Pad to the width, if given, with zeros instead of spaces.
+- - :: Pad to the width, if given, on the right instead of the left.
+- < :: Truncate to the width and precision, if given, on the left.
+- > :: Truncate to the width and precision, if given, on the right.
+- ^ :: Convert to upper case.
+- _ :: Convert to lower case.
+
+When combined all together, the above are written thus:
+
+ %<flags><width><precision>SPECIFIER-CHARACTER
+
+Any other string it taken as-is. Users may want, for example, to
+include some text that makes Denote buffers stand out, such as
+a [D] prefix."
+ :type 'string
+ :package-version '(denote . "3.1.0")
+ :group 'denote-rename-buffer)
+
+(defcustom denote-rename-buffer-function #'denote-rename-buffer
+ "Symbol of function that is called to rename the Denote file buffer.
+The default `denote-rename-buffer' function uses the pattern
+described in `denote-rename-buffer-format'.
+
+Users can set this variable to an arbitrary function that does
+something else. The function is called without arguments from
+the `find-file-hook' and `denote-after-new-note-hook'.
+
+A nil value for this variable means that the title of the Denote
+buffer will be used, if available."
+ :type '(choice
+ (const :tag "Rename using the `denote-rename-buffer-format'"
denote-rename-buffer)
+ (function :tag "Use a custom renaming function"))
+ :package-version '(denote . "2.1.0")
+ :group 'denote-rename-buffer)
+
+(defun denote-rename-buffer--format (buffer)
+ "Parse the BUFFER through the `denote-rename-buffer-format'."
+ (when-let* ((file (buffer-file-name buffer)))
+ (let ((type (denote-filetype-heuristics file))
+ (should-show-backlink-indicator (and ; only do search if format
contains "%b"
+ (string-match-p "%b"
denote-rename-buffer-format)
+ (denote--file-has-backlinks-p
file))))
+ (string-trim
+ (format-spec denote-rename-buffer-format
+ (list (cons ?t (cond
+ ((denote-retrieve-front-matter-title-value
file type))
+ ((denote-retrieve-filename-title file))
+ (t "")))
+ (cons ?T (or (denote-retrieve-filename-title file)
""))
+ (cons ?b (if should-show-backlink-indicator
denote-rename-buffer-backlinks-indicator ""))
+ (cons ?i (or (denote-retrieve-filename-identifier
file) ""))
+ (cons ?d (or (denote-retrieve-filename-identifier
file) ""))
+ (cons ?s (or (denote-retrieve-filename-signature
file) ""))
+ (cons ?k (or (denote-retrieve-filename-keywords
file) ""))
+ (cons ?% "%"))
+ 'delete)))))
+
+(defun denote-rename-buffer (&optional buffer)
+ "Rename current buffer or optional BUFFER with `denote-rename-buffer-format'.
+The symbol of this function is the default value of the user
+option `denote-rename-buffer-function' and is thus used by the
+`denote-rename-buffer-mode'."
+ (when-let* ((file (buffer-file-name buffer))
+ ((denote-file-has-identifier-p file))
+ (new-name (denote-rename-buffer--format (or buffer
(current-buffer))))
+ ((not (string-blank-p new-name))))
+ (rename-buffer new-name :unique)))
+
+(defun denote-rename-buffer--fallback (&optional buffer)
+ "Fallback to rename BUFFER or `current-buffer'.
+This is called if `denote-rename-buffer-rename-function' is nil."
+ (let ((denote-rename-buffer-format "%t"))
+ (denote-rename-buffer buffer)))
+
+(defun denote-rename-buffer-rename-function-or-fallback ()
+ "Call `denote-rename-buffer-function' or its fallback to rename with title.
+Add this to `find-file-hook' and `denote-after-new-note-hook'."
+ (funcall (or denote-rename-buffer-function
#'denote-rename-buffer--fallback)))
+
+;;;###autoload
+(define-minor-mode denote-rename-buffer-mode
+ "Automatically rename Denote buffers to be easier to read.
+A buffer is renamed upon visiting the underlying file. This
+means that existing buffers are not renamed until they are
+visited again in a new buffer (files are visited with the command
+`find-file' or related)."
+ :global t
+ (if denote-rename-buffer-mode
+ (progn
+ (add-hook 'denote-after-new-note-hook
#'denote-rename-buffer-rename-function-or-fallback)
+ (add-hook 'denote-after-rename-file-hook
#'denote-rename-buffer-rename-function-or-fallback)
+ (add-hook 'find-file-hook
#'denote-rename-buffer-rename-function-or-fallback))
+ (remove-hook 'denote-after-new-note-hook
#'denote-rename-buffer-rename-function-or-fallback)
+ (remove-hook 'denote-after-rename-file-hook
#'denote-rename-buffer-rename-function-or-fallback)
+ (remove-hook 'find-file-hook
#'denote-rename-buffer-rename-function-or-fallback)))
+
(provide 'denote)
;;; denote.el ends here
